Changeset 3219


Ignore:
Timestamp:
Mar 30, 2007, 4:32:55 PM (15 years ago)
Author:
Martin Svensson
Message:

References #528. More text in File management doc/handling files and /file types.

File:
1 edited

Legend:

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

    r3218 r3219  
    279279
    280280      <helptext external_id="file.edit" title="Edit file properties">
    281         <para>These are the file's properties that appears in the popup window.</para>
     281        <para>These are the file's properties that are displayed in the popup window.</para>
    282282        <variablelist>
    283283          <title>Properties</title>
     
    288288            <listitem>
    289289              <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
     290                This is the path where a file is located. This can only be changed
     291                by moving the file, read more about how this is done in
    293292                <xref linkend="file_system.handling.move" />
    294293                .
     
    302301            <listitem>
    303302              <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.
     303                The file's name, which can't be left empty and must be unique in
     304                current directory. The maximum length of the file name is 255
     305                charaters and it can contain blank spaces but not any of
     306                <keycap>~</keycap>
     307                ,
     308                <keycap>\</keycap>
     309                ,
     310                <keycap>/</keycap>
     311                ,
     312                <keycap>:</keycap>
     313                ,
     314                <keycap>;</keycap>
     315                ,
     316                <keycap>*</keycap>
     317                ,
     318                <keycap>&#63;</keycap>
     319                ,
     320                <keycap>&lt;</keycap>
     321                ,
     322                <keycap>&gt;</keycap>
     323                or
     324                <keycap>|</keycap>
     325                .
    306326              </para>
    307327            </listitem>
     
    313333            <listitem>
    314334              <para>
    315                 Sets which kind of type the file is. Select a file type from the
    316                 drop down list to use or select
     335                Shows which kind of type the file is. Select the file type to use
     336                from the drop down list with available types. The option
    317337                <guilabel>-none-</guilabel>
    318                 if no file type should be associated with the file.
     338                should be used if the file shouldn't be associated with any kind of
     339                file type.
    319340              </para>
    320341            </listitem>
     
    325346            </term>
    326347            <listitem>
    327               <para></para>
     348              <para>
     349                The file's content/media type. This is normally set automatically
     350                when uploading the file into BASE2 but it can be changed by an user,
     351                that has write permissions, at any time.
     352              </para>
    328353            </listitem>
    329354          </varlistentry>
     
    333358            </term>
    334359            <listitem>
    335               <para></para>
     360              <para>
     361                This text area can be used to store relevant information about file
     362                and it's contents. Use the magnifying glass, located to the right
     363                under the text area, to edit the text in a larger window.
     364              </para>
    336365            </listitem>
    337366          </varlistentry>
    338367        </variablelist>
    339368        <para>
    340           Finish the editing process by pressing
     369          Finish the editing process by pressing either
    341370          <guibutton>Save</guibutton>
    342           to save the properties to the database or press
     371          to save the properties to the database or
    343372          <guibutton>Cancel</guibutton>
    344373          to abort and discard the changes.
     
    348377    </sect2>
    349378    <sect2 id="file_system.handling.remove">
    350       <title>Delete/Restore/Move offline</title>
    351       <para></para>
     379      <title>Delete, restore and move offline</title>
     380      <para>
     381        These functions are used to manage the directories and files' existance on the
     382        server, to keep the list of files and directories up-to-date and release disk space
     383        on server.
     384      </para>
     385      <sect3 id="file_system.handling.remove.delete">
     386        <title>Delete</title>
     387        <para>
     388          A deleted file/directory is moved to the account's trash can and is marked to be
     389          removed. Those items that have been marked as deleted can't be used in analysis
     390          or other activities in BASE2 but they are not removed from the server and can be
     391          restored again by the users that have write permission on the items.
     392        </para>
     393        <para>
     394          Before a file or directory can be deleted it first needs to be selected, this is
     395          done by ticking the checkbox in front of it's name in the list. Click then on
     396          <guibutton>Delete</guibutton>
     397          to mark the item as deleted.
     398        </para>
     399        <tip>
     400          <title>Delete many directories/files</title>
     401          <para>
     402            Select all those items, that should be deleted in a list to flag them all
     403            for deletion at the same time.
     404          </para>
     405        </tip>
     406        <para>
     407          Files and directories that are marked for deletion can be included in the list
     408          by selecting
     409          <guilabel>Removed</guilabel>
     410          from the drop-down list with presets, see
     411          <xref linkend="webclient.figures.viewpresets" />
     412          .Those which have been deleted are marked with a trash can icon in front of
     413          their names.
     414        </para>
     415      </sect3>
     416      <sect3 id="file_system.handling.remove.restore">
     417        <title>Restore</title>
     418        <para>
     419          Files and directories that have been marked for deletion, and not yet removed
     420          from the trash can, can be restored again without any loss of information. To do
     421          that, the removed items have to be made visible in the list and which is done by
     422          selecting
     423          <guilabel>Removed</guilabel>
     424          in the drop down list of presets, see
     425          <xref linkend="webclient.figures.viewpresets" />
     426          .
     427        </para>
     428        <para>
     429          Select the file or directory that should be restored, by ticking the check box
     430          to the left of the item. Then click on
     431          <guibutton>Restore</guibutton>
     432          in the toolbar to restore and remove the deletion flag. The trash can has now
     433          disappeared infront of the item that was restored and it's possible to use the
     434          item in BASE2 again.
     435        </para>
     436        <tip>
     437          <title>Restoring multiple directories/files</title>
     438          <para>
     439            Multiple files and directories can be restored at the same time. This is
     440            done by selecting all the items that should be restored before pressing the
     441            restore button.
     442          </para>
     443        </tip>
     444      </sect3>
     445      <sect3 id="file_system.handling.remove.move_offline">
     446        <title>Move offline</title>
     447        <para>
     448          Moving a file offline means that the fysical file is deleted from the server's
     449          disk space but the file will still exist as an item in the database. This makes
     450          it possible to save disk space but still be able to asociate the file with other
     451          items in BASE2.
     452        </para>
     453        <para>
     454          Tick the checkbox for those files that should be moved offline and press then
     455          <menuchoice>
     456            <guibutton>Move&hellip;</guibutton>
     457            <guisubmenu>Offline&hellip;</guisubmenu>
     458          </menuchoice>
     459          . The selected files will be moved immediatley and disk space will be released.
     460        </para>
     461        <sect4>
     462          <title>Upload a file that is offline</title>
     463          <para>
     464            A file that has been moved offline can be uploaded again by clicking on the
     465            icon in the actions-column, see number 7 in
     466            <xref linkend="file.system.figures.filepage" />
     467            . The procedure to upload the file is the same that is described in
     468            <xref linkend="file_system.handling.upload" />
     469            <important>
     470              <para>
     471                There will not be any check to confirm that the file to upload is
     472                the same that was originally stored in BASE2.
     473              </para>
     474            </important>
     475          </para>
     476        </sect4>
     477      </sect3>
    352478    </sect2>
    353479    <sect2 id="file_system.handling.directories">
    354480      <title>Directories</title>
    355       <para></para>
     481      <para>
     482        Directories in BASE2 are folders where files can be organized into. Click on
     483        <guibutton>New directory&hellip;</guibutton>
     484        in the toolbar to create a directory in current path and edit the properties as
     485        described below.
     486      </para>
    356487      <sect3 id="file_system.handling.directories.edit">
    357488        <title>Edit a directory</title>
     489        <para>
     490          The window to edit a directory's properties is opened either by clicking on the
     491          directory's name in the list or when creating a new directory.
     492        </para>
    358493        <helptext external_id="directory.edit" title="Edit directory">
    359           <para></para>
     494          <para>
     495            <variablelist>
     496              <title>Properties</title>
     497              <varlistentry>
     498                <term>
     499                  <guilabel>Path</guilabel>
     500                </term>
     501                <listitem>
     502                  <para>
     503                    This property is read-only in the edit window but can be
     504                    change instead by moving the directory, described in
     505                    <xref linkend="file_system.handling.move" />
     506                  </para>
     507                </listitem>
     508              </varlistentry>
     509              <varlistentry>
     510                <term>
     511                  <guilabel>Name</guilabel>
     512                </term>
     513                <listitem>
     514                  <para>
     515                    The directory's name to identify it with in the list. This
     516                    field must have a value and it must be an unique name in the
     517                    current directory.
     518                  </para>
     519                </listitem>
     520              </varlistentry>
     521              <varlistentry>
     522                <term>
     523                  <guilabel>Description</guilabel>
     524                </term>
     525                <listitem>
     526                  <para>
     527                    Any relevant information about the directory can be written
     528                    in this text area. The magnifying glass down to the right
     529                    can be used to edit the description text in a larger text
     530                    area, just click on the icon to open it in a separate pop-up
     531                    window.
     532                  </para>
     533                </listitem>
     534              </varlistentry>
     535            </variablelist>
     536          </para>
     537          <para>
     538            The editing process is completed with either
     539            <guibutton>Save</guibutton>
     540            , to save the properties into the database, or with
     541            <guibutton>Cancel</guibutton>
     542            to discard the changes. Both of the buttons will close the edit window and
     543            if the directory is updated the list will be reloaded with the directory's
     544            new properties.
     545          </para>
    360546        </helptext>
    361547      </sect3>
     
    363549    <sect2 id="file_system.handling.move">
    364550      <title>Move file/directory</title>
    365       <para></para>
     551      <para>
     552        Files and directories can be moved to other directories to re-organize the items.
     553      </para>
     554      <para>
     555        Select first of all those files and directories in current path that should be moved
     556        and click then on
     557        <menuchoice>
     558          <guibutton>Move&hellip;</guibutton>
     559          <guisubmenu>To another directory</guisubmenu>
     560        </menuchoice>
     561        to open a window with directories to choose from.
     562      </para>
     563      <para>
     564        Choose a directory where the selected items should be moved to. Doesn't the
     565        directory exist, it can be created in the popup window's current path, with
     566        <guibutton>New&hellip;</guibutton>
     567        .
     568      </para>
     569      <para>
     570        Click on
     571        <guibutton>Ok</guibutton>
     572        to carry out the move or
     573        <guibutton>Cancel</guibutton>
     574        to abort.
     575      </para>
    366576    </sect2>
    367577  </sect1>
     
    369579  <sect1 id="file_system.filetypes">
    370580    <title>File types</title>
    371     <para></para>
     581    <para>
     582      A file can be associated with one of many file types that exists in BASE2. File types
     583      make it possible to sort the files depending of what the files should be use for in the
     584      program.
     585    </para>
     586    <para>
     587      Following file types exists in BASE2.
     588      <variablelist>
     589        <title>File types</title>
     590        <varlistentry>
     591          <term>Image</term>
     592          <listitem>
     593            <para>Indicates that the file is an image file.</para>
     594          </listitem>
     595        </varlistentry>
     596        <varlistentry>
     597          <term>Plate</term>
     598          <listitem>
     599            <para>
     600              The asociated file is a file with information about plate/plates.
     601            </para>
     602          </listitem>
     603        </varlistentry>
     604        <varlistentry>
     605          <term>Plate mapping</term>
     606          <listitem>
     607            <para>Files with information about plate mapping</para>
     608          </listitem>
     609        </varlistentry>
     610        <varlistentry>
     611          <term>Print map</term>
     612          <listitem>
     613            <para>Print map files</para>
     614          </listitem>
     615        </varlistentry>
     616        <varlistentry>
     617          <term>Protocol</term>
     618          <listitem>
     619            <para>files with protocol information</para>
     620          </listitem>
     621        </varlistentry>
     622        <varlistentry>
     623          <term>Raw data</term>
     624          <listitem>
     625            <para>Raw data files</para>
     626          </listitem>
     627        </varlistentry>
     628        <varlistentry>
     629          <term>Reporter</term>
     630          <listitem>
     631            <para>Files with information about reporters</para>
     632          </listitem>
     633        </varlistentry>
     634        <varlistentry>
     635          <term>Reporter map</term>
     636          <listitem>
     637            <para>
     638              Files of this type contain information about how the reporters are
     639              mapped.
     640            </para>
     641          </listitem>
     642        </varlistentry>
     643        <varlistentry>
     644          <term>Spot images</term>
     645          <listitem>
     646            <para>A zip-file containing generated spot images in png format.</para>
     647          </listitem>
     648        </varlistentry>
     649      </variablelist>
     650    </para>
    372651  </sect1>
    373652</chapter>
Note: See TracChangeset for help on using the changeset viewer.