Skip to Content

Changes for page Children Macro

Last modified by Martin Výlet on 27.05.2025 15:40
From version 7.1
edited by Martin Výlet
on 27.05.2025 15:37
Change comment: Migrated property [featureMandatory] from class [XWiki.WikiMacroParameterClass]
To version 9.1
edited by Martin Výlet
on 27.05.2025 15:40
Change comment: Install extension [org.xwiki.platform:xwiki-platform-index-tree-macro/17.4.0]

Summary

Details

XWiki.WikiMacroClass[0]
Macro code
... ... @@ -1,5 +1,10 @@
1 1  {{velocity}}
2 2  ## Escape special characters in the macro parameter value.
3 3  #set ($sort = $xcontext.macro.params.sort.replaceAll('([~"])', '~$1'))
4 -{{documentTree root="document:" sortDocumentsBy="$!sort" /}}
4 +#if ("$!xcontext.macro.params.root" != '')
5 + #set ($root = $xcontext.macro.params.root)
6 +#else
7 + #set ($root = 'document:')
8 +#end
9 +{{documentTree root="$root" sortDocumentsBy="$!sort" /}}
5 5  {{/velocity}}
XWiki.WikiMacroParameterClass[1]
Parameter name
... ... @@ -1,0 +1,1 @@
1 +root
Parameter description
... ... @@ -1,0 +1,1 @@
1 +The root node id. This is useful if you want to display only the descendants of a given node (which is the specified root). The tree displays the children of the root node on the first level, so the root node is not actually displayed. The entire tree is displayed if the root node is not specified. The format of a node identifier is entityType:entityReference, where the entity type can be for instance wiki, space, document. E.g.: wiki:xwiki, space:xwiki:Main, document:xwiki:Main.WebHome
Parameter mandatory
... ... @@ -1,0 +1,1 @@
1 +No