Sie sind hier: Dokumentieren > AutoDoc-Funktionen > Erzeugen von Symbolüberblicksseiten
Close
Doc-O-Matic 10
InhaltInhalt IndexIndex GlossarGlossar WillkommenWillkommen
vorigeshinaufnächstes
Erzeugen von Symbolüberblicksseiten
Alle ausblendenAlle ausblendenAlle anzeigenAlle anzeigen

Doc-O-Matic erzeugt automatisch Überblickstabellen für alle Themen, die Unterthemen haben auf der jeweiligen Themenseite. Details finden Sie in Überblicksseite und Abschnitte. 

Zusätzlich können Sie Inhalt für alle Ordner für Symbole, die in Ihrem Projekt enthalten sind erzeugen. Im Contents Manager werden die Symbole automatisch in den Ordnern Symbolreferenz, Klassen, Funktionen, Makros zugeordnet. Es gibt mehrere Möglichkeiten diese Ordner in Ihrer Dokumentation zu präsentieren. Sie können:

  • Die Ordner nur als Einträge im Inhaltsverzeichnis anzeigen.
  • Automatisch Inhalt mit den AutoDoc-Funktionen erstellen.
  • Ein echtes Thema für diese Ordner erzeugen und manuell Text für diese Themen schreiben. Überblickstabellen werden automatisch erzeugt.Editions

Verfügbar in: Doc-O-Matic Professional

  1. Klicken Sie auf der Symbolleiste für den Schnellzugriff auf Settings.
  2. Klicken Sie auf die Registerkarte der entsprechenden Konfiguration.
  3. Öffnen Sie die Seite AutoDoc > AutoDoc-Folder.
  4. Wählen Sie die Art von Verzeichnissen, für die Sie automatischen Inhalt erzeugen möchten.
  5. Geben Sie den Text ein, den Sie auf den Seiten für die Verzeichnisse anzeigen möchten.
  6. Die Option Always create content for member folders, fügt Inhalt für überladene Funktionen und Überblicksseiten für Members automatisch hinzu. Die Symbolreferenz ist der einzige Ordner, für den kein automatischer Inhalt erzeugt wird.
  7. Sie können folgende Variablen verwenden:
    • NAME Der Name der Klasse.
    • CATEGORY Die Symbole, die in dem Ordner enthalten ist.
    • CATEGORYL Die Symbole, die in dem Ordner enthalten ist mit Kleinbuchstaben geschrieben.
  1. Klicken Sie auf der Symbolleiste für den Schnellzugriff auf Settings.
  2. Klicken Sie auf die Registerkarte der entsprechenden Konfiguration.
  3. Öffnen Sie die Seite AutoDoc > Content > Symbol Titles.
  4. Geben Sie in das entsprechende Feld die Variablen ein, die Sie verwenden möchten, um die Namen für den Ordner zu bilden.
  • Wählen Sie in der Hierarchie den Ordner für den Sie ein Thema erzeugen möchten aus (zum Beispiel Klassen).
  • Klicken Sie auf dem Menüband auf der Registerkarte Manage auf Documentation .
  • Im Dialogfeld Topic ID wird die vordefinierte spezielle Themen-ID angezeigt.
  • Fügen Sie Text zu dem Thema hinzu.
  • Doc-O-Matic erzeugt nun automatisch einen Überblick aller Unterthemen dieses Themas. Auf der Seite Symbolreferenz werden zum Beispiel alle Klassen, Variablen, Dateien und Macros aufgelistet. Auf der Seite Klassen werden alle Klassen aufgelistet. Zusätzlich werden in den Hilfesystemen für alle aufgelisteten Kategorien eigene Seiten erzeugt.
  • Um die Themen für Verzeichnisse in den Index aufzunehmen, aktivieren Sie das Kontrollkästchen Add folder topics auf der Index Seite.

Alle Themen für Ordner sind Symbolthemen. Klicken Sie auf die Registerkarte Symbol Topics auf der Seite Files & Format > Section Appearance um zu bestimmen, wie diese Abschnitte im jeweiligen Ausgabeformat angezeigt werden.

AutoDoc-Ordner, Index

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