Skip to Content
Last modified by Frank Fock on 2026/04/03 11:52
From version 7.1
edited by Frank Fock
on 2026/04/03 11:52
Change comment: Install extension [com.xwiki.pro:xwiki-pro-macros-confluence-bridges-ui/1.30.1]
To version 3.1
edited by Frank Fock
on 2025/04/29 19:14
Change comment: Migrated property [featureMandatory] from class [XWiki.WikiMacroParameterClass]

Summary

Details

Page properties
Content
... ... @@ -9,7 +9,7 @@
9 9  |**id**|The group of properties to show. If empty, will show page properties without identifiers.|No|(% style="width:27px" %)(empty)|(% style="width:334px" %)book
10 10  |**headings**|Which column of the page properties to show. By default, all columns are shown. Columns with comma in their names require being quoted|No|(% style="width:27px" %)(empty)|(% style="width:334px" %){{{Title,Author,~"Released in years~""}}}
11 11  |**cql**|A query written in the Confluence Query Language (CQL) syntax defining the list of documents to show. [[See the documentation>>https://extensions.xwiki.org/xwiki/bin/view/Extension/CQL/#HSyntax]].|If labels is not given|(% style="width:27px" %)(empty)|(% style="width:334px" %){{{label = "examplelabel" and space = currentSpace ( )}}}
12 -|**labels** or **label**|A list of tags to use, separated by a comma or a space. This value is ignored if the cql parameter is set. Note: this parameter doesn't exist in Confluence, it's an XWiki addition.|If cql is not given|(% style="width:27px" %)(empty)|(% style="width:334px" %)exampletag
12 +|**labels**|A list of tags to use, separated by a comma or a space. This value is ignored if the cql parameter is set. Note: this parameter doesn't exist in Confluence, it's an XWiki addition.|If cql is not given|(% style="width:27px" %)(empty)|(% style="width:334px" %)exampletag
13 13  |**operator**|Whether all the tags should match (AND), or any (OR). This value is ignored if the cql parameter is set. Note: this parameter doesn't exist in Confluence, it's an XWiki addition.|No|(% style="width:27px" %)OR|(% style="width:334px" %)AND
14 14  |**max**|Maximum number of results. Note: this parameter doesn't exist in Confluence, it's an XWiki addition.|No|(% style="width:27px" %)1000|(% style="width:27px" %)15
15 15  |**sort**|What to sort on. The only supported values are "modified", "creation" and "title" for now. Ignored if an ##order by## clause is present in the cql parameter. Note: this parameter doesn't exist in Confluence, it's an XWiki addition.|No|(% style="width:27px" %)(unset)|(% style="width:27px" %)title
XWiki.WikiMacroClass[0]
Cached
... ... @@ -1,0 +1,1 @@
1 +No
Asynchronous rendering
... ... @@ -1,0 +1,1 @@
1 +No
Macro code
... ... @@ -1,0 +1,68 @@
1 +{{include reference="Confluence.Macros.CommonCode" /}}
2 +
3 +{{velocity output="false"}}
4 +#macro (showTags $d)
5 + #foreach ($tag in $d.getTagList())
6 + [[$services.rendering.escape($services.rendering.escape($tag, $xwiki.currentContentSyntaxId), $xwiki.currentContentSyntaxId)>>Main.Tags||queryString="do=viewTag&tag=$escapetool.url($tag)"]]#if (!$foreach.last), #end
7 + #end
8 +#end
9 +
10 +#macro (executeMacro)
11 + #set ($title = $services.rendering.escape($wikimacro.parameters.firstcolumn, $xwiki.currentContentSyntaxId))
12 + #if (!$title)
13 + #set ($title = $services.localization.render('rendering.macro.detailssummary.firstcolumn'))
14 + #end
15 + #set ($results = $NULL)
16 + #getCQLMacroResults($xcontext.macro $results)
17 + #if ($results != $NULL)
18 + #set ($showLastModified = "$!xcontext.macro.params.showLastModified")
19 + #set ($showLastModified = $showLastModified.equalsIgnoreCase("true"))
20 + #set ($showPageLabels = "$!xcontext.macro.params.showPageLabels")
21 + #set ($showPageLabels = $showPageLabels.equalsIgnoreCase("true"))
22 + #set ($showCreator = "$!xcontext.macro.params.showCreator")
23 + #set ($showCreator = $showCreator.equalsIgnoreCase("true"))
24 + #set ($showAnyMetadata = $showLastModified || $showPageLabels || $showCreator)
25 + #set ($details = $services.confluence.details.getDetails("$!xcontext.macro.params.id", "$!xcontext.macro.params.headings", $results, "$!xcontext.macro.params.sortBy", "$!xcontext.macro.params.reverseSort" == "true"))
26 + #if ($details.size() < 2)
27 + $services.localization.render('rendering.macro.detailssummary.noresults')
28 + #else
29 + #foreach ($row in $details)
30 + #if ($foreach.first)
31 + |=$title##
32 + #foreach ($cell in $row)
33 + |=$cell##
34 + #end##
35 + #if ($showLastModified)|=$services.localization.render('rendering.macro.detailssummary.lastModified')#end##
36 + #if ($showCreator)|=$services.localization.render('rendering.macro.detailssummary.creator')#end##
37 + #if ($showPageLabels)|=$services.localization.render('rendering.macro.detailssummary.tags')#end##
38 +
39 + #else
40 + #if ($showAnyMetadata)
41 + #set ($d = $xwiki.getDocument($row.get(0)))
42 + #end##
43 + #foreach ($cell in $row)
44 + | ((( #if ($foreach.first)[[$cell]]#{else}$cell#end ))) ##
45 + #end##
46 + #if ($showLastModified)|$xwiki.formatDate($d.getDate())#end##
47 + #if ($showCreator)|#if ($d.getCreator() == "XWiki.superadmin")superadmin#else[[$d.getCreator()]]#end#end##
48 + #if ($showPageLabels)|#showTags($d)#end##
49 +
50 + #end
51 + #end
52 +
53 + #end
54 + #end
55 +#end
56 +{{/velocity}}
57 +
58 +{{velocity}}
59 +## We need to check if there is a valid license because the macro is registered even if the user doesn't have view right
60 +## on the macro definition page. See XWIKI-14828: Rendering macros defined in wiki pages are available to users that
61 +## don't have view right on those pages.
62 +#if ($services.promacrolicensing.hasLicensureForEntity($xcontext.macro.doc.documentReference))
63 + #executeMacro
64 +#else
65 + {{missingLicenseMessage extensionName="proMacros.extension.name"/}}
66 +#end
67 +{{/velocity}}
68 +
Macro content availability
... ... @@ -1,0 +1,1 @@
1 +No content
Macro description
... ... @@ -1,0 +1,1 @@
1 +Confluence bridge for the Details Summary (Page Properties Report) macro to display properties attached to a page using the Details macro.
Macro id
... ... @@ -1,0 +1,1 @@
1 +confluence_detailssummary
Macro name
... ... @@ -1,0 +1,1 @@
1 +Confluence bridge for Details Summary
Supports inline mode
... ... @@ -1,0 +1,1 @@
1 +No
Macro visibility
... ... @@ -1,0 +1,1 @@
1 +Current Wiki
XWiki.WikiMacroParameterClass[0]
Parameter description
... ... @@ -1,0 +1,1 @@
1 +The group of properties to show. If empty, will show page properties without identifiers.
Parameter mandatory
... ... @@ -1,0 +1,1 @@
1 +No
Parameter name
... ... @@ -1,0 +1,1 @@
1 +id
XWiki.WikiMacroParameterClass[1]
Parameter description
... ... @@ -1,0 +1,1 @@
1 +Which column of the page properties to show. By default, all columns are shown. Columns with comma in their names require being quoted.
Parameter mandatory
... ... @@ -1,0 +1,1 @@
1 +No
Parameter name
... ... @@ -1,0 +1,1 @@
1 +headings
XWiki.WikiMacroParameterClass[2]
Parameter description
... ... @@ -1,0 +1,1 @@
1 +A query written in the Confluence Query Language (CQL) syntax defining the list of documents to show.
Parameter mandatory
... ... @@ -1,0 +1,1 @@
1 +No
Parameter name
... ... @@ -1,0 +1,1 @@
1 +cql
XWiki.WikiMacroParameterClass[3]
Parameter description
... ... @@ -1,0 +1,1 @@
1 +A list of tags to use, separated by a comma or a space. This value is ignored if the cql parameter is set. Note: this parameter doesn't exist in Confluence, it's an XWiki addition.
Parameter name
... ... @@ -1,0 +1,1 @@
1 +labels
XWiki.WikiMacroParameterClass[4]
Parameter description
... ... @@ -1,0 +1,1 @@
1 +A custom title for the document name column
Parameter name
... ... @@ -1,0 +1,1 @@
1 +firstcolumn
XWiki.WikiMacroParameterClass[5]
Parameter description
... ... @@ -1,0 +1,1 @@
1 +Show the last modified time of the page
Parameter name
... ... @@ -1,0 +1,1 @@
1 +showLastModified
Parameter type
... ... @@ -1,0 +1,1 @@
1 +java.lang.Boolean
XWiki.WikiMacroParameterClass[6]
Parameter description
... ... @@ -1,0 +1,1 @@
1 +Show the tags of listed documents
Parameter name
... ... @@ -1,0 +1,1 @@
1 +showPageLabels
Parameter type
... ... @@ -1,0 +1,1 @@
1 +java.lang.Boolean
XWiki.WikiMacroParameterClass[7]
Parameter description
... ... @@ -1,0 +1,1 @@
1 +Show the initial author of the listed documents
Parameter name
... ... @@ -1,0 +1,1 @@
1 +showCreator
Parameter type
... ... @@ -1,0 +1,1 @@
1 +java.lang.Boolean
XWiki.WikiMacroParameterClass[8]
Parameter default value
... ... @@ -1,0 +1,1 @@
1 +OR
Parameter description
... ... @@ -1,0 +1,1 @@
1 +Whether all the tags should match (AND), or any (OR). This value is ignored if the cql parameter is set. Note: this parameter doesn't exist in Confluence, it's an XWiki addition.
Parameter mandatory
... ... @@ -1,0 +1,1 @@
1 +No
Parameter name
... ... @@ -1,0 +1,1 @@
1 +operator
XWiki.WikiMacroParameterClass[9]
Parameter description
... ... @@ -1,0 +1,1 @@
1 +Maximum number of results. Note: this parameter doesn't exist in Confluence, it's an XWiki addition.
Parameter mandatory
... ... @@ -1,0 +1,1 @@
1 +No
Parameter name
... ... @@ -1,0 +1,1 @@
1 +max
Parameter type
... ... @@ -1,0 +1,1 @@
1 +java.lang.Integer
XWiki.WikiMacroParameterClass[10]
Parameter description
... ... @@ -1,0 +1,1 @@
1 +What to sort on. The only supported values are "modified", "creation" and "title" for now. Ignored if an order by clause is present in the cql parameter. Note: this parameter doesn't exist in Confluence, it's an XWiki addition.
Parameter mandatory
... ... @@ -1,0 +1,1 @@
1 +No
Parameter name
... ... @@ -1,0 +1,1 @@
1 +sort
XWiki.WikiMacroParameterClass[11]
Parameter default value
... ... @@ -1,0 +1,1 @@
1 +false
Parameter description
... ... @@ -1,0 +1,1 @@
1 +Whether to reverse the sort. Note: this parameter doesn't exist in Confluence, it's an XWiki addition.
Parameter mandatory
... ... @@ -1,0 +1,1 @@
1 +No
Parameter name
... ... @@ -1,0 +1,1 @@
1 +reverse
Parameter type
... ... @@ -1,0 +1,1 @@
1 +java.lang.Boolean