|This documentation is transcluded at the start of the conversion data page.|
This page is read by a script (makeunits). The script extracts information from the wikitext, and outputs the Lua source that defines the table of units; that source can be manually copied into Module:Convert/data.
The script that reads this page ignores everything except for the wikitext in the following sections:
== Conversions ==
== Input multiples ==
== Output multiples ==
== Combinations ==
== Defaults ==
== Links ==
== Overrides ==
In those sections, a level-3 heading (like
=== Length ===) starts a table that defines units of a certain type. In the subsection, lines that start with
| are processed (all other lines, and lines that start with
|}, are ignored). A processed line is split into fields (delimited with
||), and leading/trailing whitespace is removed from each field. Empty fields in the Conversions section are given a default value (for example, the plural of yard is formed by adding s, and the US names are also yard and yards).
The second field in each row of the Conversions section normally specifies a unit's symbol, but it can be used for other purposes described in the following. In some cases the text in the second field can be long, and it is convenient to insert
colspan="11" | before the text to avoid it wrapping in a narrow column. Any such
colspan at the start of the second field is ignored.
Some unit codes are an alias for another spelling of the unit code. For example, the code
ft2 is an alias for
sqft, and that is indicated by entering
=sqft in the Symbol column for the
ft2 entry. An alias can only be entered after the primary unit has been defined (the
sqft entry must precede the
Normally there are no other entries on an alias line, however, the following may be used:
default = unit codeto specify that the alias has a default output that is different from the primary unit
link = link textto specify that the alias has a link that is different from the primary unit
multiplier = numberused as "multiplier = 100" with unit code
100kmto define a unit that is 100 times the size of a kilometre
sp = us) to specify that using the alias forces US spelling for that unit
symbol = symbol textto specify that the alias has a symbol that is different from the primary unit
symlink = link textto specify that the alias has a different link when abbreviated ("symbol link")
A unit can be defined as a ratio of two other units. For example,
L/km can be defined as "litres per kilometer" by entering
==L/km as the symbol for the unit. A single "
=" is used with an alias to specify that a unit code is an alternative name for another unit. By contrast, if "
==" is used, the unit code is defined as the first unit "per" the second.
As well as a ratio of two units, a per unit can be of the form "currency per unit". The module recognizes "$" and "£" as currency symbols and shows them appropriately. For example, the input
|120|$/acre would be displayed as "$120 per acre", or "$120/acre" if abbreviated.
The definition for a per unit can be followed by the same modifiers available for an alias.
Some unit codes should not be used—if such a code is used, the template displays an error message telling the editor what unit code should be entered. For example, the code
feet should not be used, and that is indicated by entering
!Message in the Symbol column for the
feet entry. There should be no other entries on an error line. The Message text is displayed as an error if
feet is used in a conversion. The text should use the special format codes
%} on each side of a unit code. The format codes are replaced with wikitext defined in Module:Convert, and which applies a consistent style to each displayed unit code.
Some units generally use their name, rather than a symbol. That is indicated by inserting
~ before the symbol. For example, the code
acre has symbol
~acre which means results will use the singular name "acre", or the plural name "acres", depending on the value.
The prefix column should be empty if SI prefixes are not used, or should be
SI for a normal unit that accepts SI prefixes. Unit
m2 should have prefix
SI2 so that, for example,
km2 will be regarded as 1000 × 1000 of the
m2 base unit. Similarly, unit
m3 should have prefix
%s in the name columns is replaced with the appropriate SI prefix, or is removed if SI prefixes are not appropriate (not suitable for the unit, or not used in the conversion). It is only necessary to use
%s if the unit accepts prefixes, and if the prefix is not at the start of the unit's name, for example with
Spelling exceptions can be handled by entering a row with the exception. For example, see
ha which sets the unit name to "hectare"; without that row, the
a row would cause
ha to have the name "hectoare". There must be an override to document that an exception is intended.
The scale is a value or expression that is used as a factor to convert a value to its corresponding base unit. Commas may be used as a thousand separator.
Extra column is usually empty, but can contain a value or code when more than a simple
Scale is required for a conversion. There are two codes used with fuel efficiency units:
length/volume. In addition, certain codes are required to indicate that the conversion procedure for the unit is built-in to the module. Any other text is used as an offset in the conversion calculation that occurs with temperature units.
The conversion procedure for some units (for example, the
Mach unit of speed) are built into Module:Convert as they are too complex to be specified in a table. That is indicated by entering a code (which must be the same as used in the module) in the Extra column.
The script that reads this page contains a small amount of built-in data that does not conveniently fit into the tables below (see
set_builtins in makeunits).
A default is a code for a unit or combination that identifies the output unit or units that will be used if none is specified in the convert template. The Defaults section defines exceptions for unit codes with an SI prefix, where the default output is different from that of the base unit. Also, units using engineering notation may appear in the defaults section to define a default output for the unit.
A default may specify a unit code or an expression that tests the input value, and which produces one of two different outputs depending on that value. In the expression,
v represents the input value specified in the convert template, and exclamation marks (
!) are used to separate the expression into either three or four fields. For example, the following expression might be used as the default for unit
v < 36 ! mm ! cm
The first field is a condition which evaluates to true or false. In this example, if the input value is less than 36, the default output unit is
mm; otherwise, it is
If present, the fourth field is appended to the result. For example, the following expression might be used for unit
v < 28.316846592 ! e3 ! e6 ! cuft
If the condition is true, the result is
e3cuft; otherwise, it is
A composite input unit consists of two standard units, where the second is a subdivision of the first. For example,
|2|ft|6|in may be used to specify 2 feet 6 inches as the input unit in a conversion. See the Input multiples section.
Composites are defined in pairs, but any number of pairs can be used to specify an input. For example, given that
ch is defined as a subdivision of
mi, and that
ft is a subdivision of
ch, an input length could be specified as
1|mi|2|ch|3|ft. Also, with suitable pairs defined, an input length could be specified as
4|mi|3|yd|2|ft|1|in. There is no limit to the number of permitted subunits.
A multiple is a unit code that can be used as an output. For example,
ftin is a multiple that results in a length being expressed in feet and inches. A multiple may have any number of components defined in the Output multiples section, where each component is a subdivision of the preceding unit.
The link column is the title of the article related to that unit. If the link is preceded with
*, extra text will be inserted before the link, and the text shown by the link will be adjusted to omit a prefix of "US" or "U.S.", if present. For example, if a unit has the symbol "US gal" (or "U.S. gal"), and if the link is
+[[Gallon]], then if the symbol is linked, it would appear as "US gal" ("US" and "gal" link to two different articles). If the link is
*[[Gallon]], it would appear as "U.S. gal".
Similarly, if the link is preceded with
@, extra text will be inserted before the link, and the text shown by the link will be adjusted to omit a prefix of "imp" or "imperial", if present. For example, if a unit has the symbol "imp gal", and if the link is
@[[Gallon]], then if the symbol is linked, it would appear as "imp gal" ("imp" and "gal" link two different articles).
The Links section defines exceptions for unit codes with an SI prefix, where the linked article is different from that of the base unit.
Pipe characters (
|) in a table need to be encoded. For example, "
[[Gallon|gal]]" should be entered as "
[[Gallon|gal]]". The script that reads this page replaces each
Some unit codes match a unit with an SI prefix, and duplicate unit codes are not permitted. For example,
Pa can be interpreted as "peta-are" which would prevent the
pascal unit of pressure being defined after the
are unit of area. However, listing
Pa in the Overrides section means that the pascal unit can be defined, in which case peta-are will not be available.
Some unit codes are not intended to be used in a template, but are needed to define exceptions. For example, the code
ft has link Foot (unit), but unit
ft to be linked to Fracture gradient. To handle such cases, a unit code starting with "
-" is used (
-ft-frac for feet with a link to fracture gradient).
If needed, more dashes can be used to define additional exceptions (for example, see
--Scwt, which are similar to
Scwt but have different names).
Some infrequently used units have not yet been implemented, and there are some minor differences in the output produced by the module, when compared with the existing templates (see the testcases).
In addition to the units defined in the data below, large scale units such as
e6km (million kilometres) may be used. The following prefixes may be used, and the linked names are shown if
lk is on:
Any standard unit (not a combination, multiple, or built-in) may be used after an engineering notation prefix, including "temperature change" units, but not "temperature" units.