<translate> [[<tvar|1>Special:MyLanguage/Phabricator</>|Issue tracker]]:</translate> [[phab:tag/{{{phabricator}}}/|#{{{phabricator}}}]]
Difference between revisions of "Template:Extension"
Jump to navigation
Jump to search
>Shirayuki (translation tweaks) |
>Pppery (Template was deleted ages ago) |
||
(71 intermediate revisions by 15 users not shown) | |||
Line 1: | Line 1: | ||
<noinclude> | <noinclude> | ||
<languages/> | <languages/> | ||
</noinclude><includeonly>{{#switch:<translate></translate> | </noinclude><!-- | ||
--><templatestyles src="Template:Infobox/styles.css" /><!-- | |||
--><templatestyles src="Template:Extension/styles.css" /><!-- | |||
--><templatestyles src="Template:Extension/status.css" /><!-- | |||
--><includeonly>{{#switch:<translate></translate> | |||
| = | | = | ||
{{#ifeq:{{lc:{{{status}}}}}|unmaintained|{{#ifeq:{{NAMESPACE}}|Extension|{{#invoke:Extension|unmaintained}}}}}} | {{#ifeq:{{lc:{{{status}}}}}|unmaintained|{{#ifeq:{{NAMESPACE}}|Extension|{{#invoke:Extension|unmaintained}}}}}} | ||
{{#if: {{{phabricator|{{{bugzilla|}}}}}} | {{Ptag|{{{phabricator|MediaWiki-extensions-{{{bugzilla|}}}}}}}} }} | {{#if: {{{phabricator|{{{bugzilla|}}}}}} | {{Ptag|{{{phabricator|MediaWiki-extensions-{{{bugzilla|}}}}}}}} }} | ||
<table class="infobox infobox-{{dir|{{pagelang}}}} ext-infobox ext-status-{{#switch: {{lc: {{{status|unknown}}} }} | |||
<table class=" | |unmaintained|unstable|experimental|beta|stable={{lc: {{{status}}} }} | ||
|unmaintained | |||
|#default=unknown | |#default=unknown | ||
}}"> | }}"> | ||
<caption>'''{{ll|Manual:Extensions|2=<translate><!--T:1--> MediaWiki extensions manual</translate>}}'''</caption> | <caption>'''{{ll|Manual:Extensions|2=<translate><!--T:1--> MediaWiki extensions manual</translate>}}'''</caption> | ||
<tr class=" | <tr class="infobox-header ext-infobox-header"> | ||
<th colspan="2" style="padding-top: 0.5em;">[[File:{{#ifeq: {{lc: {{{status|}}} }} |unstable| | <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}}} }} | {{ll|Extension status|2=<translate><!--T:2--> Release status:</translate>}} {{#switch: {{lc: {{{status|unknown}}} }} | ||
|unmaintained=<translate><!--T:3--> unmaintained</translate> | |unmaintained=<translate><!--T:3--> unmaintained</translate> | ||
Line 36: | Line 42: | ||
{{#if:{{{type|}}}{{{type1|}}}| | {{#if:{{{type|}}}{{{type1|}}}| | ||
<tr> | <tr> | ||
<td>'''{{ll|Template:Extension#type|2=<translate><!--T:12--> Implementation</translate>}}'''</td> | <td style="min-width:7em">'''{{ll|Template:Extension#type|2=<translate><!--T:12--> Implementation</translate>}}'''</td> | ||
<td>{{#invoke:Extension|getTypes | <td>{{#invoke:Extension|getTypes | ||
|ajax = <translate><!--T:94--> [[w:AJAX|Ajax]]</translate> | |ajax = <translate><!--T:94--> [[w:AJAX|Ajax]]</translate> | ||
Line 93: | Line 99: | ||
-->}}<!-- | -->}}<!-- | ||
-->[[User:{{{username}}}|{{{username}}}]]<!-- | -->[[User:{{{username}}}|{{{username}}}]]<!-- | ||
--><sup>[[User talk:{{{username}}}|{{int | --><sup>[[User talk:{{{username}}}|{{int|talkpagelinktext}}]]</sup><!-- | ||
-->{{#ifeq: {{{username}}}|{{{author|{{{username}}}<!-- -->}}}|<!-- | -->{{#ifeq: {{{username}}}|{{{author|{{{username}}}<!-- -->}}}|<!-- | ||
nothing | nothing | ||
Line 107: | Line 113: | ||
<tr> | <tr> | ||
<td>'''{{ll|Template:Extension#maintainer|2=<translate><!--T:46--> Maintainer(s)</translate>}}'''</td> | <td>'''{{ll|Template:Extension#maintainer|2=<translate><!--T:46--> Maintainer(s)</translate>}}'''</td> | ||
<td>{{#ifexist:User:{{{maintainer}}}|[[User:{{{maintainer}}}]]<sup>[[User talk:{{{maintainer}}}|{{int | <td>{{#ifexist:User:{{{maintainer}}}|[[User:{{{maintainer}}}]]<sup>[[User talk:{{{maintainer}}}|{{int|talkpagelinktext}}]]</sup>|{{{maintainer}}}}}</td> | ||
</tr> | </tr> | ||
}} | }} | ||
Line 113: | Line 119: | ||
<tr> | <tr> | ||
<td>'''{{ll|Template:Extension#version|2=<translate><!--T:15--> Latest version</translate>}}'''</td> | <td>'''{{ll|Template:Extension#version|2=<translate><!--T:15--> Latest version</translate>}}'''</td> | ||
<td>{{#invoke:extension|getVersion|{{{latest release version|{{{latest_release_version|{{{version|}}}}}}}}}}}{{#if:{{{latest release date|{{{latest_release_date|{{{update|}}}}}}}}}| ({{{latest release date|{{{latest_release_date|{{{update}}} | <td>{{#invoke:extension|getVersion|{{{latest release version|{{{latest_release_version|{{{version|}}}}}}}}}}}{{#if:{{{latest release date|{{{latest_release_date|{{{update|}}}}}}}}}| ({{{latest release date|{{{latest_release_date|{{{update}}}}}}}}})}}</td> | ||
</tr> | </tr> | ||
}} | }} | ||
Line 126: | Line 132: | ||
<td>'''{{ll|Compatibility#mediawiki_extensions|2=<translate><!--T:43--> Compatibility policy</translate>}}'''</td> | <td>'''{{ll|Compatibility#mediawiki_extensions|2=<translate><!--T:43--> Compatibility policy</translate>}}'''</td> | ||
<td>{{#switch:{{{compatibility policy}}}<!-- | <td>{{#switch:{{{compatibility policy}}}<!-- | ||
-->|master=<translate><!--T: | -->|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: | -->|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: | -->|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]]}}}}<!-- | -->|#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> | -->}}</td> | ||
Line 134: | Line 140: | ||
|{{#ifeq:{{{templatemode|<noinclude>nocats</noinclude>}}}|nocats|<!-- do nothing -->|<!--else-->{{#if:{{#translation:}}||[[Category:Extensions without a compatibility policy]]}}}} | |{{#ifeq:{{{templatemode|<noinclude>nocats</noinclude>}}}|nocats|<!-- do nothing -->|<!--else-->{{#if:{{#translation:}}||[[Category:Extensions without a compatibility policy]]}}}} | ||
}} | }} | ||
<tr> | <tr> | ||
<td>{{ll|Template:Extension#mediawiki|'''MediaWiki'''}}</td> | <td>{{ll|Template:Extension#mediawiki|'''MediaWiki'''}}</td> | ||
<td>{{{mediawiki}}}</td> | <td>{{#invoke:Extension |getMediaWikiRequirement |{{{mediawiki|}}} }}</td> | ||
</tr> | </tr> | ||
{{#if:{{{php|}}}| | {{#if:{{{php|}}}| | ||
<tr> | <tr> | ||
Line 148: | Line 152: | ||
{{#if:{{{needs-updatephp|{{#invoke:Extension|getNeedsUpdates}}}}}| | {{#if:{{{needs-updatephp|{{#invoke:Extension|getNeedsUpdates}}}}}| | ||
<tr> | <tr> | ||
<td>{{ll|Template:Extension#needs-updatephp|2=<abbr title="<translate><!--T:17--> <tvar | <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> | <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> | </tr> | ||
Line 154: | Line 158: | ||
{{#if:{{{composer|}}}| | {{#if:{{{composer|}}}| | ||
<tr> | <tr> | ||
<td>{{ll|Composer|2=<abbr title="<translate><!--T:19--> Supports 'Composer' for installation</translate>">'''Composer'''</abbr>}}</td> | <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> | <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> | </tr> | ||
Line 233: | Line 237: | ||
-->{{#if:{{{changelog|}}}|<br />{{{changelog}}}<!-- -->}}</td> | -->{{#if:{{{changelog|}}}|<br />{{{changelog}}}<!-- -->}}</td> | ||
</tr> | </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|}}}| | {{#if:{{{example|}}}| | ||
<tr> | <tr> | ||
Line 285: | Line 295: | ||
<td class="mw-collapsible mw-collapsed" colspan="2"> | <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> | <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> | </td> | ||
</tr> | </tr> | ||
Line 293: | Line 303: | ||
<td class="mw-collapsible mw-collapsed" colspan="2"> | <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> | <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>|<!-- | -->{{Foreach|Extension/HookProvided|delim=</li><li>|<!-- | ||
-->{{{newhook1}}}|{{{newhook2|}}}|{{{newhook3|}}}|{{{newhook4|}}}|{{{newhook5|}}}|{{{newhook6|}}}|<!-- | -->{{{newhook1}}}|{{{newhook2|}}}|{{{newhook3|}}}|{{{newhook4|}}}|{{{newhook5|}}}|{{{newhook6|}}}|<!-- | ||
Line 311: | Line 321: | ||
-->{{{newhook85|}}}|{{{newhook86|}}}|{{{newhook87|}}}|{{{newhook88|}}}|{{{newhook89|}}}|{{{newhook90|}}}<!-- | -->{{{newhook85|}}}|{{{newhook86|}}}|{{{newhook87|}}}|{{{newhook88|}}}|{{{newhook89|}}}|{{{newhook90|}}}<!-- | ||
-->}}<!-- | -->}}<!-- | ||
--></li></ul> | --></li></ul>{{endplainlist}} | ||
</td> | </td> | ||
</tr> | </tr> | ||
Line 324: | Line 334: | ||
<tr> | <tr> | ||
<td colspan="2" style="text-align:center;"> | <td colspan="2" style="text-align:center;"> | ||
<translate><!--T: | {{#if:{{{translate|}}} | ||
</tr>}} | |<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'. | 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 | -->{{#if:{{{nousage|{{#ifeq:{{{templatemode|<noinclude>nocats</noinclude>}}}|nocats | ||
Line 339: | Line 351: | ||
}}}}} | }}}}} | ||
|<!-- no usage -->| | |<!-- no usage -->| | ||
<span style="white-space:nowrap"><translate><!--T:33--> [[<tvar | <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> | </tr> | ||
{{#if:{{{vagrant-role|}}} | | }} | ||
{{#if:{{{vagrant-role|}}}| | |||
<tr> | <tr> | ||
<td>'''{{ll|MediaWiki-Vagrant#Using roles|2=<translate><!--T:34--> Vagrant role</translate>}}'''</td> | <td>'''{{ll|MediaWiki-Vagrant#Using roles|2=<translate><!--T:34--> Vagrant role</translate>}}'''</td> | ||
Line 356: | Line 370: | ||
</tr> | </tr> | ||
}} | }} | ||
{{#if: {{{github|}}} | | {{#if: {{{github|}}} | | ||
<tr> | <tr> | ||
Line 364: | Line 377: | ||
</tr> | </tr> | ||
}} | }} | ||
</table><!-- | </table><!-- | ||
-->{{#ifeq:{{{templatemode|<noinclude>nocats</noinclude>}}}|nocats|<!-- | -->{{#ifeq:{{{templatemode|<noinclude>nocats</noinclude>}}}|nocats|<!-- | ||
Line 375: | Line 387: | ||
-->}}<!-- -->}}<!-- | -->}}<!-- -->}}<!-- | ||
-->[[Category:All extensions{{#translation:}}]]<!-- | -->[[Category:All extensions{{#translation:}}]]<!-- | ||
-->{{#invoke:Extension|getExtensionJsonCategory}}<!-- | |||
-->}}<!-- | -->}}<!-- | ||
--><!--Check if the source page was deleted/archived--> {{#invoke:Extension|maintenanceLinks}} | --><!--Check if the source page was deleted/archived--> {{#invoke:Extension|maintenanceLinks}} | ||
Line 382: | Line 395: | ||
{{intricate template}} | {{intricate template}} | ||
{{lua|Module:Extension|Module:ExtensionJson|Module:String}} | {{lua|Module:Extension|Module:ExtensionJson|Module:String}} | ||
{{Uses TemplateStyles|Template:Extension/styles.css}} | {{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> | <translate> | ||
== Usage == <!--T:50--> | == Usage == <!--T:50--> | ||
</translate> | </translate> | ||
Line 429: | Line 439: | ||
|readme = | |readme = | ||
|changelog = | |changelog = | ||
|help = | |||
|example = | |example = | ||
|namespace = | |namespace = | ||
Line 440: | Line 451: | ||
}}</pre> | }}</pre> | ||
<translate><!--T:52--> For help with parameter values, see [[<tvar | <translate><!--T:52--> For help with parameter values, see [[<tvar name=1>#Content parameters</tvar>|below]].</translate></td> | ||
<td align="right">{{Extension |templatemode=nocats | <td align="right">{{Extension |templatemode=nocats | ||
|name = {{{name}}} | |name = {{{name}}} | ||
Line 452: | Line 463: | ||
|username = SomeUser | |username = SomeUser | ||
|author = SomeAuthor | |author = SomeAuthor | ||
|image = Placeholder. | |image = Placeholder.svg | ||
|version = {{{version}}} | |version = {{{version}}} | ||
|update = {{{update}}} | |update = {{{update}}} | ||
Line 468: | Line 479: | ||
|readme = {{{readme}}} | |readme = {{{readme}}} | ||
|changelog = {{{changelog}}} | |changelog = {{{changelog}}} | ||
|help = {{{help}}} | |||
|example = {{{example}}} | |example = {{{example}}} | ||
|namespace = {{{namespace}}} | |namespace = {{{namespace}}} | ||
Line 485: | Line 497: | ||
<translate> | <translate> | ||
== Content parameters == <!--T:53--> | == Content parameters == <!--T:53--> | ||
</translate> | </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: | <!-- BEFORE YOU EDIT THIS: | ||
span ids on each parameter are used by the code in Template:Extension. | span ids on each parameter are used by the code in Template:Extension. | ||
Line 507: | Line 515: | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td><span id="status">'''status'''</span></td><td>'''<translate><!--T:60--> current release status</translate>''' | <td><span id="status">'''status'''</span></td><td> | ||
<translate> | '''<translate><!--T:60--> current release status</translate>''' | ||
<!--T:158--> | <translate><!--T:158--> One of:</translate> | ||
One of: | |||
</translate> | |||
* ''{{ll|Category:Unstable extensions|unstable}}'' - <translate><!--T:159--> broken - do not use this extension</translate> | * ''{{ll|Category:Unstable extensions|unstable}}'' - <translate><!--T:159--> broken - do not use this extension</translate> | ||
Line 518: | Line 524: | ||
* ''{{ll|Category:Stable extensions|stable}}'' - <translate><!--T:228--> stable version</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: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> | * ''{{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> | <translate> | ||
<!--T:163--> | <!--T:163--> | ||
* [[<tvar | * [[<tvar name=1>Special:MyLanguage/Extension status</tvar>|release status colour scheme]]</translate></td> | ||
</tr> | </tr> | ||
<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 --> | <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> | <translate><!--T:164--> The implementation strategy(s) employed in building this extension.</translate> | ||
<!--T:164--> | <translate><!--T:165--> This parameter is used to create categories that help programmers find examples of various MediaWiki specific implementation strategies or patterns.</translate> | ||
The implementation strategy(s) employed in building this extension.</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> | <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> | ||
<!--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 | |||
<!--T:168--> | <translate><!--T:168--> Allowed values for the '''type1''', '''type2''', ... parameters are:</translate> | ||
Allowed values for the '''type1''', '''type2''', ... parameters are: | |||
</translate> | |||
* '''''{{ll|Category:Parser extensions|parser}}''''' - <translate><!--T:213--> catchall for uncategorized [[<tvar | * '''''{{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 | ** ''{{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 | ** ''{{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> | ||
** ''{{ll|Category:Parser function extensions|parser function}}'' - <translate><!--T:217--> custom [[<tvar | ** ''{{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> | ||
** ''{{ll|Category:Tag extensions|tag}}'' - <translate><!--T:218--> [[<tvar | ** ''{{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 | ** ''{{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> | ||
** ''{{ll|Category:Extended syntax extensions|extended syntax}}'' - <translate><!--T:220--> Extensions that add non-standard wiki syntax (i.e. <em>not</em> [[<tvar | ** ''{{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> | ||
*: | *: | ||
* {{ll|Category:User access extensions|'''''access'''''}} - <translate><!--T:169--> catchall for <tvar | * {{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> | ||
** {{ll|Category:User activity extensions|''user activity''}} - <translate><!--T:221--> extensions that monitor user activity (logins, logouts, new user creation, etc.)</translate> | ** {{ll|Category:User activity extensions|''user activity''}} - <translate><!--T:221--> extensions that monitor user activity (logins, logouts, new user creation, etc.)</translate> | ||
** {{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> | ** {{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> | ||
** {{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 | ** {{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> | ||
* {{ll|Category:User interface extensions|'''''interface'''''}} - <translate><!--T:170--> catchall for uncategorized user interface extensions.</translate> | * {{ll|Category:User interface extensions|'''''interface'''''}} - <translate><!--T:170--> catchall for uncategorized user interface extensions.</translate> | ||
** ''{{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 | ** ''{{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> | ||
** ''{{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: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> | ** {{ll|Category:Notification extensions|''notify''}} - <translate><!--T:234--> extensions that email users, broadcast messages and provide other forms of community notification</translate> | ||
** ''{{ll|Category:Page action extensions|''page action''}}'' - <translate><!--T:235--> extensions that enhance or modify <tvar | ** ''{{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> | ||
** {{ll|Category:Search extensions|''search''}} - <translate><!--T:236--> extensions that search through and select pages for users.</translate> | ** {{ll|Category:Search extensions|''search''}} - <translate><!--T:236--> extensions that search through and select pages for users.</translate> | ||
** {{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> | ** {{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> | ||
** {{ll|Category:Ajax extensions|''ajax''}} - <translate><!--T:238--> extensions that use [[w:AJAX|Ajax]] programming techniques.</translate> | ** {{ll|Category:Ajax extensions|''ajax''}} - <translate><!--T:238--> extensions that use [[w:AJAX|Ajax]] programming techniques.</translate> | ||
** {{ll|Category:Special page extensions|''special''}} - <translate><!--T:239--> extensions that subclass the <tvar | ** {{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> | ||
* '''other''' | * '''other''' | ||
** {{ll|Category:API extensions|''api''}} - <translate><!--T:240--> extensions that add a new API module or extend a core API module.</translate> | ** {{ll|Category:API extensions|''api''}} - <translate><!--T:240--> extensions that add a new API module or extend a core API module.</translate> | ||
Line 581: | Line 571: | ||
** {{ll|Category:File repository extensions|''filerepo''}} - <translate><!--T:244--> extension that adds new file repository types as file backend</translate> | ** {{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> | ** {{ll|Category:Extension examples|''example''}} - <translate><!--T:245--> Not a real extension, but an example of how to write one</translate> | ||
** {{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> | |||
** {{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> | |||
<translate> | <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> | ||
<!--T:173--> | |||
Note: Many extensions have more than one type, if this applies to yours, replace <tvar | |||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td><span id="hook">'''hook1'''</span><br/>''hook2''<br/>''hook3''<br/>''hook4''<br/>...</td> | <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>''' | <td valign="top">'''<translate><!--T:62--> name of each hook used by the extension</translate>''' | ||
<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> | |||
<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> | |||
<translate> | <translate> | ||
<!--T:177--> | <!--T:177--> | ||
For built-in hooks: | For built-in hooks: | ||
* use the hook name alone. Please see <tvar | * use the hook name alone. Please see <tvar name=manual>{{ll|Manual:Hooks|Manual:Hooks}}</tvar> for values (but omit introductory '/'). | ||
<!--T:178--> | <!--T:178--> | ||
For custom hooks defined by extensions: | For custom hooks defined by extensions: | ||
* use <tvar | * use <tvar name=form>''extensionName''/''hookName''</tvar>. For a partial list of custom hooks, see <tvar name=exthooks>[[Extension hook registry]]</tvar>. | ||
<!--T:179--> | <!--T:179--> | ||
Line 615: | Line 599: | ||
<tr> | <tr> | ||
<td><span id="newhook">'''newhook1'''</span><br/>''newhook2''<br/>''newhook3''<br/>''newhook4''<br/>...<br/>''newhook90''</td> | <td><span id="newhook">'''newhook1'''</span><br/>''newhook2''<br/>''newhook3''<br/>''newhook4''<br/>...<br/>''newhook90''</td> | ||
<td valign="top"><translate><!--T:180--> | <td valign="top"> | ||
<translate> | |||
<!--T:180--> | |||
'''name of each hook provided by the extension''' | '''name of each hook provided by the extension''' | ||
<!--T:181--> | <!--T:181--> | ||
You might also want to add the hooks to <tvar | You might also want to add the hooks to <tvar name=exthooks>[[Extension hook registry]]</tvar>. | ||
</translate> | |||
</td> | |||
</tr> | </tr> | ||
<tr> | <tr> | ||
<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 | <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> | </tr> | ||
<tr> | <tr> | ||
Line 631: | Line 619: | ||
</tr> | </tr> | ||
<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 | <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> | ||
<tr> | <tr> | ||
Line 643: | Line 631: | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td><span id="compatibility_policy">compatibility policy</span></td><td><translate><!--T:77--> {{<tvar | <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> | ||
<tr> | <tr> | ||
<td>{{visible anchor|mediawiki}}</td><td><translate><!--T:79--> | <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> | ||
<tr> | <tr> | ||
Line 652: | Line 640: | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>{{visible anchor|needs-updatephp}}</td><td><translate><!--T:194--> | <td>{{visible anchor|needs-updatephp}}</td> | ||
<tvar | <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--> | <!--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 | 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> | {{$IP}}</td> | ||
</tr> | </tr> | ||
<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 | <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> | ||
<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> | <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> | <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> | ||
<!--T:205--> | |||
Links to a subpage of your extension page. For instance, "<tvar | |||
</tr> | </tr> | ||
<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 | <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> | ||
<tr> | <tr> | ||
<td><span id="download">'''download'''</span></td><td><translate><!--T:207--> '''link to the download''' : <tvar | <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> | </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 | <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> | <tr> | ||
<td>{{visible anchor|readme}}</td><td><translate><!--T:208--> external link to the <tvar | <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> | ||
<tr> | <tr> | ||
<td>{{visible anchor|changelog}}</td><td><translate><!--T:209--> external link to the changelog file, e.g. <tvar | <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> | ||
<tr> | <tr> | ||
Line 691: | Line 683: | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>{{visible anchor|tags}}</td><td><translate><!--T:198--> any tags your extension uses (e.g. <tvar | <td>{{visible anchor|tags}}</td><td><translate><!--T:198--> any tags your extension uses (e.g. <tvar name=tags><tag1>, <tag2></tvar>).</translate></td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>{{visible anchor|rights}}</td><td><translate><!--T:210--> [[<tvar | <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> | ||
<tr> | <tr> | ||
<td>{{visible anchor|namespace}}</td><td><translate><!--T:199--> [[<tvar | <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> | ||
<tr> | <tr> | ||
Line 703: | Line 698: | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>{{visible anchor|compatibility}}</td><td><translate><!--T:211--> Additional compatibility information, for instance compatibility charts | <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> | ||
<tr> | <tr> | ||
<td>{{visible anchor|translate}}</td><td><translate><!--T:212--> | <td>{{visible anchor|translate}}</td> | ||
Optional parameter to link the exact page where ([[<tvar | <td> | ||
* <tvar | <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 | * the parameter you get in the URL after | ||
** typing the name of the extension in the search/filter box at <tvar | ** 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 | ** 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> | ||
<tr> | <tr> | ||
Line 735: | Line 735: | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td>'''templatemode'''</td><td><translate><!--T:191--> | <td>'''templatemode'''</td> | ||
<td> | |||
<translate> | |||
<!--T:191--> | |||
'''Controls auto-categorization of host page.''' | '''Controls auto-categorization of host page.''' | ||
Line 741: | Line 744: | ||
Normally left blank. Alternate values are: | Normally left blank. Alternate values are: | ||
</translate> | </translate> | ||
* ''nocats'' - <translate><!--T:224--> suppresses categorization and the 'check usage' link. Use this value if you are adding this template to [[<tvar | * ''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 | * ''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> | <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> | ||
<!--T:193--> | |||
If this is left blank, this template will add the host page to <tvar | |||
</tr> | </tr> | ||
</table> | </table> | ||
Line 756: | Line 757: | ||
<!--T:85--> | <!--T:85--> | ||
If you want to add the infobox to an existing page, copy and paste the code at the [[<tvar | 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--> | === Create a new extension page === <!--T:86--> | ||
</translate> | </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}} | {{Extension/CreateExtensionInputBox}} | ||
Line 771: | Line 771: | ||
<translate> | <translate> | ||
== Enhancing this template == <!--T:89--> | == 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> | <translate> | ||
=== The Create extension button === <!--T:92--> | === The Create extension button === <!--T:92--> | ||
Line 784: | Line 782: | ||
<!--T:182--> | <!--T:182--> | ||
* '''<tvar | * '''<tvar name=extsample>{{ll|Template:Extension/Sample}}</tvar>:''' The boilerplate extension that is preloaded into newly-created pages. | ||
* '''<tvar | * '''<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--> | === Infobox parameters === <!--T:183--> | ||
Line 793: | Line 791: | ||
<!--T:185--> | <!--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 | * 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--> | <!--T:186--> | ||
To change/correct/add to the implementation type parameters: | To change/correct/add to the implementation type parameters: | ||
* Check the [[<tvar | * Check the [[<tvar name=url>Template_talk:Extension</tvar>|talk page]] - there have been some extensive discussions about this field.</translate> | ||
<translate> | <translate> | ||
<!--T:247--> | <!--T:247--> | ||
* The valid types and what they link to are defined at <tvar | * The valid types and what they link to are defined at <tvar name=1>[[Module:Extension]]</tvar> | ||
<!--T:187--> | <!--T:187--> | ||
Line 806: | Line 804: | ||
<!--T:188--> | <!--T:188--> | ||
* '''<tvar | * '''<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 | * '''<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--> | == Test case == <!--T:189--> | ||
Line 822: | Line 820: | ||
[[Special:WhatLinksHere/Template:Extension/vulnerabilities|vulnerabilities]], | [[Special:WhatLinksHere/Template:Extension/vulnerabilities|vulnerabilities]], | ||
[[Special:WhatLinksHere/Template:Extension/archived|archived]] | [[Special:WhatLinksHere/Template:Extension/archived|archived]] | ||
</noinclude> | </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