Extension:Contributors

From mediawiki.org
MediaWiki extensions manual
Contributors
Release status: unmaintained
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.1 (2023-09-22)
Compatibility policy Master maintains backward compatibility.
MediaWiki 1.35-1.39
PHP 7.3+
Database changes Yes
Tables contributors
License GNU General Public License 2.0 or later
Download
  • $wgContributorsLinkUsers
Quarterly downloads 6 (Ranked 144th)
Translate the Contributors extension if it is available at translatewiki.net
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 move the extracted Contributors folder to your extensions/ directory.
    Developers and code contributors should install the extension from Git instead, using:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/Contributors
  • Add the following code at the bottom of your LocalSettings.php file:
    wfLoadExtension( 'Contributors' );
    
  • 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
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
  • upgrade: php extensions/Contributors/maintenance/PopulateContributorsTable.php


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.

Parser function

There's also a parser function that displays the contributors in a plain list, like so: Joe, Moe and Jane.

{{#contributors:{{FULLPAGENAME}}}}

You can also filter anons from the list of contributors, like so:

{{#contributors:{{FULLPAGENAME}}|filteranon}}

Parameters

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

See also