space-hierarchy macro

Owned by Robert Alexander Marshall
Last updated: Dec 18, 2023
2 min read
1 Overview | 2 Parameters | 3 Usage | 4 Reference Markup | 5 Related Macros | 6 Related Documentation

Overview

The space-hierarchy macro displays on the page the hierarchy beneath the current space. This will be displayed as a tree representation of the hierarchy.

The space hierarchy is defined using the parent-space macro added to each child space.

You can show the hierarchy beneath a different space using the space argument.

Parameters

Parameter

Required

Default

Notes

Parameter

Required

Default

Notes

space

 

Current space

  • sets the space to use as the root space for the hierarchical display

  • value can be the spacekey or  ~<spacename>

The hierarchical root space is displayed as the root space in the tree representation on the page.

Usage

Add the Space Hierarchy macro to a page in a space using the Confluence macro browser.

In the macro editor preview, any spaces set as a child of the root space using the parent-space macro will be displayed in the tree representation.

If the Space key box is left blank, the current space is displayed as the root space. In our example this is the Human Resources space.

If required add the spacekey to set the root space for the tree representation.

Reference Markup

{space-hierarchy:space=tdt}

Where the space parameter value defines the root space for the tree representation.