Sie sind hier: Dokumentieren > AutoDoc-Funktionen > Erzeugen von Berichten
Close
Doc-O-Matic 10
Erzeugen von Berichten

Doc-O-Matic stellt Ihnen die Möglichkeit zur Verfügung verschiedenste Berichte zu erzeugen und in Ihre Dokumentation zu integrieren. Berichte sind Überblicke über Themen, die eine oder mehrere übereinstimmende Eigenschaften oder Abschnitte haben.

  1. Klicken Sie auf dem Menüband auf der Registerkarte View auf Reports.
  2. Tun Sie folgendes:
    • Klicken Sie auf die Schaltfläche Add neben der Liste der Berichte.
    • Wählen Sie einen Bericht in der Liste aus und klicken Sie auf die Schaltfläche Copy. Die Einstellungen des ausgewählten Berichtes werden kopiert.
  3. Geben Sie in Name den Namen des Berichts ein.
  4. Damit Ihr Bericht in der Ausgabe wiedergegeben wird, aktivieren Sie das Kontrollkästchen Active.
  5. Geben Sie im Feld Topic die Themen-ID des Themas, in dem der Bericht wiedergegeben werden soll, ein.
  6. Unter Options haben Sie folgende Möglichkeiten:
    • Wählen Sie Run on exported topics aus, um nur exportierte Themen in Ihren Bericht aufzunehmen.
    • Wählen Sie Run on topics not Exported aus, um nur Themen, die nicht in der Ausgabe aufscheinen, in den Bericht aufzunehmen.
    • Wählen Sie Run on all topics, um alle Themen, die den Kriterien entsprechen, in den Bericht aufzunehmen.
  7. Aktivieren Sie das Kontrollkästchen Print header, um den Bericht in einer Tabelle mit Überschrift anzuzeigen.
  8. Aktivieren Sie das Kontrollkästchen Use for aliasing, um automatisch für alle Einträge im Bericht, die aus einem Wort bestehen, einen Hyperlink zu dem Thema, in dem der Bericht enthalten, zu erzeugen.
  9. Wählen Sie unter Criteria aus, ob Sie Themen, die ein oder die alle angegebenen Kriterien erfüllen, in den Bericht aufnehmen möchten.
  10. Klicken Sie auf die Schaltfläche More, um die Kriterien für Ihren Bericht zu bestimmen.
  11. Sie können Berichte erstellen von:
    • Themen, die einen bestimmten Abschnitt enthalten.
    • Themen mit einer bestimmten Versionsnummer.
    • Themen mit einem Flag.
    • Symbole mit einem bestimmten Dokumentationsstatus.
    • Bestimmte Arten von Symbolen.
    • Symbole, die ein QS-Erfordernis erfüllen oder nicht erfüllen.
  12. Wählen Sie in Print aus, welche Teile bzw Informationen des Themas Sie im Bericht wiedergeben möchten.
  13. Sie können folgende Information anzeigen:
    • Titel des Themas (verknüpft oder nicht verknüpft)
    • Themen-ID des Themas (verknüpft oder nicht verknüpft)
    • Abschnitte
    • Dokumentationsstatus
    • Versionsnummer des Themas und Text von Flags
    • Informationen über das Thema wie zum Beispiel zu welchem Modul, zu welchem Namespace, in welcher Datei und in welcher Klasse das Symbol vorkommt und in welcher Zeile der Sourcedatei das Symbol ist.
    • Deklaration des Symbols
    • QS-Meldungen
  14. Klicken Sie auf den Pfeil neben Not Sorted und wählen Sie aus ob und wie die Themen in der jeweiligen Spalte sortiert werden sollen.
  15. Um Teile des Berichtes nur zum sortieren zu verwenden, wählen Sie Asc. oder Desc. no print aus. Sie können Themen zB nach einem Abschnitt sortieren, der nur das Datum im Format JJJJ/MM/TT enthält.
  1. Klicken Sie auf der Symbolleiste für den Schnellzugriff auf Settings.
  2. Klicken Sie auf die Registerkarte der entsprechenden Konfiguration.
  3. Wählen Sie die Seite Files & Format > Section Appearance aus.
  4. Klicken Sie auf die entsprechende Registerkarte (Symbol Topics oder Generic Topics).
  5. Wählen Sie in der Liste Reports aus.
  6. Um die Berichte zu exportieren, markieren Sie das Kontrollkästchen.
  7. Klicken Sie Up oder Down um die Position der Berichte in den Themen zu ändern.
  8. Klicken Sie auf Edit.
  9. Klicken Sie Hide um die Namen der Berichte in dieser Konfiguration nicht anzuzeigen.
  10. Sie können die Berichte ausblendbar anzeigen und Sie können eine Grafik neben der Überschrift anzeigen.
  11. Wählen Sie die Seite Files & Format->Sections->Format aus.
  12. Sie können die Berichte als Tabelle oder als Absätze formatieren.

Berichte werden nur dann ausgegeben, wenn der Abschnitt Reports in der Liste auf der Seite Files & Format > Section Appearance exportiert wird. In der Standardeinstellung wird dieser Abschnitt exportiert.

Aussehen der Abschnitte, Abschnittsformatierung, Tabellenlayout

Reports Table 

Reports Paragraphs 

Reports Section Heading

Copyright © 2000-2020 toolsfactory software inc. Alle Rechte vorbehalten.