Difference between revisions of "Template:Extension/doc"
Jump to navigation
Jump to search
link to backlog for compatibility policy parameter
>Shirayuki m (Protected "Template:Extension/doc": Excessive vandalism ([Edit=Allow only autoconfirmed users] (expires 02:22, 7 January 2019 (UTC)) [Move=Allow only autoconfirmed users] (expires 02:22, 7 January 2019 (UTC)))) |
>Tgr (WMF) (link to backlog for compatibility policy parameter) |
||
Line 2: | Line 2: | ||
<!----> | <!----> | ||
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{{ | 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{{translation}}]], along with the appropriate [[:Category:Extensions by status{{translation}}|status]] and [[:Category:Extensions by implementation type{{translation}}|implementation type]] categories. | ||
== Usage == | == Usage == | ||
Line 13: | Line 13: | ||
| align="left" | | | align="left" | | ||
<span id="CutAndPaste">Copy and paste:</span> | <span id="CutAndPaste">Copy and paste:</span> | ||
<pre>{{ | <pre>{{ {{TNTN|Extension}} |templatemode = | ||
|name = | |name = | ||
|status = | |status = | ||
Line 22: | Line 22: | ||
|newhook1 = | |newhook1 = | ||
|newhook2 = | |newhook2 = | ||
|username = | |username = | ||
|author = | |author = | ||
|description = | |description = | ||
|image = | |image = | ||
Line 62: | Line 60: | ||
|type1 = {{{type1}}} | |type1 = {{{type1}}} | ||
|type2 = {{{type2}}} | |type2 = {{{type2}}} | ||
|hook1 = | |hook1 = hook1 | ||
|hook2 = | |hook2 = hook2 | ||
|newhook1 = | |newhook1 = newhook1 | ||
|newhook2 = | |newhook2 = newhook2 | ||
|username = SomeUser | |username = SomeUser | ||
|author = SomeAuthor | |author = SomeAuthor | ||
|image = Placeholder.png | |image = Placeholder.png | ||
|version = {{{version}}} | |version = {{{version}}} | ||
Line 121: | Line 117: | ||
|<span id="status">'''status'''</span> || '''current release status''' | |<span id="status">'''status'''</span> || '''current release status''' | ||
One of: | One of: | ||
* ''[[:Category:Unstable extensions{{ | * ''[[:Category:Unstable extensions{{translation}}|unstable]]'' (broken - do not use this extension) | ||
* ''[[:Category:Experimental extensions{{ | * ''[[:Category:Experimental extensions{{translation}}|experimental]]'' (early stages of development, may change drastically) | ||
* ''[[:Category:Beta status extensions{{ | * ''[[:Category:Beta status extensions{{translation}}|beta]]'' (stable but not fully tested) | ||
* ''[[:Category:Stable extensions{{ | * ''[[:Category:Stable extensions{{translation}}|stable]]'' (stable version) | ||
* ''[[:Category:Not LTS ready{{ | * ''[[:Category:Not LTS ready{{translation}}|unmaintained]]'' (unmaintained - previously claimed to be stable, now unmaintained) | ||
* ''[[:Category:Archived extensions{{ | * ''[[:Category:Archived extensions{{translation}}|archive]]'' (archived - deprecated or merged with another extension) | ||
* ''[[:Category:Extensions with unknown status{{ | * ''[[: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]] | ||
Line 137: | Line 133: | ||
Legal values for the '''type1''', '''type2''', ... parameters are: | Legal values for the '''type1''', '''type2''', ... parameters are: | ||
* '''''[[:Category:Parser extensions{{ | * '''''[[:Category:Parser extensions{{translation}}|parser]]''''' - catchall for uncategorized [[Special:MyLanguage/Manual:Extending wiki markup|parser extensions]]. If you have written a parser extension, please use one of the following more specific types: | ||
** ''[[:Category:ContentHandler extensions{{ | ** ''[[:Category:ContentHandler extensions{{translation}}|contenthandler]]'' - Extensions using [[Special:MyLanguage/Manual:ContentHandler|ContentHandler]]. | ||
** ''[[:Category:Link markup extensions{{ | ** ''[[:Category:Link markup extensions{{translation}}|link]]'' - customized [[Special:MyLanguage/Manual:Extending wiki markup|link markup]], e.g. <code><nowiki>[[</nowiki>...]]</code> | ||
** ''[[:Category:Parser function extensions{{ | ** ''[[:Category:Parser function extensions{{translation}}|parser function]]'' - custom [[Special:MyLanguage/Manual:Parser functions|parameterized template markup]], e.g. <code><nowiki>{{</nowiki>''#name:'' ... }}</code> | ||
** ''[[:Category:Tag extensions{{ | ** ''[[:Category:Tag extensions{{translation}}|tag]]'' - [[Special:MyLanguage/Manual:Tag extensions|custom XML tag markup]], e.g. <code><nowiki><</nowiki>''tagname''>...<nowiki></</nowiki>''tagname''></code> | ||
** ''[[:Category:Variable extensions{{ | ** ''[[:Category:Variable extensions{{translation}}|variable]]'' - custom [[Special:MyLanguage/Manual:Variables|unparameterized template markup]], e.g. <code><nowiki>{{NAME}}</nowiki></code> | ||
** ''[[:Category:Extended syntax extensions{{ | ** ''[[:Category:Extended syntax extensions{{translation}}|extended syntax]]'' - Extensions that add non-standard wiki syntax (i.e. <em>not</em> [[Special:MyLanguage/Manual:Tag extensions|tags]], [[Special:MyLanguage/Manual:Parser functions|parser functions]], or [[Special:MyLanguage/Manual:Variables|variables]]). | ||
*: | *: | ||
* [[:Category:User access extensions{{ | * [[:Category:User access extensions{{translation}}|'''''access''''']] - catchall for [[Special:MyLanguage/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: | ||
** [[:Category:User activity extensions{{ | ** [[:Category:User activity extensions{{translation}}|''user activity'']] - extensions that monitor user activity (logins, logouts, new user creation, etc.) | ||
** [[:Category:User identity extensions{{ | ** [[:Category:User identity extensions{{translation}}|''user identity'']] - extensions that create and delete users, and/or verify the identity of a user | ||
** [[:Category:User rights extensions{{ | ** [[:Category:User rights extensions{{translation}}|''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]]) | ||
* [[:Category:User interface extensions{{ | * [[:Category:User interface extensions{{translation}}|'''''interface''''']] - catchall for uncategorized user interface extensions. | ||
** ''[[:Category:Media handling extensions{{ | ** ''[[:Category:Media handling extensions{{translation}}|media]]'' - extensions that permit the embedding of multimedia content on wiki pages by registering a file extension with [[Special:MyLanguage/Manual:$wgMediaHandlers|$wgMediaHandlers]]. | ||
** ''[[:Category:Personalization extensions{{ | ** ''[[:Category:Personalization extensions{{translation}}|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{{ | ** [[:Category:Notification extensions{{translation}}|''notify'']] - extensions that email users, broadcast messages and provide other forms of community notification | ||
** ''[[:Category:Page action extensions{{ | ** ''[[:Category:Page action extensions{{translation}}|''page action'']]'' - extensions that enhance or modify [[Special:MyLanguage/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''). | ||
** [[:Category:Search extensions{{ | ** [[:Category:Search extensions{{translation}}|''search'']] - extensions that search through and select articles for users. | ||
** [[:Category:Skin extensions{{ | ** [[:Category:Skin extensions{{translation}}|''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. | ||
** [[:Category:Ajax extensions{{ | ** [[:Category:Ajax extensions{{translation}}|''ajax'']] - extensions that use [[w:Ajax|Ajax]] programming techniques. | ||
** [[:Category:Special page extensions{{ | ** [[:Category:Special page extensions{{translation}}|''special'']] - extensions that subclass the {{Class doclink|SpecialPage}} class, use one of its hooks, or patch one or more functions in {{Git file|file=includes/specialpage/SpecialPage.php|text=SpecialPage.php}}. See [[Special:MyLanguage/Manual:Special pages]] for more information. | ||
* '''other''' | * '''other''' | ||
** [[:Category:API extensions{{ | ** [[:Category:API extensions{{translation}}|''api'']] - extensions that add a new API module or extend a core API module. | ||
** [[:Category:Hook extensions{{ | ** [[:Category:Hook extensions{{translation}}|''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 | ||
** [[:Category:Database extensions{{ | ** [[:Category:Database extensions{{translation}}|''database'']] - adds tables and/or fields to the database backing a MediaWiki installation | ||
** [[:Category:Data extraction extensions{{ | ** [[:Category:Data extraction extensions{{translation}}|''data extraction'']] - Data extraction | ||
** [[:Category:File repository extensions{{ | ** [[:Category:File repository extensions{{translation}}|''filerepo'']] - extension that adds new file repository types as file backend | ||
** [[:Category:Extension examples{{ | ** [[:Category:Extension examples{{translation}}|''example'']] - Not a real extension, but an example of how to write one | ||
Any other value for 'type' is invalid, and will cause the extension to be placed in [[:Category:Extensions with invalid or missing type{{ | Any other value for 'type' is invalid, and will cause the extension to be placed in [[:Category:Extensions with invalid or missing type{{translation}}]]. | ||
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. | 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. | ||
Line 187: | Line 183: | ||
You might also want to add the hooks to [[Extension hook registry]]. | You might also want to add the hooks to [[Extension hook registry]]. | ||
|- | |- | ||
| <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. | | <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. | ||
|- | |- | ||
| <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). | | <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). | ||
|- | |- | ||
| <span id="description">'''description'''</span>|| '''short description''' | | <span id="description">'''description'''</span>|| '''short description''' | ||
Line 200: | Line 192: | ||
| <span id="image">image</span>|| screenshot or logo of extension. It should be provided without namespace and without <nowiki>[[]]</nowiki>s. | | <span id="image">image</span>|| screenshot or logo of extension. It should be provided without namespace and without <nowiki>[[]]</nowiki>s. | ||
|- | |- | ||
| <span id="imagesize">imagesize</span>|| ''facultative'', size of the image (default size is | | <span id="imagesize">imagesize</span>|| ''facultative'', size of the image (default size is 220px) | ||
|- | |- | ||
| <span id="version">version</span>|| last version | | <span id="version">version</span>|| last version | ||
Line 206: | Line 198: | ||
| <span id="update">update</span>|| date of the last update | | <span id="update">update</span>|| date of the last update | ||
|- | |- | ||
| <span id="compatibility_policy">compatibility policy</span>|| {{ll|Compatibility#mediawiki_extensions|compatibility policy}} (accepted values are '''master''' and '''rel''') | | <span id="compatibility_policy">compatibility policy</span>|| {{ll|Compatibility#mediawiki_extensions|compatibility policy}} (accepted values are '''master''' and '''rel'''). ([[:Category:Extensions without a compatibility policy|backlog]]) | ||
|- | |- | ||
| <span id="mediawiki">mediawiki</span>|| required version of MediaWiki | | <span id="mediawiki">mediawiki</span>|| required version of MediaWiki | ||
Line 273: | Line 265: | ||
If this is left blank, this template will add the host page to [[:Category:All extensions{{ | If this is left blank, this template will add the host page to [[:Category:All extensions{{translation}}]] and to one or more additional categories, depending on the values assigned to the [[#Content parameters|Content parameters]]. | ||
|} | |} | ||
Line 348: | Line 340: | ||
"templatemode": { | "templatemode": { | ||
"description": "Controls auto-categorization of host page. Normally left blank. Alternate values are: nocats, nousage.", | "description": "Controls auto-categorization of host page. Normally left blank. Alternate values are: nocats, nousage.", | ||
"label": " | "label": "Mode" | ||
}, | }, | ||
"image": { | "image": { | ||
Line 356: | Line 347: | ||
}, | }, | ||
"imagesize": { | "imagesize": { | ||
"description": " | "description": "Facultative, size of the image (default size is 220px)" | ||
}, | }, | ||
"type": { | "type": { | ||
Line 378: | Line 367: | ||
"type4": { | "type4": { | ||
"description": "Implementation type. See detailed doc.", | "description": "Implementation type. See detailed doc.", | ||
"label": " | "label": "Quaternary type" | ||
}, | }, | ||
"type5": { | "type5": { | ||
"description": "Implementation type. See detailed doc.", | "description": "Implementation type. See detailed doc.", | ||
"label": " | "label": "Quinary type" | ||
}, | }, | ||
"type6": { | "type6": { | ||
Line 396: | Line 385: | ||
"username": { | "username": { | ||
"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." | "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." | ||
}, | }, | ||
"version": { | "version": { | ||
Line 407: | Line 393: | ||
}, | }, | ||
"update": { | "update": { | ||
"description": " | "description": "date of the last update" | ||
}, | |||
"version preview": { | |||
"description": "version preview" | |||
" | |||
}, | }, | ||
"update preview": { | "update preview": { | ||
" | "description": "version preview" | ||
}, | }, | ||
"mediawiki": { | "mediawiki": { | ||
Line 433: | Line 417: | ||
"example": "MediaWiki-extensions-Babel", | "example": "MediaWiki-extensions-Babel", | ||
"type": "string", | "type": "string", | ||
"suggested": true | "suggested": true | ||
}, | }, | ||
"table1": { | "table1": { | ||
Line 467: | Line 450: | ||
}, | }, | ||
"download": { | "download": { | ||
"description": "Link to the download | "description": "Link to the download." | ||
}, | }, | ||
"readme": { | "readme": { | ||
"description": " | "description": "external link to the readme file" | ||
}, | }, | ||
"changelog": { | "changelog": { | ||
Line 480: | Line 459: | ||
}, | }, | ||
"example": { | "example": { | ||
"description": "example, website or screenshot of working extension | "description": "example, website or screenshot of working extension" | ||
}, | }, | ||
"namespace": { | "namespace": { | ||
Line 784: | Line 762: | ||
}, | }, | ||
"compatibility": { | "compatibility": { | ||
"description": "Compatibility chart, e.g. Template:Extension Testing. | "description": "Compatibility chart, e.g. Template:Extension Testing." | ||
}, | }, | ||
"translate": { | "translate": { | ||
Line 792: | Line 769: | ||
"bugzilla": { | "bugzilla": { | ||
"description": "Bugzilla MediaWiki extension component name", | "description": "Bugzilla MediaWiki extension component name", | ||
"deprecated": true | "deprecated": true | ||
}, | }, | ||
"vagrant-role": { | "vagrant-role": { | ||
Line 800: | Line 776: | ||
"type": "string" | "type": "string" | ||
}, | }, | ||
" | "latest release date": {}, | ||
"latest_release_date": {}, | |||
"latest preview version": {}, | |||
}, | "latest_peview_version": {}, | ||
" | "version_preview": {}, | ||
"latest_preview_version": {}, | |||
"update_preview": {}, | |||
}, | "!": {}, | ||
"nousage": {}, | |||
"CheckUsageNameOverride": {}, | |||
"compatibility policy": { | "compatibility policy": { | ||
"description": "For older versions of MediaWiki, should one use the extension's master brunch or the REL1_XX branch corresponding to the MediaWiki version? Allowed values: master, rel", | "description": "For older versions of MediaWiki, should one use the extension's master brunch or the REL1_XX branch corresponding to the MediaWiki version? Allowed values: master, rel", | ||
"type": "string", | "type": "string", | ||
"suggested": true | "suggested": true | ||
} | } | ||
}, | }, | ||
"format": " | "format": "block", | ||
"paramOrder": [ | "paramOrder": [ | ||
"status", | |||
"name", | "name", | ||
" | "license", | ||
"templatemode", | |||
"image", | |||
"imagesize", | |||
"type", | "type", | ||
"type1", | "type1", | ||
Line 831: | Line 806: | ||
"type4", | "type4", | ||
"type5", | "type5", | ||
"type6", | |||
"description", | |||
"author", | |||
"username", | |||
"version", | |||
"update", | |||
"version preview", | |||
"update preview", | |||
"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", | "hook1", | ||
"hook2", | "hook2", | ||
Line 927: | Line 934: | ||
"newhook47", | "newhook47", | ||
"newhook48", | "newhook48", | ||
"compatibility", | "compatibility", | ||
"translate", | |||
"bugzilla", | "bugzilla", | ||
"vagrant-role", | "vagrant-role", | ||
" | "latest release date", | ||
" | "latest_release_date", | ||
"latest preview version", | |||
"latest_peview_version", | |||
"version_preview", | |||
"latest_preview_version", | |||
"update_preview", | |||
"!", | |||
"nousage", | "nousage", | ||
" | "CheckUsageNameOverride" | ||
] | ] | ||
} | } | ||
</templatedata> | </templatedata> |