Difference between revisions of "Template:OBSE Plugin"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
imported>Speedo
m
imported>Darkness X
m
 
(26 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<noinclude>
<noinclude>This template is used to display information on the main page of an OBSE plugin.  It will automatically add the page to [[:Category: OBSE Plug-Ins]].
This template is used to display information on the main page of an OBSE plugin.  It will automatically add the page to [[:Category: OBSE Plug-Ins]].


To use the template, include the following in the desired page:
To use the template, include the following in the desired page:


<pre>
<nowiki>{{OBSE Plugin</nowiki>
{{OBSE Plugin
|Version    = OPTIONAL (should be the latest public release)
|Name        = (the name of the plugin)
|InternalVer = OPTIONAL (number returned by [[GetPluginVersion]])
|Author      = (the plugin's author)
|Name        =
|Version    = (the latest public release of the plugin)
|Author      =
|InternalVer = (the version number returned by GetPluginVersion)
|Description =
|Description = (a description of the plugin)
|Install    = (installation instructions)
|Install    = (directions to install the plugin)
|Download    = (download link)
|Download    = (download link)
|Source      = OPTIONAL (source code link - see note)
|Source      = {download link for the Source Code}
|Discussions = OPTIONAL
|Discussions = (any forum threads/wiki talk pages or etc that discuss the plugin)
|OBSEname    = OPTIONAL (name used for [[IsPluginInstalled]]
|OBSEname    = (the plugin's internal name to use with IsPluginInstalled)
|TitleBG    = OPTIONAL (color of title boxes, default #ffdead)
}}
|TextBG      = OPTIONAL (color of text boxes, default #ffeded)
</pre>
}}
 
==Notes==
*If you wish to include optional values when using the template, but still displaying their default information (Unknown/NA/etc.), set their value as '''0'''.
**The exception is ''InternalVer'', which must be set to '''null''' to display default information.
*If ''Source'' is not defined or '''0''', the template will display "Not Available".  If the source code is available at the same link given in ''Download'', you can simply use "Source=1" to duplicate the link.
 
 
----
</noinclude>
</noinclude>


{| border="2" cellpadding="5" cellspacing="0" width="80%" align="center"
{| border="2" cellpadding="5" cellspacing="0" width="80%" align="center"
|-
|-
!style="background:#ffdead; font-size:150%" colspan="2"|{{{Name}}}
!style="background:{{{TitleBG|#ffdead}}}; font-size:150%" colspan="2"|{{{Name}}}
|-
|-
!style="background:#ffdead;" width="20%"|Author(s)
!style="background:{{{TitleBG|#ffdead}}};" width="20%"|Author(s)
|style="background:#ffeded;"|
|style="background:{{{TextBG|#ffeded}}};"|
{{{Author}}}
{{{Author}}}
|-
|-
!style="background:#ffdead;" width="20%"|Current Version
!style="background:{{{TitleBG|#ffdead}}};" width="20%"|Current Version
|style="background:#ffeded;"|'''{{{Version}}}''' <font style="font-size:90%">([[GetPluginVersion]] returns '''{{{InternalVer}}}''')</font>
|style="background:{{{TextBG|#ffeded}}};"|{{ #ifeq: {{{Version|0}}} | 0 | {{ #ifeq: {{{InternalVer|null}}} | null | '''(Unknown)''' | [[GetPluginVersion]] returns '''{{{InternalVer}}}''' }} | '''{{{Version}}}''' <font style="font-size:90%">([[GetPluginVersion]] returns '''{{ #ifeq: {{{InternalVer|null}}} | null | (Unknown) | {{{InternalVer}}} }}''')</font> }}
|-
|-
!style="background:#ffdead;" width="20%"|Description
!style="background:{{{TitleBG|#ffdead}}};" width="20%"|Description
|style="background:#ffeded;"|
|style="background:{{{TextBG|#ffeded}}};"|
{{{Description}}}
{{{Description}}}
|-
|-
!style="background:#ffdead;" width="20%"|Installation
!style="background:{{{TitleBG|#ffdead}}};" width="20%"|Installation
|style="background:#ffeded;"|
|style="background:{{{TextBG|#ffeded}}};"|
{{{Install}}}
{{{Install}}}
|-
|-
!style="background:#ffdead;" width="20%"|Download
!style="background:{{{TitleBG|#ffdead}}};" width="20%"|Download
|style="background:#ffeded;"|
|style="background:{{{TextBG|#ffeded}}};"|
{{{Download}}}
{{{Download}}}
|-
|-
!style="background:#ffdead;" width="20%"|Source Code
!style="background:{{{TitleBG|#ffdead}}};" width="20%"|Source Code
|style="background:#ffeded;"|
|style="background:{{{TextBG|#ffeded}}};"|
{{{Source}}}
{{ #ifeq: {{{Source|0}}} | 0 | Not Available | {{ #ifeq: {{{Source}}} | 1 | {{{Download}}} | {{{Source}}} }} }}
|-
|-
!style="background:#ffdead;" width="20%"|Discussions
!style="background:{{{TitleBG|#ffdead}}};" width="20%"|Discussions
|style="background:#ffeded;"|
|style="background:{{{TextBG|#ffeded}}};"|
{{{Discussions}}}
{{ #ifeq: {{{Discussions|0}}} | 0 | (None) | {{{Discussions}}} }}
|-
|-
!style="background:#ffdead;" width="20%"|OBSE Name
!style="background:{{{TitleBG|#ffdead}}};" width="20%"|OBSE Name
|style="background:#ffeded;"|"{{{OBSEname}}}"
|style="background:{{{TextBG|#ffeded}}};"|{{ #ifeq: {{{OBSEname|0}}} | 0 | (Unknown) | "{{{OBSEname}}}"
<font style="font-size:90%">(for use with [[IsPluginInstalled]]/[[GetPluginVersion]])</font>
<font style="font-size:90%">(for use with [[IsPluginInstalled]]/[[GetPluginVersion]])</font> }}
|}
|}
<includeonly>
<includeonly>
[[Category: OBSE Plug-Ins]]
[[Category: OBSE Plug-Ins]]
</includeonly>
</includeonly>
<noinclude>
[[Category: Templates|OBSE Plugin]]
[[Category: Function Info Templates|OBSE Plugin]]
</noinclude>

Latest revision as of 09:50, 7 August 2010

This template is used to display information on the main page of an OBSE plugin. It will automatically add the page to Category: OBSE Plug-Ins.

To use the template, include the following in the desired page: 

{{OBSE Plugin
|Version     = OPTIONAL (should be the latest public release)
|InternalVer = OPTIONAL (number returned by GetPluginVersion)
|Name        =
|Author      =
|Description =
|Install     = (installation instructions)
|Download    = (download link)
|Source      = OPTIONAL (source code link - see note)
|Discussions = OPTIONAL
|OBSEname    = OPTIONAL (name used for IsPluginInstalled
|TitleBG     = OPTIONAL (color of title boxes, default #ffdead)
|TextBG      = OPTIONAL (color of text boxes, default #ffeded)
}}

Notes[edit source]

  • If you wish to include optional values when using the template, but still displaying their default information (Unknown/NA/etc.), set their value as 0.
    • The exception is InternalVer, which must be set to null to display default information.
  • If Source is not defined or 0, the template will display "Not Available". If the source code is available at the same link given in Download, you can simply use "Source=1" to duplicate the link.



{{{Name}}}
Author(s)

{{{Author}}}

Current Version (Unknown)
Description

{{{Description}}}

Installation

{{{Install}}}

Download

{{{Download}}}

Source Code

Not Available

Discussions

(None)

OBSE Name (Unknown)
Retrieved from "https://cs.uesp.net/w/index.php?title=Template:OBSE_Plugin&oldid=709"