Sie sind hier: Dokumentieren > AutoDoc-Funktionen > Text zu speziellen Seiten hinzufügen
Close
Doc-O-Matic 10
InhaltInhalt IndexIndex GlossarGlossar WillkommenWillkommen
vorigeshinaufnächstes
Text zu speziellen Seiten hinzufügen
Alle ausblendenAlle ausblendenAlle anzeigenAlle anzeigen

Sie können zu den automatisch erzeugten Seiten in Ihrem Projekt Text hinzufügen, indem Sie spezielle Themen verwenden. Spezielle Themen sind Themen, die eine spezielle Bedeutung für Doc-O-Matic haben, wenn die Dokumentation erzeugt wird. Spezielle Themen haben spezielle vordefinierte IDs. Der Zweck von speziellen Themen ist es, Doc-O-Matic Information zu geben, die sonst nirgendwo enthalten sind. 

Es gibt drei Arten von speziellen Themen:

  • Spezielle Themen wie zB !!INDEX, !!CONTENTS, !!WELCOME und !!COPYRIGHT_FOOTER. Mit Hilfe dieser Themen können Sie Text zum Index, zum Inhaltsverzeichnis und der Standardthemenseite (Welcome topic) hinzufügen. Diese speziellen Themen werden nicht dazu benötigt, diese speziellen Seiten zu erzeugen. Wenn Sie diese spezielle Thema erzeugen, können Sie aber Text zu diesen speziellen Seiten hinzufügen.
  • Spezielle Themen wie !!COPYRIGHT lassen Doc-O-Matic diese speziellen Seiten erzeugen.
  • Spezielle Themen wie !!CLASSES werden automatisch als Ordner (Gruppierungsebenen) für die Sortierung von Symbolen erzeugt. In der Ausgabe können Sie auf folgende Arten ausgegeben werden. Sie können:
    • Ordner nur im Inhaltsverzeichnis darstellen.
    • Automatischen Inhalt für diese Ordner erzeugen.
    • Ein echtes Thema für diese Ordner erzeugen und Text zu diesen Themen hinzufügen. Überblicke über die Unterthemen dieser Themen werden automatisch erzeugt.
  1. Es gibt verschiedene Möglichkeiten um spezielle Themen zu erzeugen. Sie können:
    • Auf dem Menüband auf der Registerkarte Manage auf New Topic klicken und dann im Dialogfeld New Topic unter Topic ID eine der vordefinierten Themen-IDs eingeben.
    • Einen Ordner für Symbole auswählen, zum Beispiel Makros und auf dem Menüband auf der Registerkarte Manage auf Document klicken und dann im Dialogfeld New Topic auf OK klicken.
    • Die Datei vorlage.dtx, die in der Doc-O-Matic Installation enthalten ist, zu Ihrem Projekt hinzufügen.
    • Die kurzen Beschreibungstext, die in dieser Datei enthalten sind ändern oder Text zu den speziellen Themen hinzufügen.

Alle spezielle Themen beginnen mit den Zeichen !!. Wir empfehlen Ihnen keine Themen-ID zu verwenden, die mit !! beginnt, da es wahrscheinlich ist, dass zusätzliche spezielle Themen in zukünftigen Versionen hinzugefügt werden.

Diese Tabelle listet alle IDs von speziellen Themen auf, zeigt, ob die Themen benötigt werden, um spezielle Seiten zu erzeugen und zeigt in welchem Ausgabeformat die speziellen Themen oder Ihre Änderung aufscheinen. Die ID eines speziellen Themas muss mit "!!" beginnen.

Spezielle Themen
Bedeutung
Ausgabe
!!INDEX HTML Index
Eine kurze Beschreibung, die auf der Indexseite aufscheint.
HTML-Hilfesysteme
!!SYMREF
In jedem Ausgabeformat werden Ordner für Symbole automatisch erzeugt. Wenn Sie ein Thema für das spezielle Thema erzeugen, wird der Ordner !!SYMREF zum Thema !!SYMREF.
HTML-Hilfesysteme, PDF, RTF
!!CONTENTS
Eine kurze Beschreibung, die auf der Inhaltsverzeichnisseite aufscheint.
HTML-Hilfesysteme
!!COPYRIGHT
Das Urheberrechts-Thema wird verwendet, um das Impressum im PDF-Dokument zu erzeugen. Das Impressum enthält rechtliche Hinweise zur Dokumentation, wie Informationen über den Autor und markenrechtliche Informationen. Das Impressum ist die zweite Seite der erzeugten Dokumentation.
PDF, RTF
!!COPYRIGHT_FOOTER
In registrierten Versionen wird Ihre Urheberrechtsinformation anstelle der Urheberrechtsinformation der Firma toolsfactory auf jeder Seite oberhalb der Fußzeile angezeigt.
HTML-Hilfesysteme, PDF, RTF
!!WELCOME
Eine kurze Beschreibung, die auf der Standardthemenseite der Hilfesysteme angezeigt wird.
HTML-Hilfesysteme
!!GLOSSARY
Dieses Thema existiert lediglich um die Kompatibilität für ältere Versionen sicher zu stellen. In dieser Version von Doc-O-Matic wird das Glossar als Bericht erzeugt. In der Vorlagendatei wird im speziellen Thema !!GLOSSARY ein Glossarbericht wiedergegeben. Dieses Thema kann wie jedes andere Thema formatiert werden. Weitere Informationen über das Glossar erhalten Sie in Erstellen von Glossaren.
HTML-Hilfesysteme, RTF, PDF
!!CLASSES
In jedem Ausgabeformat werden Ordner für Symbole automatisch erzeugt. Wenn Sie ein Thema für dieses spezielle Thema erzeugen, wird der Ordner !!CLASSES zum Thema !!CLASSES. Auf der Seite AutoDoc-Ordner können Sie automatisch Inhalt für diese Themen erzeugen.
HTML-Hilfesysteme, PDF, RTF
!!FUNCTIONS
In jedem Ausgabeformat werden Ordner für Symbole automatisch erzeugt. Wenn Sie ein Thema für dieses spezielle Thema erzeugen, wird der Ordner !!FUNCTIONS zum Thema !!FUNCTIONS. Auf der Seite AutoDoc-Ordner können Sie automatisch Inhalt für diese Themen erzeugen.
HTML-Hilfesysteme, PDF, RTF
!!RECORDS
In jedem Ausgabeformat werden Ordner für Symbole automatisch erzeugt. Wenn Sie ein Thema für dieses spezielle Thema erzeugen, wird der Ordner !!RECORDS zum Thema !!RECORDS. Auf der Seite AutoDoc-Ordnerkönnen Sie automatisch Inhalt für diese Themen erzeugen.
HTML-Hilfesysteme, PDF, RTF
!!TYPES
In jedem Ausgabeformat werden Ordner für Symbole automatisch erzeugt. Wenn Sie ein Thema für dieses spezielle Thema erzeugen, wird der Ordner !!TYPES zum Thema !!TYPES. Auf der Seite AutoDoc-Ordner können Sie automatisch Inhalt für diese Themen erzeugen.
HTML- Hilfesysteme, PDF, RTF
!!VARIABLES
In jedem Ausgabeformat werden Ordner für Symbole automatisch erzeugt. Wenn Sie ein Thema für dieses spezielle Thema erzeugen, wird der Ordner !!VARIABLES zum Thema !!VARIABLES. Auf der Seite AutoDoc-Ordner können Sie automatisch Inhalt für diese Themen erzeugen.
HTML-Hilfesysteme, PDF, RTF
!!CONSTANTS
In jedem Ausgabeformat werden Ordner für Symbole automatisch erzeugt. Wenn Sie ein Thema für dieses spezielle Thema erzeugen, wird der Ordner !!CONSTANTS zum Thema !!CONSTANTS. Auf der Seite AutoDoc-Ordner können Sie automatisch Inhalt für diese Themen erzeugen.
HTML-Hilfesysteme, PDF, RTF
!!MACROS
In jedem Ausgabeformat werden Ordner für Symbole automatisch erzeugt. Wenn Sie ein Thema für dieses spezielle Thema erzeugen, wird der Ordner !!MACROS zum Thema !!MACROS. Auf der Seite AutoDoc-Ordner können Sie automatisch Inhalt für diese Themen erzeugen.
HTML-Hilfesysteme, PDF, RTF
!!FILES
In jedem Ausgabeformat werden Ordner für Symbole automatisch erzeugt. Wenn Sie ein Thema für dieses spezielle Thema erzeugen, wird der Ordner !!FILES zum Thema !!FILES. Auf der Seite AutoDoc-Ordner können Sie automatisch Inhalt für diese Themen erzeugen.
HTML-Hilfesysteme, PDF, RTF

AutoDoc-Ordner, AutoDoc-Inhalt

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