Aide contextuelle au format html

Description

Création d'un fichier d'aide générale et contextuelle au format HTML.
----------------------------------------------------------------------------
Nécessite HTML Help Workshop (hhw.exe et dll associées) téléchargeable (htmlhelp.exe 3,34 Mo) à l'adresse :
http://msdn.microsoft.com/library/default.asp?url=/library/en-us/htmlhelp/html/hwMicrosoftHTMLHelpDownloads.asp

On suppose que le projet MonProjet.vbp sera compilé en MonProjet.exe et que le fichier d'aide sera MonProjet.chm.
MonProjet.exe et MonProjet.chm seront placés dans le même dossier.

1°) Créer les pages HTML (avec Word par exemple) : AideGénérale.htm, Form2.htm, Command1.htm, Text3.htm, ...
Chaque page correspond à l'aide sur une Form, un contrôle, ... du projet VB MonProjet.vbp.

Ajouter des liens hypertexte pour : revenir à l'aide générale, aller à une page précise, ...

2°) Dans le projet VB, pour chaque contrôle ou Form qui doit avoir une page d'aide,
compléter la propriété HelpContextID avec une valeur différente de 0.
Par exemple pour Form2, on met HelpContextID = 21, pour Command1, HelpContextID = 35, pour Text3 HelpContextID =58
et pour Form1 (la feuille qui s'ouvre au lancement) on met HelpContextID = 1

Dans l'objet de démarrage (Sub Main ou Déclarations de la Form Form1 qui s'ouvre au démarrage), ajouter l'instruction :

App.HelpFile = App.Path & "\" & App.ExeName & ".chm"

Compiler MonProjet.exe

3°) Lancer un éditeur de texte (Notepad.exe par exemple) et saisir le texte ci-dessous entre les 2 lignes de ----

--------------------------------------------------------------------------------------------------
[OPTIONS]
Compatibility=1.1 or later
Compiled file=MonProjet.chm
Default Window=aide
Default topic=AideGénérale.htm
Display compile progress=Yes
Language=0x40c Français (standard)
Title=Aide de MonProjet version 1.0.0

[WINDOWS]
aide="Aide de MonProjet version 1.00 © Moi-Même - 2003",,,"AideGénérale.htm",,,,,,0x2000,,0x3006,,,,,,,,0

[FILES]
AideGénérale.htm
Form2.htm
Command1.htm
Text3.htm

[ALIAS]
IDH_GENERAL=AideGénérale.htm
IDH_FEUILLE2=Form2.htm
IDH_BOUTON1=Command1.htm
IDH_TEXTBOX3=Text3.htm

[MAP]
#define IDH_GENERAL 1
#define IDH_FEUILLE2 21
#define IDH_BOUTON1 35
#define IDH_TEXTBOX3 58

[INFOTYPES]
--------------------------------------------------------------------------------------------------

Sauvegarde le fichier sous MonProjet.hhp

4°) Lancer hhw.exe, ouvrir MonProjet.hhp (File -> Open )

Compiler : File => Compile ; on obtient le fichier au format HTML compilé MonProjet.chm

Quitter hhw

Recopier MonProjet.chm dans le dossier qui contient MonProjet.exe

L'appui sur la touche F1 appellera la page d'aide désirée.

Conclusion :


30/07/2003 : ajout d'un .zip contenant un exemple

Codes Sources

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.