• Documentation
Products
Documentation
Resources
Atlassian Support
/
Confluence
/
Resources
/
Extend the functionality of Confluence Cloud
/
Use macros to show Confluence content on pages
Cloud

Insert the contributors macro

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

To add the contributors macro:

  1. When editing, select from the toolbar

  2. Find the macro by name and select it

  3. Configure it as needed

You can also type / on the page to bring up the same list you'd see by selecting from the toolbar. Continue typing the name of the macro to filter the list.

To edit the contributors macro:

  1. Select the macro placeholder.

  2. Select the Edit icon to open the configuration panel.

  3. Configure the parameters. Your changes are saved as you go.

  4. Resume editing the page, and the panel closes.

You can also select the centered , medium-width , and full-width icons to adjust the width of some macros. Select the trashcan iconto remove the macro.

Parameters

Parameters are options that you can set to control what and how content from the macro appears on the page. 

If the parameter name used in Confluence Cloud storage format is different than the label used when inserting macros using the browser or the slash command, 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.

 

 

Still need help?

The Atlassian Community is here for you.
Ask the Community
CommunityQuestions, discussions, and articles