Extension:Contributors

Other languages:

English • ‎Türkçe • ‎português • ‎português do Brasil • ‎العربية • ‎中文 • ‎日本語

**MediaWiki extensions manual**
Contributors Release status: stable

Implementation	User activity , Special page
Description	Summarizes the most prominent contributors to an article
Author(s)	Rob Church (original), Yaron Koren, Ike Hecht
Latest version	2.0 (2015-07-08)
MediaWiki	1.25+
PHP	5.4+
Database changes	Yes
Tables	contributors
License	GNU General Public License 2.0 or later
Download	Download extension Git ^[?]: Download Git master browse repository (GitHub) commit history repository contributors (GitHub) code review
Parameters $wgContributorsLimit $wgContributorsLinkUsers $wgContributorsThreshold
Hooks used ArticleRevisionVisibilitySet LoadExtensionSchemaUpdates PageSaveComplete ParserFirstCallInit SidebarBeforeOutput SkinTemplateToolboxEnd
Translate the Contributors extension if it is available at translatewiki.net
Check usage and version matrix.
Issues	Open tasks · Report a bug

The Contributors extension provides an includable special page which summarizes the most prominent contributors to an article. The page can be accessed as a normal special page, or included into other pages to provide an automated list, which is useful for attribution.

Installation

Download and place the file(s) in a directory called Contributors in your extensions/ folder.

Add the following code at the bottom of your LocalSettings.php:

require_once "$IP/extensions/Contributors/Contributors.php";

Run the update script which will automatically create the necessary database tables that this extension needs.
Run the script that will populate the database with contributors from existing articles:

php extensions/Contributors/maintenance/PopulateContributorsTable.php

Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Usage

The list can be accessed as a conventional special page, or through inclusion into another page.

Special page

The special page is located at "Special:Contributors" and provides an interface to select an article. You can also access this page using the "main contributors" link in the toolbox when viewing an article; the results for that page will be shown.

Transclusion

You can transclude a list of names into another page using the inclusion mechanism, e.g.

{{Special:Contributors/Article}}

You can also create a template with the following code on it, and add it to your articles.

{{Special:Contributors/{{FULLPAGENAME}}}}

will produce a list of the most prominent contributors to Article.

Sorting

By default, the list is sorted by number of edits, in descending order. It is possible to sort by user name and to switch the order to ascending. This is done with a parser function. For example:

{{#contributors:{{FULLPAGENAME}}|sortuser|asc}}

This switches the sort to be alphabetical by user name, ascending. These options are also available at Special:Contributors.

Parameters

$wgContributorsLinkUsers links the user names to their User page. Doesn't affect the Special page, which is always linked. (default true)

Output criteria

This extension lists "prominent contributors" to a page. The default behaviour will show all contributors, in order of number of edits, if the number of contributors is ten or less. Once the limit is hit, contributors with over two edits will continue to be listed. Contributors who are not listed are acknowledged as "X others".

These limits can be changed:

$wgContributorsLimit defines the "intelligent cut-off" limit (default 10)
$wgContributorsThreshold defines the edit threshold for additional users (default 2)

Change log

A complete log of changes to the extension code (including internationalisation updates from third parties) is available from git. However, summarized information on changes between point releases is given below. Each point release is tagged in git.

Version	Release Date	Comments
2.0.0	2015-07-10	Change default behavior to link the user name, with option to not link
1.5.0	2014-10-07	Remove sorting options from SpecialPage inclusion, add parser function with sorting options
1.1.0	2014-06-13	Modernize code, add sorting options
1.0.1-beta	2008-01-09	Beta release using wfLoadExtensionMessages
1.0.0-beta2	2006-12-23	Beta release
1.0.0-beta1	2006-06-01	Minor bug fix