HelpViewer V1.1

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

Fonction

Le module HelpViewer permet à un utilisateur d’afficher une fenêtre d’aide. Il doit être relié au module HelpServer pour fonctionner:

Les liens suivant doivent être mis en place.

[HelpViewer].ask à [HelpServer].ask

[HelpServer].answer à [HelpViewer].answer

L’icône d’aide s’affiche soit dans une zone de document, si celle-ci a été définie, soit dans une fenêtre popup en bas à droite de l’écran.
Pour appeler la fenêtre d’aide, l’utilisateur doit cliquer sur l’icône d’aide. La fenêtre d’aide met alors à sa disposition un arbre de questions/réponses.
Plusieur champs peuvent être configuré pour l’interface cliente, cependant une fois édité et sauvegardé, il faut éviter de réouvrir l’éditeur Helpviewer
car les options par défaut sont automatiquement inscrits dans les champs écrasant toutes modifications précédentes. Donc il faut entrer à nouveau
tout les champs requis s’ils étaient modifiés.

Configuration


Figure 1 : Interface du module HelpViewer

(1) : Général => Onglet permettant de régler les apparences générales de l’interface cliente.

(2) : Titres => Onglet relatif au aspects des titres de l’interface cliente.

(3) : Champs de saisies => Onglet relatif au aspects des zones question et réponse de l’interface clientes ( 4 zones de champs à saisir).

Mise en oeuvre

Action Fonction
module.événement à HelpViewer.start Initialise le module et démare l’affichage de l’icône d’aide.
HelpServer.answerà HelpViewer.answer on transmet à HelpViewer une série de questions/réponses suivant la syntaxe de type strbuild :

[référence du champ d’aide]\ [type du champ]\ [texte du champ]\n ect...
référence : identificateur (textuel) du texte du champ, 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

module.événement à HelpViewer.make it ask déclenche automatiquement l’affichage d’un champ d’aide. Les coordonnées du champs d’aide doivent être passées en paramètre.

Exemple : make it ask 0_0 affiche la racine de l’aide.


Evénement Fonction
HelpViewer.askà HelpServer.ask transmet une référence de champ d’aide, correspondant à la référence du père des nœuds d’aide que l’on veut afficher.

Zone Fonction Interface Affectation
HelpViewerIcon interface graphique de l’icône d’aide client Oui