help.html 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144
  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. </head>
  8. <body>
  9. <div>
  10. <div id="titleBorder">
  11. <h2>SingleFile</h2>
  12. <h4>Archive a complete page into a single HTML file</h4>
  13. </div>
  14. <span id="index">
  15. <a href="#instructions">Instructions</a> -
  16. <a href="#options">Options description</a> -
  17. <a href="#notes">Technical notes</a> -
  18. <a href="#unknownIssues">Unknown issues</a>
  19. </span>
  20. <hr>
  21. <ol>
  22. <li>
  23. <a id="instructions">Instructions</a>
  24. <ul>
  25. <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>
  26. <li>click on the SingleFile button
  27. <img src="../resources/icon_19.png" class="icon"> in the extension toolbar</li>
  28. </ul>
  29. <p>Additional notes:</p>
  30. <ul>
  31. <li>You can select multiple tabs and save them by clicking on the SingleFile button
  32. <img src="../resources/icon_19.png" class="icon">.</li>
  33. </ul>
  34. </li>
  35. <li>
  36. <a id="options">Options description</a>
  37. <p>You can customize the way SingleFile process a document through the options page. Right-click on SingleFile button
  38. <img src="../resources/icon_19.png" class="icon"> in the browser toolbar and select "Options" in the context menu to open the options page.</p>
  39. <p>Details :</p>
  40. <ul>
  41. <li>
  42. <span class="option">compress HTML</span>
  43. <p>Check this option to remove all HTML comments, and unneeded spaces or returns. This helps to reduce the size of the
  44. file without altering the document.</p>
  45. <p class="notice">It is recommended to
  46. <u>check</u> this option</p>
  47. </li>
  48. <li>
  49. <span class="option">remove frame elements</span>
  50. <p>Check this option to remove all frames and iframes. This can considerably reduce the size of the file without altering
  51. the document most of the time.</p>
  52. <p class="notice">It is recommended to
  53. <u>check</u> this option</p>
  54. </li>
  55. <li>
  56. <span class="option">remove hidden elements</span>
  57. <p>Check this option to remove all hidden elements (
  58. <code>visibility = "hidden"</code>,&nbsp;or&nbsp;
  59. <code>display = "none"</code>,&nbsp;or&nbsp;
  60. <code>opacity = "0"</code> CSS property values). This option may alter the document but can considerably reduce the size of the file.</p>
  61. <p class="notice">It is recommended to
  62. <u>uncheck</u> this option</p>
  63. </li>
  64. <li>
  65. <span class="option">remove unused CSS rules</span>
  66. <p>Check this option to remove all CSS rules that do not match any element. Checking this this option may alter the document
  67. but can considerably reduce the size of the file. It may also introduce some incompatibilities issues in the saved
  68. page when opening it into another browser (i.e. not based on Chromium).</p>
  69. <p class="notice">It is recommended to
  70. <u>uncheck</u> this option</p>
  71. </li>
  72. <li>
  73. <span class="option">remove scripts</span>
  74. <p>Check this option to remove all scripts. Unchecking this option may alter the document.</p>
  75. <p class="notice">It is recommended to
  76. <u>check</u> this option</p>
  77. </li>
  78. <li>
  79. <span class="option">save raw page</span>
  80. <p>Check this option to save the page without interpreting JavaScript. Checking this option may alter the document.</p>
  81. <p class="notice">It is recommended to
  82. <u>uncheck</u> this option</p>
  83. </li>
  84. <li>
  85. <span class="option">add SingleFile entry in the context menu</span>
  86. <p>Check this option to display an entry in the context menu of the webpage to save the entire page or the selected part.
  87. </p>
  88. <p class="notice">It is recommended to
  89. <u>check</u> this option</p>
  90. </li>
  91. <li>
  92. <span class="option">append save date to the filename</span>
  93. <p>Check this option to append the save date of the webpage to the filename.
  94. </p>
  95. <p class="notice">It is recommended to
  96. <u>check</u> this option</p>
  97. </li>
  98. <li>
  99. <span class="option">Reset to default options</span>
  100. <p>Reset all the options to their default value.</p>
  101. </li>
  102. </ul>
  103. </li>
  104. <li>
  105. <a id="notes">Technical notes</a>
  106. <ul>
  107. <li>all images are converted into
  108. <a href="http://en.wikipedia.org/wiki/Base64">base64</a>
  109. </li>
  110. <li>resources are injected in the document using
  111. <a href="http://en.wikipedia.org/wiki/Data_URI_scheme">data URI scheme</a>
  112. </li>
  113. <li>data URI scheme is supported by all modern browsers.</li>
  114. </ul>
  115. </li>
  116. <li>
  117. <a id="unknownIssues">Unknown issues</a>
  118. <p>If you find an unknown issue (i.e. frozen process, extra saved files, blank or altered document, tab crash...):</p>
  119. <ul>
  120. <li>reset SingleFile options</li>
  121. <li>if resetting options did not work, try to disable all other extensions to see if there is a conflict</li>
  122. <li>if there is a conflict then try to determine against which extension(s)</li>
  123. <li>please report the issue
  124. <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>
  125. </ul>
  126. </li>
  127. </ol>
  128. </div>
  129. </body>
  130. </html>