*******************
User Interface Help
*******************

Brief on line help is available for ALL menu and gadget functions, even
within sub-systems of the program e.g. Find/Replace, Colour Selection, and
the Debugger.

This help can be obtained by entering HELP mode and then selecting any
menu or control button.

To enter HELP mode, either:

1. Select the menu Help option.

2. Press the <Help> key.

3. Press the on screen HELP gadget (if it is visible).

To get help on "hidden" control panels such as the "debug control panel",
or the "colour control panel", simply activate the panel and then press
the <Help> key to enter HELP mode.

***************
Vocabulary HELP
***************

There is a user definable vocabulary help system which brings up short help
texts on the word under the cursor.

The help display is deliberately kept small, with the intention of reducing
verbosity and forcing the help to be short and easily assimilable.  The
idea is not to provide an essay but short and precise useful information.

Single target words are matched with the word under the cursor when
vocabulary help is invoked, and the associated text in the help file is
presented in the Helios help display.

Vocabulary help can consist of up to TWO pages.  The HeliOS software will
auto-check and inform the user if a second page of help is available.

The target word matching is NOT case sensitive, and to select this function
just place the cursor within the word on which you want help, and either

1. Select the menu option.

2. Press <Ctrl>+<Help> on the keyboard.

3. Hold down <Ctrl> while pressing the HELP screen gadget.

The user definable help file is in simple ASCII format, and the startup
default is usually read from a file called "HeliOS_VocabularyHelp" in the
"S:" directory (or the HELIOS: directory if defined).

See the documentaion on InitialSetup for details on setting up a default
file to be auto-loaded at startup.

Vocabulary help files, can be edited using any ASCII text editor.

You may create several help files if you wish, and load each one as
required, but only one Vocabulary help file may be loaded at any time.

The example help file provided itself contains full instructions for 
user additions, but here is a brief description of how to create, or
add to, vocabulary help files:


*****************************************
Creating or Editing Vocabulary Help files
*****************************************


Each entry in the file must be of the following format:

Firstly, a line starting with "{{" containing the target word....

{{TARGETWORD&
^^
This signifies the start of an entry, and should be followed by the
target word....

{{TARGETWORD&
  ^^^^^^^^^^
This target word will be matched to the word under the cursor when
you invoke vocabulary help.  Only the single SPACE delimited word under
the cursor will be used for matching purposes, so your target word should
also be a single word without spaces.

{{TARGETWORD&
            ^
This "&" signifies the end of a line of the first page of help text, and
should be placed immediately after the target word and at the end of each
subsequent "first page" line.

A "&" as the first character on any line will create a blank line in the
help text "first page".

e.g.

&                                <- A blank line to start with
First line of help text. &
Second line of help text.&
Third line of help text. &
                         &       <- Another blank line - note that the "&"
etc.                                can be anywhere on the line
etc.

Finally, to end each entry...

}}
^^
This signifies the end of an entry, and should be placed after the
last line of the entry. (After the last end-of-line "&" character).


An complete single page example entry might be something like:

{{TARGETWORD&
&
First line of help text.&
&
Second line of help text.&
&
Third line of help text.&
}}


Using the "second page":

The '&' character denotes the end of a help text "first page" line, but you
are free to enter "second page" text after this character on the same line.
This text (everything after the '&') will be presented as a second page of
help by the user pressing the HELP key.

e.g.

{{TARGETWORD&
                         &
First line of help text. &  This is a comment, or note, and
                         &  will be displayed when the user
Second line of help text.&  presses HELP.
                         &
Third line of help text. &
}}

Note that the starting position of "second page" text is determined by
the number of spaces AFTER the "&" character.


Constraints:

There are a few constraints imposed by the limits of the help display.

The maximum displayable line length is 47 characters.

Lines longer than 47 characters will be truncated to 47 charatcters
when displayed on screen.

The maximum number of lines per entry, not including the target word
itself, is 7 lines.

Entries having more than 7 lines will be truncated when displayed
and only 7 lines will be shown.

The limits mentioned above (of 47 characters and 7 lines) will be
automatically imposed when the entry is displayed on screen.  It is
perfectly safe to exceed these limits within the help file, but any
extra text will not be displayed.