Changeset 3892


Ignore:
Timestamp:
Oct 30, 2007, 2:33:19 PM (14 years ago)
Author:
Nicklas Nordborg
Message:

Fixes #524: Read "Overview of user documentation" section

File:
1 edited

Legend:

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

    r3794 r3892  
    3131  <title>Overview of user documentation</title>
    3232  <para>
    33     The 'User documentation' part is quite extensive and covers all from how to login on a
     33    The 'User documentation' part is quite extensive and covers everything from how to login on a
    3434    BASE2 server and find your way through the program, to working with experiments and doing
    35     some useful analysis. It is possible to find anything a normal user wants to
    36     know about BASE in this part. The intention with this chapter is to give an overview of the
     35    some useful analysis. The intention with this chapter is to give an overview of the
    3736    following chapters so it will be easier for you to know where to look for certain
    3837    information in case you don't want to read the whole part from the beginning to the end.
     
    6059      <xref linkend="webclient.configuration" />,
    6160      describes how to personlize BASE with contact information, preferences and changing
    62       password. The preferences are for instance some appearance like date-format, text-size
    63       or the look of the toolbar-buttons.
     61      password. The preferences are for instance some appearance like date format, text size
     62      or the look of the toolbar buttons.
    6463    </para>
    6564
     
    6968      and
    7069      <xref linkend="webclient.itemlist" />,
    71       in the webclient chapter explain how to work with items in BASE. Things explained here
    72       are general in BASE and give e.g information about itemlists and in which ways they can
    73       be adjusted to become easier to overlook. Here is also described some single item issue,
    74       like creating, editing and deleting. Each item type has also a section of it's own later
    75       in this part, where more detailed information can be found.
    76     </para>
    77   </sect1>
    78 
    79   <sect1 id="userdoc_overview.think_base">
    80     <title>How to think like BASE</title>
    81     <para>
    82       There are some working principles that need to be understood by all users in BASE. These
    83       concern the permission system and how to get the workflow to move on without any
    84       disturbance caused by insufficient permission. The key is to work in projects, which
    85       is covered in detail in <xref linkend="project_permission" />.
    86     </para>
    87     <para>
    88       Understanding the permission system and how to work in projects will not only make it
    89       more simple for you to work in BASE but also for your co-workers who want access to your
    90       items.
     70      in the webclient chapter explains how to work with BASE. No matter what you
     71      are going to do the user interface contains a lot of common functions that
     72      works the same everywhere. For example, how to list and search for items,
     73      how to create new items and modify and delete existing items. Subsequent
     74      chapters with detailed information about each type of item will usually
     75      not include descriptions of the common functionality.
    9176    </para>
    9277  </sect1>
     
    9580    <title>Start working with BASE</title>
    9681    <para>
    97       The first thing to do in BASE, to get started with your work, is to put in some relevant
    98       data to work with. Most of the different items are created in the same way in the
    99       webclient, but some items and data must be imported from files. Before importing a file,
     82      There are some working principles that need to be understood by all users in BASE. These
     83      concern the permission system and how to get the workflow to move on without any
     84      disturbance caused by insufficient permissions. The key is to work in projects, which
     85      is covered in detail in <xref linkend="project_permission" />.
     86    </para>
     87    <para>
     88      Understanding the permission system and how to work in projects will not only make it
     89      more simple for you to work in BASE but also for your co-workers who want access to your
     90      data.
     91    </para>
     92    <para>
     93      The next thing to do is to add some relevant
     94      data to work with. Most of the different items can be created manually from the
     95      web client, but some items and data must be imported from files. Before importing a file,
    10096      it has to be uploaded on the BASE-server's filesystem.
    10197      <xref linkend="file_system" />
     
    112108    <para>
    113109      Each different item has it's own section in this part of the documentation, where more specific
    114       information can be found, such as properties, they are created and so on. Go back to the table
     110      information and also some screen shots can be found. Go back to the table
    115111      of contents for this part and look up the item you want to know more about.
    116112    </para>
Note: See TracChangeset for help on using the changeset viewer.