2 Eloquence ASCII Windows

Help Subsystem

The Eloquence dialog subsystem supports online help.

Each time a function key with an associated .f1...f8 attribute value of -1, or if not defined otherwise, the f1 function key or an object with a rule value of -1 is executed, the help subsystem will be activated.

Each object supports an optional help attribute. If the help attribute of the current object is defined, its value will be used as the help tag (lookup value) in the help file. If no help attribute is defined, the help tag of the object's parent is used, or, if that is not defined, the help tag of the object's parent's parent, and so on.

So if the help subsystem is activated, it will first check for a context specific help tag, and then up the object hierarchy for at least a dialog-specific one. If no help tag can be located, you will hear a beep.

The layout of the help dialog must be specified by the application programmer. So you are free to define whatever you like. Only a few guidelines must be followed. A template file is explained below.

After loading the Help dialog you have to specify the helpfile name.

A help window consists of a box and several pushbuttons.

 
Button Results in
CLOSEClose help dialog
RETURNReturn to previous help tag
 Continue help dialog with the previous help tag
 Continue help dialog with the next help tag
HELPShow help on the help window

The buttons RETURN, <<, and >> are invisible if not applicable. The help window contains the help text, and if defined, some text references which are displayed underlined.

If you move the cursor to a text reference, it becomes selected (reverse display). Pressing Return continues the help dialog with the associated help tag.

Using Spacebar and Backspace you could move to the next/previous embedded text reference.


Eloquence Dialog Manual - 19 DEC 2002