Contributors Macro

Add the Contributors macro to a page to display a list of Confluence users who have contributed to this page, another page, or set of pages. Contributors includes people who:

  • created or edited the pages
  • commented on the pages
  • added labels to the pages, or
  • are simply watching the pages.

This macro is great for:

  • document control and compliance
  • providing a list of people to contact about a page.

On this page:

Screenshot: Page showing contributors to the printer how-to pages. 

In this example, the Display Format parameter has been set to list.

Add this macro to your page

To add the Contributors macro to a page:

  1. From the editor toolbar, choose Insert > Other Macros.
  2. Choose Contributors from the Confluence content category.
  3. Enter the type of contributor you want to display, and set any parameters.
  4. Choose Insert

You can then publish your page to see the macro in action. 

Screenshot: Setting parameters in the Contributors macro

Change the macro parameters

Macro parameters are used to change the behaviour of a macro.

To change the macro parameters:

  1. In the editor, click the macro placeholder and choose Edit.
  2. Update the parameters as required then choose Insert.

Here's a list of the parameters available in this macro. 

Parameter

Default

Description

Contribution Type
(include

authors

Filters by either the type of contribution made to a page (and optionally its descendant pages), or the watches on the page. Contribution types are:

  • authors - includes people who created or have edited the page(s)
  • comments - includes people who have added comments to the page(s)
  • labels - includes people who have added labels to the page(s)
  • watches - includes people who are watching the page(s).

    You can specify one or more contribution types, separated by commas.

Sort By
(order

count

Specifies the criteria used to sort contributors. Sort criteria are:

  • count - sorts people based on the total number of contributions to the page(s)
  • name - sorts people into alphabetical order
  • update - sorts people based on the date of their last contribution to the page(s).

Reverse Sort
(reverse

false

Reverses the sort order of contributors in the list. Must be used in conjunction with the Sort By parameter.

Maximum Number of Contributors

(limit)

no limit

Limits the number of contributors in the list. If a number is not specified, all contributors are included.

Display Format
(mode

inline

Sets how the list of contributor's names is formatted:

  • inline — a comma-separated list
  • list — a bullet list.

Show Anonymous Contributions?
(showAnonymous

false

Sets whether to include those who contributed anonymously to a page.

Show Count?
(showCount

false

Sets whether to show the number of times each person made a contribution of the specified Contribution Type.

Show Last Contribution Time?
(showLastTime

false

Sets whether to show the last time each person made a contribution of the specified Contribution Type.

Page Name
(page

current

Specifies the page to use when generating the list of contributors. If Page Name and Space(s) are left blank, the current page is assumed.

Label(s)
(labels

none

Filters the list of contributors to those who created the specified labels from a page. You can specify one or more labels, separated by commas.

Space(s)
(spaces

current

Specifies the space key of the Confluence space that contains the page set in Page Name or alternatively, specifies the spaces to search. Space keys are case-sensitive.

This parameter also takes special values, including:

  • @global — All site spaces.
  • @personal — All personal spaces.
  • @all — All spaces in your Confluence site.

    You can specify one or more space keys or special values, separated by commas.

    If no Page Name and Label(s) are specified, all pages from the specified set of spaces are included.

Content Type
(contentType

both pages and blog posts

Restricts the content type to use when generating the list of contributors:

  • pages — pages
  • blogposts — blog posts.

Blog Post Date
(publishDate

none

Specifies the publish date for a blog post. The date format required is: YYYY/MM/DD.

Include Page Hierarchy
(scope

specified page only

Specifies additional pages to include when generating the list of contributors:

  • children — just the child pages of the specified page
  • descendants — all descendants of the specified page.

Show Selected Pages
(showPages

false

Sets whether to show a list of the pages used to generate the list of contributors.

Custom "None Found" Message
(noneFoundMessage

default message

Specifies the message to be used to override the default message that is displayed when no contributors are found.

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).

Other ways to add this macro

Add this macro as you type

Type followed by the start of the macro name, to see a list of macros. 

Add this macro using wiki markup

This is useful when you want to add a macro outside the editor, for example as custom content in the sidebar, header or footer of a space.

Macro name: contributors

Macro body: None.

This example specifies a content type of blog posts:

{contributors:limit=10|spaces=ds,@personal|reverse=true|labels=chocolate,cake|showPages=true|noneFoundMessage=Oh dear, no contributors found|showCount=true|contentType=blogposts|include=authors,comments,labels,watches|mode=list|showAnonymous=true|order=update|showLastTime=true|publishDate=2012/06/30}

This example specifies a content type of pages:

{contributors:limit=10|spaces=ds,@personal|reverse=true|scope=descendants|labels=chocolate,cake|showPages=true|noneFoundMessage=Oh dear, no contributors found|showCount=true|contentType=pages|include=authors,comments,labels,watches|mode=list|showAnonymous=true|order=update|page=ds:Advanced Topics|showLastTime=true}
Last modified on Jul 30, 2024

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.