Difference between revisions of "Template:Extension"

From WPRDC Wiki
Jump to navigation Jump to search
>HappyDog
m (Make cat name consistent)
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:Extensions|MediaWiki Extension]]'''
|+ '''This is a [[:Category:OM2 Project|OM2 Platform Feature]]'''
|- 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}}}}}|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>}}
<!-- -->{{!}} {{#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>}}
}}
}}
|-
|-
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 36: Line 31:
<!-- -->{{!}} style="vertical-align: top" {{!}} '''Parameters:'''
<!-- -->{{!}} style="vertical-align: top" {{!}} '''Parameters:'''
<!-- -->{{!}} {{{parameters}}}
<!-- -->{{!}} {{{parameters}}}
}}
|-
{{#if:{{{rights<includeonly>|</includeonly>}}}|
<!-- -->{{!}} style="vertical-align: top" {{!}} '''Added rights:'''
<!-- -->{{!}} {{{rights}}}
}}
}}
|-
|-
Line 49: Line 39:
|}<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 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]].


== Usage ==
== Usage ==
Line 58: Line 48:
|+ '''Parameters'''
|+ '''Parameters'''
|-
|-
| '''name''' || '''name of the extension'''
| '''name''' || '''name of the platform feature'''
|-
|-
| '''status''' || '''current release status'''
| '''status''' || '''current release status'''
Line 70: Line 60:
| '''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
* ''function'' - Global Function
* ''parser'' - Parser extension (new tag)
* ''class'' - Platform PHP Class
* ''parser,pfunc'' - available as Parser Function AND as Parser Extension
* ''module'' - OM2 Module Resource
* ''hook'' - Hook extension (using $wgHooks)
|-
* ''special'' - Special page
|colspan="2" align="center"|'''Please add to this list if necessary'''
* ''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 88: Line 74:
| update    || date of the last update
| update    || date of the last update
|-
|-
| mediawiki  || required version of MediaWiki
| readme    || link to the readme file
|-
|-
| '''download''' || '''link to the download''' : [http://svn.wikimedia.org/svnroot/mediawiki/trunk/extensions/ SVN] or other
| changelog  || link to the changelog file
|-
| 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 LocalSettings.php
| parameters || available parameters for common.php (if needed)
|-
| rights    || rights added by the extension
|-
|-
| example    || example, website or screenshot of working extension
| example    || example, website or screenshot of working feature
|}
|}
|
|
Line 113: Line 93:
|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:52, 30 May 2007

This is a OM2 Platform Feature
Crystal Clear action run.png
Extension

Release status: unknown

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

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 OM2 Project.

Usage

Parameters
name name of the platform feature
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:

  • function - Global Function
  • class - Platform PHP Class
  • module - OM2 Module Resource
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
readme link to the readme file
changelog link to the changelog file
description short description
parameters available parameters for common.php (if needed)
example example, website or screenshot of working feature 
{{Extension
|name      = 
|status    =
|type      =
|author    =
|image     =
|version   =
|update    =
|readme    =
|changelog =
|description =
|parameters=
|example   =
}}
Retrieved from "https://wiki.tessercat.net/index.php?title=Template:Extension&oldid=10022"