summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/nameauth/README
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/nameauth/README')
-rw-r--r--Master/texmf-dist/doc/latex/nameauth/README93
1 files changed, 62 insertions, 31 deletions
diff --git a/Master/texmf-dist/doc/latex/nameauth/README b/Master/texmf-dist/doc/latex/nameauth/README
index 137bcacd4ed..1063131bddd 100644
--- a/Master/texmf-dist/doc/latex/nameauth/README
+++ b/Master/texmf-dist/doc/latex/nameauth/README
@@ -1,59 +1,90 @@
-The nameauth package
-Charles P. Schaum
-charles dot schaum at comcast dot net
-v1.9 from 2015/07/09
+|
+--------:| ----------------------------------------------------------------
+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
-Abstract
+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
+Files Distribution
-README This file (normally in TEXMFDIST/doc/latex/nameauth)
-nameauth.pdf Documentation (normally in TEXMFDIST/doc/latex/nameauth)
+README This file
+nameauth.pdf Documentation
-Makefile Automates building with GNU make 3.81
-nameauth.ins Installer
-nameauth.dtx Documented LaTeX file containing both code and documentation
+Makefile Automates building with GNU make 3.81
+nameauth.dtx Documented LaTeX file containing both code and documentation
Installation
-Unpack nameauth.zip.
+Unpack nameauth.zip in an appropriate directory.
-Generate the file nameauth.sty, e.g.:
- $ pdflatex nameauth.ins
+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.
-Usually this will go in TEXMFDIST/tex/latex/nameauth.
+If you have a make utility compatible with GNU make you can type
-Generate the documentation (optimal with pdflatex):
- $ 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"
+make inst
-I used GNU make to automate the process. See the makefile for more options:
- $ make
+to install the package into your $TEXMFHOME tree or
-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.
+make install
-MacTeX and MikTeX differ. Please refer to your distribution manual.
+to install the package into your $TEXMFLOCAL tree for all users.
-Copy the distribution files to their appropriate destinations.
+Manually, you can generate the package files. First you generate the
+installer driver, README, and style files, with a preliminary PDF:
-Run mktexlsr with the appropriate level of permissions.
+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
+
+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
+
+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 the commands latex, lualatex, pdflatex, and xelatex. It can be used with makeindex and texindy. I have built the package documentation successfully with lualatex, pdflatex, and xelatex, using only makeindex.
+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 purposes, the make file permits one to change the typesetting engine on the command line. The default is to build the package with pdflatex. See Makefile for more details.
+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. See http://www.ctan.org/tex-archive/help/Catalogue/licenses.lppl.html for the details of that license.
+This material is subject to the LaTeX Project Public License:
+http://www.ctan.org/tex-archive/help/Catalogue/licenses.lppl.html
Happy TeXing!
-