HelpServer V1.1

Catégorie / Domaine : Outils
Compatibilité SCOL Voy@ger : V 2.0c et supérieure
Mise à jour : 03/2004

Fonction

HelpServer est un module d’aide contenant un arbre de champs d’aide. HelpServer doit être lié à une interface acceptant la syntaxe des champs d’aide, par exemple le module HelpViewer.

Les liens suivant doivent être mis en place.

[HelpViewer].ask à [HelpServer].ask

[HelpServer].answer à [HelpViewer].answer

Configuration


Figure 1 : Interface du module HelpServer

Mise en oeuvre

Action Fonction
HelpViewer.ask à HelpServer.ask HelpServer reçoit une référence de champ d’aide, donnant accès aux champs fils dont on veut afficher le contenu.
Cette action déclenchera un événement « answer » dont les paramètres correspondront à la référence demandée.

Evénement Fonction
HelpServer.answerà HelpViewer.answer transmet une série de champs d’aide à afficher par le viewer.>br>La syntaxe de cette transmission est la suivante (construction strbuild):
[référence du champ d’aide S]\ [type du champ S]\ [texte du champ S]\n
[ref]\ [type]\ [texte]\n ect...
référence : identificateur (textuel) du champ d’aide, correspondant aux coordonnées
du champ dans l’arbre d’aide

type : « 0 » si question,
« 1 » si réponse,
« 2 » si pointeur vers champ d’aide précédent,
« 3 » si barre de titre,
« 4 » si barre d’espace

Zone Fonction Interface Affectation
Aucune client non

Construction de l’arbre d’aide

L’arbre d’aide est décrit sous forme de fichier texte, au sein des fichiers de langue (dms/Tools/Help/HelpServer/Lang/).
Chacun des fichiers de langues contient une version de l’arbre d’aide, avec les textes traduits dans la langue correspondante.
Chaque ligne d’un fichier de langue correspond à un champ d’aide, suivant la syntaxe :
[référence] [texte]. La référence correspond en fait aux coordonnées du champ dans l’arbre d’aide.

Par exemple, la référence 1_2_1_2 pointe sur l’élément suivant :