m (unitss -> units) |
(update based on discussion on IRC) |
||
| Line 8: | Line 8: | ||
===<unit>=== | ===<unit>=== | ||
And individual unit definition. <code>unit</code>s have <code>type</code>s, <code>base</code>s, and <code> | And individual unit definition. <code>unit</code>s have <code>type</code>s, <code>base</code>s, <code>mixed</code>, and <code>round</code>, and <code>conversion</code> values. The <code>type</code> describes the function of this unit, like "currency" or "weight". The <code>base</code> is the symbol of the base unit, like "gold" or "g" (gram). The optional <code>mixed</code> describes how to handle different units (described later; default tbd). <code>round</code> describes how many decimal places to round decimals (defaults to 1 for base unit and one less than the level for other units). <code>conversion</code> is the factor applied to the internal units to reach these units (defaults to 1). | ||
===<level>=== | ===<level>=== | ||
Each unit can have multiple levels. <code>level</code>s have <code>symbol</code>s and <code> | Each unit can have multiple levels. <code>level</code>s have <code>symbol</code>s, <code>count</code>s, and <code>round</code>s. <code>symbol</code> is the symbol to use for this level. <code>count</code> describes how many of the previous level is needed to for this level. <code>round</code> is as above, except it only applies to this level. | ||
==Example== | ==Example== | ||
| Line 25: | Line 25: | ||
</code> | </code> | ||
When <code>mixed</code> is <code>no</code>, a decimal with the largest units needed is used (ex: 1.05kg). When <code>mixed</code> is <code>yes</code>, all non-0 levels are shown (ex: 1kg, | When <code>mixed</code> is <code>no</code>, a decimal with the largest units needed is used (ex: 1.05kg). When <code>mixed</code> is <code>yes</code>, all non-0 levels are shown (ex: 1kg, 50g). | ||
Revision as of 16:35, 12 February 2009
This file describes the various units used in the interface, like currency and weight.
Structure
Unit files are in XML format.
<units>
This is the root element of the file.
<unit>
And individual unit definition. units have types, bases, mixed, and round, and conversion values. The type describes the function of this unit, like "currency" or "weight". The base is the symbol of the base unit, like "gold" or "g" (gram). The optional mixed describes how to handle different units (described later; default tbd). round describes how many decimal places to round decimals (defaults to 1 for base unit and one less than the level for other units). conversion is the factor applied to the internal units to reach these units (defaults to 1).
<level>
Each unit can have multiple levels. levels have symbols, counts, and rounds. symbol is the symbol to use for this level. count describes how many of the previous level is needed to for this level. round is as above, except it only applies to this level.
Example
<units>
<unit type="currency" base="GP"/>
<unit tpye="weight" base="g" mixed="no">
<level symbol="kg" count="1000"/>
</unit>
...
</units>
When mixed is no, a decimal with the largest units needed is used (ex: 1.05kg). When mixed is yes, all non-0 levels are shown (ex: 1kg, 50g).
