Extension:BoilerPlate

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

Release status: stable

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
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; code metrics

The BoilerPlate extension is a blank extension template. It doesn't really do anything on its own. It provides boilerplate code for an actual MediaWiki extension. It's in the examples repository with other sample code.

Usage[edit | edit source]

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

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

Then

  • rename BoilerPlate files to MyExtension.
  • change BoilerPlate variable names
  • replace "John Doe" with your name
  • etc.

See also[edit | edit source]