help.html 53 KB

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