robotsnoindex

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:

  1. In the Confluence editor, choose > Other Macros
  2. 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
(all) 

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
(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
(first) 

none

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

Depth of Descendants
(depth) 

none

Enter a number to specify the depth of descendants to display. For example, if the value is 2, the macro will display 2 levels of child pages.

This setting has no effect of Show Descendants is enabled.

Heading Style
(style) 

none

Choose the style used to display descendants.

Include Excerpts
(excerpt) 

none

Allows you to include a short excerpt under each page in the list. Choose between:

  • None - no excerpt will be displayed
  • Simple - displays the first line of text contained in an Excerpt macro any of the returned pages. If there is not an Excerpt macro on the page, nothing will be shown.
  • Rich content - displays the contents of an Excerpt macro, or if there is not an Excerpt macro on the page, the first part of the page content, including formatted text, images and some macros.

Sort Children By
(sort) 

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
(reverse) 

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.


robotsnoindex
robotsnoindex

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}