Difference between revisions of "Template:Extension/doc"
>Shirayuki m (Protected "Template:Extension/doc": Excessive vandalism ([Edit=Allow only autoconfirmed users] (expires 02:22, 7 January 2019 (UTC)) [Move=Allow only autoconfirmed users] (expires 02:22, 7 January 2019 (UTC)))) |
>Tgr (WMF) (link to backlog for compatibility policy parameter) |
||
Line 2: | Line 2: | ||
<!----> | <!----> | ||
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{{ | 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{{translation}}]], along with the appropriate [[:Category:Extensions by status{{translation}}|status]] and [[:Category:Extensions by implementation type{{translation}}|implementation type]] categories. | ||
== Usage == | == Usage == | ||
Line 13: | Line 13: | ||
| align="left" | | | align="left" | | ||
<span id="CutAndPaste">Copy and paste:</span> | <span id="CutAndPaste">Copy and paste:</span> | ||
<pre>{{ | <pre>{{ {{TNTN|Extension}} |templatemode = | ||
|name = | |name = | ||
|status = | |status = | ||
Line 22: | Line 22: | ||
|newhook1 = | |newhook1 = | ||
|newhook2 = | |newhook2 = | ||
|username = | |username = | ||
|author = | |author = | ||
|description = | |description = | ||
|image = | |image = | ||
Line 62: | Line 60: | ||
|type1 = {{{type1}}} | |type1 = {{{type1}}} | ||
|type2 = {{{type2}}} | |type2 = {{{type2}}} | ||
|hook1 = | |hook1 = hook1 | ||
|hook2 = | |hook2 = hook2 | ||
|newhook1 = | |newhook1 = newhook1 | ||
|newhook2 = | |newhook2 = newhook2 | ||
|username = SomeUser | |username = SomeUser | ||
|author = SomeAuthor | |author = SomeAuthor | ||
|image = Placeholder.png | |image = Placeholder.png | ||
|version = {{{version}}} | |version = {{{version}}} | ||
Line 121: | Line 117: | ||
|<span id="status">'''status'''</span> || '''current release status''' | |<span id="status">'''status'''</span> || '''current release status''' | ||
One of: | One of: | ||
* ''[[:Category:Unstable extensions{{ | * ''[[:Category:Unstable extensions{{translation}}|unstable]]'' (broken - do not use this extension) | ||
* ''[[:Category:Experimental extensions{{ | * ''[[:Category:Experimental extensions{{translation}}|experimental]]'' (early stages of development, may change drastically) | ||
* ''[[:Category:Beta status extensions{{ | * ''[[:Category:Beta status extensions{{translation}}|beta]]'' (stable but not fully tested) | ||
* ''[[:Category:Stable extensions{{ | * ''[[:Category:Stable extensions{{translation}}|stable]]'' (stable version) | ||
* ''[[:Category:Not LTS ready{{ | * ''[[:Category:Not LTS ready{{translation}}|unmaintained]]'' (unmaintained - previously claimed to be stable, now unmaintained) | ||
* ''[[:Category:Archived extensions{{ | * ''[[:Category:Archived extensions{{translation}}|archive]]'' (archived - deprecated or merged with another extension) | ||
* ''[[:Category:Extensions with unknown status{{ | * ''[[:Category:Extensions with unknown status{{translation}}|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 categorized as [[:category:extensions with unknown status|unknown]]. In cases where the value is invalid, it will be placed in a [[:category:extensions with invalid status|special category]] so that the error can be caught and fixed. | 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 categorized as [[:category:extensions with unknown status|unknown]]. In cases where the value is invalid, it will be placed in a [[:category:extensions with invalid status|special category]] so that the error can be caught and fixed. | ||
* [[Extension status|release status colour scheme]] | * [[Extension status|release status colour scheme]] | ||
Line 137: | Line 133: | ||
Legal values for the '''type1''', '''type2''', ... parameters are: | Legal values for the '''type1''', '''type2''', ... parameters are: | ||
* '''''[[:Category:Parser extensions{{ | * '''''[[:Category:Parser extensions{{translation}}|parser]]''''' - catchall for uncategorized [[Special:MyLanguage/Manual:Extending wiki markup|parser extensions]]. If you have written a parser extension, please use one of the following more specific types: | ||
** ''[[:Category:ContentHandler extensions{{ | ** ''[[:Category:ContentHandler extensions{{translation}}|contenthandler]]'' - Extensions using [[Special:MyLanguage/Manual:ContentHandler|ContentHandler]]. | ||
** ''[[:Category:Link markup extensions{{ | ** ''[[:Category:Link markup extensions{{translation}}|link]]'' - customized [[Special:MyLanguage/Manual:Extending wiki markup|link markup]], e.g. <code><nowiki>[[</nowiki>...]]</code> | ||
** ''[[:Category:Parser function extensions{{ | ** ''[[:Category:Parser function extensions{{translation}}|parser function]]'' - custom [[Special:MyLanguage/Manual:Parser functions|parameterized template markup]], e.g. <code><nowiki>{{</nowiki>''#name:'' ... }}</code> | ||
** ''[[:Category:Tag extensions{{ | ** ''[[:Category:Tag extensions{{translation}}|tag]]'' - [[Special:MyLanguage/Manual:Tag extensions|custom XML tag markup]], e.g. <code><nowiki><</nowiki>''tagname''>...<nowiki></</nowiki>''tagname''></code> | ||
** ''[[:Category:Variable extensions{{ | ** ''[[:Category:Variable extensions{{translation}}|variable]]'' - custom [[Special:MyLanguage/Manual:Variables|unparameterized template markup]], e.g. <code><nowiki>{{NAME}}</nowiki></code> | ||
** ''[[:Category:Extended syntax extensions{{ | ** ''[[:Category:Extended syntax extensions{{translation}}|extended syntax]]'' - Extensions that add non-standard wiki syntax (i.e. <em>not</em> [[Special:MyLanguage/Manual:Tag extensions|tags]], [[Special:MyLanguage/Manual:Parser functions|parser functions]], or [[Special:MyLanguage/Manual:Variables|variables]]). | ||
*: | *: | ||
* [[:Category:User access extensions{{ | * [[:Category:User access extensions{{translation}}|'''''access''''']] - catchall for [[Special:MyLanguage/Manual:User access extensions|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 extensions{{ | ** [[:Category:User activity extensions{{translation}}|''user activity'']] - extensions that monitor user activity (logins, logouts, new user creation, etc.) | ||
** [[:Category:User identity extensions{{ | ** [[:Category:User identity extensions{{translation}}|''user identity'']] - extensions that create and delete users, and/or verify the identity of a user | ||
** [[:Category:User rights extensions{{ | ** [[:Category:User rights extensions{{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|rights parameter]]) | ||
* [[:Category:User interface extensions{{ | * [[:Category:User interface extensions{{translation}}|'''''interface''''']] - catchall for uncategorized user interface extensions. | ||
** ''[[:Category:Media handling extensions{{ | ** ''[[:Category:Media handling extensions{{translation}}|media]]'' - extensions that permit the embedding of multimedia content on wiki pages by registering a file extension with [[Special:MyLanguage/Manual:$wgMediaHandlers|$wgMediaHandlers]]. | ||
** ''[[:Category:Personalization extensions{{ | ** ''[[:Category:Personalization extensions{{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 extensions{{ | ** [[:Category:Notification extensions{{translation}}|''notify'']] - extensions that email users, broadcast messages and provide other forms of community notification | ||
** ''[[:Category:Page action extensions{{ | ** ''[[:Category:Page action extensions{{translation}}|''page action'']]'' - extensions that enhance or modify [[Special:MyLanguage/Manual:Page action|page action]]s. 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 extensions{{ | ** [[:Category:Search extensions{{translation}}|''search'']] - extensions that search through and select articles for users. | ||
** [[:Category:Skin extensions{{ | ** [[:Category:Skin extensions{{translation}}|''skin'']] - extensions adding [[w:CSS|CSS]] or [[w:JavaScript|JavaScript]], or implementing hook functions to change the look and feel of MediaWiki via the skins framework. | ||
** [[:Category:Ajax extensions{{ | ** [[:Category:Ajax extensions{{translation}}|''ajax'']] - extensions that use [[w:Ajax|Ajax]] programming techniques. | ||
** [[:Category:Special page extensions{{ | ** [[:Category:Special page extensions{{translation}}|''special'']] - extensions that subclass the {{Class doclink|SpecialPage}} class, use one of its hooks, or patch one or more functions in {{Git file|file=includes/specialpage/SpecialPage.php|text=SpecialPage.php}}. See [[Special:MyLanguage/Manual:Special pages]] for more information. | ||
* '''other''' | * '''other''' | ||
** [[:Category:API extensions{{ | ** [[:Category:API extensions{{translation}}|''api'']] - extensions that add a new API module or extend a core API module. | ||
** [[:Category:Hook extensions{{ | ** [[:Category:Hook extensions{{translation}}|''hook'']] - Hook extension - defines a <em>new</em> hook - see hook1, etc. below if you want to define hooks <em>used</em> by your extension | ||
** [[:Category:Database extensions{{ | ** [[:Category:Database extensions{{translation}}|''database'']] - adds tables and/or fields to the database backing a MediaWiki installation | ||
** [[:Category:Data extraction extensions{{ | ** [[:Category:Data extraction extensions{{translation}}|''data extraction'']] - Data extraction | ||
** [[:Category:File repository extensions{{ | ** [[:Category:File repository extensions{{translation}}|''filerepo'']] - extension that adds new file repository types as file backend | ||
** [[:Category:Extension examples{{ | ** [[:Category:Extension examples{{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 type{{ | 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 <code><nowiki>|type=</nowiki></code> with <code><nowiki>|type1=|type2=|type3=...</nowiki></code>. You may define up to six types for an extension. | Note: Many extensions have more than one type, if this applies to yours, replace <code><nowiki>|type=</nowiki></code> with <code><nowiki>|type1=|type2=|type3=...</nowiki></code>. You may define up to six types for an extension. | ||
Line 187: | Line 183: | ||
You might also want to add the hooks to [[Extension hook registry]]. | You might also want to add the hooks to [[Extension hook registry]]. | ||
|- | |- | ||
| <span id="username">'''username'''</span> || 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 <nowiki>[[]]</nowiki>s. | | <span id="username">'''username'''</span> || 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 <nowiki>[[]]</nowiki>s. | ||
|- | |- | ||
| <span id="author">author</span>|| 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). | | <span id="author">author</span>|| 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). | ||
|- | |- | ||
| <span id="description">'''description'''</span>|| '''short description''' | | <span id="description">'''description'''</span>|| '''short description''' | ||
Line 200: | Line 192: | ||
| <span id="image">image</span>|| screenshot or logo of extension. It should be provided without namespace and without <nowiki>[[]]</nowiki>s. | | <span id="image">image</span>|| screenshot or logo of extension. It should be provided without namespace and without <nowiki>[[]]</nowiki>s. | ||
|- | |- | ||
| <span id="imagesize">imagesize</span>|| ''facultative'', size of the image (default size is | | <span id="imagesize">imagesize</span>|| ''facultative'', size of the image (default size is 220px) | ||
|- | |- | ||
| <span id="version">version</span>|| last version | | <span id="version">version</span>|| last version | ||
Line 206: | Line 198: | ||
| <span id="update">update</span>|| date of the last update | | <span id="update">update</span>|| date of the last update | ||
|- | |- | ||
| <span id="compatibility_policy">compatibility policy</span>|| {{ll|Compatibility#mediawiki_extensions|compatibility policy}} (accepted values are '''master''' and '''rel''') | | <span id="compatibility_policy">compatibility policy</span>|| {{ll|Compatibility#mediawiki_extensions|compatibility policy}} (accepted values are '''master''' and '''rel'''). ([[:Category:Extensions without a compatibility policy|backlog]]) | ||
|- | |- | ||
| <span id="mediawiki">mediawiki</span>|| required version of MediaWiki | | <span id="mediawiki">mediawiki</span>|| required version of MediaWiki | ||
Line 273: | Line 265: | ||
If this is left blank, this template will add the host page to [[:Category:All extensions{{ | 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|Content parameters]]. | ||
|} | |} | ||
Line 348: | Line 340: | ||
"templatemode": { | "templatemode": { | ||
"description": "Controls auto-categorization of host page. Normally left blank. Alternate values are: nocats, nousage.", | "description": "Controls auto-categorization of host page. Normally left blank. Alternate values are: nocats, nousage.", | ||
"label": " | "label": "Mode" | ||
}, | }, | ||
"image": { | "image": { | ||
Line 356: | Line 347: | ||
}, | }, | ||
"imagesize": { | "imagesize": { | ||
"description": " | "description": "Facultative, size of the image (default size is 220px)" | ||
}, | }, | ||
"type": { | "type": { | ||
Line 378: | Line 367: | ||
"type4": { | "type4": { | ||
"description": "Implementation type. See detailed doc.", | "description": "Implementation type. See detailed doc.", | ||
"label": " | "label": "Quaternary type" | ||
}, | }, | ||
"type5": { | "type5": { | ||
"description": "Implementation type. See detailed doc.", | "description": "Implementation type. See detailed doc.", | ||
"label": " | "label": "Quinary type" | ||
}, | }, | ||
"type6": { | "type6": { | ||
Line 396: | Line 385: | ||
"username": { | "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." | "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": { | "version": { | ||
Line 407: | Line 393: | ||
}, | }, | ||
"update": { | "update": { | ||
"description": " | "description": "date of the last update" | ||
}, | |||
"version preview": { | |||
"description": "version preview" | |||
" | |||
}, | }, | ||
"update preview": { | "update preview": { | ||
" | "description": "version preview" | ||
}, | }, | ||
"mediawiki": { | "mediawiki": { | ||
Line 433: | Line 417: | ||
"example": "MediaWiki-extensions-Babel", | "example": "MediaWiki-extensions-Babel", | ||
"type": "string", | "type": "string", | ||
"suggested": true | "suggested": true | ||
}, | }, | ||
"table1": { | "table1": { | ||
Line 467: | Line 450: | ||
}, | }, | ||
"download": { | "download": { | ||
"description": "Link to the download | "description": "Link to the download." | ||
}, | }, | ||
"readme": { | "readme": { | ||
"description": " | "description": "external link to the readme file" | ||
}, | }, | ||
"changelog": { | "changelog": { | ||
Line 480: | Line 459: | ||
}, | }, | ||
"example": { | "example": { | ||
"description": "example, website or screenshot of working extension | "description": "example, website or screenshot of working extension" | ||
}, | }, | ||
"namespace": { | "namespace": { | ||
Line 784: | Line 762: | ||
}, | }, | ||
"compatibility": { | "compatibility": { | ||
"description": "Compatibility chart, e.g. Template:Extension Testing. | "description": "Compatibility chart, e.g. Template:Extension Testing." | ||
}, | }, | ||
"translate": { | "translate": { | ||
Line 792: | Line 769: | ||
"bugzilla": { | "bugzilla": { | ||
"description": "Bugzilla MediaWiki extension component name", | "description": "Bugzilla MediaWiki extension component name", | ||
"deprecated": true | "deprecated": true | ||
}, | }, | ||
"vagrant-role": { | "vagrant-role": { | ||
Line 800: | Line 776: | ||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "latest release date": {}, | ||
"latest_release_date": {}, | |||
"latest preview version": {}, | |||
}, | "latest_peview_version": {}, | ||
" | "version_preview": {}, | ||
"latest_preview_version": {}, | |||
"update_preview": {}, | |||
}, | "!": {}, | ||
"nousage": {}, | |||
"CheckUsageNameOverride": {}, | |||
"compatibility policy": { | "compatibility policy": { | ||
"description": "For older versions of MediaWiki, should one use the extension's master brunch or the REL1_XX branch corresponding to the MediaWiki version? Allowed values: master, rel", | "description": "For older versions of MediaWiki, should one use the extension's master brunch or the REL1_XX branch corresponding to the MediaWiki version? Allowed values: master, rel", | ||
"type": "string", | "type": "string", | ||
"suggested": true | "suggested": true | ||
} | } | ||
}, | }, | ||
"format": " | "format": "block", | ||
"paramOrder": [ | "paramOrder": [ | ||
"status", | |||
"name", | "name", | ||
" | "license", | ||
"templatemode", | |||
"image", | |||
"imagesize", | |||
"type", | "type", | ||
"type1", | "type1", | ||
Line 831: | Line 806: | ||
"type4", | "type4", | ||
"type5", | "type5", | ||
"type6", | |||
"description", | |||
"author", | |||
"username", | |||
"version", | |||
"update", | |||
"version preview", | |||
"update preview", | |||
"compatibility policy", | |||
"mediawiki", | |||
"php", | |||
"needs-updatephp", | |||
"composer", | |||
"phabricator", | |||
"table1", | |||
"table2", | |||
"table3", | |||
"table4", | |||
"table5", | |||
"table6", | |||
"table7", | |||
"table8", | |||
"table9", | |||
"table10", | |||
"download", | |||
"readme", | |||
"changelog", | |||
"example", | |||
"namespace", | |||
"parameters", | |||
"tags", | |||
"rights", | |||
"hook1", | "hook1", | ||
"hook2", | "hook2", | ||
Line 927: | Line 934: | ||
"newhook47", | "newhook47", | ||
"newhook48", | "newhook48", | ||
"compatibility", | "compatibility", | ||
"translate", | |||
"bugzilla", | "bugzilla", | ||
"vagrant-role", | "vagrant-role", | ||
" | "latest release date", | ||
" | "latest_release_date", | ||
"latest preview version", | |||
"latest_peview_version", | |||
"version_preview", | |||
"latest_preview_version", | |||
"update_preview", | |||
"!", | |||
"nousage", | "nousage", | ||
" | "CheckUsageNameOverride" | ||
] | ] | ||
} | } | ||
</templatedata> | </templatedata> |
Revision as of 02:54, 20 January 2018
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: {{ {{TNTN|Extension}} |templatemode = |name = |status = |type1 = |type2 = |hook1 = |hook2 = |newhook1 = |newhook2 = |username = |author = |description = |image = |imagesize = |version = |update = |version preview = |update preview = |compatibility policy = |mediawiki = |php = |needs-updatephp = |composer = |table1 = |table2 = |license = |download = |readme = |changelog = |example = |namespace = |parameters = |tags = |rights = |compatibility = |bugzilla = |phabricator = |vagrant-role = }} For help with parameter values, see below. |
Lua error: callParserFunction: function "#translation" was not found.
|
Content parameters
This section describes parameters that govern infobox content. For help with templatemode and other control parameters, please see Control parameters.
Parameter | Description |
---|---|
name | name of the extension |
status | current release status
One of:
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 categorized 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. |
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.
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 |
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:
For custom hooks defined by extensions:
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. |
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 |
compatibility policy | compatibility policy (accepted values are master and rel). (backlog) |
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 php $IP/maintenance/update.php |
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 |
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:
|
bugzilla | Bugzilla MediaWiki extension component name |
phabricator | Phabricator project name |
CheckUsageNameOverride | override the page name used for the check usage link. |
Control parameters
Parameter | Description |
---|---|
templatemode | Controls auto-categorization of host page.
Normally left blank. Alternate values are:
|
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.
TemplateData
An infobox for a MediaWiki extension.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Status | status | Current release status. One of: unstable, experimental, beta, stable, unmaintained, unknown.
| String | optional |
Name | name | name of the extension | String | optional |
License | license | Extension's license. | String | optional |
Mode | templatemode | Controls auto-categorization of host page. Normally left blank. Alternate values are: nocats, nousage. | Unknown | optional |
Screenshot or logo | image | Screenshot or logo of extension. It should be provided without namespace and without [[]]s. | Unknown | optional |
imagesize | imagesize | Facultative, size of the image (default size is 220px) | Unknown | optional |
Primary type | type | Implementation type. See detailed doc. | Unknown | optional |
Secondary type | type1 | Implementation type. See detailed doc. | Unknown | optional |
Tertiary type | type2 | Implementation type. See detailed doc. | Unknown | optional |
Quaternary type | type3 | Implementation type. See detailed doc. | Unknown | optional |
Quaternary type | type4 | Implementation type. See detailed doc. | Unknown | optional |
Quinary type | type5 | Implementation type. See detailed doc. | Unknown | optional |
Senary type | type6 | Implementation type. See detailed doc. | Unknown | optional |
description | description | Short description. | Unknown | optional |
author | 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). | Unknown | optional |
username | 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. | Unknown | optional |
version | version latest release version latest_release_version | no description | Unknown | optional |
update | update | date of the last update | Unknown | optional |
version preview | version preview | version preview | Unknown | optional |
update preview | update preview | version preview | Unknown | optional |
compatibility policy | compatibility policy | For older versions of MediaWiki, should one use the extension's master brunch or the REL1_XX branch corresponding to the MediaWiki version? Allowed values: master, rel | String | suggested |
mediawiki | mediawiki | Required version of MediaWiki | Unknown | optional |
php | php | Required version of PHP | Unknown | optional |
needs-updatephp | 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. | Unknown | optional |
composer | 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. | Unknown | optional |
phabricator | phabricator | Phabricator project name
| String | suggested |
table1 | table1 | Name of a non-core table used by the extension. | Unknown | optional |
table2 | table2 | Name of a non-core table used by the extension. | Unknown | optional |
table3 | table3 | Name of a non-core table used by the extension. | Unknown | optional |
table4 | table4 | Name of a non-core table used by the extension. | Unknown | optional |
table5 | table5 | Name of a non-core table used by the extension. | Unknown | optional |
table6 | table6 | Name of a non-core table used by the extension. | Unknown | optional |
table7 | table7 | Name of a non-core table used by the extension. | Unknown | optional |
table8 | table8 | Name of a non-core table used by the extension. | Unknown | optional |
table9 | table9 | Name of a non-core table used by the extension. | Unknown | optional |
table10 | table10 | Name of a non-core table used by the extension. | Unknown | optional |
download | download | Link to the download. | Unknown | optional |
readme | readme | external link to the readme file | Unknown | optional |
changelog | changelog | external link to the changelog file | Unknown | optional |
example | example | example, website or screenshot of working extension | Unknown | optional |
namespace | namespace | namespace in which this extension is used | Unknown | optional |
parameters | parameters | available parameters for LocalSettings.php | Unknown | optional |
tags | tags | any tags your extension uses | Unknown | optional |
rights | rights | Rights added by the extension. Not to be confused with the license! | Unknown | optional |
hook1 | hook1 | Name of a hook used by the extension. | Unknown | optional |
hook2 | hook2 | Name of a hook used by the extension. | Unknown | optional |
hook3 | hook3 | Name of a hook used by the extension. | Unknown | optional |
hook4 | hook4 | Name of a hook used by the extension. | Unknown | optional |
hook5 | hook5 | Name of a hook used by the extension. | Unknown | optional |
hook6 | hook6 | Name of a hook used by the extension. | Unknown | optional |
hook7 | hook7 | Name of a hook used by the extension. | Unknown | optional |
hook8 | hook8 | Name of a hook used by the extension. | Unknown | optional |
hook9 | hook9 | Name of a hook used by the extension. | Unknown | optional |
hook10 | hook10 | Name of a hook used by the extension. | Unknown | optional |
hook11 | hook11 | Name of a hook used by the extension. | Unknown | optional |
hook12 | hook12 | Name of a hook used by the extension. | Unknown | optional |
hook13 | hook13 | Name of a hook used by the extension. | Unknown | optional |
hook14 | hook14 | Name of a hook used by the extension. | Unknown | optional |
hook15 | hook15 | Name of a hook used by the extension. | Unknown | optional |
hook16 | hook16 | Name of a hook used by the extension. | Unknown | optional |
hook17 | hook17 | Name of a hook used by the extension. | Unknown | optional |
hook18 | hook18 | Name of a hook used by the extension. | Unknown | optional |
hook19 | hook19 | Name of a hook used by the extension. | Unknown | optional |
hook20 | hook20 | Name of a hook used by the extension. | Unknown | optional |
hook21 | hook21 | Name of a hook used by the extension. | Unknown | optional |
hook22 | hook22 | Name of a hook used by the extension. | Unknown | optional |
hook23 | hook23 | Name of a hook used by the extension. | Unknown | optional |
hook24 | hook24 | Name of a hook used by the extension. | Unknown | optional |
hook25 | hook25 | Name of a hook used by the extension. | Unknown | optional |
hook26 | hook26 | Name of a hook used by the extension. | Unknown | optional |
hook27 | hook27 | Name of a hook used by the extension. | Unknown | optional |
hook28 | hook28 | Name of a hook used by the extension. | Unknown | optional |
hook29 | hook29 | Name of a hook used by the extension. | Unknown | optional |
hook30 | hook30 | Name of a hook used by the extension. | Unknown | optional |
hook31 | hook31 | Name of a hook used by the extension. | Unknown | optional |
hook32 | hook32 | Name of a hook used by the extension. | Unknown | optional |
hook33 | hook33 | Name of a hook used by the extension. | Unknown | optional |
hook34 | hook34 | Name of a hook used by the extension. | Unknown | optional |
hook35 | hook35 | Name of a hook used by the extension. | Unknown | optional |
hook36 | hook36 | Name of a hook used by the extension. | Unknown | optional |
hook37 | hook37 | Name of a hook used by the extension. | Unknown | optional |
hook38 | hook38 | Name of a hook used by the extension. | Unknown | optional |
hook39 | hook39 | Name of a hook used by the extension. | Unknown | optional |
hook40 | hook40 | Name of a hook used by the extension. | Unknown | optional |
hook41 | hook41 | Name of a hook used by the extension. | Unknown | optional |
hook42 | hook42 | Name of a hook used by the extension. | Unknown | optional |
hook43 | hook43 | Name of a hook used by the extension. | Unknown | optional |
hook44 | hook44 | Name of a hook used by the extension. | Unknown | optional |
hook45 | hook45 | Name of a hook used by the extension. | Unknown | optional |
hook46 | hook46 | Name of a hook used by the extension. | Unknown | optional |
hook47 | hook47 | Name of a hook used by the extension. | Unknown | optional |
hook48 | hook48 | Name of a hook used by the extension. | Unknown | optional |
newhook1 | newhook1 | Name of a hook provided by the extension. | Unknown | optional |
newhook2 | newhook2 | Name of a hook provided by the extension. | Unknown | optional |
newhook3 | newhook3 | Name of a hook provided by the extension. | Unknown | optional |
newhook4 | newhook4 | Name of a hook provided by the extension. | Unknown | optional |
newhook5 | newhook5 | Name of a hook provided by the extension. | Unknown | optional |
newhook6 | newhook6 | Name of a hook provided by the extension. | Unknown | optional |
newhook7 | newhook7 | Name of a hook provided by the extension. | Unknown | optional |
newhook8 | newhook8 | Name of a hook provided by the extension. | Unknown | optional |
newhook9 | newhook9 | Name of a hook provided by the extension. | Unknown | optional |
newhook10 | newhook10 | Name of a hook provided by the extension. | Unknown | optional |
newhook11 | newhook11 | Name of a hook provided by the extension. | Unknown | optional |
newhook12 | newhook12 | Name of a hook provided by the extension. | Unknown | optional |
newhook13 | newhook13 | Name of a hook provided by the extension. | Unknown | optional |
newhook14 | newhook14 | Name of a hook provided by the extension. | Unknown | optional |
newhook15 | newhook15 | Name of a hook provided by the extension. | Unknown | optional |
newhook16 | newhook16 | Name of a hook provided by the extension. | Unknown | optional |
newhook17 | newhook17 | Name of a hook provided by the extension. | Unknown | optional |
newhook18 | newhook18 | Name of a hook provided by the extension. | Unknown | optional |
newhook19 | newhook19 | Name of a hook provided by the extension. | Unknown | optional |
newhook20 | newhook20 | Name of a hook provided by the extension. | Unknown | optional |
newhook21 | newhook21 | Name of a hook provided by the extension. | Unknown | optional |
newhook22 | newhook22 | Name of a hook provided by the extension. | Unknown | optional |
newhook23 | newhook23 | Name of a hook provided by the extension. | Unknown | optional |
newhook24 | newhook24 | Name of a hook provided by the extension. | Unknown | optional |
newhook25 | newhook25 | Name of a hook provided by the extension. | Unknown | optional |
newhook26 | newhook26 | Name of a hook provided by the extension. | Unknown | optional |
newhook27 | newhook27 | Name of a hook provided by the extension. | Unknown | optional |
newhook28 | newhook28 | Name of a hook provided by the extension. | Unknown | optional |
newhook29 | newhook29 | Name of a hook provided by the extension. | Unknown | optional |
newhook30 | newhook30 | Name of a hook provided by the extension. | Unknown | optional |
newhook31 | newhook31 | Name of a hook provided by the extension. | Unknown | optional |
newhook32 | newhook32 | Name of a hook provided by the extension. | Unknown | optional |
newhook33 | newhook33 | Name of a hook provided by the extension. | Unknown | optional |
newhook34 | newhook34 | Name of a hook provided by the extension. | Unknown | optional |
newhook35 | newhook35 | Name of a hook provided by the extension. | Unknown | optional |
newhook36 | newhook36 | Name of a hook provided by the extension. | Unknown | optional |
newhook37 | newhook37 | Name of a hook provided by the extension. | Unknown | optional |
newhook38 | newhook38 | Name of a hook provided by the extension. | Unknown | optional |
newhook39 | newhook39 | Name of a hook provided by the extension. | Unknown | optional |
newhook40 | newhook40 | Name of a hook provided by the extension. | Unknown | optional |
newhook41 | newhook41 | Name of a hook provided by the extension. | Unknown | optional |
newhook42 | newhook42 | Name of a hook provided by the extension. | Unknown | optional |
newhook43 | newhook43 | Name of a hook provided by the extension. | Unknown | optional |
newhook44 | newhook44 | Name of a hook provided by the extension. | Unknown | optional |
newhook45 | newhook45 | Name of a hook provided by the extension. | Unknown | optional |
newhook46 | newhook46 | Name of a hook provided by the extension. | Unknown | optional |
newhook47 | newhook47 | Name of a hook provided by the extension. | Unknown | optional |
newhook48 | newhook48 | Name of a hook provided by the extension. | Unknown | optional |
compatibility | compatibility | Compatibility chart, e.g. Template:Extension Testing. | Unknown | optional |
translate | translate | Optional parameter to link the exact page where (message group id with which) the extension will be translatable on translatewiki.net if enabled. | Unknown | optional |
bugzilla | bugzilla | Bugzilla MediaWiki extension component name | Unknown | deprecated |
Vagrant role | vagrant-role | A MediaWiki-Vagrant role that lets you use this extension, if present | String | optional |
latest release date | latest release date | no description | Unknown | optional |
latest_release_date | latest_release_date | no description | Unknown | optional |
latest preview version | latest preview version | no description | Unknown | optional |
latest_peview_version | latest_peview_version | no description | Unknown | optional |
version_preview | version_preview | no description | Unknown | optional |
latest_preview_version | latest_preview_version | no description | Unknown | optional |
update_preview | update_preview | no description | Unknown | optional |
! | ! | no description | Unknown | optional |
nousage | nousage | no description | Unknown | optional |
CheckUsageNameOverride | CheckUsageNameOverride | no description | Unknown | optional |