User variables

User variables are variables defined by the user from within the context of a tag mapping. A user variable name is a token beginning with an upper-case letter and continuing with letters, digits or any of the following characters:

. - _ : [ ] #

User variables are referenced from within start tag and end tag custom content, or from user definable fields in certain editor tabs.

The value of a user variable assigned by a <set/> command is universal and can be accessed by any other mapping.

The value of a user variable assigned by a <stack/> command can only be accessed within the mapping that stacks the variable and from mappings actioned by descendants of the mapped tag. When the mapping is completed, the original value of the variable is automatically restored.

[Note] Note

All mappings (other than $document) can reference user variables from user definable controls in editor tabs providing you assign the variable before the mapping is invoked.