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

Timestamp:

Dec 1, 2016, 11:58:45 AM (8 years ago)

Author:

olle

Comment:

Added information on MeLuDI wizard compnents

doc/net.sf.basedb.meludi.usermanual_start

@@ -104 +104 @@
 ==== 2.2.2 Wizard steps ====
 
- [[Image()]]
+ 1. Wizards are divided into steps, which are shown in sequence. The step number is shown to the left.
+ 2. When the wizard is entered, only step 1 is shown.
+ 3. A new step is only shown after the user clicks the "Next" button to continue to the next step.
+ 4. Only the last step is active. Previous steps are shown, but input fields are disabled.
+ 5. Previous steps might be collapsed to save space, only showing the step number bar.
 
-==== 2.2.3 Cancel and Next buttons ====
+The active step is indicated by the step number bar being dark blue.
+An inactive step is indicated by the step number bar being gray.
 
- [[Image()]]
+ [[Image(MeLuDI_002a_steps_01-02_step_01_disabled_01.png)]]
+Figure 2.3 Steps 1 and 2 of the specimen registration wizard. Step 2 is active, while step 1 is disabled.
 
-==== 2.2.4 Cancel and Registration buttons ====
+==== 2.2.3 Collapsed steps ====
 
- [[Image()]]
+ 1. Only disabled steps can be collapsed, the active step is always expanded.
+ 2. A step is collapsed, if the wizard finds that there is not enough space to show details of the step.
+ 3. A step is collapsed, if the user clicks on the step number bar to the left of an expanded step.
+ 4. A step is expanded, if the user clicks on the step number bar to the left of a collapsed step.
 
-==== 2.2.5 Registration messages and Restart button ====
+ [[Image(MeLuDI_002a_steps_01-02_step_01_collapsed_01.png)]]
+Figure 2.4 Step 1 is here collapsed.
 
- [[Image()]]
+==== 2.2.4 Cancel and Next buttons ====
 
- [[Image()]]
+Wizard steps except the last normally have a "Cancel" and "Next" button at the bottom.
 
- [[Image()]]
+ 1. Clicking the "Cancel" button makes the wizard start with step 1 again.
+ 2. Clicking the "Next" button makes the wizard continue to the next step.
+
+''Note'': If you want to leave the wizard, don't click the "Cancel" button; click the MeLuDI extension name at the upper left.
+
+ [[Image(MeLuDI_002b_cancel_next_buttons_01.png)]]
+Figure 2.5 "Cancel" and "Next" buttons.
+
+==== 2.2.5 Cancel and Register buttons ====
+
+The last wizard step has a "Register" button instead of a "Next" button.
+
+ 1. Clicking the "Register" button makes the wizard register the entered data in the BASE database.
+
+ [[Image(MeLuDI_002c_cancel_register_buttons_01.png)]]
+Figure 2.6 "Cancel" and "Register" buttons.
+
+==== 2.2.6 Registration messages and Restart button ====
+
+After registration, one or more messages may be shown at the bottom of the page, together with a "Restart" button.
+
+ 1. Clicking the "Restart" button makes the wizard start with step 1 again, ready for a new data entry.
+
+ [[Image(MeLuDI_002e_registration_messages_and_restart_button_01.png)]]
+Figure 2.7 Registration messages and "Restart" button.
+
+''Note'': If you want to leave the wizard, don't click the "Restart" button; click the MeLuDI extension name at the upper left.
+
+==== 2.2.7 Error messages ====
+
+If 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.
+
+ [[Image(MeLuDI_002g_specimen_tube_registration_page_SMIL_step_01_with_error_message_01_short_80_pct.png)]]
+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.
 
 Below is a description of some of the key elements, that are components of most of the wizards.
 
-==== 2.2.3 User permissions and wizards and results pages ====
+==== 2.3.3 User permissions and wizards and results pages ====