Skip to Content

Changes for page Documents Macro

Last modified by Ludovic Dubost on 2024/07/22 15:50
From version 3.1
edited by Ludovic Dubost
on 2015/09/01 11:46
Change comment: Install extension [org.xwiki.platform:xwiki-platform-index-ui-7.1]
To version 7.1
edited by Ludovic Dubost
on 2018/07/01 11:40
Change comment: Install extension [org.xwiki.platform:xwiki-platform-index-ui/10.5]

Summary

Details

Page properties
Content
... ... @@ -1,7 +1,7 @@
1 1  Example:
2 2  
3 -##{{{{{documents id="example" count="5" actions="false" columns="doc.title"/}}}}}##
3 +##{{{{{documents id="example" count="5" actions="false" columns="doc.title, doc.location"/}}}}}##
4 4  
5 5  Generates:
6 6  
7 -{{documents id="example" count="5" actions="false" space="Main" parent="Main.WebHome" columns="doc.title"/}}
7 +{{documents id="example" count="5" actions="false" columns="doc.title, doc.location"/}}
XWiki.WikiMacroClass[0]
Macro code
... ... @@ -5,15 +5,15 @@
5 5   #set ($discard = $collist.add($colname.trim()))
6 6   #end
7 7  #else
8 - #set($collist = ['doc.name', 'doc.space', 'doc.date', 'doc.author'])
8 + #set($collist = ['doc.title', 'doc.location', 'doc.date', 'doc.author'])
9 9  #end
10 10  #set($colprops = {
11 - 'doc.title' : { 'type' : 'text' , 'size' : 30, 'link' : 'view' },
12 - 'doc.fullName' : { 'type' : 'text' , 'size' : 30, 'link' : 'view' },
13 - 'doc.name' : { 'type' : 'text' , 'size' : 30, 'link' : 'view' },
14 - 'doc.space' : { 'type' : 'text', 'link' : 'space' },
15 - 'doc.date' : { 'type' : 'date' },
16 - 'doc.author' : { 'type' : 'text', 'link' : 'author' }
11 + 'doc.title' : { 'size' : 30, 'link' : 'view', 'filterable': false, 'sortable': false },
12 + 'doc.location' : { 'html': true },
13 + 'doc.fullName' : { 'size' : 30, 'link' : 'view' },
14 + 'doc.name' : { 'size' : 30, 'link' : 'view' },
15 + 'doc.space' : { 'link' : 'space' },
16 + 'doc.author' : { 'link' : 'author' }
17 17  })
18 18  #set($options = {
19 19   'translationPrefix' : 'platform.index.',
... ... @@ -23,6 +23,9 @@
23 23  #if ("$!xcontext.macro.params.space" != "")
24 24   #set ($extraParams = "&space=$escapetool.url($xcontext.macro.params.space)")
25 25  #end
26 +#if ("$!xcontext.macro.params.location" != "")
27 + #set ($extraParams = "$!{extraParams}&location=$escapetool.url($xcontext.macro.params.location)")
28 +#end
26 26  #if ("$!xcontext.macro.params.parent" != "")
27 27   #set ($extraParams = "$!{extraParams}&parent=$escapetool.url($xcontext.macro.params.parent)")
28 28  #end
... ... @@ -31,7 +31,11 @@
31 31  #end
32 32  #if(!$isGuest && $xcontext.macro.params.actions == "true")
33 33   #set($discard = $collist.add('_actions'))
34 - #set($discard = $colprops.put('_actions', { 'actions' : ['copy', 'rename', 'rights', 'delete'] }))
37 + #set($discard = $colprops.put('_actions', {
38 + 'actions': ['copy', 'rename', 'rights', 'delete'],
39 + 'filterable': false,
40 + 'sortable': false
41 + }))
35 35  #end
36 36  #if ("$!xcontext.macro.params.id" != "")
37 37   #set ($livetableId = $xcontext.macro.params.id)
XWiki.WikiMacroParameterClass[6]
Parameter description
... ... @@ -1,0 +1,1 @@
1 +Only lists documents having a full reference matching the passed location (e.g. passing "Beau" would match a document reference of "France.Paris.Beaubourg.Office")
Parameter mandatory
... ... @@ -1,0 +1,1 @@
1 +No
Parameter name
... ... @@ -1,0 +1,1 @@
1 +location