Difference between revisions of "OXPIconSummary"

From Elite Wiki
m
m
Line 1: Line 1:
Summary of icons for [[:Template:IconOXP]]
 
  +
__TOC__
  +
  +
{{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:
 
An example:
Line 14: Line 18:
 
}}
 
}}
   
== Minimum ==
+
== Required ==
 
=== ooVersion ===
 
=== 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.
|[[Image:IconOONo.png]]
 
  +
|Not specified
 
  +
Values: "1.76", "1.76.1", "1.77", "1.77.1".
|-
 
  +
|[[Image:IconOOPre1_76.png]]
 
  +
[[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]]
|"1.51"
 
|-
 
|[[Image:IconOO1_76.png]]
 
|"1.76"
 
|-
 
|[[Image:IconOO1_76_1.png]]
 
|"1.76.1"
 
|-
 
|[[Image:IconOO1_77.png]]
 
|"1.77"
 
|-
 
|[[Image:IconOO1_77_1.png]]
 
|"1.77.1"
 
|}
 
   
 
=== oxpCPU ===
 
=== oxpCPU ===
{|
 
  +
Specifies the CPU usage during normal gameplay. Result in '??' if not specified, empty or value not listed.
|[[Image:IconOXPCPUNo.png]]
 
  +
|Not specified
 
  +
Values: "Low", "Average", "Medium", "High", Heavy".
|-
 
  +
|[[Image:IconOXPCPULow.png]]
 
  +
[[Image:IconOXPCPUNo.png]][[Image:IconOXPCPULow.png]][[Image:IconOXPCPUAverage.png]][[Image:IconOXPCPUMedium.png]][[Image:IconOXPCPUHigh.png]][[Image:IconOXPCPUHeavy.png]]
|"Low"
 
|-
 
|[[Image:IconOXPCPUAverage.png]]
 
|"Average"
 
|-
 
|[[Image:IconOXPCPUMedium.png]]
 
|"Medium"
 
|-
 
|[[Image:IconOXPCPUHigh.png]]
 
|"High"
 
|-
 
|[[Image:IconOXPCPUHeavy.png]]
 
|"Heavy"
 
|}
 
   
 
=== oxpMEM ===
 
=== oxpMEM ===
{|
 
  +
Specifies the memory usage during normal gameplay. Result in '??' if not specified, empty or value not listed.
|[[Image:IconOXPMEMNo.png]]
 
  +
|Not specified
 
  +
Values: "Low", "Average", "Medium", "High", Heavy".
|-
 
  +
|[[Image:IconOXPMEMLow.png]]
 
  +
[[Image:IconOXPMEMNo.png]][[Image:IconOXPMEMLow.png]][[Image:IconOXPMEMAverage.png]][[Image:IconOXPMEMMedium.png]][[Image:IconOXPMEMHigh.png]][[Image:IconOXPMEMHeavy.png]]
|"Low"
 
|-
 
|[[Image:IconOXPMEMAverage.png]]
 
|"Average"
 
|-
 
|[[Image:IconOXPMEMMedium.png]]
 
|"Medium"
 
|-
 
|[[Image:IconOXPMEMHigh.png]]
 
|"High"
 
|-
 
|[[Image:IconOXPMEMHeavy.png]]
 
|"Heavy"
 
|}
 
   
 
=== oxpGPU ===
 
=== oxpGPU ===
{|
 
  +
Specifies the GPU usage during normal gameplay. Result in '??' if not specified, empty or value not listed.
|[[Image:IconOXPGPUNo.png]]
 
  +
|Not specified
 
  +
Values: "Low", "Average", "Medium", "High", Heavy".
|-
 
  +
|[[Image:IconOXPGPULow.png]]
 
  +
[[Image:IconOXPGPUNo.png]][[Image:IconOXPGPULow.png]][[Image:IconOXPGPUAverage.png]][[Image:IconOXPGPUMedium.png]][[Image:IconOXPGPUHigh.png]][[Image:IconOXPGPUHeavy.png]]
|"Low"
 
  +
|-
 
|[[Image:IconOXPGPUAverage.png]]
 
|"Average"
 
|-
 
|[[Image:IconOXPGPUMedium.png]]
 
|"Medium"
 
|-
 
|[[Image:IconOXPGPUHigh.png]]
 
|"High"
 
|-
 
|[[Image:IconOXPGPUHeavy.png]]
 
|"Heavy"
 
|}
 
   
 
== Optional ==
 
== Optional ==
 
=== oxpIsAPI ===
 
=== oxpIsAPI ===
{|
 
  +
Specifies if the OXP ships a API or has entry points for other OXPs.
|[[Image:IconOXPIsAPI.png]]
 
  +
|true, or empty
+
Values: true or empty.
|}
+
  +
[[Image:IconOXPIsAPI.png]]
   
 
=== oxpIsChild ===
 
=== oxpIsChild ===
{|
 
  +
Specifies if the OXP requires other OXPs.
|[[Image:IconOXPIsChild.png]]
 
  +
|true, or empty
+
Values: true or empty.
|}
+
  +
[[Image:IconOXPIsChild.png]]
   
 
=== oxpIsConfigurable ===
 
=== oxpIsConfigurable ===
{|
 
  +
Specifies if OXP can be configured ingame, either by handling it on its own or by using [[OXPConfig]].
|[[Image:IconOXPIsConfigurable.png]]
 
  +
|true, or empty
+
Values: true or empty.
|}
+
  +
[[Image:IconOXPIsConfigurable.png]]
   
 
=== oxpIsDocumented ===
 
=== oxpIsDocumented ===
{|
 
  +
Specifies if OXP has documentation for configuration, entry points or other important bits for other OXPs.
|[[Image:IconOXPIsDocumented.png]]
 
  +
|true, or empty
+
Values: true or empty.
|}
+
  +
[[Image:IconOXPIsDocumented.png]]
   
 
=== oxpIsParent ===
 
=== oxpIsParent ===
{|
 
  +
Specifies if OXP is required by other OXPs.
|[[Image:IconOXPIsParent.png]]
 
  +
|true, or empty
+
Values: true or empty.
|}
+
  +
[[Image:IconOXPIsParent.png]]

Revision as of 11:50, 30 September 2013

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