Extension:SiteMatrix

From MediaWiki.org
Jump to: navigation, search


Note: This extension is made for Wikimedia wikis. It may work for other wikis, but note that the extension contains Wikimedia-specific text.
MediaWiki extensions manual
Crystal Clear action run.png
SiteMatrix

Release status: stable

Implementation Special page, API
Description adds a special page with a matrix of all Wikimedia sites
Author(s) Tim Starling, Brion Vibber, Victor Vasiliev, Alexandre Emsenhuber
Latest version 1.3 (2014-03-28)
License No license specified
Download
Example Special:SiteMatrix
Parameters

$wgSiteMatrixFile
$wgSiteMatrixSites
$wgSiteMatrixPrivateSites
$wgSiteMatrixFishbowlSites
$wgSiteMatrixClosedSites

Hooks used
APIQuerySiteInfoGeneralInfo

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

Check usage and version matrix; code metrics
Bugs: list open list all report

The SiteMatrix extension adds a special page with a matrix of all sites of the Wikimedia Foundation. First a table of all normal language wikis, with blue links for existing wikis and red links for non-existing wikis. Below a list of other special projects (like Meta, Commons, Wikimania, ...), mostly the sites like *.wikimedia.org.

Installation

  • Download and extract the file(s) in a directory called SiteMatrix in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
require_once "$IP/extensions/SiteMatrix/SiteMatrix.php";
  • Done! Navigate to "Special:Version" on your wiki to verify that the extension is successfully installed.

There are some variables that you need to change:

  • $wgSiteMatrixFile - The path to a list of language codes recognised by MediaWiki (example).
  • $wgSiteMatrixPrivateSites - The path to a list of wiki databases that are private (optional)
  • $wgSiteMatrixFishbowlSites - The path to a list of wiki databases that are public, but only logged in users can edit. (optional)
  • $wgSiteMatrixClosedSites - The path of a list of wiki databases that "closed" (optional)

You would also need to customise $wgSiteMatrixSites to list the different wikis in your own wikifarm. Follow the template in SiteMatrix.php as a guide.

Additional requirements

To ensure that the extension works correctly to your needs, there are a few dependencies to this extension:

  • $wgLocalDatabases - To tell the extension all the wiki databases that exist in your wikifarm.
  • $wgConf - To feed the extension with the correct links to the different wikis in your wikifarm.

API

This extension adds an API module that provides the same information as Special:SiteMatrix

Show site matrix (only parts are shown here)

See also