Children Display Macro
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
Using the Children Display macro
To add the Children Display macro to a page:
- In the Confluence editor, choose Insert > Other Macros
- 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 Autocomplete for links, files, macros and mentions.
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 |
Parent Page | current | Specify the page to display children for, from either the current space or a different space. Enter:
|
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. For example, if the value is This setting has no effect of Show Descendants is enabled. |
Heading Style | none | Choose the style used to display descendants. |
Include Excerpts | none | Allows you to include a short excerpt under each page in the list. Choose between:
|
Sort Children By | Manual if manually ordered, otherwise alphabetical | Optional. Choose:
|
Reverse Sort | false | Use with the Sort Children By parameter. When set, the sort order changes from ascending to descending. |
Code examples
The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page.
Macro name: children
Macro body: None.
Storage format example
<ac:structured-macro ac:name="children">
<ac:parameter ac:name="reverse">true</ac:parameter>
<ac:parameter ac:name="sort">creation</ac:parameter>
<ac:parameter ac:name="style">h4</ac:parameter>
<ac:parameter ac:name="page">
<ac:link>
<ri:page ri:content-title="Home"/>
</ac:link>
</ac:parameter>
<ac:parameter ac:name="excerpt">none</ac:parameter>
<ac:parameter ac:name="first">99</ac:parameter>
<ac:parameter ac:name="depth">2</ac:parameter>
<ac:parameter ac:name="all">true</ac:parameter>
</ac:structured-macro>
Wiki markup example
{children:reverse=true|sort=creation|style=h4|page=Home|excerpt=none|first=99|depth=2|all=true}