Use the Children Display macro to list the child pages of the page on which the macro is inserted. 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.
Using the Children Display macro
To add the Children Display macro to a page:
- In the Confluence editor, choose
> Other Macros - Find and select the required macro
Speeding up macro entry with autocomplete:
- In the new editor - Type / and the beginning of an element (tool or things in the insert menu) to see a list of suggestions.
- In the legacy editor - Type { and the beginning of the macro name to see a list of suggested macros.
Details are in Keyboard shortcuts, markdown, and 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.
The page links presented using the Children Display macro are dynamic based on the page's children. To change the page titles, go to the actual child page and edit the page title.
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. |
Wiki markup example
Wiki markup is only supported in the legacy editor.
Wiki markup is useful when you need to add a macro outside the editor, for example as custom content in the sidebar, header or footer of a space.
Macro name: children
Macro body: None.
{children:reverse=true|sort=creation|style=h4|page=Home|excerpt=none|first=99|depth=2|all=true}