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

On this page:

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.

Parameters

When editing, you can click on the macro placeholder and choose Edit to display the parameters for this macro in the Macro Browser.

Parameters are options that you can set for Confluence macros to control the content or format of the macro output. The table below lists parameters for this macro that can be set in the Macro Browser.

Parameter

Default

Description

Contribution Type

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, each of which must be separated by a comma.

Sort By

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

false

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

Maximum Number of Contributors

no limit

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

Display Format

inline

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

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

Show Anonymous Contributions?

false

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

Show Count?

false

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

Show Last Contribution Time?

false

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

Page Name

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)

none

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

Space(s)

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 global spaces.
  • @personal — All personal spaces.
  • @all — All spaces in your Confluence site.

    You can specify one or more space keys or special values, each of which must be separated by a comma.

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

Content Type

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

none

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

Include Page Hierarchy

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

false

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

Custom "None Found" Message

default message

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

Related Topics

Contributors Summary Macro
Working with Macros

Take me back to the Confluence User's Guide.

  • No labels

Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 2.5 Australia License.