Créer un fichier d'aide HLP


précédentsommairesuivant

I. Présentation

Vous avez créé un superbe programme, fonctionnel, intuitif, puissant, mais vous recevez régulièrement des e-mail vous demandant comment utiliser votre logiciel. Vous n'avez sans doute pas pensé à réaliser un fichier d'aide pour accompagner celui-ci. Voici un tutoriel qui va vous aider à en réaliser un en utilisant Microsoft Help Workshop, logiciel distribué avec toutes les éditions de Delphi.

Cet article a été initialement conçu pour les utilisateurs de Delphi, ceci explique que plusieurs allusions à Delphi soient faites.

I-A. Pourquoi utiliser le format HLP ?

Le format HLP est dit obsolète par rapport au format CHM mais, regardez l'aide de Delphi, ce sont quand même des fichiers au format HLP. Ceci pour une bonne raison : on peut plus facilement accéder à un fichier HLP depuis Delphi qu'à un fichier CHM et on peut même commander un fichier HLP avec Delphi (voir les méthodes et propriétés s'y rapportant dans l'objet TApplication). De plus, je persiste à croire qu'éditer un fichier RTF est plus facile que d'éditer un fichier HTML et je pense ne pas être le seul.

I-B. Qu'est-ce que Microsoft Help Workshop ?

Pour réaliser les fichiers d'aide, vous aurez besoin du logiciel Microsoft Help Workshop, distribué avec toutes les éditions de Delphi. Ce logiciel permet de réaliser non seulement le fichier .hlp mais également le sommaire au format .cnt (pour contents). Notez que ce logiciel est en anglais. Nous décrirons son utilisation tout au long de ce tutoriel.

I-C. Qu'est-ce que WinHelp ?

WinHelp est distribué avec Windows. C'est le programme qui permet à tout un chacun de consulter les fichiers d'aide au format .hlp.

I-D. De quoi ai-je besoin ?

Outre le programme Help Workshop, vous avez besoin d'un éditeur de fichiers .rtf (Rich Text Format). Par exemple Microsoft Word sera parfait. Je supposerai dans ce tutoriel que vous utilisez Word. Si cependant vous utilisez un autre éditeur, vous n'aurez probablement aucun mal à transposer les opérations décrites, à moins que votre éditeur ne supporte pas les styles Titre, le soulignement double ou le texte masqué.

 

I-E. Modèle Word HelpFile.dot

Si vous utilisez Microsoft Word comme éditeur RTF, vous pouvez utiliser le modèle HelpFile.dot pour créer vos fichiers RTF. J'ai réalisé ce modèle dans le but de réaliser des fichiers d'aide avec Microsoft Help Workshop. Il vous facilitera la vie en accélérant l'édition de vos fichiers .rtf.
Si ce lien ne fonctionne pas, essayez celui-ci.


précédentsommairesuivant

Vous avez aimé ce tutoriel ? Alors partagez-le en cliquant sur les boutons suivants : Viadeo Twitter Facebook Share on Google+   

Tutoriels
Les génériques avec Delphi 2009 Win32 (English version) - également disponible en espagnol et en russe
Réaliser un plug-in comportant un composant
Construire une procédure pointant sur une méthode
Création de composants - en 4 parties
Refactoring avec Delphi 2007
Prise en main de Delphi 2005
Analyseurs syntaxiques - Leur fonctionnement par l'exemple
Créer un fichier d'aide HLP
Pourquoi un paramètre const change-t-il mystérieusement de valeur ?
Sources
SJRDUnits - Routines et classes diverses
SJRDComps - Quelques composants
Projet Sepi
Présentation
FAQ Sepi
Programmes
FunLabyrinthe - Jeu de labyrinthe très spécial et très fun
TrickTakingGame - Jeux de cartes à plis en ligne
MultiAgenda - Agenda multi-répertoires
DecodeFormulaires - Décode les formulaires
Excel --> HTML - Convertisseur de tableaux Excel en HTML
AddressLinks - Lie les adresses Internet et e-mail d'un document HTML
Vipion - Tic Tac Toe sur 4x4 cases avec jeu de l'ordinateur
BigCalc - Calculatrice de haut niveau
Espace paroissial Astérion de Watermael-Boitsfort
  

Les sources présentées sur cette page sont libres de droits et vous pouvez les utiliser à votre convenance. Par contre, la page de présentation constitue une œuvre intellectuelle protégée par les droits d'auteur. Copyright © 2005 Sébastien Doeraene. Aucune reproduction, même partielle, ne peut être faite de ce site et de l'ensemble de son contenu : textes, documents, images, etc. sans l'autorisation expresse de l'auteur. Sinon vous encourez selon la loi jusqu'à trois ans de prison et jusqu'à 300 000 € de dommages et intérêts.