help.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  5. <title>SingleFile help</title>
  6. <link rel="stylesheet" href="help.css">
  7. </head>
  8. <body>
  9. <div>
  10. <div id="titleBorder">
  11. <h2><img src="../resources/icon_48.png" id="titleIcon"><span id="title">SingleFile help</span></h2>
  12. <h4>SingleFile helps you to archive a complete page into a single HTML file.</h4>
  13. </div>
  14. <span id="index"><a href="#instructions">Instructions</a> - <a href="#demo">Demo</a> - <a href="#options">Options description</a> - <a href="#folder">Saved archives
  15. folder</a> - <a href="#notes">Technical notes</a> - <a href="#knownIssues">Known issues</a> - <a href="#unknownIssues">Unknown issues</a></span>
  16. <hr>
  17. <ol>
  18. <li><a id="instructions">Instructions</a>
  19. <ul>
  20. <li>wait until the page is fully loaded : you may need to scroll down the entire page and hover dynamic document elements (e.g. "rollover" images) to be sure all elements
  21. are displayed</li>
  22. <li>click on the SingleFile icon <img src="../resources/icon_48.png" id="icon"> in the Chrome toolbar or press Ctrl-Shift-S shortcut or use context menu to launch page
  23. processing</li>
  24. <li>wait until the shadow disappears then hit Ctrl-S or select "Save as" in the wrench menu and save the page</li>
  25. <li>all images, style sheets and frame contents are embedded into the ".htm" saved file</li>
  26. </ul>
  27. </li>
  28. <li><a id="demo">Demo : SingleFile advantages over default file save</a>
  29. <div><object width="480" height="385">
  30. <param name="movie" value="http://www.youtube.com/v/D99LfOF3qis&hl=fr_FR&fs=1&">
  31. <param name="allowFullScreen" value="true">
  32. <param name="allowscriptaccess" value="always">
  33. <embed src="http://www.youtube.com/v/D99LfOF3qis&hl=fr_FR&fs=1&" type="application/x-shockwave-flash" allowscriptaccess="always" allowfullscreen="true" width="480" height="385"></object>
  34. </div>
  35. <li><a id="options">Options description</a>
  36. <p>You can customize the way SingleFile process a document through the options page. Right-click on SingleFile icon <img src="../resources/icon_48.png" id="icon"> in the
  37. Chrome toolbar and select "Options" in the context menu to open the options page.</p>
  38. <div class="screenshot"></div>
  39. <p>Details :</p>
  40. <ul>
  41. <li><span class="option">remove frames</span>
  42. <p>Remove all frames on the page</p>
  43. <p>You can enable this option if the file size is too large when disabled or to remove some ads. You should enable this option to view saved pages on IE8.</p>
  44. <p class="notice">It is recommended to <u>disable</u> this option unless you want to open saved pages in IE8.</p>
  45. </li>
  46. <li><span class="option">remove scripts</span>
  47. <p>Remove all javascript scripts</p>
  48. <p>Most of the time, you don't need javascript into the saved page. If you want to save the dynamic behavior of the document, you may need to disable this option.
  49. Nevertheless it may not work or document can be altered when opening the saved file.<br>
  50. It is strongly recommended to enable <span class="option">process raw document</span> if you disable this option.</p>
  51. <p class="notice">It is recommended to <u>enable</u> this option</p>
  52. </li>
  53. <li><span class="option">remove objects</span>
  54. <p>Remove all objects</p>
  55. <p>Remove all non embeddable elements : flash objects, java applets ...</p>
  56. <p class="notice">It is recommended to <u>enable</u> this option if you want to read the saved page offline</p>
  57. </li>
  58. <li><span class="option">remove hidden elements</span>
  59. <p>Remove all hidden elements</p>
  60. <p>Remove all document hidden elements (<code>visibility = "hidden"</code>&nbsp;or&nbsp;<code>display = "none"</code>&nbsp;or&nbsp;<code>opacity = "0"</code> CSS property
  61. values). This option may alter the document but can considerably reduce the saved file size.</p>
  62. <p class="notice">It is recommended to <u>disable</u> this option unless the saved file size is too large</p>
  63. </li>
  64. <li><span class="option">remove unused CSS rules</span>
  65. <p>Remove all CSS rules that do not match any element</p>
  66. <p>This option may alter the document but can considerably reduce the saved file size. If you enable this option, it may introduce some incompatibilities issues in the saved
  67. page when opening it into another browser (i.e. not based on Webkit).</p>
  68. <p class="notice">It is recommended to <u>disable</u> this option unless the saved file size is too large or you do not want to open the saved page into another browser</p>
  69. </li>
  70. <li><span class="option">scrapbook the page</span>
  71. <p>Send the archived page to <a href="https://chrome.google.com/webstore/detail/ihkkeoeinpbomhnpkmmkpggkaefincbn">Scrapbook for SingleFile</a></p>
  72. <p>This option allows to use SingleFile action icon as a shortcut to send the viewed page to <a
  73. href="https://chrome.google.com/webstore/detail/ihkkeoeinpbomhnpkmmkpggkaefincbn">Scrapbook for SingleFile</a> extension.</p>
  74. <p class="notice">It is recommended to <u>disable</u> this option unless you want to use SingleFile icon to scrapbook pages</p>
  75. </li>
  76. <li><span class="option">process in background</span>
  77. <p>Process the page in background</p>
  78. <p>Processing in background means it won't be blocking (*). If you disable this option, a shadow will prevent you to use the page during the SingleFile processing but
  79. processing will be faster.</p>
  80. <p class="notice">It is recommended to <u>disable</u> this option unless <span class="option">display processed page</span> option is disabled</p>
  81. </li>
  82. <li><span class="option">save processed page (*)</span>
  83. <p>Save the page on filesystem</p>
  84. <p>If you enable this option, documents will be automatically saved on filesystem. See <a href="#folder">Saved archives folder</a> for more details.</p>
  85. <p class="notice">It is recommended to <u>disable</u> this option unless you want files to be automatically saved</p>
  86. </li>
  87. <li><span class="option">display processed page (*)</span>
  88. <p>Display the processed page in the tab</p>
  89. <p>This option must be enabled if you want to use Chrome "Save as" dialog box to save the processed page.<br>
  90. You should enable <span class="option">process in background</span> when this option is disabled so the processing won't be blocking. Conversely, you should disable <span
  91. class="option">process in background</span> when this option is enabled so the processing will be faster.</p>
  92. <p class="notice">It is recommended to <u>enable</u> this option</p>
  93. </li>
  94. <li><span class="option">max filename length (*)</span>
  95. <p>Maximum filename length</p>
  96. <p>Since filesystem restricts filename length and the extension cannot guess this value, you can set it to the maximum allowed by your Operating System.</p>
  97. <p class="notice">It is recommended to set this option to <u>90</u> if you are using Windows</p>
  98. </li>
  99. <li><span class="option">process raw document</span>
  100. <p>Process the raw downloaded document</p>
  101. <p>This option allows SingleFile to process the downloaded document instead of the displayed document. The main difference is that scripts won't be parsed and executed.
  102. Frames won't be embedded too.</p>
  103. <p class="notice">It is recommended to <u>disable</u> this option unless <span class="option">remove scripts</span> is disabled</p>
  104. </li>
  105. <li><span class="option">Reset to default options</span>
  106. <p>Reset all the options to default state</p>
  107. </li>
  108. </ul>
  109. </li>
  110. <li><a id="folder">Saved archives folder (*)</a>
  111. <p>When <span class="option">save processed page</span> is enabled, pages will be automatically saved on filesystem. However, Chrome will not allow to choose the root folder
  112. where archives are stored. Neither it will allow SingleFile to make links pointing to saved files folder. So you have to find "manually" this folder.</p>
  113. <p>Files are saved in the extension subfolder of "FileSystem" folder located into Chrome user data folder:</p>
  114. <ul style="text-align: left">
  115. <li>Windows default path: <br>
  116. <span class="option">%LOCALAPPDATA%\Google\Chrome\User&nbsp;Data\Default\FileSystem\chrome-extension_jemlklgaibiijojffihnhieihhagocma_0\Persistent\</span></li>
  117. <li>Linux default path: <br>
  118. <span class="option">~/.config/google-chrome/Default/FileSystem/chrome-extension_jemlklgaibiijojffihnhieihhagocma_0/Persistent/</span></li>
  119. <li>Mac OS X default path: <br>
  120. <span class="option">~/Library/Application&nbsp;Support/Google/Chrome/Default/FileSystem/chrome-extension_jemlklgaibiijojffihnhieihhagocma_0/Persistent/</span></li>
  121. </ul>
  122. <p>You can create shortcuts to access to this folder easily.
  123. <p>
  124. <p>You can also create symbolic links in order to use sync services like dropbox. Here are the way of doing it on <a
  125. href="http://technet.microsoft.com/en-us/library/cc753194(WS.10).aspx">windows (mklink /d)</a> and <a href="http://www.unixtutorial.org/commands/ln/">linux or Mac OS X (ln
  126. -s)</a>.</p>
  127. <p>You can also change Chrome user data folder with <a href="http://www.chromium.org/user-experience/user-data-directory">--user-data-dir switch</a>.
  128. </li>
  129. <li><a id="notes">Technical notes</a>
  130. <ul>
  131. <li>all images are converted into <a href="http://en.wikipedia.org/wiki/Base64">base64</a></li>
  132. <li>frame document contents and automatically saved pages (*) are encoded with <a href="http://en.wikipedia.org/wiki/Utf_8">utf-8 charset</a></li>
  133. <li>encoded contents are injected in the document using <a href="http://en.wikipedia.org/wiki/Data_URI_scheme">data URI scheme</a></li>
  134. <li>data URI scheme is supported by the following web browsers: Chrome, Firefox, Opera, Safari, Konqueror and Internet Explorer 8 (limited support: data URIs must be
  135. smaller than 32 KB, embedded frames are not supported)</li>
  136. <li>SVG images are supported (SVG document is converted into utf-8 but is not processed)</li>
  137. </ul>
  138. </li>
  139. <li><a id="knownIssues">Known issues</a>
  140. <ul>
  141. <li>SVG images without src attribute or with empty src attribute are not embedded</li>
  142. </ul>
  143. </li>
  144. <li><a id="unknownIssues">Unknown issues</a>
  145. <p>If you find an unknown issue (i.e. frozen process, extra saved files, blank or altered document, tab crash...):</p>
  146. <ul>
  147. <li>reset options</li>
  148. <li>disable all other extensions to see if there is a conflict</li>
  149. <li>if there is a conflict, try to determine against which extension(s)</li>
  150. </ul>
  151. <p>Report the issue <a href="https://chrome.google.com/webstore/detail/mpiodijhokgodhhofbcjdecpffjipkle">here</a> with a short description, URL(s), Chrome version, OS version</p>
  152. </li>
  153. </ol>
  154. <br>
  155. <p class="availability">*: feature only available on Chrome 9+</p>
  156. <a href="http://www.w3.org/html/logo/"> <img src="../resources/html5-badge-h-storage.png" alt="HTML5 offline & storage logo" id="logo-html5"
  157. title="This extension is powered by HTML5 Offline & Storage"> </a></div>
  158. </body>
  159. </html>