Difference between revisions of "Template:Extension/doc"

Jump to navigation Jump to search
>Parent5446
(Adding undocumented archive extension status)
Line 29: Line 29:
|version        =  
|version        =  
|update          =  
|update          =  
|version preview =
|update preview  =
|mediawiki      =
|php            =
|needs-updatephp =
|composer        =
|table1          =
|table2          =
|license        =
|download        =
|readme          =
|changelog      =
|example        =
|namespace      =
|parameters      =
|tags            =
|rights          =
|compatibility  =
|bugzilla        =
|phabricator    =
|vagrant-role    =
}}</pre>


For help with parameter values, see [[#Content parameters|below]].
| align="right"|{{ {{TNTN|Extension}} |templatemode=nocats
|name            = {{{name}}}
|status          = {{{status}}}
|type1          = {{{type1}}}
|type2          = {{{type2}}}
|hook1          = hook1
|hook2          = hook2
|newhook1        = newhook1
|newhook1        = newhook1
|newhook2        = newhook2
|newhook2        = newhook2
Line 77: Line 46:
|table2          = {{{table2}}}
|table2          = {{{table2}}}
|license        = {{{license}}}
|license        = {{{license}}}
|download        = {{{download}}}
|download        =
|readme          = {{{readme}}}
|changelog      = {{{changelog}}}
|example        = {{{example}}}
|namespace      = {{{namespace}}}
|description    = {{{description}}}
|parameters      = {{{parameters}}}
|tags            = {{{tags}}}
|rights          = {{{rights}}}
|compatibility  = {{{compatibility}}}
|bugzilla        = {{{bugzilla}}}
|phabricator    = {{{phabricator}}}
|vagrant-role    = {{{vagrant-role}}} 
|pagedrive1      = true
|demo            = true
}}
|}
<br style="clear:both"/>
 
== Content parameters ==


This section describes parameters that govern infobox content. For help with '''templatemode''' and other control parameters, please see ''[[#Control parameters|Control parameters]]''.
This section describes parameters that govern infobox content. For help with '''templatemode''' and other control parameters, please see ''[[#Control parameters|Control parameters]]''.
Line 105: Line 55:
     If you change an id, please update the code in Template:Extension accordingly.
     If you change an id, please update the code in Template:Extension accordingly.
-->   
-->   
{| class="wikitable"
|+ '''Content parameters'''
|+ '''Content parameters'''
|-
|-
! Parameter
! Parameter
! Description
! Description'</span> || '''name of the extension'':Unstable extensions{{translation}}|unstable]]'' (broken - do not use this extension)
|-
|<span id="name">'''name'''</span> || '''name of the extension'''
|-
|<span id="status">'''status'''</span> || '''current release status'''
One of:
* ''[[:Category:Unstable extensions{{translation}}|unstable]]'' (broken - do not use this extension)
* ''[[:Category:Experimental extensions{{translation}}|experimental]]'' (early stages of development, may change drastically)
* ''[[:Category:Experimental extensions{{translation}}|experimental]]'' (early stages of development, may change drastically)
* ''[[:Category:Beta status extensions{{translation}}|beta]]'' (stable but not fully tested)
* ''[[:Category:Beta status extensions{{translation}}|beta]]'' (stable but not extensions{{translation}}|stable]]'' (stable version)
* ''[[:Category:Stable extensions{{translation}}|stable]]'' (stable version)
* ''[[:Category:Not LTS ready{{translation}}|unmaintained]]'' (unmaintained - previously claimed to be stable, now unmaintai:Archive extensions{{translation}}|arunknown status{{translation}}|unknown]]'' (default)
* ''[[:Category:Not LTS ready{{translation}}|unmaintained]]'' (unmaintained - previously claimed to be stable, now unmaintained)
* ''[[:Category:Archive extensions{{translation}}|archive]]'' (archived - deprecated or merged with another extension)
* ''[[:Category:Extensions with unknown status{{translation}}|unknown]]'' (default)
If the status is anything other than the above, it will be ignored and the default value of 'Unknown' will be displayed in the template instead. In cases where the value is omitted, it will be categorized as [[:category:extensions with unknown status|unknown]]. In cases where the value is invalid, it will be placed in a [[:category:extensions with invalid status|special category]] so that the error can be caught and fixed.
If the status is anything other than the above, it will be ignored and the default value of 'Unknown' will be displayed in the template instead. In cases where the value is omitted, it will be categorized as [[:category:extensions with unknown status|unknown]]. In cases where the value is invalid, it will be placed in a [[:category:extensions with invalid status|special category]] so that the error can be caught and fixed.
* [[Extension status|release status colour scheme]]
* [[Extension status|release status colour scheme]]
|-
|-
| '''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 -->
| '''type1'''<br/>''type2''<br/>''type3''<br/>''type4''<br/>''type5''<br/>''type6''<br/> || <span id="type">'''implementation type


The  implementation strategy(s) employed in building this extension. This parameter is used to create categories that help programmers find examples of various MediaWiki specific implementation strategies or patterns. Although the values of this parameter sometimes coincide with the use case or purpose of an extension, that is not reason for this parameter. If the values you have chosen for this parameter do not adequately identify the [[w:Requirements|purpose]] or possible [[w:Use case|use case]]s, we recommend you add additional [[Help:Categories|category links]] as needed.
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.
Line 477: Line 417:
"hook3": {
"hook3": {
"description": "Name of a hook used by the extension."
"description": "Name of a hook used by the extension."
},
"hook4": {
"description": "Name of a hook used by the extension."
"description": "Name of a hook used by the extension."
},
"hook5": {
"description": "Name of a hook used by the extension."
"description": "Name of a hook used by the extension."
},
"hook6": {
"description": "Name of a hook used by the extension."
"description": "Name of a hook used by the extension."
},
 
"hook7": {
"description": "Name of a hook used by the extension."
"description": "Name of a hook used by the extension."
},
"hook8": {
"description": "Name of a hook used by the extension."
"description": "Name of a hook used by the extension."
},
 
"hook9": {
"description": "Name of a hook used by the extension."
"description": "Name of a hook used by the extension."
},
"hook10": {
"description": "Name of a hook used by the extension."
"description": "Name of a hook used by the extension."
},
"hook11": {
"description": "Name of a hook used by the extension."
"description": "Name of a hook used by the extension."
},
"hook12": {
"description": "Name of a hook used by the extension.
"description": "Name of a hook used by the extension."
"description": "Name of a hook used by the extension."
},
 
"hook13": {
"description": "Name of a hook used by the extension."
"description": "Name of a hook used by the extension."
},
"hook14": {
"description": "Name of a hook used by the extension."
"description": "Name of a hook used by the extension."
},
"hook15": {
"description": "Name of a hook used by the extension."
"description": "Name of a hook used by the extension."
},
"hook16": {
"description": "Name of a hook used by the extension."
"description": "Name of a hook used by the extension."
},
"hook17": {
"description": "Name of a hook used by the extension."
"description": "Name of a hook used by the extension."
},
 
"hook18": {
"description": "Name of a hook used by the extension."
"description": "Name of a hook used by the extension."
},
 
"hook19": {
"description": "Name of a hook used by the extension."
},
"hook20": {
"description": "Name of a hook used by the extension."
},
"hook21": {
"description": "Name of a hook used by the extension."
},
"hook22": {
"description": "Name of a hook used by the extension."
},
"hook23": {
"description": "Name of a hook used by the extension."
},
"hook24": {
"description": "Name of a hook used by the extension."
},
"hook25": {
"description": "Name of a hook used by the extension."
},
"hook26": {
"description": "Name of a hook used by the extension."
},
"hook27": {
"description": "Name of a hook used by the extension."
},
"hook28": {
"description": "Name of a hook used by the extension."
"description": "Name of a hook used by the extension."
"description": "Name of a hook
"description": "Name of a hook used by the
"description": "Name of a hook used by the e
"description": "Name of a hook used by the extension.
"description": "Name of a hook used by the extension.
"description": "Name of a hook used by the  "Name of a hook used by the extension."
"descriptionName of a hook  of a hook used by the extension."
},
},
"hook29": {
"description": "Name of a hook used by the 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."
"description": "Name of a hook used by the extension."
},
},
Line 597: Line 492:
"hook43": {
"hook43": {
"description": "Name of a hook used by the extension."
"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."
"description": "Name of a hook used by the extension."
},
"hook46": {
"description": "Name of a hook used by the extension."
"description": "Name of a hook used by the extension."
},
description": "Name of a hook used by the extension."
"hook47": {
}
 
"description": "Name of a hook used by the extension."
"description": "Name of a hook used by the extension."
},
"hook48": {
"description": "Name of a hook used by the extension."
"description": "Name of a hook used by the extension."
},
},
"newhook1": {
"": {
"description": "Name of a hook provided by the extension."
"description": "Name of a hook provided by the extension."
},
},
"newhook2": {
"": {
"description": "Name of a hook provided by the extension."
"description": "Name of a hook provided by the extension."
},
},
"newhook3": {
"": {
"description": "Name of a hook provided by the extension."
 
},
 
"newhook4": {
"Name of a hook provided by the extension."
"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."
"description": "Name of a hook provided by the extension."
},
},
"newhook17": {
"": {
"description": "Name of a hook provided by the extension."
"description": "Name of a hook provided by the extension."
},
},
"newhook18": {
"": {
"description": "Name of a hook provided by the extension."
"description": "Name of a hook provided by the extension."
},
},
"newhook19": {
"": {
"description": "Name of a hook provided by the extension."
"description": "Name of a hook provided by the extension."
},
},
"newhook20": {
"": {
"description": "Name of a hook provided by the extension."
"description": "Name of a hook provided by the extension."
},
},
"newhook21": {
"": {
"description": "Name of a hook provided by the extension."
"description": "Name ": "Name of a hook provided by the extension."
},
},
"newhook22": {
"": {
"description": "Name of a hook provided by the extension."
"description": "Name of a hook provided by the extension."
},
},
"newhook23": {
"": {
"description": "Name of a hook provided by the extension."
"description": "Name of a hook provided by the extension."
},
},
"newhook24": {
"": {
"description": "Name of a hook provided by the extension."
"description": "Name of a hook provided by the extension."
},
},
"newhook25": {
"{
"description": "Name of a hook provided by the extension."
"description": "Name of a hook provided by the extension."
},
"newhook26": {
"description": "Name of a hook provided by the extension."
"description": "Name of a hook provided by the extension."
},
},
"newhook27": {
"": {
"description": "Name of a hook provided by the extension."
"description": "Name of a hook provided by the extension."
},
},
"newhook28": {
" {
"description": "Name of a hook provided by the extension."
"description": "Name of a hook provided by the extension."
},
},
"newhook29": {
"": {
"description": "Name of a hook provided by the extension."
"description": "Name of a hook provided by the extension."
},
},
"newhook30": {
"": {
"description": "Name of a hook provided by the extension."
"description": "Name of a hook provided by the extension."
},
},
"newhook31": {
"": {
"description": "Name of a hook provided by the extension."
"description": "Name of a hook provided by the extension."
},
},
"newhook32": {
"": {
"description": "Name of a hook provided by the extension."
"description": "Name of a hook provided by the extension."
},
},
"newhook33": {
"": {
"description": "Name of a hook provided by the extension."
"description": "Name of a hook provided by the extension."
},
},
"newhook34": {
"": {
"description": "Name of a hook provided by the extension."
"description": "Name of a hook provided by the extension."
},
},
"newhook35": {
"": {
"description": "Name of a hook provided by the extension."
"description": "Name of a hook provided by the extension."
},
},
"newhook36": {
"": {
"description": "Name of a hook provided by the extension."
"description": "Name of a hook provided by the extension."
},
},
"newhook37": {
"": {
"description": "Name of a hook provided by the extension."
"description": "Name of a hook provided by the extension."
},
},
"newhook38": {
"": {
"description": "Name of a hook provided by the extension."
"description": "Name of a hook provided by the extension."
},
},
"newhook39": {
"": {
"description": "Name of a hook provided by the extension."
"description": "Name of a hook provided by the extension."
},
},
"newhook40": {
"": {
"description": "Name of a hook provided by the extension."
"description": "Name of a hook provided by the extension."
},
},
"newhook41": {
"": {
"description": "Name of a hook provided by the extension."
"description": "Name of a hook provided by the extension."
},
},
"newhook42": {
"": {
"description": "Name of a hook provided by the extension."
"description": "Name of a hook provided by the extension."
},
},
"newhook43": {
"": {
"description": "Name of a hook provided by the extension."
"description": "Name of a hook provided by the extension."
},
},
"newhook44": {
"": {
"description": "Name of a hook provided by the extension."
"description": "Name of a hook provided by the extension."
},
},
"newhook45": {
"": {
"description": "Name of a hook provided by the extension."
"description": "Name of a hook provided by the extension."
},
},
"newhook46": {
"": {
"description": "Name of a hook provided by the extension."
"description": "Name of a hook provided by the extension."
},
},
"newhook47": {
"": {
"description": "Name of a hook provided by the extension."
"description": "Name of a hook provided by the extension."
},
},
"newhook48": {
"": {
"description": "Name of a hook provided by the extension."
"description": "Name of a hook provided by the extension."
},
},
"compatibility": {
"": {
"description": "Compatibility chart, e.g. Template:Extension Testing."
"description": "Name of a hook provided by the ext
},
"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."
},
"bugzilla": {
"description": "Bugzilla MediaWiki extension component name",
"deprecated": true
},
"vagrant-role": {
"label": "Vagrant role",
"description": "A MediaWiki-Vagrant role that lets you use this extension, if present",
"type": "string"
},
"latest release date": {},
"latest_release_date": {},
"latest preview version": {},
"latest_peview_version": {},
"version_preview": {},
"latest_preview_version": {},
"update_preview": {},
"!": {},
"nousage": {},
"CheckUsageNameOverride": {}
},
"format": "block",
"paramOrder": [
"status",
"name",
"license",
"templatemode",
"image",
"imagesize",
"type",
"type1",
"type2",
"type3",
"type4",
"type5",
"type6",
"description",
"author",
"username",
"version",
"update",
"version preview",
"update preview",
"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",
"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",
"compatibility",
"translate",
"bugzilla",
"vagrant-role",
"latest release date",
"latest_release_date",
"latest preview version",
"latest_peview_version",
"version_preview",
"latest_preview_version",
"update_preview",
"!",
"nousage",
"CheckUsageNameOverride"
]
}
</templatedata>
Retrieved from "https://wiki.tessercat.net/wiki/Template:Extension/doc"