Difference between revisions of "Template:Extension"

From WPRDC Wiki
Jump to navigation Jump to search
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-{{{status|unknown}}}" style="float: right; background-color: white; min-width:20%;"
|+ '''This is a [[:Category:OM2 Project|OM2 Platform Feature]]'''
|+ '''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>
Line 11: Line 11:
{{#if:{{{type<includeonly>|</includeonly>}}}|
{{#if:{{{type<includeonly>|</includeonly>}}}|
<!-- -->{{!}} style="vertical-align: top" {{!}} '''Type:'''
<!-- -->{{!}} style="vertical-align: top" {{!}} '''Type:'''
<!-- -->{{!}} {{#switch: {{lc: {{{type}}}}}|function=[[Category:OM2 Functions List|Functions List]]|class=[[Category:OM2 Class Instructions|Class List]]|module=[[Category:OM2 Available Modules|Module List]]|{{{type}}}<includeonly>[[Category:Category to catch extensions with an unrecognised type]]</includeonly>}}
<!-- -->{{!}} {{#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]]|{{{type}}}<includeonly>[[Category:Category to catch extensions with an unrecognised type]]</includeonly>}}
}}
}}
|-
|-
Line 24: Line 24:
<!-- -->{{!}} style="vertical-align: top" {{!}} '''Version:'''
<!-- -->{{!}} style="vertical-align: top" {{!}} '''Version:'''
<!-- -->{{!}} {{{version}}}{{#if:{{{update|}}}|&#160;({{{update}}})}}
<!-- -->{{!}} {{{version}}}{{#if:{{{update|}}}|&#160;({{{update}}})}}
}}
|-
{{#if:{{{mediawiki<includeonly>|</includeonly>}}}|
<!-- -->{{!}} style="vertical-align: top" {{!}} '''MediaWiki:'''
<!-- -->{{!}} {{{mediawiki}}}
}}
}}
|-
|-
Line 31: Line 36:
<!-- -->{{!}} style="vertical-align: top" {{!}} '''Parameters:'''
<!-- -->{{!}} style="vertical-align: top" {{!}} '''Parameters:'''
<!-- -->{{!}} {{{parameters}}}
<!-- -->{{!}} {{{parameters}}}
}}
|-
{{#if:{{{rights<includeonly>|</includeonly>}}}|
<!-- -->{{!}} style="vertical-align: top" {{!}} '''Added rights:'''
<!-- -->{{!}} {{{rights}}}
}}
}}
|-
|-
Line 39: Line 49:
|}<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 OM2 platform function or class descriptions 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 feature to the [[:Category:OM2 Project|OM2 Project]].
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 ==
== Usage ==
Line 48: Line 58:
|+ '''Parameters'''
|+ '''Parameters'''
|-
|-
| '''name''' || '''name of the platform feature'''
| '''name''' || '''name of the extension'''
|-
|-
| '''status''' || '''current release status'''
| '''status''' || '''current release status'''
Line 60: Line 70:
| '''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:
* ''function'' - Global Function
* ''pfunc'' - Parser function
* ''class'' - Platform PHP Class
* ''parser'' - Parser extension (new tag)
* ''module'' - OM2 Module Resource
* ''parser,pfunc'' - available as Parser Function AND as Parser Extension
|-
* ''hook'' - Hook extension (using $wgHooks)
|colspan="2" align="center"|'''Please add to this list if necessary'''
* ''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
| author    || author of the extension
Line 74: Line 88:
| update    || date of the last update
| update    || date of the last update
|-
|-
| readme    || link to the readme file
| mediawiki  || required version of MediaWiki
|-
|-
| changelog  || link to the changelog file
| '''download''' || '''link to the download''' : [http://svn.wikimedia.org/svnroot/mediawiki/trunk/extensions/ SVN] or other
|-
| readme    || link to the readme file : [http://svn.wikimedia.org/svnroot/mediawiki/trunk/extensions/Sort/Sort README] or other
|-
| changelog  || link to the changelog file : [http://svn.wikimedia.org/svnroot/mediawiki/trunk/extensions/Sort/Sort CHANGELOG] or other
|-
|-
| '''description''' || '''short description'''
| '''description''' || '''short description'''
|-
|-
| parameters || available parameters for common.php (if needed)
| parameters || available parameters for LocalSettings.php
|-
| rights    || rights added by the extension
|-
|-
| example    || example, website or screenshot of working feature
| example    || example, website or screenshot of working extension
|}
|}
|
|
Line 93: Line 113:
|version  =
|version  =
|update    =
|update    =
|mediawiki =
|download  =
|readme    =
|readme    =
|changelog =
|changelog =
|description =
|description =
|parameters=
|parameters=
|rights    =
|example  =
|example  =
}}</nowiki>
}}</nowiki>
|}
|}


== Create a new extension article ==
<inputbox>
type=create
bgcolor=#eeeeff
width=40
default=Extension:MyExtension
preload=Template_Extension_Sample
buttonlabel=Create a new Extension (replace "MyExtension" with the correct name)
</inputbox>
[[Category:Info templates|{{PAGENAME}}]]
[[Category:Info templates|{{PAGENAME}}]]
</noinclude><includeonly>[[Category:status {{#switch: {{lc:{{{status|unknown}}}}}|unstable|experimental|beta|stable={{{status}}}|unknown}} extensions]]</includeonly>
</noinclude><includeonly>[[Category:status {{#switch: {{lc:{{{status|unknown}}}}}|unstable|experimental|beta|stable={{{status}}}|unknown}} extensions]]</includeonly>

Revision as of 14:53, 30 May 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)
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