Génération de fichiers de documentation

Vous pouvez générer des ensembles de fichiers de projet qui comprennent des informations standard sur la bibliothèque de patterns et son contenu. Les fichiers générés sont ouverts par l'applicateur du pattern depuis la vue Explorateur de patterns et ils sont affichés intégrés à la hiérarchie des rubriques d'aide en ligne.

Cinq types de fichiers sont générés : bibliothèque, pattern, paramètres, description et présentation. Les fichiers pattern et présentation partagent les mêmes informations. Les données statiques des fichiers comprennent des propriétés telles que noms de bibliothèque, noms de pattern et noms de paramètre, versions, auteurs, groupes, multiplicité, descriptions abrégées et types de paramètre UML 2.0. Vous pouvez importer un fichier de description pour chaque pattern et chacun de ses paramètres. Les descriptions de pattern sont introduites dans les fichiers de description et les descriptions de paramètre sont toutes introduites dans le fichier de paramètres du pattern.

Vous avez la possibilité de générer ces ensembles de fichiers pour le projet entier ou pour des patterns individuels. Si vous générez de l'aide pour au moins un pattern du projet, le fichier de bibliothèque individuel est également généré automatiquement. Bien que ce ne soit pas indispensable, il est possible d'ajouter des informations supplémentaires sur la bibliothèque de patterns à l'aide de l'éditeur de Manifeste RAS.

Si vous ne générez pas ces fichiers, ils ne sont pas inclus dans le projet de pattern. Si l'applicateur d'un pattern tente de les consulter, un message indique qu'aucune documentation n'est disponible. Si vous modifiez les informations contenues dans ces fichiers, vous devez générer à nouveau les fichiers d'aide pour mettre à jour les fichiers.

La capture d'écran qui suit montre une section de la fenêtre d'Aide en ligne avec les rubriques spécifiques au pattern. L'aide en ligne sur les patterns est fournie dans les rubriques Application de patterns. Dans cet exemple, le nom de la bibliothèque de patterns est exemple.


Fenêtre d'aide en ligne avec un exemple de fichier d'aide de pattern ouvert

Pour générer des fichiers d'aide en ligne, effectuez l'une des actions suivantes dans la vue Création de patterns :
Un dossier PatternHelp contenant le fichier HTML généré pour la bibliothèque est ajouté à l'espace de travail dans le dossier \x\PatternFiles, x étant le nom du projet de patterns. Selon la manière dont l'aide a été générée, un autre dossier PatternHelp contenant les trois fichiers HTML générés est ajouté à l'un ou à la totalité des dossiers \PatternFiles\y, y étant le nom du 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
Importation de documentation
Ajout de documentation dans des bibliothèques de patterns
Conditions d'utilisation | Retours d'informations
(C) Copyright IBM Corporation 2004, 2005. All Rights Reserved.