Difference between revisions of "Template:Extension"

       -->|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 backwards compatible.</translate><!--

<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>

<translate><!--T:32--> [[<tvar name=1>translatewiki:Special:Translate/{{{translate|ext-{{lc:{{#invoke:String|replace|{{PAGENAME:{{translatable}}}}| |}}}}}}}</tvar>|Translate the <tvar name=2>{{PAGENAME:{{translatable}}}}</tvar> extension]] {{<tvar name=3>#if:{{{translate|}}}|</tvar>|if it is available at translatewiki.net}}</translate></td>

<span style="white-space:nowrap"><translate><!--T:33--> [[<tvar name=1>wikiapiary:Extension:{{{CheckUsageNameOverride|{{BASEPAGENAMEE}}}}}</tvar>|Check usage and version matrix.]]</translate></span>

<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><!--T:52--> For help with parameter values, see [[<tvar name=1>#Content parameters</tvar>|below]].</translate></td>

<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>

<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>

* [[<tvar name=1>Special:MyLanguage/Extension status</tvar>|release status colour scheme]]</translate></td>

<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>

* '''''{{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>

** ''{{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 name=1>Special:MyLanguage/Manual:Tag extensions</tvar>|custom XML tag markup]], e.g. <tvar name=2><code><nowiki><</nowiki>''tagname''>...<nowiki></</nowiki>''tagname''></code></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>

** ''{{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 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 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: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: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: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>

<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><!--T:173--> Note: Many extensions have more than one type, if this applies to yours, replace <tvar name=type><code><nowiki>|type=</nowiki></code></tvar> with <tvar name=value><code><nowiki>|type1=|type2=|type3=...</nowiki></code></tvar>. You may define up to six types for an extension.</translate></td>

* use the hook name alone. Please see <tvar name=manual>{{ll|Manual:Hooks|Manual:Hooks}}</tvar> for values (but omit introductory '/').

* use <tvar name=form>''extensionName''/''hookName''</tvar>. For a partial list of custom hooks, see <tvar name=exthooks>[[Extension hook registry]]</tvar>.

You might also want to add the hooks to <tvar name=exthooks>[[Extension hook registry]]</tvar>.</translate></td>

<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>

<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>

<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>

<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

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><code>$IP/extensions/ExtensionName</code></tvar> and inserted <tvar name=code><code>wfLoadExtension( "ExtensionName");</code></tvar> into "LocalSettings.php", run from the command line:</translate>

<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>

<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>

<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>

<td><span id="download">'''download'''</span></td><td><translate><!--T:207--> '''link to the download''' : <tvar name=url>[https://phabricator.wikimedia.org/r/project/mediawiki/core Git]</tvar>, <tvar name=wikimediadownload>{{tl|WikimediaDownload{{#translation:}}}}</tvar>. </translate></td>

<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>

<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>

<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>

<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>

<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>

<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>

<td>{{visible anchor|compatibility}}</td><td><translate><!--T:211--> Additional compatibility information, for instance compatibility charts (formerly using <tvar name=testext>[[Template:Extension Testing]]</tvar>). 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>

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

** 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>

* ''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>

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]].

* '''<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>.

* 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.

* Check the [[<tvar name=url>Template_talk:Extension</tvar>|talk page]] - there have been some extensive discussions about this field.</translate>

* The valid types and what they link to are defined at <tvar name=1>[[Module:Extension]]</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 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.