Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The Spacetree macro allows you to group spaces in the navigation tree by specific space categories. It even enables you to display the users favourite spaces for personalizing the navigation tree. You can also leave the space categories field blank to display a list of all spaces.

...

Info

Even though space categories are lower case in Confluence, the Spacetree macro will display the categories as you specifiy them in the macro parameters. This means categories like Products or Support Documents will automatically be matched to the lower case categories products or support-documents.

You can use the Spacetree macro on wiki pages or in themes like the Default Theme or Documentation Theme to display navigation trees in the sidebar of the theme.

...

Parameter

Default

Description

Space Categories

code

spaceCategories

None - list of all spaces will be displayed

A comma-separated list of space categories to select the spaces you want to display in the tree. The space categories are case-insensitive and displayed in the tree as you specify them in the list. Use @favourite to display favorite spaces of the current user. Use @self to display pagetree of current space, if it's not already listed in the spacetree. Leave blank to list all spaces.

Include Archived Spaces
includeArchivedSpaces

false

Enable to include archived spaces.

Expand Children
expandChildren

false

Enable to automatically expand the child pages of the current page.

Start Depth
startDepth

0

Enter any number greater than 0 to set how many levels of children the tree should show for the current space when it opens for the first time.

Sort Order
sort

position

The order the spaces should be sorted by. Valid values are:

  • bitwise - Sort alphabetically, for example: title1, title10, title2.

  • creation - Sort by date of creation.

  • modified - Sort by order of date last modified.

  • natural - Sort in 'natural' alphabetical order, for example: title1, title2, title10.

  • position - Sort by the default Confluence sorting rules. If your pages have been ordered manually, this sort will respect the defined order. Otherwise the pages will be displayed in the 'natural' alphabetical order, such as: title1, title2, title10.

Sort Pages
sortPages

true

Choose whether sort order should also be applied to pages in tree. Disable if you just want to sort the spaces in the tree.

Reverse Order
reverse

false

Enable for reverse ordering.

Style
style

modern

Choose whether you want to display the tree using the modern style (arrow icons) or the classic style (plus/minus icons). Valid values are:

  • classic - classic style in use before Confluence 5 using plus/minus icons

  • modern - modern style introduced in Confluence 5 using arrow icons

@self Title
currentSpaceTitle

"Current Space"

Title to display for @self section in tree, when using @self keyword in space categories. Use @self as title to display the name of the current space.

@favourite Title
favouriteSpacesTitle

"Favorite Space"

Title to display for @favourite section in tree, when using @favourite keyword in space categories.

Hide Default Pagetree
hidePagetree

true

Choose whether the default pagetree should be hidden in the sidebar when the Spacetree macro is being used in the sidebar as well.

...