<translate> [[<tvar|1>Special:MyLanguage/Phabricator</>|Issue tracker]]:</translate> [[phab:tag/{{{phabricator}}}/|#{{{phabricator}}}]]

Difference between revisions of "Template:Extension"

From WPRDC Wiki
Jump to navigation Jump to search
>Patrick~mediawikiwiki
>Pppery
(Template was deleted ages ago)
 
(706 intermediate revisions by more than 100 users not shown)
Line 1: Line 1:
<includeonly>{{DEFAULTSORT:{{{name|{{PAGENAME}}}}}}}[[Category:Extensions]]</includeonly><div style="float: right; background-color: white; width: 292px;">
<noinclude>
{| class="ext-infobox ext-status-{{{status|unknown}}}"
<languages/>
|+ '''This is a [[:Category:Extensions|MediaWiki Extension]]'''
</noinclude><!--
|- class="ext-header"
--><templatestyles src="Template:Infobox/styles.css" /><!--
! colspan="2" style="padding-top: 0.5em;" | [[Image:{{#ifeq: {{{status|}}}|unstable|Crystal Clear app error.png|Crystal Clear action run.png}}|left|40px]] <span style="font-size: 130%;">{{{name|{{PAGENAME}}}}}</span><br>
--><templatestyles src="Template:Extension/styles.css" /><!--
Release status: {{#switch: {{{status}}}|unstable|experimental|beta|stable={{{status}}}|unknown}}
--><templatestyles src="Template:Extension/status.css" /><!--
|-
--><includeonly>{{#switch:<translate></translate>
{{#if:{{{image<includeonly>|</includeonly>}}}|
| =
<!-- -->{{!}} colspan="2" style="text-align: center;" {{!}} [[Image:{{{image<noinclude>|Placeholder.png</noinclude>}}}|270px]]
{{#ifeq:{{lc:{{{status}}}}}|unmaintained|{{#ifeq:{{NAMESPACE}}|Extension|{{#invoke:Extension|unmaintained}}}}}}
{{#if: {{{phabricator|{{{bugzilla|}}}}}} | {{Ptag|{{{phabricator|MediaWiki-extensions-{{{bugzilla|}}}}}}}} }}
<table class="infobox infobox-{{dir|{{pagelang}}}} ext-infobox ext-status-{{#switch: {{lc: {{{status|unknown}}} }}
|unmaintained|unstable|experimental|beta|stable={{lc: {{{status}}} }}
|#default=unknown
}}">
<caption>'''{{ll|Manual:Extensions|2=<translate><!--T:1--> MediaWiki extensions manual</translate>}}'''</caption>
<tr class="infobox-header ext-infobox-header">
<th colspan="2" style="padding-top: 0.5em;">[[File:{{#ifeq: {{lc: {{{status|}}} }} |unstable
|OOjs UI icon alert-invert.svg
|<!--else-->OOjs UI icon advanced{{#ifeq:{{{status}}}|beta||-invert}}.svg
}}|link=Special:MyLanguage/Template:Extension#Content|{{dir|{{pagelang}}|right|left}}|40px]] <span style="font-size: 130%; line-height: 100%;">{{#if:{{{name|}}}|{{{name}}}|{{PAGENAME:{{translatable}}}}}}</span><br />
{{ll|Extension status|2=<translate><!--T:2--> Release status:</translate>}} {{#switch: {{lc: {{{status|unknown}}} }}
  |unmaintained=<translate><!--T:3--> unmaintained</translate>
  |unstable=<translate><!--T:6--> unstable</translate>
  |experimental=<translate><!--T:7--> experimental</translate>
  |beta=<translate><!--T:8--> beta</translate>
  |stable=<translate><!--T:9--> stable</translate>
  |#default=<translate><!--T:11--> unknown</translate>
}}<!--
-->{{#ifeq:{{{templatemode|<noinclude>nocats</noinclude>}}}|nocats|<!-- do nothing -->|<!--else-->[[Category:{{#switch: {{lc:{{{status|}}} }}
|unstable|experimental|unmaintained|stable = {{{status}}} extensions
|beta = beta status extensions
|unknown = extensions with unknown status
|#default = extensions with invalid status
}}{{#translation:}}]]}}</th>
</tr>
{{#if:{{{image|}}}|
<tr>
<td colspan="2" style="text-align: center;">[[File:{{{image}}}|{{{imagesize|300}}}px]]</td>
</tr>
|{{#ifeq:{{{templatemode|<noinclude>nocats</noinclude>}}}|nocats|<!-- do nothing -->|<!--else-->{{#if:{{#translation:}}||[[Category:Extensions without an image]]}}}}
}}
}}
|-
{{#if:{{{type|}}}{{{type1|}}}|
{{#if:{{{type<includeonly>|</includeonly>}}}|
<tr>
<!-- -->{{!}} style="vertical-align: top" {{!}} '''Type:'''
<td style="min-width:7em">'''{{ll|Template:Extension#type|2=<translate><!--T:12--> Implementation</translate>}}'''</td>
<!-- -->{{!}} {{#switch: {{lc: {{{type}}}}}|special=Special Page[[Category:Special page extensions]]|pfunc=[[Extension:Parser function extension|Parser function]][[Category:Parser function extensions]]|parser=Parser extension[[Category:Parser extensions]]|parser,pfunc=Parser extension[[Category:Parser extensions]] and Parser function[[Category:Parser function extensions]]|hook=Hook[[Category:Hook extensions]]|interface=User interface[[Category:User interface extensions]]|{{{type}}}<includeonly>[[Category:Category to catch extensions with an unrecognised type]]</includeonly>}}
<td>{{#invoke:Extension|getTypes
|ajax            = <translate><!--T:94--> [[w:AJAX|Ajax]]</translate>
|api            = {{ll|API:Action API|2=<translate><!--T:95--> API</translate>}}
|beta feature    = {{ll|Beta Features|2=<translate><!--T:96--> Beta Feature</translate>}}
|contenthandler  = {{ll|Manual:ContentHandler|ContentHandler}}
|database        = {{ll|Manual:Database layout|2=<translate><!--T:97--> Database</translate>}}
|data extraction = <translate><!--T:98--> Data extraction</translate>
|example        = <translate><!--T:99--> Example</translate>
|extended syntax = {{ll|Manual:Extending wiki markup|2=<translate><!--T:100--> Extended syntax</translate>}}
|filerepo        = <translate><!--T:101--> File repository</translate>
|hook            = {{ll|Manual:Hooks|2=<translate><!--T:102--> Hook</translate>}}
|interface      = <translate><!--T:103--> User interface</translate>
|link            = {{ll|Manual:Extending wiki markup|2=<translate><!--T:104--> Link markup</translate>}}
|media          = <translate><!--T:105--> Media</translate>
|mywiki          = {{ll|Manual:Personalization|2=<translate><!--T:106--> MyWiki</translate>}}
|notify          = <translate><!--T:107--> Notify</translate>
|page action    = {{ll|Manual:Parameters to index.php#Actions|2=<translate><!--T:108--> Page action</translate>}}
|parser          = {{ll|Manual:Extending wiki markup|2=<translate><!--T:109--> Parser extension</translate>}}
|parser function = {{ll|Manual:Parser functions|2=<translate><!--T:110--> Parser function</translate>}}
|php            = <translate><!--T:111--> PHP</translate>
|search          = <translate><!--T:112--> Search</translate>
|skin            = {{ll|Manual:Skins|2=<translate><!--T:113--> Skin</translate>}}
|special page    = {{ll|Manual:Special pages|2=<translate><!--T:114--> Special page</translate>}}
|locale          = {{ll|Manual:Localization|2=<translate><!--T:115--> Locale</translate>}}
|tag            = {{ll|Manual:Tag extensions|2=<translate><!--T:116--> Tag</translate>}}
|user access    = {{ll|Manual:Security|2=<translate><!--T:117--> User access</translate>}}
|user identity  = {{ll|Manual:Security|2=<translate><!--T:118--> User identity</translate>}}
|user rights    = {{ll|Manual:Security|2=<translate><!--T:119--> User rights</translate>}}
|user activity  = {{ll|Manual:Security|2=<translate><!--T:120--> User activity</translate>}}
|variable        = {{ll|Manual:Variables|2=<translate><!--T:121--> Variable</translate>}}
}}<!--
-->|<!--else--><!--
  -->{{#ifeq:{{{templatemode|<noinclude>nocats</noinclude>}}}|nocats|<!--
      nothing
  -->|<!--else--><!--
      -->{{#invoke:Extension|getType|_missing_}}<!--
  -->}}<!--
--></td>
</tr>
}}
}}
|-
{{#if:{{{description|}}}|
| style="vertical-align: top" | '''Description:''' || {{{description}}}
<tr>
|-
<td>'''{{ll|Template:Extension#description|2=<translate><!--T:13--> Description</translate>}}'''</td>
{{#if:{{{author<includeonly>|</includeonly>}}}|
<td>{{{description}}}</td>
<!-- -->{{!}} style="vertical-align: top" {{!}} '''Author:'''
</tr>
<!-- -->{{!}} {{{author}}}
}}
}}
|-
{{#if:{{{author|}}}{{{username|}}} |
{{#if:{{{version<includeonly>|</includeonly>}}}|
<tr>
<!-- -->{{!}} style="vertical-align: top" {{!}} '''Version:'''
<td>'''{{ll|Template:Extension#username|2=<translate><!--T:14--> Author(s)</translate>}}'''</td>
<!-- -->{{!}} {{{version}}}{{#if:{{{update|}}}|&#160;({{{update}}})}}
<td>{{#if: {{{username|}}} |<!--
      -->{{#ifeq: {{{username}}}|{{{author|{{{username}}}<!-- -->}}}|<!--
        nothing
      -->|<!--else--><!--
        -->{{{author}}} (<!--
      -->}}<!--
      -->[[User:{{{username}}}|{{{username}}}]]<!--
      --><sup>[[User talk:{{{username}}}|{{int|talkpagelinktext}}]]</sup><!--
      -->{{#ifeq: {{{username}}}|{{{author|{{{username}}}<!-- -->}}}|<!--
        nothing
      -->|<!--else--><!--
        -->)<!--
      -->}}<!--
  -->|<!--else--><!--
      -->{{{author}}}<!--
  -->}}</td>
</tr>
}}
}}
|-
{{#if:{{{maintainer|}}} |
{{#if:{{{mediawiki<includeonly>|</includeonly>}}}|
<tr>
<!-- -->{{!}} style="vertical-align: top" {{!}} '''Mediawiki:'''
<td>'''{{ll|Template:Extension#maintainer|2=<translate><!--T:46--> Maintainer(s)</translate>}}'''</td>
<!-- -->{{!}} {{{mediawiki}}}
<td>{{#ifexist:User:{{{maintainer}}}|[[User:{{{maintainer}}}]]<sup>[[User talk:{{{maintainer}}}|{{int|talkpagelinktext}}]]</sup>|{{{maintainer}}}}}</td>
</tr>
}}
}}
|-
{{#if:{{#invoke:extension|getVersion|{{{latest release version|{{{latest_release_version|{{{version|}}}}}}}}}}}|
| style="vertical-align: top" | '''Download:''' || {{{download<includeonly>|''no link''</includeonly>}}}{{#if:{{{readme|}}}|<br />{{{readme}}}}}{{#if:{{{changelog|}}}|<br />{{{changelog}}}}}
<tr>
|-
<td>'''{{ll|Template:Extension#version|2=<translate><!--T:15--> Latest version</translate>}}'''</td>
{{#if:{{{parameters<includeonly>|</includeonly>}}}|
<td>{{#invoke:extension|getVersion|{{{latest release version|{{{latest_release_version|{{{version|}}}}}}}}}}}{{#if:{{{latest release date|{{{latest_release_date|{{{update|}}}}}}}}}|&#160;({{{latest release date|{{{latest_release_date|{{{update}}}}}}}}})}}</td>
<!-- -->{{!}} style="vertical-align: top" {{!}} '''Parameters:'''
</tr>
<!-- -->{{!}} {{{parameters}}}
}}
}}
|-
{{#if:{{{latest preview version|{{{latest_preview_version|{{{version_preview|{{{version preview|}}}}}}}}}}}}|
{{#if:{{{rights<includeonly>|</includeonly>}}}|
<tr>
<!-- -->{{!}} style="vertical-align: top" {{!}} '''Added rights:'''
<td>'''{{ll|Template:Extension#version|2=<translate><!--T:16--> Latest preview version</translate>}}'''</td>
<!-- -->{{!}} {{{rights}}}
<td>{{{latest preview version|{{{latest_preview_version|{{{version_preview|{{{version preview|}}}}}}}}}}}}{{#if:{{{latest preview date|{{{latest_preview_date|{{{update_preview|{{{update preview|}}}}}}}}}}}}|&#160;({{{latest preview date|{{{latest_preview_date|{{{update_preview|{{{update preview}}}}}}}}}}}})}}</td>
</tr>
}}
}}
|-
{{#if:{{{compatibility policy|}}}|
{{#if:{{{example<includeonly>|</includeonly>}}}|
<tr>
<!-- -->{{!}} style="vertical-align: top" {{!}} '''Example:'''
<td>'''{{ll|Compatibility#mediawiki_extensions|2=<translate><!--T:43--> Compatibility policy</translate>}}'''</td>
<!-- -->{{!}} {{{example}}}
<td>{{#switch:{{{compatibility policy}}}<!--
      -->|master=<translate><!--T:250--> Master maintains backward compatibility.</translate>{{#ifeq:{{{templatemode|<noinclude>nocats</noinclude>}}}|nocats|<!-- do nothing -->|<!--else-->{{#if:{{#translation:}}||[[Category:Extensions with master compatibility policy]]}}}}<!--
      -->|rel=<translate><!--T:251--> Snapshots releases along with MediaWiki.</translate> <translate><!--T:252--> Master is not backward compatible.</translate>{{#ifeq:{{{templatemode|<noinclude>nocats</noinclude>}}}|nocats|<!-- do nothing -->|<!--else-->{{#if:{{#translation:}}||[[Category:Extensions with release branches compatibility policy]]}}}}<!--
      -->|ltsrel= <translate><!--T:253--> Follows the [[<tvar name=1>Special:MyLanguage/Version lifecycle#Release policy</tvar>|MediaWiki version lifecycle]].</translate> <translate><!--T:254--> Master is not backward compatible.</translate>{{#ifeq:{{{templatemode|<noinclude>nocats</noinclude>}}}|nocats|<!-- do nothing -->|<!--else-->{{#if:{{#translation:}}||[[Category:Extensions with long-term support release branches compatibility policy]]}}}}<!--
      -->|#default=<span class="error"><translate><!--T:47--> invalid</translate></span>{{#ifeq:{{{templatemode|<noinclude>nocats</noinclude>}}}|nocats|<!-- do nothing -->|<!--else-->{{#if:{{#translation:}}||[[Category:Extensions without a compatibility policy]]}}}}<!--
      -->}}</td>
</tr>
|{{#ifeq:{{{templatemode|<noinclude>nocats</noinclude>}}}|nocats|<!-- do nothing -->|<!--else-->{{#if:{{#translation:}}||[[Category:Extensions without a compatibility policy]]}}}}
}}
}}
|}</div><noinclude>
<tr>
== Purpose ==
<td>{{ll|Template:Extension#mediawiki|'''MediaWiki'''}}</td>
This template should be added to the main page of all extensions documented on this wiki (and only the main page). It will add a useful infobox using the information supplied (see below) and will automatically add the extension to [[:Category:Extensions]].
<td>{{#invoke:Extension |getMediaWikiRequirement |{{{mediawiki|}}} }}</td>
</tr>
{{#if:{{{php|}}}|
<tr>
<td>{{ll|Template:Extension#php|'''PHP'''}}</td>
<td>{{{php}}}</td>
</tr>
}}
{{#if:{{{needs-updatephp|{{#invoke:Extension|getNeedsUpdates}}}}}|
<tr>
<td>{{ll|Template:Extension#needs-updatephp|2=<abbr title="<translate nowrap><!--T:17--> <tvar name=com>'php update.php'</tvar> needed after installation</translate>">'''<translate><!--T:18--> Database changes</translate>'''</abbr>}}</td>
<td>{{#switch:{{{needs-updatephp|{{#invoke:Extension|getNeedsUpdates}}}}}|yes|Yes=<translate><!--T:38--> Yes</translate>|no|No=<translate><!--T:39--> No</translate>|{{{needs-updatephp|{{#invoke:Extension|getNeedsUpdates}}}}}}}</td>
</tr>
}}
{{#if:{{{composer|}}}|
<tr>
<td>{{ll|Composer|2=<abbr title="<translate nowrap><!--T:19--> Supports 'Composer' for installation</translate>">'''Composer'''</abbr>}}</td>
<td>[https://packagist.org/packages/{{{composer}}} {{{composer}}}] {{#ifeq:{{{templatemode|<noinclude>nocats</noinclude>}}}|nocats|<!-- do nothing -->|<!--else-->{{#if:{{{composer|}}}|[[Category:Extensions supporting Composer{{#translation:}}]]|}} }}</td>
</tr>
}}
{{#if:{{{table1|}}}|
<tr>
<td>'''{{ll|Template:Extension#table1|2=<translate><!--T:20--> Tables</translate>}}'''</td>
<td>{{ll|{{translatable}}/{{{table1}}} table|{{{table1}}}}}<!--
-->{{#if:{{{table2|}}}|<br />{{ll|{{translatable}}/{{{table2}}} table|{{{table2}}}}}<!-- -->}}<!--
-->{{#if:{{{table3|}}}|<br />{{ll|{{translatable}}/{{{table3}}} table|{{{table3}}}}}<!-- -->}}<!--
-->{{#if:{{{table4|}}}|<br />{{ll|{{translatable}}/{{{table4}}} table|{{{table4}}}}}<!-- -->}}<!--
-->{{#if:{{{table5|}}}|<br />{{ll|{{translatable}}/{{{table5}}} table|{{{table5}}}}}<!-- -->}}<!--
-->{{#if:{{{table6|}}}|<br />{{ll|{{translatable}}/{{{table6}}} table|{{{table6}}}}}<!-- -->}}<!--
-->{{#if:{{{table7|}}}|<br />{{ll|{{translatable}}/{{{table7}}} table|{{{table7}}}}}<!-- -->}}<!--
-->{{#if:{{{table8|}}}|<br />{{ll|{{translatable}}/{{{table8}}} table|{{{table8}}}}}<!-- -->}}<!--
-->{{#if:{{{table9|}}}|<br />{{ll|{{translatable}}/{{{table9}}} table|{{{table9}}}}}<!-- -->}}<!--
-->{{#if:{{{table10|}}}|<br />{{ll|{{translatable}}/{{{table10}}} table|{{{table10}}}}}<!-- -->}}<!--
-->{{#if:{{{table11|}}}|<br />{{ll|{{translatable}}/{{{table11}}} table|{{{table11}}}}}<!-- -->}}<!--
-->{{#if:{{{table12|}}}|<br />{{ll|{{translatable}}/{{{table12}}} table|{{{table12}}}}}<!-- -->}}<!--
-->{{#if:{{{table13|}}}|<br />{{ll|{{translatable}}/{{{table13}}} table|{{{table13}}}}}<!-- -->}}<!--
-->{{#if:{{{table14|}}}|<br />{{ll|{{translatable}}/{{{table14}}} table|{{{table14}}}}}<!-- -->}}<!--
-->{{#if:{{{table15|}}}|<br />{{ll|{{translatable}}/{{{table15}}} table|{{{table15}}}}}<!-- -->}}<!--
-->{{#if:{{{table16|}}}|<br />{{ll|{{translatable}}/{{{table16}}} table|{{{table16}}}}}<!-- -->}}<!--
-->{{#if:{{{table17|}}}|<br />{{ll|{{translatable}}/{{{table17}}} table|{{{table17}}}}}<!-- -->}}<!--
-->{{#if:{{{table18|}}}|<br />{{ll|{{translatable}}/{{{table18}}} table|{{{table18}}}}}<!-- -->}}<!--
-->{{#if:{{{table19|}}}|<br />{{ll|{{translatable}}/{{{table19}}} table|{{{table19}}}}}<!-- -->}}<!--
-->{{#if:{{{table20|}}}|<br />{{ll|{{translatable}}/{{{table20}}} table|{{{table20}}}}}<!-- -->}}</td>
</tr>
}}
<tr>
<td>'''{{ll|Template:Extension#license|2=<translate><!--T:21--> License</translate>}}'''</td>
<td>{{#invoke:Extension|getFormattedLicense|{{{license|}}}
|GPL-2.0          = <translate><!--T:122--> GNU General Public License 2.0</translate>
|GPL-2.0-only      = <translate><!--T:123--> GNU General Public License 2.0 only</translate>
|GPL-2.0-or-later  = <translate><!--T:124--> GNU General Public License 2.0 or later</translate>
|GPL-3.0          = <translate><!--T:125--> GNU General Public License 3.0</translate>
|GPL-3.0-only      = <translate><!--T:126--> GNU General Public License 3.0 only</translate>
|GPL-3.0-or-later  = <translate><!--T:127--> GNU General Public License 3.0 or later</translate>
|AGPL-3.0          = <translate><!--T:128--> GNU Affero General Public License 3.0</translate>
|AGPL-3.0-or-later = <translate><!--T:248--> GNU Affero General Public License 3.0 or later</translate>
|LGPL-2.1          = <translate><!--T:129--> GNU Lesser General Public License 2.1</translate>
|LGPL-2.1-only    = <translate><!--T:130--> GNU Lesser General Public License 2.1 only</translate>
|LGPL-2.1-or-later = <translate><!--T:131--> GNU Lesser General Public License 2.1 or later</translate>
|LGPL-3.0          = <translate><!--T:132--> GNU Lesser General Public License 3.0</translate>
|LGPL-3.0-only    = <translate><!--T:133--> GNU Lesser General Public License 3.0 only</translate>
|LGPL-3.0-or-later = <translate><!--T:134--> GNU Lesser General Public License 3.0 or later</translate>
|FDL              = <translate><!--T:135--> GNU Free Documentation License</translate>
|MIT              = <translate><!--T:136--> MIT License</translate>
|ISC              = <translate><!--T:137--> ISC License</translate>
|BSD-2-Clause      = <translate><!--T:138--> BSD 2-clause "Simplified" License</translate>
|BSD-3-Clause      = <translate><!--T:139--> BSD 3-clause "Modified" License</translate>
|BSD-4-Clause      = <translate><!--T:140--> BSD 4-clause "Original" License</translate>
|MPL-1.0          = <translate><!--T:141--> Mozilla Public License 1.0</translate>
|MPL-2.0          = <translate><!--T:142--> Mozilla Public License 2.0</translate>
|WTFPL            = <translate><!--T:143--> WTFPL 2.0</translate>
|Apache-2.0        = <translate><!--T:144--> Apache License 2.0</translate>
|Zlib              = <translate><!--T:145--> zlib License</translate>
|CC0-1.0          = <translate><!--T:146--> Creative Commons Zero v1.0 Universal</translate>
|CC-BY-3.0        = <translate><!--T:147--> Creative Commons Attribution 3.0</translate>
|CC-BY-SA-2.0      = <translate><!--T:148--> Creative Commons Attribution Share Alike 2.0</translate>
|CC-BY-SA-2.5      = <translate><!--T:149--> Creative Commons Attribution Share Alike 2.5</translate>
|CC-BY-NC-SA-2.5  = <translate><!--T:150--> Creative Commons Attribution NonCommercial Share Alike 2.5</translate>
|CC-BY-NC-SA-3.0  = <translate><!--T:151--> Creative Commons Attribution NonCommercial Share Alike 3.0</translate>
|CC-BY-NC-3.0      = <translate><!--T:152--> Creative Commons Attribution NonCommercial 3.0</translate>
|CC-BY-SA-3.0      = <translate><!--T:153--> Creative Commons Attribution Share Alike 3.0</translate>
|CC-BY-SA-4.0      = <translate><!--T:154--> Creative Commons Attribution Share Alike 4.0</translate>
|ECL-2.0          = <translate><!--T:155--> [[w:Educational Community License|Educational Community License 2.0]]</translate>
|PD                = <translate><!--T:156--> [[w:Public domain|Public domain]]</translate>
|+                = <translate><!--T:157--> &#32;or later</translate>
|unspecified      = <translate><!--T:22--> No license specified</translate>
}}</td>
</tr><tr>
{{#ifeq:{{{templatemode|<noinclude>nocats</noinclude>}}}|nocats|<!-- no category -->|{{#invoke:Extension|getLicenseCategory|{{{license|}}}}}}}
<td>'''<translate><!--T:23--> Download</translate>'''</td>
<td><!--
-->{{#if:{{{download|}}}|{{{download}}}|{{#if:{{{repo|}}}|{{WikimediaDownload|{{{repo}}}}}|''<translate><!--T:24--> No link</translate>''}}}}<!--
-->{{#if:{{{readme|}}}|<br />{{{readme}}}<!-- -->}}<!--
-->{{#if:{{{changelog|}}}|<br />{{{changelog}}}<!-- -->}}</td>
</tr>
{{#if: {{{help|}}}{{#ifexist:Help:{{FULLPAGENAME}}|yes}} |
<tr>
<td>'''{{ll|Template:Extension#help|2=<translate><!--T:260--> Help</translate>}}'''</td>
<td>{{#if: {{{help|}}} | {{{help}}} | {{localized link|Help:{{FULLPAGENAME}}}} }}</td>
</tr>
}}
{{#if:{{{example|}}}|
<tr>
<td>'''{{ll|Template:Extension#example|2=<translate><!--T:25--> Example</translate>}}'''</td>
<td>{{{example}}}</td>
</tr>
}}
{{#if:{{{namespace|}}}|
<tr>
<td class="mw-collapsible mw-collapsed" colspan="2">
<div class="mw-collapsible-header">'''{{ll|Template:Extension#namespace|2=<translate><!--T:26--> Namespace</translate>}}'''</div>
<div class="mw-collapsible-content"><!-- the parameter "namespace" should begin on its own line so that bullet lists are correctly recognised by MediaWiki -->
{{{namespace|}}}</div></td>
</tr>
}}
{{#if:{{#if:{{{parameters|}}}|y|{{#invoke:Extension|getParameters}}}}|
<tr>
<td class="mw-collapsible mw-collapsed" colspan="2">
<div class="mw-collapsible-header">{{ll|Template:Extension#parameters|2=<translate><!--T:27--> Parameters</translate>}}</div>
<div class="mw-collapsible-content"><!-- the parameter "parameters" should begin on its own line so that bullet lists are correctly recognised by MediaWiki -->
{{#if:{{{parameters|}}}|{{{parameters}}}|{{#invoke:Extension|getParameters}}}}</div></td>
</tr>
}}
{{#if:{{{tags|}}}|
<tr>
<td class="mw-collapsible mw-collapsed" colspan="2">
<div class="mw-collapsible-header">{{ll|Template:Extension#tags|2=<translate><!--T:28--> Tags</translate>}}</div>
<div class="mw-collapsible-content">{{{tags}}}</div></td>
</tr>
}}
{{#if:{{#if:{{{rights|}}}|y|{{#invoke:Extension|getRights}}}}|
<tr>
<td class="mw-collapsible mw-collapsed" colspan="2">
<div class="mw-collapsible-header">{{ll|Template:Extension#rights|2=<translate><!--T:29--> Added rights</translate>}}</div>
<div class="mw-collapsible-content"><!-- the parameter "rights" should begin on its own line so that bullet lists are correctly recognised by MediaWiki -->
{{#if:{{{rights|}}}|{{{rights}}}|{{#invoke:Extension|getRights}}}}
{{#ifeq:{{{templatemode|<noinclude>nocats</noinclude>}}}|nocats|<!-- do nothing -->|<!--else-->{{#if:{{{rights|}}}|[[Category:Extensions which add rights{{#translation:}}]]|}} }}</div></td>
</tr>
}}
{{#if:{{{service1|}}}|
<tr>
<td class="mw-collapsible mw-collapsed" colspan="2">
<div class="mw-collapsible-header">{{ll|Template:Extension#service|Services defined}}</div>
<div class="mw-collapsible-content">
<div>{{{service1|}}}[[Category:Extensions defining a service|{{PAGENAME}}]]</div>
{{#if:{{{service2|}}}|<div>{{{service2|}}}</div>}}
</div></td>
</tr>
}}
{{#invoke:Extension|getHooks|header=
<tr>
<td class="mw-collapsible mw-collapsed" colspan="2">
<div class="mw-collapsible-header">{{ll|Template:Extension#hook|2=<translate><!--T:30--> Hooks used</translate>}}</div>
{{plainlist|class=mw-collapsible-content}}<ul><li>|delim=</li><li>|footer=</li></ul>{{endplainlist}}
</td>
</tr>
}}
{{#if:{{{newhook1|}}}|
<tr>
<td class="mw-collapsible mw-collapsed" colspan="2">
<div class="mw-collapsible-header">{{ll|Template:Extension#newhook|2=<translate><!--T:31--> Hooks provided</translate>}}</div>
{{plainlist|class=mw-collapsible-content}}<ul><li><!--
      -->{{Foreach|Extension/HookProvided|delim=</li><li>|<!--
        -->{{{newhook1}}}|{{{newhook2|}}}|{{{newhook3|}}}|{{{newhook4|}}}|{{{newhook5|}}}|{{{newhook6|}}}|<!--
        -->{{{newhook7|}}}|{{{newhook8|}}}|{{{newhook9|}}}|{{{newhook10|}}}|{{{newhook11|}}}|{{{newhook12|}}}|<!--
        -->{{{newhook13|}}}|{{{newhook14|}}}|{{{newhook15|}}}|{{{newhook16|}}}|{{{newhook17|}}}|{{{newhook18|}}}|<!--
        -->{{{newhook19|}}}|{{{newhook20|}}}|{{{newhook21|}}}|{{{newhook22|}}}|{{{newhook23|}}}|{{{newhook24|}}}|<!--
        -->{{{newhook25|}}}|{{{newhook26|}}}|{{{newhook27|}}}|{{{newhook28|}}}|{{{newhook29|}}}|{{{newhook30|}}}|<!--
        -->{{{newhook31|}}}|{{{newhook32|}}}|{{{newhook33|}}}|{{{newhook34|}}}|{{{newhook35|}}}|{{{newhook36|}}}|<!--
        -->{{{newhook37|}}}|{{{newhook38|}}}|{{{newhook39|}}}|{{{newhook40|}}}|{{{newhook41|}}}|{{{newhook42|}}}|<!--
        -->{{{newhook43|}}}|{{{newhook44|}}}|{{{newhook45|}}}|{{{newhook46|}}}|{{{newhook47|}}}|{{{newhook48|}}}|<!--
        -->{{{newhook49|}}}|{{{newhook50|}}}|{{{newhook51|}}}|{{{newhook52|}}}|{{{newhook53|}}}|{{{newhook54|}}}|<!--
        -->{{{newhook55|}}}|{{{newhook56|}}}|{{{newhook57|}}}|{{{newhook58|}}}|{{{newhook59|}}}|{{{newhook60|}}}|<!--
        -->{{{newhook61|}}}|{{{newhook62|}}}|{{{newhook63|}}}|{{{newhook64|}}}|{{{newhook65|}}}|{{{newhook66|}}}|<!--
        -->{{{newhook67|}}}|{{{newhook68|}}}|{{{newhook69|}}}|{{{newhook70|}}}|{{{newhook71|}}}|{{{newhook72|}}}|<!--
        -->{{{newhook73|}}}|{{{newhook74|}}}|{{{newhook75|}}}|{{{newhook76|}}}|{{{newhook77|}}}|{{{newhook78|}}}|<!--
        -->{{{newhook79|}}}|{{{newhook80|}}}|{{{newhook81|}}}|{{{newhook82|}}}|{{{newhook83|}}}|{{{newhook84|}}}|<!--
        -->{{{newhook85|}}}|{{{newhook86|}}}|{{{newhook87|}}}|{{{newhook88|}}}|{{{newhook89|}}}|{{{newhook90|}}}<!--
      -->}}<!--
  --></li></ul>{{endplainlist}}
</td>
</tr>
}}
{{#if:{{{compatibility|}}}|
<tr>
<td colspan="2"><!-- the parameter "compatibility" should begin on its own line so that bullet lists are correctly recognised by MediaWiki -->
{{{compatibility}}}</td>
</tr>
}}
{{#if:{{{notranslate|{{#if:{{#invoke:Extension|isOnGerrit}}{{{translate|}}}||n}}}}}||
<tr>
<td colspan="2" style="text-align:center;">
{{#if:{{{translate|}}}
  |<translate><!--T:255--> [[<tvar name=1>translatewiki:Special:Translate/{{{translate}}}</tvar>|Translate the <tvar name=2>{{PAGENAME:{{translatable}}}}</tvar> extension]]</translate>
  |<translate><!--T:32--> [[<tvar name=1>translatewiki:Special:Translate/ext-{{lc:{{#invoke:String|replace|{{PAGENAME:{{translatable}}}}| |}}}}</tvar>|Translate the <tvar name=2>{{PAGENAME:{{translatable}}}}</tvar> extension]] if it is available at translatewiki.net</translate>
  }}</td>
</tr>}}<!--
Note: this next check suppresses the 'Check usage' link if page is: a subpage, not in Extension: namespace, or if suppressed by 'templatemode=nocats' or 'nousage=true'.
-->{{#if:{{{nousage|{{#ifeq:{{{templatemode|<noinclude>nocats</noinclude>}}}|nocats
                      |no usage
                      |{{#ifeq:{{NAMESPACE}}|{{ns:102}}
                        |
                        |no usage
                      }}
                      {{#ifeq:{{{templatemode|}}}|nousage
                        |no usage
                      }}
                    }}}}}
    |<!-- no usage -->|
<tr>
<td colspan="2" style="text-align:center;">
<span style="white-space:nowrap"><translate><!--T:33--> [[<tvar name=1>wikiapiary:Extension:{{{CheckUsageNameOverride|{{BASEPAGENAMEE}}}}}</tvar>|Check usage and version matrix.]]</translate></span>
</td>
</tr>
}}
{{#if:{{{vagrant-role|}}}|
<tr>
<td>'''{{ll|MediaWiki-Vagrant#Using roles|2=<translate><!--T:34--> Vagrant role</translate>}}'''</td>
<td>[https://doc.wikimedia.org/mediawiki-vagrant/puppet_classes/role_3A_3A{{{vagrant-role}}}.html {{{vagrant-role}}}]</td>
</tr>
}}
{{#if: {{{phabricator|{{{bugzilla|}}}}}} |
<tr>
<td>
'''{{ll|Phabricator|2=<translate><!--T:35--> Issues</translate>}}'''</td>
<td>[[phab:tag/{{lc:{{{phabricator|MediaWiki-extensions-{{{bugzilla}}}}}}}}|<translate><!--T:36--> Open tasks</translate>]] · [https://phabricator.wikimedia.org/maniphest/task/create/?projects={{{phabricator|MediaWiki-extensions-{{{bugzilla}}}}}} <translate><!--T:37--> Report a bug</translate>]</td>
</tr>
}}
{{#if: {{{github|}}} |
<tr>
<td>
'''{{ll|Gerrit/GitHub|2=<translate><!--T:40--> Issues</translate>}}'''</td>
<td>[https://www.github.com/{{{github}}}/issues <translate><!--T:41--> Open issues</translate>] · [https://www.github.com/{{{github}}}/issues/new <translate><!--T:42--> Report a bug</translate>]</td>
</tr>
}}
</table><!--
-->{{#ifeq:{{{templatemode|<noinclude>nocats</noinclude>}}}|nocats|<!--
  nothing--><!--
-->|<!--else--><!--
  -->{{DEFAULTSORT:{{#if:{{{name|}}}|<!--
      -->{{uc:{{{name}}}<!-- -->}}<!--
  -->|<!--else--><!--
      -->{{uc:{{PAGENAME}}<!-- -->}}<!--
  -->}}<!-- -->}}<!--
  -->[[Category:All extensions{{#translation:}}]]<!--
  -->{{#invoke:Extension|getExtensionJsonCategory}}<!--
-->}}<!--
--><!--Check if the source page was deleted/archived--> {{#invoke:Extension|maintenanceLinks}}
| #default=
  {{#invoke:Template translation|renderTranslatedTemplate|template=Template:Extension|noshift=1}}
}}</includeonly><noinclude>{{Documentation|content=
{{intricate template}}
{{lua|Module:Extension|Module:ExtensionJson|Module:String}}
{{Uses TemplateStyles|Template:Infobox/styles.css|Template:Extension/styles.css|Template:Extension/status.css}}
<translate><!--T:48--> This template should be added to all extension pages on this wiki (but only the main page).</translate>
<translate><!--T:49--> It will add a useful infobox (see below) and will automatically add the extension to <tvar name=1>{{ll|Category:All extensions}}</tvar>, along with the appropriate {{<tvar name=2>ll|Category:Extensions by status</tvar>|status}} and {{<tvar name=3>ll|Category:Extensions by implementation type</tvar>|implementation type}} categories.</translate>
 
<translate>
== Usage == <!--T:50-->
</translate>
<table width="100%">
<tr>
<th width=40%></th>
<th width=60%></th>
</tr>
<tr valign="top">
<td align="left">
<span id="CutAndPaste"><translate><!--T:51--> Copy and paste:</translate></span>
<pre>{{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            =
|help                =
|example              =
|namespace            =
|parameters          =
|tags                =
|rights              =
|compatibility        =
|bugzilla            =
|phabricator          =
|vagrant-role        =
}}</pre>
 
<translate><!--T:52--> For help with parameter values, see [[<tvar name=1>#Content parameters</tvar>|below]].</translate></td>
<td align="right">{{Extension |templatemode=nocats
|name            = {{{name}}}
|status          = {{{status}}}
|type1          = {{{type1}}}
|type2          = {{{type2}}}
|hook1          = hook1
|hook2          = hook2
|newhook1        = newhook1
|newhook2        = newhook2
|username        = SomeUser
|author          = SomeAuthor
|image          = Placeholder.svg
|version        = {{{version}}}
|update          = {{{update}}}
|version preview = {{{version preview}}}
|update preview  = {{{update preview}}}
|compatibility policy = {{{compatibility policy}}}
|mediawiki      = {{{mediawiki}}}
|php            = {{{php}}}
|needs-updatephp = {{{needs-updatephp}}}
|composer        = {{{composer}}}
|table1          = {{{table1}}}
|table2          = {{{table2}}}
|license        = {{{license}}}
|download        = {{{download}}}
|readme          = {{{readme}}}
|changelog      = {{{changelog}}}
|help            = {{{help}}}
|example        = {{{example}}}
|namespace      = {{{namespace}}}
|description    = {{{description}}}
|parameters      = {{{parameters}}}
|tags            = {{{tags}}}
|rights          = {{{rights}}}
|compatibility  = {{{compatibility}}}
|bugzilla        = {{{bugzilla}}}
|phabricator    = {{{phabricator}}}
|vagrant-role    = {{{vagrant-role}}}
}}</td>
</tr>
</table>
 
{{anchor|Content parameters}}
<translate>
== Content parameters == <!--T:53-->
</translate>
<translate><!--T:54--> This section describes parameters that govern infobox content.</translate>
<translate><!--T:55--> For help with <tvar name=1>'''templatemode'''</tvar> and other control parameters, please see ''[[<tvar name=2>#Control parameters</tvar>|Control parameters]]''.</translate>
<!-- BEFORE YOU EDIT THIS:
    span ids on each parameter are used by the code in Template:Extension.
    They enable each label in the info box to link its documentation.
    If you change an id, please update the code in Template:Extension accordingly.
--> 
<table class="wikitable">
<caption>'''<translate><!--T:58--> Content parameters</translate>'''</caption>
<tr>
<th><translate><!--T:72--> Parameter</translate></th>
<th><translate><!--T:73--> Description</translate></th>
</tr>
<tr>
<td><span id="name">'''name'''</span></td><td>'''<translate><!--T:59--> name of the extension</translate>'''</td>
</tr>
<tr>
<td><span id="status">'''status'''</span></td><td>
'''<translate><!--T:60--> current release status</translate>'''
<translate><!--T:158--> One of:</translate>
 
* ''{{ll|Category:Unstable extensions|unstable}}'' - <translate><!--T:159--> broken - do not use this extension</translate>
* ''{{ll|Category:Experimental extensions|experimental}}'' - <translate><!--T:226--> early stages of development, may change drastically</translate>
* ''{{ll|Category:Beta status extensions|beta}}'' - <translate><!--T:227--> stable but not fully tested</translate>
* ''{{ll|Category:Stable extensions|stable}}'' - <translate><!--T:228--> stable version</translate>
* ''{{ll|Category:Unmaintained extensions|unmaintained}}'' - <translate><!--T:229--> unmaintained - previously claimed to be stable, now unmaintained</translate>
* ''{{ll|Category:Extensions with unknown status|unknown}}'' - <translate><!--T:231--> default</translate>
 
<translate><!--T:160--> 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.</translate>
<translate><!--T:161--> In cases where the value is omitted, it will be categorized as [[<tvar name=1>Special:MyLanguage/Category:extensions with unknown status</tvar>|unknown]].</translate>
<translate><!--T:162--> In cases where the value is invalid, it will be placed in a [[<tvar name=1>Special:MyLanguage/Category:extensions with invalid status</tvar>|special category]] so that the error can be caught and fixed.</translate>
 
<translate>
<!--T:163-->
* [[<tvar name=1>Special:MyLanguage/Extension status</tvar>|release status colour scheme]]</translate></td>
</tr>
<tr>
<td>'''type1'''<br/>''type2''<br/>''type3''<br/>''type4''<br/>''type5''<br/>''type6''<br/></td><td><span id="type">'''<translate><!--T:61--> implementation type</translate>'''</span><!-- id here so at top of documentation -->
<translate><!--T:164--> The implementation strategy(s) employed in building this extension.</translate>
<translate><!--T:165--> This parameter is used to create categories that help programmers find examples of various MediaWiki specific implementation strategies or patterns.</translate>
<translate><!--T:166--> Although the values of this parameter sometimes coincide with the use case or purpose of an extension, that is not reason for this parameter.</translate>
<translate><!--T:167--> If the values you have chosen for this parameter do not adequately identify the [[w:Requirements|purpose]] or possible [[w:Use case|use case]]s, we recommend you add additional [[<tvar name=1>Special:MyLanguage/Help:Categories</tvar>|category links]] as needed.</translate>
 
<translate><!--T:168--> Allowed values for the '''type1''', '''type2''', ... parameters are:</translate>


== Usage ==
* '''''{{ll|Category:Parser extensions|parser}}''''' - <translate><!--T:213--> catchall for uncategorized [[<tvar name=1>Special:MyLanguage/Manual:Extending wiki markup</tvar>|parser extensions]].</translate> <translate><!--T:214--> If you have written a parser extension, please use one of the following more specific types:</translate>
{|
** ''{{ll|Category:ContentHandler extensions|contenthandler}}'' - <translate><!--T:215--> Extensions using <tvar name=1>{{ll|Manual:ContentHandler|ContentHandler}}</tvar>.</translate>
|
** ''{{ll|Category:Link markup extensions|link}}'' - <translate><!--T:216--> customized [[<tvar name=1>Special:MyLanguage/Manual:Extending wiki markup</tvar>|link markup]], e.g. <tvar name=2><code><nowiki>[[</nowiki>...]]</code></tvar></translate>
{|border="1"
** ''{{ll|Category:Parser function extensions|parser function}}'' - <translate><!--T:217--> custom [[<tvar name=1>Special:MyLanguage/Manual:Parser functions</tvar>|parameterized template markup]], e.g. <tvar name=2><code><nowiki>{{</nowiki>''#name:'' ... <nowiki>}}</nowiki></code></tvar></translate>
|+ '''Parameters'''
** ''{{ll|Category:Tag extensions|tag}}'' - <translate><!--T:218--> [[<tvar name=1>Special:MyLanguage/Manual:Tag extensions</tvar>|custom XML tag markup]], e.g. <tvar name=2>{{tag|''tagname''}}</tvar></translate>
|-
** ''{{ll|Category:Variable extensions|variable}}'' - <translate><!--T:219--> custom [[<tvar name=1>Special:MyLanguage/Manual:Variables</tvar>|unparameterized template markup]], e.g. <tvar name=2><code><nowiki>{{NAME}}</nowiki></code></tvar></translate>
| '''name''' || '''name of the extension'''
** ''{{ll|Category:Extended syntax extensions|extended syntax}}'' - <translate><!--T:220--> Extensions that add non-standard wiki syntax (i.e. <em>not</em> [[<tvar name=1>Special:MyLanguage/Manual:Tag extensions</tvar>|tags]], [[<tvar name=2>Special:MyLanguage/Manual:Parser functions</tvar>|parser functions]], or [[<tvar name=3>Special:MyLanguage/Manual:Variables</tvar>|variables]]).</translate>
|-
*:
| '''status''' || '''current release status'''
* {{ll|Category:User access extensions|'''''access'''''}} - <translate><!--T:169--> catchall for <tvar name=1>{{ll|Manual:User access extensions|nsp=0}}</tvar>, 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:</translate>
One of:  
** {{ll|Category:User activity extensions|''user activity''}} - <translate><!--T:221--> extensions that monitor user activity (logins, logouts, new user creation, etc.)</translate>
* ''unstable'' (broken - do not use this extension)
** {{ll|Category:User identity extensions|''user identity''}} - <translate><!--T:222--> extensions that create and delete users, and/or verify the identity of a user</translate>
* ''experimental'' (early stages of development, may change drastically.)
** {{ll|Category:User rights extensions|''user rights''}} - <translate><!--T:223--> 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 [[<tvar name=1>#rights</tvar>|rights parameter]])</translate>
* ''beta'' (stable but not fully tested)
* {{ll|Category:User interface extensions|'''''interface'''''}} - <translate><!--T:170--> catchall for uncategorized user interface extensions.</translate>
* ''stable'' (stable version)
** ''{{ll|Category:Media handling extensions|media}}'' - <translate><!--T:232--> extensions that permit the embedding of multimedia content on wiki pages by registering a file extension with <tvar name=1>{{ll|Manual:$wgMediaHandlers|$wgMediaHandlers}}</tvar>.</translate>
* ''unknown'' (default)
** ''{{ll|Category:Personalization extensions|mywiki}}'' - <translate><!--T:233--> extensions that provide infrastructure so that users may personalize their MediaWiki experience and/or assist in the management of that infrastructure</translate>
|-
** {{ll|Category:Notification extensions|''notify''}} - <translate><!--T:234--> extensions that email users, broadcast messages and provide other forms of community notification</translate>
| '''type''' || '''type of extension'''
** ''{{ll|Category:Page action extensions|''page action''}}'' - <translate><!--T:235--> extensions that enhance or modify <tvar name=pageaction>{{ll|Manual:Page action|page action}}</tvar>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 <tvar name=userrights>''user rights''</tvar>) or logs (use <tvar name=useractivity>''user activity''</tvar>).</translate>
Can contain any value, but the following special values ensure proper categorisation:
** {{ll|Category:Search extensions|''search''}} - <translate><!--T:236--> extensions that search through and select pages for users.</translate>
* ''pfunc'' - Parser Function
** {{ll|Category:Skin extensions|''skin''}} - <translate><!--T:237--> 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.</translate>
* ''parser'' - Parser Extension (new tag)
** {{ll|Category:Ajax extensions|''ajax''}} - <translate><!--T:238--> extensions that use [[w:AJAX|Ajax]] programming techniques.</translate>
* ''parser,pfunc'' - available as Parser Function AND as Parser Extension
** {{ll|Category:Special page extensions|''special''}} - <translate><!--T:239--> extensions that subclass the <tvar name=specialpage>{{Class doclink|SpecialPage}}</tvar> class, use one of its hooks, or patch one or more functions in <tvar name=filephp>{{Git file|file=includes/specialpage/SpecialPage.php|text=SpecialPage.php}}</tvar>. See <tvar name=manual>{{ll|Manual:Special pages|Special pages}}</tvar> for more information.</translate>
* ''hook'' - Hook Extension (new parser hook)
* '''other'''
* ''special'' - Special Page
** {{ll|Category:API extensions|''api''}} - <translate><!--T:240--> extensions that add a new API module or extend a core API module.</translate>
* ''interface'' - User interface extension (e.g. javascript code).
** {{ll|Category:Hook extensions|''hook''}} - <translate><!--T:241--> Hook extension - defines a <em>new</em> hook - see hook1, etc. below if you want to define hooks <em>used</em> by your extension</translate>
Please add to this list if necessary.
** {{ll|Category:Database extensions|''database''}} - <translate><!--T:242--> adds tables and/or fields to the database backing a MediaWiki installation</translate>
|-
** {{ll|Category:Data extraction extensions|''data extraction''}} - <translate><!--T:243--> Data extraction</translate>
| author    || author of the extension
** {{ll|Category:File repository extensions|''filerepo''}} - <translate><!--T:244--> extension that adds new file repository types as file backend</translate>
|-
** {{ll|Category:Extension examples|''example''}} - <translate><!--T:245--> Not a real extension, but an example of how to write one</translate>
| image      || screenshot (of base 270px)
** {{ll|Category:Beta Feature extensions|''beta features''}} - <translate><!--T:257--> extensions that new <tvar name="1">{{ll|Beta Features}}</tvar>.</translate>
|-
** {{ll|Category:PHP extensions|''php''}} - <translate><!--T:258--> extensions to the underlying <tvar name=1>{{ll|PHP}}</tvar> programming language.</translate>
| version    || last version
** {{ll|Category:Internationalization extensions|''locale''}} - <translate><!--T:259--> extensions associated with [[<tvar name=1>Special:MyLanguage/Manual:Localization</tvar>|localization]]</translate>
|-
<translate><!--T:172--> Any other value for 'type' is invalid, and will cause the extension to be placed in <tvar name=typemissingcat>[[:Category:Extensions with invalid or missing type{{#translation:}}]]</tvar>.</translate>
| update    || date of the last update
 
|-
<translate><!--T:173--> Note: Many extensions have more than one type, if this applies to yours, replace <tvar name=type><code>{{!}}type=</code></tvar> with <tvar name=value><code>{{!}}type1={{!}}type2={{!}}type3=...</code></tvar>. You may define up to six types for an extension.</translate></td>
| mediawiki  || required version of MediaWiki
</tr>
|-
<tr>
| '''download''' || '''link to the download''' : [http://svn.wikimedia.org/svnroot/mediawiki/trunk/extensions/ SVN] or other
<td><span id="hook">'''hook1'''</span><br/>''hook2''<br/>''hook3''<br/>''hook4''<br/>...</td>
|-
<td valign="top">'''<translate><!--T:62--> name of each hook used by the extension</translate>'''
| readme    || link to the readme file : [http://svn.wikimedia.org/svnroot/mediawiki/trunk/extensions/Sort/Sort README] or other
<translate><!--T:174--> Entering values in this field is a good way to get exposure for your extension and help other developers.</translate>
|-
<translate><!--T:175--> Each documented hook will automatically add the extension to a category listing extensions that use that hook.</translate>
| changelog  || link to the changelog file : [http://svn.wikimedia.org/svnroot/mediawiki/trunk/extensions/Sort/Sort CHANGELOG] or other
<translate><!--T:176--> This category is autolinked to each hook page so that programmers can easily find examples of extensions that use a particular hook.</translate>
|-
 
| '''description''' || '''short description'''
<translate>
|-
<!--T:177-->
| parameters || available parameters for LocalSettings.php
For built-in hooks:
|-
* use the hook name alone. Please see <tvar name=manual>{{ll|Manual:Hooks|Manual:Hooks}}</tvar> for values (but omit introductory '/').
| rights    || rights added by the extension
 
|-
<!--T:178-->
| example    || example, website or screenshot of working extension
For custom hooks defined by extensions:
|}
* use <tvar name=form>''extensionName''/''hookName''</tvar>. For a partial list of custom hooks, see <tvar name=exthooks>[[Extension hook registry]]</tvar>.
|
 
<nowiki>{{Extension
<!--T:179-->
|name     =  
For multiple hooks, assign the first hook to '''hook1''', the second to '''hook2''' and so on.</translate></td>
|status    =
</tr>
|type      =
<tr>
|author    =
<td><span id="newhook">'''newhook1'''</span><br/>''newhook2''<br/>''newhook3''<br/>''newhook4''<br/>...<br/>''newhook90''</td>
|image    =
<td valign="top">
|version  =
<translate>
|update    =
<!--T:180-->
|mediawiki =
'''name of each hook provided by the extension'''
|download  =
 
|readme    =
<!--T:181-->
|changelog =
You might also want to add the hooks to <tvar name=exthooks>[[Extension hook registry]]</tvar>.
|description =
</translate>
|parameters=
</td>
|rights    =
</tr>
|example  =
<tr>
}}</nowiki>
<td><span id="username">'''username'''</span></td><td><translate><!--T:63--> The author's username on MediaWiki.org (if they have one).</translate> <translate><!--T:64--> May be omitted, but if present it will be used to link to the author's user & user_talk page.</translate> <translate><!--T:65--> It should be provided without namespace and without <tvar name=1><nowiki>[[]]</nowiki></tvar>s.</translate></td>
|}
</tr>
</noinclude><includeonly>[[Category:{{{status|unknown}}} status extensions]]</includeonly>
<tr>
<td>{{visible anchor|author}}</td><td><translate><!--T:66--> The extension author's name, if different from their MediaWiki.org username.</translate> <translate><!--T:67--> Free text.</translate> <translate><!--T:68--> If omitted then the 'username' field will be used (if present).</translate></td>
</tr>
<tr>
<td><span id="description">'''description'''</span></td><td>'''<translate><!--T:69--> short description</translate>'''</td>
</tr>
<tr>
<td>{{visible anchor|image}}</td><td><translate><!--T:70--> screenshot or logo of extension.</translate> <translate><!--T:71--> It should be provided without namespace and without <tvar name=1><nowiki>[[]]</nowiki></tvar>s.</translate></td>
</tr>
<tr>
<td>{{visible anchor|imagesize}}</td><td><translate><!--T:74--> ''facultative'', size of the image (default size is 220px)</translate></td>
</tr>
<tr>
<td>{{visible anchor|version}}</td><td><translate><!--T:75--> last version</translate></td>
</tr>
<tr>
<td>{{visible anchor|update}}</td><td><translate><!--T:76--> date of the last update</translate></td>
</tr>
<tr>
<td><span id="compatibility_policy">compatibility policy</span></td><td><translate><!--T:77--> {{<tvar name=1>ll|Compatibility#mediawiki_extensions</tvar>|compatibility policy}} (accepted values are <tvar name=2>'''master'''</tvar>, <tvar name=3>'''rel'''</tvar>, and <tvar name=x>'''ltsrel'''</tvar>).</translate> ({{ll|Category:Extensions without a compatibility policy|2=<translate><!--T:78--> backlog</translate>}})</td>
</tr>
<tr>
<td>{{visible anchor|mediawiki}}</td><td><translate><!--T:79--> Required version of MediaWiki.</translate> Most extensions should not need to use this — it defaults to the value of the {{Manual|Extension.json/Schema#requires|'requires'}} property of {{manual|extension.json}}. See also [[:Category:Extensions without MediaWiki version]] and [[:Category:Extensions with manual MediaWiki version]].</td>
</tr>
<tr>
<td>{{visible anchor|php}}</td><td><translate><!--T:80--> required version of PHP</translate></td>
</tr>
<tr>
<td>{{visible anchor|needs-updatephp}}</td>
<td>
<translate>
<!--T:194-->
<tvar name=yes><code>yes</code></tvar> 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. <tvar name=no><code>no</code></tvar> should be set as a value since this assures that the extension does not need update.php to be run and thus avoids uncertainty
 
<!--T:195-->
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 <tvar name=target><syntaxhighlight lang=php inline>$IP/extensions/ExtensionName</syntaxhighlight></tvar> and inserted <tvar name=code><syntaxhighlight lang=php inline>wfLoadExtension( "ExtensionName" );</syntaxhighlight></tvar> into "LocalSettings.php", run from the command line:
</translate>
 
<code class="mw-code mw-highlight" style="display:block"><!--
-->{{#tag:span|cd|class=nb}} ''<translate><!--T:256--> path/to/wiki_install_directory</translate>''
{{#tag:span|cd|class=nb}} maintenance
php update.php
</code>
 
{{$IP}}</td>
</tr>
<tr>
<td><span id="php">composer</span></td><td><translate><!--T:196--> If applicable the name of the "vendor" as well as the "package" should be entered in the format <tvar name=format><code>vendor/package</code></tvar>, e.g. <tvar name=xmp><code>mediawiki/semantic-media-wiki</code></tvar> to point people directly to packagist.org, which serves as the package archive.</translate></td>
</tr>
<tr>
<td><span id="table1">'''table1'''</span><br/>''table2''<br/>''table3''<br/>''table4''<br/>...<br/>''table30''</td><td><translate><!--T:204--> '''name of each ''non-core'' table used by the extension'''</translate>
 
<translate><!--T:205--> Links to a subpage of your extension page. For instance, "<tvar name=table1>table1 = cu_changes</tvar>" at <tvar name=url1>{{ll|Extension:CheckUser|Extension:CheckUser}}</tvar> will link to <tvar name=url2>{{ll|Extension:CheckUser/cu_changes table|Extension:CheckUser/cu_changes table}}</tvar>. Don't list core tables such as <tvar name=page>{{ll|Manual:Page table|page}}</tvar> or <tvar name=revision>{{ll|Manual:Revision table|revision}}</tvar>; only list tables that are added by extensions.</translate></td>
</tr>
<tr>
<td>{{visible anchor|license}}</td><td><translate><!--T:206--> license governing use of this extension, as one of the codes found in <tvar name=url>https://spdx.org/licenses/</tvar>, e.g. <tvar name=later2><code>GPL-2.0-or-later</code></tvar>, <tvar name=only2><code>GPL-2.0-only</code></tvar> or <tvar name=later3><code>GPL-3.0-or-later</code></tvar>, etc.</translate></td>
</tr>
<tr>
<td><span id="download">'''download'''</span></td><td><translate><!--T:207--> '''link to the download''' : <tvar name=url>[[phab:r/project/mediawiki/core|Git]]</tvar>, <tvar name=wikimediadownload>{{tl|WikimediaDownload{{#translation:}}}}</tvar>. </translate></td>
</tr>
<td><span id="repo">repo</span></td><td><translate><!--T:249--> Name of the Gerrit repository the extension's code is stored in, if different from the page name. Setting this automatically sets {{para|download}}, and allows the template to automatically load data from the appropriate <tvar name=1><code>extension.json</code></tvar> file.</translate></td>
<tr>
<td>{{visible anchor|readme}}</td><td><translate><!--T:208--> external link to the <tvar name=readme>readme</tvar> file, e.g. <tvar name=url>https://phabricator.wikimedia.org/r/browse/mediawiki/extensions/Flow;master;README</tvar></translate></td>
</tr>
<tr>
<td>{{visible anchor|changelog}}</td><td><translate><!--T:209--> external link to the changelog file, e.g. <tvar name=url>[[Extension:LDAP Authentication/Changelog]]</tvar></translate></td>
</tr>
<tr>
<td>{{visible anchor|parameters}}</td><td><translate><!--T:197--> available parameters for LocalSettings.php</translate></td>
</tr>
<tr>
<td>{{visible anchor|tags}}</td><td><translate><!--T:198--> any tags your extension uses (e.g. <tvar name=tags>&lt;tag1&gt;, &lt;tag2&gt;</tvar>).</translate></td>
</tr>
<tr>
<td>{{visible anchor|rights}}</td><td><translate><!--T:210--> [[<tvar name=1>Special:MyLanguage/Manual:User rights</tvar>|rights]] added by the extension. '''Not to be confused with the license!''' Rights are such as <tvar name=makebot>''{{ll|Extension:MakeBot|makebot}}''</tvar> or <tvar name=desysop>''{{ll|Extension:Desysop|desysop}}''</tvar>, not such as GFDL or LGPL or GPL - those are licenses!</translate></td>
</tr>
<tr>
<td>{{visible anchor|namespace}}</td><td><translate><!--T:199--> [[<tvar name=1>Special:MyLanguage/Manual:Namespace</tvar>|namespace]] in which this extension is used</translate></td>
</tr>
<tr>
<td>{{visible anchor|help}}</td><td>Link to user-help for the extension. If not provided, will look for <code>Help:Extension:''ExtensionName''</code>. If provided, full wikitext link should be given (because you may want to link to e.g. an external page).</td>
</tr>
<tr>
<td>{{visible anchor|example}}</td><td><translate><!--T:200--> example, website or screenshot of working extension</translate></td>
</tr>
<tr>
<td>{{visible anchor|compatibility}}</td><td><translate><!--T:211--> Additional compatibility information, for instance compatibility charts. It's encouraged to add any client-side compatibility information here too, especially when diverging from [[<tvar name=1>Special:MyLanguage/Compatibility#Browsers</tvar>|expectations of full support for a browser]].</translate></td>
</tr>
<tr>
<td>{{visible anchor|translate}}</td>
<td>
<translate>
<!--T:212-->
Optional parameter to link the exact page where ([[<tvar name=1>Special:MyLanguage/Help:Extension:Translate/Glossary</tvar>|message group id]] with which) the extension will be translatable on <tvar name=translatewiki>[[translatewiki.net]]</tvar> if enabled. If the default link is incorrect, manually set it to:
* <tvar name=lowercase>ext-LOWERCASE</tvar>(<tvar name=nospaces>NOSPACES</tvar>(Label as defined in <tvar name=file>{{git file|project=translatewiki|branch=HEAD|file=groups/MediaWiki/ExtensionsAgg.yaml|text=config}}</tvar>)), aka
* the parameter you get in the URL after
** typing the name of the extension in the search/filter box at <tvar name=tranlwikispectransl>[[translatewiki:Special:Translate]]</tvar> or
** searching for its name in <tvar name=transwikilangstat>[https://translatewiki.net/w/i.php?title=Special%3ALanguageStats&x=D languagestats]</tvar> after clicking "expand all".
</translate>
</td>
</tr>
<tr>
<td>{{visible anchor|bugzilla}}</td><td><translate><!--T:201--> Bugzilla MediaWiki extension component name</translate></td>
</tr>
<tr>
<td>{{visible anchor|phabricator}}</td><td><translate><!--T:202--> Phabricator project name</translate></td>
</tr>
<tr>
<td>{{visible anchor|CheckUsageNameOverride}}</td><td><translate><!--T:203--> override the page name used for the check usage link.</translate>
</tr>
</table>
 
{{anchor|Control parameters}}
<translate>
== Control parameters == <!--T:56-->
</translate>
<table class="wikitable">
<caption>'''<translate><!--T:57--> Control parameters</translate>'''</caption>
<tr>
<th><translate><!--T:81--> Parameter</translate></th>
<th><translate><!--T:82--> Description</translate></th>
</tr>
<tr>
<td>'''templatemode'''</td>
<td>
<translate>
<!--T:191-->
'''Controls auto-categorization of host page.'''
 
<!--T:192-->
Normally left blank. Alternate values are:
</translate>
* ''nocats'' - <translate><!--T:224--> suppresses categorization and the 'check usage' link. Use this value if you are adding this template to [[<tvar name=1>Special:MyLanguage/Help:Subpage</tvar>|subpages]] of an extension or to how-to documentation of extensions. For example, the usage image above sets <tvar name=nocats><code>templatemode=nocats</code></tvar> because this isn't an actual extension page and we don't want to add this page to any categories on account of it.</translate>
* ''nousage'' - <translate><!--T:225--> 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 '<tvar name=templatemode>templatemode=nocats</tvar>'</translate>
 
<translate><!--T:193--> If this is left blank, this template will add the host page to <tvar name=allextcat>[[:Category:All extensions{{#translation:}}]]</tvar> and to one or more additional categories, depending on the values assigned to the [[<tvar name=anchor>#Content parameters</tvar>|Content parameters]].</translate></td>
</tr>
</table>
 
<translate>
== Using the infobox == <!--T:83-->
 
=== Existing extension pages === <!--T:84-->
 
<!--T:85-->
If you want to add the infobox to an existing page, copy and paste the code at the [[<tvar name=1>#CutAndPaste</tvar>|top of this page]].
</translate>
 
{{anchor|Create a new extension page|Create a new extension article}}
<translate>
=== Create a new extension page === <!--T:86-->
</translate>
<translate><!--T:87--> If you want to create a new extension page, enter the name below and click the button.</translate>
<translate><!--T:88--> A new page will be created with the infobox template already in place.</translate>
 
{{Extension/CreateExtensionInputBox}}
 
<translate>
== Enhancing this template == <!--T:89-->
</translate>
<translate><!--T:90--> If you would like to improve on this template, thanks!</translate>
<translate><!--T:91--> This is a complicated template so here is some help along the way:</translate>
 
<translate>
=== The Create extension button === <!--T:92-->
 
<!--T:93-->
To improve the create extension button behavior:
 
<!--T:182-->
* '''<tvar name=extsample>{{ll|Template:Extension/Sample}}</tvar>:''' The boilerplate extension that is preloaded into newly-created pages.
* '''<tvar name=extinpbox>{{ll|Template:Extension/CreateExtensionInputBox}}</tvar>:''' An input box that can be inserted wherever you want users to easily create extensions. For documentation on the <tvar name=tagvalue>{{tag|inputbox|open}}</tvar> tag, please see <tvar name=url>{{ll|Extension:InputBox|Extension:InputBox}}</tvar>.
 
=== Infobox parameters === <!--T:183-->
 
<!--T:184-->
In general:
 
<!--T:185-->
* 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 [[<tvar name=1>Special:MyLanguage/Template:Extension#Content parameters</tvar>|content parameter documentation]] and link its label to that documentation.
 
<!--T:186-->
To change/correct/add to the implementation type parameters:
* Check the [[<tvar name=url>Template_talk:Extension</tvar>|talk page]] - there have been some extensive discussions about this field.</translate>
<translate>
<!--T:247-->
* The valid types and what they link to are defined at <tvar name=1>[[Module:Extension]]</tvar>
 
<!--T:187-->
To change the behavior of the hook parameters:
 
<!--T:188-->
* '''<tvar name=hookinuse>[[Template:Extension/HookInUse]]</tvar>:''' Adds links and categories for a hook in use. Multiple hooks in use are implemented by calling this template with <tvar name=foreach>[[Template:Foreach]]</tvar>.
* '''<tvar name=hookinusenocats>[[Template:Extension/HookInUseNoCats]]</tvar>:''' Used instead of <tvar name=hookinuse>[[Template:Extension/HookInUse]]</tvar> when this template is used in <tvar name=nocats><code>templatemode=nocats</code></tvar>. Templates used with <tvar name=feach>[[Template:Foreach]]</tvar> can only take one parameter so we need to wrap the call to <tvar name=hookuse>[[Template:Extension/HookInUse]]</tvar> with another template that sets the mode.
 
== Test case == <!--T:189-->
 
<!--T:190-->
See if the following pages are still ok, after edited this template.</translate>
* [[Extension:Description2]]
* [[Template:Extension]]
 
{{Extension/doc}}
 
}}
Maintenance:
[[Special:WhatLinksHere/Template:Extension/vulnerabilities|vulnerabilities]],
[[Special:WhatLinksHere/Template:Extension/archived|archived]]
</noinclude>

Latest revision as of 03:12, 15 October 2021

<languages/> Lua error in Module:TNT at line 158: Missing JsonConfig extension; Cannot load https://commons.wikimedia.org/wiki/Data:I18n/Documentation.tab.[[Category:Template documentation pages{{#translation:}}]] Maintenance: vulnerabilities, archived

Retrieved from "https://wiki.tessercat.net/index.php?title=Template:Extension&oldid=10694"