help.html 53 KB

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