Confluence Docs 3.0 : Contributors Summary Macro This page last changed on Jun 08, 2009 by ggaskell. The Contributors Summary macro displays a table of contribution-based statistics for a set of pages. These statistics can be grouped according to individual pages or individual contributors. The default scope of this macro covers an individual page, but this can be extended to include the immediate children or descendants of a specified page. The statistics cover the following types of contributions: edits to the page(s) comments added to the page(s) labels added to the page(s) people watching the page(s) A simple example of the Contributors macro is shown in the block below, which lists statistics on the number of times each contributor has edited, added comments and added labels to this page. Screenshot: Example Contributors Summary table of statistics In this example, all default parameter settings are used. 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 summary 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 summary macro, click 'insert' to add it to your page. ## Usage with the Wiki Markup Editor
    {contributors-summary:groupby=TYPE}
Where TYPE refers to the criterion used for grouping statistics associated with the current page (and optionally its descendants). This criteria can be either contributor- or page-based. ## 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
--- | --- | --- | ---
Group By (`groupby`) | no | contributors | Specify if the table should group contribution-based statistics by contributor or page.
Columns to Display (`columns`) | no | edits, comments and labels | The columns that should appear in the table. The statistics or type of information presented is based on the Group By parameter (above). The allowable types of contributions include: `edits` — number of times the contributor has edited the page(s) or number of edits made to the page. `edited` — list of pages edited by the contributor or list of contributors who have edited the page. `comments` — number of times the contributor has added comments to the page(s) or number of comments on the page. `commented` — list of pages to which the contributor has added comments or list of contributors who have commented on the page. `labels` — number of times the contributor has added labels to the page(s) or number of labels on the page. `labeled` — list of pages to which the contributor has added labels or list of contributors who have added a label to the page. `labellist` — list of labels either added by the contributor or on the page. `watches` — number of pages being watched by the contributor/person or number of contributors/people watching the page. `watching` — list of pages being watched by the contributor/person or list of contributors/people watching the page. `lastupdate` — the last time a contributor made an update or the page was last updated. Valid updates can include edit, comment or label modifications to a page. One or more columns can be used.
Sort By (`order`) | no | count | The criteria used for sorting items in the table. The items sorted are based on the Group By parameter (above). The allowable sort criteria include: `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 a contribution made to it.
Reverse Sort (`reverse`) | no | false | Reverses the order of items in the table, 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 items in the table to the value specified. If no number is specified, no restriction is applied.
Show Anonymous Contributions? (`showAnonymous`) | no | false | Includes individuals who have made anonymous contributions to a page, in the tabulated statistics.
Page Name (`page`) | no | current | The page from which to calculate the contribution-based statistics. If no Page Name and Space(s) are specified, the current page is assumed.
Label(s) (`labels`) | no | none | Restrict the contribution-based statistics to these labels only. 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.
##### RELATED TOPICS Contributors Macro Working with Macros Take me back to the Confluence User Guide. Attachments: contributors-summary.png (image/png)

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