Changeset 5794

Timestamp:

Oct 7, 2011, 2:52:46 PM (11 years ago)

Author:

Nicklas Nordborg

Message:

References #1590: Documentation cleanup

New and updated screenshots for chapter 7 "File management".

Location:

trunk/doc/src/docbook

Files:

• figures/edit_directory.png (added)
• figures/edit_fileserver.png (added)
• figures/external_file.png (modified) (previous)
• figures/filepage.png (modified) (previous)
• figures/upload_file.png (modified) (previous)
• user/file_system.xml (modified) (15 diffs)

trunk/doc/src/docbook/user/file_system.xml

@@ -64 +64 @@
             This is the logged in user's home directory with sub directories. It is
             visible if the current user has a home directory and is then always located at
-            the top of the navigation tree. More about this can be read in
-            <xref linkend="file_system.system.browse.tree.home" />.
-            Click on a directory to display it's contents to the right
+            the top of the navigation tree. Click on a directory to display it's contents to the right
             or click on the plus sign to expand the directory and view the
-            sub directories (no plus sign = no sub directories).
-          </para>
+            sub directories. Note that the directory tree is lazily loaded. Subdirectories
+            that hasn't yet been opened have light gray icon which is removed if they
+            turn out to be empty.
+          </para>
+          
+          <note>
+            <para>
+              A directory can only be opened from the navigation tree or from the directory
+              icon in the list. A click on a directory's name in the list will open the 
+              directory's edit window.
+            </para>
+          </note>
+          
         </listitem>
       </varlistentry>
@@ -80 +89 @@
           <para>
             The other users' home directories that the current user has permission
-            to read are listed here, including his/her own.
-          </para>
+            to read are listed here.
+          </para>
+          <note>
+            <title>Missing directory?</title>
+            <para>
+              Not all users have a home directory connected to their accounts. If
+              a user is missing, it most certainly depends on that the user account
+              have not got a home directory. Home directories are managed by the 
+              administrator of the BASE server.
+            </para>
+          </note>
         </listitem>
       </varlistentry>
@@ -144 +162 @@
           <para>
             This icon is only visible for those files that have been moved offline and
-            it can be used to re-upload the file to the BASE. Start to
+            can be used to re-upload the file to the BASE. Start to
             upload the file to the same position by clicking on the icon.
           </para>
@@ -159 +177 @@
     </variablelist>
 
-    <sect2 id="file_system.system.browse">
-      <title>Browse the file system</title>
-      <para>
-        Browsing the BASE file system is done from the navigation bar by clicking on a
-        directory in the tree to view it's contents. Both sub directories and files in the
-        selected directory are showed. A directory with sub directories can be expand with a
-        click on the plus-sign.
-      </para>
-      <note>
-        <title>Browse a directory</title>
-        <para>
-          A directory can only be open from the navigation tree and never from the list. A
-          click on a directory's name in the list will open the directory's edit window.
-        </para>
-      </note>
-      <sect3 id="file_system.system.browse.tree">
-        <title>Navigation tree</title>
-        <para>
-          The navigation tree contains of folders/directories that the logged in user has
-          permission to read. At the top is the current user's home directory and under it
-          is a folder with all accessible home directories.
-        </para>
-        <para>
-          The tree can be updated with the refresh-button at the bottom of the panel (the
-          tree is not self-refreshing).
-        </para>
-        <sect4 id="file_system.system.browse.tree.home">
-          <title>Home directory - 'My home'</title>
-          <para>
-            To make it easier for the logged in user to find his/her directory without
-            having to scroll through the whole list of home directories, his or hers
-            home directory is located at the top of the navigation tree under the
-            <interface>My home</interface>
-            folder.
-          </para>
-          <note>
-            <title>No home directory</title>
-            <para>
-              Not all users have a home directory connected to their accounts. If
-              <interface>My home</interface>
-              is missing, it most certainly depends on that the current user account
-              have not got a home directory. Home directories are managed by the 
-              administrator of the BASE server.
-            </para>
-          </note>
-        </sect4>
-      </sect3>
-    </sect2>
     <sect2 id="file_system.system.quota">
       <title>Disk space quota</title>
@@ -214 +184 @@
         that is occupied can be found at the account's home page, described in
         <xref linkend="webclient.intro.homepage" />.
-      </para>
-      
-      <para>
-        See <xref linkend="accounts.quota" /> for more information about 
+        See also <xref linkend="accounts.quota" /> for more information about 
         the quota system.
       </para>
@@ -281 +248 @@
                   Tick this checkbox if you want to overwrite an existing file
                   that has the same name as the one you are going to upload.
+                  In contrast with other items, file names must be unique since
+                  they are often referenced by name.
                 </para>
               </listitem>
@@ -344 +313 @@
                   Select <userinput>- none -</userinput>
                   if the file should not be associated with any file type.
+                </para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term>
+                <guilabel>Character set</guilabel>
+              </term>
+              <listitem>
+                <para>
+                  If you are uploading a text file, it may be a good idea to select the
+                  character set used for the file. The most common character set is
+                  UTF-8 or ISO-8859-1. It may be important to get this setting correct if
+                  you are going to import data from the file later.
                 </para>
               </listitem>
@@ -441 +423 @@
         </para>
         
-        <para>
+        <note>
           You cannot replace a file which has been marked as 
           <emphasis>write protected</emphasis>.
-        </para>
+        </note>
       </sect3>
       
@@ -521 +503 @@
         </seeother>
       </helptext>
-      
-      <sect3 id="file_system.handling.fileservers">
+    </sect2>
+    
+    <sect2 id="file_system.handling.fileservers">
         <title>File servers</title>
+        
+        <figure id="file_system.figures.fileserver">
+          <title>Fileserver properties</title>
+          <screenshot>
+            <mediaobject>
+              <imageobject><imagedata 
+                fileref="figures/edit_fileserver.png" format="PNG"
+                /></imageobject>
+            </mediaobject>
+          </screenshot>
+        </figure>
       
         <helptext external_id="fileserver.edit" title="Edit file server">
@@ -539 +533 @@
               <para>
                 The name of the file server.
+              </para>
+            </listitem>
+          </varlistentry>
+          <varlistentry>
+            <term>
+              <guilabel>Connection manager</guilabel>
+            </term>
+            <listitem>
+              <para>
+                The <guilabel>auto</guilabel> setting allows BASE to automatically
+                select a manager based on the file URL. It is possible to force a
+                specific connection manager from this list. The list of available
+                connection managers can be extended by plug-ins.
+                <nohelp>See 
+                <xref linkend="extensions_developer.connection_manager"/> for more information.
+                </nohelp>
               </para>
             </listitem>
@@ -609 +619 @@
         </seeother>
         </helptext>
-      
-      </sect3>
       
     </sect2>
@@ -959 +967 @@
         described below.
       </para>
-      <sect3 id="file_system.handling.directories.edit">
-        <title>Edit a directory</title>
-        <para>
-          The window to edit a directory's properties is opened either by clicking on the
-          directory's name in the list or when creating a new directory.
-        </para>
+
+        <figure id="file_system.figures.directory">
+          <title>Directory properties</title>
+          <screenshot>
+            <mediaobject>
+              <imageobject><imagedata 
+                fileref="figures/edit_directory.png" format="PNG"
+                /></imageobject>
+            </mediaobject>
+          </screenshot>
+        </figure>
+        
         <helptext external_id="directory.edit" title="Edit directory">
           <para>
@@ -1003 +1017 @@
                     This option only affect files that are uploaded later, 
                     it doesn't affect already existing files or files that
-                    are moved between directories.
+                    are moved between directories. Check the <guilabel>Recursive</guilabel>
+                    button to apply this setting to all subdirectories.
                   </para>
                 </listitem>
@@ -1036 +1051 @@
                   </listitem>
                   </itemizedlist>
-                  
+                  <para>
+                  Check the <guilabel>Recursive</guilabel>
+                  button to apply this setting to all subdirectories.
+                  </para>
                 </listitem>
               </varlistentry>
@@ -1071 +1089 @@
           
         </helptext>
-      </sect3>
     </sect2>
   </sect1>