Dokumentation von Ressourcen

Neben dem Anzeigen von Ressourcen müssen Sie die von Ihnen erstellten Anwendungen möglicherweise dokumentieren. WebSphere Integration Developer enthält ein Tool zum Generieren von Dokumentation für die Ressourcen in Ihren Modulen, Mediationsmodulen und Bibliotheken.

Die Generierung von Dokumentation wird über das Aufrufen eines Assistenten eingeleitet. Sie können den Inhalt der Dokumentation anpassen, indem Sie mehrere Ressourcen aus einem oder mehreren Modulen bzw. einer oder mehreren Bibliotheken auswählen, damit die gesamten Informationen in einen einzigen Bericht, eine PDF-Datei, geschrieben werden. Darüber hinaus können Sie das Layout und die Schriftart für die Ausgabe angeben. Die zugehörigen Tasks enthalten ausführliche Anweisungen zum Generieren der Dokumentation.

Ressourcendokumentation

Der Dokumentationsgenerator produziert die folgenden Informationen für diese Ressourcen:

Andere Ressourcen werden vom Dokumentationsgenerator nicht dokumentiert.

Referenzdateien

Der Dokumentationsgenerator kann auch Dokumentation für die ausgewählten Ressourcen generieren und für die Ressourcen, auf die die ausgewählten verweisen. Sie können beispielsweise im Assistenten für die Dokumentationsgenerierung den Geschäftsprozess und die Option Dateien, auf die verwiesen wird, einschließen auswählen. Auf diese Weise enthält der generierte PDF-Bericht auch Informationen zu den Ressourcen (z. B. durch deren Aktivitäten aufgerufene Schnittstellen), auf die der Prozess verweist.

Dokumentationsstruktur

Der generierte PDF-Bericht weist die folgende Struktur auf:

  • Titelseite

    Enthält den Titel des Berichts, den Namen des Autors sowie das Datum des Berichts.

  • Inhaltsverzeichnis

    Liste der Abschnitte und Seitenzahlen des Berichts.

  • Ressourcendokumentationsabschnitte

    Liste der Eigenschaften der Ressourcen. Für alle Ressourcen werden auch Bilder der in der Ansicht 'Editor' geöffneten Ressourcen angezeigt. Dies gilt nicht für Module und Bibliotheken.

  • Querverweis

    Liste, die für jede dokumentierte Ressource angibt, welche Ressource diese verwendet (Liste der Provider) und wo sie verwendet wird (Empfängerliste).

  • Anhang: Einstellungen für die Dokumentationsgenerierung

    Liste der Einstellungen für die Dokumentationsgenerierung, die im Assistenten für die Dokumentationsgenerierung angegeben und für den PDF-Bericht verwendet wurden.

Layout und Stil der Dokumentation

Layout und Stil des generierten PDF-Berichts können mit Hilfe des Assistenten für die Dokumentationsgenerierung angepasst werden. Wenn Sie die Einstellungen für Layout und Stil ändern, werden sie für alle nachfolgenden Dokumentationsgenerierungen gespeichert, bis sie erneut geändert werden.

Die folgenden Layouteinstellungen können geändert werden:

  • Papierformat

    Definiert das Papierformat der generierten Dokumentation.

    Standardwert: Brief

  • Inhaltsverzeichnisebene

    Definiert die höchste Abschnittsebene, die im Inhaltsverzeichnis des Berichts aufgelistet werden soll.

    Standardwert: 7

  • Schriftart
    Definiert die Schriftartengruppe, die Schriftgröße und den Schriftstil für die Ausgabe. Nachfolgend sind die Standardeinstellungen aufgelistet:
    • Klartext

      • Wird für Beschreibung und Dokumentation verschiedener Artefakte verwendet. Die Schriftartengruppe von Klartext wird auch für die Titelseite, den Header und die Fußzeile verwendet.
      • Standardschriftartengruppe: Helvetica
      • Standardschriftgröße: 10
      • Standardschriftstil: normal
    • Kapitelüberschrift

      • Wird für die nummerierten Überschriften, den Header des Inhaltsverzeichnisses und den Header des Anhangs verwendet.
      • Standardschriftartengruppe: Helvetica
      • Standardschriftgröße: 14
      • Standardschriftstil: fett
    • Quellcodetext

      • Wird für die Dokumentation von Quellcode wie beispielsweise Java verwendet.
      • Standardschriftartengruppe: Courier
      • Standardschriftgröße: 10
      • Standardschriftstil: normal
    • Beschriftungstext

      • Wird für die Beschriftung von Bildern verwendet.
      • Standardschriftartengruppe: Helvetica
      • Standardschriftgröße: 10
      • Standardschriftstil: fett
    • Definitionstext

      • Wird für die Dokumentation von Schlüsselwertpaaren verwendet.
      • Standardschriftartengruppe: Helvetica
      • Standardschriftgröße: 10
      • Standardschriftstil: normal
    • Headertext

      • Wird für die nicht nummerierten Überschriften verwendet.
      • Standardschriftartengruppe: Helvetica
      • Standardschriftgröße: 11
      • Standardschriftstil: fett
    • Inhaltsverzeichnis

      • Wird für das Inhaltsverzeichnis verwendet.
      • Standardschriftartengruppe: Helvetica
      • Standardschriftgröße: 9
      • Standardschriftstil: normal

Hauptdateien zum Speichern von Einstellungen

Bei einer Hauptdatei handelt es sich um ein Ressourcenprofil, das den Inhalt (nicht die Schriftstile) definiert, der in die generierte Dokumentation aufgenommen werden soll. Erstellen Sie bei Verwendung des Assistenten für die Dokumentationsgenerierung eine Hauptdatei, um die Ressourcenauswahl zu speichern. Wenn Sie den gleichen Bericht mit Hilfe des Assistenten erneut generieren möchten, können Sie einfach die Hauptdatei auswählen.

Neue Schriftarten registrieren

Der Dokumentationsgenerator stellt drei Standardschriftarten zur Verfügung, die für die Dokumentation verwendet werden können. Bei diesen Schriftarten handelt es sich um Helvetica, Courier und Times mit den folgenden Schriftstilen: normal, kursiv, fett und fett kursiv.

Sie können eine neue Schriftart hinzufügen, indem Sie sie registrieren. Dabei muss es sich entweder um eine True Type-Schriftartendatei (.ttf) oder eine True Type Collection-Datei (.ttc) handeln. Die Registrierung von Schriftarten erfolgt über den Assistenten für die Dokumentationsgenerierung. Nach dem Registrieren einer Schriftart kann diese für alle Berichte verwendet werden, bis sie gelöscht wird. Standardschriftarten können nicht gelöscht werden. Anweisungen zum Arbeiten mit dem Assistenten für die Dokumentationsgenerierung finden Sie bei den zugehörigen Tasks im Abschnitt "Dokumentation generieren".

Anmerkung: Im Assistenten für die Dokumentationsgenerierung werden Namen von registrierten Schriftarten, einschließlich Namen von Doppelbytezeichensatz-Schriftarten nur in lateinischem Zeichensatz angezeigt.

Tracedatei

Der Dokumentationsgenerator kann Tracenachrichten der Dokumentationsgenerierung in eine Tracedatei schreiben. Hinweis: Schalten Sie die Tracefunktion nur ein, wenn ein Problem mit dem Dokumentationsgenerator vorliegt, da die Traceverarbeitung die Systemleistung beeinträchtigt und viel Plattenspeicherplatz in Anspruch nehmen kann. Die Einstellungen für den Trace können im Fenster 'Benutzervorgaben' vorgenommen werden. Die Ausgabe wird in eine Textdatei im Metadatenverzeichnis geschrieben (arbeitsbereichsname\.metadata\.plugins\com.ibm.wbit.reporting.infrastructure\trace\). Protokolleinträge werden angehängt und niemals gelöscht.

Zugehörige Konzepte
Module und Bibliotheken
Module und Bibliotheken - Abhängigkeiten
Geschäftsintegration - Leistungsmerkmale und Aufgabenbereiche
Geschäftsintegration - Cheat-Sheets
Zugehörige Tasks
Modul für Geschäftsservices erstellen
Mediationsmodul erstellen
Standardnamensbereiche ändern
Leistungsmerkmale von Tools aktivieren
Modulen und Bibliotheken Abhängigkeiten hinzufügen
Bibliothek erstellen
Dokumentation generieren

Zugehörige Informationen

Tutorial: Mit Modulen und Bibliotheken arbeiten

Feedback
(C) Copyright IBM Corporation 2005, 2006. Alle Rechte vorbehalten.