Template:Convert/doc: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
| Line 5: | Line 5: | ||
| <small>Shortcut</small><hr />'''<nowiki>{{</nowiki>[[Template:cvt|cvt]]<nowiki>}}</nowiki>''' | | <small>Shortcut</small><hr />'''<nowiki>{{</nowiki>[[Template:cvt|cvt]]<nowiki>}}</nowiki>''' | ||
|}</div> | |}</div> | ||
The <nowiki>{{</nowiki>[[Template:Convert|convert]]}} calculates the value of a measurement in one unit from the value of another unit and presents a formatted result. The result can be rounded. | The <nowiki>{{</nowiki>[[Template:Convert|convert]]}} template calculates the value of a measurement in one unit from the value of another unit and presents a formatted result. The result can be rounded. | ||
==Usage== | ==Usage== | ||
| Line 19: | Line 19: | ||
| <code>2</code> || Measurement unit || String || '''Required''' || Use the unit code from [[#Supported units|supported units]] below | | <code>2</code> || Measurement unit || String || '''Required''' || Use the unit code from [[#Supported units|supported units]] below | ||
|- | |- | ||
| <code>3</code> || Rounding || Numeric || Optional || Defaults to the nearest integer. Setting a positive number adds decimal places. Setting a negative number rounds to the left of the decimal point (e.g., tens, hundreds, thousands, etc.). | | <code>3</code> || Rounding || Numeric || Optional || Defaults to 0, the nearest integer. Setting a positive number adds decimal places. Setting a negative number rounds to the left of the decimal point (e.g., tens, hundreds, thousands, etc.). | ||
|} | |} | ||
Revision as of 04:43, 24 September 2024
|
This is a documentation subpage for Template:Convert. It may contain usage information, categories and other content that is not part of the original template page. |
| Shortcut {{cvt}} |
The {{convert}} template calculates the value of a measurement in one unit from the value of another unit and presents a formatted result. The result can be rounded.
Usage
- Basic usage:
{{convert|1|2}} - Full usage:
{{convert|1|2|3}}
Parameters
| Parameter | Description | Type | Status | Notes |
|---|---|---|---|---|
1 |
Measurement value | Numeric | Required | May be formatted or unformatted |
2 |
Measurement unit | String | Required | Use the unit code from supported units below |
3 |
Rounding | Numeric | Optional | Defaults to 0, the nearest integer. Setting a positive number adds decimal places. Setting a negative number rounds to the left of the decimal point (e.g., tens, hundreds, thousands, etc.). |
Supported units
| Type | Unit | Unit code | Calculated unit | Sample default result |
|---|---|---|---|---|
| Area | square kilometer | km2 | square mile | 10 km2 (4 sq mi) |
| square mile | sqmi sq mi |
square kilometer | 10 sq mi (26 km2) | |
| square meter | m2 | square feet | 10 m2 (108 sq ft) | |
| square feet | sqft sq ft |
square meter | 10 sq ft (1 m2) | |
| Length | kilometer | km | mile | 10 km (6 mi) |
| mile | mi | kilometer | 10 mi (16 km) | |
| meter | m | feet | 10 m (33 ft) | |
| feet | ft | meter | 10 ft (3 m) | |
| yard | yd | meter | 10 yd (9 m) | |
| Mass | kilogram | kg | pound | 10 kg (22 lb) |
| pound | lb | kilogram | 10 lb (5 kg) |