|
Sommaire
Page d'accueil du site
Delphi
Mes programmes
Multi-Média Conception
Trucs et astuces
Aide sur HelpWork Shop
Aide sur Delphi X (les bases)
Ma charte de création d'interface
|
|
 Introduction
Vous programmez en
Delphi donc vous avec besoin de faire des fichiers d'aide. Il existe une
application fournie avec Delphi 5, Help Workshop de Microsoft. C'est un bon
programme de conception d'aide au format HLP mais son ergonomie n'est pas
exemplaire. C'est pour cela que je fais cette rubrique.
Avant de commencer, il est impératif d'avoir un programme genre MS-Word
(97,2000...) car ce logiciel ne supporte que les fichiers RTF issus d'un
traitement de texte.
Le programme Help Workshop se trouve dans le dossier "help/tools"
du répertoire Delphi 5. Personnellement, je vous conseil d'en faire un
raccourcis.
Comment
se compose une aide.
Le fichier HLP
(exécutable sous Windows) est une compilation de topiques. Un topiques
constitue une page d'aide. Sous Word, il est très facile d'en rajouter : il
suffit de créer une nouvelle page et de rajouter quelques informations
(note de bas de page). Mais nous verrons cela un plus en détails plus tard.
De plus, un document d'aide peut comporter un fichier CNT qui fais la
synthèse de l'aide. C'est le menu de l'aide lorsque celle-ci est lancée.
Les
topics
Les topiques sont
très importants car ils composent votre aide. Pour faire un topique,
utiliser Word. Dans une nouvelle page, insérez une note de bas de page
portant le nom #. Cette note contient le nom de la page d'aide. Ce
nom commence toujours par IDH_ (par exemple : IDH_SOMMAIRE). Vous pouvez insérer
un titre en ajoutant une note de bas de page portant le nom $. Il en
est de même si vous voulez identifier vos pages dans l'index de l'aide, la
note porte le nom k. Vous pouvez ajouter beaucoup de marques en les séparant
par des points-virgules.
Dans la page où vous venez d'entrez ses marques, vous pouvez ajouter le
texte et tous le contenu de votre page d'aide.
Pour ajouter une nouvelle page d'aide (topic), créer un saut de page
(CTRL+Entrée sous Word) et rentrez les nouvelles notes de bas de page comme
précédemment.
Dans ces pages, il peu être intéressant de faire des liens vers d'autre
pages de l'aide. Pour cela, Tapez le nom du lien (qui sera visible sous
l'aide) directement suivit du nom de l'aide Exemple : Allez au
sommaireIDH_SOMMAIRE. Il faut ensuite souligner en double trait le nom du
lien et mettre en caractère masqué le nom de la page.
Pour faire une page de présentation, il est bon de savoir faire un
intitulé séparé du reste de l'aide. Il faut que le texte à insérer en
titre sous au début de la page et en paragraphe solidaire.
Téléchargez
ici le fichier RTF
exemple (1.5 Ko).
Le
projet d'aide
Pour pouvoir
utiliser les topics de votre aide, il faut, avec Help Workshop, créer un
nouveau projet d'aide. Faite dans le programme "File/New" et
choisissez "Nouveau projet" et enregistrez le sous
"essai".
Il faut maintenant configurer le projet. Cliquez sur le bouton
"option" à droite. Dans l'onglet qui apparaît, tapez le nom de
la page d'aide à afficher en premier (IDH_Page1 par exemple), vous pouvez
aussi définir le titre de l'aide (Mon aide).
Dans l'onglet compression, sélectionnez "Maximum". Validez en
cliquant sur "OK".
Ensuite, il définir les topiques (le fichier RTF). Cliquez sur
"Files" puis "Add" et entrez le chemin du fichier RTF
contenant les topiques ("page.rtf" par exemple).
Pour afficher les pages, il faut configurer la fenêtre d'affichage. Dans
l'écran principal, cliquez sur "Window" et tapez le nom de la
fenêtre ("Main" par exemple). Configurez les couleurs de la
fenêtre (l'opération est très simple). Validez en cliquant sur OK.
Pour finir, retournez dans les options et dans l'onglet "FTS" et sélectionnez
"Generate full text search". Cette option permet d'afficher dans
l'index de l'aide les mots-clés de vos pages.
Le
fichier de contenu
Le fichier CNT
(contenu) regroupe vos liens vers les pages de votre aide comme un sommaire.
Ce fichier est à fournbir avec votre aide (fichier HLP).
Toujours dans le programme cliquez sur "File/New" et sélectionnez
"Content file". Cliquez sur le bouton "Edit..." en haut
à droite et selectionner le fichier HLP ("monaide.hlp") suivit de
la fenêtre d'affichage ("Main") et du titre de l'aide
("Bienvenue" par exemple).
Il faut ajouter une rubrique. Cliquez sur "Add Above", sélectionnez
"heading" et tapez le titre ("Rubrique 1" par exemple).
Il en est de même avec les liens de la rubrique. Cliquez sur "Add
below", sélectionnez "Topic", et taper son intitulé
("Ma page 1") avec le nom de la page ("IDH_PAGE1") au
dessous.
Sauver et fermer la fenêtre du fichier CNT.
Dernier
réglage et compilation
De retour dans la
fenêtre du projet de votre aide, il cliquez sur "options" puis sélectionnez
l'onglet "Files" et dans le champ "Content file", sélectionner
le chemin de votre fichier CNT. Validez.
Il faut maintenant compiler pour en faire un fichier HLP. Cliquez sur
"File/Copile", décochez "minimize window while compiling"
mais cochez la case "Automaticaly display help file when done". Il
ne reste plus qu'a cliquez sur "Compile".
Voila, vous venez de faire un premier fichier aide. Lorsque vous distribuerez
votre fichier d'aide, n'oubliez pas le fichier CNT.
Téléchargez
ici le fichier
exemple (6 Ko).
Les
fichiers d'aide et Delphi
Il manque un dernier
point pour utiliser de manière optimale les fichiers d'aide, c'est de les
utiliser dans un programme Delphi. Il faut dans un premier temps, définir
le fichier HLP à utiliser dans les options du projet.
Voici la liste des commandes pour utiliser les fichier HLP.
|
Listes
des commandes d'aide
|
| Commande |
Commentaire |
| Application.HelpCommand(HELP_FINDER, 0); |
Lance le
fichier d'aide de votre application. |
| Application.HelpCommand
(HELP_QUIT, 0); |
Fermer le
fichier d'aide de votre application |
| Application.HelpCommand
(HELP_CONTEXT, 0); |
Affiche
l'index numéro 0. |
|