Changes between Version 17 and Version 18 of doc/net.sf.basedb.meludi.usermanual_start


Ignore:
Timestamp:
Dec 2, 2016, 11:14:58 AM (4 years ago)
Author:
olle
Comment:

Added information on step forms

Legend:

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

    v17 v18  
    106106
    107107 [[Image(MeLuDI_002_specimen_tube_registration_page_SMIL_steps_01-02_01_80_pct.png)]]
    108 
    109108Figure 2.2. Specimen tube registration wizard steps 1-2
    110109
     
    117116 5. Previous steps might be collapsed to save space, only showing the step number bar.
    118117
     118 [[Image(MeLuDI_002a_step_numbers_01.png)]]
     119Figure 2.3. Steps number bar with step numbers.
     120
     121
     122===== 2.2.2.1 Active and inactive (disabled) steps =====
    119123The active step is indicated by the step number bar being dark blue.
    120124An inactive step is indicated by the step number bar being gray.
    121125
    122126 [[Image(MeLuDI_002a_steps_01-02_step_01_disabled_01.png)]]
    123 Figure 2.3. Steps 1 and 2 of the specimen registration wizard. Step 2 is active, while step 1 is disabled.
    124 
    125 ==== 2.2.3 Collapsed steps ====
     127Figure 2.4. Steps 1 and 2 of the specimen registration wizard. Step 2 is active, while step 1 is disabled.
     128
     129===== 2.2.2.2 Collapsed steps =====
    126130
    127131 1. Only disabled steps can be collapsed, the active step is always expanded.
     
    131135
    132136 [[Image(MeLuDI_002a_steps_01-02_step_01_collapsed_01.png)]]
    133 Figure 2.4. Step 1 is here collapsed.
    134 
    135 ==== 2.2.4 Cancel and Next buttons ====
     137Figure 2.5. Step 1 is here collapsed.
     138
     139==== 2.2.3 Step forms ====
     140
     141Most step forms contain four columns:
     142 1. Input item title.
     143 2. Input field/menu/checkbox.
     144 3. Input status (icon: blank, OK, Error).
     145 4. Input item description/error message.
     146
     147The status information normally covers errors that can be detected without referencing the database, e.g. if an item name has correct prefix + number of digits, a number is in allowed range, a date has correct format, a personal number is consistent with the control digit (last digit in number), etc.
     148
     149 [[Image(MeLuDI_002a1_step_02_ok_status_and_message_01_80_pct.png)]]
     150Figure 2.6. Step form rows for PAD/CL and Number of tubes. Status OK for Number of tubes.
     151
     152 [[Image(MeLuDI_002a2_step_02_error_status_and_message_01_80_pct.png)]]
     153Figure 2.7. Step form rows for PAD/CL and Number of tubes. Status error for Number of tubes (value = 0).
     154
     155==== 2.2.4 Buttons and registration messages ====
     156===== 2.2.4.1 Cancel and Next buttons =====
    136157
    137158Wizard steps except the last normally have a "Cancel" and "Next" button at the bottom.
     
    143164
    144165 [[Image(MeLuDI_002b_cancel_next_buttons_01.png)]]
    145 Figure 2.5. "Cancel" and "Next" buttons.
    146 
    147 ==== 2.2.5 Cancel and Register buttons ====
     166Figure 2.8. "Cancel" and "Next" buttons.
     167
     168===== 2.2.4.2 Cancel and Register buttons =====
    148169
    149170The last wizard step has a "Register" button instead of a "Next" button.
     
    152173
    153174 [[Image(MeLuDI_002c_cancel_register_buttons_01.png)]]
    154 Figure 2.6. "Cancel" and "Register" buttons.
    155 
    156 ==== 2.2.6 Registration messages and Restart button ====
     175Figure 2.9. "Cancel" and "Register" buttons.
     176
     177===== 2.2.4.3 Registration messages and Restart button =====
    157178
    158179After registration, one or more messages may be shown at the bottom of the page, together with a "Restart" button.
     
    161182
    162183 [[Image(MeLuDI_002e_registration_messages_and_restart_button_01.png)]]
    163 Figure 2.7. Registration messages and "Restart" button.
     184Figure 2.10. Registration messages and "Restart" button.
    164185
    165186''Note'': If you want to leave the wizard, don't click the "Restart" button; click the MeLuDI extension name at the upper left.
    166187
    167 ==== 2.2.7 Error messages ====
     188==== 2.2.5 Error messages ====
    168189
    169190If an error occurs when the "Next" button is clicked, an error message is shown in a red text area at the bottom. This is typically errors that only are detected when addressing the database. Don't be intimidated by the sinister look of the message; normally the first part might be instructive. The rest is technical information, that may be useful, if an error in the server or program itself has been found.
    170191
    171192 [[Image(MeLuDI_002g_specimen_tube_registration_page_SMIL_step_01_with_error_message_01_short_80_pct.png)]]
    172 Figure 2.8. Step 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.
     193Figure 2.11. Step 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.
    173194
    174195A very common error message is information that no appropriate items exist as input for a wizard:
    175196
    176197 [[Image(MeLuDI_002g2_create_new_start_dna_plate_page_SMIL_step_01_with_error_message_01.png)]]
    177 Figure 2.9. Step 1 of the create new start DNA plate wizard, when no suitable input items exist (here start lists).
     198Figure 2.12. Step 1 of the create new start DNA plate wizard, when no suitable input items exist (here start lists).
    178199
    179200=== 2.3 Wizard pages and some standard input elements ===
     
    187208
    188209 [[Image(MeLuDI_002j_pad_and_number_of_tubes_input_fields_01.png)]]
    189 Figure 2.10. PAD/CL and Number of tubes input fields. The Number of tubes field is required, and has a default suggestion.
     210Figure 2.13. PAD/CL and Number of tubes input fields. The Number of tubes field is required, and has a default suggestion.
    190211
    191212==== 2.3.2 Date input fields ====
     
    195216
    196217 [[Image(MeLuDI_002k_arrival_date_and_sampling_date_input_fields_01.png)]]
    197 Figure 2.11. Arrival date and Sampling date input fields with calendar icons. The Arrival date field has today's date entered as default.
     218Figure 2.14. Arrival date and Sampling date input fields with calendar icons. The Arrival date field has today's date entered as default.
    198219
    199220 [[Image(base_calendar_dialog_01_80_pct.png)]]
    200 Figure 2.12. A BASE calendar dialog. Click on a date to select it. Use arrow at top to change month and year.
     221Figure 2.15. A BASE calendar dialog. Click on a date to select it. Use arrow at top to change month and year.
    201222
    202223==== 2.3.3 User permissions and wizards and results pages ====
     
    208229
    209230 [[Image(MeLuDI_002j_pad_and_number_of_tubes_input_fields_02_pad_field_disabled.png)]]
    210 Figure 2.13. PAD/CL and Number of tubes input fields. The PAD/CL field is disabled, as the user does not have `PatientCurator` permission.
     231Figure 2.16. PAD/CL and Number of tubes input fields. The PAD/CL field is disabled, as the user does not have `PatientCurator` permission.
    211232
    212233== Next: [wiki:net.sf.basedb.meludi.usermanual_03_case_registration 3 Case registration] ==