Flux de travaux de création et publication de contenu avec FrameMaker et RoboHelp

Si votre environnement de création et publication de contenu inclut ces deux outils, vous disposez de plusieurs options pour incorporer leurs atouts dans votre flux de travaux.

Vous pouvez mapper les formats FrameMaker directement aux styles RoboHelp par le biais d’une feuille CSS standard garantissant une apparence et un comportement cohérents tout au long du projet. De plus, dans FrameMaker, vous pouvez utiliser des marqueurs pour mettre en évidence les rubriques contextuelles, que vous pouvez ensuite réutiliser directement dans RoboHelp pour créer un système d’aide contextuelle.

FrameMaker et RoboHelp en tant que produits indépendants
Si vous utilisez FrameMaker et RoboHelp en tant que produits indépendants, vous pouvez conserver votre flux de travaux de création de contenu. Dans ce flux de travaux, vous créez du contenu dans FrameMaker pour l’enregistrer au format PDF et l’imprimer. Ensuite, vous utilisez RoboHelp pour générer une aide en ligne richement mise en forme. FrameMaker et RoboHelp fournissent tous deux des fonctionnalités avancées pour l’importation de contenu FrameMaker dans les projets RoboHelp. Vous pouvez également les utiliser ensemble pour créer des formats d’aide en ligne tels que WebHelp et un format basé sur Adobe AIR.

FrameMaker comme moteur de publication multicanaux et multipériphériques
FrameMaker 12 intègre une solution de multicanaux et multipériphériques. Cette solution vous permet de publier aux formats de sortie suivants à partir de FrameMaker, donnant ainsi aux lecteurs un accès à vos documents sur différents périphériques et avec différents facteurs de forme :

  • Responsive HTML5

  • WebHelp

  • ePub

  • Kindle

  • Microsoft HTML Help

Remarque : Cette solution ne nécessite pas d’installer RoboHelp ni Adobe Technical Communication Suite.

Adobe Technical Communication Suite 
Adobe® Technical Communications Suite fournit aux spécialistes en communication technique un flux de travaux rationnel qui leur permet de créer du contenu de façon unique et de le diffuser dans plusieurs formats. Vous pouvez créer du contenu dans FrameMaker et publier un document PDF à la mis en forme riche pour l’impression ou pour la visualisation en ligne. Technical Communication Suite offre davantage de fonctionnalités que les applications individuelles qui composent la suite. Vous pouvez intégrer la création et la publication de contenu dans FrameMaker et RoboHelp et lier de manière dynamique le contenu de ces deux applications.

Adobe Technical Communication Suite inclut Adobe Captivate et Adobe Photoshop, des outils qui vous permettent d’inclure de riches fonctions multimédia dans vos documents. En outre, Adobe Acrobat vous permet de configurer des révisions partagées et de regrouper les commentaires de révision et les corrections. Vous pouvez ensuite importer le tout dans vos documents FrameMaker.

    Eléments de création à prendre en compte afin d’optimiser la sortie en ligne

    Si votre processus de création de contenu dans FrameMaker est optimisé pour l’impression, lisez ce qui suit avant de lier ou d’importer des documents FrameMaker dans des projets RoboHelp.
    Formats de titre
    Déterminez les mappages les plus appropriés entre les formats de titre FrameMaker et les styles RoboHelp. Les documents FrameMaker définissent différents formats de titre spécialement destinés à la documentation imprimée. Ces formats comprennent notamment les titres de marge et les styles de titre commençant sur une nouvelle page. Ces formats ne s’appliquent pas aux documents en ligne. Vous pouvez généralement établir une correspondance entre ces styles de titre et un certain nombre de styles standard dans un projet RoboHelp.

    Paramètres de mise en page
    Les modèles de chapitre FrameMaker indiquent souvent un nombre de pages pair pour que les nouveaux chapitres puissent commencer au recto d’une page (à droite). Cette pagination ne s’applique pas à une aide en ligne.

    En-têtes et pieds de page
    RoboHelp ignore les en-têtes et les pieds de page lors de la conversion, y compris les mentions légales ou le texte de copyright. Vous devez inclure ce type de texte dans les en-têtes ou pieds de page de manière séparée, une fois la conversion effectuée. De même, dans RoboHelp, vous devez recréer le texte ou les images en filigrane de la documentation imprimée.

    Navigation
    Dans un document imprimé, les références croisées indiquent des numéros de pages qui n’ont aucune utilité dans l’aide. La conversion en aide en ligne supprime les titres de chapitres ou de sections dans les en-têtes et les pieds de pages. Il est possible d’améliorer la navigabilité en utilisant les chemins de navigation et les boutons Précédent et Suivant à la place.

    Contenu redondant
    Afin de fournir un contexte dans différentes sections d’un document imprimé, les rédacteurs ajoutent souvent des informations redondantes, telles que des résumés succincts de concepts abordés précédemment. Etant donné que l’aide en ligne est un support non linéaire dont l’accès est aléatoire, son contenu devrait être moins redondant. Utilisez des références croisées et des options de texte conditionnel afin de réduire la quantité de contenu redondant dans vos sorties.

    Chapitres et rubriques
    Dans la documentation imprimée, les chapitres signalent des unités logiques autonomes, que les lecteurs utilisent pour saisir la portée du contenu. L’aide en ligne segmente le contenu au niveau des rubriques, lesquelles sont accessibles individuellement. Vous pouvez regrouper le contenu en dossiers qui se développent lorsqu’un utilisateur parcourt la table des matières (comme des chapitres). Même ainsi, une seule rubrique s’affiche à la fois. Dans ce cas, essayez de fournir des informations complètes sans redondance en regroupant les rubriques connexes.

    Contextualité
    Bien qu’il soit possible d’associer des ID de mappage aux rubriques dans RoboHelp, vous pouvez également attribuer des marqueurs d’aide contextuelle dans des documents FrameMaker. RoboHelp lit ces marqueurs et attribue les ID de mappage aux rubriques générées. Vérifiez que les rubriques créées dans FrameMaker contiennent suffisamment d’informations.

    Par exemple, une procédure courte sous forme d’une rubrique autonome ne fournit pas de contexte conceptuel au lecteur. Pour éviter de créer des rubriques avec des informations incomplètes, associez les marqueurs d’aide contextuelle aux rubriques à un niveau supérieur. De cette manière, la rubrique d’aide générée contient le concept, la procédure et les graphiques correspondants.

    Préparation des documents FrameMaker pour les convertir en fichiers d’aide

    Si le document FrameMaker que vous importez est un livre FrameMaker non structuré, vous pouvez définir un modèle FrameMaker unique pour la conversion. Vous pouvez ensuite spécifier ce modèle comme modèle de projet qui remplacera les formats des documents particuliers au niveau du projet RoboHelp. Vous pouvez également réutiliser les paramètres de conversion dans d’autres projets en les exportant.

    Portez une attention toute particulière aux modèles FrameMaker avant d’importer les documents dans RoboHelp, notamment quand vous utilisez un modèle FrameMaker à usage général. Si ce modèle contient des formats qui ne sont pas utilisés dans le livre, ignorez ces formats dans le modèle que vous utilisez pour la conversion.

    1. Créez un modèle FrameMaker contenant les formats dont vous avez besoin dans l’aide. Vous pouvez également personnaliser le modèle FrameMaker. Vous n’avez pas besoin d’appliquer le modèle manuellement. Vous pouvez configurer RoboHelp pour qu’il applique un modèle sélectionné aux fichiers FrameMaker avant qu’ils soient liés ou importés dans RoboHelp.

      Dans FrameMaker structuré, le document de définition des éléments (fichier EDD) ou le fichier DTD utilisé dans le modèle FrameMaker structuré contrôle automatiquement la mise en forme. Comme FrameMaker structuré applique un format et une structure valides, les documents structurés ne contiennent pas de formats personnalisés.

    2. Créez les effets HTML dynamiques requis, tels que du texte à développer et du texte déroulant, à l’aide des menus RoboHelp dans FrameMaker.

    3. Appliquez des marqueurs d’aide contextuelle aux rubriques appropriées.

    4. Entourez de cadres ancrés les graphiques, les légendes et les cadres graphiques ou de texte que vous avez créés avec les outils graphiques de FrameMaker. RoboHelp importe uniquement les graphiques FrameMaker qui sont entourés de cadres ancrés.

      Par défaut, les graphiques et les fichiers multimédia importés dans un document FrameMaker sont placés dans des cadres ancrés. Si votre document FrameMaker contient des graphiques dans des cadres graphiques, placez-les dans des cadres ancrés avant de lier ou d’importer les fichiers FrameMaker dans RoboHelp.

    5. Pour préserver la qualité d’origine des images, insérez-les dans des documents FrameMaker par référence. RoboHelp copie les images référencées directement à partir de la source si l’image complète est visible à l’intérieur du cadre ancré. De même, si les images sont volumineuses, insérez-les dans le document source par référence.

    6. Corrigez les problèmes éventuels, tels que des références croisées non résolues, des polices manquantes et des problèmes de numérotation irrégulière.

    7. Configurez un texte ou des légendes de substitution pour les images et les graphiques afin de créer un contenu en ligne accessible.

    8. Appliquez des paramètres de texte conditionnel dans les documents FrameMaker.

    9. Modifiez les pages de référence de la table des matières FrameMaker afin de placer les titres hiérarchiques en retrait avec des styles différents.

    Options de liaison pour les documents

    Lorsque vous liez un document à un projet RoboHelp, deux possibilités s’offrent à vous : Pour spécifier les options de liaison propres, dans RoboHelp choisissez Fichier > Paramètres du projet. Cliquez sur l’onglet Importer et sélectionnez l’une des options suivantes :
    Créer une référence
    Vous créez une référence à un document externe. Dans ce cas, le document source n’est pas copié dans le dossier du projet RoboHelp et reste en dehors du projet. Toutefois, le document est visible dans le conteneur Gestionnaire de projets. Vous pouvez modifier et mettre à jour le document source de façon indépendante. Par la suite, dans RoboHelp, vous pouvez mettre à jour les rubriques générées à partir du document lié.

    Utilisez l’option de liaison par référence pour importer le contenu partagé entre plusieurs projets. Comme une seule copie du document existe, toutes les modifications apportées au document source sont répercutées dans tous les projets auxquels ce document est lié.

    Créer une copie et un lien
    Vous créez une copie du document source et la liez au projet RoboHelp. Dans ce cas, une copie du document source est copiée dans le projet RoboHelp et est visible dans le conteneur Gestionnaire de projets. Vous pouvez modifier et mettre à jour la copie sans affecter le document source. Vous mettez à jour les rubriques générées à partir du document copié chaque fois que vous modifiez le document.
    Utilisez l’option Créer une copie avec liaison pour conserver le document dans RoboHelp et restreindre l’accès au document source. Cette solution permet de modifier uniquement la copie disponible dans le projet RoboHelp. Par exemple, si vous souhaitez importer du contenu à partir d’un document FrameMaker statique, liez le document en le copiant dans le projet RoboHelp.
    Remarque : les livres FrameMaker sont toujours liés par référence, indépendamment de l’option de liaison que vous choisissez.

    Compromis entre la liaison et l’importation

    • Liez des documents FrameMaker et Word lorsque l’intégralité de la création de contenu s’effectue dans l’un de ces outils, ou les deux. Vous pouvez tirer pleinement parti des fonctionnalités d’intégration avancées de RoboHelp, telles que la conversion des tables des matières, des index et des glossaires, ainsi que la création de l’aide contextuelle. Chaque fois que le contenu source est modifié, vous pouvez rapidement mettre à jour les rubriques générées dans RoboHelp à partir des documents liés. Dans ce cas, RoboHelp convertit en quelques clics vos documents FrameMaker ou Word en plusieurs sorties, avec peu de création de contenu natif (voire aucune) dans RoboHelp.

    • Importez les documents FrameMaker et Word lorsque vous avez plusieurs documents indépendants et utilisez avec précaution les fonctionnalités d’intégration de RoboHelp. En outre, assurez-vous que les documents que vous importez sont stables et qu’ils ne nécessitent aucune mise à jour indépendante tant que vous n’avez pas terminé la publication de l’aide en ligne.

    • Evitez de modifier les rubriques générées dans RoboHelp afin de ne pas perdre vos modifications si vous devez mettre à jour ou remplacer les rubriques générées. Les rubriques générées à partir de documents liés peuvent être conservées avec leurs modifications, alors que les rubriques générées à partir de documents importés sont remplacées.

    • Si vous réalisez un nombre limité de modifications dans un projet RoboHelp, ne liez pas ni n’importez de documents dans RoboHelp. Cela peut perturber les paramètres créés à l’origine de la table des matières, de l’index, du glossaire, de la pagination et de l’aide contextuelle.

    Liaison et importation de documents FrameMaker

    Le flux de travaux RoboHelp visant à lier ou importer des documents FrameMaker vous permet d’effectuer les opérations suivantes :

    • Création d’un projet RoboHelp par l’importation d’un livre FrameMaker ou d’un fichier DITAMAP

    • Liaison ou importation d’un livre FrameMaker ou d’un fichier DITAMAP dans un projet RoboHelp

    • Liaison ou importation de documents FrameMaker dans un projet RoboHelp Vous pouvez importer des fichiers FM, MIF, DITA et XML.

    Lorsque vous liez un livre FrameMaker ou un fichier DITAMAP, aucun fichier HTML n’est créé tant que vous n’avez pas défini les paramètres du projet et généré les rubriques d’aide. Au même moment, vous pouvez voir les fichiers ajoutés dans leur ordre hiérarchique. L’importation de documents FrameMaker et la modification des fichiers HTML générés à partir de ceux-ci dans RoboHelp n’ont pas d’incidence sur les documents FrameMaker source.

    Avant d’importer des documents FrameMaker, vérifiez dans FrameMaker qu’ils ne comportent pas d’erreurs, telles que des références croisées non résolues et des formats personnalisés.

    Création d’un projet RoboHelp par liaison ou importation de livres ou documents FrameMaker

    Vous pouvez créer un projet RoboHelp en important des livres ou des documents FrameMaker.

    1. Sur la page de démarrage de RoboHelp, cliquez sur Plus sous Importer ou sélectionnez Fichier > Nouveau > Projet.

    2. Dans l’onglet Importer de la boîte de dialogue Nouveau projet, sélectionnez Document FrameMaker, puis cliquez sur OK.

      Importation d’un livre FrameMaker ou d’un fichier ditamap pour créer un projet RoboHelp

    3. Sélectionnez le livre ou le document FrameMaker dans le menu déroulant Fichiers de type. Ensuite, recherchez et sélectionnez le livre FrameMaker, puis cliquez sur Ouvrir.

    Importation d’un livre FrameMaker ou d’un fichier DITAMAP dans un projet RoboHelp

    1. Créez un projet ou ouvrez un projet existant dans RoboHelp.

    2. Sélectionnez Fichier > Importer > Document FrameMaker.

      Afficher le graphique en taille réelle
      Importation d’un livre FrameMaker ou d’un fichier ditamap dans un projet RoboHelp

    3. Sélectionnez Livre FrameMaker ou FrameMaker DITAMAP dans le menu déroulant Fichiers de type.

    4. Recherchez et sélectionnez le livre FrameMaker ou le fichier DITAMAP, puis cliquez sur Ouvrir.

    5. Si vous le souhaitez, sélectionnez un fichier DITAVAL et cliquez sur Ouvrir. Cliquez sur Annuler pour continuer la procédure sans fichier DITAVAL.

    Si vous importez un document FrameMaker, vous pouvez sélectionner les composants à importer dans l’assistant Paramètres de contenu qui s’affiche. Vous pouvez sélectionner la table des matières, l’index et le glossaire, puis spécifier les paramètres de conversion.

    Remarque : les documents FrameMaker créés dans des versions antérieures à la version 6.0 (fichiers FRM) peuvent être importés, mais pas liés.

    Liaison d’un livre FrameMaker ou d’un fichier DITAMAP dans le projet RoboHelp

    1. Créez un projet ou ouvrez un projet existant dans RoboHelp.

    2. Sélectionnez Fichier > Lier > Document FrameMaker.

      Afficher le graphique en taille réelle
      Liaison d’un livre FrameMaker ou d’un fichier ditamap dans un projet RoboHelp

    3. Sélectionnez Livre FrameMaker ou FrameMaker DITAMAP dans le menu déroulant Fichiers de type.

    4. Recherchez et sélectionnez le livre FrameMaker ou le fichier DITAMAP, puis cliquez sur Ouvrir.

    Remarque : les documents FrameMaker créés dans des versions antérieures à la version 6.0 (fichiers FRM) peuvent être importés, mais pas liés.

    Génération de rubriques HTML à partir de documents FrameMaker liés

    La liaison de documents FrameMaker ne crée pas automatiquement des rubriques. Vous générez les rubriques une fois que vous avez défini le projet et les paramètres de conversion.

     Effectuez l’une des opérations suivantes :

    • Cliquez avec le bouton droit sur le document FrameMaker lié à partir du conteneur Gestionnaire de projets, puis sélectionnez Mettre à jour > Générer.

    • Sélectionnez Fichier > Mettre à jour > Générer.

    En revanche, si vous importez un document FrameMaker, les rubriques sont générées immédiatement, conformément aux paramètres de conversion que vous indiquez. En outre, vous pouvez sélectionner les composants que vous voulez importer dans l’assistant d’importation qui s’affiche. Vous pouvez sélectionner la table des matières, l’index et le glossaire, puis spécifier les paramètres de conversion.

    Conversion d’une table des matières FrameMaker

    Lorsque vous importez un livre FrameMaker dans un projet RoboHelp, vous pouvez également importer la table des matières (TDM). Importez la table des matières dans le projet RoboHelp afin de conserver la structure de navigation définie dans le livre FrameMaker.

    1. Sélectionnez Fichier > Importer > Document FrameMaker.

    2. Dans la boîte de dialogue Paramètres de contenu, sélectionnez Convertir la table des matières FrameMaker, puis parcourez la liste et sélectionnez le fichier de table des matières FrameMaker.

    3. Sélectionnez l’une des options suivantes :

      Ajouter à la table des matières existante
      Ajoute les entrées de la table des matières à une table des matières RoboHelp existante dans le projet. Sélectionnez une table des matières RoboHelp existante dans la liste.

      Créer une nouvelle table des matières associée
      Saisissez un nom pour la nouvelle table des matières associée qui est ajoutée au projet RoboHelp.

    Les styles de la table des matières FrameMaker déterminent quels éléments deviennent des livres, des sous-livres ou des pages. Dans la détermination du niveau, l’élément le plus important est le retrait le plus à gauche, suivi de la taille de la police, puis de l’épaisseur de la police. Les entrées de la table des matières dont des éléments sont en retrait deviennent des livres dans la table des matières RoboHelp. Si toutes les entrées de la table des matières ont le même retrait, la même taille de police et la même épaisseur de police, la table des matières apparaît comme aplatie dans RoboHelp.

    • Pour transformer un titre en livre principal, incluez des niveaux de titre en retrait sous ce titre, ou utilisez une plus petite taille de police ou des polices qui ne sont pas en gras pour les autres titres.

    • Pour qu’un titre devienne un sous-livre, placez-le sous un titre principal. Incluez ensuite des niveaux de titre en retrait sous le titre du sous-livre, ou utilisez des polices de plus petite taille ou des polices qui ne sont pas en gras pour les autres titres.

    • Pour qu’un titre devienne une page, il est inutile d’inclure des niveaux de titre sous ce titre. Mettez en retrait le titre de la page, ou utilisez des polices de plus petite taille ou des polices qui ne sont pas en gras.

    Différences entre les tables des matières FrameMaker et RoboHelp

    Vous pouvez importer la table des matières FrameMaker ou créer automatiquement une table des matières dans RoboHelp à partir des rubriques générées.

    • Dans FrameMaker, la table des matières est générée en fonction des styles de titre que vous incluez dans la table des matières. Dans RoboHelp, la table des matières est générée en fonction des titres des rubriques. Si vous utilisez des marqueurs de nom de rubrique dans FrameMaker pour nommer les rubriques lors de l’importation des documents FrameMaker, les noms des fichiers dans RoboHelp diffèrent des titres des rubriques.

    • La création automatique d’une table des matières pour un livre FrameMaker 9 peut créer plusieurs calques de contenu en raison de la structure des dossiers dans le livre FrameMaker 9.

    • Dans RoboHelp, vous pouvez insérer un espace réservé de table des matières dans une autre table des matières, ce qui permet de créer des tables des matières imbriquées.

    Importation des entrées d’index FrameMaker

    RoboHelp crée un index en fonction des marqueurs d’index figurant dans le document que vous importez. Toutefois, le fichier d’index généré dans le livre FrameMaker n’est pas importé dans le projet RoboHelp.

    1. Sélectionnez Fichier > Importer > Document FrameMaker, puis sélectionnez le livre ou le document FrameMaker.

    2. Dans la boîte de dialogue Paramètres de contenu, sélectionnez Convertir l’index, puis l’une des options suivantes :

      Ajouter à l’index existant
      Ajoutez les entrées d’index FrameMaker à l’index RoboHelp existant du projet.

      Créer un nouvel index associé
      Saisissez un nom pour le nouvel index associé qui est ajouté au projet RoboHelp.

      Ajouter à la rubrique
      Ajoutez les entrées d’index FrameMaker aux rubriques particulières dans lesquelles elles apparaissent.

    Importation de définitions de glossaire

    RoboHelp crée un glossaire en fonction des marqueurs de glossaire définis dans le document que vous importez. Le texte situé à l’intérieur du marqueur de glossaire est le terme du glossaire et le texte du paragraphe qui contient le marqueur est la définition.

    1. Sélectionnez Fichier > Importer > Document FrameMaker, puis sélectionnez le livre ou le document FrameMaker.

    2. Dans la boîte de dialogue Paramètres de contenu, sélectionnez Convertir le glossaire, puis l’une des options suivantes :

      Ajouter au glossaire existant
      Ajoutez le glossaire FrameMaker au glossaire RoboHelp du projet. Vous pouvez sélectionner le glossaire dans la liste.

      Créer un nouveau glossaire associé
      Saisissez un nom pour le nouveau glossaire qui est associé au glossaire existant dans le projet RoboHelp.