List Spaces
This macro returns an unordered list of all permitted spaces.
Usage
Storage Format
<ac:macro ac:name="list-spaces">
<ac:parameter ac:name="parameter">value</ac:parameter>
</ac:macro>Wiki Markup
{list-spaces:parameter=value}| Parameter | Name | Description | Type | Default | Required |
|---|---|---|---|---|---|
| display | Display Mode | The style of output to display | enum | list | |
| filter | Filter Spaces | What kind of spaces should be listed- All: All spaces will be listed- Global: only Global spaces will be listed- Personal: only Personal spaces will be listed | enum | all | |
| teams | Team Label | Filter the spaces by team label | string | ||
| root | Root | The root of the tree | string | ||
| depth | Depth | The depth of the tree | string | ||
| showRoot | Show Root | Show the root of the tree | boolean | false | |
| showPages | Show Pages | Display pages in the tree | boolean | false | |
| reverse | List Reverse | In List view, reverse the list- false: sort ascending A-Z- true: sort descending Z-A | boolean | false | |
| count | List Count | The number of spaces to display in the list | string | ||
| start | List Start | The start index of the list | string |
Example
To list all the spaces available to the user viewing the page.
<ac:macro ac:name="list-spaces" />
{list-spaces}Result
A list of spaces displays.