Page Tree macro

The UI page tree macro shows an interactive overview of the pages in a space.

This macro is designed to be used in the left-hand column of the Space Layout. Although it's possible to use it on dashboards, you achieve the best user experience by including the page tree present space layouts. 

Add and edit the macro

You can add macros to pages, user dashboards, and space layouts.

To change its settings, click the macro > Edit.

Parameter

Description

Available since version

Parameter

Description

Available since version

Space

Select to restrict the page tree to the specified space.

4.0

Root page

Specify the page ID, or one of these values:

  • @home includes all pages under the space’s home page.

  • @self includes all the current page’s child pages.

  • @parent includes the current page and all its child pages.

3.3

Include search bar above page tree

Select to add a search bar at the top of the page tree.

3.3.2

Include expand/collapse buttons

Select to add expand and collapse buttons.

3.3.2

Theme

  • Default displays the page tree within a styled container.

  • Public displays a cleaner page tree design.

  • None displays the page tree without styling.

3.3.2

4.0

3.3.2

Space Shortcuts

Select to display a space shortcuts section at the top of the page tree.

3.4.5

Space content menu

Select to include a space content menu which offers quick access to content like pages and blog posts.

5.0.0

Expand Depth

Specify how many child page levels the page tree shows when it is first displayed.

6.0.0

Macro key

Macro keys are used to identify macros in the macro browser and to build custom solutions. The Page Tree macro key is rw-pagetree.