• Products
  • Documentation
  • Resources
Products
Documentation
Resources
Atlassian Support
/
Confluence
/
Resources
/
Extend the functionality of Confluence Cloud
/
Use macros to add navigation on Confluence pages
Cloud

Insert the page tree macro

The Page Tree macro displays a dynamic, hierarchical list of pages starting from a specified parent (root) page. It can act as a table of contents or a list of related topics. When viewing the page tree, your reader can click a link to view the relevant page. The page's current position is highlighted in the page tree.

Use the Page Tree macro

To add the Page Tree macro:

  1. When editing, select from the toolbar

  2. Find the macro by name and select it

  3. Configure it as needed

You can also type / on the page to bring up the same list you'd see by selecting from the toolbar. Continue typing the name of the macro to filter the list.

To edit the Page Tree macro:

  1. Select the macro placeholder.

  2. Select the Edit icon to open the configuration panel.

  3. Configure the parameters. Your changes are saved as you go.

  4. Resume editing the page, and the panel closes.

You can also select the centered , medium-width , and full-width icons to adjust the width of some macros. Select the trashcan iconto remove the macro.

Parameters

Parameters are options that you can set to control what and how content from the macro appears on the page. 

If the parameter name used in Confluence Cloud storage format or wikimarkup is different than the label used when inserting macros using the browser or the slash command, it will be listed below in brackets (example).

Parameter

Default

Description

Root Page
(root) 

The home page of the space

Specify the parent page for the page tree. The tree will include all children of the given page, plus their children and grand-children etc. The tree will not include the root page itself.

Specify the page title or a special value as follows:

  • Your page title — to specify a page name for the parent or root of the tree. The tree will include all children and grand-children of the specified root. The tree will not include the specified root page itself.

  • '@home' — will include all pages under the home page of the space (default).

  • '@self' — will include all pages under the current page.

  • '@parent' — will include all pages under the parent of the current page, including the current page.

  • '@none' — will include all pages in the space, including orphaned pages and the home page.

Sort Pages By
(sort) 

position

Specify the order to display the pages in the tree. This sort order is for display purposes only. It does not permanently re-arrange the page order. The value may be one of the following:

  • 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.

Include Excerpts in Page Tree
(excerpt) 

false

Select if you want the page tree to show excerpts from each page. The excerpts must be defined on each page by the Excerpt macro.

Reverse Order
(reverse) 

false

Select to show the pages in reverse (descending) natural order. Must be used in combination with the Sort Pages By parameter.

Include Search Box above Page Tree
(searchBox) 

false

Select if you want to include a search box above the page tree. The search box allows your readers to search within the page tree for the specified value.

Show Expand/Collapse Links
(expandCollapseAll) 

false

Select if you want to display the 'expand all' and 'collapse all' links at the top of your page tree. Your readers can click these links to open or close all branches of the tree at once.

Available values in wikimarkup and storage format:

  • true – Show the 'expand all' and 'collapse all' options.

  • false – Do not show the options.

Start Depth
(startDepth) 

1

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

Wiki markup example

Wiki markup is only supported in the legacy editor.

Wiki markup is useful when you need to add a macro outside the editor, for example as custom content in the sidebar, header or footer of a space.

Macro name: pagetree

Macro body: None.

1 2 3 4 {pagetree:root=Page Name|sort=natural|excerpt=true|reverse=false|startDepth=3|expandCollapseAll=true|searchBox=true}

Additional Help

On this pageUse the Page Tree macroParametersWiki markup example
CommunityQuestions, discussions, and articles