![]() | This template is used on approximately 38,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.
Preview message: Transclusion count updated automatically (see documentation). |
![]() | This template should not be used in citation templates such as Citation Style 1 and Citation Style 2, because it includes markup that will pollute the COinS metadata they produce; see Wikipedia:COinS. |
![]() | This template uses Lua: |
This template is used to easily present values in scientific notation, including uncertainty and/or units, as prescribed by Wikipedia's Manual of Style.
Val specializes in numeric values, especially those with scientific notations, uncertainty notations, and those with measurement values with physical units. Because these expressions are covered by the Manual of Style, Val provides the stylized output for you, and keeps them from wrapping across lines.
Express a numeral:
{{val|123456.78901}}
→ value, formatted with gaps: 123456.78901, or with |fmt=commas
→ 123,456.78901{{val|number|number}}
→ value ± uncertainty, like 123,478±56{{val|number|(number)}}
→ value(uncertainty), like 12,345(56){{val|number|number|number}}
→value +uncertaintyExpress a measurement value: {{val|4|ul=m2}}
→ 4 m2. The m2 is a "unit code" that Val uses to look up the link to the unit's article, and the formatting of the unit symbol. Val links the units to the page it has on file for them. See {{Val/list}}.
There are a large number of unit codes that Val understands and keeps "up to code". A unit code is the just abbreviated unit name, but these can get quite involved for a compound or composite unit, with "multipliers" or "dividers". See Module:Val/units.
Some unit-code flexibility is provided by having four parameters to work the unit-code system: whether to link one or not, (see Overlinking), and whether to link the numerator or denominator of a unit ratio separately.
{{val|number|ul=unit code}}
→ number symbol, such as 9.8 km2{{val|number|u=unit code}}
→ number symbol, such as 9.8 km2{{val|number|u=unit code|upl=unit code}}
→ number symbol/symbol, such as 9.8 gal/min{{val|number|ul=unit code|up=unit code}}
→ number symbol/symbol, such as 9.8 pc/yearTo bypass the unit code system, if |u=
does not recognize your unit code, it will accept any wikitext and render it as usual.
{{val|5.4|u=[[kg]]⋅[[meter|m]]/s<sup>2</sup>}}
→ 5.4 kg⋅m/s2{{val|7.6|u=[[metre per second squared|m/s<sup>2</sup>]]}}
→ 7.6 m/s2See Module:Val/units for how to add units to the unit code system.
Sometimes a number and unit code is not enough. A prefix or suffix are also available, |p=
and |s=
.
{{val|7600|u=C⋅Ga|p=>|s=<}}
→ >7600 C⋅Ga<{{val|7600|u=C|p=<span style="color:green"><sup>|s=</sup></span>}}
→ 7600 CSee {{val/testcases}} to learn the val parameters by an example. It is comprehensive, and there are over 100 examples.
Val takes three unnamed parameters. The first is always the numeric value. When the second and third are numbers they become the various uncertainty notations, but the second unnamed parameter can also serve to grammatically join the first and third numbers.
Val clears surrounding spaces in its unnamed parameters.
1st or |1= |
A number. Can be in decimal point notation or in e notation. This number is the basis of the Val formatting.
|
|fmt=
|
By default, numbers are formatted with gaps separating groups of three digits in both integer and fractional part. However, by default, four-digit integers are not formatted; use |
|end= |
Put something at the end of the main number (before anything else that might follow).
|
2nd or |2= |
Uncertainty in either format.
|
3rd or |3=
|
Asymmetric uncertainty.
|
|errend= or |+errend= and |-errend= |
Appends something after an uncertainty.
|
|u= or |ul= |
The unit code. Val adds a space and the unit.
|
|up= or |upl= |
A unit code, but instead of a space Val adds a slash and the unit, a "per" unit (the denominator), to form a ratio.
|
|p= |
Prefix the entire Val expression. Non-spaced, but accepts markup.
|
|s= |
Suffix the entire Val expression. Non-spaced, but accepts markup.
|
|e=
|
Exponent. Val alternatively accepts e notation in the first parameter; these are mutually exclusive (see "1st" argument above).
|
|long scale= |
Usually a unit is the short ton and billion means 1×109. But there are long versions of these units and others. Use |long scale=on to assign your unit to the long scale instead. The unit code's link will change and it will sort differently in tables. "See Long and short scales".
|
|nocategory= |
If set to any value, errors in the use of this template will not cause the page to be added to the Pages with incorrect formatting templates use category. This is useful for documentation and test pages that do not need to be fixed. |
There is strict checking on the validity of arguments; any incorrect use will result in an error. Pages that contain incorrect use of this template will show up on Category:Pages with incorrect formatting templates use.
Val checks for unsupported parameters and gives a relatively subtle warning if found. See tracking category to track any of these improper usages on existing on the wiki. Hold the mouse over "warning" to see details. Here is what warnings look like:
{{val|1.23|exp=6|u=m/s}}
→ 1.23 m/sError in {{val}}: Val parameter "exp=6" is not supported{{val|1.23|us=kbit/s}}
→ 1.23Error in {{val}}: Val parameter "us=kbit/s" is not supported{{val|1.23|.05|.04|.03|u=m/s}}
→ 1.23+0.05{{Val}} produces formatting compliant with Wikipedia's Manual of Style.
The MOS recommends that numbers either be delimited using thin spaces either side of the decimal, or commas to the left and no delimiters to the right. Articles should be consistent with respect to the style of delimiting. The template defaults to the former style, this can be adjusted using |fmt=
(see above).
The sort key for each sortable unit is visible at Template:Val/list.
Here is a live example showing the minimal markup for a sortable table:
{| class="wikitable sortable floatright" summary="Val sorting test"
|+ Click to sort ↓
|-
! Val sort test
! In base unit
! {{nobold|1=(unsort)}}
|-
| {{val|3|ul= Mm }}
| style="text-align:right" | {{val|3000000|u=m}}
| style="text-align:right; font-size:small;" | {{random number|100|1|67}}
|-
| {{val|4e6|ul= m }}
| style="text-align:right" | {{val|4000000|u=m}}
| style="text-align:right; font-size:small;" | {{random number|100|3|67}}
|-
| {{val|1|ul= km }}
| style="text-align:right" | {{val|1000|u=m}}
| style="text-align:right; font-size:small;" | {{random number|100|5|67}}
|-
| {{val|5e3|u= m }}
| style="text-align:right" | {{val|5000|u=m}}
| style="text-align:right; font-size:small;" | {{random number|100|7|67}}
|-
| {{val|2|u= m }}
| style="text-align:right" | {{val|2|u=m}}
| style="text-align:right; font-size:small;" | {{random number|100|11|67}}
|}
|}
|
|
A sort value relates to a Val expression as follows.
{{val|1234567.1234567}}
→ 1234567.1234567
⟨{{val| 1234567.1234567 }}⟩
→ ⟨1234567.1234567⟩
{{val|.1234567|fmt=commas}}
→ 0.1234567
{{val|+1234567|fmt=commas}}
→ +1,234,567
{{val|-1234567}}
→ −1234567
{{val|1.234|0.005}}
→ 1.234±0.005
{{val|1.234|0.005|e=3}}
→ (1.234±0.005)×103
{{val|1.234|+0.005|-0.006}}
→ 1.234+0.005
−0.006
{{val|1.234|(5)}}
→ 1.234(5)
{{val|1.234|u=m}}
→ 1.234 m
{{val|1.234|u=m2}}
→ 1.234 m2
{{val|1.234|ul=m}}
→ 1.234 m
{{val|123.4|ul=USgal}}
→ 123.4 US gal
{{val|12.34|ul=mpgimp}}
→ 12.34 mpg‑imp
{{val|12.34|u=deg}}
→ 12.34°
{{val|1.234|0.005|u='}}
→ 1.234′±0.005′
{{val|1.234|+0.005|-0.006|u="}}
→ 1.234″+0.005″
−0.006″
{{val|1.234|u=%}}
→ 1.234%
{{val|1.234|end= [[m/s]]}}
→ 1.234 m/s
{{val|12.34|u=degC}}
→ 12.34 °C
{{val|12.34|u=K}}
→ 12.34 K
{{val|e=5}}
→ 105
{{val|e=5|ul=m}}
→ 105 m
{{val|1.234e5|ul=m}}
→ 1.234×105 m
{{val|1.234|e=5|ul=m}}
→ 1.234×105 m
{{val|1.234e7|0.056}}
→ (1.234±0.056)×107
{{val|1.234|0.056|e=7}}
→ (1.234±0.056)×107
{{val|1.23456e-9|+0.00007|-0.00008|ul=m/s}}
→ 1.23456+0.00007
−0.00008×10−9 m/s
{{val|1.23456|+0.00007|-0.00008|e=-9|ul=m/s}}
→ 1.23456+0.00007
−0.00008×10−9 m/s
{{val|1.234e7|0.056|ul=psi}}
→ (1.234±0.056)×107 psi
{{val|1.234|0.056|e=7|ul=psi}}
→ (1.234±0.056)×107 psi
{{val|1.234e-2|(5)}}
→ 1.234(5)×10−2
{{val|1.234|(5)|e=-2}}
→ 1.234(5)×10−2
{{val|12.34|p=Δ }}
→ Δ 12.34
{{val|12.34|u=%|p=≅}}
→ ≅12.34%
{{val|12.34|0.25|s=%}}
→ 12.34±0.25%
{{val|1.234|e=7|ul=W|up=m2}}
→ 1.234×107 W/m2
{{val|1.2|end={{overline|34}}|e=7|ul=W|up=m2}}
→ 1.234×107 W/m2
See the testcases at {{val/testcases}}.
|ul=
to |u=
and from |upl=
to |up=
.TemplateData for Val
This template is used to easily present values in scientific notation, including uncertainty and/or units, as prescribed by Wikipedia's Manual of Style.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Number | 1 | A number in decimal point notation or in e notation. The main basis of the Val expression.
| String | required |
Uncertainty | 2 | no description | String | optional |
Asymmetric uncertainty - | 3 | no description | String | optional |
Format | fmt | By default, numbers are formatted with gaps separating groups of three digits in both integer and fractional part. However, by default, four-digit integers are not formatted; use "gaps" (without quotes) to force gaps. Use the value "commas" (without quotes) to delimit the integer part of the number with commas. Use "none" (without quotes) for no formatting (no gaps or commas).
| String | optional |
End | end | Put something at the end of the main number (before anything else that might follow). | String | optional |
Unit | u | The unit code. A space and the unit will be added after the number.
| String | optional |
Unit – wikilinked | ul | The unit code that will be wikilinked to a page with information about the unit. A space and this unit will be added after the number.
| String | optional |
Unit to be prefixed with a slash (/) | up | A unit code, but instead of a space, the template adds a slash and the unit, a "per" unit (the denominator), to form a ratio.
| String | optional |
Unit to be prefixed with a slash (/) – wikilinked | upl | A wikilinked unit code, but instead of a space, the template adds a slash and the unit, a "per" unit (the denominator), to form a ratio.
| String | optional |
Prefix | p | Prefix for the entire Val expression. Non-spaced, but accepts markup. | Content | optional |
Suffix | s | Suffix for the entire Val expression. Non-spaced, but accepts markup. | Content | optional |
Exponent | e | Val alternatively accepts e notation in the first parameter; these are mutually exclusive (see the Number parameter).
| Number | optional |
errend | errend | no description | Unknown | optional |
4 | 4 | no description | Unknown | optional |
5 | 5 | no description | Unknown | optional |