The Spaces List Macro is used to display a list of spaces from within a page, similar to the list of spaces seen on the dashboard.

On this page:

Usage with the Macro Browser

To insert the spaces list macro into a page using the Macro Browser:

  1. Open the Confluence page or blog post that you want to edit, then click the Edit button.
  2. Click the Macro Browser icon on the toolbar. The macro browser window will open.
  3. Scroll through the list of macros to find the one you want. Alternatively, start typing the macro name into the search box at the top right of the macro browser. Macros with a matching name will appear in the main pane.
  4. Click the desired macro.
  5. Set the macro parameters to your requirements. If desired, you can preview these changes by clicking Refresh.
  6. Click Insert to add the macro onto the page.

(tick) You can also insert macros using autocomplete. For more information, see Using Autocomplete in the Rich Text Editor.

Usage with the Wiki Markup Editor

What you need to type

What you will get

{spaces}
or
{spaces-list}

Unknown macro: {spaces}
Unknown macro: {spaces}

Parameters

Parameters are options that you can include in Confluence macros to control the content or format of the macro output. The table below lists relevant parameters for this macro.

Parameter names are different in the Macro Browser and in wiki markup. Below we show the Macro Browser parameter names in bold text, and the equivalent wiki markup parameters in (bracketed) text. If we do not show any parameter name for the wiki markup, then you should leave out the parameter name and simply include the parameter value as the first parameter, immediately after the colon (:).

Parameter

Required?

Default

Description

Scope of spaces

no

all

Specify the view from which spaces are listed. Available options are:

  • all – All spaces in the Confluence installation.
  • category – Spaces grouped according to space categories.
  • team – Same as 'category' above. Space categories were formerly known as team labels, and this option remains in the macro to ensure backwards compatibility with earlier versions of the macro.
  • favourite – Spaces which you have added to your favourites list.
  • my – Same as 'favourite' above. This option remains in the macro to ensure backwards compatibility with earlier versions of the macro.
  • new – New spaces which have been created within the last 7 days.

Width of List
(width)

no

100%

Specify the width of the table. The width of the spaces list table, specified as a percentage (%).

Examples

Display the spaces in a table with a width of 40% of the window size:

{spaces:width=40%}

Display the spaces grouped by space category:

{spaces:team}
RELATED TOPICS

Browsing a space
Creating a New Page
Working with Macros

Take me back to the Confluence User's Guide

  • No labels

Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 2.5 Australia License.