WPRDC Wiki

Difference between revisions of "Template:Extension/doc"

Template:Extension/doc (view source)

Revision as of 23:55, 20 October 2021

5,588 bytes added ,  23:55, 20 October 2021
Drop parameters that aren't supported from the TemplateData
>Pppery
(Drop parameters that aren't supported from the TemplateData)
 
(144 intermediate revisions by 79 users not shown)
Line 1: Line 1:
<noinclude>{{Documentation subpage}}</noinclude>
<noinclude>{{Documentation subpage}}
 
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
<!---->
</noinclude>== TemplateData ==
This template should be added to all extension pages on this wiki (but only the main page).  It will add a useful infobox (see below) and will automatically add the extension to [[:Category:All extensions]], along with the appropriate [[:Category:Extensions by status|status]] and [[:Category:Extensions by implementation type|implementation type]] categories.
{{collapse top|title=TemplateData}}
 
{{TemplateData header|editlinks=1|docpage=Extension/doc}}
== Usage ==
<templatedata>
 
{
{| width="100%"
"description": "An infobox for a MediaWiki extension.",
|-
"params": {
! width=40% |
"status": {
! width=60% |
"description": "Current release status. One of: unstable, experimental, beta, stable, unmaintained, unknown.",
|- valign="top"
"default": "unknown",
| align="left" |
"label": "Status",
<span id="CutAndPaste">Copy and paste:</span>
"type": "string",
<pre>{{Extension|templatemode =
"example": "stable",
|name           =
"suggested": true
|status          =
},
|type1          =
"name": {
|type2          =
"description": "Name of the extension",
|hook1          =
"label": "Name",
|hook2          =
"type": "string",
|username        =
"default": "Current page name",
|author          =
"suggested": true
|description     =
},
|image          =
"license": {
|imagesize      =
"description": "Extension's license.",
|version        =
"label": "License",
|update          =
"type": "string",
|version preview =
"suggested": true
|update preview  =
},
|mediawiki      =
"templatemode": {
|php            =
"description": "Controls auto-categorization of host page. Normally left blank. Alternate values are: nocats, nousage.",
|needs-updatephp =
"label": "Mode"
|table1          =
},
|table2          =
"image": {
|license        =
"description": "Screenshot or logo of extension. It should be provided without namespace and without [[]]s.",
|download        =
"label": "Screenshot or logo",
|readme          =
"example": "Example.jpg",
|changelog      =
"type": "wiki-file-name",
|parameters      =
"suggested": true
|tags            =
},
|rights          =
"imagesize": {
|example        =
"description": "Optional size of the image",
|compatibility  =
"label": "Image size",
|bugzilla        =
"default": "220"
}}</pre>
},
 
"type": {
For help with parameter values, see [[#Content parameters|below]].
"description": "Implementation type. If more that one type is required, use \"Primary type\", \"Secondary type\", ... instead",
 
"label": "Type",
| align="right"|{{Extension|templatemode=nocats
"type": "string",
|name = {{{name}}}
"suggested": true
|status        = {{{status}}}
},
|type1         = {{{type1}}}
"type1": {
|type2        = {{{type2}}}
"description": "Implementation type. See detailed doc.",
|hook1        = hook1
"label": "Primary type",
|hook2        = hook2
"type": "string"
|username      = SomeUser
},
|author        = SomeAuthor
"type2": {
|image        = Placeholder.png
"description": "Implementation type. See detailed doc.",
|version      = {{{version}}}
"label": "Secondary type"
|update        = {{{update}}}
},
|version preview = {{{version preview}}}
"type3": {
|update preview = {{{update preview}}}
"description": "Implementation type. See detailed doc.",
|mediawiki    = {{{mediawiki}}}
"label": "Third type",
|php          = {{{php}}}
"type": "string"
|needs-updatephp = {{{needs-updatephp}}}
},
|table1        =
"type4": {
|table2        =
"description": "Implementation type. See detailed doc.",
|license      = {{{license}}}
"label": "Fourth type",
|download      = {{{download}}}
"type": "string"
|readme        = {{{readme}}}
},
|changelog    = {{{changelog}}}
"type5": {
|description   = {{{description}}}
"description": "Implementation type. See detailed doc.",
|parameters    = {{{parameters}}}
"label": "Fifth type",
|tags          = {{{tags}}}
"type": "string"
|rights        = {{{rights}}}
},
|namespace    = {{{namespace}}}
"type6": {
|example      = {{{example}}}
"description": "Implementation type. See detailed doc.",
|compatibility = {{{compatibility}}}
"label": "Sixth type",
|bugzilla      = {{{bugzilla}}}
"type": "string"
|pagedrive1 = true
},
|demo = true
"description": {
}}
"description": "Short description",
|}
"label": "Description",
<br style="clear:both"/>
"suggested": true
 
},
== Content parameters ==
"author": {
 
"description": "The extension author's name, if different from their MediaWiki.org username. Free text. If omitted then the 'username' field will be used (if present).",
This section describes parameters that govern infobox content. For help with '''templatemode''' and other control parameters, please see ''[[#Control parameters|Control parameters]]''.
"label": "Author",
 
"suggested": true
<!-- BEFORE YOU EDIT THIS:
},
    span ids on each parameter are used by the code in Template:Extension.
"username": {
    They enable each label in the info box to link its documentation.
"description": "The author's username on MediaWiki.org (if they have one). May be omitted, but if present it will be used to link to the author's user & user_talk page. It should be provided without namespace and without [[]]s.",
    If you change an id, please update the code in Template:Extension accordingly.
"label": "Username"
--> 
},
{| class="wikitable"
"mediawiki": {
|+ '''Content parameters'''
"description": "Required versions of MediaWiki. Not needed if this information is in extension.json.",
|-
"label": "MediaWiki version",
! Parameter
"example": ">= 1.35",
! Description
"type": "string",
|-
"deprecated": "This value will be read from extension.json where possible."
|<span id="name">'''name'''</span> || '''name of the extension'''
},
|-
"php": {
|<span id="status">'''status'''</span> || '''current release status'''
"description": "Required version of PHP",
One of:  
"label": "PHP version",
* ''[[:Category:Unstable extensions|unstable]]'' (broken - do not use this extension)
"example": "5.4+",
* ''[[:Category:Experimental extensions|experimental]]'' (early stages of development, may change drastically)
"type": "string"
* ''[[:Category:Beta status extensions|beta]]'' (stable but not fully tested)
},
* ''[[:Category:Stable extensions|stable]]'' (stable version)
"needs-updatephp": {
* ''[[:Category:Not LTS ready|unmaintained]]'' (unmaintained - previously claimed to be stable, now unmaintained)
"description": "Yes indicates that the extension requires a database table schema change or a similar action, before the MediaWiki can run. It is a common pitfall: your MediaWiki will stall, if you forgot to run update.php - if the extension requires it. No should be set as a value since this assures that the extension does not need update.php to be run and thus avoids uncertainty.",
* ''[[:Category:Extensions with unknown status|unknown]]'' (default)
"label": "Needs update.php",
If the status is anything other than the above, it will be ignored and the default value of 'Unknown' will be displayed in the template instead. In cases where the value is omitted, it will be categorized as [[:category:extensions with unknown status|unknown]]. In cases where the value is invalid, it will be placed in a [[:category:extensions with invalid status|special category]] so that the error can be caught and fixed.
"type": "boolean"
* [[Extension status|release status colour scheme]]
},
|-
"composer": {
| '''type1'''<br/>''type2''<br/>''type3''<br/>''type4''<br/>''type5''<br/>''type6''<br/> || <span id="type">'''implementation type'''</span><!-- id here so at top of documentation -->
"description": "If applicable the name of the \"vendor\" as well as the \"package\" should be entered in the format vendor/package, e.g. mediawiki/semantic-media-wiki to point people directly to packagist.org, which serves as the package archive.",
 
"label": "Composer package name",
The  implementation strategy(s) employed in building this extension. This parameter is used to create categories that help programmers find examples of various MediaWiki specific implementation strategies or patterns. Although the values of this parameter sometimes coincide with the use case or purpose of an extension, that is not reason for this parameter. If the values you have chosen for this parameter do not adequately identify the [[w:Requirements|purpose]] or possible [[w:Use case|use case]]s, we recommend you add additional [[Help:Categories|category links]] as needed.
"example": "mediawiki/semantic-media-wiki",
 
"type": "string"
 
},
Legal values for the '''type1''', '''type2''', ... parameters are:
"phabricator": {
* '''''[[:Category:Parser extensions|parser]]''''' - catchall for uncategorized [[Manual:Extending wiki markup|parser extensions]]. If you have written a parser extension, please use one of the following more specific types:
"example": "MediaWiki-extensions-Babel",
** ''[[:Category:ContentHandler extensions|contenthandler]]'' - Extensions using [[Manual:ContentHandler|ContentHandler]].
"type": "string",
** ''[[:Category:Link markup extensions|link]]'' - customized [[Manual:Extending wiki markup|link markup]], e.g. <code><nowiki>[[</nowiki>...]]</code>
"suggested": true,
** ''[[:Category:Parser function extensions|parser function]]'' - custom [[Manual:Parser functions|parameterized template markup]], e.g. <code><nowiki>{{</nowiki>''#name:'' ... }}</code>
"label": "Phabricator project name"
** ''[[:Category:Tag extensions|tag]]'' - [[Manual:Tag extensions|custom XML tag markup]], e.g. <code><nowiki><</nowiki>''tagname''>...<nowiki></</nowiki>''tagname''></code>
},
** ''[[:Category:Variable extensions|variable]]'' - custom [[Manual:Variables|unparameterized template markup]], e.g. <code><nowiki>{{NAME}}</nowiki></code>
"table1": {
** ''[[:Category:Extended syntax extensions|extended syntax]]'' - Extensions that add non-standard wiki syntax (i.e. <em>not</em> [[Manual:Tag extensions|tags]], [[Manual:Parser functions|parser functions]], or [[Manual:Variables|variables]]).
"description": "Name of a non-core table used by the extension.",
*:
"label": "Non-core table 1",
* [[:Category:User access extensions|'''''access''''']] - catchall for [[Manual:User access extensions|user access extensions]], that is, extensions that create, authenticate, grant permissions, revoke permissions, or monitor the activity of users. If you have written an access extension, please use one of the following more specific types:
"type": "string"
** [[:Category:User activity extensions|''user activity'']] - extensions that monitor user activity (logins, logouts, new user creation, etc.)
},
** [[:Category:User identity extensions|''user identity'']] - extensions that create and delete users, and/or verify the identity of a user
"table2": {
** [[:Category:User rights extensions|''user rights'']] - extensions to the rights management system, e.g. changes to the way rights are assigned, API, maintenance tools (does not include extensions that merely name the rights needed to use the features of that extension; for this purpose use the [[#rights|rights parameter]])
"description": "Name of a non-core table used by the extension.",
* [[:Category:User interface extensions|'''''interface''''']] - catchall for uncategorized user interface extensions.
"label": "Non-core table 2",
** ''[[:Category:Media handling extensions|media]]'' - extensions that permit the embedding of multimedia content on wiki pages by registering a file extension with [[Manual:$wgMediaHandlers|$wgMediaHandlers]].
"type": "string"
** ''[[:Category:Personalization extensions|mywiki]]'' - extensions that provide infrastructure so that users may personalize their MediaWiki experience and/or assist in the management of that infrastructure
},
** [[:Category:Notification extensions|''notify'']] - extensions that email users, broadcast messages and provide other forms of community notification
"table3": {
** ''[[:Category:Page action extensions|''page action'']]'' - extensions that enhance or modify [[Manual:Page action|page action]]s. This includes anything that implements an action that reads, writes, searches for, creates, renames, deletes, redirects or discusses a page. It does not include rights (use ''user rights'') or logs (use ''user activity'').
"description": "Name of a non-core table used by the extension.",
** [[:Category:Search extensions|''search'']] - extensions that search through and select articles for users.
"label": "Non-core table 3",
** [[:Category:Skin extensions|''skin'']] - extensions adding [[w:CSS|CSS]] or [[w:JavaScript|JavaScript]], or implementing hook functions to change the look and feel of MediaWiki via the skins framework.
"type": "string"
** [[:Category:Ajax extensions|''ajax'']] - extensions that use [[w:Ajax|Ajax]] programming techniques.
},
** [[:Category:Special page extensions|''special'']] - extensions that subclass the [[Manual:SpecialPage class|SpecialPage class]], use one of its hooks, or patch one or more functions in [http://svn.wikimedia.org/doc/SpecialPage_8php-source.html SpecialPage.php]. See [[Manual:Special pages]] for more information.
"table4": {
* '''other'''
"description": "Name of a non-core table used by the extension.",
** [[:Category:API extensions|''api'']] - extensions that add a new API module or extend a core API module.
"label": "Non-core table 4",
** [[:Category:Hook extensions|''hook'']] - Hook extension - defines a <em>new</em> hook - see hook1, etc. below if you want to define hooks <em>used</em> by your extension
"type": "string"
 
},
 
"table5": {
{{note|1=We are in the process of revising the values of this page. Types below this point are likely to be deprecated or redefined. We apologize for the inconvenience. See the [[Template talk:Extension/Archive_1#Type taxonomy|talk on type taxonomy]] for more information.}}
"description": "Name of a non-core table used by the extension.",
* ''[[:Category:Database extensions|database]]'' - adds tables and/or fields to the database backing a MediaWiki installation
"label": "Non-core table 5",
* ''[[:Category:Data extraction extensions|data extraction]]'' - Data extraction
"type": "string"
* ''[[:Category:Extension examples|example]]'' - Not a real extension, but an example of how to write one
},
 
"table6": {
Any other value for 'type' is invalid, and will cause the extension to be placed in [[:Category:Extensions with invalid or missing type]].
"description": "Name of a non-core table used by the extension.",
 
"label": "Non-core table 6",
Note: Many extensions have more than one type, if this applies to yours, replace <code><nowiki>|type=</nowiki></code> with <code><nowiki>|type1=|type2=|type3=...</nowiki></code>. You may define up to six types for an extension.
"type": "string"
|-
},
| <span id="hook">'''hook1'''</span><br/>''hook2''<br/>''hook3''<br/>''hook4''<br/>...<br/>''hook30''
"table7": {
|valign="top"| '''name of each hook used by the extension'''
"description": "Name of a non-core table used by the extension.",
 
"label": "Non-core table 7",
Entering values in this field is a good way to get exposure for your extension and help other developers. Each documented hook will automatically add the extension to a category listing extensions that use that hook. This category is autolinked to each hook article so that programmers can easily find examples of extensions that use a particular hook.
"type": "string"
 
},
For built-in hooks:
"table8": {
* use the hook name alone. Please see [[Manual:Hooks]] for values (but omit introductory '/').
"description": "Name of a non-core table used by the extension.",
 
"label": "Non-core table 8",
For custom hooks defined by extensions:
"type": "string"
* use ''extensionName''/''hookName''. For a partial list of custom hooks, see [[Extension hook registry]].
},
 
"table9": {
For multiple hooks, assign the first hook to '''hook1''', the second to '''hook2''' and so on.
"description": "Name of a non-core table used by the extension.",
|-
"label": "Non-core table 9",
| <span id="username">'''username'''</span> || The author's username on MediaWiki.org (if they have one). May be omitted, but if present it will be used to link to the author's user & user_talk page. It should be provided without namespace and without <nowiki>[[]]</nowiki>s.
"type": "string"
|-
},
| <span id="author">author</span>|| The extension author's name, if different from their MediaWiki.org username. Free text. If omitted then the 'username' field will be used (if present).
"table10": {
|-
"description": "Name of a non-core table used by the extension.",
| <span id="description">'''description'''</span>|| '''short description'''
"label": "Non-core table 10",
|-
"type": "string"
| <span id="image">image</span>|| screenshot or logo of extension. It should be provided without namespace and without <nowiki>[[]]</nowiki>s.
},
|-
"download": {
| <span id="imagesize">imagesize</span>|| ''facultative'', size of the image (default size is 220px)
"description": "External link to download",
|-
"label": "Download link",
| <span id="version">version</span>|| last version
"type": "url"
|-
},
| <span id="update">update</span>|| date of the last update
"readme": {
|-
"description": "External link to the readme file",
| <span id="mediawiki">mediawiki</span>|| required version of MediaWiki
"label": "README link",
|-
"type": "url"
| <span id="php">php</span>|| required version of PHP
},
|-
"changelog": {
| <span id="needs-updatephp">needs-updatephp</span>|| '''''Yes''''' indicates that the extension requires a database table schema change or a similar action, before the MediaWiki can run. It is a common pitfall: your MediaWiki will stall, if you forgot to run update.php - if the extension requires it. '''''No''''' should be set as a value since this assures that the extension does not need update.php to be run and thus avoids uncertainty
"description": "External link to the changelog file",
 
"label": "Changelog link",
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 <code>$IP/extensions/ExtensionName</code> and inserted <code>require_once "$IP/extensions/ExtensionName";</code> to "LocalSettings.php":
"type": "url"
 
},
php $IP/maintenance/update.php
"example": {
 
"description": "Example, website or screenshot of working extension",
{{$IP}}
"label": "Example"
|-
},
| <span id="php">composer</span>|| If applicable the name of the "vendor" as well as the "package" should be entered in the format <code>vendor/package</code>, e.g. <code>mediawiki/semantic-media-wiki</code> to point people directly to packagist.org, which serves as the package archive.
"namespace": {
|-
"description": "Namespace in which this extension is used",
| <span id="table1">'''table1'''</span><br/>''table2''<br/>''table3''<br/>''table4''<br/>...<br/>''table30'' || '''name of each ''non-core'' table used by the extension'''
"label": "Namespace"
 
},
Links to a subpage of your extension page. For instance, "table1 = cu_changes" at [[Extension:CheckUser]] will link to [[Extension:CheckUser/cu_changes table]]. Don't list core tables such as [[Manual:Page table|page]] or [[Manual:Revision table|revision]]; only list tables that are added by extensions.
"parameters": {
|-
"description": "Available parameters for LocalSettings.php",
| <span id="license">license</span>|| license(s) governing use of this extension, e.g. GPL
"label": "Parameters"
|-
},
| <span id="download">'''download'''</span>|| '''link to the download''' : [https://git.wikimedia.org/project/mediawiki Git], {{tl|WikimediaDownload}} with server=svn in case it was not migrated from [http://svn.wikimedia.org/svnroot/mediawiki/trunk/extensions/ SVN]. If you put the code into page in the MediaWiki wiki, link to it using a full page name and section name, e.g. <code> <nowiki>[[Extension:Example/version_1.22a#Code]]</nowiki> </code> (it must remain valid when bot-copied elsewhere)
"tags": {
|-
"description": "Any tags the extension uses",
| <span id="readme">readme</span>|| external link to the readme file, e.g. http://svn.wikimedia.org/svnroot/mediawiki/trunk/extensions/Sort/README
"label": "Tags"
|-
},
| <span id="changelog">changelog</span>|| external link to the changelog file, e.g. [[Extension:LDAP Authentication/Changelog]]
"rights": {
|-
"description": "User rights added by the extension.",
| <span id="parameters">parameters</span> || available parameters for LocalSettings.php
"label": "Rights"
|-
},
| <span id="tags">tags</span> || any tags your extension uses (e.g. &lt;tag1&gt;, &lt;tag2&gt;).
"hook1": {
|-
"description": "Name of a hook used by the extension."
| rights|| <span id="rights">rights</span> added by the extension. '''Not to be confused with the license!''' Rights are such as ''[[Extension:MakeBot|makebot]]'' or ''[[Extension:Desysop|desysop]]'', not such as GFDL or LGPL or GPL - those are licenses!
},
|-
"hook2": {
| <span id="namespace">namespace</span> || namespace in which this extension is used
"description": "Name of a hook used by the extension."
|-
},
| <span id="example">example</span> || example, website or screenshot of working extension
"hook3": {
|-
"description": "Name of a hook used by the extension."
| <span id="compatibility">compatibility</span> || compatibility chart, e.g. [[Template:Extension Testing]]
},
|-
"hook4": {
| <span id="translate">translate</span> || Optional parameter to link the exact page where ([[Help:Extension:Translate/Glossary|message group id]] with which) the extension will be translatable on [[translatewiki.net]] if enabled. If the default link is incorrect, manually set it to:
"description": "Name of a hook used by the extension."
* ext-LOWERCASE(NOSPACES(Label as defined in [https://git.wikimedia.org/blob/translatewiki.git/HEAD/groups%2FMediaWiki%2Fmediawiki-defines.txt config])), aka
},
* the parameter you get in the URL after
"hook5": {
** typing the name of the extension in the search/filter box at [[translatewiki:Special:Translate]] or
"description": "Name of a hook used by the extension."
** searching for its name in [https://translatewiki.net/w/i.php?title=Special%3ALanguageStats&x=D languagestats] after clicking "expand all".
},
|-
"hook6": {
| <span id="bugzilla">bugzilla</span> || Bugzilla MediaWiki extension component name
"description": "Name of a hook used by the extension."
|-
},
| <span id="CheckUsageNameOverride">CheckUsageNameOverride</span> || override the page name used for the check usage link.
"hook7": {
|}
"description": "Name of a hook used by the extension."
 
},
== Control parameters ==
"hook8": {
{| class="wikitable"
"description": "Name of a hook used by the extension."
|+ '''Control parameters'''
},
|-
"hook9": {
! Parameter
"description": "Name of a hook used by the extension."
! Description
},
|-
"hook10": {
| '''templatemode''' || '''Controls auto-categorization of host page.'''
"description": "Name of a hook used by the extension."
 
},
Normally left blank.  Alternate values are:
"hook11": {
* ''nocats'' - suppresses categorization and the 'check usage' link. Use this value if you are adding this template to [[Help:Subpage|subpages]] of an extension or to how-to documentation of extensions. For example, the usage image above sets <code>templatemode=nocats</code> because this isn't an actual extension page and we don't want to add this page to any categories on account of it.
"description": "Name of a hook used by the extension."
* ''nousage'' - suppresses the 'check usage' link. Link is also suppressed if the page is a subpage; it is not in the Extension: namespace; or if suppressed by 'templatemode=nocats'
},
 
"hook12": {
 
"description": "Name of a hook used by the extension."
If this is left blank, this template will add the host page to [[:Category:All extensions]] and to one or more additional categories, depending on the values assigned to the [[#Content parameters|Content parameters]].
},
|}
"hook13": {
 
"description": "Name of a hook used by the extension."
== Using the infobox ==
},
=== Existing extension pages ===
"hook14": {
If you want to add the infobox to an existing page, copy and paste the code at the [[#CutAndPaste|top of this page]].
"description": "Name of a hook used by the extension."
 
},
=== Create a new extension article ===
"hook15": {
 
"description": "Name of a hook used by the extension."
If you want to create a new extension page, enter the name below and click the button. A new page will be created with the infobox template already in place.
},
 
"hook16": {
 
"description": "Name of a hook used by the extension."
{{Extension/CreateExtensionInputBox}}
},
 
"hook17": {
== Enhancing this template ==
"description": "Name of a hook used by the extension."
If you would like to improve on this template, thanks!  This is a complicated template so here is some help along the way:
},
 
"hook18": {
=== Fixing documentation ===
"description": "Name of a hook used by the extension."
If you would like to fix documentation, please be aware that documentation and code is split into two files:
},
* '''[[Template:Extension/Doc]]''' - stores all documentation.
"hook19": {
* '''[[Template:Extension]]''' - stores only the code for the template and a small amount of non-included material (category links, transcluded documentation link).
"description": "Name of a hook used by the extension."
 
},
 
"hook20": {
In addition, [[Template:Extension/Sample]] stores the boiler plate that is preloaded into newly created pages and contains some basic documentation on how to fill in the template parameters. It needs to be kept in sync with [[Template:Extension/Doc]].
"description": "Name of a hook used by the extension."
 
},
=== The Create extension button ===
"hook21": {
To improve the create extension button behavior:
"description": "Name of a hook used by the extension."
* '''[[Template:Extension/Sample]]:''' The boilerplate extension that is preloaded into newly-created pages.
},
* '''[[Template:Extension/CreateExtensionInputBox]]:''' An input box that can be inserted wherever you want users to easily create extensions. For documentation on the <code><nowiki><inputbox></nowiki></code> tag, please see [[Extension:InputBox]].
"hook22": {
* '''[[Extension:MyExtension]]:''' - Defines a placeholder, in case a user accidentally hits the create button without changing the extension name.
"description": "Name of a hook used by the extension."
 
},
=== Infobox parameters ===
"hook23": {
In general:
"description": "Name of a hook used by the extension."
* 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 [[Template:Extension/Doc#Content parameters|content parameter documentation]] and link its label to that documentation.
},
 
"hook24": {
 
"description": "Name of a hook used by the extension."
To change/correct/add to the implementation type parameters:
},
* Check the [[Template_talk:Extension|talk page]] - there have been some extensive discussions about this field.
"hook25": {
* '''[[Template:Extension/TypeSwitch]]:''' Stores the possible values for the type field. Multiple values are implemented by calling this template with [[Template:Foreach]].
"description": "Name of a hook used by the extension."
* '''[[Template:Extension/TypeSwitchNoCats]]:''' Does not need to be modified when adding a new type. Used instead of [[Template:Extension/TypeSwitch]] when this template is used in <code>templatemode=nocats</code>. Templates used with [[Template:Foreach]] can only take one parameter so we need to wrap the call to [[Template:Extension/TypeSwitch]] with another template that sets the mode.
},
* '''[[Template:Extension/Doc]]:''' Documentation for this template needs to be kept in sync with any changes to the implementation type taxonomy.
"hook26": {
 
"description": "Name of a hook used by the extension."
 
},
To change the behavior of the hook parameters:
"hook27": {
* '''[[Template:Extension/HookInUse]]:''' Adds links and categories for a hook in use.  Multiple hooks in use are implemented by calling this template with [[Template:Foreach]].
"description": "Name of a hook used by the extension."
* '''[[Template:Extension/HookInUseNoCats]]:''' Used instead of [[Template:Extension/HookInUse]] when this template is used in <code>templatemode=nocats</code>.  Templates used with [[Template:Foreach]] can only take one parameter so we need to wrap the call to [[Template:Extension/HookInUse]] with another template that sets the mode.
},
 
"hook28": {
== Test case ==
"description": "Name of a hook used by the extension."
See if the following pages are still ok, after edited this template.
},
* [[Extension:Description2]]
"hook29": {
* [[Template:Extension]]
"description": "Name of a hook used by the extension."
},
"hook30": {
"description": "Name of a hook used by the extension."
},
"hook31": {
"description": "Name of a hook used by the extension."
},
"hook32": {
"description": "Name of a hook used by the extension."
},
"hook33": {
"description": "Name of a hook used by the extension."
},
"hook34": {
"description": "Name of a hook used by the extension."
},
"hook35": {
"description": "Name of a hook used by the extension."
},
"hook36": {
"description": "Name of a hook used by the extension."
},
"hook37": {
"description": "Name of a hook used by the extension."
},
"hook38": {
"description": "Name of a hook used by the extension."
},
"hook39": {
"description": "Name of a hook used by the extension."
},
"hook40": {
"description": "Name of a hook used by the extension."
},
"hook41": {
"description": "Name of a hook used by the extension."
},
"hook42": {
"description": "Name of a hook used by the extension."
},
"hook43": {
"description": "Name of a hook used by the extension."
},
"hook44": {
"description": "Name of a hook used by the extension."
},
"hook45": {
"description": "Name of a hook used by the extension."
},
"hook46": {
"description": "Name of a hook used by the extension."
},
"hook47": {
"description": "Name of a hook used by the extension."
},
"hook48": {
"description": "Name of a hook used by the extension."
},
"hook49": {
"description": "Name of a hook used by the extension."
},
"hook50": {
"description": "Name of a hook used by the extension."
},
"hook51": {
"description": "Name of a hook used by the extension."
},
"hook52": {
"description": "Name of a hook used by the extension."
},
"hook53": {
"description": "Name of a hook used by the extension."
},
"hook54": {
"description": "Name of a hook used by the extension."
},
"hook55": {
"description": "Name of a hook used by the extension."
},
"hook56": {
"description": "Name of a hook used by the extension."
},
"hook57": {
"description": "Name of a hook used by the extension."
},
"hook58": {
"description": "Name of a hook used by the extension."
},
"hook59": {
"description": "Name of a hook used by the extension."
},
"hook60": {
"description": "Name of a hook used by the extension."
},
"hook61": {
"description": "Name of a hook used by the extension."
},
"hook62": {
"description": "Name of a hook used by the extension."
},
"hook63": {
"description": "Name of a hook used by the extension."
},
"hook64": {
"description": "Name of a hook used by the extension."
},
"hook65": {
"description": "Name of a hook used by the extension."
},
"hook66": {
"description": "Name of a hook used by the extension."
},
"hook67": {
"description": "Name of a hook used by the extension."
},
"hook68": {
"description": "Name of a hook used by the extension."
},
"hook69": {
"description": "Name of a hook used by the extension."
},
"hook70": {
"description": "Name of a hook used by the extension."
},
"hook71": {
"description": "Name of a hook used by the extension."
},
"hook72": {
"description": "Name of a hook used by the extension."
},
"hook73": {
"description": "Name of a hook used by the extension."
},
"hook74": {
"description": "Name of a hook used by the extension."
},
"hook75": {
"description": "Name of a hook used by the extension."
},
"hook76": {
"description": "Name of a hook used by the extension."
},
"hook77": {
"description": "Name of a hook used by the extension."
},
"hook78": {
"description": "Name of a hook used by the extension."
},
"hook79": {
"description": "Name of a hook used by the extension."
},
"hook80": {
"description": "Name of a hook used by the extension."
},
"hook81": {
"description": "Name of a hook used by the extension."
},
"hook82": {
"description": "Name of a hook used by the extension."
},
"hook83": {
"description": "Name of a hook used by the extension."
},
"hook84": {
"description": "Name of a hook used by the extension."
},
"hook85": {
"description": "Name of a hook used by the extension."
},
"hook86": {
"description": "Name of a hook used by the extension."
},
"hook87": {
"description": "Name of a hook used by the extension."
},
"hook88": {
"description": "Name of a hook used by the extension."
},
"hook89": {
"description": "Name of a hook used by the extension."
},
"hook90": {
"description": "Name of a hook used by the extension."
},
"newhook1": {
"description": "Name of a hook provided by the extension."
},
"newhook2": {
"description": "Name of a hook provided by the extension."
},
"newhook3": {
"description": "Name of a hook provided by the extension."
},
"newhook4": {
"description": "Name of a hook provided by the extension."
},
"newhook5": {
"description": "Name of a hook provided by the extension."
},
"newhook6": {
"description": "Name of a hook provided by the extension."
},
"newhook7": {
"description": "Name of a hook provided by the extension."
},
"newhook8": {
"description": "Name of a hook provided by the extension."
},
"newhook9": {
"description": "Name of a hook provided by the extension."
},
"newhook10": {
"description": "Name of a hook provided by the extension."
},
"newhook11": {
"description": "Name of a hook provided by the extension."
},
"newhook12": {
"description": "Name of a hook provided by the extension."
},
"newhook13": {
"description": "Name of a hook provided by the extension."
},
"newhook14": {
"description": "Name of a hook provided by the extension."
},
"newhook15": {
"description": "Name of a hook provided by the extension."
},
"newhook16": {
"description": "Name of a hook provided by the extension."
},
"newhook17": {
"description": "Name of a hook provided by the extension."
},
"newhook18": {
"description": "Name of a hook provided by the extension."
},
"newhook19": {
"description": "Name of a hook provided by the extension."
},
"newhook20": {
"description": "Name of a hook provided by the extension."
},
"newhook21": {
"description": "Name of a hook provided by the extension."
},
"newhook22": {
"description": "Name of a hook provided by the extension."
},
"newhook23": {
"description": "Name of a hook provided by the extension."
},
"newhook24": {
"description": "Name of a hook provided by the extension."
},
"newhook25": {
"description": "Name of a hook provided by the extension."
},
"newhook26": {
"description": "Name of a hook provided by the extension."
},
"newhook27": {
"description": "Name of a hook provided by the extension."
},
"newhook28": {
"description": "Name of a hook provided by the extension."
},
"newhook29": {
"description": "Name of a hook provided by the extension."
},
"newhook30": {
"description": "Name of a hook provided by the extension."
},
"newhook31": {
"description": "Name of a hook provided by the extension."
},
"newhook32": {
"description": "Name of a hook provided by the extension."
},
"newhook33": {
"description": "Name of a hook provided by the extension."
},
"newhook34": {
"description": "Name of a hook provided by the extension."
},
"newhook35": {
"description": "Name of a hook provided by the extension."
},
"newhook36": {
"description": "Name of a hook provided by the extension."
},
"newhook37": {
"description": "Name of a hook provided by the extension."
},
"newhook38": {
"description": "Name of a hook provided by the extension."
},
"newhook39": {
"description": "Name of a hook provided by the extension."
},
"newhook40": {
"description": "Name of a hook provided by the extension."
},
"newhook41": {
"description": "Name of a hook provided by the extension."
},
"newhook42": {
"description": "Name of a hook provided by the extension."
},
"newhook43": {
"description": "Name of a hook provided by the extension."
},
"newhook44": {
"description": "Name of a hook provided by the extension."
},
"newhook45": {
"description": "Name of a hook provided by the extension."
},
"newhook46": {
"description": "Name of a hook provided by the extension."
},
"newhook47": {
"description": "Name of a hook provided by the extension."
},
"newhook48": {
"description": "Name of a hook provided by the extension."
},
"newhook49": {
"description": "Name of a hook provided by the extension."
},
"newhook50": {
"description": "Name of a hook provided by the extension."
},
"newhook51": {
"description": "Name of a hook provided by the extension."
},
"newhook52": {
"description": "Name of a hook provided by the extension."
},
"newhook53": {
"description": "Name of a hook provided by the extension."
},
"newhook54": {
"description": "Name of a hook provided by the extension."
},
"newhook55": {
"description": "Name of a hook provided by the extension."
},
"newhook56": {
"description": "Name of a hook provided by the extension."
},
"newhook57": {
"description": "Name of a hook provided by the extension."
},
"newhook58": {
"description": "Name of a hook provided by the extension."
},
"newhook59": {
"description": "Name of a hook provided by the extension."
},
"newhook60": {
"description": "Name of a hook provided by the extension."
},
"newhook61": {
"description": "Name of a hook provided by the extension."
},
"newhook62": {
"description": "Name of a hook provided by the extension."
},
"newhook63": {
"description": "Name of a hook provided by the extension."
},
"newhook64": {
"description": "Name of a hook provided by the extension."
},
"newhook65": {
"description": "Name of a hook provided by the extension."
},
"newhook66": {
"description": "Name of a hook provided by the extension."
},
"newhook67": {
"description": "Name of a hook provided by the extension."
},
"newhook68": {
"description": "Name of a hook provided by the extension."
},
"newhook69": {
"description": "Name of a hook provided by the extension."
},
"newhook70": {
"description": "Name of a hook provided by the extension."
},
"newhook71": {
"description": "Name of a hook provided by the extension."
},
"newhook72": {
"description": "Name of a hook provided by the extension."
},
"newhook73": {
"description": "Name of a hook provided by the extension."
},
"newhook74": {
"description": "Name of a hook provided by the extension."
},
"newhook75": {
"description": "Name of a hook provided by the extension."
},
"newhook76": {
"description": "Name of a hook provided by the extension."
},
"newhook77": {
"description": "Name of a hook provided by the extension."
},
"newhook78": {
"description": "Name of a hook provided by the extension."
},
"newhook79": {
"description": "Name of a hook provided by the extension."
},
"newhook80": {
"description": "Name of a hook provided by the extension."
},
"newhook81": {
"description": "Name of a hook provided by the extension."
},
"newhook82": {
"description": "Name of a hook provided by the extension."
},
"newhook83": {
"description": "Name of a hook provided by the extension."
},
"newhook84": {
"description": "Name of a hook provided by the extension."
},
"newhook85": {
"description": "Name of a hook provided by the extension."
},
"newhook86": {
"description": "Name of a hook provided by the extension."
},
"newhook87": {
"description": "Name of a hook provided by the extension."
},
"newhook88": {
"description": "Name of a hook provided by the extension."
},
"newhook89": {
"description": "Name of a hook provided by the extension."
},
"newhook90": {
"description": "Name of a hook provided by the extension."
},
"compatibility": {
"label": "Compatibility chart",
"example": "{{Extension Testing | ... }}"
},
"translate": {
"description": "Optional parameter to link the exact page where (message group id with which) the extension will be translatable on translatewiki.net if enabled.",
"label": "TranslateWiki group",
"example": "ext-discussiontools",
"type": "string"
},
"bugzilla": {
"deprecated": true,
"label": "Bugzilla component name",
"type": "string"
},
"vagrant-role": {
"label": "Vagrant role",
"description": "A MediaWiki-Vagrant role that lets you use this extension",
"type": "string",
"example": "visualeditor"
},
"CheckUsageNameOverride": {
"label": "Check usage link",
"description": "Override the page name used for the check usage link."
},
"compatibility policy": {
"description": "For older versions of MediaWiki, should one use the extension's master branch or the REL1_XX branch corresponding to the MediaWiki version? Allowed values: master, rel, ltsrel",
"type": "string",
"suggested": true,
"label": "Compatibility policy"
},
"latest release date": {
"aliases": [
"update",
"latest_release_date"
],
"label": "Latest version release date",
"suggested": true
},
"latest preview version": {
"aliases": [
"version preview",
"latest_preview_version",
"version_preview"
],
"label": "Latest preview version"
},
"latest release version": {
"aliases": [
"version",
"latest_release_version"
],
"label": "Latest version",
"suggested": true
},
"latest preview date": {
"aliases": [
"update preview",
"latest_preview_date",
"update_preview"
],
"label": "Latest preview version update date"
},
"maintainer": {
"label": "Maintainer",
"description": "Username or other information about who maintains this extension.",
"type": "string"
}
},
"paramOrder": [
"name",
"status",
"license",
"templatemode",
"image",
"imagesize",
"type",
"type1",
"type2",
"type3",
"type4",
"type5",
"type6",
"description",
"author",
"username",
"maintainer",
"latest release version",
"latest release date",
"latest preview version",
"latest preview date",
"compatibility policy",
"mediawiki",
"php",
"needs-updatephp",
"composer",
"phabricator",
"table1",
"table2",
"table3",
"table4",
"table5",
"table6",
"table7",
"table8",
"table9",
"table10",
"download",
"readme",
"changelog",
"example",
"namespace",
"parameters",
"tags",
"rights",
"hook1",
"hook2",
"hook3",
"hook4",
"hook5",
"hook6",
"hook7",
"hook8",
"hook9",
"hook10",
"hook11",
"hook12",
"hook13",
"hook14",
"hook15",
"hook16",
"hook17",
"hook18",
"hook19",
"hook20",
"hook21",
"hook22",
"hook23",
"hook24",
"hook25",
"hook26",
"hook27",
"hook28",
"hook29",
"hook30",
"hook31",
"hook32",
"hook33",
"hook34",
"hook35",
"hook36",
"hook37",
"hook38",
"hook39",
"hook40",
"hook41",
"hook42",
"hook43",
"hook44",
"hook45",
"hook46",
"hook47",
"hook48",
"hook49",
"hook50",
"hook51",
"hook52",
"hook53",
"hook54",
"hook55",
"hook56",
"hook57",
"hook58",
"hook59",
"hook60",
"hook61",
"hook62",
"hook63",
"hook64",
"hook65",
"hook66",
"hook67",
"hook68",
"hook69",
"hook70",
"hook71",
"hook72",
"hook73",
"hook74",
"hook75",
"hook76",
"hook77",
"hook78",
"hook79",
"hook80",
"hook81",
"hook82",
"hook83",
"hook84",
"hook85",
"hook86",
"hook87",
"hook88",
"hook89",
"hook90",
"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",
"compatibility",
"translate",
"vagrant-role",
"CheckUsageNameOverride",
"bugzilla"
]
}</templatedata>
{{collapse bottom}}
<includeonly>{{Sandbox other||
<!-- Categories below this line; interwikis at Wikidata -->
[[Category:Info templates{{#translation:}}]]
[[Category:Extension creation{{#translation:}}]]
[[Category:Categorizing templates{{#translation:}}]]
[[Category:Extension templates{{#translation:}}]]
}}</includeonly>
Anonymous user
Retrieved from "https://wiki.tessercat.net/wiki/Special:MobileDiff/11590...11735"