Gildas vor 11 Monaten
Ursprung
Commit
aa40e27aba
3 geänderte Dateien mit 102 neuen und 94 gelöschten Zeilen
  1. 5 94
      README.MD
  2. 28 0
      contributors.md
  3. 69 0
      known-issues.md

+ 5 - 94
README.MD

@@ -15,8 +15,7 @@ browser, and Opera.
   - [Additional notes](#additional-notes)
   - [FAQ](#faq)
   - [Release notes](#release-notes)
-  - [Known Issues](#known-issues)
-  - [Troubleshooting unknown issues](#troubleshooting-unknown-issues)
+  - [Known Issues and Troubleshooting](#known-issues-and-troubleshooting)
   - [Command Line Interface (SingleFile CLI)](#command-line-interface-singlefile-cli)
   - [Integration with user scripts](#integration-with-user-scripts)
   - [File format comparison](#file-format-comparison)
@@ -102,73 +101,9 @@ See https://github.com/gildas-lormeau/SingleFile/blob/master/faq.md
 
 See https://addons.mozilla.org/firefox/addon/single-file/versions/
 
-## Known Issues
-
-- All browsers:
-  - For security reasons, you cannot save pages hosted on
-    https://chrome.google.com, https://addons.mozilla.org and some other Mozilla
-    domains. When this happens, 🛇 is displayed on top of the SingleFile icon.
-  - For
-    [security reasons](https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image),
-    SingleFile is sometimes unable to save the image representation of
-    [canvas](https://developer.mozilla.org/docs/Web/HTML/Element/canvas) and
-    snapshots of
-    [video](https://developer.mozilla.org/docs/Web/HTML/Element/video) elements.
-  - The last saved path cannot be remembered by default. To circumvent this
-    limitation, disable the option "Misc > save pages in background".
-  - The following characters are replaced by their full-width equivalent 
-    symbols in file names: ~, +, ?, %, *, :, |, ", <, >, \. The 
-    replacement characters are respectively: ~, +, ?, %, *, :, |, ", <, >, \.
-    Other invalid charcaters are replaced by _. This is done to maintain 
-    compatibility with various OSs and file systems. If you don't need that 
-    level of compatibility and know what you are doing, you can change the
-    list of forbidden characters and the replacement characters in the Hidden 
-    options(https://github.com/gildas-lormeau/SingleFile/wiki/Hidden-options).
-- Chromium-based browsers:
-  - You must enable the option "Allow access to file URLs" in the extension page
-    to display the infobar when viewing a saved page, and to save or to annotate
-    a page stored on the filesystem.
-  - If the file name of a saved page looks like
-    "56833935-156b-4d8c-a00f-19599c6513d3.html", disable the option "Misc > save
-    pages in background". Reinstalling the browser may also fix this issue. This
-    issue might also be due to a conflict with another "downloader" extension. 
-    You can find more info about this bug
-    [here](https://bugs.chromium.org/p/chromium/issues/detail?id=892133).
-  - Disabling the option "File name > open the "Save as" dialog to confirm the
-    file name" will work if and only if the option "Ask where to save each file
-    before downloading" is disabled in chrome://settings/downloads.
-- Firefox:
-  - The "File name > file name conflict resolution" option does not work if set
-    to "prompt for a name"
-  - Sometimes, SingleFile is unable to save the contents of sandboxed iframes
-    because of [this bug](https://bugzilla.mozilla.org/show_bug.cgi?id=1411641).
-  - When processing a page from the filesystem, external resources (e.g. images,
-    stylesheets, fonts etc.) will not be embedded into the saved page. You can
-    find more info about this bug
-    [here](https://bugzilla.mozilla.org/show_bug.cgi?id=1644488). This bug has
-    been closed by Mozilla as "WontFix". But there is a simple workaround
-    proposed
-    [here](https://github.com/gildas-lormeau/SingleFile/issues/7#issuecomment-618980153).
-- Waterfox Classic
-  - User interface elements displayed in the page (progress bar, logs panel)
-    won't be displayed unless `dom.webcomponents.enabled` is enabled in
-    `about:config`.
-  - When opening pages saved with the option "Images > group duplicate images
-    together" enabled, some duplicate images might not displayed. It is
-    recommended to disable this option.
-
-## Troubleshooting unknown issues
-
-Please follow these steps if you find an unknown issue:
-
-- Save the page in incognito.
-- If saving page in incognito did not fix the issue, reset SingleFile options.
-- If resetting options did not fix the issue, restart the browser.
-- If restarting the browser did not fix the issue, try to disable all other
-  extensions to see if there is a conflict.
-- If there is a conflict then try to determine against which extension(s).
-- Please report the issue with a short description on how to reproduce it here:
-  https://github.com/gildas-lormeau/SingleFile/issues.
+## Known Issues and Troubleshooting
+
+See https://github.com/gildas-lormeau/SingleFile/blob/master/known-issues.md
 
 ## Command Line Interface (SingleFile CLI)
 
@@ -243,31 +178,7 @@ See https://github.com/gildas-lormeau/SingleFile/blob/master/privacy.md
 
 ## Contributors
 
-- Azerbaijani translation done by Haciagha_Sadikhov (https://github.com/Hajiagha-Sadikhov)
-- Chinese translation done by yfdyh000 (https://github.com/yfdyh000), Liu8Can
-  (https://github.com/Liu8Can), KrasnayaPloshchad 
-  (https://github.com/KrasnayaPloshchad), frostblazergit
-  (https://github.com/frostblazergit), dnknn (https://github.com/dnknn),
-  lqzhgood (https://github.com/lqzhgood)
-- Traditional Chinese translation done by frostblazergit
-  (https://github.com/frostblazergit), lqzhgood (https://github.com/lqzhgood)
-- Dutch translation done by jooleer (https://github.com/jooleer)
-- German translation done by womotroll (https://github.com/womotroll), bannmann
-  (https://github.com/bannmann)
-- Italian translation done by Fastbyte01 (https://github.com/Fastbyte01)
-- Japanese translation done by Shitennouji(四天王寺)
-  (https://github.com/Shitennouji)
-- Polish translation done by xesarni (https://github.com/xesarni)
-- Portuguese translation done by Blackspirits (https://github.com/Blackspirits)
-- Portuguese-Brazilian translation done by @mezysinc, Blackspirits
-  (https://github.com/Blackspirits)
-- Russian translation done by rstp14, kramola-RU
-  (https://github.com/kramola-RU), solokot (https://github.com/solokot),
-  TotalCaesar659 (https://github.com/TotalCaesar659)
-- Spanish translation done by strel (https://github.com/strel)
-- Turkish translation done by hbaklan943 (https://github.com/hbaklan943)
-- Ukrainian translation done by perdolka (https://github.com/perdolka),
-  gildas-lormeau
+See https://github.com/gildas-lormeau/SingleFile/blob/master/contributors.md
 
 ## Code derived from third party projects
 

+ 28 - 0
contributors.md

@@ -0,0 +1,28 @@
+# SingleFile
+
+## Contributors
+
+- Azerbaijani translation done by Haciagha_Sadikhov (https://github.com/Hajiagha-Sadikhov)
+- Chinese translation done by yfdyh000 (https://github.com/yfdyh000), Liu8Can
+  (https://github.com/Liu8Can), KrasnayaPloshchad 
+  (https://github.com/KrasnayaPloshchad), frostblazergit
+  (https://github.com/frostblazergit), dnknn (https://github.com/dnknn),
+  lqzhgood (https://github.com/lqzhgood)
+- Traditional Chinese translation done by frostblazergit
+  (https://github.com/frostblazergit), lqzhgood (https://github.com/lqzhgood)
+- Dutch translation done by jooleer (https://github.com/jooleer)
+- German translation done by womotroll (https://github.com/womotroll), bannmann
+  (https://github.com/bannmann)
+- Italian translation done by Fastbyte01 (https://github.com/Fastbyte01)
+- Japanese translation done by Shitennouji(四天王寺)
+  (https://github.com/Shitennouji)
+- Polish translation done by xesarni (https://github.com/xesarni)
+- Portuguese translation done by Blackspirits (https://github.com/Blackspirits)
+- Portuguese-Brazilian translation done by @mezysinc, Blackspirits
+  (https://github.com/Blackspirits)
+- Russian translation done by rstp14, kramola-RU
+  (https://github.com/kramola-RU), solokot (https://github.com/solokot),
+  TotalCaesar659 (https://github.com/TotalCaesar659)
+- Spanish translation done by strel (https://github.com/strel)
+- Turkish translation done by hbaklan943 (https://github.com/hbaklan943)
+- Ukrainian translation done by perdolka (https://github.com/perdolka)

+ 69 - 0
known-issues.md

@@ -0,0 +1,69 @@
+# SingleFile
+
+## Known Issues
+
+- All browsers:
+  - For security reasons, you cannot save pages hosted on
+    https://chrome.google.com, https://addons.mozilla.org and some other Mozilla
+    domains. When this happens, 🛇 is displayed on top of the SingleFile icon.
+  - For
+    [security reasons](https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image),
+    SingleFile is sometimes unable to save the image representation of
+    [canvas](https://developer.mozilla.org/docs/Web/HTML/Element/canvas) and
+    snapshots of
+    [video](https://developer.mozilla.org/docs/Web/HTML/Element/video) elements.
+  - The last saved path cannot be remembered by default. To circumvent this
+    limitation, disable the option "Misc > save pages in background".
+  - The following characters are replaced by their full-width equivalent 
+    symbols in file names: ~, +, ?, %, *, :, |, ", <, >, \. The 
+    replacement characters are respectively: ~, +, ?, %, *, :, |, ", <, >, \.
+    Other invalid charcaters are replaced by _. This is done to maintain 
+    compatibility with various OSs and file systems. If you don't need that 
+    level of compatibility and know what you are doing, you can change the
+    list of forbidden characters and the replacement characters in the Hidden 
+    options(https://github.com/gildas-lormeau/SingleFile/wiki/Hidden-options).
+- Chromium-based browsers:
+  - You must enable the option "Allow access to file URLs" in the extension page
+    to display the infobar when viewing a saved page, and to save or to annotate
+    a page stored on the filesystem.
+  - If the file name of a saved page looks like
+    "56833935-156b-4d8c-a00f-19599c6513d3.html", disable the option "Misc > save
+    pages in background". Reinstalling the browser may also fix this issue. This
+    issue might also be due to a conflict with another "downloader" extension. 
+    You can find more info about this bug
+    [here](https://bugs.chromium.org/p/chromium/issues/detail?id=892133).
+  - Disabling the option "File name > open the "Save as" dialog to confirm the
+    file name" will work if and only if the option "Ask where to save each file
+    before downloading" is disabled in chrome://settings/downloads.
+- Firefox:
+  - The "File name > file name conflict resolution" option does not work if set
+    to "prompt for a name"
+  - Sometimes, SingleFile is unable to save the contents of sandboxed iframes
+    because of [this bug](https://bugzilla.mozilla.org/show_bug.cgi?id=1411641).
+  - When processing a page from the filesystem, external resources (e.g. images,
+    stylesheets, fonts etc.) will not be embedded into the saved page. You can
+    find more info about this bug
+    [here](https://bugzilla.mozilla.org/show_bug.cgi?id=1644488). This bug has
+    been closed by Mozilla as "WontFix". But there is a simple workaround
+    proposed
+    [here](https://github.com/gildas-lormeau/SingleFile/issues/7#issuecomment-618980153).
+- Waterfox Classic
+  - User interface elements displayed in the page (progress bar, logs panel)
+    won't be displayed unless `dom.webcomponents.enabled` is enabled in
+    `about:config`.
+  - When opening pages saved with the option "Images > group duplicate images
+    together" enabled, some duplicate images might not displayed. It is
+    recommended to disable this option.
+
+## Troubleshooting unknown issues
+
+Please follow these steps if you find an unknown issue:
+
+- Save the page in incognito.
+- If saving page in incognito did not fix the issue, reset SingleFile options.
+- If resetting options did not fix the issue, restart the browser.
+- If restarting the browser did not fix the issue, try to disable all other
+  extensions to see if there is a conflict.
+- If there is a conflict then try to determine against which extension(s).
+- Please report the issue with a short description on how to reproduce it here:
+  https://github.com/gildas-lormeau/SingleFile/issues.