Template:Extension

Issue tracker: [[phab:tag/{{{phabricator}}}/|#{{{phabricator}}}]]

{{Extension |templatemode =|name = |status = |type1 = |type2 = |hook1 = |hook2 = |newhook1 = |newhook2 = |username = |author = |maintainer =|description = |image = |imagesize = |version = |update = |version preview = |update preview = |compatibility policy =|mediawiki = |php = |needs-updatephp = |composer =|virtual domain =|table1 = |table2 = |license = |download = |show-popularity = |repo =|readme = |changelog = |help = |example = |namespace = |parameters = |tags = |rights = |compatibility = |phabricator =|translate = |vagrant-role = }}

MediaWiki extensions manual

{{{name}}}
Release status: unknown

Implementation

{{{type1}}}, {{{type2}}}

Description

{{{description}}}

Author(s)

SomeAuthor (SomeUser^talk)

Maintainer(s)

SomeOtherUser

Latest version

{{{version}}} ({{{update}}})

Latest preview version

{{{version preview}}} ({{{update preview}}})

Compatibility policy

invalid

MediaWiki

{{{mediawiki}}}

PHP

{{{php}}}

Database changes

{{{needs-updatephp}}}

Composer

{{{composer}}}

Virtual domain

{{{virtual domain}}}

Tables

[[Special:MyLanguage/Template:Extension/{{{table1}}} table|{{{table1}}}]][[:Template:Extension/{{{table1}}} table| ]]
[[Special:MyLanguage/Template:Extension/{{{table2}}} table|{{{table2}}}]][[:Template:Extension/{{{table2}}} table| ]]

License

{{{license}}}

Download

{{{download}}}
{{{readme}}}
{{{changelog}}}

Help

{{{help}}}

Example

{{{example}}}

Namespace

{{{namespace}}}

Parameters

{{{parameters}}}

Tags

{{{tags}}}

Added rights

{{{rights}}}

Hooks used

Hooks provided

{{{compatibility}}}

[[translatewiki:Special:Translate/{{{translate}}}|Translate the Extension extension]]

Vagrant role

{{{vagrant-role}}}

Issues

[[phab:tag/{{{phabricator}}}|Open tasks]] ·Report a bug

**Content parameters**
Parameter	Description
name	name of the extension
status	current release statusOne of: unstable – broken – do not use this extension experimental – early stages of development, may change drastically beta – stable but not fully tested stable – stable version unmaintained – unmaintained - previously claimed to be stable, now unmaintained unknown – default If the status is anything other than the above, it will be ignored and the default value of 'Unknown' will be displayed in the template instead.In cases where the value is omitted, it will be categorised asunknown.In cases where the value is invalid, it will be placed in aspecial category so that the error can be caught and fixed. release status colour scheme
type1 type2 type3 type4 type5 type6	implementation type The implementation strategy(s) employed in building this extension.This parameter is used to create categories that help programmers find examples of various MediaWiki specific implementation strategies or patterns.Although the values of this parameter sometimes coincide with the use case or purpose of an extension, that is not reason for this parameter.If the values you have chosen for this parameter do not adequately identify thepurpose or possibleuse cases, we recommend you add additionalcategory links as needed. Allowed values for thetype1,type2, ... parameters are: parser – catchall for uncategorisedparser extensions. If you have written a parser extension, please use one of the following more specific types: contenthandler – extensions usingContentHandler. link – customisedlink markup, e.g.`[[...]]`. parser function – customparameterised template markup, e.g.`{{#name: ... }}`. tag –custom XML tag markup, e.g.`‎<tagname>...‎</tagname>`. variable – customunparameterised template markup, e.g.`{{NAME}}`. extended syntax – extensions that add non-standard wiki syntax (i.e.nottags,parser functions, orvariables). access – catchall forUser access extensions, that is, extensions that create, authenticate, grant permissions, revoke permissions, or monitor the activity of users. If you have written an access extension, please use one of the following more specific types: user activity – extensions that monitor user activity (logins, logouts, new user creation, etc.). user identity – extensions that create and delete users, and/or verify the identity of a user. user rights – extensions to the rights management system, e.g. changes to the way rights are assigned, API, maintenance tools (does not include extensions that merely name the rights needed to use the features of that extension; for this purpose use therights parameter). interface – catchall for uncategorised user interface extensions. media – extensions that permit the embedding of multimedia content on wiki pages by registering a file extension with$wgMediaHandlers. mywiki – extensions that provide infrastructure so that users may personalise their MediaWiki experience and/or assist in the management of that infrastructure. notify – extensions that email users, broadcast messages and provide other forms of community notification. page action – extensions that enhance or modifypage actions. This includes anything that implements an action that reads, writes, searches for, creates, renames, deletes, redirects or discusses a page. It does not include rights (useuser rights) or logs (useuser activity). search – extensions that search through and select pages for users. skin – extensions addingCSS orJavaScript, or implementing hook functions to change the look and feel of MediaWiki via the skins framework. ajax – extensions that useAjax programming techniques. special – extensions that subclass theSpecialPage class, use one of its hooks, or patch one or more functions inSpecialPage.php. SeeSpecial pages for more information. other ai – extensions related toArtificial intelligence. api – extensions that add a new API module or extend a core API module. hook – hook extension —defines anew hook— see`\|hook1=`, etc. below if you want to define hooksused by your extension. database – adds tables and/or fields to the database backing a MediaWiki installation. data extraction – data extraction. filerepo – extension that adds new file repository types as file backend. example – not a real extension, but an example of how to write one. beta features – extensions that create newBeta Features. php – extensions to the underlyingPHP programming language. locale – extensions associated withlocalisation. Any other value for 'type' is invalid, and will cause the extension to be placed inCategory:Extensions with invalid or missing type. Note: Many extensions have more than one type, if this applies to yours, replace`\|type=` with`\|type1=`,`\|type2=`,`\|type3=`… You may define up to six types for an extension.
hook1 hook2 hook3 hook4 ...	name of each hook used by the extension Entering values in this field is a good way to get exposure for your extension and help other developers.Each documented hook will automatically add the extension to a category listing extensions that use that hook.This category is autolinked to each hook page so that programmers can easily find examples of extensions that use a particular hook. For multiple hooks, assign the first hook tohook1, the second tohook2 and so on.
newhook1 newhook2 newhook3 newhook4 ... newhook90	name of each hook provided by the extension You might also want to add the hooks toExtension hook registry.
username	The author's username on MediaWiki.org (if they have one). May be omitted, but if present it will be used to link to the author's user & user_talk page. It should be provided without namespace and without [[]]s.
author	The extension author's name, if different from their MediaWiki.org username. Free text. If omitted then the 'username' field will be used (if present).
maintainer	The extension's current maintainer. May be omitted, but if present it will be used to link to the maintainer's user & user_talk page, if the userpage exists. It should be provided without namespace and without`[[]]`s.
description	short description
image	Screenshot or logo of extension. It should be provided without namespace and without [[]]s.
imagesize	Facultative, size of the image without adding px, e.g. 360 (default size is 300px)
version	Last version
update	Date of the last update
version preview	Preview version
update preview	Date of the last update to the preview version
compatibility policy	Compatibility policy (accepted values:`master`,`main`,`rel`,`ltsrel`). (backlog)
mediawiki	Required version of MediaWiki. Most extensions should not need to use this — it defaults to the value of the`requires` property ofextension.json. See alsoCategory:Extensions without MediaWiki version andCategory:Extensions with manual MediaWiki version.
php	Required version of PHP
needs-updatephp	`yes` indicates that the extension requires a database table schema change or a similar action, before the MediaWiki can run.It is a common pitfall: your MediaWiki will stall if you forget to run`update.php` when the extension requires it. `no` indicates that the extension does not need`update.php` to be run.To avoid ambiguity this parameter should be set explicitly instead of relying on the absence of a`yes` to mean`no`. Extensions that conform to MediaWiki extension standards come with aschema change script which you need to start manually (once) before starting and accessing the MediaWiki through your browser, and after you copied all the extension files to`$IP/extensions/ExtensionName` and inserted`wfLoadExtension("ExtensionName");` into`LocalSettings.php`, run from the command line: `cdpath/to/wiki_install_directorycd maintenancephp update.php` $IP stands for the Installation Path (or "directory") of your MediaWiki installation, the same directory that holdsLocalSettings.php,index.php etc..
composer	The extension's Composer package name, in thestandard format. It will be automatically included if set in an extension's`composer.json` file (i.e. this parameter is not required in that case). It will be linked to the extension's page onPackagist.
virtual domain	Thevirtual database domain used by the extension.
table1 table2 table3 table4 ... table30	name of eachnon-core table used by the extensionLinks to a subpage of your extension page. For instance, "table1 = cu_changes" atExtension:CheckUser will link toExtension:CheckUser/cu_changes table. Don't list core tables such aspage orrevision; only list tables that are added by extensions.
license	Licence governing use of this extension, as one of the codes found inhttps://spdx.org/licenses/, e.g.`GPL-2.0-or-later`,`GPL-2.0-only` or`GPL-3.0-or-later`, etc.
download	link to the download :Git, {{WikimediaDownload}}.
show-popularity	enable/disable popularity fields (Quarterly downloads and Public wikis using the extension) based onTemplate:Extension/popularity.json, which may not reflect real usage
repo	Name of the Gerrit repository the extension's code is stored in, if different from the page name. Setting this automatically sets`\|download=`, and allows the template to automatically load data from the appropriate`extension.json` file.
readme	External link to the`README` file, e.g.https://phabricator.wikimedia.org/r/browse/mediawiki/extensions/Flow;master;README
changelog	External link to the changelog file, e.g.Extension:GeoGebra/Changelog.
help	Link to user-help for the extension. If not provided, will look for`Help:Extension:ExtensionName`. If provided, full wikitext link should be given (because you may want to link to e.g. an external page).
example	Example, website or screenshot of working extension.
namespace	Namespace in which this extension is used.
parameters	Available parameters for`LocalSettings.php`.
tags	Any tags your extension uses (e.g. <tag1>, <tag2>).
rights	Rights added by the extension.Not to be confused with the licence! Rights are such asmakebot ordesysop, not such as GFDL or LGPL or GPL - those are licences!
compatibility	Additional compatibility information, for instance compatibility charts. It's encouraged to add any client-side compatibility information here too, especially when diverging fromexpectations of full support for a browser.
bugzilla	Bugzilla MediaWiki extension component name
phabricator	Phabricator project name
translate	Optional parameter to link the exact page where (message group id with which) the extension will be translatable ontranslatewiki.net if enabled. If the default link is incorrect, manually set it to: ext-LOWERCASE(NOSPACES(Label as defined inconfig)), aka the parameter you get in the URL after typing the name of the extension in the search/filter box attranslatewiki:Special:Translate or searching for its name inlanguagestats after clicking "expand all".
vagrant-role	MediaWiki-Vagrant role
CheckUsageNameOverride	Override the page name used for the check usage link.

Content parameters

Parameter

Description

name

name of the extension

status

current release statusOne of:

unstable – broken – do not use this extension
experimental – early stages of development, may change drastically
beta – stable but not fully tested
stable – stable version
unmaintained – unmaintained - previously claimed to be stable, now unmaintained
unknown – default

If the status is anything other than the above, it will be ignored and the default value of 'Unknown' will be displayed in the template instead.In cases where the value is omitted, it will be categorised asunknown.In cases where the value is invalid, it will be placed in aspecial category so that the error can be caught and fixed.

release status colour scheme

type1
type2
type3
type4
type5
type6

implementation type

The implementation strategy(s) employed in building this extension.This parameter is used to create categories that help programmers find examples of various MediaWiki specific implementation strategies or patterns.Although the values of this parameter sometimes coincide with the use case or purpose of an extension, that is not reason for this parameter.If the values you have chosen for this parameter do not adequately identify thepurpose or possibleuse cases, we recommend you add additionalcategory links as needed.

Allowed values for thetype1,type2, ... parameters are:

parser – catchall for uncategorisedparser extensions. If you have written a parser extension, please use one of the following more specific types:
- contenthandler – extensions usingContentHandler.
- link – customisedlink markup, e.g.[[...]].
- parser function – customparameterised template markup, e.g.{{#name: ... }}.
- tag –custom XML tag markup, e.g.‎<tagname>...‎</tagname>.
- variable – customunparameterised template markup, e.g.{{NAME}}.
- extended syntax – extensions that add non-standard wiki syntax (i.e.nottags,parser functions, orvariables).
access – catchall forUser access extensions, that is, extensions that create, authenticate, grant permissions, revoke permissions, or monitor the activity of users. If you have written an access extension, please use one of the following more specific types:
- user activity – extensions that monitor user activity (logins, logouts, new user creation, etc.).
- user identity – extensions that create and delete users, and/or verify the identity of a user.
- user rights – extensions to the rights management system, e.g. changes to the way rights are assigned, API, maintenance tools (does not include extensions that merely name the rights needed to use the features of that extension; for this purpose use therights parameter).
interface – catchall for uncategorised user interface extensions.
- media – extensions that permit the embedding of multimedia content on wiki pages by registering a file extension with$wgMediaHandlers.
- mywiki – extensions that provide infrastructure so that users may personalise their MediaWiki experience and/or assist in the management of that infrastructure.
- notify – extensions that email users, broadcast messages and provide other forms of community notification.
- page action – extensions that enhance or modifypage actions. This includes anything that implements an action that reads, writes, searches for, creates, renames, deletes, redirects or discusses a page. It does not include rights (useuser rights) or logs (useuser activity).
- search – extensions that search through and select pages for users.
- skin – extensions addingCSS orJavaScript, or implementing hook functions to change the look and feel of MediaWiki via the skins framework.
- ajax – extensions that useAjax programming techniques.
- special – extensions that subclass theSpecialPage class, use one of its hooks, or patch one or more functions inSpecialPage.php. SeeSpecial pages for more information.
other
- ai – extensions related toArtificial intelligence.
- api – extensions that add a new API module or extend a core API module.
- hook – hook extension —defines anew hook— see|hook1=, etc. below if you want to define hooksused by your extension.
- database – adds tables and/or fields to the database backing a MediaWiki installation.
- data extraction – data extraction.
- filerepo – extension that adds new file repository types as file backend.
- example – not a real extension, but an example of how to write one.
- beta features – extensions that create newBeta Features.
- php – extensions to the underlyingPHP programming language.
- locale – extensions associated withlocalisation.

Any other value for 'type' is invalid, and will cause the extension to be placed inCategory:Extensions with invalid or missing type.

Note: Many extensions have more than one type, if this applies to yours, replace|type= with|type1=,|type2=,|type3=… You may define up to six types for an extension.

hook1
hook2
hook3
hook4
...

name of each hook used by the extension

Entering values in this field is a good way to get exposure for your extension and help other developers.Each documented hook will automatically add the extension to a category listing extensions that use that hook.This category is autolinked to each hook page so that programmers can easily find examples of extensions that use a particular hook.

For multiple hooks, assign the first hook tohook1, the second tohook2 and so on.

newhook1
newhook2
newhook3
newhook4
...
newhook90

name of each hook provided by the extension

You might also want to add the hooks toExtension hook registry.

username

The author's username on MediaWiki.org (if they have one). May be omitted, but if present it will be used to link to the author's user & user_talk page. It should be provided without namespace and without [[]]s.

author

The extension author's name, if different from their MediaWiki.org username. Free text. If omitted then the 'username' field will be used (if present).

maintainer

The extension's current maintainer. May be omitted, but if present it will be used to link to the maintainer's user & user_talk page, if the userpage exists. It should be provided without namespace and without[[]]s.

description

short description

image

Screenshot or logo of extension. It should be provided without namespace and without [[]]s.

imagesize

Facultative, size of the image without adding px, e.g. 360 (default size is 300px)

version

Last version

update

Date of the last update

version preview

Preview version

update preview

Date of the last update to the preview version

compatibility policy

Compatibility policy (accepted values:master,main,rel,ltsrel). (backlog)

mediawiki

Required version of MediaWiki. Most extensions should not need to use this — it defaults to the value of therequires property ofextension.json. See alsoCategory:Extensions without MediaWiki version andCategory:Extensions with manual MediaWiki version.

php

Required version of PHP

needs-updatephp

yes indicates that the extension requires a database table schema change or a similar action, before the MediaWiki can run.It is a common pitfall: your MediaWiki will stall if you forget to runupdate.php when the extension requires it.

no indicates that the extension does not needupdate.php to be run.To avoid ambiguity this parameter should be set explicitly instead of relying on the absence of ayes to meanno.

Extensions that conform to MediaWiki extension standards come with aschema change script which you need to start manually (once) before starting and accessing the MediaWiki through your browser, and after you copied all the extension files to$IP/extensions/ExtensionName and insertedwfLoadExtension("ExtensionName"); intoLocalSettings.php, run from the command line:

cdpath/to/wiki_install_directorycd maintenancephp update.php

$IP stands for the Installation Path (or "directory") of your MediaWiki installation, the same directory that holdsLocalSettings.php,index.php etc..

composer

The extension's Composer package name, in thestandard format. It will be automatically included if set in an extension'scomposer.json file (i.e. this parameter is not required in that case). It will be linked to the extension's page onPackagist.

virtual domain

Thevirtual database domain used by the extension.

table1
table2
table3
table4
...
table30

name of eachnon-core table used by the extensionLinks to a subpage of your extension page. For instance, "table1 = cu_changes" atExtension:CheckUser will link toExtension:CheckUser/cu_changes table. Don't list core tables such aspage orrevision; only list tables that are added by extensions.

license

Licence governing use of this extension, as one of the codes found inhttps://spdx.org/licenses/, e.g.GPL-2.0-or-later,GPL-2.0-only orGPL-3.0-or-later, etc.

download

link to the download :Git, {{WikimediaDownload}}.

show-popularity

enable/disable popularity fields (Quarterly downloads and Public wikis using the extension) based onTemplate:Extension/popularity.json, which may not reflect real usage

repo

Name of the Gerrit repository the extension's code is stored in, if different from the page name. Setting this automatically sets|download=, and allows the template to automatically load data from the appropriateextension.json file.

readme

External link to theREADME file, e.g.https://phabricator.wikimedia.org/r/browse/mediawiki/extensions/Flow;master;README

changelog

External link to the changelog file, e.g.Extension:GeoGebra/Changelog.

help

Link to user-help for the extension. If not provided, will look forHelp:Extension:ExtensionName. If provided, full wikitext link should be given (because you may want to link to e.g. an external page).

example

Example, website or screenshot of working extension.

namespace

Namespace in which this extension is used.

parameters

Available parameters forLocalSettings.php.

Movatterモバイル変換

Template:Extension

Usage

Content parameters

Control parameters

Using the infobox

Existing extension pages

Create a new extension page

Enhancing this template

The Create extension button

Infobox parameters

Test case

TemplateData