mirrors
/
SingleFile
дзеркало https://github.com/gildas-lormeau/SingleFile


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346
							<!DOCTYPE html>
<html>

<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
	<title>SingleFile help</title>
	<link rel="stylesheet" href="help.css">
	<meta name="viewport" content="width=device-width,initial-scale=1">
</head>

<body>
	<div>
		<div id="titleBorder">
			<h2>SingleFile</h2>
			<h4>Save a complete page into a single HTML file</h4>
		</div>
		<span id="index">
			<a href="#getting-started">Getting started</a> -
			<a href="#general-notes">Additional notes</a> -
			<a href="#options">Options description</a> -
			<a href="#notes">Technical notes</a> -
			<a href="#known-issues">Known issues</a> -
			<a href="#unknown-issues">Troubleshooting unknown issues</a>
		</span>
		<hr>
		<ol>
			<li>
				<a id="getting-started">Getting started</a>
				<ul>
					<li>Wait until the page is fully loaded, you may need to scroll down the entire page to be sure all elements are loaded.</li>
					<li>Click on the SingleFile button
						<img src="../resources/icon_16.png" class="icon"> in the extension toolbar to save the page.</li>
				</ul>
			</li>
			<li>
				<a id="general-notes">Additional notes</a>
				<ul>
					<li>
						Open the context menu by right-clicking the SingleFile button
						<img src="../resources/icon_16.png" class="icon"> in the extension toolbar or on the webpage. It allows you to:
						<ul>
							<li>save a tab,</li>
							<li>or a selected content,</li>
							<li>or a frame content,</li>
							<li>or selected tabs,</li>
							<li>or unpinned tabs,</li>
							<li>or all tabs.</li>
						</ul>
					</li>
					<li>
						The context menu also allows you to activate the auto-save of:
						<ul>
							<li>the current tab,</li>
							<li>or unpinned tabs,</li>
							<li>or all tabs.</li>
						</ul>
					</li>
					<li>With auto-save active, pages are automatically saved every time after being loaded (or before being unloaded if not).
						The period of time to wait before saving the page can be configured in the options page.</li>
					<li>The options page allows you to auto-save the page after after being loaded or before being unloading only.</li>
					<li>Right-click on the SingleFile button and select "Options" to open the options page.</li>
					<li>To save multiple tabs, select them first and click on the SingleFile button
						<img src="../resources/icon_16.png" class="icon">.</li>
				</ul>
			</li>
			<li>
				<a id="options">Options description</a>
				<p>You can customize SingleFile through the options page. Right-click on SingleFile button
					<img src="../resources/icon_16.png" class="icon"> in the browser toolbar and select "Options"/"Manage extension" in the context menu to open the options page.</p>
				<p>User interface</p>
				<ul>
					<li>
						<span class="option">add entry in the context menu of the webpage</span>
						<p>Check this option to display an entry for SingleFile in the context menu of the webpage. The context menu of the SingleFile
							button
							<img src="../resources/icon_16.png" class="icon"> in the extension toolbar is displayed wether this option is checked or not.
						</p>
						<p class="notice">It is recommended to
							<u>check</u> this option</p>
					</li>

					<li>
						<span class="option">overlay a shadow on the page during processing</span>
						<p>Check this option to overlay a shadow on the page when SingleFile is retrieving page resources. This reminds you that
							you should not close the tab.
						</p>
						<p class="notice">It is recommended to
							<u>check</u> this option</p>
					</li>

					<li>
						<span class="option">display an infobar when viewing archives</span>
						<p>Check this option to display the ❔ button at the top right of the page when viewing a saved page. By clicking this
							icon, you can get more information about the saved date and open the original URL.
						</p>
						<p class="notice">It is recommended to
							<u>check</u> this option</p>
					</li>
				</ul>
				<p>File name</p>
				<ul>
					<li>
						<span class="option">append the save date to the file name</span>
						<p>Check this option to append the save date of the webpage to the file name.
						</p>
						<p class="notice">It is recommended to
							<u>check</u> this option</p>
					</li>

					<li>
						<span class="option">open the "Save as" dialog to confirm the file name</span>
						<p>Check this option to display the "Save as" dialog in order to confirm the file name before saving the page. If the
							option "save pages in background" is unchecked then a prompt dialog will be displayed instead of the "Save as" dialog.
						</p>
						<p class="notice">It is recommended to
							<u>uncheck</u> this option</p>
					</li>
				</ul>
				<p>Page content</p>
				<ul>
					<li>
						<span class="option">compress HTML</span>
						<p>Check this option to remove all HTML comments, and unneeded spaces or returns. This helps to reduce the size of the
							file without altering the document.</p>
						<p class="notice">It is recommended to
							<u>check</u> this option</p>
					</li>

					<li>
						<span class="option">remove HTML import</span>
						<p>Check this option to remove all link elements used to import HTML documents. This can reduce the size of the file without
							altering the document most of the time.</p>
						<p class="notice">It is recommended to
							<u>check</u> this option</p>
					</li>

					<li>
						<span class="option">remove frames</span>
						<p>Check this option to remove all frame and iframe elements. This can considerably reduce the size of the file without
							altering the document most of the time.</p>
						<p class="notice">It is recommended to
							<u>check</u> this option</p>
					</li>

					<li>
						<span class="option">remove hidden elements</span>
						<p>Check this option to remove all hidden elements. This option can considerably reduce the size of the file without altering
							the document most of the time.</p>
						<p class="notice">It is recommended to
							<u>check</u> this option</p>
					</li>

					<li>
						<span class="option">save raw page</span>
						<p>Check this option to save the page without interpreting JavaScript. Checking this option may alter the document.</p>
						<p class="notice">It is recommended to
							<u>uncheck</u> this option</p>
					</li>
				</ul>
				<p>Pages resources</p>
				<ul>
					<li>
						<span class="option">remove scripts</span>
						<p>Check this option to remove all scripts. Unchecking this option may alter the document.</p>
						<p class="notice">It is recommended to
							<u>check</u> this option</p>
					</li>

					<li>
						<span class="option">remove video sources</span>
						<p>Check this option to empty the "src" attribute of all video elements.</p>
						<p class="notice">It is recommended to
							<u>check</u> this option</p>
					</li>

					<li>
						<span class="option">remove audio sources</span>
						<p>Check this option to empty the "src" attribute of all audio elements.</p>
						<p class="notice">It is recommended to
							<u>check</u> this option</p>
					</li>

					<li>
						<span class="option">compress CSS</span>
						<p>Check this option to minify CSS stylesheets. This helps to reduce the size of the file without altering the document.</p>
						<p class="notice">It is recommended to
							<u>check</u> this option</p>
					</li>

					<li>
						<span class="option">remove unused CSS rules</span>
						<p>Check this option to remove all CSS rules that do not match any element. Checking this this option should not alter
							the document and can considerably reduce the size of the file.</p>
						<p class="notice">It is recommended to
							<u>check</u> this option</p>
					</li>

					<li>
						<span class="option">remove alternative fonts to woff</span>
						<p>Check this option to remove fonts that are alternatives to the Web Open Font Format. Checking this this option should
							not alter the document for modern browsers and can considerably reduce the size of the file.</p>
						<p class="notice">It is recommended to
							<u>check</u> this option</p>
					</li>

					<li>
						<span class="option">save lazy loaded images</span>
						<p>Check this option to save all the lazy loaded images that are not displayed. This may help to save all the images without
							scrolling the page. This feature is not guaranteed to work on all sites.</p>
						<p class="notice">It is recommended to
							<u>check</u> this option</p>
					</li>

					<li>
						<span class="option">set a maximum size for embedded resources (Mb)</span>
						<p>Specify the maximum size of embedded resources (i.e. images, stylesheets, scripts and iframes) in megabytes.
						</p>
					</li>
				</ul>
				<p>Auto-save</p>
				<ul>
					<li>
						<span class="option">auto-save on page load or on page unload as fallback</span>
						<p>Check this option to auto-save pages after being loaded. If you browse to another page before the page is fully loaded
							then the page will be saved just before being unloaded. With this option active, you are guaranteed pages will always
							be saved. Pages saved before being unloaded will not contain frame contents (if you unchecked "remove frames").</p>
					</li>
					<p class="notice">It is recommended to
						<u>check</u> this option</p>

					<li>
						<span class="option">auto-save on page load</span>
						<p>Check this option to auto-save pages after being loaded.</p>
					</li>

					<li>
						<span class="option">auto-save on page unload</span>
						<p>Check this option to auto-save pages before being unloaded instead of saving pages after being loaded. With this option
							active, you are guaranteed pages will always be saved but they will never contain frame contents (if you unchecked
							"remove frames").</p>
					</li>

					<li>
						<span class="option">auto-save wait delay after load (sec.)</span>
						<p>Specify the amount of time in seconds to wait before saving a page when the "auto-save on page load or on page unload
							as fallback" or "auto-save on page load" is checked.
						</p>
					</li>
				</ul>
				<p>Misc.</p>
				<ul>
					<li>
						<span class="option">save pages in background</span>
						<p>Uncheck this option if you get invalid file names like "37bec68b-446a-46a5-8642-19a89c231b46.html" when saving pages
							or if you prefer to use the prompt dialog instead of the "Save as" dialog when "open the 'Save as' dialog to confirm
							the file name" option is checked.
						</p>
						<p class="notice">It is recommended to
							<u>check</u> this option</p>
					</li>

					<li>
						<span class="option">display stats in the console after processing</span>
						<p>Check this option to display stats about processing in the JavaScript developer tools of your browser. Checking this
							option may increase the CPU consumption and the time needed to process a page.
						</p>
						<p class="notice">It is recommended to
							<u>uncheck</u> this option</p>
					</li>
				</ul>
				<p>Form buttons</p>
				<ul>
					<li>
						<span class="option">Reset</span>
						<p>Reset all the options to their default value.</p>
					</li>
				</ul>
			</li>

			<li>
				<a id="notes">Technical notes</a>
				<ul>
					<li>All images are converted into
						<a href="http://en.wikipedia.org/wiki/Base64">base64</a>.
					</li>
					<li>All resources except frame contents are injected in the document using
						<a href="http://en.wikipedia.org/wiki/Data_URI_scheme">data URI scheme</a>.
					</li>
					<li>Frame contents are injected as text in the document by using the srcdoc attribute.
					</li>
				</ul>
			</li>

			<li>
				<a id="known-issues">Known issues</a>
				<ul>
					<li>
						All browsers
						<ul>
							<li>For security reasons, you cannot save pages hosted on https://chrome.google.com or https://addons.mozilla.org.</li>
							<li>Frame contents cannot be saved when "auto-save on page unload" option is checked.</li>
						</ul>
					</li>
					<li>
						Chrome/Opera
						<ul>
							<li>You must enable the option "Allow access to file URLs" in the extension page to display the infobar when viewing a
								saved page, or to save a page stored on the filesystem.</li>
							<li>If saved pages have file names like "4e5a13fd-6638-4a37-a34b-a3c104ac66b1" instead of the title then it means another
								extension is conflicting with SingleFile. You can uncheck the option "save pages in background" to circumvent this
								issue.
							</li>
						</ul>
					</li>
					<li>
						Firefox
						<ul>
							<li>You cannot save selected tabs via the context menu because it is not possible to select multiple tabs.</li>
						</ul>
					</li>
					<li>
						Edge
						<ul>
							<li>The file name looks like "4e5a13fd-6638-4a37-a34b-a3c104ac66b1".</li>
						</ul>
					</li>
				</ul>
			</li>

			<li>
				<a id="unknown-issues">Troubleshooting unknown issues</a>
				<p>Please follow these steps if you find an unknown issue:</p>
				<ul>
					<li>Reset SingleFile options.</li>
					<li>If resetting options did not fix the issue, try to disable all other extensions to see if there is a conflict.</li>
					<li>If there is a conflict then try to determine against which extension(s).</li>
					<li>Please report the issue
						<a href="https://github.com/gildas-lormeau/SingleFile/issues">here</a> with a short description describing how to reproduce the issue, Browser version, OS name and version.</li>
				</ul>
				<p>Suggestions are welcome :)</p>
			</li>
		</ol>
	</div>
</body>

</html>