Création et utilisation d’un fichier de mappage d’aide contextuelle

Vous pouvez appliquer des marqueurs CSH pour spécifier l’emplacement d’aide·contextuelle spécifique dans votre document FrameMaker. Vous devez ensuite créer un fichier de mappage d’aide (avec une extension.h). Les développeurs d’application utilisent le fichier de mappage pour associer des parties spécifiques de l’application (par exemple, les boîtes de dialogue ou les éléments de menu) aux rubriques d’aide correspondantes.

  1. Ajoutez les marqueurs CSH dans la source FrameMaker.

  2. Créez un fichier texte dans n’importe quel éditeur de texte et nommez le fichier comme suit°:

    <nom du livre ou document source>.h.

  3. Placez le fichier de mappage dans le dossier source FrameMaker.

  4. Pour chaque marqueur CSH appliqué dans votre document, vous devez créer un élément de ligne dans le fichier de mappage comme suit°:

    #define <map ID> <map number>
    ID de mappage

    Nom spécifié pour le marqueur CSH

    numéro de mappage

    Identificateur numérique unique fourni par les développeurs de l’application. Vous pouvez toutefois fournir n’importe quel numéro comme marque de réservation.

    A titre de référence, la procédure de publication de FrameMaker crée également un fichier de mappage type°:

    1. Exécutez la procédure de publication pour votre document.

    2. Dans l’Explorateur Windows, accédez au dossier de sortie.

      Si le contenu source contient des marqueurs CSH, un fichier <nom du livre ou document source>_Generated.h est créé au même niveau que le dossier de sortie.

      Exemple : pour la sortie d’un livre nommé framemaker-publisher.book, le fichier de mappage est framemaker-publisher.h.

    Vous pouvez utiliser ce fichier .h comme référence pour créer votre fichier de mappage.

    Vous devez créer votre fichier de mappage au même format que ce fichier .h.

    Important: Le fichier <nom du livre ou document source>.h est créé au même niveau que le dossier de sortie et non à l’intérieur du dossier de sortie.
  5. Après avoir ajouté tous les marqueurs CSH à votre fichier de mappage, fournissez ce dernier à l’équipe de développement du produit.

    L’équipe de développement du produit peut utiliser les identificateurs uniques que vous avez inclus dans le fichier. L’équipe produit peut également modifier les identificateurs, si nécessaire, et renvoyer le fichier mis à jour.

  6. Copiez le fichier de mappage mis à jour dans le dossier source FrameMaker.

    Assurez -vous que le nom du fichier correspond à <nom du livre ou du document source>.h.

  7. Exécutez la procédure de publication.

    Les marqueurs CSH sont désormais inclus en tant qu’ancrages dans la sortie publiée. Vous pouvez maintenant tester la fonctionnalité d’aide contextuelle du produit.

Pour implémenter l’aide contextuelle dans une application, vous devez inclure les marqueurs CSH dans la documentation comme décrit ci-dessus. De plus, votre équipe produit doit également ajouter cette fonctionnalité à l’application. Pour une description détaillée de la fonctionnalité d’aide contextuelle et la manière de l’utiliser, consultez Travailler avec l’aide contextuelle dans le guide d’utilisation RoboHelp.