ThemeBuilder for Confluence Server and DC

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

error

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

error

teams

Team Label

Filter the spaces by team-label

string

error

root

Root

The root of the tree

string

error

depth

Depth

The depth of the tree

string

error

showRoot

Show Root

Show the root of the tree

boolean

false

error

showPages

Show Pages

Display pages in the tree

boolean

false

error

reverse

List Reverse

In list-view reverse the list

- false: sort ascending A-Z

- true: sort descending Z-A

boolean

false

error

count

List Count

The number of spaces to display in the list

string

error

start

List Start

The start index of the list

string

error

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 is displayed.

list spaces 01