Ignore:
Timestamp:
Mar 28, 2007, 4:52:09 PM (15 years ago)
Author:
Martin Svensson
Message:

References #528. More text in File management doc.

File:
1 edited

Legend:

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

    r3215 r3218  
    3737        <guimenuitem>Files</guimenuitem>
    3838      </menuchoice>
    39       . The basic layout on the page is the same as for the all other listpages in BASE2 but
    40       there are some differences e.g. a navigation tree to the left, used to browse the
    41       directory structure, and some buttons in toolbar, that are special for files and
    42       directories. The figure below is a representation of the files and directories-page.
     39      . The basic layout on the page is the same as for all the other list pages in BASE2 but
     40      there are some differences e.g. there is a navigation tree to the left, used to browse
     41      the directory structure, and there are some buttons in the toolbar, that are special for
     42      files and directories. The figure below is a representation of the files and
     43      directories-page and is followed with a short description to some of the special
     44      fucntions.
    4345    </para>
    4446    <figure id="file.system.figures.filepage">
     
    5961        <listitem>
    6062          <para>
    61             The logged in user's home directory with subdirectories. It is visible if
    62             current user has a home directory and is then always located at the top of
    63             the navigation tree(8). More about this can be read in
     63            This is the logged in user's home directory with sub directories. It is
     64            visible if current user has a home directory and is then always located at
     65            the top of the navigation tree. More about this can be read in
    6466            <xref linkend="file_system.system.browse.tree.home" />
    6567          </para>
     
    6971      <varlistentry>
    7072        <term>
    71           <interface>2. All home directories</interface>
    72         </term>
    73         <listitem>
    74           <para>Home directories for all those users that are visible for the current user are available under this path, included the current user's own directory.</para>
     73          <interface>2. Other users</interface>
     74        </term>
     75        <listitem>
     76          <para>
     77            The other users' home directories that the current user has read permission
     78            on are listed here, including his/her own.
     79          </para>
    7580        </listitem>
    7681      </varlistentry>
     
    8186        </term>
    8287        <listitem>
    83           <para></para>
     88          <para>
     89            This button, which is located at the bottom of the navigation tree,
     90            refreshes/updates the directory tree. It can for example be used to get a
     91            recently created directory to appear in the tree.
     92          </para>
    8493        </listitem>
    8594      </varlistentry>
     
    9099        </term>
    91100        <listitem>
    92           <para></para>
    93         </listitem>
    94       </varlistentry>
    95 
    96       <varlistentry>
    97         <term>
    98           <interface>5. View file contents</interface>
    99         </term>
    100         <listitem>
    101           <para></para>
     101          <para>Shows the full BASE2-path to current directory.</para>
     102        </listitem>
     103      </varlistentry>
     104
     105      <varlistentry>
     106        <term>
     107          <interface>5. View a file's contents</interface>
     108        </term>
     109        <listitem>
     110          <para>
     111            A click on this icon will open the file's contents in a new window. If the
     112            browser doesn't has support to view the file there will be possibilities to
     113            download the file instead.
     114          </para>
    102115        </listitem>
    103116      </varlistentry>
     
    108121        </term>
    109122        <listitem>
    110           <para></para>
    111         </listitem>
    112       </varlistentry>
    113 
    114       <varlistentry>
    115         <term>
    116           <interface>7. Contents in current directory</interface>
    117         </term>
    118         <listitem>
    119           <para></para>
    120         </listitem>
    121       </varlistentry>
    122 
    123       <varlistentry>
    124         <term>
    125           <interface>8. Navigation tree</interface>
    126         </term>
    127         <listitem>
    128           <para></para>
     123          <para>
     124            This icon lets the user to download a file by clicking on it. The download
     125            will start in a new dialog window.
     126          </para>
     127        </listitem>
     128      </varlistentry>
     129
     130      <varlistentry>
     131        <term>
     132          <interface>7. Re-upload a file</interface>
     133        </term>
     134        <listitem>
     135          <para>
     136            This icon is only visible for those files that have been moved offline and
     137            should be used to reload the file into BASE2's filesystem. Start to upload
     138            the file to the same position by clicking on the icon.
     139          </para>
     140        </listitem>
     141      </varlistentry>
     142
     143      <varlistentry>
     144        <term>
     145          <interface>8. Contents in current directory</interface>
     146        </term>
     147        <listitem>
     148          <para>
     149            This area contains the files and sub directories that are located in the
     150            current directory that is choosen in the navigation tree.
     151          </para>
     152        </listitem>
     153      </varlistentry>
     154
     155      <varlistentry>
     156        <term>
     157          <interface>9. Navigation tree</interface>
     158        </term>
     159        <listitem>
     160          <para>
     161            This sidebar displays the tree of directories that the current user has
     162            permission to read. Click on a directory to display it's contents in the
     163            list or click on the plus sign to the left to expand directory and view the
     164            subdirectories (no plus sign - no subdirectories).
     165          </para>
    129166        </listitem>
    130167      </varlistentry>
     
    133170    <sect2 id="file_system.system.browse">
    134171      <title>Browse the file system</title>
    135       <para></para>
     172      <para>
     173        Browsing BASE2's filesystem is done from the navigation bar by clicking on a
     174        directory to view it's contents in the list. Both subdirectories and files in the
     175        selected directory are showed.
     176      </para>
     177      <note>
     178        <title>Browse a directory</title>
     179        <para>
     180          A directory can only be open from the navigation tree and never from the list. A
     181          click on a directory's name in the list will open the directory's edit window.
     182        </para>
     183      </note>
    136184      <sect3 id="file_system.system.browse.tree">
    137185        <title>Navigation tree</title>
    138         <para></para>
     186        <para>
     187          The navigation tree contains of folders/directories that the logged in user has
     188          permission to read. At the top is the current user's home directory and under it
     189          is a folder with all home directories.
     190        </para>
     191        <para>
     192          The tree can be updated with the refresh-button at the bottom of the panel (the
     193          tree isn't self-refreshing).
     194        </para>
    139195        <sect4 id="file_system.system.browse.tree.home">
    140196          <title>Home directory - 'My home'</title>
    141           <para></para>
     197          <para>
     198            To make it easier for the logged in user to find his/her directory without
     199            having to scroll through the whole list of home directories, his or hers
     200            home directory is located at the top of the navigation tree under the
     201            <interface>My home</interface>
     202            folder .
     203          </para>
     204          <note>
     205            <title>No home directory</title>
     206            <para>
     207              Not all users have a home directory connected to their accounts. If
     208              <interface>My home</interface>
     209              is missing, it most certainly depends on that the current user account
     210              doesn't have got a home directory. Home directories are managed by the
     211              user administrator on the BASE2 server.
     212            </para>
     213          </note>
    142214        </sect4>
    143215      </sect3>
    144216    </sect2>
    145217    <sect2 id="file_system.system.qouta">
    146       <title>Diskspace quota</title>
    147       <para></para>
     218      <title>Disk space quota</title>
     219      <para>
     220        Normally is the user accounts assigned with limited quota of disk space used to
     221        store files, raw data or experiments at a location. The three categories have, in
     222        case of disk quota, a total limit of space to use and it's also possible for them to
     223        have a limit by their own too.
     224        <example>
     225          <title>Disk quota</title>
     226          <para>
     227            The user account has a total quota of 1GB but there is also a limitation of
     228            raw data to be at maximum 500MB. This will prevent the raw data to take more
     229            then 500 MB of the total quota.
     230          </para>
     231        </example>
     232        More information about how much quota the current account has and how much that is
     233        occupied of it can be found at account's home page, described in
     234        <xref linkend="webclient.intro.homepage" />
     235        .
     236      </para>
    148237    </sect2>
    149238    <sect2 id="file_system.system.locaiton">
    150239      <title>Location</title>
    151       <para></para>
     240      <para>TODO</para>
    152241    </sect2>
    153242  </sect1>
     
    176265    <sect2 id="file_system.handling.edit">
    177266      <title>Edit a file</title>
    178       <para></para>
    179       <sect3 id="file_system.handling.properties">
    180         <title>Properties</title>
    181         <helptext external_id="file.edit" title="Edit file properties">
    182           <para></para>
    183         </helptext>
    184       </sect3>
     267      <para>
     268        The edit window to set a file's property in can either be open with
     269        <guibutton>Edit&hellip;</guibutton>
     270        in the toolbar at the file's view page or by holding down
     271        <keycap>ctrl</keycap>
     272        ,
     273        <keycap>alt</keycap>
     274        or
     275        <keycap>shift</keycap>
     276        when clicking on the name of the file. It requires that the current user has write
     277        permission on the file to be able to edit and set the properties.
     278      </para>
     279
     280      <helptext external_id="file.edit" title="Edit file properties">
     281        <para>These are the file's properties that appears in the popup window.</para>
     282        <variablelist>
     283          <title>Properties</title>
     284          <varlistentry>
     285            <term>
     286              <guilabel>Path</guilabel>
     287            </term>
     288            <listitem>
     289              <para>
     290                This property can not be changed in the edit window and so the user
     291                knows the ful path to the file. This can Instead be changed by
     292                moving the file, which is described in
     293                <xref linkend="file_system.handling.move" />
     294                .
     295              </para>
     296            </listitem>
     297          </varlistentry>
     298          <varlistentry>
     299            <term>
     300              <guilabel>Name</guilabel>
     301            </term>
     302            <listitem>
     303              <para>
     304                This is the file's name, which must be unique in current directory.
     305                The name can't have more then 255 characters.
     306              </para>
     307            </listitem>
     308          </varlistentry>
     309          <varlistentry>
     310            <term>
     311              <guilabel>Type</guilabel>
     312            </term>
     313            <listitem>
     314              <para>
     315                Sets which kind of type the file is. Select a file type from the
     316                drop down list to use or select
     317                <guilabel>-none-</guilabel>
     318                if no file type should be associated with the file.
     319              </para>
     320            </listitem>
     321          </varlistentry>
     322          <varlistentry>
     323            <term>
     324              <guilabel>MIME type</guilabel>
     325            </term>
     326            <listitem>
     327              <para></para>
     328            </listitem>
     329          </varlistentry>
     330          <varlistentry>
     331            <term>
     332              <guilabel>Description</guilabel>
     333            </term>
     334            <listitem>
     335              <para></para>
     336            </listitem>
     337          </varlistentry>
     338        </variablelist>
     339        <para>
     340          Finish the editing process by pressing
     341          <guibutton>Save</guibutton>
     342          to save the properties to the database or press
     343          <guibutton>Cancel</guibutton>
     344          to abort and discard the changes.
     345        </para>
     346      </helptext>
     347
    185348    </sect2>
    186349    <sect2 id="file_system.handling.remove">
Note: See TracChangeset for help on using the changeset viewer.