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