Dokumentation generieren

Sie können für die Ressourcen in Ihren Modulen und Bibliotheken Dokumentation generieren.

Führen Sie die folgenden Schritte aus, um Dokumentation zu generieren:

  1. Wählen Sie die Ressource in der Sicht 'Geschäftsintegration' aus.
  2. Klicken Sie auf Dokumentation generieren in der FunktionsleisteSchaltfläche 'Dokumentation generieren' in der Funktionsleiste, oder klicken Sie mit der rechten Maustaste, und wählen Sie Dokumentation generieren... aus. Daraufhin wird der Assistent für die Dokumentationsgenerierung geöffnet.
    Anmerkung: Alle Felder in diesem Assistenten verfügen über F1-Hilfetext zum Ausfüllen der Spezifikation. Setzen Sie den Fokus mit Hilfe der Tabulatortaste auf das entsprechende Feld oder die entsprechende Schaltfläche, und drücken Sie dann die Taste F1 (Strg+F1 unter Linux), um den zusätzlichen Hilfetext anzuzeigen.
  3. Geben Sie im Assistenten für die Dokumentationsgenerierung den Namen für den Autor, den Titel der Dokumentation und eine Position für die PDF-Datei an, die generiert wird. Der standardmäßige Dateiname lautet reportFile.pdf, und die Standardposition ist Ihr Arbeitsbereich. Der F1-Hilfetext enthält Anweisungen zum Ändern des Berichtsnamens.
  4. Sie können die Standardeinstellungen akzeptieren und auf Fertig stellen klicken, um die Dokumentation zu generieren. Wenn Sie jedoch zusätzliche Ressourcen auswählen möchten, die in die Ausgabe aufgenommen werden sollen, oder das Layout der Dokumentation ändern möchten, klicken Sie auf Weiter.
    Anmerkung: Wenn die Schaltfläche Weiter nicht aktiviert ist, haben Sie eine Ressource ausgewählt, die vom Dokumentationsgenerator nicht unterstützt wird. Sie müssen auf Weiter klicken, um eine neue Hauptdatei zu erstellen. Zu einem späteren Zeitpunkt können Sie dann eine Ressource auswählen, die vom Dokumentationsgenerator unterstützt wird. Zusätzliche Informationen zur Ressourcendokumentation enthält der Abschnitt "Dokumentation von Ressourcen" unter 'Zugehörige Konzepte'.
    1. Auf der Seite 'Inhalt auswählen' können Sie angeben, ob Sie den Inhalt der generierten Ausgabe weiter anpassen möchten.
      • Wählen Sie Generiert die Dokumentation von der ausgewählten Ressource aus, wenn Sie für die Dokumentationsgenerierung keine Ressourcen hinzufügen oder entfernen möchten.
      • Wählen Sie Generiert die Dokumentation von einer vorhandenen Hauptdatei und eine Hauptdatei aus, um ein zuvor gespeichertes Ressourcenprofil erneut auszuführen.
      • Wählen Sie Neue Masterdatei erstellen aus, um Ressourcen für diese Dokumentationsgenerierung hinzuzufügen oder zu löschen.
      Zusätzliche Informationen zu Hauptdateien enthält der Abschnitt "Dokumentation von Ressourcen" unter 'Zugehörige Konzepte'. Klicken Sie auf Weiter.
    2. Auf der Seite zum Bearbeiten von Inhalten können Sie Ressourcen für die Dokumentation hinzufügen oder löschen. Wählen Sie eine Ressource aus, und klicken Sie auf >, um sie der Tabelle Dokumentationseingaberessourcen hinzuzufügen. Sie können auch Elemente in der Tabelle auswählen und auf < klicken, um Inhalt aus der zu generierenden Dokumentation zu löschen. Wählen Sie das Markierungsfeld Dateien, auf die verwiesen wird, einschließen aus, um auch Informationen für Artefakte zu generieren, auf die von den ausgewählten Ressourcen verwiesen wird. Zusätzliche Informationen zu Dateien, auf die verwiesen wird, enthält der Abschnitt "Dokumentation von Ressourcen" unter 'Zugehörige Konzepte'.

      Mit der Schaltfläche Sichern als... wird die neue Hauptdatei gesichert. Auf diese Weise können Sie denselben Bericht unter Verwendung der Hauptdatei erneut generieren. Klicken Sie auf Weiter.

    3. Wählen Sie auf der Seite 'Layouteinstellungen' das gewünschte Dokumentationslayout aus, und klicken Sie auf Fertig stellen, um die Dokumentation zu generieren.
      Anmerkung: Wenn Sie die Einstellungen für Layout und Stil ändern, werden sie für alle nachfolgenden Dokumentationsgenerierungen gespeichert, bis sie erneut geändert werden.
      Informationen zum Hinzufügen neuer Schriftarten, die in der Dokumentation verwendet werden sollen, finden Sie im nachfolgenden Abschnitt "Schriftarten hinzufügen".
  5. Suchen Sie die PDF-Datei an der von Ihnen angegebenen Position, und öffnen Sie sie mit Acrobat Reader.

Schriftarten hinzufügen

Wenn Sie neue Schriftarten hinzufügen möchten, die in der generierten Dokumentation verwendet werden können, rufen Sie den Assistenten 'Dokumentationsgenerierung' auf und, klicken Sie auf Weiter, bis Sie auf die Seite für Layouteinstellungen gelangen:

Seite 'Layouteinstellungen' des Assistenten für die Dokumentationsgenerierung

Führen Sie anschließend die folgenden Schritte aus:

  1. Wählen Sie das Markierungsfeld Standardschriftarten überschreiben aus. Daraufhin wird die Schaltfläche Schriftarten... aktiviert.
  2. Klicken Sie auf Schriftarten.... Daraufhin wird die Seite 'Einstellungen für die Darstellung von Dokumentation' geöffnet:

    Seite 'Einstellungen für die Darstellung von Dokumentation'

  3. Klicken Sie auf Schriftarten verwalten.... Daraufhin wird das Fenster 'Dokumentationsschriftarten verwalten...' geöffnet.

    Fenster 'Dokumentationsschriftarten verwalten'

  4. Klicken Sie auf die Schaltfläche Hinzufügen.... Daraufhin wird das Fenster 'Fügt eine Dokumentationsschriftart hinzu' geöffnet.

    Fenster 'Fügt eine Dokumentationsschriftart hinzu'

  5. Klicken Sie auf Durchsuchen, damit Sie zum Fenster 'Öffnen' gelangen, suchen Sie die TTF- oder TTC-Datei, und wählen Sie sie aus.
    Anmerkung: (nur Windows) Wenn Sie Schriftarten aus dem Windows-Verzeichnis, zum Beispiel WINNT oder WINDOWS auswählen möchten, müssen Sie den Namen der TTF- oder TTC-Datei im Fenster zum Öffnen erneut eingeben. Dieses Fenster ist unten dargestellt:
    Fenster zum Öffnen im Verzeichnis WINNT
    Wenn Sie im Verzeichnis WINNT doppelt auf die Datei klicken, öffnet Windows die TTF- oder TTC-Datei anstatt sie auszuwählen. Daher müssen Sie zum Auswählen der Datei den Namen eingeben. Wenn Sie die Auswahl mit der Maus treffen möchten, kopieren Sie die TTF- oder TTC-Datei in ein anderes Verzeichnis. Dann können Sie die Schriftartdatei mit Hilfe der Maus anklicken und auswählen.

    Wenn eine TTC-Datei ausgewählt wird, muss ein gültiger Schriftartname eingegeben werden.

  6. Klicken Sie im Fenster für Dokumentationsschriftarten auf OK, um die Auswahl abzuschließen. Nun wird die neue Schriftart im Fenster 'Dokumentationsschriftarten verwalten' angezeigt.
    Anmerkung: Im Assistenten für die Dokumentationsgenerierung werden Namen von registrierten Schriftarten, einschließlich Namen von Doppelbytezeichensatz-Schriftarten nur in lateinischem Zeichensatz angezeigt.
  7. Klicken Sie auf OK, um zur Seite 'Einstellungen für die Darstellung von Dokumentation' zurück zu gelangen. Dort können Sie nun die neue Schriftart für die aufgelisteten Texttypen auswählen.

Die neue Schriftart ist jetzt registriert und damit für nachfolgende Dokumentationsgenerierungen verfügbar. Standardschriftarten können nicht gelöscht werden.

Zugehörige Verweise
Dokumentation von Ressourcen

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