瀏覽代碼

updated docs

Gildas 7 年之前
父節點
當前提交
76721f5ad5
共有 3 個文件被更改,包括 49 次插入15 次删除
  1. 18 5
      README.MD
  2. 30 9
      extension/ui/pages/help.html
  3. 1 1
      extension/ui/pages/options.html

+ 18 - 5
README.MD

@@ -14,11 +14,24 @@ https://www.youtube.com/watch?v=RdV8DBW5b0g
 - Click on the SingleFile button in the extension toolbar to save the page.
 
 ## Additional notes
-- Right-click on the SingleFile button and select "Options" to open the options page.
-- To save multiple tabs, select them first and click on the SingleFile button .
-- Use the context menu to save a tab, a selected content, a frame content, unpinned tabs, selected tabs, or all tabs. The context menu also allows activating automatic page saving (i.e. "Auto-save") of a tab, unpinned tabs, or all tabs.
-- With auto-save active, pages will be automatically saved every time after being loaded by default. The period of time to wait before saving the page can be configured in the options page.
-- Check the option "auto-save on page unload" in the options page to auto-save the page before being unloading instead of after being loaded.
+ - Open the context menu by right-clicking the SingleFile button in the extension toolbar or on the webpage. It allows you to:
+  - save a tab,
+  - or a selected content,
+  - or a frame content,
+  - or selected tabs,
+  - or unpinned tabs,
+  - or all tabs.
+ - The context menu also allows you to activate the auto-save of:
+  - the current tab,
+  - or selected tabs,
+  - or unpinned tabs,
+  - or all tabs.						
+ - With auto-save active, pages are automatically saved every time after being loaded. The period of time to wait before
+saving the page can be configured in the options page.
+ - To save multiple tabs, select them first and click on the SingleFile button.
+ - Right-click on the SingleFile button and select "Options" to open the options page.
+ - Check the option "auto-save on page unload" in the options page to auto-save the page before being unloading instead
+of after being loaded.
 
 ## More info
 See the extension help in the options page for more detailed information about the options, and technical notes.

+ 30 - 9
extension/ui/pages/help.html

@@ -15,7 +15,7 @@
 			<h4>Save a complete page into a single HTML file</h4>
 		</div>
 		<span id="index">
-			<a href="#instructions">Instructions</a> -
+			<a href="#getting-started">Getting started</a> -
 			<a href="#general-notes">Additional notes</a> -
 			<a href="#options">Options description</a> -
 			<a href="#notes">Technical notes</a> -
@@ -25,7 +25,7 @@
 		<hr>
 		<ol>
 			<li>
-				<a id="instructions">Instructions</a>
+				<a id="getting-started">Getting started</a>
 				<ul>
 					<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>
 					<li>Click on the SingleFile button
@@ -35,13 +35,32 @@
 			<li>
 				<a id="general-notes">Additional notes</a>
 				<ul>
-					<li>Right-click on the SingleFile button and select "Options" to open the options page.</li>
+					<li>
+						Open the context menu by right-clicking the SingleFile button
+						<img src="../resources/icon_16.png" class="icon"> in the extension toolbar or on the webpage. It allows you to:
+						<ul>
+							<li>save a tab,</li>
+							<li>or a selected content,</li>
+							<li>or a frame content,</li>
+							<li>or selected tabs,</li>
+							<li>or unpinned tabs,</li>
+							<li>or all tabs.</li>
+						</ul>
+					</li>
+					<li>
+						The context menu also allows you to activate the auto-save of:
+						<ul>
+							<li>the current tab,</li>
+							<li>or selected tabs,</li>
+							<li>or unpinned tabs,</li>
+							<li>or all tabs.</li>
+						</ul>
+					</li>
+					<li>With auto-save active, pages are automatically saved every time after being loaded. The period of time to wait before
+						saving the page can be configured in the options page.</li>
 					<li>To save multiple tabs, select them first and click on the SingleFile button
 						<img src="../resources/icon_16.png" class="icon">.</li>
-					<li>Use the context menu to save a tab, a selected content, a frame content, unpinned tabs, selected tabs, or all tabs.
-						The context menu also allows activating automatic page saving of a tab, unpinned tabs, or all tabs.</li>
-					<li>With auto-save active, pages will be automatically saved every time after being loaded. The period of time to wait before
-						saving the page can be configured in the options page.</li>
+					<li>Right-click on the SingleFile button and select "Options" to open the options page.</li>
 					<li>Check the option "auto-save on page unload" in the options page to auto-save the page before being unloading instead
 						of after being loaded.</li>
 				</ul>
@@ -53,8 +72,10 @@
 				<p>Option details :</p>
 				<ul>
 					<li>
-						<span class="option">add entry in the context menu</span>
-						<p>Check this option to display an entry in the context menu of the webpage to save the entire page or the selected part.
+						<span class="option">add entry in the context menu of the webpage</span>
+						<p>Check this option to display an entry for SingleFile in the context menu of the webpage. The context menu of the SingleFile
+							button
+							<img src="../resources/icon_16.png" class="icon"> in the extension toolbar is displayed wether this option is checked or not.
 						</p>
 						<p class="notice">It is recommended to
 							<u>check</u> this option</p>

+ 1 - 1
extension/ui/pages/options.html

@@ -12,7 +12,7 @@
 	<details>
 		<summary>User interface</summary>
 		<div class="option">
-			<label for="contextMenuEnabledInput">add entry in the context menu</label>
+			<label for="contextMenuEnabledInput">add entry in the context menu of the webpage</label>
 			<input type="checkbox" id="contextMenuEnabledInput">
 		</div>
 		<div class="option">