| 1 | <?xml version="1.0" encoding="UTF-8"?> |
|---|
| 2 | <!DOCTYPE helptexts SYSTEM "helpfile.dtd"> |
|---|
| 3 | <!-- |
|---|
| 4 | $Id: |
|---|
| 5 | Copyright (C) Authors contributing to this file. |
|---|
| 6 | |
|---|
| 7 | This file is part of BASE - BioArray Software Environment. |
|---|
| 8 | Available at http://base.thep.lu.se/ |
|---|
| 9 | |
|---|
| 10 | BASE is free software; you can redistribute it and/or |
|---|
| 11 | modify it under the terms of the GNU General Public License |
|---|
| 12 | as published by the Free Software Foundation; either version 2 |
|---|
| 13 | of the License, or (at your option) any later version. |
|---|
| 14 | |
|---|
| 15 | BASE is distributed in the hope that it will be useful, |
|---|
| 16 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
|---|
| 17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|---|
| 18 | GNU General Public License for more details. |
|---|
| 19 | |
|---|
| 20 | You should have received a copy of the GNU General Public License |
|---|
| 21 | along with this program; if not, write to the Free Software |
|---|
| 22 | Foundation, Inc., 59 Temple Place - Suite 330, |
|---|
| 23 | Boston, MA 02111-1307, USA. |
|---|
| 24 | --> |
|---|
| 25 | <helptexts clientExternalID="net.sf.basedb.clients.web"> |
|---|
| 26 | <helpitem externalID="help.edit"> |
|---|
| 27 | <name>Edit help texts</name> |
|---|
| 28 | <description><h4>Properties</h4>
 |
|---|
| 29 | <ul>
 |
|---|
| 30 | <li>
 |
|---|
| 31 | <req>Title</req><br>
 |
|---|
| 32 | The helptext's title. It should be a relevant name/title that gives a hint what the text is about. <imp>Maximum length of the text is 255 characters</imp>. The title will be displayed at the top of the popup-window that the text is viewed in.
 |
|---|
| 33 | </li>
 |
|---|
| 34 | <li>
 |
|---|
| 35 | <req>External ID</req><br>
 |
|---|
| 36 | The id is used by the webclient to identify the help text. <imp>It should consist of few explaining words separated with '.'</imp>. Many helptexts' external IDs are already specified in the webclient, it's therefore recommended visit the part of the webclient where the help text should be placed and look for already existing IDs/help links.
 |
|---|
| 37 | </li>
 |
|---|
| 38 | <li>
 |
|---|
| 39 | <ui>Help text</ui><br>
 |
|---|
| 40 | The whole helptext should be written in this textarea. Click on the magnifying glass to get a larger typing window. The editing is in plain text, but the help text itself will be HTML-decoded before displayed and it's therefore recommended to use basic HTML-tags to make the text more readable. There are some tools, explained later in this text, that can be used to simplify the editing process.
 |
|---|
| 41 | </li>
 |
|---|
| 42 | </ul>
 |
|---|
| 43 | Save the helptext item by pressing the <btn>Save</btn> - button or press <btn>Cancel</btn> to discard the changes.
 |
|---|
| 44 | 
 |
|---|
| 45 | <h4>Editing tools</h4>
 |
|---|
| 46 | The toolbar for text editing contains following buttons that are listed in the table below. 
 |
|---|
| 47 | Mark the text that shall be between the start- and end tag and click on the toolbutton for the wanted function.
 |
|---|
| 48 | <table width=100% border="1" cellpadding="2" style="border-collapse:collapse;">
 |
|---|
| 49 | <tr>
 |
|---|
| 50 | <th width="50" colspan="2">Edit tools</th>
 |
|---|
| 51 | <th>Starttag</th>
 |
|---|
| 52 | <th>Endtag</th>
 |
|---|
| 53 | <th>Description</th>
 |
|---|
| 54 | </tr> 
 |
|---|
| 55 | 
 |
|---|
| 56 | <tr>
 |
|---|
| 57 | <td><btn><img src="/base2/images/text_bold.png"/></btn></td>
 |
|---|
| 58 | <td>-</td>
 |
|---|
| 59 | <td><ui>&lt;b&gt;</ui></td>
 |
|---|
| 60 | <td><ui>&lt;/b&gt;</ui></td>
 |
|---|
| 61 | <td>Bold text</td>
 |
|---|
| 62 | </tr>
 |
|---|
| 63 | 
 |
|---|
| 64 | <tr>
 |
|---|
| 65 | <td><btn><img src="/base2/images/text_italic.png"/></btn></td>
 |
|---|
| 66 | <td>-</td>
 |
|---|
| 67 | <td><ui>&lt;i&gt;</ui></td>
 |
|---|
| 68 | <td><ui>&lt;/i&gt;</ui></td>
 |
|---|
| 69 | <td>Italic text</td>
 |
|---|
| 70 | </tr>
 |
|---|
| 71 | 
 |
|---|
| 72 | <tr>
 |
|---|
| 73 | <td><btn><img src="/base2/images/text_underline.png"/></btn></td>
 |
|---|
| 74 | <td>-</td>
 |
|---|
| 75 | <td><ui>&lt;u&gt;</ui></td>
 |
|---|
| 76 | <td><ui>&lt;/u&gt;</ui></td>
 |
|---|
| 77 | <td>Underlined text</td>
 |
|---|
| 78 | </tr>
 |
|---|
| 79 | 
 |
|---|
| 80 | <tr>
 |
|---|
| 81 | <td><btn><img src="/base2/images/text_h3.png"/></btn></td>
 |
|---|
| 82 | <td>-</td>
 |
|---|
| 83 | <td><ui>&lt;h3&gt;</ui></td> 
 |
|---|
| 84 | <td><ui>&lt;/h3&gt;</ui></td> 
 |
|---|
| 85 | <td>Large header, e.g. new chapter.</td>
 |
|---|
| 86 | </tr>
 |
|---|
| 87 | 
 |
|---|
| 88 | <tr>
 |
|---|
| 89 | <td><btn><img src="/base2/images/text_h4.png"/></btn></td>
 |
|---|
| 90 | <td>-</td>
 |
|---|
| 91 | <td><ui>&lt;h4&gt;</ui></td>
 |
|---|
| 92 | <td><ui>&lt;/h4&gt;</ui></td>
 |
|---|
| 93 | <td>Small header, e.g. new part</td>
 |
|---|
| 94 | </tr>
 |
|---|
| 95 | 
 |
|---|
| 96 | <tr>
 |
|---|
| 97 | <td rowspan="5"><btn><img src="/base2/images/text_style_edit.gif"/></btn></td>
 |
|---|
| 98 | <td><mnu>Important</mnu></td>
 |
|---|
| 99 | <td><ui>&lt;imp&gt;</ui></td>
 |
|---|
| 100 | <td><ui>&lt;/imp&gt;</ui></td>
 |
|---|
| 101 | <td>Marks the text as important. This should be used when the reader should take extra notice.</td>
 |
|---|
| 102 | </tr>
 |
|---|
| 103 | <tr>
 |
|---|
| 104 | <td><mnu>User input</mnu></td>
 |
|---|
| 105 | <td><ui>&lt;ui&gt;</ui></td>
 |
|---|
| 106 | <td><ui>&lt;/ui&gt;</ui></td>
 |
|---|
| 107 | <td>Marks a text to symblize input from user, e.g. textfields</td> 
 |
|---|
| 108 | </tr>
 |
|---|
| 109 | <tr>
 |
|---|
| 110 | <td><mnu>Required</mnu></td>
 |
|---|
| 111 | <td><ui>&lt;req&gt;</ui></td>
 |
|---|
| 112 | <td><ui>&lt;/req&gt;</ui></td>
 |
|---|
| 113 | <td>Marks the text to symlize required input from user.</td>
 |
|---|
| 114 | </tr>
 |
|---|
| 115 | <tr>
 |
|---|
| 116 | <td><mnu>Button&nbsp;text</mnu></td>
 |
|---|
| 117 | <td><ui>&lt;btn&gt;</ui></td>
 |
|---|
| 118 | <td><ui>&lt;/btn&gt;</ui></td>
 |
|---|
| 119 | <td>Text that symbolize a button. This will put a border around the text give it a grey background.</td>
 |
|---|
| 120 | </tr>
 |
|---|
| 121 | <tr>
 |
|---|
| 122 | <td><mnu>Menu&nbsp;text</mnu></td>
 |
|---|
| 123 | <td><ui>&lt;mnu&gt;</ui></td>
 |
|---|
| 124 | <td><ui>&lt;/mnu&gt;</ui></td>
 |
|---|
| 125 | <td>Marks text to symbolize a menu. The text's background will be light grey.</td>
 |
|---|
| 126 | </tr>
 |
|---|
| 127 | 
 |
|---|
| 128 | <tr>
 |
|---|
| 129 | <td rowspan="3"><btn><img src="/base2/images/text_table.png"/></btn></td>
 |
|---|
| 130 | <td><mnu>Table</mnu></td>
 |
|---|
| 131 | <td><ui>&lt;table frame="borders"&gt;</ui></td>
 |
|---|
| 132 | <td><ui>&lt;/table&gt;</ui></td>
 |
|---|
| 133 | <td>Inserts an empty table with a small border around.</td>
 |
|---|
| 134 | </tr>
 |
|---|
| 135 | <tr>
 |
|---|
| 136 | <td><mnu>Row</mnu></td>
 |
|---|
| 137 | <td><ui>&lt;tr&gt;</ui></td>
 |
|---|
| 138 | <td><ui>&lt;/tr&gt;</ui></td>
 |
|---|
| 139 | <td>Inserts a table row. <imp>Need to be inside a table-tag.</imp></td>
 |
|---|
| 140 | </tr>
 |
|---|
| 141 | <tr>
 |
|---|
| 142 | <td><mnu>Cell</mnu></td>
 |
|---|
| 143 | <td><ui>&lt;td&gt;</ui></td>
 |
|---|
| 144 | <td><ui>&lt;/td&gt;</ui></td>
 |
|---|
| 145 | <td>Inserts a table cell. <imp>Need to be inside a table row-tag.</imp></td>
 |
|---|
| 146 | </tr>
 |
|---|
| 147 | 
 |
|---|
| 148 | <tr>
 |
|---|
| 149 | <td rowspan="2"><btn><img src="/base2/images/text_list.gif"/></btn></td>
 |
|---|
| 150 | <td><mnu>Orderded&nbsp;list</mnu></td>
 |
|---|
| 151 | <td><ui>&lt;ol&gt;</ui></td>
 |
|---|
| 152 | <td><ui>&lt;/ol&gt;</ui></td>
 |
|---|
| 153 | <td>An ordered list of items. Each list item has to begin with &lt;li&gt; and end with &lt;/li&gt;.</td>
 |
|---|
| 154 | </tr>
 |
|---|
| 155 | <tr>
 |
|---|
| 156 | <td><mnu>Unorderded&nbsp;list</mnu></td>
 |
|---|
| 157 | <td><ui>&lt;ul&gt;</ui></td>
 |
|---|
| 158 | <td><ui>&lt;/ul&gt;</ui></td>
 |
|---|
| 159 | <td>An unordered list where each list item has to begin with &lt;li&gt; and end with &lt;/li&gt;.</td>
 |
|---|
| 160 | </tr>
 |
|---|
| 161 | 
 |
|---|
| 162 | <tr>
 |
|---|
| 163 | <td><btn><img src="/base2/images/text_newline.gif"/></btn></td>
 |
|---|
| 164 | <td>-</td>
 |
|---|
| 165 | <td><ui>&lt;br&gt;</ui></td>
 |
|---|
| 166 | <td>&nbsp;</td>
 |
|---|
| 167 | <td>Inserts a new line. No end tag is needed</td>
 |
|---|
| 168 | </tr>
 |
|---|
| 169 | 
 |
|---|
| 170 | <tr>
 |
|---|
| 171 | <td><btn><img src="/base2/images/text_paragraph.gif"/></btn></td>
 |
|---|
| 172 | <td>-</td>
 |
|---|
| 173 | <td><ui>&lt;p&gt;</ui></td>
 |
|---|
| 174 | <td><ui>&lt;/p&gt;</ui></td>
 |
|---|
| 175 | <td>Inserts a paragraph in the document.</td>
 |
|---|
| 176 | </tr>
 |
|---|
| 177 | 
 |
|---|
| 178 | <tr>
 |
|---|
| 179 | <td rowspan="4"><btn><img src="/base2/images/text_link.png"/></btn></td>
 |
|---|
| 180 | <td><mnu>Insert helptext</mnu></td>
 |
|---|
| 181 | <td><ui>&#123@include external.id&#125</ui></td>
 |
|---|
| 182 | <td>&nbsp;</td>
 |
|---|
| 183 | <td>Inserts the helptext which has the external id that is put inside the curly braces. The 'tag' will be displayed if no help text with the specified id can be found.</td>
 |
|---|
| 184 | </tr>
 |
|---|
| 185 | <tr>
 |
|---|
| 186 | <td><mnu>External link</mnu></td>
 |
|---|
| 187 | <td><ui>&#123@link external.id linkname&#125</ui></td>
 |
|---|
| 188 | <td>&nbsp;</td>
 |
|---|
| 189 | <td>Inserts a link to the helptext which has the external id. This has three parts all separated with a blank space between. Beside the '@link' and the helptext's external id it is the linkname - the name to be displayed in the text.</td>
 |
|---|
| 190 | </tr>
 |
|---|
| 191 | <tr>
 |
|---|
| 192 | <td><mnu>Internal link</mnu></td>
 |
|---|
| 193 | <td><ui>&lt;a href="#bookmark name"&gt;</ui></td>
 |
|---|
| 194 | <td><ui>&lt;/a&gt;</ui></td>
 |
|---|
| 195 | <td>Links to a bookmark within the text. A bookmark is inserted with the bookmark-tag below. There has to be a word/text between the start- and end tag for this to work.</td>
 |
|---|
| 196 | </tr>
 |
|---|
| 197 | <tr>
 |
|---|
| 198 | <td><mnu>Bookmark</mnu></td>
 |
|---|
| 199 | <td><ui>&lt;a name="name"&gt;</ui></td>
 |
|---|
| 200 | <td><ui>&lt;/a&gt;</ui></td>
 |
|---|
| 201 | <td>Inserts a bookmark in the text. Use the bookmark's name as reference in a internal link.</td>
 |
|---|
| 202 | </tr>
 |
|---|
| 203 | </table></description> |
|---|
| 204 | </helpitem> |
|---|
| 205 | <helpitem externalID="list.filter"> |
|---|
| 206 | <name>Filter</name> |
|---|
| 207 | <description>By using the filters it's possible to limit what the item lists should contain, 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.
 |
|---|
| 208 | <br>
 |
|---|
| 209 | <h4>Clear filter</h4>
 |
|---|
| 210 | The filter can be cleared any time by clicking on <mnu>Clear filter</mnu> in the <mnu>view/preset</mnu> dropdown list.<br>
 |
|---|
| 211 | <h4>Input Formats</h4>
 |
|---|
| 212 | The format that the filter value should be in depends on what kind of column that should be filtered.<br>
 |
|---|
| 213 | Simple textfields such as names, descriptions, titles etc. take any textstring as an input. The filter is <imp>incasesensitive</imp> and the value can contain wildcards for textstrings to expand the conditions(see <a href="#wildcards">Wildcards</a> below).<br><br>
 |
|---|
| 214 | The filter value for date fields shall be in the format <imp>YYYY-MM-DD</imp>, e.g. 2005-03-05 for the 5th of March year 2005.<br>
 |
|---|
| 215 | The columns with a dropdown list as a filter field can only be filtered with one of the values availble in the list.<br>
 |
|---|
| 216 | Boolean fields have three options that they can be filtered on: true, false and any(both true and false).<br>
 |
|---|
| 217 | The columns in number format can be filtered with any float number with '.' as a decimalpoint. The filter value can contain <a href="#wildcards">wildcards</a> for numbers to expand the conditions.<br>
 |
|---|
| 218 | <h4>Operators</h4>
 |
|---|
| 219 | Can 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. 
 |
|---|
| 220 | <table width=100% border="1" cellpadding="2" style="border-collapse:collapse;">
 |
|---|
| 221 | <tr>
 |
|---|
| 222 | <th>Operator</th>
 |
|---|
| 223 | <th>Name</th>
 |
|---|
| 224 | <th>Description/result</th>
 |
|---|
| 225 | </tr>
 |
|---|
| 226 | <tr>
 |
|---|
| 227 | <td>=</td>
 |
|---|
| 228 | <td>Equals to</td>
 |
|---|
| 229 | <td>Values that are equal to the filter value are displayed in the list.</td>
 |
|---|
| 230 | </tr>
 |
|---|
| 231 | <tr>
 |
|---|
| 232 | <td><></td>
 |
|---|
| 233 | <td>Not equal to</td>
 |
|---|
| 234 | <td>Values that not are equal to the filter value are displayed in the list.</td>
 |
|---|
| 235 | </tr>
 |
|---|
| 236 | <tr>
 |
|---|
| 237 | <td><</td>
 |
|---|
| 238 | <td>Less then</td>
 |
|---|
| 239 | <td>Values that are less then the filter value are displayed in the list.</td>
 |
|---|
| 240 | </tr>
 |
|---|
| 241 | <tr>
 |
|---|
| 242 | <td><=</td>
 |
|---|
| 243 | <td>Less then or equal</td>
 |
|---|
| 244 | <td>Values that are less then or equal to the filter value are displayed in the list.</td>
 |
|---|
| 245 | </tr>
 |
|---|
| 246 | <tr>
 |
|---|
| 247 | <td>></td>
 |
|---|
| 248 | <td>Greater then</td>
 |
|---|
| 249 | <td>Values that are greater then the filter value are displayed in the list.</td>
 |
|---|
| 250 | </tr>
 |
|---|
| 251 | <tr>
 |
|---|
| 252 | <td>>=</td>
 |
|---|
| 253 | <td>Greater then or equal</td>
 |
|---|
| 254 | <td>Values that are greater then or equal to the filter value are displayed in the list.</td>
 |
|---|
| 255 | </tr>
 |
|---|
| 256 | </table>
 |
|---|
| 257 | 
 |
|---|
| 258 | <h4>Sort order</h4>
 |
|---|
| 259 | Click on the column header on which the list items should be sorted after. Repeat the action to invert the order.<br>
 |
|---|
| 260 | <h4>Wildcards</h4><a name="wildcards"></a>
 |
|---|
| 261 | It 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.
 |
|---|
| 262 | <br>
 |
|---|
| 263 | <h4>Presets</h4>
 |
|---|
| 264 | It'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 <mnu>Save as</mnu> in the <mnu>view/preset</mnu> 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 <mnu>Manage</mnu> also located in the dropdown list.</description> |
|---|
| 265 | </helpitem> |
|---|
| 266 | <helpitem externalID="news.edit"> |
|---|
| 267 | <name>Edit news</name> |
|---|
| 268 | <description><ul>
 |
|---|
| 269 | <li><req>Title</req><br> 
 |
|---|
| 270 | A word or few words that gives a good hint about what the news are about. <imp>Can't be larger then 255 characters(including space).</imp>
 |
|---|
| 271 | </li>
 |
|---|
| 272 | <hr>
 |
|---|
| 273 | The date properties below can be set by either pressing the <btn>Calender</btn> button and pick a date from the popup window or it can be typed by hand.<br>
 |
|---|
| 274 | The only valid format in the date-fields is <imp>YYYY-MM-DD</imp>.<br><br>
 |
|---|
| 275 | <li>
 |
|---|
| 276 | <req>Start date</req><br> 
 |
|---|
| 277 | The date from which the news should start to be displayed on other users login and main pages.Must be <imp>before or equal the <i>News date</i> and the <i>End date</i></imp>.
 |
|---|
| 278 | </li>
 |
|---|
| 279 | <li>
 |
|---|
| 280 | <req>News date</req><br> 
 |
|---|
| 281 | The date when the news really took place. It has to be <imp>after or equal the <i>Start date</i> and before the <i>End date</i></imp>. 
 |
|---|
| 282 | </li>
 |
|---|
| 283 | <li>
 |
|---|
| 284 | <ui>End date</ui><br> 
 |
|---|
| 285 | The last date when the news should viewed at the users' login and main page. The news will always be displayed if this field is left empty.
 |
|---|
| 286 | </li>
 |
|---|
| 287 | <hr>
 |
|---|
| 288 | <li>
 |
|---|
| 289 | <ui>Description</ui><br>
 |
|---|
| 290 | Put the full news text here. Click on the magnifying glass to the right of the textbox if it's preferable to edit in larger window. It's possible to use basic HTML-tags in the text to make it more readable.
 |
|---|
| 291 | </li>
 |
|---|
| 292 | </ul>
 |
|---|
| 293 | Click on <btn>Save</btn> button to save the news or <btn>Cancel</btn> to abort and discard the changes.</description> |
|---|
| 294 | </helpitem> |
|---|
| 295 | </helptexts> |
|---|
