Changes between Version 10 and Version 11 of doc/net.sf.basedb.meludi.usermanual_start


Ignore:
Timestamp:
Dec 1, 2016, 1:32:46 PM (4 years ago)
Author:
olle
Comment:

Added information on MeLuDI wizard input elements

Legend:

Unmodified
Added
Removed
Modified
  • doc/net.sf.basedb.meludi.usermanual_start

    v10 v11  
    9494The number of shown sections on the start page depends on the permissions of the logged-in user, as only sections the user is allowed to use are shown. The example above shows all sections, as the logged-in user is `root`, i.e. system administrator. The "Server administrator wizards" section is only visible for a system administrator, and the "Personal information wizards" section is only visible for a system administrator and users belonging to the `PatientCurator` group.
    9595
    96 === 2.2 Wizard page and some key components ===
     96=== 2.2 Wizard pages and some key components ===
    9797
    9898==== 2.2.1 Wizard page example and key elements ====
     
    114114
    115115 [[Image(MeLuDI_002a_steps_01-02_step_01_disabled_01.png)]]
    116 Figure 2.3 Steps 1 and 2 of the specimen registration wizard. Step 2 is active, while step 1 is disabled.
     116Figure 2.3. Steps 1 and 2 of the specimen registration wizard. Step 2 is active, while step 1 is disabled.
    117117
    118118==== 2.2.3 Collapsed steps ====
     
    124124
    125125 [[Image(MeLuDI_002a_steps_01-02_step_01_collapsed_01.png)]]
    126 Figure 2.4 Step 1 is here collapsed.
     126Figure 2.4. Step 1 is here collapsed.
    127127
    128128==== 2.2.4 Cancel and Next buttons ====
     
    136136
    137137 [[Image(MeLuDI_002b_cancel_next_buttons_01.png)]]
    138 Figure 2.5 "Cancel" and "Next" buttons.
     138Figure 2.5. "Cancel" and "Next" buttons.
    139139
    140140==== 2.2.5 Cancel and Register buttons ====
     
    145145
    146146 [[Image(MeLuDI_002c_cancel_register_buttons_01.png)]]
    147 Figure 2.6 "Cancel" and "Register" buttons.
     147Figure 2.6. "Cancel" and "Register" buttons.
    148148
    149149==== 2.2.6 Registration messages and Restart button ====
     
    154154
    155155 [[Image(MeLuDI_002e_registration_messages_and_restart_button_01.png)]]
    156 Figure 2.7 Registration messages and "Restart" button.
     156Figure 2.7. Registration messages and "Restart" button.
    157157
    158158''Note'': If you want to leave the wizard, don't click the "Restart" button; click the MeLuDI extension name at the upper left.
     
    163163
    164164 [[Image(MeLuDI_002g_specimen_tube_registration_page_SMIL_step_01_with_error_message_01_short_80_pct.png)]]
    165 Figure 2.8 Steps 1 of the specimen registration wizard after the "Next" button has been clicked and an error occurred, here the case number has already been registered for another item.
     165Figure 2.8. Steps 1 of the specimen registration wizard after the "Next" button has been clicked and an error occurred, here the case number has already been registered for another item.
    166166
    167 Below is a description of some of the key elements, that are components of most of the wizards.
     167=== 2.3 Wizard pages and some standard input elements ===
     168
     169Wizards make use of most standard input elements in web pages, e.g. text input fields, menus, check boxes, etc. This section only contains comments on some of them.
     170
     171==== 2.3.1 Required and optional text input fields ====
     172
     173 1. Required text input fields have blue background. A required field is not allowed to be empty.
     174 2. Optional text input fields have white background.
     175
     176 [[Image(MeLuDI_002j_pad_and_number_of_tubes_input_fields_01.png)]]
     177Figure 2.9. PAD/CL and Number of tubes input fields. The Number of tubes field is required, and has a default suggestion.
     178
     179==== 2.3.2 Date input fields ====
     180
     181 1. Date input fields are text input fields, but normally have a calendar icon to the right ([[Image(MeLuDI_002i_calendar_button_02.png)]]).
     182 2. Clicking on a calendar button makes a BASE calendar dialog appear.
     183
     184 [[Image(MeLuDI_002k_arrival_date_and_sampling_date_input_fields_01.png)]]
     185Figure 2.10. Arrival date and Sampling date input fields with calendar icons. The Arrival date field has today's date entered as default.
     186
     187 [[Image(base_calendar_dialog_01_80_pct.png)]]
     188Figure 2.11. A BASE calendar dialog. Click on a date to select it. Use arrow at top to change month and year.
    168189
    169190==== 2.3.3 User permissions and wizards and results pages ====
     191
     192If a user has permission to use a wizard, normally all elements of it are accessible. However, there are some exceptions related to patient data:
     193
     194 1. When registering a new case without (full) patient information, the PAD/CL input field is disabled, if the user does not belong to the `PatientCurator` group.
     195 2. On the Case Summary page, all personal patient information is hidden by default (patient item number, registration date, and gender are shown), and can only be displayed if the user clicks on check box "Show confidential information" and belongs to the `PatientCurator` group.
     196
     197 [[Image(MeLuDI_002j_pad_and_number_of_tubes_input_fields_02_pad_field_disabled.png)]]
     198Figure 2.12. PAD/CL and Number of tubes input fields. The PAD/CL field is disabled, as the user does not have `PatientCurator` permission.