Tag Description Macro
The PTC Tag Description Macro allows you to configure additional settings for individual tags on a template. These settings will be applied and enforced when the template is copied.
The PTC Tag Description Macro provides the following configuration options:
What type the content with which the tag is replaced should be restricted, see Tag Formats (per default Standard)
Whether the user copying the template must provide a value to replace the tag with or not.
Setting an additional description text for the tag to be shown in the replacement dialog when the template is copied.
If the content of the macros body should be displayed on the page, uncheck the 'Hidden' parameter. (Default)
Your also able to set the same settings with the Tag Configuration. The Tag Description Macro overwrites the Tag Configuration.
The value entered in the macro body describes the tag. It is later shown in the replacement dialog.
When setting the tags format to standard, the user copying the template can supply any text with which the tag is replaced.
Tags of the user format will ask for existing Confluence users when being replaced. The user names will be displayed in default Confluence rich text, such as Lisa for example.
Date tags require a valid date to be entered into the replacement. The date will be displayed in default Confluence rich text, such as 01 Jan 2020 for example.
A tag set to the link format will be replaced with a functional link to another Confluence page or an external web page.
The multiline format makes it easy to have the tag replaced with multiple lines of text.
Setting the tag format to single line restricts the replacement value to a single line of text.
When the dropdown format is selected, the user can choose one or multiple items from a dropdown menu in the replacement dialog. The selectable values can be defined directly in the Tag Description Macro. See Dropdown Format Parameters.
The regex format forces the user to choose a replacement text that matches a regular expression defined directly in the Tag Description Macro. See Regex Format Parameters.
The counter tag works in the same way as ConsecutiveTags. What the counter tag adds in is the location where it counts up. See Counter Format Parameters.
A tag set to the page format will be replaced with a link to a Confluence Page.
The tag you want to configure
Select what format you want the tag to be
Insert some help for the user when replacing the tag
If checked, an input is required for this tag
Check to hide the macro on the page
Only appears when Dropdown Format is selected
Values entered here will show up in the replacement form as a dropdown list
If checked, multiple options can be selected during replacement
Appears only if multi select is checked. Enter a desired separator which will be used to separate the different options after replacement
Invalid characters as Seperator:
!, #, &, (, ), *, ,, ., :, ;, <, >, ?, @, [, ], ^
Only appears when Regex Format is selected
A regular expression to match the replacement input
Only appears when Counter Format is selected
If a template with the tag is copied to another space the counter restarts
Whenever a template with the tag is copied, the corresponding counter is incremented by one. Regardless of whether or not the template is copied to another space
Set a prefix to the counter
Set a postfix to the counter
Set a start value for the counter (if it does not exist yet!)
Number of digits
Set how many digits the replacement will have (left pad with 0s)