This page last changed on May 29, 2007 by rosie@atlassian.com.

This page is outdated. Please see new page.

  
Displays the children and descendants of the current page.
Usage:
{children}
OR
{children:page=a_page_title}
OR
{children:all=true}
OR
{children:depth=a_depth}
OR
{children:depth=_a_depth_|style=heading_style}
OR
{children:_sort=<mode>|reverse=<true or false>}

parameter Required Default Description
page no the current page Specify which page to display children for
depth no none Specify the depth of descendents to display
style no none One of "h1", "h2" .... "h6" - displays children in a contents view
excerpt no false Display the child pages' excerpts (if they exist)
sort no
title
 The 'sort' attribute is an optional attribute that allows you to configure how the children are sorted. Specify 'creation' to sort by content creation date, 'title' to sort alphabetically on title and 'modified' to sort of last modification date.
reverse no false
 Use the reverse attribute to optionally reverse the sorting.

If the page parameter is '/', then the macro will list all the current space's "top level" pages - those without parents. If the page parameter is a space key followed by a
colon (e.g {children:page=DOC:}), then the top level pages of that space will be listed.

Example 1:

{children:all=true}

gives:

Example 2:

A depth of 1 will only display the first generation descendents of the current page. That is it will only display the direct children of the current page.

{children:depth=1}

gives:

Example 3:

A style of "h3" will display the page's direct children as level 3 headings, with their children as lists below the headings. Very useful for quickly generating a contents page

{children:all=true|style=h3}

gives

(outdated) Child Page 1

(outdated) Child Page 2

Document generated by Confluence on Dec 03, 2008 15:18