Changeset 3790


Ignore:
Timestamp:
Sep 26, 2007, 11:24:20 AM (15 years ago)
Author:
Martin Svensson
Message:

References #524 Some small changes to finish the writing.

File:
1 edited

Legend:

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

    r3782 r3790  
    3131  <title>Overview of user documentation</title>
    3232  <para>
    33     This part of the documentation is quite extensive and covers all from how to login on a
     33    The 'User documentation' part is quite extensive and covers all 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. In other words it is possible to find anything a normal user wants to
    36     know about BASE. The intention with this first chapter is to give an overview of the
     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
    3737    following chapters so it will be easier for you to know where to look for certain
    3838    information in case you don't want to read the whole part from the beginning to the end.
     
    4242    <title>Working environment</title>
    4343    <para>
    44       Before you start working with any big experiment or project in BASE it could be handy to
    45       get to know the environment and perhaps personalize some behavior and appearance of the
    46       program. When this is done your daily work in BASE will be much easier and you will feel
    47       more comfortable working with the program.
     44      Before you start working with any big experiment or project in BASE it could be a good
     45      idea to get to know the environment and perhaps personalize some behavior and appearance
     46      of the program. When this is done your daily work in BASE will be much easier and you
     47      will feel more comfortable working with the program.
    4848    </para>
    4949
    5050    <para>
    5151      Most of the things that have to do with the working environment are gathered in one
    52       chapter,
    53       <xref linkend="webclient" />
    54       where the first subsection,
     52      chapter, where the first subsection,
    5553      <xref linkend="webclient.introduction" />
    5654      , gives a good guidance how to start using BASE including a general explanation
     
    6361      , describes how to personlize BASE with contact information, preferences and changing
    6462      password. The preferences are for instance some appearance like date-format, text-size
    65       or the look of buttons in the toolbar.
     63      or the look of the toolbar-buttons.
    6664    </para>
    6765
    6866    <para>
    69       The last two subsections in the webclient chapter explain how to work with items in
    70       BASE. Things explained here are general in BASE and give e.g information about item
    71       lists and in which ways they can be adjusted to become easier to overlook. Here is also
    72       described the general way of working with a single item, like creating, editing and
    73       deleting. Each item type has also a section of it's own later in this part, where more
    74       detailed information can be found.
     67      The last two subsections,
     68      <xref linkend="webclient.items" />
     69      and
     70      <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.
    7576    </para>
    7677  </sect1>
     
    8081    <para>
    8182      There are some working principles that need to be understood by all users in BASE. These
    82       are about the permission system and how to get the workflow to move on without any
     83      concern the permission system and how to get the workflow to move on without any
    8384      disturbance caused by insufficient permission. The key is to work in projects, that and
    8485      the permission system are covered in
     
    8788    <para>
    8889      Understanding the permission system and how to work in projects will not only make it
    89       simpliar for you to work in BASE but also for your colleagues who needs access to your
    90       items when you are working together.
     90      simpliar for you to work in BASE but also for your co-workers who want access to your
     91      items.
    9192    </para>
    9293  </sect1>
     
    9697    <para>
    9798      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, but some
    99       items and data must be imported from files. The files to import from have to be on the
    100       BASE-server's file system.
     99      data to work with. Most of the different items are created in the same way in the
     100      webclient, but some items and data must be imported from files. Before importing a file,
     101      it has to be uploaded on the BASE-server's filesystem.
    101102      <xref linkend="file_system" />
    102       explains how the server's file system works and how to upload the files.
     103      gives you information about the server's file system and how to upload the files.
     104    </para>
     105
     106    <para>
     107     
     108      <xref linkend="import_export_data" />
     109      explains then how the import is done . This chapter also covers how the data later on
     110      can be exported from the database back into files, often simple text files or xml files.
    103111    </para>
    104112   
    105113    <para>
    106       In most cases it's not enough to just keep the data in files on the server. To be able
    107       to use the data it has to be imported into the database.
    108       <xref linkend="import_export" />
    109       explains how this is done . This chapter also covers how the data later on are exported
    110       from the database back into files, often simple text or xml files.
     114      Each different item has it's own section in this part of the documentation, where more specific
     115      information can be found, such as properties, they are created and so on. Go back to the table
     116      of contents for this part and look up the item you want to know more about.
    111117    </para>
    112118  </sect1>
Note: See TracChangeset for help on using the changeset viewer.