View source for Template:Val/doc

{{Documentation subpage}}
{{High-use| 16851 }}
{{COinS safe|n}}
{{Lua|Module:Val}}

This template is used to easily present values in [[scientific notation]], including uncertainty and/or units, as prescribed by Wikipedia's [[WP:MOSNUM|Manual of Style]].

== Introduction ==

Val specializes in numeric ''values'', especially those with [[scientific notation]]s, [[uncertainty#Measurements|uncertainty notation]]s, 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:
* <code>&#123;{val|123456.78901}}</code> &rarr; ''value'', formatted with gaps: {{val|123456.78901}}, or with {{para|fmt|commas}} &rarr; {{val|fmt=commas|123456.78901}}
* <code>&#123;{val|''number''|''number''}}</code> &rarr; ''value'' ± ''uncertainty'',  like {{val|fmt=commas|123478|56}}
* <code>&#123;{val|''number''|{{hilite|(}}''number''{{hilite|)}}}}</code> &rarr; ''value''(''uncertainty''), like {{val|fmt=commas|12345|(56)}}
* <code>&#123;{val|''number''|''number''|''number''}}</code> &rarr;''value'' {{su|p=+uncertainty|b=−uncertainty}} like {{val|fmt=commas4|1234|+56|-78}}

Express a measurement value: {{#invoke:DemoTemplate|val|4|ul=m2}}. The  <kbd>m2</kbd> is a "unit code" that Val uses to lookup 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 {{tl|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 ''[[WP:Overlinking|Overlinking]]''), and whether to link the numerator or denominator of a unit ratio separately.
* <code>&#123;{val|''number''|'''ul='''''unit code''}}</code> &rarr; ''number {{font color|blue|symbol}}'', such as {{val|9.8|ul=km2}}
* <code>&#123;{val|''number''|'''u='''''unit code''}}</code> &rarr; ''number&nbsp;symbol'', such as {{val|9.8|u=km2}}
* <code>&#123;{val|''number''|'''u='''''unit code''|'''u{{hilite|p}}l='''''unit code''}}</code> &rarr; ''number''&nbsp;symbol{{big|{{hilite|/}}}}{{font color|blue|symbol}}, such as {{val|9.8|u=gal|upl=min}}
* <code>&#123;{val|''number''|'''ul='''''unit code''|'''u{{hilite|p}}='''''unit code''}}</code> &rarr; ''number''&nbsp;{{font color|blue|symbol}}{{big|{{hilite|/}}}}''symbol'', such as {{val|9.8|ul=parsec|up=year}}

To bypass the unit code system, if {{para|u}} does not recognize your unit code, it will accept any wikitext and render it as usual.
* {{#invoke:DemoTemplate|val|5.4|u=[[kg]]&sdot;[[meter|m]]/s<sup>2</sup>}}
* {{#invoke:DemoTemplate|val|7.6|u=[[metre per second squared|m/s<sup>2</sup>]]}}
See [[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, {{para|p}} and {{para|s}}.
* {{#invoke:DemoTemplate|val|7600|u=  C&sdot;Ga  |p= > | s= < }}
* {{#invoke:DemoTemplate|val|7600|u=C|p=<span style="color:green"><sup>|s=</sup></span>}}

See {{tl|val/testcases}} to learn the val parameters by an example. It is comprehensive, and there are over 100 examples.

== Arguments ==
{{details|Help:Template#Parameters}}
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.

{|cellspacing="15" cellpadding="0"
| style="vertical-align:top;text-align: center;" | '''1st''' or {{para|1}} || A number in [[radix point|decimal point]] notation or in [[e notation]].  The main basis of the Val expression.<br />
{{#invoke:DemoTemplate|val|1234567.1234567}}<br />
{{#invoke:DemoTemplate|val|.1234}} {{spaces|19}}(adds the zero)<br />
{{#invoke:DemoTemplate|val|+1234}} {{spaces|20}}(displays the plus) <br />
{{#invoke:DemoTemplate|val|-1234}} {{spaces|20}}(replaces the [[hyphen-minus]] with a [[minus sign]])<br />
{{#invoke:DemoTemplate|val|12e34}} {{spaces|15}}([[Scientific notation#E notation|E notation]])<br />
|-
|style="vertical-align:top;text-align: center;"| {{para|fmt}}
| By default, numbers are formatted with gaps separating groups of three digits in both integer and fractional part.<br />
However, by default, four-digit integers are not formatted; use {{para|fmt|gaps}} to force gaps.<br />
Use {{para|fmt|commas}} to delimit the integer part of the number with commas.<br />
Use {{para|fmt|none}} for no formatting (no gaps or commas).<br />
{{#invoke:DemoTemplate|val|1234567.1234567}}<br />
{{#invoke:DemoTemplate|val|1234567.1234567|fmt=commas}}<br />
{{#invoke:DemoTemplate|val|1234}}<br />
{{#invoke:DemoTemplate|val|1234|fmt=gaps}}<br />
{{#invoke:DemoTemplate|val|1234.5}}<br />
{{#invoke:DemoTemplate|val|1234.5|fmt=none}}
|-
| style="vertical-align:top;text-align: center;" | {{para|end}} || Put something at the end of the main number (before anything else that might follow). <br />
{{#invoke:DemoTemplate|val|11|end=<END>}}<br />
{{#invoke:DemoTemplate|val|11|22|end=<END>}}<br />
{{#invoke:DemoTemplate|val|1111|(22)|end=<END>}}<br />
{{#invoke:DemoTemplate|val|11|22|33|end=<END>}}<br />
{{#invoke:DemoTemplate|val|11|ul=m/s|end=<END>}}
|-
| style="vertical-align:top;text-align: center;" | '''2nd''' or {{para|2}} || [[uncertainty#Measurements|Uncertainty]] in either format.<br />
{{#invoke:DemoTemplate|val|11|22}}<br />
{{#invoke:DemoTemplate|Val|11|(22)}}<br />
A conjunction to join two numbers.  Useful for ranges, grammatical output, etc.<br />
{{#invoke:DemoTemplate|val|11|-|33}}<br />
{{#invoke:DemoTemplate|val|11|–|33}}<br />
{{#invoke:DemoTemplate|val|11|,|33}}<br />
{{#invoke:DemoTemplate|val|11|by|33|e=9}}<br />
{{#invoke:DemoTemplate|val|11|and|33|end=$}}<br />
{{#invoke:DemoTemplate|val|11|or|33}}<br />
{{#invoke:DemoTemplate|val|11|to|33}}<br />
{{#invoke:DemoTemplate|val|11|x|33}}<br />
{{#invoke:DemoTemplate|val|11|×|33}}<br />
{{#invoke:DemoTemplate|val|11|/|33|ul=m/s}}<br />
Note that for dashes or x's, the various kinds all obtain one properly styled output.
|-
| style="vertical-align:top;text-align: center;" | '''3rd''' or {{para|3}}
| Asymmetric uncertainty.<br />
{{#invoke:DemoTemplate|Val|11|22|33}}
|-
|style="vertical-align:top;text-align: left;"|{{para|errend}} or {{para|+errend}} and {{para|-errend}}|| Appends something after an uncertainty.<br />
{{#invoke:DemoTemplate|val|11|22|errend=<Errend>}}<br />
{{#invoke:DemoTemplate|val|11|22|33|-errend=<−Errend>|+errend=<+Errend>}}
|-
| style="vertical-align:top;text-align: center;" | {{para|u}} or {{para|ul}} || [[Template:Val/units|The unit code]].  Val adds a space and the unit.<br />
{{para|ul}} Link the unit.<br />
{{para|u}} Don't link the unit. Also accepts [[help:wiki markup|wiki markup]] in lieu of a unit code.<br />
{{#invoke:DemoTemplate|val|11|ul=m}}
|-
| style="vertical-align:top;text-align: center;" | {{para|up}} or {{para|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.<br />
{{para|upl}} Link the per unit.<br />
{{para|up}} Don't link the per unit.<br />
The ratio can be of two unit codes, or a prefix and a unit code. Val will add parentheses to disambiguate, if a unit code has a dot or a slash.<br />
{{#invoke:DemoTemplate|Val|11|ul=J/C|upl=F/m}}<br /> {{#invoke:DemoTemplate|Val|11|p=$|upl=acre}}<br />
{{#invoke:DemoTemplate|Val|11|ul=km/s|upl=Mpc}}<br />
{{#invoke:DemoTemplate|Val|11|ul=kg.m|upl=s-2}}
|-
| style="vertical-align:top;text-align: center;" | {{para|p}}  || Prefix the entire Val expression.  Non-spaced, but accepts markup.<br />
{{#invoke:DemoTemplate|Val|11|22|ul=m/s|p=<Prefix>}}<br />
{{#invoke:DemoTemplate|Val|11|22|ul=m/s|p=<Prefix>&nbsp;}}
|-
| style="vertical-align:top;text-align: center;" | {{para|s}}  || Suffix the entire Val expression. Non-spaced, but accepts markup.<br />
{{#invoke:DemoTemplate|Val|11|22|ul=m/s|s=<Suffix>}}<br /> {{#invoke:DemoTemplate|Val|11|22|ul=m/s|s=&nbsp;<Suffix>}}
|-
| style="vertical-align:top;text-align: center;" | {{para|e}}
| Exponent. Val alternatively accepts e notation in the first parameter; these are mutually exclusive (see "1st" argument above).<br />
{{#invoke:DemoTemplate|Val|11|22|33|e=11}}<br />
{{#invoke:DemoTemplate|Val|11e11|22|33}}
|-
| style="vertical-align:top;text-align: center;" | {{para|long scale}}  || Usually a unit is the short [[ton]] and [[billion]] means {{val|1|e=9}}.  But there are long versions of these units and others. Use {{para|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]]".
|-
| style="vertical-align:top;text-align: center;" | {{para|nocategory}}  || If set to any value, errors in the use of this template will not cause the page to be added to the [[:Category:Pages with incorrect formatting templates use|Pages with incorrect formatting templates use]] category. This is useful for documentation and test pages that do not need to be fixed.
|}

== Errors ==

There is strict checking on the validity of arguments; any incorrect use will result in an error, which is displayed using {{tl|FormattingError}}. 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 [[:Category:Pages with incorrect formatting templates use|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:
*<code><nowiki>{{val|1.23|exp=6|u=m/s}}</nowiki></code> → {{val|1.23|exp=6|u=m/s|nocategory=true}}
*<code><nowiki>{{val|1.23|us=kbit/s}}</nowiki></code> → {{val|1.23|us=kbit/s|nocategory=true}}
*<code><nowiki>{{val|1.23|.05|.04|.03|u=m/s}}</nowiki></code> → {{val|1.23|.05|.04|.03|u=m/s|nocategory=true}}

== Format of numbers ==

{{tl|Val}} produces formatting compliant with Wikipedia's [[WP:MOSNUM|Manual of Style]].

The [[Wikipedia:MOSNUM#Delimiting (grouping of digits)|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 <code>|fmt=</code> (see [[#Arguments|above]]).

== Sorting ==
{{details|Help:Sorting}}

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:

{|
|style="vertical-align:top;" |
<pre>
{| class="sortable"
! Val sort test
! In base unit
|-
| {{val|3|ul=  Mm }}
| {{val|3000000|u=m}}
|-
| {{val|4e6|ul= m }}
| {{val|4000000|u=m}}
|-
| {{val|1|ul=  km }}
| {{val|1000|u=m}}
|-
| {{val|5e3|u=  m }}
| {{val|5000|u=m}}
|-
| {{val|2|u=    m }}
| {{val|2|u=m}}
|}
</pre>
| style="vertical-align:top;" |<!--
-->
{| class="wikitable sortable floatright" summary="Val sorting test"
|+ Click to sort &darr;
|-
! Val sort test
! In base unit
|-
| {{val|3|ul=  Mm }}
| style="text-align:right" | {{val|3000000|u=m}}
|-
| {{val|4e6|ul= m }}
| style="text-align:right" | {{val|4000000|u=m}}
|-
| {{val|1|ul=  km }}
| style="text-align:right" | {{val|1000|u=m}}
|-
| {{val|5e3|u=  m }}
| style="text-align:right" | {{val|5000|u=m}}
|-
| {{val|2|u=    m }}
| style="text-align:right" | {{val|2|u=m}}
|}
|}

A sort value relates to a Val expression as follows.
# The numeric value is a starting point.
# If the unit has an SI Prefix, that order of magnitude is applied.
# The value of the unit from its own [[system of units]] is applied.
# If the unit is composite, each subunit is multiplied or divided per their [[Dimensional analysis#Definition|dimension]].
# The result is passed to {{tl|ntsh}} which applies a normalization formula.
# The output of {{tlf|ntsh}} is added (behaviorally only, i.e. "hidden") into the table as usual, via the data-sort-value attribute of a table.

== More example expressions ==

=== Number ===
{{#invoke:DemoTemplate|val|1234567.1234567}}<br />
<code>.{<nowiki/>{val|{{spaces|2}}1234567.1234567{{spaces|3}}}}.</code> &rarr; .{{val| 1234567.1234567 }}.<br />
{{#invoke:DemoTemplate|val|fmt=commas|.1234567}}<br />
{{#invoke:DemoTemplate|val|fmt=commas|+1234567}}<br />
{{#invoke:DemoTemplate|val|-1234567}}<br />

===Uncertainty===
{{#invoke:DemoTemplate|val|1.234|0.005}}<br >
{{#invoke:DemoTemplate|val|1.234|0.005|e=3}}<br >
{{#invoke:DemoTemplate|val|1.234|+0.005|-0.006}}<br >
{{#invoke:DemoTemplate|val|1.234|(5)}}<br >

===Units===
{{#invoke:DemoTemplate|val|1.234|u=m}}<br >
{{#invoke:DemoTemplate|val|1.234|u=m2}}<br >
{{#invoke:DemoTemplate|val|1.234|ul=m}}<br >
{{#invoke:DemoTemplate|val|123.4|ul=USgal}}<br >
{{#invoke:DemoTemplate|val|12.34|ul=mpgimp}}<br >

{{#invoke:DemoTemplate|val|12.34|u=deg}}<br >
{{#invoke:DemoTemplate|val|1.234|0.005|u='}}<br >
{{#invoke:DemoTemplate|val|1.234|+0.005|-0.006|u="}}<br >

{{#invoke:DemoTemplate|val|1.234|u=%}}<br >
{{#invoke:DemoTemplate|val|1.234|end=&nbsp;[[m/s]]}}<br >

{{#invoke:DemoTemplate|val|12.34|u=degC}}<br >
{{#invoke:DemoTemplate|val|12.34|u=K}}<br >

===Exponents===
{{#invoke:DemoTemplate|val|1.234e5|ul=m}}<br >
{{#invoke:DemoTemplate|val|1.234|e=5|ul=m}}

{{#invoke:DemoTemplate|val|1.234e7|0.056}}<br >
{{#invoke:DemoTemplate|val|1.234|0.056|e=7}}

{{#invoke:DemoTemplate|val|1.23456e-9|+0.00007|-0.00008|ul=m/s}}<br >
{{#invoke:DemoTemplate|val|1.23456|+0.00007|-0.00008|e=-9|ul=m/s}}

{{#invoke:DemoTemplate|val|1.234e7|0.056|ul=psi}}<br >
{{#invoke:DemoTemplate|val|1.234|0.056|e=7|ul=psi}}

{{#invoke:DemoTemplate|val|1.234e-2|(5)}}<br />
{{#invoke:DemoTemplate|val|1.234|(5)|e=-2}}

===Prefix/suffix===
{{#invoke:DemoTemplate|val|p=Δ&nbsp;|12.34}}<br >
{{#invoke:DemoTemplate|val|p=≅|12.34|u=%}}<br >
{{#invoke:DemoTemplate|val|12.34|0.25|s=%}}<br />

===Numerator/denominator===
{{#invoke:DemoTemplate|val|1.234|e=7|ul=W|up=m2}}<br />

===Repeating digits===
<code><nowiki>{{val|1.2|end={{overline|34}}|e=7|ul=W|up=m2}}</nowiki></code> → {{val|1.2|end={{overline|34}}|e=7|ul=W|up=m2}}

===Even more examples===
See the testcases at {{tl|val/testcases}}.

== FAQ and comments ==

; Q. Why should I use Val?
: A1. Val formats numbers:
:*inserts spaces between groups of digits, meeting [[MOS:NUM|MoS standards]],
:*formats standard [[Uncertainty#Measurements|uncertainties in measurements]], providing a ± character, correct spacing, and correct alignment,
:*formats [[Exponentiation|exponents of 10]] and [[scientific notation]],
:*replaces "-" (hyphen) with a "&minus;" (minus sign).
: A2. Val preserves spacing:
:* It makes sure the value does not [[Word wrap|wrap]] at the end of a line, so that it can always be read as a single value on one line in the text.
:* It spaces the various parts of the value where they should be.
: A3. Configuring Val gives you your own code for automating the markup for, and a link to, any units in the entire Encyclopedia.
: A4. Val helps make Wikipedia more consistent. It adheres to the [[Wikipedia:MOSNUM|Wikipedia Manual of Style for numbers]]. Updates to the MoS can be applied to this template and result in automatic modification on values that use it. All this makes sure all values on all pages have the same [[look and feel]] because they will all use the same [[Letter-spacing|spacing]], [[font|font size]], positioning, etc, and makes updating and checking by the bots easier because they can recognize a value for what it is.
; Q. Why not use <nowiki><math></nowiki>?
: A. For the same reasons [[Help:Math#Pros of HTML|HTML might be preferred over TeX]]:
:*Because the [[font]] in math tags differs both in face and size from the prose, which can disturb the layout of a page when used inline with the prose.
:*You cannot [[Cut, copy, and paste|cut and paste]] a bitmap image rendered by the LaTeX.
:*Images are slower to load and use more bandwidth, which is especially bad for the mobile version of Wikipedia.
:*<nowiki><math></nowiki> does not automatically easily align to the Manual of Style for numbers.
; Q. Are there any known issues with Val?
: A1: This template is now a new Lua module as of Aug 6, 2015. Technically, there is no good reason not to try Val.
: A2. Issues are solved rapidly by an active set of responsive template coders.  See the talk page.
; Q. How should I use Val?
: A1. Val probably already has your unit on [[Module:Val/units|its current list]]. If not, add your own unit there.
: A2. To avoid [[WP:OVERLINKING|overlinking]], switch from {{para|ul}} to {{para|u}} and from {{para|upl}} to {{para|up}}.
: A3. Any time you have a unit to link or a table to sort, Val already setup with that unit's link and sorting value.
: A3. Use Val along with {{tl|Convert}}.  See [[Module:Convert/data|how to add units to Convert]].
: A4. Where consistent styling of long list articles, with many hundreds or thousands of numbers or units is needed.

== See also ==
* [[Module:Val]]
* [[Module:Val/units]]
* [[Module:Convert/data]]
* [[Template:Gaps]]
* [[Template:Decimals]]
* [[Template:Rnd]]
* [[Template:Scinote]] to display a value in scientific notation
* [[Template:10^]] to display a power of ten
<includeonly>{{basepage subpage| <!-- Categories below this line, please: -->
[[Category:Mathematical formatting templates]]
[[Category:Superscript and subscript templates]]
[[Category:Convert-like templates|{{SUBPAGENAME}}]]
[[Category:Sorting templates]]
}}</includeonly>

== TemplateData ==
{{TemplateData header}}
<templatedata>
{
	"params": {
		"1": {
			"label": "Number",
			"description": "A number in decimal point notation or in e notation. The main basis of the Val expression.",
			"example": "-12.12345e9",
			"type": "string",
			"required": true
		},
		"2": {
			"label": "Uncertainty",
			"type": "string"
		},
		"3": {
			"label": "Asymmetric uncertainty -",
			"type": "string"
		},
		"4": {},
		"5": {},
		"fmt": {
			"label": "Format",
			"description": "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).",
			"example": "commas",
			"type": "string"
		},
		"end": {
			"label": "End",
			"description": "Put something at the end of the main number (before anything else that might follow).",
			"type": "string"
		},
		"u": {
			"label": "Unit",
			"description": "The unit code. A space and the unit will be added after the number.",
			"example": "m",
			"type": "string"
		},
		"ul": {
			"label": "Unit – wikilinked",
			"description": "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.",
			"example": "m",
			"type": "string"
		},
		"up": {
			"label": "Unit to be prefixed with a slash (/)",
			"description": "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.",
			"example": "s",
			"type": "string"
		},
		"upl": {
			"label": "Unit to be prefixed with a slash (/) – wikilinked",
			"description": "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.",
			"example": "s",
			"type": "string"
		},
		"p": {
			"label": "Prefix",
			"description": "Prefix for the entire Val expression. Non-spaced, but accepts markup.",
			"type": "content"
		},
		"s": {
			"label": "Suffix",
			"description": "Suffix for the entire Val expression. Non-spaced, but accepts markup.",
			"type": "content"
		},
		"e": {
			"label": "Exponent",
			"description": "Val alternatively accepts e notation in the first parameter; these are mutually exclusive (see the Number parameter).",
			"example": "9",
			"type": "number"
		},
		"errend": {}
	},
	"paramOrder": [
		"1",
		"2",
		"3",
		"fmt",
		"end",
		"u",
		"ul",
		"up",
		"upl",
		"p",
		"s",
		"e",
		"errend",
		"4",
		"5"
	],
	"format": "inline",
	"description": "This template is used to easily present values in scientific notation, including uncertainty and/or units, as prescribed by Wikipedia's Manual of Style."
}
</templatedata>