M -1.0-

 

Module : HelpServer V1.0

Category / Domain :

Tools

Scol Engine Compatibility :

V3.2d and higher

Operating Systems :

Windows 95/98

 

Windows NT 4.0

Documentation dated :

31/07/2000

Supersedes sheet :

 

Module Description

 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

 

 

Actions and Events

Actions

·        ask : HelpServer receives a reference from a helpViewer module. This reference deals with a help field, from which the user wants to get help.

Events

·         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.

 

Help Tree Construction

            The Help Tree is described by a text file (emdms/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  :