source: trunk/data/helptexts.xml @ 2959

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

References #412: Fix build.xml to make it more developer-friendly

  • Property svn:keywords set to Id
File size: 8.1 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE helptexts SYSTEM "helpfile.dtd">
3<!--
4  $Id: helptexts.xml 2959 2006-11-27 11:36:37Z nicklas $
5
6  BioArray Software Environment (BASE) - http://base.thep.lu.se/
7  Copyright (C) 2006 Martin Svensson
8
9  This file is part of BASE.
10
11  BASE is free software; you can redistribute it and/or
12  modify it under the terms of the GNU General Public License
13  as published by the Free Software Foundation; either version 2
14  of the License, or (at your option) any later version.
15
16  BASE is distributed in the hope that it will be useful,
17  but WITHOUT ANY WARRANTY; without even the implied warranty of
18  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  GNU General Public License for more details.
20
21  You should have received a copy of the GNU General Public License
22  along with this program; if not, write to the Free Software
23  Foundation, Inc., 59 Temple Place - Suite 330,
24  Boston, MA  02111-1307, USA.
25-->
26<helptexts clientExternalID="net.sf.basedb.clients.web">
27<helpitem externalID="news.create">
28    <name>Create news</name>
29    <description>Here is an explanation about the fields that is available to fill in when new news are created in BASE2&lt;br&gt;&#xD;
30&lt;table border="1"&gt;&#xD;
31&lt;tr&gt;&#xD;
32  &lt;td&gt;Field&lt;/td&gt;&#xD;
33  &lt;td&gt;Limitations&lt;/td&gt;&#xD;
34  &lt;td&gt;Explanation&lt;/td&gt;&#xD;
35&lt;/tr&gt;&#xD;
36&lt;tr&gt;&#xD;
37  &lt;td&gt;Title&lt;/td&gt;&#xD;
38  &lt;td&gt;Can not be longer then 255 characters(including space).&lt;/td&gt;&#xD;
39  &lt;td&gt;A word or few words that gives a good hint about what the news are about. &lt;u&gt;This field can not be left empty.&lt;/u&gt;&lt;/td&gt;&#xD;
40&lt;/tr&gt;&#xD;
41&lt;tr&gt;&#xD;
42  &lt;td&gt;Start date&lt;/td&gt;&#xD;
43  &lt;td&gt;Must be set to be before or equal &lt;i&gt;News date&lt;/i&gt; and &lt;i&gt;End date&lt;/i&gt;.&lt;/td&gt;&#xD;
44  &lt;td&gt;From which date the news should start to be displayed for other users on their login and main pages. The date must be in the format: &lt;u&gt;YYYY-MM-DD&lt;/u&gt;. It can also be set with the 'Calender...' button and then by clicking on the date that you want to set this property to. &lt;u&gt;This field can not be left empty!&lt;/u&gt;&lt;/td&gt;&#xD;
45&lt;/tr&gt;&#xD;
46&lt;tr&gt;&#xD;
47  &lt;td&gt;News date&lt;/td&gt;&#xD;
48  &lt;td&gt;Must be after or equal to &lt;i&gt;Start date&lt;/i&gt; and not later then the &lt;i&gt;End date&lt;/i&gt;.&lt;/td&gt;&#xD;
49  &lt;td&gt;This is the date when the news really happens and it must be in the format: &lt;u&gt;YYYY-MM-DD&lt;/u&gt;. It can also be set with the 'Calender...' button to the right of the field and then by clicking on the date that you want to set this property to. &lt;u&gt;This field can not be left empty!&lt;/u&gt;&lt;/td&gt;&#xD;
50&lt;/tr&gt;&#xD;
51&lt;tr&gt;&#xD;
52  &lt;td&gt;End date&lt;/td&gt;&#xD;
53  &lt;td&gt;Must be after or equal to &lt;i&gt;Start date&lt;/i&gt; and &lt;i&gt;News date&lt;/i&gt;.&lt;/td&gt;&#xD;
54  &lt;td&gt;Set this date to the day that this news should be displayed until on the users' login and main page. The date must be in the format: &lt;u&gt;YYYY-MM-DD&lt;/u&gt;. It can also be set with the 'Calender...' button to the right of the field and then by clicking on the date that you want to set this property to. The news will allways be displayed if this field is left empty.&lt;/td&gt;&#xD;
55&lt;/tr&gt;&#xD;
56&lt;tr&gt;&#xD;
57  &lt;td&gt;Description&lt;/td&gt;&#xD;
58  &lt;td&gt;-&lt;/td&gt;&#xD;
59  &lt;td&gt;Put the full news text here. Click on the arrow to the right of the textbox if it's preferable to edit the text in larger window, e.g. when it's a lot of text to put in. This property is not required to create the news.&lt;/td&gt;&#xD;
60&lt;/tr&gt;&#xD;
61&lt;/table&gt;&#xD;
62Click on the 'Save' button to create the news or 'Cancel' to abort.</description>
63  </helpitem>
64  <helpitem externalID="list.filter">
65    <name>Filter</name>
66    <description>By using the filters you can limit what to display in lists, locate specific list items, perform data filtration and more. Details may vary slightly from page to page but the general usage operations are well conserved.&#xD;
67&lt;br&gt;&lt;br&gt;&#xD;
68&lt;b&gt;Clear filter&lt;/b&gt;&lt;br&gt;&#xD;
69The filter can be cleared any time by clicking on 'Clear filter' in the dropdown list 'view/preset'.&lt;br&gt;&lt;br&gt;&#xD;
70&lt;b&gt;Input Formats&lt;/b&gt;&lt;br&gt;&#xD;
71The format that the filter value should be in depends on what kind of column that should be filtered.&lt;br&gt;&#xD;
72Simple textfields such as names, descriptions, titles etc. take any textstring as an input. The filter is &lt;u&gt;non-case sensitive&lt;/u&gt; and the value can contain wildcards for textstrings to expand the conditions(see Wildcards below).&lt;br&gt;&#xD;
73The filter value for date fields shall be in the format YYYY-MM-DD, e.g. 2005-03-05 for the 5th of March year 2005.&lt;br&gt;&#xD;
74The columns with a dropdown list as a filter field can only be filtered with one of the values availble in the list.&lt;br&gt;&#xD;
75Boolean fields have three options that they can be filtered on: true, false and any(both true and false).&lt;br&gt;&#xD;
76The columns in number format can be filtered with any float number with '.' as a decimalpoint. The filter value can contain wildcards for numbers to expand the conditions(see Wildcards below).&lt;br&gt;&lt;br&gt;&#xD;
77&lt;b&gt;Operators&lt;/b&gt;&lt;br&gt;&#xD;
78Can be used to define different limits for a column to be filtered on. These operators shall be typed first in the filter field, before the value to filter the column on. &#xD;
79&lt;table border="1"&gt;&#xD;
80&lt;tr&gt;&#xD;
81  &lt;td&gt;Operator&lt;/td&gt;&#xD;
82  &lt;td&gt;Name&lt;/td&gt;&#xD;
83  &lt;td&gt;Description&lt;/td&gt;&lt;/b&gt;&#xD;
84&lt;/tr&gt;&#xD;
85&lt;tr&gt;&#xD;
86  &lt;td&gt;=&lt;/td&gt;&#xD;
87  &lt;td&gt;Equals to&lt;/td&gt;&#xD;
88  &lt;td&gt;Values that are equal to the filter value are displayed in the list.&lt;/td&gt;&#xD;
89&lt;/tr&gt;&#xD;
90&lt;tr&gt;&#xD;
91  &lt;td&gt;&lt;&gt;&lt;/td&gt;&#xD;
92  &lt;td&gt;Not equal to&lt;/td&gt;&#xD;
93  &lt;td&gt;Values that not are equal to the filter value are displayed in the list.&lt;/td&gt;&#xD;
94&lt;/tr&gt;&#xD;
95&lt;tr&gt;&#xD;
96  &lt;td&gt;&lt;&lt;/td&gt;&#xD;
97  &lt;td&gt;Less then&lt;/td&gt;&#xD;
98  &lt;td&gt;Values that are less then the filter value are displayed in the list.&lt;/td&gt;&#xD;
99&lt;/tr&gt;&#xD;
100&lt;tr&gt;&#xD;
101  &lt;td&gt;&lt;=&lt;/td&gt;&#xD;
102  &lt;td&gt;Less then or equal&lt;/td&gt;&#xD;
103  &lt;td&gt;Values that are less then or equal to the filter value are displayed in the list.&lt;/td&gt;&#xD;
104&lt;/tr&gt;&#xD;
105&lt;tr&gt;&#xD;
106  &lt;td&gt;&gt;&lt;/td&gt;&#xD;
107  &lt;td&gt;Greater then&lt;/td&gt;&#xD;
108  &lt;td&gt;Values that are greater then the filter value are displayed in the list.&lt;/td&gt;&#xD;
109&lt;/tr&gt;&#xD;
110&lt;tr&gt;&#xD;
111  &lt;td&gt;&gt;=&lt;/td&gt;&#xD;
112  &lt;td&gt;Greater then or equal&lt;/td&gt;&#xD;
113  &lt;td&gt;Values that are greater then or equal to the filter value are displayed in the list.&lt;/td&gt;&#xD;
114&lt;/tr&gt;&#xD;
115&lt;/table&gt;&#xD;
116&lt;br&gt;&#xD;
117&lt;b&gt;Sort order&lt;/b&gt;&lt;br&gt;&#xD;
118Click on the column header that the list items should be sorted after. Repeat the action to invert the order.&lt;br&gt;&lt;br&gt;&#xD;
119&lt;b&gt;Wildcards&lt;/b&gt;&lt;br&gt;&#xD;
120It is possible to use the wildcard '%' to allow any character(s) in a value(e.g.  bas% will give all values that start with 'bas' indepedently what characters that follows. The wildcard can be used in more then one place in a textstring at the same time.&#xD;
121&lt;br&gt;&lt;br&gt;&#xD;
122&lt;b&gt;Presets&lt;/b&gt;&lt;br&gt;&#xD;
123It's possible to save a filter settings as a preset. This is very usefull if a filter will be used more then once and especially when there are more then one column that are included in the filter too. A filter is saved as a preset by clicking on 'Save as...' in the 'view/preset' dropdown list. The filter can then be used by choosing the preset's name from the same dropdown list as above. If a preset not is usefull anymore or it should be deleted for some other reason, this can be done by 'Manage...' also in the dropdown list.</description>
124  </helpitem>
125</helptexts>
Note: See TracBrowser for help on using the repository browser.