Labels List
Description
Creates a dropdown with a preset list of labels that a user can select. These labels will then be applied to the page.
This has the same effect as manually adding labels to a Confluence page, but using a labels list helps to reduce labelling errors and to enforce content workflows.
Parameters
Name | Required | Default Value | Description |
---|---|---|---|
Field name |
| A descriptive name for this field. A random name is generated by default. You can also key in your own field name, which can be useful when integrating Scaffolding with other apps such as Reporting for Confluence Cloud. The field name is mandatory, and must be unique. | |
Helper Text |
| Gives context or additional information about a field input. It will appear at the bottom of the field. The helper text will only appear when you edit the content, not when viewing it. | |
Labels |
| You can add labels which are currently being used in the Confluence instance by selecting them from the dropdown list. You can also add new labels to the list by typing or pasting them in. Click the Create button to add them to the list. | |
Allow Multiple |
| Unchecked (Not enabled) | If enabled, allows more than one label to be chosen from the dropdown. |
Required |
| Unchecked (Not enabled) | If enabled, the user must select a label (mandatory) and this field cannot be empty. |
Editor View
Not applicable.
Macro Edit View
Notes
To make the best use of this feature, use it with the Live Template macro.
If you enable the Required option, you will not be able to Save Changes in editor view until you have selected a date. An example error message is shown below. Alternatively, you can click Cancel to discard the changes.