HelpViewer V1.1

Category / Domain : Tools
SCOL Voy@ger Compatibility : V 2.0c or above
Update : 1999/02

Function

The HelpViewer module allow a user to get a help window. It must be linked to the HelpServer module :
The following links must be set in place.

[HelpViewer].ask à [HelpServer].ask
[HelpServer].answer à [HelpViewer].answer

The help icon is displayed either in a document zone, if this one has been defined, either in a popup window below on the right of the screen.
To call the help window, the user must click on the help icon. The help window places then at its disposal a questions/answers tree.
Several fields can be configured for the client interface, however once edited and saved, you must avoid to reopen the Helpviewer editor
because the options are by default automatically filled in the fields, crushing all previous modifications.
Therefore it is necessary to enter all the required fields again if they were modified.

Configuration


Figure 1 : HelpViewer module interface

(1) : General => Tab allowing to adjust the general appearances of the client interface.

(2) : Titles=> Tab allowing to modify the aspects of the client interface titles.

(3) : Fields => Tab allowing to modify the aspects of the question and answer zones of the client interface (4 zones fields to fill).

Implementation

Action Function
module.event à HelpViewer.start Start the HelpViewer client and display the help icon.
HelpServer.answerà HelpViewer.answer HelpViewer receives a set of help fields, containing a question,
or an answer, or a title bar, or a space bar :

[help field reference]\ [field type]\ [field text]\n ect...
reference : field coordinates in the help tree of the HelpServer module.

« 0 » as question,
« 1 » as answer,
« 2 » as a previous field pointer,
« 3 » as title bar,
« 4 » as space bar

module.event à HelpViewer.make it ask trigger the display of a help field automatically. The coordinates of the help fields must be pass in parameter.

Exemple : make it ask 0_0 display the roots of the help.


Event Function
HelpViewer.ask à HelpServer.ask send a help field reference, as the reference is the father field the user wants to get.

Zone Function Interface Assignment
HelpViewerIcon the zone to display the help icon Client Yes