Copyright: WYSI-Help1.21   875770417 ® DDTEC


Présentation générale

HelpMaker propose un outil de transformation automatique de documents en fichiers hypertexte.

Cette transformation peut être utilisée pour rendre des documents existants consultables à l'aide du moteur d'aide de Windows.

De cette façon, la génération de l'aide en ligne d'une application à partir de son manuel se fera en grande partie automatiquement. Cette approche présente deux avantages :

Une seule rédaction et une seule saisie suffiront. Une fois le manuel créé, vous générerez l'aide en ligne après quelques clics à la souris. Vous gagnerez du temps et vous pourrez ainsi vous concentrer sur le contenu et sur la rédaction.

Pour l'utilisateur les choses deviendront plus faciles car il retrouvera dans le manuel et dans l'aide une homogénéité dans le contenu et dans la forme. Cette homogénéité améliorera l'efficacité du manuel et de l'aide.

Ce document décrit le fonctionnement et l'utilisation de la fonction d'importation de HelpMaker qui automatise la récupération de documents existants et leur transformation en fichiers hypertexte pouvant être consultés à l'aide du moteur d'aide Windows.


Principes

La transformation de documents en fichiers hypertexte repose sur la lecture de fichiers au format RTF et à leur transformation en fichiers exploitables par l'éditeur de rubriques HelpMaker.

Les fichiers au format RTF seront produits à l'aide de n'importe quel outil (Traitement de texte, PAO) capable de générer le format RTF.

Au cours de la transformation, l'outil d'importation va analyser le document et utiliser sa structure pour déterminer un découpage en rubriques. De façon interactive, vous pourrez intervenir pour paramétrer les règles de découpage que vous souhaitez utiliser et visualiser leur effet.

Vous pourrez également demander à ce qu'une rubrique d'index (table des matières du fichier hypertexte) soit automatiquement créée avec des liens hypertexte sur chacune des rubriques générées par l'importateur.

Comme il est parfois nécessaire d'avoir certaines explications dans le manuel et pas dans l'aide, l'importateur vous permet aussi de définir automatiquement des portions de manuel à ne pas importer.

Pour cet ensemble de services, l'importateur repose sur l'utilisation de styles dans le document à importer.

Enfin sachez que l'importateur peut aussi, à votre demande, utiliser les entrées d'index pour générer automatiquement les mots clés de recherche qui pourront servir, sous le moteur d'aide, à accéder aux rubriques d'aide.

Si vous avez déjà eu l'occasion de développer des fichiers hypertexte avant d'utiliser HelpMaker, vous pourrez aussi les transformer facilement en fichiers HelpMaker. L'importateur dispose en effet d'une option qui vous autorise leur importation. Dans ce cas, l'importateur interprète tous les codes RTF décrivant la structure du fichier hypertexte qui se trouvent déjà dans le fichier.


Mise en oeuvre

La mise en oeuvre de l'importation se fait en choisissant les règles d'importation à  appliquer selon les étapes suivantes :

- choix du type de fichier RTF à importer :

- document (manuel),

- fichier avec enrichissements hypertexte,

- sélection des principes de découpage en rubriques :

- sauts de page

- changement de styles,

- choix du style des titres servant au découpage en rubriques,

- sélection des rubriques à importer,

- choix du style des textes à ne pas importer,

- organisation de l'index créé automatiquement.


Choisir le fichier à importer

Le choix du fichier à importer se fait par le choix Ouvrir du menu Fichier. Ce choix conduit à la boîte de dialogue suivante :

Vous choisissez alors le nom et le chemin d'accès du fichier avant de valider à l'aide du bouton Ok.

L'importateur vous demande alors de choisir le mode d'importation que vous souhaitez appliquer.


Choisir un mode d'importation

La boîte de dialogue suivante :

vous permet de choisir le mode d'importation que vous souhaitez selon l'origine du fichier RTF que vous voulez importer.

S'il s'agit d'un document (manuel existant par exemple) vous sélectionnerez le bouton Document alors que vous sélectionnerez le bouton Fichier hypertexte si le fichier à importer dispose déjà des codes RTF spécifiques à la création de fichiers d'aide.

Dans ce dernier cas, l'importation pourra être lancée sans intervention supplémentaire de votre part. En effet ce sont alors les conventions de codification RTF des fichiers d'aide imposées par le compilateur d'aide qui définissent les règles d'importation. Aucun paramétrage particulier n'est à faire. L'importation sera lancée par le bouton Importer.

En revanche s'il s'agit d'un manuel, vous allez pouvoir définir la façon dont vous souhaitez que l'importateur traite votre document. En effet, c'est la structure du document qui va déterminer les règles de l'importation. Dans ce cas vous agirez sur le bouton Règles... pour aller définir les règles d'importation à appliquer.


Importer des fichiers hypertexte RTF existants

Quand l'importation est demandée avec l'option Hypertexte, l'importateur va considérer que le fichier RTF possède déjà des informations de type fichier d'aide.

Cette option est fondamentale car elle vous permet d'utiliser l'éditeur de rubriques de HelpMaker pour modifier un fichier d'aide qui existe déjà. Vous allez pouvoir changer d'outil et accéder à la puissance et à la simplicité de HelpMaker sans avoir à refaire ce que vous avez déjà commencé.

En effet si vous avez déjà commencé à créer de l'aide, quel que soit l'outil que vous avez utilisé, vous possèdez déjà un fichier RTF dans lequel vous avez inséré les différentes informations permettant au compilateur d'aide de traduire ce fichier en un fichier HLP.

Les informations que l'importateur va interpréter sont les suivantes :

sauts de page qui délimitent les rubriques :

l'importateur changera de rubrique lors de chaque saut de page rencontré dans le fichier RTF.

interprétation des indicateurs qui se trouvent en tête de chaque rubrique :

une rubrique commence par les caractères # $ K + (avec l'attribut exposant). Chaque caractère renvoie vers des informations qui se trouveront dans un texte constituant une note en bas de page :

#	ce caractère précède, dans la note en bas de page, l'identificateur de la rubrique. C'est cet identificateur qui sera donné à la rubrique et qui permettra ensuite d'accéder à la rubrique depuis Help Maker (c'est, en langage WinHelp, le context_Id de la rubrique).

$	ce caractère précède, dans la note en bas de page, le titre de la rubrique ainsi que les différents mots clés de recherche. C'est ce titre et les mots clés qui seront visibles au niveau du moteur d'aide, dans la fonction Rechercher et dans la fonction Historique.

K	ce caractère précède, dans la note en bas de page, les mots clés de recheche qui seront associés à cette rubrique. Les différents mots clés sont séparés dans la note en bas de page par des virgules.

Si la rubrique ne possède pas de mots clés de recherche associés, ce caractère ne sera pas présent en tête de la rubrique ni naturellement dans la note en bas de page.

+	ce caractère précède, dans la note en bas de page, les informations permettant de déterminer la place de cette rubrique dans une séquence de feuilletage.

Comme vous pouvez le constater si vous avez déjà développé de l'aide " à la main", l'importateur HelpMaker des fichiers hypertexte assure une récupération intégrale du travail que vous avez réalisé. Vous n'aurez plus qu'à profiter de l'interface WYSIWYGde l'éditeur de rubriques pour compléter rapidement votre aide.


Règles d'importation
Choisir les règles d'importation

Choix de la vue

Styles des titres

Styles ignorés

Titres

Rubrique index

Règles d'importation

Nouvelle rubrique sur :

   Saut de page

   Changement de titre

Ignorer certains styles

Créer rubrique index

Créer mots clés

Liens


Découper un document en rubriques d'aide

Quand vous souhaitez importer un document, vous devez indiquer comment découper le document en rubriques. Il s'agit là de la base du travail de transformation d'un document en fichier hypertexte.

En effet, alors qu'un document ne constitue qu'un seul fichier, un hypertexte est composé d'unités élémentaires (les rubriques). L'une des tâches essentielles que l'importateur doit prendre en charge consiste donc à déterminer où commence et où se termine chaque rubrique.

Comme le montre le groupe d'options Règles d'importation, deux options sont proposées.

Vous pouvez demander à ce que les rubriques soient créées sur la base du changement de page (saut de page forcé) ou sur la base du Changement de titre (option par défaut).

Saut de page :

Ce sera la seule méthode que vous pourrez raisonnablement employer si votre document ne comporte pas de titres que l'importateur pourrait reconnaître.

L'utilisation de cette option suppose, naturellement, que votre document contient des sauts de page forcés; il vous faudra donc les avoir insérés avant de demander l'importation avec une telle option.

Avec ce mode l'importateur affecte automatiquement un nom à chaque rubrique créée (voir Nommer les rubriques).

Changement de titre :

La plupart du temps votre document sera structuré (chapitres, sous-chapitres, sections, paragraphes...). Pour assurer cette structuration, vous aurez utilisé des titres et c'est la raison pour laquelle l'importateur vous propose d'utiliser par défaut lechangement de titre comme séparateur de rubriques.

Le guidage de la fonction d'importation va consister pour vous à sélectionner d'abord le style des titres séparateur de rubriques, et ensuite les titres eux-mêmes parmi tous ceux correspondant aux styles sélectionnés.


Choisir les rubriques à créer

Le principe de l'importation consiste à effectuer un découpage en rubriques sur la base de la structure de votre document telle qu'elle apparaît à travers les titres.

La détermination des rubriques à créer (parties du document à importer) se fait en choisissant d'abord les styles des différents titres qui vont délimiter les parties du document (voir Sélectionner les styles des titres).

Quand la boîte de dialogue de réglage de l'importation est ouverte, elle présente la liste de l'ensemble des styles qui se trouvent dans le fichier que vous voulez importer. Cela correspond à la vue Styles des titres.

Vous devez à ce stade sélectionner les styles correspondant à des titres.

Vous pouvez aussi indenter les styles que vous avez sélectionnés avec les flèches. Ceci permettra de hiérarchiser la liste des titres.

Pour vérifier que les styles sélectionnés correspondent bien aux titres délimiteurs que vous souhaitez, il vous suffit de changer le Choix de la vue et de sélectionner l'option  Titres. L'importateur parcourt alors tout le document afin de collecter l'ensemble des titres correspondant aux styles que vous avez choisis.

A partir de cette liste il vous est possible de retirer les titres des rubriques à ne pas créer (voir Sélectionner les titres de rubriques).

Remarques :

1.	L'opération de sélection va prendre quelques instants. En effet quand vous agissez sur ce bouton, l'importateur parcourt l'ensemble du fichier représentant le document pour en extraire tous les titres correspondant aux styles qui ont été retenus.

2.	L'extraction qui est faite concerne tout le texte constituant chaque paragraphe écrit dans l'un des styles choisis (si le texte ne contient qu'un caractère celui-ci n'est pas considéré comme titre).

3.	Si vous avez choisi des styles qui ne correspondent pas réellement à des titres dans le document, l'importateur va donc extraire des paragraphes dont la longueur est supérieure à la longueur habituelle d'un titre (dans ce cas l'importateur limite la taille des titres qui pourront être retenus à 128 caractères) et vous aurez probablement le message "Titre dupliqué" indiquant que le même texte a été trouvé deux fois.

Il s'agit là d'une erreur de votre part et vous devez changer la sélection des styles de titres.

4.	La liste des titres qui apparaît dans cette boîte de dialogue n'est autre que la liste des rubriques qui seront créées par l'importateur. Chaque rubrique créée recevra comme titre de rubrique le libellé du titre (voir Nommer les rubriques).

5.	Lorqu'un titre est sélectionné, la rubrique correspondante contient tout ce qui se trouve (textes, images) entre ce titre et le titre suivant.

6.	Lorqu'un titre n'est pas sélectionné, tout ce qui se trouve entre ce titre et le titre suivant n'est pas importé.


Nommer les rubriques

Comme un fichier hypertexte est constitué de rubriques, c'est-à-dire d'unités indépendantes consultables séparément, il est nécessaire de donner un nom à chaque rubrique.

Ce nom (appelé Context_Id dans le langage technique de WinHelp) identifie de façon unique chaque rubrique d'aide. Ce nom n'est jamais vu par l'utilisateur final qui consulte l'aide. Il ne sert qu'au créateur, soit pour établir les liens hypertexte entre rubriques, soit au développeur pour mettre en place une aide contextuelle.

Dans l'éditeur de rubriques de HelpMaker, cet identificateur sert à repérer et à accéder à chaque rubrique.

Le nom de la rubrique est affecté automatiquement par l'importateur.

Si les rubriques sont constituées sur la base des changements de titre, c'est le titre lui-même qui sert aussi comme identificateur de rubrique. L'importateur le débarassera seulement des caractères non permis (apostrophes, caractères accentués ...).

Si le changement de rubrique se fait sur les sauts de page forcés, l'importateur génère automatiquement le nom des rubriques sur la base d'un préfixe et d'un numéro.


Choisir les portions de document à ne pas importer

Quand vous construisez une aide, il se peut que vous ne vouliez pas inclure dans l'aide certaines portions de votre document. En effet certaines explications peuvent faire partie d'un manuel et ne pas avoir leur place dans un fichier hypertexte.

L'importateur vous propose deux niveaux pour ne pas intégrer dans l'aide certaines parties d'un document :

Dans la vue Titres, en désélectionnant un titre, vous indiquez à l'importateur de ne pas importer tout ce qui se trouve entre ce titre et le titre suivant.

En cochant l'option Ignorer certains styles, et en sélectionnant un ou plusieurs styles dans la vue Styles ignorés, vous pouvez définir des portions de texte à ne pas importer, à l'intérieur de rubriques qui sont elles-mêmes importées.


Organiser la rubrique index

L'importateur est en mesure de construire automatiquement une rubrique d'index (table des matières).

Quand l'option Créer rubrique index dans le groupe Règles d'importation est sélectionnée, l'option Rubrique index dans le groupe Choix de la vue devient utilisable.

Si vous la sélectionnez, la liste Composer l'index vous présente l'ensemble des titres correspondant à la sélection des styles que vous avez faite. Par défaut, tous les titres sont sélectionnés et en conséquence ils figureront tous dans l'index.

Si cette table des matières vous convient, tant dans son contenu que dans sa présentation, elle sera créée lors de l'action sur le bouton Importer. L'importateur créera alors une rubrique dite rubrique d'index, de nom Main Index, dans laquelle chaque titre possédera un lien hypertexte vers la rubrique correspondante à condition bien entendu, que cette rubrique ait été créée (ce qui n'est pas le cas si vous avez désélectionné le titre dans la vue Titre).

Si vous souhaitez enrichir sa présentation (police, taille de caractères, ajout de dessins...) il suffira d'aller éditer cette rubrique depuis l'éditeur de rubriques.

Vous pouvez aussi modifier directement la présentation de l'index grâce aux différents boutons qui sont présentés en dessous de la liste composant l'index :

Sélection

Vous pouvez sélectionner ou désélectionner un titre. Cela ne signifie pas que la rubrique de titre correspondant ne sera pas importée mais que le titre n'apparaîtra pas dans la table des matières.

Ordre

Vous pouvez modifier l'ordre des titres de l'index en agissant sur les flèches. De cette façon vous pouvez définir vous-même l'ordre dans lequel les titres seront listés dans la table des matières de l'aide.

Le bouton Ordre alphabétique vous permet de trier les titres par ordre alphabétique, tout en respectant la hiérarchie des titres (le tri se fera niveau par niveau).

Les titres de niveau 1 seront triés par ordre alphabétique les uns par rapport aux autres.

Sous chaque titre de niveau 1, les titres de niveau inférieur seront à leur tour triés par ordre alphabétique, etc...

Vous pouvez revenir à l'Ordre du document en agissant sur le même bouton.

Voir aussi : Composer l'index.


Ajouter des mots clé de recherche

Le moteur d'aide de Windows dispose d'une fonction rechercher qui sert à retrouver une rubrique d'aide à partir d'un mot clé.

Si votre document dispose d'un index (liste de mots référençant les parties du docu-ment), l'importateur HelpMaker peut récupérer cet index pour construire automatiquement une liste des mots clés de recherche associés à chaque rubrique.

Remarque :

L'importateur ajoute aussi à la liste des mots clés de recherche de chaque rubrique, le titre de la rubrique (voir Nommer les rubriques).

Cette capacité à créer une liste de mots clés de recherche se commande par la case à cocher Créer mots clés.


Créer des liens hypertextes

Pour créer des liens hypertextes, il faut tout d'abord choisir dans le groupe Règles d'importation l'une des deux options tous ou première occurrence de la liste lien  et choisir ensuite la vue Titre.

Si la présélection est sur un titre sélectionné, le bouton lien permet d'ouvrir la boîte de dialogue suivante :

Dans notre exemple, la présélection était sur "Titre 1.1.1" et la boîte de dialogue permet maintenant de définir les liens hypertextes qui appelleront la rubrique "Titre 1.1.1". Au départ, la boîte de dialogue contenait le titre de la rubrique comme lien par défaut. Nous l'avons enlevé en le présélectionnant dans la liste et en agissant sur le bouton Enlever. Puis nous avons défini quatre liens ; le dernier "albatros" étant du type popup.

Pour définir un lien, il faut entrer un texte de référence dans la zone Texte, sélectionner le type du lien et presser le bouton Ajouter.

Lors de l'importation, des liens hypertextes sont générés chaque fois qu'un texte de référence est rencontré dans une rubrique autre que la rubrique cible. Si l'option Première occurence a été choisie, le lien ne sera mis que sur la première occurrence du texte dans la rubrique.


Styles des titres
Quand cette option est sélectionnée, ce sont tous les styles qui apparaissent dans la liste.

A partir de cette liste, vous pouvez :

- retirer ou ajouter des styles,

- changer la hiérarchie.

Les titres correspondant aux styles sélectionnés serviront à découper le document en rubriques et à constituer l'index.


Sélectionner les styles des titres

Avant tout, vous devez sélectionner les styles des titres et les indenter si vous désirez que les titres soient hiérarchisés.

Dans l'exemple qui suit, les trois premiers styles sont sélectionnés et l'indentation définit une hiérarchie qui est ici fondée sur la taille de la police utilisée pour ce style :

Pour l'importateur, un style est composé de cinq attributs :

- Le nom de la police, Times New Roman dans l'exemple.

- L'attribut de la police qui peut être : normal, gras, italique, souligné, barré, indice, exposant.

- La taille de la police exprimée en points.

- La couleur du texte qui peut être : auto (couleur par défaut), Blanc, Marron, Marine, Pourpre, Vert clair, Jaune, Eau, Noir, Gris, Rouge, Bleu, Fuschia, Vert, Olive, Bleu, Vert, Argent.

- L'alignement du texte qui peut être : gauche, droit, centré, justifié.

Remarque : un style de titre est généralement gras et de taille supérieure au texte normal.


Sélectionner les titres de rubriques

Une fois que vous avez sélectionné les styles de titres, vous choisissez la vue Titre et l'importateur recherche les titres correspondants.

Avant de déclencher l'importation des rubriques vous pouvez sélectionner sur une base individuelle celles qui seront importées et celles qui ne le seront pas. Au départ, la vue Titres présente l'ensemble des titres:

Par défaut tous les titres sont sélectionnés, c'est-à-dire qu'ils feront tous partie de l'importation.

Dans notre exemple, les titres de niveaux 1 et 2 ne correspondent pas à des rubriques, car dans le document, ils ne sont suivis d'aucun texte. Ces titres ont donc été désélectionnés à l'aide des boutons Sélection et Etendre au niveau (aucune rubrique ne sera créée pour ces titres et ces titres ne seront pas importés).


Composer l'index

Si vous choisissez la vue Index,  vous pouvez sélectionner les titres qui apparaîtront dans l'index. Par défaut tous les titres sont sélectionnés, c'est-à-dire qu'ils feront tous partie de l'index.

Dans l'exemple, on a désélectionné "Titre 1.1.2" car ce titre ne doit pas apparaître dans l'index : c'est par exemple le titre d'une rubrique popup ou d'une rubrique qui ne doit être accessible que par mot clé.

Comme les titres de niveaux 1 et 2 ne correspondent pas à des rubriques, il n'y aura pas de liens hypertexte sur ces titres.

Notez que l'indentation des styles dans l'index est fondé sur la hiérarchie des titres.


Sauvegarde des règles d'importation

A la fermeture de la boîte de dialogue Règles d'importation, vous pouvez sauvegarder l'ensemble des règles que vous avez définies  dans un fichier d'extension CFG, qui se trouvera dans le même répertoire que votre fichier RTF.

Ce fichier sera ouvert automatiquement lors de la prochaine importation du fichier RTF.


Main Index
Importateur RTF

Généralités

Présentation générale

Principes

Mise en oeuvre

Les bases

Choisir le fichier à importer

Choisir un mode d'importation

Importer des fichiers hypertexte RTF existants

Sauvegarde des règles d'importation

Importer un document

Découper un document en rubriques d'aide

Choisir les rubriques à créer

Nommer les rubriques

Choisir les portions de document à ne pas importer

Organiser la rubrique index

Ajouter des mots clé de recherche

Créer des liens hypertextes

Traiter des documents hiérarchisés

Sélectionner les styles des titres

Sélectionner les titres de rubriques

Composer l'index


Quand cette option est sélectionnée, ce sont tous les styles qui apparaissent dans la liste.

A partir de cette liste, vous pouvez en sélectionnant certains de ces styles indiquer quelles sont les portions de texte qui ne devront pas être importées.


Quand cette option est sélectionnée, l'importateur parcourt tout le document en recherchant les titres correspondant aux styles de titres qui ont été retenus.

A partir de cette liste, vous pouvez sélectionner les titres de rubriques qui seront créées.


Quand cette option est sélectionnée, la liste présente la rubrique d'index.

Vous pouvez à partir de cette vue :

- retirer des titres de l'index,

- changer l'ordre des titres de l'index.


En sélectionnant cette option, vous indiquez que le découpage du document en rubriques se fera sur les sauts de page forcés.

Vous devez avoir placé ces sauts de page dans le document, avant l'importation.


En sélectionnant cette option, vous indiquez que le découpage du document en rubriques se fera sur les titres trouvés à partir des styles que vous aurez préalablement sélectionnés.


Si vous cochez cette option, c'est que vous ne voulez pas importer certaines portions du document.

Dans ce cas, l'option Styles ignorés dans le groupe Choix de la vue sera accessible pour vous permettre de choisir les styles de texte à ignorer.


Si vous cochez cette option, une rubrique d'index sera créée.

Dans cette rubrique, un lien hypertexte sera créé sur chaque titre correspondant à une rubrique importée.

En sélectionnant l'option Rubrique index du groupe Choix de la vue, vous pourrez arranger l'index à votre convenance.


En cochant cette option, vous indiquez que des mots clés de recherche doivent être définis pour chaque rubrique.

Pour une rubrique donnée, l'importateur prendra comme mot clé :

- le titre de la rubrique,

- toute entrée d'index présente dans le document.


En choisissant l'option tous, des liens hypertextes seront créés chaque fois qu'un texte de référence défini dans la boîte de dialogue Liens automatiques (accessible à partir du bouton Liens de la vue Titre) est rencontré dans une rubrique.

En choisissant l'option première occurrence, seule la première occurrence du texte est prise en compte.