This page is a snippet

For full information, see:

Snippet

 

Macro name: contributors

Macro body: None.

Parameter name

Required

Default

Parameter description and accepted values

limit

 No

(None)

Limits the number of contributors displayed in the list.

spaces

 No

Current space

Specifies the space key of the Confluence space to search. Space keys are case sensitive.

Special values:

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

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

If no page and labels are specified, all pages from the specified set of spaces are included.

reverse

No

false

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

scope
 No

The specified page only

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

Available values:

  • children – only the child pages of the specified page.
  • descendants – all descendants of the specified page.

labels

 No

(None)

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

showPages No

false

If the value is true, the macro will display a list of the pages used to generate the list of contributors.

noneFoundMessage No

"No contributors found for:" (and a summary of selected parameter values)

Any message given here will override the default message that is displayed when no contributors are found.

showCount

 No

false

Determines whether the macro will show the number of times each person made a contribution.

contentType
 No

Both pages and blog posts

Restricts the content type that the macro will use when generating the list of contributors.

Available values:

  • pages – pages

  • blogposts – blog posts.

include
No

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.

mode
 No
inline

Determines how the list of contributors is formatted:

  • inline — a comma-separated list
  • list — a bullet list.
showAnonymous
 No
false

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

order
No
count

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

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

The current page

Specifies the page to use when generating the list of contributors. If page and spaces are left blank, the current page is assumed.

showLastTime
No
false

Determines whether to show the last time each person made a contribution.

publishDate
No

(None)e

Specifies the publication date for a blog post. The date format required is: YYYY/MM/DD.
  • No labels

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