help.html 80 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354
  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/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>
  17. <span id="index">
  18. <a href="#getting-started">Getting started</a> -
  19. <a href="#general-notes">Additional notes</a> -
  20. <a href="#options">Options description</a> -
  21. <a href="#annotation-editor">Annotation editor</a> -
  22. <a href="#notes">Technical notes</a> -
  23. <a href="#template-variables">Template variables</a> -
  24. <a href="#template-functions">Template functions</a> -
  25. <a href="#external-messages">Integration with other extensions</a> -
  26. <a href="#known-issues">Known issues</a> -
  27. <a href="#unknown-issues">Troubleshooting unknown issues</a> -
  28. <a href="#contributors">Contributors</a> </span>
  29. <hr>
  30. <ol>
  31. <li><a id="getting-started">Getting started</a>
  32. <ul>
  33. <li>Wait until the page is fully loaded.</li>
  34. <li>Click on the SingleFile button <img src="../resources/icon_16.png" class="icon"> in the
  35. extension toolbar to process and save the page.</li>
  36. <li>You can click again on the button to cancel the action when processing a page.</li>
  37. </ul>
  38. </li>
  39. <li><a id="general-notes">Additional notes</a>
  40. <ul>
  41. <li>To save multiple tabs, select them first and click on the SingleFile button <img
  42. src="../resources/icon_16.png" class="icon">.</li>
  43. <li>Open the context menu by right-clicking the SingleFile button <img
  44. src="../resources/icon_16.png" class="icon"> in the extension toolbar or on the webpage. It
  45. allows you to save: <ul>
  46. <li>the current tab,</li>
  47. <li>or the selected content,</li>
  48. <li>or the selected frame.</li>
  49. </ul>
  50. </li>
  51. <li>You can also process multiple tabs in one click and save: <ul>
  52. <li id="selectableTabsMenu">the selected tabs,</li>
  53. <li>or the unpinned tabs,</li>
  54. <li>or all the tabs.</li>
  55. </ul>
  56. </li>
  57. <li id="autoSaveMenu">The context menu also allows you to activate the auto-save of: <ul>
  58. <li>the current tab,</li>
  59. <li>or the unpinned tabs,</li>
  60. <li>or all the tabs.</li>
  61. </ul>
  62. </li>
  63. <li>You can highlight text, add notes, format and remove content before saving the page with the <a
  64. href="#annotation-editor">Annotation editor</a> by selecting "Annotate and save the page..."
  65. in the context menu</li>
  66. <li id="autoSaveHint">With auto-save active, pages are automatically saved every time after being
  67. loaded (or before
  68. being unloaded if not). </li>
  69. <li>Select "Save Selection" from the context menu without selecting any content first to display a
  70. selector that will help you choose content by hovering over it with the mouse.</li>
  71. <li>Right-click on the SingleFile button and select "Options" to open the options page.</li>
  72. <li id="saveToGDriveHint">Enable the option "Destination &gt; upload to Google Drive" to upload
  73. pages to Google Drive</li>
  74. <li id="shortcutsSection">You can use the customizable shortcut Ctrl+Shift+Y to save the current tab
  75. or the selected tabs.
  76. Go to about:addons and select "Manage extension shortcuts" in the cogwheel menu to change it in
  77. Firefox. Go to chrome://extensions/shortcuts to change it in Chrome..</li>
  78. <li>The default save folder is the download folder configured in your browser, cf. about:preferences
  79. in Firefox, chrome://settings in Chrome, and Settings > General > File download location in
  80. Safari.</li>
  81. </ul>
  82. </li>
  83. <li><a id="options">Options description</a>
  84. <p>You can customize SingleFile through the options page. Right-click on SingleFile button <img
  85. src="../resources/icon_16.png" class="icon"> in the browser toolbar and select "Options"/"Manage
  86. extension" in the context menu to open the options page.</p>
  87. <p>Profiles</p>
  88. <ul>
  89. <li>
  90. <p>A profile is a set of user-defined options associated to a unique name.</p>
  91. <p>The drop-down list in the upper right of the options page allows you to select a profile and
  92. modify the associated options. The buttons next to the drop-down list allows you
  93. respectively to create, delete and rename a profile. </p>
  94. </li>
  95. <li>
  96. <p>You can select the default profile through the context menu of SingleFile. The selection is
  97. persistent and applied to all tabs. </p>
  98. </li>
  99. <li>
  100. <p>You can also override the default profile by associating a profile to a complete or partial
  101. URL. See the description of the <a href="#auto-settings-rules">Auto-settings rules</a>
  102. feature for more info. </p>
  103. </li>
  104. </ul>
  105. <p>User interface</p>
  106. <ul>
  107. <li data-options-label="addMenuEntryLabel"> <span class="option">Option: add entry in the context
  108. menu of the webpage</span>
  109. <p>Check this option to display an entry for SingleFile in the context menu of the webpage. The
  110. context menu of the SingleFile button <img src="../resources/icon_16.png" class="icon"> in
  111. the extension toolbar is displayed whether this option is checked or not. </p>
  112. <p class="notice">It is recommended to <u>check</u> this option</p>
  113. </li>
  114. <li data-options-label="shadowEnabledLabel"> <span class="option">Option: overlay a shadow on the
  115. page during processing</span>
  116. <p>Check this option to overlay a shadow on the page when SingleFile is retrieving page
  117. resources. This reminds you that you should not close the tab. </p>
  118. <p class="notice">It is recommended to <u>check</u> this option</p>
  119. </li>
  120. <li data-options-label="openSavedPageLabel" id="openSavedPageOption"> <span class="option">Option:
  121. open saved pages in a new tab</span>
  122. <p>Check this option to display the saved page in a new tab. This option can be useful, for
  123. example, in order to check the page is properly saved.</p>
  124. </li>
  125. <li data-options-label="autoCloseLabel"> <span class="option">Option: auto-close the tab after the
  126. page is saved</span>
  127. <p>Check this option to automatically close the tab after saving the page displayed inside. </p>
  128. </li>
  129. </ul>
  130. <p>File name</p>
  131. <ul>
  132. <li data-options-label="filenameTemplateLabel"> <span class="option">Option: template</span>
  133. <p>The template allows you to customize the file name of saved pages. You can use any valid
  134. character and "/" to create sub-folders (with the option "save pages in background" active).
  135. You can also use any variables from <a href="#template-variables">this list</a> and
  136. functions from <a href="#template-functions">this list</a> anywhere in the template.</p>
  137. <p>Invalid characters are automatically transformed and collapsed to underscores. File names
  138. cannot exceed 192 characters and are truncated if longer. The invalid characters are:
  139. <code>[</code> <code>~</code> <code>+</code> <code>\</code> <code>?</code> <code>%</code>
  140. <code>*</code> <code>:</code> <code>|</code> <code>"</code> <code>&lt;</code>
  141. <code>&gt;</code> and control characters from 0 to 31 in the ASCII table. When you want
  142. to customize the infobar, you can prefix the special characters <code>%</code>,
  143. <code>&lt;</code>, <code>&gt;</code>, <code>{</code>, <code>}</code> and <code>|</code> with
  144. <code>\</code> (e.g. <code>\&gt;</code>) to keep them in the infobar content.
  145. </p>
  146. <p>Template examples:</p>
  147. <ul>
  148. <li><code>{page-title} ({date-iso} {time-locale}).html</code> will produce filenames like
  149. "Introduction to SingleFile (2018-09-15 11_06_03 PM).html" for a page having
  150. "Introduction to SingleFile" as title.</li>
  151. <li><code>archives/{url-last-segment} - {date-iso}</code> will produce filenames like
  152. "welcome - 2018-09-15" for a page hosted on https://example.com/welcome.html. The saved
  153. files will be saved in the sub-directory "archives".</li>
  154. <li><code>archives/{year-locale}/{month-locale}/{day-locale}/{page-title}.html</code> will
  155. produce filenames like "Introduction to SingleFile.html" stored into 3 sub-directories
  156. in the "archives" folder, one for each part of the save date (e.g.
  157. "2018/9/15/Introduction to SingleFile.html").</li>
  158. </ul>
  159. </li>
  160. <li data-options-label="filenameMaxLengthLabel"> <span class="option">Option: max length</span>
  161. <p>Enter the maximum length of the filename (without the extension) and its unit (bytes or
  162. characters).</p>
  163. </li>
  164. <li data-options-label="filenameReplacementCharacterLabel"> <span class="option">Option: replacement
  165. character</span>
  166. <p>Enter the character used to replace invalid characters in the filename.</p>
  167. </li>
  168. <li data-options-label="replaceEmojisInFilenameLabel">
  169. <span class="option">Option: replace emojis with text</span>
  170. <p>Check this option to replace emojis in the file name with their unicode text representation.
  171. </p>
  172. </li>
  173. <li data-options-label="saveFilenameTemplateDataLabel">
  174. <span class="option">Option: save the filename template data into the page</span>
  175. <p>Check this option to save the template file data to the page. This allows you to recover
  176. template data previously used when saving the page and, for example, to ensure that the file
  177. is saved in the same directory as the original file when saving the page again.
  178. </p>
  179. </li>
  180. <li data-options-label="confirmFilenameLabel" id="confirmFilenameOption"> <span
  181. class="option">Option: open the "Save as"
  182. dialog to confirm the file name</span>
  183. <p>Check this option to display the "Save as" dialog in order to confirm the file name before
  184. saving the page. If the option "save pages in background" is unchecked then a prompt dialog
  185. will be displayed instead of the "Save as" dialog. </p>
  186. </li>
  187. <li data-options-label="filenameConflictActionLabel" id="filenameConflictActionOption"> <span
  188. class="option">Option: file name
  189. conflict resolution</span>
  190. <p>Choose the most appropriate action when the filename of the saved page is conflicting with
  191. existing ones on the filesystem. The "skip duplicate files" action only detects duplicates
  192. among files downloaded during the current browsing session.</p>
  193. </li>
  194. </ul>
  195. <p>File format</p>
  196. <ul>
  197. <li data-options-label="fileFormatSelectLabel">
  198. <span class="option">Option: format</span>
  199. <p>Select the output format of the saved file:
  200. </p>
  201. <ul>
  202. <li><code>"HTML"</code>: HTML file (default format). This format produces HTML files that do
  203. not depend on JavaScript to be opened.
  204. </li>
  205. <li><code>"self-extracting ZIP (universal)"</code>: self-extracting ZIP file that can be
  206. opened on any platform. This format produces files smaller than the "HTML" format but
  207. requires JavaScript to be enabled to open the file.
  208. </li>
  209. <li><code>"self-extracting ZIP"</code>: self-extracting ZIP file that can be
  210. opened on any platform from HTTP but not from the filesystem in some browsers (e.g.
  211. in browsers based on Chromium or WebKit) without SingleFile to be installed. This format
  212. produces files smaller (approx. 1%) than the "self-extracting ZIP (universal)" format.
  213. </li>
  214. <li><code>"ZIP"</code>: ZIP file. This format produces ZIP files that cannot be opened in a
  215. browser but can be opened in the annotation editor.
  216. </li>
  217. </ul>
  218. </li>
  219. <li data-options-label="passwordLabel">
  220. <span class="option">Option: password</span>
  221. <p>Type a password to encrypt the ZIP file with AES-256 (compatible with Winzip). Be careful, if
  222. you lose the password, it will be impossible to open the file. Enabling this option
  223. increases the CPU consumption and the time needed to save or read a page.</p>
  224. </p>
  225. </li>
  226. <li data-options-label="insertEmbeddedImageLabel">
  227. <span class="option">Option: embed image</span>
  228. <p>Check one of the options to embed an image when saving the page as a ZIP file
  229. (self-extracting or not). This allows you to display the saved page as a PNG image when
  230. the filename extension is changed to ".png".
  231. </p>
  232. </li>
  233. <li data-options-label="createRootDirectoryLabel">
  234. <span class="option">Option: create a root directory</span>
  235. <p>Check this option to create a root directory in the ZIP file. The directory name consists of
  236. a timestamp and the identifier of the tab where the saved page is displayed.
  237. </p>
  238. </li>
  239. <li data-options-label="preventAppendedDataLabel">
  240. <span class="option">Option: do not append data after the ZIP data</span>
  241. <p>Check this option to remove the data appended after the ZIP data. The resulting file may be
  242. easier to open with some archive managers that do not support ZIP files with appended data.
  243. Enabling this option increases the time needed to save a page.
  244. </p>
  245. </li>
  246. <li data-options-label="insertTextBodyLabel">
  247. <span class="option">Option: make text searchable</span>
  248. <p>Check this option to insert the text content of the saved page into the self-extracting ZIP
  249. file. This makes it possible, for example, to search for pages from the text. Note that if
  250. the selected format is "self-extracting ZIP (universal)", the text content is
  251. encoded in UTF-8 but the page is declared in ISO-8859-1.
  252. </p>
  253. </li>
  254. </ul>
  255. <p>HTML content</p>
  256. <ul>
  257. <li data-options-label="compressHTMLLabel"> <span class="option">Option: compress HTML
  258. content</span>
  259. <p>Check this option to remove all HTML comments and unneeded tags, spaces, quotes and
  260. whitespace characters. Checking this option helps to reduce the size of the file without
  261. altering the document.</p>
  262. <p class="notice">It is recommended to <u>check</u> this option</p>
  263. </li>
  264. <li data-options-label="removeHiddenElementsLabel"> <span class="option">Option: remove hidden
  265. elements</span>
  266. <p>Check this option to remove all hidden elements. Checking this option can help to reduce the
  267. size of the file without altering the document. It may also increase the CPU consumption and
  268. the time needed to save a page.</p>
  269. <p class="notice">It is recommended to <u>check</u> this option</p>
  270. </li>
  271. <li data-options-label="insertMetaCSPLabel"> <span class="option">Option: set content security
  272. policy</span>
  273. <p>Check this option to add a meta tag with a policy to block any external resources from being
  274. loaded.</p>
  275. <p class="notice">It is recommended to <u>check</u> this option</p>
  276. </li>
  277. <li data-options-label="removeFramesLabel"> <span class="option">Option: remove frames</span>
  278. <p>Check this option to remove all frame and iframe elements. Checking this option can
  279. considerably reduce the size of the file without altering the document most of the time. It
  280. may also decrease the time needed to save a page.</p>
  281. </li>
  282. <li data-options-label="saveOriginalURLsLabel"> <span class="option"></span>: save original
  283. URLs of embedded resources</span>
  284. <p>Check this option to save the URLs of the resources embedded into the saved page. URLs
  285. are stored in attributes with a name prefixed with "data-sf-original-" and suffixed with the
  286. original attribute name (e.g. "data-sf-original-src", "data-sf-original-href") for HTML
  287. contents. For CSS contents, URLs are stored as comments beginning with "original URL:".
  288. </li>
  289. <li data-options-label="removeInfobarSavedDateLabel">
  290. <span class="option">Option: do not include the saved date</span>
  291. <p>Check this option to remove the saved date included in the saved page and displayed in the
  292. infobar.</p>
  293. </li>
  294. <li data-options-label="saveRawPageLabel"> <span class="option">Option: save raw page</span>
  295. <p>Check this option to save the raw HTML file that the browser received. When this option is
  296. checked, the page will be saved as if JavaScript was disabled. Checking this option may
  297. alter the document.</p>
  298. <p class="notice">It is recommended to <u>uncheck</u> this option</p>
  299. </li>
  300. </ul>
  301. <p>Infobar</p>
  302. <ul>
  303. <li data-options-label="displayInfobarLabel" id="displayInfobarOption"> <span class="option">Option:
  304. display an infobar when
  305. viewing a saved page</span>
  306. <p>Check this option to display the ℹ button at the top right of the page when viewing a saved
  307. page. By clicking this button, you can get more information about the saved date and open
  308. the original URL.</p>
  309. <p class="notice">It is recommended to <u>check</u> this option</p>
  310. </li>
  311. <li data-options-label="infobarTemplateLabel"> <span class="option">Option: template of the infobar
  312. content</span>
  313. <p>The template allows you to customize the content displayed in the infobar. You can use any
  314. valid character, <code>\n</code> for new lines or <code>\t</code> for tabs. You can also use
  315. any variables from <a href="#template-variables">this list</a> anywhere in the template. If
  316. the template or the resulting content is empty, the infobar will display the saved date by
  317. default. </p>
  318. <p>Template examples:</p>
  319. <ul>
  320. <li><code>{url-href} ({date-iso})</code> will produce contents like "https://www.example.com
  321. (2018-09-15 11 06 03 PM)".</li>
  322. <li><code>Title: {page-title}</code> will produce contents like "Title: Example Domain" for
  323. a page having "Example Domain" as title.</li>
  324. </ul>
  325. </li>
  326. <li data-options-label="confirmInfobarLabel"> <span class="option">Option: open a prompt dialog to
  327. edit the infobar content</span>
  328. <p>Check this option to display a prompt dialog in order to confirm the infobar content before
  329. saving the page. </p>
  330. </li>
  331. <li data-options-label="includeInfobarLabel"> <span class="option"></span>Option: include infobar in
  332. the saved page</span>
  333. <p>Check this option to display the ℹ button at the top right of the page when viewing a saved
  334. page in a browser where SingleFile is not installed.</p>
  335. </li>
  336. <li data-options-label="openInfobarLabel"> <span class="option"></span>Option: keep infobar
  337. open</span>
  338. <p>Check this option to keep the infobar open when viewing a saved page.</p>
  339. </li>
  340. </ul>
  341. <p>Stylesheets</p>
  342. <ul>
  343. <li data-options-label="removeUnusedStylesLabel"> <span class="option">Option: remove unused
  344. styles</span>
  345. <p>Check this option to remove all the CSS rules and styles that do not match any element in the
  346. saved page. Checking this option will not alter the document and can considerably reduce the
  347. size of the file. It will also increase the CPU consumption and the time needed to save a
  348. page.</p>
  349. <p class="notice">It is recommended to <u>check</u> this option</p>
  350. </li>
  351. <li data-options-label="removeAlternativeMediasLabel"> <span class="option">Option: remove
  352. stylesheets for alternative devices to screens</span>
  353. <p>Check this option to remove stylesheets that are not used for the screen display like
  354. stylesheets for print preview and speech synthesizers. Checking this option can help to
  355. reduce the size of the file.</p>
  356. </li>
  357. <li data-options-label="compressCSSLabel"> <span class="option">Option: compress CSS content</span>
  358. <p>Check this option to minify CSS stylesheets. Checking this option can reduce size of the file
  359. without altering the document. It may also increase the CPU consumption and the time needed
  360. to save a page.</p>
  361. <p class="notice">It is recommended to <u>uncheck</u> this option</p>
  362. </li>
  363. <li data-options-label="groupDuplicateStylesheetsLabel"> <span class="option">Option: group
  364. duplicate stylesheets together</span>
  365. <p>Check this option to group together all the duplicate inline stylesheets. Checking this
  366. option should not alter the document and can considerably reduce the size of the file. This
  367. option is ignored with archive formats based on ZIP files. Please note that this option
  368. requires JavaScript to be enabled in order to function properly.</p>
  369. <p class="notice">It is recommended to <u>uncheck</u> this option</p>
  370. </li>
  371. <li data-options-label="moveStylesInHeadLabel"> <span class="option">Option: move in the head
  372. element the styles found outside of it</span>
  373. <p>
  374. Check this option to move all the style elements found outside the head element into the
  375. head element. This can be useful to avoid a FOUC ("flash of unstyled content") when
  376. displaying a saved page.</p>
  377. <p class="notice">It is recommended to <u>uncheck</u> this option</p>
  378. </li>
  379. </ul>
  380. <p>Images</p>
  381. <ul>
  382. <li data-options-label="groupDuplicateImagesLabel"> <span class="option">Option: group duplicate
  383. images together</span>
  384. <p>Check this option to avoid saving multiple times duplicate images. Checking this option
  385. should not alter the document in modern browsers and can considerably reduce the size of the
  386. file. This option is ignored with archive formats based on ZIP files.</p>
  387. <p class="notice">It is recommended to <u>check</u> this option</p>
  388. </li>
  389. <li data-options-label="loadDeferredImagesLabel"> <span class="option">Option: save deferred
  390. images</span>
  391. <p>Check this option to save all the deferred images (or frames) that are not yet displayed.
  392. This may help to save all the images without scrolling the page. This feature does its best
  393. effort and is not guaranteed to work on all sites. It will also increase the time needed to
  394. save a page.
  395. </p>
  396. <p class="notice">It is recommended to <u>check</u> this option</p>
  397. </li>
  398. <li data-options-label="loadDeferredImagesMaxIdleTimeLabel"> <span class="option">Option: maximum
  399. idle time (ms)</span>
  400. <p>Enter the maximum delay of time to wait for deferred images. You can increase this value if
  401. for example the network or system conditions are degraded. You can also decrease this value
  402. otherwise.</p>
  403. </li>
  404. <li data-options-label="loadDeferredImagesDispatchScrollEventLabel"> <span class="option">Option:
  405. dispatch "scroll" event</span>
  406. <p>Check this option to dispatch the <a
  407. href="https://developer.mozilla.org/docs/Web/API/Document/scroll_event"
  408. target="_blank">"scroll"
  409. event</a> when waiting for deferred images. This can improve the loading of images
  410. on some sites but it can also cause unexpected scrolling problems on some other sites.</p>
  411. <p class="notice">It is recommended to <u>uncheck</u> this option</p>
  412. </li>
  413. <li data-options-label="loadDeferredImagesKeepZoomLevelLabel"> <span class="option">Option: zoom out
  414. the page</span>
  415. <p>Check this option to save the entire content of a page by zooming out the page. This can help
  416. saving pages using infinite virtual lists for example. </p>
  417. <p class="notice">It is recommended to <u>uncheck</u> this option</p>
  418. </li>
  419. <li data-options-label="loadDeferredImagesBeforeFramesLabel"> <span class="option">Option: load
  420. deferred frames</span>
  421. <p>Check this option to load deferred frames and images before saving frame contents. It will
  422. increase the time needed to save a page.
  423. </p>
  424. <p class="notice">It is recommended to <u>uncheck</u> this option</p>
  425. </li>
  426. <li data-options-label="removeAlternativeImagesLabel"> <span class="option">Option: remove images
  427. for alternative screen resolutions</span>
  428. <p>Check this option to remove images that are alternatives in lower and/or higher resolutions
  429. to the ones displayed by default. Checking this option can considerably reduce the size of
  430. the file.</p>
  431. </li>
  432. </ul>
  433. <p>Fonts</p>
  434. <ul>
  435. <li data-options-label="removeUnusedFontsLabel"> <span class="option">Option: remove unused
  436. fonts</span>
  437. <p>Check this option to remove all font CSS rules that do not match any content. Checking this
  438. option should not alter the document and can considerably reduce the size of the file.</p>
  439. <p class="notice">It is recommended to <u>check</u> this option</p>
  440. </li>
  441. <li data-options-label="removeAlternativeFontsLabel"> <span class="option">Option: remove
  442. alternative fonts</span>
  443. <p>Check this option to remove fonts that are alternatives to the ones used. Checking this
  444. option should not alter the document and can considerably reduce the size of the file.</p>
  445. <p class="notice">It is recommended to <u>check</u> this option</p>
  446. </li>
  447. </ul>
  448. <p>Destination</p>
  449. <ul>
  450. <li data-options-label="saveToFilesystemLabel"> <span class="option">Option: save to
  451. filesystem</span>
  452. <p>Check this option to save the downloaded page on the filesystem of your computer.</p>
  453. <p class="notice">It is recommended to <u>check</u> this option</p>
  454. </li>
  455. <li data-options-label="sharePageLabel" id="sharePageInput"> <span class="option">Option: share
  456. page</span>
  457. <p>Check this option to share the page with other applications. This option is only available in
  458. browsers supporting the <a href="https://web.dev/web-share/" target="_blank">Web Share
  459. API</a>.
  460. <p class="notice">It is recommended to <u>uncheck</u> this option</p>
  461. </li>
  462. <li data-options-label="saveToClipboardLabel" id="saveToClipboardOption"> <span
  463. class="option">Option: copy to clipboard</span>
  464. <p>Check this option to copy the page to the clipboard. This option does not work with
  465. archive formats based on ZIP files.</p>
  466. <p class="notice">It is recommended to <u>uncheck</u> this option</p>
  467. </li>
  468. <li data-options-label="saveToGitHubLabel"> <span class="option">Option: upload to GitHub</span>
  469. <p>Check this option to save the page on GitHub. See the <a
  470. href="https://github.com/gildas-lormeau/SingleFile/wiki/How-to-publish-saved-pages-with-SingleFile-on-GitHub"
  471. target="_blank">documentation page</a> to learn how to configure SingleFile to save
  472. pages on GitHub. Warning: once a page saved on GitHub, it is complicated to delete it, see
  473. the <a
  474. href="https://docs.github.com/github/authenticating-to-github/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository"
  475. target="_blank">documentation page</a> on GitHub for more information.</p>
  476. <p class="notice">It is recommended to <u>uncheck</u> this option</p>
  477. </li>
  478. <li data-options-label="githubTokenLabel"> <span class="option">Option: access token</span>
  479. <p>Enter your personal access token on GitHub, see the <a
  480. href="https://docs.github.com/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token"
  481. target="_blank">documentation page</a> on GitHub for more information.</p>
  482. </li>
  483. <li data-options-label="githubUserLabel"> <span class="option">Option: user name</span>
  484. <p>Enter your user name on GitHub.</p>
  485. </li>
  486. <li data-options-label="githubRepositoryLabel"> <span class="option">Option: repository name</span>
  487. <p>Enter the name of the repository on GitHub where the saved pages will be archived, see
  488. the <a
  489. href="https://docs.github.com/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-new-repository"
  490. target="_blank">documentation page</a> on GitHub for more information on how to create a
  491. repository.
  492. </p>
  493. </li>
  494. <li data-options-label="githubBranchLabel"> <span class="option">Option: branch name</span>
  495. <p>Enter the repository branch name where pages will be archived. The branch
  496. <strong>must</strong> exist on GitHub, see the <a
  497. href="https://docs.github.com/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site"
  498. target="_blank">documentation page</a> on GitHub for more information on how to publish
  499. the branch on github.io.
  500. </p>
  501. </li>
  502. <li data-options-label="saveWithWebDAVLabel"> <span class="option">Option: upload to a WebDAV
  503. server</span>
  504. <p>Check this option to save the page on a WebDAV server.</p>
  505. <p class="notice">It is recommended to <u>uncheck</u> this option</p>
  506. </li>
  507. <li data-options-label="webDAVURLLabel"> <span class="option">Option: URL</span>
  508. <p>Enter the URL of the WebDAV server.</p>
  509. </li>
  510. <li data-options-label="webDAVUserLabel"> <span class="option">Option: user identifier</span>
  511. <p>Enter your user identifier on the WebDAV server.</p>
  512. </li>
  513. <li data-options-label="webDAVPasswordLabel"> <span class="option">Option: password</span>
  514. <p>Enter your password.</p>
  515. </li>
  516. <li data-options-label="saveToGDriveLabel" id="saveToGDriveOption"> <span class="option">Option:
  517. upload to Google Drive</span>
  518. <p>Check this option to save the page on Google Drive.</p>
  519. <p>The permissions requested by SingleFile allow it to access only to the files and folders it
  520. has created. When you uncheck this option, SingleFile revokes automatically its access to
  521. your Google Drive account.</p>
  522. <p class="notice">It is recommended to <u>uncheck</u> this option</p>
  523. </li>
  524. <li data-options-label="saveToS3Label" id="saveToS3Option"> <span class="option">Option: upload to
  525. Amazon S3</span>
  526. <p>Check this option to save the page on Amazon S3. You must configure the bucket policy to
  527. include the permission <code>s3:PutObject</code>, and <code>s3:HeadObject</code> or
  528. <code>s3:ListObjects</code>, or <code>s3:GetObject</code> if you do not want to overwrite or
  529. skip existing files in the event of a filename conflict.
  530. </p>
  531. <p class="notice">It is recommended to <u>uncheck</u> this option</p>
  532. </li>
  533. <li data-options-label="S3DomainLabel"> <span class="option">Option: domain</span>
  534. <p>Enter the domain of the Amazon S3 server (e.g. <code>s3.amazonaws.com</code>).</p>
  535. </li>
  536. <li data-options-label="S3RegionLabel"> <span class="option">Option: region</span>
  537. <p>Enter the region of the Amazon S3 server (e.g. <code>us-east-1</code>).</p>
  538. </li>
  539. <li data-options-label="S3BucketLabel"> <span class="option">Option: bucket name</span>
  540. <p>Enter the name of the bucket on Amazon S3 where the saved pages will be archived. Pages will
  541. be uploaded to <code>&lt;bucket name&gt;.&lt;domain&gt;</code></p>.
  542. </li>
  543. <li data-options-label="S3AccessKeyLabel"> <span class="option">Option: access key</span>
  544. <p>Enter your access key on Amazon S3 (e.g. <code>AKDO525K84LJTH4SFAKE</code>).</p>
  545. </li>
  546. <li data-options-label="S3SecretKeyLabel"> <span class="option">Option: secret key</span>
  547. <p>Enter your secret key on Amazon S3.</p>
  548. </li>
  549. <li data-options-label="saveToDropboxLabel" id="saveToDropboxOption"> <span class="option">Option:
  550. upload to Dropbox</span>
  551. <p>Check this option to save the page on Dropbox.</p>
  552. <p>The permissions requested by SingleFile allow it to access only to the files and folders it
  553. has created.</p>
  554. <p class="notice">It is recommended to <u>uncheck</u> this option</p>
  555. </li>
  556. <li data-options-label="saveWithCompanionLabel" id="saveWithCompanionOption"> <span
  557. class="option">Option: save with
  558. SingleFile Companion</span>
  559. <p>Check this option to delegate the saving process to SingleFile Companion. It is a program
  560. that runs outside the browser and can help to make the saving process more transparent. It
  561. also allows the pages to be saved in another directory than the download directory. You can
  562. find more info <a href="https://github.com/gildas-lormeau/single-file-companion"
  563. target="_blank">here</a></p>
  564. <p class="notice">It is recommended to <u>uncheck</u> this option</p>
  565. </li>
  566. <li data-options-label="saveToRestFormApiLabel"> <span class="option">Option: upload to a REST Form
  567. API</span>
  568. <p>Check this option to save the page on an API endpoint accepting form data.</p>
  569. <p class="notice">It is recommended to <u>uncheck</u> this option</p>
  570. </li>
  571. <li data-options-label="saveToRestFormApiUrlLabel"> <span class="option">Option: URL</span>
  572. <p>Enter the URL of the API endpoint.</p>
  573. </li>
  574. <li data-options-label="saveToRestFormApiTokenLabel"> <span class="option">Option: authorization
  575. token</span>
  576. <p>Provide the the value of the "Bearer" token to authenticate the request.</p>
  577. </li>
  578. <li data-options-label="saveToRestFormApiFileFieldNameLabel"> <span class="option">Option: archive
  579. data field name</span>
  580. <p>Enter the name of the field that will contain the data of the saved page.</p>
  581. </li>
  582. <li data-options-label="saveToRestFormApiUrlFieldNameLabel"> <span class="option">Option: archive
  583. URL field name</span>
  584. <p>Enter the name of the field that will contain the URL of the saved page.</p>
  585. </li>
  586. </ul>
  587. <p>Network</p>
  588. <ul>
  589. <li data-options-label="blockResourcesLabel"> <span class="option">Option: blocked resources</span>
  590. <p>
  591. Check the options below to block the download of the corresponding resource types.
  592. </p>
  593. </li>
  594. <li data-options-label="blockMixedContentLabel"> <span class="option">Option: block mixed
  595. contents</span>
  596. <p>Check this option to block active content served from HTTP when viewing a page in HTTPS. You
  597. can find more information about mixed content pages <a
  598. href="https://developer.mozilla.org/docs/Web/Security/Mixed_content"
  599. target="_blank">here</a>.</p>
  600. </li>
  601. <li data-options-label="acceptHeadersLabel"> <span class="option">Option: "Accept" headers</span>
  602. <p>
  603. Enter the <a href="https://developer.mozilla.org/docs/Web/HTTP/Headers/Accept"
  604. target="_blank">"Accept" HTTP
  605. header</a> values below to adjust support for the corresponding resource types.
  606. </p>
  607. <p class="notice">It is recommended to leave these values <u>as they are</u></p>
  608. </li>
  609. <li data-options-label="setMaxResourceSizeLabel"> <span class="option">Option: set maximum size
  610. (MB)</span>
  611. <p>Check this option to remove from the saved page embedded resources (i.e. images, stylesheets,
  612. scripts and iframes) that exceeds a given size.</p>
  613. </li>
  614. <li data-options-label="maxResourceSizeLabel"> <span class="option">Option: maximum size (MB)</span>
  615. <p>Enter the maximum size in megabytes.</p>
  616. </li>
  617. <li data-options-label="setMaxResourceDelayLabel"> <span class="option">Option: set maximum
  618. download delay (s)</span>
  619. <p>Check this option to remove from the saved page embedded resources (i.e. images, stylesheets,
  620. scripts and iframes) that exceeds a given download time.</p>
  621. </li>
  622. <li data-options-label="maxResourceDelayLabel"> <span class="option">Option: maximum download delay
  623. (s)</span>
  624. <p>Enter the maximum download delay in seconds.</p>
  625. </li>
  626. <li data-options-label="passReferrerOnErrorLabel" id="passReferrerOnErrorOption"> <span
  627. class="option">Option: pass \"Referer\"
  628. header on
  629. cross-origin errors</span>
  630. <p>Check this option to pass the HTTP header "Referer" with the "origin" policy after an 401,
  631. 403, or 404 HTTP error when downloading a cross-origin resource. You should enable this
  632. option if you cannot download resources blocked by a hotlink protection.</p>
  633. <p class="notice">It is recommended to <u>uncheck</u> this option</p>
  634. </li>
  635. </ul>
  636. <p>Annotation editor</p>
  637. <ul>
  638. <li data-options-label="defaultEditorModeLabel"> <span class="option">Option: default mode</span>
  639. <p>Select the default mode when opening the annotation editor. The available choices are:
  640. <ul>
  641. <li><code>normal</code>: default value</li>
  642. <li><code>edit the page</code>: enable the button <img
  643. src="../resources/button_note_edit.png" class="icon button"></li>
  644. <li><code>format the page</code>: enable the button <img
  645. src="../resources/button_note_format.png" class="icon button"> if the page can be
  646. formatted</li>
  647. <li><code>remove elements</code>: enable the button <img
  648. src="../resources/button_cut_inner.png" class="icon button"></li>
  649. <li><code>remove external elements</code>: enable the button <img
  650. src="../resources/button_cut_outer.png" class="icon button"></li>
  651. </ul>
  652. </p>
  653. </li>
  654. <li data-options-label="applySystemThemeLabel"> <span class="option">Option: apply the system theme
  655. when formatting a page in the annotation editor</span>
  656. <p>Uncheck this option if you do not want to apply the theme of the operating system or the
  657. browser (e.g. dark or light) when you click on the button "Format the page for better
  658. readability" in the annotation editor.</p>
  659. </li>
  660. <li data-options-label="warnUnsavedPageLabel"> <span class="option">Option: warn if leaving page
  661. with unsaved changes</span>
  662. <p>Check this option to display a blocking popup when you leave the annotation editor (e.g.
  663. close the tab) without saving the changes.</p>
  664. <p class="notice">It is recommended to <u>check</u> this option</p>
  665. </li>
  666. <li data-options-label="openEditorLabel"> <span class="option">Option: edit page before
  667. saving</span>
  668. <p>Check this option to open the annotation editor before saving any page. Checking this option
  669. removes the entry "Annotate and save the page..." from the context menu.</p>
  670. <p class="notice">It is recommended to <u>uncheck</u> this option</p>
  671. </li>
  672. <li data-options-label="autoOpenEditorLabel" id="autoOpenEditorOption"> <span class="option">Option:
  673. open the annotation editor when viewing a page saved with SingleFile</span>
  674. <p>Check this option to open the annotation editor when displaying a page saved by SingleFile.
  675. </p>
  676. <p class="notice">It is recommended to <u>uncheck</u> this option</p>
  677. </li>
  678. <li data-options-label="displayInfobarInEditorLabel"> <span class="option">Option:
  679. display the infobar</span>
  680. <p>Check this option to display the infobar when displaying a page in the annotation editor.</p>
  681. <p class="notice">It is recommended to <u>uncheck</u> this option</p>
  682. </p>
  683. </li>
  684. </ul>
  685. <p id="bookmarksSection">Bookmarks</p>
  686. <ul id="bookmarksOptions">
  687. <li data-options-label="saveCreatedBookmarksLabel"> <span class="option">Option: save the page of a
  688. newly created bookmark</span>
  689. <p>Check this option to save pages that you add into your bookmarks. Note that if the page is to
  690. be saved is not already displayed in a tab, SingleFile will open temporarily a new tab to
  691. save the page. </p>
  692. <p class="notice">It is recommended to <u>uncheck</u> this option</p>
  693. </li>
  694. <li data-options-label="replaceBookmarkURLLabel"> <span class="option">Option: link the new bookmark
  695. to the saved page</span>
  696. <p>Check this option to replace the URL of the page added into your bookmark with the file URI
  697. of the saved page on your disk. </p>
  698. <p class="notice">It is recommended to <u>uncheck</u> this option</p>
  699. </li>
  700. <li data-options-label="ignoredBookmarkFoldersLabel"> <span class="option">Option: ignored
  701. folders</span>
  702. <p>Enter a list of bookmark folder names to ignore. The folder names must be separated with a
  703. comma. SingleFile will ignore bookmarks added in folders that contains these names.
  704. </p>
  705. </li>
  706. <li data-options-label="allowedBookmarkFoldersLabel"> <span class="option">Option: allowed
  707. folders</span>
  708. <p>Enter a list of bookmark folder names to allow. The folder names must be separated with a
  709. comma. SingleFile will only save pages added in folders that contains these names.
  710. </p>
  711. </li>
  712. </ul>
  713. <p id="autoSaveSection">Auto-save</p>
  714. <ul id="autoSaveOptions">
  715. <li data-options-label="autoSaveLoadOrUnloadLabel"> <span class="option">Option: auto-save after
  716. page load or on page unload</span>
  717. <p>Check this option to auto-save pages after being loaded. If you browse to another page before
  718. the page is fully loaded then the page will be saved just before being unloaded. With this
  719. option active, you are guaranteed pages will always be saved. Some frame contents may be
  720. missing (if you checked "remove frames") when pages are saved before being unloaded. </p>
  721. </li>
  722. <li data-options-label="autoSaveLoadLabel"> <span class="option">Option: auto-save after page
  723. load</span>
  724. <p>Check this option to auto-save pages after being loaded.</p>
  725. </li>
  726. <li data-options-label="autoSaveUnloadLabel"> <span class="option">Option: auto-save on page
  727. unload</span>
  728. <p>Check this option to auto-save pages before being unloaded instead of saving pages after
  729. being loaded. With this option active, you are guaranteed pages will always be saved but
  730. some frame contents may be missing (if you checked "remove frames"). </p>
  731. </li>
  732. <li data-options-label="autoSaveDiscardLabel"> <span class="option">Option: auto-save on tab
  733. discard</span>
  734. <p>Check this option to auto-save pages when discarding a tab. Some frame contents may be
  735. missing (if you checked "remove frames"). </p>
  736. </li>
  737. <li data-options-label="autoSaveRemoveLabel"> <span class="option">Option: auto-save on tab
  738. removal</span>
  739. <p>Check this option to auto-save pages when closing a tab. Some frame contents may be missing
  740. (if you checked "remove frames"). </p>
  741. </li>
  742. <li data-options-label="autoSaveDelayLabel"> <span class="option">Option: auto-save waiting delay
  743. after load (s)</span>
  744. <p>Enter the delay in seconds to wait before saving a page when the "auto-save on page load or
  745. on page unload" or "auto-save on page load" is checked. </p>
  746. </li>
  747. <li data-options-label="autoSaveRepeatLabel"> <span class="option">Option: auto-save
  748. periodically</span>
  749. <p>Check this option to auto-save pages periodically after load.</p>
  750. </li>
  751. <li data-options-label="autoSaveRepeatDelayLabel"> <span class="option">Option: period (s)</span>
  752. <p>Enter the delay in seconds to wait before each page saving when the "auto-save
  753. periodically" option is checked. </p>
  754. </li>
  755. <li data-options-label="autoSaveExternalSaveLabel"> <span class="option">Option: save the page with
  756. SingleFile Companion</span>
  757. <p>Check this option to delegate the capturing and saving process to SingleFile Companion. It is
  758. a program that runs outside the browser and can help to make the saving process more
  759. transparent. It also allows the pages to be saved in another directory than the download
  760. directory. You can find more info <a
  761. href="https://github.com/gildas-lormeau/single-file-companion" target="_blank">here</a>
  762. </p>
  763. </li>
  764. </ul>
  765. <p>Misc.</p>
  766. <ul>
  767. <li data-options-label="addProofLabel"> <span class="option">Option: add proof of existence</span>
  768. <p>Check this option to create a worldwide proof of the existence of the page you want to save.
  769. </p>
  770. <ul>
  771. <li> <strong>What is a proof of existence (data anchoring)?</strong><br> Data anchoring
  772. consists in building a time-stamped proof of existence for a data by linking it to a
  773. tamper resistant and time-stamped blockchain. Data anchoring implementation relies on
  774. the resilience and immutability of the Bitcoin blockchain to provide the best possible
  775. security level </li>
  776. <li> <strong>How does this protect my data?</strong><br> The anchoring mechanism only
  777. handles data impressions. Your data remains where you calculate the fingerprints, i.e.
  778. in the browser. Their confidentiality is totally preserved. </li>
  779. <li> <strong> The day after your backup you can get freely the proof receipt here: <a
  780. href="https://gildas-lormeau.github.io/singlefile-woleet/index.html"
  781. target="_blank">gildas-lormeau.github.io/singlefile-woleet/index.html</a>.
  782. A proof receipt will be used to verify the validity of the evidence </strong> </li>
  783. </ul>
  784. <p> More information <a href="https://doc.woleet.io" target="_blank">doc.woleet.io</a> </p>
  785. </li>
  786. <li data-options-label="woleetKeyLabel" hidden> <span class="option">Option: access token</span>
  787. <p>Enter your personal access token on Woleet, see the <a href="http://app.woleet.io/"
  788. target="_blank">registration page</a> on Woleet for more information.</p>
  789. </li>
  790. <li data-options-label="backgroundSaveLabel" id="backgroundSaveOption"> <span class="option">Option:
  791. save pages in
  792. background</span>
  793. <p>Uncheck this option if you get invalid file names like
  794. "37bec68b-446a-46a5-8642-19a89c231b46.html" or interrupted downloads when saving pages. You
  795. can also uncheck this option if you want the "Save as" dialog to remember the last saved
  796. path. Unchecking this option prevent using sub-directories in filename templates.</p>
  797. <p class="notice">It is recommended to <u>check</u> this option</p>
  798. </li>
  799. <li data-options-label="displayStatsLabel"> <span class="option">Option: display stats in the
  800. console after processing</span>
  801. <p>Check this option to display stats about processing in the JavaScript developer tools of your
  802. browser. Checking this option may increase the CPU consumption and the time needed to save a
  803. page. </p>
  804. <p class="notice">It is recommended to <u>uncheck</u> this option</p>
  805. </li>
  806. </ul>
  807. <p id="auto-settings-rules">Auto-settings rules</p>
  808. <ul>
  809. <li>The auto-settings rules let you associate a complete or partial URL with a profile. It also
  810. allows to associate a specific profile for the auto-save, or to disable it (check "display
  811. 'Auto-save profile' column"). When two or more rules match a URL of a page to save, the rule
  812. with the longest URL will be chosen. The special profile "-" means the current profile. </li>
  813. <li>You can use the special value "*" as URL to create a rule that applies to all URLs</li>
  814. <li>You can use regular expressions by prefixing the URL with "regexp:" (e.g. "regexp:.*\.com" to
  815. match all URLs containing ".com"). When zero or more rules based on URLs and one or more rules
  816. based on regular expressions match a URL, the longest rule based on regular expression will be
  817. chosen. </li>
  818. </ul>
  819. <p>Form buttons</p>
  820. <ul>
  821. <li><span class="option">synchronize options</span>
  822. <p>Check this option to synchronize your options and make them available in all instances of the
  823. browser you are logged into, on different devices.</p>
  824. </li>
  825. <li><span class="option">Reset</span>
  826. <p>Reset all options to their default values.</p>
  827. </li>
  828. </ul>
  829. </li>
  830. <li><a id="annotation-editor">Annotation editor</a>
  831. <p>The annotation editor can be opened by selecting "Annotate and save the page" in the context menu or
  832. by enabling the option "Annotation editor &gt; edit page before saving". It allows you to:
  833. <ul>
  834. <li>add notes by clicking one of these buttons: <img src="../resources/button_note_yellow.png"
  835. class="icon button"> <img src="../resources/button_note_pink.png" class="icon button"> <img
  836. src="../resources/button_note_blue.png" class="icon button"> <img
  837. src="../resources/button_note_green.png" class="icon button"></li>
  838. <li>hide or show notes by clicking the button <img src="../resources/button_note_visible.png"
  839. class="icon button"></li>
  840. <li>highlight text by clicking one of these buttons: <img
  841. src="../resources/button_highlighter_yellow.png" class="icon button"> <img
  842. src="../resources/button_highlighter_pink.png" class="icon button"> <img
  843. src="../resources/button_highlighter_blue.png" class="icon button"> <img
  844. src="../resources/button_highlighter_green.png" class="icon button"></li>
  845. <li>hide or show highlighted text by clicking the button <img
  846. src="../resources/button_highlighter_visible.png" class="icon button"></li>
  847. <li>remove text highlighting by clicking the button <img
  848. src="../resources/button_highlighter_delete.png" class="icon button"></li>
  849. <li>edit the page by clicking the button <img src="../resources/button_note_edit.png"
  850. class="icon button"> </li>
  851. <li>format the page to improve readability (when possible) by clicking the button <img
  852. src="../resources/button_note_format.png" class="icon button"> </li>
  853. <li>remove contents by clicking the button <img src="../resources/button_cut_inner.png"
  854. class="icon button"> (inner elements) or <img src="../resources/button_cut_outer.png"
  855. class="icon button"> (outer elements)</li>
  856. <li>undo removes by clicking the button <img src="../resources/button_undo_cut.png"
  857. class="icon button"> or the button <img src="../resources/button_undo_all_cut.png"
  858. class="icon button"> (undo all)
  859. <li>redo removes by clicking the button <img src="../resources/button_redo_cut.png"
  860. class="icon button"></li>
  861. <li>print the page by clicking the button <img src="../resources/button_print.png"
  862. class="icon button"> or by pressing <code>Ctrl-P</code></li>
  863. <li>save the page by clicking the button <img src="../resources/button_download.png"
  864. class="icon button"> or by pressing <code>Ctrl-S</code></li>
  865. </ul>
  866. </p>
  867. <br>
  868. <p>
  869. You can use the following keyboard shortcuts when removing contents with <img
  870. src="../resources/button_cut_inner.png" class="icon button"> or <img
  871. src="../resources/button_cut_outer.png" class="icon button">:
  872. <ul>
  873. <li><code>Tab</code>: expand the selection</li>
  874. <li><code>Shift-Tab</code>: reduce the selection</li>
  875. <li><code>Space</code>: remove the selected element</li>
  876. <li><code>Ctrl-Z</code>: undo the last removal</li>
  877. <li><code>Ctrl-Shift-Z</code>: redo the last removal</li>
  878. <li><code>Ctrl</code>: select/unselect multiple elements, releasing the <code>Ctrl</code> key
  879. validates the selection</li>
  880. <li><code>Shift</code>: temporarily reverse the type of removal (i.e. removal of inner elements or
  881. removal of outer elements) on the last selected element and reset the other selected elements if
  882. any</li>
  883. <li><code>Escape</code>: reset selected elements</li>
  884. </ul>
  885. </p>
  886. </ul>
  887. </li>
  888. <li><a id="template-variables">Template variables</a>
  889. <p>The template variables are used to customize the infobar content or the file name of a saved page.
  890. They help to insert dynamic values like the save date or the page title.</p>
  891. <p> You can limit the length of a dynamic value by adding <code>[<em>maxByteSize</em>]</code> or
  892. <code>[<em>maxCharSize</em>ch]</code> just after the variable name. The <code>maxByteSize</code>
  893. value is the maximum length of the value in bytes (e.g. `{page-title}[20]` to limit the title to 20
  894. bytes). The <code>maxCharSize</code> value is the maximum length in characters (e.g.
  895. `{page-title}[10ch]` to limit the title to 10 characters).
  896. </p>
  897. <ul>
  898. <li><code>{navigator-language}</code>: the language of the browser</li>
  899. <li><code>{page-title}</code>: the title of the page</li>
  900. <li><code>{page-heading}</code>: the content of the H1 tag in the page</li>
  901. <li><code>{page-language}</code>: the language of the page</li>
  902. <li><code>{page-description}</code>: the description of the page</li>
  903. <li><code>{page-author}</code>: the author of the page</li>
  904. <li><code>{page-creator}</code>: the creator of the page</li>
  905. <li><code>{page-publisher}</code>: the publisher of the page</li>
  906. <li><code>{datetime-iso}</code>: the save date and time in the ISO format (e.g.
  907. "2018-09-15T22_38_26_317Z")</li>
  908. <li><code>{datetime-utc}</code>: the save date and time in UTC format (e.g. "Sat, 15 Sep 2018
  909. 22_38_26 GMT")</li>
  910. <li><code>{datetime-locale}</code>: the localized value of the date and time (e.g. "9_16_2018,
  911. 12_54_31 AM")</li>
  912. <li><code>{date-iso}</code>: the save date in the ISO format (e.g. "2018-09-15")</li>
  913. <li><code>{date-locale}</code>: the localized value of the save date (e.g. "16_09_2018")</li>
  914. <li><code>{time-iso}</code>: the save time in the ISO format (e.g. "22_38_26_317")</li>
  915. <li><code>{time-locale}</code>: the localized value of the save time (e.g. "00_38_26")</li>
  916. <li><code>{time-ms}</code>: the save time is ms since the Unix Epoch (e.g. 1563582018000)</li>
  917. <li><code>{day-utc}</code>: the day of the save date in UTC format (e.g. "15")</li>
  918. <li><code>{day-locale}</code>: the localized value of the day (e.g. "15")</li>
  919. <li><code>{month-utc}</code>: the month of the save date in UTC format (e.g. "09")</li>
  920. <li><code>{month-locale}</code>: the localized value of the month (e.g. "09")</li>
  921. <li><code>{year-utc}</code>: the year of the save date in UTC format (e.g. "2018")</li>
  922. <li><code>{year-locale}</code>: the localized value of the year (e.g. "2018")</li>
  923. <li><code>{hours-utc}</code>: the hour of the save date in UTC format (e.g. "20")</li>
  924. <li><code>{hours-locale}</code>: the localized value of the hour (e.g. "22")</li>
  925. <li><code>{minutes-utc}</code>: the minutes of the save date in UTC format (e.g. "38")</li>
  926. <li><code>{minutes-locale}</code>: the localized value of the minutes (e.g. "38")</li>
  927. <li><code>{seconds-utc}</code>: the seconds of the save date in UTC format (e.g. "31")</li>
  928. <li><code>{seconds-locale}</code>: the localized value of the seconds (e.g. "31")</li>
  929. <li><code>{visit-datetime-iso}</code>: the visit date and time in the ISO format (e.g.
  930. "2018-09-15T22_38_26_317Z")</li>
  931. <li><code>{visit-datetime-utc}</code>: the visit date and time in UTC format (e.g. "Sat, 15 Sep 2018
  932. 22_38_26 GMT")</li>
  933. <li><code>{visit-datetime-locale}</code>: the localized value of the date and time (e.g. "9_16_2018,
  934. 12_54_31 AM")</li>
  935. <li><code>{visit-date-iso}</code>: the visit date in the ISO format (e.g. "2018-09-15")</li>
  936. <li><code>{visit-date-locale}</code>: the localized value of the visit date (e.g. "16_09_2018")</li>
  937. <li><code>{visit-time-iso}</code>: the visit time in the ISO format (e.g. "22_38_26_317")</li>
  938. <li><code>{visit-time-locale}</code>: the localized value of the visit time (e.g. "00_38_26")</li>
  939. <li><code>{visit-time-ms}</code>: the visit time is ms since the Unix Epoch (e.g. 1563582018000)
  940. </li>
  941. <li><code>{visit-day-utc}</code>: the day of the visit date in UTC format (e.g. "15")</li>
  942. <li><code>{visit-day-locale}</code>: the localized value of the day (e.g. "15")</li>
  943. <li><code>{visit-month-utc}</code>: the month of the visit date in UTC format (e.g. "09")</li>
  944. <li><code>{visit-month-locale}</code>: the localized value of the month (e.g. "09")</li>
  945. <li><code>{visit-year-utc}</code>: the year of the visit date in UTC format (e.g. "2018")</li>
  946. <li><code>{visit-year-locale}</code>: the localized value of the year (e.g. "2018")</li>
  947. <li><code>{visit-hours-utc}</code>: the hour of the visit date in UTC format (e.g. "20")</li>
  948. <li><code>{visit-hours-locale}</code>: the localized value of the hour (e.g. "22")</li>
  949. <li><code>{visit-minutes-utc}</code>: the minutes of the visit date in UTC format (e.g. "38")</li>
  950. <li><code>{visit-minutes-locale}</code>: the localized value of the minutes (e.g. "38")</li>
  951. <li><code>{visit-seconds-utc}</code>: the seconds of the visit date in UTC format (e.g. "31")</li>
  952. <li><code>{visit-seconds-locale}</code>: the localized value of the seconds (e.g. "31")</li>
  953. <li><code>{url-href}</code>: the URL of the page (e.g. "http://example.com/category/index.html")
  954. </li>
  955. <li><code>{url-href-digest-sha-1}</code>: the SHA-1 hash value of the URL of the page (e.g.
  956. 4b826844d9f5c128533e4ff14d746334f3ac9e00)</li>
  957. <li><code>{url-href-flat}</code>: the URL of the page with replaced slashes (e.g.
  958. "http__example.com_category_index.html")</li>
  959. <li><code>{url-pathname}</code>: the path name of the URL (e.g. "category/index.html")</li>
  960. <li><code>{url-pathname-flat}</code>: the path name of the URL with replaced slashes (e.g.
  961. "category_index.html")</li>
  962. <li><code>{url-last-segment}</code>: the last part of the pathname (without the extension) or the
  963. host if not found (e.g. "index")</li>
  964. <li><code>{url-protocol}</code>: the protocol of the URL (e.g. "https")</li>
  965. <li><code>{url-host}</code>: the host name + the port of the URL (e.g. "example.com_8080")</li>
  966. <li><code>{url-hostname}</code>: the host name of the URL (e.g. "example.com")</li>
  967. <li><code>{url-hostname-suffix}</code>: the suffix of the host name of the URL (e.g. "com")</li>
  968. <li><code>{url-hostname-domain}</code>: the domain of the host name of the URL (e.g. "example")</li>
  969. <li><code>{url-hostname-root}</code>: the root of the host name of the URL (e.g. "example.com")</li>
  970. <li><code>{url-hostname-subdomains}</code>: the sub-domains of the host name of the URL (e.g.
  971. "sub" for "sub.example.com"), "www" is ignored</li>
  972. <li><code>{url-port}</code>: the port of the URL (e.g. "8080")</li>
  973. <li><code>{url-username}</code>: the user name of the URL (e.g. "john_doe")</li>
  974. <li><code>{url-password}</code>: the password of the URL (e.g. "qwerty123")</li>
  975. <li><code>{url-search}</code>: the search string of the URL (e.g. "order=ascending")</li>
  976. <li><code>{url-hash}</code>: the hash of the URL (e.g. "chapter-2")</li>
  977. <li><code>{url-referrer}</code>: the URI of the page that "linked" to the page (e.g.
  978. "http://example.com")</li>
  979. <li><code>{url-referrer-flat}</code>: the URI of the page that "linked" to the page with slashed
  980. replaced (e.g. "http_example.com")</li>
  981. <li><code>{bookmark-pathname}</code>: the path name of the newly created bookmark (e.g. "My
  982. Bookmarks/Last Month") when the option "Bookmarks &gt; save the page of a
  983. newly created bookmark" is enabled</li>
  984. <li><code>{bookmark-pathname-flat}</code>: the path name of the newly created bookmark with replaced
  985. slashes (e.g. "My Bookmarks_Last Month") when the option "Bookmarks &gt; save the page of a
  986. newly created bookmark" is enabled</li>
  987. <li><code>{tab-id}</code>: the unique identifier of the tab (e.g. "326")</li>
  988. <li><code>{tab-index}</code>: the index of the tab in the window (e.g. "1")</li>
  989. <li><code>{digest-sha-256}</code>: the SHA-256 hash value of the entire page content (e.g.
  990. e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855)</li>
  991. <li><code>{digest-sha-384}</code>: the SHA-384 hash value of the entire page content</li>
  992. <li><code>{digest-sha-512}</code>: the SHA-512 hash value of the entire page content</li>
  993. <li><code>{profile-name}</code>: the name of the profile used to save the page</li>
  994. <li><code>{filename-extension}</code>: the extension of the filename depending on the file format
  995. (i.e. "html", "u.zip.html", "zip.html", "zip")</li>
  996. <li><code>{save-action}</code>: the action used to save the page (i.e. "page", "selection")</li>
  997. <li><code>{options-json}</code>: the JSON representation of the options used to save the page. Each
  998. property name is written in camel case (e.g. "blockScripts")</li>
  999. <li><code>{options-text}</code>: the text representation of the options used to save the page. The
  1000. text representation is formatted with a list of options and their values separated by a line
  1001. break (e.g. "saveRawPage: false\includeInfobar: true...")</li>
  1002. </ul>
  1003. </li>
  1004. <li><a id="template-functions" href="#template-functions">Template functions</a>
  1005. <p>The template functions are used to format values in the template or to insert values depending on
  1006. parameters.</p>
  1007. <p>The syntax of a function call is <code>%<em>function-name</em>&lt;<em>parameter</em>&gt;</code>.
  1008. You can pass multiple parameters separated with a pipe character (e.g.
  1009. "%<em>function-name</em>&lt;<em>parameter1</em>|<em>parameter2</em>&gt;"). Like the template
  1010. variables, you can limit the length of a dynamic value by adding <code>[<em>maxByteSize</em>]</code>
  1011. or <code>[<em>maxCharSize</em>ch]</code> just after the function name.
  1012. </p>
  1013. <ul>
  1014. <li><code>%if-empty&lt;value|default&gt;</code>: returns the <code>default</code> value if
  1015. <code>value</code> is empty (e.g. "%if-empty&lt;{page-title}|Untitled&gt;" to return "Untitled"
  1016. if the page title is empty).
  1017. You also can pass multiple values separated with a pipe character (e.g.
  1018. "%if-empty&lt;{page-title}|{page-heading}|Untitled&gt;" to return the page heading if not empty,
  1019. the page title if not empty or "Untitled" if both are empty).
  1020. </li>
  1021. <li><code>%if-not-empty&lt;value|default&gt;</code>: returns the <code>default</code> value if
  1022. <code>value</code> is not empty (e.g. "%if-not-empty&lt;{page-title}({page-title})&gt; to return
  1023. the page title surrounded by parentheses if the page title is not empty).
  1024. You also can pass multiple values separated like with the function <code>%if-empty</code>.
  1025. </li>
  1026. <li><code>%if-equals&lt;value|expected|trueValue|falseValue&gt;</code>: returns the
  1027. <code>trueValue</code> if <code>value</code> equals <code>expected</code> or the
  1028. <code>falseValue</code> otherwise (e.g.
  1029. "%if-equals&lt;{page-title}|Untitled|{page-heading}|{page-title}&gt;"
  1030. to return the page heading if the page title equals "Untitled" or the page title otherwise).
  1031. <li><code>%if-not-equals&lt;value|expected|trueValue|falseValue&gt;</code>: returns the
  1032. <code>trueValue</code> if <code>value</code> does not equal <code>expected</code> or the
  1033. <code>falseValue</code> otherwise (e.g.
  1034. "%if-not-equals&lt;{page-title}|Untitled|{page-title}|{page-heading}&gt;"
  1035. to return the page title if the page title does not equal "Untitled" or the page heading
  1036. otherwise).
  1037. <li><code>%if-contains&lt;value|expected|trueValue|falseValue&gt;</code>: returns the
  1038. <code>trueValue</code> if <code>value</code> contains <code>expected</code> or the
  1039. <code>falseValue</code> otherwise (e.g.
  1040. "%if-contains&lt;{page-title}|Untitled|{page-heading}|{page-title}&gt;"
  1041. to return the page heading if the page title contains "Untitled" or the page title otherwise).
  1042. </li>
  1043. <li><code>%if-not-contains&lt;value|expected|trueValue|falseValue&gt;</code>: returns the
  1044. <code>trueValue</code> if <code>value</code> does not contain <code>expected</code> or the
  1045. <code>falseValue</code> otherwise (e.g.
  1046. "%if-not-contains&lt;{page-title}|Untitled|{page-title}|{page-heading}&gt;"
  1047. to return the page title if the page title does not contain "Untitled" or the page heading
  1048. otherwise).
  1049. </li>
  1050. <li><code>%substring&lt;value|start|end&gt;</code>: returns a substring of the <code>value</code>
  1051. (e.g. "%substring&lt;{page-title}|0|20&gt;" to return the first 20 characters of the page
  1052. title, "%substring&lt;{page-title}|5&gt;" to return the page title without the first 5
  1053. characters).
  1054. </li>
  1055. <li><code>%lowercase&lt;value&gt;</code>: returns the <code>value</code> in lowercase (e.g.
  1056. "%lowercase&lt;{page-title}&gt;" to return the page title in lowercase).
  1057. </li>
  1058. <li><code>%uppercase&lt;value&gt;</code>: returns the <code>value</code> in uppercase (e.g.
  1059. "%uppercase&lt;{page-title}&gt;" to return the page title in uppercase).
  1060. </li>
  1061. <li><code>%capitalize&lt;value&gt;</code>: returns the <code>value</code> with the first letter in
  1062. uppercase (e.g. "%capitalize&lt;{page-title}&gt;" to return the page title with the first letter
  1063. in uppercase).
  1064. </li>
  1065. <li><code>%replace&lt;value|search|replacement&gt;</code>: returns the <code>value</code> with
  1066. all <code>search</code> values replaced by <code>replacement</code> (e.g.
  1067. "%replace&lt;{page-title}| |_&gt;" to replace all spaces by underscores in the page title).
  1068. </li>
  1069. <li><code>%repeat&lt;value|count&gt;</code>: returns the <code>value</code> repeated
  1070. <code>count</code> times (e.g. "%repeat&lt;{page-title}|3&gt;" to repeat the page title 3
  1071. times).
  1072. </li>
  1073. <li><code>%index-of&lt;value|search|fromIndex&gt;</code>: returns the index of the first occurrence
  1074. of <code>search</code> in <code>value</code> (e.g. "%index-of&lt;{page-title}|"Title"&gt;" to
  1075. return the index of the first occurrence of the string "Title" in <code>page-title</code>).
  1076. </li>
  1077. <li><code>%last-index-of&lt;value|search|fromIndex&gt;</code>: returns the index of the last
  1078. occurrence of <code>search</code> in <code>value</code> (e.g.
  1079. "%last-index-of&lt;{page-title}|"Title"&gt;" to return the index of the last occurrence of the
  1080. string "Title" in <code>page-title</code>).
  1081. </li>
  1082. <li><code>%length&lt;value&gt;</code>: returns the length of the <code>value</code> (e.g.
  1083. "%length&lt;{page-title}&gt;" to return the length of the page title).
  1084. </li>
  1085. <li><code>%trim&lt;value&gt;</code>: returns the <code>value</code> with all leading and trailing
  1086. whitespace removed (e.g. "%trim&lt;{page-title}&gt;" to remove all leading and trailing
  1087. whitespace in the page title).
  1088. </li>
  1089. <li><code>%trim-left&lt;value&gt;</code>: returns the <code>value</code> with all leading
  1090. whitespace removed (e.g. "%trim-left&lt;{page-title}&gt;" to remove all leading whitespace in
  1091. the page title).
  1092. </li>
  1093. <li><code>%trim-right&lt;value&gt;</code>: returns the <code>value</code> with all trailing
  1094. whitespace removed (e.g. "%trim-right&lt;{page-title}&gt;" to remove all trailing whitespace in
  1095. the page title).
  1096. </li>
  1097. <li><code>%pad-left&lt;value|length|pad&gt;</code>: returns the <code>value</code> with
  1098. <code>pad</code> added to the left side so as to make the length of the <code>value</code> equal
  1099. to <code>length</code> (e.g. "%pad-left&lt;{page-title}|20|_&gt;" to add underscores to the left
  1100. side of the page title so as to make its length equal to 20).
  1101. </li>
  1102. <li><code>%pad-right&lt;value|length|pad&gt;</code>: returns the <code>value</code> with
  1103. <code>pad</code> added to the right side so as to make the length of the <code>value</code>
  1104. equal to <code>length</code> (e.g. "%pad-right&lt;{page-title}|20|_&gt;" to add underscores to
  1105. the right side of the page title so as to make its length equal to 20).
  1106. </li>
  1107. <li><code>%url-search-name&lt;index&gt;</code>: the name of the search parameter at the specified
  1108. index (e.g. "%url-search-name&lt;0&gt;" for the name of the first search parameter)
  1109. </li>
  1110. <li><code>%url-search-value&lt;index&gt;</code>: the value of the search parameter at the specified
  1111. index (e.g. "%url-search-value&lt;0&gt;" for the value of the first search parameter)
  1112. </li>
  1113. <li><code>%url-search-named-value&lt;name&gt;</code>: the value of the search parameter with the
  1114. specified name (e.g. "%url-search-named-value&lt;id&gt;" for the value of the search parameter
  1115. "id")
  1116. </li>
  1117. <li><code>%url-segment&lt;index&gt;</code>: the segment of the pathname at the specified index (e.g.
  1118. "%url-segment&lt;0&gt;" for the first segment of the pathname)
  1119. </li>
  1120. <li><code>%url-hostname-subdomain&lt;index&gt;</code>: the subdomain of the hostname at the
  1121. specified index (e.g. "%url-hostname-subdomain&lt;0&gt;" for the first subdomain of the
  1122. hostname)
  1123. </li>
  1124. <li><code>%stringify&lt;value&gt;</code>: the string representation of the specified value (e.g.
  1125. "%stringify&lt;{page-title}&gt;" for the string representation of the page title)
  1126. </li>
  1127. <li><code>%encode-uri&lt;value&gt;</code>: the URI-encoded representation of the specified value
  1128. (e.g. "%encode-uri&lt;{page-title}&gt;" for the URI-encoded representation of the page title)
  1129. </li>
  1130. <li><code>%decode-uri&lt;value&gt;</code>: the URI-decoded representation of the specified value
  1131. (e.g. "%decode-uri&lt;{page-title}&gt;" for the URI-decoded representation of the page title)
  1132. </li>
  1133. <li><code>%encode-uri-component&lt;value&gt;</code>: the URI-encoded representation of the
  1134. specified value (e.g. "%encode-uri-component&lt;{page-title}&gt;" for the URI-encoded
  1135. representation of the page title)
  1136. </li>
  1137. <li><code>%decode-uri-component&lt;value&gt;</code>: the URI-decoded representation of the
  1138. specified value (e.g. "%decode-uri-component&lt;{page-title}&gt;" for the URI-decoded
  1139. representation of the page title)
  1140. </li>
  1141. <li><code>%page-element-text&lt;selector&gt;</code>: the text content of the first element matching
  1142. the specified selector (e.g. "%page-element-text&lt;h1&gt;" for the text content of the first H1
  1143. element)
  1144. </li>
  1145. <li><code>%page-element-attribute&lt;selector|attribute&gt;</code>: the value of the specified
  1146. attribute of the first element matching the specified selector (e.g.
  1147. "%page-element-attribute&lt;h1|class&gt;" for the class attribute of the first H1 element)
  1148. </li>
  1149. <li><code>%date-locale&lt;locales&gt;</code>: the localized value of the date and time (e.g.
  1150. "%date-locale&lt;en-US&gt;" for the date and time in the US English format)
  1151. </li>
  1152. <li><code>%time-locale&lt;locales&gt;</code>: the localized value of the time (e.g.
  1153. "%time-locale&lt;en-US&gt;" for the time in the US English format)
  1154. </li>
  1155. <li><code>%datetime-locale&lt;locales&gt;</code>: the localized value of the date and time (e.g.
  1156. "%datetime-locale&lt;en-US&gt;" for the date and time in the US English format)
  1157. </li>
  1158. <li><code>%datetime-custom&lt;locale|year|month|day|weekday|hour|minute|second|hour12|time-zone|fractional-seconds-digits|time-zone-name|era|locale-matcher&gt;</code>:
  1159. the date and time formatted according to the specified locale and options. See below for the
  1160. list of options. You can pass <code> </code> (space character) as a value to use the default
  1161. value for an option. You can also omit options at the end of the list. For example, to format
  1162. the date and time in the US English format with the year, day, and weekday, you can use
  1163. "%datetime-custom&lt;en-US|numeric| |numeric| |numeric&gt;".
  1164. <ul>
  1165. <li><code>locale</code>: the locale to use as a BCP 47 language tag (e.g. "en-US")</li>
  1166. <li><code>year</code>: the year format (i.e. "numeric", "2-digit")</li>
  1167. <li><code>month</code>: the month format (i.e. "numeric", "2-digit", "narrow", "short",
  1168. "long")
  1169. </li>
  1170. <li><code>day</code>: the day format (i.e. "numeric", "2-digit")</li>
  1171. <li><code>weekday</code>: the weekday format (i.e. "narrow", "short", "long")</li>
  1172. <li><code>hour</code>: the hour format (i.e. "numeric", "2-digit")</li>
  1173. <li><code>minute</code>: the minute format (i.e. "numeric", "2-digit")</li>
  1174. <li><code>second</code>: the second format (i.e. "numeric", "2-digit")</li>
  1175. <li><code>hour12</code>: whether to use 12-hour time (i.e. "true", "false")</li>
  1176. <li><code>time-zone</code>: the time zone of the IANA Time Zone Database (e.g. "UTC", "GMT",
  1177. "EST", "PST", "America/New_York")</li>
  1178. <li><code>fractional-seconds-digits</code>: the number of fractional second digits (i.e.
  1179. "1" to "3")</li>
  1180. <li><code>time-zone-name</code>: the time zone name format (i.e. "short", "long",
  1181. "shortOffset", "longOffset", "shortGeneric", "longGeneric")</li>
  1182. <li><code>day-period</code>: the day period (i.e. "narrow", "short", "long")</li>
  1183. <li><code>era</code>: the era (i.e. "narrow", "short", "long")</li>
  1184. <li><code>locale-matcher</code>: the locale matcher (e.g. "lookup", "best fit")</li>
  1185. </ul>
  1186. You can find more information about the options in the <a
  1187. href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat#parameters"
  1188. target="_blank">DateTimeFormat constructor</a> documentation.
  1189. </li>
  1190. <li><code>%option-value&lt;key&gt;</code>: the value of the specified option (e.g.
  1191. "%option-value&lt;displayInfobar&gt;" for the value of the "displayInfobar" option)
  1192. </li>
  1193. </ul>
  1194. </li>
  1195. <li>
  1196. <a id="external-messages">Integration with other extensions</a>
  1197. <p>SingleFile can receive messages from other extensions. The messages must be sent to the extension ID
  1198. of SingleFile and must be a string containing one of the following values:
  1199. <ul>
  1200. <li>
  1201. <code>"save-page"</code>: save the current page
  1202. </li>
  1203. <li>
  1204. <code>"edit-and-save-page"</code>: edit the current page in the annotation editor and save it
  1205. </li>
  1206. <li>
  1207. <code>"save-selected-links"</code>: save all the links in the selected content
  1208. </li>
  1209. <li>
  1210. <code>"save-selected-content"</code>: save the selected content
  1211. </li>
  1212. <li>
  1213. <code>"save-selected-tabs"</code>: save the selected tabs
  1214. </li>
  1215. <li>
  1216. <code>"save-unpinned-tabs"</code>: save the unpinned tabs
  1217. </li>
  1218. <li>
  1219. <code>"save-all-tabs"</code>: save all the tabs
  1220. </li>
  1221. </ul>
  1222. </p>
  1223. </li>
  1224. <li><a id="notes">Technical notes</a>
  1225. <ul>
  1226. <li>All images are converted into <a href="http://en.wikipedia.org/wiki/Base64"
  1227. target="_blank">base64</a>. </li>
  1228. <li>All resources except frame contents are injected in the document using <a
  1229. href="http://en.wikipedia.org/wiki/Data_URI_scheme" target="_blank">data URI scheme</a>.
  1230. </li>
  1231. <li>Frame contents are injected as text in the document by using the srcdoc attribute. </li>
  1232. </ul>
  1233. </li>
  1234. <li><a id="known-issues">Known issues</a>
  1235. <ul>
  1236. <li>All browsers
  1237. <ul>
  1238. <li>For security reasons, you cannot save pages hosted on https://chrome.google.com,
  1239. https://addons.mozilla.org and some other Mozilla domains. When this happens, 🚫 is
  1240. displayed on top of the SingleFile icon.</li>
  1241. <li>For security reasons, SingleFile is sometimes unable to save the image representation of
  1242. canvas and snapshots of video elements.</li>
  1243. <li>The last saved path cannot be remembered by default. To circumvent this limitation,
  1244. disable the option "Misc. &gt; Save pages in background".</li>
  1245. <li>The following characters are replaced with _ in filenames: ~, +, \, ?, %, *, :, |, ",
  1246. &lt;, &gt;. This is done to maintain compatibility with various OSs and file systems.
  1247. If you don't need that level of compatibility and know what you are doing, you can
  1248. change the list of forbidden characters in
  1249. <a href="https://github.com/gildas-lormeau/SingleFile/wiki/Hidden-options">Hidden
  1250. options</a>.
  1251. </li>
  1252. </ul>
  1253. </li>
  1254. <li>Chromium-based browsers
  1255. <ul>
  1256. <li>You must enable the option "Allow access to file URLs" in the extension page to display
  1257. the infobar when viewing a saved page, to save or to annotate a page stored on the
  1258. filesystem.</li>
  1259. <li>If the filename of a saved page looks like "56833935-156b-4d8c-a00f-19599c6513d3",
  1260. disable the option "Misc. &gt; Save pages in background". Reinstalling the browser may
  1261. also fix this issue.</li>
  1262. <li>Disabling the option 'File name &gt; open the "Save as" dialog to confirm the file name'
  1263. will work if and only if "Ask where to save each file before downloading" is disabled in
  1264. chrome://settings/downloads</li>
  1265. </ul>
  1266. </li>
  1267. <li>Firefox
  1268. <ul>
  1269. <li>The "File name &gt; file name conflict resolution" option does not work if set to
  1270. "prompt for a name".
  1271. </li>
  1272. <li>Sometimes, SingleFile is unable to save the contents of sandboxed iframes.</li>
  1273. <li>When processing a page from the filesystem, external resources (e.g. images,
  1274. stylesheets, fonts etc.) will not be embedded into the saved page.</li>
  1275. </ul>
  1276. </li>
  1277. </ul>
  1278. </li>
  1279. <li><a id="unknown-issues">Troubleshooting unknown issues</a>
  1280. <p>Please follow these steps if you find an unknown issue:</p>
  1281. <ul>
  1282. <li>Save the page in incognito.</li>
  1283. <li>If saving page in incognito did not fix the issue, reset SingleFile options.</li>
  1284. <li>If resetting options did not fix the issue, restart the browser.</li>
  1285. <li>If restarting the browser did not fix the issue, try to disable all other extensions to see if
  1286. there is a conflict.</li>
  1287. <li>If there is a conflict then try to determine against which extension(s).</li>
  1288. <li>Please report the issue <a href="https://github.com/gildas-lormeau/SingleFile/issues"
  1289. target="_blank">here</a>
  1290. with a short description on how to reproduce it.</li>
  1291. </ul>
  1292. <p>Suggestions are welcome :)</p>
  1293. </li>
  1294. <li><a id="contributors">Contributors</a>
  1295. <ul>
  1296. <li>Chinese translation done by yfdyh000 (<a href="https://github.com/yfdyh000"
  1297. target="_blank">GitHub profile</a>), KrasnayaPloshchad (<a
  1298. href="https://github.com/KrasnayaPloshchad" target="_blank">GitHub
  1299. profile</a>), frostblazergit (<a href="https://github.com/frostblazergit"
  1300. target="_blank">GitHub profile</a>), NightSharp (<a href="https://github.com/NightSharp"
  1301. target="_blank">GitHub profile</a>), lqzhgood (<a href="https://github.com/lqzhgood"
  1302. target="_blank">GitHub profile</a>) </li>
  1303. <li>Traditional Chinese translation done by frostblazergit (<a
  1304. href="https://github.com/frostblazergit" target="_blank">GitHub profile</a>), lqzhgood (<a
  1305. href="https://github.com/lqzhgood" target="_blank">GitHub profile</a>)</li>
  1306. <li>Dutch translation done by jooleer (<a href="https://github.com/jooleer" target="_blank">GitHub
  1307. profile</a>)</li>
  1308. <li>Dutch translation done by jooleer (<a href="https://github.com/jooleer" target="_blank">GitHub
  1309. profile</a>)</li>
  1310. <li>German translation done by womotroll (<a href="https://github.com/womotroll"
  1311. target="_blank">GitHub profile</a>), bannmann (<a href="https://github.com/bannmann"
  1312. target="_blank">GitHub profile</a>) </li>
  1313. <li>Italian translation done by Fastbyte01 (<a href="https://github.com/Fastbyte01"
  1314. target="_blank">GitHub profile</a>)</li>
  1315. <li>Japanese translation, done by Shitennouji (四天王寺) (<a href="https://github.com/Shitennouji"
  1316. target="_blank">GitHub profile</a>)</li>
  1317. <li>Polish translation done by xesarni (<a href="https://github.com/xesarni" target="_blank">GitHub
  1318. profile</a>)
  1319. </li>
  1320. <li>Portuguese translation done by @Blackspirits (<a href="https://github.com/Blackspirit"
  1321. target="_blank">GitHub profile</a>)
  1322. </li>
  1323. <li>Portuguese-Brazilian translation done by @mezysinc, Blackspirits (<a
  1324. href="https://github.com/Blackspirit" target="_blank">GitHub profile</a>)
  1325. </li>
  1326. <li>Russian translation done by rstp14 (<a href="https://github.com/rstp14" target="_blank">GitHub
  1327. profile</a>), kramola-RU (<a href="https://github.com/kramola-RU" target="_blank">GitHub
  1328. profile</a>), solokot (<a href="https://github.com/solokot" target="_blank">GitHub
  1329. profile</a>)</li>
  1330. <li>Spanish translation done by strel (<a href="https://github.com/strel" target="_blank">GitHub
  1331. profile</a>)</li>
  1332. <li>Turkish translation done by hbaklan943 (<a href="https://github.com/hbaklan943"
  1333. target="_blank">GitHub profile</a>)</li>
  1334. <li>Ukrainian translation done by perdolka (<a href="https://github.com/perdolka"
  1335. target="_blank">GitHub profile</a>), gildas-lormeau</li>
  1336. </ul>
  1337. </li>
  1338. <li><a id="icons">Icons</a>
  1339. <ul>
  1340. <li>Icon made by <a href="https://www.flaticon.com/authors/kiranshastry" title="Kiranshastry"
  1341. target="_blank" s>Kiranshastry</a> from <a href="https://www.flaticon.com/" title="Flaticon"
  1342. target="_blank">www.flaticon.com</a> is licensed by <a
  1343. href="http://creativecommons.org/licenses/by/3.0/" title="Creative Commons BY 3.0"
  1344. target="_blank">CC 3.0 BY</a> </li>
  1345. </ul>
  1346. </li>
  1347. </ol>
  1348. </div>
  1349. <script type="module" src="../bg/ui-help.js"></script>
  1350. </body>
  1351. </html>