Création d'un fichier d'aide

Contenu du snippet

Au moment de la création (design) d'un fichier d'aide plusieurs autres fichiers interviennent, mais quand vous compiler le projet, tous ces fichiers se regroupent en un seul .hlp. Parmis ces fichiers, on trouve le fichier Projet (qui gère les références à tous les autres fichiers), le fichier Sommaire (Qui est la table des matières de l'aide), le fichier de rubriques (qui contient le contenu de l'aide proprement dit).
La création d'un fichier d'aide est similaire à la création d'un programme Visual Basic. Voici donc une description de l'ensemble des fichiers nécessaires au moment de la création.

Le fichier Projet .HPJ

Le fichier de Projet est le fichier que vous compilez pour avoir le fichier .hlp. Il contient toutes les références aux autres fichiers, spécifie les paramètres et options du fichier d'aide tels que le taux de compression, le style de fenêtre utilisé dans l'aide.
Vous pouvez utiliser NotePad pour écrire ce fichier et tous les autres, mais l'utilisation d'un outil spécifique (comme Help WorkShop) est le bienvenu.

Un exemple de fichier projet , met dans bloc-notes !

[OPTIONS]
LCID=0x40c 0x0 0x0
REPORT=Yes
CONTENTS=Topic1
TITLE=Help Sample
CNT=HELPContents.cnt
COPYRIGHT=Help Sample
CITATION=Copyright Help Sample
HLP=HELP.HLP

[FILES]
HELPText.rtf

[MAP]
Topic1=001
Topic2=002
Topic3=003

[WINDOWS]
Window="Help Sample",(462,78,548,878),62212,(r14876671),(r48059),f3

LCID=0x40c 0x0 0x0 définit la langue utilisée. Ici c'est le Français.
CONTENTS=Topic1 définit la rubrique "Topic1" comme rubrique par défaut, celle qui s'affiche par défaut quand il y a pas de sommaire ou lorsqu'une rubrique à laquelle l'utilisateur veut accéder est absente.
TITLE définit le titre qui s'affiche dans la barre de titre du fichier d'aide.
CNT=HLPContents.cnt définit le fichier "HLPContents.cnt" comme le fichier qui contient le sommaire de l'aide.
HLP définit le fichier .hlp qui sera créé pendant la compilation.
[FILES] définit les fichiers contenant les rubriques de l'aide. A la compilation, tous ces fichiers sont regroupés en un seul et attachés au projet.

[MAP], cette section contient le nom de chaque rubrique, suivi d'un nombre. Ce nombre est appelé l'identificateur contextuel de la rubrique. C'est ce nombre qu'on utilisera plus tard dans notre projet Visual Basic afin de se référer à la rubrique.

Window=... spécifie le type de fenêtre utilisé pour afficher l'aide, sa couleur et ses boutons de navigation.

Le fichier Sommaire .Cnt

Le fichier Sommaire est le fichier qui contient la Table des matières de l'aide. Voici un petit exemple de sommaire.

:Base HELP.hlp>Window
:Title Table des matières de l'Aide
1 Introduction à AddressBook=Introduction
1 Environnement
2 Barre d'Outils=ToolBar
2 Les Menus
3 Menu Fihier=mnuFile
3 Menu Edition=mnuEdit
3 Menu Affichage=mnuView
3 Menu Aide=mnuAide
1 Formulaire de saisie=saisie
1 Barre de navigation=NaviBar
1 Barre de Liste=ListBar
1 Tâches Courantes
2 Créer un Contact=Create
2 Editer un Contact=Edit
2 Supprimer un Contact=Del
2 Mettre à jour un Contact=Update
2 Rechercher=Find
2 Trier les Contacts=Trier
2 Aller à=GoTo
2 Imprimer un Contact=Print
1 A propos
2 L'auteur=Auteur
2 CamerNet et le Web=Site
2 Prochaines Versions=Versions
c bon ou non !

A voir également

Vous n'êtes pas encore membre ?

inscrivez-vous, c'est gratuit et ça prend moins d'une minute !

Les membres obtiennent plus de réponses que les utilisateurs anonymes.

Le fait d'être membre vous permet d'avoir un suivi détaillé de vos demandes et codes sources.

Le fait d'être membre vous permet d'avoir des options supplémentaires.