création de fichiers d'aide

Accueil > Aide HLP > Microsoft Help Workshop 4, leçon 3
Ou Page précédente

Une table des matières : l'onglet Sommaire

Introduction

Il s'agit de créer une table des matières pour votre fichier d'aide qui permettra d'afficher l'onglet Sommaire de la fenêtre générale de Winhelp. Pour ce faire, vous allez créer un fichier de sommaire et l'intégrer à votre projet d'aide.

---

Créer le fichier de sommaire

Afin de créer une tables des matières pour l'onglet Sommaire de la fenêtre générale qu'affichera Winhelp, vous devez créer un fichier qui contiendra le détail de cette tables des matières.

1. Ouvrez Help Workshop, si ce n'est déjà fait.
2. Cliquez sur File > New.
3. Dans la fenêtre New, sélectionnez Help Contents dans la liste et cliquez sur OK.

La fenêtre du fichier de sommaire s'ouvre dans Help Workshop avec les particularités suivantes :

• Dans la partie du haut de la fenêtre du document :
• La case de texte Default filename.
• La case de texte Default title.
• Et le bouton éditer qui permet de modifier le contenu de ces deux cases.
• Dans la partie du bas de la fenêtre du document :
• La zone ou s'affichera votre fichier de sommaire. Notez que vous ne pourrez rien y ajouter directement.
• À droite, une série de boutons d'options qui vous permettront de créer et de modifier votre fichier de sommaire (Help Contents).

Pour ajouter du contenu à votre fichier de sommaire ou si vous préférez, à votre table des matières, vous devez d'abord indiquer le nom du fichier d'aide qui s'ouvrira par défaut et le titre qui s'affichera par défaut dans la barre de titre de Winhelp.

1. Cliquez sur le bouton Edit.
2. Dans la boîte de dialogue Default Help Information, tapez le nom de votre fichier d'aide, soit AideHLP.hlp dans la première boîte de texte (Default helpfile). Lorsque plusieurs fichier HLP sont utilisés, on indique ici le nom du fichier d'aide générale sur l'application.
3. Dans la seconde boîte de texte (Default window), tapez Main. Nous verrons pourquoi un peu plus loin.
4. Enfin, dans la dernière boîte de texte (Default Title), tapez le titre qui apparaîtra par défaut dans la fenêtre d'aide :
   Ma première rubrique
   puis, cliquez sur OK.

Vous allez maintenant créer votre table des matières :

1. Cliquez sur le bouton Add below.
2. Dans la boîte de dialogue Edit Contents Tab Entry, cliquez sur Heading pour créer un titre de section.
3. Entrez le titre suivant :
   Généralités
4. Cliquez à nouveau sur le bouton Add Below.
5. Entrez les informations suivantes :
   Cochez Topic
Title : Rubrique principale
Topic ID : IDH_PRINCIPAL
Window type : main

6. Cliquez sur OK pour confirmer.
7. Ensuite cliquez sur le bouton Move Right pour décaler l'item du sommaire vers la droite.
8. Cliquez une dernière fois sur Add Below.
9. Entrez les informations suivantes :
   Cochez Topic
Title : Seconde rubrique
Topic ID : IDH_SECONDAIRE
Window type : Main

10. Cliquez sur OK pour confirmer.

Vous devez maintenant enregistrer votre fichier de sommaire. Cliquez sur le bouton Enregistrer (Save). Dans la boîte de dialogue Enregistrer sous (Save as), vérifiez que vous êtes bien dans le même répertoire que le fichier de projet (hpj). Dans la case Nom (Name), tapez AideHLP. Normalement, le type de fichier sélectionné devrait être CNT. Si ça n'est pas le cas, sélectionnez CNT dans la liste. Cliquez sur Enregistrer (Save).

Voici ce que vous devriez voir dans la fenêtre de Help Workshop.

|   Haut de la page   |   Sommaire   |

---

Lier le contenu au fichier de projet (.hpj)

Pour s'assurer que votre fenêtre d'aide s'ouvrira bien sur l'onglet Sommaire et avec le bon contenu, vous devez lier votre fichier de sommaire (contents file: cnt) à votre fichier de projet (project file: hpj).

1. Basculez vers le fichier de projet (Window > AideHLP.hpj) s'il est déjà ouvert, sinon ouvrez-le.
2. Cliquez sur le bouton Options.
3. Dans la boîte de dialogue Options, cliquez sur l'onglet Files.
4. Dans la case de texte Contents file, tapez le nom du fichier : AideHLP. Pour éviter de vous tromper, vous pouvez aussi cliquez sur le bouton Browse et chercher le fichier dans la boîte de dialogue Ouverture (Open).
5. Cliquez sur OK pour confirmer et fermer la boîte de dialogue Options.
6. La ligne CNT=AideHLP.cnt s'est ajoutée sous la section [OPTIONS].
   
   
    
   
7. Cliquez sur Save and Compile pour enregistrer et compiler votre projet d'aide.

|   Haut de la page   |   Sommaire   |

---

Le nouvel aspect de votre fichier d'aide

Tel qu'il est maintenant, votre fichier d'aide s'affichera différemment selon que vous cliquerez sur le bouton Aide de votre application VB ou que vous appuierez sur la touche F1. En effet, si vous cliquez sur le bouton Aide, l'aide s'ouvrira sur la rubrique principale et non sur le sommaire de l'aide. C'est du moins le résultat que j'ai obtenu par ma propre expérience. Par contre, en appuyant sur F1, vous verrez s'afficher le sommaire de l'aide que vous avez défini dans votre fichier de sommaire.

Comment afficher le sommaire de l'aide lorsqu'on clique sur le bouton Aide ? Retour à la case départ ! Vous devrez avoir recours, dans le code VB, à l'instruction Sendkeys "{F1}" plutôt qu'à la programmation de la boîte de dialogue commune. Pourtant, nous avions bien mis la valeur cdlHelpContents à la propriété HelpCommand, vous vous souvenez ? Cette même valeur qui devait faire afficher le sommaire si un fichier de sommaire est spécifié. Allez comprendre ! Moi, j'y renonce ! Pour l'instant, du moins.

Prix de consolation : quand vous cliquez sur le bouton Sommaire d'une fenêtre de rubrique d'aide, vous voyez apparaître la fenêtre générale d'aide et son onglet Sommaire affichant votre table des matières.

|   Haut de la page   |   Sommaire   |

---

En résumé

Dans cette leçon, vous avez appris à :

• Créer un fichier de sommaire.
• Ajouter des entêtes de chapitres et des rubriques à votre fichier de sommaire.
• Lier votre fichier de sommaire à votre fichier de projet.

Dans la prochaine leçon, vous apprendrez à paramétrer l'apparence des fenêtres d'affichage des rubriques comme leur taille, leur couleur et leur priorité sur les autres fenêtres.

|  Leçon précédente  |  Leçon suivante  |

---

|   Haut de la page   |   Sommaire   |