aide hlp avec help workshop

Accueil > Iza > Aide HLP
Ou Page précédente

Introduction

Vous êtes peut-être comme moi, un programmateur amateur et sentez le besoin d'ajouter un peu d'aide à vos créations. VisualBasic 6 de Microsoft vient avec une trousse d'outils qui peuvent vous aider. Cependant, ces mêmes outils peuvent sembler, d'un premier abord, un peu hermétiques. J'espère que ces quelques pages sauront vous faire paraître le tout un peu plus clair.

Vous trouverez quelque part dans le menu Démarrer > Programme le dossier Microsoft Help Workshop contenant les outils nécessaires à la création de fichiers d'aide HLP. Si vous ne le trouvez pas, peut-être n'a-t-il pas été installé.

Pour installer Help Workshop

1. Insérez le cd-rom d'installation de Visual Basic 6 et ouvrez l'Explorateur de Windows.
2. Sur le cd-rom, dans Common \ Tools \ VB. repérez le dossier hcw et ouvrez le. Il contient entre autres le fichier setup.exe.
   Il est aussi possible de télécharger Help Workshop depuis le site de Microsoft.
3. Vous pouvez soit :
• Démarrer l'installation depuis le cd-rom en double-cliquant sur le fichier setup.exe du cd-rom.
  ou
• Copier le dossier hcw et son contenu sur votre disque dur et démarrer l'installation en double-cliquant sur la copie de setup.exe qui se trouve maintenant sur votre disque dur.
4. Suivez les étapes de l'installation.

Après l'installation, vous devriez trouver quelque part sous Démarrer > Programmes le dossier Microsoft Help Workshop contenant les applications suivantes :

• Dialog Box Help Editor, que nous n'exploreront pas, du moins pour l'instant.
• Help Authoring Guide, les rubriques d'aide sur l'utilisation de ces logiciels.
• Help Workshop, le logiciel de création de fichiers d'aide.
• Hotspot Editor, le logiciel de création d'images réactives.

|   Haut de la page   |   Sommaire   |

---

Ms Word et les fichiers RTF

Tous sinon la plupart des logiciels de traitement de texte peuvent enregistrer au format RTF (Ritch Text Format) mais ne le font pas tous de la même manière.

En effet, si vous créez un fichier RTF avec Ms Word par exemple, et que vous l'ouvrez par la suite dans WordPad (traitement de texte par défaut de Windows) certaines mises en formes pourraient être perdues. WordPad par exemple ne gardera du format Titre 1 de Word que les attributs de police. Les attributs de paragraphes comme Paragraphes solidaires, qui permet de faire suivre sur une même page le titre et le paragraphe qui suit le titre, seront perdus.

Il en va de même si vous ouvrez le fichier RTF créé dans Word avec WordPerfect (version 8). Celui-ci effectue une conversion de format laborieuse (indiquée par une boîte de progression) qui supprime encore une fois une partie des attributs que Word avait laissé. Ce même fichier convertis par WordPerfect, si on l'ouvre dans WordPad perdra encore des plumes.

Ceci laisse l'impression à un utilisateur débutant en la matière (comme moi...) que Word ou même WordPerfect ne sont pas capables de créer des fichiers RTF purs. Et bien c'est faux ! Tout ceci n'est qu'une question de version de RTF. En effet, le codage des fichiers RTF dépend de différentes version du langage. Cependant WordPad sera plus à même de créer un fichier RTF transportable d'une plateforme à l'autre sans pertes décevantes. Car il arrive que Word refuse d'ouvrir un fichier RTF créé avec WordPerfect. À moins que ce ne soit l'inverse ! Tout dépendant des versions de traitements de texte testées...

Quoi qu'il en soit, je peux vous affirmer ceci : Tout comme les différentes version de navigateurs qui seront plus ou moins à même d'afficher correctement les documents HTML selons la version du langage utilisé, les logiciels de traitements de texte seront capables de décoder et d'afficher les fichier au format RTF que dans la version du langage et ses fonctionnalités pour lequel ils (les traitements de texte) ont été programmé.

De plus, voici ce qu'on apprend sur le site de Microsoft :

Microsoft Word 97 produces a rich text file that is incompatible with Microsoft Help Compiler 4.0. Microsoft is aware of this problem and has produced a new version of the Microsoft Help Compiler that will work correctly with Microsoft Word 97 files.

Ce qui signifie que Word 97 crée des fichiers au format RTF qui sont incompatible avec le Microsoft Help Compiler (hcw) version 4 et que Microsoft a réglé le problème avec la nouvelle version de Microsoft Help Compiler. Vous trouverez un peu plus haut un lien vers la page de téléchargement de cette nouvelle version.

J'ai trouvé sur Internet (en cherchant dans Beaucoup.com), le site Wotsit's Format qui répertorie les différents formats de fichiers existant et, quand c'est possible, les adresses où l'on peut trouver le texte de référence des formats en question. Vous pourrez y trouver les spécification du format de texte RTF (version Microsoft...). Pour porgrammeurs avertis... ou curieux invétérés (comme moi !).

Quel traitement de texte utiliser?

Le principal étant que le logiciel de traitement de texte que vous utiliserez soit capable de conserver dans le format RTF les mises en formes suivantes :

• En plus de la taille, gras, italique et souligné : l'attribut soulignement double.
• Les paragraphes solidaires (inclus dans les styles Titre 1, Titre 2, Titre n... de Word).
• Le texte masqué.
• Les sauts de pages.
• Les notes de bas de pages.

Dans cette rubrique nous utiliseront MS Word 97. Mais vous pourriez tout aussi bien utiliser un autre traitement de textes en vous assurant qu'il conservera les attributs mentionnés plus haut. C'est du moins ce que nous dit l'aide de Help Workshop. Pour ma part, je n'ai pas vérifié.

Testez votre logiciel de traitement de texte

Si vous possédez un autre logiciel que Ms Word et voulez être certain de pouvoir l'utiliser pour concocter vos fichiers d'aide, voici comment procéder :

1. Créez un nouveau document et tapez-y deux paragraphes. Attribuez au premier le style Titre 1. Vérifiez dans la boîte de dialogue appropriée (Style ou Paragraphe) si le style Paragraphe solidaire (ou quelque chose du genre) est activé pour ce style de titre. Si ce n'est pas le cas, sachez que n'importe quelle mise en forme (attribut de police comme la taille ou gras, rien de compliqué cependant) autre que le Titre 1 fera l'affaire pouvu que vous vous en teniez à des attributs de police simples qui ne risquent pas d'être perdus lors de l'enregistrement et que vous y ajoutiez manuellement l'attribut de Paragraphe solidaire.
    
2. Dans votre deuxième paragraphe, placez
• du texte souligné,
• avec soulignement double
• et du texte masqué (devrait être disponible dans la boîte de dialogue Police). Le texte mis en Texte masqué ne sera visible que si vous affichez les caractès non imprimables en cliquant sur le bouton  . Si vous utilisez WordPerfect, faites afficher la fenêtre de codes : Visualisaiton > Afficher les codes.
   
3. Placez votre curseur au début du titre et ajoutez une note de bas de page. Dans la boîte de dialogue Note, vous devez pouvoir remplacer le chiffre par un autre caractère comme un "#". Ajoutez quelques mots dans le texte de la note.
    
4. Ajoutez un saut de page après votre second paragraphe et tapez un peu de texte dans votre deuxième page. ATTENTION : un saut de page ne se crée pas en ajoutant des paragraphes vides (touche Entrée). Il faut passer par les menus Insertion > Sauts (ou quelque chose y ressemblant). Dans WordPerfect vous devez faire Insertion > Nouvelle page. Généralement, le raccourci de clavier CTRL + Entrée aboutit au même résultat.
    
5. Enregistrez au format RTF. Si votre logiciel vous informe que certaines mises en formes seront perdues, vous ne pourrez probablement pas utiliser votre traitement de texte pour créer les fichers d'aide hlp. Ce qui, je crois, est assez rare.

|   Haut de la page   |   Sommaire   |

---

L'utilisation de Help Workshop

Lorsque j'avais suivi avec d'autres mordus des cours en programmagion VB au service de la formation continue du Cégep de Rimouski, nous avions un cours de documentation de système où nous avions eu, entre autres, à créer des rubriques d'aide. Nous avions alors utilisé un logiciel gratuit EasyHelp permettant de créer plus simplement des fichiers d'aide. Ce genre de logiciel offre l'avantage de la simplicité mais malheureusement perd en contrôle de l'apparence des différentes fenêtres de l'aide que vous voulez créer. C'est pourquoi je privilégie l'approche plus laborieuse du logiciel fourni par défaut : Help Workshop.

Vous apprendrez à travers ces rubriques, d'abord à créer le fichier de rubriques (RTF), à y créer des liens, un index de mots clés, à y ajouter des images, à créer une fenêtre de départ avec un onglet sommaire, un ognlet Index et un onglet rechercher. Vous apprendrez aussi comment modifier l'apparence des fenêtres de rubriques, y afficher des boutons de navigation. Vous apprendrez donc à créer des fenêtres d'aide d'aspect professionnel.

Cependant, il existe bien d'autres logiciels qui pourront vous aider à créer vos documents d'aide. En fouillant sur le site de Programmers heaven vous pourrez trouver une liste d'outil d'édition de fichiers d'aide. Vous y trouverez, entre autres, un lien pour télécharger le logiciel Help & Manual 3.3.1 qui peut éditer des fichiers d'aide HTML et HLP, ainsi que des documents PDF dans un environnement WYSIWYG. Je ne l'ai pas encore essayé, mais selon les commentaires des utilisateurs, ça m'apparaît un bon choix.

|   Haut de la page   |   Sommaire   |

---

Des images réactives avec Hotspot Editor

C'est un petit logiciel tout simple et même un peu désuet d'aspect. Mais très efficace pour créer des images réactives qui vous permettront de créer des rubriques d'aide plus visuelles et plus interactives.

Voici à quoi ressemble l'interface de Hotspot Editor.

L'utilisation de Hotspot Editor est si simple que l'explication de son fonctionnement sera intégré à la rubrique explicant la création du fichier d'aide.

|   Haut de la page   |   Sommaire   |

---

HTML Help Workshop

C'est depuis quelques années la nouvelle tendance (plus tout à fait nouvelle, en fait). Si les fichiers d'aide apportaient un bon soutien à l'utilisateur, ils avaient cependant un défaut que l'aide HTML corrige. Le retour à la fenêtre sommaire devenait à la longue lassant. Avec l'aide HTML, ces fenêtres sont toujours disponibles (bien qu'elles puissent être masquées).

Un autre désavantage des fichiers d'aide hlp est que vous ne pouvez insérer de liens vers votre site Web (ou d'autre sites) directement dans vos rubriques. Vous devez passer par une macro qui ouvrira un programme proposant les différents liens que vous voulez mettre en place ou encore prévoir ces liens dans le menu Aide de votre application. L'aide HTML étant basée sur le langage HTML vous permet d'emblée de faire ce genre de liens sans problèmes.

Voici en avant goût un aperçu de la fenêtre d'aide de HTML Help Workshop. Ça vous donnera une idée de ce que vous pourriez faire.

Windows 95 ne gère pas naturellement ce type d'aide. Cette nouvelle formule est apparue avec les versions plus récente de Windows. Mais si comme moi, vous roulez encore sous Win 95, et que vous avez sur votre machine des logiciels plus récents qui ne semblent pas avoir de rubriques d'aide bien que possédant l'option de menu, vous avez peut-être avantage à installer HTML Help Workshop. Ne serait-ce que pour pouvoir enfin consulter l'aide de vos logiciels plus récents.

Pour installer HTML Help Workshop :

1. Vous n'aurez pas de mal à repérer le dossier HTML Help qui se trouve à la racine du cd-rom d'installation de VisualBasic 6. Il contient le fichier htmlhelp.exe.
   Vous pouvez aussi télécharger le kit d'installation de HTML Help Workshop depuis le site de Microsoft.
2. Vous pouvez soit :
• Démarrer l'installation en double-cliquant sur htmlhelp.exe depuis le disque dur.
  ou
• Copier le fichier htmlhelp.exe sur votre disque dur et démarrer l'installation depuis votre disque dur.
3. Suivez les étapes à l'écran.

|   Création de fichiers d'aide HLP   |   Création de fichiers d'aide HTML   |

---

|   Haut de la page   |   Sommaire   |