Extension:Contributors

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manual
Crystal Clear action run.png
Contributors

Release status: stable

Contributors.png
Implementation User activity, Special page
Description Summarises the most prominent contributors to an article
Author(s) Rob Church (original), Yaron Koren (current maintainer), Ike Hecht
Latest version 1.1.0 (2014-03-31)
MediaWiki 1.17+
PHP 5.3+
Database changes Yes
License No license specified
Download
Parameters
  • $wgContributorsLimit
  • $wgContributorsThreshold
Hooks used
ArticleDeleteComplete

ArticleSaveComplete
SkinTemplateBuildNavUrlsNav_urlsAfterPermalink
SkinTemplateToolboxEnd

Translate the Contributors extension if it is available at translatewiki.net

Check usage and version matrix; code metrics

The Contributors extension provides an includable special page which summarises 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[edit | edit source]

  • Download and extract the file(s) in a directory called Contributors in your extensions/ folder. If you're a developer and this extension is in a Git repository, then instead you should clone the repository using:
git clone https://gerrit.wikimedia.org/r/p/mediawiki/extensions/Contributors.git
  • 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.
  • Done! Navigate to "Special:Version" on your wiki to verify that the extension is successfully installed.

Usage[edit | edit source]

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

Special page[edit | edit source]

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.

Inclusion[edit | edit source]

You can include 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[edit | edit source]

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. For example:

{{Special:Contributors/{{FULLPAGENAME}},sortuser,asc}}

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

Output criteria[edit | edit source]

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[edit | edit source]

A complete log of changes to the extension code (including internationalisation updates from third parties) is available from the Subversion log, however, summarised information on changes between point releases is given below:

Version Release Date Comments
1.1.0 2014-06-13 Modernize code, add sorting options
1.0.1beta 2008-01-09 Beta release using wfLoadExtensionMessages
1.0beta 2006-12-23 Beta release
1.0beta 2006-06-01 Minor bug fix

See also[edit | edit source]

Language: English  • português do Brasil