Confluence

Basic Usage

To display a tree starting with the space home page, use the macro as follows:

{pagetree}

Which results in:

To display the tree starting from a specific page, use the root parameter as follows:

{pagetree:root=Macros}

Which produces the following output:

You can also specify the root page as "@self" for the current page or "@parent" for the parent of the current page.

Displaying page excerpts

Excerpts embedded into pages may be displayed alongside the link to the page by setting the excerpt flag to true

{pagetree:root=Navigation and Lists|excerpt=true}

Which looks like this:

Bitwise sort order

Bitwise sorting simply takes each character of the title and compares it with the next title in order to decide which should be displayed first. This is the simplest kind of sorting, and is used by confluence in most places.

{pagetree:root=pagetree macro|sort=bitwise}

Which looks like this:

Natural sort order

Bitwise sorting works very well in most cases however when your title contains a number of some kind it starts to break down. A bitwise sort will think that 'title 10' should come after 'title 1' but before 'title 2', since when the bitwise sort gets to the first digit in 'title 10' it doesn't understand that the zero should also be taken into account.

Natural sorting is very similar to bitwise sorting, however as the two titles are being compared the algorithm checks to see if the characters it is comparing are numbers or not. If they are numbers then it works along the title until it finds something that isn't a number and then uses the whole number value to compare against the other title.

Since this method of sorting produces more reliable results than the standard bitwise sort used elsewhere in confluence, it has been chosen as the default sort method for the {pagetree} macro

{pagetree:root=pagetree macro}

Which looks like this:

Creation Date sort order

There may be occasions when you need to sort by the date that the page was created (first to last / oldest to newest), to do this you set the sort algorithm to 'creation' as can be seen below.

{pagetree:root=pagetree macro|sort=creation}

Which looks like this:

Modification Date sort order

There may be occasions when you need to sort by the date that the page was last modified (first to last / oldest to newest), to do this you set the sort aglorithm to 'modified' as can be seen below.

{pagetree:root=pagetree macro|sort=modified}

Which looks like this:

Reversing the sort order

You can also display any of the sort orders in reverse order by setting the reverse parameter to true

{pagetree:root=pagetree macro|reverse=true}

Which produces a reverse-alphabetical sort as can be seen below:

Reverse sorting however may be more useful when used in conjunction with the modification or creation date sorting, for example the following code produces the pagetree with the most recently modified page at the top.

{pagetree:root=pagetree macro|sort=modified|reverse=true}

Produces a tree of pages reverse sorted by modification date: