CREATION D'UN FICHIER D'AIDE .HLP

Introduction
Structure d'un fichier d'aide
Les Outils de Création
Conclusion
Téléchargement

Vous venez sûrement de réaliser une programme "super chouette", mais à quoi servira t-elle si les utilisateurs finals ne savent pas s'en servir ?
Vous pouvez évitez ce genre ce scenario en procurant avec votre programme un Fichier d'Aide, qui apprendra à l'utilisateur comment utiliser le programme afin d'obtenir en retour les meilleures performances. Le fichier d'aide peut procurer des guides, ou encore des astuces pour optimiser le programme.

Il existe actuellement deux types de fichiers d'aide sous Windows: Les fichiers d'aide d'extension .HLP et les fichiers d'aide d'extension .CHM.
Notons que vous n'avez pas NECESSAIREMENT besoin d'un outil spécifique pour créer les différents fichiers que néccessite un fichier d'aide; hors mis les outils de compilation que nous détaillerons en bas de page.
Rapellons aussi que cet article ne détaille pas les codes employés dans les différents fichiers, mais s'efforce à vous faire comprendre le principe de conception d'un projet d'aide. Vous devez vous procurer un outil spécialisé pour générer ces fichiers, et la plus part de ces outils proposent une aide complète sur la création des différents fichiers.

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:

[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

:Base HELP.hlp>Window définit le fichier d'aide lié à la table des matières (ici c'est HELP.hlp), et la fenêtre qui sera utilisée pour afficher l'aide (ici c'est "Window", que nous avions définit plus haut).
Voici le résultat de ce code.

Le nombre 1 désigne une branche de niveau maximal, le nombre 2 désigne  une sous-branche d'une branche de niveau 1. Le nombre de niveau 3 désigne une sous-branche d'une branche de niveau 2, et Ainsi de suite...
La chaîne de caractères qui suit le nombre désigne le texte affiché dans la table des matières. Si cette chaîne de caractères contient le signe "=" alors lorsque vous cliquerez sur cet élément dans la table des matières, il vous renverra la rubrique dont le nom figure à droite de "=". Ex: "Introduction à AddressBook" renvoie à la rubrique "Introduction".
Notons aussi que le fichier sommaire est optionnel, on n'est pas obligé de l'inclure.

Le fichier de Rubriques .Rtf

Le fichier le plus important, et aussi le plus difficile à réaliser. Ici, abandonnez Notepad, allez maintenant vers un logiciel de formatage de texte tel que MS Word. Dans les explications qui suivent, on utilise MS Word.

Le fichier de rubriques contient toutes les rubriques (les explications) de votre fichier d'aide. Chaque rubrique est identifiée par un nom. C'est ce nom que les autres fichiers tels que le fichier de projet et le fichier Sommaire utilisent pour se réferer à la rubrique.

Les différentes rubriques du fichier d'aide sont délimitées par des sauts de page volontaires. Pour effectuer un saut de page dans Word, appuyez sur CTRL + ENTREE. Pour spécifier le nom de la rubrique nouvellement crée, ajouter à la page une Note de bas de page avec la numérotation personnalisée #. Puis de retour dans votre page ajoutez après le #, l'identificateur de la rubrique. Dans Word, cliquez sur "Insertion" puis sur "Note...", sélectionnez "Note de bas de page", sélectionnez aussi une Numérotation personnalisée. Puis tapez le symbole # comme numérotation et cliquez sur OK. Le nom de l'identificateur de rubrique peut contenir tout caractère sauf ceux qui sont réservés (#, =, +, @, *, %, !) et possède un maximum de 255 caractères. Ex: le nom complet peut ressembler à ça: "#Rubrique1"

Vous pouvez ajouter un titre à votre rubrique en ajoutant une note de bas de page avec comme numérotation le symbole $. Ensuite tapez le titre de la rubrique après le $.

Vous pouvez spécifier dans votre fichier de rubriques des Séquences de Parcours de rubrique. Elles correspondent au parcours suivi lorsqu'on clique sur les boutons flèches (<< et >>). Ainsi une séquence de parcours désigne l'ordre dans lequel apparait les rubriques qui appartiennent à cette séquence lorsqu'on clique sur les boutons flèches de la fenêtre d'aide. Pour ajouter une rubrique à une séquence spécifique, ajouter une note de bas de page avec la marque +. Ensuite suivez cette marque du nom de la séquence, puis du caractère : (deux-points) et enfin du numéro spécifiant l'ordre dans lequel la rubrique apparaît dans la séquence. Ex:  "SequenceMenus:011".

Pour lier des mots clés à votre rubrique, insérer une note de bas de page avec K pour entrée personnalisée. Séparez chaque mot clé par un ; (point-virgule). Ex:   Menu Fichier; Barre de Données; Ordre d'alignement. Si vous souhaitez créer des mots clés secondaires (un groupe de mots clés qui appartiennent à un autre mot clé),il suffit de suivre cette syntaxe:
ClePrimaire;ClePrimaire:CleSecondaire1;ClePrimaire:CleSecondaire2;
NOTE: vous pouvez remplacez les : (deux-points) par des , (virgules).

Une chose importante aussi c'est la possibilité de lier les rubriques comme des pages Web grâce à des liens. Pour faire un lien vers une autre rubrique, tapez le titre du lien, puis sélectionnez le et soulignez le en double (pour un lien normal) ou en simple (pour un lien popup). Ensuite tapez le l'identificateur de la rubrique à la suite du texte souligné avec le style Masqué. Ex:  Allez à la Rubrique 1 Marubrique1 . Cette exemple crée un lien popup vers "Marubrique1". Note: "Marubrique1" doit être masqué.

Le texte de la rubrique peut être écrit de n'importe quelle façon, il y a pas de restrictions. Vous pouvez formatez le texte (police, taille) mais évitez de formater le texte avec des styles définis plus haut. Si vous souhaitez insérer une image, insérez juste la ligne {bmX nomfichier.bmp} où vous remplacez "X" par "c" pour que l'image soit traitée comme un caractère du texte, "l" pour que l'image soit alignée à gauche, "r" pour qu'elle soit alignée à droite. Le fichier image doit uniquement être un bitmap (.bmp). Lorsque vous compilez le projet, le fichier image est automatiquement incorporé à l'interieur donc vous n'avez pas besoin de distribuer aussi les bitmaps utilisés dans le projet. Note: vous pouvez très bien attacher un lien à une image, en suivant les intructions plus hautes.

Vous pouvez créer un zone fixe pour votre rubrique. La zone fixe d'une rubrique est la zone qui ne bouge pas lorsqu'on fait défiler le contenu de la rubrique avec les barres de défilement. Cette zone est située en haut de la fenêtre, dans un cadre. Pour créer une zone fixe, sélectionner le texte (qui peut contenir des images) qui constitura la zone fixe, et formatez le en "Paragraphe Solidaire". Dans MS Word, ce style est accessible via le menu "Format/Paragraphes", et en sélectionnant l'onglet "Enchaînements".

Une fois ces trois fichiers créés, vous devez les compiler grâce à des outils spécifiques de compilation de fichiers d'aides. La plus part de ces outils vous permettent aussi de créer facilement le fichier sommaire et le fichier projet nécessaires en utilisant des techniques intuitives et simples de compréhension. Quant au fichier de rubrique, il existe aussi des outils permettant de les automatiser. Nous allons voir quelques uns de ces outils.

Microsoft Help WorkShop

Microsoft Help WorkShop est un outil à la fois de compilation et de création automatisée de fichiers d'aides. Cet outil est livré avec le pack Microsoft Visual Studio 6 Entreprise (je sais pas pour les autres versions). Ce programme est freeware (gratuit), et vous pouvez le Télécharger ici.

Oasis SE

Son intuitivité et sa simplicité vous permetrons de créer des fichiers d'aide sans lire de documentation. Ce programme est freeware, et vous pouvez le Télécharger ici.

Help Decompiler

Help Decompiler vous permet de décompiler des fichiers d'aides qui sont au format .hlp pour voir ses fichiers sources. Utile pour apprendre rapidement en essayant de comprendre comme un fichier d'aide sophistiqué à été créé. Note: la documentation étant en Allemand, voici l'instruction Dos qu'il faut executer pour décompiler le fichier d'aide: Helpdeco.exe FichierAide.hlp. Ce programme est freeware, et vous pouvez le Télécharger ici. Le zip est fourni avec le code source du programme fait en C.

Helpy

Helpy est un outil lié à Word. C'est en fait un ensemble de macros qui vous permet d'executer les tâces les plus courantes lors de la création d'un fichier de rubriques. Ainsi, il fait la grande part du boulot, et il automatise tout ! C'est un must si vous souhaitez créer des fichiers d'aide puissants. Ce programme est freeware, et vous pouvez le Télécharger sur le Site web de K/OS.

Avec la sortie de Microsoft Internet Explorer 4, un nouveau type de fichiers d'aide est né : ces fichiers ont l'extension .CHM et sont composés d'un ensemble de pages HTML classées suivant des rubriques. Ils sont beaucoup plus efficaces (notamment avec la fonction de recherche évoluée) que les fichiers .hlp. Mais le poste client doit disposer d'au moins Internet Explorer 3 pour utiliser le fichier d'aide.

Notez que lors de la création d'un fichier d'aide, il convient d'abord de créer le fichier de rubriques contenant tous les identificateurs de rubriques et autres détails, ensuite de créer le fichier sommaire (s'il y en a un) et de lier les titres de branches aux différentes rubriques. Enfin, vous créez le fichier projet et ajoutez à votre projet les deux fichiers précédement crées.

Notez aussi que lorsque vous distriburez votre fichier d'aide avec votre application, il faudra inclure dans la distribution le fichier sommaire .cnt (s'il y en a un).

La plus part des outils de compilation que vous verrez possèdent une aide en ligne beaucoup plus complete que cet article, et qui vous permettrons de créer des fichiers d'aide ultre sophistiqués.

Pour vous accompagner dans la lecture, voici un exemple de fichier d'aide livré avec ses fichiers sources.

Help.zip - Téléchargez le zip qui contient le programme qui changer le bouton Démarrer.

[Home] [Actualités]  [Trucs & Astuces] [Astuces Windows] [ActiveX-Ocx/Dll] [Articles] [Codes Sources] [VB Games] [Fichiers Sons] [Fichiers Icônes] [Programmes & Sources]  [Mailing-List] [Divers] [A Propos]