mirrors
/
SingleFile
mirror of https://github.com/gildas-lormeau/SingleFile


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204
							<!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">
</head>

<body>
	<div>
		<div id="titleBorder">
			<h2>SingleFile</h2>
			<h4>Archive a complete page into a single HTML file</h4>
		</div>
		<span id="index">
			<a href="#instructions">Instructions</a> -
			<a href="#options">Options description</a> -
			<a href="#notes">Technical notes</a> -
			<a href="#unknownIssues">Unknown issues</a>
		</span>
		<hr>
		<ol>
			<li>
				<a id="instructions">Instructions</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</li>
				</ul>
				<p>Additional notes:</p>
				<ul>
					<li>You can select multiple tabs and save them by clicking 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 the way SingleFile process a document through the options page. Right-click on SingleFile button
					<img src="../resources/icon_16.png" class="icon"> in the browser toolbar and select "Options" in the context menu to open the options page.</p>
				<p>Details :</p>
				<ul>
					<li>
						<span class="option">add entry in the context menu</span>
						<p>Check this option to display an entry in the context menu of the webpage to save the entire page or the selected part.
						</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">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">enter file name before saving the page</span>
						<p>Check this option to display a prompt asking you to enter the file name of the saved page.
						</p>
						<p class="notice">It is recommended to
							<u>uncheck</u> this option</p>
					</li>
					<label for="confirmFilenameInput"></label>

					<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 (
							<code>visibility = "hidden"</code>,&nbsp;or&nbsp;
							<code>display = "none"</code>,&nbsp;or&nbsp;
							<code>opacity = "0"</code> CSS property values). This option may alter the document but can considerably reduce the size of the file.</p>
						<p class="notice">It is recommended to
							<u>uncheck</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>

					<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">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>

					<li>
						<span class="option">Reset to default options</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>resources are injected in the document using
						<a href="http://en.wikipedia.org/wiki/Data_URI_scheme">data URI scheme</a>
					</li>
					<li>data URI scheme is supported by all modern browsers.</li>
				</ul>
			</li>

			<li>
				<a id="unknownIssues">Unknown issues</a>
				<p>If you find an unknown issue (i.e. frozen process, extra saved files, blank or altered document, tab crash...):</p>
				<ul>
					<li>reset SingleFile options</li>
					<li>if resetting options did not work, 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>
			</li>
		</ol>
	</div>
</body>

</html>