Changeset 3197


Ignore:
Timestamp:
Mar 19, 2007, 2:31:39 PM (16 years ago)
Author:
Nicklas Nordborg
Message:

More documentation about the web client

Location:
trunk/doc/src/docbook
Files:
2 added
3 edited

Legend:

Unmodified
Added
Removed

  • trunk/doc/src/docbook/userdoc/project_permission.xml

    r3192 r3197  
    2828
    2929<chapter id="project_permission">
    30   <title>Project and the permission system</title>
     30  <title>Projects and the permission system</title>
    3131    <sect1>
    3232      <title></title>

  • trunk/doc/src/docbook/userdoc/webclient.xml

    r3192 r3197  
    3535      <sect2 id="webclient.intro.login">
    3636        <title>Logging in</title>
    37         <para></para>
     37        <para>
     38          There are three things that you need to know
     39          before you can use BASE:
     40        </para>
     41       
     42        <orderedlist>
     43        <listitem>The address (URL) to a BASE server</listitem>
     44        <listitem>A username to login with</listitem>
     45        <listitem>A password</listitem>
     46        </orderedlist>
     47       
     48        <para>
     49          You may, for example, try the BASE 2 demo server. Go to the
     50          URL <ulink url="http://base2.thep.lu.se:8080/demo/">http://base2.thep.lu.se:8080/demo/</ulink>
     51          and enter <userinput>base2</userinput> for the login and <userinput>base2</userinput>
     52          for the password.
     53        </para>
     54       
     55        <para>
     56          You will need to get all three things from a adminstrator
     57          of the BASE server. If you know only the address to the
     58          BASE server, you may check the front page if the administrator
     59          has added any information about how to get a username/password
     60          there. Look for a link named <guilabel>Get an account!</guilabel>.
     61        </para>
     62       
     63        <para>
     64          Logging in is simple, just enter your <guilabel>login</guilabel>
     65          and <guilabel>password</guilabel> in the input fields. There is
     66          a checkbox which allows you to <guilabel>encrypt the password</guilabel>
     67          before it is sent to the BASE server. It is enabled by default, and
     68          it is a good idea to leave it checked unless you have problems logging
     69          in. If you are sure you are entering the correct login and password
     70          try unchecking the encyption option.
     71        </para>
     72      </sect2>
     73 
     74      <sect2 id="webclient.intro.homepage">
     75        <title>The home page</title>
     76     
     77      <para>
     78        When you have been logged in the home page will be displayed. It
     79        displays some useful information.
     80      </para>
     81       
     82      <figure id="webclient.figures.homepage">
     83        <title>The home page</title>
     84        <screenshot>
     85          <mediaobject>
     86            <imageobject><imagedata fileref="figures/homepage.png" format="PNG"/></imageobject>
     87          </mediaobject>
     88        </screenshot>
     89      </figure>
     90       
     91      <variablelist>
     92        <varlistentry>
     93          <term><interface>New messages</interface></term>
     94          <listitem>
     95            <para>
     96            Messages are sent by plugins to notify you about finished jobs.
     97            </para>
     98          </listitem>
     99        </varlistentry>
     100       
     101        <varlistentry>
     102          <term><interface>Projects</interface></term>
     103          <listitem>
     104            <para>
     105            A list of projects that you are a member of. It is possible
     106            to select to activate a project from this list. We recommend
     107            that you always use a project when working with BASE. It will
     108            make your life much easier once you start to cooperate with
     109            other users. For more information read <xref linkend="project_permission"/>.
     110            </para>
     111          </listitem>
     112        </varlistentry>
     113       
     114        <varlistentry>
     115          <term><interface>Disk usage</interface></term>
     116          <listitem>
     117            <para>
     118            An overview of how much disk space you have been assigned and
     119            how much you are using.
     120            </para>
     121          </listitem>
     122        </varlistentry>
     123       
     124        <varlistentry>
     125          <term><interface>Help</interface></term>
     126          <listitem>
     127            <para>
     128            Links for getting help and reportering bugs. The number
     129            of links displayed here may vary depending on how the administrator
     130            have set up the server.
     131            </para>
     132          </listitem>
     133        </varlistentry>
     134       
     135        <varlistentry>
     136          <term><interface>News and announcements</interface></term>
     137          <listitem>
     138            <para>
     139            A list of important news and announcements from the
     140            server administrator. Here you may, for example, find
     141            information about server upgrades and maintenance.
     142            </para>
     143          </listitem>
     144        </varlistentry>
     145      </variablelist>
     146       
    38147      </sect2>
    39148     
    40149      <sect2 id="webclient.intro.menubar">
    41150        <title>Using the menu bar</title>
    42         <para></para>
     151        <para>
     152          On the top of the home page is the <interface>Menu bar</interface>.
     153          This is the main navigation tool in BASE. It works the same way
     154          as the regular menu system found in most other applications. Use
     155          the mouse to click and select an item from the menu.
     156        </para>
     157       
     158        <para>
     159          Most of the menu is in two levels, ie. clicking on a top-level menu
     160          will open a submenu just below it. Clicking on something in the
     161          submenu will take you to another page or open a popup. For example, the
     162          <menuchoice><guimenu>View</guimenu><guimenuitem>Samples</guimenuitem></menuchoice>
     163          menu will take you to the <interface>Samples</interface> page listing
     164          samples.
     165        </para>
     166       
    43167      </sect2>
    44168     
    … …  
    91215        <screenshot>
    92216          <mediaobject>
    93             <imageobject><imagedata fileref="figures/listpage.png" format="PNG" /></imageobject>
     217            <imageobject><imagedata fileref="figures/listpage.png" format="PNG"/></imageobject>
    94218          </mediaobject>
    95219        </screenshot>
    … …  
    100224        elements:
    101225      </para>
    102      
     226
    103227      <variablelist>
    104228        <varlistentry>
    105           <term><interface>Toolbar</interface></term>
     229          <term><interface>1. Toolbar</interface></term>
    106230          <listitem>
    107231            <para>
    … …  
    117241       
    118242        <varlistentry>
    119           <term><interface>Navigation bar</interface></term>
     243          <term><interface>2. Navigation bar</interface></term>
    120244          <listitem>
    121245            <para>
    … …  
    132256       
    133257        <varlistentry>
    134           <term><interface>List of presets</interface></term>
     258          <term><interface>3. List of presets</interface></term>
    135259          <listitem>
    136260            <para>
    … …  
    143267       
    144268        <varlistentry>
    145           <term><interface>Column headers</interface></term>
     269          <term><interface>4. Column headers</interface></term>
    146270          <listitem>
    147271            <para>
    … …  
    152276       
    153277        <varlistentry>
    154           <term><interface>Filter bar</interface></term>
     278          <term><interface>5. Filter bar</interface></term>
    155279          <listitem>
    156280            <para>
    … …  
    203327        <para>
    204328          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.
     329          required, use % as a wildcard that matches any character.
    206330          For example, the filter <informalexample>Experiment A</informalexample>
    207331          only matches the same exact string, but the filter
    … …  
    259383          <guibutton>Columns&hellip;</guibutton> button to open
    260384          a dialog that allows you to select which columns to show
    261           and the order which they are shown.
     385          and the order in which they are shown.
    262386        </para>
    263387       
    … …  
    290414          The <guilabel>Presets</guilabel> dropdown list allows you to
    291415          select a set of preconfigured columns. You may also create
    292           your own preset if often you need to switch between different
     416          your own preset if you often need to switch between different
    293417          configurations. The list of presets is the same as the one
    294           described <link linkend="webclient.itemlist.presets">below</link>.
     418          described <link linkend="webclient.itemlist.presets">below</link>,
     419          but if used from this dialog the presets doesn't affect filters,
     420          sort order, etc.
    295421        </para>
    296422       
    … …  
    303429        <para>
    304430          The <guilabel>view / presets</guilabel> dropdown has three
    305           functions (TODO - screen shot):
    306         </para>
    307        
     431          main functions:
     432        </para>
     433       
     434        <figure id="webclient.figures.viewpresets" float="right">
     435          <title>The view / presets dropdown</title>
     436          <screenshot>
     437            <mediaobject>
     438              <imageobject><imagedata fileref="figures/view_presets.png" format="PNG" /></imageobject>
     439            </mediaobject>
     440          </screenshot>
     441        </figure>
    308442        <orderedlist>
    309443          <listitem>
    310444            <para>
    311445              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
     446              The top of the dropdown contains user-defined presets (<guilabel>Saved preset #1</guilabel> and
     447              <guilabel>#2</guilabel>) and a few preconfigured presets.
     448              The user-defined presets are used to store a complete table configuration,
     449              including:
     450            </para>
     451           
     452            <itemizedlist>
     453              <listitem>Which columns are visible and their order</listitem>
     454              <listitem>The column (or columns) used for sorting</listitem>
     455              <listitem>Filter settings</listitem>
     456              <listitem>The number of items per page and the current page</listitem>
     457            </itemizedlist>
     458           
     459            <para>             
     460              The preconfigured presets only affects
    319461              the visible columns as follows:
    320462            </para>
    … …  
    322464            <itemizedlist>
    323465              <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>
     466                <para><guilabel>All columns</guilabel> - Show all columns.</para>
     467              </listitem>
     468              <listitem>
     469                <para><guilabel>Required columns</guilabel> - Show only the required columns.
     470                  Usually only the <guilabel>Name</guilabel> column is required.</para>
     471              </listitem>
     472              <listitem>
     473                <para><guilabel>Default columns</guilabel> - Show the default set of columns.</para>
    331474              </listitem>
    332475              <listitem>
    … …  
    336479            </itemizedlist>
    337480           
    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>
    342481          </listitem>
    343482         
    344           <listitem>Filter items by the removed status and the access
    345             permissions to an item</listitem>
    346 
    347           <listitem>Administrate the presets</listitem>
     483          <listitem>
     484            <para>
     485              Filter items by the removed status and the access
     486              permissions to an item.
     487            </para>
     488           
     489            <itemizedlist>
     490              <listitem>
     491                <para><guilabel>Removed</guilabel> - If checked, items that have been
     492                marked for deletion are shown, otherwise they are hidden.</para>
     493              </listitem>
     494              <listitem>
     495                <para><guilabel>Owned by me</guilabel> - If checked, items that the logged in user
     496                owns are displayed, otherwise they are hidden.</para>
     497              </listitem>
     498              <listitem>
     499                <para><guilabel>Shared to me</guilabel> - If checked, items that are owned
     500                by other users but shared to the logged in user are displayed, otherwise
     501                they are hidden.</para>
     502              </listitem>
     503              <listitem>
     504                <para><guilabel>In current project</guilabel> -
     505                  If checked, items that are linked with the current project are displayed,
     506                  otherwise they are hidden. It doesn't matter if the logged in user is the
     507                  owner or not. This option is only available if a project is active.
     508                </para>
     509              </listitem>
     510              <listitem>
     511                <para><guilabel>Owned by others</guilabel> -
     512                  This option is only avilable to administrators and will display
     513                  items that are owned by other users.
     514                </para>
     515              </listitem>
     516            </itemizedlist>
     517           
     518            <para>
     519              The default options are to only display items that the current
     520              user owns and, if a project is active, items in that project.
     521            </para>
     522           
     523          </listitem>
     524
     525          <listitem>
     526            <para>
     527              Administrate the presets
     528            </para>
     529            <itemizedlist>
     530              <listitem>
     531                <para><guilabel>Clear filter</guilabel> - Clears
     532                all filters.</para>
     533              </listitem>
     534             
     535              <listitem>
     536                <para><guilabel>Save as&hellip;</guilabel> - Save the
     537                current configuration as a preset.</para>
     538              </listitem>
     539
     540              <listitem>
     541                <para><guilabel>Manage&hellip;</guilabel> - Opens a dialog
     542                where you can remove saved presets. You can also load
     543                saved presets from the dialog, but it is quicker to just
     544                use the dropdown list for this.</para>
     545              </listitem>
     546             
     547            </itemizedlist>
     548         
     549         
     550          </listitem>
    348551
    349552        </orderedlist>
Note: See TracChangeset for help on using the changeset viewer.