1
0

help.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410
  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. <meta name="viewport" content="width=device-width,initial-scale=1">
  8. </head>
  9. <body>
  10. <div>
  11. <div id="titleBorder">
  12. <h2>SingleFile</h2>
  13. <h4>Save a complete page into a single HTML file</h4>
  14. </div>
  15. <span id="index">
  16. <a href="#getting-started">Getting started</a> -
  17. <a href="#general-notes">Additional notes</a> -
  18. <a href="#options">Options description</a> -
  19. <a href="#notes">Technical notes</a> -
  20. <a href="#known-issues">Known issues</a> -
  21. <a href="#unknown-issues">Troubleshooting unknown issues</a>
  22. </span>
  23. <hr>
  24. <ol>
  25. <li>
  26. <a id="getting-started">Getting started</a>
  27. <ul>
  28. <li>Wait until the page is fully loaded, you may need to scroll down the entire page to be sure all elements are
  29. loaded.</li>
  30. <li>Click on the SingleFile button
  31. <img src="../resources/icon_16.png" class="icon"> in the extension toolbar to save the page.</li>
  32. </ul>
  33. </li>
  34. <li>
  35. <a id="general-notes">Additional notes</a>
  36. <ul>
  37. <li>To save multiple tabs, select them first and click on the SingleFile button
  38. <img src="../resources/icon_16.png" class="icon">.</li>
  39. <li>
  40. Open the context menu by right-clicking the SingleFile button
  41. <img src="../resources/icon_16.png" class="icon"> in the extension toolbar or on the webpage. It allows you to
  42. save:
  43. <ul>
  44. <li>the current tab,</li>
  45. <li>or the selected content,</li>
  46. <li>or the selected frame.</li>
  47. </ul>
  48. </li>
  49. <li>
  50. You can also process multiple tabs in one click and save:
  51. <ul>
  52. <li>selected tabs,</li>
  53. <li>or unpinned tabs,</li>
  54. <li>or all tabs.</li>
  55. </ul>
  56. </li>
  57. <li>
  58. The context menu also allows you to activate the auto-save of:
  59. <ul>
  60. <li>the current tab,</li>
  61. <li>or unpinned tabs,</li>
  62. <li>or all tabs.</li>
  63. </ul>
  64. </li>
  65. <li>With auto-save active, pages are automatically saved every time after being loaded (or before being unloaded
  66. if
  67. not).
  68. </li>
  69. <li>Right-click on the SingleFile button and select "Options" to open the options page.</li>
  70. <li>You can use the shortcut Ctrl+Shift+X to save current or selected tabs in Chrome. Go to
  71. <a href="chrome://extensions/shortcuts">chrome://extensions/shortcuts</a> to change it.</li>
  72. </ul>
  73. </li>
  74. <li>
  75. <a id="options">Options description</a>
  76. <p>You can customize SingleFile through the options page. Right-click on SingleFile button
  77. <img src="../resources/icon_16.png" class="icon"> in the browser toolbar and select "Options"/"Manage extension"
  78. in
  79. the context menu to open the options page.</p>
  80. <p>User interface</p>
  81. <ul>
  82. <li>
  83. <span class="option">add entry in the context menu of the webpage</span>
  84. <p>Check this option to display an entry for SingleFile in the context menu of the webpage. The context menu of
  85. the
  86. SingleFile button
  87. <img src="../resources/icon_16.png" class="icon"> in the extension toolbar is displayed wether this option is
  88. checked
  89. or not.
  90. </p>
  91. <p class="notice">It is recommended to
  92. <u>check</u> this option</p>
  93. </li>
  94. <li>
  95. <span class="option">overlay a shadow on the page during processing</span>
  96. <p>Check this option to overlay a shadow on the page when SingleFile is retrieving page resources. This reminds
  97. you
  98. that you should not close the tab.
  99. </p>
  100. <p class="notice">It is recommended to
  101. <u>check</u> this option</p>
  102. </li>
  103. <li>
  104. <span class="option">display an infobar when viewing archives</span>
  105. <p>Check this option to display the ❔ button at the top right of the page when viewing a saved page. By clicking
  106. this
  107. icon, you can get more information about the saved date and open the original URL.
  108. </p>
  109. <p class="notice">It is recommended to
  110. <u>check</u> this option</p>
  111. </li>
  112. </ul>
  113. <p>File name</p>
  114. <ul>
  115. <li>
  116. <span class="option">append the save date to the file name</span>
  117. <p>Check this option to append the save date of the webpage to the file name.
  118. </p>
  119. <p class="notice">It is recommended to
  120. <u>check</u> this option</p>
  121. </li>
  122. <li>
  123. <span class="option">open the "Save as" dialog to confirm the file name</span>
  124. <p>Check this option to display the "Save as" dialog in order to confirm the file name before saving the page. If
  125. the
  126. option "save pages in background" is unchecked then a prompt dialog will be displayed instead of the "Save as"
  127. dialog.
  128. </p>
  129. <p class="notice">It is recommended to
  130. <u>uncheck</u> this option</p>
  131. </li>
  132. </ul>
  133. <p>HTML content</p>
  134. <ul>
  135. <li>
  136. <span class="option">compress HTML</span>
  137. <p>Check this option to remove all HTML comments, and unneeded spaces or returns. This helps to reduce the size
  138. of
  139. the file without altering the document.</p>
  140. <p class="notice">It is recommended to
  141. <u>check</u> this option</p>
  142. </li>
  143. <li>
  144. <span class="option">remove HTML import</span>
  145. <p>Check this option to remove all link elements used to import HTML documents. This can reduce the size of the
  146. file
  147. without altering the document most of the time.</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 frames</span>
  153. <p>Check this option to remove all frame and iframe elements. This can considerably reduce the size of the file
  154. without
  155. altering the document most of the time. Checking this this option option may also increase the time needed to
  156. save
  157. a page</p>
  158. <p class="notice">It is recommended to
  159. <u>check</u> this option</p>
  160. </li>
  161. <li>
  162. <span class="option">remove hidden elements</span>
  163. <p>Check this option to remove all hidden elements. This option can considerably reduce the size of the file
  164. without
  165. altering the document most of the time.</p>
  166. </li>
  167. </ul>
  168. <p>Images</p>
  169. <ul>
  170. <li>
  171. <span class="option">save lazy loaded images</span>
  172. <p>Check this option to save all the lazy loaded images that are not displayed. This may help to save all the
  173. images
  174. without scrolling the page. This feature is not guaranteed to work on all sites.</p>
  175. <p class="notice">It is recommended to
  176. <u>check</u> this option</p>
  177. </li>
  178. <li>
  179. <span class="option">remove images for alternative resolutions</span>
  180. <p>Check this option to remove images that are alternatives in lower and/or higher resolutions to the ones
  181. displayed
  182. by default. Checking this this option can considerably reduce the size of the file in some cases.</p>
  183. </li>
  184. </ul>
  185. <p>Stylesheets</p>
  186. <ul>
  187. <li>
  188. <span class="option">compress CSS</span>
  189. <p>to minify CSS stylesheets. This the size of the file without altering the
  190. document.
  191. It also prevents images from being saved several times by using CSS variables.
  192. </p>
  193. <p class="notice">It is recommended to
  194. <u>check</u> this option</p>
  195. </li>
  196. <li>
  197. <span class="option">remove unused styles</span>
  198. <p>Check this option to remove all CSS rules and styles that do not match any element. Checking this this option
  199. should
  200. not alter the document and can considerably reduce the size of the file. Checking this this option option may
  201. also
  202. increase the CPU consumption and the time needed to save a page.</p>
  203. <p class="notice">It is recommended to
  204. <u>check</u> this option</p>
  205. </li>
  206. <li>
  207. <span class="option">remove alternative fonts to woff/otf and unused font rules</span>
  208. <p>Check this option to remove fonts that are alternatives to the Web Open Font or OpenType formats, and CSS font
  209. rules
  210. that are not used. Checking this this option should not alter the document and can considerably reduce the size
  211. of
  212. the file in some cases.</p>
  213. <p class="notice">It is recommended to
  214. <u>check</u> this option</p>
  215. </li>
  216. <li>
  217. <span class="option">remove stylesheets for alternative devices</span>
  218. <p>Check this option to remove stylesheets that are not used for the screen display like stylesheets for print
  219. preview
  220. and speech synthesizers. Checking this this option can reduce the size of the file.</p>
  221. </li>
  222. </ul>
  223. <p>Other resources</p>
  224. <ul>
  225. <li>
  226. <span class="option">remove scripts</span>
  227. <p>Check this option to remove all scripts. Unchecking this option may alter the document and lead to security
  228. issues.</p>
  229. <p class="notice">It is recommended to
  230. <u>check</u> this option</p>
  231. </li>
  232. <li>
  233. <span class="option">remove video sources</span>
  234. <p>Check this option to empty the "src" attribute of all video elements.</p>
  235. <p class="notice">It is recommended to
  236. <u>check</u> this option</p>
  237. </li>
  238. <li>
  239. <span class="option">remove audio sources</span>
  240. <p>Check this option to empty the "src" attribute of all audio elements.</p>
  241. <p class="notice">It is recommended to
  242. <u>check</u> this option</p>
  243. </li>
  244. </ul>
  245. <p>Auto-save</p>
  246. <ul>
  247. <li>
  248. <span class="option">auto-save on page load or unload</span>
  249. <p>Check this option to auto-save pages after being loaded. If you browse to another page before the page is
  250. fully
  251. loaded then the page will be saved just before being unloaded. With this option active, you are guaranteed pages
  252. will
  253. always be saved but some frame contents may be missing (if you unchecked "remove frames") when pages are saved
  254. before
  255. being unloaded.
  256. </p>
  257. <p class="notice">It is recommended to
  258. <u>check</u> this option</p>
  259. </li>
  260. <li>
  261. <span class="option">auto-save on page load</span>
  262. <p>Check this option to auto-save pages after being loaded.</p>
  263. </li>
  264. <li>
  265. <span class="option">auto-save on page unload</span>
  266. <p>Check this option to auto-save pages before being unloaded instead of saving pages after being loaded. With
  267. this
  268. option active, you are guaranteed pages will always be saved but some frame contents may be missing (if you
  269. unchecked
  270. "remove frames").
  271. </p>
  272. </li>
  273. <li>
  274. <span class="option">auto-save wait delay after load (sec.)</span>
  275. <p>Specify the amount of time in seconds to wait before saving a page when the "auto-save on page load or on page
  276. unload"
  277. or "auto-save on page load" is checked.
  278. </p>
  279. </li>
  280. </ul>
  281. <p>Misc.</p>
  282. <ul>
  283. <li>
  284. <span class="option">save pages in background</span>
  285. <p>Uncheck this option if you get invalid file names like "37bec68b-446a-46a5-8642-19a89c231b46.html" or
  286. interrupted downloads
  287. when saving pages or if you prefer to use the prompt dialog instead of the "Save as" dialog when "open the 'Save
  288. as' dialog
  289. to confirm the file name" option is checked.
  290. </p>
  291. <p class="notice">It is recommended to
  292. <u>check</u> this option</p>
  293. </li>
  294. <li>
  295. <span class="option">display stats in the console after processing</span>
  296. <p>Check this option to display stats about processing in the JavaScript developer tools of your browser.
  297. Checking
  298. this option may increase the CPU consumption and the time needed to save a page.
  299. </p>
  300. <p class="notice">It is recommended to
  301. <u>uncheck</u> this option</p>
  302. </li>
  303. <li>
  304. <span class="option">set a maximum size for embedded resources (Mb)</span>
  305. <p>Specify the maximum size of embedded resources (i.e. images, stylesheets, scripts and iframes) in megabytes.
  306. </p>
  307. </li>
  308. <li>
  309. <span class="option">save raw page</span>
  310. <p>Check this option to save the page without interpreting JavaScript. Checking this option may alter the
  311. document.</p>
  312. <p class="notice">It is recommended to
  313. <u>uncheck</u> this option</p>
  314. </li>
  315. </ul>
  316. <p>Form buttons</p>
  317. <ul>
  318. <li>
  319. <span class="option">Reset</span>
  320. <p>Reset all the options to their default value.</p>
  321. </li>
  322. </ul>
  323. </li>
  324. <li>
  325. <a id="notes">Technical notes</a>
  326. <ul>
  327. <li>All images are converted into
  328. <a href="http://en.wikipedia.org/wiki/Base64">base64</a>.
  329. </li>
  330. <li>All resources except frame contents are injected in the document using
  331. <a href="http://en.wikipedia.org/wiki/Data_URI_scheme">data URI scheme</a>.
  332. </li>
  333. <li>Frame contents are injected as text in the document by using the srcdoc attribute.
  334. </li>
  335. </ul>
  336. </li>
  337. <li>
  338. <a id="known-issues">Known issues</a>
  339. <ul>
  340. <li>
  341. All browsers
  342. <ul>
  343. <li>For security reasons, you cannot save pages hosted on https://chrome.google.com or
  344. https://addons.mozilla.org.</li>
  345. </ul>
  346. </li>
  347. <li>
  348. Chrome/Opera
  349. <ul>
  350. <li>You must enable the option "Allow access to file URLs" in the extension page to display the infobar when
  351. viewing
  352. a saved page, or to save a page stored on the filesystem.</li>
  353. </ul>
  354. </li>
  355. <li>
  356. Firefox
  357. <ul>
  358. <li>You cannot save selected tabs via the context menu because it is not possible to select multiple tabs.</li>
  359. </ul>
  360. </li>
  361. <li>
  362. Edge
  363. <ul>
  364. <li>The file name looks like "4e5a13fd-6638-4a37-a34b-a3c104ac66b1".</li>
  365. </ul>
  366. </li>
  367. </ul>
  368. </li>
  369. <li>
  370. <a id="unknown-issues">Troubleshooting unknown issues</a>
  371. <p>Please follow these steps if you find an unknown issue:</p>
  372. <ul>
  373. <li>Reset SingleFile options.</li>
  374. <li>If resetting options did not fix the issue, try to disable all other extensions to see if there is a conflict.</li>
  375. <li>If there is a conflict then try to determine against which extension(s).</li>
  376. <li>Please report the issue
  377. <a href="https://github.com/gildas-lormeau/SingleFile/issues">here</a> with a short description describing how to
  378. reproduce
  379. the issue, Browser version, OS name and version.</li>
  380. </ul>
  381. <p>Suggestions are welcome :)</p>
  382. </li>
  383. </ol>
  384. </div>
  385. </body>
  386. </html>