Verwenden von Variablen

Mit Hilfe dieses Dialoges können Sie Variablen in Ihre Dokumentation einfügen. Eine Variable wird als Platzhalter für einen bestimmten Wert, der an einer anderen Stelle definiert wird verwendet. In Doc-O-Matic gibt es einige vordefinierte Variablen und Sie können jede Variable, die Sie verwenden möchten definieren. Eine Variable besteht aus einer Zeichenkette. Variablen werden nicht rekursiv aufgelöst. Sie können in Ihren Variablen aber Variablen verwenden, die in der Liste der Variablen unter der aktuellen Variable definiert sind. Alle Variablen Ihrer aktuellen Konfiguration werden auf der Seite Variables in der entsprechenden Konfiguration aufgelistet. Sie können den gleichen Wert für alle Konfigurationen eingeben oder für jede Konfiguration einen anderen Wert angeben.

Um Ihre eigenen oder die vordefinierten Variablen einzufügen

Sie haben folgende Möglichkeiten:
- Klicken Sie im Menüband in der Gruppe Insert auf Variables .
- Klicken Sie mit der rechten Maustaste, zeigen Sie auf Insert und klicken Sie dann auf Variables .
- Drücken Sie Strg+<Leertaste>.
Wählen Sie die Variable aus, die Sie verwenden möchten.

Um eine neue Variable zu definieren

Klicken Sie im Menüband in der Gruppe Insert auf den Pfeil neben Variables .
Klicken Sie am Ende der Liste auf Add Variable.
Geben Sie eine beliebige Zeichenkette in das Feld Variable ein. Zum Beispiel RELEASEDATE.
Geben Sie in Value den Wert für Ihre Variable ein.
Aktivieren Sie unter Appearance das Kontrollkästchen Format, wenn Sie die Variable formatieren möchten.
Aktivieren Sie unter Appearance das Kontrollkästchen Label, wenn Sie der Variable automatisch ein Label zuweisen möchten.
Sie werden gefragt, ob Sie Ihre neue Variable zu allen Konfigurationen hinzufügen möchten.

Um Variablen zu formatieren und zu ändern

Klicken Sie auf der Symbolleiste für den Schnellzugriff auf Settings.
Klicken Sie auf die Registerkarte der entsprechenden Konfiguration.
Wählen Sie die Seite AutoDoc > Variables aus.
Wählen Sie in der Liste die Variable, die Sie bearbeiten möchten aus und klicken Sie auf Edit.
Ändern Sie die Werte der Variablen und ändern Sie die Formatierung für die aktuelle Konfiguration.

Vordefinierte Variablen

PROJECTTITLE: Der Projekttitel.
PROJECTSUMMARY: Eine kurze Zusammenfassung des Projektinhaltes.
AUTHOREMAIL: Die E-Mail-Adresse des Verfassers der Hilfe.
COPYRIGHT: Die Copyright-Information des Projektes.
PROJECTVERSION: Die Versions-Information des Projektes.
DATE: Das aktuelle Datum in kurzem Datumsformat.
DATEL: Das aktuelle Datum in langem Datumsformat.
TIME: Die aktuelle Zeit in kurzem Zeitformat.
TIMEL: Die aktuelle Zeit in langem Zeitformat.
USER: Der aktuelle Benutzername.
MACHINE: Der Name des Computers.
FILENAME: Der Name und der absolute Pfad der Datei, in der das Symbol enthalten ist.
LINENUMBER: Die Nummer der Zeile, in der sich das Symbol in der Sourcedatei befindet.
PAR0, PAR1, PAR2, PAR3: Wird durch den Namen des n-ten Parameters ersetzt, wenn das Thema eine Funktion beschreibt.
SYMBOLNAME: Wird durch den vollständigen Namen des Symbols ersetzt, wenn das Thema ein Symbol ist.
CLASSNAME: Wird durch den Namen der Klasse, in dem das Symbol deklariert ist ersetzt, wenn das Thema ein Mitglied oder eine Klasse ist.
MEMBERNAME: Wird durch den einfachen Namen des Symbols (Mitgliedname ohne Klassenname) ersetzt, wenn das Thema ein Mitglied ist.

Sie können vordefinierte Variablen verwenden, um Ihre eigenen Variablen zu erzeugen.