next up previous contents index
Next: Interacting with the Operating Up: The GUI (``Graphics-User-Interface'') Mode Previous: Actions and Buttons in   Contents   Index

Help file structure

Command GUI$\backslash$PANEL allows to associate an help file to the main window or detached menus, and command GUI$\backslash$BUTTON does the same for optional windows.

The HELP files format should be

      1 Description
          General help for the window or menu
      2 NAME1
          help for variable NAME1
      2 NAME2
          help for variable NAME2
      1 ENDOFHELP
where 1 and 2 are in the first column of the text file, and followed by a single space.

Clicking on the HELP button will display the complete help file in a scrolled window. Clicking in the prompt area of an input variable will display the associated variable name and the help for this variable (if it exists).



Gildas manager 2014-07-01