Difference between revisions of "Template:IconOXP"

From Elite Wiki
m
(Move this here, since that page was clearly a documentation page.)
Line 1: Line 1:
−
{{IconOOV|{{{ooVersion|}}}}}{{IconOXPCPU|{{{oxpCPU|}}}}}{{IconOXPMEM|{{{oxpMEM|}}}}}{{IconOXPGPU|{{{oxpGPU|}}}}}{{#if:{{{oxpIsParent|}}}|[[Image:IconOXPIsParent.png|32px|link=OXPIconSummary|isParent]]}}{{#if:{{{oxpIsChild|}}}|[[Image:IconOXPIsChild.png|32px|link=OXPIconSummary|isChild]]}}{{#if:{{{oxpIsAPI|}}}|[[Image:IconOXPIsAPI.png|32px|link=OXPIconSummary|isAPI]]}}{{#if:{{{oxpIsDocumented|}}}|[[Image:IconOXPIsDocumented.png|32px|link=OXPIconSummary|isDocumented]]}}{{#if:{{{oxpIsConfigurable|}}}|[[Image:IconOXPIsConfigurable.png|32px|link=OXPIconSummary|isConfigurable]]}}
 +
{{IconOOV|{{{ooVersion|}}}}}{{IconOXPCPU|{{{oxpCPU|}}}}}{{IconOXPMEM|{{{oxpMEM|}}}}}{{IconOXPGPU|{{{oxpGPU|}}}}}{{#if:{{{oxpIsParent|}}}|[[Image:IconOXPIsParent.png|32px|link=OXPIconSummary|isParent]]}}{{#if:{{{oxpIsChild|}}}|[[Image:IconOXPIsChild.png|32px|link=OXPIconSummary|isChild]]}}{{#if:{{{oxpIsAPI|}}}|[[Image:IconOXPIsAPI.png|32px|link=OXPIconSummary|isAPI]]}}{{#if:{{{oxpIsDocumented|}}}|[[Image:IconOXPIsDocumented.png|32px|link=OXPIconSummary|isDocumented]]}}{{#if:{{{oxpIsConfigurable|}}}|[[Image:IconOXPIsConfigurable.png|32px|link=OXPIconSummary|isConfigurable]]}}<noinclude>
−
<noinclude><br><br>For infos see [[OXPIconSummary]]. To use include the following:
 +
  +
To use include the following:
 
{| style="background: transparent; float: left;"
 
{| style="background: transparent; float: left;"
 
|<pre>{{IconOXP
  
|<pre>{{IconOXP
Line 13: Line 13:
 
|oxpIsConfigurable =
  
|oxpIsConfigurable =
 
}}</pre>
  
}}</pre>
−
|}</noinclude>
  
  +
|}
  +
  +
{{OXPNote|The template itself is work in progress and will get more icons. Later on it will push SemanticMediaWiki properties.}}
  +
Summary of icons for [[:Template:IconOXP]]. The icons itself should give users a visual hint about expected costs and features.
  +
  +
  +
An example:
  +
{{IconOXP
  +
|ooVersion = "1.77"
  +
|oxpCPU = "Low"
  +
|oxpMEM = "Medium"
  +
|oxpGPU = "Heavy"
  +
|oxpIsParent = true
  +
|oxpIsChild = true
  +
|oxpIsAPI = true
  +
|oxpIsDocumented = true
  +
|oxpIsConfigurable = true
  +
}}
  +
  +
== Required ==
  +
=== ooVersion ===
  +
Specifies the required minimum version of Oolite for the latest OXP version. The template expects a string with the version number.Results in '??' if not specified or '<1.76' if the string is empty or the value is not listed.
  +
  +
Values: "1.76", "1.76.1", "1.77", "1.77.1".
  +
  +
[[Image:IconOONo.png]][[Image:IconOOPre1_76.png]][[Image:IconOO1_76.png]][[Image:IconOO1_76_1.png]][[Image:IconOO1_77.png]][[Image:IconOO1_77_1.png]]
  +
  +
=== oxpCPU ===
  +
Specifies the CPU usage during normal gameplay. Result in '??' if not specified, empty or value not listed.
  +
  +
Values: "Low", "Average", "Medium", "High", Heavy".
  +
  +
[[Image:IconOXPCPUNo.png]][[Image:IconOXPCPULow.png]][[Image:IconOXPCPUAverage.png]][[Image:IconOXPCPUMedium.png]][[Image:IconOXPCPUHigh.png]][[Image:IconOXPCPUHeavy.png]]
  +
  +
=== oxpMEM ===
  +
Specifies the memory usage during normal gameplay. Result in '??' if not specified, empty or value not listed.
  +
  +
Values: "Low", "Average", "Medium", "High", Heavy".
  +
  +
[[Image:IconOXPMEMNo.png]][[Image:IconOXPMEMLow.png]][[Image:IconOXPMEMAverage.png]][[Image:IconOXPMEMMedium.png]][[Image:IconOXPMEMHigh.png]][[Image:IconOXPMEMHeavy.png]]
  +
  +
=== oxpGPU ===
  +
Specifies the GPU usage during normal gameplay. Result in '??' if not specified, empty or value not listed.
  +
  +
Values: "Low", "Average", "Medium", "High", Heavy".
  +
  +
[[Image:IconOXPGPUNo.png]][[Image:IconOXPGPULow.png]][[Image:IconOXPGPUAverage.png]][[Image:IconOXPGPUMedium.png]][[Image:IconOXPGPUHigh.png]][[Image:IconOXPGPUHeavy.png]]
  +
  +
  +
== Optional ==
  +
=== oxpIsAPI ===
  +
Specifies if the OXP ships a API or has entry points for other OXPs.
  +
  +
Values: true or empty.
  +
  +
[[Image:IconOXPIsAPI.png]]
  +
  +
=== oxpIsChild ===
  +
Specifies if the OXP requires other OXPs.
  +
  +
Values: true or empty.
  +
  +
[[Image:IconOXPIsChild.png]]
  +
  +
=== oxpIsConfigurable ===
  +
Specifies if OXP can be configured ingame, either by handling it on its own or by using [[OXPConfig]].
  +
  +
Values: true or empty.
  +
  +
[[Image:IconOXPIsConfigurable.png]]
  +
  +
=== oxpIsDocumented ===
  +
Specifies if OXP has documentation for configuration, entry points or other important bits for other OXPs.
  +
  +
Values: true or empty.
  +
  +
[[Image:IconOXPIsDocumented.png]]
  +
  +
=== oxpIsParent ===
  +
Specifies if OXP is required by other OXPs.
  +
  +
Values: true or empty.
  +
  +
[[Image:IconOXPIsParent.png]]
  +
</noinclude>

Revision as of 21:16, 23 January 2016

Minimum Oolite version not specifiedCPU usage not specifiedMemory usage not specifiedGPU usage not specified

To use include the following: 

{{IconOXP
|ooVersion =
|oxpCPU =
|oxpMEM =
|oxpGPU =
|oxpIsParent =
|oxpIsChild =
|oxpIsAPI =
|oxpIsDocumented =
|oxpIsConfigurable =
}}
Mr Gimlet.png

Please note:   The template itself is work in progress and will get more icons. Later on it will push SemanticMediaWiki properties..

Summary of icons for Template:IconOXP. The icons itself should give users a visual hint about expected costs and features.


An example: Minimum Oolite versionCPU usage lowMemory usage mediumGPU usage heavyisParentisChildisAPIisDocumentedisConfigurable

Required

ooVersion

Specifies the required minimum version of Oolite for the latest OXP version. The template expects a string with the version number.Results in '??' if not specified or '<1.76' if the string is empty or the value is not listed.

Values: "1.76", "1.76.1", "1.77", "1.77.1".

IconOONo.pngIconOOPre1 76.pngIconOO1 76.pngIconOO1 76 1.pngIconOO1 77.pngIconOO1 77 1.png

oxpCPU

Specifies the CPU usage during normal gameplay. Result in '??' if not specified, empty or value not listed.

Values: "Low", "Average", "Medium", "High", Heavy".

IconOXPCPUNo.pngIconOXPCPULow.pngIconOXPCPUAverage.pngIconOXPCPUMedium.pngIconOXPCPUHigh.pngIconOXPCPUHeavy.png

oxpMEM

Specifies the memory usage during normal gameplay. Result in '??' if not specified, empty or value not listed.

Values: "Low", "Average", "Medium", "High", Heavy".

IconOXPMEMNo.pngIconOXPMEMLow.pngIconOXPMEMAverage.pngIconOXPMEMMedium.pngIconOXPMEMHigh.pngIconOXPMEMHeavy.png

oxpGPU

Specifies the GPU usage during normal gameplay. Result in '??' if not specified, empty or value not listed.

Values: "Low", "Average", "Medium", "High", Heavy".

IconOXPGPUNo.pngIconOXPGPULow.pngIconOXPGPUAverage.pngIconOXPGPUMedium.pngIconOXPGPUHigh.pngIconOXPGPUHeavy.png


Optional

oxpIsAPI

Specifies if the OXP ships a API or has entry points for other OXPs.

Values: true or empty.

IconOXPIsAPI.png

oxpIsChild

Specifies if the OXP requires other OXPs.

Values: true or empty.

IconOXPIsChild.png

oxpIsConfigurable

Specifies if OXP can be configured ingame, either by handling it on its own or by using OXPConfig.

Values: true or empty.

IconOXPIsConfigurable.png

oxpIsDocumented

Specifies if OXP has documentation for configuration, entry points or other important bits for other OXPs.

Values: true or empty.

IconOXPIsDocumented.png

oxpIsParent

Specifies if OXP is required by other OXPs.

Values: true or empty.

IconOXPIsParent.png

Retrieved from "http://backup.witchspacewiki.org/index.php?title=Template:IconOXP&oldid=51028"