Difference between revisions of "Template:Extension"
>Jack Phoenix (enough with people puttng GFDL or other license to rights, since it's meant for rights added by the $wgAvailableRights hook) |
>Eep ("special page"and "parser function" type alternate triggers, separated pipes for easier editing, multiple type fields) |
||
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}}}}} | ||
{{extensiontype}}|{{{type}}}<includeonly>[[Category:Extensions with invalid or missing type]]</includeonly>}} | |||
}} | |||
|- | |||
{{#if:{{{type2<includeonly>|</includeonly>}}}| | |||
<!-- -->{{!}} style="vertical-align: top" {{!}} '''Type2''' | |||
<!-- -->{{!}} {{#switch: {{lc: {{{type2}}}}} | |||
{{extensiontype}}|{{{type2}}}<includeonly>[[Category:Extensions with invalid or missing type]]</includeonly>}} | |||
}} | }} | ||
|- | |- | ||
Line 77: | Line 84: | ||
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''' || '''type | | '''type''' || '''extension type''' | ||
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]]'' - Parser function | * ''[[:Category:Parser function extensions|pfunc]]'' (or ''parser function'') - Parser function | ||
* ''[[:Category:Parser extensions|parser]]'' - Parser extension | * ''[[:Category:Parser extensions|parser]]'' - Parser extension | ||
* ''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]]'' - Special page | * ''[[:Category:Special page extensions|special]]'' (or ''special page'') - 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, | * ''parser, hook, special'' - Parser extension, hook, 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 91: | Line 98: | ||
* ''[[: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--perhaps repeating the type switch field several times (at least 3-5) into "type1", "type2", etc. | |||
Any other value for 'type' is invalid, and will cause the extension to be placed in [[:Category:Extensions with invalid or missing type]]. | |||
|- | |||
| '''type2''' || '''extension type''' | |||
Same as above; for multiple types. Enter a single type, not separated by commas. | |||
|- | |- | ||
| 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:44, 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}}} |
Type2 | {{{type2}}} |
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. |