help.html 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106
  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">remove frame elements</span>
  43. <p>Check this option to remove all frames and iframes. This can considerably reduce the size of the file without altering
  44. the document most of the time.</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 hidden elements</span>
  50. <p>Check this option to remove all hidden elements (
  51. <code>visibility = "hidden"</code>,&nbsp;or&nbsp;
  52. <code>display = "none"</code>,&nbsp;or&nbsp;
  53. <code>opacity = "0"</code> CSS property values). This option may alter the document but can considerably reduce the size of the file.</p>
  54. <p class="notice">It is recommended to
  55. <u>uncheck</u> this option</p>
  56. </li>
  57. <li>
  58. <span class="option">remove unused CSS rules</span>
  59. <p>Check this option to remove all CSS rules that do not match any element. This option may alter the document but can
  60. considerably reduce the size of the file. Checking this option may also introduce some incompatibilities issues in
  61. the saved page when opening it into another browser (i.e. not based on Chromium).</p>
  62. <p class="notice">It is recommended to
  63. <u>uncheck</u> this option</p>
  64. </li>
  65. <li>
  66. <span class="option">Reset to default options</span>
  67. <p>Reset all the options to default state.</p>
  68. </li>
  69. </ul>
  70. </li>
  71. <li>
  72. <a id="notes">Technical notes</a>
  73. <ul>
  74. <li>all images are converted into
  75. <a href="http://en.wikipedia.org/wiki/Base64">base64</a>
  76. </li>
  77. <li>resources are injected in the document using
  78. <a href="http://en.wikipedia.org/wiki/Data_URI_scheme">data URI scheme</a>
  79. </li>
  80. <li>data URI scheme is supported by all modern browsers.</li>
  81. </ul>
  82. </li>
  83. <li>
  84. <a id="unknownIssues">Unknown issues</a>
  85. <p>If you find an unknown issue (i.e. frozen process, extra saved files, blank or altered document, tab crash...):</p>
  86. <ul>
  87. <li>reset SingleFile options</li>
  88. <li>if resetting options did not work, try to disable all other extensions to see if there is a conflict</li>
  89. <li>if there is a conflict then try to determine against which extension(s)</li>
  90. <li>please report the issue
  91. <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>
  92. </ul>
  93. </li>
  94. </ol>
  95. </div>
  96. </body>
  97. </html>