summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/ionumbers/README
blob: adc28bf23da6345a70ee3f4afcbc6ab66ef25543 (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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
SHORT DESCRIPTION
=================

(This is a copy of the LaTeX code of the documentation's abstract.)

\textsf{ionumbers} stands for `input/output numbers'.

This package restyles numbers in math mode. If a number in the input file
is written, e.g., as |$3,231.44$| as commonly used in English texts, this
package is able to restyle it to be output as `$3\,231{,}44$' as commonly
used in German texts (and vice versa). This may be very useful, if you have
a large table and want to include it in texts with different output
conventions without the need of changing the table.

Furthermore this package can automatically group digits left to the decimal
separator (\emph{thousands}) and right to the decimal separator
(\emph{thousandths}) in triplets without the need of specifing commas
(English) or points (German) as separators. E.g., the input |$1234.567890$|
can be output as `$1\,234.\,567\,890$'.

Finally, an |e| starts the exponent of the number. For example, |$21e6$|
may be output as `$26\times10\,^{6}$'.

See `ionumbers.pdf' for detailed information on usage.

BUILDING
========

If you do not want to use the pre-build `ionumber.sty' and `ionumber.pdf'
files, you will have to choose one of the following two ways for building them.
Otherwise you can skip this section.

1) Building with make
---------------------

Running `make' will create the LaTeX package and documentation:
  # make

2) Building manually
--------------------

a) Generation of package (.sty file):

Run `ionumbers.ins' through LaTeX:
  # pdflatex -interaction=nonstopmode ionumbers.ins

b) Generation of documentation:

Run `ionumbers.dtx' through LaTeX:
  # pdflatex -interaction=nonstopmode ionumbers.dtx

Then create the index and change history:
  # makeindex -s gind.ist -o ionumbers.ind ionumbers.idx
  # makeindex -s gglo.ist -o ionumbers.gls ionumbers.glo

Finally, run `ionumbers.dtx' three time through LaTeX.
  # pdflatex -interaction=nonstopmode ionumbers.dtx
  # pdflatex -interaction=nonstopmode ionumbers.dtx
  # pdflatex -interaction=nonstopmode ionumbers.dtx

INSTALLATION
============

Copy the file `ionumbers.sty' to a directory, where LaTeX will find it.

LICENSE
=======

Copyright 2007-2008 Christian Schneider <software(at)chschneider(dot)eu>

idea and parts of this package based on: ziffer.sty v2.1
Copyright Martin Vaeth <vaeth@mathematik.uni-wuerzburg.de>

ion@addto@macro: identical to l@addto@macro from koma-script
                 bundle v2.9t
Copyright 1994-2004 Markus Kohm and Frank Neukam

Thanks to Martin Vaeth and Markus Kohm for permitting to use their
code in this package. Please do not bother Martin, Markus, or Frank
with questions or bugs concering this package!

This file is part of ionumbers.

ionumbers is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License version 3 as
published by the Free Software Foundation, not any later version.

ionumbers is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with ionumbers.  If not, see <http://www.gnu.org/licenses/>.

WARNING: THIS IS ALPHA SOFTWARE AND MAY CONTAIN SERIOUS BUGS!