Documentation for Confluence 5.7.
Documentation for Confluence Cloud and earlier versions of Confluence is available too.

Skip to end of metadata
Go to start of metadata

The Contributors macro displays a list of Confluence users who have made a contribution of some type to a page. It can also be used to list watchers of the page.

The scope of this macro can be extended to include the immediate children or descendants of the specified page. The list of contributors can be based on people who have:

  • authored or edited the page(s)
  • contributed comments or added labels to the page(s), or
  • are simply watching the page(s).

Screenshot: Example list of Contributors

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

Using the Contributors Macro

To add the Contributors macro to a page:

  1. In the Confluence editor, choose Insert > Other Macros
  2. 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 Using Autocomplete.

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

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.

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

Macro body: None.

Storage format example

This example specifies a content type of blog posts:

Wikimarkup example

This example specifies a content type of blog posts:

This example specifies a content type of pages:

  • No labels

6 Comments

  1. GuL

    Hello,

    we are trying to list all blogpost-watchers within our space, but have the following problem:

    Our code is

    ...but we get the message "No contributors found for: watches on selected page(s)"

    The same if we change to _contentType=pages_.
    The only way we get results is to drop the parameter contentType.

    Any help is highly appreciated
    GuL

  2. Hi!

    I'd like to find a feature/plugin/extension that lists the viewers users of a given page.

    I've look at this page , but didn't find any.

    Does anybody know how to deploy this into Confluence?

    Thank you!

    1. You may want to check out our viewtracker plugin for tracking page views per user: https://plugins.atlassian.com/plugin/details/28637

      It's free & open source

  3. Anonymous

    Hi,

     

    I'm trying to view who is watching a page in another space using this macro. I type the page in the page input box and the page pops up in drop down menu, I click it, and the box shows the spacekey:pagename. but none of the watchers show up. Is this a bug or is this macro. I notice that if you add the spacekey in the space input box and then erase the "spacekey" that is auto inserted by clicking a page in the drop down menu it works...

     

    Thanks,

    Andrew

  4. Anonymous

    Is there any way to limit/filter the date on this macro?  I just want to see contributions for the last six months or so - not going back to the beginning of time. (smile)

  5. Is there any way to add the avatars of the contributors automatically?