You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 77 Next »

The Spaces List Macro is used to display a list of spaces from within a page.

By default, Confluence lists the spaces from your current view of spaces on the Dashboard.

For each space listed, there is a link to browse the space, and to add a new page (if the user has permission to create pages).

On this page:

Usage with the Macro Browser

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

  1. Open your desired Confluence page or blog post, then click the 'Edit' button. The page or blog post opens in edit mode.
  2. Click the Macro Browser icon on the toolbar. The macro browser window opens in the middle of the screen in 'macro selection' mode.
  3. Scroll through the list of macros. Alternatively, start typing part of the name of your desired macro into the search box at the top right of the macro browser window. Macros with a matching name will appear in the main pane.
  4. Click on the desired macro to access its parameters and preview parameter changes ('preview mode').
  5. Set the macro parameters to your requirements. If desired, you can preview these changes by clicking 'Refresh'.
  6. Click 'Insert' to put the macro into the page.

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

Once you've found the spaces list macro, click 'insert' to add it to your page.

Usage with the Wiki Markup Editor

What you need to type

What you will get

{spaces-list}

Unknown macro: {spaces-list}
Unknown macro: {spaces-list}

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.
  • team — spaces grouped according to team labels.
  • my — spaces which you have added to your favourites list.
  • 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

Specify the width of the table in which the spaces are listed

{spaces-list:width=40%}

Specify the view from which spaces are listed

{spaces-list:team}

Replace 'team' with 'all', 'my' or 'new' to display all spaces, my spaces only or new spaces only.

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.