Template:Val/doc

From FamilySearch Wiki
Jump to: navigation, search

Purpose

This template is used to easily present values in scientific notation, including uncertainty and/or units. It wraps the entire result in a {{nowrap}} block, so that it never gets broken into separate pieces at the end of a line.

Arguments

There are four ways this template can be used:

  • {{val|number}} - for displaying values without uncertainty/significance.
  • {{val|number|uncertainty}} - for displaying values with uncertainty like so 1,234±56.
  • {{val|number|upper uncertainty|lower uncertainty}} - for displaying values with uncertainty like so 1,234Template:Su.
  • {{val|number|(significance)}} - for displaying values with significance like so 1,234(56).

They all take roughly the same arguments

1 The value (must be a valid number)
2 The (upper limit of) uncertainty (must be a valid number) or significance (must be a valid number in parenthesis)
3 The lower limit of uncertainty (must be a valid negative number)
e The exponent for the power of 10 (optional). This will show up in the result as " × 10Template:Su".
Values (arguments 1-3 and e) are run through code copied from {{delimitnum}} for readability, except for argument 2 when it is surrounded by parenthesis. This currently causes an error for large numbers, numbers that require high precision and numbers that have zeros after the decimal point. This last issue is being addressed, the other issues require changes to the Wikipedia software.
u / ul The units for the number (optional, with/without a link to the page about the unit respectively).
up / upl The units per for the units (optional, requires u to be specified, with/without a link to the page about the unit respectively).
Units (specified by u, ul, up and upl) are replaced by a more aesthetically pleasing HTML representation and get a link (ul and upl only, if they are in the list found in {{val/units}} or if they are supported by {{convert}}). You can specify units using just u; a good example is "ul=m/s", which gets translated to "m·s-1", or you can use u and up, as in "u/up"; a good examples if "ul=m|up=s", which gets translated to "m/s".
p A prefix for the value (such as ∆, ⌀, etc.; optional).
s A suffix for the value (such as %, optional).
Prefixes (specified by p) and suffixes (specified by s) are put in front of or behind the value as is: this includes spaces. They are inside the nowrap block and will always be on the same line as the value. The parameters that previously provided this functionality (h for header and f for footer) are deprecated and will be ignored.
end Appends something after the main value. For example, {{val|123.24|end=...}} gives 123.24...
errend Appends something after the uncertainty. For example, {{val|123.23|end=...|2.34|errend=...}} gives 123.23...±2.34...
+errend & -errend Appends something after the positive/negative uncertainties. For example, {{val|123.23|end=...|+2.34|+errend=...|-1.23|-errend=...}} gives 123.23...Template:Su
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.

See {{val/test}} for a list of examples of the correct output of {{val}} and the errors it may return when incorrectly used.

Errors

There is strict checking on the validity of arguments; any incorrect use will result in an error, which is displayed using {{FormattingError}}. Pages that contain incorrect use of this template will show up on Category:Pages with incorrect formatting templates use.

Format convention

As mentioned before, {{val}} should produce formatting compliant with the wikipedia manual of style. It currently produces formatting compliant with the U.S. Government Printing Office Style Manual, in rules 12.9e and 12.14, which requires that the decimal separator be a full stop; i.e. “decimal point” (.), requires comma-delimiting to the left of the decimal point for numbers with four or more digits to the left (values of 1,000 or more), and also requires space-delimiting to the right of the decimal point for numbers containing five or more digits to the right (e.g., 0.12345 and 5.12345 and 125.12345).

Note that if {{val}} is used on numbers simultaneously comprising four or more digits to the left of the decimal point and five or more digits to the right, the resultant expression will delimited with commas left and spaces (actually non-selectable, non-breaking, narrow gaps) right (see below).

Examples

{{val|1234567890}}  →  1,234,567,890
{{val|1.23456789}}  →  1.23456789
Template:Xpdop3c
Uncertainty/significance
{{val|1.234|0.005}}  →  1.234±0.005
{{val|1.234|+0.005|-0.006}}  →  1.234Template:Su
{{val|1.234|(5)}}  →  1.234(5)
Exponents/units
{{val|1.234|e=5|u=m}}  →  1.234×10Template:Su Template:Val/units
{{val|1.234|e=5|u=m2}}  →  1.234×10Template:Su Template:Val/units
{{val|1.234|e=5|ul=m}}  →  1.234×10Template:Su Template:Val/unitswithlink
{{val|1.234|0.056|e=7}}  →  1.234±0.056×10Template:Su
{{val|1.23456|+0.00007|-0.00008|e=-9|ul=m/s}}  →  1.23456Template:Su×10Template:Su Template:Val/unitswithlink
{{val|1.234|0.056|e=7|ul=psi}}  →  1.234±0.056×10Template:Su Template:Val/unitswithlink
{{val|123.4|ul=USgal}}  →  123.4 Template:Val/unitswithlink
{{val|12.34|ul=mpgimp}}  →  12.34 Template:Val/unitswithlink
Prefix/suffix
{{val|p=Δ |12.34|s=%}}  →  Δ 12.34%

See also

  • {{Valid}} : number validity checking (for parameters 1, 2, 3, e : value, and uncertainties, base-10 exponent)
  • {{FormattingError}} : for reporting inconsistent parameters
  • {{Val/delimitnum}} : for formatting a decimal number with delimiters between groups of digits
  • {{Su}} : for formatting exponents, or two-values incertainty one below the other (monospaced : currently not printable to PDF)
  • {{Val/units}} : for formatting unit names (contents of parameters u or up)
  • {{Val/unitswithlink}} : for formatting unit names with links (contents of parameters ul or upl)