HelpServer

^{HelpServer V1.1}

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

Function

HelpServer is a help module, with a tree containing the help fields.
HelpServer has to be linked to a viewer, in order to print the help messages.
This viewer must contain the helpServer protocol, to get the messages readable.

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

Configuration

Figure 1 : HelpServer module interface

Implementation

Open the SCS creation tree, select the Tools folder and double-click on HelpServer 1.1.
Create required links for the project.

Action	Function
HelpViewer.askà HelpServer.ask	HelpServer receives a reference from a helpViewer module. This reference deals with a help field, from which the user wants to get help.

Event	Function
HelpServer.answer à HelpViewer.answer	send a set of help fields. Syntax (strbuild) : [help field reference S]\ [field type S]\ [field text S]\n [ref]\ [type]\ [text]\n ect... reference : describes the field coordinates, in the help tree of HelpServer. Type : Ť0ť as question, Ť1ť as answer, Ť2ť as pointer to previous field, Ť3ť as title, Ť4ť as space bar.

Zone	Function	Interface	Assignment
None		Client	No

Help Tree Construction

The Help Tree is described by a text file (dms/Tools/Help/HelpServer/Lang/language_file).
Each line contains a help field, as follow : [reference] [text].

For example, the reference 1_2_1_2 points to :