help.html 43 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738
  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> <span id="index"> <a href="#getting-started">Getting started</a> - <a href="#general-notes">Additional
  15. notes</a> - <a href="#options">Options description</a> - <a href="#annotation-editor">Annotation
  16. editor</a> - <a href="#notes">Technical notes</a> - <a href="#template-variables">Template variables</a>
  17. - <a href="#known-issues">Known issues</a> - <a href="#unknown-issues">Troubleshooting unknown issues</a> -
  18. <a href="#contributors">Contributors</a> </span>
  19. <hr>
  20. <ol>
  21. <li><a id="getting-started">Getting started</a>
  22. <ul>
  23. <li>Wait until the page is fully loaded.</li>
  24. <li>Click on the SingleFile button <img src="../resources/icon_16.png" class="icon"> in the
  25. extension toolbar to process and save the page.</li>
  26. <li>You can click again on the button to cancel the action when processing a page.</li>
  27. </ul>
  28. </li>
  29. <li><a id="general-notes">Additional notes</a>
  30. <ul>
  31. <li>To save multiple tabs, select them first and click on the SingleFile button <img
  32. src="../resources/icon_16.png" class="icon">.</li>
  33. <li>Open the context menu by right-clicking the SingleFile button <img
  34. src="../resources/icon_16.png" class="icon"> in the extension toolbar or on the webpage. It
  35. allows you to save: <ul>
  36. <li>the current tab,</li>
  37. <li>or the selected content,</li>
  38. <li>or the selected frame.</li>
  39. </ul>
  40. </li>
  41. <li>You can also process multiple tabs in one click and save: <ul>
  42. <li>the selected tabs,</li>
  43. <li>or the unpinned tabs,</li>
  44. <li>or all the tabs.</li>
  45. </ul>
  46. </li>
  47. <li>The context menu also allows you to activate the auto-save of: <ul>
  48. <li>the current tab,</li>
  49. <li>or the unpinned tabs,</li>
  50. <li>or all the tabs.</li>
  51. </ul>
  52. </li>
  53. <li>You can highlight text, add notes, format and remove content before saving the page with the <a
  54. href="#annotation-editor">Annotation editor</a> by selecting "Annotate and save the page..."
  55. in the context menu</li>
  56. <li>With auto-save active, pages are automatically saved every time after being loaded (or before
  57. being unloaded if not). </li>
  58. <li>Select "Save Selection" from the context menu without selecting any content first to display a
  59. selector that will help you choose content by hovering over it with the mouse.</li>
  60. <li>Right-click on the SingleFile button and select "Options" to open the options page.</li>
  61. <li>Enable the option "Destination &gt; upload to Google Drive" to upload pages to Google Drive</li>
  62. <li>You can use the customizable shortcut Ctrl+Shift+Y to save the current tab or the selected tabs.
  63. Go to about:addons and select "Manage extension shortcuts" in the cogwheel menu to change it in
  64. Firefox. Go to chrome://extensions/shortcuts to change it in Chrome..</li>
  65. <li>The default save folder is the download folder configured in your browser, cf. about:preferences
  66. in Firefox and chrome://settings in Chrome.</li>
  67. </ul>
  68. </li>
  69. <li><a id="options">Options description</a>
  70. <p>You can customize SingleFile through the options page. Right-click on SingleFile button <img
  71. src="../resources/icon_16.png" class="icon"> in the browser toolbar and select "Options"/"Manage
  72. extension" in the context menu to open the options page.</p>
  73. <p>Profiles</p>
  74. <ul>
  75. <li>
  76. <p>A profile is a set of user-defined options associated to a unique name.</p>
  77. <p>The drop-down list in the upper right of the options page allows you to select a profile and
  78. modify the associated options. The buttons next to the drop-down list allows you
  79. respectively to create, delete and rename a profile. </p>
  80. </li>
  81. <li>
  82. <p>You can select the default profile through the context menu of SingleFile. The selection is
  83. persistent and applied to all tabs. </p>
  84. </li>
  85. <li>
  86. <p>You can also override the default profile by associating a profile to a complete or partial
  87. URL. See the description of the <a href="#auto-settings-rules">Auto-settings rules</a>
  88. feature for more info. </p>
  89. </li>
  90. </ul>
  91. <p>User interface</p>
  92. <ul>
  93. <li data-options-label="addMenuEntryLabel"> <span class="option">Option: add entry in the context
  94. menu of the webpage</span>
  95. <p>Check this option to display an entry for SingleFile in the context menu of the webpage. The
  96. context menu of the SingleFile button <img src="../resources/icon_16.png" class="icon"> in
  97. the extension toolbar is displayed whether this option is checked or not. </p>
  98. <p class="notice">It is recommended to <u>check</u> this option</p>
  99. </li>
  100. <li data-options-label="shadowEnabledLabel"> <span class="option">Option: overlay a shadow on the
  101. page during processing</span>
  102. <p>Check this option to overlay a shadow on the page when SingleFile is retrieving page
  103. resources. This reminds you that you should not close the tab. </p>
  104. <p class="notice">It is recommended to <u>check</u> this option</p>
  105. </li>
  106. <li data-options-label="displayInfobarLabel"> <span class="option">Option: display an infobar when
  107. viewing a saved page</span>
  108. <p>Check this option to display the ℹ button at the top right of the page when viewing a saved
  109. page. By clicking this button, you can get more information about the saved date and open
  110. the original URL.</p>
  111. <p class="notice">It is recommended to <u>check</u> this option</p>
  112. </li>
  113. <li data-options-label="infobarTemplateLabel"> <span class="option">Option: template of the infobar
  114. content</span>
  115. <p>The template allows you to customize the content displayed in the infobar. You can use any
  116. valid character, <code>\n</code> for new lines or <code>\t</code> for tabs. You can also use
  117. any variables from <a href="#template-variables">this list</a> anywhere in the template. If
  118. the template or the resulting content is empty, the infobar will display the saved date by
  119. default. </p>
  120. <p>Template examples:</p>
  121. <ul>
  122. <li><code>{url-href} ({date-iso})</code> will produce contents like "https://www.example.com
  123. (2018-09-15 11 06 03 PM)".</li>
  124. <li><code>Title: {page-title}</code> will produce contents like "Title: Example Domain" for
  125. a page having "Example Domain" as title.</li>
  126. </ul>
  127. </li>
  128. <li data-options-label="confirmInfobarLabel"> <span class="option">Option: open a prompt dialog to
  129. edit the infobar content</span>
  130. <p>Check this option to display a prompt dialog in order to confirm the infobar content before
  131. saving the page. </p>
  132. </li>
  133. <li data-options-label="autoCloseLabel"> <span class="option">Option: auto-close the tab after the
  134. page is saved</span>
  135. <p>Check this option to automatically close the tab after saving the page displayed inside. </p>
  136. </li>
  137. </ul>
  138. <p>File name</p>
  139. <ul>
  140. <li data-options-label="filenameTemplateLabel"> <span class="option">Option: template</span>
  141. <p>The template allows you to customize the file name of saved pages. You can use any valid
  142. character and "/" to create sub-folders (with the option "save pages in background" active).
  143. You can also use any variables from <a href="#template-variables">this list</a> anywhere in
  144. the template.</p>
  145. <p>Invalid characters are automatically transformed and collapsed to underscores. File names
  146. cannot exceed 192 characters and are truncated if longer. The invalid characters are:
  147. <code>[</code> <code>~</code> <code>+</code> <code>\</code> <code>?</code> <code>%</code>
  148. <code>*</code> <code>:</code> <code>|</code> <code>"</code> <code>&lt;</code>
  149. <code>&gt;</code> and control characters from 0 to 31 in the ASCII table.</p>
  150. <p>Template examples:</p>
  151. <ul>
  152. <li><code>{page-title} ({date-iso} {time-locale}).html</code> will produce filenames like
  153. "Introduction to SingleFile (2018-09-15 11_06_03 PM).html" for a page having
  154. "Introduction to SingleFile" as title.</li>
  155. <li><code>archives/{url-last-segment} - {date-iso}</code> will produce filenames like
  156. "welcome - 2018-09-15" for a page hosted on https://example.com/welcome.html. The saved
  157. files will be saved in the sub-directory "archives".</li>
  158. <li><code>archives/{year-locale}/{month-locale}/{day-locale}/{page-title}.html</code> will
  159. produce filenames like "Introduction to SingleFile.html" stored into 3 sub-directories
  160. in the "archives" folder, one for each part of the save date (e.g.
  161. "2018/9/15/Introduction to SingleFile.html").</li>
  162. </ul>
  163. </li>
  164. <li data-options-label="filenameMaxLengthLabel"> <span class="option">Option: max length
  165. (bytes)</span>
  166. <p>Specify the maximum length in bytes of the filename.</p>
  167. </li>
  168. <li data-options-label="confirmFilenameLabel"> <span class="option">Option: open the "Save as"
  169. dialog to confirm the file name</span>
  170. <p>Check this option to display the "Save as" dialog in order to confirm the file name before
  171. saving the page. If the option "save pages in background" is unchecked then a prompt dialog
  172. will be displayed instead of the "Save as" dialog. </p>
  173. </li>
  174. <li data-options-label="filenameConflictActionLabel"> <span class="option">Option: file name
  175. conflict resolution</span>
  176. <p>Choose the most appropriate action when the filename of the saved page is conflicting with
  177. existing ones on the filesystem. The "skip duplicate files" action only detects duplicates
  178. among files downloaded during the current browsing session.</p>
  179. </li>
  180. </ul>
  181. <p>HTML content</p>
  182. <ul>
  183. <li data-options-label="compressHTMLLabel"> <span class="option">Option: compress HTML
  184. content</span>
  185. <p>Check this option to remove all HTML comments and unneeded tags, spaces, quotes and
  186. whitespace characters. Checking this option helps to reduce the size of the file without
  187. altering the document.</p>
  188. <p class="notice">It is recommended to <u>check</u> this option</p>
  189. </li>
  190. <li data-options-label="removeImportsLabel"> <span class="option">Option: remove HTML imports</span>
  191. <p>Check this option to remove all link elements used to import HTML documents. Checking this
  192. option can help to reduce the size of the file without altering the document.</p>
  193. <p class="notice">It is recommended to <u>check</u> this option</p>
  194. </li>
  195. <li data-options-label="removeHiddenElementsLabel"> <span class="option">Option: remove hidden
  196. elements</span>
  197. <p>Check this option to remove all hidden elements. Checking this option can help to reduce the
  198. size of the file without altering the document. It may also increase the CPU consumption and
  199. the time needed to save a page.</p>
  200. <p class="notice">It is recommended to <u>check</u> this option</p>
  201. </li>
  202. <li data-options-label="removeFramesLabel"> <span class="option">Option: remove frames</span>
  203. <p>Check this option to remove all frame and iframe elements. Checking this option can
  204. considerably reduce the size of the file without altering the document most of the time. It
  205. may also decrease the time needed to save a page.</p>
  206. </li>
  207. <li data-options-label="includeInfobarLabel">Option: include infobar in the saved page <p>Check this
  208. option to display the ℹ button at the top right of the page when viewing a saved page in a
  209. browser where SingleFile is not installed.</p>
  210. </li>
  211. <li data-options-label="saveRawPageLabel"> <span class="option">Option: save raw page</span>
  212. <p>Check this option to save the page without interpreting JavaScript. Checking this option may
  213. alter the document.</p>
  214. <p class="notice">It is recommended to <u>uncheck</u> this option</p>
  215. </li>
  216. </ul>
  217. <p>Stylesheets</p>
  218. <ul>
  219. <li data-options-label="removeUnusedStylesLabel"> <span class="option">Option: remove unused
  220. styles</span>
  221. <p>Check this option to remove all the CSS rules and styles that do not match any element in the
  222. saved page. Checking this option will not alter the document and can considerably reduce the
  223. size of the file. It will also increase the CPU consumption and the time needed to save a
  224. page.</p>
  225. <p class="notice">It is recommended to <u>check</u> this option</p>
  226. </li>
  227. <li data-options-label="removeAlternativeMediasLabel"> <span class="option">Option: remove
  228. stylesheets for alternative devices to screens</span>
  229. <p>Check this option to remove stylesheets that are not used for the screen display like
  230. stylesheets for print preview and speech synthesizers. Checking this option can help to
  231. reduce the size of the file.</p>
  232. </li>
  233. <li data-options-label="compressCSSLabel"> <span class="option">Option: compress CSS content</span>
  234. <p>Check this option to minify CSS stylesheets. Checking this option can reduce size of the file
  235. without altering the document. It may also increase the CPU consumption and the time needed
  236. to save a page.</p>
  237. <p class="notice">It is recommended to <u>uncheck</u> this option</p>
  238. </li>
  239. </ul>
  240. <p>Images</p>
  241. <ul>
  242. <li data-options-label="groupDuplicateImagesLabel"> <span class="option">Option: group duplicate
  243. images together</span>
  244. <p>Check this option to avoid saving multiple times duplicate images. Checking this option
  245. should not alter the document in modern browsers and can considerably reduce the size of the
  246. file.</p>
  247. <p class="notice">It is recommended to <u>check</u> this option</p>
  248. </li>
  249. <li data-options-label="loadDeferredImagesLabel"> <span class="option">Option: save deferred
  250. images</span>
  251. <p>Check this option to save all the deferred images that are not yet displayed. This may help
  252. to save all the images without scrolling the page. This feature does its best effort and is
  253. not guaranteed to work on all sites. It will also increase the time needed to save a page.
  254. </p>
  255. <p class="notice">It is recommended to <u>check</u> this option</p>
  256. </li>
  257. <li data-options-label="loadDeferredImagesMaxIdleTimeLabel"> <span class="option">Option: maximum
  258. idle time (ms)</span>
  259. <p>Specify the maximum delay of time to wait for deferred images. You can increase this value if
  260. for example the network or system conditions are degraded. You can also decrease this value
  261. otherwise.</p>
  262. </li>
  263. <li data-options-label="loadDeferredImagesKeepZoomLevelLabel"> <span class="option">Option: zoom out
  264. the page</span>
  265. <p>Check this option to save the entire content of a page by zooming out the page. This can help
  266. saving pages using infinite virtual lists for example. </p>
  267. <p class="notice">It is recommended to <u>uncheck</u> this option</p>
  268. </li>
  269. <li data-options-label="removeAlternativeImagesLabel"> <span class="option">Option: remove images
  270. for alternative screen resolutions</span>
  271. <p>Check this option to remove images that are alternatives in lower and/or higher resolutions
  272. to the ones displayed by default. Checking this option can considerably reduce the size of
  273. the file.</p>
  274. </li>
  275. </ul>
  276. <p>Fonts</p>
  277. <ul>
  278. <li data-options-label="removeUnusedFontsLabel"> <span class="option">Option: remove unused
  279. fonts</span>
  280. <p>Check this option to remove all font CSS rules that do not match any content. Checking this
  281. option should not alter the document and can considerably reduce the size of the file.</p>
  282. <p class="notice">It is recommended to <u>check</u> this option</p>
  283. </li>
  284. <li data-options-label="removeAlternativeFontsLabel"> <span class="option">Option: remove
  285. alternative fonts</span>
  286. <p>Check this option to remove fonts that are alternatives to the ones used. Checking this
  287. option should not alter the document and can considerably reduce the size of the file.</p>
  288. <p class="notice">It is recommended to <u>check</u> this option</p>
  289. </li>
  290. </ul>
  291. <p>Other resources</p>
  292. <ul>
  293. <li data-options-label="removeScriptsLabel"> <span class="option">Option: remove scripts</span>
  294. <p>Check this option to remove all the JavaScript scripts. Unchecking this option may alter the
  295. document and may introduce privacy or security issues.</p>
  296. <p class="notice">It is recommended to <u>check</u> this option</p>
  297. </li>
  298. <li data-options-label="removeVideoLabel"> <span class="option">Option: remove video sources</span>
  299. <p>Check this option to empty the "src" attribute of all video elements.</p>
  300. <p class="notice">It is recommended to <u>check</u> this option</p>
  301. </li>
  302. <li data-options-label="removeAudioLabel"> <span class="option">Option: remove audio sources</span>
  303. <p>Check this option to empty the "src" attribute of all audio elements.</p>
  304. <p class="notice">It is recommended to <u>check</u> this option</p>
  305. </li>
  306. </ul>
  307. <p>Destination</p>
  308. <ul>
  309. <li data-options-label="saveToFilesystemLabel"> <span class="option">Option: save to
  310. filesystem</span>
  311. <p>Check this option to save the downloaded page on the filesystem of your computer.</p>
  312. <p class="notice">It is recommended to <u>check</u> this option</p>
  313. </li>
  314. <li data-options-label="saveToClipboardLabel"> <span class="option">Option: copy to clipboard</span>
  315. <p>Check this option to copy the page to the clipboard.</p>
  316. <p class="notice">It is recommended to <u>uncheck</u> this option</p>
  317. </li>
  318. <li data-options-label="saveToGDriveLabel"> <span class="option">Option: upload to Google
  319. Drive</span>
  320. <p>Check this option to save the page on Google Drive.</p>
  321. <p>The permissions requested by SingleFile allow it to access only to the files and folders it
  322. has created. When you uncheck this option, SingleFile revokes automatically its access to
  323. your Google Drive account. </p>
  324. <p class="notice">It is recommended to <u>uncheck</u> this option</p>
  325. </li>
  326. </ul>
  327. <p>Annotation editor</p>
  328. <ul>
  329. <li data-options-label="defaultEditorModeLabel"> <span class="option">Option: default mode</span>
  330. <p>Select the default mode when opening the annotation editor. The available choices are:
  331. <ul>
  332. <li><code>normal</code>: default value</li>
  333. <li><code>edit the page</code>: enable the button <img
  334. src="../resources/button_note_edit.png" class="icon button"></li>
  335. <li><code>format the page</code>: enable the button <img
  336. src="../resources/button_note_format.png" class="icon button"> if the page can be
  337. formatted</li>
  338. <li><code>remove elements</code>: enable the button <img
  339. src="../resources/button_cut_inner.png" class="icon button"></li>
  340. <li><code>remove external elements</code>: enable the button <img
  341. src="../resources/button_cut_outer.png" class="icon button"></li>
  342. </ul>
  343. </p>
  344. </li>
  345. <li data-options-label="applySystemThemeLabel"> <span class="option">Option: apply the system theme
  346. when formatting a page in the annotation editor</span>
  347. <p>Uncheck this option if you do not want to apply the theme of the operating system or the
  348. browser (e.g. dark or light) when you click on the button "Format the page for better
  349. readability" in the annotation editor.</p>
  350. </li>
  351. <li data-options-label="warnUnsavedPageLabel"> <span class="option">Option: warn if leaving page
  352. with unsaved changes</span>
  353. <p>Check this option to display a blocking popup when you leave the annotation editor (e.g.
  354. close the tab) without saving the changes.</p>
  355. <p class="notice">It is recommended to <u>check</u> this option</p>
  356. </li>
  357. <li data-options-label="openEditorLabel"> <span class="option">Option: edit page before
  358. saving</span>
  359. <p>Check this option to open the annotation editor before saving any page. Checking this option
  360. removes the entry "Annotate and save the page..." from the context menu.</p>
  361. <p class="notice">It is recommended to <u>uncheck</u> this option</p>
  362. </li>
  363. <li data-options-label="autoOpenEditorLabel"> <span class="option">Option: open the annotation
  364. editor when viewing a page saved with SingleFile </span>
  365. <p>Check this option to open the annotation editor when displaying a page saved by SingleFile.
  366. </p>
  367. <p class="notice">It is recommended to <u>uncheck</u> this option</p>
  368. </li>
  369. </ul>
  370. <p>Bookmarks</p>
  371. <ul>
  372. <li data-options-label="saveCreatedBookmarksLabel"> <span class="option">Option: save the page of a
  373. newly created bookmark</span>
  374. <p>Check this option to save pages that you add into your bookmarks. Note that if the page is to
  375. be saved is not already displayed in a tab, SingleFile will open temporarily a new tab to
  376. save the page. </p>
  377. <p class="notice">It is recommended to <u>uncheck</u> this option</p>
  378. </li>
  379. <li data-options-label="replaceBookmarkURLLabel"> <span class="option">Option: link the new bookmark
  380. to the saved page</span>
  381. <p>Check this option to replace the URL of the page added into your bookmark with the file URI
  382. of the saved page on your disk. </p>
  383. <p class="notice">It is recommended to <u>uncheck</u> this option</p>
  384. </li>
  385. <li data-options-label="ignoredBookmarkFoldersLabel"> <span class="option">Option: ignored
  386. folders</span>
  387. <p>Enter a list of bookmark folder names to ignore. The folder names must be separated with a
  388. comma.
  389. </p>
  390. </li>
  391. </ul>
  392. <p>Auto-save</p>
  393. <ul>
  394. <li data-options-label="autoSaveLoadOrUnloadLabel"> <span class="option">Option: auto-save after
  395. page load or on page unload</span>
  396. <p>Check this option to auto-save pages after being loaded. If you browse to another page before
  397. the page is fully loaded then the page will be saved just before being unloaded. With this
  398. option active, you are guaranteed pages will always be saved. Some frame contents may be
  399. missing (if you unchecked "remove frames") when pages are saved before being unloaded. </p>
  400. </li>
  401. <li data-options-label="autoSaveLoadLabel"> <span class="option">Option: auto-save after page
  402. load</span>
  403. <p>Check this option to auto-save pages after being loaded.</p>
  404. </li>
  405. <li data-options-label="autoSaveUnloadLabel"> <span class="option">Option: auto-save on page
  406. unload</span>
  407. <p>Check this option to auto-save pages before being unloaded instead of saving pages after
  408. being loaded. With this option active, you are guaranteed pages will always be saved but
  409. some frame contents may be missing (if you unchecked "remove frames"). </p>
  410. </li>
  411. <li data-options-label="autoSaveDelayLabel"> <span class="option">Option: auto-save waiting delay
  412. after load (s)</span>
  413. <p>Specify the delay in seconds to wait before saving a page when the "auto-save on page load or
  414. on page unload" or "auto-save on page load" is checked. </p>
  415. </li>
  416. <li data-options-label="autoSaveRepeatLabel"> <span class="option">Option: auto-save
  417. periodically</span>
  418. <p>Check this option to auto-save pages periodically after load.</p>
  419. </li>
  420. <li data-options-label="autoSaveRepeatDelayLabel"> <span class="option">Option: period (s)</span>
  421. <p>Specify the delay in seconds to wait before each page saving when the "auto-save
  422. periodically" option is checked. </p>
  423. </li>
  424. <li data-options-label="autoSaveExternalSaveLabel"> <span class="option">Option: save the page with
  425. SingleFile Companion</span>
  426. <p>Check this option to delegate the saving process to SingleFile Companion. It is a program
  427. that runs outside the browser and can help to make the saving process more transparent. It
  428. also allows the pages to be saved in another directory than the download directory. You can
  429. find more info <a
  430. href="https://github.com/gildas-lormeau/SingleFile/tree/master/companion">here</a></p>
  431. </li>
  432. </ul>
  433. <p>Misc.</p>
  434. <ul>
  435. <li data-options-label="setMaxResourceSizeLabel"> <span class="option">Option: set a maximum size
  436. for embedded resources (MB)</span>
  437. <p>Check this option to remove from the saved page embedded resources (i.e. images, stylesheets,
  438. scripts and iframes) that exceeds a given size.</p>
  439. </li>
  440. <li data-options-label="maxResourceSizeLabel"> <span class="option">Option: maximum size (MB)</span>
  441. <p>Specify the maximum size of embedded resources in megabytes.</p>
  442. </li>
  443. <li data-options-label="passReferrerOnErrorLabel"> <span class="option">Option: pass \"Referer\"
  444. header on
  445. cross-origin errors</span>
  446. <p>Check this option to pass the HTTP header "Referer" with the "origin" policy after an 401,
  447. 403, or 404 HTTP error when downloading a cross-origin resource. You should enable this
  448. option if you cannot download resources blocked by a hotlink protection.</p>
  449. <p class="notice">It is recommended to <u>uncheck</u> this option</p>
  450. </li>
  451. <li data-options-label="addProofLabel"> <span class="option">Option: add proof od existence</span>
  452. <p>Check this option to create a worldwide proof of the existence of the page you want to save.
  453. </p>
  454. <ul>
  455. <li> <strong>What is a proof of existence (data anchoring)?</strong><br> Data anchoring
  456. consists in building a time-stamped proof of existence for a data by linking it to a
  457. tamper resistant and time-stamped blockchain. Data anchoring implementation relies on
  458. the resilience and immutability of the Bitcoin blockchain to provide the best possible
  459. security level </li>
  460. <li> <strong>How does this protect my data?</strong><br> The anchoring mechanism only
  461. handles data impressions. Your data remains where you calculate the fingerprints, i.e.
  462. in the browser. Their confidentiality is totally preserved. </li>
  463. <li> <strong> The day after your backup you can get freely the proof receipt here: <a
  464. href="https://gildas-lormeau.github.io/singlefile-woleet/index.html">gildas-lormeau.github.io/singlefile-woleet/index.html</a>.
  465. A proof receipt will be used to verify the validity of the evidence </strong> </li>
  466. </ul>
  467. <p> More information <a href="https://doc.woleet.io">doc.woleet.io</a> </p>
  468. </li>
  469. <li data-options-label="backgroundSaveLabel"> <span class="option">Option: save pages in
  470. background</span>
  471. <p>Uncheck this option if you get invalid file names like
  472. "37bec68b-446a-46a5-8642-19a89c231b46.html" or interrupted downloads when saving pages. You
  473. can also uncheck this option if you want the "Save as" dialog to remember the last saved
  474. path. Unchecking this option prevent using sub-directories in filename templates.</p>
  475. <p class="notice">It is recommended to <u>check</u> this option</p>
  476. </li>
  477. <li data-options-label="displayStatsLabel"> <span class="option">Option: display stats in the
  478. console after processing</span>
  479. <p>Check this option to display stats about processing in the JavaScript developer tools of your
  480. browser. Checking this option may increase the CPU consumption and the time needed to save a
  481. page. </p>
  482. <p class="notice">It is recommended to <u>uncheck</u> this option</p>
  483. </li>
  484. </ul>
  485. <p id="auto-settings-rules">Auto-settings rules</p>
  486. <ul>
  487. <li>The auto-settings rules let you associate a complete or partial URL with a profile. It also
  488. allows to associate a specific profile for the auto-save, or to disable it (check "display
  489. 'Auto-save profile' column"). When two or more rules match a URL of a page to save, the rule
  490. with the longest URL will be chosen. The special profile "-" means the current profile. </li>
  491. <li>You can use the special value "*" as URL to create a rule that applies to all URLs</li>
  492. <li>You can use regular expressions by prefixing the URL with "regexp:" (e.g. "regexp:.*\.com" to
  493. match all URLs containing ".com"). When zero or more rules based on URLs and one or more rules
  494. based on regular expressions match a URL, the longest rule based on regular expression will be
  495. chosen. </li>
  496. </ul>
  497. <p>Form buttons</p>
  498. <ul>
  499. <li><span class="option">synchronize options</span>
  500. <p>Check this option to synchronize your options and make them available in all instances of the
  501. browser you are logged into, on different devices.</p>
  502. </li>
  503. <li><span class="option">Reset</span>
  504. <p>Reset all options to their default values.</p>
  505. </li>
  506. </ul>
  507. </li>
  508. <li><a id="annotation-editor">Annotation editor</a>
  509. <p>The annotation editor can be opened by selecting "Annotate and save the page" in the context menu or
  510. by enabling the option "Annotation editor &gt; edit page before saving". It allows you to:
  511. <ul>
  512. <li>add notes by clicking one of these buttons: <img src="../resources/button_note_yellow.png"
  513. class="icon button"> <img src="../resources/button_note_pink.png" class="icon button"> <img
  514. src="../resources/button_note_blue.png" class="icon button"> <img
  515. src="../resources/button_note_green.png" class="icon button"></li>
  516. <li>hide or show notes by clicking the button <img src="../resources/button_note_visible.png"
  517. class="icon button"></li>
  518. <li>highlight text by clicking one of these buttons: <img
  519. src="../resources/button_highlighter_yellow.png" class="icon button"> <img
  520. src="../resources/button_highlighter_pink.png" class="icon button"> <img
  521. src="../resources/button_highlighter_blue.png" class="icon button"> <img
  522. src="../resources/button_highlighter_green.png" class="icon button"></li>
  523. <li>hide or show highlighted text by clicking the button <img
  524. src="../resources/button_highlighter_visible.png" class="icon button"></li>
  525. <li>remove text highlighting by clicking the button <img
  526. src="../resources/button_highlighter_delete.png" class="icon button"></li>
  527. <li>edit the page by clicking the button <img src="../resources/button_note_edit.png"
  528. class="icon button"> </li>
  529. <li>format the page to improve readability (when possible) by clicking the button <img
  530. src="../resources/button_note_format.png" class="icon button"> </li>
  531. <li>remove contents by clicking the button <img src="../resources/button_cut_inner.png"
  532. class="icon button"> (inner elements) or <img src="../resources/button_cut_outer.png"
  533. class="icon button"> (outer elements)</li>
  534. <li>undo removes by clicking the button <img src="../resources/button_undo_cut.png"
  535. class="icon button"> or the button <img src="../resources/button_undo_all_cut.png"
  536. class="icon button"> (undo all)
  537. <li>redo removes by clicking the button <img src="../resources/button_redo_cut.png"
  538. class="icon button"></li>
  539. <li>print the page by clicking the button <img src="../resources/button_print.png"
  540. class="icon button"> or by pressing <code>Ctrl-P</code></li>
  541. <li>save the page by clicking the button <img src="../resources/button_download.png"
  542. class="icon button"> or by pressing <code>Ctrl-S</code></li>
  543. </ul>
  544. </p>
  545. <br>
  546. <p>
  547. You can use the following keyboard shortcuts when removing contents with <img
  548. src="../resources/button_cut_inner.png" class="icon button"> or <img
  549. src="../resources/button_cut_outer.png" class="icon button">:
  550. <ul>
  551. <li><code>Tab</code>: expand the selection</li>
  552. <li><code>Shift-Tab</code>: reduce the selection</li>
  553. <li><code>Space</code>: remove the selected element</li>
  554. <li><code>Ctrl-Z</code>: undo the last removal</li>
  555. <li><code>Ctrl-Shift-Z</code>: redo the last removal</li>
  556. <li><code>Ctrl</code>: select/unselect multiple elements, releasing the <code>Ctrl</code> key
  557. validates the selection</li>
  558. <li><code>Shift</code>: temporarily reverse the type of removal (i.e. removal of inner elements or
  559. removal of outer elements) on the last selected element and reset the other selected elements if
  560. any</li>
  561. <li><code>Escape</code>: reset selected elements</li>
  562. </ul>
  563. </p>
  564. </ul>
  565. </li>
  566. <li><a id="template-variables">Template variables</a>
  567. <p>The template variables are used to customize the infobar content or the file name of a saved page.
  568. They help to insert dynamic values like the save date or the page title.</p>
  569. <p> You can limit the length of a dynamic value by adding <code>[<em>maxByteSize</em>]</code> just after
  570. the variable name. The <code>maxByteSize</code> value is the maximum length of the value in bytes
  571. (e.g. `{page-title}[20]` to limit the title to 20 bytes).</p>
  572. <ul>
  573. <li><code>{page-title}</code>: the title of the page</li>
  574. <li><code>{page-heading}</code>: the content of the H1 tag in the page</li>
  575. <li><code>{page-language}</code>: the language of the page</li>
  576. <li><code>{page-description}</code>: the description of the page</li>
  577. <li><code>{page-author}</code>: the author of the page</li>
  578. <li><code>{page-creator}</code>: the creator of the page</li>
  579. <li><code>{page-publisher}</code>: the publisher of the page</li>
  580. <li><code>{datetime-iso}</code>: the save date and time in the ISO format (e.g.
  581. "2018-09-15T22_38_26_317Z")</li>
  582. <li><code>{datetime-utc}</code>: the save date and time in UTC format (e.g. "Sat, 15 Sep 2018
  583. 22_38_26 GMT")</li>
  584. <li><code>{datetime-locale}</code>: the localized value of the date and time (e.g. "9_16_2018,
  585. 12_54_31 AM")</li>
  586. <li><code>{date-iso}</code>: the save date in the ISO format (e.g. "2018-09-15")</li>
  587. <li><code>{date-locale}</code>: the localized value of the save date (e.g. "16_09_2018")</li>
  588. <li><code>{time-iso}</code>: the save time in the ISO format (e.g. "22_38_26_317")</li>
  589. <li><code>{time-locale}</code>: the localized value of the save time (e.g. "00_38_26")</li>
  590. <li><code>{day-utc}</code>: the day of the save date in UTC format (e.g. "15")</li>
  591. <li><code>{day-locale}</code>: the localized value of the day (e.g. "15")</li>
  592. <li><code>{month-utc}</code>: the month of the save date in UTC format (e.g. "09")</li>
  593. <li><code>{month-locale}</code>: the localized value of the month (e.g. "09")</li>
  594. <li><code>{year-utc}</code>: the year of the save date in UTC format (e.g. "2018")</li>
  595. <li><code>{year-locale}</code>: the localized value of the year (e.g. "2018")</li>
  596. <li><code>{hours-utc}</code>: the hour of the save date in UTC format (e.g. "20")</li>
  597. <li><code>{hours-locale}</code>: the localized value of the hour (e.g. "22")</li>
  598. <li><code>{minutes-utc}</code>: the minutes of the save date in UTC format (e.g. "38")</li>
  599. <li><code>{minutes-locale}</code>: the localized value of the minutes (e.g. "38")</li>
  600. <li><code>{seconds-utc}</code>: the seconds of the save date in UTC format (e.g. "31")</li>
  601. <li><code>{seconds-locale}</code>: the localized value of the seconds (e.g. "31")</li>
  602. <li><code>{url-href}</code>: the URL of the page (e.g. "http://example.com/category/index.html")
  603. </li>
  604. <li><code>{url-href-flat}</code>: the URL of the page with replaced slashes (e.g.
  605. "http__example.com_category_index.html")</li>
  606. <li><code>{url-pathname}</code>: the path name of the URL (e.g. "category/index.html")</li>
  607. <li><code>{url-pathname-flat}</code>: the path name of the URL with replaced slashes (e.g.
  608. "category_index.html")</li>
  609. <li><code>{url-last-segment}</code>: the last part of the pathname (without the extension) or the
  610. host if not found (e.g. "index")</li>
  611. <li><code>{url-protocol}</code>: the protocol of the URL (e.g. "https")</li>
  612. <li><code>{url-host}</code>: the host name + the port of the URL (e.g. "example.com_8080")</li>
  613. <li><code>{url-hostname}</code>: the host name of the URL (e.g. "example.com")</li>
  614. <li><code>{url-port}</code>: the port of the URL (e.g. "8080")</li>
  615. <li><code>{url-username}</code>: the user name of the URL (e.g. "john_doe")</li>
  616. <li><code>{url-password}</code>: the password of the URL (e.g. "qwerty123")</li>
  617. <li><code>{url-search}</code>: the search string of the URL (e.g. "order=ascending")</li>
  618. <li><code>{url-search-&lt;name&gt;}</code>: the query parameter "&lt;name&gt;" in the the search
  619. string of the URL (e.g. "url-search-order" will return "ascending" in the previous example)</li>
  620. <li><code>{url-hash}</code>: the hash of the URL (e.g. "chapter-2")</li>
  621. <li><code>{url-referrer}</code>: the URI of the page that "linked" to the page (e.g.
  622. "http://example.com")</li>
  623. <li><code>{url-referrer-flat}</code>: the URI of the page that "linked" to the page with slashed
  624. replaced (e.g. "http_example.com")</li>
  625. <li><code>{bookmark-pathname}</code>: the path name of the newly created bookmark (e.g. "My
  626. Bookmarks/Last Month") when the option "Bookmarks &gt; save the page of a
  627. newly created bookmark" is enabled</li>
  628. <li><code>{bookmark-pathname-flat}</code>: the path name of the newly created bookmark with replaced
  629. slashes (e.g. "My Bookmarks_Last Month") when the option "Bookmarks &gt; save the page of a
  630. newly created bookmark" is enabled</li>
  631. <li><code>{tab-id}</code>: the unique identifier of the tab (e.g. "326")</li>
  632. <li><code>{tab-index}</code>: the index of the tab in the window (e.g. "1")</li>
  633. <li><code>{digest-sha-256}</code>: the SHA-256 hash value of the entire page content (e.g.
  634. e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855)</li>
  635. <li><code>{digest-sha-384}</code>: the SHA-384 hash value of the entire page content</li>
  636. <li><code>{digest-sha-512}</code>: the SHA-512 hash value of the entire page content</li>
  637. </ul>
  638. </li>
  639. <li><a id="notes">Technical notes</a>
  640. <ul>
  641. <li>All images are converted into <a href="http://en.wikipedia.org/wiki/Base64">base64</a>. </li>
  642. <li>All resources except frame contents are injected in the document using <a
  643. href="http://en.wikipedia.org/wiki/Data_URI_scheme">data URI scheme</a>. </li>
  644. <li>Frame contents are injected as text in the document by using the srcdoc attribute. </li>
  645. </ul>
  646. </li>
  647. <li><a id="known-issues">Known issues</a>
  648. <ul>
  649. <li>All browsers
  650. <ul>
  651. <li>For security reasons, you cannot save pages hosted on https://chrome.google.com,
  652. https://addons.mozilla.org and some other Mozilla domains. When this happens, 🚫 is
  653. displayed on top of the SingleFile icon.</li>
  654. <li>For security reasons, SingleFile is sometimes unable to save the image representation of
  655. canvas and snapshots of video elements.</li>
  656. <li>The last saved path cannot be remembered by default. To circumvent this limitation,
  657. disable the option "Misc. &gt; Save pages in background".</li>
  658. <li>The following characters are replaced with _ in filenames: ~, +, \, ?, %, *, :, |, ",
  659. &lt;, &gt;</li>
  660. </ul>
  661. </li>
  662. <li>Chromium-based browsers
  663. <ul>
  664. <li>You must enable the option "Allow access to file URLs" in the extension page to display
  665. the infobar when viewing a saved page, to save or to annotate a page stored on the
  666. filesystem.</li>
  667. <li>If the filename of a saved page looks like "56833935-156b-4d8c-a00f-19599c6513d3",
  668. disable the option "Misc. &gt; Save pages in background". Reinstalling the browser may
  669. also fix this issue.</li>
  670. <li>Disabling the option 'File name &gt; open the "Save as" dialog to confirm the file name'
  671. will work if and only if "Ask where to save each file before downloading" is disabled in
  672. chrome://settings/downloads</li>
  673. </ul>
  674. </li>
  675. <li>Firefox
  676. <ul>
  677. <li>The "File name &gt; file name conflict resolution" option does not work if set to
  678. "prompt for a name".
  679. </li>
  680. <li>Sometimes, SingleFile is unable to save the contents of sandboxed iframes.</li>
  681. <li>When processing a page from the filesystem, external resources (e.g. images,
  682. stylesheets, fonts etc.) will not be embedded into the saved page.</li>
  683. </ul>
  684. </li>
  685. </ul>
  686. </li>
  687. <li><a id="unknown-issues">Troubleshooting unknown issues</a>
  688. <p>Please follow these steps if you find an unknown issue:</p>
  689. <ul>
  690. <li>Save the page in incognito.</li>
  691. <li>If saving page in incognito did not fix the issue, reset SingleFile options.</li>
  692. <li>If resetting options did not fix the issue, restart the browser.</li>
  693. <li>If restarting the browser did not fix the issue, try to disable all other extensions to see if
  694. there is a conflict.</li>
  695. <li>If there is a conflict then try to determine against which extension(s).</li>
  696. <li>Please report the issue <a href="https://github.com/gildas-lormeau/SingleFile/issues">here</a>
  697. with a short description on how to reproduce it.</li>
  698. </ul>
  699. <p>Suggestions are welcome :)</p>
  700. </li>
  701. <li><a id="contributors">Contributors</a>
  702. <ul>
  703. <li>Chinese translation done by yfdyh000 (<a href="https://github.com/yfdyh000">GitHub profile</a>),
  704. KrasnayaPloshchad (<a href="https://github.com/KrasnayaPloshchad">GitHub profile</a>),
  705. frostblazergit (<a href="https://github.com/frostblazergit">GitHub profile</a>), NightSharp (<a
  706. href="https://github.com/NightSharp">GitHub profile</a>) </li>
  707. <li>Traditional Chinese translation done by frostblazergit (<a
  708. href="https://github.com/frostblazergit">GitHub profile</a>)</li>
  709. <li>German translation done by womotroll (<a href="https://github.com/womotroll">GitHub
  710. profile</a>), bannmann (<a href="https://github.com/bannmann">GitHub profile</a>) </li>
  711. <li>Japanese translation, done by Shitennouji (四天王寺) (<a
  712. href="https://github.com/Shitennouji">GitHub profile</a>)</li>
  713. <li>Polish translation done by xesarni (<a href="https://github.com/xesarni">GitHub profile</a>)
  714. </li>
  715. <li>Russian translation done by rstp14 (<a href="https://github.com/rstp14">GitHub profile</a>),
  716. kramola-RU (<a href="https://github.com/kramola-RU">GitHub profile</a>), solokot (<a
  717. href="https://github.com/solokot">GitHub profile</a>)</li>
  718. <li>Ukrainian translation done by perdolka (<a href="https://github.com/perdolka">GitHub
  719. profile</a>)</li>
  720. <li>Spanish translation done by strel (<a href="https://github.com/strel">GitHub profile</a>)</li>
  721. </ul>
  722. </li>
  723. <li><a id="icons">Icons</a>
  724. <ul>
  725. <li>Icon made by <a href="https://www.flaticon.com/authors/kiranshastry"
  726. title="Kiranshastry">Kiranshastry</a> from <a href="https://www.flaticon.com/"
  727. title="Flaticon">www.flaticon.com</a> is licensed by <a
  728. href="http://creativecommons.org/licenses/by/3.0/" title="Creative Commons BY 3.0"
  729. target="_blank">CC 3.0 BY</a> </li>
  730. </ul>
  731. </li>
  732. </ol>
  733. </div>
  734. </body>
  735. </html>