Difference between revisions of "Template:Extension"
Jump to navigation
Jump to search
no edit summary
>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: | |+ '''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}}}}}| | <!-- -->{{!}} {{#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|}}}| ({{{update}}})}} | <!-- -->{{!}} {{{version}}}{{#if:{{{update|}}}| ({{{update}}})}} | ||
}} | }} | ||
|- | |- | ||
Line 36: | Line 31: | ||
<!-- -->{{!}} style="vertical-align: top" {{!}} '''Parameters:''' | <!-- -->{{!}} style="vertical-align: top" {{!}} '''Parameters:''' | ||
<!-- -->{{!}} {{{parameters}}} | <!-- -->{{!}} {{{parameters}}} | ||
}} | }} | ||
|- | |- | ||
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 | 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 | | '''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: | ||
* '' | * ''function'' - Global Function | ||
* ''class'' - Platform PHP Class | |||
* ''module'' - OM2 Module Resource | |||
|- | |||
* '' | |colspan="2" align="center"|'''Please add to this list if necessary''' | ||
* '' | |||
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 | ||
|- | |- | ||
| | | readme || link to the readme file | ||
|- | |- | ||
| changelog || link to the changelog file | |||
| changelog || link to the changelog file | |||
|- | |- | ||
| '''description''' || '''short description''' | | '''description''' || '''short description''' | ||
|- | |- | ||
| parameters || available parameters for | | parameters || available parameters for common.php (if needed) | ||
|- | |- | ||
| example || example, website or screenshot of working | | example || example, website or screenshot of working feature | ||
|} | |} | ||
| | | | ||
Line 113: | Line 93: | ||
|version = | |version = | ||
|update = | |update = | ||
|readme = | |readme = | ||
|changelog = | |changelog = | ||
|description = | |description = | ||
|parameters= | |parameters= | ||
|example = | |example = | ||
}}</nowiki> | }}</nowiki> | ||
|} | |} | ||
[[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> |