summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/nameauth/README
blob: 418fc47a3839afa2ff8b04fe07199600ebbb5376 (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
|
--------:| ----------------------------------------------------------------
nameauth:| Name authority mechanism for consistency in text and index
  Author:| Charles P. Schaum
  E-mail:| charles dot schaum at comcast dot net
 License:| Released under the LaTeX Project Public License v1.3c or later
     See:| http://www.latex-project.org/lppl.txt

Short description:

The nameauth package automates the formatting and indexing of names.
This aids the use of a name authority and the process of textual reordering
and revision without needing to retype name references.

Files  Distribution

README       This file
nameauth.pdf Documentation
examples.tex Some longer example macros from the documentation

Makefile     Automates building with GNU make 3.81
nameauth.dtx Documented LaTeX file containing both code and documentation

Manual Installation

Download the package from

www.ctan.org/tex-archive/macros/latex/contrib/nameauth

Unpack nameauth.zip in an appropriate directory.

Note that the instructions below assume that you are using a *nix-
compatible computer. If that is otherwise, you will need to modify
these instructions to your needs.

If you have a make utility compatible with GNU make you can type

make inst

to install the package into your $TEXMFHOME tree or

make install

to install the package into your $TEXMFLOCAL tree for all users.

Manually, you can generate the package files. First you generate the
installer driver, README, and style files, with a preliminary PDF:

pdflatex -shell-escape -recorder -interaction=batchmode nameauth.dtx

Next you generate the PDF with a table of contents and all cross-references
validated, so that the index entries will not move:

pdflatex --recorder --interaction=nonstopmode nameauth.dtx

The next commands generate the glossary/index and final pdf file

makeindex -q -s gglo.ist -o nameauth.gls nameauth.glo
makeindex -q -s gind.ist -o nameauth.ind nameauth.idx
pdflatex --recorder --interaction=nonstopmode nameauth.dtx
pdflatex --recorder --interaction=nonstopmode nameauth.dtx

Normally you create the following manual installation directories for user:

$TEXMFHOME/source/latex/nameauth dtx file
$TEXMFHOME/tex/latex/nameauth sty file
$TEXMFHOME/doc/latex/nameauth pdf file, README, examples.tex

and you create the following manual installation directories for local site:

$TEXMFLOCAL/source/latex/nameauth dtx file
$TEXMFLOCAL/tex/latex/nameauth sty file
$TEXMFLOCAL/doc/latex/nameauth pdf file, README, examples.tex

The above environment variables often are /usr/local/texlive/texmf-local and
~/texmf.

Run mktexlsr with the appropriate level of permissions to complete the install.

Testing notes:

This packages works and builds with latex, lualatex, pdflatex, and xelatex.
It can be used with makeindex and texindy. The documentation builds with
lualatex, pdflatex, and xelatex, using makeindex.

For testing, the make file permits one to change the typesetting engine
on the command line. The default is to build the package and documentation
with pdflatex. See the make file for details.

License

This material is subject to the LaTeX Project Public License:
http://www.ctan.org/tex-archive/help/Catalogue/licenses.lppl.html

Happy TeXing!