Contributors Plugin

Added by Shannon Krebs, last edited by David Chui on Apr 14, 2008  (view change) show comment
Name Contributors Plugin
Vendor Brock Janiczak, Shannon Krebs
Authors Shannon Krebs
Homepage http://confluence.atlassian.com/display/CONFEXT/Contributors+Plugin
Issue Management http://developer.atlassian.com/jira/browse/CONTRB
Categories Content Macros
Version 1.1.2
Availability Confluence v2.3 to v2.9-m2-r2
State Stable
Support Atlassian Supported Plugins
License Freeware / Open Source (BSD)
Price Free
Release Docs http://confluence.atlassian.com/display/CONFEXT/Contributors+Plugin
Java API Docs n/a
Download Source http://svn.atlassian.com/svn/public/contrib/confluence/contributors-plugin/tags/contributors-1.1.2/
Download JAR contributors-1.1.2.jar

Compatibility With Confluence

Plugin Version 2.4.5 2.5.8 2.6.2 2.7.3 2.8.0 Tested
1.1   David Chui (Jan/09/2008)
1.1.2     David Chui (Apr/14/2008)

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.

Screenshots
(view as slideshow)
     
  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.)  
 

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

Atlassian Developer Network JIRA (8 issues)
T Key Summary Assignee Reporter Pr Status Res Created Updated Due
Bug CONTRB-45 IllegalArgumentException thrown in historic versions Shannon Krebs Don Willis Major Open UNRESOLVED Jul 03, 2008 Jul 03, 2008
New Feature CONTRB-41 Add page contributor information to the lucene index Unassigned Shannon Krebs Major Open UNRESOLVED Feb 17, 2008 Jun 30, 2008
Bug CONTRB-40 Contrib plugin using up database resources Shannon Krebs Jens Schumacher Critical Open UNRESOLVED Jan 22, 2008 Jun 20, 2008
Improvement CONTRB-38 i18n text Shannon Krebs Shannon Krebs Trivial Open UNRESOLVED Jul 06, 2007 Jul 06, 2007
New Feature CONTRB-34 groupby=space Shannon Krebs James Mortimer Major Open UNRESOLVED Jan 22, 2007 Jan 22, 2007
Improvement CONTRB-31 allow stats from pages other spaces to be collected by specifying a page in another space Shannon Krebs James Mortimer Minor Open UNRESOLVED Jan 22, 2007 Jan 22, 2007
New Feature CONTRB-29 Attachments column for contributors summary macro Shannon Krebs Shannon Krebs Minor Open UNRESOLVED Jan 22, 2007 Jan 22, 2007
New Feature CONTRB-18 include/exclude users based on group Shannon Krebs Shannon Krebs Minor Open UNRESOLVED Sep 16, 2006 Sep 16, 2006

Plugin Versions

Version Date State License Price
Show description 1.1.2 (#1104) 17 Feb 2008 Stable Freeware / Open Source (BSD) Free

Release Notes

The Contributors Plugin contains macros to display contributors and statistics from a page or a set of pages.

The following issues have been fixed in this release:

  • [CONTRB-39] - Error formatting macro: contributors-summary: java.lang.NullPointerExceptio
  • [CONTRB-37] - Contributor Summary Macro displays too many users when columns are filtered

Contributors

  • Shannon Krebs — Developer

Show description 1.1.1-dr1 (#1103) 17 Feb 2008 Prerelease Freeware / Open Source (BSD) Free

Release Notes

Release Notes - Confluence Contributors Plugin - Version 1.1.1 Development Release

Contributors

  • Shannon Krebs — Developer

Show description 1.1 (#1102) 11 Feb 2007 Stable Freeware / Open Source (BSD) Free

Release Notes

Release Notes - Confluence Contributors Plugin - Version 1.1

This release provides improved searching parameters and support for blog posts. Full Issue list:

Bug

  • [CONTRB-24] - Doesn't work for blog posts
  • [CONTRB-30] - documentation is not synchronized with parameters
  • [CONTRB-33] - duplicate redundant 'watches' are counted in the summary
  • [CONTRB-35] - contributors plugin count doesn't include new watches parameter

Improvement

  • [CONTRB-20] - Update macros to support confluence 2.3
  • [CONTRB-25] - remove deprecated contributors by label macro
  • [CONTRB-27] - Message reporting no information found is unconfigurable and not always end-user friendly
  • [CONTRB-32] - Include 'space' watchers in 'watches' and 'watching' lists

New Feature

  • [CONTRB-22] - support multiple spaces with the space parameter
  • [CONTRB-26] - include watches in contributors plugin

Task

Contributors

  • Shannon Krebs — Developer

Show description 0.8.3 (#5) 08 Nov 2006 Beta Freeware / Open Source (BSD) Free

Contributors

  • Shannon Krebs — Developer

In its previous life this plugin was originally developed as an entry for the Codegeist competition.

Similar Plugins

The Page Information Plugin provides similar functionality to the {contributors} macro to view the authors of pages.
The Global Statistics Plugin can give you some of the {contributors-summary} functionality from a space point of view.

Labels

 

Comments (10)

 

  1. Nov 28, 2007

    Nana says:

    I need help with this plugin. where is the documentation.\\ I am trying to list ...

    I need help with this plugin. where is the documentation.

    I am trying to list contributors to all pages in a space. Does this plugin do that? where do you use the page searching parameters?

    1. Nov 28, 2007

      Shannon Krebs says:

      I need help with this plugin. where is the documentation. This page should have...
      I need help with this plugin. where is the documentation.

      This page should have everything you need to know, the examples could possibly be improved...

      I am trying to list contributors to all pages in a space. Does this plugin do that? where do you use the page searching parameters?

      The page searching parameters are just used where you use normal parameters (they are only listed once because they apply to both macros). The plugin should be able to display a list of contributors from a whole space by doing something like {contributors:space=<spaceKey>} (Note, this has the potential to be very slow if you have a large space.)

      1. Dec 14, 2007

        Nana says:

        I tried to use the script you provided above, but it does not work. Looks like i...

        I tried to use the script you provided above, but it does not work. Looks like it ignores the space= parameter.

        1. Dec 14, 2007

          Shannon Krebs says:

          Check that the user viewing the macro has permission to view the pages inside th...

          Check that the user viewing the macro has permission to view the pages inside the space you are trying to look at. You can also try contacting Atlassian support if you are still having trouble.

  2. Feb 21

    Barbara Key says:

    Is it possible to exclude one person from the macro. Like for example an adminis...

    Is it possible to exclude one person from the macro. Like for example an administrator who created a lot of pages. I would also be happy if I could somehow restrict the report time maybe?

    1. Feb 21

      Shannon Krebs says:

      There is no way to do this currently. Please add a Jira issue for this feature t...

      There is no way to do this currently. Please add a Jira issue for this feature to get it considered for future versions.

  3. Feb 21

    K says:

    Is there a way to show only contibutions since a specific date? This will allevi...

    Is there a way to show only contibutions since a specific date? This will alleviate any performance problems (assuming there are indexes on update date) Ideally, there would be a parameter to show only contibutions since X days ago.  For example, showDays=30 would show contributions made within the past 30 days.  I think our business case is probably pretty common -- we want to know who is contributing in the last week or month so that we can 1) encourage adoption by sending encouraging emails to new contributors 2) monitor contributions for quantity and quality.

    1. Feb 21

      Shannon Krebs says:

      Restricting the contributor data to a date range probably won't help too much wi...

      Restricting the contributor data to a date range probably won't help too much with the performance issues, but would be a worthwhile feature. Please add a Jira issue to get it considered for future versions.

  4. May 16

    Michael Coxe says:

    What are the changes from 1.1 to 1.1.2? Just a new build to support Confluence 2...

    What are the changes from 1.1 to 1.1.2? Just a new build to support Confluence 2.8, or ?

    1. May 16

      Shannon Krebs says:

      fixes for 1.1.2 are in Jira here:

      fixes for 1.1.2 are in Jira here:
      http://developer.atlassian.com/jira/secure/IssueNavigator.jspa?reset=true&pid=10072&fixfor=11567

      I'm not sure why that never made it into release notes in the plugin repository... :-\