Difference between revisions of "Units"

From Wiki
Jump to navigation Jump to search
m (Added typeset examples, and changed a note into a TODO tag.)
m (Text replacement - "pragma-ade.com" to "pragma-ade.nl")
 
(26 intermediate revisions by 16 users not shown)
Line 1: Line 1:
< [[Math]] >
+
< [[Math]] [[Physics]] >
  
The units module comes with ConTeXt's default distribution, and can be accessed via <cmd>\usemodule[units]</cmd>.
+
The units module comes with ConTeXt's default distribution. In MkIV the units module comes built-in, however there is still the option to access the old module and its commands via {{cmd|usemodule}}[units]
The following is copied from the source file <tt>m-units.tex</tt> and only slightly modified:
 
  
----
+
Additional documentation about units in MkIV is available from the [[http://www.pragma-ade.nl/general/manuals/units-mkiv.pdf Units manual]]
 +
 
 +
===Using the built-in command===
  
Scientific units can be typeset in math mode pretty well, but occasionally one has to take care of spacing.
+
In MkIV you can use the built-in {{cmd|unit}} command to parse units. Some examples of this are shown below:
Furthermore, entering these units is not that natural as wanted. Therefore this module presents a more natural way of doing things, like:
 
  
 
<texcode>
 
<texcode>
1.23 \Cubic \Meter \Per \Second
+
10 \unit{km/h}
 +
\unit{10 km/h}
 +
\unit{~1 km/h}
 +
\unit{KiloMeter/Hour}
 +
\unit{10 cubic meter / second}
 +
\unit{kilo pascal square meter / second}
 +
\unit{kilo pascal square meter / kelvin second }$
 +
\unit{10 AC}
 +
$\frac{10 \unit{m/s}}{20 \unit{m/s}}$
 +
{\ss 30 \unit{kilo pascal square meter / second kelvin}}
 +
\unit{123.22^-3 km/s}
 +
\unit{123.22e-3 km/s}
 
</texcode>
 
</texcode>
  
<context>
+
ConTeXt will take care of spacing and formatting. The parser is fairly flexible, and the following all work and give the same output.
\usemodule[units]
+
 
1.23 \Cubic \Meter \Per \Second
+
{|
 +
! width="45%"|
 +
! width="10%"|
 +
! width="45%"|
 +
|-
 +
| <texcode>
 +
\unit{10 kg}
 +
\unit{10kg}
 +
\unit{10 kilo gram}
 +
\unit{10 kilogram}
 +
\unit{10 Kilo Gram}
 +
\unit{10 KiloGram}
 +
</texcode>
 +
|
 +
|<context mode=mkiv>
 +
\startlines
 +
\unit{10 kg}
 +
\unit{10kg}
 +
\unit{10 kilo gram}
 +
\unit{10 kilogram}
 +
\unit{10 Kilo Gram}
 +
\unit{10 KiloGram}
 +
\stoplines
 
</context>
 
</context>
 +
|}
  
This example shows that we use the order in which we say things, instead of typeset things. There is a separate [http://www.pragma-ade.com/general/manuals/ manual for this module].
+
The command works in text as well as in math mode and spaces are normally ignored. You can define your own command:  
  
{{todo|Link is dead, couldn't find the manual --[[User:Hraban|Hraban]]}}
+
<texcode>
 +
\defineunits[un][alternative=text,separator=medium]
 +
</texcode>
  
This runtime loadable module implements a way of defining units. The core macro is <cmd>dimension</cmd>, a rather clever one that is able to cooperate with some other dimension related macros. As said, this module enables user to enter:
+
Valid separators are <code>cdot</code>, <code>big</code>, <code>medium</code>, and <code>space</code> with the first being the default. You can later tune the rendering with
  
 
<texcode>
 
<texcode>
Some 10 \Square \Meter \Per \Second\ or more.
+
\setupunits[un][separator=cdot]
 
</texcode>
 
</texcode>
  
<context>
+
In due time there will be a few more options. Numbers are formatted cf the digits mechanism (not discussed here).
 +
 
 +
===Using the old units module===
 +
 
 +
The following is copied from the source file [[source:m-units.tex|m-units.tex]] and only slightly modified:
 +
 
 +
----
 +
 
 +
* Scientific units can be typeset in math mode pretty well, but occasionally one has to take care of spacing.
 +
Furthermore, entering these units is not that natural as wanted. Therefore this module presents a more natural way of doing things, like:
 +
 
 +
<context source="yes">
 +
\usemodule[units]
 +
1.23 \Cubic \Meter \Per \Second
 +
</context>
 +
 
 +
This example shows that we use the order in which we say things, instead of typeset things. There is no dedicated manual for this module, but an article (in dutch)
 +
has been published in [[http://www.ntg.nl/maps/pdf/21_16.pdf Maps#21]], the journal of the NTG.
 +
 
 +
 
 +
* This runtime loadable module implements a way of defining units. The core macro is {{cmd|dimension}}, a rather clever one that is able to cooperate with some other dimension related macros. As said, this module enables user to enter:
 +
 
 +
<context source="yes">
 
\usemodule[units]
 
\usemodule[units]
 
Some 10 \Square \Meter \Per \Second\ or more.
 
Some 10 \Square \Meter \Per \Second\ or more.
 
</context>
 
</context>
  
(Note that the space after <cmd>Second</cmd> needs to be explicitly specified; otherwise, it will get eaten.)
+
(Note that the space after {{cmd|Second}} needs to be explicitly specified; otherwise, it will get eaten.)
 +
 
 +
 
 +
* Units act upon signals that they insert in the text, in case no quantity is given you need to start the unit sequence using {{cmd|Unit}}
 +
 
 +
<context source="yes">
 +
\usemodule[units]
 +
Units of measurement is \Unit \Milli \Meter
 +
</context>
  
 
The units itself are implemented as synonyms.
 
The units itself are implemented as synonyms.
Line 42: Line 108:
 
</texcode>
 
</texcode>
  
This definition means that we can ask for the meaning of a unit using <cmd>unitmeaning</cmd> and get a list of used units by saying <cmd>placelistofunits</cmd>.
+
This definition means that we can ask for the meaning of a unit using {{cmd|unitmeaning}} and get a list of used units by saying {{cmd|placelistofunits}}.
  
We have to use the command <cmd>unitmeaning</cmd> instead of <cmd>meaning</cmd>, simply because the latter is a TeX primitive we don't want to loose. We use the label text mechanism for translations.
+
We have to use the command {{cmd|unitmeaning}} instead of {{cmd|meaning}}, simply because the latter is a TeX primitive we don't want to lose. We use the label text mechanism for translations.
  
 
----
 
----
Line 50: Line 116:
 
===Macros defined in units===
 
===Macros defined in units===
  
* Modifiers: <cmd>Square</cmd>, <cmd>Cubic</cmd>, <cmd>Inverse</cmd>, <cmd>Pico</cmd>, <cmd>Nano</cmd>, <cmd>Micro</cmd>, <cmd>Milli</cmd>, <cmd>Centi</cmd>, <cmd>Deci</cmd>, <cmd>Hecto</cmd>, <cmd>Kilo</cmd>, <cmd>Mega</cmd>, <cmd>Giga</cmd>, <cmd>Tera</cmd>
+
External link:
* Fraction: <cmd>Per</cmd>, <cmd>Percent</cmd>, <cmd>Permille</cmd>, <cmd>Promille</cmd>
+
[[https://www.easyunitconverter.com/ Easy Unit Converter]]
* Time: <cmd>Second</cmd>, <cmd>Minute</cmd>, <cmd>Hour</cmd>, <cmd>Day</cmd>, <cmd>Month</cmd>, <cmd>Year</cmd>
+
 
* Length, Area, Volume: <cmd>Meter</cmd>, <cmd>Angstrom</cmd>, <cmd>Foot</cmd>, <cmd>Inch</cmd>, <cmd>Liter</cmd>
+
* Prefixes: {{cmd|Atto}} a, {{cmd|Femto}} f, {{cmd|Pico}} p, {{cmd|Nano}} n, {{cmd|Micro}} μ, {{cmd|Milli}} m, {{cmd|Centi}} c, {{cmd|Deci}} d, {{cmd|Hecto}} h, {{cmd|Kilo}} k, {{cmd|Mega}} M, {{cmd|Giga}} G, {{cmd|Tera}} T, {{cmd|Peta}} P, {{cmd|Exa}} E (missing: {{cmd|Zetta}} Z, {{cmd|Yotta}} Y, {{cmd|Zepto}} z, {{cmd|Yocto}} y)
* Mass, Force and Pressure: <cmd>Gram</cmd>, <cmd>Atom</cmd>, <cmd>Newton</cmd>, <cmd>Pascal</cmd>, <cmd>Mol</cmd>, , <cmd>at</cmd>, <cmd>Atm</cmd>, <cmd>Bar</cmd>, <cmd>Force</cmd>
+
* Suffixes: {{cmd|Linear}} <sup>1</sup>, {{cmd|Square}} <sup>2</sup>, {{cmd|Cubic}} <sup>3</sup>, {{cmd|Inverse}} or {{cmd|ILinear}} <sup>-1</sup>, {{cmd|ISquare}} <sup>-2</sup>, {{cmd|ICubic}} <sup>-3</sup>
* Energy and Electricity: <cmd>Joule</cmd>, <cmd>Watt</cmd>, <cmd>Cal</cmd>, <cmd>Farad</cmd>, <cmd>Ohm</cmd>, <cmd>Siemens</cmd>, <cmd>Ampere</cmd>, <cmd>Coulomb</cmd>, <cmd>Volt</cmd>, <cmd>Tesla</cmd>, <cmd>VoltAC</cmd>, <cmd>VoltDC</cmd>, <cmd>EVolt</cmd>
+
* Fraction: {{cmd|Per}}, {{cmd|Percent}}, {{cmd|Permille}}, {{cmd|Promille}}
* Temperature: <cmd>Degrees</cmd>, <cmd>Kelvin</cmd>, <cmd>Celsius</cmd>, <cmd>Fahrenheit</cmd>
+
* Time: {{cmd|Second}}, {{cmd|Minute}}, {{cmd|Hour}}, {{cmd|Day}}, {{cmd|Month}}, {{cmd|Year}}
* Angle: <cmd>Rad</cmd>, <cmd>Deg</cmd>
+
* Length, Area, Volume: {{cmd|Meter}}, {{cmd|Angstrom}}, {{cmd|Foot}}, {{cmd|Inch}}, {{cmd|Liter}}
* Frequency, Optics and Acoustics: <cmd>Hertz</cmd>, <cmd>RevPerSec</cmd>, <cmd>RevPerMin</cmd>, <cmd>Candela</cmd>, <cmd>Lux</cmd>, <cmd>Bell</cmd>
+
* Mass, Force and Pressure: {{cmd|Gram}}, {{cmd|Atom}}, {{cmd|Newton}}, {{cmd|Pascal}}, {{cmd|Mol}}, {{cmd|At}}, {{cmd|Atm}}, {{cmd|Bar}}, {{cmd|Force}}
* Chemistry and Radiation: <cmd>Atom</cmd>, <cmd>Mol</cmd>, <cmd>Molair</cmd>, <cmd>Equivalent</cmd>, <cmd>Bequerel</cmd>, <cmd>Sievert</cmd>
+
* Energy, Electricity and Magnetism: {{cmd|Joule}}, {{cmd|Watt}}, {{cmd|Cal}}, {{cmd|Farad}}, {{cmd|Henry}}, {{cmd|Ohm}}, {{cmd|Siemens}}, {{cmd|Ampere}}, {{cmd|Coulomb}}, {{cmd|Volt}}, {{cmd|Tesla}}, {{cmd|Gauss}}, {{cmd|VoltAC}}, {{cmd|VoltDC}}, {{cmd|EVolt}}, {{cmd|Weber}}
* Informatics: <cmd>Baud</cmd>, <cmd>Bit</cmd>, <cmd>Byte</cmd>
+
* Temperature: {{cmd|Degrees}}, {{cmd|Kelvin}}, {{cmd|Celsius}}, {{cmd|Fahrenheit}}
* Other (please sort in): <cmd>Gray</cmd>, <cmd>Weber</cmd>, <cmd>Henry</cmd>, <cmd>Sterant</cmd>, <cmd>Gauss</cmd>
+
* Angle: {{cmd|Rad}}, {{cmd|Deg}}, {{cmd|Sterant}}
 +
* Frequency, Optics and Acoustics: {{cmd|Hertz}}, {{cmd|RevPerSec}}, {{cmd|RevPerMin}}, {{cmd|Candela}}, {{cmd|Lux}}, {{cmd|Bell}}
 +
* Chemistry and Radiation: {{cmd|Atom}}, {{cmd|Mol}}, {{cmd|Molair}}, {{cmd|Equivalent}}, {{cmd|Bequerel}}, {{cmd|Sievert}}, {{cmd|Gray}}
 +
* Informatics: {{cmd|Baud}}, {{cmd|Bit}}, {{cmd|Byte}}
 
* some old dutch (not listed)
 
* some old dutch (not listed)
 +
 +
===Define a new unit===
 +
 +
<context source="yes">
 +
\usemodule[units]
 +
\unit[Mynewunit]{Nu}{New Unit}
 +
 +
10 \Mynewunit
 +
 +
</context>
 +
 +
[[Category:Sciences]]
 +
[[Category:Modules]]

Latest revision as of 08:28, 2 July 2022

< Math Physics >

The units module comes with ConTeXt's default distribution. In MkIV the units module comes built-in, however there is still the option to access the old module and its commands via \usemodule[units]

Additional documentation about units in MkIV is available from the [Units manual]

Using the built-in command

In MkIV you can use the built-in \unit command to parse units. Some examples of this are shown below:

10 \unit{km/h}
\unit{10 km/h}
\unit{~1 km/h}
\unit{KiloMeter/Hour}
\unit{10 cubic meter / second}
\unit{kilo pascal square meter / second}
\unit{kilo pascal square meter / kelvin second }$
\unit{10 AC}
$\frac{10 \unit{m/s}}{20 \unit{m/s}}$
{\ss 30 \unit{kilo pascal square meter / second kelvin}}
\unit{123.22^-3 km/s}
\unit{123.22e-3 km/s}

ConTeXt will take care of spacing and formatting. The parser is fairly flexible, and the following all work and give the same output.

\unit{10 kg}
\unit{10kg}
\unit{10 kilo gram}
\unit{10 kilogram}
\unit{10 Kilo Gram}
\unit{10 KiloGram}

The command works in text as well as in math mode and spaces are normally ignored. You can define your own command:

\defineunits[un][alternative=text,separator=medium]

Valid separators are cdot, big, medium, and space with the first being the default. You can later tune the rendering with

\setupunits[un][separator=cdot]

In due time there will be a few more options. Numbers are formatted cf the digits mechanism (not discussed here).

Using the old units module

The following is copied from the source file m-units.tex and only slightly modified:


  • Scientific units can be typeset in math mode pretty well, but occasionally one has to take care of spacing.

Furthermore, entering these units is not that natural as wanted. Therefore this module presents a more natural way of doing things, like:

\usemodule[units]
1.23 \Cubic \Meter \Per \Second

This example shows that we use the order in which we say things, instead of typeset things. There is no dedicated manual for this module, but an article (in dutch) has been published in [Maps#21], the journal of the NTG.


  • This runtime loadable module implements a way of defining units. The core macro is \dimension, a rather clever one that is able to cooperate with some other dimension related macros. As said, this module enables user to enter:
\usemodule[units]
Some 10 \Square \Meter \Per \Second\ or more.

(Note that the space after \Second needs to be explicitly specified; otherwise, it will get eaten.)


  • Units act upon signals that they insert in the text, in case no quantity is given you need to start the unit sequence using \Unit
\usemodule[units]
Units of measurement is \Unit \Milli \Meter

The units itself are implemented as synonyms.

\definesynonyms [unit] [units] [\unitmeaning]
\setupsynonyms [unit] [textstyle=\dimension]

This definition means that we can ask for the meaning of a unit using \unitmeaning and get a list of used units by saying \placelistofunits.

We have to use the command \unitmeaning instead of \meaning, simply because the latter is a TeX primitive we don't want to lose. We use the label text mechanism for translations.


Macros defined in units

External link: [Easy Unit Converter]

Define a new unit

\usemodule[units]
\unit[Mynewunit]{Nu}{New Unit}

10 \Mynewunit