Name

sub — Defines a substitution that will be made in a configuration file.

Description

This element maps a substitution in a configuration file. This substitution is only relevant to the file defined by the parent configfile tag.

Attributes

  • name (required) - The token that will be substituted in the file. This token should not contain any spaces or special characters.

  • description (recommended) - A description of what this particular substitution does in the configuration file.

  • format (optional) - This parameter is used to validate that the input is of the proper form. This is not currently supported by ReST.

  • default (required) - The default value is this substitution is not customized.

  • type (required) - What type of substitution is this? Valid types are string (one line of text), option (chosen from a list), text (multiple lines of text), boolean (true/false).

  • truevalue (required if type=boolean) - The value to subsitute if type is boolean and true is selected. This can contain an empty string.

  • falsevalue (required if type=boolean) - The value to subsitute if type is boolean and false is selected. This can contain an empty string.

  • choices (required if type=choice) - A comma separated list of possbile choices for this substitution.

  • customChoice (optional) - If the type is choice and this attribute is set to true then the user may choose from the list of options or give their own value for this substitution. If this attribute is false or not declared, the user is restricted to the given choices.

Parents

The following elements are valid parents of sub: configfile.

Children

The following elements are children of sub: No Children.

Example

See configfile for an example of how to use this tag.