Spaces macro

List spaces in categories or list all spaces from a specific category. Perfect to show the content of a category and ease navigation.

On this page


Macro Setup

Spaces

Macro key: rw-spaces-in-categories or spaces-in-category 

Macro body: None.

Promoted: Space Layout, pages

 

Using the Spaces macro

To add the Spaces macro to a page

  1. In the Confluence editor, choose Insert > Other Macros.
  2. Find and select the Spaces In Categories macro.


To add the Page Tree macro to a Space layout

  1. In the Space Layout editor, open the Macro Browser and select RefinedWiki's macro Page Tree, or search for rw-pagetree.


For Site and Category homes we recommend using the Spaces Module.


If you have a large instance you can speed up the performance of this macro by setting the parameter closed to true. Please read this document for more performance tips.


Preview


Parameters

Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example).

Parameter

Default

Description

Available since

Title

(title)

SpacesThe title for this macro4.0

Closed

(closed)

false

When checked, the sorted list will be closed/collapsed.

1.3

 

Category key

(categoryKey)

 

Filter the content by setting a category key. Note that this is automatically done if the macro is placed on a category dashboard

1.3.1

Show space logo

(showLogo)

false

When checked, space logos will be displayed instead of space icons.

3.1

Exclude archived spaces

(excludeArchivedSpaces)

false

When checked, archived spaces will be excluded in the list. (Only for Confluence 4.3 and above )

3.3

Include links

(includeLinks)

false

When checked, any links configured for the category will be displayed in the list.

3.5

Include Create Space button

(includeCreateButton)

falseWhen checked, a create space button will be included in the macro.4.0

Exclude Space Descriptions

(excludeDescriptions)

falseWhen checked, space descriptions will not be visible in the list. 

Show Users

(showUsers)

false
When checked, users assigned to a category will be displayed in the list.
4.2

Link to dashboards

(showDashboards)

falseWhen checked, category names will be links to their dashboards.4.2


Demo

Product Documentation Spaces