The hypertext help system is one of the truly unique features
of the Virtual Advanced BBS. It is very flexable and can be
configured to meet a variety of informational needs. The
calling sequence is
ADVAUX %1 HELP <help system number>
The <help system number> is used to form a filename of the
"lookup" file, which should be placed in your VADV \DATA direc-
tory. For example, for help system number 1, the file name would
be LOOKUP.1 (not LOOKUP.001). Help systems from 1 to 999 are
available; system 0 is reserved for future internal use.
Lookup files have the format -- one entry per line --
<help filename> <keyword or key phrase>
For example, you might have this information in your lookup file:
MAIN Main Menu
MESS Message Base Information
FILE File Base Information
QWK QWK Mailer Help
In the lookup file, do not put in an extension for the help
filename; .HLP is assumed. The first entry in your lookup file
is considered to be the starting point. The help filename speci-
fied is displayed, and the user is prompted; continuing or going
back to the main menu proceeds from there.
Within each help file, you reference topics in the lookup
file by bracketing them with [ and ].
Using the example LOOKUP file from above, help-file skeletons
might look like this:
MAIN.HLP:
----------
Your text here.
[Message Base Information]
[File Base Information]
[QWK Mailer Help]
MESS.HLP
---------
Your text here.
[Main Menu]
[File Base Information]
[QWK Mailer Help]
FILE.HLP
---------
Your text here.
[Message Base Information]
[Main Menu]
[QWK Mailer Help]
QWK.HLP
---------
Your text here.
[Message Base Information]
[File Base Information]
[Main Menu]
The hypertext links (information in square brackets) can be
placed at any point in the help file.
Each .HLP file should have one or two blank lines at the top
and at least three blank lines at the bottom of the file in
order to accommodate the header and footer lines that VADV
appends to the display area.
|