Introduction

The {pagetree} macro is a handy hierarchical browser of all the pages in your wiki. It's a great way to provide an interactive table of contents. By default it presents a view of all the child pages of your home page. Clicking the plus sign next to an item expands it to show its children without leaving the page you're on. Just click a title to go to the page.

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

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 parameter sets the root at the specified page. You can substitute a page name for @self here 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.

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

Screenshot of rendered {pagetree} macro

Macro parameters

Here are all the macro parameters you can control:

Related Documentation

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

Related macros