Changeset 3181


Ignore:
Timestamp:
Mar 12, 2007, 4:01:43 PM (15 years ago)
Author:
Nicklas Nordborg
Message:

Added some text about list pages

Location:
trunk/doc/src/docbook/userdoc
Files:
1 edited
1 moved

Legend:

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

    r3173 r3181  
    2929  <title>User documentation</title>
    3030  <include file= "about.xml"/>
    31   <include file="gui.xml"/>
     31  <include file="webclient.xml"/>
    3232  <include file="project_permission.xml"/>
    3333  <include file="trashcan.xml"/>
  • trunk/doc/src/docbook/userdoc/webclient.xml

    r3177 r3181  
    2727-->
    2828
    29 <chapter id="gui">
    30   <title>GUI</title>
    31     <sect1>
     29<chapter id="webclient">
     30  <title>Using the web client</title>
     31    <sect1 id="webclient.introduction">
    3232      <title>Introduction</title>
    3333      <para></para>
    3434     
    35       <sect2>
    36         <title>Help texts</title>
     35      <sect2 id="webclient.intro.login">
     36        <title>Logging in</title>
    3737        <para></para>
    3838      </sect2>
    3939     
    40       <sect2>
    41         <title>Menu bar</title>
     40      <sect2 id="webclient.intro.menubar">
     41        <title>Using the menu bar</title>
    4242        <para></para>
    4343      </sect2>
    4444     
    45       <sect2>
    46         <title>Tool bar</title>
     45      <sect2 id="webclient.intro.help">
     46        <title>Getting help</title>
    4747        <para></para>
    4848      </sect2>
    49      
    50       <sect2>
    51         <title>Ctrl/alt/shift - click</title>
    52         <para></para>
    53       </sect2>
     49   
    5450    </sect1>
    5551   
    56     <sect1>
    57       <title>Configuration</title>
     52    <sect1 id="webclient.configuration">
     53      <title>Configuring your account</title>
     54     
     55      <sect2 id="webclient.configuration.contact">
     56        <title>Contact information</title>
     57      </sect2>
     58
     59      <sect2 id="webclient.configuration.password">
     60        <title>Changing password</title>
     61      </sect2>
     62
     63      <sect2 id="webclient.configuration.other">
     64        <title>Other settings</title>
     65      </sect2>
     66 
    5867    </sect1>
    5968   
     69    <sect1 id="webclient.itemlist">
     70      <title>Listing items</title>
     71     
     72      <para>
     73        All pages that lists items are very similar in their appearance and
     74        functionality. In this section we will describe the things that are
     75        common for most (if not all) list pages.
     76      </para>
     77     
     78      <para>
     79        Use the <link linkend="webclient.intro.menubar">menu</link> to
     80        open a page listing items. Most list pages can only
     81        list one type of items. For example: use the
     82        <menuchoice><guimenu>View</guimenu><guimenuitem>Samples</guimenuitem></menuchoice>
     83        menu to list samples and the
     84        <menuchoice><guimenu>View</guimenu><guimenuitem>Experiments</guimenuitem></menuchoice>
     85        menu to list experiments. A typical list
     86        page is shown below.
     87      </para>
     88     
     89      <figure id="webclient.figures.listpage">
     90        <title>Example of a list page</title>
     91        <screenshot>
     92          <mediaobject>
     93            <imageobject><imagedata fileref="figures/listpage.png" format="PNG" /></imageobject>
     94          </mediaobject>
     95        </screenshot>
     96      </figure>
     97     
     98      <para>
     99        The typical list page contains the following important
     100        elements:
     101      </para>
     102     
     103      <variablelist>
     104        <varlistentry>
     105          <term><interface>Toolbar</interface></term>
     106          <listitem>
     107            <para>
     108            A toolbar with buttons for various actions such as
     109            <guibutton>New&hellip;</guibutton> for creating a new item,
     110            <guibutton>Delete</guibutton> for deleting items and
     111            <guibutton>Columns&hellip;</guibutton> for configuring columns.
     112            Depending on the permissions of the logged in user
     113            some buttons may be disabled (greyed out) or not shown at all.
     114            </para>
     115          </listitem>
     116        </varlistentry>
     117       
     118        <varlistentry>
     119          <term><interface>Navigation bar</interface></term>
     120          <listitem>
     121            <para>
     122            If there are many items the list will be divided into
     123            pages showin a limited number of items at the same time.
     124            The navigation bar allows you to
     125            move to other pages and specify how many items each page
     126            should display. The navigation bar is repeated at the
     127            bottom of the list so you don't have to scroll back to the
     128            top of a long list just to get to another page.
     129            </para>
     130          </listitem>
     131        </varlistentry>
     132       
     133        <varlistentry>
     134          <term><interface>List of presets</interface></term>
     135          <listitem>
     136            <para>
     137            A list with preconfigured settings allowing you to
     138            quickly switch between different layouts (sort order, visible
     139            columns, filter settings, etc).
     140            </para>
     141          </listitem>
     142        </varlistentry>
     143       
     144        <varlistentry>
     145          <term><interface>Column headers</interface></term>
     146          <listitem>
     147            <para>
     148            The columns headers can be used for selecting sort order.
     149            </para>
     150          </listitem>
     151        </varlistentry>
     152       
     153        <varlistentry>
     154          <term><interface>Filter bar</interface></term>
     155          <listitem>
     156            <para>
     157            The filter bar allows you to search for items.
     158            </para>
     159          </listitem>
     160        </varlistentry>
     161       
     162      </variablelist>
     163     
     164     
     165      <sect2 id="webclient.itemlist.order">
     166        <title>Ordering the list</title>
     167       
     168        <para>
     169          Most lists are by default sorted by the name of the item. This can
     170          be changed by clicking on the column header of another column.
     171          If you click on the same column twice the sort order is reversed.
     172          A downwards or upwards pointing arrow is displayed next to the
     173          column header in the column that is currently used for sorting.
     174          Column headers that are black can't be used for sorting.
     175        </para>
     176       
     177        <para>
     178          It is possible to use more than one column for sorting. Press
     179          and hold one of the <keycap>CTRL</keycap>,
     180          <keycap>ALT</keycap> or <keycap>SHIFT</keycap> keys while clicking
     181          on another column header. The original sorting is kept and the new
     182          column is used for sub-sorting the list. The procedure can be
     183          repeated with more columns if you need to sort on three or more
     184          columns. To revert to sort by only one column again click the
     185          column header without holding down any key.
     186        </para>
     187      </sect2>
     188   
     189      <sect2 id="webclient.itemlist.filter">
     190        <title>Filtering the list</title>
     191       
     192        <para>
     193          If the list contains many items you may need to use a filter to be
     194          able to find the item you are looking for. The input boxes on the
     195          line below the column headers are used for filtering. Most columns
     196          are filtered using a free-text input box, but some columns that can
     197          only take a few distinct values use a selection list or radio buttons
     198          instead. The selection list and radio buttons are very simple to use.
     199          Just select the alternative that you want to filter on. The list
     200          will be automatically updated when the selection has been made.
     201        </para>
     202       
     203        <para>
     204          The free-text filter is a bit more complex. By default, an exact match is
     205          required, use a % as a wildcard that matches any character.
     206          For example, the filter <informalexample>Experiment A</informalexample>
     207          only matches the same exact string, but the filter
     208          <informalexample>Exp%</informalexample> matches
     209          <informalexample>Experiment A, Experiment B, etc.</informalexample>
     210        </para>
     211       
     212        <para>
     213          You can also use operators to find items which has a value that
     214          is greater than, less than or not equal to a specific value. This is
     215          mostly useful on numeric or date columns but also works on text
     216          columns. The operator must be entered first in the
     217          free-text box, for example
     218          <informalexample>&lt;=10</informalexample>
     219          to find items which has a value less than or equal to 10.   
     220          Here is a list of the supported operators:
     221        </para>
     222       
     223        <variablelist id="webclient.itemlist.filter.operators">
     224          <title>List of operators supported by the free-text filter</title>
     225          <varlistentry>
     226            <term><keycap>&lt;</keycap></term>
     227            <listitem>Less than</listitem>
     228          </varlistentry>
     229          <varlistentry>
     230            <term><keycap>&lt;=</keycap></term>
     231            <listitem>Less than or equal to</listitem>
     232          </varlistentry>
     233          <varlistentry>
     234            <term><keycap>&gt;</keycap></term>
     235            <listitem>Greater than</listitem>
     236          </varlistentry>
     237          <varlistentry>
     238            <term><keycap>&gt;=</keycap></term>
     239            <listitem>Greater than or equal to</listitem>
     240          </varlistentry>
     241          <varlistentry>
     242            <term><keycap>=</keycap></term>
     243            <listitem>Equal to (useful to find items with a null value)</listitem>
     244          </varlistentry>
     245          <varlistentry>
     246            <term><keycap>&lt;&gt;</keycap></term>
     247            <term><keycap>!=</keycap></term>
     248            <listitem>Not equal to (useful to find items with a non-null value)</listitem>
     249          </varlistentry>
     250        </variablelist>
     251      </sect2>
     252     
     253      <sect2 id="webclient.itemlist.columns">
     254        <title>Configuring which columns to show</title>
     255       
     256        <para>
     257          Most lists show only a small subset of the columns it
     258          is capable of showing. Use the
     259          <guibutton>Columns&hellip;</guibutton> button to open
     260          a dialog that allows you to select which columns to show
     261          and the order which they are shown.
     262        </para>
     263       
     264        <figure id="webclient.figures.configure_columns">
     265          <title>Configuring which columns to show</title>
     266          <screenshot>
     267          <mediaobject>
     268            <imageobject>
     269              <imagedata fileref="figures/configure_columns.png" format="PNG"/>
     270            </imageobject>
     271          </mediaobject>
     272          </screenshot>
     273        </figure>
     274       
     275        <para>
     276          Use the left/right arrow buttons to move columns between
     277          the <guilabel>Visible columns</guilabel> list and the
     278          <guilabel>Hidden columns</guilabel> list. Use the up/down arrow
     279          buttons to arrange the order of the visible columns. The topmost column
     280          will be shown to the left.
     281        </para>
     282       
     283        <para>
     284          Columns marked with an <guilabel>×</guilabel> are required
     285          and can't be hidden. In mosts lists the <guilabel>Name</guilabel> column
     286          is the only column that is required.
     287        </para>
     288       
     289        <para>
     290          The <guilabel>Presets</guilabel> dropdown list allows you to
     291          select a set of preconfigured columns. You may also create
     292          your own preset if often you need to switch between different
     293          configurations. The list of presets is the same as the one
     294          described <link linkend="webclient.itemlist.presets">below</link>.
     295        </para>
     296       
     297       
     298      </sect2>
     299     
     300      <sect2 id="webclient.itemlist.presets">
     301        <title>Presets</title>
     302       
     303        <para>
     304          The <guilabel>view / presets</guilabel> dropdown has three
     305          functions (TODO - screen shot):
     306        </para>
     307       
     308        <orderedlist>
     309          <listitem>
     310            <para>
     311              Switch between different configuration presets.
     312             
     313            </para>
     314           
     315            <para>
     316              The top of the <guilabel>view / presets</guilabel> dropdown
     317              contains user-defined presets and a few
     318              preconfigured presets. The preconfigured presets only affects
     319              the visible columns as follows:
     320            </para>
     321           
     322            <itemizedlist>
     323              <listitem>
     324                <para><guilabel>All columns</guilabel> - Show all columns</para>
     325              </listitem>
     326              <listitem>
     327                <para><guilabel>Required columns</guilabel> - Show only the required columns</para>
     328              </listitem>
     329              <listitem>
     330                <para><guilabel>Default columns</guilabel> - Show the default set of columns</para>
     331              </listitem>
     332              <listitem>
     333                <para><guilabel>Other&hellip;</guilabel> -
     334                  Open the <link linkend="webclient.itemlist.columns">configure columns dialog box</link>.</para>
     335              </listitem>
     336            </itemizedlist>
     337           
     338            <para>
     339              The user-defined presets affects the visible columns, the sort order,
     340              filter settings, the number of items per page and the current page.
     341            </para>
     342          </listitem>
     343         
     344          <listitem>Filter items by the removed status and the access
     345            permissions to an item</listitem>
     346
     347          <listitem>Administrate the presets</listitem>
     348
     349        </orderedlist>
     350      </sect2>
     351     
     352    </sect1>
     353   
     354    <sect1 id="webclient.items">
     355      <title>Working with items</title>
     356     
     357      <sect2 id="webclient.items.new">
     358        <title>Creating a new item</title>
     359      </sect2>
     360     
     361      <sect2 id="webclient.items.edit">
     362        <title>Editing an existing item</title>
     363      </sect2>
     364
     365      <sect2 id="webclient.items.delete">
     366        <title>Delete an item</title>
     367      </sect2>
     368     
     369      <sect2 id="webclient.items.restore">
     370        <title>Restore a deleted item</title>
     371      </sect2>
     372
     373    </sect1>
     374   
     375   
    60376</chapter>
Note: See TracChangeset for help on using the changeset viewer.