Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

There is also an option in the macro for expanding or collapsing all children.

Example

Using the Macro

To use the macro, edit a page and select the wiki markup tab. You can simply paste the {pagetree} macro anywhere in the page where you want the page browser to appear. The macro takes several parameters outlined below. The root Here's my favorite macro expression which I use on my wikis. The root=@self parameter sets the root at the current specified page. You can substitute a page name for @self here instead if you want. If you don't specify a root, it sets the home page as root by default. In addition, the expandCollapseAll parameter provides expand/collapse all links which are handy.

Code Block
{pagetree:root=@self|expandCollapseAll=true}

...

  • root: - (optional) page where the tree would be rooted from. Meta root names @self, @parent, @home can also be used.
  • sort: - (optional) sorts the tree node. It my be one of the following: bitwise, creation, modified, natural, position. Default sorting is position
  • excerpt: - (optional) true/false flag that indicate if a page excerpt would be included in the tree display (default is false).
  • reverse: - (optional) true/false flag that allows you to reverse the order of the display (default is false).
  • searchBox: - (optional) true/false flag that allows you to add a search box in the tree that would search from the root page (default is false).
  • expandCollapseAll: - (optional) true/false flag that allows you to add an expand all and a collapse all row (default is false).
  • startDepth: - (optional) a number that indicates the initial depth that the tree would display (default value is 1).

Related Documentation

For more detailed documentation, see the official Pagetree Macro Docs.

Related macros

  • {children}