Génération de documentation

Vous pouvez générer des documentations pour les ressources de vos modules et de vos bibliothèques.

Pour générer une documentation, suivez ces instructions :

  1. Sélectionnez la ressource dans la vue Intégration métier.
  2. Cliquez sur Générer la documentation dans la barre d'outilsBouton Générer la documentation de la barre d'outils ou cliquez avec le bouton droit de la souris pour sélectionner Générer la documentation. L'assistant Génération de documentation s'ouvre.
    Remarque : Toutes les zones de cet assistant permettent d'utiliser la touche d'aide F1 pour vous aider à remplir les spécifications. A l'aide de la touche Tab, positionnez-vous sur la zone ou le bouton voulu, puis appuyez sur la touche F1 (Ctrl+F1 dans Linux) pour afficher l'aide supplémentaire.
  3. Dans l'assistant Génération de documentation, indiquez le nom de l'auteur, le titre de la documentation et l'emplacement du fichier PDF à générer. Le nom du fichier par défaut est reportFile.pdf et son emplacement par défaut est situé dans votre espace de travail. Pour savoir comment modifier le nom du rapport, consultez l'aide avec la touche F1.
  4. Vous pouvez accepter les valeurs par défaut et cliquer sur Terminer pour générer la documentation. Cependant, si vous souhaitez sélectionner des ressources supplémentaires pour les inclure dans la sortie ou modifier la disposition de la documentation, cliquez sur Suivant.
    Remarque : Si le bouton Terminer n'est pas activé, cela signifie que vous avez sélectionné une ressource que le générateur de documentation ne prend pas en charge. Cliquez sur Suivant pour créer un nouveau fichier principal. Vous pourrez ensuite sélectionner une ressource prise en charge par le générateur de documentation. Pour plus d'informations, voir "Documentation des ressources" sous les concepts connexes.
    1. Dans la page Sélection du contenu, indiquez si vous voulez personnaliser davantage le contenu de la sortie générée.
      • Sélectionnez Générer la documentation à partir de la ressource sélectionnée si vous ne voulez pas ajouter ou supprimer de ressources pour la génération de documentation.
      • Sélectionnez Générer la documentation à partir d'un fichier principal existant et un fichier principal pour réexécuter un profil de ressource déjà sauvegardé.
      • Sélectionnez Créer un fichier principal pour ajouter ou supprimer des ressources pour cette génération de documentation.
      Pour plus d'informations sur les fichiers principaux, voir "Documentation des ressources" sous les concepts connexes. Cliquez sur Suivant.
    2. Dans la page Editer le contenu de la documentation, vous pouvez ajouter et supprimer des ressources pour votre documentation. Sélectionnez une ressource et cliquez sur > pour l'ajouter au tableau Ressources d'entrée de documentation. Vous pouvez aussi sélectionner des éléments dans le tableau, puis cliquer sur < pour supprimer les documentations à générer. Cochez la case Inclure les fichiers référencés pour générer également des informations sur les artefacts référencés par les ressources sélectionnées. Pour plus d'informations sur les fichiers référencés, voir "Documentation des ressources" sous les concepts connexes.

      Le bouton Sauvegarder sous... enregistre le nouveau fichier principal afin de vous permettre de régénérer le même rapport avec le fichier principal. Cliquez sur Suivant.

    3. Dans la page Paramètres de présentation, sélectionnez la disposition à utiliser pour la documentation et cliquez sur Terminer pour générer la documentation.
      Remarque : Si vous modifiez les paramètres de présentation et de style, ils sont sauvegardés en vue des générations de documentation suivantes jusqu'à ce que vous les modifiez.
      Pour ajouter de nouvelles polices à la documentation, voir la section suivante, "Ajout de polices".
  5. Recherchez le fichier PDF à l'emplacement indiqué et ouvrez-le avec Acrobat Reader.

Ajout de polices

Si vous souhaitez ajouter de nouvelles polices pour les utiliser dans la documentation générée, lancez l'assistant Génération de documentation, puis cliquez sur Suivant jusqu'à ce que la page Paramètres de présentation s'affiche :

Page Paramètres de présentation de l'assistant Génération de documentation

Procédez comme indiqué ci-après :

  1. Cochez la case Remplacer les polices par défaut. Le bouton Polices... est alors activé.
  2. Cliquez sur Polices... et la page Paramètres de style de la documentation s'ouvre :

    Page Paramètres de style de la documentation

  3. Cliquez sur Gérer les polices... et la fenêtre Gestion des polices de la documentation s'ouvre.

    Fenêtre Gestion des polices de la documentation

  4. Cliquez sur le bouton Ajouter.... La fenêtre Ajout d'une police de documentation s'ouvre.

    Fenêtre Ajout d'une police de documentation

  5. Cliquez sur Parcourir pour accéder à la fenêtre Ouvrir ; recherchez le fichier TTF ou TTC et sélectionnez-le.
    Remarque : (Windows uniquement) Si vous souhaitez sélectionner des polices dans le répertoire Windows, par exemple WINNT ou WINDOWS, vous devez retaper le nom du fichier TTF ou TTC dans la fenêtre Ouvrir, qui est affichée ici :
    Fenêtre Ouvrir dans le répertoire WINNT
    . Par défaut, si vous cliquez deux fois sur le fichier dans le répertoire WINNT, Windows ouvre le fichier TTF ou TTC au lieu de le sélectionner. Pour faire une sélection, vous devez donc taper le nom. Pour utiliser la souris pour cette sélection, copiez le fichier TTF ou TTC dans un autre répertoire. Vous pourrez alors utiliser la souris pour cliquer sur le fichier de police et le sélectionner.

    Si un fichier TTC est sélectionné, entrez un nom de police valide.

  6. Cliquez sur OK dans la fenêtre Ajout d'une police de documentation pour terminer la sélection. La nouvelle police doit apparaître dans la fenêtre Gestion des polices de la documentation.
    Remarque : Dans l'assistant Génération de documentation, les noms des polices enregistrées, y compris les noms de polices DBCS, s'affichent uniquement en caractères latins.
  7. Cliquez sur OK pour revenir à la page Paramètres de style de la documentation dans laquelle vous pouvez maintenant sélectionner la nouvelle police des types de texte répertoriés.

La nouvelle police est maintenant enregistrée et disponible pour toutes les générations de documentation suivantes. Les polices par défaut ne peuvent pas être supprimées.

Référence associée
Documentation des ressources

Commentaires en retour
(C) Copyright IBM Corporation 2005, 2006. All Rights Reserved.