List Data
Description
Allows selection of one or more options from a specific list.
Must contain option-generating sub-macros (e.g. List Option, Content Options, User Options, Attachment Options or Label Options).
Parameters
Name | Required | Migratable to Cloud? | Default Value | Description |
---|---|---|---|---|
name (Field Name) |
|
|
| The name of the field. Must be unique. |
type |
|
| select | The type of field to display. May be one of the following:
Note: Only applies for forms mode. |
required |
|
| false/unchecked | If |
multiple (Allow Multiple) |
|
| false/unchecked | If |
separator |
|
| comma | If multiple items are selected, the type of separator to display between each item. Defaults to one item per line. May be one of the following:
|
customSeparator |
|
|
| What you wish to use as a separator, only used when custom is selected for Separator. |
blank |
|
| true | If 'true', a blank item is added to the list. Only applies to 'select' lists. If the user saves while selecting the blank item and the list is 'required', the page cannot be saved. Note: Only applicable for forms mode. |
blankText |
|
|
| If specified, and 'blank' is true, this text will be used for the blank option label. Note: Only applicable for forms mode. |
width |
|
|
| The width of the field. Any CSS width is allowed (e.g. 100px). Note: Only applies when type is 'select'. |
height |
|
|
| The height of the field. Any CSS height is allowed (e.g. '20px'). Note: Only applies when type is 'select'. |
Editor View
Macro Edit View
Not applicable.
Notes
Not applicable.
Tutorial Examples
- List Data
- Tracking Workflow Status
- Creating a Project Details Form
- Populating a List with Confluence Pages
- Grouping and Retrieving Data
- Collecting and Displaying Data in a Structured Way
- Adding Labels to Pages Automatically
- Creating a Checklist with Special Characters
- Using Confluence User Names as Options
- Using Attachments as Options
- Creating a Simple Form
- Creating a Dynamic Table