Contributors Summary Macro
The Contributors Summary macro displays a table of contribution-based statistics for a set of pages. These statistics can be grouped according to individual pages or individual contributors.
The default scope for this macro is an individual page, but this can be extended to include the immediate children or descendants of a specified page. The statistics cover the following types of contributions:
- edits to the page(s)
- comments added to the page(s)
- labels added to the page(s)
- people watching the page(s)
A simple example of the Contributors Summary macro is shown in the screenshot below. It lists statistics for the number of times each contributor has edited, added comments and added labels to this page.
Screenshot: Example Contributors Summary table of statistics
In this example, all default parameter settings are used. For more information about this macro's parameters, refer to the Parameters section below.
Using the Contributors Summary Macro
To add the Contributors Summary macro to a page:
- In the Confluence editor, choose Insert > Other Macros
- Find and select the required macro
Speeding up macro entry with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Autocomplete for links, files, macros and mentions.
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.
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 |
|---|---|---|
Group By | contributors | Specifies the basis for grouping contribution-based statistics:
|
Columns to Display | edits,comments,labels | Sets the columns that should appear in the table. The statistics or type of information presented depends on the basis for grouping set with the Group By parameter. Statistics may be calculated for:
|
Sort By | edits | Sets the criterion used for sorting items in the table. The items sorted depend on the basis for grouping set with the Group By parameter. Sort criteria are:
|
Reverse Sort | false | Reverses the sort order of items in the table, as specified using the Sort By parameter. (Used only in conjunction with the Sort By parameter.) |
Maximum Number of Items | no limit | Limits the number of contributors or pages in the table to the value specified. If no number is specified, all items are included. |
Show Anonymous Contributions? | false | Includes individuals who have made anonymous contributions to a page. |
Show Zero Counts? | false | Sets whether contributors or pages are included for which a calculated statistic is zero. |
Page Name | current | Sets the page for which to calculate the contribution-based statistics. If no values for Page Name and Space(s) are specified, the current page is assumed. |
Label(s) | none | Restricts the contribution-based statistics to the specified labels only. You can specify one or more labels, separated by commas. |
Space(s) | current | Specifies the space key of the Confluence space which contains the specified page name or alternatively, specifies a scope of spaces to search. Space keys are case-sensitive.
You can specify one or more space keys or special values, separated by commas. |
Content Type | both pages and blog posts | Restricts page types to either pages (pages) or blog posts (blogposts). If no value is specified in the Macro Browser, both pages and blog posts are included. Available values |
Blog Post Date | none | Specifies the publish date for a blog post. The date format required is: YYYY/MM/DD. |
Include Page Hierarchy | specified page only | Includes either the immediate children or all descendants of the specified page. If no value is indicated in the Macro Browser, only the specified page is included. |
Code examples
The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page.
Macro name: contributors-summary
Macro body: None.
Storage format example
This example specifies a content type of blog posts:
<ac:structured-macro ac:name="contributors-summary">
<ac:parameter ac:name="limit">10</ac:parameter>
<ac:parameter ac:name="spaces">
<ri:space ri:space-key="ds"/>
<ri:space ri:space-key="@personal"/>
</ac:parameter>
<ac:parameter ac:name="reverse">true</ac:parameter>
<ac:parameter ac:name="showAnonymous">true</ac:parameter>
<ac:parameter ac:name="order">update</ac:parameter>
<ac:parameter ac:name="labels">chocolate,cake</ac:parameter>
<ac:parameter ac:name="columns">edits,comments,labels,lastupdate</ac:parameter>
<ac:parameter ac:name="groupby">pages</ac:parameter>
<ac:parameter ac:name="contentType">blogposts</ac:parameter>
<ac:parameter ac:name="showZeroCounts">true</ac:parameter>
<ac:parameter ac:name="publishDate">2012/06/07</ac:parameter>
</ac:structured-macro>This example specifies a content type of pages:
<ac:structured-macro ac:name="contributors-summary">
<ac:parameter ac:name="limit">10</ac:parameter>
<ac:parameter ac:name="spaces">
<ri:space ri:space-key="ds"/>
<ri:space ri:space-key="@personal"/>
</ac:parameter>
<ac:parameter ac:name="reverse">true</ac:parameter>
<ac:parameter ac:name="showAnonymous">true</ac:parameter>
<ac:parameter ac:name="scope">descendants</ac:parameter>
<ac:parameter ac:name="order">update</ac:parameter>
<ac:parameter ac:name="page">
<ac:link>
<ri:page ri:content-title="Advanced Topics" ri:space-key="ds"/>
</ac:link>
</ac:parameter>
<ac:parameter ac:name="labels">chocolate,cake</ac:parameter>
<ac:parameter ac:name="columns">edits,comments,labels,lastupdate</ac:parameter>
<ac:parameter ac:name="groupby">pages</ac:parameter>
<ac:parameter ac:name="contentType">pages</ac:parameter>
<ac:parameter ac:name="showZeroCounts">true</ac:parameter>
</ac:structured-macro>Wiki markup example
This example specifies a content type of blog posts:
{contributors-summary:limit=10|spaces=ds,@personal|reverse=true|showAnonymous=true|order=update|labels=chocolate,cake|columns=edits,comments,labels,lastupdate|groupby=pages|contentType=blogposts|showZeroCounts=true|publishDate=2012/06/07}This example specifies a content type of pages:
{contributors-summary:limit=10|spaces=ds,@personal|reverse=true|showAnonymous=true|scope=descendants|order=update|page=ds:Advanced Topics|labels=chocolate,cake|columns=edits,comments,labels,lastupdate|groupby=pages|contentType=pages|showZeroCounts=true}