Template:Extension/doc

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 extensionsTemplate:Translation]], along with the appropriate [[:Category:Extensions by statusTemplate:Translation|status]] and [[:Category:Extensions by implementation typeTemplate:Translation|implementation type]] categories.

Usage

Copy and paste: MediaWiki extensions manual Extension/doc Release status: unknown[[Category:extensions with invalid status{{#translation:}}]] Author(s) SomeAuthor (SomeUsertalk) Latest version  ({{{update}}}) Latest preview version {{{version preview}}} ({{{update preview}}}) MediaWiki PHP {{{php}}} Database changes {{{needs-updatephp}}} Composer {{{composer}}} [[Category:Extensions supporting Composer{{#translation:}}]] Tables [[Special:MyLanguage/Template:Extension/doc/{{{table1}}} table|{{{table1}}}]][[:Template:Extension/doc/{{{table1}}} table| ]] [[Special:MyLanguage/Template:Extension/doc/{{{table2}}} table|{{{table2}}}]][[:Template:Extension/doc/{{{table2}}} table| ]] License Download This section describes parameters that govern infobox content. For help with templatemode and other control parameters, please see Control parameters. Parameters Added rights Hooks provided newhook1 newhook2 Translate the Extension/doc extension if it is available at translatewiki.net [[Category:All extensions{{#translation:}}]] ** [[:Category:Tag extensionsTemplate:Translation|tag]] - custom XML tag markup, e.g. <tagname>...</tagname> ** [[:Category:Variable extensionsTemplate:Translation|variable]] - custom unparameterized template markup, e.g. {{NAME}} ** [[:Category:Extended syntax extensionsTemplate:Translation|extended syntax]] - Extensions that add non-standard wiki syntax (i.e. not tags, parser functions, or variables). *: * [[:Category:User access extensionsTemplate:Translation|access]] - catchall for 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: ** [[:Category:User activity extensionsTemplate:Translation|user activity]] - extensions that monitor user activity (logins, logouts, new user creation, etc.) ** [[:Category:User identity extensionsTemplate:Translation|user identity]] - extensions that create and delete users, and/or verify the identity of a user ** [[:Category:User rights extensionsTemplate:Translation|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) * [[:Category:User interface extensionsTemplate:Translation|interface]] - catchall for uncategorized user interface extensions. ** [[:Category:Media handling extensionsTemplate:Translation|media]] - extensions that permit the embedding of multimedia content on wiki pages by registering a file extension with $wgMediaHandlers. ** [[:Category:Personalization extensionsTemplate:Translation|mywiki]] - extensions that provide infrastructure so that users may personalize their MediaWiki experience and/or assist in the management of that infrastructure ** [[:Category:Notification extensionsTemplate:Translation|notify]] - extensions that email users, broadcast messages and provide other forms of community notification ** [[:Category:Page action extensionsTemplate:Translation|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). ** [[:Category:Search extensionsTemplate:Translation|search]] - extensions that search through and select articles for users. ** [[:Category:Skin extensionsTemplate:Translation|skin]] - extensions adding CSS or JavaScript, or implementing hook functions to change the look and feel of MediaWiki via the skins framework. ** [[:Category:Ajax extensionsTemplate:Translation|ajax]] - extensions that use Ajax programming techniques. ** [[:Category:Special page extensionsTemplate:Translation|special]] - extensions that subclass the SpecialPage class, use one of its hooks, or patch one or more functions in SpecialPage.php. See Special:MyLanguage/Manual:Special pages for more information. * other ** [[:Category:API extensionsTemplate:Translation|api]] - extensions that add a new API module or extend a core API module. ** [[:Category:Hook extensionsTemplate:Translation|hook]] - Hook extension - defines a new hook - see hook1, etc. below if you want to define hooks used by your extension ** [[:Category:Database extensionsTemplate:Translation|database]] - adds tables and/or fields to the database backing a MediaWiki installation ** [[:Category:Data extraction extensionsTemplate:Translation|data extraction]] - Data extraction ** [[:Category:File repository extensionsTemplate:Translation|filerepo]] - extension that adds new file repository types as file backend ** [[:Category:Extension examplesTemplate:Translation|example]] - Not a real extension, but an example of how to write one Any other value for 'type' is invalid, and will cause the extension to be placed in [[:Category:Extensions with invalid or missing typeTemplate: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 ... hook30	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 article so that programmers can easily find examples of extensions that use a particular hook. For built-in hooks: * use the hook name alone. Please see Manual:Hooks for values (but omit introductory '/'). For custom hooks defined by extensions: * use extensionName/hookName. For a partial list of custom hooks, see Extension hook registry. For multiple hooks, assign the first hook to hook1, the second to hook2 and so on.
newhook1 newhook2 newhook3 newhook4 ... newhook30	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.
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).
description	short description
image	screenshot or logo of extension. It should be provided without namespace and without [[]]s.
imagesize	facultative, size of the image (default size is 220px)
version	last version
update	date of the last update
mediawiki	required version of MediaWiki
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 forgot to run update.php - if the extension requires it. No should be set as a value since this assures that the extension does not need update.php to be run and thus avoids uncertainty Extensions which 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 $IP/extensions/ExtensionName and inserted require_once "$IP/extensions/ExtensionName"; to "LocalSettings.php": php $IP/maintenance/update.php Template:TNT
composer	If applicable the name of the "vendor" as well as the "package" should be entered in the format vendor/package, e.g. mediawiki/semantic-media-wiki to point people directly to packagist.org, which serves as the package archive.
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.
license	license governing use of this extension, as one of the codes found in https://spdx.org/licenses/
download	link to the download : Git, {{WikimediaDownload}} with server=svn in case it was not migrated from Subversion. If you put the code into page in the MediaWiki wiki, link to it using a full page name and section name, e.g. [[Extension:Example/version_1.22a#Code]] (it must remain valid when bot-copied elsewhere)
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:LDAP Authentication/Changelog
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 license! Rights are such as makebot or desysop, not such as GFDL or LGPL or GPL - those are licenses!
namespace	namespace in which this extension is used
example	example, website or screenshot of working extension
compatibility	Additional compatibility information, for instance compatibility charts (formerly using Template:Extension Testing). It's encouraged to add any client-side compatibility information here too, especially when diverging from expectations of full support for a browser.
translate	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 config)), 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".
bugzilla	Bugzilla MediaWiki extension component name
phabricator	Phabricator project name
CheckUsageNameOverride	override the page name used for the check usage link.

Control parameters

Control parameters

Parameter

Description

templatemode

Controls auto-categorization of host page. Normally left blank. Alternate values are: * nocats - suppresses categorization 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 extensionsTemplate: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 article

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.

<translate> A developer sharing their code in the MediaWiki code repository should expect:</translate> ;<translate> Feedback / Criticism / Code reviews</translate> :<translate> Review and comments by other developers on things like [<tvar

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:

Fixing documentation

If you would like to fix documentation, please be aware that documentation and code is split into two files: * Template:Extension/doc - stores all documentation. * Template:Extension - stores only the code for the template and a small amount of non-included material (category links, transcluded documentation link). In addition, Template:Extension/Sample stores the boiler plate that is preloaded into newly created pages and contains some basic documentation on how to fill in the template parameters. It needs to be kept in sync with Template:Extension/doc.

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. * Template:Extension/TypeSwitch: Stores the possible values for the type field. Multiple values are implemented by calling this template with Template:Foreach. * Template:Extension/TypeSwitchNoCats: Does not need to be modified when adding a new type. Used instead of Template:Extension/TypeSwitch 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/TypeSwitch with another template that sets the mode. * Template:Extension/doc: Documentation for this template needs to be kept in sync with any changes to the implementation type taxonomy. 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 edited this template. * Extension:Description2 * Template:Extension

TemplateData

<templatedata> { "description": "An infobox for a MediaWiki extension.", "params": { "status": { "description": "Current release status. One of: unstable, experimental, beta, stable, unmaintained, unknown.", "default": "unknown", "label": "Status", "type": "string" }, "name": { "description": "name of the extension", "label": "Name", "type": "string" }, "license": { "description": "Extension's license.", "label": "License", "type": "string" }, "templatemode": { "description": "Controls auto-categorization of host page. Normally left blank. Alternate values are: nocats, nousage.", "label": "Mode" }, "image": { "description": "Screenshot or logo of extension. It should be provided without namespace and without [[]]s.", "label": "Screenshot or logo" }, "imagesize": { "description": "Facultative, size of the image (default size is 220px)" }, "type": { "description": "Implementation type. See detailed doc.", "label": "Primary type" }, "type1": { "description": "Implementation type. See detailed doc.", "label": "Secondary type" }, "type2": { "description": "Implementation type. See detailed doc.", "label": "Tertiary type" }, "type3": { "description": "Implementation type. See detailed doc.", "label": "Quaternary type" }, "type4": { "description": "Implementation type. See detailed doc.", "label": "Quaternary type" }, "type5": { "description": "Implementation type. See detailed doc.", "label": "Quinary type" }, "type6": { "description": "Implementation type. See detailed doc.", "label": "Senary type" }, "description": { "description": "Short description." }, "author": { "description": "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)." }, "username": { "description": "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." }, "version": { "aliases": [ "latest release version", "latest_release_version" ] }, "update": { "description": "date of the last update" }, "version preview": { "description": "version preview" }, "update preview": { "description": "version preview" }, "mediawiki": { "description": "Required version of MediaWiki" }, "php": { "description": "Required version of PHP" }, "needs-updatephp": { "description": "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 forgot to run update.php - if the extension requires it. No should be set as a value since this assures that the extension does not need update.php to be run and thus avoids uncertainty." }, "composer": { "description": "If applicable the name of the \"vendor\" as well as the \"package\" should be entered in the format vendor/package, e.g. mediawiki/semantic-media-wiki to point people directly to packagist.org, which serves as the package archive." }, "phabricator": { "description": "Phabricator project name", "example": "MediaWiki-extensions-Babel", "type": "string", "suggested": true }, "table1": { "description": "Name of a non-core table used by the extension." }, "table2": { "description": "Name of a non-core table used by the extension." }, "table3": { "description": "Name of a non-core table used by the extension." }, "table4": { "description": "Name of a non-core table used by the extension." }, "table5": { "description": "Name of a non-core table used by the extension." }, "table6": { "description": "Name of a non-core table used by the extension." }, "table7": { "description": "Name of a non-core table used by the extension." }, "table8": { "description": "Name of a non-core table used by the extension." }, "table9": { "description": "Name of a non-core table used by the extension." }, "table10": { "description": "Name of a non-core table used by the extension." }, "download": { "description": "Link to the download." }, "readme": { "description": "external link to the readme file" }, "changelog": { "description": "external link to the changelog file" }, "example": { "description": "example, website or screenshot of working extension" }, "namespace": { "description": "namespace in which this extension is used" }, "parameters": { "description": "available parameters for LocalSettings.php" }, "tags": { "description": "any tags your extension uses" }, "rights": { "description": "Rights added by the extension. Not to be confused with the license!" }, "hook1": { "description": "Name of a hook used by the extension." }, "hook2": { "description": "Name of a hook used by the extension." }, "hook3": { "description": "Name of a hook used by the extension." "description": "Name of a hook used by the extension." "description": "Name of a hook used by the extension." "description": "Name of a hook used by the extension." "description": "Name of a hook used by the extension." "description": "Name of a hook used by the extension." "description": "Name of a hook used by the extension." "description": "Name of a hook used by the extension." "description": "Name of a hook used by the extension." "description": "Name of a hook used by the extension. "description": "Name of a hook used by the extension." "description": "Name of a hook used by the extension." "description": "Name of a hook used by the extension." "description": "Name of a hook used by the extension." "description": "Name of a hook used by the extension." "description": "Name of a hook used by the extension." "description": "Name of a hook used by the extension." "description": "Name of a hook used by the extension." "description": "Name of a hook "description": "Name of a hook used by the "description": "Name of a hook used by the e "description": "Name of a hook used by the extension. "description": "Name of a hook used by the extension. "description": "Name of a hook used by the "Name of a hook used by the extension." "descriptionName of a hook of a hook used by the extension." }, "description": "Name of a hook used by the extension." }, "description": "Name of a hook used by the extension." }, "hook35": { "description": "Name of a hook used by the extension." }, "hook36": { "description": "Name of a hook used by the extension." }, "hook37": { "description": "Name of a hook used by the extension." }, "hook38": { "description": "Name of a hook used by the extension." }, "hook39": { "description": "Name of a hook used by the extension." }, "hook40": { "description": "Name of a hook used by the extension." }, "hook41": { "description": "Name of a hook used by the extension." }, "hook42": { "description": "Name of a hook used by the extension." }, "hook43": { "description": "Name of a hook used by the extension." "description": "Name of a hook used by the extension." "description": "Name of a hook used by the extension." description": "Name of a hook used by the extension." } "description": "Name of a hook used by the extension." "description": "Name of a hook used by the extension." }, "": { "description": "Name of a hook provided by the extension." }, "": { "description": "Name of a hook provided by the extension." }, "": { "Name of a hook provided by the extension." }, "": { "description": "Name of a hook provided by the extension." }, "": { "description": "Name of a hook provided by the extension." }, "": { "description": "Name of a hook provided by the extension." }, "": { "description": "Name of a hook provided by the extension." }, "": { "description": "Name of a hook provided by the extension." }, "": { "description": "Name ": "Name of a hook provided by the extension." }, "": { "description": "Name of a hook provided by the extension." }, "": { "description": "Name of a hook provided by the extension." }, "": { "description": "Name of a hook provided by the extension." }, "{ "description": "Name of a hook provided by the extension." "description": "Name of a hook provided by the extension." }, "": { "description": "Name of a hook provided by the extension." }, " { "description": "Name of a hook provided by the extension." }, "": { "description": "Name of a hook provided by the extension." }, "": { "description": "Name of a hook provided by the extension." }, "": { "description": "Name of a hook provided by the extension." }, "": { "description": "Name of a hook provided by the extension." }, "": { "description": "Name of a hook provided by the extension." }, "": { "description": "Name of a hook provided by the extension." }, "": { "description": "Name of a hook provided by the extension." }, "": { "description": "Name of a hook provided by the extension." }, "": { "description": "Name of a hook provided by the extension." }, "": { "description": "Name of a hook provided by the extension." }, "": { "description": "Name of a hook provided by the extension." }, "": { "description": "Name of a hook provided by the extension." }, "": { "description": "Name of a hook provided by the extension." }, "": { "description": "Name of a hook provided by the extension." }, "": { "description": "Name of a hook provided by the extension." }, "": { "description": "Name of a hook provided by the extension." }, "": { "description": "Name of a hook provided by the extension." }, "": { "description": "Name of a hook provided by the extension." }, "": { "description": "Name of a hook provided by the extension." }, "": { "description": "Name of a hook provided by the extension." }, "": { "description": "Name of a hook provided by the ext