Use the Children Display macro to list the child pages of a page and the further descendants (children's children). By default, the macro displays links to the child pages as shown in the screenshot below. People viewing the page will see only the links for pages that they have permission to view.

Screenshot: The Children Display macro in Confluence


 

On this page:

Related pages:

Using the Children Display macro

To add the Children Display macro to a page:

  1. In the Confluence editor, choose Insert > Other Macros.
  2. Find and select the required macro.

Speeding up macro entry with autocomplete:

Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete.

To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro.

Example

This list of child pages is generated by a Children Display macro on this page:

Parameters

Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example).

Parameter

Default

Description

Show Descendants

false

Choose whether to display all the parent page's descendants.

  • If true shows the complete tree of pages underneath the parent page, regardless of Depth of Descendants

Parent Page

current

Specify the page to display children for, from either the current space or a different space. Enter:

  • '/' — to list the top-level pages of the current space, i.e. those without parents.
  • 'pagename' — to list the children of the specified page.
  • 'spacekey:' — to list the top-level pages of the specified space.
  • 'spacekey:pagename' — to list the children of the specified page in the specified space.

Number of Children

none

Restrict the number of child pages that are displayed at the top level.

Depth of Descendants

none

Enter a number to specify the depth of descendants to display. This setting has no effect of Show Descendants is enabled.

Heading Style

none

Choose the style used to display descendants.

Include Excerpts

false

Display excerpts for the child pages, if they exist.

Sort Children By

Manual if manually ordered, otherwise alphabetical

Optional. Choose:

  • creation — to sort by content creation date
  • title — to sort alphabetically on title
  • modified — to sort of last modification date.

Reverse Sort

false

Use with the Sort Children By parameter. When set, the sort order changes from ascending to descending.

Code examples

See:

  • No labels

Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 2.5 Australia License.