Winhelp

La méthode standard pour créer un fichier de help est d'utiliser Microsoft Help Workshop. Il exploite des fichiers .rtf produits par Word. La version Word 97 nécessite la version 4.03.

La version 4 était livrée dans les environnements de développement Microsoft ou Borland c++ builder 3.

Vous trouverez ici une description pas à pas des fonctions minimums nécessaires pour la réalisation du fichier d'aide.

Voici la procédure élémentaire de création d'un fichier help :

bullet#Créer le projet
bullet#Créer un fichier RTF
bullet#Ajouter le fichier rtf au projet
bullet#Ecrire le contenu du fichier rtf
bullet#sujet de la page
bullet#mots-clefs
bullet#étiquette
bullet#Ajouter une lien vers une autre page
bullet 
bullet#Définir des points d'entrée directe dans l'aide

Procédure élémentaire

Créer le projet

bulletCréer un répertoire de travail
bulletLancer hcw.exe
bulletLancer le menu File/New, Help Project, bouton OK

wpe2.gif (2178 octets)wpe4.gif (3672 octets)

bulletSe déplacer vers le répertoire de travail et donner un nom de projet sans extension

wpe5.gif (5993 octets)

bulletLe projet existe :

wpe6.gif (12299 octets)

bulletCliquer sur option pour entrer le titre du help

wpe8.gif (6850 octets)

Créer un fichier RTF

bulletLancer Microsoft Word, et activer options du menu outil, onglet Affichage, cocher la case Afficher le texte caché.
bulletCréer un nouveau fichier et le sauvegarder dans le répertoire de travail en type de fichier Texte mis en forme (RTF) (*.rtf)

wpe7.gif (9434 octets)

Ajouter le fichier rtf au projet

Sous Microsoft Help Workshop cliquer sur Files/Add et ajouter le fichier rtf créé.

Ecrire le contenu du fichier rtf

Notes

bulletSéparer chaque rubrique par un saut de page
bulletPour chaque rubrique :
bulletAjouter une note  en bas de page $, et y écrire le sujet de la page. Ce sujet apparaitra dans la zone 3 sujet de l'onglet rechercher de la boite ouverte par le bouton index. Tous les mots du sujet seront dans la zone 2 de la boîte
bulletAjouter une note en bas de page K, et y écrire les mots-clefs séparés par ';'. Les mots clefs apparaissent dans la zone 2 de l'onglet index de la boîte ouverte par le bonton index.
bulletAjouter une note en bas de page #, et y écrire IDH_nom_etiquette. Cette étiquette est nécessaire pour pouvoir utiliser des liens vers cette rubrique. Préfixer par IDH_ si vous voulez pouvoir y accéder par programme.

Ajouter une lien vers une autre page

Ecrire dans le fichier rtf sans séparation le mot sur lequel l'utilisateur pourra cliquer et l'étiquette de destination. Passer en attribut barré le premier et en attribut caché le second :

wpeC.gif (1145 octets) provoquera à l'exécution : wpeE.gif (2338 octets)

Insérer des images

Presque simplement par copier coller sous word. Faire attention toutefois à selectionner un collage spécial en image en mode point. Les images insérées en tant qu'objet sont ignorées.

Insérer plùtôt vos images comme fichiers liés et limitez vous à 16 couleurs, les fichiers .hlp généré seront beaucoup plus petits.

Définir des points d'entrée directe dans l'aide

Sous Microsoft Help Workshop, cliquer sur Map/Add, et faire correspondre l'étiquette alphanumérique (Topic id) avec un numéro d'identification.

wpe9.gif (5753 octets)

Ce numéro peut être exploité par windows dans le système contextuel d'aide via le '?' des boîtes de dialogue. Il peut aussi être utilisé dans les programme dans la commande d'invocation de l'aide par la fonction :

winhelp( my_window_handle, "chemin et nom du fichier .hlp", HELP_CONTEXT, numéro);   

Ce numéro peut être testé sous Microsoft Help Workshop

wpeA.gif (4460 octets)wpeB.gif (7275 octets)

Créer un fichier sommaire

Par le menu file / new File contents

wpeF.gif (6054 octets)

Indiquer le nom du fichier .hlp par défaut.

wpe13.gif (9994 octets)

bulletLes chapitres et sections (heading)
bulletet les rubrique avec un titre qui apparaît et l'étiquette (Topic Id)

wpe11.gif (4496 octets)wpe12.gif (7897 octets)

Le Help file est par défaut celui spécifié dans le Default filename.

Accueil ] Remonter ]