Template:Convinfobox/priter3/doc
File:Edit-copy green.svg | This is a documentation subpage for Template:Convinfobox/priter3. It contains usage information, categories and other content that is not part of the original template page. |
File:Ambox warning yellow.svg | This template is used on 98,000+ pages, so changes to it will be widely noticed. Please test any changes in the template's /sandbox or /testcases subpages, or in a user subpage, and consider discussing changes at the talk page before implementing them. |
This template is a frontend for {{convert}}. It is intended as a meta-template for use within the code for a template, where the input is not known a priori. For unit conversions within articles, one should use {{convert}} directly.
This template 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 Template:Tlf. Named parameters are the same as used by Template:Tlf.
This template differs from Template:Tlf 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
}} → Template:Convinfobox/pri2 - {{
convinfobox||m2|100|sqft
}} → Template:Convinfobox/sec2
Dual conversions
Dual conversions may be performed by adding a fifth (possibly blank) and sixth unnamed parameter.
- {{
convinfobox|375|ml||impoz||USoz
}} → Template:Convinfobox/pri3 - {{
convinfobox||ml|40|impoz||USoz
}} → Template:Convinfobox/sec3 - {{
convinfobox||ml||impoz|32|USoz
}} → Template:Convinfobox/ter3
Paired units
Length may be expressed in feet and inches.
- {{
convinfobox|180|cm||ft||in
}} → Template:Convinfobox/pri3 - {{
convinfobox||cm|5|ft||in
}} → Template:Convinfobox/sec3 - {{
convinfobox||cm||ft|120|in
}} → Template:Convinfobox/ter3 - {{
convinfobox||cm|5|ft|6|in
}} → Template:Convinfobox/secter3 - {{
convinfobox||ft||in|180|cm
}} → Template:Convinfobox/ter3 - {{
convinfobox|5|ft||in||cm
}} → Template:Convinfobox/pri3 - {{
convinfobox||ft|120|in||cm
}} → Template:Convinfobox/sec3 - {{
convinfobox|5|ft|6|in||cm
}} → Template:Convinfobox/prisec3
Similarly, mass may be expressed in pounds and ounces.
- {{
convinfobox|8.5|kg||lb||oz
}} → Template:Convinfobox/pri3 - {{
convinfobox||kg|4|lb|3|oz
}} → Template:Convinfobox/secter3
Mass may also be expressed in stone and pounds.
- {{
convinfobox|65|kg||st||lb
}} → Template:Convinfobox/pri3 - {{
convinfobox||kg|10|st||lb
}} → Template:Convinfobox/sec3 - {{
convinfobox||kg|10|st|7|lb
}} → Template:Convinfobox/secter3 - {{
convinfobox||kg||st|145|lb
}} → Template:Convinfobox/ter3
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
}} → Template:Convinfobox/prisec2 - {{
convinfobox|375|ml|40|impoz||USoz
}} → Template:Convinfobox/prisec3 - {{
convinfobox|375|ml||impoz|32|USoz
}} → Template loop detected: Template:Convinfobox/priter3 - {{
convinfobox||ml|40|impoz|32|USoz
}} → Template:Convinfobox/secter3
Rounding
As with Template:Tlf 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
}} → Template:Convinfobox/pri2 - {{
convinfobox|100|m2||sqft|sigfig=4
}} → Template:Convinfobox/pri2 - {{
convinfobox||ml|40|impoz||USoz|2
}} → Template:Convinfobox/sec3 - {{
convinfobox||ml|40|impoz||USoz|sigfig=3
}} → Template:Convinfobox/sec3 - {{
convinfobox||kg|10|st|7|lb|3
}} → Template:Convinfobox/secter3 - {{
convinfobox||kg|10|st|7|lb|sigfig=5
}} → Template:Convinfobox/secter3
Leaving all numerical fields blank
If all numerical value fields are left blank the template returns nothing.
- {{
convinfobox||m2||sqft
}} → Template:Convinfobox/2 - {{
convinfobox||ml||impoz||USoz
}} →
See also
- Supporting templates
- Templates transcluding {{convinfobox}}