Accueil | Les fichiers d´aide standards | Composants Delphi | Téléchargements | Radios | Fichiers MIDI | Potager | Liens | Livre d´Or |
Introduction |
J´étais curieux de savoir comment réaliser un fichier d´aide et j´en avais marre de taper des fichiers texte en guise d´aide. Cette rubrique n´est pas un complet sur la création des fichiers d´aide, mais elle vous permettra de débuter dans ce domaine.
Un projet de fichier d´aide est composé au minimum de deux fichiers : le fichier de projet (*.HPJ) et le fichier contenu du fichier d´aide (*.RTF). Le fichier HPJ contient les données nécessaires à la compilation (Help WorkShop permet l´édition de ce fichier). Le fichier RTF rassemble toutes les informations qui seront dans le fichier d´aide. Il définit la structure du fichier d´aide avec ses rubriques, ses liens, ses images, et son système d´indexation des rubriques et de recherche par mot-clés. Un autre fichier (*.CNT) -facultatif- peut être créé lors que l´on veut proposer un menu des différentes rubriques sous forme d´arborescence.
Les outils |
Pour écrire des fichiers d´aide, plusieurs outils sont
nécessaires :
Le fichier RTF |
Dans votre traitement de texte, il faut afficher des commandes qui ne le sont pas habituellement :
Un fichier d´aide est divisé en rubriques. Une rubrique occupe au moins une page et chacune est séparée de la suivante par un saut de page. Une rubrique peut comporter du texte, des images et des liens vers d´autres rubriques.
Chaque rubrique possède un identificateur et un titre. Il est possible de préciser
les mots clés d´une rubrique pour faciliter la recherche d´informations. Les notes de pied
de page (footnotes) seront utilisées par le compilateur pour déerminer
l´identificateur, le titre et les mots clés de chaque rubrique.
Les notes de pied de page "de base" sont les suivantes :
Symbole | Fonction |
# | Identificateur de rubrique (ID) |
$ | Titre de la rubrique (facultatif) |
K | Mots clés de la rubrique (facultatif) |
Pour plus de commodité, lors de l´édition des fichiers RTF, je passe en affichage
Normal, je laisse les notes de pied de page visibles et j´ai ajouté une barre doutils
à mon traitement de texte :
Une rubrique commence toujours par une ou plusieurs notes de pied de page (footnote). La footnote # est obligatoire car c´est l´identificateur de la rubrique. Les footnotes $ et k sont facultatives : elles servent respectivement à définir le titre et les mots clés de chaque rubrique.
Le fichier HPJ |
Le fichier HPJ est un fichier texte qui regroupe les directives de compilation. Il est préférable de laisser sa maintenance au compilateur HCW. Pour le créér, utilisez File | New et Help Project dans la boite de dialogue. Placez ce fichier dans le même dossier que le fichier RTF.
Le fichier CNT |
Ce fichier est utile lorsque le fichier d´aide comporte des nombreuses rubriques. Help Workshop
permet de le créer : File | New et Help Contents dans la boite de dialogue.
Placez aussi ce fichier dans le même dossier que le fichier RTF. Comme le fichier HPJ, c´est
un fichier texte donc on laissera aussi la maintenance au compilateur HCW.
Il faut maintenant préciser le nom du fichier et de la fenêtre à utiliser
par défaut, le titre, et constituer notre arbre en fonction des thèmes des
différentes rubriques.
Les boutons sur la droite permettent de gérer les nouveaus items et les liens de
parenté entre eux.
Pour chaque nouvel item, plusieurs renseignements sont nécessaires :
Les zones fixes / défilantes |
Comme vous l´avez déjà pu le constaté, les fichiers d´aide ont le plus souvent une zone fixe en couleur où sont indiqués le titre de la rubrique et d´éventuels liens. Par défaut, une rubrique ne comporte pas de zone fixe et, dans le cas contraire, ne peut en contenir qu´une seule.
Pour positionner une zone fixe dans une rubrique, il suffit de donner au paragraphe qui
constitue la zone fixe l´attribut Paragraphes solidaires.
Dans Help Workshop, pour donner une couleur à une zone, il faut d´abord créer une
nouvelle fenêtre en utilisant le bouton Windows, nommer
celle-ci et sélectionner l´onglet Colors qui propose deux boutons : un pour la
couleur de la zone fixe et un pour la zone défilante.
Les images |
Il y a 3 formats d´image utilisables : BMP, WMF et EMF. Les 2 derniers formats sont ceux des images vectorielles, donc beaucoup moins volumineux que les bitmaps. De toute façon, le compilateur les comprime à la compilation. Insérer une image est facile et on peut le faire directement à partir des menus du traitement de texte. Facile, mais cette méthode présente deux inconvénients :
Pour pallier à ces inconvénients, il est possible d´insérer une image par référence. Il s´agit d´indiquer à l´intérieur du fichier RTF l´endroit où le compilateur pourra trouver l´image à afficher. La syntaxe typique est {bmc MonImage.bmp} (il en existe d´autres qui sont explicités dans l´aide de Help Workshop), où MonImage.bmp est le fichier image (qui est dans le même dossier que le fichier RTF) qui sera dans le fichier d´aide. On peut aussi insérer un hypergraphique (SHG).
Quelques mots sur les hypergraphiques ou Segmented Hyper Graphic (SHG)L´insertion d´un SHG dans un fichier d´aide ne peut se faire que par référence. Pour créer un SHG, il faut avoir de l´éditeur SHED (SHG Editor). Un SHG est une image au format vectoriel *.WMF ou BitMap *.BMP sur laquelle on définit plusieurs zones pouvant réagir à un clic de souris (un SHG ne possédant qu´une zone active ne présente aucun intérêt puisqu´un lien conduit au même résultat).
Après avoir ouvert un fichier d´image dans l´éditeur SHG, il faut définir les zones actives (HotSpots). Pour cela, on sélectionne avec la souris un rectangle de la taille désirée. Ce rectangle (on ne peut définir que des rectangles, contrairement aux ImageMaps des pages web) pourra ensuite déplacé ou redimensionné. Il ne reste ensuite qu´à configurer la zone active en y double-cliquant ou en choisissant la commande de menu Edit | Attributes. Les paramètres d´une zone sont :
Créer un SHG avec une seule zone active présente peu d´intérêt, à part le fait de profiter de la compression, puisque cela revient au même qu´un lien simple. Il ne reste plus qu´à enregistrer le fichier avec l´extension SHG dans le même dossier que le fichier RTF.
Les différents type de liens |
En dehors des liens classiques (de couleur verte et soulignés), il est possible de définir des liens d´aspect et de fonctions variés :
Un saut simple est constitué d´une étiquette doublement soulignée et d´une cible (Identificateur de rubrique) en caractères masqués. Il est conseillé de faire suivre la cible en caractères masqués d´un espace en caractère non masqué, pour éviter des problèmes de formatage de paragraphe.
Un lien peut avoir une couleur autre que la couleur verte. Il faut un lien classique (avec une étiquette doublement soulignée et une cible en caractères masqués). On place alors au début de la cible un astérisque * et on applique au texte de l´étiquette la couleur de son choix. Ceci dit, je préfère pour ma part utiliser les conventions habituelles pour ne pas perdre l´utilisateur.
Il suffit pour cela de créer un lien classique sauf que l´on met une image (de préférence par référence) à la place du texte de l´étiquette.
Un Pop-Up ouvrir une petite fenêtre temporaire au lieu d´ouvrir fenêtre complète. Un pop-up peut être généré à partir de texte ou d´une image et apparaît souligné en pointillés. La procédure ressemble à celle de la création d´un saut simple : un lien classique avec une étiquette mais simplement soulignée cette fois et une cible en caractères masqués.
il suffit d´utiliser un arobas @ pour spécifier le chemin et le nom du fichier d´aide qui contiendra la rubrique cible.
Une macro est une fonction qui est appelée depuis un fichier d´aide. Il existe de nombreuses macros dans WinHelp, mais il est possible d´ajouter ses propres macros. Pour créer un lien vers une macro, il nous faut un lien classique avec une étiquette doublement soulignée et une cible en caractères masqués, la cible étant ici la macro qui va être exécutée précédée par un point d´exclamation !. Voici quelques une des macros de WinHelp :
Exemple |
Rien ne vaut un exemple pour illuster tout cela.
Aucune garantie ne couvre les
problèmes pouvant résulter de l´utilisation du code contenu dans ce fichier.
Vous êtes libre de le copier et l´utiliser.
Fichier aide standard | |
Version : | - |
Licence / Prix : | Freeware / Gratuit |
Plate-forme(s) : | Windows 95, 98, NT |
Téléchargement (2691) : | ExAideStd.zip |
Mise à jour : 19/08/02