Changeset 5794


Ignore:
Timestamp:
Oct 7, 2011, 2:52:46 PM (10 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:
2 added
4 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/src/docbook/user/file_system.xml

    r5782 r5794  
    6464            This is the logged in user's home directory with sub directories. It is
    6565            visible if the current user has a home directory and is then always located at
    66             the top of the navigation tree. More about this can be read in
    67             <xref linkend="file_system.system.browse.tree.home" />.
    68             Click on a directory to display it's contents to the right
     66            the top of the navigation tree. Click on a directory to display it's contents to the right
    6967            or click on the plus sign to expand the directory and view the
    70             sub directories (no plus sign = no sub directories).
    71           </para>
     68            sub directories. Note that the directory tree is lazily loaded. Subdirectories
     69            that hasn't yet been opened have light gray icon which is removed if they
     70            turn out to be empty.
     71          </para>
     72         
     73          <note>
     74            <para>
     75              A directory can only be opened from the navigation tree or from the directory
     76              icon in the list. A click on a directory's name in the list will open the
     77              directory's edit window.
     78            </para>
     79          </note>
     80         
    7281        </listitem>
    7382      </varlistentry>
     
    8089          <para>
    8190            The other users' home directories that the current user has permission
    82             to read are listed here, including his/her own.
    83           </para>
     91            to read are listed here.
     92          </para>
     93          <note>
     94            <title>Missing directory?</title>
     95            <para>
     96              Not all users have a home directory connected to their accounts. If
     97              a user is missing, it most certainly depends on that the user account
     98              have not got a home directory. Home directories are managed by the
     99              administrator of the BASE server.
     100            </para>
     101          </note>
    84102        </listitem>
    85103      </varlistentry>
     
    144162          <para>
    145163            This icon is only visible for those files that have been moved offline and
    146             it can be used to re-upload the file to the BASE. Start to
     164            can be used to re-upload the file to the BASE. Start to
    147165            upload the file to the same position by clicking on the icon.
    148166          </para>
     
    159177    </variablelist>
    160178
    161     <sect2 id="file_system.system.browse">
    162       <title>Browse the file system</title>
    163       <para>
    164         Browsing the BASE file system is done from the navigation bar by clicking on a
    165         directory in the tree to view it's contents. Both sub directories and files in the
    166         selected directory are showed. A directory with sub directories can be expand with a
    167         click on the plus-sign.
    168       </para>
    169       <note>
    170         <title>Browse a directory</title>
    171         <para>
    172           A directory can only be open from the navigation tree and never from the list. A
    173           click on a directory's name in the list will open the directory's edit window.
    174         </para>
    175       </note>
    176       <sect3 id="file_system.system.browse.tree">
    177         <title>Navigation tree</title>
    178         <para>
    179           The navigation tree contains of folders/directories that the logged in user has
    180           permission to read. At the top is the current user's home directory and under it
    181           is a folder with all accessible home directories.
    182         </para>
    183         <para>
    184           The tree can be updated with the refresh-button at the bottom of the panel (the
    185           tree is not self-refreshing).
    186         </para>
    187         <sect4 id="file_system.system.browse.tree.home">
    188           <title>Home directory - 'My home'</title>
    189           <para>
    190             To make it easier for the logged in user to find his/her directory without
    191             having to scroll through the whole list of home directories, his or hers
    192             home directory is located at the top of the navigation tree under the
    193             <interface>My home</interface>
    194             folder.
    195           </para>
    196           <note>
    197             <title>No home directory</title>
    198             <para>
    199               Not all users have a home directory connected to their accounts. If
    200               <interface>My home</interface>
    201               is missing, it most certainly depends on that the current user account
    202               have not got a home directory. Home directories are managed by the
    203               administrator of the BASE server.
    204             </para>
    205           </note>
    206         </sect4>
    207       </sect3>
    208     </sect2>
    209179    <sect2 id="file_system.system.quota">
    210180      <title>Disk space quota</title>
     
    214184        that is occupied can be found at the account's home page, described in
    215185        <xref linkend="webclient.intro.homepage" />.
    216       </para>
    217      
    218       <para>
    219         See <xref linkend="accounts.quota" /> for more information about
     186        See also <xref linkend="accounts.quota" /> for more information about
    220187        the quota system.
    221188      </para>
     
    281248                  Tick this checkbox if you want to overwrite an existing file
    282249                  that has the same name as the one you are going to upload.
     250                  In contrast with other items, file names must be unique since
     251                  they are often referenced by name.
    283252                </para>
    284253              </listitem>
     
    344313                  Select <userinput>- none -</userinput>
    345314                  if the file should not be associated with any file type.
     315                </para>
     316              </listitem>
     317            </varlistentry>
     318            <varlistentry>
     319              <term>
     320                <guilabel>Character set</guilabel>
     321              </term>
     322              <listitem>
     323                <para>
     324                  If you are uploading a text file, it may be a good idea to select the
     325                  character set used for the file. The most common character set is
     326                  UTF-8 or ISO-8859-1. It may be important to get this setting correct if
     327                  you are going to import data from the file later.
    346328                </para>
    347329              </listitem>
     
    441423        </para>
    442424       
    443         <para>
     425        <note>
    444426          You cannot replace a file which has been marked as
    445427          <emphasis>write protected</emphasis>.
    446         </para>
     428        </note>
    447429      </sect3>
    448430     
     
    521503        </seeother>
    522504      </helptext>
    523      
    524       <sect3 id="file_system.handling.fileservers">
     505    </sect2>
     506   
     507    <sect2 id="file_system.handling.fileservers">
    525508        <title>File servers</title>
     509       
     510        <figure id="file_system.figures.fileserver">
     511          <title>Fileserver properties</title>
     512          <screenshot>
     513            <mediaobject>
     514              <imageobject><imagedata
     515                fileref="figures/edit_fileserver.png" format="PNG"
     516                /></imageobject>
     517            </mediaobject>
     518          </screenshot>
     519        </figure>
    526520     
    527521        <helptext external_id="fileserver.edit" title="Edit file server">
     
    539533              <para>
    540534                The name of the file server.
     535              </para>
     536            </listitem>
     537          </varlistentry>
     538          <varlistentry>
     539            <term>
     540              <guilabel>Connection manager</guilabel>
     541            </term>
     542            <listitem>
     543              <para>
     544                The <guilabel>auto</guilabel> setting allows BASE to automatically
     545                select a manager based on the file URL. It is possible to force a
     546                specific connection manager from this list. The list of available
     547                connection managers can be extended by plug-ins.
     548                <nohelp>See
     549                <xref linkend="extensions_developer.connection_manager"/> for more information.
     550                </nohelp>
    541551              </para>
    542552            </listitem>
     
    609619        </seeother>
    610620        </helptext>
    611      
    612       </sect3>
    613621     
    614622    </sect2>
     
    959967        described below.
    960968      </para>
    961       <sect3 id="file_system.handling.directories.edit">
    962         <title>Edit a directory</title>
    963         <para>
    964           The window to edit a directory's properties is opened either by clicking on the
    965           directory's name in the list or when creating a new directory.
    966         </para>
     969
     970        <figure id="file_system.figures.directory">
     971          <title>Directory properties</title>
     972          <screenshot>
     973            <mediaobject>
     974              <imageobject><imagedata
     975                fileref="figures/edit_directory.png" format="PNG"
     976                /></imageobject>
     977            </mediaobject>
     978          </screenshot>
     979        </figure>
     980       
    967981        <helptext external_id="directory.edit" title="Edit directory">
    968982          <para>
     
    10031017                    This option only affect files that are uploaded later,
    10041018                    it doesn't affect already existing files or files that
    1005                     are moved between directories.
     1019                    are moved between directories. Check the <guilabel>Recursive</guilabel>
     1020                    button to apply this setting to all subdirectories.
    10061021                  </para>
    10071022                </listitem>
     
    10361051                  </listitem>
    10371052                  </itemizedlist>
    1038                  
     1053                  <para>
     1054                  Check the <guilabel>Recursive</guilabel>
     1055                  button to apply this setting to all subdirectories.
     1056                  </para>
    10391057                </listitem>
    10401058              </varlistentry>
     
    10711089         
    10721090        </helptext>
    1073       </sect3>
    10741091    </sect2>
    10751092  </sect1>
Note: See TracChangeset for help on using the changeset viewer.