Template:Convinfobox/doc

This is a documentation subpage for Template:Convinfobox.
It may contain usage information, categories and other content that is not part of the original template page.

This template has been developed differently to the version maintained on the English Wikipedia.

Parts of this wiki work differently to other wikis and this template has been adapted to suit. If you are making a major change to it, please first familiarise yourself with how it works and why it is different. The page's revision history may contain more information. Do not simply "update" the markup without checking how this will affect the template's local function. If your edit causes unexpected problems, please undo it quickly.

This template is based on {{convert}}. It is intended as a meta-template for use in infoboxes. It accepts from four to seven unnamed parameters. Odd parameters must be numerical (or empty) and specify the numerical value of a measurement and the intended precision of the conversion. Even parameters must be unit codes as used in {{convert}}. Named parameters are the same as used by {{convert}}.

This template differs from {{convert}} in the following respects.

The units to convert to and the units to convert from must be specified (therefore there are no default convert-to units).
Fields for the numerical value of a measurement may be left blank.
The default is to abbreviate units (where abbreviations exist).
Range conversions are not available.

This template may be used when it is unknown in which direction the conversion is to be made. The direction is determined as shown in the following examples.

{{convinfobox|100|m2||sqft}} gives "100 m² (1,100 sq ft)"
{{convinfobox||m2|100|sqft}} gives "100 sq ft (9.3 m²)"

Leaving all numerical fields blank

If all numerical value fields are left blank the template returns nothing.

{{convinfobox||m2||sqft}} gives ""
{{convinfobox||ml||impoz||USoz}} gives ""

Specifying more than one value

The template currently bases conversions on the first non-blank numerical value ignoring any secondary or tertiary values.

{{convinfobox|100|m2|100|sqft}} gives "100 m² (1,100 sq ft)"

Rounding

As with {{convert}} rounding can be done automatically or manually by specifying the precision and/or number of significant figures in the converted value. The number of significant figures can be determined by the parameter sigfig. The precision can be determined by the fifth (if there is no sixth) or seventh (if there is a sixth) unnamed parameter as shown in the examples below.

{{convinfobox|100|m2||sqft|4}} gives "100 m² (1,076.3910 sq ft)"
{{convinfobox|100|m2||sqft|sigfig=4}} gives "100 m² (1,076 sq ft)"