Dokumentationsdateien generieren

Sie können Gruppen von Projektdateien generieren, die Standardinformationen über die Musterbibliothek und ihren Inhalt enthalten. Die generierten Dateien werden vom Anwender des Musters in der Sicht 'Musterexplorer' geöffnet und in der Themenhierarchie der Onlinehilfe angezeigt.

Dabei werden fünf Dateitypen generiert: Bibliotheks-, Muster-, Parameter-, Beschreibungs- und Übersichtsdateien. Die Muster- und die Übersichtsdateien verwenden dieselben Informationen. Zu den statischen Daten in den Dateien gehören Bibliotheksnamen, Musternamen und Parameternamen, Versionsnummern, Autoren, Gruppen, Multiplizität, Kurzbeschreibungen und UML 2.0-Parametertypen. Sie können eine Beschreibungsdatei für jedes Muster und für jeden dazugehörigen Parameter importieren. Musterbeschreibungen werden in die Beschreibungsdateien eingefügt und alle Parameterbeschreibungen werden in die Parameterdatei des Musters eingefügt.

Sie können angeben, ob diese Dateigruppen für das gesamte Projekt oder für einzelne Muster generiert werden sollen. Wenn Sie Hilfe für mindestens ein Muster in dem Projekt generieren, wird die einzelne Bibliotheksdatei ebenfalls automatisch generiert. Obwohl nicht zwingend erforderlich, können zusätzliche Informationen zu der Musterbibliothekt mit dem RAS-Manifesteditor hinzugefügt werden.

Wenn Sie diese Dateien nicht generieren, werden Sie nicht in das Musterprojekt aufgenommen. Versucht der Musteranwender, die Dateien aufzurufen, weist eine Nachricht darauf hin, dass keine Dokumentation verfügbar ist. Wenn Sie Informationen ändern, die in diesen Dateien enthalten sind, müssen Sie die Hilfedateien erneut generieren, um die Dateien zu aktualisieren.

Die folgende Momentaufnahme der Bildschirmanzeige zeigt einen Ausschnitt aus dem Fenster Hilfe der Onlinehilfe mit musterspezifischen Themen. Die Onlinehilfe für Muster wird unter dem Themenstichwort 'Muster anwenden' angezeigt. In diesem Beispiel hat die Musterbibliothek den Namen 'sample'.


Das Fenster der Onlinehilfe mit geöffneter Beispieldatei für Musterhilfe.

Führen Sie einen der folgenden Schritte in der Sicht Musterauthoring aus, um Onlinehilfedateien zu generieren:
Ein Ordner 'PatternHelp' mit der generierten HTML-Datei für die Bibliothek wird im Ordner \x\PatternFiles zum Arbeitsbereich hinzugefügt. Datei ist x der Name des Musterprojekts. Je nachdem, wie die Hilfe generiert wurde, wird ein Ordner 'PatternHelp' mit den drei generierten HTML-Dateien einem oder allen Ordnern \PatternFiles\y hinzugefügt. Dabei ist y der Name des Musters.
Zugehörige Konzepte
IBM Rational-Entwurfsmuster
Mustercode und Unterstützungsdateien
RAS-Mustersoftwarebausteine
Inhalt des Musterprojekts
Zugehörige Tasks
Text für die Kurzbeschreibung angeben
Übersichtsdiagramme hinzufügen
Dokumentation importieren
Dokumentation zu Musterbibliotheken hinzufügen
Nutzungsbedingungen | Feedback
(C) Copyright IBM Corporation 2004, 2005. Alle Rechte vorbehalten.