Using Variables in the Documentation

Variables from different areas can be used for documentation generation; these are then replaced by current values at the time of execution.

Variables in File Names and Directory Names of Output Files

You can use variables in documentation file names and directory names for output files.

You can set both names in the configuration editor for each documentation command in the Edit/Properties dialog in the Options tab.

The file name of the documentation is set with the Name of the Information Files option, e.g. $(model)_$(selection)_$(date)_$(time)_($(command)).

Names of output directories are set with the Directory for output files option.

Variable	Brief Description
`$(command)`	Name of documentation command
`$(date)`	Current date (example: 2012_09_20)
`$(i)`	Continuous counter for generation runs
`$(model)`	Innovator model's name
`$(repository)`	Name of repository
`$(selection)`	Documentation selection used (primary selection)
`$(time)`	Current time (example: 09_33)
`$(TMP)`, `$(TEMP)`	Windows -directory for temporary files

Variables in Headers, Footers and Title Pages

Variables can be used in headers, footers and title pages.

Variable	Brief Description
`$(command)`	Name of documentation command
`$(date)`	Current date (example: 2012_09_20)
`$(name)`	Innovator model's name
`$(repository)`	Name of repository
`$(selection)`	Documentation selection used
`$(structure)`	Documentation structure used
`$(time)`	Current time (example: 09_33)
`$(title)`	First header for a model element enumeration chapter that is not hidden enables the name of the selected model element to be output on the title page
`$(type)`	Model type, currently always "Innovator model"
`$(user)`	Name of the Innovator model user

Format specifications can be used for the $(date) and $(time) variables. e.g. $(date:dd) specifies the day of the month with leading zero. You can find more information about date transformation under DateTimeFormatInfo on the MSDN page.