|Page Contents||Introduction Help Requests Help Facilities Help search results Help display Display options Help books Programmer Interface Web aware|
|See also||HelpIndex Bean Information HiDemo example|
The Hi HelpIndex and Hi Brow beans should be able to take part in most of these options,
especially where it is marked as * below.
The HiDemo Java application example shows how you could provide some of the other facilities, ie where they marked as # below.
Note: Hi HelpIndex does not provide all these facilities.
Requesting help within a GUI (IDE) can take these forms:
The books may either be selected one at a time, or their contents/index be merged.
Provide programmer/user options to add/remove books.
An easy interface should be provided for programmers,
ie to provide a link between dialogs/controls and the corresponding help text.
For WinHelp and C/C++ programs, the C++ identifiers are used to relate dialogs/controls to help pages, eg dialog IDD_COLOURS is used to display the help page with topic id of HIDD_COLOURS.
Hi HelpIndex and VC++ programs have a similar link, eg dialog IDD_COLOURS has a help page called IDD_COLOURS.htm.
There is also a link provided for pop-up help, eg button IDC_PRESS_ME has its pop up help defined at anchor IDC_PRESS_ME within web page Popups.htm (or whatever).
* The help pages or system should be written so that it can be made available on the public internet in a useable way.
For use on the web, Hi HelpIndex as an applet would be used to provide the Contents/Index.
On the web, Back/Forward buttons must be provided using a Java applet such as Hi Jump on each web page. In a GUI system, Back/Forward may be better provided as a part of a separate bean (with Prev/Next etc).