Ajout de documentation dans des bibliothèques de patterns

La bibliothèque de patterns conserve des informations sur ses patterns membres dans un fichier de données statique. Vous pouvez ajouter à ce fichier de manifeste de bibliothèque de la documentation destinée à l'utilisateur des patterns.

Un petit sous-ensemble des informations de bibliothèque s'affiche dans l'aide en ligne lorsque l'utilisateur d'un pattern clique sur l'élément de menu Afficher la documentation de pattern dans la vue Explorateur de patterns. Vous pouvez ajouter une brève description à ces informations de bibliothèque.

Le fichier de manifeste de la bibliothèque porte le même nom que celle-ci, avec l'extension .rmd.

Pour ajouter une brève description à la bibliothèque :

  1. Dans la vue Explorateur de package, repérez et développez le noeud PatternFiles dans le projet de pattern.
    Dossier PatternFiles développé d'un projet de pattern.
  2. Double-cliquez sur le fichier de manifeste de la bibliothèque pour l'ouvrir dans l'éditeur de manifeste RAS.
  3. Sur la page Actif, supprimez le texte par défaut dans la zone Description abrégée et tapez les informations que vous souhaitez ajouter pour la bibliothèque.
  4. Cliquez sur Fichier > Tout enregistrer pour enregistrer les modifications.
  5. Dans la vue Création de patterns, cliquez avec le bouton droit de la souris sur la bibliothèque de projet et cliquez avec le bouton gauche sur Générer des fichiers d'aide pour ajouter les informations de manifeste aux fichiers de projet.
  6. Dans la vue Explorateur de package, développez le noeud PatternHelp sous PatternFiles et double-cliquez sur le fichier HTML de la bibliothèque. Vous pouvez visualiser les modifications que vous avez apportées au fichier.
Remarque : Vous pouvez modifier d'autres propriétés des manifestes de bibliothèque à l'aide de l'éditeur de manifeste RAS, mais soyez prudent. Les projets de pattern reposent sur l'intégrité de la bibliothèque et des fichiers de manifeste de pattern pour la création et l'importation des plug-ins de pattern.
Concepts associés
Patterns de conception IBM Rational
Code de pattern et fichiers d'assistance
Actifs de patterns RAS
Contenu du projet de pattern
Tâches associées
Fourniture d'un texte de description abrégée
Ajout de diagrammes de présentation
Génération de fichiers de documentation
Importation de documentation
Conditions d'utilisation | Retours d'informations
(C) Copyright IBM Corporation 2004, 2005. All Rights Reserved.