Création de fichiers d`aide

Jacques Bourgeois
Formation Informatique Inc.
Spécialiste Visual Basic
Formation et développement
[email protected]
Copyright © 2003 Jacques Bourgeois
Création de fichiers d’aide
La création de fichiers d’aide n’est généralement pas l’affaire des programmeurs
et est habituellement confiée à des rédacteurs techniques. Le programmeur doit
cependant être impliqué, étant donné que c’est lui qui devra créer les liens entre
l’application et le fichier d’aide. Nous considérons donc utile de vous donner un
aperçu. Cette section est loin d’être exhaustive, mais devrait vous donner une idée
des processus impliqués. Référez-vous à la documentation de l’outil que vous
déciderez d’utiliser pour les détails.
Les fichiers d’aide peuvent avoir plusieurs formats, incluant les vieux fichiers .hlp
utilisés du temps de Windows 3.1 et qu’on retrouve encore assez fréquemment
aujourd’hui, et qui sont des fichiers RTF formatés de façon particulière et ensuite
passé au travers d’un compilateur.
Les systèmes d’assistance en ligne modernes sont cependant presque tous conçus
à partir de fichiers HTML qui, combinés à une série de fichiers de configuration1
en format texte ou XML, sont passés au travers d’un compilateur qui génère un
fichier d’aide CHM, le format standard pour HTML Help 1.x. Un fichier CHM est
simplement une combinaison, dans un format comprimé, de plusieurs fichiers
HTML. Un système d’aide simple n’a pas nécessairement à être comprimé et peut
être distribué en fichiers HTML séparés.
Visual Studio utilise, en plus des fichiers CHM, des fichiers HXS, un nouveau
format défini dans HTML Help 2.0.
Des fichiers d’aide séparés peuvent être combinés dans un seul système, ce qui
permet une extensibilité. Ainsi, si vous ajoutez des composantes ou des outils à
votre environnement Visual Studio, leurs fichiers d’aide devraient normalement
s’intégrer à l’aide en ligne que vous utilisez pour votre programmation VB.
Ces fichiers de configuration servent à créer les index et autres éléments de
navigation et de recherche dans le système d’aide.
1
Les fichiers d’aide sont habituellement créés avec des logiciels spécialisés comme
RoboHelp (http://www.ehelp.com/products/robohelp). Ces logiciels sont cependant
dispendieux (souvent autour de 1000 $ US), donc réservés à des professionnels
qui pourront amortir leur coût sur plusieurs applications, ou qui doivent produire
une quantité importante de documentation.
Pour des petits projets, des outils fournis gratuitement par Microsoft peuvent
s’avérer suffisant.
Truc
Les adresses Web données ci-dessous sont longues et à-peu-près impossibles à taper
sans erreur dans la barre d’adresse de votre navigateur. Pour vous faciliter l’accès à ces
pages, vous pouvez passer par notre propre site Web à
http://www3.sympatico.ca/jbfi/vb.htm. La section « Outils », dans le milieu de la page,
vous offre des liens vers ces sites.
Le compilateur d’aide pour les applications et la documentation sont disponibles
dans un logiciel appelé le HTML Help Workshop que vous trouverez à
http://msdn.microsoft.com/library/default.asp?url=/library/enus/htmlhelp/html/hwMicrosoftHTMLHelpDownloads.asp.
Si vous voulez créer des fichiers d’aide pour les programmeurs qui utiliseront vos
composantes .NET, plutôt que des fichiers pour des applications, vous devrez
utiliser le Visual Studio Help Integration Kit, disponible à
http://www.microsoft.com/downloads/details.aspx?displaylang=en&familyid=CE1B26DCD6AF-42A1-A9A4-88C4EB456D87. Pour Visual Studio 2002, allez plutôt à
http://www.microsoft.com/downloads/details.aspx?familyid=3eaeb657-98dd-4959-b9469719fec3a3ce&displaylang=en.
Tous ces outils demandent que vous disposiez en plus d’un éditeur HTML. Visual
Studio peut être utilisé, mais pour des pages complexes, vous préférerez
probablement utiliser un éditeur spécialisé.
Dans vos applications, vous créez des liens avec l’aide en ligne par
l’intermédiaire d’un contrôle HelpProvider. Ce contrôle possède une propriété
HelpNamespace qui permet de le faire pointer au fichier d’aide de votre
application. Une fois le HelpProvider ajouté à un formulaire, chaque contrôle
possède quatre nouvelles propriétés permettant de déterminer quelle page sera
appelée quand l’utilisateur activera F1 quand le contrôle a le focus.
ShowHelp définit si le contrôle affiche de l’aide ou pas. C’est en quelque sorte
une propriété Enabled pour la touche F1 sur le contrôle.
HelpKeyword indique au système la page d’aide à afficher. Le créateur du
système d’aide a défini un mot clé pour chacune des pages et devrait normalement
en fournir une liste au programmeur pour qu’il puisse créer les références.
HelpNavigator détermine l’action à prendre sur l’activation de l’aide. On veut
généralement présenter la page d’aide définie par la propriété HelpKeyword, mais
il existe aussi d’autre méthodes de navigation dans le système d’aide, ou vous
pourriez vouloir pointer à la table des matières (TableOfContents) du système
d’aide.
HelpString détermine le texte à afficher sur une demande d’aide « pop-up », la
forme d’aide réduite qui apparaît comme une info-bulle à l’intérieur de
l’application elle-même quand l’utilisateur fait SHIFT-F1 ou active un bouton
d’aide (?) dans la barre d’outil d’une boîte de dialogue2. Dans une application
VB.NET, il suffit de mettre du texte dans la propriété HelpString pour qu’il
s’affiche sur SHIFT-F1. Pour avoir le bouton d’aide, il faut à la fois activer la
propriété HelpButton du formulaire, et désactiver MaximizeBox et MinimizeBox.
2
Ce type d’aide n’est pas fourni dans toutes les applications.