Doc/parametrer_une_commande.rst

   1 .. _form-label:
   2
   3 ===============
   4 Edit a command
   5 ===============
   6
   7 Each command has to be setted up. Eficas generates a data entry form.
   8 This form varies dynamicaly, depending on the context : rules and already existing values.
   9
  10 This widget appears by selecting (clicking) on a command (first level in the tree view).
  11
  12 .. image:: images/DoubleFleche.png
  13    :align: right
  14
  15 You can navigate from command to command using the arrows buttons:
  16
  17
  18 The command widget
  19 --------------------
  20
  21 this widget is divided vertically into three separate areas :
  22    - the tree view,
  23    - the form widget
  24    - the optional keywords.
  25
  26 When needed, views provide scrollbar so that the entire information can be viewed.
  27
  28 A bottom widget provides a horizontal bar for presenting documentation as the status bar  is used to display error or warning messages.
  29
  30 .. image:: images/Main.png
  31    :align: center
  32
  33 |
  34 |
  35
  36 Edit values
  37 -------------
  38
  39 Eficas uses many different widgets in order to help you to choose values :
  40
  41 - Line editors for simple values
  42 - Entry lists widgets
  43 - Popup lists
  44 - Group boxes of button
  45
  46 see :ref:`features-label` to know more about each widget.
  47
  48
  49 .. image:: images/Erreur.png
  50    :align: center
  51 Eficas does not let you enter invalid values. It checks the type and the cardinality of the value.
  52 It ensures that the value is in the value domain or proposes  a set of discrete values.
  53 Data entered is checked against a set of rules. Errors are displayed in red to draw attention.
  54
  55
  56 Form construction is dynamic
  57 ----------------------------
  58
  59 The form is updated according to values. It asks for the field depending on what's selected.
  60
  61 In the example below:
  62
  63 - if value of 'Initial_Conditions' is 'Zero Elevation', no additional data is needed
  64
  65 .. image:: images/Zero.png
  66    :align: center
  67
  68 - if value of 'Initial_Conditions' is 'TPXO satellite altimetry', you have to fill 'Ascii_Database_For_Tide'
  69
  70 .. image:: images/TPXO.png
  71    :align: center
  72
  73 Displaying optional keyword
  74 ------------------------------
  75
  76 When you create a new command, the widget opens with the optional keywords of this command.
  77
  78 .. image:: images/OptionnelCommande.png
  79    :align: center
  80
  81 When entering in a "group keyword", the optional keywords list is updated to show optional keyword for this specific "group keyword".
  82
  83 .. image:: images/OptionnelCommande1.png
  84    :align: center
  85
  86
  87 By clicking on command label ("INITIALIZATION") or on keyword label ("Input_files"), the corresponding optional keywords list is displayed.
  88
  89 Sometimes, when a user enters a value for a keyword, optional keywords  are dependents on this value. Optional keywords list is updated.
  90 This is the case for conditionnal keywords
  91
  92 .. image:: images/OptionnelParametersAdao.png
  93    :align: center
  94
  95
  96 .. image:: images/OptionnelParametersAdao1.png
  97    :align: center
  98
  99 Adding/Deleting an optional keyword
 100 ------------------------------------
 101
 102 Optional keywords (if any) are in the right part of the "command window". Just double-click on the checkbox to add the keyword.
 103 The input data form is redisplayed and the list of possible optional keywords will be updated (for example, if two keywords cannot be simultaneously present).
 104
 105 .. image:: images/DblClickOnOptional.png
 106    :align: center
 107
 108 .. image:: images/Poubelle.png
 109    :align: right
 110 To delete a keyword (or a command), just click the garbage icon :
 111
 112 |
 113 Naming Concepts
 114 ---------------
 115
 116 The icon for a command may be one of three colors: green, yellow or red. These colors represent the status of the command and the color meanings is :
 117  - red for unvalid command,
 118  - green for valid command,
 119  - yellow for commands which have to be named.
 120
 121 .. image:: images/NommerObjet.png
 122    :align: center
 123
 124 Tooltips
 125 --------
 126
 127 **Use tooltips to have information.**
 128
 129 - Tooltips on **labels** display **information about the keyword**. Double-click on the label to display this information in the comment area, at the bottom of the window. This is useful for long text. *(You also can double-click on the keyword in the tree dataset.)*
 130
 131 .. image:: images/ToolTipOnLabel.png
 132    :align: center
 133
 134 - Tooltips on **lineEdit** (one-line text editor) display **suggestion** for the input value. Suggestion are not very frequent. They are not default values, because you have to enter it explicitely.
 135
 136 .. image:: images/ToolTipOnLineEdit.png
 137    :align: center
 138
 139 - Tooltips on **Red point**  display **information about the validity** for the keyword or for the group of keywords.
 140 By double-clicking on the "red point" a window displaying the same information appears. It should be usefull if text
 141 is too long to be read at one sitting.
 142
 143 .. image:: images/ToolTipOnRed.png
 144    :align: center
 145
 146 - Tooltips on **Commands Button**  explain what the icon/button represents, and which action is activated by clicking.
 147
 148 .. image:: images/ToolTipOnButton.png
 149    :align: center
 150
 151
 152 Context Menus
 153 --------------
 154 In the dataset tree, context menus  (invoked by right-clicking) allow user to :
 155
 156 - create comments in the tree
 157 - create parameter
 158 - comment the command itself
 159 - delete the node
 160
 161 .. image:: images/Menus.png
 162    :align: center
 163
 164 Some commands have associated scripts. They are easy to identify because the "run" icon is present :
 165
 166 .. image:: images/Roue.png
 167    :align: right
 168
 169
 170 .. image:: images/Scripts.png
 171    :align: center