Skip to Content

Changes for page Children Macro

Last modified by Drunk Monkey on 2025-05-02 10:50
From version 5.1
edited by Drunk Monkey
on 2024-03-31 09:02
Change comment: Install extension [org.xwiki.platform:xwiki-platform-index-tree-macro/16.2.0]
To version 9.1
edited by Drunk Monkey
on 2025-05-02 10:50
Change comment: Install extension [org.xwiki.platform:xwiki-platform-index-tree-macro/17.3.0]

Summary

Details

XWiki.WikiMacroClass[0]
Macro code
... ... @@ -1,1 +1,10 @@
1 -{{documentTree root="document:" /}}
1 +{{velocity}}
2 +## Escape special characters in the macro parameter value.
3 +#set ($sort = $xcontext.macro.params.sort.replaceAll('([~"])', '~$1'))
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" /}}
10 +{{/velocity}}
XWiki.WikiMacroParameterClass[0]
Parameter name
... ... @@ -1,0 +1,1 @@
1 +sort
Parameter description
... ... @@ -1,0 +1,1 @@
1 +The document field used to sort the child documents, followed optionally by the sort order. E.g.: 'title' or 'date:desc'.
Parameter type
... ... @@ -1,0 +1,1 @@
1 +org.xwiki.index.tree.internal.macro.DocumentSort
Parameter mandatory
... ... @@ -1,0 +1,1 @@
1 +No
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