{deck:id=pagetree|width=907px}
{card:label=Overview}
h4. Page Tree
The Pagetree macro displays a dynamic, hierarchical list of pages starting from a specified parent (root) page. You can embed the page tree into your Confluence page, where it can act as a table of contents or a list of related topics.
h5. This plugin includes the following macros:
* *pagetree* - Creates a list of pages.
{card}
{card:label=documentation}
{deck:id=pagetreem}
{card:label=pagetree}
Displays a dynamic, hierarchical list of pages starting from a specified parent (root) page. You can embed the page tree into your Confluence page, where it can act as a table of contents or a list of related topics.
h3. The Code
Displaying all the pages in the current space:
{code}
{pagetree}
{code}
With a searchbox:
{code}
{pagetree:searchBox=true}
{code}
h3. {toggle-cloak:id=1} Result
{cloak:id=1}
*Displaying all the pages in the current space:*
{pagetree}
*With a searchBox:*
{pagetree:searchbox=true}
{cloak}
h3. {toggle-cloak:id=2} Parameters
{cloak:id=2}
||*Name*||*Required?*||*Default*||*Description*||
|excerpt|(x)|false|Set this value to 'true' if you want the page tree to show excerpts from each page. The excerpts must be defined on each page by the [Excerpt macro|Advanced Macro Plugin].|
|expandCollapseAll|(x)|false|Set this value to 'true' 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.|
|reverse|(x)|false|Use this parameter in combination with the sort parameter described below. Set this value to 'true' if you want the pages displayed in descending order rather than ascending order.|
| root | (x) | homepage of current 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 — Page tree shows all pages under the specified page.
* @home = Page tree shows all pages under the home page of the space (default).
* @self = Page tree shows all pages under the current page.
* @parent = Page tree shows all pages under the parent of the current page, including the current page.
* @none = Page tree shows all pages in the space, including orphaned pages and the home page. |
|searchBox|(x)|false|Set this value to 'true' if you want to include 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. |
| sort | (x) | 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 = Display the pages using standard alphabetical sorting, such as: title1, title10, title2.
* creation = Display the pages in order of date created.
* modified = Display the pages in order of date last modified.
* natural = Display the pages in 'natural' alphabetical order, such as: title1, title2, title10.
* position = Display the pages using 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|(x)|1|Enter any number greater than 0, indicating how many levels of children the tree should show when it opens for the first time.|
{cloak}
{deckcard}
{card}
{deck}
{roundrect:bgcolor=#828282|width=909px|height=50px|corners=false,false,true,true}
{roundrect}
|