help.html 60 KB

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