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.
Note: The Page Tree macro is used in the Confluence Documentation theme, to create a navigation panel showing a table of contents for your space. Read the instructions on Configure the Documentation Theme.
Using the Page Tree Macro
To add the Page Tree macro to a page:
- In the Confluence editor, choose Insert > Other Macros
- Find and select the required macro
Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Autocomplete for links, files, macros and mentions.
To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro.
Click Refresh in the Macro Browser to see the effect of changes to the macro parameters.
Macro Parameters
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 macro browser, it will be listed below in brackets (example).
Parameter | Default | Description |
|---|---|---|
Root Page | 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 | 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:
|
Include Excerpts in Page Tree | 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 | 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 | 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 | 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:
|
Start Depth | 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. |
Code examples
The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page.
Macro name: pagetree
Macro body: None.
Storage format example
<ac:structured-macro ac:name="pagetree">
<ac:parameter ac:name="reverse">false</ac:parameter>
<ac:parameter ac:name="sort">natural</ac:parameter>
<ac:parameter ac:name="root">
<ac:link>
<ri:page ri:content-title="Page Name"/>
</ac:link>
</ac:parameter>
<ac:parameter ac:name="startDepth">3</ac:parameter>
<ac:parameter ac:name="excerpt">true</ac:parameter>
<ac:parameter ac:name="searchBox">true</ac:parameter>
<ac:parameter ac:name="expandCollapseAll">true</ac:parameter>
</ac:structured-macro>Wiki markup example
{pagetree:root=Page Name|sort=natural|excerpt=true|reverse=false|startDepth=3|expandCollapseAll=true|searchBox=true}