Acasă Explorează Ajutor
Autentificare
mirrors
/
SingleFile
oglindă de https://github.com/gildas-lormeau/SingleFile
1
0
Bifurcare 0
Fisiere Probleme 0 Wiki
Arbore: 754607acd9
Ramuri Etichete
SingleFile
/
WebContent
/
ui
/
pages
/
help.html

help.html 11 KB
Istoric Crud

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172 
  1. <!DOCTYPE html>
    2. 

  2. <html>
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    5. 

  5. <title>SingleFile help</title>
    6. 

  6. <link rel="stylesheet" href="help.css">
    7. 

  7. </head>
    8. 

  8. <body>
    9. 

  9. <div>
    10. 

  10. <div id="titleBorder">
    11. 

  11. <h2><img src="../resources/icon_48.png" id="titleIcon"><span id="title">SingleFile help</span></h2>
    12. 

  12. <h4>SingleFile helps you to archive a complete page into a single HTML file.</h4>
    13. 

  13. </div>
    14. 

  14. <span id="index"><a href="#instructions">Instructions</a> - <a href="#demo">Demo</a> - <a href="#options">Options description</a> - <a href="#folder">Saved archives
    15. 

  15. folder</a> - <a href="#notes">Technical notes</a> - <a href="#knownIssues">Known issues</a> - <a href="#unknownIssues">Unknown issues</a></span>
    16. 

  16. <hr>
    17. 

  17. <ol>
    18. 

  18. 	<li><a id="instructions">Instructions</a>
    19. 

  19. 	<ul>
    20. 

  20. 		<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
    21. 

  21. 		are displayed</li>
    22. 

  22. 		<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
    23. 

  23. 		processing</li>
    24. 

  24. 		<li>wait until the shadow disappears then hit Ctrl-S or select "Save as" in the wrench menu and save the page</li>
    25. 

  25. 		<li>all images, style sheets and frame contents are embedded into the ".htm" saved file</li>
    26. 

  26. 	</ul>
    27. 

  27. 	</li>
    28. 

  28. 

  29. 	<li><a id="demo">Demo : SingleFile advantages over default file save</a>
    30. 

  30. 	<div><object width="480" height="385">
    31. 

  31. 		<param name="movie" value="http://www.youtube.com/v/D99LfOF3qis&hl=fr_FR&fs=1&">
    32. 

  32. 		<param name="allowFullScreen" value="true">
    33. 

  33. 		<param name="allowscriptaccess" value="always">
    34. 

  34. 		<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>
    35. 

  35. 	</div>
    36. 

  36. 	<li><a id="options">Options description</a>
    37. 

  37. 

  38. 	<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
    39. 

  39. 	Chrome toolbar and select "Options" in the context menu to open the options page.</p>
    40. 

  40. 	<div class="screenshot"></div>
    41. 

  41. 	<p>Details :</p>
    42. 

  42. 	<ul>
    43. 

  43. 		<li><span class="option">remove frames</span>
    44. 

  44. 		<p>Check this option to remove all frames on the page. It may help to reduce the file size, to remove some ads and to view saved pages on IE8.</p>
    45. 

  45. 		<p class="notice">It is recommended to <u>uncheck</u> this option</p>
    46. 

  46. 		</li>
    47. 

  47. 

  48. 		<li><span class="option">remove objects</span>
    49. 

  49. 		<p>Check this option to remove all non embeddable elements : flash objects, java applets ...</p>
    50. 

  50. 		<p class="notice">It is recommended to <u>check</u> this option</p>
    51. 

  51. 		</li>
    52. 

  52. 		
    53. 

  53. 		<li><span class="option">remove scripts</span>
    54. 

  54. 		<p>Check this option if you do not want to save scripts. Most of the time, you do not need scripts in the saved page. Thus they can alter it. Nevertheless if you want to save
    55. 

  55. 		page dynamic behavior then uncheck this option. If you uncheck this option then it is strongly recommended to check <span class="option">process raw document</span> option.</p>
    56. 

  56. 		<p class="notice">It is recommended to <u>check</u> this option</p>
    57. 

  57. 		</li>
    58. 

  58. 

  59. 		<li><span class="option">remove hidden elements</span>
    60. 

  60. 		<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
    61. 

  61. 		property values). This option may alter the document but can considerably reduce the saved file size.</p>
    62. 

  62. 		<p class="notice">It is recommended to <u>uncheck</u> this option</p>
    63. 

  63. 		</li>
    64. 

  64. 

  65. 		<li><span class="option">remove unused CSS rules</span>
    66. 

  66. 		<p>Check this option to remove all CSS rules that do not match any element. This option may alter the document but can considerably reduce the saved file size. If you check
    67. 

  67. 		this option, it may also introduce some incompatibilities issues in the saved page when opening it into another browser (i.e. not based on Webkit).</p>
    68. 

  68. 		<p class="notice">It is recommended to <u>uncheck</u> this option</p>
    69. 

  69. 		</li>
    70. 

  70. 

  71. 		<li><span class="option">scrapbook the page</span>
    72. 

  72. 		<p>Check this option to send the processed page to <a href="https://chrome.google.com/webstore/detail/ihkkeoeinpbomhnpkmmkpggkaefincbn">Scrapbook for SingleFile</a>.</p>
    73. 

  73. 		<p class="notice">It is recommended to <u>uncheck</u> this option</p>
    74. 

  74. 		</li>
    75. 

  75. 

  76. 		<li><span class="option">process in background</span>
    77. 

  77. 		<p>Check this option to process the page in background. Processing in background means it won't be blocking (only if <span class="option">display processed page</span> option
    78. 

  78. 		is unchecked). If you uncheck this option, a shadow will prevent you to navigate into the page during the SingleFile processing but it will be faster.</p>
    79. 

  79. 		<p class="notice">It is recommended to <u>uncheck</u> this option</p>
    80. 

  80. 		</li>
    81. 

  81. 

  82. 		<li><span class="option">save processed page (*)</span>
    83. 

  83. 		<p>Check this option to save the processed page on filesystem. See <a href="#folder">Saved archives folder</a> for more details about saving folder location. If you check
    84. 

  84. 		this option and you do not want to use "Save as" dialog box to save the page then you should uncheck <span class="option">display processed page</span> option.</p>
    85. 

  85. 		<p class="notice">It is recommended to <u>uncheck</u> this option</p>
    86. 

  86. 		</li>
    87. 

  87. 

  88. 		<li><span class="option">display processed page (*)</span>
    89. 

  89. 		<p>Check this option to display the processed page in the tab. This option must be checked if you want to use Chrome "Save as" dialog box to save the page. If you uncheck
    90. 

  90. 		this option then you should check <span class="option">process in background</span> so the processing won't be blocking: you will just have to wait that "..." label in action
    91. 

  91. 		icon disappears. Conversely, you should uncheck <span class="option">process in background</span> when this option is checked so the processing will be faster.</p>
    92. 

  92. 		<p class="notice">It is recommended to <u>check</u> this option</p>
    93. 

  93. 		</li>
    94. 

  94. 

  95. 		<li><span class="option">max filename length (*)</span>
    96. 

  96. 		<p>Set the value of maximum filename length. This value is used when <span class="option">save processed page</span> option is checked. SingleFile cannot guess the maximum filename
    97. 

  97. 		length allowed by the Operating System so you have to configure it manually.</p>
    98. 

  98. 		<p class="notice">It is recommended to set this option to <u>90</u> (if you are using Windows)</p>
    99. 

  99. 		</li>
    100. 

  100. 

  101. 		<li><span class="option">process raw document</span>
    102. 

  102. 		<p>Check this option to process the raw downloaded document instead of the displayed document. The main difference is that scripts won't be parsed and executed. Frames won't
    103. 

  103. 		be embedded too. This option also helps to not alter the saved page when <span class="option">remove scripts</span> is unchecked</p>
    104. 

  104. 		<p class="notice">It is recommended to <u>uncheck</u> this option</p>
    105. 

  105. 		</li>
    106. 

  106. 

  107. 		<li><span class="option">Reset to default options</span>
    108. 

  108. 		<p>Reset all the options to default (i.e. recommended) state</p>
    109. 

  109. 		</li>
    110. 

  110. 	</ul>
    111. 

  111. 	</li>
    112. 

  112. 

  113. 	<li><a id="folder">Saved archives folder (*)</a>
    114. 

  114. 	<p>When <span class="option">save processed page</span> option is checked, pages are automatically saved on filesystem. However, Chrome will not allow to choose the root
    115. 

  115. 	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>
    116. 

  116. 	<p>Files are saved in the extension subfolder of "FileSystem" folder located into Chrome user data folder:</p>
    117. 

  117. 	<ul style="text-align: left">
    118. 

  118. 		<li>Windows default path: <br>
    119. 

  119. 		<span class="option">%LOCALAPPDATA%\Google\Chrome\User&nbsp;Data\Default\FileSystem\chrome-extension_jemlklgaibiijojffihnhieihhagocma_0\Persistent\</span></li>
    120. 

  120. 		<li>Linux default path: <br>
    121. 

  121. 		<span class="option">~/.config/google-chrome/Default/FileSystem/chrome-extension_jemlklgaibiijojffihnhieihhagocma_0/Persistent/</span></li>
    122. 

  122. 		<li>Mac OS X default path: <br>
    123. 

  123. 		<span class="option">~/Library/Application&nbsp;Support/Google/Chrome/Default/FileSystem/chrome-extension_jemlklgaibiijojffihnhieihhagocma_0/Persistent/</span></li>
    124. 

  124. 	</ul>
    125. 

  125. 	<p>You can create shortcuts to access to this folder easily.
    126. 

  126. 	<p>
    127. 

  127. 	<p>You can also create symbolic links in order to use sync services like dropbox. Here are the way of doing it on <a
    128. 

  128. 		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
    129. 

  129. 	-s)</a>.</p>
    130. 

  130. 	<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>.
    131. 

  131. 	</li>
    132. 

  132. 

  133. 	<li><a id="notes">Technical notes</a>
    134. 

  134. 	<ul>
    135. 

  135. 		<li>all images are converted into <a href="http://en.wikipedia.org/wiki/Base64">base64</a></li>
    136. 

  136. 		<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>
    137. 

  137. 		<li>encoded contents are injected in the document using <a href="http://en.wikipedia.org/wiki/Data_URI_scheme">data URI scheme</a></li>
    138. 

  138. 		<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
    139. 

  139. 		than 32 KB, embedded frames are not supported)</li>
    140. 

  140. 		<li>SVG images are supported (SVG document is converted into utf-8 but is not processed)</li>
    141. 

  141. 	</ul>
    142. 

  142. 	</li>
    143. 

  143. 

  144. 	<li><a id="knownIssues">Known issues</a>
    145. 

  145. 	<ul>
    146. 

  146. 		<li>SVG images without src attribute or with empty src attribute are not embedded</li>
    147. 

  147. 		<li>If you are using <a href="https://chrome.google.com/extensions/detail/odjhifogjcknibkahlpidmdajjpkkcfn">NotScripts</a> extension and have issues when using SingleFile
    148. 

  148. 		then you must add this line in "CHANGE__PASSWORD__HERE.js" file as described <a href="http://optimalcycling.com/other-projects/notscripts/faq/#stumbleuponextension">here</a>:<br>
    149. 

  149. 		<code>const DO_NOT_MITIGATE_INLINE_SCRIPTS = true;</code></li>
    150. 

  150. 		<li>If <span class="option">process in background</span> is unchecked and <span class="option">display processed page</span> is checked, processed page may sometimes be
    151. 

  151. 		altered after being processed (i.e. some elements are not correctly placed). This issue won't affect the saved page.</li>
    152. 

  152. 		<li><code>file:///*</code>, <code>chrome://*</code> and <code>https://chrome.google.com/*</code> URIs cannot be processed</li>
    153. 

  153. 	</ul>
    154. 

  154. 	</li>
    155. 

  155. 

  156. 	<li><a id="unknownIssues">Unknown issues</a>
    157. 

  157. 	<p>If you find an unknown issue (i.e. frozen process, extra saved files, blank or altered document, tab crash...):</p>
    158. 

  158. 	<ul>
    159. 

  159. 		<li>reset options</li>
    160. 

  160. 		<li>disable all other extensions to see if there is a conflict</li>
    161. 

  161. 		<li>if there is a conflict, try to determine against which extension(s)</li>
    162. 

  162. 		<li>report the issue <a href="https://chrome.google.com/webstore/detail/mpiodijhokgodhhofbcjdecpffjipkle">here</a> with a short description describing how to reproduce it,
    163. 

  163. 		Chrome version, OS name and version.</li>
    164. 

  164. 	</ul>
    165. 

  165. 	</li>
    166. 

  166. </ol>
    167. 

  167. <br>
    168. 

  168. <p class="availability">*: feature only available on Chrome 9+</p>
    169. 

  169. <a href="http://www.w3.org/html/logo/"> <img src="../resources/html5-badge-h-storage.png" alt="HTML5 offline & storage logo" id="logo-html5"
    170. 

  170. 	title="This extension is powered by HTML5 Offline & Storage"> </a></div>
    171. 

  171. </body>
    172. 

  172. </html>
    173.