Template:Val/doc: Difference between revisions

From Zoophilia Wiki
Jump to navigationJump to search
meta>SkyLined
(→‎Purpose: removing {{sci}}, encouraging {{val}})
meta>SkyLined
m (→‎Arguments: Added description for '''s''')
Line 14: Line 14:
or
or
:'''1''' The value
:'''1''' The value
:'''s''' The significance
or
:'''2''' The upper limit of uncertainty
:'''2''' The upper limit of uncertainty
:'''3''' The lower limit of uncertainty (must be a negative value)
:'''3''' The lower limit of uncertainty (must be a negative value)
and you can use the following named arguments:
and you can use the following optional named arguments:
:'''e''' The exponent for power of 10.
:'''e''' The exponent for power of 10.
:'''u''' The units for the number.
:'''u''' The units for the number.

Revision as of 16:33, 9 April 2008

Template:Template doc page viewed directly

Purpose

To easily present values in scientific notation, including uncertainty. Wraps entire result in "nowrap" block, so it never gets broken in seperate pieces at the end of a line.

There is a shorter aliases for this template: {{val}}, you are encouraged to use this shorter version. ({{ScientificValue}} may be deprecated in the near future in favor of this new, shorter name).

Arguments

1 The value

or

1 The value
2 The uncertainty

or

1 The value
s The significance

or

2 The upper limit of uncertainty
3 The lower limit of uncertainty (must be a negative value)

and you can use the following optional named arguments:

e The exponent for power of 10.
u The units for the number.

Units are replaced by a more esthetically pleasing HTML representation and get a link, if they are in the list found in {{ScientificValue/units}} or if they are supported by {{convert}}. A good example is "m/s", which gets translated to "m·s-1".

Examples

{{ScientificValue|1.234}}  →  Template:ScientificValue
Uncertainty/significance
{{ScientificValue|1.234|0.005}}  →  Template:ScientificValue
{{ScientificValue|1.234|+0.005|-0.001}}  →  Template:ScientificValue
{{ScientificValue|1.234|s=5}}  →  Template:ScientificValue
Exponents/units
{{ScientificValue|1.234|e=10|u=m}}  →  Template:ScientificValue
{{ScientificValue|1.234|0.05|e=5}}  →  Template:ScientificValue
{{ScientificValue|1.234|+0.05|-0.04|e=-23|u=m/s}}  →  Template:ScientificValue
{{ScientificValue|1.234|0.04|e=3|u=psi}}  →  Template:ScientificValue
{{ScientificValue|123.4|u=USgal}}  →  Template:ScientificValue
{{ScientificValue|12.34|u=mpgimp}}  →  Template:ScientificValue