help.html 8.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227
  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>SingleFile</h2>
  12. <h4>Save a complete page into a single HTML file</h4>
  13. </div>
  14. <span id="index">
  15. <a href="#instructions">Instructions</a> -
  16. <a href="#options">Options description</a> -
  17. <a href="#notes">Technical notes</a> -
  18. <a href="#unknownIssues">Unknown issues</a>
  19. </span>
  20. <hr>
  21. <ol>
  22. <li>
  23. <a id="instructions">Instructions</a>
  24. <ul>
  25. <li>wait until the page is fully loaded: you may need to scroll down the entire page to be sure all elements are loaded</li>
  26. <li>click on the SingleFile button
  27. <img src="../resources/icon_16.png" class="icon"> in the extension toolbar</li>
  28. </ul>
  29. <p>Additional notes:</p>
  30. <ul>
  31. <li>You can select multiple tabs and save them by clicking on the SingleFile button
  32. <img src="../resources/icon_16.png" class="icon">.</li>
  33. </ul>
  34. </li>
  35. <li>
  36. <a id="options">Options description</a>
  37. <p>You can customize the way SingleFile process a document through the options page. Right-click on SingleFile button
  38. <img src="../resources/icon_16.png" class="icon"> in the browser toolbar and select "Options" in the context menu to open the options page.</p>
  39. <p>Details :</p>
  40. <ul>
  41. <li>
  42. <span class="option">add entry in the context menu</span>
  43. <p>Check this option to display an entry in the context menu of the webpage to save the entire page or the selected part.
  44. </p>
  45. <p class="notice">It is recommended to
  46. <u>check</u> this option</p>
  47. </li>
  48. <li>
  49. <span class="option">overlay a shadow on the page during processing</span>
  50. <p>Check this option to overlay a shadow on the page when SingleFile is retrieving page resources. This reminds you that
  51. you should not close the tab.
  52. </p>
  53. <p class="notice">It is recommended to
  54. <u>check</u> this option</p>
  55. </li>
  56. <li>
  57. <span class="option">display an infobar when viewing archives</span>
  58. <p>Check this option to display the ❔ button at the top right of the page when viewing a saved page. By clicking this
  59. icon, you can get more information about the saved date and open the original URL.
  60. </p>
  61. <p class="notice">It is recommended to
  62. <u>check</u> this option</p>
  63. </li>
  64. <li>
  65. <span class="option">display stats in the console after processing</span>
  66. <p>Check this option to display stats about processing in the JavaScript developer tools of your browser. Checking this
  67. option may increase the time needed to process a page.
  68. </p>
  69. <p class="notice">It is recommended to
  70. <u>uncheck</u> this option</p>
  71. </li>
  72. <li>
  73. <span class="option">append the save date to the file name</span>
  74. <p>Check this option to append the save date of the webpage to the file name.
  75. </p>
  76. <p class="notice">It is recommended to
  77. <u>check</u> this option</p>
  78. </li>
  79. <li>
  80. <span class="option">enter file name before saving the page</span>
  81. <p>Check this option to display a prompt asking you to enter the file name of the saved page.
  82. </p>
  83. <p class="notice">It is recommended to
  84. <u>uncheck</u> this option</p>
  85. </li>
  86. <li>
  87. <span class="option">save pages in background</span>
  88. <p>Uncheck this option if you get invalid file names like "37bec68b-446a-46a5-8642-19a89c231b46.html" when saving pages.
  89. </p>
  90. <p class="notice">It is recommended to
  91. <u>check</u> this option</p>
  92. </li>
  93. <li>
  94. <span class="option">compress HTML</span>
  95. <p>Check this option to remove all HTML comments, and unneeded spaces or returns. This helps to reduce the size of the
  96. file without altering the document.</p>
  97. <p class="notice">It is recommended to
  98. <u>check</u> this option</p>
  99. </li>
  100. <li>
  101. <span class="option">remove HTML import</span>
  102. <p>Check this option to remove all link elements used to import HTML documents. This can reduce the size of the file without
  103. altering the document most of the time.</p>
  104. <p class="notice">It is recommended to
  105. <u>check</u> this option</p>
  106. </li>
  107. <li>
  108. <span class="option">remove frames</span>
  109. <p>Check this option to remove all frame and iframe elements. This can considerably reduce the size of the file without
  110. altering the document most of the time.</p>
  111. <p class="notice">It is recommended to
  112. <u>check</u> this option</p>
  113. </li>
  114. <li>
  115. <span class="option">remove hidden elements</span>
  116. <p>Check this option to remove all hidden elements. This option can considerably reduce the size of the file without altering
  117. the document most of the time.</p>
  118. <p class="notice">It is recommended to
  119. <u>check</u> this option</p>
  120. </li>
  121. <li>
  122. <span class="option">save raw page</span>
  123. <p>Check this option to save the page without interpreting JavaScript. Checking this option may alter the document.</p>
  124. <p class="notice">It is recommended to
  125. <u>uncheck</u> this option</p>
  126. </li>
  127. <li>
  128. <span class="option">remove scripts</span>
  129. <p>Check this option to remove all scripts. Unchecking this option may alter the document.</p>
  130. <p class="notice">It is recommended to
  131. <u>check</u> this option</p>
  132. </li>
  133. <li>
  134. <span class="option">remove video sources</span>
  135. <p>Check this option to empty the "src" attribute of all video elements.</p>
  136. <p class="notice">It is recommended to
  137. <u>check</u> this option</p>
  138. </li>
  139. <li>
  140. <span class="option">remove audio sources</span>
  141. <p>Check this option to empty the "src" attribute of all audio elements.</p>
  142. <p class="notice">It is recommended to
  143. <u>check</u> this option</p>
  144. </li>
  145. <li>
  146. <span class="option">compress CSS</span>
  147. <p>Check this option to minify CSS stylesheets. This helps to reduce the size of the file without altering the document.</p>
  148. <p class="notice">It is recommended to
  149. <u>check</u> this option</p>
  150. </li>
  151. <li>
  152. <span class="option">remove unused CSS rules</span>
  153. <p>Check this option to remove all CSS rules that do not match any element. Checking this this option should not alter
  154. the document and can considerably reduce the size of the file.</p>
  155. <p class="notice">It is recommended to
  156. <u>check</u> this option</p>
  157. </li>
  158. <li>
  159. <span class="option">save lazy loaded images</span>
  160. <p>Check this option to save all the lazy loaded images that are not displayed. This may help to save all the images without
  161. scrolling the page. This feature is not guaranteed to work on all sites.</p>
  162. <p class="notice">It is recommended to
  163. <u>check</u> this option</p>
  164. </li>
  165. <li>
  166. <span class="option">set a maximum size for embedded resources (Mb)</span>
  167. <p>Specify the maximum size of embedded resources (i.e. images, stylesheets, scripts and iframes) in megabytes.
  168. </p>
  169. </li>
  170. <li>
  171. <span class="option">Reset to default options</span>
  172. <p>Reset all the options to their default value.</p>
  173. </li>
  174. </ul>
  175. </li>
  176. <li>
  177. <a id="notes">Technical notes</a>
  178. <ul>
  179. <li>all images are converted into
  180. <a href="http://en.wikipedia.org/wiki/Base64">base64</a>
  181. </li>
  182. <li>resources are injected in the document using
  183. <a href="http://en.wikipedia.org/wiki/Data_URI_scheme">data URI scheme</a>
  184. </li>
  185. <li>data URI scheme is supported by all modern browsers.</li>
  186. </ul>
  187. </li>
  188. <li>
  189. <a id="unknownIssues">Unknown issues</a>
  190. <p>If you find an unknown issue (i.e. frozen process, extra saved files, blank or altered document, tab crash...):</p>
  191. <ul>
  192. <li>reset SingleFile options</li>
  193. <li>if resetting options did not work, try to disable all other extensions to see if there is a conflict</li>
  194. <li>if there is a conflict then try to determine against which extension(s)</li>
  195. <li>please report the issue
  196. <a href="https://github.com/gildas-lormeau/SingleFile/issues">here</a> with a short description describing how to reproduce the issue, Browser version, OS name and version.</li>
  197. </ul>
  198. </li>
  199. </ol>
  200. </div>
  201. </body>
  202. </html>