source: trunk/doc/src/docbook/userdoc/webclient.xml @ 3495

Last change on this file since 3495 was 3495, checked in by Nicklas Nordborg, 16 years ago

References #625. Major features are now in place. It's a bit tricky to update the isInContext
method on all plug-ins. I need more testing time to verify that all works before I close the
ticket.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Date Id
File size: 59.1 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE chapter PUBLIC
3    "-//Dawid Weiss//DTD DocBook V3.1-Based Extension for XML and graphics inclusion//EN"
4    "../../../../lib/docbook/preprocess/dweiss-docbook-extensions.dtd">
5<!--
6  $Id: webclient.xml 3495 2007-06-14 12:36:26Z nicklas $
7
8  Copyright (C) Authors contributing to this file.
9
10  This file is part of BASE - BioArray Software Environment.
11  Available at http://base.thep.lu.se/
12
13  BASE is free software; you can redistribute it and/or
14  modify it under the terms of the GNU General Public License
15  as published by the Free Software Foundation; either version 2
16  of the License, or (at your option) any later version.
17
18  BASE is distributed in the hope that it will be useful,
19  but WITHOUT ANY WARRANTY; without even the implied warranty of
20  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  GNU General Public License for more details.
22
23  You should have received a copy of the GNU General Public License
24  along with this program; if not, write to the Free Software
25  Foundation, Inc., 59 Temple Place - Suite 330,
26  Boston, MA  02111-1307, USA.
27-->
28
29<chapter id="webclient">
30  <?dbhtml dir="webclient"?>
31  <title>Using the web client</title>
32    <sect1 id="webclient.introduction">
33      <title>Introduction</title>
34     
35      <sect2 id="webclient.intro.login">
36        <title>Logging in</title>
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><simpara>The address (URL) to a BASE server</simpara></listitem>
44        <listitem><simpara>A username to login with</simpara></listitem>
45        <listitem><simpara>A password</simpara></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 need to get all three things from an administrator
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 the <guilabel>Get an account!</guilabel> link on
61          the front page.
62        </para>
63       
64        <para>
65          Logging in is simple, just enter your <guilabel>login</guilabel> 
66          and <guilabel>password</guilabel> in the form on the front page
67          and click the <guibutton>Login</guibutton> button. There is
68          a checkbox which allows you to <guilabel>encrypt the password</guilabel>
69          before it is sent to the BASE server. It is checked by default, and
70          it is a good idea to leave it checked unless you have problems logging
71          in. If you are sure you are entering the correct login and password,
72          but still cannot log in, try unchecking the encryption option.
73          If the checkbox is not visible, which happens if the server is
74          using an external authentication server, the password is not encrypted.
75        </para>
76      </sect2>
77     
78      <sect2 id="webclient.intro.forgotten_password">
79        <title>Forgotten password</title>
80        <para>
81          If you forget your password you will need to get a new one.
82          BASE stores the passwords in an encrypted form that does not allow
83          anyone, not even the server administrator, to find out the
84          un-encrypted password.
85        </para>
86        <para>
87          To get a new password you will have to contact the server
88          administrator. There may be a <guilabel>Forgot your password?</guilabel>
89          link on the front page where the server administrator has entered
90          information about how to get a new password.
91        </para>
92      </sect2>
93
94      <sect2 id="webclient.intro.homepage">
95        <title>The home page</title>
96     
97      <para>
98        When you have been logged in the home page will be displayed. It
99        displays some useful information. You can also go to the home page
100        using the
101        <menuchoice><guimenu>View</guimenu><guimenuitem>Home</guimenuitem></menuchoice>
102      </para>
103       
104      <figure id="webclient.figures.homepage">
105        <title>The home page</title>
106        <screenshot>
107          <mediaobject>
108            <imageobject><imagedata fileref="figures/homepage.png" format="PNG"
109              scalefit="1" width="100%"/></imageobject>
110          </mediaobject>
111        </screenshot>
112      </figure>
113       
114      <variablelist>
115        <varlistentry>
116          <term><interface>New messages</interface></term>
117          <listitem>
118            <para>
119            Messages are sent by plug-ins to notify you about finished jobs. In the
120            future, you may get messages from other sources as well. As of today,
121            messages are not used for communication between users.
122            </para>
123          </listitem>
124        </varlistentry>
125       
126        <varlistentry>
127          <term><interface>Projects</interface></term>
128          <listitem>
129            <para>
130            A list of projects that you are a member of. Projects are an important
131            part of BASE and are the best way to share data when you are
132            cooperating with other users. We recommend
133            that you always use a project when working with BASE.
134            For more information read <xref linkend="project_permission"/>.
135            </para>
136          </listitem>
137        </varlistentry>
138       
139        <varlistentry>
140          <term><interface>Disk usage</interface></term>
141          <listitem>
142            <para>
143            An overview of how much disk space you have been assigned and
144            how much you are using.
145            </para>
146          </listitem>
147        </varlistentry>
148       
149        <varlistentry>
150          <term><interface>Help</interface></term>
151          <listitem>
152            <para>
153            Links for getting help and reporting bugs. The number
154            of links displayed here may vary depending on the server
155            configuration.
156            </para>
157          </listitem>
158        </varlistentry>
159       
160        <varlistentry>
161          <term><interface>News and announcements</interface></term>
162          <listitem>
163            <para>
164            A list of important news and announcements from the
165            server administrator. Here you may, for example, find
166            information about server upgrades and maintenance.
167            </para>
168          </listitem>
169        </varlistentry>
170      </variablelist>
171       
172      </sect2>
173     
174      <sect2 id="webclient.intro.menubar">
175        <title>Using the menu bar</title>
176        <para>
177          On the top of the home page is the <interface>Menu bar</interface>.
178          This is the main navigation tool in BASE. It works the same way
179          as the regular menu system found in most other applications. Use
180          the mouse to click and select an item from the menu.
181        </para>
182       
183        <para>
184          Most of the menu is in two levels, ie. clicking on a top-level menu
185          will open a submenu just below it. Clicking on something in the
186          submenu will take you to another page or open a popup dialog window.
187          For example, the
188          <menuchoice><guimenu>View</guimenu><guimenuitem>Samples</guimenuitem></menuchoice>
189          menu will take you to the page listing samples and
190          <menuchoice><guimenu>File</guimenu><guimenuitem>Contact information</guimenuitem></menuchoice>
191          opens a dialog where you can modify your contact information details.
192        </para>
193       
194        <para>
195          The menu bar also contains shortcuts to some often-used
196          actions:
197        </para>
198       
199       
200      <variablelist>
201        <varlistentry>
202          <term>
203            <interface>
204            <inlinemediaobject>
205            <imageobject><imagedata fileref="figures/refresh.gif" format="GIF" align="left"
206              /></imageobject>
207            </inlinemediaobject>
208            Refresh page
209            </interface>
210          </term>
211          <listitem>
212            <para>
213            Refresh/reload the current page. This is useful when you add
214            or modify items in BASE. Most of the time the page is refreshed
215            automatically, but in some cases you will have to use
216            this button to refresh the page.
217            </para>
218           
219            <warning>
220              <para>
221              Do not use your browser's <guibutton>Refresh</guibutton> button.
222              Most browsers will take you to the login page again.
223              </para>
224            </warning>
225          </listitem>
226        </varlistentry>
227       
228        <varlistentry>
229          <term>
230            <interface>
231            <inlinemediaobject>
232            <imageobject><imagedata fileref="figures/recent.png" format="PNG" align="left"/></imageobject>
233            </inlinemediaobject>
234            Recent items
235            </interface>
236          </term>
237          <listitem>
238            <para>
239            Shortcut to the most recently viewed items. The number of items are
240            configurable and you can also make some item types
241            <emphasis>sticky</emphasis>. This will for example keep the shortcut
242            to the last experiment even if you have viewed lots of other items
243            more recently.
244            See <xref linkend="webclient.configuration.preferences.mostrecent"/>
245            for configuration information.
246            </para>
247          </listitem>
248        </varlistentry>
249       
250        <varlistentry>
251          <term>
252            <interface>
253            <inlinemediaobject>
254            <imageobject><imagedata fileref="figures/project.gif" format="GIF" align="left"/></imageobject>
255            </inlinemediaobject>
256            Projects
257            </interface>
258          </term>
259          <listitem>
260            <para>
261            A list of all projects you are a member of. Selecting a project in the
262            list will make that project the active project.
263            </para>
264          </listitem>
265        </varlistentry>
266       
267        <varlistentry>
268          <term>
269            <interface>
270            <inlinemediaobject>
271            <imageobject><imagedata fileref="figures/user.png" format="PNG" align="left"/></imageobject>
272            </inlinemediaobject>
273            Logged in user
274            </interface>
275          </term>
276          <listitem>
277            <para>
278            Displays the name of the currently logged in user and allows
279            you to quickly logout and switch to another user.
280            </para>
281          </listitem>
282        </varlistentry>
283       
284      </variablelist>
285       
286      </sect2>
287     
288      <sect2 id="webclient.intro.help">
289        <title>Getting help</title>
290        <para>
291          Besides reading this document there are more ways to get help:
292        </para>
293        <variablelist>
294          <varlistentry>
295            <term>
296              Online context-sensitive help
297            </term>
298            <listitem>
299              <para>
300              Whenever you find a small help icon (
301              <inlinemediaobject>
302              <imageobject><imagedata fileref="figures/help.gif" format="GIF" /></imageobject>
303              </inlinemediaobject>
304              ) or button you may
305              click it to get help about the part of the page
306              you are currently viewing. The icon is located in the title
307              bar in most popup dialog windows and in the toolbar in most
308              other pages.
309              </para>
310            </listitem>
311          </varlistentry>
312
313          <varlistentry>
314            <term>
315              Using the <menuchoice><guimenu>Help</guimenu></menuchoice> menu
316            </term>
317            <listitem>
318              <para>
319              The <menuchoice><guimenu>Help</guimenu></menuchoice> menu
320              contains links for getting online help. These links
321              may be configured by a server administrator, so they may be
322              different from server to server. By default links for reporting
323              a bug and accessing this document are installed.
324              </para>
325            </listitem>
326          </varlistentry>
327
328          <varlistentry>
329            <term>
330              Mailing lists and other resources
331            </term>
332            <listitem>
333              <para>
334              See <xref linkend="resources" />.
335              </para>
336            </listitem>
337          </varlistentry>
338
339        </variablelist>
340       
341      </sect2>
342   
343    </sect1>
344   
345    <sect1 id="webclient.configuration">
346      <title>Configuring your account</title>
347     
348      <sect2 id="webclient.configuration.contact">
349        <title>Contact information</title>
350       
351        <para>
352          Use the <menuchoice><guimenu>File</guimenu>
353          <guimenuitem>Contact information</guimenuitem></menuchoice>
354          menu to bring up the user information dialog.
355        </para>
356       
357        <helptext external_id="userpreferences.contact" title="Contact information">
358       
359          <para>
360          This dialog has three tabs, <guilabel>Contact information</guilabel>
361          (selected), <guilabel>Password</guilabel> and <guilabel>Other information</guilabel>.
362          The logged in user can update the following contact information
363          details.
364          </para>
365       
366          <note>
367            <title>Multi-user accounts</title>
368            <para>
369              If you are using a multi-user account, for example a demo-account, you
370              do not have permission to change the contact information.
371            </para>
372          </note>
373       
374          <variablelist>
375            <varlistentry>
376              <term>
377                <guilabel>Full name</guilabel>
378              </term>
379              <listitem>
380                <para>
381                Your full name. You are not allowed to change this. If
382                it is not correct, contact an administrator to do it for
383                you.
384                </para>
385              </listitem>
386            </varlistentry>
387            <varlistentry>
388              <term>
389                <guilabel>Email</guilabel>
390              </term>
391              <listitem>
392                <para>
393                Your email address (optional).
394                </para>
395              </listitem>
396            </varlistentry>
397            <varlistentry>
398              <term>
399                <guilabel>Organisation</guilabel>
400              </term>
401              <listitem>
402                <para>
403                The name of the organisation you work for or represent (optional).
404                </para>
405              </listitem>
406            </varlistentry>
407            <varlistentry>
408              <term>
409                <guilabel>Address</guilabel>
410              </term>
411              <listitem>
412                <para>
413                Your postal address as it should be printed on letters to you
414                (optional).
415                </para>
416              </listitem>
417            </varlistentry>
418            <varlistentry>
419              <term>
420                <guilabel>Phone</guilabel>
421              </term>
422              <listitem>
423                <para>
424                Your phone number (optional). You may enter multiple phone numbers,
425                for example your work phone number and a mobile number.
426                </para>
427              </listitem>
428            </varlistentry>
429            <varlistentry>
430              <term>
431                <guilabel>Fax</guilabel>
432              </term>
433              <listitem>
434                <para>
435                Your fax number (optional).
436                </para>
437              </listitem>
438            </varlistentry>
439            <varlistentry>
440              <term>
441                <guilabel>Url</guilabel>
442              </term>
443              <listitem>
444                <para>
445                An URL to your home page or your organisation's home page (optional).
446                </para>
447              </listitem>
448            </varlistentry>
449          </variablelist>
450         
451          <para>
452            Press &gbSave; to save the changes or
453            &gbCancel; to abort.
454          </para>
455         
456          <seeother>
457            <other external_id="userpreferences.password">Change password</other>
458            <other external_id="userpreferences.other">Other information</other>
459          </seeother>
460        </helptext>
461       
462      </sect2>
463
464      <sect2 id="webclient.configuration.password">
465        <title>Changing password</title>
466       
467        <para>
468          Use the <menuchoice><guimenu>File</guimenu>
469          <guimenuitem>Change password</guimenuitem></menuchoice>
470          menu to bring up the change password dialog.
471        </para>
472       
473        <helptext external_id="userpreferences.password" title="Change password">
474
475          <para>
476          This dialog has three tabs, <guilabel>Contact information</guilabel>,
477          <guilabel>Password</guilabel> (selected) and <guilabel>Other information</guilabel>.
478          </para>
479
480          <variablelist>
481            <varlistentry>
482              <term>
483                <guilabel>New password</guilabel>
484              </term>
485              <listitem>
486                <para>
487                Enter the new password.
488                </para>
489              </listitem>
490            </varlistentry>
491            <varlistentry>
492              <term>
493                <guilabel>Retype password</guilabel>
494              </term>
495              <listitem>
496                <para>
497                Retype the same password. You must do this to
498                avoid spelling mistakes.
499                </para>
500              </listitem>
501            </varlistentry>
502          </variablelist>
503
504          <note>
505            <title>Multi-user accounts</title>
506            <para>
507              If you are using a multi-user account, for example a demo-account, you
508              do not have permission to change the password.
509            </para>
510          </note>
511       
512          <note>
513            <title>Empty passwords</title>
514            <para>
515              If you leave both fields empty the password will not be changed. It
516              is not possible to have an empty password.
517            </para>
518          </note>
519         
520          <seeother>
521            <other external_id="userpreferences.contact">Contact information</other>
522            <other external_id="userpreferences.other">Other information</other>
523          </seeother>
524         
525        </helptext>
526      </sect2>
527
528      <sect2 id="webclient.configuration.preferences">
529        <title>Preferences</title>
530       
531        <para>
532          Use the <menuchoice><guimenu>File</guimenu>
533          <guimenuitem>Preferences</guimenuitem></menuchoice>
534          menu to bring up the preferences dialog.
535          This dialog has three tabs, <guilabel>Appearance</guilabel>,
536          <guilabel>Plugins</guilabel> and <guilabel>Most recent</guilabel>.
537        </para>
538       
539        <sect3 id="webclient.configuration.preferences.appearance">
540          <title>The Appearance tab</title>
541         
542          <helptext external_id="userpreferences.appearance" title="Preferences - Appearance">
543         
544          <para>
545          This tab contains settings that affect the appearance of the
546          web client.
547          </para>
548         
549          <variablelist>
550            <varlistentry>
551              <term>
552                <guilabel>Font size</guilabel>
553              </term>
554              <listitem>
555                <para>
556                Select a basic font size. You can choose between
557                five sizes: extra small (XS), small (S), medium (M),
558                large (L) and extra large (XL). The default font size is
559                medium.
560                </para>
561              </listitem>
562            </varlistentry>
563            <varlistentry>
564              <term>
565                <guilabel>Scale factor</guilabel>
566              </term>
567              <listitem>
568                <para>
569                The scale factor affects the size of popup windows.
570                This setting exists because different browsers render
571                pages differently. If you often find that popup windows
572                are too small you can change this setting to make them
573                bigger.
574                </para>
575                <note>
576                  <para>
577                    The scale factor is automatically changed if the
578                    font size is changed.
579                  </para>
580                </note>
581              </listitem>
582            </varlistentry>
583            <varlistentry>
584              <term>
585                <guilabel>Toolbar</guilabel>
586              </term>
587              <listitem>
588                <para>
589                You may choose if the toolbar buttons should
590                have only images, only text or both images and text.
591                The default is that they have both images and text.
592                </para>
593              </listitem>
594            </varlistentry>
595            <varlistentry>
596              <term>
597                <guilabel>Ratio color range</guilabel>
598              </term>
599              <listitem>
600                <para>
601                Select three colors to use when displaying
602                data that is suitable for color coding, for
603                example the intensity ratio in two-color
604                experiments. The default setting is blue-black-yellow.
605                The list of presets contains other useful color combinations
606                (for example, the BASE 1 red-yellow-green) and the most
607                recently used color combinations.
608                </para>
609              </listitem>
610            </varlistentry>
611            <varlistentry>
612              <term>
613                <guilabel>Date format</guilabel>
614              </term>
615              <listitem>
616                <para>
617                A format string describing how dates should be displayed.
618                We support all formatting options supported by the Java
619                language. For more information see:
620                <ulink url="http://java.sun.com/j2se/1.5.0/docs/api/java/text/SimpleDateFormat.html">SimpleDateFormat documentation</ulink>
621                The most useful format patterns are:
622                </para>
623               
624                <itemizedlist>
625                  <listitem><simpara>yy: two-digit year</simpara></listitem>
626                  <listitem><simpara>yyyy: four-digit year</simpara></listitem>
627                  <listitem><simpara>MM: two-digit month</simpara></listitem>
628                  <listitem><simpara>MMM: month name (short)</simpara></listitem>
629                  <listitem><simpara>MMMM: month name (full)</simpara></listitem>
630                  <listitem><simpara>dd: two-digit day in month</simpara></listitem>
631                </itemizedlist>
632               
633                <para>
634                The list of presets contains the most commonly/recently
635                used date formats.
636                </para>
637               
638              </listitem>
639            </varlistentry>
640           
641            <varlistentry>
642              <term>
643                <guilabel>Date-time format</guilabel>
644              </term>
645              <listitem>
646                <para>
647                A format string describing how dates with times should be displayed.
648                We support all formatting options supported by the Java
649                language. For more information see:
650                <ulink url="http://java.sun.com/j2se/1.5.0/docs/api/java/text/SimpleDateFormat.html">SimpleDateFormat documentations</ulink>
651                The most useful time-format patterns are:
652                </para>
653               
654                <itemizedlist>
655                  <listitem><simpara>HH: two-digit hour (0-23)</simpara></listitem>
656                  <listitem><simpara>hh: two-digit hour (1-12)</simpara></listitem>
657                  <listitem><simpara>a: AM/PM marker</simpara></listitem>
658                  <listitem><simpara>mm: two-digit minute</simpara></listitem>
659                  <listitem><simpara>ss: two-digit second</simpara></listitem>
660                </itemizedlist>
661               
662              </listitem>
663            </varlistentry>
664           
665            <varlistentry>
666              <term>
667                <guilabel>Decimals</guilabel>
668              </term>
669              <listitem>
670                <para>
671                The number of decimals to display for numeric values.
672                The default is 2.
673                </para>
674              </listitem>
675            </varlistentry>
676           
677          </variablelist>
678       
679          </helptext>
680       
681        </sect3>
682       
683        <sect3 id="webclient.configuration.preferences.plugins">
684          <title>The Plugins tab</title>
685         
686          <helptext external_id="userpreferences.plugins" title="Preferences - Plugins">
687         
688          <para>
689            This tab contains settings that affect plug-in execution.
690          </para>
691         
692          <variablelist>
693            <varlistentry>
694              <term>
695                <guilabel>Messages</guilabel>
696              </term>
697              <listitem>
698                <para>
699                Mark the checkbox if you want to have a message sent
700                to you when a plug-in completes execution. This setting
701                can be overridden each time you start a plug-in.
702                </para>
703              </listitem>
704            </varlistentry>
705            <varlistentry>
706              <term>
707                <guilabel>Remove jobs</guilabel>
708              </term>
709              <listitem>
710                <para>
711                  This checkbox should be marked if you want the jobs, done by
712                  import or export plug-ins, to be marked as removed if they
713                  finished successfully. This setting can be overridden each time
714                  you start a plug-in.
715                </para>
716              </listitem>
717            </varlistentry>
718            <varlistentry>
719              <term>
720                <guilabel>Show warnings</guilabel>
721              </term>
722              <listitem>
723                <para>
724                  This checkbox should be marked if you want to show warning
725                  messages from plug-ins in the <guilabel>Select plug-in</guilabel>
726                  dialog. Warning-level messages usually originates from plug-ins
727                  that are unrelated to the current task and are only of interest to
728                  plug-in developers. Error messages that are related to the
729                  current task are always shown.
730                </para>
731              </listitem>
732            </varlistentry>
733          </variablelist>
734          </helptext>
735         
736        </sect3>
737       
738        <sect3 id="webclient.configuration.preferences.mostrecent">
739          <title>The Recent items tab</title>
740         
741          <helptext external_id="userpreferences.mostrecent" 
742            title="Preferences - Recent items">
743         
744          <para>
745            This tab contains settings that affect the <guilabel>Recent
746            items</guilabel> menu.
747          </para>
748         
749          <variablelist>
750          <varlistentry>
751            <term>
752              <guilabel>Recently viewed items</guilabel>
753            </term>
754            <listitem>
755              <para>
756              The number of recently <emphasis>viewed</emphasis> items to remember.
757              The default is to remember 6 items. The remembered items
758              will be displayed in the <guilabel>Recent items</guilabel>
759              menu in the menu bar.
760              </para>
761            </listitem>
762          </varlistentry>
763          <varlistentry>
764            <term>
765              <guilabel>Recently used items</guilabel>
766            </term>
767            <listitem>
768              <para>
769              The number of recently <emphasis>used</emphasis> items to remember.
770              The default is to remember 4 items. The remembered items will
771              be displayed in edit dialogs where they have been used before.
772              Each type of edit operation has it's own list of remembered items.
773              For example, there is one list that remembers the most recently used
774              protocols when creating a sample, and there is another list that
775              remembers the most recently used scanners when creating a scan.
776              </para>
777            </listitem>
778          </varlistentry>
779         
780          <varlistentry>
781            <term>
782              <guilabel>Load the names of all items</guilabel>
783            </term>
784            <listitem>
785              <para>
786              If checked, the names of the items will be loaded and
787              displayed in the menu, otherwise only the ID and type of item
788              is displayed.
789              </para>
790            </listitem>
791          </varlistentry>
792         
793          <varlistentry>
794            <term>
795              <guilabel>Sticky items</guilabel>
796            </term>
797            <listitem>
798              <para>
799              Always remember the last viewed item of the selected types.
800              For example, if you have selected <emphasis>Experiment</emphasis>
801              as a sticky item, the last viewed experiment will be remembered
802              even if you view hundreds of other items. Use the arrow buttons
803              to move item types between the lists and sort the sticky items list.
804              Sticky items will be displayed in the <guilabel>Recent items</guilabel>
805              menu in the menu bar.             
806              </para>
807            </listitem>
808          </varlistentry>
809          </variablelist>
810          </helptext>
811         
812        </sect3>
813      </sect2>
814 
815    </sect1>
816   
817    <sect1 id="webclient.items">
818      <title>Working with items</title>
819     
820      <para>
821        No matter what you are doing in BASE some things works more
822        or less in the same way. This section covers things that are
823        common for most parts of BASE.
824      </para>
825     
826      <para>
827        You mostly work with a single type of item at a time. This is
828        reflected in the menu system. For example, use
829        <menuchoice>
830          <guimenu>View</guimenu>
831          <guimenuitem>Samples</guimenuitem>
832        </menuchoice>
833        to work with samples, and
834        <menuchoice>
835          <guimenu>View</guimenu>
836          <guimenuitem>Experiments</guimenuitem>
837        </menuchoice>
838        to work with experiments. In most cases the list view for that type
839        of item is displayed. The list view, as the name says,
840        is used to list all items. There are two more standard views, the
841        single-item view and the edit view.
842      </para>
843     
844      <variablelist>
845        <varlistentry>
846          <term>List view</term>
847          <listitem>
848            <para>
849            This view lists all items of a certain type. The view allows you to search
850            and it is possible to configure which information to show
851            for each item. It also contains functions that
852            can be used on multiple items at the same time, for example,
853            delete, share and export. See <xref linkend="webclient.itemlist"/> for more information.
854            </para>
855          </listitem>
856        </varlistentry>
857     
858        <varlistentry>
859          <term>Single-item view</term>
860          <listitem>
861            <para>
862            Displays information about a single item. Sometimes it is very little,
863            sometimes it is very much and the information may be divided
864            into multiple tabs.
865            </para>
866          </listitem>
867        </varlistentry>
868     
869        <varlistentry>
870          <term>Edit view</term>
871          <listitem>
872            <para>
873            This view is used for editing the information
874            about a single item. It is always displayed as a popup window.
875            </para>
876          </listitem>
877        </varlistentry>
878      </variablelist> 
879             
880      <sect2 id="webclient.items.new">
881        <title>Create a new item</title>
882       
883        <para>
884          New items are mostly created from the list view. For example,
885          to create a new experiment go to the
886          <menuchoice><guimenu>View</guimenu> <guimenuitem>Experiments</guimenuitem></menuchoice>
887          page. Here you will find a &gbNew; button in the
888          toolbar. The button is disabled if you do not have permission to create new experiments.
889          Otherwise, click on it and enter any required information in the popup dialog.
890          Sometimes there are multiple tabs in this dialog. In the case of experiments
891          there are three tabs: <guilabel>Experiment</guilabel>, <guilabel>Publication</guilabel>
892          and <guilabel>Experimental factors</guilabel>.
893         
894          As a general rule, only the first tab has information that is required.
895          The information in all other tabs are optional.
896        </para>
897       
898        <para>
899          In some places you will also find actions that create items
900          directly in the list. For example in the list of samples or on
901          the single-item view for a sample you can create an extract using that
902          sample as the parent. If you use such links the parent
903          item will in most cases be selected automatically, which saves
904          you a few clicks when creating new items.
905        </para>
906       
907        <para>
908          Click on the &gbSave; button to save the new
909          item to the database or on the &gbCancel; button
910          to abort.
911        </para>
912
913        <note>
914          <para>
915          To speed up data entry when adding multiple new items there
916          are a few tricks you can use to make the web client supply
917          default values for most properties. To find a default value
918          the following checklist is used in this order:
919          </para>
920       
921        <orderedlist>         
922          <listitem>
923            <para>
924            If the list have an active filter the filter values are
925            used as default property values for the new item. For example,
926            if you are listing experiments with <guilabel>Genepix</guilabel>
927            raw data type the new experiment will automatically have
928            <guilabel>Genepix</guilabel> selected. This trick should work
929            for all properties except annotations, if it does not
930            report it as a bug to the development team.
931            </para>
932          </listitem>
933         
934          <listitem>
935            <para>
936            When you link to other items the same item will be used the next time.
937            For example, if you create an extract and selects an extraction protocol
938            the same protocol is used the next time you create another extract.
939            In fact, BASE will remember as many items as specified by
940            the <link linkend="webclient.configuration.preferences.appearance">
941            <guilabel>Recently used items</guilabel></link> setting (default is 4),
942            allowing you to quickly select one of those protocols.
943            </para>
944          </listitem>
945         
946          <listitem>
947            <para>
948            If you have a project active and that project has specified default
949            values those values will be used for new items. A project can specify
950            defaults for protocols, hardware and software and a few other settings.
951            </para>
952          </listitem>
953         
954        </orderedlist>
955       
956        </note>
957       
958      </sect2>
959     
960      <sect2 id="webclient.items.edit">
961        <title>Edit an existing item</title>
962       
963        <para>
964          On all single-item views there is an &gbEdit;
965          button in the toolbar that opens a popup dialog for editing the properties
966          of the item. This button is disabled if the logged in user does not have
967          write permission for the item.
968        </para>
969       
970        <para>
971          You can also open the edit popup in most other places where
972          the item appears, for example, in lists or the single-item view
973          of a related item. Press and hold one of the <keycap>CTRL</keycap>,
974          <keycap>ALT</keycap> or <keycap>SHIFT</keycap> keys while clicking
975          on the link and the edit window will open in a popup.
976          If you do not have write permission
977          on the item there is no meaning to open the edit popup and you will
978          be taken to the single-item view page instead.
979        </para>
980
981        <para>
982          Click on the &gbSave; button to save the changes
983          to the database or on the &gbCancel; button
984          to abort.
985        </para>
986     
987      </sect2>
988
989      <sect2 id="webclient.items.delete">
990        <title>Delete items</title>
991
992        <para>
993          You can delete items either from the list view or from
994          a single-item view. In both cases, the item is only moved to
995          the trashcan. No information is deleted from the database. This allows
996          you to restore the item if you later find out that you need it again.
997          In fact, there is nothing special about a removed item. It can still be
998          used for the same things as any non-removed item can.
999        </para>
1000
1001        <important>
1002          <para>
1003          To really delete an item from the database you must use
1004          the trashcan. See <xref linkend="trashcan"/>.
1005          </para>
1006        </important>
1007       
1008        <para>
1009          To delete items from the list view you must first mark
1010          the checkbox for each item you want to delete. Then, click on
1011          the &gbDelete; button. The list should refresh itself
1012          automatically. If you want to confirm that the items have been removed
1013          use the <guilabel>view / presets</guilabel> dropdown and select
1014          the <guilabel>Removed</guilabel> option. The removed items should now
1015          be displayed in the list with a small trashcan icon to indicate that
1016          they are located in the trashcan.
1017        </para>
1018
1019        <para>
1020          To delete items from the single-item view, click on the
1021          &gbDelete; button in the toolbar. The page will refresh
1022          itself automatically and a small trashcan icon should be displayed.
1023          If you do not have permission to delete the item the delete button
1024          is disabled.
1025        </para>
1026
1027      </sect2>
1028     
1029      <sect2 id="webclient.items.restore">
1030        <title>Restore deleted items</title>
1031       
1032        <para>
1033          You can restore deleted items either from the trashcan,
1034          from the list view or from the single-item view. This section only covers the last two
1035          cases. The trashcan has a <link linkend="trashcan">chapter of it's own</link>.
1036        </para>
1037
1038        <para>
1039          To delete items from the list view you must first make the deleted
1040          items appear in the list. This is easy, just use the <guilabel>view / presets</guilabel> 
1041          dropdown and select the <guilabel>Removed</guilabel> option. The list should
1042          refresh itself automatically. The removed items are
1043          displayed in the list with a small trashcan icon to indicate that
1044          they are located in the trashcan. Then, mark the checkbox for each item that you want
1045          to restore and click the &gbRestore; button. The list should
1046          refresh itself automatically and the trashcan icon should be gone from the
1047          restored items.
1048        </para>
1049       
1050        <para>
1051          To restore items from the single-item view, click on the
1052          &gbRestore; button in the toolbar. The page will refresh
1053          itself automatically and the small trashcan icon should be gone.
1054          If you do not have permission to restore the item the restore button
1055          is disabled.
1056        </para>
1057
1058      </sect2>
1059
1060      <sect2 id="webclient.items.share">
1061        <title>Share items to other users</title>
1062        <para>
1063          Sharing data with other users is an important feature
1064          of BASE, which allows you cooperate in teams. If you have
1065          followed the instructions in <xref linkend="project_permission" />
1066          you will find that you almost never have to share items manually
1067          to other users. This is because whenever you work with an active
1068          project each new item you create will automatically be shared
1069          to that project. In most cases, this is all you need.
1070        </para>
1071       
1072        <para>
1073          If you still need to manually share your data with other users,
1074          here is how to do it.
1075        </para>
1076       
1077        <para>
1078          From a list view, mark the checkbox for each item you want to share.
1079          Then, click on the &gbShare; button.
1080          If you are on a single-item page, click on the &gbShare; 
1081          button on that page. In both cases, this will open the
1082          <guilabel>Set access permissions</guilabel>
1083          dialog window.
1084        </para>
1085       
1086        <figure id="webclient.items.share.set_permissions">
1087          <title>Sharing items to other users</title>
1088          <screenshot>
1089          <mediaobject>
1090            <imageobject>
1091              <imagedata fileref="figures/set_permissions.png" format="PNG" />
1092            </imageobject>
1093          </mediaobject>
1094          </screenshot>
1095        </figure>
1096       
1097        <helptext external_id="share.setpermissions" title="Set access permissions">
1098          <variablelist>
1099            <varlistentry>
1100              <term><guilabel>Members</guilabel></term>
1101              <listitem>
1102                <para>
1103                The list displays the users, groups and projects
1104                that already has access to the items you selected.
1105                The list shows the name and the permission level.
1106                The permission level uses a one-letter code as follows:
1107                </para>
1108               
1109                <itemizedlist>
1110                <listitem><simpara><guilabel>R</guilabel> = Read</simpara></listitem>
1111                <listitem><simpara><guilabel>U</guilabel> = Use</simpara></listitem>
1112                <listitem><simpara><guilabel>W</guilabel> = Write</simpara></listitem>
1113                <listitem><simpara><guilabel>D</guilabel> = Delete</simpara></listitem>
1114                <listitem><simpara><guilabel>O</guilabel> = Take ownership</simpara></listitem>
1115                <listitem><simpara><guilabel>P</guilabel> = Set permission</simpara></listitem>
1116                </itemizedlist>
1117               
1118                <para>
1119                  Instead of a permission code, the word <guilabel>varying</guilabel>
1120                  may be displayed. This happens if the items you selected have been
1121                  shared with different permission.
1122                </para>
1123               
1124              </listitem>
1125            </varlistentry>
1126           
1127            <varlistentry>
1128              <term><guilabel>Permissions</guilabel></term>
1129              <listitem>
1130                <para>
1131                When you select a user, group or project in the
1132                list, the checkboxes will display the current permission.
1133                The exception is if the permissions are varying, in which
1134                case no checkboxes are checked.
1135                To change the permissions just check the permissions you want to
1136                grant or uncheck the permissions you want to revoke.
1137                You can select more than one user, group or project
1138                and change the permissions for all of them at once.
1139                </para>
1140              </listitem>
1141            </varlistentry>           
1142
1143            <varlistentry>
1144              <term><guibutton>Add users</guibutton></term>
1145              <listitem>
1146                <para>
1147                Opens a popup window that allows you to select
1148                users to share the items to. In the popup window, mark
1149                one or more users and click on the &gbOk;
1150                button. Unless you are an administrator, the popup window
1151                will only list users that are members of at least one of the
1152                groups where you also are a member. It will not list users that
1153                already have access to the items.
1154                </para>
1155              </listitem>
1156            </varlistentry>
1157
1158            <varlistentry>
1159              <term><guibutton>Add groups</guibutton></term>
1160              <listitem>
1161                <para>
1162                Opens a popup window that allows you to select
1163                groups to share the items to. In the popup window, mark
1164                one or more groups and click on the &gbOk;
1165                button. Unless you are an administrator, the popup window
1166                will only list groups where you are a member. It will not list
1167                groups that already have access to the items.
1168                </para>
1169              </listitem>
1170            </varlistentry>
1171           
1172            <varlistentry>
1173              <term><guibutton>Add projects</guibutton></term>
1174              <listitem>
1175                <para>
1176                Opens a popup window that allows you to select
1177                projects to share the items to. In the popup window, mark
1178                one or more projects and click on the &gbOk;
1179                button. Unless you are an administrator, the popup window
1180                will only list projects where you are a member. It will not list
1181                projects that already have access to the items.
1182                </para>
1183              </listitem>
1184            </varlistentry>
1185
1186            <varlistentry>
1187              <term>&gbRemove;</term>
1188              <listitem>
1189                <para>
1190                Click on this button to revoke access permissions from
1191                the selected users, groups and projects.
1192                </para>
1193              </listitem>   
1194            </varlistentry>
1195          </variablelist>
1196       
1197          <para>
1198            Use the &gbSave; button to save your
1199            changes or the &gbCancel; button to
1200            close the popup without saving.
1201          </para>
1202        </helptext>
1203
1204      </sect2>
1205
1206      <sect2 id="webclient.items.takeownership">
1207        <title>Take ownership of items</title>
1208        <para>
1209          Sometime it may be necessary to change the owner of an item.
1210          As an user you cannot give the ownership of your items to another
1211          user. It is instead the other user that must take the ownership
1212          of your items. For this to work, you must first give the other user
1213          permission to do so. That it, you must share your items with
1214          <guilabel>Take ownership</guilabel> permission to other user.
1215          See <xref linkend="webclient.items.share" />.
1216        </para>
1217       
1218        <para>
1219          When the items have been shared, the other user has to go to the
1220          list view (or the single-item view), mark the checkboxes for
1221          the items, and click in the <guibutton>Take ownership</guibutton>
1222          button. A warning message about not being able to undo the action
1223          is displayed. Click on &gbOk; to continue or
1224          &gbCancel; to abort.
1225        </para>
1226       
1227        <note>
1228          <para>
1229          The original owner may not have access permissions to the items
1230          any longer. If that is desired, the new owner must share the items
1231          to the original owner.
1232          </para>
1233        </note>
1234       
1235      </sect2>
1236     
1237      <sect2 id="webclient.items.export">
1238        <title>Export items</title>
1239        <para>
1240          This has a chapter of it's own. See <xref linkend="import_export_data.export"/>.
1241        </para>
1242      </sect2>
1243
1244    </sect1>
1245   
1246    <sect1 id="webclient.itemlist">
1247      <title>Listing items</title>
1248     
1249      <para>
1250        All pages that lists items are very similar in their appearance and
1251        functionality. In this section we will describe the things that are
1252        common for most (if not all) list pages.
1253      </para>
1254     
1255      <para>
1256        Use the <link linkend="webclient.intro.menubar">menu</link> to
1257        open a page listing items. Most list pages can only
1258        list one type of items. For example: use the
1259        <menuchoice><guimenu>View</guimenu><guimenuitem>Samples</guimenuitem></menuchoice>
1260        menu to list samples and the
1261        <menuchoice><guimenu>View</guimenu><guimenuitem>Experiments</guimenuitem></menuchoice>
1262        menu to list experiments.
1263      </para>
1264     
1265      <tip>
1266        An example of a list page that can list
1267        items of several types is found by going to
1268        <menuchoice>
1269          <guimenu>View</guimenu>
1270          <guimenuitem>All items</guimenuitem>
1271        </menuchoice>.
1272        This page lists all items that you are the owner of. It has a few limitations:
1273       
1274        <itemizedlist>
1275          <listitem>
1276            <para>
1277              It support only a limited set of columns (type, name and description)
1278              since these are the only properties that are common
1279              among all items.
1280            </para>
1281          </listitem>
1282         
1283          <listitem>
1284            <para>
1285              The list cannot be filtered (except by item type)
1286              or sorted. This is due to a limitation in the query system
1287              used to generate the list.
1288            </para>
1289          </listitem>
1290        </itemizedlist>
1291       
1292        <para>
1293          There are also several similarities:
1294        </para>
1295       
1296        <itemizedlist>
1297          <listitem>
1298            <para>
1299              It supports all of the regular multi-item
1300              operations such as delete, restore, share
1301              and take ownership.
1302            </para>
1303          </listitem>
1304         
1305          <listitem>
1306            <para>
1307              Clicking on the name of the item will take you to the
1308              single-item view of that item. Holding down <keycap>CTRL</keycap>,
1309              <keycap>ALT</keycap> or <keycap>SHIFT</keycap> while clicking,
1310              will open the edit popup.
1311            </para>
1312          </listitem>
1313        </itemizedlist>       
1314       
1315      </tip>
1316     
1317      <figure id="webclient.figures.listpage">
1318        <title>A typical list page</title>
1319        <screenshot>
1320          <mediaobject>
1321            <imageobject><imagedata fileref="figures/listpage.png" format="PNG"
1322              scalefit="1" width="100%" /></imageobject>
1323          </mediaobject>
1324        </screenshot>
1325      </figure>
1326     
1327      <para>
1328        The typical list page contains the following important
1329        elements:
1330      </para>
1331
1332      <variablelist>
1333        <varlistentry>
1334          <term><interface>1. Toolbar</interface></term>
1335          <listitem>
1336            <para>
1337            A toolbar with buttons for various actions such as
1338            &gbNew; for creating a new item,
1339            &gbDelete; for deleting items and
1340            <guibutton>Columns&hellip;</guibutton> for configuring columns.
1341            Depending on the permissions of the logged in user
1342            some buttons may be disabled (greyed out) or not shown at all.
1343            </para>
1344          </listitem>
1345        </varlistentry>
1346       
1347        <varlistentry>
1348          <term><interface>2. Navigation bar</interface></term>
1349          <listitem>
1350            <para>
1351            If there are many items the list will be divided into
1352            pages, each one showing a limited number of items.
1353            The navigation bar allows you to
1354            move to other pages and specify how many items each page
1355            should display. The navigation bar is repeated at the
1356            bottom of the list so you do not have to scroll back to the
1357            top of a long list just to get to another page.
1358            </para>
1359          </listitem>
1360        </varlistentry>
1361       
1362        <varlistentry>
1363          <term><interface>3. List of presets</interface></term>
1364          <listitem>
1365            <para>
1366            A list with preconfigured settings which allows you to
1367            quickly switch between different layouts (sort order, visible
1368            columns, filter settings, etc).
1369            </para>
1370          </listitem>
1371        </varlistentry>
1372       
1373        <varlistentry>
1374          <term><interface>4. Column headers</interface></term>
1375          <listitem>
1376            <para>
1377            The columns headers can be used for selecting sort order.
1378            </para>
1379          </listitem>
1380        </varlistentry>
1381       
1382        <varlistentry>
1383          <term><interface>5. Filter bar</interface></term>
1384          <listitem>
1385            <para>
1386            The filter bar allows you to search for items.
1387            </para>
1388          </listitem>
1389        </varlistentry>
1390       
1391      </variablelist>
1392     
1393     
1394      <sect2 id="webclient.itemlist.order">
1395        <title>Ordering the list</title>
1396       
1397        <para>
1398          Most lists are by default sorted by the name of the item. This can
1399          be changed by clicking on the column header of another column.
1400          If you click on the same column twice the sort order is reversed.
1401          A downwards or upwards pointing arrow is displayed next to the
1402          column header in the column that is currently used for sorting.
1403          Column headers that are black cannot be used for sorting.
1404        </para>
1405       
1406        <para>
1407          It is possible to use more than one column for sorting. Press
1408          and hold one of the <keycap>CTRL</keycap>,
1409          <keycap>ALT</keycap> or <keycap>SHIFT</keycap> keys while clicking
1410          on another column header. The original sorting is kept and the new
1411          column is used for sub-sorting the list. The procedure can be
1412          repeated with more columns if you need to sort on three or more
1413          columns. To revert to sort by only one column again click a
1414          column header without holding down any key.
1415        </para> 
1416      </sect2>
1417   
1418      <sect2 id="webclient.itemlist.filter">
1419        <title>Filtering the list</title>
1420       
1421        <para>
1422          If the list contains many items you may need to use a filter to be
1423          able to find the item you are looking for. The input boxes on the
1424          line below the column headers are used for filtering. Most columns
1425          are filtered using a free-text input box, but some columns that can
1426          only take a few distinct values use a selection list or radio buttons
1427          instead. The selection list and radio buttons are very simple to use.
1428          Just select the alternative that you want to filter on. The list
1429          will be automatically updated when the selection has been made.
1430        </para>
1431       
1432        <para>
1433          The free-text filter is a bit more complex. By default, an exact match is
1434          required, use % as a wildcard that matches any character.
1435          For example, the filter <informalexample>Experiment A</informalexample> 
1436          only matches the same exact string, but the filter
1437          <informalexample>Exp%</informalexample> matches
1438          <informalexample>Experiment A, Experiment B, etc.</informalexample>
1439        </para>
1440       
1441        <para>
1442          You can also use operators to find items which has a value that
1443          is greater than, less than or not equal to a specific value. This is
1444          mostly useful on numeric or date columns but also works on text
1445          columns. The operator must be entered first in the
1446          free-text box, for example
1447          <informalexample>&lt;=10</informalexample>
1448          to find items which has a value less than or equal to 10.   
1449          Here is a list of the supported operators:
1450        </para>
1451       
1452        <variablelist id="webclient.itemlist.filter.operators">
1453          <title>List of operators supported by the free-text filter</title>
1454          <varlistentry>
1455            <term><keycap>&lt;</keycap></term>
1456            <listitem><simpara>Less than</simpara></listitem>
1457          </varlistentry>
1458          <varlistentry>
1459            <term><keycap>&lt;=</keycap></term>
1460            <listitem><simpara>Less than or equal to</simpara></listitem>
1461          </varlistentry>
1462          <varlistentry>
1463            <term><keycap>&gt;</keycap></term>
1464            <listitem><simpara>Greater than</simpara></listitem>
1465          </varlistentry>
1466          <varlistentry>
1467            <term><keycap>&gt;=</keycap></term>
1468            <listitem><simpara>Greater than or equal to</simpara></listitem>
1469          </varlistentry>
1470          <varlistentry>
1471            <term><keycap>=</keycap></term>
1472            <listitem><simpara>Equal to (useful to find items with a null value)</simpara></listitem>
1473          </varlistentry>
1474          <varlistentry>
1475            <term><keycap>&lt;&gt;</keycap></term>
1476            <term><keycap>!=</keycap></term>
1477            <listitem><simpara>Not equal to (useful to find items with a non-null value)</simpara></listitem>
1478          </varlistentry>
1479        </variablelist>
1480      </sect2>
1481     
1482      <sect2 id="webclient.itemlist.columns">
1483        <title>Configuring which columns to show</title>
1484       
1485        <para>
1486          Most lists show only a small subset of the columns it
1487          is capable of showing. Use the
1488          <guibutton>Columns&hellip;</guibutton> button to open
1489          a dialog that allows you to select which columns to show
1490          and the order in which they are shown.
1491        </para>
1492       
1493        <figure id="webclient.figures.configure_columns">
1494          <title>Configuring which columns to show</title>
1495          <screenshot>
1496          <mediaobject>
1497            <imageobject>
1498              <imagedata fileref="figures/configure_columns.png" format="PNG"/>
1499            </imageobject>
1500          </mediaobject>
1501          </screenshot>
1502        </figure>
1503       
1504        <helptext external_id="columns.configure" 
1505          title="Set column order and visiblity">
1506       
1507        <variablelist>
1508        <varlistentry>
1509          <term><guilabel>Visible columns</guilabel></term>
1510          <listitem>
1511            <para>
1512              Shows the columns that are currently visible.
1513              Use the up/down arrow buttons to arrange the order of the
1514              visible columns. The topmost column is shown to the left.
1515              Use the right arrow button to move columns from this list
1516              to the hidden columns list. Columns marked with an <guilabel>×</guilabel> 
1517              are required
1518              and cannot be hidden. In most lists the <guilabel>Name</guilabel> column
1519              is the only column that is required.
1520            </para>
1521          </listitem>
1522        </varlistentry>
1523         
1524        <varlistentry>
1525          <term><guilabel>Hidden columns</guilabel></term>
1526          <listitem>
1527            <para>
1528              Shows columns that are not currently visible in the
1529              list. Use the left arrow button to move columns from
1530              this list to the visible columns list.
1531            </para>
1532          </listitem>
1533        </varlistentry>
1534       
1535       
1536        <varlistentry>
1537          <term><guilabel>Presets</guilabel></term>
1538          <listitem>
1539            <para>
1540              A dropdown list that allows you to
1541              select a set of preconfigured columns. You may also create
1542              your own preset if you often need to switch between different
1543              configurations. The list of presets is the same as the one
1544              described <link linkend="webclient.itemlist.presets">below</link>,
1545              but if used from this dialog the presets does not affect filters,
1546              sort order, etc.
1547            </para>
1548          </listitem>
1549        </varlistentry>
1550        </variablelist>
1551       
1552          <para>
1553            Use the &gbSave; button to apply your
1554            changes or the &gbCancel; button to
1555            close the popup without saving.
1556          </para>
1557
1558        </helptext>
1559
1560      </sect2>
1561     
1562      <sect2 id="webclient.itemlist.presets">
1563        <title>Presets</title>
1564       
1565        <para>
1566          The <guilabel>view / presets</guilabel> dropdown has three
1567          main functions:
1568        </para>
1569       
1570        <figure id="webclient.figures.viewpresets">
1571          <title>The view / presets dropdown</title>
1572          <screenshot>
1573            <mediaobject>
1574              <imageobject><imagedata fileref="figures/view_presets.png" format="PNG" 
1575                /></imageobject>
1576            </mediaobject>
1577          </screenshot>
1578        </figure>
1579        <orderedlist>
1580          <listitem>
1581            <para>
1582              Switch between different configuration presets.
1583              The top of the dropdown contains user-defined presets (<guilabel>Saved preset #1</guilabel> and
1584              <guilabel>#2</guilabel>) and a few preconfigured presets.
1585              The user-defined presets are used to store a complete table configuration,
1586              including:
1587            </para>
1588           
1589            <itemizedlist>
1590              <listitem><simpara>Which columns are visible and their order</simpara></listitem>
1591              <listitem><simpara>The column (or columns) used for sorting</simpara></listitem>
1592              <listitem><simpara>Filter settings</simpara></listitem>
1593              <listitem><simpara>The number of items per page and the current page</simpara></listitem>
1594            </itemizedlist>
1595           
1596            <para>             
1597              The preconfigured presets only affects
1598              the visible columns as follows:
1599            </para>
1600           
1601            <itemizedlist>
1602              <listitem>
1603                <para><guilabel>All columns</guilabel> - Show all columns.</para>
1604              </listitem>
1605              <listitem>
1606                <para><guilabel>Required columns</guilabel> - Show only the required columns.
1607                  Usually only the <guilabel>Name</guilabel> column is required.</para>
1608              </listitem>
1609              <listitem>
1610                <para><guilabel>Default columns</guilabel> - Show the default set of columns.</para>
1611              </listitem>
1612              <listitem>
1613                <para><guilabel>Other&hellip;</guilabel> -
1614                  Open the <link linkend="webclient.itemlist.columns">configure columns dialog box</link>.</para>
1615              </listitem>
1616            </itemizedlist>
1617           
1618          </listitem>
1619         
1620          <listitem>
1621            <para>
1622              Filter items by the removed status and the access
1623              permissions to an item.
1624            </para>
1625           
1626            <itemizedlist>
1627              <listitem>
1628                <para><guilabel>Removed</guilabel> - If checked, items that have been
1629                moved to the trashcan are shown, otherwise they are hidden.</para>
1630              </listitem>
1631              <listitem>
1632                <para><guilabel>Owned by me</guilabel> - If checked, items that the logged in user
1633                owns are displayed, otherwise they are hidden.</para>
1634              </listitem>
1635              <listitem>
1636                <para><guilabel>Shared to me</guilabel> - If checked, items that are owned
1637                by other users but shared to the logged in user are displayed, otherwise
1638                they are hidden.</para>
1639              </listitem>
1640              <listitem>
1641                <para><guilabel>In current project</guilabel> -
1642                  If checked, items that are linked with the current project are displayed,
1643                  otherwise they are hidden. It does not matter if the logged in user is the
1644                  owner or not. This option is only available if a project is active.
1645                </para>
1646              </listitem>
1647              <listitem>
1648                <para><guilabel>Owned by others</guilabel> -
1649                  This option is only available to administrators and will display
1650                  items that are owned by other users.
1651                </para>
1652              </listitem>
1653            </itemizedlist>
1654           
1655            <para>
1656              The default is to display item that the current user
1657              owns and, if a project is active, items in that project.
1658            </para>
1659           
1660          </listitem>
1661
1662          <listitem>
1663            <para>
1664              Administrate the presets
1665            </para>
1666            <itemizedlist>
1667              <listitem>
1668                <para><guilabel>Clear filter</guilabel> - Clears
1669                all filters.</para>
1670              </listitem>
1671             
1672              <listitem>
1673                <para><guilabel>Save as&hellip;</guilabel> - Save the
1674                current configuration as a preset.</para>
1675              </listitem>
1676
1677              <listitem>
1678                <para><guilabel>Manage&hellip;</guilabel> - Opens a dialog
1679                where you can remove saved presets. You can also load
1680                saved presets from the dialog, but it is quicker to just
1681                use the dropdown list for this.</para>
1682              </listitem>
1683            </itemizedlist>
1684          </listitem>
1685        </orderedlist>
1686       
1687        <sect3 id="webclient.itemlist.presets.saveas">
1688          <title>Save a preset</title>
1689         
1690          <para>
1691            If you select the <guilabel>Save as&hellip;</guilabel>
1692            option from the <guilabel>view / presets</guilabel> dropdown
1693            the <guilabel>Save preset as</guilabel> dialog is opened.
1694          </para>
1695         
1696          <figure id="webclient.figures.savepresetas">
1697            <title>Save preset as</title>
1698            <screenshot>
1699              <mediaobject>
1700                <imageobject><imagedata fileref="figures/save_preset.png" format="PNG" /></imageobject>
1701              </mediaobject>
1702            </screenshot>
1703          </figure>
1704         
1705          <helptext external_id="contexts.saveas" title="Save preset as">
1706         
1707          <variablelist>
1708          <varlistentry>
1709            <term><guilabel>For item</guilabel></term>
1710            <listitem>
1711              <para>
1712              The type of item the preset is saved for.
1713              </para>
1714            </listitem>
1715          </varlistentry>
1716          <varlistentry>
1717            <term><guilabel >Name</guilabel></term>
1718            <listitem>
1719              <para>
1720              The name of the preset. The name must be unique.
1721              </para>
1722            </listitem>
1723          </varlistentry>
1724          <varlistentry>
1725            <term><guilabel>Overwrite existing</guilabel></term>
1726            <listitem>
1727              <para>
1728              If a preset with the same name already exists, it is
1729              overwritten if this checkbox is checked.
1730              </para>
1731            </listitem>
1732          </varlistentry>
1733          <varlistentry>
1734            <term><guilabel>Public</guilabel></term>
1735            <listitem>
1736              <para>
1737              This options is only available for users
1738              which has the <emphasis>SHARE_TO_EVERYONE</emphasis>
1739              permission. If checked the preset is visible to
1740              all users.
1741              </para>
1742            </listitem>
1743          </varlistentry>
1744          </variablelist>
1745         
1746          <para>
1747            Use the &gbOk; button to save the preset
1748            or the &gbCancel; button to
1749            close the popup without saving.
1750          </para>
1751         
1752         
1753          </helptext>
1754         
1755        </sect3>
1756       
1757        <sect3 id="webclient.itemlist.presets.manage">
1758          <title>Manage presets</title>
1759         
1760          <para>
1761            If you select the <guilabel>Manage&hellip;</guilabel>
1762            option from the <guilabel>view / presets</guilabel> dropdown
1763            the <guilabel>Manage presets</guilabel> dialog is opened.
1764          </para>
1765         
1766          <figure id="webclient.figures.managepresets">
1767            <title>Manage presets</title>
1768            <screenshot>
1769              <mediaobject>
1770                <imageobject><imagedata fileref="figures/manage_presets.png" format="PNG" /></imageobject>
1771              </mediaobject>
1772            </screenshot>
1773          </figure>
1774         
1775          <helptext external_id="contexts.manage" title="Manage presets">
1776         
1777          <para>
1778            From this dialog you can delete or load presets.
1779          </para>
1780         
1781          <para>
1782            To delete presets, first mark the checkbox in front of
1783            each preset you want to delete. Then, click on the
1784            <guibutton>Delete&hellip;</guibutton> button. You will get
1785            a warning about that the action cannot be undone. Unlike other
1786            items, the presets are not moved to the trashcan. Click on
1787            &gbOk; to delete the preset.
1788          </para>
1789         
1790          <note>
1791            <title>Edit a preset</title>
1792            <para>
1793            It is not possible to edit a preset directly. To change an
1794            existing preset you must:
1795           
1796            <orderedlist>
1797            <listitem><simpara>Load the preset.</simpara></listitem>
1798            <listitem><simpara>Use the interface to change column settings, filter,
1799              sort order, etc.</simpara></listitem>
1800            <listitem><simpara>Save the preset with the same name.</simpara></listitem>
1801            </orderedlist>
1802            </para>
1803          </note>
1804         
1805          <para>
1806            Use the &gbClose; button to
1807            close the popup.
1808          </para>
1809         
1810         
1811          </helptext>
1812         
1813        </sect3>
1814       
1815      </sect2>
1816    </sect1>
1817   
1818</chapter>
Note: See TracBrowser for help on using the repository browser.