This page is a snippet
For full information, see:
Snippet
Macro name: pagetree Macro body: None. Parameter name | Required | Default | Parameter description and accepted values |
|---|
excerpt | No | false | Determines whether the page tree will show excerpts from each page. The excerpts must be defined on the individual pages by the Excerpt macro. Available values: true – Show excerpts.false – Do not show excerpts.
| expandCollapseAll | No | false | Determines whether the macro will offer the 'expand all' and 'collapse all' options at the top of the page tree. Your readers can click these links to open or close all branches of the tree at once. Available values: true – Show the 'expand all' and 'collapse all' options.false – Do not show the options.
| reverse | No | false | Used in combination with the sort parameter. Determines the order of pages displayed in the tree, by reversing the default (ascending) order. Available values: true – Pages will be displayed in descending order by title.false – Pages will be displayed in ascending order by title.
| root | No | The home page of the space | Specifies the parent page for the page tree. The tree will include all children of the given page, plus their children and grand-children, and so on. The tree will not include the root page itself.
Available values: - A 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.
| searchBox | No | false | Determines whether the macro will offer a search box above the page tree. The search box allows your readers to enter a search term, and then searches within the page tree for the specified value. Available values: true – Include the search box.false – Do not include the search box.
| sort | No | position | Determines the order in which pages are displayed in the tree. This sort order is for display purposes only. It does not permanently re-arrange the page order. Available values: 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.
| startDepth | No | 1 | Indicates how many levels of children the tree should show when it opens for the first time. Available values: Any number greater than 0. |
|