Verwenden von QuickDoc und Vorlagen

Die Funktion QuickDoc hilft Ihren Dokumentationsprozess zu beschleunigen. Mit QuickDoc können Sie die Erzeugung und Speicherung von Themen für jede Art von Symbolen und alle Themen im vorhinein bestimmen. Wenn Sie das Symbol dann tatsächlich dokumentieren brauchen Sie nur noch eine Klick für den gesamten Prozess.

Themenvorlagen

Sie können jedes Thema in Ihrer Dokumentation als Vorlage für neue Themen verwenden oder spezielle Vorlagethemen erstellen. Vorlagethemen sind durch eine Themen-ID, die mit !!TEMPLATE_ beginnt gekennzeichnet. Sie werden nicht in die Ausgabe exportiert und werden im Verzeichnis Vorlagen, Snippets & Spezielle Themen gespeichert. Sie können Ihre eigenen Vorlagethemen erstellen oder die vordefinierten Vorlagethemen, die in der Installation in der template.dtx Datei gespeichert sind wie zB !!TEMPLATE_Function, !!TEMPLATE_FunctionEx, !!TEMPLATE_Source, verwenden.

Um QuickDoc einzustellen

Klicken Sie auf dem Menüband auf der Registerkarte Manage auf den Pfeil neben QuickDoc , und dann klicken Sie QuickDoc Settings aus.
Wählen Sie die Symbole oder Themen aus für die Sie QuickDoc einstellen wollen. Topics sind alle allgemeinen Themen in Ihrem Projekt.
Wählen Sie das Thema aus, dass Sie als Vorlage für den ausgewählten Symbol oder Thementyp verwenden möchten.
Aktivieren Sie das Kontrollkästchen Adjust template, um die Vorlagen für die Dokumentation von Funktionen anzupassen.
Um einen leeren Editor zu verwenden, lassen Sie das Feld Template Topic leer und aktivieren Sie unter Options die entsprechenden Kontrollkästchen. Sie können:
- Dem Thema die Versionsnummer des Projektes zuweisen.
- Das neue Thema als unbeendet kennzeichnen.
Klicken Sie auf die Registerkarte Save Topic Behavior.
Aktivieren Sie unter Save Topic die entsprechenden Kontrollkästchen.
Um Ihr Thema in einer DTX-Datei zu speichern tun Sie folgendes:
- Wählen Sie einer der Einstellungen für den Dateinamen.
- Wählen Sie ein Verzeichnis.

Um QuickDoc zu verwenden

Wählen Sie in der Hierarchie das Symbol aus, das Sie dokumentieren wollen.
Klicken Sie auf der Registerkarte Manage auf QuickDoc .
Klicken Sie Save .

Um die Datei template.dtx zu Ihrem Projekt hinzuzufügen

Klicken Sie auf dem Menüband auf der Registerkarte View auf Project Manager.
Klicken Sie auf dem Menüband auf der Registerkarte Manage auf Add Files .
Finden Sie das Doc-O-Matic Verzeichnis.
Wählen Sie die Datei Vorlagen.dtx im Unterverzeichnis support aus.

Hinweise

Um ein einheitliches Aussehen Ihrer Dokumentation zu gewährleisten können alle Programmierer oder technische Autoren, die an einem Dokumentationsprojekt arbeiten die gleichen Themenvorlage verwenden.