Difference between revisions of "Template:Extension/doc"
Jump to navigation
Jump to search
prepare for translation
>Nemo bis (→Content parameters: It's encouraged to add any client-side compatibility information here too, especially when diverging from expectations of full support for a browser.) |
>Shirayuki (prepare for translation) |
||
| Line 1: | Line 1: | ||
<noinclude>{{Documentation subpage}}</noinclude> | <noinclude>{{TNT|Documentation subpage}}</noinclude> | ||
<!----> | <!----> | ||
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. | 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 108: | Line 108: | ||
|<span id="status">'''status'''</span> || '''current release status''' | |<span id="status">'''status'''</span> || '''current release status''' | ||
One of: | One of: | ||
* ''[[:Category:Unstable extensions|unstable]]'' (broken - do not use this extension) | * ''[[:Category:Unstable extensions{{translation}}|unstable]]'' (broken - do not use this extension) | ||
* ''[[:Category:Experimental extensions|experimental]]'' (early stages of development, may change drastically) | * ''[[:Category:Experimental extensions{{translation}}|experimental]]'' (early stages of development, may change drastically) | ||
* ''[[:Category:Beta status extensions|beta]]'' (stable but not fully tested) | * ''[[:Category:Beta status extensions{{translation}}|beta]]'' (stable but not fully tested) | ||
* ''[[:Category:Stable extensions|stable]]'' (stable version) | * ''[[:Category:Stable extensions{{translation}}|stable]]'' (stable version) | ||
* ''[[:Category:Not LTS ready|unmaintained]]'' (unmaintained - previously claimed to be stable, now unmaintained) | * ''[[:Category:Not LTS ready{{translation}}|unmaintained]]'' (unmaintained - previously claimed to be stable, now unmaintained) | ||
* ''[[:Category:Extensions with unknown status|unknown]]'' (default) | * ''[[: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 123: | Line 123: | ||
Legal values for the '''type1''', '''type2''', ... parameters are: | Legal values for the '''type1''', '''type2''', ... parameters are: | ||
* '''''[[: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: | * '''''[[: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|contenthandler]]'' - Extensions using [[Manual:ContentHandler|ContentHandler]]. | ** ''[[:Category:ContentHandler extensions{{translation}}|contenthandler]]'' - Extensions using [[Special:MyLanguage/Manual:ContentHandler|ContentHandler]]. | ||
** ''[[:Category:Link markup extensions|link]]'' - customized [[Manual:Extending wiki markup|link markup]], e.g. <code><nowiki>[[</nowiki>...]]</code> | ** ''[[: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|parser function]]'' - custom [[Manual:Parser functions|parameterized template markup]], e.g. <code><nowiki>{{</nowiki>''#name:'' ... }}</code> | ** ''[[: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|tag]]'' - [[Manual:Tag extensions|custom XML tag markup]], e.g. <code><nowiki><</nowiki>''tagname''>...<nowiki></</nowiki>''tagname''></code> | ** ''[[: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|variable]]'' - custom [[Manual:Variables|unparameterized template markup]], e.g. <code><nowiki>{{NAME}}</nowiki></code> | ** ''[[:Category:Variable extensions{{translation}}|variable]]'' - custom [[Special:MyLanguage/Manual:Variables|unparameterized template markup]], e.g. <code><nowiki>{{NAME}}</nowiki></code> | ||
** ''[[: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]]). | ** ''[[: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|'''''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: | * [[: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|''user activity'']] - extensions that monitor user activity (logins, logouts, new user creation, etc.) | ** [[:Category:User activity extensions{{translation}}|''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 | ** [[: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|''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 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|'''''interface''''']] - catchall for uncategorized user interface extensions. | * [[:Category:User interface extensions{{translation}}|'''''interface''''']] - catchall for uncategorized user interface extensions. | ||
** ''[[: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]]. | ** ''[[: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|mywiki]]'' - extensions that provide infrastructure so that users may personalize their MediaWiki experience and/or assist in the management of that infrastructure | ** ''[[: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|''notify'']] - extensions that email users, broadcast messages and provide other forms of community notification | ** [[:Category:Notification extensions{{translation}}|''notify'']] - extensions that email users, broadcast messages and provide other forms of community notification | ||
** ''[[: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''). | ** ''[[: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|''search'']] - extensions that search through and select articles for users. | ** [[:Category:Search extensions{{translation}}|''search'']] - extensions that search through and select articles for users. | ||
** [[: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. | ** [[: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|''ajax'']] - extensions that use [[w:Ajax|Ajax]] programming techniques. | ** [[:Category:Ajax extensions{{translation}}|''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. | ** [[:Category:Special page extensions{{translation}}|''special'']] - extensions that subclass the [[Special:MyLanguage/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 [[Special:MyLanguage/Manual:Special pages]] for more information. | ||
* '''other''' | * '''other''' | ||
** [[:Category:API extensions|''api'']] - extensions that add a new API module or extend a core API module. | ** [[:Category:API extensions{{translation}}|''api'']] - extensions that add a new API module or extend a core API module. | ||
** [[: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 | ** [[: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|''database'']] - adds tables and/or fields to the database backing a MediaWiki installation | ** [[:Category:Database extensions{{translation}}|''database'']] - adds tables and/or fields to the database backing a MediaWiki installation | ||
** [[:Category:Data extraction extensions|''data extraction'']] - Data extraction | ** [[:Category:Data extraction extensions{{translation}}|''data extraction'']] - Data extraction | ||
** [[:Category:File repository extensions|''filerepo'']] - extension that adds new file repository types as file backend | ** [[:Category:File repository extensions{{translation}}|''filerepo'']] - extension that adds new file repository types as file backend | ||
** [[:Category:Extension examples|''example'']] - Not a real extension, but an example of how to write one | ** [[: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 162: | Line 162: | ||
For built-in hooks: | For built-in hooks: | ||
* use the hook name alone. Please see [[Manual:Hooks]] for values (but omit introductory '/'). | * use the hook name alone. Please see [[Special:MyLanguage/Manual:Hooks|Manual:Hooks]] for values (but omit introductory '/'). | ||
For custom hooks defined by extensions: | For custom hooks defined by extensions: | ||
| Line 199: | Line 199: | ||
| <span id="table1">'''table1'''</span><br/>''table2''<br/>''table3''<br/>''table4''<br/>...<br/>''table30'' || '''name of each ''non-core'' table used by the extension''' | | <span id="table1">'''table1'''</span><br/>''table2''<br/>''table3''<br/>''table4''<br/>...<br/>''table30'' || '''name of each ''non-core'' table used by the extension''' | ||
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. | Links to a subpage of your extension page. For instance, "table1 = cu_changes" at [[Special:MyLanguage/Extension:CheckUser|Extension:CheckUser]] will link to [[Extension:CheckUser/cu_changes table]]. Don't list core tables such as [[Special:MyLanguage/Manual:Page table|page]] or [[Special:MyLanguage/Manual:Revision table|revision]]; only list tables that are added by extensions. | ||
|- | |- | ||
| <span id="license">license</span>|| license(s) governing use of this extension, e.g. GPL | | <span id="license">license</span>|| license(s) governing use of this extension, e.g. GPL | ||
| Line 213: | Line 213: | ||
| <span id="tags">tags</span> || any tags your extension uses (e.g. <tag1>, <tag2>). | | <span id="tags">tags</span> || any tags your extension uses (e.g. <tag1>, <tag2>). | ||
|- | |- | ||
| 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! | | rights|| <span id="rights">rights</span> added by the extension. '''Not to be confused with the license!''' Rights are such as ''[[Special:MyLanguage/Extension:MakeBot|makebot]]'' or ''[[Special:MyLanguage/Extension:Desysop|desysop]]'', not such as GFDL or LGPL or GPL - those are licenses! | ||
|- | |- | ||
| <span id="namespace">namespace</span> || namespace in which this extension is used | | <span id="namespace">namespace</span> || namespace in which this extension is used | ||
| Line 246: | Line 246: | ||
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]]. | 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]]. | ||
|} | |} | ||