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

Last change on this file since 3359 was 3359, checked in by Nicklas Nordborg, 15 years ago

Added text about View -> All items and fixed some cross references.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Date Id
File size: 57.4 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 3359 2007-05-22 07:02:57Z 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 can't log in, try unchecking the encryption option.
73          If the checkbox isn't 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 doesn't 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              don't 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 <guibutton>Save</guibutton> to save the changes or
451            <guibutton>Cancel</guibutton> 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              don't 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          </variablelist>
716          </helptext>
717         
718        </sect3>
719       
720        <sect3 id="webclient.configuration.preferences.mostrecent">
721          <title>The Most recent tab</title>
722         
723          <helptext external_id="userpreferences.mostrecent" title="Preferences - Most recent">
724         
725          <para>
726            This tab contains settings that affect the <guilabel>Most
727            recent</guilabel> menu. You can select which items should
728            appear in the menu by moving them to the left list. Use
729            the up and down arrows to change the order in which they appear.
730          </para>
731         
732          <para>
733            If the <guilabel>Load the names of all recent items</guilabel> checkbox
734            is checked the name of the items will be displayed in the menu (for example,
735            Experiment: My experiment). Otherwise only the type of the item is
736            displayed (for example, Experiment).
737          </para>
738          </helptext>
739         
740        </sect3>
741      </sect2>
742 
743    </sect1>
744   
745    <sect1 id="webclient.items">
746      <title>Working with items</title>
747     
748      <para>
749        No matter what you are doing in BASE some things works more
750        or less in the same way. This section covers things that are
751        common for most parts of BASE.
752      </para>
753     
754      <para>
755        You mostly work with a single type of item at a time. This is
756        reflected in the menu system. For example, use
757        <menuchoice>
758          <guimenu>View</guimenu>
759          <guimenuitem>Samples</guimenuitem>
760        </menuchoice>
761        to work with samples, and
762        <menuchoice>
763          <guimenu>View</guimenu>
764          <guimenuitem>Experiments</guimenuitem>
765        </menuchoice>
766        to work with experiments. In most cases the list view for that type
767        of item is displayed. The list view, as the name says,
768        is used to list all items. There are two more standard views, the
769        single-item view and the edit view.
770      </para>
771     
772      <variablelist>
773        <varlistentry>
774          <term>List view</term>
775          <listitem>
776            <para>
777            This view lists all items of a certain type. The view allows you to search
778            and it is possible to configure which information to show
779            for each item. It also contains functions that
780            can be used on multiple items at the same time, for example,
781            delete, share and export. See <xref linkend="webclient.itemlist"/> for more information.
782            </para>
783          </listitem>
784        </varlistentry>
785     
786        <varlistentry>
787          <term>Single-item view</term>
788          <listitem>
789            <para>
790            Displays information about a single item. Sometimes it is very little,
791            sometimes it is very much and the information may be divided
792            into multiple tabs.
793            </para>
794          </listitem>
795        </varlistentry>
796     
797        <varlistentry>
798          <term>Edit view</term>
799          <listitem>
800            <para>
801            This view is used for editing the information
802            about a single item. It is always displayed as a popup window.
803            </para>
804          </listitem>
805        </varlistentry>
806      </variablelist> 
807             
808      <sect2 id="webclient.items.new">
809        <title>Create a new item</title>
810       
811        <para>
812          New items are mostly created from the list view. For example,
813          to create a new experiment go to the
814          <menuchoice><guimenu>View</guimenu> <guimenuitem>Experiments</guimenuitem></menuchoice>
815          page. Here you will find a <guibutton>New&hellip;</guibutton> button in the
816          toolbar. The button is disabled if you don't have permission to create new experiments.
817          Otherwise, click on it and enter any required information in the popup dialog.
818          Sometimes there are multiple tabs in this dialog. In the case of experiments
819          there are three tabs: <guilabel>Experiment</guilabel>, <guilabel>Publication</guilabel>
820          and <guilabel>Experimental factors</guilabel>.
821         
822          As a general rule, only the first tab has information that is required.
823          The information in all other tabs are optional.
824        </para>
825       
826        <para>
827          In some places you will also find actions that create items
828          directly in the list. For example in the list of samples or on
829          the single-item view for a sample you can create an extract using that
830          sample as the parent. If you use such links the parent
831          item will in most cases be selected automatically, which saves
832          you a few clicks when creating new items.
833        </para>
834       
835        <para>
836          Click on the <guibutton>Save</guibutton> button to save the new
837          item to the database or on the <guibutton>Cancel</guibutton> button
838          to abort.
839        </para>
840
841        <note>
842          <para>
843          To speed up data entry when adding multiple new items there
844          are a few tricks you can use to make the web client supply
845          default values for most properties. To find a default value
846          the following checklist is used in this order:
847          </para>
848       
849        <orderedlist>         
850          <listitem>
851            <para>
852            If the list have an active filter the filter values are
853            used as default property values for the new item. For example,
854            if you are listing experiments with <guilabel>Genepix</guilabel>
855            raw data type the new experiment will automatically have
856            <guilabel>Genepix</guilabel> selected. This trick should work
857            for all properties except annotations, if it doesn't
858            report it as a bug to the development team.
859            </para>
860          </listitem>
861         
862          <listitem>
863            <para>
864            When you link to other items the same item will be used the next time.
865            For example, if you create an extract and selects an extraction protocol
866            the same protocol is used the next time you create another extract.
867            In fact, BASE will remember as many items as specified by
868            the <link linkend="webclient.configuration.preferences.appearance">
869            <guilabel>Recently used items</guilabel></link> setting (default is 4),
870            allowing you to quickly select one of those protocols.
871            </para>
872          </listitem>
873         
874          <listitem>
875            <para>
876            If you have a project active and that project has specified default
877            values those values will be used for new items. A project can specify
878            defaults for protocols, hardware and software and a few other settings.
879            </para>
880          </listitem>
881         
882        </orderedlist>
883       
884        </note>
885       
886      </sect2>
887     
888      <sect2 id="webclient.items.edit">
889        <title>Edit an existing item</title>
890       
891        <para>
892          On all single-item views there is an <guibutton>Edit&hellip;</guibutton>
893          button in the toolbar that opens a popup dialog for editing the properties
894          of the item. This button is disabled if the logged in user doesn't have
895          write permission for the item.
896        </para>
897       
898        <para>
899          You can also open the edit popup in most other places where
900          the item appears, for example, in lists or the single-item view
901          of a related item. Press and hold one of the <keycap>CTRL</keycap>,
902          <keycap>ALT</keycap> or <keycap>SHIFT</keycap> keys while clicking
903          on the link and the edit window will open in a popup.
904          If you don't have write permission
905          on the item there is no meaning to open the edit popup and you will
906          be taken to the single-item view page instead.
907        </para>
908
909        <para>
910          Click on the <guibutton>Save</guibutton> button to save the changes
911          to the database or on the <guibutton>Cancel</guibutton> button
912          to abort.
913        </para>
914     
915      </sect2>
916
917      <sect2 id="webclient.items.delete">
918        <title>Delete items</title>
919
920        <para>
921          You can delete items either from the list view or from
922          a single-item view. In both cases, the item is only moved to
923          the trashcan. No information is deleted from the database. This allows
924          you to restore the item if you later find out that you need it again.
925          In fact, there is nothing special about a removed item. It can still be
926          used for the same things as any non-removed item can.
927        </para>
928
929        <important>
930          <para>
931          To really delete an item from the database you must use
932          the trashcan. See <xref linkend="trashcan"/>.
933          </para>
934        </important>
935       
936        <para>
937          To delete items from the list view you must first mark
938          the checkbox for each item you want to delete. Then, click on
939          the <guibutton>Delete</guibutton> button. The list should refresh itself
940          automatically. If you want to confirm that the items have been removed
941          use the <guilabel>view / presets</guilabel> dropdown and select
942          the <guilabel>Removed</guilabel> option. The removed items should now
943          be displayed in the list with a small trashcan icon to indicate that
944          they are located in the trashcan.
945        </para>
946
947        <para>
948          To delete items from the single-item view, click on the
949          <guibutton>Delete</guibutton> button in the toolbar. The page will refresh
950          itself automatically and a small trashcan icon should be displayed.
951          If you don't have permission to delete the item the delete button
952          is disabled.
953        </para>
954
955      </sect2>
956     
957      <sect2 id="webclient.items.restore">
958        <title>Restore deleted items</title>
959       
960        <para>
961          You can restore deleted items either from the trashcan,
962          from the list view or from the single-item view. This section only covers the last two
963          cases. The trashcan has a <link linkend="trashcan">chapter of it's own</link>.
964        </para>
965
966        <para>
967          To delete items from the list view you must first make the deleted
968          items appear in the list. This is easy, just use the <guilabel>view / presets</guilabel> 
969          dropdown and select the <guilabel>Removed</guilabel> option. The list should
970          refresh itself automatically. The removed items are
971          displayed in the list with a small trashcan icon to indicate that
972          they are located in the trashcan. Then, mark the checkbox for each item that you want
973          to restore and click the <guibutton>Restore</guibutton> button. The list should
974          refresh itself automatically and the trashcan icon should be gone from the
975          restored items.
976        </para>
977       
978        <para>
979          To restore items from the single-item view, click on the
980          <guibutton>Restore</guibutton> button in the toolbar. The page will refresh
981          itself automatically and the small trashcan icon should be gone.
982          If you don't have permission to restore the item the restore button
983          is disabled.
984        </para>
985
986      </sect2>
987
988      <sect2 id="webclient.items.share">
989        <title>Share items to other users</title>
990        <para>
991          Sharing data with other users is an important feature
992          of BASE, which allows you cooperate in teams. If you have
993          followed the instructions in <xref linkend="project_permission" />
994          you will find that you almost never have to share items manually
995          to other users. This is because whenever you work with an active
996          project each new item you create will automatically be shared
997          to that project. In most cases, this is all you need.
998        </para>
999       
1000        <para>
1001          If you still need to manually share your data with other users,
1002          here is how to do it.
1003        </para>
1004       
1005        <para>
1006          From a list view, mark the checkbox for each item you want to share.
1007          Then, click on the <guibutton>Share&hellip;</guibutton> button.
1008          If you are on a single-item page, click on the <guibutton>Share&hellip;</guibutton> 
1009          button on that page. In both cases, this will open the
1010          <guilabel>Set access permissions</guilabel>
1011          dialog window.
1012        </para>
1013       
1014        <figure id="webclient.items.share.set_permissions">
1015          <title>Sharing items to other users</title>
1016          <screenshot>
1017          <mediaobject>
1018            <imageobject>
1019              <imagedata fileref="figures/set_permissions.png" format="PNG" />
1020            </imageobject>
1021          </mediaobject>
1022          </screenshot>
1023        </figure>
1024       
1025        <helptext external_id="share.setpermissions" title="Set access permissions">
1026          <variablelist>
1027            <varlistentry>
1028              <term><guilabel>Members</guilabel></term>
1029              <listitem>
1030                <para>
1031                The list displays the users, groups and projects
1032                that already has access to the items you selected.
1033                The list shows the name and the permission level.
1034                The permission level uses a one-letter code as follows:
1035                </para>
1036               
1037                <itemizedlist>
1038                <listitem><simpara><guilabel>R</guilabel> = Read</simpara></listitem>
1039                <listitem><simpara><guilabel>U</guilabel> = Use</simpara></listitem>
1040                <listitem><simpara><guilabel>W</guilabel> = Write</simpara></listitem>
1041                <listitem><simpara><guilabel>D</guilabel> = Delete</simpara></listitem>
1042                <listitem><simpara><guilabel>O</guilabel> = Take ownership</simpara></listitem>
1043                <listitem><simpara><guilabel>P</guilabel> = Set permission</simpara></listitem>
1044                </itemizedlist>
1045               
1046                <para>
1047                  Instead of a permission code, the word <guilabel>varying</guilabel>
1048                  may be displayed. This happens if the items you selected have been
1049                  shared with different permission.
1050                </para>
1051               
1052              </listitem>
1053            </varlistentry>
1054           
1055            <varlistentry>
1056              <term><guilabel>Permissions</guilabel></term>
1057              <listitem>
1058                <para>
1059                When you select a user, group or project in the
1060                list, the checkboxes will display the current permission.
1061                The exception is if the permissions are varying, in which
1062                case no checkboxes are checked.
1063                To change the permissions just check the permissions you want to
1064                grant or uncheck the permissions you want to revoke.
1065                You can select more than one user, group or project
1066                and change the permissions for all of them at once.
1067                </para>
1068              </listitem>
1069            </varlistentry>           
1070
1071            <varlistentry>
1072              <term><guibutton>Add users</guibutton></term>
1073              <listitem>
1074                <para>
1075                Opens a popup window that allows you to select
1076                users to share the items to. In the popup window, mark
1077                one or more users and click on the <guibutton>Ok</guibutton>
1078                button. Unless you are an administrator, the popup window
1079                will only list users that are members of at least one of the
1080                groups where you also are a member. It will not list users that
1081                already have access to the items.
1082                </para>
1083              </listitem>
1084            </varlistentry>
1085
1086            <varlistentry>
1087              <term><guibutton>Add groups</guibutton></term>
1088              <listitem>
1089                <para>
1090                Opens a popup window that allows you to select
1091                groups to share the items to. In the popup window, mark
1092                one or more groups and click on the <guibutton>Ok</guibutton>
1093                button. Unless you are an administrator, the popup window
1094                will only list groups where you are a member. It will not list
1095                groups that already have access to the items.
1096                </para>
1097              </listitem>
1098            </varlistentry>
1099           
1100            <varlistentry>
1101              <term><guibutton>Add projects</guibutton></term>
1102              <listitem>
1103                <para>
1104                Opens a popup window that allows you to select
1105                projects to share the items to. In the popup window, mark
1106                one or more projects and click on the <guibutton>Ok</guibutton>
1107                button. Unless you are an administrator, the popup window
1108                will only list projects where you are a member. It will not list
1109                projects that already have access to the items.
1110                </para>
1111              </listitem>
1112            </varlistentry>
1113
1114            <varlistentry>
1115              <term><guibutton>Remove</guibutton></term>
1116              <listitem>
1117                <para>
1118                Click on this button to revoke access permissions from
1119                the selected users, groups and projects.
1120                </para>
1121              </listitem>   
1122            </varlistentry>
1123          </variablelist>
1124       
1125          <para>
1126            Use the <guibutton>Save</guibutton> button to save your
1127            changes or the <guibutton>Cancel</guibutton> button to
1128            close the popup without saving.
1129          </para>
1130        </helptext>
1131
1132      </sect2>
1133
1134      <sect2 id="webclient.items.takeownership">
1135        <title>Take ownership of items</title>
1136        <para>
1137          Sometime it may be necessary to change the owner of an item.
1138          As an user you can't give the ownership of your items to another
1139          user. It is instead the other user that must take the ownership
1140          of your items. For this to work, you must first give the other user
1141          permission to do so. That it, you must share your items with
1142          <guilabel>Take ownership</guilabel> permission to other user.
1143          See <xref linkend="webclient.items.share" />.
1144        </para>
1145       
1146        <para>
1147          When the items have been shared, the other user has to go to the
1148          list view (or the single-item view), mark the checkboxes for
1149          the items, and click in the <guibutton>Take ownership</guibutton>
1150          button. A warning message about not being able to undo the action
1151          is displayed. Click on <guibutton>Ok</guibutton> to continue or
1152          <guibutton>Cancel</guibutton> to abort.
1153        </para>
1154       
1155        <note>
1156          <para>
1157          The original owner may not have access permissions to the items
1158          any longer. If that is desired, the new owner must share the items
1159          to the original owner.
1160          </para>
1161        </note>
1162       
1163      </sect2>
1164     
1165      <sect2 id="webclient.items.export">
1166        <title>Export items</title>
1167        <para>
1168          This has a chapter of it's own. See <xref linkend="import_export_data.export"/>.
1169        </para>
1170      </sect2>
1171
1172    </sect1>
1173   
1174    <sect1 id="webclient.itemlist">
1175      <title>Listing items</title>
1176     
1177      <para>
1178        All pages that lists items are very similar in their appearance and
1179        functionality. In this section we will describe the things that are
1180        common for most (if not all) list pages.
1181      </para>
1182     
1183      <para>
1184        Use the <link linkend="webclient.intro.menubar">menu</link> to
1185        open a page listing items. Most list pages can only
1186        list one type of items. For example: use the
1187        <menuchoice><guimenu>View</guimenu><guimenuitem>Samples</guimenuitem></menuchoice>
1188        menu to list samples and the
1189        <menuchoice><guimenu>View</guimenu><guimenuitem>Experiments</guimenuitem></menuchoice>
1190        menu to list experiments.
1191      </para>
1192     
1193      <tip>
1194        An example of a list page that can list
1195        items of several types is found by going to
1196        <menuchoice>
1197          <guimenu>View</guimenu>
1198          <guimenuitem>All items</guimenuitem>
1199        </menuchoice>.
1200        This page lists all items that you are the owner of. It has a few limitations:
1201       
1202        <itemizedlist>
1203          <listitem>
1204            <para>
1205              It support only a limited set of columns (type, name and description)
1206              since these are the only properties that are common
1207              among all items.
1208            </para>
1209          </listitem>
1210         
1211          <listitem>
1212            <para>
1213              The list can't be filtered (except by item type)
1214              or sorted. This is due to a limitation in the query system
1215              used to generate the list.
1216            </para>
1217          </listitem>
1218        </itemizedlist>
1219       
1220        <para>
1221          There are also several similarities:
1222        </para>
1223       
1224        <itemizedlist>
1225          <listitem>
1226            <para>
1227              It supports all of the regular multi-item
1228              operations such as delete, restore, share
1229              and take ownership.
1230            </para>
1231          </listitem>
1232         
1233          <listitem>
1234            <para>
1235              Clicking on the name of the item will take you to the
1236              single-item view of that item. Holding down <keycap>CTRL</keycap>,
1237              <keycap>ALT</keycap> or <keycap>SHIFT</keycap> while clicking,
1238              will open the edit popup.
1239            </para>
1240          </listitem>
1241        </itemizedlist>       
1242       
1243      </tip>
1244     
1245      <figure id="webclient.figures.listpage">
1246        <title>A typical list page</title>
1247        <screenshot>
1248          <mediaobject>
1249            <imageobject><imagedata fileref="figures/listpage.png" format="PNG"
1250              scalefit="1" width="100%" /></imageobject>
1251          </mediaobject>
1252        </screenshot>
1253      </figure>
1254     
1255      <para>
1256        The typical list page contains the following important
1257        elements:
1258      </para>
1259
1260      <variablelist>
1261        <varlistentry>
1262          <term><interface>1. Toolbar</interface></term>
1263          <listitem>
1264            <para>
1265            A toolbar with buttons for various actions such as
1266            <guibutton>New&hellip;</guibutton> for creating a new item,
1267            <guibutton>Delete</guibutton> for deleting items and
1268            <guibutton>Columns&hellip;</guibutton> for configuring columns.
1269            Depending on the permissions of the logged in user
1270            some buttons may be disabled (greyed out) or not shown at all.
1271            </para>
1272          </listitem>
1273        </varlistentry>
1274       
1275        <varlistentry>
1276          <term><interface>2. Navigation bar</interface></term>
1277          <listitem>
1278            <para>
1279            If there are many items the list will be divided into
1280            pages, each one showing a limited number of items.
1281            The navigation bar allows you to
1282            move to other pages and specify how many items each page
1283            should display. The navigation bar is repeated at the
1284            bottom of the list so you don't have to scroll back to the
1285            top of a long list just to get to another page.
1286            </para>
1287          </listitem>
1288        </varlistentry>
1289       
1290        <varlistentry>
1291          <term><interface>3. List of presets</interface></term>
1292          <listitem>
1293            <para>
1294            A list with preconfigured settings which allows you to
1295            quickly switch between different layouts (sort order, visible
1296            columns, filter settings, etc).
1297            </para>
1298          </listitem>
1299        </varlistentry>
1300       
1301        <varlistentry>
1302          <term><interface>4. Column headers</interface></term>
1303          <listitem>
1304            <para>
1305            The columns headers can be used for selecting sort order.
1306            </para>
1307          </listitem>
1308        </varlistentry>
1309       
1310        <varlistentry>
1311          <term><interface>5. Filter bar</interface></term>
1312          <listitem>
1313            <para>
1314            The filter bar allows you to search for items.
1315            </para>
1316          </listitem>
1317        </varlistentry>
1318       
1319      </variablelist>
1320     
1321     
1322      <sect2 id="webclient.itemlist.order">
1323        <title>Ordering the list</title>
1324       
1325        <para>
1326          Most lists are by default sorted by the name of the item. This can
1327          be changed by clicking on the column header of another column.
1328          If you click on the same column twice the sort order is reversed.
1329          A downwards or upwards pointing arrow is displayed next to the
1330          column header in the column that is currently used for sorting.
1331          Column headers that are black can't be used for sorting.
1332        </para>
1333       
1334        <para>
1335          It is possible to use more than one column for sorting. Press
1336          and hold one of the <keycap>CTRL</keycap>,
1337          <keycap>ALT</keycap> or <keycap>SHIFT</keycap> keys while clicking
1338          on another column header. The original sorting is kept and the new
1339          column is used for sub-sorting the list. The procedure can be
1340          repeated with more columns if you need to sort on three or more
1341          columns. To revert to sort by only one column again click a
1342          column header without holding down any key.
1343        </para> 
1344      </sect2>
1345   
1346      <sect2 id="webclient.itemlist.filter">
1347        <title>Filtering the list</title>
1348       
1349        <para>
1350          If the list contains many items you may need to use a filter to be
1351          able to find the item you are looking for. The input boxes on the
1352          line below the column headers are used for filtering. Most columns
1353          are filtered using a free-text input box, but some columns that can
1354          only take a few distinct values use a selection list or radio buttons
1355          instead. The selection list and radio buttons are very simple to use.
1356          Just select the alternative that you want to filter on. The list
1357          will be automatically updated when the selection has been made.
1358        </para>
1359       
1360        <para>
1361          The free-text filter is a bit more complex. By default, an exact match is
1362          required, use % as a wildcard that matches any character.
1363          For example, the filter <informalexample>Experiment A</informalexample> 
1364          only matches the same exact string, but the filter
1365          <informalexample>Exp%</informalexample> matches
1366          <informalexample>Experiment A, Experiment B, etc.</informalexample>
1367        </para>
1368       
1369        <para>
1370          You can also use operators to find items which has a value that
1371          is greater than, less than or not equal to a specific value. This is
1372          mostly useful on numeric or date columns but also works on text
1373          columns. The operator must be entered first in the
1374          free-text box, for example
1375          <informalexample>&lt;=10</informalexample>
1376          to find items which has a value less than or equal to 10.   
1377          Here is a list of the supported operators:
1378        </para>
1379       
1380        <variablelist id="webclient.itemlist.filter.operators">
1381          <title>List of operators supported by the free-text filter</title>
1382          <varlistentry>
1383            <term><keycap>&lt;</keycap></term>
1384            <listitem><simpara>Less than</simpara></listitem>
1385          </varlistentry>
1386          <varlistentry>
1387            <term><keycap>&lt;=</keycap></term>
1388            <listitem><simpara>Less than or equal to</simpara></listitem>
1389          </varlistentry>
1390          <varlistentry>
1391            <term><keycap>&gt;</keycap></term>
1392            <listitem><simpara>Greater than</simpara></listitem>
1393          </varlistentry>
1394          <varlistentry>
1395            <term><keycap>&gt;=</keycap></term>
1396            <listitem><simpara>Greater than or equal to</simpara></listitem>
1397          </varlistentry>
1398          <varlistentry>
1399            <term><keycap>=</keycap></term>
1400            <listitem><simpara>Equal to (useful to find items with a null value)</simpara></listitem>
1401          </varlistentry>
1402          <varlistentry>
1403            <term><keycap>&lt;&gt;</keycap></term>
1404            <term><keycap>!=</keycap></term>
1405            <listitem><simpara>Not equal to (useful to find items with a non-null value)</simpara></listitem>
1406          </varlistentry>
1407        </variablelist>
1408      </sect2>
1409     
1410      <sect2 id="webclient.itemlist.columns">
1411        <title>Configuring which columns to show</title>
1412       
1413        <para>
1414          Most lists show only a small subset of the columns it
1415          is capable of showing. Use the
1416          <guibutton>Columns&hellip;</guibutton> button to open
1417          a dialog that allows you to select which columns to show
1418          and the order in which they are shown.
1419        </para>
1420       
1421        <figure id="webclient.figures.configure_columns">
1422          <title>Configuring which columns to show</title>
1423          <screenshot>
1424          <mediaobject>
1425            <imageobject>
1426              <imagedata fileref="figures/configure_columns.png" format="PNG"/>
1427            </imageobject>
1428          </mediaobject>
1429          </screenshot>
1430        </figure>
1431       
1432        <helptext external_id="columns.configure" 
1433          title="Set column order and visiblity">
1434       
1435        <variablelist>
1436        <varlistentry>
1437          <term><guilabel>Visible columns</guilabel></term>
1438          <listitem>
1439            <para>
1440              Shows the columns that are currently visible.
1441              Use the up/down arrow buttons to arrange the order of the
1442              visible columns. The topmost column is shown to the left.
1443              Use the right arrow button to move columns from this list
1444              to the hidden columns list. Columns marked with an <guilabel>×</guilabel> 
1445              are required
1446              and can't be hidden. In most lists the <guilabel>Name</guilabel> column
1447              is the only column that is required.
1448            </para>
1449          </listitem>
1450        </varlistentry>
1451         
1452        <varlistentry>
1453          <term><guilabel>Hidden columns</guilabel></term>
1454          <listitem>
1455            <para>
1456              Shows columns that are not currently visible in the
1457              list. Use the left arrow button to move columns from
1458              this list to the visible columns list.
1459            </para>
1460          </listitem>
1461        </varlistentry>
1462       
1463       
1464        <varlistentry>
1465          <term><guilabel>Presets</guilabel></term>
1466          <listitem>
1467            <para>
1468              A dropdown list that allows you to
1469              select a set of preconfigured columns. You may also create
1470              your own preset if you often need to switch between different
1471              configurations. The list of presets is the same as the one
1472              described <link linkend="webclient.itemlist.presets">below</link>,
1473              but if used from this dialog the presets doesn't affect filters,
1474              sort order, etc.
1475            </para>
1476          </listitem>
1477        </varlistentry>
1478        </variablelist>
1479       
1480          <para>
1481            Use the <guibutton>Save</guibutton> button to apply your
1482            changes or the <guibutton>Cancel</guibutton> button to
1483            close the popup without saving.
1484          </para>
1485
1486        </helptext>
1487
1488      </sect2>
1489     
1490      <sect2 id="webclient.itemlist.presets">
1491        <title>Presets</title>
1492       
1493        <para>
1494          The <guilabel>view / presets</guilabel> dropdown has three
1495          main functions:
1496        </para>
1497       
1498        <figure id="webclient.figures.viewpresets">
1499          <title>The view / presets dropdown</title>
1500          <screenshot>
1501            <mediaobject>
1502              <imageobject><imagedata fileref="figures/view_presets.png" format="PNG" 
1503                /></imageobject>
1504            </mediaobject>
1505          </screenshot>
1506        </figure>
1507        <orderedlist>
1508          <listitem>
1509            <para>
1510              Switch between different configuration presets.
1511              The top of the dropdown contains user-defined presets (<guilabel>Saved preset #1</guilabel> and
1512              <guilabel>#2</guilabel>) and a few preconfigured presets.
1513              The user-defined presets are used to store a complete table configuration,
1514              including:
1515            </para>
1516           
1517            <itemizedlist>
1518              <listitem><simpara>Which columns are visible and their order</simpara></listitem>
1519              <listitem><simpara>The column (or columns) used for sorting</simpara></listitem>
1520              <listitem><simpara>Filter settings</simpara></listitem>
1521              <listitem><simpara>The number of items per page and the current page</simpara></listitem>
1522            </itemizedlist>
1523           
1524            <para>             
1525              The preconfigured presets only affects
1526              the visible columns as follows:
1527            </para>
1528           
1529            <itemizedlist>
1530              <listitem>
1531                <para><guilabel>All columns</guilabel> - Show all columns.</para>
1532              </listitem>
1533              <listitem>
1534                <para><guilabel>Required columns</guilabel> - Show only the required columns.
1535                  Usually only the <guilabel>Name</guilabel> column is required.</para>
1536              </listitem>
1537              <listitem>
1538                <para><guilabel>Default columns</guilabel> - Show the default set of columns.</para>
1539              </listitem>
1540              <listitem>
1541                <para><guilabel>Other&hellip;</guilabel> -
1542                  Open the <link linkend="webclient.itemlist.columns">configure columns dialog box</link>.</para>
1543              </listitem>
1544            </itemizedlist>
1545           
1546          </listitem>
1547         
1548          <listitem>
1549            <para>
1550              Filter items by the removed status and the access
1551              permissions to an item.
1552            </para>
1553           
1554            <itemizedlist>
1555              <listitem>
1556                <para><guilabel>Removed</guilabel> - If checked, items that have been
1557                moved to the trashcan are shown, otherwise they are hidden.</para>
1558              </listitem>
1559              <listitem>
1560                <para><guilabel>Owned by me</guilabel> - If checked, items that the logged in user
1561                owns are displayed, otherwise they are hidden.</para>
1562              </listitem>
1563              <listitem>
1564                <para><guilabel>Shared to me</guilabel> - If checked, items that are owned
1565                by other users but shared to the logged in user are displayed, otherwise
1566                they are hidden.</para>
1567              </listitem>
1568              <listitem>
1569                <para><guilabel>In current project</guilabel> -
1570                  If checked, items that are linked with the current project are displayed,
1571                  otherwise they are hidden. It doesn't matter if the logged in user is the
1572                  owner or not. This option is only available if a project is active.
1573                </para>
1574              </listitem>
1575              <listitem>
1576                <para><guilabel>Owned by others</guilabel> -
1577                  This option is only available to administrators and will display
1578                  items that are owned by other users.
1579                </para>
1580              </listitem>
1581            </itemizedlist>
1582           
1583            <para>
1584              The default is to display item that the current user
1585              owns and, if a project is active, items in that project.
1586            </para>
1587           
1588          </listitem>
1589
1590          <listitem>
1591            <para>
1592              Administrate the presets
1593            </para>
1594            <itemizedlist>
1595              <listitem>
1596                <para><guilabel>Clear filter</guilabel> - Clears
1597                all filters.</para>
1598              </listitem>
1599             
1600              <listitem>
1601                <para><guilabel>Save as&hellip;</guilabel> - Save the
1602                current configuration as a preset.</para>
1603              </listitem>
1604
1605              <listitem>
1606                <para><guilabel>Manage&hellip;</guilabel> - Opens a dialog
1607                where you can remove saved presets. You can also load
1608                saved presets from the dialog, but it is quicker to just
1609                use the dropdown list for this.</para>
1610              </listitem>
1611            </itemizedlist>
1612          </listitem>
1613        </orderedlist>
1614       
1615        <sect3 id="webclient.itemlist.presets.saveas">
1616          <title>Save a preset</title>
1617         
1618          <para>
1619            If you select the <guilabel>Save as&hellip;</guilabel>
1620            option from the <guilabel>view / presets</guilabel> dropdown
1621            the <guilabel>Save preset as</guilabel> dialog is opened.
1622          </para>
1623         
1624          <figure id="webclient.figures.savepresetas">
1625            <title>Save preset as</title>
1626            <screenshot>
1627              <mediaobject>
1628                <imageobject><imagedata fileref="figures/save_preset.png" format="PNG" /></imageobject>
1629              </mediaobject>
1630            </screenshot>
1631          </figure>
1632         
1633          <helptext external_id="contexts.saveas" title="Save preset as">
1634         
1635          <variablelist>
1636          <varlistentry>
1637            <term><guilabel>For item</guilabel></term>
1638            <listitem>
1639              <para>
1640              The type of item the preset is saved for.
1641              </para>
1642            </listitem>
1643          </varlistentry>
1644          <varlistentry>
1645            <term><guilabel >Name</guilabel></term>
1646            <listitem>
1647              <para>
1648              The name of the preset. The name must be unique.
1649              </para>
1650            </listitem>
1651          </varlistentry>
1652          <varlistentry>
1653            <term><guilabel>Overwrite existing</guilabel></term>
1654            <listitem>
1655              <para>
1656              If a preset with the same name already exists, it is
1657              overwritten if this checkbox is checked.
1658              </para>
1659            </listitem>
1660          </varlistentry>
1661          <varlistentry>
1662            <term><guilabel>Public</guilabel></term>
1663            <listitem>
1664              <para>
1665              This options is only available for users
1666              which has the <emphasis>SHARE_TO_EVERYONE</emphasis>
1667              permission. If checked the preset is visible to
1668              all users.
1669              </para>
1670            </listitem>
1671          </varlistentry>
1672          </variablelist>
1673         
1674          <para>
1675            Use the <guibutton>Ok</guibutton> button to save the preset
1676            or the <guibutton>Cancel</guibutton> button to
1677            close the popup without saving.
1678          </para>
1679         
1680         
1681          </helptext>
1682         
1683        </sect3>
1684       
1685        <sect3 id="webclient.itemlist.presets.manage">
1686          <title>Manage presets</title>
1687         
1688          <para>
1689            If you select the <guilabel>Manage&hellip;</guilabel>
1690            option from the <guilabel>view / presets</guilabel> dropdown
1691            the <guilabel>Manage presets</guilabel> dialog is opened.
1692          </para>
1693         
1694          <figure id="webclient.figures.managepresets">
1695            <title>Manage presets</title>
1696            <screenshot>
1697              <mediaobject>
1698                <imageobject><imagedata fileref="figures/manage_presets.png" format="PNG" /></imageobject>
1699              </mediaobject>
1700            </screenshot>
1701          </figure>
1702         
1703          <helptext external_id="contexts.manage" title="Manage presets">
1704         
1705          <para>
1706            From this dialog you can delete or load presets.
1707          </para>
1708         
1709          <para>
1710            To delete presets, first mark the checkbox in front of
1711            each preset you want to delete. Then, click on the
1712            <guibutton>Delete&hellip;</guibutton> button. You will get
1713            a warning about that the action can't be undone. Unlike other
1714            items, the presets are not moved to the trashcan. Click on
1715            <guibutton>Ok</guibutton> to delete the preset.
1716          </para>
1717         
1718          <note>
1719            <title>Edit a preset</title>
1720            <para>
1721            It is not possible to edit a preset directly. To change an
1722            existing preset you must:
1723           
1724            <orderedlist>
1725            <listitem><simpara>Load the preset.</simpara></listitem>
1726            <listitem><simpara>Use the interface to change column settings, filter,
1727              sort order, etc.</simpara></listitem>
1728            <listitem><simpara>Save the preset with the same name.</simpara></listitem>
1729            </orderedlist>
1730            </para>
1731          </note>
1732         
1733          <para>
1734            Use the <guibutton>Close</guibutton> button to
1735            close the popup.
1736          </para>
1737         
1738         
1739          </helptext>
1740         
1741        </sect3>
1742       
1743      </sect2>
1744    </sect1>
1745   
1746</chapter>
Note: See TracBrowser for help on using the repository browser.