Dokumentation zu Musterbibliotheken hinzufügen

Die Musterbibliothek verwaltet Informationen zu den dazugehörigen Mustern in einer statischen Datendatei. Dieser Bibliothekmanifestdatei können Sie Dokumentation hinzufügen, die der Musteranwender verwenden kann.

Eine kleine Untergruppe der Bibliothekinformationen wird in der Onlinehilfe angezeigt, wenn der Musteranwender auf das Menüelement Musterdokumentation anzeigen in der Sicht 'Musterexplorer' klickt. Diesen Bibliothekinformationen können Sie eine Kurzbeschreibung hinzufügen.

Die Bibliothekmanifestdatei hat denselben Namen wie die Bibliothek und die Dateierweiterung .rmd.

So fügen Sie der Bibliothek eine Kurzbeschreibung hinzu:

  1. Suchen und erweitern Sie in der Sicht 'Paketexplorer' den Knoten 'PatternFiles' in dem Musterprojekt.
    Ein erweiterter Ordner 'PatternFiles' eines Musterprojekts.
  2. Doppelklicken Sie auf die Bibliothekmanifestdatei, um sie im RAS-Manifesteditor zu öffnen.
  3. Löschen Sie auf der Seite 'Softwarebaustein' den Standardtext im Feld Kurzbeschreibung, und geben Sie die Informationen ein, die Sie für die Bibliothek hinzufügen möchten.
  4. Klicken Sie auf Datei > Alle speichern, um die Änderungen zu speichern.
  5. Klicken Sie in der Sicht 'Musterauthoring' mit der rechten Maustaste auf die Projektbibliothek, und klicken Sie anschließend auf Hilfedateien generieren, um die Manifestinformationen den Projektdateien hinzuzufügen.
  6. Erweitern Sie in der Sicht 'Paketexplorer' den Knoten PatternHelp unter PatternFiles, und doppelklicken Sie auf die HTML-Datei der Bibliothek. Die Änderungen, die Sie an der Datei vorgenommen haben, werden angezeigt.
Anmerkung: Mit dem RAS-Manifesteditor können Sie weitere Eigenschaften des Bibliothekmanifests modifizieren. Dies sollte immer mit großer Vorsicht geschehen. Musterprojekte sind auf die Integrität der Bibliothek- und Mustermanifestdateien angewiesen, damit Muster-Plug-ins erstellt und importiert werden können.
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
Dokumentationsdateien generieren
Dokumentation importieren
Nutzungsbedingungen | Feedback
(C) Copyright IBM Corporation 2004, 2005. Alle Rechte vorbehalten.