Add common problem sections and related pages

Add pages about slow scan and permissions problems.

https://bugzilla.gnome.org/show_bug.cgi?id=670527

7 files changed, 73 insertions, 277 deletions

diff --git a/help/C/index.page b/help/C/index.page
index d01e2cf..b88f299 100644
--- a/help/C/index.page
+++ b/help/C/index.page
@@ -32,8 +32,8 @@
     <title>Preferences</title>
   </section>
 
-<!--    <section id="problems">
-	<title>Common problems and questions</title>
-    </section>-->
+  <section id="problems" style="2column">
+    <title>Common problems and questions</title>
+  </section>
 
 </page>
diff --git a/help/C/problem-permissions.page b/help/C/problem-permissions.page
new file mode 100644
index 0000000..033485b
--- /dev/null
+++ b/help/C/problem-permissions.page
@@ -0,0 +1,40 @@
+<page xmlns="http://projectmallard.org/1.0/"
+      type="topic" style="task"
+      id="problem-permissions">
+  <info>
+    <link type="guide" xref="index#problems"/>
+    <revision pkgversion="3.10" date="2014-01-25" status="stub"/>
+
+    <credit type="author copyright">
+      <name>Baptiste Mille-Mathias</name>
+      <email>baptistem@gnome.org</email>
+      <years>2014</years>
+    </credit>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+    <desc>I see a <gui>Could not scan /… or some of the folders it
+    contains</gui> error message when scanning.</desc>
+
+  </info>
+
+  <title>Error when scanning</title>
+
+  <p>When scanning you might see a message <gui>Could not scan /… or some of the
+  folders it contains</gui> at the top of <app>Disk Usage Analyzer</app> window.
+  This error appears because you don't have the required permissions to access
+  some files due to restrictions set on the target system. The files you can't
+  access won't be used to compute the <link xref="views">chart</link>
+  representing the disk usage, hence the result reported may be wrong.</p>
+
+  <p>Not having access to all files and directories is perfectly common thought
+  so there is nothing you can do about this error.</p>
+
+  <note style="info"><p><app>Disk Usage Analyzer</app> uses command
+  <cmd>du</cmd> to create the detailled view of the use of storage, and needs
+  you have read permission on files and execute permission of directories.</p>
+
+  <p>On the other hand, filesystem disk usage on the use command <cmd>df</cmd>
+  for disk utilisation on the main window which relies on the filesystem and not
+  on file permissions.</p></note>
+</page>
diff --git a/help/C/problem-slow-scan.page b/help/C/problem-slow-scan.page
new file mode 100644
index 0000000..ceb0520
--- /dev/null
+++ b/help/C/problem-slow-scan.page
@@ -0,0 +1,30 @@
+<page xmlns="http://projectmallard.org/1.0/"
+      type="topic" style="task"
+      id="problem-slow-scan">
+
+  <info>
+    <link type="guide" xref="index#problems"/>
+    <revision pkgversion="3.10" date="2014-01-25" status="stub"/>
+
+    <credit type="author copyright">
+      <name>Baptiste Mille-Mathias</name>
+      <email>baptistem@gnome.org</email>
+      <years>2014</years>
+    </credit>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+    <desc>Scanning a folder or a remote location is slow.</desc>
+
+  </info>
+  <title>Scanning is slow</title>
+
+  <p>The speed required to scan a folder or a remote location depends on the
+  speed of the media you're scanning. For instance a mechanical hard drive will
+  be slower than a SSD, and scanning a remote directory over Internet will
+  generally take longer than scanning a folder over a local network.</p>
+
+  <p>The speed also depends on the depth of the directory structure and the
+  number of files stored.</p>
+
+</page>
diff --git a/help/C/protocol-ftp.page.stub b/help/C/protocol-ftp.page.stub
deleted file mode 100644
index 688891c..0000000
--- a/help/C/protocol-ftp.page.stub
+++ /dev/null
@@ -1,76 +0,0 @@
-<page xmlns="http://projectmallard.org/1.0/"
-      xmlns:its="http://www.w3.org/2005/11/its"
-      type="topic" style="task"
-      id="ftp">
-
-  <info>
-    <revision version="0.1" date="2011-12-19" status="stub"/>
-
-    <credit type="author copyright">
-      <name>Julita Inca</name>
-      <email its:translate="no">yrazes@gmail.com</email>
-      <years>2011</years>
-    </credit>
-    <credit type="editor">
-      <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>
-
-    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
-
-    <desc>Scanning a remote file system using FTP - File Transfer Protocol</desc>
-  </info>
-
-  <title>FTP</title>
-
-  <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>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>
-      <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>
-  </note>
- 
-  <p>You can read more about this protocol
-  <link href="http://www.ietf.org/rfc/rfc959.txt">in the RFC</link>.</p>
-
-</page>
diff --git a/help/C/protocol-ssh.page.stub b/help/C/protocol-ssh.page.stub
deleted file mode 100644
index 2ec13c5..0000000
--- a/help/C/protocol-ssh.page.stub
+++ /dev/null
@@ -1,62 +0,0 @@
-<page xmlns="http://projectmallard.org/1.0/"
-      xmlns:its="http://www.w3.org/2005/11/its"
-      type="topic" style="task"
-      id="ssh">
-
-  <info>
-    <revision version="0.1" date="2011-12-19" status="stub"/>
-
-    <credit type="author copyright">
-      <name>Julita Inca</name>
-      <email its:translate="no">yrazes@gmail.com</email>
-      <years>2011</years>
-    </credit>
-    <credit type="editor">
-      <name>Michael Hill</name>
-      <email its:translate="no">mdhillca@gmail.com</email>
-    </credit>
-
-    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
-
-    <desc>Scanning a remote file system using SSH - Secure Shell Protocol</desc>
-  </info>
-
-  <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>
-
-  <p>To scan remotely using your SSH credentials:</p>    
-
-  <steps>
-    <item>
-      <p>Click <gui>SSH</gui> as a <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>
-      <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>.</p>
-
-</page>
diff --git a/help/C/protocol-web-dav.page.stub b/help/C/protocol-web-dav.page.stub
deleted file mode 100644
index 312abd1..0000000
--- a/help/C/protocol-web-dav.page.stub
+++ /dev/null
@@ -1,74 +0,0 @@
-<page xmlns="http://projectmallard.org/1.0/"
-      xmlns:its="http://www.w3.org/2005/11/its"
-      type="topic" style="task"
-      id="web-dav">
-
-  <info>
-    <revision version="0.1" date="2011-12-19" status="stub"/>
-
-    <credit type="author copyright">
-      <name>Julita Inca</name>
-      <email its:translate="no">yrazes@gmail.com</email>
-      <years>2011</years>
-    </credit>
-    <credit type="editor">
-      <name>Michael Hill</name>
-      <email its:translate="no">mdhillca@gmail.com</email>
-    </credit>
-
-    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
-
-    <desc>Scanning a remote file system using the WebDAV (HTTP) Protocol.</desc>
-  </info>
-
-  <title>WebDAV (HTTP) 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>
- 
-  <p>The WebDAV protocol makes documents on the Web readable and writable. You
-  can create, change and move documents within a web server or web share. You
-  can also lock (“overwrite prevention”) and make queries of information about
-  author and modified date.</p> 
-
-  <p>To scan remotely using the WebDAV (HTTP) Protocol:</p>
-
-  <steps>
-    <item>
-      <p>Click <gui>WebDAV (HTTP)</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>
-      <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>
-  
-  <note style="important">
-    <p><gui>Secure WebDAV (HTTPS)</gui> requires 5006 to be entered for
-    <gui>Port</gui>.</p>
-  </note>
-
-  <note style="tip">
-    <p>You can see more details of the
-    <link href="http://www.ietf.org/rfc/rfc5397.txt">WebDAV
-    protocol</link>.</p>
-  </note>
-
-</page>
diff --git a/help/C/protocol-windows-share.page.stub b/help/C/protocol-windows-share.page.stub
deleted file mode 100644
index 12fc21e..0000000
--- a/help/C/protocol-windows-share.page.stub
+++ /dev/null
@@ -1,62 +0,0 @@
-<page xmlns="http://projectmallard.org/1.0/"
-      xmlns:its="http://www.w3.org/2005/11/its"
-      type="topic" style="task"
-      id="windows-share">
-
-  <info>
-    <revision version="0.1" date="2011-12-19" status="stub"/>
-
-    <credit type="author copyright">
-      <name>Julita Inca</name>
-      <email its:translate="no">yrazes@gmail.com</email>
-      <years>2011</years>
-    </credit>
-    <credit type="editor">
-      <name>Michael Hill</name>
-      <email its:translate="no">mdhillca@gmail.com</email>
-    </credit>
-
-    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
-
-    <desc>Scanning a remote file system using the Windows Share Protocol.</desc>
-  </info>
-
-  <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>
-
-  <p>To scan remotely using the Windows Share Protocol:</p>
-
-  <steps>
-    <item>
-      <p>Click <gui>Windows share</gui> as the <gui>Service type</gui>.</p>
-    </item>
-    <item>
-      <p>Enter the name of the remote Windows <gui>Server</gui>.</p>
-    </item>
-    <item>
-      <p>Add the following <gui>Optional information</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>