Difference between revisions of "Template:Extension"

From WPRDC Wiki
Jump to navigation Jump to search
>HappyDog
m (Rename cat to match 'status' field equivalent)
>HappyDog
(Link to 'type' categories.)
Line 51: Line 51:


== Purpose ==
== 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 [[:Category:Extensions by status|status category]].
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 [[:Category:Extensions by status|status]] and [[:Category:Extensions by type|type]] categories.


== Usage ==
== Usage ==
Line 73: Line 73:
| '''type''' || '''type of 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:
* ''pfunc'' - Parser function
* ''[[:Category:Parser function extensions|pfunc]]'' - Parser function
* ''parser'' - Parser extension (new tag)
* ''[[:Category:Parser extensions|parser]]'' - Parser extension (new tag)
* ''parser,pfunc'' - available as Parser Function AND as Parser Extension
* ''parser,pfunc'' - available as Parser Function AND as Parser Extension (places extension in both categories)
* ''hook'' - Hook extension (using $wgHooks)
* ''[[:Category:Hook extensions|hook]]'' - Hook extension (using $wgHooks)
* ''special'' - Special page
* ''[[:Category:Special page extensions|special]]'' - Special page
* ''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, and special page
* ''parser, hook, special''  - Parser extension, hook, and special page (places extension in each category)
* ''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.
Please add to this list if necessary.
Any other value for 'type' is invalid, and will cause the extension to be placed in [[:Category:extensions with invalid or missing type]].
|-
|-
| author    || author of the extension
| author    || author of the extension

Revision as of 13:57, 13 July 2007

This is a MediaWiki Extension
Crystal Clear action run.png
Extension

Release status: unknown

Placeholder.png
Type: {{{type}}}
Description: {{{description}}}
Author: {{{author}}}
Version: {{{version}}}
MediaWiki: {{{mediawiki}}}
Download: {{{download}}}
Parameters: {{{parameters}}}
Added rights: {{{rights}}}
Example: {{{example}}}


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.

Usage

Parameters
name name of the extension
status current release status

One of:

  • unstable (broken - do not use this extension)
  • experimental (early stages of development, may change drastically.)
  • beta (stable but not fully tested)
  • stable (stable version)
  • unknown (default)

If the status is anything other than the above, it will be ignored and the default value will be used instead. In these cases it will be placed in a special category so that the error can be caught and fixed.

type type of extension

Can contain any value, but the following special values ensure proper categorisation:

  • pfunc - Parser function
  • parser - Parser extension (new tag)
  • parser,pfunc - available as Parser Function AND as Parser Extension (places extension in both categories)
  • hook - Hook extension (using $wgHooks)
  • special - Special page
  • interface - User interface extension (e.g. javascript code).
  • parser, hook, special - Parser extension, hook, and special page (places extension in each category)
  • 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.

author author of the extension
image screenshot (of base 270px)
version last version
update date of the last update
mediawiki required version of MediaWiki
download link to the download : SVN or other
readme link to the readme file : README or other
changelog link to the changelog file : CHANGELOG or other
description short description
parameters available parameters for LocalSettings.php
rights rights added by the extension
example example, website or screenshot of working extension
{{Extension
|name      = 
|status    =
|type      =
|author    =
|image     =
|version   =
|update    =
|mediawiki =
|download  =
|readme    =
|changelog =
|description =
|parameters=
|rights    =
|example   =
}}

Create a new extension article