| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176 |
- <!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><img src="../resources/icon_48.png" id="titleIcon"><span id="title">SingleFile help</span></h2>
- <h4>SingleFile helps you to archive a complete page into a single HTML file.</h4>
- </div>
- <span id="index"><a href="#instructions">Instructions</a> - <a href="#demo">Demo</a> - <a href="#options">Options description</a> - <a href="#folder">Saved archives
- folder</a> - <a href="#notes">Technical notes</a> - <a href="#knownIssues">Known issues</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 and hover dynamic document elements (e.g. "rollover" images) to be sure all elements
- are displayed</li>
- <li>click on the SingleFile icon <img src="../resources/icon_48.png" id="icon"> in the Chrome toolbar or press Ctrl-Shift-S shortcut or use context menu to launch page
- processing</li>
- <li>wait until the shadow disappears then hit Ctrl-S or select "Save as" in the wrench menu and save the page</li>
- <li>all images, style sheets and frame contents are embedded into the ".htm" saved file</li>
- </ul>
- </li>
- <li><a id="demo">Demo : SingleFile advantages over default file save</a>
- <div><object width="480" height="385">
- <param name="movie" value="http://www.youtube.com/v/D99LfOF3qis&hl=fr_FR&fs=1&">
- <param name="allowFullScreen" value="true">
- <param name="allowscriptaccess" value="always">
- <embed src="http://www.youtube.com/v/D99LfOF3qis&hl=fr_FR&fs=1&" type="application/x-shockwave-flash" allowscriptaccess="always" allowfullscreen="true" width="480" height="385"></object>
- </div>
- <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 icon <img src="../resources/icon_48.png" id="icon"> in the
- Chrome toolbar and select "Options" in the context menu to open the options page.</p>
- <div class="screenshot"></div>
- <p>Details :</p>
- <ul>
- <li><span class="option">remove frames</span>
- <p>Remove all frames on the page</p>
- <p>You can enable this option if the file size is too large when disabled or to remove some ads. You should enable this option to view saved pages on IE8.</p>
- <p class="notice">It is recommended to <u>disable</u> this option unless you want to open saved pages in IE8.</p>
- </li>
- <li><span class="option">remove scripts</span>
- <p>Remove all javascript scripts</p>
- <p>Most of the time, you don't need javascript into the saved page. If you want to save the dynamic behavior of the document, you may need to disable this option.
- Nevertheless it may not work or document can be altered when opening the saved file.<br>
- It is strongly recommended to enable <span class="option">process raw document</span> if you disable this option.</p>
- <p class="notice">It is recommended to <u>enable</u> this option</p>
- </li>
- <li><span class="option">remove objects</span>
- <p>Remove all objects</p>
- <p>Remove all non embeddable elements : flash objects, java applets ...</p>
- <p class="notice">It is recommended to <u>enable</u> this option if you want to read the saved page offline</p>
- </li>
- <li><span class="option">remove hidden elements</span>
- <p>Remove all hidden elements</p>
- <p>Remove all document hidden elements (<code>visibility = "hidden"</code> or <code>display = "none"</code> or <code>opacity = "0"</code> CSS property
- values). This option may alter the document but can considerably reduce the saved file size.</p>
- <p class="notice">It is recommended to <u>disable</u> this option unless the saved file size is too large</p>
- </li>
- <li><span class="option">remove unused CSS rules</span>
- <p>Remove all CSS rules that do not match any element</p>
- <p>This option may alter the document but can considerably reduce the saved file size. If you enable this option, it may introduce some incompatibilities issues in the saved
- page when opening it into another browser (i.e. not based on Webkit).</p>
- <p class="notice">It is recommended to <u>disable</u> this option unless the saved file size is too large or you do not want to open the saved page into another browser</p>
- </li>
- <li><span class="option">scrapbook the page</span>
- <p>Send the archived page to <a href="https://chrome.google.com/webstore/detail/ihkkeoeinpbomhnpkmmkpggkaefincbn">Scrapbook for SingleFile</a></p>
- <p>This option allows to use SingleFile action icon as a shortcut to send the viewed page to <a
- href="https://chrome.google.com/webstore/detail/ihkkeoeinpbomhnpkmmkpggkaefincbn">Scrapbook for SingleFile</a> extension.</p>
- <p class="notice">It is recommended to <u>disable</u> this option unless you want to use SingleFile icon to scrapbook pages</p>
- </li>
- <li><span class="option">process in background</span>
- <p>Process the page in background</p>
- <p>Processing in background means it won't be blocking (*). If you disable this option, a shadow will prevent you to use the page during the SingleFile processing but
- processing will be faster.</p>
- <p class="notice">It is recommended to <u>disable</u> this option unless <span class="option">display processed page</span> option is disabled</p>
- </li>
- <li><span class="option">save processed page (*)</span>
- <p>Save the page on filesystem</p>
- <p>If you enable this option, documents will be automatically saved on filesystem. See <a href="#folder">Saved archives folder</a> for more details.</p>
- <p class="notice">It is recommended to <u>disable</u> this option unless you want files to be automatically saved</p>
- </li>
- <li><span class="option">display processed page (*)</span>
- <p>Display the processed page in the tab</p>
- <p>This option must be enabled if you want to use Chrome "Save as" dialog box to save the processed page.<br>
- You should enable <span class="option">process in background</span> when this option is disabled so the processing won't be blocking. Conversely, you should disable <span
- class="option">process in background</span> when this option is enabled so the processing will be faster.</p>
- <p class="notice">It is recommended to <u>enable</u> this option</p>
- </li>
- <li><span class="option">max filename length (*)</span>
- <p>Maximum filename length</p>
- <p>Since filesystem restricts filename length and the extension cannot guess this value, you can set it to the maximum allowed by your Operating System.</p>
- <p class="notice">It is recommended to set this option to <u>90</u> if you are using Windows</p>
- </li>
- <li><span class="option">process raw document</span>
- <p>Process the raw downloaded document</p>
- <p>This option allows SingleFile to process the downloaded document instead of the displayed document. The main difference is that scripts won't be parsed and executed.
- Frames won't be embedded too.</p>
- <p class="notice">It is recommended to <u>disable</u> this option unless <span class="option">remove scripts</span> is disabled</p>
- </li>
- <li><span class="option">Reset to default options</span>
- <p>Reset all the options to default state</p>
- </li>
- </ul>
- </li>
- <li><a id="folder">Saved archives folder (*)</a>
- <p>When <span class="option">save processed page</span> is enabled, pages will be automatically saved on filesystem. However, Chrome will not allow to choose the root folder
- where archives are stored. Neither it will allow SingleFile to make links pointing to saved files folder. So you have to find "manually" this folder.</p>
- <p>Files are saved in the extension subfolder of "FileSystem" folder located into Chrome user data folder:</p>
- <ul style="text-align: left">
- <li>Windows default path: <br>
- <span class="option">%LOCALAPPDATA%\Google\Chrome\User Data\Default\FileSystem\chrome-extension_jemlklgaibiijojffihnhieihhagocma_0\Persistent\</span></li>
- <li>Linux default path: <br>
- <span class="option">~/.config/google-chrome/Default/FileSystem/chrome-extension_jemlklgaibiijojffihnhieihhagocma_0/Persistent/</span></li>
- <li>Mac OS X default path: <br>
- <span class="option">~/Library/Application Support/Google/Chrome/Default/FileSystem/chrome-extension_jemlklgaibiijojffihnhieihhagocma_0/Persistent/</span></li>
- </ul>
- <p>You can create shortcuts to access to this folder easily.
- <p>
- <p>You can also create symbolic links in order to use sync services like dropbox. Here are the way of doing it on <a
- href="http://technet.microsoft.com/en-us/library/cc753194(WS.10).aspx">windows (mklink /d)</a> and <a href="http://www.unixtutorial.org/commands/ln/">linux or Mac OS X (ln
- -s)</a>.</p>
- <p>You can also change Chrome user data folder with <a href="http://www.chromium.org/user-experience/user-data-directory">--user-data-dir switch</a>.
- </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>frame document contents and automatically saved pages (*) are encoded with <a href="http://en.wikipedia.org/wiki/Utf_8">utf-8 charset</a></li>
- <li>encoded contents 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 the following web browsers: Chrome, Firefox, Opera, Safari, Konqueror and Internet Explorer 8 (limited support: data URIs must be
- smaller than 32 KB, embedded frames are not supported)</li>
- <li>SVG images are supported (SVG document is converted into utf-8 but is not processed)</li>
- </ul>
- </li>
- <li><a id="knownIssues">Known issues</a>
- <ul>
- <li>SVG images without src attribute or with empty src attribute are not embedded</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 options</li>
- <li>disable all other extensions to see if there is a conflict</li>
- <li>if there is a conflict, try to determine against which extension(s)</li>
- </ul>
- <p>Report the issue <a href="https://chrome.google.com/webstore/detail/mpiodijhokgodhhofbcjdecpffjipkle">here</a> with a short description, URL(s), Chrome version, OS version</p>
- </li>
- </ol>
- <br>
- <p class="availability">*: feature only available on Chrome 9+</p>
- <a href="http://www.w3.org/html/logo/"> <img src="../resources/html5-badge-h-storage.png" alt="HTML5 offline & storage logo" id="logo-html5"
- title="This extension is powered by HTML5 Offline & Storage"> </a></div>
- </body>
- </html>
|