Template:Extension/en

<languages/>

File:Test Template Info-Icon - Version (2).svg Template documentation

Template:Intricate template Template:Uses TemplateStyles This template should be added to all extension pages on this wiki (but only the main page). It will add a useful infobox (see below) and will automatically add the extension to Category:All extensions , along with the appropriate status and implementation type categories. It autofills some fields of the infobox with extension data collected by wikitech:Tool:Extjsonuploader.

Usage

Copy and paste: {{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 = }} For help with parameter values, see below.

Template:Ptag MediaWiki extensions manual File:OOjs UI icon advanced-invert.svg {{{name}}} Release status: unknown File:Placeholder.svg Implementation Description {{{description}}} Author(s) (SomeUsertalk) Maintainer(s) SomeOtherUser Latest version  ({{{update}}}) Latest preview version {{{version preview}}} ({{{update preview}}}) Compatibility policy MediaWiki PHP Database changes {{{needs-updatephp}}} 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 Download {{{download}}} {{{readme}}} {{{changelog}}} Help {{{help}}} Example {{{example}}} Namespace {{{namespace}}} Parameters {{{parameters}}} Tags {{{tags}}} Added rights {{{rights}}} Hooks provided Template:Foreach {{{compatibility}}} [[translatewiki:Special:Translate/{{{translate}}}|Translate the Extension extension]] Vagrant role {{{vagrant-role}}} Issues [[phab:tag/{{{phabricator}}}|Open tasks]] · Report a bug

Content parameters

This section describes parameters that govern infobox content. For help with templatemode and other control parameters, please see Control parameters.

Content parameters

Parameter	Description
name	name of the extension
status	current release status One 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 as unknown. In cases where the value is invalid, it will be placed in a special 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 the purpose or possible use cases, we recommend you add additional category links as needed. Allowed values for the type1, type2, ... parameters are: parser – catchall for uncategorised parser extensions. If you have written a parser extension, please use one of the following more specific types: contenthandler – extensions using ContentHandler . link – customised link markup, e.g. [[...]]. parser function – custom parameterised template markup, e.g. {{#name: ... }}. tag – custom XML tag markup, e.g. ‎<tagname>...‎</tagname>. variable – custom unparameterised template markup, e.g. {{NAME}}. extended syntax – extensions that add non-standard wiki syntax (i.e. not tags, parser functions, or variables). access – catchall for Manual:User 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 the rights 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 modify page 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 (use user rights) or logs (use user activity). search – extensions that search through and select pages for users. skin – extensions adding CSS or JavaScript, or implementing hook functions to change the look and feel of MediaWiki via the skins framework. ajax – extensions that use Ajax programming techniques. special – extensions that subclass the Template:Class doclink class, use one of its hooks, or patch one or more functions in Template:Git file. See Special pages for more information. other ai – extensions related to Artificial intelligence. api – extensions that add a new API module or extend a core API module. hook – hook extension —defines a new hook— see |hook1=, etc. below if you want to define hooks used 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 new Beta Features . php – extensions to the underlying PHP programming language. locale – extensions associated with localisation. Any other value for 'type' is invalid, and will cause the extension to be placed in [[:Category:Extensions with invalid or missing type{{#translation:}}]]. 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 to hook1, the second to hook2 and so on.
newhook1 newhook2 newhook3 newhook4 ... newhook90	name of each hook provided by the extension You might also want to add the hooks to Extension 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.
Template:Visible anchor	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).
Template:Visible anchor	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
Template:Visible anchor	Screenshot or logo of extension. It should be provided without namespace and without [[]]s.
Template:Visible anchor	Facultative, size of the image without adding px, e.g. 360 (default size is 300px)
Template:Visible anchor	Last version
Template:Visible anchor	Date of the last update
Template:Visible anchor	Preview version
Template:Visible anchor	Date of the last update to the preview version
compatibility policy	Compatibility policy (accepted values: master, main, rel, ltsrel). (backlog )
Template:Visible anchor	Required version of MediaWiki. Most extensions should not need to use this — it defaults to the value of the Template:Manual property of Template:Manual. See also Category:Extensions without MediaWiki version and Category:Extensions with manual MediaWiki version .
Template:Visible anchor	Required version of PHP
Template:Visible anchor	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 a schema 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 <syntaxhighlight lang=php inline>$IP/extensions/ExtensionName</syntaxhighlight> and inserted <syntaxhighlight lang=php inline>wfLoadExtension( "ExtensionName" );</syntaxhighlight> into LocalSettings.php, run from the command line: cd path/to/wiki_install_directory cd maintenance php update.php Template:$IP
composer	The extension's Composer package name, in the standard 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 on Packagist.
virtual domain	The virtual database domain used by the extension.
table1 table2 table3 table4 ... table30	name of each non-core table used by the extension Links to a subpage of your extension page. For instance, "table1 = cu_changes" at Extension:CheckUser will link to Extension:CheckUser/cu_changes table . Don't list core tables such as page or revision ; only list tables that are added by extensions.
Template:Visible anchor	License governing use of this extension, as one of the codes found in https://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, {{[[Template:WikimediaDownload{{#translation:}}|WikimediaDownload{{#translation:}}]]}}.
show-popularity	enable/disable popularity fields (Quarterly downloads and Public wikis using the extension) based on Template: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.
Template:Visible anchor	External link to the README file, e.g. https://phabricator.wikimedia.org/r/browse/mediawiki/extensions/Flow;master;README
Template:Visible anchor	External link to the changelog file, e.g. Extension:GeoGebra/Changelog.
Template:Visible anchor	Link to user-help for the extension. If not provided, will look for Template:Tmpl. If provided, full wikitext link should be given (because you may want to link to e.g. an external page).
Template:Visible anchor	Example, website or screenshot of working extension.
Template:Visible anchor	Namespace in which this extension is used.
Template:Visible anchor	Available parameters for LocalSettings.php.
Template:Visible anchor	Any tags your extension uses (e.g. <tag1>, <tag2>).
Template:Visible anchor	Rights added by the extension. Not to be confused with the license! Rights are such as makebot or desysop , not such as GFDL or LGPL or GPL - those are licenses!
Template:Visible anchor	Additional compatibility information, for instance compatibility charts. It's encouraged to add any client-side compatibility information here too, especially when diverging from expectations of full support for a browser.
Template:Visible anchor	Bugzilla MediaWiki extension component name
Template:Visible anchor	Phabricator project name
Template:Visible anchor	Optional parameter to link the exact page where (message group id with which) the extension will be translatable on translatewiki.net if enabled. If the default link is incorrect, manually set it to: ext-LOWERCASE(NOSPACES(Label as defined in Template:Git file)), aka the parameter you get in the URL after typing the name of the extension in the search/filter box at translatewiki:Special:Translate or searching for its name in languagestats after clicking "expand all".
Template:Visible anchor	MediaWiki-Vagrant role
Template:Visible anchor	Override the page name used for the check usage link.

Control parameters

Control parameters

Parameter

Description

templatemode

Controls auto-categorisation of host page. Normally left blank. Alternate values are: nocats - suppresses categorisation and the 'check usage' link. Use this value if you are adding this template to subpages of an extension or to how-to documentation of extensions. For example, the usage image above sets templatemode=nocats because this isn't an actual extension page and we don't want to add this page to any categories on account of it. nousage - suppresses the 'check usage' link. Link is also suppressed if the page is a subpage; it is not in the Extension: namespace; or if suppressed by 'templatemode=nocats' If this is left blank, this template will add the host page to [[:Category:All extensions{{#translation:}}]] and to one or more additional categories, depending on the values assigned to the Content parameters.

Using the infobox

Existing extension pages

If you want to add the infobox to an existing page, copy and paste the code at the top of this page.

Create a new extension page

If you want to create a new extension page, enter the name below and click the button. A new page will be created with the infobox template already in place.

Enhancing this template

If you would like to improve on this template, thanks! This is a complicated template so here is some help along the way:

The Create extension button

To improve the create extension button behavior:

• Template:Extension/Sample : The boilerplate extension that is preloaded into newly-created pages.
• Template:Extension/CreateExtensionInputBox : An input box that can be inserted wherever you want users to easily create extensions. For documentation on the ‎<inputbox> tag, please see Extension:InputBox .

Infobox parameters

In general:

• To make this template easy to use, each label in the infobox is linked to documentation on the template parameter(s) it displays. If you add a parameter, please be sure to also add it to the content parameter documentation and link its label to that documentation.

To change/correct/add to the implementation type parameters:

• Check the talk page - there have been some extensive discussions about this field.
• The valid types and what they link to are defined at Module:Extension

To change the behavior of the hook parameters:

• Template:Extension/HookInUse: Adds links and categories for a hook in use. Multiple hooks in use are implemented by calling this template with Template:Foreach.
• Template:Extension/HookInUseNoCats: Used instead of Template:Extension/HookInUse when this template is used in templatemode=nocats. Templates used with Template:Foreach can only take one parameter so we need to wrap the call to Template:Extension/HookInUse with another template that sets the mode.

Test case

See if the following pages are still ok after editing this template.

• Extension:Description2
• Template:Extension

Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Subpages of this template.

[[Category:Template documentation pages{{#translation:}}]]

Maintenance: vulnerabilities, archived

[[Category:Infobox templates{{#translation:}}|Extension/en]]