Difference between revisions of "Template:Extension"

From WPRDC Wiki
Jump to navigation Jump to search
>Bouncingmolar
>HappyDog
(Updated 'status' field to categorize more usefully, as per Category talk:Extensions. May take a while for changes to filter through...)
Line 1: Line 1:
{| class="ext-infobox ext-status-{{{status|unknown}}}" style="float: right; background-color: white; min-width:20%;"
{| class="ext-infobox ext-status-{{#switch: {{lc: {{{status|unknown}}}}}|unstable|experimental|beta|stable={{{status}}}|unknown}}" style="float: right; background-color: white; min-width:20%;"
|+ '''This is a [[:Category:Extensions|MediaWiki Extension]]'''
|+ '''This is a [[:Category:Extensions|MediaWiki Extension]]'''
|- class="ext-header"
|- class="ext-header"
! colspan="2" style="padding-top: 0.5em;" | [[Image:{{#ifeq: {{{status|}}}|unstable|Crystal Clear app error.png|Crystal Clear action run.png}}|left|40px]] <span style="font-size: 130%;">{{{name|{{PAGENAME}}}}}</span><br>
! colspan="2" style="padding-top: 0.5em;" | [[Image:{{#ifeq: {{{status|}}}|unstable|Crystal Clear app error.png|Crystal Clear action run.png}}|left|40px]] <span style="font-size: 130%;">{{{name|{{PAGENAME}}}}}</span><br>
Release status: {{#switch: {{lc: {{{status|unknown}}}}}|unstable|experimental|beta|stable={{{status}}}|unknown}}
Release status: {{#switch: {{lc: {{{status|unknown}}}}}|unstable|experimental|beta|stable={{{status}}}|unknown}} <includeonly>[[Category:{{#switch: {{lc:{{{status}}}}}|unstable|experimental|stable={{{status}}} extensions|beta=beta status extensions|unknown=extensions with unknown status|extensions with invalid or missing status}}]]</includeonly>
|-
|-
{{#if:{{{image<includeonly>|</includeonly>}}}|
{{#if:{{{image<includeonly>|</includeonly>}}}|
Line 48: Line 48:
}}
}}
|}<includeonly>{{DEFAULTSORT:{{{name|{{PAGENAME}}}}}}}[[Category:Extensions]]</includeonly><noinclude>
|}<includeonly>{{DEFAULTSORT:{{{name|{{PAGENAME}}}}}}}[[Category:Extensions]]</includeonly><noinclude>
== 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:Extensions]].
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:Extensions]].
Line 62: Line 64:
| '''status''' || '''current release status'''
| '''status''' || '''current release status'''
One of:  
One of:  
* ''unstable'' (broken - do not use this extension)
* ''[[:category:unstable extensions|unstable]]'' (broken - do not use this extension)
* ''experimental'' (early stages of development, may change drastically.)
* ''[[:category:experimental extensions|experimental]]'' (early stages of development, may change drastically.)
* ''beta'' (stable but not fully tested)
* ''[[:category:beta status extensions|beta]]'' (stable but not fully tested)
* ''stable'' (stable version)
* ''[[:category:stable extensions|stable]]'' (stable version)
* ''unknown'' (default)
* ''[[:category:extensions with unknown status|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 [[:category:extensions with invalid or missing status|special category]] so that the error can be caught and fixed.
|-
|-
| '''type''' || '''type of extension'''
| '''type''' || '''type of extension'''
Line 135: Line 138:
</inputbox>
</inputbox>
[[Category:Info templates|{{PAGENAME}}]][[category:extension creation]]
[[Category:Info templates|{{PAGENAME}}]][[category:extension creation]]
</noinclude><includeonly>[[Category:status {{#switch: {{lc:{{{status|unknown}}}}}|unstable|experimental|beta|stable={{{status}}}|unknown}} extensions]]</includeonly>
</noinclude>

Revision as of 13:02, 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:Extensions.

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
  • 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
  • example - not a real extension, but an example of how to write one.

Please add to this list if necessary.

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