help.html 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  5. <title>SingleFile help</title>
  6. <link rel="stylesheet" href="help.css">
  7. <meta name="viewport" content="width=device-width,initial-scale=1">
  8. </head>
  9. <body>
  10. <div>
  11. <div id="titleBorder">
  12. <h2>SingleFile</h2>
  13. <h4>Save a complete page into a single HTML file</h4>
  14. </div> <span id="index"> <a href="#getting-started">Getting started</a> - <a href="#general-notes">Additional
  15. notes</a> - <a href="#options">Options description</a> - <a href="#notes">Technical notes</a> - <a
  16. href="#template-variables">Template variables</a> - <a href="#known-issues">Known issues</a> - <a
  17. href="#unknown-issues">Troubleshooting unknown issues</a> - <a href="#contributors">Contributors</a>
  18. </span>
  19. <hr>
  20. <ol>
  21. <li> <a id="getting-started">Getting started</a>
  22. <ul>
  23. <li>Wait until the page is fully loaded, you may need to scroll down the entire page to be sure all
  24. elements are loaded.</li>
  25. <li>Click on the SingleFile button <img src="../resources/icon_16.png" class="icon"> in the
  26. extension toolbar to save the page.</li>
  27. </ul>
  28. </li>
  29. <li> <a id="general-notes">Additional notes</a>
  30. <ul>
  31. <li>To save multiple tabs, select them first and click on the SingleFile button <img
  32. src="../resources/icon_16.png" class="icon">.</li>
  33. <li> Open the context menu by right-clicking the SingleFile button <img
  34. src="../resources/icon_16.png" class="icon"> in the extension toolbar or on the webpage. It
  35. allows you to save: <ul>
  36. <li>the current tab,</li>
  37. <li>or the selected content,</li>
  38. <li>or the selected frame.</li>
  39. </ul>
  40. </li>
  41. <li> You can also process multiple tabs in one click and save: <ul>
  42. <li>the selected tabs,</li>
  43. <li>or the unpinned tabs,</li>
  44. <li>or all the tabs.</li>
  45. </ul>
  46. </li>
  47. <li> The context menu also allows you to activate the auto-save of: <ul>
  48. <li>the current tab,</li>
  49. <li>or the unpinned tabs,</li>
  50. <li>or all the tabs.</li>
  51. </ul>
  52. </li>
  53. <li>You can interrupt the saving progress by clicking on the SingleFile button when processing a
  54. page.</li>
  55. <li>With auto-save active, pages are automatically saved every time after being loaded (or before
  56. being unloaded if not). </li>
  57. <li>Right-click on the SingleFile button and select "Options" to open the options page.</li>
  58. <li> The default save folder is the download folder configured in your browser, cf.
  59. about:preferences in Firefox and chrome://settings in Chrome. </li>
  60. <li>You can use the shortcut Ctrl+Shift+Y to save the current tab or the selected tabs. Go to <a
  61. href="chrome://extensions/shortcuts">chrome://extensions/shortcuts</a> to change it in
  62. Chrome.</li>
  63. </ul>
  64. </li>
  65. <li> <a id="options">Options description</a>
  66. <p>You can customize SingleFile through the options page. Right-click on SingleFile button <img
  67. src="../resources/icon_16.png" class="icon"> in the browser toolbar and select "Options"/"Manage
  68. extension" in the context menu to open the options page.</p>
  69. <p>Profiles</p>
  70. <ul>
  71. <li>
  72. <p>A profile is a set of user-defined options associated to a unique name.</p>
  73. <p> The drop-down list in the upper right of the options page allows you to select a profile and
  74. modify the associated options. The buttons next to the drop-down list allows you
  75. respectively to create, delete and rename a profile. </p>
  76. </li>
  77. <li>
  78. <p> You can select the default profile through the context menu of SingleFile. The selection is
  79. persistent and applied to all tabs. </p>
  80. </li>
  81. <li>
  82. <p> You can also override the default profile by associating a profile to a complete or partial
  83. URL. See the description of the <a href="#auto-settings-rules">Auto-settings rules</a>
  84. feature for more info. </p>
  85. </li>
  86. </ul>
  87. <p>User interface</p>
  88. <ul>
  89. <li data-options-label="addMenuEntryLabel"> <span class="option">Option: add entry in the context
  90. menu of the webpage</span>
  91. <p>Check this option to display an entry for SingleFile in the context menu of the webpage. The
  92. context menu of the SingleFile button <img src="../resources/icon_16.png" class="icon"> in
  93. the extension toolbar is displayed wether this option is checked or not. </p>
  94. <p class="notice">It is recommended to <u>check</u> this option</p>
  95. </li>
  96. <li data-options-label="shadowEnabledLabel"> <span class="option">Option: overlay a shadow on the
  97. page during processing</span>
  98. <p>Check this option to overlay a shadow on the page when SingleFile is retrieving page
  99. resources. This reminds you that you should not close the tab. </p>
  100. <p class="notice">It is recommended to <u>check</u> this option</p>
  101. </li>
  102. <li data-options-label="displayInfobarLabel"> <span class="option">Option: display an infobar when
  103. viewing a saved page</span>
  104. <p>Check this option to display the ℹ button at the top right of the page when viewing a saved
  105. page. By clicking this button, you can get more information about the saved date and open
  106. the original URL.</p>
  107. <p class="notice">It is recommended to <u>check</u> this option</p>
  108. </li>
  109. <li data-options-label="infobarTemplateLabel"> <span class="option">Option: template of the infobar
  110. content</span>
  111. <p>The template allows you to customize the content displayed in the infobar. You can use any
  112. valid character, <code>\n</code> for new lines or <code>\t</code> for tabs. You can also use
  113. any variables from <a href="#template-variables">this list</a> anywhere in the template. If
  114. the template or the resulting content is empty, the infobar will display the saved date by
  115. default. </p>
  116. <p>Template examples:</p>
  117. <ul>
  118. <li><code>{url-href} ({date-iso})</code> will produce contents like "https://www.example.com
  119. (2018-09-15 11 06 03 PM)".</li>
  120. <li><code>Title: {page-title}</code> will produce contents like "Title: Example Domain" for
  121. a page having "Example Domain" as title.</li>
  122. </ul>
  123. </li>
  124. <li data-options-label="openEditorLabel"> <span class="option">Option: edit page before
  125. saving</span>
  126. <p>Check this option to open the annotation editor before saving any page. Checking this option
  127. removes the entry "Annotate and save the page..." from the context menu.</p>
  128. <p class="notice">It is recommended to <u>uncheck</u> this option</p>
  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="autoCloseLabel"> <span class="option">Option: auto-close the tab after
  136. the page is saved</span>
  137. <p>Check this option to automatically close the tab after saving the page displayed inside.
  138. </p>
  139. </li>
  140. </ul>
  141. <p>File name</p>
  142. <ul>
  143. <li data-options-label="filenameTemplateLabel"> <span class="option">Option: template</span>
  144. <p>The template allows you to customize the file name of saved pages. You can use any valid
  145. character and "/" to create sub-folders (with the option "save pages in background" active).
  146. You can also use any variables from <a href="#template-variables">this list</a> anywhere in
  147. the template.</p>
  148. <p>Invalid characters are automatically transformed and collapsed to underscores. File names
  149. cannot exceed 192 characters and are truncated if longer. The invalid characters are:
  150. <code>[</code> <code>~</code> <code>\</code> <code>?</code> <code>%</code>
  151. <code>*</code> <code>:</code> <code>|</code> <code>"</code> <code>&lt;</code>
  152. <code>&gt;</code> and control characters from 0 to 31 in the ASCII table.</p>
  153. <p>Template examples:</p>
  154. <ul>
  155. <li><code>{page-title} ({date-iso} {time-locale}).html</code> will produce filenames like
  156. "Introduction to SingleFile (2018-09-15 11_06_03 PM).html" for a page having
  157. "Introduction to SingleFile" as title.</li>
  158. <li><code>archives/{url-last-segment} - {date-iso}</code> will produce filenames like
  159. "welcome - 2018-09-15" for a page hosted on https://example.com/welcome.html. The saved
  160. files will be saved in the sub-directory "archives".</li>
  161. <li><code>archives/{year-locale}/{month-locale}/{day-locale}/{page-title}.html</code> will
  162. produce filenames like "Introduction to SingleFile.html" stored into 3 sub-directories
  163. in the "archives" folder, one for each part of the save date (e.g.
  164. "2018/9/15/Introduction to SingleFile.html").</li>
  165. </ul>
  166. </li>
  167. <li data-options-label="confirmFilenameLabel"> <span class="option">Option: open the "Save as"
  168. dialog to confirm the file name</span>
  169. <p>Check this option to display the "Save as" dialog in order to confirm the file name before
  170. saving the page. If the option "save pages in background" is unchecked then a prompt dialog
  171. will be displayed instead of the "Save as" dialog. </p>
  172. </li>
  173. <li data-options-label="filenameConflictActionLabel"> <span class="option">Option: file name
  174. conflict resolution</span>
  175. <p>Choose the most appropriate action when a the filename of the saved page is conflicting with
  176. existing ones on the filesystem.</p>
  177. </li>
  178. </ul>
  179. <p>HTML content</p>
  180. <ul>
  181. <li data-options-label="compressHTMLLabel"> <span class="option">Option: compress HTML
  182. content</span>
  183. <p>Check this option to remove all HTML comments and unneeded tags, spaces, quotes and
  184. whitespace characters. Checking this option helps to reduce the size of the file without
  185. altering the document.</p>
  186. <p class="notice">It is recommended to <u>check</u> this option</p>
  187. </li>
  188. <li data-options-label="removeImportsLabel"> <span class="option">Option: remove HTML imports</span>
  189. <p>Check this option to remove all link elements used to import HTML documents. Checking this
  190. option can help to reduce the size of the file without altering the document.</p>
  191. <p class="notice">It is recommended to <u>check</u> this option</p>
  192. </li>
  193. <li data-options-label="removeHiddenElementsLabel"> <span class="option">Option: remove hidden
  194. elements</span>
  195. <p>Check this option to remove all hidden elements. Checking this option can help to reduce the
  196. size of the file without altering the document. It may also increase the CPU consumption and
  197. the time needed to save a page.</p>
  198. <p class="notice">It is recommended to <u>check</u> this option</p>
  199. </li>
  200. <li data-options-label="removeFramesLabel"> <span class="option">Option: remove frames</span>
  201. <p>Check this option to remove all frame and iframe elements. Checking this option can
  202. considerably reduce the size of the file without altering the document most of the time. It
  203. may also decrease the time needed to save a page.</p>
  204. </li>
  205. <li data-options-label="includeInfobarLabel">Option: include infobar in the saved page
  206. <p>Check this option to display the ℹ button at the top right of the page when viewing a saved
  207. page in a browser where SingleFileZ is not installed.</p>
  208. </li>
  209. </ul>
  210. <p>Stylesheets</p>
  211. <ul>
  212. <li data-options-label="compressCSSLabel"> <span class="option">Option: compress CSS content</span>
  213. <p>Check this option to minify CSS stylesheets. Checking this option can reduce size of the file
  214. without altering the document. It may also increase the CPU consumption and the time needed
  215. to save a page.</p>
  216. <p class="notice">It is recommended to <u>check</u> this option</p>
  217. </li>
  218. <li data-options-label="removeUnusedStylesLabel"> <span class="option">Option: remove unused
  219. styles</span>
  220. <p>Check this option to remove all the CSS rules and styles that do not match any element in the
  221. saved page. Checking this option will not alter the document and can considerably reduce the
  222. size of the file. It will also increase the CPU consumption and the time needed to save a
  223. page.</p>
  224. <p class="notice">It is recommended to <u>check</u> this option</p>
  225. </li>
  226. <li data-options-label="removeAlternativeMediasLabel"> <span class="option">Option: remove
  227. stylesheets for alternative devices to screens</span>
  228. <p>Check this option to remove stylesheets that are not used for the screen display like
  229. stylesheets for print preview and speech synthesizers. Checking this option can help to
  230. reduce the size of the file.</p>
  231. </li>
  232. </ul>
  233. <p>Images</p>
  234. <ul>
  235. <li data-options-label="groupDuplicateImagesLabel"> <span class="option">Option: group duplicate
  236. images together</span>
  237. <p>Check this option to avoid saving multiple times duplicate images. Checking this option
  238. should not alter the document in modern browsers and can considerably reduce the size of the
  239. file.</p>
  240. <p class="notice">It is recommended to <u>check</u> this option</p>
  241. </li>
  242. <li data-options-label="loadDeferredImagesLabel"> <span class="option">Option: save deferred
  243. images</span>
  244. <p>Check this option to save all the deferred images that are not yet displayed. This may help
  245. to save all the images without scrolling the page. This feature does its best effort and is
  246. not guaranteed to work on all sites. It will also increase the time needed to save a page.
  247. </p>
  248. <p class="notice">It is recommended to <u>check</u> this option</p>
  249. </li>
  250. <li data-options-label="loadDeferredImagesMaxIdleTimeLabel"> <span class="option">Option: maximum
  251. idle time (ms)</span>
  252. <p>Specify the maximum delay of time to wait for deferred images. You can increase this value if
  253. for example the network or system conditions are degraded. You can also decrease this value
  254. otherwise.</p>
  255. </li>
  256. <li data-options-label="removeAlternativeImagesLabel"> <span class="option">Option: remove images
  257. for alternative screen resolutions</span>
  258. <p>Check this option to remove images that are alternatives in lower and/or higher resolutions
  259. to the ones displayed by default. Checking this option can considerably reduce the size of
  260. the file.</p>
  261. </li>
  262. </ul>
  263. <p>Fonts</p>
  264. <ul>
  265. <li data-options-label="removeUnusedFontsLabel"> <span class="option">Option: remove unused
  266. fonts</span>
  267. <p>Check this option to remove all font CSS rules that do not match any content. Checking this
  268. option should not alter the document and can considerably reduce the size of the file.</p>
  269. <p class="notice">It is recommended to <u>check</u> this option</p>
  270. </li>
  271. <li data-options-label="removeAlternativeFontsLabel"> <span class="option">Option: remove
  272. alternative fonts</span>
  273. <p>Check this option to remove fonts that are alternatives to the ones used. Checking this
  274. option should not alter the document and can considerably reduce the size of the file.</p>
  275. <p class="notice">It is recommended to <u>check</u> this option</p>
  276. </li>
  277. </ul>
  278. <p>Other resources</p>
  279. <ul>
  280. <li data-options-label="removeScriptsLabel"> <span class="option">Option: remove scripts</span>
  281. <p>Check this option to remove all the JavaScript scripts. Unchecking this option may alter the
  282. document and may introduce privacy or security issues.</p>
  283. <p class="notice">It is recommended to <u>check</u> this option</p>
  284. </li>
  285. <li data-options-label="removeVideoLabel"> <span class="option">Option: remove video sources</span>
  286. <p>Check this option to empty the "src" attribute of all video elements.</p>
  287. <p class="notice">It is recommended to <u>check</u> this option</p>
  288. </li>
  289. <li data-options-label="removeAudioLabel"> <span class="option">Option: remove audio sources</span>
  290. <p>Check this option to empty the "src" attribute of all audio elements.</p>
  291. <p class="notice">It is recommended to <u>check</u> this option</p>
  292. </li>
  293. </ul>
  294. <p>Auto-save</p>
  295. <ul>
  296. <li data-options-label="autoSaveLoadOrUnloadLabel"> <span class="option">Option: auto-save after
  297. page load or on page unload</span>
  298. <p>Check this option to auto-save pages after being loaded. If you browse to another page before
  299. the page is fully loaded then the page will be saved just before being unloaded. With this
  300. option active, you are guaranteed pages will always be saved. Some frame contents may be
  301. missing (if you unchecked "remove frames") when pages are saved before being unloaded. </p>
  302. </li>
  303. <li data-options-label="autoSaveLoadLabel"> <span class="option">Option: auto-save after page
  304. load</span>
  305. <p>Check this option to auto-save pages after being loaded.</p>
  306. </li>
  307. <li data-options-label="autoSaveUnloadLabel"> <span class="option">Option: auto-save on page
  308. unload</span>
  309. <p>Check this option to auto-save pages before being unloaded instead of saving pages after
  310. being loaded. With this option active, you are guaranteed pages will always be saved but
  311. some frame contents may be missing (if you unchecked "remove frames"). </p>
  312. </li>
  313. <li data-options-label="autoSaveDelayLabel"> <span class="option">Option: auto-save waiting delay
  314. after load (s)</span>
  315. <p>Specify the delay in seconds to wait before saving a page when the "auto-save on page load or
  316. on page unload" or "auto-save on page load" is checked. </p>
  317. </li>
  318. <li data-options-label="autoSaveRepeatLabel"> <span class="option">Option: auto-save
  319. periodically</span>
  320. <p>Check this option to auto-save pages periodically after load.</p>
  321. </li>
  322. <li data-options-label="autoSaveRepeatDelayLabel"> <span class="option">Option: period (s)</span>
  323. <p>Specify the delay in seconds to wait before each page saving when the "auto-save
  324. periodically" option is checked. </p>
  325. </li>
  326. </ul>
  327. <p>Misc.</p>
  328. <ul>
  329. <li data-options-label="backgroundSaveLabel"> <span class="option">Option: save pages in
  330. background</span>
  331. <p>Uncheck this option if you get invalid file names like
  332. "37bec68b-446a-46a5-8642-19a89c231b46.html" or interrupted downloads when saving pages. You
  333. can also uncheck this option if you want the "Save as" dialog to remember the last saved
  334. path. Unchecking this option prevent using sub-directories in filename templates.</p>
  335. <p class="notice">It is recommended to <u>check</u> this option</p>
  336. </li>
  337. <li data-options-label="displayStatsLabel"> <span class="option">Option: display stats in the
  338. console after processing</span>
  339. <p>Check this option to display stats about processing in the JavaScript developer tools of your
  340. browser. Checking this option may increase the CPU consumption and the time needed to save a
  341. page. </p>
  342. <p class="notice">It is recommended to <u>uncheck</u> this option</p>
  343. </li>
  344. <li data-options-label="setMaxResourceSizeLabel"> <span class="option">Option: set a maximum size
  345. for embedded resources (MB)</span>
  346. <p>Check this option to remove from the saved page embedded resources (i.e. images, stylesheets,
  347. scripts and iframes) that exceeds a given size.</p>
  348. </li>
  349. <li data-options-label="maxResourceSizeLabel"> <span class="option">Option: maximum size (MB)</span>
  350. <p>Specify the maximum size of embedded resources in megabytes.</p>
  351. </li>
  352. <li data-options-label="saveRawPageLabel"> <span class="option">Option: save raw page</span>
  353. <p>Check this option to save the page without interpreting JavaScript. Checking this option may
  354. alter the document, will force the options "remove frames", "remove hidden elements" to
  355. be enabled and "save deferred images" to be disabled.</p>
  356. <p class="notice">It is recommended to <u>uncheck</u> this option</p>
  357. </li>
  358. <li data-options-label="saveToClipboardLabel"> <span class="option">Option: save to clipboard</span>
  359. <p>Check this option to copy the page to the clipboard instead of downloading it. Checking this
  360. option will force the "file name" options to be disabled.</p>
  361. <p class="notice">It is recommended to <u>uncheck</u> this option</p>
  362. </li>
  363. </ul>
  364. <p id="auto-settings-rules">Auto-settings rules</p>
  365. <ul>
  366. <li> The auto-settings rules let you associate a complete or partial URL with a profile. It also
  367. allows to associate a specific profile for the auto-save, or to disable it (check "display
  368. 'Auto-save profile' column"). When two or more rules match a URL of a page to save, the rule
  369. with the longest URL will be chosen. The special profile "-" means the current profile. </li>
  370. <li> You can use the special value "*" as URL to create a rule that applies to all URLs</li>
  371. <li> You can use regular expressions by prefixing the URL with "regexp:" (e.g. "regexp:.*\.com" to
  372. match all URLs containing ".com"). When zero or more rules based on URLs and one or more rules
  373. based on regular expressions match a URL, the longest rule based on regular expression will be
  374. chosen. </li>
  375. </ul>
  376. <p>Form buttons</p>
  377. <ul>
  378. <li> <span class="option">Reset</span>
  379. <p>Reset all options to their default values.</p>
  380. </li>
  381. </ul>
  382. </li>
  383. <li> <a id="template-variables">Template variables</a>
  384. <p>The template variables are used to customize the infobar content or the file name of a saved page.
  385. They help to insert dynamic values like the save date or the page title.</p>
  386. <ul>
  387. <li><code>{page-title}</code>: the title of the page</li>
  388. <li><code>{page-language}</code>: the language of the page</li>
  389. <li><code>{page-description}</code>: the description of the page</li>
  390. <li><code>{page-author}</code>: the author of the page</li>
  391. <li><code>{page-creator}</code>: the creator of the page</li>
  392. <li><code>{page-publisher}</code>: the publisher of the page</li>
  393. <li><code>{datetime-iso}</code>: the save date and time in the ISO format (e.g.
  394. "2018-09-15T22_38_26_317Z")</li>
  395. <li><code>{datetime-utc}</code>: the save date and time in UTC format (e.g. "Sat, 15 Sep 2018
  396. 22_38_26 GMT")</li>
  397. <li><code>{datetime-locale}</code>: the localized value of the date and time (e.g. "9_16_2018,
  398. 12_54_31 AM")</li>
  399. <li><code>{date-iso}</code>: the save date in the ISO format (e.g. "2018-09-15")</li>
  400. <li><code>{date-locale}</code>: the localized value of the save date (e.g. "16_09_2018")</li>
  401. <li><code>{time-iso}</code>: the save time in the ISO format (e.g. "22_38_26_317")</li>
  402. <li><code>{time-locale}</code>: the localized value of the save time (e.g. "00_38_26")</li>
  403. <li><code>{day-utc}</code>: the day of the save date in UTC format (e.g. "15")</li>
  404. <li><code>{day-locale}</code>: the localized value of the day (e.g. "15")</li>
  405. <li><code>{month-utc}</code>: the month of the save date in UTC format (e.g. "09")</li>
  406. <li><code>{month-locale}</code>: the localized value of the month (e.g. "09")</li>
  407. <li><code>{year-utc}</code>: the year of the save date in UTC format (e.g. "2018")</li>
  408. <li><code>{year-locale}</code>: the localized value of the year (e.g. "2018")</li>
  409. <li><code>{hours-utc}</code>: the hour of the save date in UTC format (e.g. "20")</li>
  410. <li><code>{hours-locale}</code>: the localized value of the hour (e.g. "22")</li>
  411. <li><code>{minutes-utc}</code>: the minutes of the save date in UTC format (e.g. "38")</li>
  412. <li><code>{minutes-locale}</code>: the localized value of the minutes (e.g. "38")</li>
  413. <li><code>{seconds-utc}</code>: the seconds of the save date in UTC format (e.g. "31")</li>
  414. <li><code>{seconds-locale}</code>: the localized value of the seconds (e.g. "31")</li>
  415. <li><code>{url-href}</code>: the URL of the page (e.g. "http_example.com")</li>
  416. <li><code>{url-pathname}</code>: the path name of the URL (e.g. "category_index.html")</li>
  417. <li><code>{url-last-segment}</code>: the last part of the pathname (without the extension) or the
  418. host if not found (e.g. "index")</li>
  419. <li><code>{url-protocol}</code>: the protocol of the URL (e.g. "https")</li>
  420. <li><code>{url-host}</code>: the host name + the port of the URL (e.g. "example.com_8080")</li>
  421. <li><code>{url-hostname}</code>: the host name of the URL (e.g. "example.com")</li>
  422. <li><code>{url-port}</code>: the port of the URL (e.g. "8080")</li>
  423. <li><code>{url-username}</code>: the user name of the URL (e.g. "john_doe")</li>
  424. <li><code>{url-password}</code>: the password of the URL (e.g. "qwerty123")</li>
  425. <li><code>{url-search}</code>: the search string of the URL (e.g. "order=ascending")</li>
  426. <li><code>{url-search-&lt;name&gt;}</code>: the query parameter "&lt;name&gt;" in the the search
  427. string of the URL (e.g. "url-search-order" will return "ascending" in the previous example)</li>
  428. <li><code>{url-hash}</code>: the hash of the URL (e.g. "chapter-2")</li>
  429. <li><code>{url-referrer}</code>: the URI of the page that "linked" to the page (e.g.
  430. "http_example.com")</li>
  431. <li><code>{tab-id}</code>: the unique identifier of the tab (e.g. "326")</li>
  432. <li><code>{tab-index}</code>: the index of the tab in the window (e.g. "1")</li>
  433. <li><code>{digest-sha-256}</code>: the SHA-256 hash value of the entire page content (e.g.
  434. e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855)</li>
  435. <li><code>{digest-sha-384}</code>: the SHA-384 hash value of the entire page content</li>
  436. <li><code>{digest-sha-512}</code>: the SHA-512 hash value of the entire page content</li>
  437. </ul>
  438. </li>
  439. <li> <a id="notes">Technical notes</a>
  440. <ul>
  441. <li>All images are converted into <a href="http://en.wikipedia.org/wiki/Base64">base64</a>. </li>
  442. <li>All resources except frame contents are injected in the document using <a
  443. href="http://en.wikipedia.org/wiki/Data_URI_scheme">data URI scheme</a>. </li>
  444. <li>Frame contents are injected as text in the document by using the srcdoc attribute. </li>
  445. </ul>
  446. </li>
  447. <li> <a id="known-issues">Known issues</a>
  448. <ul>
  449. <li> All browsers <ul>
  450. <li>For security reasons, you cannot save pages hosted on https://chrome.google.com,
  451. https://addons.mozilla.org and some other Mozilla domains. When this happens, 🚫 is
  452. displayed on top of the SingleFile icon.</li>
  453. <li>For security reasons, SingleFile is sometimes unable to save the image representation of
  454. a
  455. canvas element.</li>
  456. <li>The last saved path cannot be remembered by default. To circumvent this limitation,
  457. disable the option "Misc. &gt; Save pages in background".</li>
  458. <li>The following characters are replaced with _ in filenames: ~, \, ?, %, *, :, |, ", &lt;,
  459. &gt;</li>
  460. </ul>
  461. </li>
  462. <li> Chrome/Opera <ul>
  463. <li>You must enable the option "Allow access to file URLs" in the extension page to display
  464. the infobar when viewing a saved page, or to save a page stored on the filesystem.</li>
  465. <li>If the filename of a saved page looks like "56833935-156b-4d8c-a00f-19599c6513d3",
  466. disable the option "Misc. &gt; Save pages in background". Reinstalling the browser may
  467. also fix this issue.</li>
  468. <li>Disabling the option 'File name &gt; open the "Save as" dialog to confirm the file name'
  469. will work if and only if "Ask where to save each file before downloading" is disabled in
  470. chrome://settings/downloads</li>
  471. </ul>
  472. </li>
  473. <li> Firefox <ul>
  474. <li>The "file name conflict resolution" option does not work if set to "prompt for a name".
  475. </li>
  476. </ul>
  477. </li>
  478. </ul>
  479. </li>
  480. <li> <a id="unknown-issues">Troubleshooting unknown issues</a>
  481. <p>Please follow these steps if you find an unknown issue:</p>
  482. <ul>
  483. <li>Save the page in incognito.</li>
  484. <li>If saving page in incognito did not fix the issue, reset SingleFile options.</li>
  485. <li>If resetting options did not fix the issue, restart the browser.</li>
  486. <li>If restarting the browser did not fix the issue, try to disable all other extensions to see if
  487. there is a conflict.</li>
  488. <li>If there is a conflict then try to determine against which extension(s).</li>
  489. <li>Please report the issue <a href="https://github.com/gildas-lormeau/SingleFile/issues">here</a>
  490. with a short description on how to reproduce it.</li>
  491. </ul>
  492. <p>Suggestions are welcome :)</p>
  493. </li>
  494. <li> <a id="contributors">Contributors</a>
  495. <ul>
  496. <li>Chinese translation done by yfdyh000 (<a href="https://github.com/yfdyh000">GitHub profile</a>),
  497. KrasnayaPloshchad (<a href="https://github.com/KrasnayaPloshchad">GitHub profile</a>),
  498. frostblazergit (<a href="https://github.com/frostblazergit">GitHub profile</a>)</li>
  499. <li>Traditional Chinese translation done by frostblazergit (<a
  500. href="https://github.com/frostblazergit">GitHub profile</a>)</li>
  501. <li>German translation done by womotroll (<a href="https://github.com/womotroll">GitHub
  502. profile</a>), bannmann (<a href="https://github.com/bannmann">GitHub profile</a>)
  503. </li>
  504. <li>Japanese translation, done by Shitennouji (四天王寺) (<a
  505. href="https://github.com/Shitennouji">GitHub profile</a>)</li>
  506. <li>Polish translation done by xesarni (<a href="https://github.com/xesarni">GitHub profile</a>)
  507. </li>
  508. <li>Russian translation done by rstp14 (<a href="https://github.com/rstp14">GitHub profile</a>),
  509. kramola-RU (<a href="https://github.com/kramola-RU">GitHub profile</a>)</li>
  510. <li>Spanish translation done by strel (<a href="https://github.com/strel">GitHub profile</a>)</li>
  511. </ul>
  512. </li>
  513. <li> <a id="icons">Icons</a>
  514. <ul>
  515. <li> Icon made by <a href="https://www.flaticon.com/authors/kiranshastry"
  516. title="Kiranshastry">Kiranshastry</a> from <a href="https://www.flaticon.com/"
  517. title="Flaticon">www.flaticon.com</a> is licensed by <a
  518. href="http://creativecommons.org/licenses/by/3.0/" title="Creative Commons BY 3.0"
  519. target="_blank">CC 3.0 BY</a> </li>
  520. </ul>
  521. </li>
  522. </ol>
  523. </div>
  524. </body>
  525. </html>