Confluence Contributors Plugin

Added by Shannon Krebs - Adaptavist, last edited by Philip Cher on Nov 30, 2008  (view change)
Name Contributors Plugin
Vendor Brock Janiczak, Shannon Krebs
Authors Shannon Krebs
Homepage http://confluence.atlassian.com/display/CONFEXT/Confluence+Contributors+Plugin
Issue Management http://developer.atlassian.com/jira/browse/CONTRB
Continuous Integration n/a
Categories Content Macros
Most Recent Version 1.2.1
Availability Confluence v2.9 to v2.10
State Stable
Support Atlassian Supported Plugins
License Freeware / Open Source (BSD)
Price Free
Release Docs http://confluence.atlassian.com/display/CONFEXT/Confluence+Contributors+Plugin
Java API Docs n/a
Download Source http://svn.atlassian.com/svn/public/contrib/confluence/contributors-plugin/tags/contributors-1.2.1/
Download JAR contributors-1.2.1.jar

Compatibility With Confluence

Plugin Versions 2.4 2.5 2.6 2.7 2.8 2.9 2.10
1.2.1          
1.2      
1.1.3      
1.1.2      
1.1.1-dr1            
1.1      

Screenshots
example of contributors macro with inline mode
example of contributors-summary macro
example of contributors macro with list mode
example of combining the contributors-summary macro with the chart macro. (You will need atleast the 1.6 version of the chart plugin to get this to work correctly.)
This plugin has known performance problems in large installations. See CONTRB-40.

Description/Features

The Contributors Plugin contains macros to display contributors and statistics from a page or a set of pages. There are currently two macros in this plugin

The {contributors} macro displays a simple list of contributors within a page while the {contributors-summary} macro displays a table grouped by contributors or page names.

Usage

Contributors Macro

Displays a list of contributors for a list of pages (and possibly it's children/decendants). A page can be specified by its name and/or some labels. The list of contributors can be restricted to only page editors, commenters, labelers or any combination of those.

Display Parameters
  • include (optional) What type of content from the pages to base the contributor list (and the counts) on. Multiple values can be specified with a comma separated list.
    • authors Include page authors (default)
    • comments Include page comments
    • labels Include page labels
    • watches Include page watches
  • order (optional) The order the contributors will appear in.
    • count Order by the total count (default)
    • name Order by the names of the contributors
    • update Order by the last update time
      Both the count and update orderings will use values from only the content specified with the include parameter.
  • reverse (optional) If true the sort order will be reversed.
  • limit (optional) Limit the number of contributors initially displayed to this amount
  • mode (optional) Sets the display mode of the macro
    • inline The contributors will be displayed across the screen (default)
    • list The contributors will be displayed in a list down the screen
  • showAnonymous optional Show edits by anonymous users. Default is false.
  • showCount (optional) Show the count for each user. Default is false.
  • showLastTime (optional) Show the last time a contribution was made by each user for any content specified by the include parameter. Default is false.
Advanced Options
  • showPages show a list of pages returned above the list. Useful for debugging.
  • noneFoundMessage override the default message that is displayed when no contributors are found.

Examples

{contributors}
Displays the default contributor list with editors from the current page

Contributors Summary Macro

Displays the contributors of a page (or list of pages) in a table. Pages can be selected by their name and/or labels. There are two ways to display the data in this table; grouped by contributors or grouped by pages. The columns that are actualy displayed is configurable, selecting the count columns allows this macro to be used as input to the chart macro.

Display Parameters
  • groupby - (optional) Specify if the table should be grouped by contributors or pages. Default value is contributors
  • columns - (optional) Specify the columns that should appear in the table as a comma separated list. Default value is edits,comments,labels. Valid values:
    • edits Edit Count Column
    • edited List of pages or contributors
    • comments Comment Count Column
    • commented List of pages or contributors
    • labels Label Count Column
    • labeled List of pages or contributors
    • labellist List of labels
    • watches Watches Count Column
    • watching List of pages or contributors
    • lastupdate Last time a page was updated or a contributor changed some content.
  • order - (optional) The order the contributors will appear in. By default contributors are ordered by the number of edits.
    • edits Orders the contributors with the highest number of edits first in the list
    • name Orders the contributors by name alphabetically
    • editTime Orders the contributors by the time they last edited the page
    • update Order by the last update time of any content
  • reverse - (optional) If true the sort order will be reversed.
  • limit - (optional) Limit the number of contributors displayed to this amount
  • showAnonymous - (optional) Show edits by anonymous users. Default is false.

Examples
{contributors-summary}

Page Searching Parameters

Both macros take the same parameters to build up a list of pages

The macros in this plugin can take a while to render when a large list of pages is selected as there is currently no caching. If you want to view a large list of pages it is probably a good idea to put the macros on a page that doesn't see a lot of traffic, i.e. not a space home page.
* page The page to count statistics from. If no spaces or labels are specified this will default to the current page.

  • label The label to use to search for pages. Multiple labels can be specified in a comma separated list. (A page will match if it has any of the labels.)
  • spaces Specifiy the space for the page or labels parameter. Multiple spaces can be specified in a comma separated list. If no pages or labels are specified all pages from the space will be included. The following shortcut space names can also be used:
    • @all All Spaces
    • @global All Global Spaces
    • @personal All Personal Spaces
  • contentType Valid options are:
    • pages
    • blogposts
      If not specified both blog posts and pages are included.
  • publishDate specify the publish date for a blog post. The date format expected is: YYYY/mm/dd
  • scope For each of the pages found this parameter lets you include the children or decendants. (Each page will only be counted once if it is already in the list.)
    • children include statistics from the immediate children of the page
    • descendants include statistics from all descendants of the page

Future Plans

If you find a bug, or have and feature suggestions please create an issue in the jira project for this plugin.

The page/label searching isn't perfect at the moment. There is currently some discussion going on about common page searching parameters and utility library at Unified Page Searching Tags. If a common library is developed out of this it could in theory be used to enhance the macros in this plugin.

Open Issues

Plugin Versions

Version Date State License Price
Show description 1.2.1 (#1201) 23 Oct 2008 Stable Freeware / Open Source (BSD) Free

Release Notes