This page last changed on Sep 24, 2008 by smaddox.

Use the Children Display Macro to display the children and the descendants of a page.

Note that only pages to which you have 'View' permission will be displayed.

Children Display Macro

What you need to type What you will get
{children}

Optional Parameters

No  parameter Default Description
 1 all true Display all descendants
 2 page current Specify which page to display children for in a current space or in a different space.
If the page parameter is '/', then the macro will list all the current space's top-level pages i.e. 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.
 3 depth none Specify the depth of descendents to display
 4 first none Restrict the number of children displayed at the top level
 5 style none Specify the style in which descendants are displayed
 6 excerpt false Display the child pages' excerpts, if they exist
 7 sort=creation
sort=title
sort=modified
Manual if manually ordered, otherwise alphabetical 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.
 8 reverse false Use this parameter in conjunction with the 'sort' parameter described above. Set 'reverse=true' to change the sort from ascending to descending order.

1. Display all descendants of the page

{children:all=true}

2a. Specify which page to display children for

{children:page=page-name}

2b. Specify which page in a different space to display children for

{children:page=space-key:page-name}

3. Specify the depth of descendants

{children:depth=2}

4. Restrict the number of children displayed at the top level

{children:first=x}

5. Specify the style in which descendants are displayed

Choose from heading levels h1 to h6.

{children:depth=1|style=h3}

6. Display the child pages' excerpts, if they exist

{children:depth=2|excerpt=true}

7. Sort children by modification date

{children:sort=creation|reverse=true}
RELATED TOPICS

Working with Page Families
Working with Macros

Take me back to Confluence User Guide

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