| 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="columns.configure"> |
|---|
| 27 | <name>Configure columns</name> |
|---|
| 28 | <description><h4>Visible/Hidden columns</h4>
 |
|---|
| 29 | Columns which name are placed in the listbox of visible columns will be displayed on listpage and the ones in hidden columns will not. The order between the visible columns on listpage will be the same as in the listbox.<br>
 |
|---|
| 30 | 
 |
|---|
| 31 | <p><b>Hide/unhide</b><br>
 |
|---|
| 32 | Select those column names, in either Visible columns or Hidden columns, that should be moved to the other listbox. Click then on one of the direction arrows between the listboxes, left to make columns visible or right to hide columns.<br>
 |
|---|
| 33 | <imp>Column names that are bold and marked with </imp><b>x</b><imp> can't be hidden.</p></imp>
 |
|---|
| 34 | 
 |
|---|
| 35 | <p><b>Change the order</b><br>
 |
|---|
| 36 | The order between visible columns can be changed to fit different purpose.<br>
 |
|---|
| 37 | A selected column is moved with the up and down arrows, located to the left of the listbox. The column is moved one step at the time/click.</p>
 |
|---|
| 38 | 
 |
|---|
| 39 | <h4>Presets of visible columns</h4>
 |
|---|
| 40 | Choose a preset of column configuration from the dropdown list to save clicks and time.<br>
 |
|---|
| 41 | Beside predefined presets there are also possibility for userdefined presets, where users can create their own presets.<br>
 |
|---|
| 42 | <p><b>Predefined</b>
 |
|---|
| 43 | <ul>
 |
|---|
| 44 | <li>
 |
|---|
| 45 | <mnu>All</mnu><br>
 |
|---|
| 46 | All columns will be visible in a specific order.
 |
|---|
| 47 | </li>
 |
|---|
| 48 | <li>
 |
|---|
| 49 | <mnu>Required</mnu><br>
 |
|---|
| 50 | Only columns that can't be hidden (marked with <b>x</b>) will be visible.
 |
|---|
| 51 | </li>
 |
|---|
| 52 | <li>
 |
|---|
| 53 | <mnu>Current</mnu></td><br>
 |
|---|
| 54 | The last saved column setup.
 |
|---|
| 55 | </li>
 |
|---|
| 56 | <li>
 |
|---|
| 57 | <mnu>Default</mnu><br>
 |
|---|
| 58 | Columns that are most typical for the list will be visible.
 |
|---|
| 59 | </li>
 |
|---|
| 60 | </ul></p>
 |
|---|
| 61 | 
 |
|---|
| 62 | <p>
 |
|---|
| 63 | <b>Userdefined</b><br>
 |
|---|
| 64 | New presets for different purpose can be created/saved in following way. Click on the <btn>Save&nbsp;as...</btn> button, a popup window will appear.<br> Give the new preset a proper <req>name</req> and press then <btn>Ok</btn>(<btn>Cancel</btn> to abort).<br>
 |
|---|
| 65 | Userdefined presets can be manged from <mnu>Manage...</mnu> in the -view/presets- dropdown list on the listpage.
 |
|---|
| 66 | </p></description> |
|---|
| 67 | </helpitem> |
|---|
| 68 | <helpitem externalID="help.edit"> |
|---|
| 69 | <name>Edit help texts</name> |
|---|
| 70 | <description><h4>Properties</h4>
 |
|---|
| 71 | <ul>
 |
|---|
| 72 | <li>
 |
|---|
| 73 | <req>Title</req><br>
 |
|---|
| 74 | 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.
 |
|---|
| 75 | </li>
 |
|---|
| 76 | <li>
 |
|---|
| 77 | <req>External ID</req><br>
 |
|---|
| 78 | 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.
 |
|---|
| 79 | </li>
 |
|---|
| 80 | <li>
 |
|---|
| 81 | <ui>Help text</ui><br>
 |
|---|
| 82 | 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.
 |
|---|
| 83 | </li>
 |
|---|
| 84 | </ul>
 |
|---|
| 85 | Save the helptext item by pressing the <btn>Save</btn> - button or press <btn>Cancel</btn> to discard the changes.
 |
|---|
| 86 | 
 |
|---|
| 87 | <h4>Tools</h4>
 |
|---|
| 88 | The toolbar for text editing contains following buttons that are listed in the table below. 
 |
|---|
| 89 | Mark the text that shall be between the start- and end tag and click on the toolbutton for the wanted function.
 |
|---|
| 90 | <table width=100% border="1" cellpadding="2" style="border-collapse:collapse;">
 |
|---|
| 91 | <tr>
 |
|---|
| 92 | <th width="50" colspan="2">Edit tools</th>
 |
|---|
| 93 | <th>Starttag</th>
 |
|---|
| 94 | <th>Endtag</th>
 |
|---|
| 95 | <th>Description</th>
 |
|---|
| 96 | </tr> 
 |
|---|
| 97 | 
 |
|---|
| 98 | <tr>
 |
|---|
| 99 | <td><btn><img src="/base2/images/text_bold.png"/></btn></td>
 |
|---|
| 100 | <td>-</td>
 |
|---|
| 101 | <td><ui>&lt;b&gt;</ui></td>
 |
|---|
| 102 | <td><ui>&lt;/b&gt;</ui></td>
 |
|---|
| 103 | <td>Bold text</td>
 |
|---|
| 104 | </tr>
 |
|---|
| 105 | 
 |
|---|
| 106 | <tr>
 |
|---|
| 107 | <td><btn><img src="/base2/images/text_italic.png"/></btn></td>
 |
|---|
| 108 | <td>-</td>
 |
|---|
| 109 | <td><ui>&lt;i&gt;</ui></td>
 |
|---|
| 110 | <td><ui>&lt;/i&gt;</ui></td>
 |
|---|
| 111 | <td>Italic text</td>
 |
|---|
| 112 | </tr>
 |
|---|
| 113 | 
 |
|---|
| 114 | <tr>
 |
|---|
| 115 | <td><btn><img src="/base2/images/text_underline.png"/></btn></td>
 |
|---|
| 116 | <td>-</td>
 |
|---|
| 117 | <td><ui>&lt;u&gt;</ui></td>
 |
|---|
| 118 | <td><ui>&lt;/u&gt;</ui></td>
 |
|---|
| 119 | <td>Underlined text</td>
 |
|---|
| 120 | </tr>
 |
|---|
| 121 | 
 |
|---|
| 122 | <tr>
 |
|---|
| 123 | <td><btn><img src="/base2/images/text_h3.png"/></btn></td>
 |
|---|
| 124 | <td>-</td>
 |
|---|
| 125 | <td><ui>&lt;h3&gt;</ui></td> 
 |
|---|
| 126 | <td><ui>&lt;/h3&gt;</ui></td> 
 |
|---|
| 127 | <td>Large header, e.g. new chapter.</td>
 |
|---|
| 128 | </tr>
 |
|---|
| 129 | 
 |
|---|
| 130 | <tr>
 |
|---|
| 131 | <td><btn><img src="/base2/images/text_h4.png"/></btn></td>
 |
|---|
| 132 | <td>-</td>
 |
|---|
| 133 | <td><ui>&lt;h4&gt;</ui></td>
 |
|---|
| 134 | <td><ui>&lt;/h4&gt;</ui></td>
 |
|---|
| 135 | <td>Small header, e.g. new part</td>
 |
|---|
| 136 | </tr>
 |
|---|
| 137 | 
 |
|---|
| 138 | <tr>
 |
|---|
| 139 | <td rowspan="5"><btn><img src="/base2/images/text_style_edit.gif"/></btn></td>
 |
|---|
| 140 | <td><mnu>Important</mnu></td>
 |
|---|
| 141 | <td><ui>&lt;imp&gt;</ui></td>
 |
|---|
| 142 | <td><ui>&lt;/imp&gt;</ui></td>
 |
|---|
| 143 | <td>Marks the text as important. This should be used when the reader should take extra notice.</td>
 |
|---|
| 144 | </tr>
 |
|---|
| 145 | <tr>
 |
|---|
| 146 | <td><mnu>User input</mnu></td>
 |
|---|
| 147 | <td><ui>&lt;ui&gt;</ui></td>
 |
|---|
| 148 | <td><ui>&lt;/ui&gt;</ui></td>
 |
|---|
| 149 | <td>Marks a text to symblize input from user, e.g. textfields</td> 
 |
|---|
| 150 | </tr>
 |
|---|
| 151 | <tr>
 |
|---|
| 152 | <td><mnu>Required</mnu></td>
 |
|---|
| 153 | <td><ui>&lt;req&gt;</ui></td>
 |
|---|
| 154 | <td><ui>&lt;/req&gt;</ui></td>
 |
|---|
| 155 | <td>Marks the text to symlize required input from user.</td>
 |
|---|
| 156 | </tr>
 |
|---|
| 157 | <tr>
 |
|---|
| 158 | <td><mnu>Button text</mnu></td>
 |
|---|
| 159 | <td><ui>&lt;btn&gt;</ui></td>
 |
|---|
| 160 | <td><ui>&lt;/btn&gt;</ui></td>
 |
|---|
| 161 | <td>Text that symbolize a button. This will put a border around the text give it a grey background.</td>
 |
|---|
| 162 | </tr>
 |
|---|
| 163 | <tr>
 |
|---|
| 164 | <td><mnu>Menu text</mnu></td>
 |
|---|
| 165 | <td><ui>&lt;mnu&gt;</ui></td>
 |
|---|
| 166 | <td><ui>&lt;/mnu&gt;</ui></td>
 |
|---|
| 167 | <td>Marks text to symbolize a menu. The text's background will be light grey.</td>
 |
|---|
| 168 | </tr>
 |
|---|
| 169 | 
 |
|---|
| 170 | <tr>
 |
|---|
| 171 | <td rowspan="3"><btn><img src="/base2/images/text_table.png"/></btn></td>
 |
|---|
| 172 | <td><mnu>Table</mnu></td>
 |
|---|
| 173 | <td><ui>&lt;table frame="borders"&gt;</ui></td>
 |
|---|
| 174 | <td><ui>&lt;/table&gt;</ui></td>
 |
|---|
| 175 | <td>Inserts an empty table with a small border around.</td>
 |
|---|
| 176 | </tr>
 |
|---|
| 177 | <tr>
 |
|---|
| 178 | <td><mnu>Row</mnu></td>
 |
|---|
| 179 | <td><ui>&lt;tr&gt;</ui></td>
 |
|---|
| 180 | <td><ui>&lt;/tr&gt;</ui></td>
 |
|---|
| 181 | <td>Inserts a table row. <imp>Need to be inside a table-tag.</imp></td>
 |
|---|
| 182 | </tr>
 |
|---|
| 183 | <tr>
 |
|---|
| 184 | <td><mnu>Cell</mnu></td>
 |
|---|
| 185 | <td><ui>&lt;td&gt;</ui></td>
 |
|---|
| 186 | <td><ui>&lt;/td&gt;</ui></td>
 |
|---|
| 187 | <td>Inserts a table cell. <imp>Need to be inside a table row-tag.</imp></td>
 |
|---|
| 188 | </tr>
 |
|---|
| 189 | 
 |
|---|
| 190 | <tr>
 |
|---|
| 191 | <td rowspan="2"><btn><img src="/base2/images/text_list.gif"/></btn></td>
 |
|---|
| 192 | <td><mnu>Orderded list</mnu></td>
 |
|---|
| 193 | <td><ui>&lt;ol&gt;</ui></td>
 |
|---|
| 194 | <td><ui>&lt;/ol&gt;</ui></td>
 |
|---|
| 195 | <td>An ordered list of items. Each list item has to begin with &lt;li&gt; and end with &lt;/li&gt;.</td>
 |
|---|
| 196 | </tr>
 |
|---|
| 197 | <tr>
 |
|---|
| 198 | <td><mnu>Unorderded list</mnu></td>
 |
|---|
| 199 | <td><ui>&lt;ul&gt;</ui></td>
 |
|---|
| 200 | <td><ui>&lt;/ul&gt;</ui></td>
 |
|---|
| 201 | <td>An unordered list where each list item has to begin with &lt;li&gt; and end with &lt;/li&gt;.</td>
 |
|---|
| 202 | </tr>
 |
|---|
| 203 | 
 |
|---|
| 204 | <tr>
 |
|---|
| 205 | <td><btn><img src="/base2/images/text_newline.gif"/></btn></td>
 |
|---|
| 206 | <td>-</td>
 |
|---|
| 207 | <td><ui>&lt;br&gt;</ui></td>
 |
|---|
| 208 | <td>&nbsp;</td>
 |
|---|
| 209 | <td>Inserts a new line. No end tag is needed</td>
 |
|---|
| 210 | </tr>
 |
|---|
| 211 | 
 |
|---|
| 212 | <tr>
 |
|---|
| 213 | <td><btn><img src="/base2/images/text_paragraph.gif"/></btn></td>
 |
|---|
| 214 | <td>-</td>
 |
|---|
| 215 | <td><ui>&lt;p&gt;</ui></td>
 |
|---|
| 216 | <td><ui>&lt;/p&gt;</ui></td>
 |
|---|
| 217 | <td>Inserts a paragraph in the document.</td>
 |
|---|
| 218 | </tr>
 |
|---|
| 219 | 
 |
|---|
| 220 | <tr>
 |
|---|
| 221 | <td rowspan="4"><btn><img src="/base2/images/text_link.png"/></btn></td>
 |
|---|
| 222 | <td><mnu>Insert helptext</mnu></td>
 |
|---|
| 223 | <td><ui>&#123@include external.id&#125</ui></td>
 |
|---|
| 224 | <td>&nbsp;</td>
 |
|---|
| 225 | <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>
 |
|---|
| 226 | </tr>
 |
|---|
| 227 | <tr>
 |
|---|
| 228 | <td><mnu>External link</mnu></td>
 |
|---|
| 229 | <td><ui>&#123@link external.id linkname&#125</ui></td>
 |
|---|
| 230 | <td>&nbsp;</td>
 |
|---|
| 231 | <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>
 |
|---|
| 232 | </tr>
 |
|---|
| 233 | <tr>
 |
|---|
| 234 | <td><mnu>Internal link</mnu></td>
 |
|---|
| 235 | <td><ui>&lt;a&nbsp;href="#bm_name"&gt;</ui></td>
 |
|---|
| 236 | <td><ui>&lt;/a&gt;</ui></td>
 |
|---|
| 237 | <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>
 |
|---|
| 238 | </tr>
 |
|---|
| 239 | <tr>
 |
|---|
| 240 | <td><mnu>Bookmark</mnu></td>
 |
|---|
| 241 | <td><ui>&lt;a&nbsp;name="bm_name"&gt;</ui></td>
 |
|---|
| 242 | <td><ui>&lt;/a&gt;</ui></td>
 |
|---|
| 243 | <td>Inserts a bookmark in the text. Use the bookmark's name as reference in a internal link.</td>
 |
|---|
| 244 | </tr>
 |
|---|
| 245 | </table></description> |
|---|
| 246 | </helpitem> |
|---|
| 247 | <helpitem externalID="list.filter"> |
|---|
| 248 | <name>Filter</name> |
|---|
| 249 | <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.
 |
|---|
| 250 | <br>
 |
|---|
| 251 | <h4>Clear filter</h4>
 |
|---|
| 252 | The filter can be cleared any time by clicking on <mnu>Clear filter</mnu> in the <mnu>view/preset</mnu> dropdown list.<br>
 |
|---|
| 253 | <h4>Input Formats</h4>
 |
|---|
| 254 | The format that the filter value should be in depends on what kind of column that should be filtered.<br>
 |
|---|
| 255 | 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>
 |
|---|
| 256 | The filter value for date fields shall be in the format that is specified in <mnu>File</mnu> - <mnu>Preferences...</mnu>. <br>
 |
|---|
| 257 | The columns with a dropdown list as a filter field can only be filtered with one of the values availble in the list.<br>
 |
|---|
| 258 | Boolean fields have three options that they can be filtered on: true, false and any(both true and false).<br>
 |
|---|
| 259 | 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>
 |
|---|
| 260 | <h4>Operators</h4>
 |
|---|
| 261 | 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. 
 |
|---|
| 262 | <table width=100% border="1" cellpadding="2" style="border-collapse:collapse;">
 |
|---|
| 263 | <tr>
 |
|---|
| 264 | <th>Operator</th>
 |
|---|
| 265 | <th>Name</th>
 |
|---|
| 266 | <th>Description/result</th>
 |
|---|
| 267 | </tr>
 |
|---|
| 268 | <tr>
 |
|---|
| 269 | <td>=</td>
 |
|---|
| 270 | <td>Equals to</td>
 |
|---|
| 271 | <td>Values that are equal to the filter value are displayed in the list.</td>
 |
|---|
| 272 | </tr>
 |
|---|
| 273 | <tr>
 |
|---|
| 274 | <td><></td>
 |
|---|
| 275 | <td>Not equal to</td>
 |
|---|
| 276 | <td>Values that not are equal to the filter value are displayed in the list.</td>
 |
|---|
| 277 | </tr>
 |
|---|
| 278 | <tr>
 |
|---|
| 279 | <td><</td>
 |
|---|
| 280 | <td>Less then</td>
 |
|---|
| 281 | <td>Values that are less then the filter value are displayed in the list.</td>
 |
|---|
| 282 | </tr>
 |
|---|
| 283 | <tr>
 |
|---|
| 284 | <td><=</td>
 |
|---|
| 285 | <td>Less then or equal</td>
 |
|---|
| 286 | <td>Values that are less then or equal to the filter value are displayed in the list.</td>
 |
|---|
| 287 | </tr>
 |
|---|
| 288 | <tr>
 |
|---|
| 289 | <td>></td>
 |
|---|
| 290 | <td>Greater then</td>
 |
|---|
| 291 | <td>Values that are greater then the filter value are displayed in the list.</td>
 |
|---|
| 292 | </tr>
 |
|---|
| 293 | <tr>
 |
|---|
| 294 | <td>>=</td>
 |
|---|
| 295 | <td>Greater then or equal</td>
 |
|---|
| 296 | <td>Values that are greater then or equal to the filter value are displayed in the list.</td>
 |
|---|
| 297 | </tr>
 |
|---|
| 298 | </table>
 |
|---|
| 299 | 
 |
|---|
| 300 | <h4>Sort order</h4>
 |
|---|
| 301 | Click on the column header on which the list items should be sorted after. Repeat the action to invert the order.<br>
 |
|---|
| 302 | <h4>Wildcards</h4><a name="wildcards"></a>
 |
|---|
| 303 | 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.
 |
|---|
| 304 | <br>
 |
|---|
| 305 | <h4>Presets</h4>
 |
|---|
| 306 | 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> |
|---|
| 307 | </helpitem> |
|---|
| 308 | <helpitem externalID="news.edit"> |
|---|
| 309 | <name>Edit news</name> |
|---|
| 310 | <description><h4>Properties</h4>
 |
|---|
| 311 | <ul>
 |
|---|
| 312 | <li><req>Title</req><br> 
 |
|---|
| 313 | 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>
 |
|---|
| 314 | </li>
 |
|---|
| 315 | <hr>
 |
|---|
| 316 | 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>
 |
|---|
| 317 | Use the date format that is specified in <mnu>File</mnu> - <mnu>Preferences...</mnu><br><br>
 |
|---|
| 318 | <li>
 |
|---|
| 319 | <req>Start date</req><br> 
 |
|---|
| 320 | 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>.
 |
|---|
| 321 | </li>
 |
|---|
| 322 | <li>
 |
|---|
| 323 | <req>News date</req><br> 
 |
|---|
| 324 | 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>. 
 |
|---|
| 325 | </li>
 |
|---|
| 326 | <li>
 |
|---|
| 327 | <ui>End date</ui><br> 
 |
|---|
| 328 | 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.
 |
|---|
| 329 | </li>
 |
|---|
| 330 | <hr>
 |
|---|
| 331 | <li>
 |
|---|
| 332 | <ui>Description</ui><br>
 |
|---|
| 333 | 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.
 |
|---|
| 334 | </li>
 |
|---|
| 335 | </ul>
 |
|---|
| 336 | Click on <btn>Save</btn> button to save the news or <btn>Cancel</btn> to abort and discard the changes.</description> |
|---|
| 337 | </helpitem> |
|---|
| 338 | <helpitem externalID="user.edit"> |
|---|
| 339 | <name>Edit user</name> |
|---|
| 340 | <description><h4>Properties</h4>
 |
|---|
| 341 | This is one of three tabs where the information about an user account can be edit. The other two are Contact information and Membership.
 |
|---|
| 342 | <ul>
 |
|---|
| 343 | <li>
 |
|---|
| 344 | <req>Name</req><br>
 |
|---|
| 345 | The full name of the user that is associated with this account.
 |
|---|
| 346 | </li>
 |
|---|
| 347 | 
 |
|---|
| 348 | <li>
 |
|---|
| 349 | <req>Login</req><br>
 |
|---|
| 350 | The login name to use together with a password for login/access and identification in BASE.<br>
 |
|---|
| 351 | <imp>The login must be unique for each user.</imp>
 |
|---|
| 352 | </li>
 |
|---|
| 353 | 
 |
|---|
| 354 | <li>
 |
|---|
| 355 | <ui>External&nbsp;ID</ui><br>
 |
|---|
| 356 | This field can be used if the users has external ids to be identified with. <imp>An external id must be unique for each user.</imp>
 |
|---|
| 357 | </li>
 |
|---|
| 358 | 
 |
|---|
| 359 | <li>
 |
|---|
| 360 | <req>New&nbsp;password</req><br>
 |
|---|
| 361 | Password to use together with the login. Mix at least 6 upper- and lower-case letters together with numbers for a secure password.<br>
 |
|---|
| 362 | It's only necessary to fill in this field for new user accounts.<br>
 |
|---|
| 363 | <imp>Not filling in a password for an already existing account will leave the password unchanged.</imp>
 |
|---|
| 364 | </li>
 |
|---|
| 365 | 
 |
|---|
| 366 | <li>
 |
|---|
| 367 | <ui>Retype&nbsp;password</ui><br>
 |
|---|
| 368 | Retype the new password in this field to be sure it's saved right.
 |
|---|
| 369 | </li>
 |
|---|
| 370 | 
 |
|---|
| 371 | <li>
 |
|---|
| 372 | <req>Quota</req><br>
 |
|---|
| 373 | This sets how large diskspace the user account should be able to use on the BASE-server. Select one option from the drop down-list of qoutas.
 |
|---|
| 374 | </li>
 |
|---|
| 375 | 
 |
|---|
| 376 | <li>
 |
|---|
| 377 | <mnu>Quota&nbsp;group</mnu><br>
 |
|---|
| 378 | A quota group has a limit of total quota in the group. Select a group from the drop down-list quota groups if the account should be apart of such group.<br>
 |
|---|
| 379 | See the help text about {@link group.edit edit&nbsp;groups} for more information about quota groups.
 |
|---|
| 380 | </li>
 |
|---|
| 381 | 
 |
|---|
| 382 | <li>
 |
|---|
| 383 | <mnu>Home&nbsp;directory</mnu><br>
 |
|---|
| 384 | This is where the files for this account should be put by default. <mnu>-Create new-</mnu> or <mnu>-create new from template-</mnu> will create a new file directory for the account. The second option will also create some default sub directories. Instead of creating a new directory it's possible to choose from already existing home directories of other users or not to have a home directory at all, <mnu>-none-</mnu>.
 |
|---|
| 385 | </li>
 |
|---|
| 386 | 
 |
|---|
| 387 | <li>
 |
|---|
| 388 | <ui>Expiration&nbsp;date</ui><br>
 |
|---|
| 389 | After the epiration date of an account it is not longer possible to login/use it. Fill in this field if the account should be valid until a certain date.<br>
 |
|---|
| 390 | Write the date in the format that is specified under <mnu>File</mnu>-<mnu>Preferences...</mnu>. Use the <btn>Calender</btn> button to pick a date with the mouse.
 |
|---|
| 391 | </li>
 |
|---|
| 392 | 
 |
|---|
| 393 | <li>
 |
|---|
| 394 | <ui>Multi-user&nbsp;account</ui><br>
 |
|---|
| 395 | This checkbox should be checked if there are more then one user to an account. This will make it impossible for a user to change personal preferences such as password, contact information or description.
 |
|---|
| 396 | </li>
 |
|---|
| 397 | 
 |
|---|
| 398 | <li>
 |
|---|
| 399 | <ui>Disabled</ui><br>
 |
|---|
| 400 | Tick this checkbox to disable the account. If an account is disabled it's not possible to login on that account.
 |
|---|
| 401 | </li>
 |
|---|
| 402 | 
 |
|---|
| 403 | </ul>
 |
|---|
| 404 | 
 |
|---|
| 405 | <h4>See also</h4>
 |
|---|
| 406 | <ul>
 |
|---|
| 407 | <li>{@link user.edit.contact Contact&nbsp;information}</li>
 |
|---|
| 408 | <li>{@link user.edit.membership Membership}</li>
 |
|---|
| 409 | </ul></description> |
|---|
| 410 | </helpitem> |
|---|
| 411 | <helpitem externalID="user.edit.contact"> |
|---|
| 412 | <name>Edit user's contact information</name> |
|---|
| 413 | <description>This tab holds information about how to contact the user. No properties on this tab are required to be able to save the user information.
 |
|---|
| 414 | 
 |
|---|
| 415 | <h4>Properties</h4>
 |
|---|
| 416 | <ul>
 |
|---|
| 417 | 
 |
|---|
| 418 | <li>
 |
|---|
| 419 | <ui>Email</ui><br>
 |
|---|
| 420 | The email is validated before it's saved and need to have at least one letter before '@' and at least one sub domain and top domain after to pass.
 |
|---|
| 421 | </li>
 |
|---|
| 422 | 
 |
|---|
| 423 | <li>
 |
|---|
| 424 | <ui>Organisation</ui><br>
 |
|---|
| 425 | Organisation/company that the user belongs to.
 |
|---|
| 426 | </li>
 |
|---|
| 427 | 
 |
|---|
| 428 | <li>
 |
|---|
| 429 | <ui>Address</ui><br>
 |
|---|
| 430 | Write the mail address of the user here. Click on the magnifying glass to the right for a larger window to edit in.
 |
|---|
| 431 | </li>
 |
|---|
| 432 | 
 |
|---|
| 433 | <li>
 |
|---|
| 434 | <ui>Phone</ui><br>
 |
|---|
| 435 | User's phone number.
 |
|---|
| 436 | </li>
 |
|---|
| 437 | 
 |
|---|
| 438 | <li>
 |
|---|
| 439 | <ui>Fax</ui><br>
 |
|---|
| 440 | The user's fax number, if she/he has any, should be put here.
 |
|---|
| 441 | </li>
 |
|---|
| 442 | 
 |
|---|
| 443 | <li>
 |
|---|
| 444 | <ui>Url</ui><br>
 |
|---|
| 445 | URL associated to the user.
 |
|---|
| 446 | </li>
 |
|---|
| 447 | 
 |
|---|
| 448 | <li>
 |
|---|
| 449 | <ui>Description</ui><br>
 |
|---|
| 450 | More information that can be of importance. Click on the magnifying glass to the right for a larger window to edit in.
 |
|---|
| 451 | </li>
 |
|---|
| 452 | 
 |
|---|
| 453 | </ul>
 |
|---|
| 454 | 
 |
|---|
| 455 | <h4>See also</h4>
 |
|---|
| 456 | <ul>
 |
|---|
| 457 | <li>{@link user.edit Edit user's account information}</li>
 |
|---|
| 458 | <li>{@link user.edit.membership Edit user's membership}</li>
 |
|---|
| 459 | <li>{@link userpreferences.contact Edit login user's preferences}</li>
 |
|---|
| 460 | </ul></description> |
|---|
| 461 | </helpitem> |
|---|
| 462 | <helpitem externalID="user.edit.membership"> |
|---|
| 463 | <name>Edit user's membership</name> |
|---|
| 464 | <description><h4>Membership</h4>
 |
|---|
| 465 | <p>An user can have membership in none or several groups and roles.<br>
 |
|---|
| 466 | As a member in a group the user will have access to those items that are shared to the group.<br> A membership in a role gives the user those permissions that are assigned to the role.<br>
 |
|---|
| 467 | Which groups and roles the user is a member of are listed in the listbox under seperate headlines.<br><br>
 |
|---|
| 468 | </p>
 |
|---|
| 469 | 
 |
|---|
| 470 | <b>New membership</b><br>
 |
|---|
| 471 | Press one of the <btn>Add groups...</btn> or the <btn>Add roles...</btn> button to open a popup window that contains a list of either groups or roles(depending on which button that was pressed) that are possible to add. Select one or several items from the list and press then <btn>Ok</btn> to procced and to close the popup window.<br>
 |
|---|
| 472 | The selected items are added to the listbox.
 |
|---|
| 473 | <br><br>
 |
|---|
| 474 | 
 |
|---|
| 475 | <b>Remove membership</b><br>
 |
|---|
| 476 | Memberships in groups or roles are removed by selecting the groups/roles in the listbox and then pressing the <btn>Remove</btn> button.<br>
 |
|---|
| 477 | 
 |
|---|
| 478 | <h4>See also</h4>
 |
|---|
| 479 | <ul>
 |
|---|
| 480 | <li>
 |
|---|
| 481 | {@link user.edit Edit&nbsp;user}
 |
|---|
| 482 | </li>
 |
|---|
| 483 | 
 |
|---|
| 484 | <li>
 |
|---|
| 485 | {@link user.edit.contact Edit&nbsp;contact&nbsp;information}
 |
|---|
| 486 | </li>
 |
|---|
| 487 | 
 |
|---|
| 488 | <li>
 |
|---|
| 489 | Groups
 |
|---|
| 490 | </li>
 |
|---|
| 491 | 
 |
|---|
| 492 | <li>
 |
|---|
| 493 | Roles
 |
|---|
| 494 | </li>
 |
|---|
| 495 | </ul></description> |
|---|
| 496 | </helpitem> |
|---|
| 497 | </helptexts> |
|---|
