Verwendung von Variablen in der Dokumentation
Bei der Dokumentationsgenerierung können an verschiedenen Stellen Variablen verwendet werden, die zur Ausführungszeit durch aktuelle Werte ersetzt werden.
Variablen im Dateinamen und im Verzeichnisnamen der Ausgabedateien
Im Dateinamen der Dokumentation und im Verzeichnisnamen für Ausgabedateien können Sie Variablen verwenden.
Beide Namen können Sie im Konfigurationseditor je Dokumentationskommando im Dialog Bearbeiten/Eigenschaften im Register Optionen einstellen.
Der Dateiname der Dokumentation wird mit der Option Name der Informationsdateien eingestellt, z.B. $(model)_$(selection)_$(date)_$(time)_($(command)).
Der Name des Ausgabeverzeichnisses wird mit der Option Verzeichnis für Ausgabedateien eingestellt.
Variable | Kurzbeschreibung |
---|---|
$(command) | Name des Dokumentationskommandos |
$(date) | aktuelles Datum (Beispiel: 2012_09_20) |
$(i) | fortlaufender Zähler der Generierungsläufe |
$(model) | Name des Innovator-Modells |
$(repository) | Name des Repositorys |
$(selection) | verwendete Dokumentationsselektion (Primärselektion) |
$(time) | aktuelle Uhrzeit (Beispiel: 09_33) |
$(TMP), $(TEMP) | Windows-Verzeichnis für temporäre Dateien |
Variablen in Kopf- und Fußzeilen sowie auf der Titelseite
In Kopf- und Fußzeilen sowie auf der Titelseite können Sie Variablen verwenden.
Variable | Kurzbeschreibung |
---|---|
$(command) | Name des Dokumentationskommandos |
$(date) | aktuelles Datum (Beispiel: 2012_09_20) |
$(name) | Name des Innovator-Modells |
$(repository) | Name des Repositorys |
$(selection) | verwendete Dokumentationsselektion |
$(structure) | verwendete Dokumentationsstruktur |
$(time) | aktuelle Uhrzeit (Beispiel: 09_33) |
$(title) | erste nicht ausgeblendete Überschrift eines Modellelementaufzählungskapitels, ermöglicht die Ausgabe des Namens des selektierten Modellelements auf der Titelseite |
$(type) | Modelltyp, zur Zeit immer "Innovator-Modell" |
$(user) | Name des Innovator-Modellbenutzers |
Bei den Variablen $(date) und $(time) können Formatangaben verwendet werden. So gibt z.B. $(date:dd) den Tag des Monats mit führender Null aus. Weitere Hinweise zur Datumsformatierung finden Sie auf der MSDN-Seite zu DateTimeFormatInfo.