list select

1 list select | 1.1 Parameters | 1.2 list select examples

list select

macro

{list-select}

Defines a column as a selection (drop-down menu).

The selection can be from a list of options, a list of labels or a list of users.

On this page

1 Use labels for the drop-down selection options
2 User group members for the drop-down selection options
3 Configure access and storage of the column values

Related links

Add the list-select macro

The list-select macro is added to the body of the list macro to create a drop-down selection column in the list on the page.

The drop-down selection is configured in the Edit 'List select' macro dialogue box.

If Use Labels is not checked and no Users group is specified, a list of options for the selection can be added to the macro body.

Use labels for the drop-down selection options

Checking Use Labels, will allow the choice of existing labels from the list content to be added to the macro body to be used as the drop-down selection options. Content in the list that has one of these labels will show the label pre-selected in the drop-down selection.

If labels are used, changing the drop-down selection will update the label on the linked page.

User group members for the drop-down selection options

Adding a Confluence user group to Users group in the Edit macro dialogue box will populate the drop-down selection with the group members.

Configure access and storage of the column values

The list-select macro can be configured so

the column values to be read-only
the column values are stored with the row entry page or stored in the page containing the list

The values can be accessed as metadata values (see the Parameters table below).

See Examples 5, 6 and 7.

Parameters

parameter	Mandatory?	Default	Description	Comment

parameter	Mandatory?	Default	Description	Comment
`heading`	yes		The heading of the column
`use labels`	no	`false`	Instead of setting a metadata value, add the selected label
`users group`	no		Instead of listing the value, use the given users group to select from a list of users. Use `all` for listing all the users	Not available with Comala Boards
`storage type`	no	`rows`	Determines where to store the value. Use `rows` to store the values for this column into the pages representing each row (metadata value name is `<Column Heading>`), or `checklist` to store the values into the page containing the checklist (metadata value name is `<Column Heading>.<Space Key>:<Row page title>`)	`store=checklist` not supported with Comala Boards
`sorttype`	no	`S`	Type of value to be used to sort the table by this column. Values could be any of A: Already sorted; C: Currency; D: Date; F: Float; I: Integer; S: String
`width`	no		Width of the column
`readonly`	no	`false`	Whether or not the column is read-only
`CSS class`	no		The style sheet (CSS) class to use for the cells
macro body			If no `usersgroup` is given, the options to select from have to be defined as part of the body. Each line of the body defines an option. Each option could have a different value from the actual caption by defining it as `<value>\|<caption>` . See Example 5 and Example 6.

Back to Comala Lists User Guide

Back to Comala Lists User Guide
list select examples