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

Last change on this file since 3490 was 3490, checked in by Martin Svensson, 15 years ago

References #426 Documentation about setting the user preferences for 'Remove jobs'

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