The Adaptavist Group LogoDocumentation

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}
ParameterNameDescriptionTypeDefaultRequired
displayDisplay ModeThe style of output to displayenumlist
filterFilter 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 enumall
teamsTeam LabelFilter the spaces by team labelstring
rootRootThe root of the treestring
depthDepthThe depth of the treestring
showRootShow RootShow the root of the treebooleanfalse
showPagesShow PagesDisplay pages in the treebooleanfalse
reverseList Reverse In List view, reverse the list- false: sort ascending A-Z- true: sort descending Z-A booleanfalse
countList CountThe number of spaces to display in the liststring
startList StartThe start index of the liststring

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.

Search documentation

Start typing to search the docs.