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:
- In the Confluence editor, select > View more
- Find the item to be inserted and select it
- Select Insert
You can also type / onto the page to bring up the same list you'd see by selectingfrom the toolbar.
To edit the Page Tree macro:
- Select the macro placeholder. The floating toolbar appears.
- Select Edit. The right panel opens.
- Modify the parameters. Your changes are saved as you go.
- Resume editing the page, and the panel closes.
Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the browser, it will be listed below in brackets (
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.
Sort Pages By
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:
Include Excerpts in Page Tree
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.
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
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
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:
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 body: None.