summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/nameauth/README
blob: 687f0991654c5fbbfd6b3606e4f4c916fe0f254c (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
The nameauth package
Charles P. Schaum
charles dot schaum at att dot net
v1.22 from 2012/04/20

Abstract

Using the nameauth package, an author can encode names according to a
name authority. Index entries are consistent with input parameters. In-text
formatting of names is predictable and automated, making it easier to go
from drafts to a final manuscript. This package mainly supports Western
names, with basic features for ancient, royal, and Eastern names.

Files		Target distribution

nameauth.pdf	Documentation	(normally in TEXMFDIST/doc/latex/nameauth)
nameauth.sty	Package file	(normally in TEXMFDIST/tex/latex/nameauth)
README		This file 	(normally in TEXMFDIST/doc/latex/nameauth)

		Source distribution

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

Installation	Target distribution

Unpack nameauth.zip.

Create the directories listed above. For TeX Live, TEXMFDIST is often /usr/local/texmf/<year>/texmf-dist on Posix-compliant systems. Manual installation calls rather for /usr/local/texlive/texmf-local or ~/texmf.

MacTeX and MikTeX differ. Please refer to your distribution manual.

Copy the target distribution files to their appropriate destinations.

Run mktexlsr with the appropriate level of permissions.

Source distribution notes:

One can use the following commands to generate the target distribution:

Generate the style file with:
	$ pdflatex nameauth.ins

Generate the documentation with:
	$ pdflatex nameauth.dtx -draftmode "\AtBeginDocument{\OnlyDescription} \input nameauth.dtx"
	$ makeindex -s gglo.ist -o nameauth.gls nameauth.glo
	$ makeindex -s gind.ist -o nameauth.ind nameauth.idx
	$ pdflatex nameauth.dtx "\AtBeginDocument{\OnlyDescription} \input nameauth.dtx"
	$ pdflatex nameauth.dtx "\AtBeginDocument{\OnlyDescription} \input nameauth.dtx"

I used GNU make to automate the process:
	$ make dist

Testing notes:

This packages works with the commands latex, lualatex, pdflatex, and xelatex. It has created inxexes successfully with makeindex and texindy.

For testing purposes, I modified the make file so that one can change the typesetting engine on the command line. The way that the make file is designed, the pdf target really depends on just they .sty file being made, so it can generate .dvi files just as easily. The default behavior (shown above) builds with pdflatex. That is the preferred method for creating the package.

License

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

Happy TeXing!