Difference between revisions of "Template:Extension"
>Eep ("special page"and "parser function" type alternate triggers, separated pipes for easier editing, multiple type fields) |
>Eep |
||
Line 18: | Line 18: | ||
{{#if:{{{type<includeonly>|</includeonly>}}}| | {{#if:{{{type<includeonly>|</includeonly>}}}| | ||
<!-- -->{{!}} style="vertical-align: top" {{!}} '''Type''' | <!-- -->{{!}} style="vertical-align: top" {{!}} '''Type''' | ||
<!-- -->{{!}} {{#switch: {{lc: {{{type}}}}} | <!-- -->{{!}} {{#switch: {{lc: {{{type}}}}}|special=Special page[[Category:Special page extensions]]|pfunc=[[Extension:Parser function extensions|Parser function]][[Category:Parser function extensions]]|parser=Parser extension[[Category:Parser extensions]]|parser,pfunc=[[Extension:Parser function extensions|Parser function]][[Category:Parser function extensions]] and Parser extension[[Category:Parser extensions]]|hook=Hook[[Category:Hook extensions]]|interface=User interface[[Category:User interface extensions]]|parser, hook, special=Parser extension[[Category:Parser extensions]], hook[[Category:Hook extensions]], and special page[[Category:Special page extensions]]|example=Example[[Category:Extension examples]]|category=Category[[Category:Category extensions]]|table=Table[[Category:Table extensions]]|list=List[[Category:List extensions]]|form=Form[[Category:Form extensions]]|{{{type}}}<includeonly>[[Category:Extensions with invalid or missing type]]</includeonly>}} | ||
| | |||
}} | }} | ||
|- | |- | ||
Line 84: | Line 77: | ||
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 categorised 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 categorised 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''' || '''extension | | '''type''' || '''type of extension''' | ||
Can contain any value, but the following special values ensure proper categorisation: | Can contain any value, but the following special values ensure proper categorisation: | ||
* ''[[:Category:Parser function extensions|pfunc]]'' | * ''[[:Category:Parser function extensions|pfunc]]'' - Parser function | ||
* ''[[:Category:Parser extensions|parser]]'' - Parser extension | * ''[[:Category:Parser extensions|parser]]'' - Parser extension (new tag) | ||
* ''parser,pfunc'' - available as parser function ''and'' as parser extension (places extension in both categories) | * ''parser,pfunc'' - available as parser function ''and'' as parser extension (places extension in both categories) | ||
* ''[[:Category:Hook extensions|hook]]'' - Hook extension (using $wgHooks) | * ''[[:Category:Hook extensions|hook]]'' - Hook extension (using $wgHooks) | ||
* ''[[:Category:Special page extensions|special]]'' | * ''[[:Category:Special page extensions|special]]'' - Special page | ||
* ''[[:Category:User interface extensions|interface]]'' - User interface extension (e.g. javascript code) | * ''[[:Category:User interface extensions|interface]]'' - User interface extension (e.g. javascript code) | ||
* ''parser, hook, special'' - Parser extension, hook, special page (places extension in each category) | * ''parser, hook, special'' - Parser extension, hook, and special page (places extension in each category) | ||
* ''[[:Category:Extension examples|example]]'' - Not a real extension, but an example of how to write one | * ''[[:Category:Extension examples|example]]'' - Not a real extension, but an example of how to write one | ||
* ''[[:Category:Category extensions|category]]'' - Category | * ''[[:Category:Category extensions|category]]'' - Category | ||
Line 98: | Line 91: | ||
* ''[[:Category:List extensions|list]]'' - List | * ''[[:Category:List extensions|list]]'' - List | ||
* ''[[:Category:Table extensions|table]]'' - Table | * ''[[:Category:Table extensions|table]]'' - Table | ||
Obviously, better template coding to allow multiple types without having to create separate syntax for all possible combinations is needed | (Obviously, better template coding to allow multiple types without having to create separate syntax for all possible combinations is needed.) 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]] | |||
|- | |- | ||
| author || 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). | | author || 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). |
Revision as of 08:54, 11 August 2007
Purpose
This template should be added to the main page of all extensions documented on this wiki (and only the main page). It will add a useful infobox using the information supplied (see below) and will automatically add the extension to Category:All extensions, plus the appropriate status and type categories.
Example
Extension Release status: unknown | |
---|---|
Type | {{{type}}} |
Description | {{{description}}} |
Author | {{{author}}} |
Version | {{{version}}} |
MediaWiki | {{{mediawiki}}} |
Download | {{{download}}} |
Parameters | {{{parameters}}} |
Added rights | {{{rights}}} |
Example | {{{example}}} |
Usage
Using the infoboxExisting extension pagesIf you want to add the infobox to an existing page, copy and paste the following code and add it to the top: {{Extension |name = |status = |type = |author = |username = |image = |version = |update = |mediawiki = |download = |readme = |changelog = |description = |parameters = |rights = |example = }} Create a new extension articleIf 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. |