Pagination, désignation des rubriques et aide contextuelle

Lorsque vous liez ou importez un document FrameMaker, vous devez définir la manière dont le contenu FrameMaker sera présenté en rubriques dans RoboHelp. Avec Technical Communication Suite, vous pouvez définir la pagination du contenu, la désignation des rubriques et faire correspondre les rubriques d’aide contextuelle pour l’intégration dans un produit.

    Eléments à prendre en compte pour la pagination et les titres des rubriques

    Déterminez les options de pagination adaptées à votre environnement en fonction des facteurs suivants :

    Exhaustivité du contenu de la rubrique
    Vérifiez que la rubrique générée contient des informations pertinentes et complètes pour le lecteur. Si, par exemple, vous définissez la pagination au niveau Titre 3 pour un paragraphe, il est possible que la rubrique contienne uniquement les informations de tâches, sans les informations contextuelles nécessaires abordées dans une autre rubrique de niveau Titre 3. Pour éviter de telles rubriques déconnectées, définissez la pagination à un niveau supérieur afin que toutes les informations nécessaires soient disponibles dans une même rubrique d’aide.

    Texte déroulant
    Vérifiez que le format de paragraphe du corps de texte déroulant n’est pas défini pour la pagination. Les paragraphes auxquels ce format est appliqué doivent accompagner le format de paragraphe de la légende du texte déroulant.

    Même s’il est facile de générer la pagination et le titre des rubriques en fonction des formats de paragraphe FrameMaker, cette approche présente les limites suivantes :

    Manque de contrôle au niveau des rubriques
    Etant donné que les paramètres de pagination sont définis au niveau du projet, vous ne pouvez pas exercer un contrôle discret sur les rubriques qui ne se trouvent pas dans les niveaux de titre définis. Par exemple, supposons que vous souhaitez transformer une rubrique de niveau H3 en rubrique d’aide distincte. Si vous définissez la pagination sur H2 pour votre projet, vous ne pouvez pas effectuer cette opération. La rubrique H3 est intégrée sous la rubrique qui se trouve immédiatement au-dessus.

    Convention de dénomination uniforme des rubriques
    Les rubriques d’aide utilisent les conventions de dénomination des fichiers que vous définissez dans les paramètres de conversion, en particulier si vous créez dans FrameMaker structuré. Vous ne pouvez pas déroger à ces conventions.

    Manque de souplesse dans les titres des rubriques
    Vous ne pouvez pas modifier de manière sélective les titres ou les noms de fichiers des rubriques sans modifier le contenu de la source. Lorsque vous recherchez du contenu dans RoboHelp, les titres des rubriques s’affichent dans la recherche. Une rubrique intitulée de façon intuitive aide le lecteur à identifier rapidement les informations les plus pertinentes dans les résultats de la recherche.

    Possibilité d’incohérence dans les documents à partir de plusieurs livres
    Les documents FrameMaker liés et importés à partir de plusieurs livres peuvent entraîner des disparités dans les styles de titre pour les rubriques générées.

    Par exemple, supposons que vous liez ou importez des documents FrameMaker à partir d’un guide de l’utilisateur et d’un guide de référence. Dans ce cas, les titres des rubriques peuvent répercuter les différences de style du contenu pédagogique et du contenu de référence. Si les titres des rubriques proviennent du texte du paragraphe sur lequel la pagination est définie, les titres des rubriques d’aide générées peuvent être différents.

    Avantages liés à la définition de la pagination dans FrameMaker

    Les marqueurs personnalisés dans FrameMaker vous permettent de contourner ces inconvénients pour les petits projets et d’effectuer les opérations suivantes :
    Créer du contenu basé sur un flux de travaux
    En utilisant de façon intelligente les marqueurs personnalisés de FrameMaker, vous pouvez créer des rubriques RoboHelp qui présentent des informations aux utilisateurs concernant le flux de travaux. Vous pouvez créer des rubriques d’aide, quels que soient les styles de titre appliqués dans le document FrameMaker.

    Le cas échéant, définir les titres de la rubrique
    Cette possibilité est utile lorsque vous voulez combiner de nombreuses rubriques et attribuer un titre pertinent à la rubrique associée, au lieu de faire dériver le texte du titre de rubrique à partir de l’un des styles de titre.

    Optimiser la longueur des rubriques
    Etant donné que vous définissez dans FrameMaker la façon dont les rubriques d’aide sont créées dans RoboHelp, vous pouvez contrôler avec précision la longueur appropriée pour les rubriques. Toutefois, si vous utilisez la mini-table des matières pour vos rubriques d’aide, limitez le nombre de titres dans chaque rubrique. Si la mini-table des matières est trop longue, son contenu risque de n’être accessible qu’en faisant défiler la liste.

    Après avoir défini ces marqueurs dans vos documents FrameMaker, vous pouvez définir les paramètres de conversion dans RoboHelp pour créer et nommer les rubriques selon vos préférences.

    Options de pagination

    Vous pouvez définir la façon dont le contenu FrameMaker est séparé sous forme de rubriques d’aide différentes dans RoboHelp.

    Créer des rubriques HTML distinctes en fonction des formats de paragraphe FrameMaker
    Dans FrameMaker, vous pouvez spécifier les styles de titre qui doivent être utilisés comme saut de page. Par exemple, si le fichier FrameMaker contient dix rubriques, chacune comportant des sous-rubriques, des tâches et des tableaux, vous pouvez convertir chaque rubrique en fichier HTML distinct. Si le format de chacun de ces titres de rubrique est Titre 1, vous pouvez faire en sorte que chaque rubrique Titre 1 soit créée sous forme de rubrique HTML distincte. En revanche, si vous définissez la pagination au format Titre 2, des fichiers HTML distincts sont créés pour chaque rubrique Titre 2.

    Définir des marqueurs de saut de page dans le contenu FrameMaker
    Vous pouvez insérer des marqueurs de saut de page en début de paragraphe dans les documents FrameMaker. En règle générale, les sauts de page sont créés au niveau des titres que vous choisissez. Si vous utilisez cette option, évitez de définir les paramètres de pagination en fonction des formats de paragraphe.

    Utiliser les marqueurs personnalisés définis dans FrameMaker
    Si vous convertissez du contenu existant dans FrameMaker qui utilisait des marqueurs personnalisés pour définir la pagination à l’aide d’autres outils, vous pouvez utiliser cette option. Evitez d’utiliser les marqueurs de saut de page dans ce type de document.

    Options de désignation des rubriques

    Vous pouvez définir comment les rubriques générées à partir de contenu FrameMaker seront nommées dans RoboHelp. Par défaut, vous pouvez définir le texte du paragraphe défini pour la pagination comme nom de rubrique. En outre, vous pouvez définir d’autres conventions d’affectation de noms. Si les noms de fichiers utilisent une numérotation séquentielle, telle que rubrique001.html et rubrique002.html, vous pouvez définir le modèle de ces conventions.

    Basé sur un texte de paragraphe
    Lorsque vous définissez des styles de titre pour la pagination, le texte de titre devient le nom de fichier par défaut du fichier de rubrique créé dans RoboHelp. Par exemple, supposons que vous définissez Titre 2 pour la pagination et que le document FrameMaker comporte deux rubriques Titre 2, « Introduction » et « Explication ». Dans ce cas, RoboHelp crée les rubriques introduction.htm et explication.htm. Par conséquent, vous obtenez des fichiers HTML nommés intuitivement qui indiquent les titres des rubriques.

    Modèle de nom de rubrique
    Les rubriques sont nommées en fonction du modèle sélectionné. Vous pouvez sélectionner l’un des modèles ci-dessous ou créer un modèle de nom de rubrique à l’aide des blocs fonctionnels Modèle de nom de rubrique fournis par RoboHelp. En outre, vous pouvez ajouter un texte statique standard, tel que « Rubrique », suivi d’un numéro séquentiel comme modèle de nom de rubrique.

    Bloc fonctionnel

    Modèle de nom de rubrique converti

    par défaut

    La rubrique HTML générée a un nom de fichier correspondant au texte du paragraphe.

    <$filename_no_ext>-<$paratext>

    La rubrique HTML générée a un nom de fichier correspondant au nom de fichier du document FrameMaker sans l’extension .fm, auquel est ajouté le nom de la rubrique, séparé par un trait d’union. Par exemple, le document FrameMaker intitulé « Chapitre.fm » ayant « 1.Introduction » comme texte de paragraphe est converti en rubrique HTML avec le nom de fichier « Chapitre-1-Introduction.htm ».

    <$filename_no_ext>-<n>

    La rubrique HTML générée a un nom de fichier correspondant au nom de fichier du document FrameMaker sans l’extension .fm, auquel est ajouté le numéro du paragraphe, séparé par un trait d’union. Par exemple, le document FrameMaker « Chapitre.fm » sera converti en rubrique HTML avec le nom de fichier « Chapitre-1.htm ».

    <$paratext_no_num>

    La rubrique HTML générée a un nom de fichier correspondant au texte du paragraphe du format de paragraphe sur lequel la pagination est définie, sans le numéro de paragraphe. Par exemple, un paragraphe de titre 1 « 1. Introduction » est converti en rubrique HTML avec le nom de fichier « Introduction.htm ».

    <$paraText>

    La rubrique HTML générée a un nom de fichier correspondant au texte du paragraphe du format de paragraphe sur lequel la pagination est définie. Par exemple, le paragraphe de titre 1 « Introduction » sera converti en rubrique HTML avec le nom de fichier « Introduction.htm ».

    Marqueur de nom de rubrique
    Vous pouvez utiliser les marqueurs de nom de rubrique dans le document FrameMaker pour créer des titres de rubrique et des noms de fichiers à partir du texte du marqueur. Si vous sélectionnez cette option, les paramètres de pagination appliqués dans le volet Styles de paragraphe sont ignorés. Utilisez cette option pour contrôler de manière précise la création de rubriques d’aide distinctes à partir de documents FrameMaker.

    Marqueur de saut de page
    Si vous créez un nouveau contenu dans FrameMaker et que vous ne souhaitiez pas utiliser des marqueurs personnalisés pour définir la pagination, vous pouvez utiliser le marqueur de saut de page. Lorsque vous définissez le titre de la rubrique, FrameMaker crée automatiquement le nom de la rubrique en fonction du titre de la rubrique.

    Evitez d’utiliser cette option lorsque votre document FrameMaker contient déjà des marqueurs personnalisés pour la pagination ou lorsque vous souhaitez définir la pagination en fonction des formats de paragraphe FrameMaker.

    Définition des paramètres de désignation des rubriques

    1. Sélectionnez Fichier > Paramètres du projet.

    2. Dans l’onglet Importer de la boîte de dialogue Paramètres du projet, cliquez sur Modifier, sous Document FrameMaker.

    3. Dans l’onglet Autres paramètres, sélectionnez l’option requise.

    Marqueurs d’aide contextuelle dans les documents FrameMaker

    Si vous utilisez Technical Communications Suite, vous pouvez définir les ID de mappage de l’aide contextuelle directement dans FrameMaker, en plus d’utiliser d’autres marqueurs.

    Vous pouvez convertir les marqueurs d’aide contextuelle que vous insérez dans vos documents FrameMaker et les réutiliser en tant qu’ID de mappage. Vous indiquez le marqueur d’aide contextuelle dans la boîte de dialogue Paramètres du projet avant de lier des documents FrameMaker. Vous pouvez également spécifier ce paramètre lorsque vous importez des documents FrameMaker. Vous pouvez utiliser les marqueurs d’aide contextuelle dans les documents FrameMaker de deux manières :

    Conversion automatique des ID de mappage à partir de documents FrameMaker
    Vous appliquez les marqueurs d’aide contextuelle dans vos documents FrameMaker et indiquez le type de marqueur dans les paramètres de conversion. RoboHelp importe les marqueurs des documents FrameMaker et ajoute les ID de mappage des chaînes contenues dans les marqueurs d’aide contextuelle.

    Ajouter manuellement des ID de mappage
    Vous pouvez utiliser les ID de mappage que vous avez reçus de votre équipe de développement de deux manières :

    • Dans FrameMaker, utilisez l’option de marqueur CSH pour saisir les ID de mappage des rubriques que vous souhaitez générer. Cette option est disponible uniquement si vous utilisez Technical Communications Suite.

    • Dans FrameMaker, utilisez l’ID de mappage comme texte pour le marqueur d’aide contextuelle que vous souhaitez utiliser. Lorsque vous liez ou importez les documents FrameMaker, vous indiquez le marqueur d’aide contextuelle dans les paramètres de conversion.

    Si vous optez pour la première solution, n’indiquez pas le marqueur d’aide contextuelle dans les paramètres de conversion.

    Définition du marqueur d’aide contextuelle

    1. Sélectionnez Fichier > Paramètres du projet.

    2. Dans l’onglet Importer de la boîte de dialogue Paramètres du projet, sous Document FrameMaker, cliquez sur Modifier.

    3. Dans le groupe Autres paramètres de la boîte de dialogue Paramètres de conversion, sélectionnez le marqueur d’aide contextuelle.