Confluence Docs 3.0 : Contributors Macro This page last changed on Jun 09, 2009 by ggaskell. 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) Screenshot: Example list of Contributors In this example, the Display Format/`mode` parameter has been set to `list`. For more information about this macro's parameters, refer to the Parameters section below. On this page: Usage with the Macro Browser Usage with the Wiki Markup Editor Parameters ## Usage with the Macro Browser To insert the contributors macro into a page using the Macro Browser, Open your desired Confluence page, then click the 'Edit' button. The 'Edit Page' mode opens. Next, click the Macro Browser icon on the editor toolbar. The Macro Browser will open in the middle of the screen. In the Macro Browser, type the name of your desired macro into the search box at the top right of the window. Macros with a matching name will appear in the centre pane. Click on the desired macro to see its options screen. Here, you can set the macro parameters then click 'insert' to put the macro into the page. Once you've found the contributors macro, click 'insert' to add it to your page. ## Usage with the Wiki Markup Editor
    {contributors:include=TYPE}
Where TYPE refers to the type of contribution made to the current page (and optionally its descendants), or watches of these pages. ## Parameters Parameters are settings for Confluence macros that allow the user to control their content or presentation. The table below lists relevant parameters for this macro. Parameter names are displayed differently in the macro browser interface and in wiki markup. Below, parameter names used in the macro browser are indicated in Bold text, while their equivalents in wiki markup are indicated in (`bracketed`) text. If the latter is not shown, then in wiki markup, the parameter's name should be omitted and only its value should be added immediately after the colon symbol (`:`).
Parameter | Required in Wiki Markup? | Default | Description
--- | --- | --- | ---
Contribution Type (`include`) | no | authors | The type of contribution made to a page (and optionally its descendant pages), or watches of these pages. This parameter defines which people appear in the contributors list and the statistics used to order them in the list. The allowable contribution types include: `authors` - people who authored or have edited the page(s) `comments` - people who have added comments to the page(s) `labels` - people who have added labels to the page(s) `watches` - people who are watching the page(s). One or more contribution types can be used.
Sort By (`order`) | no | count | The criteria used to sort the contributors in the list, based on the chosen Contribution Type. The allowable sort criteria include: `count` - sorts people based on the total number of edits, or comments or labels added to the page(s) `name` - sorts people in alphabetical order `update` - sorts people based on when they last edited, or added a comment or label to the page(s).
Reverse Sort (`reverse`) | no | false | Reverses the order of contributors in the list, sorted by the chosen Sort By criterion. Used only in conjunction with the Sort By parameter.
Maximum Number of Contributors (`limit`) | no | no limit | Restricts the number of contributors in the list to the value specified. If no number is specified, no restriction is applied.
Display Format (`mode`) | no | inline | Displays the contributors as a comma-separated line of names (inline) or as a bullet-point list (list).
Show Anonymous Contributions? (`showAnonymous`) | no | false | Includes people who have made anonymous contributions to a page, in the list of contributors.
Show Count? (`showCount`) | no | false | Indicate the number of times each person in the list made a contribution, based on the chosen Contribution Type.
Show Last Contribution Time? (`showLastTime`) | no | false | Indicates the last time each person in the list made a contribution, based on the chosen Contribution Type.
Page Name (`page`) | no | current | The page from which to base the contributors list and its statistics. If no Page Name and Space(s) are specified, the current page is assumed.
Label(s) (`labels`) | no | none | Restricts list of contributors to those who created these labels from the specified page(s). Separate each label with a comma.
Space(s) (`spaces`) | no | current | Specify the space key of the Confluence space which contains the specified Page Name or alternatively, specify a scope of 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 (`contentType`) | no | both pages and blog posts | Used to restrict page types to either pages (pages) or blog posts (blogposts). If no value is specified in the Macro Browser, both pages and blog posts are included.
Blog Post Date (`publishDate`) | no | none | Specify the publish date for a blog post. The date format required is: YYYY/MM/DD.
Include Page Hierarchy (`scope`) | no | specified page only | Includes either the immediate children or all descendants of the specified page. If no value is indicated in the Macro Browser, only the specified page is included.
Show Selected Pages (`showPages`) | no | false | Shows a list of pages returned immediately above the list of contributors.
Custom "None Found" Message (`noneFoundMessage`) | no | default "none found" message | When no contributors are found, override the default message displayed by the macro, with this one.
##### RELATED TOPICS Contributors Summary Macro Working with Macros Take me back to the Confluence User Guide. Attachments: contributors-list.png (image/png)

Document generated by Confluence on Nov 05, 2009 23:35