This page is a snippet

For full information, see:

Snippet

 

Macro name: contributors-summary

Macro body: None.

Parameter name

Required

Default

Parameter description and accepted values

limit

 No

(None)

Limits the number of contributors or pages displayed in the table.

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 items in the table. Must be used in conjunction with the order parameter.

showAnonymous
 No
false

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

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.
order
No
edits

Sets the criterion used for sorting items in the table.

Available values:

  • edits sorts items in the table based on the total number of edits made, either by a contributor or to a page.
  • name sorts items in the table in alphabetical order, either by contributor or page name.
  • editTime sorts items in the table based on when the contributor last edited a page (or a specified set of pages) or when the page was lasted edited.
  • update sorts items in the table based on when the contributor last made any contribution to a page (or a specified set of pages) or when the page last had any contribution made to it.
page
No

The current page

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

labels

 No

(None)

Limits contribution-based statistics to the specified labels only. You can specify one or more labels, separated by commas.

columns
No

edits,comments,labels

Determines the columns that should appear in the table. The statistics or type of information presented depends on the groupby parameter.

Available values:

  • edits – the number of times each contributor has edited the page(s) or the number of edits made to each page.
  • edited – a list of the pages edited by each contributor or a list of contributors who have edited each page.
  • comments – the number of times each contributor has added comments to the page(s) or the number of comments on each page.
  • commented – a list of pages to which each contributor has added comments or a list of contributors who have commented on each page.
  • labels – the number of times each contributor has added labels to the page(s) or the number of labels on each page.
  • labeled – a list of pages to which each contributor has added labels or a list of contributors who have added a label to each page.
  • labellist – a list of labels either added by each contributor or on each page.
  • watches – the number of pages being watched by each contributor/person or the number of contributors/people watching each page.
  • watching – a list of pages being watched by each contributor/person or a list of contributors/people watching each page.
  • lastupdate – the last time each contributor made an update or when each page was last updated. Valid updates can include edits, comments or label modifications to a page.

You can specify one or more columns, separated by commas.

groupby
Nocontributors

Specifies the basis for grouping contribution-based statistics:

  • contributors – group by the people who have contributed.
  • pages – group by the pages used to find the contributors.
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.

showZeroCountsNofalseDetermines whether contributors or pages are included for which the calculated statistic is zero.
publishDate
No

(None)

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

  • No labels