Difference between revisions of "Template:IconOXP"

From Elite Wiki
m
m (added version 1.90)
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{IconOOV|{{{ooVersion|}}}}}{{IconOXPCPU|{{{oxpCPU|}}}}}{{IconOXPMEM|{{{oxpMEM|}}}}}{{IconOXPGPU|{{{oxpGPU|}}}}}{{#if:{{{oxpIsParent|}}}|[[Image:IconOXPIsParent.png|32px|link=OXPIconSummary]]}}{{#if:{{{oxpIsChild|}}}|[[Image:IconOXPIsChild.png|32px|link=OXPIconSummary]]}}{{#if:{{{oxpIsAPI|}}}|[[Image:IconOXPIsAPI.png|32px|link=OXPIconSummary]]}}{{#if:{{{oxpIsDocumented|}}}|[[Image:IconOXPIsDocumented.png|32px|link=OXPIconSummary]]}}{{#if:{{{oxpIsConfigurable|}}}|[[Image:IconOXPIsConfigurable.png|32px|link=OXPIconSummary]]}}
+
{{IconOOV|{{{ooVersion|}}}}}{{IconOXPCPU|{{{oxpCPU|}}}}}{{IconOXPMEM|{{{oxpMEM|}}}}}{{IconOXPGPU|{{{oxpGPU|}}}}}{{#if:{{{oxpIsParent|}}}|[[Image:IconOXPIsParent.png|32px|link=Template:IconOXP|isParent]]}}{{#if:{{{oxpIsChild|}}}|[[Image:IconOXPIsChild.png|32px|link=Template:IconOXP|isChild]]}}{{#if:{{{oxpIsAPI|}}}|[[Image:IconOXPIsAPI.png|32px|link=Template:IconOXP|isAPI]]}}{{#if:{{{oxpIsDocumented|}}}|[[Image:IconOXPIsDocumented.png|32px|link=Template:IconOXP|isDocumented]]}}{{#if:{{{oxpIsConfigurable|}}}|[[Image:IconOXPIsConfigurable.png|32px|link=Template:IconOXP|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 14:
 
|oxpIsConfigurable =
 
|oxpIsConfigurable =
 
}}</pre>
 
}}</pre>
|}</noinclude>
+
|}
 +
 
 +
{{Clear}}
 +
 
 +
{{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", "1.80", "1.82", "1.84", "1.86", "1.88", "1.90".
 +
 
 +
[[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]][[Image:IconOO1_80.png]][[Image:IconOO1_82.png]][[Image:IconOO1_84.png]][[Image:IconOO1_86.png]][[Image:IconOO1_88.png]][[Image:IconOO1_90.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>

Latest revision as of 12:34, 24 January 2021

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 =
}}

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", "1.80", "1.82", "1.84", "1.86", "1.88", "1.90".

IconOONo.pngIconOOPre1 76.pngIconOO1 76.pngIconOO1 76 1.pngIconOO1 77.pngIconOO1 77 1.pngIconOO1 80.pngIconOO1 82.pngIconOO1 84.pngIconOO1 86.pngIconOO1 88.pngIconOO1 90.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