Open main menu

Extension:BoilerPlate

MediaWiki extensions manual
OOjs UI icon advanced.svg
BoilerPlate
Release status: stable
BoilerPlate extension screenshot.png
Implementation Example
Description Boilerplate code ready to be substituted to create a new extension with the latest standards and structure in place.
Author(s) Krinkletalk
MediaWiki 1.25+
License GNU General Public License 2.0 or later
Download
Translate the BoilerPlate extension if it is available at translatewiki.net
Check usage and version matrix.

The BoilerPlate extension is a blank extension template. It doesn't really do anything on its own, but provides boilerplate code for an actual MediaWiki extension. It also implements MediaWiki's preferred test automation and continuous integration (see that section below).

You should base your own code on the BoilerPlate extension, but for more in-depth comments and learning you should go and examine the Example extension.

Contents

UsageEdit

To use it, enter the following commands to make a clean directory of just the BoilerPlate source code without the Git meta-data and other examples. (Substitute your extension's name for MyExtension.)

cd extensions
git clone https://gerrit.wikimedia.org/r/p/mediawiki/extensions/BoilerPlate.git
cp -R BoilerPlate ./MyExtension

Then in MyExtension:

  • rename BoilerPlate files to MyExtension.
  • change BoilerPlate variable names, preserving case (i.e. boilerPlate -> myExtension).
  • replace "Your Name" in extension.json with your name.

Test automation and continuous integrationEdit

The BoilerPlate extension implements the standard entry points for test automation, running various code checkers for you that test for errors and enforce part of the MediaWiki coding conventions.

If your extension is hosted on gerrit.wikimedia.org, you can request that Wikimedia's continuous integration machinery run these tests on each commit; see gerrit:226680.

InstallationEdit

If you want to install this dull extension on your wiki to see if it works or troubleshoot problems with your adaptation.

  • Download and place the file(s) in a directory called BoilerPlate in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    wfLoadExtension( 'BoilerPlate' );
    
  • Visit Special:HelloWorld to verify the extension is working.
  • Follow the steps in its README to install testing dependencies, then run npm test and composer test.
  •   Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Earlier MediaWiki releasesEdit

If you want your extension to be compatible with earlier MediaWiki releases, consult the source code of release branches of the Example extension.

See alsoEdit