diff options
author | Ekaterina Gerasimova <kittykat3756@gmail.com> | 2013-04-10 11:22:01 +0100 |
---|---|---|
committer | Ekaterina Gerasimova <kittykat3756@gmail.com> | 2013-04-10 11:23:38 +0100 |
commit | 96ab0a75609a4528522e7cc51b588f09ab9b3666 (patch) | |
tree | ab12e692cef6dfe29854f4d1554325d2677ad5cf /help | |
parent | 702a7096aa1beb1d409589b3f3bb3c4ae6af9ddf (diff) | |
download | baobab-96ab0a75609a4528522e7cc51b588f09ab9b3666.tar.gz |
Tidy up help
Mini-review of the stubs, tidy indenting, add markup, rename protocol
pages.
Diffstat (limited to 'help')
-rw-r--r-- | help/C/custom-location.page.stub | 23 | ||||
-rw-r--r-- | help/C/introduction.page | 8 | ||||
-rw-r--r-- | help/C/pref.page | 7 | ||||
-rw-r--r-- | help/C/prob-virtual-folders.page.stub | 3 | ||||
-rw-r--r-- | help/C/protocol-ftp.page.stub (renamed from help/C/ftp.page.stub) | 38 | ||||
-rw-r--r-- | help/C/protocol-ssh.page.stub (renamed from help/C/ssh.page.stub) | 31 | ||||
-rw-r--r-- | help/C/protocol-web-dav.page.stub (renamed from help/C/web-dav.page.stub) | 21 | ||||
-rw-r--r-- | help/C/protocol-windows-share.page.stub (renamed from help/C/windows-share.page.stub) | 28 | ||||
-rw-r--r-- | help/C/scan-home.page | 7 | ||||
-rw-r--r-- | help/C/scan-remote.page | 4 |
10 files changed, 113 insertions, 57 deletions
diff --git a/help/C/custom-location.page.stub b/help/C/custom-location.page.stub index 5171ad7..8dcdc01 100644 --- a/help/C/custom-location.page.stub +++ b/help/C/custom-location.page.stub @@ -15,21 +15,28 @@ <name>Michael Hill</name> <email its:translate="no">mdhillca@gmail.com</email> </credit> + <credit type="editor"> + <name>Ekaterina Gerasimova</name> + <email its:translate="no">kittykat3756@gmail.com</email> + <years>2012, 2013</years> + </credit> - <desc>Scan a remote file system using Custom Location.</desc> + <desc>Scan a remote file system using <gui>Custom Location</gui>.</desc> </info> - <title>Custom Location</title> + <title><gui>Custom Location</gui></title> - <comment><cite date="2011-12-19" href="mailto:yrazes@gmail.com">Julita Inca</cite> - <p>This assumes the reader knows there are many forms to establish connection - remotely to scan folders.</p></comment> + <comment> + <cite date="2011-12-19" href="mailto:yrazes@gmail.com">Julita Inca</cite> + <p>This assumes the reader knows there are many forms to establish + connection remotely to scan folders.</p> + </comment> <p>To scan remotely using <gui>Custom Location</gui> as the <gui>Service type</gui>:</p> - <p>For <gui>Location (URI)</gui> enter the URL of your Web site, replacing - "https" with "davs". For example, instead of "https://example.edu.pe:8443/" - enter "davs://example.edu.pe:8443/".</p> + <p>For <gui>Location (URI)</gui> enter the address that you want to scan, + replacing "https" with "davs". For example, instead of + "https://example.edu.pe:8443/" enter "davs://example.edu.pe:8443/".</p> </page> diff --git a/help/C/introduction.page b/help/C/introduction.page index 02908ef..8c2615a 100644 --- a/help/C/introduction.page +++ b/help/C/introduction.page @@ -32,9 +32,9 @@ analysing storage device usage. It can be used to scan multiple local or remote storage device (including hard disks, SSDs, USB sticks, digital cameras and memory cards). <app>Disk Usage Analyzer</app> can scan either the - <link xref="scan-file-system">whole file system</link> tree, <link - xref="scan-home">your <file>Home</file> directory</link>, a <link - xref="scan-folder">specific user-requested directory</link> or <link - xref="scan-remote">a remote folder</link>.</p> + <link xref="scan-file-system">whole file system</link> tree, + <link xref="scan-home">your <file>Home</file> directory</link>, a + <link xref="scan-folder">specific user-requested directory</link> or + <link xref="scan-remote">a remote folder</link>.</p> </page> diff --git a/help/C/pref.page b/help/C/pref.page index f31f14c..b9176ea 100644 --- a/help/C/pref.page +++ b/help/C/pref.page @@ -12,8 +12,7 @@ <email its:translate="no">kittykat3756@gmail.com</email> </credit> - <desc>Skip specific devices and partitions when scanning the - file system.</desc> + <desc>Skip specific devices and partitions when scanning the file system.</desc> </info> @@ -38,8 +37,8 @@ </steps> <note style="bug"> - <p>The first item in the list, which is mounted on <file>/</file>, cannot be - deselected</p> + <p>The first item in the list, which is mounted on <file>/</file>, cannot + be deselected</p> </note> </page> diff --git a/help/C/prob-virtual-folders.page.stub b/help/C/prob-virtual-folders.page.stub index dc7218b..b3fd73f 100644 --- a/help/C/prob-virtual-folders.page.stub +++ b/help/C/prob-virtual-folders.page.stub @@ -17,8 +17,7 @@ <email its:translate="no">mdhillca@gmail.com</email> </credit> - <desc>The directory listing from the command line does not match the list - in <app>Disk Usage Analyzer</app>.</desc> + <desc>The directory listing from the command line does not match the list in <app>Disk Usage Analyzer</app>.</desc> </info> <title>Why are all the folders not shown in the scan file system option?</title> diff --git a/help/C/ftp.page.stub b/help/C/protocol-ftp.page.stub index 6d29bef..7e59046 100644 --- a/help/C/ftp.page.stub +++ b/help/C/protocol-ftp.page.stub @@ -15,40 +15,60 @@ <name>Michael Hill</name> <email its:translate="no">mdhillca@gmail.com</email> </credit> + <credit type="editor"> + <name>Ekaterina Gerasimova</name> + <email its:translate="no">kittykat3756@gmail.com</email> + <years>2012, 2013</years> + </credit> <desc>Scanning a remote file system using FTP - File Transfer Protocol</desc> </info> - <title>File Transfer Protocol</title> + <title>FTP</title> - <comment><cite date="2011-12-17" href="mailto:yrazes@gmail.com">Julita Inca</cite> + <comment> + <cite date="2011-12-17" href="mailto:yrazes@gmail.com">Julita Inca</cite> <p>This assumes the reader knows there are many forms to establish connection remotely to scan folders.</p> </comment> + <!-- TODO: explain what FTP is at least on some basic level, link to + gnome-user-help if there is a more detailed explanation there. --> + <p>To scan remotely using the FTP Protocol:</p> <steps> <item> - <p>Click <gui>FTP (with login)</gui> as the <gui>Service type</gui>.</p> + <p>Select <gui>FTP (with login)</gui> as the <gui>Service type</gui>.</p> </item> <item> <p>Enter the name of the remote <gui>Server</gui>.</p> </item> <item> <p>Add the following <gui>Optional information</gui>:</p> - <p>The <gui>Port</gui> for this protocol is 21;</p> - <p>The <gui>Folder</gui> to be scanned beginning with a <file>/</file>;</p> - <p>The <gui>User Name</gui> of the account used to connect to the server.</p> + <list> + <item> + <p>The <gui>Port</gui> for this protocol is 21.</p> + </item> + <item> + <p>The <gui>Folder</gui> to be scanned beginning with a + <file>/</file>.</p> + </item> + <item> + <p>The <gui>User Name</gui> of the account used to connect to the + server.</p> + </item> + </list> </item> </steps> <note style="important"> - <p>If you select <gui>Public FTP</gui> as a <gui>Service type</gui> the user - information is not neccesary because the user is usually anonymous.</p> + <p>If you select <gui>Public FTP</gui> as a <gui>Service type</gui> the + user information is not neccesary because the user is usually + anonymous.</p> </note> <p>You can read more about this protocol - <link href="http://www.ietf.org/rfc/rfc959.txt">here</link>.</p> + <link href="http://www.ietf.org/rfc/rfc959.txt">in the RFC</link>.</p> </page> diff --git a/help/C/ssh.page.stub b/help/C/protocol-ssh.page.stub index 0bae9b8..08cf60f 100644 --- a/help/C/ssh.page.stub +++ b/help/C/protocol-ssh.page.stub @@ -19,11 +19,13 @@ <desc>Scanning a remote file system using SSH - Secure Shell Protocol</desc> </info> - <title>Secure Shell Protocol</title> + <title>SSH</title> - <comment><cite date="2011-12-19" href="mailto:yrazes@gmail.com">Julita Inca</cite> - <p>This assumes the reader knows there are many forms to establish connection - remotely to scan folders.</p></comment> + <comment> + <cite date="2011-12-19" href="mailto:yrazes@gmail.com">Julita Inca</cite> + <p>This assumes the reader knows there are many forms to establish + connection remotely to scan folders.</p> + </comment> <p>To scan remotely using your SSH credentials:</p> @@ -36,16 +38,23 @@ </item> <item> <p>Add the following <gui>Optional information</gui>:</p> - <p>The <gui>Port</gui> for this protocol is 22;</p> - <p>The <gui>Folder</gui> to be scanned beginning with a <file>/</file>;</p> - <p>The <gui>User Name</gui> of the account used to connect to the server.</p> + <list> + <item> + <p>The <gui>Port</gui> for this protocol is 22.</p> + </item> + <item> + <p>The <gui>Folder</gui> to be scanned beginning with a + <file>/</file>.</p> + </item> + <item> + <p>The <gui>User Name</gui> of the account used to connect to the + server.</p> + </item> + </list> </item> </steps> <p>You can read more about this - <link href="http://www.ietf.org/rfc/rfc4251.txt">protocol</link> - and get more help - <link href="https://live.gnome.org/DejaDup/Help/Restore/WorstCase">here</link> - </p> + <link href="http://www.ietf.org/rfc/rfc4251.txt">protocol</link>.</p> </page> diff --git a/help/C/web-dav.page.stub b/help/C/protocol-web-dav.page.stub index 4f3b1d9..47e58fe 100644 --- a/help/C/web-dav.page.stub +++ b/help/C/protocol-web-dav.page.stub @@ -42,9 +42,19 @@ </item> <item> <p>Add the following <gui>Optional information</gui>:</p> - <p>The <gui>Port</gui> of this protocol is 22880;</p> - <p>The <gui>Folder</gui> to be scanned, beginning with a <file>/</file>;</p> - <p>The <gui>User Name</gui> of the account used to connect to the server.</p> + <list> + <item> + <p>The <gui>Port</gui> of this protocol is 22880.</p> + </item> + <item> + <p>The <gui>Folder</gui> to be scanned, beginning with a + <file>/</file>.</p> + </item> + <item> + <p>The <gui>User Name</gui> of the account used to connect to the + server.</p> + </item> + </list> </item> </steps> @@ -55,9 +65,8 @@ <note style="tip"> <p>You can see more details of the - <link href="http://www.ietf.org/rfc/rfc5397.txt">WebDAV protocol</link> - and learn more - <link href="http://unixwiz.net/techtips/ms971492-webdav-vuln.html"> here</link>.</p> + <link href="http://www.ietf.org/rfc/rfc5397.txt">WebDAV + protocol</link>.</p> </note> </page> diff --git a/help/C/windows-share.page.stub b/help/C/protocol-windows-share.page.stub index bf2c131..7a49d18 100644 --- a/help/C/windows-share.page.stub +++ b/help/C/protocol-windows-share.page.stub @@ -21,9 +21,10 @@ <title>Windows Share Protocol</title> - <comment><cite date="2011-12-19" href="mailto:yrazes@gmail.com">Julita Inca</cite> - <p>This assumes the reader knows there are many forms to establish connection - remotely to scan folders.</p> + <comment> + <cite date="2011-12-19" href="mailto:yrazes@gmail.com">Julita Inca</cite> + <p>This assumes the reader knows there are many forms to establish + connection remotely to scan folders.</p> </comment> <p>To scan remotely using the Windows Share Protocol:</p> @@ -37,10 +38,23 @@ </item> <item> <p>Add the following <gui>Optional information</gui>:</p> - <p>The name of the Windows <gui>Share</gui>;</p> - <p>The <gui>Folder</gui> to be scanned, beginning with a <file>/</file>;</p> - <p>The <gui>User Name</gui> of the account used to connect to the server;</p> - <p>The Windows <gui>Domain Name</gui>.</p> + <list> + <item> + <p>The name of the Windows <gui>Share</gui>.</p> + </item> + <item> + <p>The <gui>Folder</gui> to be scanned, beginning with a + <file>/</file>.</p> + </item> + <item> + <p>The <gui>User Name</gui> of the account used to connect to the + server.</p> + </item> + <item> + <p>The Windows <gui>Domain Name</gui>.</p> + </item> + </list> </item> </steps> + </page> diff --git a/help/C/scan-home.page b/help/C/scan-home.page index aef81fe..c31c263 100644 --- a/help/C/scan-home.page +++ b/help/C/scan-home.page @@ -21,8 +21,7 @@ <email its:translate="no">mdhillca@gmail.com</email> </credit> - <desc>Scan all of your personal files that are on your internal - storage device.</desc> + <desc>Scan all of your personal files that are on your internal storage device.</desc> </info> @@ -50,8 +49,8 @@ <p>The results may be useful in deciding which folders can be <link href="help:file-roller">archived</link>, <link href="help:gnome-help/files-delete">deleted</link> or - <link href="help:gnome-help/files-copy">moved</link> to free up space. You can - also use the results to estimate how much space would be needed for a + <link href="help:gnome-help/files-copy">moved</link> to free up space. You + can also use the results to estimate how much space would be needed for a <link href="help:gnome-help/backup-how">backup</link> of your <file>Home</file> folder.</p> diff --git a/help/C/scan-remote.page b/help/C/scan-remote.page index aa732fb..125d1ab 100644 --- a/help/C/scan-remote.page +++ b/help/C/scan-remote.page @@ -96,8 +96,8 @@ </note> <note> - <p>Right-click on any folder and select <gui>Open Folder</gui> to launch the - <app>Files</app> application, or <gui>Move to Trash</gui> to move your + <p>Right-click on any folder and select <gui>Open Folder</gui> to launch + the <app>Files</app> application, or <gui>Move to Trash</gui> to move your folder to <file>Trash</file>.</p> </note> |