Access Keys:
Skip to content (Access Key - 0)

pagetree macro

Overview:

The {pagetree} macro, is used for displaying a tree view of the page hierarchy.

The {pagetree} macro displays a tree view of the hierarchy of pages using a user-definable page as its root. It can display both the page title and any excerpt that is inside the page. The tree entries can be sorted by title, creation or modification date and may also be reversed.

Parameters:

The {pagetree} macro parameters define the way that the entries are sorted, whether the excerpt should be included or not and the page that is to be the root of the tree.

{pagetree:root=myPage|excerpt=true}
Parameter Required Default Notes
root Space Homepage The page from which the tree view will start (ie. it's first "root" node). This setting defaults to the Space Homepage (as defined in Space Admin) but can also be:
  • any page title — the title of a page to use as the root node
  • @self — the current page
  • @parent — the parent page for the current page being viewed
excerpt false Whether excerpts should be displayed or not
sort natural The order in which pages should be sorted, this parameter can take one of four values
  • natural — Natural sort order is the order that most people would expect, ie 'title 10' comes after 'title 2'
  • bitwise — Bitwise sorting is confluence's default mode of sorting, using this algorithm 'title 10' comes before 'title 2' since '1' is less than '2' (the zero never gets considered)
  • creation — Sorts the pages in the order that they were created
  • modified — Sorts the pages in the order of their last modification date
reverse false Setting this parameter to true will reverse the order of sorting

Examples:

Hints and Tips

If you just see a message "Loading..." and nothing else, make sure you have Base URL correctly set in your General Configuration settings.

See Also



Ask questions, get help and report bugs & issues on our Community Site

View old comments


Adaptavist Theme Builder Powered by Atlassian Confluence