summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/siunitx/README
blob: a104e81e3052faf52e6a361710f873091d3dee2e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
----------------------------------------------------------------
The siunitx package --- A comprehensive (SI) units package
Maintained by Joseph Wright
E-mail: joseph.wright@morningstar2.co.uk
Released under the LaTeX Project Public License v1.3c or later
See http://www.latex-project.org/lppl.txt
----------------------------------------------------------------

Physical quantities have both numbers and units, and each
physical quantity should be expressed as the product of a number
and a unit. Typesetting physical quantities requires care to
ensure that the combined mathematical meaning of the number-unit
combination is clear.  In particular, the SI units system lays
down a consistent set of units with rules on how these are to be
used. However, different countries and publishers have differing
conventions on the exact appearance of numbers (and units).

The siunitx package provides a set of tools for authors to
typeset quantities in a consistent way.  The package has
an extended set of configuration options which make it possible
to follow varying typographic conventions with the same input
syntax.  The package includes automated processing of numbers
and units, and the ability to control tabular alignment of
numbers.

Installation
------------

The package is supplied in dtx format and as a pre-extracted zip
file, siunitx.tds.zip. The later is most convenient for most
users: simply unzip this in your local texmf directory and run
texhash to update the database of file locations. If you want to
unpack the dtx yourself, running 'tex siunitx.dtx' will extract
the package whereas 'latex siunitx.dtx will extract it and also
typeset the documentation.

The package requires LaTeX3 support as provided in the expl3
and xpackages bundles. Both of these are available on CTAN
(http://www.ctan.org/) as ready-to-install zip files. Suitable
versions are available in MiKTeX 2.9 and TeX Live 2010
(updating the relevant packages online may be necessary).
LaTeX3, and so siunitx, requires the e-TeX extensions: these
are available on all modern TeX systems.

Typesetting the documentation requires a number of packages in
addition to those needed to use the package. This is mainly
because of the number of demonstration items included in the
text. To compile the documentation without error, you will
need the packages:
 - amsmath
 - booktabs
 - caption
 - cleveref
 - csquotes
 - datatool
 - helvet
 - mathpazo
 - listings
 - pgfplots
 - xcolor
The xfrac package is also loaded if available, but is not
required to typeset the documentation.