Using Variables

Using this dialog box you can insert variables in your documentation. A variable is used as placeholder for a value that is defined elsewhere. There are some predefined variables in Doc-O-Matic and you can define any variable you need. A variable value consists of any single line string. Note that variables are not resolved recursively. In your variables you can use all predefined variables and variables defined after the respective variable in the variable list. All variables in your current configuration are listed on the Text Variables page in the corresponding configuration. You can use the same value for a variable in each configuration or you can use a different value for each configuration.

To insert your own or predefined variables do one of the following

On the Editor tab, in the Insert group, click.
Select the variable from all defined variables in your project.

To define a new variable

On the Editor tab, in the Insert group, click., and then click Add Variable.
Type any string in the Variable box (for example RELEASEDATE).
In the Value box, enter the value for your variable.
To apply character formatting to your variable, open the Format dialog.
Doc-O-Matic adds your new variable to all configurations.

To change and format variables

On the Quick Access Toolbar, click Settings .
Click the corresponding Configuration tab.
Select AutoDoc > Variables.
Select the Variable you want to edit and click Edit.
Change variable values and apply character formatting for the current configuration.

Predefined Variables

PROJECTTITLE: The title of the project.
PROJECTSUMMARY: The summary of the project.
AUTHOREMAIL: The author's e-mail address.
COPYRIGHT: The copyright information of the project.
PROJECTVERSION: The version information of the project.
DATE: The current date in short format.
DATEL: The current date in long format.
TIME: The current time in short format.
TIMEL: The current time in long format.
USER: The current user name.
MACHINE: The computer's name.
FILENAME: The name and absolute path of the file a symbol is contained in.
LINENUMBER: The line number where the symbol is located in the source file.
PAR0, PAR1, PAR2, PAR3: Expands to the name of the n-th parameter, if the topic describes a function.
SYMBOLNAME: Expands to the symbol's fully qualified name if the topic is a symbol.
CLASSNAME: Expands to the containing class name, if the topic is a member or class.
MEMBERNAME: Expands to the symbol's simple member name (without class) if the topic is a member.

You can also use predefined variables, to create your own variables.