diff options
author | Karl Berry <karl@freefriends.org> | 2020-11-24 22:13:48 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2020-11-24 22:13:48 +0000 |
commit | f84e441f563ccac19ce53299ad4a6d507e0c0c35 (patch) | |
tree | 76b2ce96e8e11a8146c2f7a85951443dd4d90088 /Master/texmf-dist/source/latex/nameauth/nameauth.dtx | |
parent | 21dd641b3e636daa59b326c76dabbe7b62e535dd (diff) |
nameauth (24nov20)
git-svn-id: svn://tug.org/texlive/trunk@56995 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/source/latex/nameauth/nameauth.dtx')
-rw-r--r-- | Master/texmf-dist/source/latex/nameauth/nameauth.dtx | 10729 |
1 files changed, 6871 insertions, 3858 deletions
diff --git a/Master/texmf-dist/source/latex/nameauth/nameauth.dtx b/Master/texmf-dist/source/latex/nameauth/nameauth.dtx index b523a087773..5a9d1ad1267 100644 --- a/Master/texmf-dist/source/latex/nameauth/nameauth.dtx +++ b/Master/texmf-dist/source/latex/nameauth/nameauth.dtx @@ -1,139 +1,179 @@ % \iffalse meta-comment -% vim: textwidth=75 +% +% Copyright (C) 2020 by Charles P. Schaum <charles[dot]schaum@comcast.net> +% ------------------------------------------------------- +% +% This file may be distributed and/or modified under the +% conditions of the LaTeX Project Public License, either version 1.3 +% of this license or (at your option) any later version. +% The latest version of this license is in: +% +% http://www.latex-project.org/lppl.txt +% +% and version 1.3 or later is part of all distributions of LaTeX +% version 2005/12/01 or later. +% %<*internal> \iffalse %</internal> %<*readme> -| ---------:| ---------------------------------------------------------------- -nameauth:| Name authority mechanism for consistency in text and index - Author:| Charles P. Schaum - E-mail:| charles dot schaum@comcast.net - License:| Released under the LaTeX Project Public License 1.3c or later - See:| http://www.latex-project.org/lppl.txt - - -Short description: +%<<readmevb +# Short Description -The nameauth package automates the correct formatting and indexing of names +The `nameauth` package automates the correct formatting and indexing of names for professional writing. This aids the use of a name authority and the editing process without needing to retype name references. -Files Distribution +# Files + +|Filename |Description | +|--------------|---------------------------------------| +|`nameauth.dtx`|commented style file; source file | +|`Makefile` |For use with GNU make; with source file| +|`nameauth.ins`|installation driver (generated file) | +|`nameauth.pdf`|Documentation (generated file) | +|`README.md` |This file (generated file) | +|`examples.tex`|example macros (generated file) | + +# Obtaining the Package + +1. Packaged in your current TeX distrbution: See the appropriate documentation. + +2. Otherwise, download `nameauth.zip` from [CTAN](www.ctan.org/tex-archive/macros/latex/contrib/nameauth). + +3. Unpack `nameauth.zip` in an appropriate directory. + +4. Change to the directory containing the `nameauth` files. + +# File Generation -README This file -nameauth.pdf Documentation -examples.tex Some longer example macros from the documentation +## Automatic Installation -Makefile Automates building with GNU make 3.81 -nameauth.dtx Documented LaTeX file containing both code and documentation +This method requires GNU `make` on a POSIX-compliant environment, such as GNU/Linux, various BSD flavors, perhaps MacOS (e.g., with various porting systems), and even Cygwin on Windows. -Manual Installation +0. A quick install in one's home directory using some of the included files from the `zip` archive just requires the following steps: -Download the package from + tex nameauth.dtx + make inst -www.ctan.org/tex-archive/macros/latex/contrib/nameauth +Otherwise we use the LaTeX installation on the host machine to build the package. When using `make`, any `dvi` files that are created will also be converted to `pdf` format. -Unpack nameauth.zip in an appropriate directory. +1. Type `make distclean release` to generate the release files using `pdflatex`. -If you have a make utility compatible with GNU make, either in -GNU/Linux, a BSD variant, OSX, or Cygwin in Windows you can type +2. To use another TeX engine, type one of the following: + make ENGINE=latex + make ENGINE=lualatex + make ENGINE=dvilualatex + make ENGINE=xelatex - make inst +3. Type `make inst` to install the files in the user's personal TDS-compliant directory tree. -to install the package into your $TEXMFHOME tree or +4. Type `sudo make install` to install the files in the system-wide, local TDS-compliant directory tree. - make install +## Manual Compilation -to install the package into your $TEXMFLOCAL tree for all users. -The latter requires sudo privileges. +Otherwise, the following steps are used for manual installation. See the general information at the [TeX FAQ](https://www.texfaq.org/FAQ-installthings). -Other useful targets include: +0. To use some of the included files from the `zip` archive and only extract files from the `dtx` file, just do the following step and proceed to installation: - (release process) + tex nameauth.dtx - make release The default target, same as just ``make''. +1. To build the package on the host system, generate the installation files and a copy of the documentation without the table of contents and cross-references. We use `pdflatex` by default: - make clean Removes all intermediate files. Left are - the files listed above plus nameauth.sty. + pdflatex --shell-escape --recorder --interaction=batchmode nameauth.dtx - make distclean Leave only nameauth.dtx, examples.tex, - and Makefile. +2. Generate the TOC and cross-references for the documentation: - make zip Generate a zip file ready for distribution. + pdflatex --recorder --interaction=nonstopmode nameauth.dtx - (testing process) +3. Generate the index files using `makeindex`: - make testing Release files, plus compiles examples.tex. + makeindex -q -s gglo.ist -o nameauth.gls nameauth.glo + makeindex -q -s gind.ist -o nameauth.ind nameauth.idx - make release ENGINE=<command> - Here, <command> can be pdflatex (default), - xelatex, lualatex, dvilualatex, or latex. +4. Integrate the glossary (changes) and index into the documentation. The second run updates the TOC: - make testing ENGINE=<command> See above. - -It is not necessary, however, to use GNU make. One can generate -the package files manually. Since the files nameauth.ins and README.txt -are contained in the .dtx file itself, the first step is to generate -the installer driver nameauth.ins, plus the file README.txt, which will -also trigger the extraction of nameauth.sty and produce the first pass of -the package documentation nameauth.pdf: + pdflatex --recorder --interaction=nonstopmode nameauth.dtx + pdflatex --recorder --interaction=nonstopmode nameauth.dtx - pdflatex -shell-escape -recorder -interaction=batchmode nameauth.dtx +One can substitute, e.g., `latex`, `xelatex`, `lualatex`, and `dvilualatex` for `pdflatex`, but the documentation may look different in some cases. -Next one adds a table of contents and all cross-references, this also -should finalize page numbers for glossary and index input files: +## File Installation - pdflatex --recorder --interaction=nonstopmode nameauth.dtx - -The next commands generate the glossary/index output files: - - makeindex -q -s gglo.ist -o nameauth.gls nameauth.glo - makeindex -q -s gind.ist -o nameauth.ind nameauth.idx - -The final two commands integrate the glossary (changes) and index: - - pdflatex --recorder --interaction=nonstopmode nameauth.dtx - pdflatex --recorder --interaction=nonstopmode nameauth.dtx +Different TeX distributions have somewhat different ways to store TDS-compliant configuration and package data. See, for example, [MikTeX](https://miktex.org/kb/texmf-roots) and the [TeX FAQ](https://www.texfaq.org/FAQ-privinst). Two approaches below conform generally to a Unix-based system: -Now one can either keep README.txt or rename it to README, e.g.: +## User's Home Directory - mv README.txt README +`TEXMFHOME` is a variable that points to the root of a TDS-compliant directory tree available to a user. Use `kpsewhich --var-value TEXMFHOME` to obtain its value. Quite often it is equivalent to `$HOME/texmf`. The dollar sign in front of the variable denotes the value of the variable instead of its name. So if `$HOME` is `/home/bob`, then `$TEXMFHOME` would be `/home/bob/texmf`, and we can understand the following paths to be under that directory: -Normally one creates the following directories for a user: +|Path |Description | +|----------------------------------|---------------------------------------| +|`$TEXMFHOME/source/latex/nameauth`|`ins` and `dtx` files, Makefile | +|`$TEXMFHOME/tex/latex/nameauth` |`sty` file | +|`$TEXMFHOME/doc/latex/nameauth` |`pdf` file, `README.md`, `examples.tex`| - $TEXMFHOME/source/latex/nameauth dtx file - $TEXMFHOME/tex/latex/nameauth sty file - $TEXMFHOME/doc/latex/nameauth pdf file, README, examples.tex - -and creates the following directories for the local site: +On older TeX distributions, run `mktexlsr` on $TEXMFHOME to complete the install process. - $TEXMFLOCAL/source/latex/nameauth dtx file - $TEXMFLOCAL/tex/latex/nameauth sty file - $TEXMFLOCAL/doc/latex/nameauth pdf file, README, examples.tex +## System-Wide Directory -The above environment variables often are /usr/local/texlive/texmf-local -and ~/texmf. +`TEXMFLOCAL` is a variable that points to the root of a TDS-compliant directory tree available to all users on a local site, system-wide installation. Use `kpsewhich --var-value TEXMFLOCAL` to obtain its value. See the [TeX FAQ](https://www.texfaq.org/FAQ-what-TDS). We can understand the following paths to be under that directory: -The make process normally renames the README.txt file created from the -dtx file to just README by using mv (move / rename utility in the *nix -userland). Windows distributions of TeX and LaTeX often keep the txt file -because of using file extensions instead of ``magic numbers'' to identify -files. +|Path |Description | +|-----------------------------------|---------------------------------------| +|`$TEXMFLOCAL/source/latex/nameauth`|`ins` and `dtx` files, Makefile | +|`$TEXMFLOCAL/tex/latex/nameauth` |`sty` file | +|`$TEXMFLOCAL/doc/latex/nameauth` |`pdf` file, `README.md`, `examples.tex`| -Run mktexlsr with the appropriate level of permissions to complete the -install. +Run `mktexlsr` with the appropriate permissions on `$TEXMFLOCAL` to complete the install process. -Testing notes: +# Testing -See the nameauth manual. +## Compiling `examples.tex` -License +1. Either go to the directory used when unpacking the `zip` file or copy the file `examples.tex` from the `doc/latex/nameauth` branch of whatever TDS-compliant tree to a directory of your choice. -This material is subject to the LaTeX Project Public License: -http://www.ctan.org/tex-archive/help/Catalogue/licenses.lppl.html +2. If one has access to GNU `make`, use either `Makefile` in the directory where one unpacked the `zip` file or copy `Makefile` from either `src/latex/nameauth` or `doc/latex/nameauth` in whatever TDS-compliant tree it exists. -Happy TeXing! +When using `make`, any `dvi` files that are created will also be converted to `pdf` format. + +3. To compile the test file using `make` and `pdflatex`, simply type `make testing`. + +4. For multi-format testing using `make` in addition to that above, one can do the following: + + make testing ENGINE=pdflatex + make testing ENGINE=latex + make testing ENGINE=lualatex + make testing ENGINE=dvilualatex + make testing ENGINE=xelatex + +5. If one does not have `make`, one can use the following commands, substituting, e.g., `latex`, `xelatex`, `lualatex`, and `dvilualatex` for `pdflatex`: + + pdflatex --interaction=nonstopmode examples + pdflatex --interaction=nonstopmode examples + makeindex -o examples.ind examples.idx + makeindex -o examples.rnd examples.rdx + pdflatex --interaction=nonstopmode examples + pdflatex --interaction=nonstopmode examples + +The use of different extensions for the index results from using the `index` package to generate a persons index separate from a subject index. + +The manual is also a test suite. + +# Copyright + +Copyright (C) 2020 by Charles P. Schaum <charles[dot]schaum@comcast.net> +------------------------------------------------------- + +This file may be distributed and/or modified under the +conditions of the LaTeX Project Public License, either version 1.3 +of this license or (at your option) any later version. +The latest version of this license is in: + + [http://www.latex-project.org/lppl.txt](http://www.latex-project.org/lppl.txt) + +and version 1.3 or later is part of all distributions of LaTeX +version 2005/12/01 or later. +%readmevb %</readme> %<*internal> \fi @@ -146,35 +186,24 @@ Happy TeXing! \input docstrip.tex \keepsilent \askforoverwritefalse + \preamble ---------:| ---------------------------------------------------------------- -nameauth:| Name authority mechanism for consistency in text and index - Author:| Charles P. Schaum - E-mail:| charles dot schaum@comcast.net - License:| Released under the LaTeX Project Public License 1.3c or later - See:| http://www.latex-project.org/lppl.txt +This is a generated file. -\endpreamble -\postamble +Copyright (C) 2020 by Charles P. Schaum <charles[dot]schaum@comcast.net> -Copyright (C) 2020 by Charles P. Schaum <charles dot schaum@comcast.net> +This file may be distributed and/or modified under the conditions of +the LaTeX Project Public License, either version 1.3 of this license +or (at your option) any later version. The latest version of this +license is in: -This work may be distributed and / or modified under the -conditions of the LaTeX Project Public License (LPPL), either -version 1.3c of this license or (at your option) any later -version. The latest version of this license is in the file: + http://www.latex-project.org/lppl.txt -http://www.latex-project.org/lppl.txt +and version 1.3 or later is part of all distributions of LaTeX version +2005/12/01 or later. -This work is "maintained" (as per LPPL maintenance status) by -Charles P. Schaum. - -This work consists of the files nameauth.dtx, examples.tex, and a Makefile. -These files generate README.txt / README, nameauth.ins, nameauth.sty, and -nameauth.pdf, with other intermediate files, as a part of this work. See -the README.txt or README for more information. -\endpostamble +\endpreamble \usedir{tex/latex/nameauth} \generate{ @@ -187,10 +216,14 @@ the README.txt or README for more information. \generate{ \file{\jobname.ins}{\from{\jobname.dtx}{install}} } -\nopreamble\nopostamble \usedir{doc/latex/nameauth} +\nopostamble +\generate{ + \file{examples.tex}{\from{\jobname.dtx}{examples}} +} +\nopreamble \generate{ - \file{README.txt}{\from{\jobname.dtx}{readme}} + \file{README.md}{\from{\jobname.dtx}{readme}} } \ifx\fmtname\nameofplainTeX \expandafter\endbatchfile @@ -204,15 +237,18 @@ the README.txt or README for more information. %<*driver> \ProvidesFile{nameauth.dtx} %</driver> -%<package>\NeedsTeXFormat{LaTeX2e}[1999/12/01] +%<package>\NeedsTeXFormat{LaTeX2e}[2005/12/01] %<package>\ProvidesPackage{nameauth} %<*package> - [2020/02/26 3.4 Name authority mechanism for consistency in text and index] + [2020/11/23 3.5 Name authority mechanism for consistency in text and index] %</package> +% %<*driver> \documentclass[11pt]{ltxdoc} + %^^A Below we check if our TL distribution has the iftex package and load it. \IfFileExists{iftex.sty}{\usepackage{iftex}}{} + %^^A Only versions of iftex since 2019 have the macro \RequireTUTeX. %^^A If the package is not loaded or if it is not new, %^^A we load the older, transitional packages. @@ -221,14 +257,15 @@ the README.txt or README for more information. \usepackage{ifluatex} \usepackage{ifpdf} \fi + +%^^A We include packages depending on the LaTeX engine, mode, +%^^A and version of TeX being used. \ifxetex %^^A \ifpdf will not be true, but a pdf results. \usepackage{fontspec} \usepackage{polyglossia} \setdefaultlanguage{american} \setotherlanguage{german} \newcommand\de[1]{\textgerman{#1}} - \usepackage{tikz} - \usepackage{tcolorbox} \else \ifluatex \ifpdf %^^A pdf mode @@ -237,8 +274,6 @@ the README.txt or README for more information. \setdefaultlanguage{american} \setotherlanguage{german} \newcommand\de[1]{\textgerman{#1}} - \usepackage{tikz} - \usepackage{tcolorbox} \else %^^A dvi mode \IfFileExists{utf8-2018.def}{}{\usepackage[utf8]{inputenc}} \usepackage[TS1,T1]{fontenc} @@ -260,43 +295,62 @@ the README.txt or README for more information. \DeclareTextSymbolDefault{\textlongs}{TS1} \DeclareTextSymbol{\textlongs}{TS1}{115} \newunicodechar{ſ}{\textlongs} - \ifpdf %^^A These only get included for pdf. - \usepackage{tikz} - \usepackage{tcolorbox} - \fi \fi \fi + +%^^A Used unconditionally because we convert the dvi to pdf +%^^A Otherwise we would put this in \ifpdf...\fi +\usepackage{tikz} +\usepackage{tcolorbox} + +\usepackage{microtype} + %^^A Set up initial page layout to fit both letter and DIN A4. -\usepackage[textwidth=137mm,textheight=237mm,right=25mm,marginparwidth=40mm,nohead]{geometry} -%^^A Include only this version of the package. -\usepackage{\jobname}[2020/02/26] -%^^A Set up all tabular information. +\usepackage[textwidth=137mm,textheight=237mm, + right=25mm,marginparwidth=39mm,nohead]{geometry} + +%^^A Include specifically the current version of the package. +\usepackage{\jobname}[2020/11/23] + +%^^A Set up all tabular packages. Booktabs makes them pretty, +%^^A colortabl shades rows, and tabularx allows some fiddly +%^^A stuff when typesetting the nameauth environment as a table. \usepackage{booktabs} \usepackage{colortbl} -\usepackage{tabularx} + %^^A Set up lists. \usepackage{enumitem} \setlist{rightmargin=\leftmargin,itemsep=0pt} -%^^A Create indexes and set up the ``actual'' character in nameauth. + +%^^A Create indexes and set up the ``actual'' character in nameauth +%^^A to conform to gind.ist. \usepackage{makeidx} \IndexActual{=} + %^^A Dangerous bend ahead... \usepackage{manfnt} + %^^A Two-column TOC \usepackage[toc]{multitoc} + %^^A Some examples get some stretch to aid clarity and readability. \usepackage{setspace} + %^^A Color helps categorize information. \usepackage{xcolor} + \colorlet{nared}{red!50!black} \colorlet{nagreen}{green!35!black} \colorlet{nablue}{blue!50!black} -\colorlet{nabrown}{brown!55!black} +\colorlet{nabrown}{brown!50!black} \colorlet{naviolet}{violet!90!black} \colorlet{nataupe}{yellow!40!black} \colorlet{naslate}{cyan!45!black} +\colorlet{grey}{black!7!white} + %^^A For example... \usepackage{verbatim} + %^^A Have documentation with hyperlinks \usepackage[numbered]{hypdoc} @@ -320,8 +374,8 @@ the README.txt or README for more information. \makeatother %^^A Use color indicators in a couple of tables. -\newcommand\NO{\bgroup\color{lightgray}\lower 0.075ex\hbox{\rule{1.5ex}{1.5ex}}\egroup} -\newcommand\YES{\bgroup\color{darkgray}\lower 0.075ex\hbox{\rule{1.5ex}{1.5ex}}\egroup} +\newcommand\NO{\bgroup\color{black!20!white}\lower 0.075ex\hbox{\rule{1.5ex}{1.5ex}}\egroup} +\newcommand\YES{\bgroup\color{black!80!white}\lower 0.075ex\hbox{\rule{1.5ex}{1.5ex}}\egroup} %^^A Stretch out some text for clarity. \newcommand*\MyStretch{\setstretch{1.1}} @@ -331,37 +385,43 @@ the README.txt or README for more information. \newcommand*\BigBlank{{\large\itshape\vfil\leavevmode\hfil This space is intentionally left blank.}} %^^A Macros for marginalia. -\newcommand*\Version[1]{\unless\ifinner\marginpar{\strut\raggedleft\textsf{\bfseries#1}}\fi} -\newcommand*\VersionWarn[1]{{\unless\ifinner\marginpar{\strut\raggedleft\textsf{\bfseries#1}\break\small\dbend}\fi}} -\newcommand*\Warn{{\unless\ifinner\marginpar{\strut\small\raggedleft\dbend}\fi}} -\newcommand*\Info[1]{{\unless\ifinner\marginpar{\strut\small\raggedleft#1}\fi}} +\newcommand*\Version[1]{\unless\ifinner\marginpar{\raggedleft\strut\textsf{\bfseries#1}}\fi} +\newcommand*\Warn{{\unless\ifinner\marginpar{\small\strut\raggedleft\raise0.7ex\hbox{\dbend}}\fi}} +\newcommand*\Info[1]{{\MyStretch\unless\ifinner\marginpar{\small\raggedleft#1}\fi}} +\newcommand*\SPatInfo[1]{{\MyStretch\unless\ifinner\marginpar{\footnotesize\raggedleft Simplified Name Pattern(s):\break\ttfamily#1}\fi}} +\newcommand*\PatInfo[1]{{\MyStretch\unless\ifinner\marginpar{\footnotesize\raggedleft Name Pattern(s):\hfill\break\ttfamily#1}\fi}} +\newcommand*\IdxInfo[1]{{\MyStretch\unless\ifinner\marginpar{\footnotesize\raggedleft Basic Index:\hfill\break#1}\fi}} +\newcommand*\Illus{{\MyStretch\unless\ifinner\marginpar{\footnotesize\raggedleft + Name color and\\ + typeface are only\\ + illustrative, not\\ + package defaults.}\fi}} %^^A Use this example in the body text. \newcommand\Orphan[2]{#1(\hyperpage{#2})} \TagName[Lost]{Name}{\,\S|Orphan{perdit}} \TagName{foo\Name {bar}}{\,\S|hyperpage} -%^^A Redefine emphasis in the body text +%^^A Redefine emphasis in the body text because italic has some dedicated uses. \let\oldemph\emph \let\emph\textbf -%^^A Struts for framed boxes -\newcommand*{\mystrut}{\rule[-0.25\baselineskip]{0pt}{\baselineskip}} - -%^^A Set up all the shorthands, but not all the names. +%^^A Set up all the shorthands, but not all the names. Even if one does not set +%^^A up all the names here, it is a very good idea to set up the (pre)tags just below, +%^^A especially in a dtx file. \begin{nameauth} \< Adams & John & \noexpand\textSC{Adams} & > \< Aeth & & Æthelred, II & > - \< Anth & Susan B. & Anthony & > \< Aris & & Aristotle & > - \< Attil & & Attila, the Hun & > + \< Bailey & Betsey & Bailey & > \< Cicero & M.T. & Cicero & > \< Confucius & & Confucius & > \< Dagb & & Dagobert & I > \< SDJR & Sammy & \noexpand\textSC{Davis}, \noexpand\textSC{Jr}. & > \< Dem & & Demetrius, I & > - \< deSmet & Pierre-Jean & \noexpand\Fbox{\noexpand\AltCaps{d}e Smet} & > - \< Soto & Hernando & de Soto & > + \< deSmet & Pierre-Jean & \noexpand\Fbox{\noexpand\AltCaps{d}e~Smet} & > + \< Soto & Hernando & de~Soto & > + \< Doug & Frederick & Douglass & > \< DuBois & W.E.B. & Du~Bois & > \< AltDuBois & W.E.B. & DuBois & > \< Einstein & Albert & Einstein & > @@ -373,6 +433,7 @@ the README.txt or README for more information. \< Harnack & Adolf & Harnack & > \< Henry & & Henry & VIII > \< Jeff & Thomas & \noexpand\JEFF & > + \< Eriugena & & John, Eriugena & > \< Lewis & Clive Staples & Lewis & > \< CSL & Clive Staples & Lewis & C.S. > \< Luth & Martin & \noexpand\textSC{Luther} & > @@ -382,16 +443,13 @@ the README.txt or README for more information. \< MSens & & Miyazaki, Hayao & Sensei > \< Noguchi & Hideyo & Noguchi & > \< Pat & George S. & Patton, Jr. & > - \< JRIII & John David & \textSC{Rockefeller},\textSC{III} & > - \< JRIV & John David & Rockefeller, IV & > - \< JayR & John David & Rockefeller, IV & Jay > + \< JRIII & J.D. & \textSC{Rockefeller},\textSC{III} & > + \< JRIV & J.D. & Rockefeller, IV & > + \< JayR & J.D. & Rockefeller, IV & Jay > \< Scipio & \noexpand\SCIPi & \noexpand\SCIPii & > \< OScipio & Publius & \noexpand\CSA & > \< Shak & \noexpand\WM & \noexpand\SHK & > \< Striet & John & \de{Strietelmeier} & > - \< Ches & Chesley B. & Sullenberger, III & > - \< Sully & Chesley B. & Sullenberger, III & Sully > - \< Sun & & Sun, Yat-sen & > \< KempMed & & Thomas, à~Kempis & > \< KempW & Thomas & à~Kempis & > \< Tyson & Mike & Tyson & > @@ -403,10 +461,11 @@ the README.txt or README for more information. \< Yosh & & Yoshida & Shigeru > \end{nameauth} -%^^A Add sort tags for those needing them. +%^^A Add sort tags here for those needing them. Especially for dtx files. \PretagName[John]{\noexpand\textSC{Adams}}{Adams, John} \PretagName{Æthelred, II}{Aethelred 2} \PretagName{Atatürk}{Ataturk} +\PretagName[W.H.]{Auden}{Auden, Wystan} \PretagName{\textit{Doctor mellifluus}}{Doctor mellifluus} \PretagName[Charles]{\textBF{Babbage}}{Babbage, Charles} \PretagName{Bo\"ethius}{Boethius} @@ -415,12 +474,12 @@ the README.txt or README for more information. \PretagName[Sammy]{\noexpand\textSC{Davis}, \noexpand\textSC{Jr}.}{Davis, Sammy, Jr.} \PretagName{Demetrius, I}{Demetrius 1} \PretagName[Jacques]{De~Pamele}{Depamele, Jacques} -\PretagName[Pierre-Jean]{\noexpand\Fbox{\noexpand\AltCaps{d}e Smet}}{desmet, Pierre-Jean} -\PretagName[Hernando]{de Soto}{Desoto, Hernando} -\PretagName[W.E.B.]{Du~Bois}{Dubois, W.E.B.} -\PretagName[W.E.B.]{DuBois}{Dubois, W.E.B.} -\PretagName[Charles]{du Fresne}{Dufresne, Charles} -\PretagName{du Cange}{Ducange} +\PretagName[Pierre-Jean]{\noexpand\Fbox{\noexpand\AltCaps{d}e~Smet}}{deSmet, Pierre-Jean} +\PretagName[Hernando]{de~Soto}{Desoto, Hernando} +\PretagName[W.E.B.]{Du~Bois}{Dubois, William} +\PretagName[W.E.B.]{DuBois}{Dubois, William} +\PretagName[Charles]{du~Fresne}{Dufresne, Charles} +\PretagName{du~Cange}{Ducange} \PretagName{Elizabeth, I}{Elizabeth 1} \PretagName{\textUC{Fukuyama}, Takeshi}{Fukuyama Takeshi} \PretagName[Greta]{\textSC{Garbo}}{Garbo, Greta} @@ -428,14 +487,14 @@ the README.txt or README for more information. \PretagName{Harun, \noexpand\textSC{\noexpand\AltCaps{a}l-Rashid}}{Harun Alrashid} \PretagName[Thomas]{\noexpand\JEFF}{Jefferson, Thomas} \PretagName[Ada]{\textIT{Lovelace}}{Lovelace, Ada} -\PretagName[Jan]{Łukasiewicz}{Lukasiewicz, Jan} \PretagName[Martin]{\noexpand\textSC{Luther}}{Luther, Martin} \PretagName[Catherine \noexpand\AltCaps{d}e']{\noexpand\textSC{Medici}}{Medici, Catherine de} \PretagName{\noexpand\textSC{Mencius}}{Mencius} \PretagName{\noexpand\textSC{Meng}, Ke}{Meng Ke} +\PretagName{\textSC{Misora}, Hibari}{Misora Hibari} \PretagName[Frenec]{Molnár}{Molnar, Frenec} -\PretagName[John David]{\textSC{Rockefeller},\textSC{III}}{Rockefeller, John David 3} -\PretagName[John David]{Rockefeller, IV}{Rockefeller, John David 4} +\PretagName[J.D.]{\textSC{Rockefeller},\textSC{III}}{Rockefeller, John D 3} +\PretagName[J.D.]{Rockefeller, IV}{Rockefeller, John D 4} \PretagName[Heinrich Wilhelm]{\textSC{Rühmann}}{Ruehmann, Heinrich Wilhelm} \PretagName[\noexpand\SCIPi]{\noexpand\SCIPii}{Scipio Africanus} \PretagName[Publius]{\noexpand\CSA}{Cornelius Scipio Africanus} @@ -447,16 +506,16 @@ the README.txt or README for more information. \PretagName[Thomas]{à~Kempis}{Akempis, Thomas} \PretagName{\textUC{Tokugawa}, Ieyasu}{Tokugawa Ieyasu} \PretagName{Vlad, Ţepeş}{Vlad Tepes} -\PretagName[E.\,B.]{White}{White, E.B.} +\PretagName[E.\,B.]{White}{White, Elwyn} -%^^A Add index tags for all names. +%^^A Add index tags for all names. Failing to do this here, especially in +%^^A dtx files, can result in errors. \TagName[John]{\noexpand\textSC{Adams}}{, pres.|hyperpage} \TagName{Æthelred, II}{, king|hyperpage} -\TagName[Susan B.]{Anthony}{|hyperpage} -\TagName{Arai, Akino}{|hyperpage} \TagName{Aristotle}{|hyperpage} -\TagName{Attila, the Hun}{|hyperpage} +\TagName[W.H.]{Auden}{|hyperpage} \TagName[Charles]{\textBF{Babbage}}{|hyperpage} +\TagName[Thomas Haynes]{Bayly}{|hyperpage} \TagName{Bernard, of Clairvaux}{|hyperpage} \TagName{Bo\"ethius}{|hyperpage} \TagName[Robert]{\textSC{Burns}}{|hyperpage} @@ -473,11 +532,13 @@ the README.txt or README for more information. \TagName[Sammy]{\noexpand\textSC{Davis}, \noexpand\textSC{Jr}.}{|hyperpage} \TagName{Demetrius, I}{ Soter, king|hyperpage} \TagName[Jacques]{De~Pamele}{|hyperpage} -\TagName[Pierre-Jean]{\noexpand\Fbox{\noexpand\AltCaps{d}e Smet}}{|hyperpage} -\TagName[Hernando]{de Soto}{|hyperpage} +\TagName[Pierre-Jean]{\noexpand\Fbox{\noexpand\AltCaps{d}e~Smet}}{|hyperpage} +\TagName[Hernando]{de~Soto}{|hyperpage} \TagName[Marc van]{Dongen}{|hyperpage} +\TagName[Frederick]{Douglass}{|hyperpage} +\TagName[Betsey]{Bailey}{|hyperpage} \TagName[W.E.B.]{Du~Bois}{|hyperpage} -\TagName[Charles]{du Fresne}{|hyperpage} +\TagName[Charles]{du~Fresne}{|hyperpage} \TagName[Albert]{Einstein}{|hyperpage} \TagName{Elizabeth, I}{, queen|hyperpage} \TagName{\textUC{Fukuyama}, Takeshi}{|hyperpage} @@ -493,38 +554,36 @@ the README.txt or README for more information. \TagName[Adolf]{Harnack}{|hyperpage} \TagName{Harun, \noexpand\textSC{\noexpand\AltCaps{a}l-Rashid}}{|hyperpage} \TagName[Lafcadio]{Hearn}{|hyperpage} -\TagName{Henry}[VIII]{\ddag, king|hyperpage} +\TagName{Henry}[VIII]{, king|hyperpage} \TagName[Bob]{Hope}{|hyperpage} \TagName{Ishida}[Yoko]{\ddag|hyperpage} \TagName[Thomas]{\noexpand\JEFF}{, pres.|hyperpage} \TagName{Jesus, Christ}{|hyperpage} -\TagName[Yoko]{Kanno}{\dag|hyperpage} +\TagName{John, Eriugena}{|hyperpage} \TagName[Mustafa]{Kemal}{|hyperpage} -\TagName[John Maynard]{Keynes}{|hyperpage} \TagName[Martin Luther]{King, Jr.}{|hyperpage} -\TagName[The Amazing]{Kreskin}{|hyperpage} \TagName{Lao-tzu}{|hyperpage} -\TagName{Leo, I}{, pope|hyperpage} \TagName[Clive Staples]{Lewis}{|hyperpage} \TagName{Louis, XIV}{, king|hyperpage} \TagName[Ada]{\textIT{Lovelace}}{|hyperpage} \TagName[Uwe]{Lueck}{|hyperpage} \TagName[Dan]{Luecking}{|hyperpage} -\TagName[Jan]{Łukasiewicz}{|hyperpage} \TagName[Martin]{\noexpand\textSC{Luther}}{|hyperpage} \TagName{Maimonides}{|hyperpage} +\TagName{\textSC{Misora}, Hibari}{|hyperpage} \TagName[Nicolas]{Malebranche}{|hyperpage} \TagName[Catherine \noexpand\AltCaps{d}e']{\noexpand\textSC{Medici}}{|hyperpage} \TagName{\noexpand\textSC{Mencius}}{|hyperpage} \TagName{Miyazaki, Hayao}{|hyperpage} \TagName[Frenec]{Molnár}{\dag|hyperpage} \TagName[Hideyo]{Noguchi}{\dag|hyperpage} +\TagName{Novalis}{|hyperpage} \TagName[Heiko]{Oberdiek}{|hyperpage} \TagName[George S.]{Patton, Jr.}{|hyperpage} \TagName[Lucius]{Sergius Paulus}{|hyperpage} \TagName{Rambam}{|hyperpage} -\TagName[John David]{\textSC{Rockefeller},\textSC{III}}{|hyperpage} -\TagName[John David]{Rockefeller, IV}{|hyperpage} +\TagName[J.D.]{\textSC{Rockefeller},\textSC{III}}{|hyperpage} +\TagName[J.D.]{Rockefeller, IV}{|hyperpage} \TagName[Heinz]{\textSC{Rühmann}}{|hyperpage} \TagName{Saul, of Tarsus}{|hyperpage} \TagName[Robert]{Schlicht}{|hyperpage} @@ -533,9 +592,9 @@ the README.txt or README for more information. \TagName[\noexpand\WM]{\noexpand\SHK}{|hyperpage} \TagName[R.]{Snel van Royen}{|hyperpage} \TagName[W.]{Snel van Royen}{|hyperpage} +\TagName[Gertrude]{Stein}{|hyperpage} \TagName[Philipp]{Stephani}{|hyperpage} \TagName[John]{\de{Strietelmeier}}{|hyperpage} -\TagName[Chesley B.]{Sullenberger, III}{|hyperpage} \TagName{Sun, Yat-sen}{, pres.|hyperpage} \TagName{Thomas, à~Kempis}{|hyperpage} \TagName{Thomas, Aquinas}{|hyperpage} @@ -551,10 +610,11 @@ the README.txt or README for more information. \TagName[E.\,B.]{White}{|hyperpage} \TagName{William, I}{|hyperpage} \TagName{Yamamoto, Isoroku}{|hyperpage} -\TagName{Yohko}{|hyperpage} \TagName{Yoshida}[Shigeru]{\ddag, PM|hyperpage} \TagName[Caspar]{Ziegler}{|hyperpage} +%^^A These options allow the index to focus on names in the index more like +%^^A one might see in a normal document. \DisableCrossrefs \CodelineIndex \RecordChanges @@ -566,7 +626,7 @@ the README.txt or README for more information. %</driver> % \fi % -% \CheckSum{3799} +% \CheckSum{3447} % % \CharacterTable % {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z @@ -585,66 +645,104 @@ the README.txt or README for more information. % Right brace \} Tilde \~} % % \changes{0.7}{2011/12/26}{Initial release} +% \changes{0.75}{2012/01/19}{Standardized arguments} +% \changes{0.85}{2012/02/05}{Show or hide commas} % \changes{1.0}{2012/02/20}{Works with \textsf{microtype}, \textsf{memoir}} -% \changes{2.0}{2015/11/11}{Use dtxgen; prevent bad args} +% \changes{2.3}{2016/01/05}{New back-end for naming macros} % \changes{2.5}{2016/04/06}{No default format} -% \changes{3.3}{2020/02/20}{Update manual} +% \changes{3.2}{2017/03/22}{Root, suffix macros renamed, redesigned} % \changes{3.4}{2020/02/26}{Update manual, \texttt{examples.tex}} +% \changes{3.5}{2020/11/23}{Updates to manual, \texttt{Readme.md}, \texttt{Makefile}, \texttt{examples.tex}, combine \texttt{Readme.md} and \texttt{examples.tex} files in \texttt{dtx}} % % \GetFileInfo{\jobname.dtx} % % \DoNotIndex{\@empty, \@gobble, \@period, \@token, \trim@spaces, % \zap@space} -% +% % \DoNotIndex{\begingroup, \bfseries, \bgroup, \csdef, \csgdef, \csname, % \csundef, \DeclareOption, \def, \detokenize, \edef, \egroup, \else, % \endcsname, \endgroup, \endinput, \ExecuteOptions, \expandafter, \fi, % \futurelet, \global, \hbox, \if, \ifcsname, \ifx, \ignorespaces, \index, % \itshape, \leavevmode, \let, \newcommand, \newcommandx, \newenvironment, % \newif, \nobreakspace, \PackageError, \PackageWarning, \ProcessOptions, -% \relax, \renewcommand, \RequirePackage, \scshape, \space, \textbackslash, -% \uppercase} -% -% \newif\ifNoTag -% \newif\ifDoTikZ -% \ifxetex -% \DoTikZtrue -% \else -% \ifluatex -% \ifpdf -% \DoTikZtrue -% \fi -% \else -% \ifpdf -% \DoTikZtrue -% \fi -% \fi -% \fi +% \relax, \renewcommand, \RequirePackage, \scshape, \textbackslash, \uppercase} +% +% \hfuzz=3pt % % \ClearNum -% \ifDoTikZ -% \tcbset{fonttitle=\bfseries\sffamily,box align=top,lower separated=false} -% \fi -% -% \renewcommand*\FrontNamesFormat[1]{\color{nared}\sffamily #1} -% \renewcommand*\FrontNameHook[1]{\color{nagreen}\sffamily #1} -% \renewcommand*\NamesFormat[1]{\color{nablue}\sffamily #1} -% \renewcommand*\MainNameHook[1]{\color{nabrown}\sffamily #1} -% \newcommand*\ReturnLink{\ifDoTikZ -% \begin{tcolorbox}\centering Back to Section~\ref{sec:Dashboard}\end{tcolorbox}\else -% \medskip{\hfil\large Back to Section~\ref{sec:Dashboard}}\fi} +% \tcbset{fonttitle=\bfseries\sffamily,box align=top,lower separated=false} % -% \newif\ifFontDebug -%^^A \FontDebugtrue +% \renewcommand*\FrontNamesFormat[1]{\color{red}\sffamily #1} +% \renewcommand*\FrontNameHook[1]{\color{darkgray}\sffamily #1} +% \renewcommand*\NamesFormat[1]{\color{blue}\sffamily #1} +% \renewcommand*\MainNameHook[1]{\sffamily #1} +% \newcommand*\ReturnLink{\leavevmode^^A +% \begin{tcolorbox}\centering Back to Section~\ref{sec:Dashboard}\end{tcolorbox}^^A +% \leavevmode} % +%^^A This helps track down any stray or unintended changes to font sizes. +% \newif\ifFontDebug +%^^A Uncomment the following line to debug font sizes. +%^^A\FontDebugtrue % \makeatletter -% \@setpar{\ifFontDebug\edef\@FS{ \f@size pt}{\tiny\@FS}\fi\@@par} +% \@setpar{^^A +% \ifFontDebug +% \edef\@FS{ \f@size pt}^^A +% \unless\ifinner\marginpar{\scriptsize\normalfont\@FS}\fi +% \fi +% \@@par} % \makeatother % -% \begingroup\FontDebugfalse +%^^A Global definitions of conditionals for examples +%^^A For Scipio Africanus +% \newif\ifSkipGens +% \newif\ifNoGens +% \newif\ifSkipAgnomen +% \newif\ifNoAgnomen +%^^A For Thomas Jefferson +% \newif\ifGenitive +% \newif\ifDoGen +%^^A For George Washington/Mustafa Kemal +% \newif\ifNoTag +%^^A For William Shakespeare +% \newif\ifSpecialFN +% \newif\ifSpecialSN +% \newif\ifRevertSN +%^^A For advanced hooks +% \newif\ifFbox +% \newif\ifFirstCap +% \newif\ifInHook +% \Fboxtrue +% \newif\ifCaps +%^^A Global definitions of macros for examples +%^^A For Scipio Africanus +% \newcommand*\SCIPi{\ifNoGens +% Publius\else Publius Cornelius\fi} +% \newcommand*\SCIPii{\ifNoAgnomen +% Scipio\else Scipio Africanus\fi} +% \newcommand*\ScipioOnly{\SkipAgnomentrue\Scipio} +% \newcommand*\CSA{\ifNoGens\ifNoAgnomen +% Scipio\else +% Scipio Africanus\fi +% \else\ifNoAgnomen +% Cornelius Scipio\else +% Cornelius Scipio Africanus\fi\fi} +% \ExcludeName[Publius]{\noexpand\CSA} +%^^A For Thomas Jefferson +% \newcommand\JEFF{\ifDoGen\textSC{Jefferson's}\else\textSC{Jefferson}\fi} +%^^A For William Shakespeare +% \newcommand*\WM{\ifSpecialFN Wm.\else William\fi} +% \newcommand*\SHK{\ifRevertSN \textSC{Shakespeare}\else +% \ifSpecialSN \noexpand\AltCaps{t}he Bard\else +% \textSC{Shakespeare}\fi\fi} +% \newcommand*\Revert{\RevertSNtrue} +%^^A End of global definitions for examples +% +% \begingroup^^A This group prevents font debugging on the title page. +% \FontDebugfalse % \title{\textsf{nameauth} --- Name authority mechanism\\ for consistency in text and % index\thanks{This file describes version \fileversion, last revised \filedate.}} -% \author{Charles P. Schaum\thanks{E-mail: charles dot schaum@comcast.net}} +% \author{Charles P. Schaum\thanks{E-mail: charles[dot]schaum@comcast.net}} % \date{Released \filedate} % % \maketitle @@ -654,513 +752,548 @@ the README.txt or README for more information. % \end{abstract} % % \bgroup\small\tableofcontents\egroup -% \endgroup +% \endgroup^^A End title page group. +% \newpage % % \section{Quick Start} +% \begin{tcolorbox}[colback=white,colframe=nared,adjusted title={\hfil Disclaimer}] +% \small\noindent Names are about real people; examples should be too. This manual mentions notable figures both living and deceased. All names herein are meant to be used respectfully, for teaching purposes only. At no time is any disrespect or bias intended. +% \end{tcolorbox} % -% \subsection{How to Use the Manual} +% \subsection{Introduction} +% A \emph{name authority} is a canonical, scholarly list of name forms to which all variant name forms and aliases must refer. The task dashboard (Section~\ref{sec:Dashboard}) guides one to various areas of interest. To load the defaults, simply type: +% \begin{center} +% \fbox{ +% \begin{tabular}{l} +% {\Large\strut}\texttt{\textbackslash usepackage\{nameauth\}}\\ +% \end{tabular} +% }\smallskip +% \end{center} +% +% The \textsf{nameauth} macros permit ambiguity because name forms are ambiguous unless they are put into a cultural context. Therefore, keep it simple. Use the quick interface. Use the fewest number of \textsf{nameauth} macros for one's use case. % -% A \emph{name authority} is a canonical, scholarly list of names to which all variants must refer. The task dashboard (Section~\ref{sec:Dashboard}) guides one to various areas of interest. Start with the basics and add features as needed. To load the defaults, simply type: -% \begin{quote} -% \fbox{\mystrut\ \texttt{\textbackslash usepackage\{nameauth\}} } -% \end{quote} +% \begin{center}\bfseries Package Design and Features\end{center} % -% \begin{center}\large\bfseries Package Design and Features\end{center} -% \noindent With \textsf{nameauth} names become abstractions: verbs that alter state and nouns that have state. That improves accuracy and consistency: +% The editorial process for book-length projects may require one to add, delete, or relocate text. Several issues emerge from this: % \begin{itemize} -% \item \emph{Automate} name forms used in professional writing. First uses of names will have full forms. Later uses have shorter forms. Names vary in the text, but stay constant in the index. -% \item Permit \emph{complex name formatting}. -% \item Many \emph{cross-cultural, multilingual naming conventions} are possible. More details appear in Sections~\ref{sec:ErrorProt}, \ref{sec:AltFormat}, \ref{sec:IndexSort}, and~\ref{sec:Hooksiii}. -% \item \emph{Automatic sort keys and tags} aid indexing. -% \item One can \emph{associate information with names.} -% \item The standard used for implementing the \textsf{nameauth} indexing macros is Nancy C. Mulvany, \textit{Indexing Books} (Chicago: University of Chicago Press, 1994). All references [\hypertarget{Mulvany}{Mulvany}] refer to this edition. -% \item In Section~\ref{sec:ErrorProt} we see how to avoid common errors. -% \item Section~\ref{sec:TechNotes} contains \emph{thanks} and various technical notes. +% \item Professional writing needs a full name form to introduce a person, using shorter forms thereafter. Moving text may require re-checking names. +% \item If a name is keyed to another name or narrative event, moving text may require checking for anachronistic references. +% \item Including special information in the index, such as including non-Latin script name forms with Latin script forms, can be complex and tedious. +% \item Unless one is familiar with professional indexing, one might create incorrect index entries. +% \item One must check if any names straddle page breaks and index them. % \end{itemize} % -% \begin{center}\large\bfseries Special Signs\end{center} -% \noindent As teaching aids, this manual uses markings that are not part of \textsf{nameauth}, but in some cases are implemented using it: +% The \textsf{nameauth} package provides automated solutions for all points above at the time of writing. Names become abstractions; they are verbs that alter state and nouns that have state. That improves accuracy and consistency: % \begin{itemize} -% \item[\ \ ]We show \fbox{\mystrut\NamesFormat{first uses}} and \fbox{\mystrut\MainNameHook{subsequent uses}} of names (Sections~\ref{sec:Formatting}, \ref{sec:NameControl}). +% \item \emph{Automate} name forms. First uses of names have long forms. Later uses are short by default. Names vary in the text, but not in the index. +% \item Implement \emph{cross-cultural, multilingual naming conventions}. +% \item Implement \emph{complex name formatting} using conditional elements. +% \item Improve indexing with \emph{automatic sorting and tagging, and cross-reference control.} Indexing rules are based on Nancy C. Mulvany, \textit{Indexing Books} (Chicago: University of Chicago Press, 1994). All references [\hypertarget{Mulvany}{Mulvany}] refer to this edition. +% \item \emph{Associate and retrieve information} bound to names. +% \end{itemize} +% +% \begingroup +% \renewcommand{\NamesFormat}{} +% \renewcommand{\MainNameHook}{} +% For example,\IdxInfo{\ShowIdxPageref*[Frederick]{Douglass}\break \ShowIdxPageref*[Betsey]{Bailey}} from a biography written a century ago, we show reordered paragraphs that require no subsequent changes. We use the ``quick interface'' and no name formatting (the package default). We ``forget'' names at the top of the right-hand column to simulate not using them yet (Section~\ref{sec:NameControl}): +% \begin{quote}\small +% \begin{multicols}{2} +% |\Doug\| \Doug\ rose to eminence by sheer force of character and talents that neither slavery nor caste proscription could crush. Circumstances could not prevent him from becoming a freeman and a leader. +% +% |\Doug's| \Doug's early life is perhaps the most complete indictment of the slave system ever presented at the bar of public opinion. +% +% |\Doug\| \Doug\ was born in February, l8l7. His earliest memories centered around the private cabin of his grandmother, |\Bailey,| \Bailey, who was charged with only the duty of looking after young children. +% +% \columnbreak\ForgetName[Frederick]{Douglass}\ForgetName[Betsey]{Bailey} +% |\Doug's| \Doug's early life is perhaps the most complete indictment of the slave system ever presented at the bar of public opinion. +% +% |\Doug\| \Doug\ was born in February, l8l7. His earliest memories centered around the private cabin of his grandmother, |\Bailey,| \Bailey, who was charged with only the duty of looking after young children. +% +% |\Doug\| \Doug\ rose to eminence by sheer force of character and talents that neither slavery nor caste proscription could crush. Circumstances could not prevent him from becoming a freeman and a leader. +% \end{multicols} +% \end{quote} +% \endgroup +% +% \subsection{How to Use the Manual} +% Topics in this manual that are more basic or frequent in use are toward the front. Topics that are more complex or less-used are toward the back. As topics get more advanced, various sections mutually inform each other. +% +% For reference, throughout this manual we show simplified and complete \emph{name patterns} in the margins (Section~\ref{sec:NamePatterns}). These patterns control name behavior. In the early pages of the manual we also show \emph{basic index entries} in the margins. +% +% \begin{center}\bfseries Special Signs\end{center} +% \noindent This manual uses signs and illustrative typesetting that are not built-in defaults of \textsf{nameauth}, but in some cases are implemented using it: +% \begin{itemize} +% \item[\ \ ]We often highlight {\NamesFormat{first}} and {\MainNameHook{later}} uses of names (Sections~\ref{sec:Formatting}, \ref{sec:NameControl}). % \item[\dag\ ]A dagger indicates ``non-native'' Eastern forms (Section~\ref{sec:Eastern}). % \item[\ddag\ ]A double dagger shows usage of the obsolete syntax (Section~\ref{sec:Obsolete}). % \item[\S\ ]A section mark denotes index entries of fictional names. % \item[\(\leftarrow\)]Major\Version{3.0} changes have package version numbers in the margin. % \item[\(\leftarrow\)]The\Warn{} ``dangerous bend'' shows where caution is needed. % \end{itemize} +% \vfill % -% \ifDoTikZ\begin{tcolorbox}[colback=white,colframe=nared,adjusted title={\hfil Disclaimer}]\else -% \begin{center}\large\bfseries Disclaimer\end{center}\fi -% \noindent Names are about real people. This manual mentions notable figures both living and deceased. All names herein are meant to be used respectfully, for teaching purposes only. At no time is any disrespect or bias intended. -% \ifDoTikZ\end{tcolorbox}\fi +% \begin{tcolorbox}[colback=white,colframe=nared,adjusted title={\hfil Thanks}] +% \small\noindent Thanks to \Name[Marc van]{Dongen}, \Name[Enrico]{Gregorio}, \Name[Philipp]{Stephani}, \Name[Heiko]{Oberdiek}, \Name[Uwe]{Lueck}, \Name[Dan]{Luecking} and \Name[Robert]{Schlicht} for assistance in early versions of this package. Thanks also to users for valuable feedback.\vfil +% \end{tcolorbox} % \newpage % % \subsection{Task Dashboard} % \label{sec:Dashboard} % % Here we link to sections by task in order to get things done quickly. Many sections have return links at their end that bring the reader back to this page. -% \ifDoTikZ -% \begin{tcolorbox}[colframe=naslate,adjusted title={\hfil Where do you want to go today?}]\centering -% \tcbox[equal height group=Z,on line,tikznode,colframe=nabrown,colback=white,adjusted title={\bfseries\sffamily\hfil Quick Start}]{Sections~\ref{sec:QuickStart}, \ref{sec:TradStart},\\ \ref{sec:SimpleStart}, \ref{sec:SelectOver}, \ref{sec:Obsolete},\\ \ref{sec:NamePatterns}, \ref{sec:ErrorProt}}\hfill -% \tcbox[equal height group=Z,on line,tikznode,colframe=nabrown,colback=white,adjusted title={\bfseries\sffamily\hfil Basics}]{Package options:\\ Section~\ref{sec:PkgOptions}}\hfill -% \tcbox[equal height group=Z,on line,tikznode,colframe=nabrown,colback=white,adjusted title={\bfseries\sffamily\hfil Basics}]{Name macros:\\ Sections~\ref{sec:Naming},\\ \ref{sec:FName}}\bigskip -% -% \tcbox[equal height group=Zi,on line,tikznode,colframe=nagreen,colback=white,adjusted title={\bfseries\sffamily\hfil Intermediate}]{Variant forms:\\Sections~\ref{sec:VarNames},\\\ref{sec:NameParticles}, \ref{sec:IndexXref}}\hfill -% \tcbox[equal height group=Zi,on line,tikznode,colframe=nagreen,colback=white,adjusted title={\bfseries\sffamily\hfil Intermediate}]{Avoid errors: Sec-\\tions~\ref{sec:Obsolete}, \ref{sec:NamePatterns}, \ref{sec:ErrorProt},\\ \ref{sec:NameParticles}, \ref{sec:Unicode}}\hfill -% \tcbox[equal height group=Zi,on line,tikznode,colframe=naviolet,colback=white,adjusted title={\bfseries\sffamily\hfil Language}]{Western names:\\ Sections~\ref{sec:Affix},\\ \ref{sec:LastFirst}}\bigskip -% -% \tcbox[equal height group=Zii,on line,tikznode,colframe=naviolet,colback=white,adjusted title={\bfseries\sffamily\hfil Language}]{Eastern names:\\ Sections~\ref{sec:Affix},\\ \ref{sec:Eastern}}\hfill -% \tcbox[equal height group=Zii,on line,tikznode,colframe=naviolet,colback=white,adjusted title={\bfseries\sffamily\hfil Language}]{Particles, medieval,\\ ancient names: Sec-\\ tions\,\ref{sec:NameParticles},\,\ref{sec:AltFormat},\,\ref{sec:Hooksiii}}\hfill -% \tcbox[equal height group=Zii,on line,tikznode,colframe=nataupe,colback=white,adjusted title={\bfseries\sffamily\hfil Index}]{Index entries\\ and control:\\ Section~\ref{sec:IndexControl}}\bigskip -% -% \tcbox[equal height group=Ziii,on line,tikznode,colframe=nataupe,colback=white,adjusted title={\bfseries\sffamily\hfil Index}]{\hbox to 0.385\textwidth{\ Index cross-refs, automatic\ }\\ sorting, and auto-info: Sec-\\ tions~\ref{sec:IndexXref}, \ref{sec:IndexSort}, \ref{sec:IndexTag}, \ref{sec:AKA}}\hfill -% \tcbox[equal height group=Ziii,on line,tikznode,colframe=nared,colback=white,adjusted title={\bfseries\sffamily\hfil Advanced}]{\hbox to 0.39\textwidth{Generally manage how names}\\ are typeset: Sections~\ref{sec:Formatting}, \ref{sec:AltFormat},\\ \ref{sec:NameControl}, \ref{sec:NameTests}, \ref{sec:Hooksi}\,--\,\ref{sec:Customize}}\bigskip % -% \tcbox[equal height group=Ziv,on line,tikznode,colframe=nared,colback=white,adjusted title={\bfseries\sffamily\hfil Advanced}]{\hbox to 0.385\textwidth{Generally manage names by}\\ using a name authority: Sec-\\ tions~\ref{sec:VarNames}, \ref{sec:Formatting}, \ref{sec:IndexControl}, \ref{sec:NameControl}}\hfill -% \tcbox[equal height group=Ziv,on line,tikznode,colframe=nared,colback=white,adjusted title={\bfseries\sffamily\hfil Advanced}]{Make complex elements\\\hbox to 0.39\textwidth{determined automatically by}\\ names: Sections \ref{sec:TextTags}, \ref{sec:NameTests}}\bigskip -% -% \tcbox[equal height group=Zv,on line,tikznode,colframe=nablue,colback=white,adjusted title={\bfseries\sffamily\hfil Application}]{Use \textsf{nameauth} with \textsf{beamer}\\\hbox to 0.385\textwidth{overlays to get correct name}\\ forms: Sections~\ref{sec:Formatting}, \ref{sec:NameDecisions},\\ \ref{sec:NameControl}, \ref{sec:NameTests}}\hfill -% \tcbox[equal height group=Zv,on line,tikznode,colframe=nablue,colback=white,adjusted title={\bfseries\sffamily\hfil Application}]{\hbox to 0.39\textwidth{History / game books, other}\\ complex layouts: Sections\\ \ref{sec:Formatting}, \ref{sec:IndexTag}, \ref{sec:TextTags}, \ref{sec:NameControl},\\ \ref{sec:NameTests}, \ref{sec:Hooksi}\,--\,\ref{sec:Hooksiii}}\smallskip +% \begin{tcolorbox}[colframe=naslate,adjusted title={\hfil Where do you want to go today?}]\centering +% \tcbox[equal height group=Z,on line,tikznode,colframe=nablue,colback=white,adjusted title={\bfseries\sffamily\hfil Quick Start}]{^^A +% Basic concepts: \ref{sec:QuickStart}\\ +% Macros: \ref{sec:TradStart}, \ref{sec:SimpleStart}, \ref{sec:SelectOver}\\ +% Various hints: \ref{sec:Hints}}^^A +% \hfill +% \tcbox[equal height group=Z,on line,tikznode,colframe=nablue,colback=white,adjusted title={\bfseries\sffamily\hfil Basics}]{^^A +% Package options: \ref{sec:PkgOptions}\\ +% Name macros: \ref{sec:Naming}, \ref{sec:FName}\\ +% Simple\,Variants\,(text/index): \ref{sec:VarNames}, \ref{sec:Indexing}}^^A +% \vspace{9pt} +% +% \tcbox[equal height group=Zi,on line,tikznode,colframe=nagreen,colback=white,adjusted title={\bfseries\sffamily\hfil Language}]{^^A +% Western names: \ref{sec:Affix}, \ref{sec:LastFirst}\\ +% Eastern names: \ref{sec:Affix}, \ref{sec:Eastern}\\ +% Particles: \ref{sec:NameParticles}, \ref{sec:AltFormat}, \ref{sec:Hooksiii}}^^A +% \hfill +% \tcbox[equal height group=Zi,on line,tikznode,colframe=nagreen,colback=white,adjusted title={\bfseries\sffamily\hfil Language}]{^^A +% Medieval/Ancient: \ref{sec:NameAncient}, \ref{sec:Hooksi}\\ +% ``Continental'' typesetting:\\ +% \ref{sec:AltFormat}, \ref{sec:AltBasic}, \ref{sec:AltAdvanced}, \ref{sec:Hooksiii}}^^A +% \vspace{9pt} +% +% \tcbox[equal height group=Zii,on line,tikznode,colframe=nataupe,colback=white,adjusted title={\bfseries\sffamily\hfil Index}]{^^A +% Page entries, index\\ +% \,control, \& xrefs: \ref{sec:GeneralIndex}\,}^^A +% \hfill +% \tcbox[equal height group=Zii,on line,tikznode,colframe=nataupe,colback=white,adjusted title={\bfseries\sffamily\hfil Index}]{^^A +% Setting up automatic sorting: \ref{sec:IndexSort}\\ +% Auto-add info to index entries: \ref{sec:IndexTag}}^^A +% \vspace{9pt} +% +% \tcbox[equal height group=Ziii,on line,tikznode,colframe=nabrown,colback=white,adjusted title={\bfseries\sffamily\hfil Intermediate}]{^^A +% Name info database: \ref{sec:TextTags}\\ +% Test for the presence of names:\\ +% \ref{sec:NameDecisions}, \ref{sec:NameControl}, \ref{sec:NameTests}}^^A +% \hfill +% \tcbox[equal height group=Ziii,on line,tikznode,colframe=nared,colback=white,adjusted title={\bfseries\sffamily\hfil Advanced}]{^^A +% \hbox{\ }Various discussions about\hbox{\ }\\ +% errors: \ref{sec:NameParticles}, \ref{sec:Warnings}, \ref{sec:Errors},\\ +% \ref{sec:Obsolete}, \ref{sec:NamePatterns}, \ref{sec:Unicode}}^^A +% \vspace{9pt} +% +% \tcbox[equal height group=Ziv,on line,tikznode,colframe=nared,colback=white,adjusted title={\bfseries\sffamily\hfil Advanced}]{^^A +% Formatting: \ref{sec:Formatting}, \ref{sec:AltFormat}, \ref{sec:AltBasic},\\ +% \ref{sec:AltAdvanced}, \ref{sec:Hooksi}, \ref{sec:Hooksii}, \ref{sec:Hooksiii}\\ +% Customizing: \ref{sec:Customize}}^^A +% \hfill +% \tcbox[equal height group=Ziv,on line,tikznode,colframe=nared,colback=white,adjusted title={\bfseries\sffamily\hfil Advanced}]{^^A +% Link names \& text to sequences\\ +% of time or ideas: \ref{sec:TextTags}, \ref{sec:NameTests}\\ +% (history/game books)}^^A +% \vspace{9pt} +% +% \tcbox[equal height group=Zv,on line,tikznode,colframe=nared,colback=white,adjusted title={\bfseries\sffamily\hfil Advanced}]{^^A +% Use different formats\\ +% to call out information: \ref{sec:TextTags},\\ +% \ \ref{sec:Formatting}, \ref{sec:AltFormat}, \ref{sec:NameTests}, +% \ref{sec:Hooksi}, \ref{sec:Hooksii},\ \ \ \\ +% \ref{sec:Hooksiii} (history/game books)}^^A +% \hfill +% \tcbox[equal height group=Zv,on line,tikznode,colframe=nared,colback=white,adjusted title={\bfseries\sffamily\hfil Advanced}]{^^A +% Use \textsf{nameauth} with \textsf{beamer}\\ +% overlays to get correct name\\ +% forms: Sections~\ref{sec:Formatting}, \ref{sec:NameDecisions},\\ +% \ref{sec:NameControl}, \ref{sec:NameTests}}^^A +% \vspace{4pt} +% +% \begin{tcolorbox}[colframe=nared,colback=white] +% \centering For building the \textsf{nameauth} package, see \texttt{README.md},\\ +% located with this manual, and Section~\ref{sec:TechNotes}. +% \end{tcolorbox} +% \vspace{-3pt} % \end{tcolorbox} -% \else -% \begin{center} -% \begin{tabularx}{0.9\textwidth}{@{}X|X|X@{}}\toprule -% &&\\ -% Concept overview: Sections~\ref{sec:QuickStart}, \ref{sec:TradStart}, \ref{sec:SimpleStart}, \ref{sec:SelectOver}, \ref{sec:Obsolete}, \ref{sec:NamePatterns}, \ref{sec:ErrorProt} & Package options: Section~\ref{sec:PkgOptions} & Basic macros: Section \ref{sec:Naming}, \ref{sec:FName}\\ -% &&\\\midrule -% &&\\ -% Variant forms: Sections~\ref{sec:VarNames}, \ref{sec:NameParticles}, \ref{sec:IndexXref} & Avoid errors: Sections~\ref{sec:Obsolete}, \ref{sec:NamePatterns}, \ref{sec:ErrorProt}, \ref{sec:NameParticles}, \ref{sec:Unicode} & Western names: Sections~\ref{sec:Affix}, \ref{sec:LastFirst}\\ -% &&\\\midrule -% &&\\ -% Eastern names: Sections~\ref{sec:Affix}, \ref{sec:Eastern} & Particles, medieval, ancient names: Sections~\ref{sec:NameParticles}, \ref{sec:AltFormat}, \ref{sec:Hooksiii} & Index entries and control: Section~\ref{sec:IndexControl}\\ -% &&\\\midrule -% &&\\ -% Index cross-refs, automatic sorting, and auto-info: Sections~\ref{sec:IndexXref}, \ref{sec:IndexSort}, \ref{sec:IndexTag}, \ref{sec:AKA} & Generally manage how names are typeset: Sections~\ref{sec:Formatting}, \ref{sec:AltFormat}, \ref{sec:NameControl}, \ref{sec:NameTests}, \ref{sec:Hooksi}\,--\,\ref{sec:Customize} & Generally manage names by using a name authority: Sections~\ref{sec:VarNames}, \ref{sec:Formatting}, \ref{sec:IndexControl}, \ref{sec:NameControl}\\ -% &&\\\midrule -% &&\\ -% Make complex elements determined automatically by names: Sections \ref{sec:TextTags}, \ref{sec:NameTests} & Use \textsf{nameauth} with \textsf{beamer} overlays to get correct name forms: Sections~\ref{sec:Formatting}, \ref{sec:NameDecisions}, \ref{sec:NameControl}, \ref{sec:NameTests} & History\,/\,game books, other complex layouts: Sections~\ref{sec:Formatting}, \ref{sec:IndexTag}, \ref{sec:TextTags}, \ref{sec:NameControl}, \ref{sec:NameTests}, \ref{sec:Hooksi}\,--\,\ref{sec:Hooksiii}\\ -% &&\\\bottomrule -% \end{tabularx} -% \end{center} -% \fi -% \newpage % -% \subsection{Basic Concepts} +% \subsection{Basic Name Concepts} % \label{sec:QuickStart} % % We encode names in macro arguments to address multiple naming systems. Required name elements are shown in \emph{black}; optional parts are in \emph{\color{nared}red}.\footnote{Compare [\hyperlink{Mulvany}{Mulvany}, 152--82] and the \textit{Chicago Manual of Style}.} -% The arguments appear in the order \meta{FNN} \meta{SNN} \meta{Affix} \meta{Alternate}: -% -% \ifDoTikZ -% \noindent\begin{tcolorbox}[colframe=naslate,adjusted title={Western Name}]\centering -% \tcbox[equal height group=A,on line,tikznode,colback=white,adjusted title={\bfseries\sffamily Forename(s):\\ \meta{FNN}}]{% -% Personal name(s):\\ -% \textit{baptismal name}\\ -% \textit{Christian name}\\ -% \textit{multiple names}\\ -% \textit{praenomen}\footnotemark\\ -% \hphantom{Family\,/\,clan name}} -% \tcbox[equal height group=A,on line,tikznode,colback=white,adjusted title={\bfseries\sffamily Surname(s):\\ \meta{SNN}}]{% -% Family name:\\ -% \textit{of father, mother}\\ -% \textit{ancestor, vocation}\\ -% \textit{origin, region}\\ -% \textit{nomen, cognomen}\\ -% \textit{patronym}\\ -% \vspace{-2ex}\hphantom{\textit{ancestor, vocation}}} -% \tcbox[equal height group=A,on line,tikznode,colback=white,colframe=nared,adjusted title={\bfseries\sffamily Descriptor:\\ \meta{Affix}}]{% -% Sobriquet\,/\,title:\\ -% \textit{Sr., Jr., III\dots}\\ -% \textit{notable attribute}\\ -% \textit{origin, region}} -% \tcbox[tikznode,colback=white,colframe=nared,adjusted title={\bfseries\sffamily Alternate Name(s): \meta{Alternate}}]{\hbox to 0.913\textwidth{\hfil In the body text, not the index, \meta{Alternate} swaps with \meta{FNN}\hfil}\\ \hbox to 0.913\textwidth{\hfil for Western names and \meta{Affix} for all other name categories.\hfil}} -% \end{tcolorbox}\medskip -% \begin{tcolorbox}[colframe=naslate,adjusted title={Eastern Name}]\centering -% \tcbox[equal height group=B,on line,tikznode,colback=white,adjusted title={\bfseries\sffamily Family name:\\ \meta{SNN}}]{Family\,/\,clan name} -% \tcbox[equal height group=B,on line,tikznode,colback=white,adjusted title={\bfseries\sffamily Personal name:\\ \meta{Affix}}]{Seldom multiple\\ -% names; multi-\\ -% character okay.\\ -% \vspace{-2ex}\hphantom{\textit{ancestor, vocation}}} -% \tcbox[equal height group=B,on line,tikznode,colback=white,colframe=nared,adjusted title={\bfseries\sffamily Descriptor:\\ \meta{Alternate}}]{% -% Title, etc.\\ -% (old syntax for\\ -% personal names)\\ -% \vspace{-2ex}\hphantom{Sobriquet\,/\,title:}} -% \end{tcolorbox}\medskip -% \begin{tcolorbox}[colframe=naslate,adjusted title={Ancient name}]\centering -% \tcbox[equal height group=C,on line,tikznode,colback=white,adjusted title={\bfseries\sffamily Personal name:\\ \meta{SNN}}]{Given name(s)\\ -% \hphantom{Family\,/\,clan name}} -% \tcbox[equal height group=C,on line,tikznode,colback=white,colframe=nared,adjusted title={\bfseries\sffamily Descriptor:\\ \meta{Affix}}]{% -% Sobriquet\,/\,title:\\ -% \textit{Sr., Jr., III\dots}\\ -% \textit{notable attribute}\\ -% \textit{origin, region}\\ -% \textit{patronym}\\ -% \vspace{-2ex}\hphantom{\textit{ancestor, vocation}}} -% \tcbox[equal height group=C,on line,tikznode,colback=white,colframe=nared,adjusted title={\bfseries\sffamily Descriptor:\\ \meta{Alternate}}]{% -% Alternate name\\ -% (old syntax for\\ -% titles, etc.)\\ -% \hphantom{Sobriquet\,/\,title:}} +% The arguments appear in the order \meta{FNN} \meta{SNN} \meta{Affix} \meta{Alternate}. Section~\ref{sec:Obsolete} shows the obsolete syntax, which is usable but discouraged. Basic syntactic forms are: +% +% \noindent\begin{tcolorbox}[colframe=naslate,adjusted title={Western Name and ``Non-native'' Eastern Name}] +% \tcbox[equal height group=A,on line,tikznode,colback=white,adjusted title={\bfseries\sffamily Forename(s):\\ \meta{FNN}}]{% +% Personal name(s):\\ +% \textit{baptismal name}\\ +% \textit{Christian name}\\ +% \textit{multiple names}\\ +% \textit{praenomen}\footnotemark\\ +% \hphantom{Family/clan name}}\hfill +% \tcbox[equal height group=A,on line,tikznode,colback=white,adjusted title={\bfseries\sffamily Surname(s):\\ \meta{SNN}}]{% +% Family name:\\ +% \textit{of father, mother}\\ +% \textit{ancestor, vocation}\\ +% \textit{origin, region}\\ +% \textit{nomen, cognomen}\\ +% \textit{patronym}\\ +% \vspace{-2ex}\hphantom{\textit{ancestor, vocation}}}\hfill +% \tcbox[equal height group=A,on line,tikznode,colback=white,colframe=nared,adjusted title={\bfseries\sffamily Descriptor:\\ \meta{Affix}}]{% +% Sobriquet/title:\\ +% \textit{Sr., Jr., III\dots}\\ +% \textit{notable attribute}\\ +% \textit{origin, region}} +% +% \begin{tcolorbox}[colback=white,colframe=nared,adjusted title={\bfseries\sffamily Alternate Name(s): \meta{Alternate}}] +% \centering In the body text, not the index, \meta{Alternate} swaps with \meta{FNN}\\ +% for Western names and \meta{Affix} for all other name categories. +% \end{tcolorbox} % \end{tcolorbox} -% \else -% \begin{enumerate}[noitemsep] -% \item Western Name:\medskip\\ -% \begin{tabular}{p{0.28\textwidth}p{0.28\textwidth}p{0.28\textwidth}} -% \strut\textbf{Forename(s)} & -% \strut\textbf{Surname(s)} & -% \strut\textbf{\color{nared}Descriptor}\smallskip\\ -% \strut Personal name(s): & -% \strut Family name: & -% \strut Sobriquet\,/\,title:\smallskip\\ -% \textit{baptismal name}\newline -% \textit{Christian name}\newline -% \textit{multiple names}\newline -% \textit{praenomen}\footnotemark & -% \textit{of father, mother}\newline -% \textit{ancestor, vocation}\newline -% \textit{origin, region}\newline -% \textit{nomen, cognomen}\newline -% \textit{patronym} & -% \textit{Sr., Jr., III\dots}\newline -% \textit{notable attribute}\newline -% \textit{origin, region}\medskip\\ -% \end{tabular}\\ -% -% \noindent \textbf{Alternate Name(s):} In the body text, not the index, \meta{Alternate} swaps with \meta{FNN} for Western names and \meta{Affix} for all other name categories.\medskip\\ -% \item Eastern Name:\medskip\\ -% \begin{tabular}{p{0.28\textwidth}p{0.28\textwidth}p{0.28\textwidth}} -% \textbf{Family name} & -% \textbf{Given name} & -% \textbf{\color{nared}Descriptor}\smallskip\\ -% Family\,/\,clan name & -% \textit{Seldom multiple}\newline -% \textit{names; multi-}\newline -% \textit{character okay.} & -% Title, etc.\newline -% \textit{(old syntax for}\newline -% \textit{personal names)}\medskip\\ -% \end{tabular} -% -% \item Ancient name:\medskip\\ -% \begin{tabular}{p{0.28\textwidth}p{0.28\textwidth}p{0.28\textwidth}} -% \textbf{Personal name} & -% \textbf{\color{nared}Descriptor} & -% \textbf{\color{nared}Alt. Desc.}\smallskip\\ -% Given name(s): & -% Sobriquet\,/\,title: & -% Alternate name:\smallskip\\ -% & -% \textit{Sr., Jr., III\dots}\newline -% \textit{notable attribute}\newline -% \textit{origin, region}\newline -% \textit{patronym} & -% \textit{(old syntax for}\newline -% \textit{titles, etc.)}\\ -% \end{tabular} -% \end{enumerate}\fi -%\begingroup -%\newif\ifSkipGens -%\newif\ifNoGens -%\newif\ifSkipAgnomen -%\newif\ifNoAgnomen -%\newcommand*\SCIPi{\unless\ifNoGens Publius Cornelius\else Publius\fi} -%\newcommand*\SCIPii{\unless\ifNoAgnomen Scipio Africanus\else Scipio\fi} -%\newcommand*\ScipioOnly{\SkipAgnomentrue\Scipio} -%\renewcommand*\NamesFormat[1]%^^A -% {\sffamily\color{nablue}\ifSkipGens\NoGenstrue\fi\ifSkipAgnomen\NoAgnomentrue\fi#1%^^A -% \global\SkipGensfalse\global\SkipAgnomenfalse} -%\renewcommand*\MainNameHook[1]%^^A -% {\sffamily\color{nabrown}\ifSkipGens\NoGenstrue\fi\ifSkipAgnomen\NoAgnomentrue\fi#1%^^A -% \global\SkipGensfalse\global\SkipAgnomenfalse} -% \footnotetext{How one handles Roman names depends on index entry form; some possible suggestions are given above. Explained on page~\pageref{page:Sobriquets} and following, we have a name \ScipioOnly\ that can be \SkipGenstrue\Scipio\ or just \SkipGenstrue\ScipioOnly, using macro expansion.} -% \endgroup +% +% \begin{tcolorbox}[colframe=naslate,adjusted title={``Native'' Eastern Name}]\centering +% \tcbox[equal height group=B,on line,tikznode,colback=white,adjusted title={\bfseries\sffamily Family name:\\ \meta{SNN}}]{Family/clan name}\hfill +% \tcbox[equal height group=B,on line,tikznode,colback=white,adjusted title={\bfseries\sffamily Personal name:\\ \meta{Affix}}]{Few multiple\\ +% names; multi-\\ +% character okay.\\ +% \vspace{-2ex}\hphantom{\textit{ancestor, vocation}}}\hfill +% \tcbox[equal height group=B,on line,tikznode,colback=white,colframe=nared,adjusted title={\bfseries\sffamily Descriptor:\\ \meta{Alternate}}]{% +% Replaces \meta{Affix}\\ +% (new); personal\\ +% name (obsolete)\\ +% \vspace{-2ex}\hphantom{Sobriquet/title:}} +% \end{tcolorbox} +% +% \begin{tcolorbox}[colframe=naslate,adjusted title={Royal/Medieval/Ancient Name}]\centering +% \tcbox[equal height group=C,on line,tikznode,colback=white,adjusted title={\bfseries\sffamily Personal name:\\ \meta{SNN}}]{Given name(s)\\ +% \hphantom{Family/clan name}}\hfill +% \tcbox[equal height group=C,on line,tikznode,colback=white,colframe=nared,adjusted title={\bfseries\sffamily Descriptor:\\ \meta{Affix}}]{% +% Sobriquet/title:\\ +% \textit{Sr., Jr., III\dots}\\ +% \textit{notable attribute}\\ +% \textit{origin, region}\\ +% \textit{patronym}\\ +% \vspace{-2ex}\hphantom{\textit{ancestor, vocation}}}\hfill +% \tcbox[equal height group=C,on line,tikznode,colback=white,colframe=nared,adjusted title={\bfseries\sffamily Descriptor:\\ \meta{Alternate}}]{% +% Alternate name\\ +% Replaces \meta{Affix}\\ +% (new); titles,\\ +% etc. (obsolete)\\ +% \hphantom{Sobriquet/title:}} +% \end{tcolorbox} +% +% \footnotetext{How one handles Roman names depends on index entry form; some possible suggestions are given above. See more on page~\pageref{page:Romani} and following.} % \newpage % -% \subsubsection{Traditional Interface} +% \subsection{Basic Interface} % \label{sec:TradStart} % -% Mandatory arguments are shown in \emph{black}, with optional elements in \emph{\color{nared}red}. If the required argument \meta{SNN} expands to the empty string, \textsf{nameauth} will generate a package error. Extra spaces around each argument are stripped (Section~\ref{sec:ErrorProt}). The argument patterns shown here are used in many \textsf{nameauth} macros. -% -% \bgroup\ifDoTikZ -% \begin{tcolorbox}[colframe=naslate,adjusted title={Western Names}]\centering +% Using \textsf{nameauth}\Illus{} allows one to use names according to one's culture of origin. The name arguments in this section are used in many \textsf{nameauth} macros. +% \begin{itemize} +% \item The name form's required arguments are shown below in \emph{black}, with optional elements shown in \emph{\color{nared}red}. +% \item If the required argument \meta{SNN} expands to the empty string, \textsf{nameauth} will generate a package error. +% \item Extra spaces around each argument are stripped. +% \item Always include all name arguments to have consistent index entries. +% \item \cmd{\Name} prints first uses of names long, then short thereafter. \cmd{\Name*} always creates a long form. \cmd{\FName} prints a short form in later uses. +% \end{itemize}\leavevmode +% +% \begin{tcolorbox}[colframe=naslate,adjusted title={\large\hfil Western Name}]\centering % \begin{tabular}{l@{ }c@{ }c@{ }c} % & \small Required & \small Required & \small Optional,\\ % & \small forename(s) & \small surname(s), & \small in text only \\ % & & \small optional \meta{Affix}\smallskip\\ -% \tcbox[equal height group=D,colback=white,tikznode,left=1mm,right=1mm,valign=center]{\bfseries\strut \hbox{\cmd{\Name}\texttt{\space}}\\ \strut \cmd{\Name*}\\ \strut \cmd{\FName}} & +% \tcbox[equal height group=D,colback=white,tikznode,left=1mm,right=1mm,valign=center]{\bfseries\strut \hbox{\cmd{\Name}\texttt{ }}\\ \strut \cmd{\Name*}\\ \strut \cmd{\FName}} & % \tcbox[equal height group=D,colback=white,tikznode,left=1mm,right=1mm,valign=center]{\bfseries\oarg{FNN}} & % \tcbox[equal height group=D,colback=white,tikznode,left=1mm,right=1mm,valign=center]{\bfseries\marg{SNN\color{nared}, Affix}} & % \tcbox[equal height group=D,colback=white,tikznode,left=1mm,right=1mm,valign=center]{\bfseries\oarg{\color{nared}Alternate}} % \end{tabular} % % Add braces \texttt{\bfseries\{\,\}} after {\bfseries\marg{SNN\color{nared}, Affix}} if other text in brackets \texttt{\bfseries[\,]} follows. -% \end{tcolorbox} -% \else -% \bigskip\noindent{\bfseries Western Names} -% -% \bigskip\begin{tabular}{lccc} -% & \small Required & \small Required surname(s), & \small Optional,\\ -% & \small forename(s) & \small optional \meta{Affix} & \small in text only\smallskip\\ -% \cmd{\Name}\\ -% \cmd{\Name*} & \bfseries\oarg{FNN} & \bfseries\marg{SNN\color{nared}, Affix} & \bfseries\oarg{\color{nared}Alternate}\\ -% \cmd{\FName} -% \end{tabular}\\ +% \end{tcolorbox}\medskip % -% Add braces \texttt{\bfseries\{\,\}} after {\bfseries\marg{SNN\color{nared}, Affix}} if other text in brackets \texttt{\bfseries[\,]} follows. -% \fi\egroup -% -% \begin{center}\bfseries Examples\end{center} -% -% \noindent Western names require the \meta{FNN} argument to be present. One always includes all arguments for consistent index entries. The simplified interface (Section~\ref{sec:SimpleStart}) cuts down the amount of typing in many cases.\medskip -% -% \bgroup\MyStretch\noindent% -% |\Name [George]{Washington}|\dotfill\Name[George]{Washington}\\ -% |\Name*[George]{Washington}|\dotfill\Name*[George]{Washington}\\ -% |\Name [George]{Washington}|\dotfill\Name[George]{Washington}\\ -% |\FName[George]{Washington}|\dotfill\FName[George]{Washington}\smallskip\\ -% |\Name [George S.]{Patton, Jr.}|\dotfill\Name[George S.]{Patton, Jr.}\\ -% |\Name*[George S.]{Patton, Jr.}|\dotfill\Name*[George S.]{Patton, Jr.}\\ -% |\Name [George S.]{Patton, Jr.}|\dotfill\Name[George S.]{Patton, Jr.}\\ -% |\FName[George S.]{Patton, Jr.}|\dotfill\FName[George S.]{Patton, Jr.}\egroup\medskip -% -% The \meta{Alternate} argument will swap with \meta{FNN} in the text, not in the index or the name pattern (Section~\ref{sec:NamePatterns}). To see alternate names, one must use a macro that shows forenames (first use, \cmd{\Name*}, and \cmd{\FName}). Western names require a comma to delimit affixes (Section~\ref{sec:Affix}). Below we see alternate names:\medskip -% -% \bgroup\MyStretch\noindent% -% |\DropAffix\Name*[George S.]{Patton, Jr.}[George]|\dotfill\DropAffix\Name*[George S.]{Patton, Jr.}[George]\smallskip\\ -% |\Name [John David]{Rockefeller, IV}|\dotfill\Name[John David]{Rockefeller, IV}\\ -% |\Name*[John David]{Rockefeller, IV}[Jay]|\dotfill\Name*[John David]{Rockefeller, IV}[Jay]\\ -% |\DropAffix\Name*[John David]{Rockefeller, IV}[Jay]|\dotfill\DropAffix\Name*[John David]{Rockefeller, IV}[Jay]\\ -% |\Name [John David]{Rockefeller, IV}[Jay]|\dotfill\Name[John David]{Rockefeller, IV}[Jay]\smallskip\\ -% |\Name [Clive Staples]{Lewis}|\dotfill\Name[Clive Staples]{Lewis}\\ -% |\Name*[Clive Staples]{Lewis}[C.S.]|\dotfill\Name*[Clive Staples]{Lewis}[C.S.]\\ -% |\FName[Clive Staples]{Lewis}[Jack]|\dotfill\FName[Clive Staples]{Lewis}[Jack]\egroup\medskip -% -% In addition to alternate forenames, one also can display alternate surnames, but that uses several different approaches (Sections~\ref{sec:VarNames}, \ref{sec:NameParticles}, \ref{sec:AltAdvanced}, \ref{sec:Hooksiii}). +% \noindent +% Within \textsf{nameauth}, Western names have distinct features: +% \begin{itemize} +% \item Western names must use the first optional \meta{FNN} argument. +% \item They require a comma to delimit any affixes (Section~\ref{sec:Affix}). +% \item Western index entries have two general forms: \meta{SNN}, \meta{FNN} and \meta{SNN}, \meta{FNN}, \meta{Affix}. +% \item They do not share control patterns (Section~\ref{sec:NamePatterns}) and index entry forms with non-Western names. +% \end{itemize}\smallskip +% +% \bgroup\MyStretch\noindent +% |\Name [George]{Washington}|\SPatInfo{\ShowPattern[George]{Washington}\break\ShowPattern[George S.]{Patton, Jr.}}\dotfill \Name [George]{Washington}\\ +% |\Name*[George]{Washington}|\dotfill \Name*[George]{Washington}\\ +% |\Name [George]{Washington}|\dotfill \Name [George]{Washington}\\ +% |\FName[George]{Washington}|\IdxInfo{\ShowIdxPageref*[George]{Washington}\break\ShowIdxPageref*[George S.]{Patton, Jr.}}\dotfill \FName[George]{Washington}\medskip\\ +% |\Name [George S.]{Patton, Jr.}|\dotfill \Name [George S.]{Patton, Jr.}\\ +% |\Name*[George S.]{Patton, Jr.}|\dotfill \Name*[George S.]{Patton, Jr.}\\ +% |\Name [George S.]{Patton, Jr.}|\dotfill \Name [George S.]{Patton, Jr.}\\ +% |\FName[George S.]{Patton, Jr.}|\dotfill \FName[George S.]{Patton, Jr.}^^A +% \egroup\medskip +% +% Below, \meta{Alternate} swaps with \meta{FNN} only in the text. Alternate forenames print in the text with a first use, \cmd{\Name*}, or \cmd{\FName}. Use \cmd{\DropAffix}, a prefix macro (Section~\ref{sec:SelectOver}), to drop affixes in long name forms, but only in the text.\medskip % \newpage % -% \bgroup\ifDoTikZ -% \begin{tcolorbox}[colframe=naslate,adjusted title={``Non-native'' Eastern Names, Western Index Entry}]\centering +% \bgroup\MyStretch\noindent +% |\Name*[George S.]{Patton, Jr.}|\SPatInfo{\ShowPattern[George S.]{Patton, Jr.}\break \ShowPattern[J.D.]{Rockefeller, IV}\break \ShowPattern[Clive Staples]{Lewis}}\dotfill \Name*[George S.]{Patton, Jr.}\\ +% |\DropAffix\Name*[George S.]{Patton, Jr.}[George]|\dotfill \DropAffix\Name*[George S.]{Patton, Jr.}[George]\medskip\\ +% |\Name [J.D.]{Rockefeller, IV}|\dotfill \Name [J.D.]{Rockefeller, IV}\\ +% |\Name*[J.D.]{Rockefeller, IV}[John David]|\dotfill \Name*[J.D.]{Rockefeller, IV}[John David]\\ +% \vspace{-2ex}\IdxInfo{\ShowIdxPageref*[George S.]{Patton, Jr.}\break \ShowIdxPageref*[J.D.]{Rockefeller, IV}\break \ShowIdxPageref*[Clive Staples]{Lewis}}\vspace{2ex}|\DropAffix\Name*[J.D.]{Rockefeller, IV}[Jay]|\dotfill \DropAffix\Name*[J.D.]{Rockefeller, IV}[Jay]\\ +% |\Name [J.D.]{Rockefeller, IV}[Jay]|\dotfill \Name [J.D.]{Rockefeller, IV}[Jay]\medskip\\ +% |\Name [Clive Staples]{Lewis}|\dotfill \Name [Clive Staples]{Lewis}\\ +% |\Name*[Clive Staples]{Lewis}[C.S.]|\dotfill \Name*[Clive Staples]{Lewis}[C.S.]\\ +% |\FName[Clive Staples]{Lewis}[Jack]|\dotfill \FName[Clive Staples]{Lewis}[Jack]^^A +% \egroup\medskip +% +% Use the first name for sorting names instead of the initials, as with \DropAffix\Name*[J.D.]{Rockefeller, IV}: |\PretagName[J.D.]{Rockefeller, IV}{Rockefeller, John D 4}| (Section~\ref{sec:IndexSort}). +% For alternate surnames see Sections~\ref{sec:VarNames}, \ref{sec:NameAncient}, \ref{sec:AltAdvanced}, \ref{sec:Hooksiii}. +% \medskip +% +% \begin{tcolorbox}[colframe=naslate,adjusted title={\large\hfil ``Non-native'' Eastern Name}]\centering % \begin{tabular}{l@{ }c@{ }c@{ }c} % & \small Required & \small Required & \small Optional,\\ % & \small forename(s) & \small surname(s), & \small in text only \\ % & & \small no \meta{Affix}\smallskip\\ -% \tcbox[equal height group=D,colback=white,tikznode,left=1mm,right=1mm,valign=center]{\bfseries\strut \hbox{\cmd{\Name}\texttt{\space}}\\ \strut \cmd{\Name*}\\ \strut \cmd{\FName}} & +% \tcbox[equal height group=D,colback=white,tikznode,left=1mm,right=1mm,valign=center]{\bfseries\strut \hbox{\cmd{\Name}\texttt{ }}\\ \strut \cmd{\Name*}\\ \strut \cmd{\FName}} & % \tcbox[equal height group=D,colback=white,tikznode,left=1mm,right=1mm,valign=center]{\bfseries\oarg{FNN}} & % \tcbox[equal height group=D,colback=white,tikznode,left=1mm,right=1mm,valign=center]{\bfseries\marg{SNN}} & % \tcbox[equal height group=D,colback=white,tikznode,left=1mm,right=1mm,valign=center]{\bfseries\oarg{\color{nared}Alternate}} % \end{tabular} % % Add braces \texttt{\bfseries\{\,\}} after {\bfseries\marg{SNN}} if other text in brackets \texttt{\bfseries[\,]} follows. -% \end{tcolorbox} -% \else -% \bigskip\noindent{\bfseries ``Non-native'' Eastern Names, Western Index Entry} -% -% \bigskip\begin{tabular}{lccc} -% & \small Required & \small Required surname(s), & \small Optional,\\ -% & \small forename(s) & \small no \meta{Affix} & \small in text only\smallskip\\ -% \cmd{\Name}\\ -% \cmd{\Name*} & \bfseries\oarg{FNN} & \bfseries\marg{SNN} & \bfseries\oarg{\color{nared}Alternate}\\ -% \cmd{\FName} -% \end{tabular}\\ -% -% Add braces \texttt{\bfseries\{\,\}} after {\bfseries\marg{SNN}} if other text in brackets \texttt{\bfseries[\,]} follows. -% \fi\egroup -% -% -% \begin{center}\bfseries Examples\end{center} -% -% \noindent Below we start with ``regular'' Western name forms:\medskip -% -% \bgroup\noindent\MyStretch|\Name[Hideyo]{Noguchi}|\dotfill\Name[Hideyo]{Noguchi}\\ -% |\Name*[Hideyo]{Noguchi}[Doctor]|\dotfill\Name*[Hideyo]{Noguchi}[Doctor]\\ -% |\Name[Frenec]{Molnár}|\dotfill\Name[Frenec]{Molnár}\egroup\medskip -% -% To turn them into ``non-native'' Eastern names or proper Hungarian names [\hyperlink{Mulvany}{Mulvany}, 166] we use the reversing macros and leave the \meta{Alternate} argument empty (Section~\ref{sec:Eastern}). Index entries are in Western style: \meta{SNN}, \meta{FNN}:\medskip +% \end{tcolorbox}\medskip % -% \bgroup\MyStretch\noindent|\CapName\RevName\Name*[Hideyo]{Noguchi}|\dotfill\CapName\RevName\Name*[Hideyo]{Noguchi}\dag\\ -% |\CapName\RevName\Name*[Hideyo]{Noguchi}[Sensei]|\dotfill\CapName\RevName\Name*[Hideyo]{Noguchi}[Sensei]\dag\\ -% |\RevName\Name*[Frenec]{Molnár}|\dotfill\RevName\Name*[Frenec]{Molnár}\dag\egroup\medskip -% -% Reversed Western forms do not work with the older syntax (Section~\ref{sec:Obsolete}) and \emph{they do not share name control sequences and index entries} with ``native'' Eastern names and ancient name forms (Section~\ref{sec:NamePatterns}). +% \noindent +% ``Non-native'' Eastern names (Section~\ref{sec:Eastern}) have these features: +% \begin{itemize} +% \item They must use the first optional \meta{FNN} argument. +% \item They cannot use affixes; one would get \meta{FNN} \meta{Affix} \meta{SNN}. +% \item Index entries have the Western form with no affix: \meta{SNN}, \meta{FNN}. +% \item They do not share control patterns and index entry forms with non-Western names. +% \item They do not work with the obsolete syntax (Section~\ref{sec:Obsolete}). +% \end{itemize} +% % Below we start with Western name forms:\medskip +% +% \bgroup\noindent\MyStretch +% |\Name [Hideyo]{Noguchi}|\SPatInfo{\ShowPattern[Hideyo]{Noguchi}\break\ShowPattern[Frenec]{Molnár}}\dotfill \Name [Hideyo]{Noguchi}\hbox to 0.45em{\hfill}\\ +% |\Name*[Hideyo]{Noguchi}[Doctor]|\dotfill \Name*[Hideyo]{Noguchi}[Doctor]\hbox to 0.45em{\hfill}\\ +% |\Name [Frenec]{Molnár}|\dotfill \Name [Frenec]{Molnár}\footnote{With \texttt{pdflatex} and \texttt{latex}, in \texttt{\ShowPattern[Frenec]{Molnár}} the glyphs \texttt{Ãą} correspond to \cmd{\IeC\{\textbackslash\textquotesingle a\}}.}^^A +% \egroup\medskip +% +% \vspace{1.5ex}\IdxInfo{\ShowIdxPageref*[Hideyo]{Noguchi}\break\ShowIdxPageref*[Frenec]{Molnár}}\vspace{-1.5ex}\noindent We use the prefix macros \cmd{\RevName} and optionally \cmd{\CapName} (Section~\ref{sec:SelectOver}) to print an Eastern or Hungarian name order in the text [\hyperlink{Mulvany}{Mulvany}, 166]. We see above that these macros work in context, not arbitrarily:\medskip +% +% \bgroup\vspace{2.4ex}\Info{Same name patterns and\break index entries as above.}\vspace{-2.4ex}\MyStretch\noindent +% |\CapName\RevName\Name*[Hideyo]{Noguchi}[Sensei]|\dotfill \CapName\RevName\Name*[Hideyo]{Noguchi}[Sensei]\dag\\ +% |\CapName\RevName\Name [Hideyo]{Noguchi}[Sensei]|\dotfill \CapName\RevName\Name [Hideyo]{Noguchi}[Sensei]\dag\\ +% |\RevName\Name*[Frenec]{Molnár}|\dotfill \RevName\Name*[Frenec]{Molnár}\dag\\ +% |\RevName\Name [Frenec]{Molnár}|\dotfill \RevName\Name [Frenec]{Molnár}\dag^^A +% \egroup +% \newpage % -% \bgroup\ifDoTikZ -% \begin{tcolorbox}[colframe=naslate,adjusted title={\bfseries ``Native'' Eastern Names in the Text, Eastern Index Entry}]\centering +% \begin{tcolorbox}[colframe=naslate,adjusted title={\large\hfil ``Native'' Eastern Name}]\centering % \begin{tabular}{l@{ }c@{ }c} % & \small Required surname & \small Optional,\\ % & \small and forename & \small in text only\smallskip\\ -% \tcbox[equal height group=D,colback=white,tikznode,left=1mm,right=1mm,valign=center]{\bfseries\strut \hbox{\cmd{\Name}\texttt{\space}}\\ \strut \cmd{\Name*}\\ \strut \cmd{\FName}} & +% \tcbox[equal height group=D,colback=white,tikznode,left=1mm,right=1mm,valign=center]{\bfseries\strut \hbox{\cmd{\Name}\texttt{ }}\\ \strut \cmd{\Name*}\\ \strut \cmd{\FName}} & % \tcbox[equal height group=D,colback=white,tikznode,left=1mm,right=1mm,valign=center]{\bfseries\marg{SNN, Affix}} & % \tcbox[equal height group=D,colback=white,tikznode,left=1mm,right=1mm,valign=center]{\bfseries\oarg{\color{nared}Alternate}} % \end{tabular} % % Add braces \texttt{\bfseries\{\,\}} after {\bfseries\marg{SNN, Affix}} if other text in brackets \texttt{\bfseries[\,]} follows. -% \end{tcolorbox} -% \else -% \bigskip\noindent{\bfseries ``Native'' Eastern Names in the Text, Eastern Index Entry} +% \end{tcolorbox}\medskip % -% \bigskip\begin{tabular}{lcc} -% & \small Required Surname & \small Optional,\\ -% & \small and forename & \small in text only\smallskip\\ -% \cmd{\Name}\\ -% \cmd{\Name*} & \bfseries\marg{SNN, Affix} & \bfseries\oarg{\color{nared}Alternate}\\ -% \cmd{\FName} -% \end{tabular}\\ +% \noindent +% These features denote ``native'' Eastern names in \textsf{nameauth}: +% \begin{itemize} +% \item They must \emph{leave empty} the \meta{FNN} argument. +% \item They use instead the \meta{SNN, Affix} arguments. +% \item Their index entries take the non-Western form: \meta{SNN Affix}. +% \item They do not share control patterns and index entry forms with both Western names and ``non-native'' Eastern names. +% \end{itemize} % -% Add braces \texttt{\bfseries\{\,\}} after {\bfseries\marg{SNN, Affix}} if text in brackets \texttt{\bfseries[\,]} follows. -% \fi\egroup +% The basic forms of ``native'' Eastern names are shown below. Notice that the macro \cmd{\FName} does not show the personal name by default. This design choice helps to prevent one from naively causing offense:\medskip % -% \begin{center}\bfseries Examples\end{center} +% \bgroup\MyStretch\noindent +% \SPatInfo{\ShowPattern{Miyazaki, Hayao}}|\Name {Miyazaki, Hayao}|\dotfill \Name {Miyazaki, Hayao}\\ +% |\Name {Miyazaki, Hayao}|\dotfill \Name {Miyazaki, Hayao}\\ +% \IdxInfo{\ShowIdxPageref*{Miyazaki, Hayao}}|\FName{Miyazaki, Hayao}|\dotfill \FName{Miyazaki, Hayao}^^A +% \egroup\medskip % -% \noindent The comma-delimited required argument, \meta{SNN, Affix}, is the key to non-Western names, which always take the form \meta{SNN Affix} in the index. See Section~\ref{sec:Eastern}. ``Native'' Eastern names have Eastern name order from the start and \emph{they do not share name control sequences and index entries} with Western names (Section~\ref{sec:NamePatterns}). They can be reversed to have Western name order in the body text. -% \newpage +% If ``Native'' Eastern names are reversed, they will have Western name order in the text, but \emph{they will retain Eastern-form index entries.} % -% Except\Version{3.0} for mononyms, non-Western forms also can have alternate names. This is incompatible with the older syntax (see Section~\ref{sec:Obsolete}). Unless the index must have Western-style entries, ``native'' forms are best for Eastern names:\medskip +% One must use the prefix macro \cmd{\ForceFN} (Section~\ref{sec:SelectOver}) with \cmd{\FName} to get a personal name. \meta{Alternate} swaps with \meta{FNN} (in long forms and in short forms using \cmd{\ForceFN}) in the text only. \meta{Alternate} does not work with the obsolete syntax (Section~\ref{sec:Obsolete}):\medskip % -% \bgroup\MyStretch\noindent|\Name{Yamamoto, Isoroku}|\dotfill\Name{Yamamoto, Isoroku}\\ -% |\Name{Yamamoto, Isoroku}|\dotfill\Name{Yamamoto, Isoroku}\\ -% |\RevName\Name*{Yamamoto, Isoroku}[Admiral]|\dotfill\RevName\Name*{Yamamoto, Isoroku}[Admiral]\smallskip\\ -% |\Name{Miyazaki, Hayao}|\dotfill\Name{Miyazaki, Hayao}\\ -% |\Name*{Miyazaki, Hayao}[Sensei]|\dotfill\Name*{Miyazaki, Hayao}[Sensei]\\ -% |\RevName\Name*{Miyazaki, Hayao}[Mr.]|\dotfill\RevName\Name*{Miyazaki, Hayao}[Mr.]\egroup\medskip +% \bgroup\vspace{2.4ex}\Info{Same name patterns and\break index entries as above.}\vspace{-2.4ex}\MyStretch\noindent +% |\ForceFN\FName{Miyazaki, Hayao}|\dotfill \ForceFN\FName{Miyazaki, Hayao}\\ +% |\CapName\Name*{Miyazaki, Hayao}[Sensei]|\dotfill \CapName\Name*{Miyazaki, Hayao}[Sensei]\\ +% |\ForceFN\FName{Miyazaki, Hayao}[Sensei]|\dotfill \ForceFN\FName{Miyazaki, Hayao}[Sensei]\\ +% |\RevName\Name*{Miyazaki, Hayao}[Mr.]|\dotfill \RevName\Name*{Miyazaki, Hayao}[Mr.]^^A +% \egroup\medskip +% +% ``Native'' Eastern names have the same kind of macro parameters as do royal, medieval, and ancient names from Europe and the Near East (below). From the standpoint of how the macros work, one can identify ``non-western'' names with the form \meta{SNN, Affix}. +% +% Yet one should not confuse similarity in form with similarity in what the names themselves mean. Even though the syntactic form of non-Western names works the same, that form has different meanings in different contexts. For one context, \meta{SNN, Affix} refers to a family name and a personal name. For another context, \meta{SNN, Affix} refers to a person's name and any affixes thereto. +% \newpage % -% \bgroup\ifDoTikZ -% \begin{tcolorbox}[colframe=naslate,adjusted title={\bfseries Ancient and Medieval Names}]\centering +% \begin{tcolorbox}[colframe=naslate,adjusted title={\large\hfil Royal/Medieval/Ancient Name}]\centering % \begin{tabular}{l@{ }c@{ }c} % & \small Required name & \small Optional,\\ % & \small optional \meta{Affix} & \small in text only\smallskip\\ -% \tcbox[equal height group=D,colback=white,tikznode,left=1mm,right=1mm,valign=center]{\bfseries\strut \hbox{\cmd{\Name}\texttt{\space}}\\ \strut \cmd{\Name*}\\ \strut \cmd{\FName}} & +% \tcbox[equal height group=D,colback=white,tikznode,left=1mm,right=1mm,valign=center]{\bfseries\strut \hbox{\cmd{\Name}\texttt{ }}\\ \strut \cmd{\Name*}\\ \strut \cmd{\FName}} & % \tcbox[equal height group=D,colback=white,tikznode,left=1mm,right=1mm,valign=center]{\bfseries\marg{SNN\color{nared}, Affix}} & % \tcbox[equal height group=D,colback=white,tikznode,left=1mm,right=1mm,valign=center]{\bfseries\oarg{\color{nared}Alternate}} % \end{tabular} % % Add braces \texttt{\bfseries\{\,\}} after {\bfseries\marg{SNN\color{nared}, Affix}} if other text in brackets \texttt{\bfseries[\,]} follows. -% \end{tcolorbox} -% \else -% \bigskip\noindent{\bfseries Ancient and Medieval Names} -% -% \bigskip\begin{tabular}{lcc} -% & \small Required name & \small Optional,\\ -% & \small optional \meta{Affix} & \small in text only\smallskip\\ -% \cmd{\Name}\\ -% \cmd{\Name*} & \bfseries\marg{SNN\color{nared}, Affix} & \bfseries\oarg{\color{nared}Alternate}\\ -% \cmd{\FName} -% \end{tabular}\\ -% -% Add braces \texttt{\bfseries\{\,\}} after {\bfseries\marg{SNN\color{nared}, Affix}} if other text in brackets \texttt{\bfseries[\,]} follows. -% \fi\egroup +% \end{tcolorbox}\medskip % -% \begin{center}\bfseries Examples\end{center} -% -% \noindent These forms are meant for royalty and ancient figures. They can be mononyms or have multiple names, and may have an affix. Note the teaser for Section~\ref{sec:FName}:\medskip -% -% \bgroup\MyStretch\noindent|\Name{Aristotle}|\dotfill\Name{Aristotle}\\ -% |\Name{Aristotle}|\dotfill\Name{Aristotle}\smallskip\\ -% |\Name{Elizabeth, I}|\dotfill\Name{Elizabeth, I}\\ -% |\Name{Elizabeth, I}|\dotfill\Name{Elizabeth, I}\\ -% |\ForceFN\FName{Elizabeth, I}[Good Queen Bess]|\dotfill\ForceFN\FName{Elizabeth, I}[Good Queen Bess]\egroup +% \noindent +% These features denote royal, medieval, and ancient names in \textsf{nameauth}, grouped under the general rubric of ``non-Western'' name forms: +% \begin{itemize} +% \item They must \emph{leave empty} the \meta{FNN} argument. +% \item They use instead the \meta{SNN, Affix} arguments or just \meta{SNN}. +% \item Their index entries take the non-Western forms: \meta{SNN Affix} or \meta{SNN}. +% \item Names\Version{3.0} with the form \meta{SNN, Affix} can use the \meta{Alternate} argument. +% \item Names with the form \meta{SNN} cannot use \meta{Alternate}. +% \item They do not share control patterns and index entry forms with both Western names and ``non-native'' Eastern names. +% \end{itemize} % -% \subsubsection{Simplified Interface} +% As with ``native'' Eastern names, \cmd{\FName} prints \meta{SNN} unless forced otherwise by \cmd{\ForceFN}. This guards against nonsense names in the text:\medskip +% +% \bgroup\MyStretch\noindent +% |\Name {Elizabeth, I}|\SPatInfo{\ShowPattern{Elizabeth, I}\break \ShowPattern{John, Eriugena}\break \ShowPattern{Aristotle}}\dotfill \Name {Elizabeth, I}\\ +% |\Name {Elizabeth, I}|\dotfill \Name {Elizabeth, I}\\ +% |\FName{Elizabeth, I}|\dotfill \FName{Elizabeth, I}\\ +% |\ForceFN\FName{Elizabeth, I}|\dotfill \ForceFN\FName{Elizabeth, I}\\ +% |\ForceFN\FName{Elizabeth, I}[Good Queen Bess]|\IdxInfo{\ShowIdxPageref*{Elizabeth, I}\break \ShowIdxPageref*{John, Eriugena}\break \ShowIdxPageref*{Aristotle}}\dotfill \ForceFN\FName{Elizabeth, I}[Good Queen Bess]\medskip\\% |\Name{John, Eriugena}|\dotfill \Name{John, Eriugena}\\ +% |\Name{John, Eriugena}|\dotfill \Name{John, Eriugena}\\ +% |\ForceFN\FName{John, Eriugena}|\dotfill \ForceFN\FName{John, Eriugena}\medskip\\ +% |\Name{Aristotle}|\dotfill \Name{Aristotle}\\ +% |\Name{Aristotle}|\dotfill \Name{Aristotle}^^A +% \egroup +% +% \subsection{Quick Interface} % \label{sec:SimpleStart} -% % \DescribeEnv{nameauth} -% Although not required, using the \texttt{nameauth} environment in the preamble guards against undefined macros. This environment defines a tabular-like macro: +% To reduce typing, we replace frequently-used macros with the shorthand forms of the quick interface. Using the \texttt{nameauth} environment in the preamble guards against undefined macros. It defines a delimited macro \cmd{\<}, recalling a \texttt{tabular}: % \begin{quote} -% \fbox{\vbox{ -% \hbox{\mystrut\ \cmd{\begin\{nameauth\}}}\par -% \hbox{\hspace{2em}\cmd{\<} \meta{arg1} \texttt{\&} \meta{arg2} \texttt{\&} \meta{arg3} \texttt{\&} \meta{arg4} \texttt{>} }\par -% \hbox{\mystrut\ \cmd{\end\{nameauth\}}}}} +% \fbox{ +% \begin{tabular}{l} +% {\Large\strut}\cmd{\begin\{nameauth\}}\\ +% \hspace{2em}\cmd{\<} \meta{arg1} \texttt{\&} \meta{arg2} +% \texttt{\&} \meta{arg3} \texttt{\&} \meta{arg4} \texttt{>}\vspace{-1pt}\\ +% {\Large\strut}\cmd{\end\{nameauth\}}\\ +% \end{tabular} +% } % \end{quote} -% It uses \meta{arg1} as a basis to create three macros that are equivalent to:\medskip +% \newpage +% +% \noindent +% The macro \cmd{\<} uses \meta{arg1} as a basis to create three new macros per name:\medskip % -% \begin{tabular}{@{\quad}l@{\ \(\rightarrow\)\ }ll} -% \texttt{\textbackslash}\meta{arg1} & \cmd{\Name}\oarg{arg2}\marg{arg3}\oarg{arg4} \\ +% \begin{tabular}{@{\quad}l@{\ same as: }ll} +% \texttt{\textbackslash}\meta{arg1} & \cmd{\Name\ }\oarg{arg2}\marg{arg3}\oarg{arg4} \\ % \texttt{\textbackslash L}\meta{arg1} & \cmd{\Name*}\oarg{arg2}\marg{arg3}\oarg{arg4} & {\color{nared} |%| L for \textit{long}} \\ % \texttt{\textbackslash S}\meta{arg1} & \cmd{\FName}\oarg{arg2}\marg{arg3}\oarg{arg4} & {\color{nared} |%| S for \textit{short}} \\ % \end{tabular}\medskip\\ -% If either \meta{arg1} or \meta{arg3} are empty, or \meta{SNN} is empty, \textsf{nameauth} will generate a package error. Forgetting the backslash, ampersands, or angle brackets will cause errors. For more on \meta{arg4} see page~\pageref{page:ArgIV}. -% \newpage -% -% Comments below are not part of the environment. Extra spaces in each argument are stripped (Section~\ref{sec:ErrorProt}). Put trailing braces \texttt{\{\,\}} or something else after the shorthand macros if text in brackets \texttt{[\,]} follows, so it does not become an optional argument. Below we introduce name forms with particles. -% -% \begin{center}\bfseries Examples\end{center} -% \def\startrowa{\ \ \cmd{\< }} -% \def\startrowb{\color{nared}\% } -% \def\midrowa{\texttt{ \& }} -% \def\midrowb{\texttt{\ \ \ }} -% \def\endrowa{\texttt{ >}} -% \def\endrowb{} -% \def\startrow{\startrowb} -% \def\midrow{\midrowb} -% \def\endrow{\endrowb} +% If either \meta{arg1} or \meta{arg3} are empty, or \meta{SNN} is empty, \textsf{nameauth} will generate a package error. Forgetting the backslash, any ampersand, argument, or angle bracket will cause errors. The \meta{Alternate} field is \meta{arg4} (see below). +% +% Here we do not show the obsolete syntax (Section~\ref{sec:Obsolete}). Comments are not part of the \texttt{nameauth} environment. Extra spaces around each argument are stripped. Put trailing braces \texttt{\{\,\}} after the shorthand macros if text in brackets \texttt{[\,]} follows. We introduce Western name forms with particles (followed by {\color{nared}\textit{W. part.}}).\medskip +% +% \def\startrowa{\ \ \cmd{\< }}^^A +% \def\startrowb{\color{nared}\% }^^A +% \def\midrowa{\texttt{ \& }}^^A +% \def\midrowb{\texttt{\ \ \ }}^^A +% \def\endrowa{\texttt{ >}}^^A +% \def\endrowb{}^^A +% \def\startrow{\startrowb}^^A +% \def\midrow{\midrowb}^^A +% \def\endrow{\endrowb}^^A % \bgroup\noindent\ttfamily\small| \begin{nameauth}|\\ % \begin{tabular}{>{\startrow}l@{\midrow}l@{\midrow}l@{\midrow}l@{\endrow}l} -% {\normalfont\color{nared}\quad\ \ \,\meta{arg1}}\gdef\startrow{\startrowa} & {\normalfont\color{nared}\meta{arg2}} & {\normalfont\color{nared}\meta{arg3}} & {\normalfont\color{nared}\meta{arg4}}\\\gdef\midrow{\midrowa}\gdef\endrow{\endrowa}%^^A -% Wash & George & Washington & &{\color{nared} \% \normalfont\textit{Western}}\\ -% Harnack & Adolf & Harnack & &{\color{nared} \% \normalfont\textit{Western}}\\ -% Lewis & Clive Staples & Lewis & &{\color{nared} \% \normalfont\textit{Western}}\\ -% Pat & George S. & Patton, Jr. & &{\color{nared} \% \normalfont\textit{W. affix}}\\ -% JRIV & John David & Rockefeller, IV & &{\color{nared} \% \normalfont\textit{W. affix}}\\ -% Ches & Chesley B. & Sullenberger, III & &{\color{nared} \% \normalfont\textit{W. affix}}\\ -% Soto & Hernando & de Soto & &{\color{nared} \% \normalfont\textit{W. part.}}\\ -% JWG & J.W. von & Goethe & &{\color{nared} \% \normalfont\textit{W. part.}}\\ -% VBuren & Martin & Van Buren & &{\color{nared} \% \normalfont\textit{W. part.}}\\ -% Noguchi & Hideyo & Noguchi & &{\color{nared} \% \normalfont\textit{W. as E.}}\\ -% Miyaz & & Miyazaki, Hayao & &{\color{nared} \% \normalfont\textit{Eastern}}\\ -% Yamt & & Yamamoto, Isoroku & &{\color{nared} \% \normalfont\textit{Eastern}}\\ -% Aeth & & Æthelred, II & &{\color{nared} \% \normalfont\textit{Ancient}}\\ -% Attil & & Attila, the Hun & &{\color{nared} \% \normalfont\textit{Ancient}}\\ -% Dem & & Demetrius, I & &{\color{nared} \% \normalfont\textit{Ancient}}\\ -% Eliz & & Elizabeth, I & &{\color{nared} \% \normalfont\textit{Ancient}}\\ -% Aris & & Aristotle & &{\color{nared} \% \normalfont\textit{Mono}}\\ -% CSL & Clive Staples & Lewis & C.S. &{\color{nared} \% \normalfont\textit{W. alt.}}\\ -% MSens & & Miyazaki, Hayao & Sensei &{\color{nared} \% \normalfont\textit{E. alt.}}\\ +% {\normalfont\color{nared}\quad\ \ \,\meta{arg1}}\gdef\startrow{\startrowa} & {\normalfont\color{nared}\meta{arg2}} & {\normalfont\color{nared}\meta{arg3}} & {\normalfont\color{nared}\meta{arg4}}\\\gdef\midrow{\midrowa}\gdef\endrow{\endrowa}^^A +% Wash & George & Washington & &{\color{nared} \% +% \normalfont\textit{Western}}\\ +% Lewis & Clive Staples & Lewis & &{\color{nared} \% +% \normalfont\textit{Western}}\\ +% Pat & George S. & Patton, Jr. & &{\color{nared} \% +% \normalfont\textit{W. affix}}\\ +% JRIV & J.D. & Rockefeller, IV & &{\color{nared} \% +% \normalfont\textit{W. affix}}\\ +% Soto & Hernando & de~Soto & &{\color{nared} \% +% \normalfont\textit{W. part.}}\\ +% JWG & J.W. von & Goethe & &{\color{nared} \% +% \normalfont\textit{W. part.}}\\ +% VBuren & Martin & Van Buren & &{\color{nared} \% +% \normalfont\textit{W. part.}}\\ +% Noguchi & Hideyo & Noguchi & &{\color{nared} \% +% \normalfont\textit{W. as E.}}\\ +% Molnar & Frenec & Molnár & &{\color{nared} \% +% \normalfont\textit{W. as E.}}\\ +% Miyaz & & Miyazaki, Hayao & &{\color{nared} \% +% \normalfont\textit{Eastern}}\\ +% Yamt & & Yamamoto, Isoroku & &{\color{nared} \% +% \normalfont\textit{Eastern}}\\ +% Eliz & & Elizabeth, I & &{\color{nared} \% +% \normalfont\textit{Royal}}\\ +% Aeth & & Æthelred, II & &{\color{nared} \% +% \normalfont\textit{Royal}}\\ +% Eriugena & & John, Eriugena & &{\color{nared} \% +% \normalfont\textit{Medieval}}\\ +% Aris & & Aristotle & &{\color{nared} \% +% \normalfont\textit{Mono}}\\ +% CSL & Clive Staples & Lewis & C.S. &{\color{nared} \% +% \normalfont\textit{W. alt.}}\\ +% MSens & & Miyazaki, Hayao & Sensei &{\color{nared} \% +% \normalfont\textit{E. alt.}}\\ % \end{tabular}\\ -% | \end{nameauth}|\egroup\medskip +% | \end{nameauth}|\egroup % -% \begin{center}\small\MyStretch -% \begin{tabular}{rlp{0.41\textwidth}}\toprule -% Output & Short Form & Long Form\\\midrule -% \Wash & \cmd{\Wash} & \cmd{\Name}\texttt{[George]\{Washington\}}\\ -% \rowcolor{black!7!white}\LWash & \cmd{\LWash} & \cmd{\Name*}\texttt{[George]\{Washington\}}\\ -% \SWash & \cmd{\SWash} & \cmd{\FName}\texttt{[George]\{Washington\}}\\ -% \rowcolor{black!7!white}\JustIndex\Wash & \cmd{\JustIndex}\cmd{\Wash} & \cmd{\IndexName}\texttt{[George]\{Washington\}}\\ -% \Eliz & \cmd{\SubvertThis}\cmd{\Eliz} & \cmd{\SubvertThis}\cmd{\Name}\texttt{\{Elizabeth,I\}}\\ -% \rowcolor{black!7!white}\ForgetThis\Eliz & \cmd{\ForgetThis}\cmd{\Eliz} & \cmd{\ForgetThis}\cmd{\Name}\texttt{\{Elizabeth,I\}}\\\bottomrule +% \begin{center}\bfseries \meta{Alternate} Tips\end{center} +% \phantomsection +% Two shorthands above use \meta{arg4}: \cmd{\CSL} and \cmd{\MSens}. Their similar forms \cmd{\Lewis} and \cmd{\Miyaz} leave \meta{arg4} empty. Here is how they are related:\label{page:ArgIV} +% \begin{itemize} +% \item They\SPatInfo{\ShowPattern[Clive Staples]{Lewis}\break \ShowPattern{Miyazaki, Hayao}} share name control patterns (Section~\ref{sec:NamePatterns}). Therefore, they have the same ``first-use'' and ``later-use'' conditions. +% \item Usually, one adds alternate names to shorthands with an empty \meta{arg4}:\\[1ex] +% \vspace{-7ex}\IdxInfo{\ShowIdxPageref*[Clive Staples]{Lewis}\break \ShowIdxPageref*{Miyazaki, Hayao}}\vspace{7ex}\leavevmode +% \begin{tabular}{llll}\toprule +% \cmd{\LLewis[C.S.]} & \LLewis[C.S.] & \cmd{\LCSL} & \LCSL\\ +% \rowcolor{grey}\cmd{\LMiyaz[Sensei]} & \LMiyaz[Sensei] & \cmd{\LMSens} & \LMSens\\\bottomrule % \end{tabular} -% \end{center} +% \item The field \meta{arg4} contains either \meta{Alternate} or uses the obsolete syntax. Trying to add ``alternate names'' to shorthands that use \meta{arg4} fails:\\[1ex] +% \begin{tabular}{ll}\toprule +% \cmd{\LCSL[Jack]} & \LCSL[Jack]\\ +% \rowcolor{grey}\cmd{\LMSens[Sensei]} & \LMSens[Sensei]\\\bottomrule +% \end{tabular} +% \end{itemize} +% \newpage % -% English and modern Romance languages keep the particle with the surname. German and other languages do not (cf. Sections~\ref{sec:NameParticles} and~\ref{sec:AltFormat}).\footnote{See also [\hyperlink{Mulvany}{Mulvany}, 152--82], and the \textit{Chicago Manual of Style}.} +% \begin{center}\bfseries How Quick Is Quick?\end{center} % +% Prefix macros (Section~\ref{sec:SelectOver}) work with both interfaces. Here we show just a few examples showing how much typing we save with common macros: % \begin{center}\small\MyStretch -% \begin{tabular}{rll}\toprule -% \bfseries Macro & \bfseries Body Text & \bfseries Index \\\midrule -% \cmd{\VBuren} & \VBuren & \ShowIdxPageref*[Martin]{Van Buren}\\ -% \rowcolor{black!7!white}\cmd{\VBuren} & \VBuren & \ShowIdxPageref*[Martin]{Van Buren}\\ -% \cmd{\Soto} & \Soto & \ShowIdxPageref*[Hernando]{de Soto}\\ -% \rowcolor{black!7!white}\cmd{\CapThis}\cmd{\Soto} & \CapThis\Soto & \ShowIdxPageref*[Hernando]{de Soto}\\ -% \cmd{\JWG} & \JWG & \ShowIdxPageref*[J.W. von]{Goethe}\\ -% \rowcolor{black!7!white}\cmd{\JWG} & \JWG & \ShowIdxPageref*[J.W. von]{Goethe}\\\bottomrule -% \end{tabular} -% \end{center} -% \newpage -% -% \begin{center}\bfseries \meta{Alternate} Tips\end{center} +% \begin{tabular}{r@{\ \ \ }l@{\ \ }l}\toprule +% Output & Short Form & Long Form\\\midrule +% \rowcolor{grey}\Wash & \cmd{\Wash} & \cmd{\Name}\texttt{[George]\{Washington\}}\\ +% \LWash & \cmd{\LWash} & \cmd{\Name*}\texttt{[George]\{Washington\}}\\ +% \rowcolor{grey}\SWash & \cmd{\SWash} & \cmd{\FName}\texttt{[George]\{Washington\}}\\ +% \ForgetThis\Wash & \cmd{\ForgetThis}\cmd{\Wash} & \cmd{\ForgetName}\texttt{[George]\{Washington\}}\\ +% & & \cmd{\Name}\texttt{[George]\{Washington\}}\\ +% \rowcolor{grey}\SubvertThis\Wash & \cmd{\SubvertThis}\cmd{\Wash} & \cmd{\SubvertName}\texttt{[George]\{Washington\}}\\ +% \rowcolor{grey}& & \cmd{\Name}\texttt{[George]\{Washington\}}\\ +% \JustIndex\Wash & \cmd{\JustIndex}\cmd{\Wash} & \cmd{\IndexName}\texttt{[George]\{Washington\}}\\\bottomrule +% \end{tabular} +% \end{center}\leavevmode % +% \begin{center}\bfseries Name Variant Overview\end{center} % \phantomsection -% \noindent Above we listed two shorthands that had alternate names in \meta{arg4}: \cmd{\CSL} and \cmd{\MSens}. They have related shorthands whose \meta{arg4} are empty: \cmd{\Lewis} and \cmd{\Miyaz}. Here are how they are related (cf. Section~\ref{sec:FName}):\label{page:ArgIV} -% \begin{itemize} -% \item They share the same name patterns (Section~\ref{sec:NamePatterns}): |\ForgetThis\Lewis| \ForgetThis\Lewis; \cmd{\CSL} \CSL. |\ForgetThis\Miyaz| \ForgetThis\Miyaz; and \cmd{\MSens} \MSens. -% \item More commonly, one produces alternate names with \cmd{\LLewis[C.S.]} \LLewis[C.S.] and \cmd{\LMiyaz[Sensei]} \LMiyaz[Sensei]. -% \item Both\Warn{} \cmd{\LCSL} \LCSL\ and \cmd{\LMSens} \LMSens\ already have \meta{Alternate} built in. They cannot take another optional argument. One must remember which shorthands have used \meta{arg4}. -% \item If one should forget that, one will get errors: \cmd{\LCSL[C.S.]} \LCSL[C.S.] and \cmd{\LMsens[Sensei]} \LMSens[Sensei]. -% \end{itemize} % -% \begin{center}\bfseries Variant Overview\end{center} +% \vspace{-2ex}\Illus{}\vspace{2ex}Below we use \cmd{\ForgetThis} (Section~\ref{sec:NameControl}) to simulate first uses of names as needed, then proceed with subsequent uses:\footnote{With \texttt{pdflatex} and \texttt{latex}, in \texttt{\ShowPattern{Æthelred, II}} the glyphs \texttt{ÃĘ} correspond to \cmd{\IeC\{}\cmd{\AE\}}.} % % \begin{center}\footnotesize\MyStretch +% \leavevmode\SPatInfo{\ShowPattern[George]{Washington}\break \ShowPattern[Hernando]{de~Soto}\break \ShowPattern[George S.]{Patton, Jr.}\break \ShowPattern[J.D.]{Rockefeller, IV}\break \ShowPattern[Clive Staples]{Lewis}\break \ShowPattern{Aristotle}\break \ShowPattern{Æthelred, II}\break \ShowPattern{John, Eriugena}\break \ShowPattern[Hideyo]{Noguchi}\break \ShowPattern{Yamamoto, Isoroku}}\vspace{-2.3ex} % \begin{tabular}{@{}p{18.4em}p{22.4em}@{}} -% \textsc{Western:}\par +% \textsc{Western:} \hfill (Sections~\ref{sec:Naming}, \ref{sec:FName})\par % |\Wash|\dotfill \ForgetThis\Wash\par % |\LWash|\dotfill \LWash\par % |\Wash|\dotfill \Wash\par @@ -1171,16 +1304,31 @@ the README.txt or README for more information. % |\Soto|\dotfill \ForgetThis\Soto\par % |\Soto|\dotfill \Soto\par % |\CapThis\Soto|\dotfill \CapThis\Soto\par -% \par\hbox{}\par +% & +% \textsc{Ancient Mononym} \hfill (trivial case)\par +% |\Aris|\dotfill \ForgetThis\Aris\par +% |\Aris|\dotfill \Aris \par +% (This is the trivial case.)\par\hbox{}\par +% \textsc{Royal and Medieval:} \hfill (Sections~\ref{sec:Eastern}, \ref{sec:NameAncient})\par +% |\Aeth|\dotfill \ForgetThis\Aeth\par +% |\Aeth|\dotfill \Aeth\par +% |\LAeth[Unrædig]|\dotfill \LAeth[Unrædig]\par +% |\Eriugena|\dotfill \ForgetThis\Eriugena\par +% |\Eriugena|\dotfill \Eriugena\par +% \\ +% \end{tabular} +% \leavevmode\vspace{2ex}\IdxInfo{\ShowIdxPageref*[George]{Washington}\break \ShowIdxPageref*[Hernando]{de~Soto}\break \ShowIdxPageref*[George S.]{Patton, Jr.}\break \ShowIdxPageref*[J.D.]{Rockefeller, IV}\break \ShowIdxPageref*[Clive Staples]{Lewis}\break \ShowIdxPageref*{Aristotle}\break \ShowIdxPageref*{Æthelred, II}\break \ShowIdxPageref*{John, Eriugena}\break \ShowIdxPageref*[Hideyo]{Noguchi}\break \ShowIdxPageref*{Yamamoto, Isoroku}}\vspace{-2.5ex} +% \begin{tabular}{@{}p{18.4em}p{22.4em}@{}} % \textsc{Affixes:} \hfill (Section~\ref{sec:Affix})\par % |\Pat|\dotfill \ForgetThis\Pat\par % |\LPat|\dotfill \LPat\par % |\DropAffix\LPat|\dotfill \DropAffix\LPat\par % |\Pat|\dotfill \Pat\par -% |\SPat|\dotfill \SPat\par % \par\hbox{}\par % \textsc{Nicknames:} \hfill (Section~\ref{sec:FName})\par -% |\JRIV|\dotfill \ForgetThis\JRIV\par +% |\DropAffix\LPat[George]|\dotfill \DropAffix\LPat[George]\par +% |\SPat[George]|\dotfill \SPat[George]\par +% |\JRIV[John D.]|\dotfill \ForgetThis\JRIV[John D.]\par % |\DropAffix\LJRIV[Jay]|\dotfill \DropAffix\LJRIV[Jay]\par % |\SJRIV[Jay]|\dotfill \SJRIV[Jay]\par % |\Lewis|\dotfill \ForgetThis\Lewis\par @@ -1189,17 +1337,6 @@ the README.txt or README for more information. % |\LCSL|\dotfill \LCSL\par % |\SCSL|\dotfill \SCSL % & -% \textsc{Ancient\,/\,Mononym}\par -% |\Aris|\dotfill \ForgetThis\Aris\par -% |\Aris|\dotfill \Aris \par -% \par\hbox{}\par -% \textsc{Ancient\,/\,Royal:} \hfill (Sections~\ref{sec:Eastern}, \ref{sec:NameParticles})\par -% |\Aeth|\dotfill \ForgetThis\Aeth\par -% |\Aeth|\dotfill \Aeth\par -% |\LAeth[Unrædig]|\dotfill \LAeth[Unrædig]\par -% |\Attil|\dotfill \ForgetThis\Attil\par -% |\Attil|\dotfill \Attil\par -% \par\hbox{}\par % \textsc{``Non-native'' Eastern:} \hfill (Section~\ref{sec:Eastern})\par % |\Noguchi|\dotfill \ForgetThis\Noguchi\par % |\LNoguchi|\dotfill \LNoguchi\par @@ -1218,278 +1355,153 @@ the README.txt or README for more information. % |\SYamt|\dotfill \SYamt\par % |\ForceFN\SYamt|\dotfill \ForceFN\SYamt % \\ -% \end{tabular} +% \end{tabular}\medskip % \end{center} -% Above we used \cmd{\ForgetThis} (Section~\ref{sec:NameControl}) to reset first uses of names. Now we set up examples on page~\pageref{page:ExPage} by invoking \cmd{\ExcludeName\{Attila, the Hun\}}\ExcludeName{Attila, the Hun} and \cmd{\AKA[John David]\{Rockefeller,IV\}[Jay]\{Rockefeller\}} \AKA[John David]{Rockefeller,IV}[Jay]{Rockefeller}. On why that form has a different index entry than |\DropAffix\LJRIV[Jay]| \DropAffix\LJRIV[Jay], see Sections~\ref{sec:IndexXref} and~\ref{sec:AKA}. % \newpage % -% \subsubsection[Macro Overview]{Select Macro Overview} +% \subsection[Macro Overview]{Select Macro Overview} % \label{sec:SelectOver} % -% \noindent Below we have a partial selection of macros and their arguments in overview: +% \begin{center}\bfseries Macros Taking Name Arguments\end{center} +% % \begin{center}\small\MySmallStretch % \begin{tabular}{lrccl}\toprule -% \meta{prefix macros} & \cmd{\Name} & \meta{optional *} & \meta{name args} & \\ +% \llap{Naming\qquad}\meta{prefix macros} & \cmd{\Name} & \meta{optional *} & \meta{name args} & \\ % \meta{prefix macros} & \cmd{\FName} & \meta{optional *} & \meta{name args} & \\ -% \rowcolor{black!7!white}\meta{prefix macros} & \cmd{\IndexName} & & \meta{name args} & \\ -% \rowcolor{black!7!white}\meta{prefix macros} & \cmd{\IndexRef} & & \meta{xref args} & \meta{target}\\ -% \meta{prefix macros} & \cmd{\AKA} & \meta{optional *} & \meta{target args} & \meta{xref args}\\ -% \rowcolor{black!7!white} & \cmd{\ExcludeName} & & \meta{name args} & \\ -% \rowcolor{black!7!white} & \cmd{\IncludeName} & \meta{optional *} & \meta{name args} & \\ -% & \cmd{\PretagName} & & \meta{name args} & \meta{sort key} \\ -% & \cmd{\TagName} & & \meta{name args} & \meta{tag} \\ -% & \cmd{\UntagName} & & \meta{name args} & \\ -% \rowcolor{black!7!white} & \cmd{\NameAddInfo} & & \meta{name args} & \meta{tag} \\ -% \rowcolor{black!7!white} & \cmd{\NameQueryInfo} & & \meta{name args} & \\ -% \rowcolor{black!7!white} & \cmd{\NameClearInfo} & & \meta{name args} & \\ -% & \cmd{\ForgetName} & & \meta{name args} & \\ -% & \cmd{\SubvertName} & & \meta{name args} & \\ -% \rowcolor{black!7!white} & \cmd{\IfMainName} & & \meta{name args} & \marg{y}\marg{n}\\ -% \rowcolor{black!7!white} & \cmd{\IfFrontName} & & \meta{name args} & \marg{y}\marg{n}\\ -% \rowcolor{black!7!white} & \cmd{\IfAKA} & & \meta{name args} & \marg{y}\marg{n}\marg{x}\\\bottomrule +% \rowcolor{grey}\llap{Page ref\qquad}\cmd{\SeeAlso} & \cmd{\IndexName} & & \meta{name args} & \\ +% \rowcolor{grey}\llap{Only cross-ref\qquad}\cmd{\SeeAlso} & \cmd{\IndexRef} & & \meta{xref args} & \meta{target}\\ +% \llap{Prevent page ref\qquad} & \cmd{\ExcludeName} & & \meta{name args} & \\ +% \llap{Enable page ref\qquad} & \cmd{\IncludeName} & \meta{optional *} & \meta{name args} & \\ +% \rowcolor{grey}\llap{Sort index\qquad}& \cmd{\PretagName} & & \meta{name args} & \meta{sort key} \\ +% \rowcolor{grey}\llap{Append idx tag\qquad}& \cmd{\TagName} & & \meta{name args} & \meta{tag} \\ +% \rowcolor{grey}\llap{Delete idx tag\qquad}& \cmd{\UntagName} & & \meta{name args} & \\ +% \llap{Make text tag\qquad} & \cmd{\NameAddInfo} & & \meta{name args} & \meta{tag} \\ +% \llap{Show text tag\qquad} & \cmd{\NameQueryInfo} & & \meta{name args} & \\ +% \llap{Delete text tag\qquad} & \cmd{\NameClearInfo} & & \meta{name args} & \\ +% \rowcolor{grey}\llap{Delete name cs\qquad} & \cmd{\ForgetName} & & \meta{name args} & \\ +% \rowcolor{grey}\llap{Create name cs\qquad} & \cmd{\SubvertName} & & \meta{name args} & \\ +% \llap{Name cs tests\qquad} & \cmd{\IfMainName} & & \meta{name args} & \marg{y}\marg{n}\\ +% & \cmd{\IfFrontName} & & \meta{name args} & \marg{y}\marg{n}\\ +% & \cmd{\IfAKA} & & \meta{name args} & \marg{y}\marg{n}\marg{x}\\ +% \rowcolor{grey}\llap{Debugging\qquad} & \cmd{\ShowPattern} & & \meta{name args} & \\ +% \rowcolor{grey} & \cmd{\ShowIdxPageref} & \meta{optional *} & \meta{name args} & \\\bottomrule % \end{tabular} % \end{center} +% Not shown above are \cmd{\AKA}, \cmd{\AKA*}, \cmd{\PName}, and \cmd{\PName*} (Section~\ref{sec:AKA}). These macros from the early days of \textsf{nameauth} have specialized arguments and issues. +% +% \begin{center}\bfseries Prefix Macros (One Use Per Name)\end{center} % -% \noindent The \meta{prefix macros} below have a one-time effect per name and they also stack. For example: |\CapThis\RevName\SkipIndex\Name[bar]{foo}|: \CapThis\RevName\SkipIndex\Name[bar]{foo}. % \begin{center}\small\MySmallStretch % \begin{tabular}{rp{0.72\textwidth}}\toprule % & \bfseries Capitalization in the Text\\ +% \cmd{\CapName} & Cap entire \meta{SNN} in body text. Overrides \cmd{\CapThis}.\\ % \cmd{\CapThis} & Capitalize first letter of all name components in body text.\\ % \cmd{\AccentCapThis} & Fallback when Unicode detection cannot be done.\\ -% \cmd{\CapName} & Cap entire \meta{SNN} in body text. Overrides \cmd{\CapThis}.\\ -% \rowcolor{black!7!white} & \bfseries Reversing in the Text\\ -% \rowcolor{black!7!white}\cmd{\RevName} & Reverse order of any name in body text. Overrides \cmd{\RevComma}\\ -% \rowcolor{black!7!white}\cmd{\RevComma} & Reverse only Western names to \meta{SNN}, \meta{FNN}.\\ +% \rowcolor{grey} & \bfseries Reversing in the Text\\ +% \rowcolor{grey}\cmd{\RevName} & Reverse order of any name in body text. Overrides \cmd{\RevComma}\\ +% \rowcolor{grey}\cmd{\RevComma} & Reverse only Western names to \meta{SNN}, \meta{FNN}.\\ % & \bfseries Commas in the Text\\ % \cmd{\ShowComma} & Add comma between \meta{SNN} and \meta{Affix}.\\ % \cmd{\NoComma} & No comma between \meta{SNN} and \meta{Affix}. Overrides \cmd{\ShowComma}.\\ -% \rowcolor{black!7!white} & \bfseries Name Breaks in the Text\\ -% \rowcolor{black!7!white}\cmd{\DropAffix} & Drop affix only for a long Western name reference.\\ -% \rowcolor{black!7!white}\cmd{\KeepAffix} & Insert non-breaking space (NBSP) between \meta{SNN}, \meta{FNN/Affix}.\\ -% \rowcolor{black!7!white}\cmd{\KeepName} & Insert NBSP between all name elements. Overrides \cmd{\KeepAffix}.\\ -% & \bfseries Forcing Name Forms in the Text\\ +% \rowcolor{grey} & \bfseries Name Breaks in the Text\\ +% \rowcolor{grey}\cmd{\DropAffix} & Drop affix only for a long Western name reference.\\ +% \rowcolor{grey}\cmd{\KeepAffix} & Insert non-breaking space (NBSP) between \meta{SNN}, \meta{FNN/Affix}.\\ +% \rowcolor{grey}\cmd{\KeepName} & Insert NBSP between all name elements. Overrides \cmd{\KeepAffix}.\\ +% & \bfseries Forcing Name Forms via Control Sequence\\ % \cmd{\ForgetThis} & Force a first-time name use. Negates \cmd{\SubvertThis}.\\ % \cmd{\SubvertThis} & Force a subsequent use.\\ -% \cmd{\ForceName} & Force first-use formatting hooks.\\ -% \cmd{\ForceFN} & Force printing of \meta{Affix} in non-Western short forms.\\ -% \rowcolor{black!7!white} & \bfseries Indexing\\ -% % \rowcolor{black!7!white}\cmd{\SeeAlso} & Make a \textit{see also} reference instead of a page reference. Only for use with \cmd{\IndexRef}, \cmd{\AKA}, \cmd{\PName} and their starred variants.\\ -% \rowcolor{black!7!white}\cmd{\SkipIndex} & Do not create index entries.\\ -% \rowcolor{black!7!white}\cmd{\JustIndex} & Act like \cmd{\IndexName}; negated by \cmd{\AKA}, \cmd{\PName}.\\\bottomrule +% \rowcolor{grey} & \bfseries Forcing Name Forms via Boolean Flags\\ +% \rowcolor{grey}\cmd{\ForceName} & Force first-use formatting hooks.\\ +% \rowcolor{grey}\cmd{\ForceFN} & Force printing of \meta{Affix} in non-Western short forms.\\ +% & \bfseries Indexing\\ +% \cmd{\SeeAlso} & For \cmd{\IndexName}, \cmd{\AKA}, and \cmd{\PName}; make a \textit{see also} xref.\\ +% \cmd{\SkipIndex} & For naming macros; do not create an index entry.\\ +% \cmd{\JustIndex} & For naming macros; index only (once); negated by \cmd{\AKA}, \cmd{\PName}.\\\bottomrule % \end{tabular} % \end{center} -% -% \ReturnLink % \newpage % -% \subsection{Obsolete Syntax} -% \label{sec:Obsolete} -% -% This ``ghost''\Warn{} of \textsf{nameauth} past limits alternate names and cross-references (Section~\ref{sec:AKA}), excludes comma-delimited names, and complicates indexing and tagging (Sections~\ref{sec:IndexTag} and~\ref{sec:TextTags}). When the \meta{FNN} and \meta{Affix} arguments are empty, \meta{Alternate} acts like \meta{Affix} and affects both name and index patterns (Section~\ref{sec:NamePatterns}). In this manual we designate these names with a double dagger (\ddag): -% -% \begin{quote}\small\MyStretch -% |\Name{Henry}[VIII] | {\color{nared}|%| \textit{Ancient}}\\ -% |\Name{Chiang}[Kai-shek] | {\color{nared}|%| \textit{Eastern}}\\ -% |\begin{nameauth}|\\ -% | \< Dagb & & Dagobert & I > | {\color{nared}|%| \textit{Ancient}}\\ -% | \< Yosh & & Yoshida & Shigeru > | {\color{nared}|%| \textit{Eastern}}\\ -% |\end{nameauth}|\medskip -% \end{quote} -% -% \begin{center}\small\MyStretch -% \begin{tabular}{ll}\toprule -% |\Name{Henry}[VIII]| & \Name{Henry}[VIII]\ddag\\ -% |\Name{Henry}[VIII]| & \Name{Henry}[VIII]\ddag\\ -% \rowcolor{black!7!white}|\Name{Chiang}[Kai-shek]| & \Name{Chiang}[Kai-shek]\ddag\\ -% \rowcolor{black!7!white}|\Name{Chiang}[Kai-shek]| & \Name{Chiang}[Kai-shek]\ddag\\ -% |\Dagb| & \Dagb\ddag\\ -% |\Dagb| & \Dagb\ddag\\ -% \rowcolor{black!7!white}|\CapName\Yosh| & \CapName\Yosh\ddag\\ -% \rowcolor{black!7!white}|\CapName\RevName\LYosh| & \CapName\RevName\LYosh\ddag\\\bottomrule -% \end{tabular} -% \end{center} -% -% |\Name{Henry}[VIII]|\Version{2.6} (older syntax) and |\Name{Henry, VIII}| (new syntax) share name patterns, tags, and index entries, as shown below. We recommend using the newer syntax unless otherwise needed. -% \begin{quote}\small -% \NameAddInfo{Henry}[VIII]{ (\textit{Defensor Fidei})}% -% |\NameAddInfo{Henry}[VIII]{ (\textit{Defensor Fidei})}|{\color{nared}| % old|}\\ -% {.\,.\,.}\\ -% |\Name*{Henry, VIII}\NameQueryInfo{Henry, VIII} |{\color{nared}| % new|}\smallskip\\ -% \Name*{Henry, VIII}\NameQueryInfo{Henry, VIII} -% \end{quote} -% -% \ReturnLink -% -% \subsection{Name Pattern Overview} -% \label{sec:NamePatterns} -% -% The table below shows how the macro arguments generate name patterns central to \textsf{nameauth}. The \meta{Alternate} argument only affects patterns when using the obsolete syntax. The naming macro arguments create internal control sequences that affect names in both the text and the index: -% -% \begin{center}\MyStretch -% \begin{tabular}{lll}\toprule -% Macro Arguments & Patterns & Type\\\midrule -% \rowcolor{black!7!white}\oarg{FNN}\marg{SNN} & \meta{FNN}!\meta{SNN} & \normalfont Western\\ -% \oarg{FNN}\marg{SNN, Affix} & \meta{FNN}!\meta{SNN},\meta{Affix} & \normalfont Western\\ -% \rowcolor{black!7!white}\hphantom{\oarg{FNN}}\marg{SNN, Affix} & \meta{SNN},\meta{Affix} & \normalfont non-Western\\ -% \hphantom{\oarg{FNN}}\marg{SNN}\oarg{Alt} & \meta{SNN},\meta{Alt} & \normalfont (obsolete)\\ -% \rowcolor{black!7!white}\hphantom{\oarg{FNN}}\marg{SNN} & \meta{SNN} & \normalfont mononym\\\bottomrule -% \end{tabular} -% \end{center} -% \newpage -% -% \noindent We ``forget'' several names below to create first-use cases: -% \begin{center}\footnotesize\MyStretch -% \begin{tabular}{rll}\toprule -% Macro & Body Text & \cmd{\ShowPattern}\\\midrule -% \cmd{\Harnack[Adolf von]} & \Harnack[Adolf von] & \texttt{\ShowPattern[Adolf]{Harnack}}\\ -% \cmd{\LHarnack} & \LHarnack & \texttt{\ShowPattern[Adolf]{Harnack}}\\ -% \rowcolor{black!7!white}\cmd{\ForgetThis}\cmd{\Pat} & \ForgetThis\Pat & \texttt{\ShowPattern[George S.]{Patton, Jr.}}\\ -% \rowcolor{black!7!white}\cmd{\DropAffix}\cmd{\LPat} & \DropAffix\LPat & \texttt{\ShowPattern[George S.]{Patton, Jr.}}\\ -% \cmd{\ForgetThis}\cmd{\Noguchi} & \ForgetThis\Noguchi & \texttt{\ShowPattern[Hideyo]{Noguchi}}\\ -% \cmd{\RevName}\cmd{\LNoguchi} & \RevName\LNoguchi\dag & \texttt{\ShowPattern[Hideyo]{Noguchi}}\\ -% \rowcolor{black!7!white}\cmd{\ForgetThis}\cmd{\Yamt} & \ForgetThis\Yamt & \texttt{\ShowPattern{Yamamoto,Isoroku}}\\ -% \rowcolor{black!7!white}\cmd{\RevName}\cmd{\LYamt} & \RevName\LYamt & \texttt{\ShowPattern{Yamamoto,Isoroku}}\\ -% \cmd{\ForgetThis}\cmd{\Name\{Henry,VIII\}} & \ForgetThis\Name{Henry,VIII} & \texttt{\ShowPattern{Henry,VIII}}\\ -% \cmd{\Name*\{Henry\}[VIII]} & \Name*{Henry}[VIII]\ddag & \texttt{\ShowPattern{Henry,VIII}}\\ -% \rowcolor{black!7!white}\cmd{\Dem[I Soter]} & \Dem[I Soter] & \texttt{\ShowPattern{Demetrius,I}}\\ -% \rowcolor{black!7!white}\cmd{\LDem} & \LDem & \texttt{\ShowPattern{Demetrius,I}}\\ -% \cmd{\ForgetThis}\cmd{\Aris} & \ForgetThis\Aris & \texttt{\ShowPattern{Aristotle}}\\ -% \cmd{\Aris} & \Aris & \texttt{\ShowPattern{Aristotle}}\\\bottomrule -% \end{tabular} -% \ForgetName{Demetrius, I}\ForgetName[Adolf]{Harnack} -% \end{center}\bigskip -% -% \noindent Six suffixes are appended to these patterns to create independent data sets: -% \begin{center}\small\MyStretch -% \begin{tabular}{llll}\toprule -% Description & Pattern & Mnemonic & Example\\\midrule -% \rowcolor{black!7!white}Front-matter names & \meta{pattern}\texttt{!NF} & ``name front'' & \texttt{\ShowPattern[Adolf]{Harnack}{!NF}}\\ -% Main-matter names & \meta{pattern}\texttt{!MN} & ``main name'' & \texttt{\ShowPattern[Hideyo]{Noguchi}{!MN}}\\ -% \rowcolor{black!7!white}Index cross-refs & \meta{pattern}\texttt{!PN} & ``pseudonym'' & \texttt{\ShowPattern{Yamamoto, Isoroku}{!PN}}\\ -% Index sorting tags & \meta{pattern}\texttt{!PRE} & ``pretag'' & \texttt{\ShowPattern{Henry, VIII}{!PRE}}\\ -% \rowcolor{black!7!white}Index info tags & \meta{pattern}\texttt{!TAG} & ``tag'' & \texttt{\ShowPattern{Demetrius, I}{!TAG}}\\ -% ``Text tag'' database & \meta{pattern}\texttt{!DB} & ``database'' & \texttt{\ShowPattern{Aristotle}{!DB}}\\\bottomrule -% \end{tabular} -% \end{center}\bigskip -% -% \noindent The following macros \emph{write} to these data sets; others also can read from them: -% \begin{center}\small\MyStretch -% \begin{tabular}{lcccccc}\toprule[1pt] -% Macros & \ttfamily \,!NF\, & \ttfamily \,!MN\, & \ttfamily \,!PN\, & \ttfamily !PRE & \ttfamily !TAG & \ttfamily \,!DB\,\\\midrule -% \cmd{\Name} \cmd{\Name*} \cmd{\FName} & \YES & \YES & \NO & \NO & \NO & \NO\\ -% \cmd{\ForgetName} \cmd{\SubvertName} & \YES & \YES & \NO & \NO & \NO & \NO\\\midrule -% \cmd{\PName}\cmd{\PName*} & \YES & \YES & \YES & \NO & \NO & \NO\\\midrule -% \cmd{\AKA} \cmd{\AKA*} \cmd{\IndexRef} & \NO & \NO & \YES & \NO & \NO & \NO\\ -% \cmd{\ExcludeName} & \NO & \NO & \YES & \NO & \NO & \NO\\ -% \cmd{\IncludeName} \cmd{\IncludeName*} & \NO & \NO & \YES & \NO & \NO & \NO\\\midrule -% \cmd{\PretagName} & \NO & \NO & \NO & \YES & \NO & \NO\\\midrule -% \cmd{\TagName} \cmd{\UntagName} & \NO & \NO & \NO & \NO & \YES & \NO\\\midrule -% \cmd{\NameAddInfo} \cmd{\NameClearInfo} & \NO & \NO & \NO & \NO & \NO & \YES\\\bottomrule -% \end{tabular} -% \end{center}\bigskip -% -% \ReturnLink -% \newpage -% -% \subsection[Debug and Avoid Errors]{Debugging and Avoiding Errors} -% \label{sec:ErrorProt} -% -% \begin{center}\bfseries Debugging Macros\end{center} -% -% \DescribeMacro{\ShowPattern} -% \cmd{\ShowPattern} displays how the name arguments create name patterns. One can debug pattern collisions and other issues with this macro:\Version{3.3} -% \begin{quote} -% \fbox{\mystrut\ \cmd{\ShowPattern}\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate} } -% \end{quote} -% We used \cmd{\ShowPattern} in two of the tables on the previous page in order to illustrate name control patterns. We set the macro using a typewriter font, e.g.: |\texttt{\ShowPattern[Hernando]{de Soto}}|:\quad \texttt{\ShowPattern[Hernando]{de Soto}}\medskip -% -% \DescribeMacro{\ShowIdxPageref} -% \cmd{\ShowIdxPageref} displays a full index entry in the text. -% Its analogue is \cmd{\ShowIdxPageref*}, -% \DescribeMacro{\ShowIdxPageref*} -% which shows a short index entry. Both only show names as page references, even if they are cross-references\Version{3.3}: -% \begin{quote} -% \fbox{\vbox{\hbox{\mystrut\ \cmd{\ShowIdxPageref\ }\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate} }\par -% \hbox{\mystrut\ \cmd{\ShowIdxPageref*}\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate} }}} -% \end{quote} -% The full entry produced by \cmd{\ShowIdxPageref} can be affected by both index styles and tags produced by \cmd{\PretagName} and \cmd{\TagName}, e.g.: -% \begin{quote} -% |\texttt{\ShowIdxPageref[Hernando]{de Soto}}:|\\ -% \ShowIdxPageref[Hernando]{de Soto} -% \end{quote} -% \cmd{\ShowIdxPageref*} appears throughout this manual to illustrate basic index entries, e.g.: |\ShowIdxPageref*[Hernando]{de Soto}|:\quad \ShowIdxPageref*[Hernando]{de Soto} -% -% \begin{center}\bfseries Avoiding Common Errors\end{center} -% +% \begin{center}\bfseries More on Prefix Macros\end{center} % \begin{itemize} -% \item Keep it simple! Avoid unneeded macros and use the simplified interface. -% \item Compare index entries with names in the body text. -% \item Check package warnings. Set the \texttt{verbose} option if needed. -% \item Check arguments' braces and brackets to avoid errors like ``\texttt{Paragraph ended}'' and ``\texttt{Missing} \meta{grouping token} \texttt{inserted.}'' -% \item Do not format \meta{SNN},\meta{Affix} together as a pair. Format \meta{SNN} and \meta{Affix} separately (Section~\ref{sec:AltFormat}). -% \item Sort names in the index with \cmd{\PretagName} (Section~\ref{sec:IndexSort}). -% \item In package docs (\texttt{dtx} files) set up the \texttt{nameauth} environment and tags in the driver section to avoid errors. +% \item Prefix macros stack:\\ \hbox{}\quad |\CapThis\RevName\SkipIndex\Name[bar]{foo}| \qquad \CapThis\RevName\SkipIndex\Name[bar]{foo}. +% \item The Boolean flags governed by the prefix macros are reverted after the appropriate macros produce output in the text (or index) unless the output of the naming macros is suppressed. +% \item Except for \cmd{\SeeAlso}, use prefix macros only before a naming macro that is designed to print output in the text. +% \item Use \cmd{\SeeAlso}\Version{3.5} only with \cmd{\IndexRef}, \cmd{\AKA}, and \cmd{\PName}. Otherwise it will be reset by \cmd{\IndexName} and the naming macros. +% \item Using \cmd{\JustIndex}\Version{3.5} will cause name form modifiers to be reset. % \end{itemize} -% -% \begin{center}\bfseries Obsolete Syntax Caution\end{center} % +% Macros that do not take name arguments include: % \begin{itemize} -% \item The older syntax has restrictions (Section~\ref{sec:Obsolete}). Only the new syntax permits variant names, e.g.: \cmd{\Name*\{Henry, VIII\}[Tudor]} \Name*{Henry, VIII}[Tudor]. The new syntax is preferred. -% \item A proper form for the old syntax is \cmd{\Name*\{Henry\}[VIII]}: \Name*{Henry}[VIII]. -% \item \bgroup\IndexInactive\cmd{\Name[Henry]\{VIII\}} is a malformed Western name: ``\Name*[Henry]{VIII}'' and ``\Name[Henry]{VIII}.'' Likewise \cmd{\Name[Henry]\{VIII\}[Tudor]}: ``\Name*[Henry]{VIII}[Tudor]'' and ``\Name[Henry]{VIII}[Tudor].'' Both have the incorrect index entry ``\ShowIdxPageref*[Henry]{VIII}''.\egroup +% \item State-changing macros with broad effects (document, section, scope). +% \item State-changing macros with single-use effects (prefix macros). +% \item Macros that alter general \textsf{nameauth} package behavior. +% \item Formatting macros. % \end{itemize} +% +% \subsection{Various Hints} +% \label{sec:Hints} % -% \begin{center}\bfseries Standard Warnings\end{center} +% In this section we make a brief foray into some technical issues that are good to keep in mind, but not overwhelming at this point. Sections~\ref{sec:Warnings} and~\ref{sec:Errors} go into greater detail on the things that one can do to diagnose missteps and avoid errors. The point here is to keep the quick start quick. % -% \begin{itemize} -% \item If one defines shorthand macros in the \texttt{nameauth} environment whose control sequence already exists, warnings always appear. For example: -% \begin{quote}\small\StartNum -% \begin{verbatim} -%\PretagName[E.\,B.]{White}{White, E.B.} -%\begin{nameauth} -% \< White & E.B. & White & > % v.1 -% \< White & E.\,B. & White & > % v.2 -%\end{nameauth}\end{verbatim} -% \end{quote} -%\begin{nameauth} -% \< White & E.B. & White & > -% \< White & E.\,B. & White & > -%\end{nameauth} -% \item \cmd{\White} gives ``\White''. Its pattern is: \texttt{\ShowPattern[E.\,B.]{White}}. We lost the first version. We forget \White\ for later.\ForgetName[E.\,B.]{White} There should be two package warnings in this section for the redefinition of \cmd{\White}, because we defined it in the driver, then again here twice. -% \item This could be a problem if a name shorthand replaces an actual macro that is used for something else and breaks that macro. -% \item Then again, if one uses, e.g., a new \texttt{nameauth} environment per chapter, these warnings may be harmless. User discretion is advised. -% \end{itemize} +% \begin{center}\bfseries Automatic Stripping of Spaces\end{center} +% The\SPatInfo{\ShowPattern[Martin Luther]{King, Jr.}} \textsf{nameauth} package trims extra spaces \emph{around} name arguments to prevent errors. Here, name arguments include \meta{FNN}, \meta{SNN}, \meta{Affix}, and \meta{Alternate}. For example,\IdxInfo{\ShowIdxPageref*[Martin Luther]{King, Jr.}} instead of being two different names, below we have the same name in a first, then subsequent use. We use no name formatting below in order to show this:\bigskip % -% \begin{center}\bfseries Verbose Warnings\end{center} +% \begingroup^^A Local scope for format +% \renewcommand*\NamesFormat{} +% \renewcommand*\MainNameHook{} +% \leavevmode\quad\begin{minipage}[c]{0.43\textwidth}\small +% \StartNum +% \begin{verbatim*} +%\Name*[Martin Luther] +%{King,Jr.}\\ +%\Name*[ Martin Luther ] +%{ King, Jr. }\end{verbatim*} +% \end{minipage} +% \begin{minipage}[c]{0.45\textwidth}\small +% \def\sep{\vrule width0.5pt\kern-0.5pt}% +% \begin{tabular}{@{}ll@{}} +% No spaces: & \sep\SubvertThis\FName[Martin Luther]{King,Jr.}\sep\ \sep\Name*[Martin Luther]{King,Jr.}[\ignorespaces]\sep\\ +% & \sep\hphantom{Martin Luther}\sep\ \sep\hphantom{King Jr.}\sep\\ +% Spaces: & \sep\FName[ Martin Luther ] +% { King, Jr. }\sep\ \sep\Name*[ Martin Luther ] +% { King, Jr. }[\ignorespaces]\sep\\ +% \end{tabular} +% \end{minipage}\bigskip % -% \noindent Package warnings result from the following \emph{only} when the \texttt{verbose} option is used because we do not want the default to be ``chatty'': -% \begin{itemize} -% \item Creating an index page reference after using a name as an xref or excluding it. Not allowed. -% \item Creating the same cross-reference multiple times. Not allowed. -% \item Using \cmd{\ExcludeName} on an xref. Not allowed. -% \item Using\Version{3.3} \cmd{\IncludeName} on an xref. Not allowed. -% \item Using \cmd{\ExcludeName} to exclude a name that exists is allowed, but a warning still results. -% \item \cmd{\PretagName} sorts xrefs, but also creates ``informational warnings.'' -% \item Using \cmd{\TagName} and \cmd{\UntagName} on xrefs. No tag allowed. -% \end{itemize} +% \IndexInactive +% Using macros that expand to spaces will produce a totally different name:\bigskip % -% \begin{center}\bfseries Error Protection Strategies\end{center} -% -% \noindent The\Info{extra spaces} \textsf{nameauth} package trims extra spaces \emph{around} name arguments to prevent errors like multiple index entries that appear due to extra spaces. \LaTeX\ usually compacts internal spaces. For example, instead of being two different names, below we have the same name in a first, then subsequent use: -% -% \begin{center}\small\MyStretch\ForgetName[Martin Luther]{King, Jr.} -% \begin{tabular}{ll} -% \cmd{\Name*[Martin Luther]\{King,Jr.\}} & \Name*[Martin Luther]{King,Jr.}\\ -% \cmd{\Name*}\texttt{[\textvisiblespace\textvisiblespace Martin\textvisiblespace\textvisiblespace Luther\textvisiblespace\textvisiblespace]\{\textvisiblespace\textvisiblespace King\textvisiblespace\textvisiblespace,\textvisiblespace\textvisiblespace Jr.\textvisiblespace\textvisiblespace\}} & \Name*[ Martin Luther ]{ King , Jr. }\\ -% \end{tabular} -% \end{center} +% \leavevmode\quad\begin{minipage}[c]{0.43\textwidth}\small +% \StartNum +% \begin{verbatim*} +%\Name*[ Martin Luther ] +%{ King, Jr. }\\ +%\Name*[\ Martin Luther\ ] +%{\ King, Jr.\ }\end{verbatim*} +% \end{minipage} +% \begin{minipage}[c]{0.45\textwidth}\small +% \def\sep{\vrule width0.5pt\kern-0.5pt}% +% \begin{tabular}{@{}ll@{}} +% Spaces:\hphantom{No} & \sep\SubvertThis\FName[ Martin Luther ]{ King, Jr. }\sep\ \sep\Name*[ Martin Luther ]{ King, Jr. }[\ignorespaces]\sep\\ +% & \sep\hphantom{Martin Luther}\sep\ \sep\hphantom{King Jr.}\sep\\ +% Macros: & \sep\SubvertThis\FName[\ Martin Luther\ ] +% {\ King, Jr.\ }\sep\ \sep\Name*[\ Martin Luther\ ] +% {\ King, Jr.\ }[\ignorespaces]\sep\\ +% \end{tabular}\smallskip % -% This does not include explicit spaces from \cmd{\space}, etc. For example, the pattern \texttt{\ShowPattern[Martin Luther]{King, Jr.}} comes from \cmd{\Name[Martin Luther]\{King, Jr.\}} while \texttt{\ShowPattern[Martin~Luther]{King, Jr.}} comes from \cmd{\Name[Martin}|~|\texttt{Luther]\{King, Jr.\}}. The tilde appears as a non-breaking space in the text. +% Simple Pattern:\\ +% \hphantom{Index: }\fbox{\texttt{\ShowPattern[\ Martin Luther\ ]{\ King, Jr.\ }}}\\ +% Index: \fbox{\ShowIdxPageref*[\ Martin Luther\ ]{\ King, Jr.\ }} +% \end{minipage}\bigskip +% \endgroup^^A Local scope for format +% +% Yet one may have to include a non-breaking space (active character |~|) after a name particle like \textit{de} to keep the name from breaking badly (Section~\ref{sec:NameParticles}). One must use that non-breaking space consistently to avoid errors. % \newpage -% -% Full\Info{full stop\break detection} stops appear in one's initials and in affixes like ``Jr.'' (junior), ``Sr.'' (senior), ``d.\,J.'' (\textit{der Jüngere}), and ``d.\,Ä.'' (\textit{der Ältere}). The naming macros and some of the alternate name macros (Section~\ref{sec:AKA}) check if the printed name ends with a full stop and is followed by one. They gobble the extra full stop: +% +% \begin{center}\bfseries Full Stop Detection\end{center} +% Full stops appear in one's initials and in affixes like ``Jr''. (junior), ``Sr''. (senior), ``d.\,J''. (\textit{der Jüngere}), and ``d.\,Ä''. (\textit{der Ältere}). The naming macros and some alternate name macros (Section~\ref{sec:AKA}) check if the printed name ends with a full stop and is followed by one. They gobble the extra full stop. Below we resume formatting and pretend that we have not seen Dr. King's name yet: % \begin{quote}\small\ForgetName[Martin Luther]{King, Jr.} -% |This is Rev. Dr. \Name[Martin Luther]{King, Jr.}.|\\ +% |This is Rev. Dr. \Name[Martin Luther]{King, Jr.}.|\SPatInfo{\ShowPattern[Martin Luther]{King,Jr.}}\\ % This is Rev. Dr. \Name[Martin Luther]{King, Jr.}. \hfill Full stop is gobbled.\\[2ex] % |This is Rev. Dr. \Name[Martin Luther]{King, Jr.}.|\\ % This is Rev. Dr. \Name[Martin Luther]{King, Jr.}. \hfill Full stop is not gobbled.\\[2ex] @@ -1501,176 +1513,228 @@ the README.txt or README for more information. % His initials are \FName[Martin Luther]{King, Jr.}[M.L.]. \hfill Full stop is gobbled. % \end{quote} % -% Take\Info{grouping\break issues} care when using braces and spaces with a name at the end of a sentence. Braces can change name arguments, even though they look the same. We disable indexing for the three points below:\IndexInactive +% \begin{center}\bfseries Caveats with Grouping\end{center} +% Take care when using braces and spaces with a name at the end of a sentence. Braces will change the control sequence patterns generated by name arguments. Put simply, this means that both the names and their index entries will be different and behave differently\,---\,even though they look the same (Sections~\ref{sec:IndexSort}, \ref{sec:NamePatterns}). We disable indexing for the three points below:\IndexInactive % \begin{itemize}\small -% \item If one encapsulates a name in braces, the punctuation detection fails:\\ +% \item If one\SPatInfo{\ShowPattern[Martin Luther]{King,Jr.}} encapsulates a name in braces, the punctuation detection fails:\\ % |This is Rev. Dr. {\Name*[Martin Luther]{King, Jr.}}.|\\ % This is Rev. Dr. {\Name*[Martin Luther]{King, Jr.}}. \hfill Full stop is not gobbled. % \item[] A solution encapsulates both the name and the full stop:\\ % |This is Rev. Dr. {\Name*[Martin Luther]{King, Jr.}.}|\\ % This is Rev. Dr. {\Name*[Martin Luther]{King, Jr.}.} \hfill Full stop is gobbled. -% \item If one encapsulates \meta{Affix} in braces, the punctuation detection fails:\\ +% \item If one\SPatInfo{\ShowPattern[Martin Luther]{King, {Jr.}}\break \ShowPattern[Martin Luther]{King, {Jr}.}} encapsulates \meta{Affix} in braces, the punctuation detection fails:\\ % |This is Rev. Dr. \Name*[Martin Luther]{King, {Jr.}}.|\\ % This is Rev. Dr. \Name*[Martin Luther]{King, {Jr.}}. \hfill Full stop is not gobbled. -% \item[] The solution leaves the full stop in \meta{Affix} outside the braces:\\ +% \item[] A solution\vspace{-1ex}\IdxInfo{\ShowIdxPageref*[Martin Luther]{King, {Jr.}}\break \ShowIdxPageref*[Martin Luther]{King, {Jr}.}\break (Looks identical, but not.)}\vspace{1ex} leaves the full stop in \meta{Affix} outside the braces:\\ % |This is Rev. Dr. \Name*[Martin Luther]{King, {Jr}.}.|\\ % This is Rev. Dr. \Name*[Martin Luther]{King, {Jr}.}. \hfill Full stop is gobbled. -% \item[] The name patterns, however, are different, creating different names:\\ -% \texttt{\ShowPattern[Martin Luther]{King, {Jr.}}}\\ -% \texttt{\ShowPattern[Martin Luther]{King, {Jr}.}} -% \item If one leaves an extra space after a name, the punctuation detection fails:\\ +% \item[] Yet the name patterns (Section~\ref{sec:NamePatterns}) are different, creating two different names and two different index entries. +% \item A space\SPatInfo{\ShowPattern[Martin Luther]{King,Jr.}} between a name and full stop hinders punctuation detection, except with the quick interface:\\ % |This is Rev. Dr. \Name*[Martin Luther]{King, Jr.}|\texttt{\textvisiblespace.}\\ % This is Rev. Dr. \Name*[Martin Luther]{King, Jr.} . \hfill Full stop is not gobbled. % \item[] The solution removes the extra space:\\ % |This is Rev. Dr. \Name*[Martin Luther]{King, Jr.}.|\\ % This is Rev. Dr. \Name*[Martin Luther]{King, Jr.}. \hfill Full stop is gobbled. % \end{itemize}\IndexActive +% \newpage % -% Variations\Info{active chars\break and macros} in the use of active characters and control sequences also change name arguments and index sorting (Section~\ref{sec:IndexSort}; cf.~\ref{sec:Unicode} and~\ref{sec:TeXengines}): -% \begin{itemize}\small -% \item |\Name*{Æthelred, II}| \Name*{Æthelred, II};\hfill Pattern: \texttt{\ShowPattern{Æthelred, II}}\footnote{With \texttt{pdflatex} / \texttt{latex}, the glyphs \texttt{ÃĘ} correspond to \cmd{\IeC\{\textbackslash AE\}}.}\newline We have seen this name earlier. -% \item |\SkipIndex\Name{\AE thelred, II}| \SkipIndex\Name{\AE thelred, II};\hfill Pattern: \texttt{\ShowPattern{\AE thelred, II}}\newline This is a new name that looks the same.\newpage -% \item |\Name{Bo\"ethius}| \Name{Bo\"ethius};\hfill Pattern: \texttt{\ShowPattern{Bo\"ethius}}\newline We introduce this new name. -% \item |\SkipIndex\Name{Boëthius}| \SkipIndex\Name{Boëthius} \hfill Pattern: \texttt{\ShowPattern{Boëthius}}\footnote{With \texttt{pdflatex} / \texttt{latex}, the glyphs \texttt{Ãń} correspond to \cmd{\IeC\{\textbackslash"e\}}.}\newline This is a different name that looks the same. -% \item |\SkipIndex\Name{Bo{\"e}thius}| \SkipIndex\Name{Bo{\"e}thius};\hfill Pattern: \texttt{\ShowPattern{Bo{\"e}thius}}\newline This also is a different name that looks the same. -% \end{itemize} -% -% Omit\Info{formatting\break initials} spaces between initials; see Bringhurst, \textit{Elements of Typographic Style}. If a style guide requires spaces, try thin spaces. Use \cmd{\PretagName} to sort those names (Section~\ref{sec:IndexSort}). Below we use no formatting:\bigskip +% \begin{center}\bfseries Caveats with Active Characters\end{center} +% Variations in the use of active characters and control sequences also change name arguments, name control patterns, and index sorting. These changes can depend on the \LaTeX\ engine being used, but often different names are just different, even if they appear the same (Section~\ref{sec:IndexSort}; cf.~\ref{sec:Unicode} and~\ref{sec:TeXengines}): +% \begin{enumerate}\small +% \item |\Name*{Æthelred, II}|\dotfill \Name*{Æthelred, II}\SPatInfo{\ShowPattern{Æthelred, II} \textrm{(1)}\break \ShowPattern{\AE thelred, II} \textrm{(2)}\break \ShowPattern{Bo\"ethius} \textrm{(3)}\break \ShowPattern{Boëthius} \textrm{(4)}\break \ShowPattern{Bo{\"e}thius} \textrm{(5)}}\footnote{With \texttt{pdflatex} and \texttt{latex}, in \texttt{\ShowPattern{Æthelred, II}} the glyphs \texttt{ÃĘ} correspond to \cmd{\IeC\{}\cmd{\AE\}}.}\newline We have seen this name earlier. +% \item |\SkipIndex\Name{\AE thelred, II}|\dotfill \SkipIndex\Name{\AE thelred, II}\hbox to 0.45em{\hfill}\newline This is a new name that looks the same. +% \item |\Name{Bo\"ethius}|\dotfill \Name{Bo\"ethius}\hbox to 0.45em{\hfill}\newline We introduce this new name. +% \item |\SkipIndex\Name{Boëthius}|\dotfill \SkipIndex\Name{Boëthius}\footnote{With \texttt{pdflatex} and \texttt{latex}, in \texttt{\ShowPattern{Boëthius}} the glyphs \texttt{Ãń} correspond to \cmd{\IeC\{}\cmd{\"e\}}.}\newline This is a different name that looks the same. +% \item |\SkipIndex\Name{Bo{\"e}thius}|\dotfill \SkipIndex\Name{Bo{\"e}thius}\hbox to 0.45em{\hfill}\newline This is a third, different name that looks the same. +% \end{enumerate} +% +% \begin{center}\bfseries Formatting Initials\end{center} +% This is a thorny topic. Some publishers are dead-set on having a space between initials. Many designers find that practice to be inelegant at best. Robert Bringhurst wisely advises one to omit spaces between initials.\footnote{Robert Bringhurst, \textit{Elements of Typographic Style} 3.2 ed. (Point Roberts, Washington: Hartley \& Marks, 2008.)} +% +% Yet fighting with one's editor will be a lost cause unless one already has sufficient \textit{gravitas}. If a style guide requires spaces, try thin spaces. Use \cmd{\PretagName} to sort those names (Section~\ref{sec:IndexSort}). Below we use no formatting:\bigskip % % \leavevmode\quad\begin{minipage}[c]{0.45\textwidth}\small % \StartNum % \begin{verbatim} %\PretagName[E.\,B.]{White}% -% {White, E.B.} +% {White, Elwyn} %\begin{nameauth} % \< White & E.\,B. & White & > %\end{nameauth}\end{verbatim} % \end{minipage} -% \begin{minipage}[c]{0.35\textwidth}\normalsize\renewcommand*\NamesFormat{} +% \begin{minipage}[c]{0.35\textwidth}\renewcommand*\NamesFormat{} % \def\sep{\vrule width0.5pt\kern-0.5pt}% -% \begin{tabular}{@{}ll@{}}\hline -% & \sep\hphantom{E.}\sep\,\sep\hphantom{B.}\sep\hphantom{\ }\sep\hphantom{White}\\ +% \begin{tabular}{@{}ll@{}}\toprule % \cmd{\White} & \hspace{0.48pt}\White\\ % & \sep\hphantom{E.}\sep\,\sep\hphantom{B.}\sep\hphantom{\ }\sep\hphantom{White}\\\hline % & \sep\hphantom{E.}\sep\ \sep\hphantom{B.}\sep\ \sep\hphantom{White}\\ -% Normal text:\hfill & E. B. White\\ -% & \sep\hphantom{E.}\sep\ \sep\hphantom{B.}\sep\ \sep\hphantom{White}\\\hline +% Normal text:\hfill & E. B. White\\\bottomrule % \end{tabular} % \end{minipage}\bigskip % -% English\Info{hyphenation} contains names from many cultures. The rules for hyphenation go to the heart of how names with non-English origins should be pronounced. With \textsf{nameauth}, one can use either optional hyphens or the \textsf{babel}\,/\,\textsf{polyglossia} packages to handle such names: -% \NameAddInfo[John]{\de{Strietelmeier}}{late professor at Valparaiso University} +% \begin{center}\bfseries Multicultural Hyphenation\end{center} +% Names can be hyphenated to reflect their cultural and linguistic origins. With \textsf{nameauth}, one can use either optional hyphens or the \textsf{babel}/\textsf{polyglossia} packages to handle such names. Below we offer a simplified example without alternate formatting (Section~\ref{sec:AltFormat}): % \begin{quote}\small % \StartNum % \begin{verbatim} %\newcommand\de[1]{\foreignlanguage{ngerman}{#1}} % % or polyglossia: \newcommand\de[1]{\textgerman{#1}} %\NameAddInfo[John]{\de{Strietelmeier}}% -% {late professor at Valparaiso University} +% {a professor at Valparaiso University} %\begin{nameauth} % \< Striet & John & \de{Strietelmeier} & > %\end{nameauth} %\PretagName[John]{\de{Strietelmeier}}{Strietelmeier, John}\end{verbatim} % \end{quote} +% \newpage +% +% Now we demonstrate three different ways of engaging this problem. In the first example we use the default hyphenation. We omit this version from the index. One might think that the name were pronounced ``stree-et-el-mai-er'':\medskip +% +% \noindent \emph{Not fixed:}\SPatInfo{\ShowPattern[John]{Strietelmeier}} +% +% \noindent In English, some names come from other cultures. These names, like \SkipIndex\Name[John]{Strietelmeier}, |\SkipIndex\Name[John]{Strietelmeier},| can break badly.\medskip +% +% The next example uses discretionary hyphens. It is a different name from the one above and one must be consistent with the discretionary hyphens. We also omit this version from the index:\medskip % -% \noindent \emph{Not fixed:}\\ -% \noindent In English, some names come from other cultures. These names, like \SkipIndex\Name[John]{Strietelmeier} \cmd{\SkipIndex}\cmd{\Name[John]\{Strietelmeier\}} can break badly.\smallskip +% \noindent \emph{Fixed with discretionary hyphens:}\SPatInfo{\ShowPattern[John]{Strie\-tel\-meier}}\medskip % -% \noindent \emph{Fixed with discretionary hyphens:}\\ -% \noindent In English, some names come from other cultures. These names, like \SkipIndex\Name[John]{Strie\-tel\-meier}, \cmd{\SkipIndex}\cmd{\Name[John]\{Strie\textbackslash-tel\textbackslash-meier\}} could break badly.\smallskip +% \noindent In English, some names come from other cultures. These names, like \SkipIndex\Name[John]{Strie\-tel\-meier}, |\SkipIndex\Name[John]{Strie\-tel\-meier},| could break badly.\medskip % -% \noindent \emph{Fixed with language packages:}\\ -% \noindent In English, some names come from other cultures. These names, like \Striet, \cmd{\Striet} could break badly.\medskip +% Finally we use what may be the best general solution, the \textsf{babel} or \textsf{polyglossia} packages. Since the leading element of \meta{SNN} is a macro, using \cmd{\CapThis} would halt \LaTeX\ with errors unless we used alternate formatting (Section~\ref{sec:AltFormat}):\medskip % -% \Striet\ (\NameQueryInfo[John]{\de{Strietelmeier}}) is neither pronounced nor hyphenated as ``Stri-etel-meier''; rather, it is pronounced and hyphenated as ``Strie-tel-meier''. See Sections~\ref{sec:NameParticles} and~\ref{sec:AltFormat} when using macros in name arguments. -% Using \textsf{babel} or \textsf{polyglossia} likely is best. +% \noindent \emph{Fixed with language packages:}\SPatInfo{\ShowPattern[John]{\de{Strietelmeier}}}\medskip % +% \noindent In English, some names come from other cultures. These names, like \Striet, \cmd{\Striet,} could break badly. \Striet\ was at Valparaiso University. +% +% \begin{center}\bfseries Obsolete Syntax Caution\end{center} +% We moved the discussion of the obsolete syntax to Section~\ref{sec:Obsolete} because, as this package matures, we do not expect people to use it much anymore. There are more advantages to using the current syntax. +% +% \begin{enumerate} +% \item Only\SPatInfo{\ShowPattern{Henry, VIII}[Tudor]\hfil \textrm{(1--2)}\break \ShowPattern[Henry]{VIII}[Tudor]\hfil \textrm{\ \ \ (3)}} the newer syntax permits variants: \cmd{\Name*\{Henry, VIII\}[Tudor]} \Name*{Henry, VIII}[Tudor]. The new syntax is preferred. +% \item A proper form for the old syntax is \cmd{\Name*\{Henry\}[VIII]}: \Name*{Henry}[VIII]. Both\vspace{-2ex}\IdxInfo{\ShowIdxPageref*{Henry}[VIII]\hfil \textrm{(1--2)}\break \ShowIdxPageref*[Henry]{VIII}[Tudor]\hfil \textrm{\ \ (3)}}\vspace{2ex} old and new share name patterns (Section~\ref{sec:NamePatterns}). +% \item \bgroup\IndexInactive\cmd{\Name[Henry]\{VIII\}} is a malformed Western name: ``\Name*[Henry]{VIII}'' and ``\Name[Henry]{VIII}''. Likewise \cmd{\Name[Henry]\{VIII\}[Tudor]}: ``\Name*[Henry]{VIII}[Tudor]'' and ``\Name[Henry]{VIII}[Tudor]''. Both have the incorrect index entry ``\ShowIdxPageref*[Henry]{VIII}''.\egroup +% \end{enumerate} +% % \ReturnLink +% \vfill +% +% \AltFormatActive^^A +% \begin{verse} +% 'Tis but thy name that is my enemy;\dots\\ +% What's in a name? That which we call a rose\\ +% By any other name would smell as sweet;\\ +% So Romeo would, were he not Romeo call'd,\\ +% Retain that dear perfection which he owes\\ +% Without that title. Romeo, doff thy name,\\ +% And for that name which is no part of thee\\ +% Take all myself.\\[1ex]\hfill---\Shak, \textit{Romeo and Juliet}, Act II, Scene II +% \end{verse} +% \AltFormatInactive^^A % \newpage % % \section{Detailed Usage} -% +% % \subsection{Package Options} % \label{sec:PkgOptions} % % One includes the \textsf{nameauth} package thus: % \begin{quote} -% \fbox{\mystrut\ \cmd{\usepackage[}\meta{\(option_1\)}\texttt{,}\meta{\(option_2\)}\texttt{,}\dots\texttt{,}\meta{\(option_n\)}\texttt{]\{nameauth\} }} +% \fbox{ +% \begin{tabular}{l} +% {\Large\strut}\cmd{\usepackage[}\meta{\(option_1\)}\texttt{,}\meta{\(option_2\)}\texttt{,}\dots\texttt{,}\meta{\(option_n\)}\texttt{]\{nameauth\}} +% \end{tabular} +% } % \end{quote} % The options have no required order. Still, we discuss them from the general to the specific, as the headings below indicate. In the listings below, {\bfseries implicit default options are boldface and need not be invoked by the user.} {\color{nared}Non-default options are in red and must be invoked explicitly.} % % \begin{center}\bfseries Choosing Features\end{center} % -% \noindent{\bfseries Enable Package Warnings}\medskip\\ -% \bgroup\begin{tabular}{p{0.22\textwidth}p{0.6\textwidth}} -% \leavevmode\color{nared}\quad\texttt{verbose} & \leavevmode\color{nared}Show warnings about index cross-references.\medskip\\ -% \end{tabular}\egroup -% -% \noindent The default\Version{3.0} suppresses package warnings from the indexing macros. Warnings from the \texttt{nameauth} environment are not suppressed.\bigskip -% -% \noindent{\bfseries Choose Formatting}\medskip\\ +% \noindent{\bfseries Choose Formatting System}\medskip\\ % \bgroup\begin{tabular}{p{0.22\textwidth}p{0.6\textwidth}} -% \bfseries\quad\texttt{mainmatter} & \bfseries Start with ``main-matter names'' and formatting hooks (see also page~\pageref{page:PostProcess}).\smallskip\\ -% \leavevmode\color{nared}\quad\texttt{frontmatter} & \leavevmode\color{nared}Start with ``front-matter names'' and hooks.\smallskip\\ +% \bfseries\quad\texttt{mainmatter} & \bfseries Start with ``main-matter names'' and formatting hooks \normalfont (see also page~\pageref{page:PostProcess}).\smallskip\\ +% \leavevmode\color{nared}\quad\texttt{frontmatter} & \leavevmode\color{nared}Start with ``front-matter names'' and hooks until \cmd{\NamesActive} starts the main system.\smallskip\\ % \leavevmode\color{nared}\quad\texttt{alwaysformat} & \leavevmode\color{nared}Use only respective ``first use'' formatting hooks.\smallskip\\ -% \leavevmode\color{nared}\quad\texttt{formatAKA} & \leavevmode\color{nared}Format the first use of a name with \cmd{\AKA} like the first use of a name with \cmd{\Name}.\smallskip\\ -% \leavevmode\color{nared}\quad\texttt{oldAKA} & \leavevmode\color{nared}Force \cmd{\AKA*} to act like it did before version 3.0.\smallskip\\ -% \leavevmode\color{nared}\quad\texttt{oldreset} & \leavevmode\color{nared}Reset per-use name flags locally within the naming macros, as before version 3.3.\smallskip\\ -% \leavevmode\color{nared}\quad\texttt{oldpass} & \leavevmode\color{nared}When \cmd{\Justindex} is called, allow long\,/\,short flags to pass through, as before version 3.3.\medskip\\ +% \leavevmode\color{nared}\quad\texttt{formatAKA} & \leavevmode\color{nared}Format the first use of a name with \cmd{\AKA} like the first use of a name with \cmd{\Name}.\medskip\\ % \end{tabular}\egroup -% -% \noindent The \texttt{mainmatter} option and the \texttt{frontmatter} option enable two different systems of name use and formatting. They are mutually exclusive. \cmd{\NamesActive} starts the main matter system when \texttt{frontmatter} is used. See Section~\ref{sec:Formatting}. -% -% The \texttt{alwaysformat} option forces ``first use'' hooks globally in both naming systems. Its use is limited in current versions of \textsf{nameauth}. % -% The\Version{3.1} \texttt{formatAKA} option permits \cmd{\AKA} to use the ``first use'' formatting hooks. This enables \cmd{\ForceName} to trigger those hooks at will (Section~\ref{sec:AKA}). Otherwise \cmd{\AKA} uses ``subsequent use'' hooks. +% \noindent The \texttt{mainmatter} and \texttt{frontmatter} options enable two respectively independent systems of name use and formatting. See Section~\ref{sec:Formatting}. % -% Using the\Version{3.0} \texttt{oldAKA} option forces \cmd{\AKA*} always to print a ``forename'' argument in the text, as in versions before 3.0. Otherwise the current behavior of \cmd{\AKA*} prints in the same fashion as \cmd{\FName} (see Sections~\ref{sec:FName} and~\ref{sec:AKA}). +% The \texttt{alwaysformat} option forces ``first use'' hooks globally in both naming systems. Its use is limited in current versions of \textsf{nameauth}. % -% Used together,\Version{3.3} the next two options restore pre-version 3.3 handling of flags that could lead to undocumented behavior. The \texttt{oldreset} option causes all Boolean flags related to the prefix macros and long\,/\,short name forms to be reset locally. The new default is to reset them globally (Section~\ref{sec:Customize}). Likewise, the \texttt{oldpass} option allows the long\,/\,short flags to pass through \cmd{\JustIndex} instead of being reset (Section~\ref{sec:IndexControl}). -% \newpage +% The\Version{3.1} \texttt{formatAKA} option permits \cmd{\AKA} to use the ``first use'' formatting hooks. This enables \cmd{\ForceName} to trigger those hooks at will (Section~\ref{sec:AKA}). Otherwise \cmd{\AKA} only uses ``subsequent use'' formatting hooks.\bigskip % -% \noindent{\bfseries Enable\,/\,Disable Indexing}\medskip\\ +% \noindent{\bfseries Enable/Disable Indexing}\medskip\\ % \bgroup\begin{tabular}{p{0.22\textwidth}p{0.6\textwidth}} % \quad\bfseries\texttt{index} & \bfseries Create index entries in place with names.\smallskip\\ % \leavevmode\color{nared}\quad\texttt{noindex} & \leavevmode\color{nared}Suppress indexing of names.\medskip\\ % \end{tabular}\egroup -% -% \noindent These options and related macros do not affect the normal use of \cmd{\index}. They apply only to the \textsf{nameauth} package macros. The default \texttt{index} option enables name indexing right away. The \texttt{noindex} option disables the indexing of names until \cmd{\IndexActive} enables it. \emph{Caution:}\Warn{} using \texttt{noindex} and \cmd{\IndexInactive} prevents index tags until you call \cmd{\IndexActive}, as explained also in Section~\ref{sec:IndexControl}.\bigskip % -% \noindent{\bfseries Enable\,/\,Disable Index Sorting}\medskip\\ +% \noindent These options and related macros apply only to the \textsf{nameauth} package macros. The default \texttt{index} option enables name indexing right away. The \texttt{noindex} option disables the indexing of names until \cmd{\IndexActive} enables it. \emph{Caution:}\Warn{} using \texttt{noindex} and \cmd{\IndexInactive} prevents index tags until you call \cmd{\IndexActive}, as explained also in Section~\ref{sec:GeneralIndex}. For indexing feature priority, see page~\pageref{page:Priorities}.\bigskip +% +% \noindent{\bfseries Enable/Disable Index Sorting}\medskip\\ % \bgroup\begin{tabular}{p{0.22\textwidth}p{0.6\textwidth}} % \quad\bfseries\texttt{pretag} & \bfseries Create sort keys used with \texttt{makeindex}.\smallskip\\ % \leavevmode\color{nared}\quad\texttt{nopretag} & \leavevmode\color{nared}Do not create sort keys.\medskip\\ % \end{tabular}\egroup -% -% \noindent The default allows \cmd{\PretagName} to create sort keys used with \texttt{makeindex}. The \texttt{nopretag} option disables the sorting mechanism, e.g., if a different sorting method is used with \texttt{xindy}. See Section~\ref{sec:IndexSort}. +% +% \noindent The default allows \cmd{\PretagName} to create sort keys used with \texttt{makeindex}. The \texttt{nopretag} option disables the sorting mechanism and causes \cmd{\PretagName} only to emit warnings. That is designed for cases that use different sorting methods, such as \texttt{xindy}. See Section~\ref{sec:IndexSort}.\newpage +% +% \noindent{\bfseries Enable ``Global'' Decision Paths}\medskip\\ +% \bgroup\begin{tabular}{p{0.22\textwidth}p{0.6\textwidth}} +% \leavevmode\color{nared}\quad\texttt{globaltest} & \leavevmode\color{nared}Do not put name decision paths in a local scope.\medskip\\ +% \end{tabular}\egroup +% +% \noindent The default puts the decision paths of \cmd{\IfMainName}, etc., into groups with local scope (Section~\ref{sec:NameTests}). This option removes that scoping.\bigskip +% +% \noindent{\bfseries Enable Package Warnings}\medskip\\ +% \bgroup\begin{tabular}{p{0.22\textwidth}p{0.6\textwidth}} +% \leavevmode\color{nared}\quad\texttt{verbose} & \leavevmode\color{nared}Show more diagnostic warnings.\medskip\\ +% \end{tabular}\egroup +% +% \noindent The default suppresses all but the most essential package warnings. Increasing the warnings may help to debug index page entries, cross-references, and exclusions.\bigskip +% +% \noindent{\bfseries Choose Version Compatibility}\medskip\\ +% \textbf{Using these options will increase the chance of undocumented behavior.} They are included only for the sake of backward compatibility.\medskip\\ +% \bgroup\begin{tabular}{p{0.22\textwidth}p{0.6\textwidth}} +% \leavevmode\color{nared}\quad\texttt{oldAKA} & \leavevmode\color{nared}Force \cmd{\AKA*} to act like it did before version 3.0, instead of like \cmd{\FName}.\smallskip\\ +% \leavevmode\color{nared}\quad\texttt{oldreset} & \leavevmode\color{nared}Reset per-use name flags locally; let \cmd{\ForgetThis} and \cmd{\SubvertThis} pass through \cmd{\AKA} (pre-v3.3). Let \cmd{\SeeAlso} pass through \cmd{\IndexName} and other macros. Keep \cmd{\IndexName} and \cmd{\IndexRef} from resetting \cmd{\SkipIndex} (pre-version 3.5).\smallskip\\ +% \leavevmode\color{nared}\quad\texttt{oldpass} & \leavevmode\color{nared}When \cmd{\Justindex} is called, allow long/short flags to pass through, as before version 3.3.\smallskip\\ +% \leavevmode\color{nared}\quad\texttt{oldtoks} & \leavevmode\color{nared}Token registers holding the arguments of the last-used name are set locally, as before version 3.5.\smallskip\\ +% \leavevmode\color{nared}\quad\texttt{oldsee} & \leavevmode\color{nared}Allow lax handling of \textit{see} references that are extant names, as before version 3.5.\medskip\\ +% \end{tabular}\egroup +% +% \noindent Previously, local scope for Boolean flags related to the prefix macros and long/short name forms could produce unexpected results, but that could hide the problems with some flags not being reset by \cmd{\AKA}, \cmd{\AKA*}, and the use of \cmd{\JustIndex}. Global name token registers are preferable, as is the newer, stricter control over \textit{see} references related to index page entries. +% +% \begin{center} +% \begin{tabular}{rr}\toprule +% \textsf{nameauth} version & compatibility options to approximate:\\\midrule +% \rowcolor{grey}2.6 & \texttt{oldAKA,oldpass,oldreset,oldtoks,oldsee}\\ +% 3.0--3.2 & \texttt{oldpass,oldreset,oldtoks,oldsee}\\ +% \rowcolor{grey}3.3--3.4 & \texttt{oldreset,oldtoks,oldsee}\\\bottomrule +% \end{tabular} +% \end{center}\leavevmode % % \begin{center}\bfseries Affect the Syntax of Names\end{center} % -% \noindent{\bfseries Show\,/\,Hide Affix Commas}\medskip\\ +% \noindent{\bfseries Show/Hide Affix Commas}\medskip\\ % \bgroup\begin{tabular}{p{0.22\textwidth}p{0.6\textwidth}} % \quad\bfseries\texttt{nocomma} & \bfseries Suppress commas between surnames and affixes, following the \textit{Chicago Manual of Style} and other conventions.\smallskip\\ % \leavevmode\color{nared}\quad\texttt{comma} & \leavevmode\color{nared}Retain commas between surnames and affixes.\medskip\\ % \end{tabular}\egroup -% -% \noindent If you use \emph{modern standards}, choose the default \texttt{nocomma} option to get, e.g., \Name[J.E.]{Carter, Jr.}[James Earl]. If you need to adopt \emph{older standards} that use commas between surnames and affixes, you have two choices: +% +% \noindent These options do not affect the index. On comma macro priority, see page~\pageref{page:Priorities}. If you use \emph{modern standards}, choose the default \texttt{nocomma} option to get, e.g., \Name[J.E.]{Carter, Jr.}[James Earl]. If you need to adopt \emph{older standards} that use commas between surnames and affixes, you have two choices: % \begin{enumerate} % \item The \texttt{comma} option globally produces, e.g., \ShowComma\Name*[J.E.]{Carter, Jr.}[James Earl]. % \item Section~\ref{sec:Affix} shows how one can use \cmd{\ShowComma} with the \texttt{nocomma} option and \cmd{\NoComma} with the \texttt{comma} option to get per-name results. -% \end{enumerate} -% In both cases, the display of commas (or the lack thereof) does not affect the appearance or the sorting of index entries.\bigskip +% \end{enumerate}\medskip % % \noindent{\bfseries Capitalize Entire Surnames}\medskip\\ % \bgroup\begin{tabular}{p{0.22\textwidth}p{0.6\textwidth}} % \quad\bfseries\texttt{normalcaps} & \bfseries Do not perform any special capitalization.\smallskip\\ -% \leavevmode\color{nared}\quad\texttt{allcaps} & \leavevmode\color{nared}Capitalize entire surnames, e.g., romanized Eastern names.\medskip\\ +% \leavevmode\color{nared}\quad\texttt{allcaps} & \leavevmode\color{nared}Capitalize entire surnames, e.g., romanized Eastern names, throughout the document.\medskip\\ % \end{tabular}\egroup -% -% \noindent This only capitalizes names printed in the body text. English standards usually do not propagate typographic changes into the index. % -% Still, you can use this package with non-English conventions (just not via these options). You can add, e.g., uppercase or small caps in surnames, formatting them also in the index. See also Sections~\ref{sec:AltFormat} and~\ref{sec:Hooksiii}. The simplified interface aids the embedding of control sequences in names. Section~\ref{sec:Eastern} deals with capitalization on a section-level and per-name basis. -% \newpage +% \noindent These options do not affect the index. See Section~\ref{sec:Eastern} for finer control. To capitalize names in the index, use all caps or alternate formatting (Section~\ref{sec:AltFormat}). On capitalization feature priority, see page~\pageref{page:Priorities}.\bigskip % % \noindent{\bfseries Reverse Name Order}\medskip\\ % \bgroup\begin{tabular}{p{0.22\textwidth}p{0.6\textwidth}} @@ -1678,16 +1742,13 @@ the README.txt or README for more information. % \leavevmode\color{nared}\quad\texttt{allreversed} & \leavevmode\color{nared}Print all name forms in ``smart'' reverse order.\smallskip\\ % \leavevmode\color{nared}\quad\texttt{allrevcomma} & \leavevmode\color{nared}Print all names in ``Surname, Forenames'' order, meant for Western names.\medskip\\ % \end{tabular}\egroup -% -% \noindent These three options are mutually exclusive. Section~\ref{sec:Eastern} speaks more about reversing. The \texttt{allreversed} option, \cmd{\ReverseActive}, and \cmd{\RevName} work with all names and override \texttt{allrevcomma} and its macros. % -% So-called ``last-comma-first'' lists of names via \texttt{allrevcomma} and the reversing macros \cmd{\ReverseCommaActive} and \cmd{\RevComma} (Section~\ref{sec:LastFirst}) are \emph{not} the same as the \texttt{comma} option. They only affect Western names. +% \noindent These options do not affect the index and are mutually exclusive. See also Sections~\ref{sec:LastFirst} and~\ref{sec:Eastern}. Regarding which of these features overrides the other, see page~\pageref{page:Priorities}. So-called ``last-comma-first'' lists of names via \texttt{allrevcomma} and the reversing macros \cmd{\ReverseCommaActive} and \cmd{\RevComma} (Section~\ref{sec:LastFirst}) are \emph{not} the same as the \texttt{comma} option. They only affect Western names. % +% \begin{center}\bfseries Typographic Post-Processing\end{center} % \phantomsection % \label{page:PostProcess} % -% \begin{center}\bfseries Typographic Post-Processing\end{center} -% % \noindent{\bfseries Formatting Attributes}\medskip\\ % \bgroup\begin{tabular}{p{0.22\textwidth}p{0.6\textwidth}} % \quad\bfseries\texttt{noformat} & \bfseries Do not define a default format.\smallskip\\ @@ -1695,12 +1756,13 @@ the README.txt or README for more information. % \leavevmode\color{nared}\quad\texttt{italic} & \leavevmode\color{nared}First use of a main-matter name in italic.\smallskip\\ % \leavevmode\color{nared}\quad\texttt{boldface} & \leavevmode\color{nared}First use of a main-matter name in boldface.\medskip\\ % \end{tabular}\egroup -% -% \noindent Current\Version{2.5} versions assign no default formatting to names. Most users have preferred the \texttt{noformat} option as the default and then design their own hooks as needed.\footnote{For those that want the old default option from the early days of this package, one can recover that behavior with the \texttt{smallcaps} option.} -% The options above are ``quick'' solutions based on English typography. % -% What\Version{2.4} was ``typographic formatting'' has become a generalized concept of ``post-processing'' via hook macros.\footnote{This package was designed with type hierarchies and flexibility in mind. See Robert Bringhurst, \textit{The Elements of Typographic Style}, version 3.2 (Point Roberts, Washington: Hartley \& Marks, 2008), 53--60. Typographic inspiration comes from Bernhard Lohse, \textit{Luthers Theologie} (G\"ottingen: Vandenhoeck \& Ruprecht, 1995) and Jaroslav J. Pelikan Jr., \textit{The Christian Tradition: A History of the Development of Doctrine}, 5 vols. (Chicago: Chicago UP, 1971--89).} -% Post-processing does not affect the index. Sections \ref{sec:Formatting}, \ref{sec:Hooksi}, \ref{sec:Hooksii}, and~\ref{sec:Hooksiii} explain these hooks in greater detail: +% \noindent The options above are ``quick'' definitions of \cmd{\NamesFormat} based on English typography.\footnote{For the old default, use the \texttt{smallcaps} option. See also Robert Bringhurst, \textit{The Elements of Typographic Style}, version 3.2 (Point Roberts, Washington: Hartley \& Marks, 2008), 53--60.} +% The default is no formatting, the overwhelming user preference. +% +% The following macros are formatting hooks that do ``typographic post-processing'' of names in the text. Originally, \cmd{\NamesFormat} was the only such hook, which resulted in the organic development of the names of these macros. This development reflects the use of two naming systems, one for main-matter text (default) and one for front-matter text. +% +% Unlike alternate formatting, the hooks do not affect the index. Sections \ref{sec:Formatting}, \ref{sec:Hooksi}, \ref{sec:Hooksii}, and~\ref{sec:Hooksiii} explain these hooks and their redefinition in greater detail. Changes to the formatting hooks apply within the scope where they are made: % \begin{itemize} % \item \cmd{\NamesFormat} formats first uses of main-matter names. % \item \cmd{\MainNameHook} formats subsequent uses of main-matter names. @@ -1708,29 +1770,24 @@ the README.txt or README for more information. % \item \cmd{\FrontNameHook} formats subsequent uses of front-matter names. % \end{itemize} % -% Changes\Info{\cmd{\global}} to the formatting hooks apply within the scope where they are made. Use \cmd{\global} explicitly to alter that. \cmd{\NamesFormat} originally was the only hook, so any oddity in the naming of these hooks results from the need for backward compatibility with old versions. -% -% Section~\ref{sec:AKA} discusses how \cmd{\AKA} does not respect these formatting systems and uses the hooks differently. To avoid using the \texttt{formatAKA} option and \cmd{\ForceName} with \cmd{\AKA}, Section~\ref{sec:IndexXref} shows how to use \cmd{\IndexRef} and \cmd{\Name} instead. -% \newpage -% +% Section~\ref{sec:AKA} discusses how \cmd{\AKA} does not respect these formatting systems and uses the hooks differently. To avoid using the \texttt{formatAKA} option and \cmd{\ForceName} with \cmd{\AKA}, Section~\ref{sec:GeneralIndex} shows how to use \cmd{\IndexRef} and \cmd{\Name} instead. +% % \begin{center}\bfseries Alternate or Continental Formatting\end{center} % % \noindent{\bfseries Alternate Formatting}\medskip\\ % \bgroup\begin{tabular}{p{0.22\textwidth}p{0.6\textwidth}} % \leavevmode\color{nared}\quad\texttt{altformat} & \leavevmode\color{nared}Make available the alternate formatting framework from the start of the document. Activate formatting by default.\medskip\\ % \end{tabular}\egroup -% +% % \noindent A built-in\Version{3.1} framework provides an alternate formatting mechanism that can be used for ``Continental'' formatting that one sees in German, French, and so on. Continental standards often format surnames only, both in the text and in the index. Section~\ref{sec:AltFormat} introduces the topic and should be sufficient for most users, while Section~\ref{sec:Hooksiii} goes into greater detail. % -% The previous methods that produced Continental formatting were rather complex compared to the current, simplified manner of doing so. Yet it is likely that these older solutions still ought to work. The error protection that prevents \cmd{\CapThis} from breaking alternately formatted names remains available to these older solutions by using \texttt{altformat} or the related macros (Section~\ref{sec:AltFormat}).\bigskip +% Previous methods that produced Continental formatting were more complex than the current ones. Yet these older solutions still should work, as long as one uses the \texttt{altformat} option and related macros. % +% \begin{center}\bfseries Feature Priority\end{center} % \phantomsection % \label{page:Priorities} -% \begin{center}\bfseries Feature Priority\end{center} % -% \noindent The following table shows the relative priority of package options and macros related to indexing, capitalization, and reversing. The darker the row, the lower the priority. Those macros or options in a particular category (column) that have higher priority (row) tend to override similar macros that have lower priority in that same category. -% -% Thus, \cmd{\IndexInactive} overrides \cmd{\JustIndex}, which overrides \cmd{\SkipIndex}; using \cmd{\SeeAlso} depends entirely on the interaction of the three others. +% \noindent Below we see the relative priority of package options and macros, with darker rows showing lower priority. Within a column, high priority can override low priority. Thus, \cmd{\IndexInactive} overrides \cmd{\JustIndex}, which overrides \cmd{\SkipIndex}. % % \begin{center}\small\MyStretch % \begin{tabular}{llll}\toprule @@ -1740,13 +1797,13 @@ the README.txt or README for more information. % \texttt{noindex} & \texttt{allcaps} & \texttt{allreversed} & \cmd{\DropAffix}\\ % \cmd{\IndexActive} & \cmd{\AllCapsInactive} & \cmd{\ReverseActive} \\ % \cmd{\IndexInactive} & \cmd{\AllCapsActive} & \cmd{\ReverseInactive} \\ -% \rowcolor{black!7!white}\cmd{\JustIndex} & \cmd{\CapName} & \cmd{\RevName} & \cmd{\SubvertThis}\\ -% \rowcolor{black!7!white} & & & \cmd{\ForceName}\\ -% \rowcolor{black!7!white} & & & \cmd{\NoComma}\\ +% \rowcolor{black!6!white}\cmd{\JustIndex} & \cmd{\CapName} & \cmd{\RevName} & \cmd{\SubvertThis}\\ +% \rowcolor{black!6!white} & & & \cmd{\ForceName}\\ +% \rowcolor{black!6!white} & & & \cmd{\NoComma}\\ % \rowcolor{black!12!white}\cmd{\SkipIndex} & \cmd{\AccentCapThis} & \texttt{allrevcomma} & \cmd{\KeepName}\\ % \rowcolor{black!12!white} & & \cmd{\RevCommaActive} & \cmd{\ForceFN}\\ % \rowcolor{black!12!white} & & \cmd{\RevCommaInactive} & \cmd{\ShowComma}\\ -% \rowcolor{black!17!white}\cmd{\SeeAlso} & \cmd{\CapThis} & \cmd{\RevComma} & \cmd{\KeepAffix}\\\bottomrule +% \rowcolor{black!18!white}\cmd{\SeeAlso} & \cmd{\CapThis} & \cmd{\RevComma} & \cmd{\KeepAffix}\\\bottomrule % \end{tabular} % \end{center} % @@ -1755,7 +1812,7 @@ the README.txt or README for more information. % % \subsection{Naming Macros} % -% In this manual we modify the formatting hooks to show first and later name uses, forcing such uses as needed (Sections~\ref{sec:Formatting} and~\ref{sec:NameControl}). All naming macros create index entries before and after a name for when a name straddles a page break. +% In this\Illus{} manual we modify the formatting hooks to show first and later name uses, forcing such uses as needed (Sections~\ref{sec:Formatting}--\ref{sec:NameControl}). All naming macros create index entries before and after a name for when a name straddles a page break. % % \subsubsection{\texttt{\textbackslash Name} and \texttt{\textbackslash Name*}} % \label{sec:Naming} @@ -1765,12 +1822,15 @@ the README.txt or README for more information. % \DescribeMacro{\Name*} % then usually just the \meta{SNN} argument thereafter. \cmd{\Name*} always prints the full name: % \begin{quote} -% \fbox{\vbox{\hbox{\mystrut\ \cmd{\Name}| |\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate} }\par -% \hbox{\mystrut\ \cmd{\Name}|*|\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate} }}} +% \fbox{ +% \begin{tabular}{l} +% {\Large\strut}\cmd{\Name\ }\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate}\vspace{-2pt}\\ +% {\Large\strut}\cmd{\Name*}\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate}\\ +% \end{tabular} +% } % \end{quote} % -% In\Version{3.0} the body text, not the index, the \meta{Alternate} argument replaces either \meta{FNN} or, if \meta{FNN} is absent, \meta{Affix}.\footnote{If \meta{Alternate} is \cmd{\ignorespaces}, the Western long form of \cmd{\Name} looks like the short form. ``Native'' Eastern and ancient forms would have an extra trailing space.} -% If both \meta{FNN} and \meta{Affix} are absent, then the obsolete syntax is used (Section~\ref{sec:Obsolete}). +% In the body text, not the index, the \meta{Alternate} argument replaces either \meta{FNN} or, if \meta{FNN} is absent, \meta{Affix}. If both \meta{FNN} and \meta{Affix} are absent when \meta{Alternate} is present, then the obsolete syntax is used (Section~\ref{sec:Obsolete}). % % \begin{quote}\small % \StartNum @@ -1783,28 +1843,37 @@ the README.txt or README for more information. % \< Eliz & & Elizabeth, I & > %\end{nameauth}\end{verbatim} % \end{quote} -% -% \begin{center}\small\MyStretch +% +% \leavevmode\SPatInfo{\ShowPattern[Albert]{Einstein}\break \ShowPattern[M.T.]{Cicero}\break \ShowPattern{Confucius}\break \ShowPattern{Miyazaki, Hayao}\break \ShowPattern{Elizabeth, I}}\vspace{-4.25ex} +% +% \begin{center}\small\MyStretch\leavevmode\vspace{-26ex}\IdxInfo{\ShowIdxPageref*[Albert]{Einstein}\break \ShowIdxPageref*[M.T.]{Cicero}\break \ShowIdxPageref*{Confucius}\break \ShowIdxPageref*{Miyazaki, Hayao}\break \ShowIdxPageref*{Elizabeth, I}}\vspace{26ex} % \begin{tabular}{ll}\toprule % |\Name [Albert]{Einstein}| or |\Einstein| & \Name [Albert]{Einstein}\\ % |\Name*[Albert]{Einstein}| or |\LEinstein| & \LEinstein\\ % |\Name [Albert]{Einstein}| or |\Einstein| & \Einstein\\ -% \rowcolor{black!7!white}|\Name [M.T.]{Cicero}| or |\Cicero| & \Name [M.T.]{Cicero}\\ -% \rowcolor{black!7!white}|\Name*[M.T.]{Cicero}[Marcus Tullius]| & \Name*[M.T.]{Cicero}[Marcus Tullius]\\ -% \rowcolor{black!7!white}|\Name [M.T.]{Cicero}| or |\Cicero| & \Cicero\\ +% \rowcolor{grey}|\Name [M.T.]{Cicero}| or |\Cicero| & \Name [M.T.]{Cicero}\\ +% \rowcolor{grey}|\Name*[M.T.]{Cicero}[Marcus Tullius]| & \Name*[M.T.]{Cicero}[Marcus Tullius]\\ +% \rowcolor{grey}|\Name [M.T.]{Cicero}| or |\Cicero| & \Cicero\\ % |\Name {Confucius}|, |\Confucius| & \Confucius\\ % \footnotesize Same for all variants; no \meta{Affix} or \meta{Alternate}. & \Confucius\\ -% \rowcolor{black!7!white}|\Name {Miyazaki, Hayao}| or |\Miyaz| & \ForgetThis\Name {Miyazaki, Hayao}\\ -% \rowcolor{black!7!white}|\Name*{Miyazaki, Hayao}[Sensei]| & \Name*{Miyazaki, Hayao}[Sensei]\\ -% \rowcolor{black!7!white}|\Name {Miyazaki, Hayao}| or |\Miyaz| & \Name {Miyazaki, Hayao}\\ +% \rowcolor{grey}|\Name {Miyazaki, Hayao}| or |\Miyaz| & \ForgetThis\Name {Miyazaki, Hayao}\\ +% \rowcolor{grey}|\Name*{Miyazaki, Hayao}[Sensei]| & \Name*{Miyazaki, Hayao}[Sensei]\\ +% \rowcolor{grey}|\Name {Miyazaki, Hayao}| or |\Miyaz| & \Name {Miyazaki, Hayao}\\ % |\Name {Elizabeth, I}| or |\Eliz| & \ForgetThis\Eliz\\ % |\Name*{Elizabeth, I}| or |\LEliz| & \Name*{Elizabeth, I}\\ % |\Name {Elizabeth, I}| or |\Eliz| & \Name {Elizabeth, I}\\\bottomrule % \end{tabular} % \end{center} % -% When using the simplified interface, the preferred way to get alternate names is |\LCicero[Marcus Tullius]| and |\LMiyaz[Sensei]|: \LCicero[Marcus Tullius] and \LMiyaz[Sensei]. The alternate forename is not shown in subsequent short name references e.g., |\Cicero[Marcus Tullius]| \Cicero[Marcus Tullius]. -% +% When using the quick interface, the preferred way to get alternate names is |\LCicero[Marcus Tullius]| and |\LMiyaz[Sensei]|: \LCicero[Marcus Tullius] and \LMiyaz[Sensei]. The alternate forename is not shown in subsequent short name references e.g., |\Cicero[Marcus Tullius]| \Cicero[Marcus Tullius]. Remember the following: +% \begin{center}\small +% \begin{tabular}{rll}\toprule +% \rowcolor{grey}No: & \cmd{\LEinstein}\texttt{\ \ \ [said]\dots} & \LEinstein [said]\dots\\ +% \rowcolor{grey}No: & \cmd{\Einstein}\texttt{\ \ \ \ [said]\dots} & \Einstein [said]\dots\\ +% Yes: & \cmd{\LEinstein}\texttt{\{\} [said]\dots} & \LEinstein{} [said]\dots\\ +% Yes: & \cmd{\Einstein}\texttt{\{\}\ \ [said]\dots} & \Einstein{} [said]\dots\\\bottomrule +% \end{tabular} +% \end{center} % \newpage % % \subsubsection{Forenames: \texttt{\textbackslash FName}} @@ -1815,50 +1884,62 @@ the README.txt or README for more information. % \DescribeMacro{\FName*} % These synonyms let one add an \texttt{F} either to \cmd{\Name} or \cmd{\Name*} to get the same effect: % \begin{quote} -% \fbox{\vbox{\hbox{\mystrut\ \cmd{\FName\ }\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate} }\par -% \hbox{\mystrut\ \cmd{\FName*}\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate} }}} +% \fbox{ +% \begin{tabular}{l} +% {\Large\strut}\cmd{\FName\ }\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate}\vspace{-2pt}\\ +% {\Large\strut}\cmd{\FName*}\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate}\\ +% \end{tabular} +% } % \end{quote} % % \DescribeMacro{\ForceFN} -% These macros work with both Eastern and Western names, but to get an Eastern personal name, one must precede these macros with \cmd{\ForceFN}. -% See\Version{3.0} also Sections~\ref{sec:NameParticles} and~\ref{sec:NameControl} on how to vary some of the forms below: +% These macros work with both Eastern and Western names, but to get an Eastern personal name, one must precede these macros with \cmd{\ForceFN}.\Version{3.0} This was designed to discourage one from being too familiar and causing offense. +% See also Sections~\ref{sec:NameParticles} and~\ref{sec:NameControl} on how to vary some of the forms below: % +% \vspace{1.5ex}\leavevmode\SPatInfo{\ShowPattern[Albert]{Einstein}\break \ShowPattern[M.T.]{Cicero}\break \ShowPattern{Confucius}\break \ShowPattern{Miyazaki, Hayao}\break \ShowPattern{Elizabeth, I}}\vspace{-4ex} % \begin{center}\small\MyStretch % \begin{tabular}{ll}\toprule % |\FName[Albert]{Einstein}| or |\SEinstein| & \SEinstein\\ -% \rowcolor{black!7!white}|\FName[M.T.]{Cicero}[Marcus Tullius]| & \\ -% \rowcolor{black!7!white}or |\SCicero[Marcus Tullius]| & \SCicero[Marcus Tullius]\\ +% \rowcolor{grey}|\FName[M.T.]{Cicero}[Marcus Tullius]| & \\ +% \rowcolor{grey}or |\SCicero[Marcus Tullius]| & \SCicero[Marcus Tullius]\\ % |\FName{Confucius}| or |\SConfucius |& \FName{Confucius}\\ -% \rowcolor{black!7!white}|\FName{Miyazaki, Hayao}| or |\SMiyaz| & \FName{Miyazaki, Hayao}\\ +% \rowcolor{grey}|\FName{Miyazaki, Hayao}| or |\SMiyaz| & \FName{Miyazaki, Hayao}\\ % |\ForceFN\FName{Miyazaki, Hayao}| & \\ % or |\ForceFN\SMiyaz| & \ForceFN\FName{Miyazaki, Hayao} \\ -% \rowcolor{black!7!white}|\ForceFN\FName{Miyazaki, Hayao}[Sensei]| & \\ -% \rowcolor{black!7!white}or |\ForceFN\SMiyaz[Sensei]| & \ForceFN\FName{Miyazaki, Hayao}[Sensei]\\ +% \rowcolor{grey}|\ForceFN\FName{Miyazaki, Hayao}[Sensei]| & \\ +% \rowcolor{grey}or |\ForceFN\SMiyaz[Sensei]| & \ForceFN\FName{Miyazaki, Hayao}[Sensei]\\ % |\FName{Elizabeth, I}| or |\SEliz| & \SEliz\\ -% \rowcolor{black!7!white}|\ForceFN\SEliz[Good Queen Bess]| & \ForceFN\SEliz[Good Queen Bess]\\\bottomrule +% \rowcolor{grey}|\ForceFN\SEliz[Good Queen Bess]| & \ForceFN\SEliz[Good Queen Bess]\\\bottomrule % \end{tabular} % \end{center} % -% The \meta{Alternate} argument replaces forenames in the text, which strongly shapes the use of \cmd{\FName}.\footnote{If \meta{Alternate} is \cmd{\ignorespaces}, the Western long form of \cmd{\FName} looks like the short form of \cmd{\Name}, while the Western short form of \cmd{\FName} acts like \cmd{\leavevmode} and prints nothing. ``Native'' Eastern and ancient forms would have an extra trailing space.} -% We recap what we saw on page~\pageref{page:ArgIV}, emphasizing forenames: +% The \meta{Alternate} argument replaces forenames in the text, which strongly shapes the use of \cmd{\FName}. We apply page~\pageref{page:ArgIV} to forenames: % \begin{quote}\small % \StartNum % \begin{verbatim} %\begin{nameauth} % \< Lewis & Clive Staples & Lewis & > % \< CSL & Clive Staples & Lewis & C.S. > -% \< Ches & Chesley B. & Sullenberger, III & > -% \< Sully & Chesley B. & Sullenberger, III & Sully > % \< Miyaz & & Miyazaki, Hayao & > % \< MSens & & Miyazaki, Hayao & Sensei > %\end{nameauth}\end{verbatim} % \end{quote} % -% These share name patterns: \cmd{\SCSL} \SCSL, \cmd{\SLewis} \SLewis; \cmd{\SChes} \SChes, \cmd{\SSully} \SSully; \cmd{\SMiyaz} \SMiyaz, \cmd{\SMSens} \SMSens. -% -% Equivalents: \cmd{\SCSL} \SCSL, \cmd{\SLewis[C.S.]} \SLewis[C.S.]; \cmd{\SSully} \SSully, \cmd{\SChes[Sully]} \SChes[Sully]; |\ForceFN\SMSens| \ForceFN\SMSens, |\ForceFN\SMiyaz[Sensei]|: \ForceFN\SMiyaz[Sensei]. -% -% These\Warn{} fail: \cmd{\SCSL[Jack]}: \SCSL[Jack]; \cmd{\SSully[Chesley]}: \SSully[Chesley]; and |\ForceFN\SMSens[Hayao]|: \ForceFN\SMSens[Hayao]. Whenever \meta{arg4} of the \texttt{nameauth} environment is used, the respective shorthands cannot take optional arguments. +% \begin{itemize} +% \item They\SPatInfo{\ShowPattern[Clive Staples]{Lewis}\break \ShowPattern{Miyazaki, Hayao}} share name control patterns (Section~\ref{sec:NamePatterns}). Therefore, they have the same ``first-use'' and ``later-use'' conditions. +% \item Usually, one adds alternate names to shorthands with an empty \meta{arg4}:\\[1ex] +% \vspace{-11ex}\IdxInfo{\ShowIdxPageref*[Clive Staples]{Lewis}\break \ShowIdxPageref*{Miyazaki, Hayao}}\vspace{11ex}\leavevmode +% \begin{tabular}{l@{\ }ll@{\ }l}\toprule +% \cmd{\SLewis[C.S.]} & \SLewis[C.S.] & \cmd{\SCSL} & \SCSL\\ +% \rowcolor{grey}\cmd{\SMiyaz[Sensei]} & \SMiyaz[Sensei] & \cmd{\SMSens} & \SMSens\\ +% \cmd{\ForceFN}\cmd{\SMiyaz[Sensei]} & \ForceFN\SMiyaz[Sensei] & \cmd{\ForceFN}\cmd{\SMSens} & \ForceFN\SMSens\\\bottomrule +% \end{tabular} +% \item Trying to add ``alternate names'' to shorthands that use \meta{arg4} fails:\\[1ex] +% \begin{tabular}{l@{\ }l}\toprule +% \rowcolor{grey}\cmd{\SCSL[Jack]} & \SCSL[Jack]\\ +% \cmd{\ForceFN}\cmd{\SMSens[Sensei]} & \ForceFN\SMSens[Sensei]\\\bottomrule +% \end{tabular} +% \end{itemize} % % \ReturnLink % \newpage @@ -1866,9 +1947,9 @@ the README.txt or README for more information. % \subsubsection{Variant Names} % \label{sec:VarNames} % -% This\Version{3.1} section explains how to manage more complicated variants, which gives one the skills needed to implement a name authority. We draw from Sections~\ref{sec:Formatting}, \ref{sec:IndexXref}, \ref{sec:IndexSort}, \ref{sec:NameControl}, and \ref{sec:AKA}. One might want to consult those sections also. -% -% We\Info{variant forenames} begin with the easier kind of variant names, namely, variant forenames indexed under a canonical name entry: +% This\Version{3.1} section explains how to manage more complicated variants, which gives one the skills needed to implement a name authority. We draw from Sections~\ref{sec:GeneralIndex}, \ref{sec:IndexSort}, \ref{sec:Formatting}, and \ref{sec:NameControl}. One might want to consult those sections also.\medskip +% +% We\Info{Variant forenames} begin with the easier kind of variant names, namely, variant forenames indexed under a canonical name entry: % \begin{quote}\small % \StartNum % \begin{verbatim} @@ -1876,15 +1957,20 @@ the README.txt or README for more information. % \< Tyson & Mike & Tyson & > % \< Iron & Mike & Tyson & Iron Mike > %\end{nameauth}\end{verbatim} +% \end{quote} +% +% Below,\SPatInfo{\ShowPattern[Mike]{Tyson}} all variants have the same pattern and index entry because they are based on the same name form: % -% \begin{tabular}{@{}lrlrl} -% Same pattern: & \cmd{\Iron} & \Iron & \cmd{\LTyson} & \LTyson\\ -% & \cmd{\SIron} & \SIron & \cmd{\STyson} & \STyson\\ +% \begin{quote}\small\leavevmode\vspace{-8ex}\IdxInfo{\ShowIdxPageref*[Mike]{Tyson}}\vspace{8ex} +% \begin{tabular}{rlrl} +% \cmd{\Iron} & \Iron & \cmd{\LTyson[Iron Mike]} & \LTyson[Iron Mike]\\ +% \cmd{\LIron} & \LIron & \cmd{\LTyson} & \LTyson\\ +% \cmd{\SIron} & \SIron & \cmd{\STyson} & \STyson\\ % \end{tabular} % \end{quote} -% Since \LIron\ is indexed as ``\ShowIdxPageref*[Mike]{Tyson}'' throughout the document, we can use |\IndexRef{Iron Mike}{Tyson, Mike}| with no output in the text or |\AKA[Mike]{Tyson}{Iron Mike}| \AKA[Mike]{Tyson}{Iron Mike} to print a name. Both create the cross-reference ``Iron Mike \textit{see} Tyson, Mike'' in the index. +% Since \LIron\ is indexed as ``\ShowIdxPageref*[Mike]{Tyson}'' throughout the document, we can use \cmd{\IndexRef\{Iron Mike\}\{Tyson, Mike\}}\IndexRef{Iron Mike}{Tyson, Mike}, which produces no output in the text. Thus we get ``Iron Mike \textit{see} Tyson, Mike'' as a cross-reference in the index.\medskip % -% Variant\Info{variant surnames} family names are more complicated than variant personal names. For surname variants, one can use the following method to get fairly good results, depending on the trade-offs that one wishes to accept: +% Variant\Info{Variant surnames} family names are more complicated. The following method avoids using macros in name arguments (cf. Page~\pageref{page:Romani}) to get decent results: % \begin{quote}\small % \StartNum % \begin{verbatim} @@ -1892,27 +1978,28 @@ the README.txt or README for more information. % \< DuBois & W.E.B. & Du~Bois & > % \< AltDuBois & W.E.B. & DuBois & > %\end{nameauth} -%\PretagName[W.E.B.]{Du~Bois}{Dubois, W.E.B.}\end{verbatim} +%\PretagName[W.E.B.]{Du~Bois}{Dubois, William}% +%\PretagName[W.E.B.]{DuBois}{Dubois, William}\end{verbatim} % \end{quote} -% \begin{enumerate} -% \item We decide the canonical name form: \cmd{\DuBois} \ForgetThis\DuBois. -% \item Both\Warn{} \cmd{\Name[W.E.B.]\{Du Bois\}} and \cmd{\Name[W.E.B.]\{DuBois\}} have the pattern ``\texttt{\ShowPattern[W.E.B.]{Du Bois}}'' (Section~\ref{sec:NamePatterns}). Here we use |Du~Bois| as the argument because we want no breaks, giving us ``\texttt{\ShowPattern[W.E.B.]{Du~Bois}}''. -% \item We set the sort key for both names to be \texttt{\{Dubois, W.E.B.\}}. If it were of the form \texttt{\{Du Bois, W.E.B.\}}, they would sort differently (Section~\ref{sec:IndexSort}). One must check a style manual for proper sorting. +% \begin{itemize} +% \item We decide\SPatInfo{\ShowPattern[W.E.B.]{Du~Bois}\break \ShowPattern[W.E.B.]{DuBois}} the canonical name form: \cmd{\DuBois} \ForgetThis\DuBois. +% \item Both \cmd{\Name[W.E.B.]\{Du Bois\}} and \cmd{\Name[W.E.B.]\{DuBois\}} have the same pattern: \texttt{\ShowPattern[W.E.B.]{DuBois}} (Section~\ref{sec:NamePatterns}). +% \item Here\vspace{-3ex}\IdxInfo{\ShowIdxPageref*[W.E.B.]{Du~Bois}\break \ShowIdxPageref*[W.E.B.]{DuBois}}\vspace{3ex} we use |\Name[W.E.B.]{Du~Bois}| to avoid bad breaks. +% \item The sort key for both names is \texttt{\{Dubois, William\}}. Had we kept the space, the name would be sorted before \texttt{dual} (Section~\ref{sec:IndexSort}). One may have to spell out a name when sorting its initials. % \item Instead of using \cmd{\SkipIndex}\cmd{\AltDuBois} many times, we create a cross-reference in the preamble so that no page entry for the alternate form will occur in the index:\IndexRef[W.E.B.]{DuBois}{Du Bois, W.E.B.}\smallskip\\ % | \IndexRef[W.E.B.]{DuBois}{Du Bois, W.E.B.}| % \item We can use |\JustIndex\DuBois\AltDuBois| \JustIndex\DuBois\AltDuBois, keep full stop detection, and check if the name straddles a page break in order to append |\JustIndex\DuBois| if needed. % \item If we create a macro like the one below, we lose full stop detection but then we do not have to check if the name straddles a page break. Normally, the name macros create two index entries each in order to handle this issue automatically:\smallskip\\ % | \newcommand\NewDuBois%|\\ % | {\JustIndex\DuBois\AltDubois\JustIndex\DuBois}| -% \end{enumerate} -% +% \end{itemize} +% % \newpage % \begin{center}\bfseries Example Name Authority\end{center} -% % Below are a couple of names from a name authority created for a translation of \textit{De Diaconis et Diaconissis Veteris Ecclesiae Liber Commentarius} by \Name[Caspar]{Ziegler}, of which the present author was the editor.\footnote{The book, \textit{The Diaconate of the Ancient and Medieval Church}, originally was typeset using \LaTeX, but had to be converted to a different format. Using \LaTeX, the present author has published Charles P. Schaum and Albert B. Collver III, \textit{Breath of God, Yet Work of Man: Scripture, Philosophy, Dialogue, and Conflict} (St. Louis: Concordia Publishing House, 2019).} -% +% % Constructing that name authority was a challenge. In order to get the names right\,---\,the deceased translator unfortunately had left them in abbreviated Latin, as well as leaving many place names in Latin or translating them incorrectly\,---\,the present author used the following sources, among several others: -% +% % \begin{itemize} % \item CERL Thesaurus: \url{https://data.cerl.org/thesaurus/_search} % \item Virtual International Authority File: \url{http://viaf.org/} @@ -1920,12 +2007,13 @@ the README.txt or README for more information. % \item WorldCat: \url{https://www.worldcat.org/} % \item An older version of Graesse, \textit{Orbis Latinus}:\\ \url{http://www.columbia.edu/acis/ets/Graesse/contents.html} % \end{itemize} -% -% This author followed the scholarly standards for determining the canonical name forms and used the alternate names (which were the ones actually in the original text) to refer to the canonical forms. I just translated all the place-names. -% -% Below we have candidates for sorting with \cmd{\PretagName} (Section~\ref{sec:IndexSort}) and potential use of \cmd{\CapThis} (Section~\ref{sec:NameParticles}). After using \cmd{\IndexRef} with a particular name, using \cmd{\Name} with that same name will not create a page reference from that point onward (Section~\ref{sec:IndexXref}). -% -% \begin{quote} +% +% This author used the vernacular forms as canonical, with the Latin versions as alternates. I translated all the place-names. +% +% Below we have candidates for sorting with \cmd{\PretagName} (Section~\ref{sec:IndexSort}) and potential use of \cmd{\CapThis} (Section~\ref{sec:NameParticles}). \emph{After} using \cmd{\IndexRef} with a particular name, using \cmd{\Name} with that same name will not create a page reference from that point onward (Section~\ref{sec:GeneralIndex}). If one were to use the alternate name \emph{before} using \cmd{\IndexRef}, then \cmd{\SeeAlso}\cmd{\IndexRef} would be used after all name references. +% +% \begin{quote}\small\vspace{3.5ex}\SPatInfo{\ShowPattern[Jacques]{De~Pamele}\break \ShowPattern[Jacobus]{Pamelius}\break \ShowPattern[Giovanni]{d'Andrea}\break \ShowPattern[Ioannes]{Andreae}} +% \vspace{-3ex} % \StartNum % \begin{verbatim} %\PretagName[Jacques]{De~Pamele}{Depamele, Jacques} @@ -1938,59 +2026,62 @@ the README.txt or README for more information. %\IndexRef[Ioannes]{Andreae}{d'Andrea, Giovanni} %\Name[Ioannes]{Andreae}\end{verbatim} % -% \medskip \begin{tabular}{ll}\toprule +% \leavevmode\vspace{-12ex}\IdxInfo{\ShowIdxPageref*[Jacques]{De~Pamele}\break \ShowIdxPageref*[Jacobus]{Pamelius}\break \ShowIdxPageref*[Giovanni]{d'Andrea}\break \ShowIdxPageref*[Ioannes]{Andreae}}\vspace{12ex} +% +% \begin{tabular}{ll}\toprule % Canonical Name & Alternate Name\\\midrule -% \Name[Jacques]{De~Pamele}[Jacques de~Joigny] & -% \leavevmode\IndexRef[Jacobus]{Pamelius}{De~Pamele, Jacques}\Name[Jacobus]{Pamelius}\\ -% \rowcolor{black!7!white}\Name[Giovanni]{d'Andrea} & -% \leavevmode\IndexRef[Ioannes]{Andreae}{d'Andrea, Giovanni}\Name[Ioannes]{Andreae}\\\bottomrule +% \rowcolor{grey}\Name[Jacques]{De~Pamele}[Jacques de~Joigny]\IndexRef[Jacobus]{Pamelius}{De~Pamele, Jacques} & +% \Name[Jacobus]{Pamelius}\\ +% \Name[Giovanni]{d'Andrea}\IndexRef[Ioannes]{Andreae}{d'Andrea, Giovanni} & +% \Name[Ioannes]{Andreae}\\\bottomrule % \end{tabular} % \end{quote} % \CapThis\Name[Giovanni]{d'Andrea} |\CapThis\Name[Giovanni]{d'Andrea}| can be used at the beginning of a sentence. |\Name[Jacques]{De~Pamele}| gives \Name[Jacques]{De~Pamele}. -% +% % \ReturnLink % \newpage % % \subsection{Language Topics} % \label{sec:Lang} -% This section looks at how \textsf{nameauth} addresses grammar, usage, and cultural standards. The concept of comma-delimited affixes dominates much of this section. +% Here we focus on specific issues that are related to parts of names used differently in various cultures and kinds of names related to specific cultures. Comma-delimited affixes \meta{SNN, Affix} are a key concept here. Advanced topics in this section draw on Sections~\ref{sec:Indexing}, \ref{sec:Formatting}, \ref{sec:AltFormat}, and \ref{sec:NameDecisions}. % % \subsubsection[Affixes]{Affixes Require Commas} % \label{sec:Affix} % -% A comma is required to separate a Western surname and affix, an Eastern family name and personal name, and an ancient name and affix. Yet we must take care because an example like \cmd{\Name\{}\cmd{\textsc\{a Name, Problem\}\}} will halt \LaTeX\ with errors (Section~\ref{sec:AltFormat}). Spaces around the comma are ignored (Section~\ref{sec:ErrorProt}). +% A comma\SPatInfo{\ShowPattern[Oskar]{Hammerstein, II}\break \ShowPattern{Louis, XIV}\break \ShowPattern{Sun, Yat-sen}} separates a Western surname and affix; a ``native'' Eastern family name and personal name; and a royal, medieval, or ancient name and affix. To avoid errors, one must treat \meta{SNN, Affix} as two separate arguments (Section~\ref{sec:AltFormat}). Spaces around the comma are ignored. % -% \begin{center}\small\ForgetName{Sun, Yat-sen}\MyStretch +% \begin{center}\small\ForgetName{Sun, Yat-sen}\IdxInfo{\ShowIdxPageref*[Oskar]{Hammerstein, II}\break \ShowIdxPageref*{Louis, XIV}\break \ShowIdxPageref*{Sun, Yat-sen}}\MyStretch % \begin{tabular}{ll}\toprule % |\Name[Oskar]{Hammerstein, II}| & \KeepAffix\Name[Oskar]{Hammerstein, II}\\ % |\Name[Oskar]{Hammerstein, II}| & \Name[Oskar]{Hammerstein, II}\\ -% \rowcolor{black!7!white}|\Name{Louis, XIV}| & \KeepAffix\Name{Louis, XIV}\\ -% \rowcolor{black!7!white}|\Name{Louis, XIV}| & \Name{Louis, XIV}\\ +% \rowcolor{grey}|\Name{Louis, XIV}| & \KeepAffix\Name{Louis, XIV}\\ +% \rowcolor{grey}|\Name{Louis, XIV}| & \Name{Louis, XIV}\\ % |\Name{Sun, Yat-sen}| & \KeepAffix\Name{Sun, Yat-sen}\\ % |\Name{Sun, Yat-sen}| & \Name{Sun, Yat-sen}\\\bottomrule % \end{tabular} % \end{center} % -% Western\Warn{} names with affixes must use the comma-delimited syntax. Using the obsolete syntax, |\SkipIndex\Name[Oskar]{Hammerstein}[II]| produces \SkipIndex\Name[Oskar]{Hammerstein}[II] which is an error. See also (Section~\ref{sec:AKA}).\medskip -% +% Western\SPatInfo{\ShowPattern[Oskar]{Hammerstein}[II]} names with affixes must use \meta{SNN, Affix}, never the obsolete syntax, which is meant for non-Western names and is discouraged. We get \SkipIndex\Name[Oskar]{Hammerstein}[II] and a bad index entry from, e.g., \cmd{\SkipIndex}\cmd{\Name[Oskar]\{Hammerstein\}[II]}.\medskip +% % \DescribeMacro{\KeepAffix} -% In the text only, \cmd{\KeepAffix} turns the space \emph{between} \meta{SNN} and \meta{Affix} into a non-breaking space. This holds for a Western surname and affix, an ancient name and affix, and a ``native'' Eastern family name and personal name.\medskip +% In the text only, \cmd{\KeepAffix} turns the space \emph{between} \meta{SNN} and \meta{Affix} into a non-breaking space if both \meta{SNN} and \meta{Affix} are displayed. This macro works with all name types, even with the obsolete syntax.\medskip % % \DescribeMacro{\KeepName} -% In the text only, \cmd{\KeepName} turns all spaces \emph{between} name elements \meta{FNN}, \meta{SNN}, and \meta{Affix} into non-breaking spaces;\Version{3.1} |\KeepName\LJWG[von]| \KeepName\LJWG[von] will not break. This macro does not alter spaces \emph{within} name elements like \meta{FNN} (French or German forenames) and \meta{SNN} (Spanish surnames). Both \cmd{\KeepAffix} and \cmd{\KeepName} can affect \textsf{nameauth} macros that print in the text.\medskip +% In the text only, \cmd{\KeepName} turns all spaces \emph{between} name elements \meta{FNN}, \meta{SNN}, and \meta{Affix} into non-breaking spaces if those elements are displayed.\Version{3.1} This macro does not alter spaces \emph{within} name elements that have multiple names like French or German forenames and Spanish surnames. As above, this macro works with all name types, even with the obsolete syntax.\medskip % % \DescribeMacro{\DropAffix} -% Preceding the naming macros with \cmd{\DropAffix} will suppress an affix in a Western name. |\DropAffix\Name*[Oskar]{Hammerstein, II}| produces\Version{3.0} ``\DropAffix\Name*[Oskar]{Hammerstein, II}.'' This does not affect non-Western names.\medskip +% Preceding the naming macros with \cmd{\DropAffix} will suppress an affix only in a Western name. |\DropAffix\Name*[Oskar]{Hammerstein, II}| produces\Version{3.0} ``\DropAffix\Name*[Oskar]{Hammerstein, II}''. This macro does not affect non-Western names. +% +% With non-Western names, the \meta{Affix} in the \meta{SNN, Affix} pair drops automatically in the text for subsequent uses, making \cmd{\DropAffix} redundant. We see that above in the case of \Name*{Louis,XIV}, who becomes \Name{Louis,XIV}.\medskip % % \DescribeMacro{\ShowComma} -% \cmd{\ShowComma} forces a comma between a Western name and its affix. It works like the \texttt{comma} option on a per-name basis, and only in the body text. +% \cmd{\ShowComma} forces a comma between a Western name and its affix. It works like the \texttt{comma} option on a per-name basis, and only in the text. % \DescribeMacro{\NoComma} -% \cmd{\NoComma} works like the \texttt{nocomma} option in the body text on a per-name basis. -% Neither\Version{2.6} of these macros affect the use of \cmd{\RevComma}, which always prints a comma. +% One uses \cmd{\ShowComma} with older publication styles that separate a Western name and affix with a comma. \cmd{\NoComma} works like the \texttt{nocomma} option in the body text on a per-name basis. Neither of these macros affect the use of \cmd{\RevComma}, which always prints a comma. % \begin{center}\small\MyStretch % \begin{tabular}{ll}\toprule -% |\ShowComma\Name*[Louis]{Gossett, Jr.}| & \ShowComma\Name*[Louis]{Gossett, Jr.}\\ -% \rowcolor{black!7!white}|\NoComma\Name*[Louis]{Gossett, Jr.}| & \NoComma\Name*[Louis]{Gossett, Jr.}\\\bottomrule +% \rowcolor{grey}|\ShowComma\LPat| & \ShowComma\LPat\\ +% |\NoComma\LPat| & \NoComma\LPat\\\bottomrule % \end{tabular} % \end{center} % @@ -1999,21 +2090,25 @@ the README.txt or README for more information. % % \subsubsection[Listing by Surname]{Listing Western names by Surname} % \label{sec:LastFirst} +%^^A Starting with this point, if there is an error in the docs then the aux files will +%^^A be ruined and must be deleted. Above this point it will be okay. Why? % % \DescribeMacro{\ReverseCommaActive} % In addition to the options for reversed comma listing (Section~\ref{sec:PkgOptions}), the macros \cmd{\ReverseCommaActive} and \cmd{\ReverseCommaInactive} % \DescribeMacro{\ReverseCommaInactive} % function the same way with blocks of text. They all override \cmd{\RevComma}. % \DescribeMacro{\RevComma} -% These all reorder long Western name forms (via \cmd{\Name*} and the like). The first two are broad toggles, while the third works on a per-name basis. These\Version{3.0} macros only affect Western and ``non-native'' Eastern name forms. +% These all reorder only long Western and ``non-native'' Eastern name forms.\Version{3.0} The first two are broad toggles, while the third works on a per-name basis. +% +% \vspace{1.5ex}\leavevmode\SPatInfo{\ShowPattern[Oskar]{Hammerstein, II}\break \ShowPattern[Hideyo]{Noguchi}\break \ShowPattern{Æthelred,II}\break \ShowPattern{Sun, Yat-sen}\break \ShowPattern{Confucius}}\vspace{-4ex} % \begin{center}\small\MyStretch % \begin{tabular}{lll}\toprule -% \ForgetThis\VBuren & \RevComma\LVBuren & OK\\ -% \ForgetThis\Name[Oskar]{Hammerstein, II} & \RevComma\Name*[Oskar]{Hammerstein, II} & OK\\ -% \ForgetThis\LNoguchi & \RevComma\LNoguchi\dag & OK\\ -% \rowcolor{black!7!white}\ForgetThis\Aeth & \RevComma\LAeth & no change\\ -% \rowcolor{black!7!white}\ForgetThis\Name{Chiang}[Kai-shek] & \RevComma\Name*{Chiang}[Kai-shek] & no change\\ -% \rowcolor{black!7!white}\ForceName\Name{Confucius} & \RevComma\Name{Confucius} & no change\\\bottomrule +% \ForgetThis\VBuren & \RevComma\LVBuren & change\\ +% \ForgetThis\Name[Oskar]{Hammerstein, II} & \RevComma\Name*[Oskar]{Hammerstein, II} & change\\ +% \ForgetThis\LNoguchi & \RevComma\LNoguchi\dag & change\\ +% \rowcolor{grey}\ForgetThis\Aeth & \RevComma\LAeth & no change\\ +% \rowcolor{grey}\ForgetThis\Name{Sun, Yat-sen} & \RevComma\Name*{Sun, Yat-sen} & no change\\ +% \rowcolor{grey}\ForceName\Name{Confucius} & \RevComma\Name{Confucius} & no change\\\bottomrule % \end{tabular} % \end{center} % @@ -2024,44 +2119,54 @@ the README.txt or README for more information. % \subsubsection{Eastern Names} % \label{sec:Eastern} % -% One\Info{``non-native''} produces a ``non-native'' Eastern name in the text by reversing a Western without \meta{Affix} using \cmd{\RevName}: +% All non-Western name forms using the \textsf{nameauth} macros omit the first optional argument. Yet the reversing macros can make Western names have Eastern name order, but only in the text, not in the index.\medskip +% +% One\Info{``Non-native''} produces a ``non-native'' Eastern name in the text by reversing a Western name without \meta{Affix} using \cmd{\RevName}, e.g.: % \begin{quote} -% \fbox{\mystrut\ \cmd{\RevName}\cmd{\Name*}\oarg{FNN}\marg{SNN}\oarg{Alternate} } +% \fbox{ +% \begin{tabular}{l} +% {\Large\strut}\cmd{\RevName}\cmd{\Name}\oarg{FNN}\marg{SNN}\oarg{Alternate}\\ +% \end{tabular} +% } % \end{quote} -% % The index entry of this name form looks like \meta{SNN}, \meta{FNN} (including the comma). This is a Western index entry. This form is used also for Hungarian names, e.g.: |\RevName\Name[Frenec]{Molnár}| \ForgetThis\RevName\Name[Frenec]{Molnár}\dag, \RevName\Name[Frenec]{Molnár}\dag.\medskip % -% In\Info{``native''} contrast, ``native'' Eastern names use either comma-delimited syntax or the obsolete syntax. They have Eastern-form index entries \meta{SNN} \meta{Affix/Alternate} (no comma). The new syntax permits alternate names; the obsolete does not. These forms work also with ancient and medieval names: +% In\Info{``Native''} contrast, ``native'' Eastern names use either comma-delimited syntax or the obsolete syntax (Section~\ref{sec:Obsolete}). They have index entries appropriate to Eastern names: \meta{SNN} \meta{Affix} (no comma). The current syntax permits alternate names; the obsolete does not. These forms work also with ancient and medieval names: % % \begin{quote} -% \fbox{\ \parbox{0.45\textwidth}{% -% \mystrut\cmd{\Name}\marg{SNN, Affix}\oarg{Alternate}\\ -% \mystrut\cmd{\Name}\marg{SNN}\oarg{Alternate}} -% \parbox{0.225\textwidth}{\color{nared}\mystrut\texttt{\%} \textit{new syntax}\\ \mystrut\texttt{\%} \textit{obsolete syntax}}} +% \fbox{ +% \begin{tabular}{ll} +% {\Large\strut}\cmd{\Name}\marg{SNN, Affix}\oarg{Alternate} & \color{nared}\texttt{\%} \textit{new syntax}\\ +% \end{tabular} +% } % \end{quote} % -% People\Info{avoid error} can make mistakes that these forms help one to avoid. For example, in an otherwise excellent German-language history textbook series, one finds an index entry for ``Yat-sen, Sun''. It should be ``Sun Yat-sen''.\footnote{See Immanuel Geiss, \textit{Personen: Die biographische Dimension der Weltgeschichte}, Geschichte Griffbereit vol. 2 (Munich: Wissen Media Verlag, 2002), 720. Errors arising from cultural differences and basic mistakes give justification for the design of \textsf{nameauth}.} -% The form |\Name{Sun, Yat-sen}| \Sun\ ensures the correct entry.\medskip +% People\Info{Avoid error} can make mistakes that these forms help one to avoid. For example, in an otherwise excellent German-language multi-volume history text, one finds the incorrect, Western-form index entry ``\ShowIdxPageref*[Sun]{Yat-Sen}''. It should be ``\ShowIdxPageref*{Sun, Yat-sen}''.\footnote{See Immanuel Geiss, \textit{Personen: Die biographische Dimension der Weltgeschichte}, Geschichte Griffbereit vol. 2 (Munich: Wissen Media Verlag, 2002), 720.} +% The macro |\Name*{Sun, Yat-sen}| \Name*{Sun, Yat-sen} ensures the correct entry by using the correct form. The goal is to promote cross-cultural sensitivity.\medskip +% \newpage % % \DescribeMacro{\ReverseActive} % In addition to the options for reversing (Section~\ref{sec:PkgOptions}), \cmd{\ReverseActive} and \cmd{\ReverseInactive} reverse name order for blocks of text. % \DescribeMacro{\ReverseInactive} % These all override the use of \cmd{\RevName}, which reverses once per name. % \DescribeMacro{\RevName} -% These macros do not affect the index. They work also with \cmd{\AKA} and its derivatives. The reverse mechanism shows only in full names, but it does not force full names. ``Non-native'' forms are shown by a dagger (\dag) in the next table: -% \begin{center}\small\MyStretch +% These macros do not affect the index. They work also with \cmd{\AKA} and friends. Reversing only affects long name forms. ``Non-native'' forms are shown with a dagger (\dag): +% +% \vspace{1.5ex}\leavevmode\SPatInfo{\ShowPattern[Hideyo]{Noguchi}\break \ShowPattern{Miyazaki, Hayao}}\vspace{-3.5ex} +% \begin{center}\small\MyStretch\leavevmode\vspace{-29ex}\IdxInfo{\ShowIdxPageref*[Hideyo]{Noguchi}\break \ShowIdxPageref*{Miyazaki, Hayao}}\vspace{29ex} % \begin{tabular}{rll}\toprule % & unchanged & |\RevName|\\\midrule -% |\LNoguchi| & \LNoguchi & \RevName\LNoguchi\dag\\ -% |\LNoguchi[Doctor]| & \LNoguchi[Doctor] & \raise0.5ex\hbox to 5em{\hfil\rule{3em}{0.6pt}} \\ -% |\LNoguchi[Sensei]| & \raise0.5ex\hbox to 5em{\hfil\rule{3em}{0.6pt}} & \RevName\LNoguchi[Sensei]\dag\\ -% |\Noguchi| & \Noguchi & \RevName\Noguchi\dag\\ -% |\SNoguchi| & \SNoguchi & \RevName\SNoguchi\dag\\ -% \rowcolor{black!7!white}|\LYamt| & \LYamt & \RevName\LYamt\\ -% \rowcolor{black!7!white}|\LYamt[Admiral]| & \raise0.5ex\hbox to 5em{\hfil\rule{3em}{0.6pt}} & \RevName\LYamt[Admiral]\\ -% \rowcolor{black!7!white}|\Yamt| & \Yamt & \RevName\Yamt\\ -% \rowcolor{black!7!white}|\SYamt| & \SYamt & \RevName\SYamt\\ -% \rowcolor{black!7!white}|\ForceFN\SYamt| & \ForceFN\SYamt & \ForceFN\RevName\SYamt\\\bottomrule +% \rowcolor{grey}|\LNoguchi| & \LNoguchi & \RevName\LNoguchi\dag\\ +% \rowcolor{grey}|\LNoguchi[Doctor]| & \LNoguchi[Doctor] & \raise0.5ex\hbox to 5em{\hfil\rule{3em}{0.6pt}} \\ +% \rowcolor{grey}|\LNoguchi[Sensei]| & \raise0.5ex\hbox to 5em{\hfil\rule{3em}{0.6pt}} & \RevName\LNoguchi[Sensei]\dag\\ +% \rowcolor{grey}|\Noguchi| & \Noguchi & \RevName\Noguchi\dag\\ +% \rowcolor{grey}|\SNoguchi| & \SNoguchi & \RevName\SNoguchi\dag\\ +% |\LMiyaz| & \LMiyaz & \RevName\LMiyaz\\ +% |\LMiyaz[Mr.]| & \raise0.5ex\hbox to 5em{\hfil\rule{3em}{0.6pt}} & \RevName\LMiyaz[Mr.]\\ +% |\LMiyaz[Sensei]| & \LMiyaz[Sensei] & \raise0.5ex\hbox to 5em{\hfil\rule{3em}{0.6pt}}\\ +% |\Miyaz| & \Miyaz & \RevName\Miyaz\\ +% |\SMiyaz| & \SMiyaz & \RevName\SMiyaz\\ +% |\ForceFN\SMiyaz| & \ForceFN\SMiyaz & \ForceFN\RevName\SMiyaz\\\bottomrule % \end{tabular}\medskip\\ % \end{center} % @@ -2072,120 +2177,194 @@ the README.txt or README for more information. % \DescribeMacro{\AllCapsInactive} % All override \cmd{\CapName}, which works once per name. % \DescribeMacro{\CapName} -% These capitalize \meta{SNN} in the body text only. They also work with \cmd{\AKA} and friends. For caps in the text and index see Sections~\ref{sec:AltFormat} and~\ref{sec:Hooksiii}. We show ``non-native'' Eastern forms with a dagger ({\dag}) and the old syntax with a double dagger(\ddag). +% These capitalize \meta{SNN} in the body text only. They also work with \cmd{\AKA} and friends. For caps in the text and index see Sections~\ref{sec:AltFormat} and~\ref{sec:Hooksiii}. We show ``non-native'' Eastern forms with a dagger ({\dag}): % % \begin{center}\small\MyStretch\AllCapsActive % \begin{tabular}{lll}\toprule % & |\CapName| only & |\CapName\RevName|\\\midrule -% |\Name*[Yoko]{Kanno}| & \CapName\Name*[Yoko]{Kanno} & \CapName\RevName\Name*[Yoko]{Kanno}\dag\\ -% \rowcolor{black!7!white}|\Name*{Arai, Akino}| & \Name*{Arai, Akino} & \RevName\Name*{Arai, Akino}\\ -% |\Name*{Ishida}[Yoko]| & \CapName\Name*{Ishida}[Yoko]\ddag & \CapName\RevName\Name*{Ishida}[Yoko]\ddag\\ -% \rowcolor{black!7!white}|\Name*{Yohko}| & \Name*{Yohko} & \RevName\Name*{Yohko}\\\bottomrule +% \rowcolor{grey}|\LNoguchi| & \CapName\LNoguchi & \RevName\LNoguchi\dag\\ +% |\LMiyaz| & \LMiyaz & \RevName\LMiyaz\\\bottomrule % \end{tabular}\AllCapsInactive % \end{center} -% +% % Both\Info{\cmd{\global}} \cmd{\AllCapsActive} and \cmd{\AllCapsInactive} can be used either as a pair or singly within an explicitly local scope. Use \cmd{\global} to force a global effect. % % \ReturnLink % -% \subsubsection[Particles / Ancient]{Particles, Medieval Names, and Ancient Names} +% \subsubsection[Particles]{Particles in Names} % \label{sec:NameParticles} % -% English\Info{cap rules} names with particles \textit{de}, \textit{de\ la}, \textit{d'}, \textit{von}, \textit{van}, and \textit{ten} often keep them with the last name, using varied capitalization.\footnote{According to [\hyperlink{Mulvany}{Mulvany}, 165f.] and the \textit{Chicago Manual of Style}.} \textit{Le}, \textit{La}, and \textit{L'} always are capitalized unless preceded by \textit{de}. See also Sections~\ref{sec:SimpleStart}, \ref{sec:NamePatterns}, \ref{sec:VarNames}, and \ref{sec:AltFormat}.\medskip +% Particles in names have specific rules: +% \begin{itemize} +% \item English use of \textit{de}, \textit{de\ la}, \textit{d'}, \textit{von}, \textit{van}, and \textit{ten} often keeps them with the surname with varied capitalization. +% \item \textit{Le}, \textit{La}, and \textit{L'} always are capitalized unless preceded by \textit{de}.\footnote{According to [\hyperlink{Mulvany}{Mulvany}, 152–82] and the \textit{Chicago Manual of Style}.} +% \item Modern Romance languages keep particles with the surname. +% \item German and medieval Romance languages put particles with forenames. +% \end{itemize} +% \newpage +% +% \leavevmode\SPatInfo{\ShowPattern[Martin]{Van Buren}\break \ShowPattern[Hernando]{de~Soto}\break \ShowPattern[J.W. von]{Goethe}} +% \vspace{-3ex} +% \begin{center}\small\MyStretch\leavevmode\vspace{-12ex}\IdxInfo{\ShowIdxPageref*[Martin]{Van Buren}\break \ShowIdxPageref*[Hernando]{de~Soto}\break \ShowIdxPageref*[J.W. von]{Goethe}}\vspace{12ex} +% \begin{tabular}{rll}\toprule +% \bfseries Macro & \bfseries Body Text & \bfseries Index \\\midrule +% \rowcolor{grey}\cmd{\ForgetThis}\cmd{\VBuren} & \ForgetThis\VBuren & \ShowIdxPageref*[Martin]{Van Buren}\\ +% \cmd{\VBuren} & \VBuren & \ShowIdxPageref*[Martin]{Van Buren}\\ +% \rowcolor{grey}\cmd{\ForgetThis}\cmd{\Soto} & \ForgetThis\Soto & \ShowIdxPageref*[Hernando]{de~Soto}\\ +% \cmd{\CapThis}\cmd{\Soto} & \CapThis\Soto & \ShowIdxPageref*[Hernando]{de~Soto}\\ +% \rowcolor{grey}\cmd{\ForgetThis}\cmd{\JWG} & \ForgetThis\JWG & \ShowIdxPageref*[J.W. von]{Goethe}\\ +% \cmd{\JWG} & \JWG & \ShowIdxPageref*[J.W. von]{Goethe}\\\bottomrule +% \end{tabular} +% \end{center} % -% We\Info{non-breaking\break spaces} recommend inserting a tilde (active character for a non-breaking space) or \cmd{\nobreakspace} between some particles and names to prevent bad breaks, sorting them with \cmd{\PretagName} (Section~\ref{sec:IndexSort}). -% Some particles look similar: \textit{L'} (L+apostrophe) and \textit{d'} (d+apostrophe) are two separate glyphs each. In contrast, \textit{Ľ} (L+caron) and \textit{ď} (d+caron) are one Unicode glyph each (Section~\ref{sec:Unicode}). -%\newpage +% We\Info{A few tips} recommend inserting a tilde (active character for a non-breaking space) or \cmd{\nobreakspace} between some particles and names to prevent bad breaks, sorting them with \cmd{\PretagName} (Section~\ref{sec:IndexSort}). +% Some particles look similar: \textit{L'} (L+apostrophe) and \textit{d'} (d+apostrophe) are two separate glyphs each. In contrast, \textit{Ľ} (L+caron) and \textit{ď} (d+caron) are one Unicode glyph each (Section~\ref{sec:Unicode}).\medskip % % \phantomsection % \label{page:CapThis} % \DescribeMacro{\CapThis} -% In English and modern Romance languages, e.g., \ForgetThis\Soto\ shows that these particles go in the \meta{SNN} argument of \cmd{\Name}: \Soto. When the particle appears at the beginning of a sentence, one must capitalize it: +% In English and modern Romance languages, e.g., \LSoto\ shows that these particles go in the \meta{SNN} argument of \cmd{\Name}: \Soto. When the particle appears at the beginning of a sentence, one must capitalize it: % \begin{quote}\small % |\CapThis\Soto\| \CapThis\Soto\ was a famous Spanish explorer in North America. % \end{quote} % % \cmd{\CapName} overrides the \meta{SNN} created by \cmd{\CapThis}. \cmd{\CapThis}\Version{3.2} should work with all of the Unicode characters available in the T1 encoding (its mechanism is explained in Section~\ref{sec:Unicode} and on page~\pageref{page:CapSystem}). For a broader set of Unicode characters, consider using \texttt{xelatex} and \texttt{lualatex}.\medskip % -% For\Info{surname variants} another example, we mention poet \Name[e.e.]{cummings}. One can have formatted name caps and inflections, e.g.: \ExcludeName[e.e.]{cummings's}``\SubvertThis\CapThis\Name[e.e.]{cummings's} motif of the goat-footed balloon man has underlying sexual themes that nevertheless have a childish facade.'' The easiest way to do that is from Section~\ref{sec:IndexXref}: +% For\Info{Surname variants} another example, we mention poet \Name[e.e.]{cummings}. One can have formatted name caps and inflections. The easiest way to do that is from Section~\ref{sec:GeneralIndex}: +% +% \vspace{1.5ex}\leavevmode\SPatInfo{\ShowPattern[e.e.]{cummings}\break \ShowPattern[e.e.]{cummings's}}\vspace{-4.5ex} % \begin{quote}\small -% |\ExcludeName[e.e.]{cummings's}|\\ -% . . .\\ -% |\SubvertThis\CapThis\Name[e.e.]{cummings's}%|\\ -% |\IndexName[e.e.]{cummings}|\dotfill \SubvertThis\CapThis\Name[e.e.]{cummings's}\IndexName[e.e.]{cummings} +% \StartNum +% \begin{verbatim} +%\ExcludeName[e.e.]{cummings's}\IndexName[e.e.]{cummings} +%\SubvertThis\CapThis\Name[e.e.]{cummings's} motif of the +%goat-footed balloon man has underlying sexual themes that +%nevertheless have a childish facade''.\end{verbatim} +% +%\vspace{1ex}\IdxInfo{\ShowIdxPageref*[e.e.]{cummings}}\vspace{-1ex}\ExcludeName[e.e.]{cummings's}\IndexName[e.e.]{cummings} +%\SubvertThis\CapThis\Name[e.e.]{cummings's} motif of the +%goat-footed balloon man has underlying sexual themes that +%nevertheless have a childish facade''. % \end{quote} % -% One\Warn{} must use \cmd{\SubvertThis} only for the first use to avoid ``\ForgetThis\CapThis\Name[e.e.]{cummings's}''; all name elements are capped with \cmd{\CapThis}. Using \cmd{\ExcludeName} keeps one from having to use \cmd{\SkipIndex} every time. With \textsf{nameauth} we can use both simple and complex solutions to name variation. See also Section~\ref{sec:VarNames}. +% One\Warn{} must use \cmd{\SubvertThis} only for the first use to avoid ``\ForgetThis\CapThis\Name[e.e.]{cummings's}''; all name elements are capped with \cmd{\CapThis}. Using \cmd{\ExcludeName} keeps one from having to use \cmd{\SkipIndex} every time. See also Section~\ref{sec:VarNames}. % -% Section~\ref{sec:AltFormat} explains how to use \cmd{\CapThis} with alternate formatting when using macros in name arguments. Page~\pageref{page:Inflections} describes how automation lends itself to Continental (French, German, etc.) formats and grammatical inflections.\medskip +% Section~\ref{sec:AltFormat} explains how to use \cmd{\CapThis} with alternate formatting when using macros in name arguments. Page~\pageref{page:Inflections} describes how automation lends itself to Continental formats (French, German, etc.) and grammatical inflections.\medskip % % \DescribeMacro{\AccentCapThis} -% If one uses this package on a system that does not handle Unicode, one can use \cmd{\AccentCapThis} instead of \cmd{\CapThis}\Version{3.0} to handle active initial characters. Otherwise, one should not need to use \cmd{\AccentCapThis}. +% If one uses this package on a system that does not support Unicode, one can use \cmd{\AccentCapThis} instead of \cmd{\CapThis}\Version{3.0} to handle active initial characters. Otherwise, one should not need to use \cmd{\AccentCapThis}. % -% \begin{center}\bfseries Examples\end{center} +% \ReturnLink +% \vfill +% +% \begin{verse} +% ``Rose is a rose is a rose is a rose''\\\hfill---\Name[Gertrude]{Stein}, ``Sacred Emily'' in \textit{Geography and Plays} +% \end{verse} +% \newpage +% +% \subsubsection[Medieval/Ancient]{Medieval, Ancient, and Roman Names} +% \label{sec:NameAncient} +% \medskip +% +% \begin{center}\bfseries Medieval Names\end{center} +% Medieval names present some interesting difficulties, often based on the expected standards of the context in which they are used. Some publications use them like Western names while others do not. In the following preamble snippet we have: % -% Medieval\Info{medieval names} names present some interesting difficulties, often based on the expected standards of the context in which they are used: +% \vspace{1.5ex}\leavevmode\SPatInfo{\ShowPattern{Thomas, à~Kempis}\hfill \textrm{(1--4, 7)}\break \ShowPattern{Thomas,\`a~Kempis}\hfill \textrm{(5--6)}\break \ShowPattern[Thomas]{à~Kempis}\hfill \textrm{(8--10)}}\vspace{-4.5ex} % \begin{quote}\small % \StartNum % \begin{verbatim} %\PretagName{Thomas, à~Kempis}{Thomas Akempis} % medieval %\PretagName[Thomas]{à~Kempis}{Akempis, Thomas} % Western -%\IndexRef[Thomas]{à~Kempis}{Thomas à~Kempis} % xref +%\IndexRef[Thomas]{à~Kempis}{Thomas à~Kempis} % xref %\ExcludeName{Thomas,\`a~Kempis} % alternate form excluded %\begin{nameauth} -% \< KempMed & & Thomas, à~Kempis & > % medieval -% \< KempW & Thomas & à~Kempis & > % Western +% \< KempMed & & Thomas, à~Kempis & > % medieval +% \< KempW & Thomas & à~Kempis & > % Western %\end{nameauth}\end{verbatim} % \IndexRef[Thomas]{à~Kempis}{Thomas à~Kempis} % \ExcludeName{Thomas,\`a~Kempis} -% \end{quote} +% \end{quote}\vspace{-9ex}\IdxInfo{\ShowIdxPageref*{Thomas, à~Kempis}\hfill (1--4, 7)\break \ShowIdxPageref*{Thomas,\`a~Kempis}\hfill (5--6)\break \ShowIdxPageref*[Thomas]{à~Kempis}\hfill (8--10)}\vspace{8ex} % -% The medieval forms\Version{3.1} \KempMed\ and \KempMed\ are indexed as ``\ShowIdxPageref*{Thomas, à~Kempis}.'' The place name |\ForceFN\SKempMed| ``\ForceFN\SKempMed'' (Latin for \textit{von Kempen}) technically is not a Western surname. -% \CapThis\ForceFN\SKempMed\ |\CapThis\ForceFN\SKempMed| starts a sentence. \Name{Thomas,\`a~Kempis} |\Name{Thomas,\`a~Kempis}| is different. \CapThis\SubvertThis\ForceFN\FName{Thomas, \`a~Kempis} is |\CapThis\SubvertThis\ForceFN\FName{Thomas,\`a~Kempis}|. -% One should use \cmd{\PretagName} to sort the index entry (Section~\ref{sec:IndexSort}). We excluded this alternate form (Section~\ref{sec:IndexXref}). -% \newpage +% \begin{enumerate} +% \item \KempMed\Version{3.1} is indexed as ``\ShowIdxPageref*{Thomas, à~Kempis}''. +% \item Later uses display \KempMed\ because ``\ForceFN\SKempMed'' |\ForceFN\SKempMed| is a place name, not a surname. It is Latin for \textit{von Kempen}. +% \item \CapThis\ForceFN\SKempMed\ |\CapThis\ForceFN\SKempMed| starts a sentence. +% \item We use \cmd{\PretagName} (Section~\ref{sec:IndexSort}) to sort the name. +% \item \Name{Thomas,\`a~Kempis} |\Name{Thomas,\`a~Kempis}| is a different name. As above, we would sort this name with \cmd{\PretagName}. +% \item We used \cmd{\ExcludeName} (Section~\ref{sec:GeneralIndex}) before using the alternate name to keep it out of the index. +% \item We index the canonical form here with \JustIndex\KempMed|\JustIndex\KempMed|. +% \item \KempW\ |\KempW| is a Western form with the index entry: ``\ShowIdxPageref*[Thomas]{à~Kempis}''. +% \item \CapThis\KempW\ appears via |\CapThis\KempW|. +% \item We created a cross-reference from the Western form to the medieval form, before we used the Western form, thus preventing any spurious page entries (Section~\ref{sec:GeneralIndex}). We index with the medieval form (7). +% \end{enumerate} % -% Western forms\Warn{} like |\KempW|: \KempW\ are very different from medieval forms and create different index entries. |\CapThis\KempW| gives ``\CapThis\KempW'' in the text and ``\ShowIdxPageref*[Thomas]{à~Kempis}'' in the index. -% -% Above, we created a cross-reference from the Western form to the medieval form, preventing page entries (Section~\ref{sec:IndexXref}). If we sorted the cross-reference using |\PretagName[Thomas]{à~Kempis}{a Kempis, Thomas}|, it would precede \texttt{aardvark}. We use |\PretagName[Thomas]{à~Kempis}{Akempis, Thomas}|, which sorts the cross-reference between \texttt{ajar} and \texttt{alkaline}. One should check a style manual for correct sorting (Section~\ref{sec:IndexSort}).\medskip +% Spaces count\Warn{} when sorting index entries (Section~\ref{sec:IndexSort}). Sorting the cross-reference with |\PretagName[Thomas]{à~Kempis}{a Kempis, Thomas}|, would put it before \texttt{aardvark}. |\PretagName[Thomas]{à~Kempis}{Akempis, Thomas}| sorts the cross-reference between \texttt{ajar} and \texttt{alkaline}. +% \vfil % +% \begin{tcolorbox}[colback=white,colframe=nared] +% From this point forward, we shall change what we show in the margin. +% We shall show full name patterns that reflect naming systems, +% index sorting tags, index entry tags, cross-references, +% and name info (Section~\ref{sec:NamePatterns}).\\[2ex] +% No longer shall we show index entries in the margins because they +% shall become too complex for such display to work well. +% \end{tcolorbox} +% \newpage +% +% \begin{center}\bfseries Ancient Names\end{center} % \phantomsection % \label{page:Sobriquets} -% \begingroup%^^A -% \renewcommand*\NamesFormat{}%^^A -% \renewcommand*\MainNameHook{}%^^A -% Ancient\Info{ancient names} contexts may or may not bind particles to surnames. The \meta{alternate} argument, \cmd{\PretagName}, and \cmd{\TagName} address this (Sections~\ref{sec:IndexSort}, \ref{sec:IndexTag}). +% \begingroup%^^A Local format hook redefinition +% \renewcommand*\NamesFormat{}^^A +% \renewcommand*\MainNameHook{}^^A +% Ancient contexts may or may not bind particles or other name elements to surnames. One must handle these cases not only in the text, but also in the index. In the rest of this section the examples do not use the formatting conventions of this manual and present themselves as if they were in an ordinary \LaTeX\ document. +% +% \begin{itemize} +% \item For name entries in the index, we can use \cmd{\PretagName} and \cmd{\TagName} to ensure that any ``long form'' information is displayed without using macros in the name arguments. See Sections~\ref{sec:IndexSort}, \ref{sec:IndexTag}. +% \item In the text, we can use the \meta{Alternate} argument or the name information database (Section~\ref{sec:TextTags}) to add ``long form'' information as needed. Beyond that, we would have to use macros in the name arguments. +% \end{itemize} % -% The next examples do not use the formatting conventions of this manual and sometimes hide details that are specific to this manual in order to keep things simple and reflect normal document usage. See the \texttt{dtx} source code for more information. First we use variants with \meta{alternate}:\footnote{Copies of these examples are in \texttt{examples.tex}, collocated with this manual.} +% First we explore the easiest way to handle royal or ancient variants with extra ``long form'' information using the \meta{Alternate} argument. We use macros introduced in Sections~\ref{sec:IndexSort} and~\ref{sec:IndexTag}.\footnote{Copies of examples in this section are in \texttt{examples.tex}, located with this manual.} +% % \NameAddInfo{Demetrius, I}{ Soter} +% \vspace{1.5ex}\leavevmode\PatInfo{\ShowPattern{Demetrius, I}!PRE\break \ShowPattern{Demetrius, I}!TAG\break \ShowPattern{Demetrius, I}!MN}\vspace{-4.5ex} % \begin{quote}\small % \StartNum % \begin{verbatim} -%\NameAddInfo{Demetrius, I}{ Soter} %\PretagName{Demetrius, I}{Demetrius 1} %\TagName{Demetrius, I}{ Soter, king} %\begin{nameauth} % \< Dem & & Demetrius, I & > %\end{nameauth}\end{verbatim} -% % \smallskip +% +% \MyStretch % \begin{tabular}{ll}\toprule -% |\Dem[I Soter]| & \Dem[I Soter]\\ -% \rowcolor{black!7!white}|\LDem| & \LDem\\ -% |\Dem| & \Dem\\\bottomrule -% \end{tabular} -% \end{quote} +% \cmd{\Dem[I Soter]} & \Dem[I Soter]\\ +% \rowcolor{grey}^^A +% \cmd{\LDem} & \LDem\\ +% \cmd{\Dem} & \Dem\\\bottomrule +% \end{tabular}\smallskip % -% \makeatletter\renewcommand*\NamesFormat[1]{\begingroup%^^A -% \protected@edef\temp{\endgroup{#1%^^A +% \IndexActual{@}^^A +% \TagName{Demetrius, I}{ Soter, king}^^A +% Index (normal \LaTeX\ document): \texttt{\ShowIdxPageref{Demetrius, I}}^^A +% \TagName{Demetrius, I}{ Soter, king\string|hyperpage}^^A +% \end{quote} +% +% \makeatletter\renewcommand*\NamesFormat[1]{^^A +% \begingroup^^A +% \protected@edef\temp{\endgroup{#1^^A % \noexpand\NameQueryInfo[\unexpanded\expandafter{\the\@nameauth@toksa}] % {\unexpanded\expandafter{\the\@nameauth@toksb}} % [\unexpanded\expandafter{\the\@nameauth@toksc}]}}\temp}\makeatother -% For a more automated approach, we can use ``text tags'' in the formatting macros (see Sections~\ref{sec:TextTags}, \ref{sec:Hooksii}). +% Using the name information database (``text tags'') with the formatting macros (Sections~\ref{sec:TextTags}, \ref{sec:Hooksii}), we can provide a more automatic approach: % +% \vspace{1.5ex}\leavevmode\PatInfo{\ShowPattern{Demetrius, I}!DB\break \ShowPattern{Demetrius, I}!MN}\vspace{-4.5ex} % \begin{quote}\small % \ContinueNum % \begin{verbatim} +%\NameAddInfo{Demetrius, I}{ Soter} %\makeatletter %\renewcommand*\NamesFormat[1]{% % \begingroup% @@ -2200,924 +2379,618 @@ the README.txt or README for more information. %} %\makeatother\end{verbatim} % -% \smallskip +% \smallskip\MyStretch % \begin{tabular}{ll}\toprule -% |\ForgetThis\Dem| & \ForgetThis\Dem\\ -% \rowcolor{black!7!white}|\LDem| & \LDem\\ -% |\Dem| & \Dem\\\bottomrule -% \end{tabular} +% \cmd{\ForgetThis}\cmd{\Dem} & \ForgetThis\Dem\\ +% \rowcolor{grey}^^A +% \cmd{\LDem} & \LDem\\ +% \cmd{\Dem} & \Dem\\\bottomrule +% \end{tabular}\smallskip +% +% The index entry is the same as above. % \end{quote} -% -% The Roman naming\Info{Roman names} system does present some challenges. As long as we do not use \cmd{\CapThis}, we do not need alternate formatting (Section~\ref{sec:AltFormat}). Earlier we treated \LCicero[Marcus Tullius] as a Western name. Now we show how to handle Roman names more properly. -% -% Roman names have a \textit{praenomen}, a personal name, then a \textit{nomen}, a clan name, followed by a \textit{cognomen}, a ``nickname,'' except it could be inherited from one's father to denote clan branches. Added to that are \textit{agnomina}, affixed names. -% -% Popular\Info{popular works} sources tend to treat the \textit{cognomen} as we might a surname, with the indexed form: \ShowIdxPageref*[\meta{praenomen} \meta{nomen}]{\meta{cognomen} \meta{agnomen}}.\footnote{See Geiss, \textit{Geschichte Griffbereit}; Kinder and Hilgemann, \textit{dtv-Atlas zur Weltgeschichte}, 2 vols., 29th printing (1964; Munich: Deutscher Taschenbuch Verlag, 1993). For further resources see: \url{http://books.infotoday.com/books/Indexing-names.shtml}. See also \url{https://en.wikipedia.org/wiki/Roman_naming_conventions}.} -% We want all names in the index, so we define macros in \meta{FNN} and \meta{SNN} that expand to become one or two components: \textit{praenomen} and \textit{nomen}; \textit{cognomen} and \textit{agnomen}. We begin by defining a name with macros using \cmd{\noexpand} to prevent error: +% \endgroup^^A Local format hook redefinition +% +% \newpage +% +% \leavevmode\begin{center}\bfseries Roman Names\end{center} +% \phantomsection +% \label{page:Romani} +% Earlier we treated \Name*[M.T.]{Cicero}[Marcus Tullius] as a Western name. Now we handle Roman names properly. The examples below do not use this manual's standard formatting. +% Roman names have the following format: +% \begin{itemize} +% \item A personal name: \textit{praenomen} +% \item A clan name: \textit{nomen} +% \item A nickname, often hereditary to denote clan branches: \textit{cognomen} +% \item Affixed names: \textit{agnomina} +% \end{itemize} +% +% Popular\Info{Popular works} sources tend to treat the \textit{cognomen} as if it were a Western surname.\footnote{See Geiss, \textit{Geschichte Griffbereit}; Kinder and Hilgemann, \textit{dtv-Atlas zur Weltgeschichte}, 2 vols., 29th printing (1964; Munich: Deutscher Taschenbuch Verlag, 1993). See also \href{http://books.infotoday.com/books/Indexing-names.shtml}{this page} on indexing and \href{https://en.wikipedia.org/wiki/Roman_naming_conventions}{Wikipedia} on Roman names.} +% Using this approach, Roman names have the indexed form: +% \begin{quote} +% \ShowIdxPageref*[\meta{praenomen} \meta{nomen}]{\meta{cognomen} \meta{agnomen}} +% \end{quote} +% +% Using \textsf{nameauth}, one can drop both \textit{praenomen} and \textit{nomen} automatically in subsequent uses in the text. We accomplish this by designing names using macros in their arguments. When doing so, here are a few tips: +% +% \begin{itemize} +% \item Use alternate formatting (Sections~\ref{sec:AltFormat}) if the macros in the name arguments will be ``segmented'' in some way, as \cmd{\CapThis} does by separating the first letter from the rest. +% \item Use \cmd{\noexpand} before the macros in the name arguments if they contain conditional statements. Otherwise one will get spurious index entries. +% \item Ensure that the default state of any Boolean flags (\texttt{\textbackslash if}\meta{flag}) trigger expansion so that all the desired names appear in the index entry. +% \end{itemize} +% We define all macros and conditionals used in naming macro arguments in the preamble. We use \cmd{\noexpand} in the naming macro arguments to prevent error. Since we do not use \cmd{\CapThis} in the examples below, we skip alternate formatting for simplicity, yet we still recommend it. +% +%Since we have four name components, we need two Boolean flags to reflect local changes and two global flags to trigger the local changes without affecting the index. We define macros in \meta{FNN} and \meta{SNN} that expand one or two components: \textit{praenomen} and \textit{nomen}, \textit{cognomen} and \textit{agnomen}. +% +% \begin{quote}\small +% \StartNum +% \begin{verbatim} %\newif\ifSkipGens %\newif\ifNoGens %\newif\ifSkipAgnomen %\newif\ifNoAgnomen -%\newcommand*\SCIPi{\ifNoGens Publius\else -% Publius Cornelius\fi} -%\newcommand*\SCIPii{\ifNoAgnomen Scipio\else -% Scipio Africanus\fi} +%\newcommand*\SCIPi{\ifNoGens +% Publius\else Publius Cornelius\fi} +%\newcommand*\SCIPii{\ifNoAgnomen +% Scipio\else Scipio Africanus\fi} %\newcommand*\ScipioOnly{\SkipAgnomentrue\Scipio} -%\renewcommand*\NamesFormat[1]%^^A -% {\ifSkipGens\NoGenstrue\fi\ifSkipAgnomen\NoAgnomentrue\fi#1%^^A -% \global\SkipGensfalse\global\SkipAgnomenfalse} -%\renewcommand*\MainNameHook[1]%^^A -% {\ifSkipGens\NoGenstrue\fi\ifSkipAgnomen\NoAgnomentrue\fi#1%^^A -% \global\SkipGensfalse\global\SkipAgnomenfalse} -% \begin{quote}\small -% \StartNum -% \begin{verbatim} %\begin{nameauth} % \< Scipio & \noexpand\SCIPi & \noexpand\SCIPii & > %\end{nameauth} %\PretagName[\noexpand\SCIPi]{\noexpand\SCIPii}{Scipio Africanus}\end{verbatim} % \end{quote} % -% We define the flags and macros by which the name will change. The global state of \cmd{\NoGens} and\cmd{\NoAgnomen} determine the index form. The local scope in the formatting hooks allows changes that are reset when exiting that scope. The logic is inverted; false prints long, true prints short: +% We begin a new scope below, redefining the formatting hooks (Section~\ref{sec:Formatting}), which affect only names printed in the text. If the local Boolean flags are false, one gets longer name forms. If the flags are true, one gets shorter forms. This approach allows the global state of the flags to be false by default, meaning that one need not remember to set any of them true in the preamble. That results in one less thing to remember, and one less problem to fix. +%\begingroup^^A Local format hook redefinition +%\renewcommand*\NamesFormat[1]^^A +% {\ifSkipGens\NoGenstrue\fi\ifSkipAgnomen\NoAgnomentrue\fi#1^^A +% \global\SkipGensfalse\global\SkipAgnomenfalse} +%\renewcommand*\MainNameHook[1]^^A +% {\ifSkipGens\NoGenstrue\fi\ifSkipAgnomen\NoAgnomentrue\fi#1^^A +% \global\SkipGensfalse\global\SkipAgnomenfalse} % \begin{quote}\small % \ContinueNum % \begin{verbatim} -%\newif\ifSkipGens -%\newif\ifNoGens -%\newif\ifSkipAgnomen -%\newif\ifNoAgnomen -%\newcommand*\SCIPi{\ifNoGens Publius\else -% Publius Cornelius\fi} -%\newcommand*\SCIPii{\ifNoAgnomen Scipio\else -% Scipio Africanus\fi} -%\newcommand*\ScipioOnly{\SkipAgnomentrue\Scipio} -%\renewcommand*\NamesFormat[1]%^^A +%\renewcommand*\NamesFormat[1] % {\ifSkipGens\NoGenstrue\fi\ifSkipAgnomen\NoAgnomentrue\fi#1% % \global\SkipGensfalse\global\SkipAgnomenfalse} -%\renewcommand*\MainNameHook[1]%^^A +%\renewcommand*\MainNameHook[1] % {\ifSkipGens\NoGenstrue\fi\ifSkipAgnomen\NoAgnomentrue\fi#1% % \global\SkipGensfalse\global\SkipAgnomenfalse}\end{verbatim} -%\smallskip -% \ForgetThis\ScipioOnly\ \cmd{\ScipioOnly} was born around 236 \textsc{bc} into the Scipio branch of the Cornelius clan, one of six large patrician clans. \ScipioOnly\ \cmd{\ScipioOnly} rose to military fame during the Second Punic War. Thereafter he was known as \Scipio\ \cmd{\Scipio}. % \end{quote} -% -% An advantage of the popular format is that one can drop both \textit{praenomen} and \textit{nomen} automatically in subsequent uses. Yet in any case, one can define helper macros to change Boolean flags. The raw index entry is fairly lengthy by necessity, governed by the global state of the Boolean flags, and expanding to: +% +% The index always shows the name determined by the global state of \cmd{\NoGens} and \cmd{\NoAgnomen}, which we set up as false, meaning a maximally long name form. In the body text we have: % \begin{quote}\small -% \ShowIdxPageref[\noexpand\SCIPi]{\noexpand\SCIPii} +% \ForgetThis\ScipioOnly\ \cmd{\ScipioOnly} was born around 236 \textsc{bc} into the Scipio branch of the Cornelius clan, one of six large patrician clans. \ScipioOnly\ \cmd{\ScipioOnly} rose to military fame during the Second Punic War. Thereafter he was known as \Scipio\ \cmd{\Scipio}. % \end{quote} -% -% The\Info{scholarly works} \textit{Oxford Classical Dictionary} and other scholarly sources index under the \textit{nomen}. That requires a similar approach, but it moves the \textit{nomen} from \meta{FNN} to \meta{SNN}. Although we will not index the name, we will show how to set up \SkipGenstrue\Scipio\ to work in that alternate configuration. -% \newpage -% -% We keep the Boolean flags and formatting hooks from above. We redefine the name in the following manner: +% +% Below we show more information about popular name forms by way of comparison with scholarly name forms.\medskip +% +% The\Info{Scholarly works} \textit{Oxford Classical Dictionary} and other scholarly sources index according to the \textit{nomen}. That approach moves the \textit{nomen} from \meta{FNN} to \meta{SNN}. They have the the indexed form: +% \begin{quote} +% \ShowIdxPageref*[\meta{praenomen}]{\meta{nomen} \meta{cognomen} \meta{agnomen}} +% \end{quote} +% +% The two methods do not clash \textit{per se} in the text, but they make incompatible index entries. In this case, since we have indexed \ScipioOnly\ under the popular form above, we use \cmd{\ExcludeName} to exclude the scholarly form below. +% +% In the document preamble we define the following Boolean flags and macros. We use a nested conditional in \meta{SNN}. The default still is to show all names so that they can be indexed that way: % \begin{quote}\small % \StartNum % \begin{verbatim} +%\newif\ifSkipGens % These flags remain the same as above. +%\newif\ifNoGens +%\newif\ifSkipAgnomen +%\newif\ifNoAgnomen +%\global\def\CSA{\ifNoGens\ifNoAgnomen +% Scipio\else +% Scipio Africanus\fi +% \else\ifNoAgnomen +% Cornelius Scipio\else +% Cornelius Scipio Africanus\fi\fi} +%\ExcludeName[Publius]{\noexpand\CSA} %\begin{nameauth} -% \< OScipio & Publius & \noexpand\CSA & > +% \< OScipio & Publius & \noexpand\CSA & > % O for Oxford %\end{nameauth} %\PretagName[Publius]{\noexpand\CSA}{Cornelius Scipio Africanus}\end{verbatim} % \end{quote} -% -%\newcommand*\CSA{\ifNoGens -% \ifNoAgnomen -% Scipio\else -% Scipio Africanus\fi -% \else\ifNoAgnomen -% Cornelius Scipio\else -% Cornelius Scipio Africanus\fi\fi} -% \ExcludeName[Publius]{\noexpand\CSA} -% We use a nested conditional in \meta{SNN}. The default still is to show all names so that they can be indexed that way. This time we decided to index under the popular form instead of the scholarly one, so we exclude the scholarly form: -% \begin{quote}\small -% \StartNum -% \begin{verbatim} -%\newcommand*\CSA{\ifNoGens -% \ifNoAgnomen -% Scipio\else -% Scipio Africanus\fi -% \else\ifNoAgnomen -% Cornelius Scipio\else -% Cornelius Scipio Africanus\fi\fi} -%\ExcludeName[Publius]{\noexpand\CSA}\end{verbatim} -% \end{quote} -% -% The scholarly form has a different name pattern, so it is not compatible with the popular version. Nevertheless, we show what the raw index entry of the scholarly form would be. We include some of the more meaningful forms of both versions: -% \begin{quote}\small -% \cmd{\ShowPattern[Publius]\{}\cmd{\noexpand}\cmd{\CSA\}}:\\ -% \hbox{}\quad \ShowPattern[Publius]{\noexpand\CSA} -% -% \cmd{\ShowIdxPageref[Publius]\{}\cmd{\noexpand}\cmd{\CSA\}}:\\ -% \hbox{}\quad \ShowIdxPageref[Publius]{\noexpand\CSA} -% -% \textbf{First use:}\\[0.5ex] -% \cmd{\OScipio}:\quad \OScipio\\ -% \cmd{\Scipio\ }:\quad \ForgetThis\Scipio -% -% \textbf{Subsequent use:}\\[0.5ex] -% \hphantom{\cmd{\SkipGenstrue}}\cmd{\OScipio}:\quad \OScipio\\ -% \cmd{\SkipGenstrue}\cmd{\OScipio}:\quad \SkipGenstrue\OScipio\\ -% \hphantom{\cmd{\SkipGenstrue}}\cmd{\Scipio\ }:\quad \SkipGenstrue\Scipio -% -% \textbf{Subsequent use, full, no \textit{agnomen}:}\\[0.5ex] -% \cmd{\SkipAgnomentrue}\cmd{\LOScipio}:\quad \SkipAgnomentrue\LOScipio\\ -% \cmd{\SkipAgnomentrue}\cmd{\LScipio\ }:\quad \SkipAgnomentrue\LScipio -% -% \textbf{Subsequent use, shortest forms:}\\[0.5ex] -% \hphantom{\cmd{\SkipGenstrue}}\cmd{\SkipAgnomentrue}\cmd{\OScipio}:\quad \SkipAgnomentrue\OScipio\\ -% \cmd{\SkipGenstrue}\cmd{\SkipAgnomentrue}\cmd{\OScipio}:\quad \SkipGenstrue\SkipAgnomentrue\OScipio\\ -% \hphantom{\cmd{\SkipGenstrue}}\cmd{\SkipAgnomentrue}\cmd{\Scipio\ }:\quad \SkipAgnomentrue\Scipio -% -% \textbf{Subsequent use, personal name:}\\[0.5ex] -% \hphantom{\cmd{\SkipGenstrue}}\cmd{\SOScipio}:\quad \SOScipio\\ -% \cmd{\SkipGenstrue}\cmd{\SScipio\ }:\quad \SkipGenstrue\SScipio -% \end{quote} -% -% See Sections~\ref{sec:ErrorProt}, \ref{sec:AltFormat}, and \ref{sec:Hooks} for more guidance on avoiding errors when using name arguments that contain macros. -% \endgroup -% -% \ReturnLink -% \newpage % -% \subsection{Basic Formatting} -% \label{sec:Formatting} +% We keep the same formatting macros that we defined above. By the way, these formatting macros could work with regular names as well as Roman names, e.g., \LDem, because they have no side effects. % -% Below are many of the forms and formats that names can have: -% -% \ifDoTikZ -% \begin{tcolorbox}[colframe=naslate,sidebyside,lower separated=true,adjusted title={\hfil Full Forms, Front Matter\hspace{5em} Short Forms, Front matter}]\centering -% {\cmd{\NamesInactive}}\NamesInactive -% \begin{tcolorbox}[left=2mm,right=2mm,bottom=1mm,colback=white,adjusted title={\sffamily\bfseries\hfil First Use (Default)}]\small -% \begin{tabular}{@{}ll@{}} -% \cmd{\Name} & \ForgetThis\Pat\\ -% & \ForgetThis\Eliz\\ -% & \ForgetThis\Yamt\\ -% \cmd{\Name*} & \ForgetThis\LPat\\ -% \cmd{\FName} & \ForgetThis\SPat\\ -% \end{tabular} -% \end{tcolorbox} -% \begin{tcolorbox}[left=2mm,right=2mm,bottom=1mm,colback=white,adjusted title={\sffamily\bfseries\hfil Later Use (\texttt{*} or \cmd{\L}\meta{macro})}]\small -% \begin{tabular}{@{}ll@{}} -% \cmd{\Name*} & \LPat\\ -% & \LEliz\\ -% & \LYamt\\ -% \end{tabular} -% \end{tcolorbox} -% \begin{tcolorbox}[left=2mm,right=2mm,bottom=1mm,colback=white,adjusted title={\sffamily\bfseries\hfil Long, with \cmd{\DropAffix}}]\small -% \begin{tabular}{@{}ll@{}} -% \cmd{\DropAffix}\cmd{\LPat}\\ \SubvertThis\DropAffix\LPat\\ -% \end{tabular} -% \end{tcolorbox} -% \tcblower\centering -% {\cmd{\NamesInactive}}\NamesInactive -% \begin{tcolorbox}[left=2mm,right=2mm,bottom=1mm,colback=white,adjusted title={\sffamily\bfseries\hfil Later Use (Default)}]\small -% \begin{tabular}{@{}ll@{}} -% \cmd{\Name} & \SubvertThis\Pat; \SubvertThis\Eliz\\ -% & \SubvertThis\Yamt\\ -% \cmd{\FName}, & \SubvertThis\SPat; \SubvertThis\SEliz\\ -% \cmd{\S}\meta{macro} & \SubvertThis\SYamt\\ -% \end{tabular} -% \end{tcolorbox}\vspace{1.4ex} -% \begin{tcolorbox}[left=2mm,right=2mm,bottom=1mm,colback=white,adjusted title={\sffamily\bfseries\hfil Later Use (\cmd{\ForceName})}]\small -% \begin{tabular}{@{}ll@{}} -% \cmd{\Name} & \SubvertThis\ForceName\Pat; \SubvertThis\ForceName\Eliz\\ -% & \SubvertThis\ForceName\Yamt\\ -% \cmd{\FName}, & \SubvertThis\ForceName\SPat; \SubvertThis\ForceName\SEliz\\ -% \cmd{\S}\meta{macro} & \SubvertThis\ForceName\SYamt\\ -% \end{tabular} -% \end{tcolorbox}\vspace{1.4ex} -% \begin{tcolorbox}[left=2mm,right=2mm,bottom=1mm,colback=white,adjusted title={\sffamily\bfseries\hfil Later Use (\cmd{\ForceFN})}]\small -% \begin{tabular}{@{}ll@{}} -% \cmd{\FName}, \cmd{\S}\meta{macro} & \SubvertThis\ForceFN\SYamt\\ -% \end{tabular} -% \end{tcolorbox} -% \end{tcolorbox} -% \vfil -% \begin{tcolorbox}[colframe=naslate,sidebyside,lower separated=true,adjusted title={\hfil Full Forms, Main Matter\hspace{5em} Short Forms, Main Matter}]\centering -% {\cmd{\NamesActive}}\NamesActive -% \begin{tcolorbox}[left=2mm,right=2mm,bottom=1mm,colback=white,adjusted title={\sffamily\bfseries\hfil First Use (Default)}]\small -% \begin{tabular}{@{}ll@{}} -% \cmd{\Name} & \ForgetThis\Pat\\ -% & \ForgetThis\Eliz\\ -% & \ForgetThis\Yamt\\ -% \cmd{\Name*} & \ForgetThis\LPat\\ -% \cmd{\FName} & \ForgetThis\SPat\\ -% \end{tabular} -% \end{tcolorbox} -% \begin{tcolorbox}[left=2mm,right=2mm,bottom=1mm,colback=white,adjusted title={\sffamily\bfseries\hfil Later Use (\texttt{*} or \cmd{\L}\meta{macro})}]\small -% \begin{tabular}{@{}ll@{}} -% \cmd{\Name*} & \LPat\\ -% & \LEliz\\ -% & \LYamt\\ -% \end{tabular} -% \end{tcolorbox} -% \begin{tcolorbox}[left=2mm,right=2mm,bottom=1mm,colback=white,adjusted title={\sffamily\bfseries\hfil Long, with \cmd{\DropAffix}}]\small -% \begin{tabular}{@{}ll@{}} -% \cmd{\DropAffix}\cmd{\LPat}\\ \SubvertThis\DropAffix\LPat\\ -% \end{tabular} -% \end{tcolorbox} -% \tcblower\centering -% {\cmd{\NamesActive}}\NamesActive -% \begin{tcolorbox}[left=2mm,right=2mm,bottom=1mm,colback=white,adjusted title={\sffamily\bfseries\hfil Later Use (Default)}]\small -% \begin{tabular}{@{}ll@{}} -% \cmd{\Name} & \SubvertThis\Pat; \SubvertThis\Eliz\\ -% & \SubvertThis\Yamt\\ -% \cmd{\FName}, & \SubvertThis\SPat; \SubvertThis\SEliz\\ -% \cmd{\S}\meta{macro} & \SubvertThis\SYamt\\ -% \end{tabular} -% \end{tcolorbox}\vspace{1.4ex} -% \begin{tcolorbox}[left=2mm,right=2mm,bottom=1mm,colback=white,adjusted title={\sffamily\bfseries\hfil Later Use (\cmd{\ForceName})}]\small -% \begin{tabular}{@{}ll@{}} -% \cmd{\Name} & \SubvertThis\ForceName\Pat; \SubvertThis\ForceName\Eliz\\ -% & \SubvertThis\ForceName\Yamt\\ -% \cmd{\FName}, & \SubvertThis\ForceName\SPat; \SubvertThis\ForceName\SEliz\\ -% \cmd{\S}\meta{macro} & \SubvertThis\ForceName\SYamt\\ -% \end{tabular} -% \end{tcolorbox}\vspace{1.4ex} -% \begin{tcolorbox}[left=2mm,right=2mm,bottom=1mm,colback=white,adjusted title={\sffamily\bfseries\hfil Later Use (\cmd{\ForceFN})}]\small -% \begin{tabular}{@{}ll@{}} -% \cmd{\FName}, \cmd{\S}\meta{macro} & \SubvertThis\ForceFN\SYamt\\ -% \end{tabular} -% \end{tcolorbox} -% \end{tcolorbox} -% \else\bigskip -% \begin{center}\small\NamesInactive -% \begin{tabular}{@{\hspace{4em}}c@{\hspace{6em}}c} -% Full Forms, Front Matter & Short Forms, Front Matter\\ -% \cmd{\NamesInactive} & \cmd{\NamesInactive}\medskip\\ -% \end{tabular} -% -% \begin{tabular}{llll}\toprule -% \cmd{\Name} & \ForgetThis\Pat & \cmd{\Name} & \SubvertThis\Pat, \SubvertThis\Eliz\\ -% & \ForgetThis\Eliz & & \SubvertThis\Yamt\\ -% & \ForgetThis\Yamt & \cmd{\FName}, & \SubvertThis\SPat; \SubvertThis\SEliz\\ -% \cmd{\Name*} & \ForgetThis\LPat & \cmd{\S}\meta{macro} & \SubvertThis\SYamt\\ -% \cmd{\FName} & \ForgetThis\SPat & \\\midrule -% & & Using \cmd{\ForceName} \\ -% \cmd{\Name*}, & \LPat & \cmd{\Name} & \SubvertThis\ForceName\Pat; \SubvertThis\ForceName\Eliz\\ -% \cmd{\L}\meta{macro} & \LEliz & & \SubvertThis\ForceName\Yamt\\ -% & \LYamt & \cmd{\FName}, & \SubvertThis\ForceName\SPat; \SubvertThis\ForceName\SEliz\\ -% & & \cmd{\S}\meta{macro} & \SubvertThis\ForceName\SYamt\\\midrule -% & & Using \cmd{\ForceFN} \\ -% \cmd{\DropAffix}\cmd{\LPat} & \SubvertThis\DropAffix\LPat & \cmd{\FName}, \cmd{\S}\meta{macro} & \SubvertThis\ForceFN\SYamt\\\bottomrule% \end{tabular} -% \end{center}\bigskip -% \begin{center}\small\NamesActive -% \begin{tabular}{@{\hspace{4em}}c@{\hspace{6em}}c} -% Full Forms, Main Matter & Short Forms, Main Matter\\ -% \cmd{\NamesActive} & \cmd{\NamesActive}\medskip\\ -% \end{tabular} -% -% \begin{tabular}{llll}\toprule -% \cmd{\Name} & \ForgetThis\Pat & \cmd{\Name} & \SubvertThis\Pat; \SubvertThis\Eliz\\ -% & \ForgetThis\Eliz & & \SubvertThis\Yamt\\ -% & \ForgetThis\Yamt & \cmd{\FName}, & \SubvertThis\SPat; \SubvertThis\SEliz\\ -% \cmd{\Name*} & \ForgetThis\LPat & \cmd{\S}\meta{macro} & \SubvertThis\SYamt\\ -% \cmd{\FName} & \ForgetThis\SPat & \\\midrule -% & & Using \cmd{\ForceName} \\ -% \cmd{\Name*}, & \LPat & \cmd{\Name} & \SubvertThis\ForceName\Pat; \SubvertThis\ForceName\Eliz\\ -% \cmd{\L}\meta{macro} & \LEliz & & \SubvertThis\ForceName\Yamt\\ -% & \LYamt & \cmd{\FName}, & \SubvertThis\ForceName\SPat; \SubvertThis\ForceName\SEliz\\ -% & & \cmd{\S}\meta{macro} & \SubvertThis\ForceName\SYamt\\\midrule -% & & Using \cmd{\ForceFN} \\ -% \cmd{\DropAffix}\cmd{\LPat} & \SubvertThis\DropAffix\LPat & \cmd{\FName}, \cmd{\S}\meta{macro} & \SubvertThis\ForceFN\SYamt\\\bottomrule +% The scholarly form of Roman names has a different name pattern, so it is not compatible with the popular version. Nevertheless, we show what the index entries would be in a normal \LaTeX\ document without hyperlinks. Since we have excluded the scholarly form in order to suppress any spurious index entries, we only index the popular form below: +% +% \begin{center}\footnotesize\IndexActual{@} +% \begin{tabular}{ll} +% \multicolumn{2}{l}{\small\textbf{Simplified Name Patterns:}}\\ +% Scholarly: & \texttt{\ShowPattern[Publius]{\noexpand\CSA}}\\ +% Popular: & \texttt{\ShowPattern[\noexpand\SCIPi]{\noexpand\SCIPii}}\\[2ex] +% +% \multicolumn{2}{l}{\small\textbf{Full Index Entries:}}\\ +% \UntagName[Publius]{\noexpand\CSA}^^A +% \UntagName[\noexpand\SCIPi]{\noexpand\SCIPii}^^A +% Scholarly: & \texttt{\ShowIdxPageref[Publius]{\noexpand\CSA}}\\ +% Popular: & \texttt{\ShowIdxPageref[\noexpand\SCIPi]{\noexpand\SCIPii}}^^A +% \TagName[Publius]{\noexpand\CSA}{\string|hyperpage}^^A +% \TagName[\noexpand\SCIPi]{\noexpand\SCIPii}{\string|hyperpage}\\[2ex] +% +% \multicolumn{2}{l}{\small\textbf{Basic Index Entries:}}\\ +% \UntagName[Publius]{\noexpand\CSA}^^A +% Scholarly: & \ShowIdxPageref*[Publius]{\noexpand\CSA}\\ +% Popular: & \ShowIdxPageref*[\noexpand\SCIPi]{\noexpand\SCIPii}^^A +% \TagName[Publius]{\noexpand\CSA}{\string|hyperpage}\\ % \end{tabular} % \end{center} -% \fi -% \newpage -% -% These formatting features of \textsf{nameauth} can work with name control macros (Section~\ref{sec:NameControl}) in, for example, \textsf{beamer} overlays to define consistently the context and outcome of how names appear. There are two kinds of formatting at work that interact with each other: -% \begin{enumerate}\small -% \item \emph{Syntactic Formatting:} Reversing and caps normally occur only in the body text, not the index. Yet macros in name arguments affect both text and index. -% \item \emph{Name Post-Processing:} Hook macros apply formatting only to the printed form of a name after parsing. See also Section~\ref{sec:Hooksiii}. -% \end{enumerate} -% -% \DescribeMacro{\NamesFormat} -% Independent ``main-matter'' and ``front-matter'' systems are used to format first and subsequent name uses. -% \DescribeMacro{\MainNameHook} -% The main-matter system uses \cmd{\NamesFormat} to post-process first occurrences of names and \cmd{\MainNameHook} for subsequent uses. -% \DescribeMacro{\FrontNamesFormat} -% The front-matter system uses \cmd{\FrontNamesFormat} for first uses and -% \DescribeMacro{\FrontNameHook} -% \cmd{\FrontNameHook} for subsequent uses. The \texttt{alwaysformat} option\Version{2.5} causes only \cmd{\NamesFormat} and \cmd{\FrontNamesFormat} to be used (cf. Section~\ref{sec:NamePatterns}).\footnote{The names of these macros may seem poorly conceived. When starting work on this package, this author was ignorant of the breadth of how names might be handled. Designed to meet the needs of a master's thesis, this package has evolved to meet the needs of several published works. At one time, \cmd{\NamesFormat} was the only macro that did any formatting. The rest came later. A certain degree of cargo cult programming arose, to be corrected in the 3.0 series of \textsf{nameauth}.}\medskip -% -% \DescribeMacro{\NamesActive} -% \cmd{\NamesInactive} and the \texttt{frontmatter} option make names use the front matter system. \cmd{\NamesActive} switches names to the main matter system. -% \DescribeMacro{\NamesInactive}\medskip -% -% These\Info{\cmd{\global}} two macros can be used explicitly as a pair or singly within an explicit local scope. Use \cmd{\global} to force a global effect.\medskip -% -% The two formatting systems are distinct, useful for front matter and main matter, text and footnotes, etc. We show this with different colors: -% \begin{quote}\small -% \StartNum -% \begin{verbatim} -%\colorlet{nared}{red!50!black} -%\colorlet{nagreen}{green!35!black} -%\colorlet{nablue}{blue!50!black} -%\colorlet{nabrown}{brown!55!black} -%\renewcommand*\FrontNamesFormat[1]{\color{nared}\sffamily #1} -%\renewcommand*\FrontNameHook[1]{\color{nagreen}\sffamily #1} -%\renewcommand*\NamesFormat[1]{\color{nablue}\sffamily #1} -%\renewcommand*\MainNameHook[1]{\color{nabrown}\sffamily #1}\end{verbatim} -% \end{quote} % -% \begin{center}\small\MyStretch -% \NamesInactive -% \begin{tabular}{ll}\toprule -% Front-matter system: & \cmd{\NamesInactive}\\\midrule -% |\Name[Rudolph]{Carnap}| & \Name[Rudolph]{Carnap}\\ -% \rowcolor{black!7!white}|\Name[Rudolph]{Carnap}| & \Name[Rudolph]{Carnap}\\ -% |\Name[Nicolas]{Malebranche}| & \Name[Nicolas]{Malebranche}\\ -% \rowcolor{black!7!white}|\Name[Nicolas]{Malebranche}| & \Name[Nicolas]{Malebranche}\\\bottomrule -% \end{tabular}\vfil +% Below we compare some differences between the scholarly and popular forms, and how to get equivalent forms in the text while understanding that they would be two separate forms in the index. % -% \NamesActive -% \begin{tabular}{ll}\toprule -% Main-matter system: & \cmd{\NamesActive}\\\midrule -% |\Name[Rudolph]{Carnap}| & \Name[Rudolph]{Carnap}\\ -% \rowcolor{black!7!white}|\Name[Rudolph]{Carnap}| & \Name[Rudolph]{Carnap}\\ -% |\Name[Nicolas]{Malebranche}| & \Name[Nicolas]{Malebranche}\\ -% \rowcolor{black!7!white}|\Name[Nicolas]{Malebranche}| & \Name[Nicolas]{Malebranche}\\\bottomrule +% \begin{center}\footnotesize +% \begin{tabular}{p{0.51\textwidth}l} +% \multicolumn{2}{l}{\small\textbf{First use:}}\\ +% scholarly:\dotfill \cmd{\OScipio} & \OScipio\\ +% popular:\dotfill \cmd{\Scipio} & \ForgetThis\Scipio\\[2ex] +% +% \multicolumn{2}{l}{\small\textbf{Subsequent use:}}\\ +% scholarly:\dotfill \cmd{\OScipio} & \OScipio\\ +% scholarly:\dotfill \cmd{\SkipGenstrue}\cmd{\OScipio} & \SkipGenstrue\OScipio\\ +% popular:\dotfill \cmd{\Scipio} & \SkipGenstrue\Scipio\\[2ex] +% +% \multicolumn{2}{l}{\small\textbf{Subsequent use, full, no \textit{agnomen}:}}\\ +% scholarly:\dotfill \cmd{\SkipAgnomentrue}\cmd{\LOScipio} & \SkipAgnomentrue\LOScipio\\ +% popular:\dotfill \cmd{\SkipAgnomentrue}\cmd{\LScipio} & \SkipAgnomentrue\LScipio\\[2ex] +% +% \multicolumn{2}{l}{\small\textbf{Subsequent use, shortest forms:}}\\ +% scholarly:\dotfill \cmd{\SkipAgnomentrue}\cmd{\OScipio} & \SkipAgnomentrue\OScipio\\ +% \hfill\cmd{\SkipGenstrue}\cmd{\SkipAgnomentrue}\cmd{\OScipio} & \SkipGenstrue\SkipAgnomentrue\OScipio\\ +% popular:\dotfill \cmd{\SkipAgnomentrue}\cmd{\Scipio\ } & \SkipAgnomentrue\Scipio\\[2ex] +% +% \multicolumn{2}{l}{\small\textbf{Subsequent use, personal name:}}\\ +% scholarly:\dotfill \cmd{\SOScipio} & \SOScipio\\ +% popular:\dotfill \cmd{\SScipio} & \SScipio\\ +% popular:\dotfill \cmd{\SkipGenstrue}\cmd{\SScipio} & \SkipGenstrue\SScipio % \end{tabular} % \end{center} -% \newpage -% -% \DescribeMacro{\ForceName} -% Use this prefix macro to force ``first use'' formatting for the next \cmd{\Name}, etc. This will not force a full name reference like \cmd{\ForgetThis}.\Version{3.1} One must use the \texttt{formatAKA} option when using this with \cmd{\AKA}, etc. We show \cmd{\ForceName} in Sections~\ref{sec:NameControl}, \ref{sec:AKA}, and~\ref{sec:Hooksii}.\medskip +% \endgroup^^A Local format hook redefinition % -% Below\Info{\texttt{alwaysformat}} we simulate the \texttt{alwaysformat} option by manipulating the package internals. Using first-use hooks will not force full name references. This option made more sense when \cmd{\NamesFormat} was the only formatting hook. -% \makeatletter\@nameauth@AlwaysFormattrue\makeatother% -% \ForgetName[M.T.]{Cicero}\ForgetName{Elizabeth, I}% -% \begin{itemize} -% \item \NamesInactive Using \texttt{alwaysformat} in the front matter will produce: \Name[Albert]{Einstein}, then \Name[Albert]{Einstein}; \Name{Confucius}, then \Name{Confucius}. -% \item \global\NamesActive Using \texttt{alwaysformat} in the main matter will produce: \Name[M.T.]{Cicero}[Marcus Tullius], then \Name[M.T.]{Cicero}[Marcus Tullius]; \Name{Elizabeth, I}, then \Name{Elizabeth, I}. -% \end{itemize} -% \makeatletter\@nameauth@AlwaysFormatfalse\makeatother -% -% The internal\Info{hook caveats} hook dispatcher calls the formatting hooks using the pattern \cmd{\bgroup}\meta{Hook}\texttt{\{\#1\}}\cmd{\egroup}. Thus one can use, e.g., \cmd{\itshape} in a local scope. One also can use macros that take one argument (cf. Section~\ref{sec:Hooksiii}), e.g., |\renewcommand*\NamesFormat{\sffamily\color{nablue}\textit}| will create\break the forms \bgroup\renewcommand*\NamesFormat{\sffamily\color{nablue}\textit}\ForgetThis\Einstein\ and \Einstein.\egroup\medskip -% -% The\Info{applied to\break footnotes} independent systems or ``species'' of names fit independent text elements, like front matter or even footnotes. Names in the body text, such as \Name[John Maynard]{Keynes}, also affect names in the footnotes.\footnote{We have \Name[John Maynard]{Keynes} from \cmd{\Name}\texttt{[John Maynard]\{Keynes\}} instead of \ForgetThis\Name[John Maynard]{Keynes}.} -% In footnote \arabic{footnote} \cmd{\MainNameHook} is called instead of \cmd{\NamesFormat} because \Name[John Maynard]{Keynes} already had occurred above. -% -% If we wanted to format names differently in the footnotes than in the body text, an easy way to do that is to use the front-matter system. For example: -% -% \makeatletter -% \let\@oldfntext\@makefntext -% \long\def\@makefntext#1{\NamesInactive\@oldfntext{#1}\NamesActive} -% \makeatother -% \begin{quote}\small -% \StartNum -% \begin{verbatim} -%\makeatletter -% \let\@oldfntext\@makefntext -% \long\def\@makefntext#1{\NamesInactive\@oldfntext{#1}\NamesActive} -%\makeatother\end{verbatim} -% \end{quote} -% -% When we create another footnote, we see very different results.\footnote{We have \Name[John Maynard]{Keynes} from \cmd{\Name}\texttt{[John Maynard]\{Keynes\}}, then \Name[John Maynard]{Keynes}.} -% Footnote \arabic{footnote} shows a completely independent formatting. One also can synchronize the two systems with \cmd{\ForgetThis} and \cmd{\SubvertThis} (Section~\ref{sec:NameDecisions} and its subsections). -% -% To finish this example, we change footnotes back to normal: -% \begin{quote}\small -% \ContinueNum -% \begin{verbatim} -%\makeatletter -%\let\@makefntext\@oldfntext -%\makeatother\end{verbatim} -% \end{quote} -% \makeatletter\let\@makefntext\@oldfntext\makeatother -% -% Of cource, one can force long and short forms as needed (Section~\ref{sec:NameControl}). Yet the main point of \textsf{nameauth} is to do the complex work once, then use that in automated fashion for the rest of the document. -% % \ReturnLink -% \newpage -% -% \subsection{Alternate Formatting} -% \label{sec:AltFormat} -% \begingroup\AltFormatActive -% -% \noindent The formatting hooks only affect names in the body text. Continental formatting occurs in both the text and in the index. One needs to format those names with macros in the name arguments. The basic way formats names in both text and index. The advanced way allows changes in the text, but keeps the index consistent. -% -% \subsubsection{Basic Features} -% \label{sec:AltBasic} -% -%Section~\ref{sec:ErrorProt} showed us that changing a control sequence will change the index entry of a name, even if one cannot see differences on the page. Alternate formatting helps one avert spurious index entries. -% -% Using,\Warn{} e.g., \cmd{\Name\{}\cmd{\textsc\{a Name, Problem\}\}} will halt \LaTeX\ because the comma tries to break \cmd{\textsc} and its argument into two elements. We fix that with: \cmd{\Name\{}\cmd{\textsc\{a Name\},} \cmd{\textsc\{Problem\}\}}. Yet \cmd{\CapThis} still needs alternate formatting, given that \cmd{\textsc} is robust (Section~\ref{sec:AltAdvanced}).\footnote{Pre-version 3.1 methods of Continental formatting should work if one uses the \texttt{altformat} option or \cmd{\AltFormatActive} to protect against the default behavior of \cmd{\CapThis}.}\medskip -% -% \DescribeMacro{\AltFormatActive} -% Both the \texttt{altformat} option and \cmd{\AltFormatActive} enable and activate alternate formatting. Both cause \cmd{\CapThis} to work via \cmd{\AltCaps} instead of the normal way. \cmd{\AltFormatActive} countermands \cmd{\AltFormatActive*}. -% \begin{itemize} -% \item \emph{Enabled} means that the alternate formatting mechanism inhibits the normal behavior of \cmd{\CapThis}. -% \item \emph{Activated} means that \cmd{\textSC} and other alternate formatting macros (see below) format their arguments. When deactivated, they do not format their arguments. -% \end{itemize} -% -% At\Version{3.1} the start of this section we used \cmd{\AltFormatActive} to enable alternate formatting and ``switch on'' the alternate formatting macros. That is the basic set of conditions for the simple use of alternate formatting. \medskip -% -% \DescribeMacro{\AltFormatActive*} -% The starred form \cmd{\AltFormatActive*} enables alternate formatting but deactivates the special formatting macros, preventing them from changing their arguments. It countermands both the \texttt{altformat} option and \cmd{\AltFormatActive}. It causes \cmd{\CapThis} only to work via \cmd{\AltCaps}.\medskip +% \vfill % -% \DescribeMacro{\AltFormatInactive} -% To both disable alternate formatting and deactivate the alternate formatting macros, use \cmd{\AltFormatInactive}. This reverts globally to standard formatting and the normal function of \cmd{\CapThis}. -% -% \begin{center} -% \begin{tabular}{lcc} -% & Enabled & Activated\\\midrule -% \cmd{\AltFormatActive} & \YES & \YES\\ -% \cmd{\AltFormatActive*} & \YES & \NO\\ -% \cmd{\AltFormatInactive} & \NO & \NO\\\bottomrule -% \end{tabular} -% \end{center} -% -% On the next page we describe the formatting macros that are built in to \textsf{nameauth} in order to use the basic features of alternate formatting and provide a foundation for the advanced features. One should use \cmd{\PretagName} (Section~\ref{sec:IndexSort}) to sort the related index entries for these names. +% \begin{verse} +% Oft fühl ich jetzt \dots [und] je tiefer ich einsehe, dass\\ +% Schicksal und Gemüt Namen eines Begriffes sind.\\[1ex]\hfill---\Name{Novalis}, \textit{Heinrich von Ofterdingen} +% \end{verse} % \newpage % -% \DescribeMacro{\textSC} -% Continental formatting can be as simple as using the short macro \cmd{\textSC}. Three other macros also implement alternate formatting. -% \DescribeMacro{\textIT} -% These macros make changes only when alternate formatting is active. -% \DescribeMacro{\textBF} -% We sort the index entry with \cmd{\PretagName} and demonstrate the formatting. -% \DescribeMacro{\textUC} -% \begin{quote}\small -% \StartNum -% \begin{verbatim} -%\PretagName[Greta]{\textSC{Garbo}}{Garbo, Greta} -%\PretagName[Ada]{\textIT{Lovelace}}{Lovelace, Ada} -%\PretagName[Charles]{\textBF{Babbage}}{Babbage, Charles} -%\PretagName{\textUC{Tokugawa}, Ieyasu}{Tokugawa Ieyasu}\end{verbatim} -% -% \smallskip\MyStretch -% |\Name[Greta]{\textSC{Garbo}}|\dotfill \Name[Greta]{\textSC{Garbo}}; \Name[Greta]{\textSC{Garbo}}\\ -% |\Name[Ada]{\textIT{Lovelace}}|\dotfill \Name[Ada]{\textIT{Lovelace}}; \Name[Ada]{\textIT{Lovelace}}\\ -% |\Name[Charles]{\textBF{Babbage}}|\dotfill \Name[Charles]{\textBF{Babbage}}; \Name[Charles]{\textBF{Babbage}}\\ -% |\Name{\textUC{Tokugawa}, Ieyasu}|\dotfill \Name{\textUC{Tokugawa}, Ieyasu}; \Name{\textUC{Tokugawa}, Ieyasu} -% \end{quote} -% -% Since we switch to Latin Modern Sans in the formatting hooks, the switch to small caps in \Name[Greta]{\textSC{Garbo}} forces a substitution to Latin Modern Roman. This action varies with the font being used. -% -% Using basic alternate formatting, these macros \emph{always format their arguments} with the \texttt{altformat} option or \cmd{\AltFormatActive}. Likewise, they \emph{never format their arguments} when \cmd{\AltFormatActive*} is used. To change the formatting of the name arguments, one must use the advanced features. Whenever\Warn{} a naming macro writes to the index, the formatting macros must be in the same Boolean state to avoid spurious index entries. The next section explains more. -% -% As with normal formatting, \cmd{\CapName} interacts with alternate formatting only in the text. Thus \CapName\Name*[Greta]{\textSC{Garbo}} instead of \Name[Greta]{\textSC{Garbo}}. \cmd{\RevComma} likewise gives \RevComma\Name*[Ada]{\textIT{Lovelace}}. \cmd{\RevName} produces \RevName\Name*{\textUC{Tokugawa}, Ieyasu}.\medskip +% \subsection{Indexing Macros} +% \label{sec:Indexing} % -% A comma\Info{comma karma} delimiter splits the mandatory macro argument into a root and an affix. To avoid errors, format the name and suffix separately. -% \begin{quote}\small -% \StartNum -% \begin{verbatim} -%\PretagName[John David]{\textSC{Rockefeller},\textSC{III}} -% {Rockefeller, John David 3} -%\PretagName{\textUC{Fukuyama}, Takeshi}{Fukuyama Takeshi} -%\begin{nameauth} -% \< JRIII & John David & \textSC{Rockefeller},\textSC{III} & > -% \< Fukuyama & & \textUC{Fukuyama}, Takeshi & > -% \< OFukuyama & & \textUC{Fukuyama} & Takeshi > -%\end{nameauth}\end{verbatim} -% \end{quote} +% The strictness\Version{3.5} of the \textsf{nameauth} indexing macros and the detail of index-related warnings, especially with the \texttt{verbose} option, are comparable to professional indexing software. In addition to the macros below, please see also: % -% From above we get \JRIII, then \JRIII. For non-Western names, the new syntax and the older syntax produce the same control sequence that identifies names. Again we are careful to avoid putting the comma delimiter within a container macro. % \begin{center}\small\MyStretch -% \begin{tabular}{rl}\toprule -% |\Fukuyama| & \Fukuyama\\ -% \rowcolor{black!7!white}|\OFukuyama| & \OFukuyama\\ -% |\LOFukuyama| & \LOFukuyama\\ -% \rowcolor{black!7!white}|\Fukuyama| & \Fukuyama\\\bottomrule -% \end{tabular} +% \begin{tabular}{ll}\toprule +% error prevention & page~\pageref{page:IdxErrors}\\ +% \rowcolor{grey}index-related prefix macros & page~\pageref{page:IdxPrefix}\\ +% variant names and cross-references & page~\pageref{page:IdxVariants}\\\bottomrule +% \end{tabular} % \end{center} % -% Only the new syntax allows one to use alternate names in the text (Section~\ref{sec:FName}). For example, ``|\LFukuyama[Sensei]| \LFukuyama[Sensei] wrote \textit{Nihon Fukuin R\=uteru Ky\=okai Shi} in 1954, after studying in the US in the 1930s.'' -% \newpage -% -% \subsubsection{Advanced Features} -% \label{sec:AltAdvanced} -% -% \noindent A more complex version of alternate formatting allows us to make formatting and other changes in the text while keeping the index consistent. In order to do this, we will be using \cmd{\textSC}, \cmd{\textIT}, \cmd{\textBF}, and \cmd{\textUC} with \cmd{\noexpand} and special triggering macros. Below we briefly see the difference: +% Here also are the general protection rules for the indexing macros: % \begin{center}\small\MyStretch -% \begin{tabular}{ll} -% |\Name[Martin]{\textSC{Luther}}| & {\color{nared}|%| \textit{basic alternate formatting}}\\ -% |\Name[Martin]{\noexpand\textSC{Luther}}| & {\color{nared}|%| \textit{advanced version}}\\ +% \begin{tabular}{c@{\ \ }c@{\ \ }p{0.6\textwidth}}\toprule +% Permit & Ignore & Attempted Action \\\midrule +% \NO & \YES & Use \cmd{\IndexRef} with an extant name.\\ +% \YES & \NO & Use \cmd{\SeeAlso}\cmd{\IndexRef} with an extant name.\\ +% \NO & \YES & Create page references to a name after \cmd{\IndexRef} created a cross-reference using that name.\\\midrule +% \NO & \YES & Try to make the same cross-reference multiple times.\\ +% \NO & \YES & Use \cmd{\IndexName} with a cross-reference.\\ +% \NO & \YES & Use \cmd{\ExcludeName} with a cross-reference.\\ +% \NO & \YES & Use \cmd{\IncludeName} with a cross-reference.\\ +% \YES & \NO & Use \cmd{\IncludeName*} with a cross-reference.\\ +% \YES & \NO & Use \cmd{\PretagName} to sort a cross-reference.\\ +% \NO & \YES & Use \cmd{\TagName} and \cmd{\UntagName} with a cross-reference.\\\bottomrule % \end{tabular} -% \end{center} -% The reason for this approach is that indexing operations occur outside the formatting hooks, never within the hooks, and \cmd{\noexpand} keeps the two separate. -% -% \ifDoTikZ +% \end{center}\smallskip +% % \begin{tcolorbox}[colback=white,colframe=nared] -% \centering Using \cmd{\noexpand} is key to consistent index entries. -% \end{tcolorbox}\bigskip -% \else -% \begin{center}\bfseries Using \cmd{\noexpand} is key to consistent index entries.\end{center} -% \fi +% \centering We test \cmd{\ExcludeName\{Gregory, I\}}\ExcludeName{Gregory, I} here. See page~\pageref{page:ExPage}. +% \end{tcolorbox} % -% \cmd{\CapThis}\DescribeMacro{\AltCaps}\ causes \cmd{\AltCaps} to cap its argument only in a formatting hook. It is enabled whenever alternate formatting is enabled. \cmd{\AltCaps} works independently of \cmd{\AltOn} and \cmd{\AltOff}: -% \begin{quote} -% \fbox{\mystrut\ \cmd{\noexpand}\cmd{\AltCaps}\marg{Arg} } -% \end{quote} -% In the example below we redefine \cmd{\MainNameHook} to suppress formatting: -% \renewcommand*\MainNameHook{\color{nabrown}\sffamily\AltOff} -% \begin{quote}\small -% \StartNum -% \begin{verbatim} -%\renewcommand*\MainNameHook% -% {\color{nabrown}\sffamily\AltOff}% we match the manual +% \subsubsection[General Macros]{General Indexing Macros} +% \label{sec:GeneralIndex} +% +% \begin{center}\bfseries General Control\end{center} +% \DescribeMacro{\IndexInactive} +% \cmd{\IndexInactive} deactivates the indexing functions of the naming macros, \cmd{\IndexName}, and \cmd{\IndexRef}. +% \DescribeMacro{\IndexActive} +% \cmd{\IndexActive} enables indexing. +% These can be used throughout the document. % -%\IndexInactive -%What's in a \Name{\noexpand\AltCaps{a} Name}? -%\CapThis\Name{\noexpand\AltCaps{a} Name} smells not, -%but a rose does. We avoid \Name{ -% \noexpand\textSC{\noexpand\AltCaps{a} Name}, -% \noexpand\textSC{Problem}}. -%\CapThis\Name*{ -% \noexpand\textSC{\noexpand\AltCaps{a} Name}, -% \noexpand\textSC{Problem}} will not occur, -% even if it smells like a rose.\end{verbatim} -% -% \smallskip\IndexInactive -% What's in a \Name{\noexpand\AltCaps{a} Name}? -% \CapThis\Name{\noexpand\AltCaps{a} Name} smells not, -% but a rose does. We avoid \Name{ -% \noexpand\textSC{\noexpand\AltCaps{a} Name}, -% \noexpand\textSC{Problem}}. -% \CapThis\Name*{ -% \noexpand\textSC{\noexpand\AltCaps{a} Name}, -% \noexpand\textSC{Problem}} will not occur, -% even if it smells like a rose. -% \end{quote} -% -% Like\DescribeMacro{\AltOff}\ a manual automobile clutch and gearbox, \cmd{\AltOff} deactivates \cmd{\textSC}, \cmd{\textBF}, \cmd{\textIT}, and \cmd{\textUC} only in a formatting hook.\medskip -% -% \cmd{\AltOn}\DescribeMacro{\AltOn}\ activates \cmd{\textSC}, \cmd{\textBF}, \cmd{\textIT}, and \cmd{\textUC} only in a formatting hook. To summarize: -% % \begin{itemize} -% \item \cmd{\AltFormatActive} and \cmd{\AltFormatActive*} set global states. -% \item \cmd{\AltFormatActive} causes formatting in the text and index, as well as forcing the use of \cmd{\AltCaps}. -% \item With \cmd{\AltFormatActive*} inhibits formatting, but still requires one to use \cmd{\AltCaps}. -% \item \cmd{\AltOn} and \cmd{\AltOff} change local state only in the formatting hooks. -% \item The user adds \cmd{\AltOn} and \cmd{\AltOff} to the hooks as needed. -% \item The actual formatting happens via macros in the name arguments. +% \item \cmd{\IndexInactive} broadly suppresses \cmd{\IndexName}, \cmd{\IndexRef}, the page entry indexing components of the naming macros, and the cross-referencing components of \cmd{\AKA} and \cmd{\PName}. +% \item For a fine degree of control, use \cmd{\ExcludeName} and \cmd{\IncludeName}. % \end{itemize} -% \newpage +% +% \cmd{\IndexActive}\Info{\cmd{\global}} and \cmd{\IndexInactive} can be used as a pair or singly within a group. They have top priority (page~\pageref{page:Priorities}). Use \cmd{\global} to force a global effect.\medskip % -% Keeping the \cmd{\MainNameHook} example above, we have: -% \begin{quote}\small -% \StartNum -% \begin{verbatim} -%\begin{nameauth} -% \< Luth & Martin & \noexpand\textSC{Luther} & > -%\end{nameauth} -%\PretagName[Martin]{\noexpand\textSC{Luther}}{Luther, Martin}\end{verbatim} -% \end{quote} +% \DescribeMacro{\IndexProtect} +% This macro causes all naming macros to do nothing. \cmd{\IndexProtect} is local in scope, e.g., |{\IndexProtect\Name{Error}}|{\IndexProtect\Name{Error}} is isolated.\Version{3.3} +% The naming macros and \cmd{\AKA} have locks that prevent them from being used in their own arguments to prevent errors. To prevent unlikely errors in the index, one can use \cmd{\IndexProtect} right before \cmd{\printindex} to eliminate spurious output.\footnote{This manual uses the tag \S\ for \cmd{\Name\{foo}\cmd{\Name\{bar\}\}}, not shown in the example.} % -% We first mention \cmd{\Luth} \Luth. Then again, \cmd{\Luth} \Luth. Medieval Italian differs from modern Italian with respect to particles. Below the index entry should be ``\ShowIdxPageref*[Catherine \noexpand\AltCaps{d}e']{\noexpand\textSC{Medici}}\,'' instead of ``\ShowIdxPageref*[Catherine]{de~\textSC{Medici}}'': -% \begin{quote}\small -% \StartNum -% \begin{verbatim} -%\begin{nameauth} -% \< Cath & Catherine \noexpand\AltCaps{d}e' -% & \noexpand\textSC{Medici} & > -%\end{nameauth} -%\PretagName[Catherine \noexpand\AltCaps{d}e'] -% {\noexpand\textSC{Medici}}{Medici, Catherine de}\end{verbatim} -% \end{quote} -%This gives us \Cath\ and \Cath. To get \ForceName\CapThis\LCath[\noexpand\AltCaps{d}e'] and \CapThis\LCath[\noexpand\AltCaps{d}e'] in the text, use |\CapThis\LCath[\noexpand\AltCaps{d}e']|.\medskip +% \begin{center}\small\MyStretch +% \begin{tabular}{llll}\toprule +% \bfseries Macro & \bfseries Text & \bfseries \texttt{.ind} file & \bfseries Index\\\midrule +% \rowcolor{grey}|\Name{foo\Name{bar}}| & \Name{foo\Name{bar}} & |\item foo\Name {bar}| & foo{\NamesFormat bar}\\ +% \rowcolor{grey}\cmd{\printindex} (next iteration adds) \(\rightarrow\) & & |\item bar| & bar\\ +% |\Name{foo\Name{bar}}| & \Name{foo\Name{bar}} & |\item foo\Name {bar}| & foo\\ +% \cmd{\IndexProtect}\cmd{\printindex} & & (no further output) & \\\bottomrule +% \end{tabular} +% \end{center} % -% \phantomsection -% \label{page:Inflections} -% We\Info{name inflections\break\dbend} can use alternate formatting for grammatical inflections (cf. Section~\ref{sec:Hooksiii}). We tell the same set of lies that we did on page~\pageref{page:Sobriquets}. \cmd{\DoGentrue} occurs only in the formatting hook, thereby keeping the index entries consistent:\footnote{A copy of this example is in \texttt{examples.tex}, collocated with this manual.} +% \DescribeMacro{\NameauthIndex} +% \LaTeX\ has various ways to produce multiple indexes. \cmd{\NameauthIndex}, which is defined as \cmd{\index}, can be redefined to implement multiple indexes of names.\Version{3.5} Below we use the \textsf{index} package to do this, but other alternatives also are possible.\footnote{See also \href{https://www.texfaq.org/FAQ-multind}{this} on multiple indexes and the test in \texttt{examples.tex}, located with this manual.} % -% \newif\ifGenitive -% \newif\ifDoGen -% \renewcommand*\NamesFormat[1]{\ifGenitive\DoGentrue\fi#1\global\Genitivefalse} -% \renewcommand*\MainNameHook[1]{\ifGenitive\DoGentrue\fi\AltOff#1\global\Genitivefalse} -% \newcommand\JEFF{\ifDoGen\textSC{Jefferson's}\else\textSC{Jefferson}\fi} -% \begin{quote}\small -% \StartNum -% \begin{verbatim} -%\newif\ifGenitive -%\newif\ifDoGen -%\renewcommand*\NamesFormat[1] -% {\ifGenitive\DoGentrue\fi#1\global\Genitivefalse} -%\renewcommand*\MainNameHook[1] -% {\ifGenitive\DoGentrue\fi\AltOff#1\global\Genitivefalse} -%\begin{nameauth} -% \< Jeff & Thomas & \noexpand\JEFF & > -%\end{nameauth} -%\PretagName[Thomas]{\noexpand\JEFF}{Jefferson, Thomas} -%\TagName[Thomas]{\noexpand\JEFF}{, pres.|hyperpage} -%\newcommand\JEFF{\ifDoGen\textSC{Jefferson's}\else -% \textSC{Jefferson}\fi} +%\begin{quote}\small\StartNum +%\begin{verbatim} +%\documentclass{article} +%\usepackage[T1]{fontenc} +%\usepackage{index} +%\usepackage{nameauth} % -%Consider \Genitivetrue\Jeff\ legacy. More on \Jeff\ later. -%\Genitivetrue\Jeff\ reputation has declined in recent decades.\end{verbatim} +%\makeindex % Default index +%\newindex{per}{rdx}{rnd}{Index of Persons} % Other index +%\renewcommand\NameauthIndex{\index[per]} % -% \smallskip -% Consider \Genitivetrue\Jeff\ legacy. More on \Jeff\ later. -% \Genitivetrue\Jeff\ reputation has declined in recent decades. -% \end{quote} -% -% For highly inflected languages, this would require two Boolean flags per case and nested conditional statements. Now we resume normal formatting with \cmd{\AltFormatInactive} and we do not use the names in this section outside of it.\footnote{In a \texttt{dtx} file it is best to put the \texttt{nameauth} environment, \cmd{\PretagName}, and \cmd{\TagName} macros in the driver section, especially when names contain macros.} -% \AltFormatInactive\endgroup -% -% \ReturnLink -% \newpage +%\begin{document} +% Electric Boogaloo\index{Boogaloo, Electric}% to main index +% by \Name{Ollie~\& Jerry}% to name index % -% \subsection{Indexing Macros} +% \printindex[per]% Shows the entry: Ollie & Jerry, 1 % -% \subsubsection[Entries \& Control]{Index Entries and Control} -% \label{sec:IndexControl} +% \renewcommand\indexname{Index of Subjects} +% \printindex % Shows the entry: Boogaloo, Electric, 1 +%\end{document}\end{verbatim} +% \end{quote} % +% \begin{center}\bfseries Page Entries\end{center} % \DescribeMacro{\IndexName} % Both package users and the naming macros themselves use this macro to create index entries. It prints nothing in the body text: % \begin{quote} -% \fbox{\mystrut\ \cmd{\IndexName}\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate} } +% \fbox{ +% \begin{tabular}{l} +% {\Large\strut}\cmd{\IndexName}\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate}\\ +% \end{tabular} +% } % \end{quote} % -% If \meta{FNN} is present, it ignores \meta{Alternate} for Western and ``native'' Eastern name forms. If \meta{FNN} is absent, \cmd{\IndexName} may use the current or obsolete non-Western syntax (Section~\ref{sec:Obsolete}). Indexing follows [\hyperlink{Mulvany}{Mulvany}, 152--82]. -% -% If \cmd{\IndexInactive} or the \texttt{noindex} option are used, this macro does nothing until \cmd{\IndexActive} appears. Additionally, it will not create index entries for cross-references made by \cmd{\IndexRef} and \cmd{\AKA}. It will not index names excluded by \cmd{\ExcludeName}. This provides some error protection for professional indexing. +% If \meta{FNN} is present, it ignores \meta{Alternate} for Western and ``native'' Eastern name forms. If \meta{FNN} is absent, \cmd{\IndexName} can use either the current or the obsolete non-Western syntax (Section~\ref{sec:Obsolete}). Indexing follows [\hyperlink{Mulvany}{Mulvany}, 152--82]. % -% \cmd{\IndexName} and \cmd{\IndexRef} call \cmd{\@nameauth@Index}, a macro that assembles an index entry from the sort tag (Section~\ref{sec:IndexXref}), name arguments, and index tag (Section~\ref{sec:IndexTag}). -% Different standards exist for index entries and cross-references. Check with your publisher, style guide, and docs for \textsf{xindy} and \textsf{makeindex}.\medskip -% -% \DescribeMacro{\IndexActive} -% The \texttt{noindex} option deactivates the indexing function of this package until \cmd{\IndexActive} enables indexing. -% \DescribeMacro{\IndexInactive} -% Another macro, \cmd{\IndexInactive}, will deactivate indexing again. These can be used throughout the document. {\bfseries \cmd{\IndexInactive} suppresses index sorting and tagging macros.} Compare the use of macros \cmd{\ExcludeName} and \cmd{\IncludeName} (Section~\ref{sec:IndexXref}).\medskip -% -% \DescribeMacro{\IndexProtect} -% Both the core name engine \cmd{\@nameauth@Name} and \cmd{\AKA} have locks that prevent them from being re-entrant.\VersionWarn{3.3} This protects the text. Usually, one does not put naming macros in the index. Just in case, now one can use \cmd{\IndexProtect} right before \cmd{\printindex} to prevent \textsf{nameauth} macros from producing any output. -% -% This example shows the difference between the effects of the older and newer approaches. We use the tag \S\ in this manual's index, but not below: -% \begin{center}\small -% \begin{tabular}{llll}\toprule -% \bfseries Macro & \bfseries Text & \bfseries \texttt{.ind} file & \bfseries Index\\\midrule -% no protection\\ -% |\Name{foo\Name{bar}}| & \Name{foo\Name{bar}} & |\item foo\Name {bar}| & foo{\NamesFormat bar}\\ -% (next iteration adds) \(\rightarrow\) & & |\item bar| & bar\\ -% \rowcolor{black!7!white}\cmd{\IndexProtect} & & & \\ -% \rowcolor{black!7!white}|\Name{foo\Name{bar}}| & \Name{foo\Name{bar}} & -% |\item foo\Name {bar}| & foo\\ -% \rowcolor{black!7!white}(no further output results) & & & \\\bottomrule -% \end{tabular} -% \end{center} -% -% \cmd{\IndexActive}\Info{\cmd{\global}} and \cmd{\IndexInactive} can be used as a pair or singly within a group. These macros override any prefix macros. \cmd{\IndexProtect} also can be used in a local scope. Use \cmd{\global} with these macros to force a global effect.\medskip -% -% \DescribeMacro{\SkipIndex} -% The prefix macro \cmd{\SkipIndex} will suppress indexing for just one instance of a naming or cross-referencing macro.\VersionWarn{3.1} It will not alter name forms or formatting. For example, |\SkipIndex\Name[Monty]{Python}| produces \SkipIndex\Name[Monty]{Python} in the text with no index entry. The same thing again yields \SkipIndex\Name[Monty]{Python}. Since prefix macros are meant for macros that print a name, both \cmd{\IndexName} and \cmd{\IndexRef} ignore \cmd{\SkipIndex} and allow the Boolean flags set by the prefix macros, to ``pass through'' to the next naming macro. That may seem counter-intuitive. -% \newpage +% Currently,\Version{3.5} we assume that if one wants to use \cmd{\IndexName}, one really wants to index something. That means \cmd{\IndexName} will not respect \cmd{\SkipIndex}. Using \cmd{\IndexInactive} will still suppress indexing. The naming macros have used the following for some time, which causes \cmd{\IndexName} to obey \cmd{\SkipIndex}: +% \begin{quote}\small +% |\unless\if@nameauth@SkipIndex \IndexName|\dots|\fi.| +% \end{quote} % -% \DescribeMacro{\JustIndex} -% This prefix macro makes \cmd{\Name}, \cmd{\Name*}, \cmd{\Fname}, and the shorthands act like a one-time call to \cmd{\IndexName}.\VersionWarn{3.3} Flags set by the prefix macros ``pass through'' to the next naming macro except these three: \cmd{\@nameauth@JustIndexfalse} (obviously), but also \cmd{\@nameauth@FullNamefalse} and \cmd{\@nameauth@FirstNamefalse}. +% The stricter indexing control\Version{3.5} in place means that: % \begin{itemize} -% \item Both \cmd{\AKA} and \cmd{\PName} ignore and reset the flag set by \cmd{\JustIndex}. -% \item \cmd{\SkipIndex} \cmd{\JustIndex} \cmd{\Name\{A\}} \cmd{\Name\{B\}} is just like \cmd{\JustIndex} \cmd{\Name\{A\}} \cmd{\SkipIndex} \cmd{\Name\{B\}}. See the table on page~\pageref{page:Priorities}. -% \item Version 3.3 eliminates the undocumented behavior that used to occur when not using, e.g., \cmd{\JustIndex}\cmd{\Wash}. Now any version will do:\smallskip\\ -% \bgroup\small\begin{tabular}{ll@{ }ll@{ }l} -% |\JustIndex\LWash \Wash| & old: & \makeatletter\@nameauth@OldPasstrue\makeatother\JustIndex\LWash \Wash & new: & \Wash\\ -% |\JustIndex\SWash \Wash| & old: & \makeatletter\@nameauth@OldPasstrue\makeatother\JustIndex\SWash \Wash & new: & \Wash\\ -% \end{tabular}\egroup -% \item The \texttt{oldpass} option restores the old behavior. Cf. Section~\ref{sec:Customize}. +% \item \cmd{\IndexName} will not index names excluded by \cmd{\ExcludeName}, as well as cross-references. This has been true for quite a while. +% \item \cmd{\IndexName} resets the effects of both \cmd{\SeeAlso} and \cmd{\SkipIndex} unless one uses the \texttt{oldreset} option. % \end{itemize} % -% \ReturnLink +% \DescribeMacro{\SkipIndex} +% The prefix macro \cmd{\SkipIndex} will suppress indexing for just one instance of a naming macro.\Version{3.1} See also page~\pageref{page:IdxPrefix}. |\SkipIndex\Name[Monty]{Python}| produces \SkipIndex\Name[Monty]{Python} and \SkipIndex\Name[Monty]{Python} in the text, but with no index entry.\medskip % -% \subsubsection{Cross-References} -% \label{sec:IndexXref} +% \DescribeMacro{\JustIndex} +% This prefix macro makes \cmd{\Name}, \cmd{\Name*}, \cmd{\FName}, and the quick interface shorthand macros act similar to a one-time call to \cmd{\IndexName}.\Version{3.5} \cmd{\JustIndex} suppresses name output in the text, but it resets flags for long and first name forms as if the naming macro had produced output. Using the \texttt{oldreset} option prevents these flags from being reset. See also page~\pageref{page:IdxPrefix}. % +% \begin{center}\bfseries Cross-References\end{center} % \DescribeMacro{\IndexRef} -% This macro emerged from the macros in Section~\ref{sec:AKA}. By default, \cmd{\IndexRef} creates a \textit{see} reference\Version{3.0} from the name defined by its first three arguments to the target in its final argument: -% \begin{quote}\small -% \fbox{\mystrut\ \cmd{\IndexRef}\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate}\marg{reference target} } +% By default, \cmd{\IndexRef} creates a \textit{see} reference from the name defined by its first three arguments to the target in its final argument: +% \begin{quote} +% \fbox{ +% \begin{tabular}{@{}l@{}} +% {\Large\strut}\small\cmd{\IndexRef}\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate}\marg{reference target}\\ +% \end{tabular} +% } % \end{quote} % -% The name parsing is like \cmd{\IndexName}, except that the final argument is neither parsed nor checked if a target entry exists. For example, to cross-reference ``Sun King'' with \Name*{Louis, XIV} use: \cmd{\IndexRef}\texttt{\{Sun King\}\{Louis XIV\}}\IndexRef{Sun King}{Louis XIV}. -% -% When\Warn{} \cmd{\IndexRef} calls \cmd{\@nameauth@Index}, a preexisting tag of the form \meta{some text}\texttt{\textbar}\meta{some macro} is reduced to \meta{some text}. One cannot tag an extant cross-reference, but one can tag a name, then later create a \textit{see also} reference. For related warnings activated by the \texttt{verbose} option, see Section~\ref{sec:ErrorProt}. -% -% Next we look at variant names and cross-references. Some can be handled with the \meta{Alternate} argument. Others require more work to implement (Section~\ref{sec:VarNames}). +% The stricter indexing control\Version{3.5} in place means that: % \begin{itemize} -% \item Variant names potentially can have page numbers in index entries. Cross-references cannot have page numbers. -% \item |\DropAffix\ForgetThis\Name[J.E.]{Carter, Jr.}[Jimmy]| gives a variant name: \DropAffix\ForgetThis\Name[J.E.]{Carter, Jr.}[Jimmy] indexed under ``\ShowIdxPageref*[J.E.]{Carter, Jr.}'' -% \item |\IndexRef[Jimmy]{Carter}{Carter, J.E., Jr.}| makes an xref but prints nothing. We need only create this cross-reference once.\IndexRef[Jimmy]{Carter}{Carter, J.E., Jr.} -% \item By contrast, \cmd{\AKA} automatically formats the cross-reference name in the text and in the index. -% \item Yet \cmd{\AKA} has limited formatting. Instead, after creating the xref with \cmd{\IndexRef}, one can use |\SubvertThis\Name*[Jimmy]{Carter}| \SubvertThis\Name*[Jimmy]{Carter} with full formatting, but without creating any page entries. -% \item \cmd{\SubvertThis} syncs the variant with the canonical form \cmd{\DropAffix} \cmd{\Name*[J.E.]\{Carter, Jr.\}[Jimmy]} \DropAffix\Name*[J.E.]{Carter, Jr.}[Jimmy]. Otherwise, they would act as different names. See also Section~\ref{sec:NameTests}. -% \item If we use |\Name[Jimmy]{Carter}| \Name[Jimmy]{Carter} we have to index this alternate name with the canonical one: |\IndexName[J.E.]{Carter, Jr.}| +% \item \cmd{\IndexRef} will not cross-reference names excluded by \cmd{\ExcludeName}, as well as cross-references. This has been true for quite a while. +% \item \cmd{\IndexRef} will not index any extant names used with \cmd{\Name} and friends, as well as the quick interface, unless one uses the \texttt{oldsee} option. +% \item \cmd{\IndexName} resets the effects of both \cmd{\SeeAlso} and \cmd{\SkipIndex} unless one uses the \texttt{oldreset} option. +% \item To have multiple names and cross-references interact, see page~\pageref{page:IdxVariants}. % \end{itemize} % -% \DescribeMacro{\SeeAlso} -% Put \cmd{\SeeAlso} before \cmd{\IndexRef}, \cmd{\AKA}, and \cmd{\PName} to make a \textit{see also} reference for a name that has appeared already in the index.\Version{3.0} -% Yet one should mind the caveats: -% \begin{itemize} -% \item If |\SeeAlso\IndexRef{Bar}{Foo}| occurs on page 10, \cmd{\Name\{Bar\}} will not create index entries thereafter. A \textit{see also} ref follows all page refs. -% \item If |\SeeAlso\IndexRef{Bar}{Foo}| occurs on page 10, \cmd{\Name\{Foo\}} will create index entries thereafter because it is the target of ``Bar.'' -% \item If |\Name{Baz}| occurs on page 12 and |\IndexRef{Baz}{Meschugge}| on page 16, no xref will be created. A \textit{see} reference has no page refs. -% \end{itemize} +% \cmd{\IndexRef} prints nothing in the text. The name parsing is like \cmd{\IndexName}. The final argument is not checked in any way. For example: +% \begin{quote}\leavevmode\Info{\vspace{-4ex}\break \strut\footnotesize Name Pattern(s):\hfill \break\ttfamily\ShowPattern{Sun King}!PN} +% \begin{tabular}{ll} +% source: & \cmd{\IndexRef}\texttt{\{Sun King\}\{Louis XIV\}}\IndexRef{Sun King}{Louis XIV}\\ +% index: & Sun King \textit{see} Louis XIV\\ +% \end{tabular} +% \end{quote} % +% \DescribeMacro{\SeeAlso} +% Put \cmd{\SeeAlso} before \cmd{\IndexRef}, \cmd{\AKA}, and \cmd{\PName} to make a \textit{see also} reference for a name that has appeared already in the index.\Version{3.5} If enabled before invoking \cmd{\PName}, \cmd{\SeeAlso} will be disabled when the regular name is generated, then enabled when the cross-reference is generated. Currently \cmd{\IndexName} and any macros that use it will reset the Boolean flag governed by \cmd{\SeeAlso} unless one uses the \texttt{oldreset} option. This does not change the intended behavior of \cmd{\SeeAlso}. Rather, it prevents a stray use of the macro from affecting the index.\medskip +% % \DescribeMacro{\ExcludeName} % This macro prevents a name from being used as either an index entry or as an index cross-reference.\Version{3.0} It will not exclude extant cross-references: % \begin{quote} -% \fbox{\mystrut\ \cmd{\ExcludeName}\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate} } +% \fbox{ +% \begin{tabular}{l} +% {\Large\strut}\cmd{\ExcludeName}\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate}\\ +% \end{tabular} +% } % \end{quote} -% \cmd{\IndexRef} works best if one needs a cross-reference from a variant to the canonical name. If no cross-reference is needed, then \cmd{\ExcludeName} is used. Unlike \cmd{\IndexInactive} and \cmd{\IndexActive}, this macro works only on a per-name basis. Below we keep specific names and cross-references out of the index:\ExcludeName[Kris]{Kringle}\ExcludeName[Santa]{Claus}\ExcludeName{Grinch}\vspace{2.5ex} +% Unlike \cmd{\IndexInactive} and \cmd{\IndexActive}, which inhibit indexing altogether, this macro only excludes a specific name from being printed as a page reference or cross-reference in the index. See the following example, as well as examples in Sections~\ref{sec:VarNames} and \ref{sec:NameParticles}: +% \newpage % -%\leavevmode\quad\begin{minipage}[b]{0.9\textwidth}\small -% \StartNum +% \begin{quote}\small\leavevmode\PatInfo{\ShowPattern[Kris]{Kringle}!PN\break \ShowPattern[Santa]{Claus}!PN\break \ShowPattern{Grinch}!PN\break \ShowPattern[Kris]{Kringle}!MN\break \ShowPattern[Santa]{Claus}!MN\break \ShowPattern{Grinch}!MN} +% \ExcludeName[Kris]{Kringle}\ExcludeName[Santa]{Claus}\ExcludeName{Grinch} +% \StartNum\vspace{-5ex} % \begin{verbatim} %\ExcludeName[Kris]{Kringle} %\ExcludeName[Santa]{Claus} -%\ExcludeName{Grinch}\end{verbatim} -% \end{minipage}\medskip +%\ExcludeName{Grinch} +%\Name[Kris]{Kringle}, a.k.a. \Name[Santa]{Claus} +%even likes the \Name{Grinch}.\end{verbatim} % -%\leavevmode\quad\begin{minipage}[b]{0.5\textwidth}\small -% \ContinueNum -% \begin{verbatim} -%\Name[Kris]{Kringle} -%\Name[Kris]{Kringle} -%\AKA[Kris]{Kringle}[Santa]{Claus}\end{verbatim} -% \end{minipage} -% \begin{minipage}[b]{0.3\textwidth}\small -% \Name[Kris]{Kringle}\\ -% \Name[Kris]{Kringle}\\ -% \AKA[Kris]{Kringle}[Santa]{Claus} -% \end{minipage}\vspace{2ex} -% -% For more examples of using \cmd{\ExcludeName} to handle variants, see Sections~\ref{sec:VarNames} and \ref{sec:NameParticles}, among others. We will check on the \Name{Grinch} later.\medskip +% \Name[Kris]{Kringle}, a.k.a. \Name[Santa]{Claus} +% even likes the \Name{Grinch}. +% \end{quote} % -% \phantomsection -% \label{page:ExPage} % \DescribeMacro{\IncludeName} -% For those who might need to break the indexing rules set by \textsf{nameauth}, these two macros get the job done. +% Use these macros to break a few indexing rules. They remove the protections used for exclusion and cross-referencing. % \DescribeMacro{\IncludeName*} -% They remove the protections used for exclusion and cross-referencing. These macros have the same syntax as \cmd{\ExcludeName}:\Version{3.0} +% They have the same syntax as \cmd{\ExcludeName}: % \begin{quote} -% \fbox{\vbox{\hbox{\mystrut\ \cmd{\IncludeName\ }\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate} }\par -% \hbox{\mystrut\ \cmd{\IncludeName*}\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate} }}} +% \fbox{ +% \begin{tabular}{l} +% {\Large\strut}\cmd{\IncludeName\ }\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate}\vspace{-2pt}\\ +% {\Large\strut}\cmd{\IncludeName*}\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate}\\ +% \end{tabular} +% } % \end{quote} % -% \cmd{\IncludeName} only removes an excluded reference created by \cmd{\ExcludeName} while \cmd{\IncludeName*} completely un-protects a cross-reference. Thereafter, one may create page entries for it like a name. +% \phantomsection +% \label{page:ExPage} +% \cmd{\IncludeName} only voids an exclusion created by \cmd{\ExcludeName}. The more extreme \cmd{\IncludeName*} completely un-protects a cross-reference. Thereafter, one may create page entries for it as a name. For example: +% +% \begin{itemize} +% \item As an\PatInfo{\ShowPattern{Gregory, I}!PN\break \ShowPattern{Gregory, I}!MN} excluded name, |\Name*{Gregory, I}| \Name*{Gregory, I} does not create an index entry. +% \item \cmd{\IfAKA\{Gregory, I\}}|{|\meta{an xref}|}{|\meta{a name}|}{|\meta{excluded}|}| tells us that \Name{Gregory, I} is \IfAKA{Gregory, I}{\meta{an xref}}{\meta{a name}}{\meta{excluded}} (cf. Section~\ref{sec:NameTests}). +% \end{itemize} % -% For example, we used |\ExcludeName{Attila, the Hun}| at the end of Section~\ref{sec:SimpleStart}. Using \cmd{\IfAKA\{Attila, the Hun\}}|{|\meta{an xref}|}{|\meta{no xref}|}{|\meta{excluded}|}| tells us that he is \IfAKA{Attila, the Hun}{\meta{an xref}}{\meta{no xref}}{\meta{excluded}} (cf. Section~\ref{sec:NameTests}). -% -% Once we use |\IncludeName{Attila, the Hun}|\IncludeName{Attila, the Hun}, using |\LAttil| \LAttil\ will create a name and an index entry on this page. \cmd{\IfAKA} now tells us that he is \IfAKA{Attila, the Hun}{\meta{an xref}}{\meta{no xref}}{\meta{excluded}}. We again have a name that can be indexed. +% After using |\IncludeName{Gregory, I}|\IncludeName{Gregory, I}, the following points are true: +% \begin{itemize} +% \item |\Name*{Gregory, I}| displays \Name*{Gregory, I} and creates an index entry. +% \item \cmd{\IfAKA\{Gregory, I\}}|{|\meta{an xref}|}{|\meta{a name}|}{|\meta{excluded}|}| now tells us that \Name{Gregory, I} has become \IfAKA{Gregory, I}{\meta{an xref}}{\meta{a name}}{\meta{excluded}}. +% \end{itemize} % -% Cross-references get more protection. \cmd{\IfAKA[Jay]\{Rockefeller\}} (a reference from Section~\ref{sec:SimpleStart}) tells us that he is \IfAKA[Jay]{Rockefeller}{\meta{an xref}}{\meta{no xref}}{}. If we follow the previous example and use |\IncludeName[Jay]{Rockefeller}|\IncludeName[Jay]{Rockefeller} he still is \IfAKA[Jay]{Rockefeller}{\meta{an xref}}{\meta{no xref}}{}. After using |\IncludeName*[Jay]{Rockefeller}|\IncludeName*[Jay]{Rockefeller} he finally becomes \IfAKA[Jay]{Rockefeller}{\meta{an xref}}{\meta{no xref}}{}, removing all protection from that cross-reference. +% Cross-references get more protection.\PatInfo{\ShowPattern[J.D.]{Rockefeller, IV}!MN\break \ShowPattern[Jay]{Rockefeller}!PN\break \ShowPattern[Jay]{Rockefeller}!MN} We have seen \DropAffix\LJRIV[Jay] indexed under ``\ShowIdxPageref*[J.D.]{Rockefeller, IV}'' with |\DropAffix\LJRIV[Jay]|. We create the cross-index \IndexRef[Jay]{Rockefeller}{Rockefeller, J.D., IV}|\IndexRef[Jay]{Rockefeller}{Rockefeller, J.D., IV}|. +% \begin{itemize} +% \item \cmd{\IfAKA[Jay]\{Rockefeller\}}|{|\meta{xref}|}{|\meta{name}|}{}| calls \SJRIV[Jay] an \IfAKA[Jay]{Rockefeller}{\meta{xref}}{\meta{name}}{}. +% \item After |\IncludeName[Jay]{Rockefeller}|\IncludeName[Jay]{Rockefeller} he still is an \IfAKA[Jay]{Rockefeller}{\meta{xref}}{\meta{name}}{}. +% \item After |\IncludeName*[Jay]{Rockefeller}|\IncludeName*[Jay]{Rockefeller} he becomes a \IfAKA[Jay]{Rockefeller}{\meta{xref}}{\meta{name}}{}. +% \item Now \cmd{\Name[Jay]\{Rockefeller\}} will create page entries. +% \end{itemize} % +% Analogous to how \cmd{\IncludeName*} allows one to turn an xref into a name with page references, \cmd{\ForgetName} and possibly \cmd{\ForgetThis} (Section~\ref{sec:NameControl}) allow one to assign a \textit{see} reference to an extant name. This is bad when using one index, but desirable when using multiple indexes.\medskip +% +% \begin{center}\bfseries Error Prevention\end{center} % \phantomsection -% \label{page:ManualXref} -% \begin{center}\bfseries Advanced Cross-Referencing\end{center} +% \label{page:IdxErrors} +% \cmd{\IndexName} and \cmd{\IndexRef}\Version{3.5} strictly enforce professional indexing practices. Now they are more sensitive to order of use. Both \cmd{\ForgetName} and \cmd{\ForgetThis} (Section~\ref{sec:NameControl}) can affect this mechanism. The \texttt{verbose} option aids debugging. +% \begin{itemize} +% \item[] +% \bgroup\small\MyStretch\begin{tabular}{rp{0.38\textwidth}@{\ }p{0.23\textwidth}}\toprule +% Page & Macro & Index Result\\\midrule +% \rowcolor{grey}1 & \cmd{\Name\{bar\}}\dotfill \hbox{} & bar, 1\\ +% 2 & \cmd{\Name\{bar\}}\dotfill \hbox{} & bar, 1, 2\\ +% \end{tabular}\egroup\smallskip +% +% \item A \textit{see also} reference to a certain name must follow all page references to that name. The use of \cmd{\SeeAlso}\cmd{\IndexRef\{bar\}\{foo\}} on page~3 prevents \cmd{\Name\{bar\}} from creating an index page reference on page~4:\\[1.5ex] +% \bgroup\small\MyStretch\begin{tabular}{rp{0.38\textwidth}@{\ }p{0.23\textwidth}} +% \phantom{Page} & \phantom{Macro} & \phantom{Index Result}\\[-2.5ex] +% \rowcolor{grey}3 & \cmd{\SeeAlso}\cmd{\IndexRef\{bar\}\{foo\}} & bar, 1, 2, \textit{see also} foo\\ +% 4 & \cmd{\Name\{bar\}}\dotfill \hbox{} & bar, 1, 2, \textit{see also} foo\\ +% \end{tabular}\egroup\smallskip +% +% \item Targets of cross-references are not affected by this. \cmd{\Name\{foo\}} creates index page entries because it is the target, not the xref:\\[1.5ex] +% \bgroup\small\begin{tabular}{rp{0.38\textwidth}@{\ }p{0.23\textwidth}} +% \phantom{Page} & \phantom{Macro} & \phantom{Index Result}\\[-2.5ex] +% \rowcolor{grey}5 & \cmd{\Name\{foo\}}\dotfill \hbox{} & bar, 1, 2, \textit{see also} foo\\ +% \rowcolor{grey}& & foo, 5\\ +% \end{tabular}\egroup % -% \noindent \cmd{\IndexRef}\Info{combining xrefs} will not merge multiple cross-references. One must manually merge cross-references: |\IndexRef{Bar}{Baz; Foo}| makes the index entry ``Bar, \textit{see} Baz; Foo.'' The preferred standard (in the humanities) suggests that one avoid something like |\IndexRef{Bar}{Baz} \IndexRef{Bar}{Foo}|.\medskip +% \item A \textit{see}\Version{3.5} reference is supposed to have no page references; a \textit{see also} reference does have page references, but only before it is created. Trying to use an extant name as a \textit{see} reference is strictly ignored:\\[1.5ex] +% \bgroup\small\begin{tabular}{rp{0.38\textwidth}@{\ }p{0.23\textwidth}} +% \phantom{Page} & \phantom{Macro} & \phantom{Index Result}\\[-2.5ex] +% 6 & \cmd{\Name\{baz\}}\dotfill \hbox{} & bar, 1, 2, \textit{see also} foo\\ +% & & baz, 6\\ +% & & foo, 5\\ +% \rowcolor{grey}7 & \cmd{\IndexRef\{baz\}\{meschugge\}}\dotfill \hbox{} & bar, 1, 2, \textit{see also} foo\\ +% \rowcolor{grey}& & baz, 6\\ +% \rowcolor{grey}& & foo, 5\\\bottomrule +% \end{tabular}\egroup +% \end{itemize}\leavevmode % -% There\Info{one xref\break many targets} is a special case where one cross-reference can point to multiple targets, such as demonstrated in the example below: -% \begin{quote}\small -% \StartNum -% \begin{verbatim} -%\PretagName{\textit{Snellius}}{Snellius} -%\IndexRef{\textit{Snellius}}{Snel van Royen, R.; Snel van Royen, W.} +% \begin{center}\bfseries Prefix Macros and Indexing Macros\end{center} +% \phantomsection +% \label{page:IdxPrefix} +% Indexing macros ignore Boolean flags meant for naming macros. Yet there are three prefix macros that affect indexing: \cmd{\SeeAlso}, \cmd{\SkipIndex}, and \cmd{\JustIndex}. % -%Both \Name[W.]{Snel van Royen}[Willebrord] and -%his son \Name[R.]{Snel van Royen}[Rudolph] were known -%by the Latin moniker \Name{\textit{Snellius}}.\end{verbatim} +% \begin{itemize} +% \item \cmd{\SeeAlso} works with and is reset by \cmd{\IndexRef}, \cmd{\AKA}, and \cmd{\PName} (see also Section~\ref{sec:AKA}). There are few, if any, side effects.\medskip +% \item \cmd{\SkipIndex} works with the naming macros. Side effects include: +% \begin{itemize} +% \item Unless the \texttt{oldreset} option is used,\Version{3.5} both \cmd{\IndexName} and \cmd{\IndexRef} issue warnings if \cmd{\SkipIndex} precedes them, ignore \cmd{\SkipIndex}, and reset its flag. +% \item Only when the \texttt{oldreset} option is used, both \cmd{\PName}\Version{3.5} and \cmd{\PName*} issue warnings when \texttt{\textbackslash if@nameauth@SkipIndex} is true on exit. +% \end{itemize} +% \item \cmd{\JustIndex} makes the naming macros act like \cmd{\IndexName}. That affects both the printing and indexing flags governed by prefix macros. +% \end{itemize} % -% \smallskip -% \IndexRef{\textit{Snellius}}{Snel van Royen, R.; Snel van Royen, W.} -% Both \Name[W.]{Snel van Royen}[Willebrord] and -% his son \Name[R.]{Snel van Royen}[Rudolph] were known -% by the Latin moniker \Name{\textit{Snellius}}. -% \end{quote} +% There are many potential side effects related to \cmd{\JustIndex}: +% \begin{itemize} +% \item Both \cmd{\AKA} and \cmd{\PName} ignore \cmd{\JustIndex} and go on about their business. They also set \cmd{\@nameauth@JustIndexfalse}. +% \item \cmd{\JustIndex} causes the naming macros to imitate \cmd{\IndexName} and ignore most flags, except for those discussed in the next bullet point. That makes the following two lines equivalent: +% \begin{quote}\small\MyStretch +% \cmd{\SkipIndex} \cmd{\JustIndex} \cmd{\Name\{A\}} \cmd{\Name\{B\}}\\ +% \cmd{\JustIndex} \cmd{\Name\{A\}} \cmd{\SkipIndex} \cmd{\Name\{B\}} +% \end{quote} +% According to the table on page~\pageref{page:Priorities}, \cmd{\JustIndex} takes priority with \cmd{\Name\{A\}} and passes \cmd{\@nameauth@SkipIndextrue} to \cmd{\Name\{B\}}. +% \item Currently,\Version{3.3} the naming macros always reset \cmd{\@nameauth@FullNamefalse} and \cmd{\@nameauth@FirstNamefalse}. For example:\\[1.5ex] +% \bgroup\small\vspace{-17ex}\PatInfo{\ShowPattern[George]{Washington}!MN}\vspace{17ex}\MyStretch\begin{tabular}{ll}\toprule +% Source & Output\\\midrule +% \rowcolor{grey}|\JustIndex\FName[George]{Washington}%| & \\ +% \rowcolor{grey}| \Name[George]{Washington}| & +% \JustIndex\FName[George]{Washington}\Name[George]{Washington}\\ +% \rowcolor{grey}|\JustIndex\SWash \Wash| & \JustIndex\SWash \Wash \hphantom{ George}\\ +% |\JustIndex\Name*[George]{Washington}%| & \\ +% | \Name[George]{Washington}| & +% \JustIndex\Name*[George]{Washington}\Name[George]{Washington}\\ +% |\JustIndex\LWash \Wash| & \JustIndex\LWash \Wash\\ +% \end{tabular}\egroup\smallskip +% +% \item The \texttt{oldpass} option restores the old behavior, which did not always reset the name length modifier. For example:\\[1.5ex] +% \bgroup\makeatletter\@nameauth@OldPasstrue\makeatother% +% \small\vspace{-17ex}\PatInfo{\ShowPattern[George]{Washington}!MN}\vspace{17ex}\MyStretch\begin{tabular}{ll} +% \rowcolor{grey}|\JustIndex\FName[George]{Washington}%| & \\ +% \rowcolor{grey}| \Name[George]{Washington}| & +% \JustIndex\FName[George]{Washington}\Name[George]{Washington}\\ +% \rowcolor{grey}|\JustIndex\SWash \Wash| & \JustIndex\SWash \Wash\\ +% |\JustIndex\Name*[George]{Washington}%| & \\ +% | \Name[George]{Washington}| & +% \JustIndex\Name*[George]{Washington}\Name[George]{Washington}\\ +% |\JustIndex\LWash \Wash| & \JustIndex\LWash \Wash\\\bottomrule +% \end{tabular}\egroup +% \end{itemize}\leavevmode % -% \cmd{\IndexRef}\Info{location matters} prevents page numbers in cross-references, so one must plan how to set up complex cross-references. Above, |\Name{\textit{Snellius}}| produces no index entry because \cmd{\IndexRef} comes first.\medskip +% \begin{center}\bfseries Variant Names and Cross-References\end{center} +% \phantomsection +% \label{page:IdxVariants} +% Here we show differences among variants and cross-references. We can choose to index variants under the canonical name or we can set up cross-references with variants. The order in which we do that is significant: +% \begin{enumerate} +% \item We use\PatInfo{\ShowPattern[J.E.]{Carter, Jr.}!MN\hfill \textrm{(1--2)}\break \ShowPattern[Jimmy]{Carter}!PN\hfill \textrm{(3, 6)}\break \ShowPattern[Jimmy]{Carter}!MN\hfill \textrm{(4)}\break \ShowPattern[J.E.]{Carter, Jr.}!PN\hfill \textrm{(5)}} the canonical name to create page references:\smallskip\\ +% \hbox{}\quad|\Name*[J.E.]{Carter, Jr.}|\dotfill \Name*[J.E.]{Carter, Jr.} +% \item Variants that use \meta{Alternate} in the text create page entries under the canonical form, not the variant form:\smallskip\\ +% \hbox{}\quad|\DropAffix\Name*[J.E.]{Carter, Jr.}[Jimmy]|\dotfill \DropAffix\Name*[J.E.]{Carter, Jr.}[Jimmy]\\ +% \hbox{}\quad|\ShowIdxPageref*[J.E.]{Carter, Jr.}[Jimmy]|\dotfill \ShowIdxPageref*[J.E.]{Carter, Jr.}[Jimmy] +% \item We must create\Version{3.5} a \textit{see} reference from an alternate form to a canonical form \emph{before} using the alternate form in a naming macro, or it will be ignored and a warning will result:\smallskip\\ +% \hbox{}\quad|\IndexRef[Jimmy]{Carter}{Carter, J.E., Jr.}|\IndexRef[Jimmy]{Carter}{Carter, J.E., Jr.} +% \item No page references will occur below because we made the \textit{see} reference first. Note how the alternate form is an independent name:\smallskip\\ +% \hbox{}\quad|\Name[Jimmy]{Carter}|\dotfill \Name[Jimmy]{Carter} +% \item If we want to index the alternate name, we have to use the canonical name instead of the alternate name:\smallskip\\ +% \hbox{}\quad|\IndexName[J.E.]{Carter, Jr.}| +% \item If instead we wanted to make a \textit{see also} reference, we would use both the canonical name and the alternate name, then create the cross-reference \emph{after} all uses of the alternate name (at the end of the document), e.g.:\smallskip\\ +% \hbox{}\quad|\SeeAlso\IndexRef[Jimmy]{Carter}{Carter, J.E., Jr.}| +% \end{enumerate} % % Below,\Info{Multiple\break connections} two names are indexed with page numbers. They have \textit{see also} cross-references to each other. One of those names also has a \textit{see} reference to it: -% \begin{itemize} -% \item We use the canonical name to set up page references:\smallskip\\ -% \hbox{}\qquad|\Name{Maimonides}|\dotfill\Name{Maimonides} +% \begin{enumerate} +% \item We use\PatInfo{\ShowPattern{Maimonides}!MN \textrm{(1)}\break \ShowPattern{Moses, ben-Maimon}!PN \textrm{(2)}\break \ShowPattern{Moses, ben-Maimon}!MN \textrm{(3)}\break \ShowPattern{Rambam}!MN \textrm{(4)}\break \ShowPattern{Rambam}!PN \textrm{(5)}} the canonical name to set up page references:\smallskip\\ +% \hbox{}\qquad|\Name{Maimonides}|\dotfill \Name{Maimonides} % \item \Name{Maimonides} has two other names, one more used than the other. We set up his least-used name as the \textit{see} reference:\smallskip\\ -% \hbox{}\qquad|\IndexRef{Moses, ben-Maimon}{Maimonides}|\IndexRef{Moses, ben-Maimon}{Maimonides}\\ -% \hbox{}\qquad|\Name{Moses, ben-Maimon}|\dotfill\Name{Moses, ben-Maimon} -% \item We now have a main name with a page entry and a ``\textit{see} reference'' to that name. \Name*{Moses, ben-Maimon} has no page entries because we made the xref before we started to use the name. +% \hbox{}\qquad|\IndexRef{Moses, ben-Maimon}{Maimonides}|\IndexRef{Moses, ben-Maimon}{Maimonides} +% \item We now have a main name with a page entry and a ``\textit{see} reference'' to that name. No page references will occur below because we made the \textit{see} reference first:\smallskip\\ +% \hbox{}\qquad|\Name{Moses, ben-Maimon}|\dotfill \Name{Moses, ben-Maimon} % \item Before creating \textit{see also} cross-references, we use the other alternate name so that all the page entries precede the cross-references:\smallskip\\ -% \hbox{}\qquad|\Name{Rambam}|\dotfill\Name{Rambam} +% \hbox{}\qquad|\Name{Rambam}|\dotfill \Name{Rambam} % \item All \textit{see also} references must come after all page references. For example, one could put both of these macros at the end of the document:\smallskip\\ % \hbox{}\qquad|\SeeAlso\IndexRef{Maimonides}{Rambam}|\SeeAlso\IndexRef{Maimonides}{Rambam}\\ % \hbox{}\qquad|\SeeAlso\IndexRef{Rambam}{Maimonides}|\SeeAlso\IndexRef{Rambam}{Maimonides} -% \end{itemize} -% -% \BigBlank -% \newpage -% -% \begin{center}\bfseries Continental Format Reference Work\end{center} -% -% Let us create a macro for entries in a reference work using the basic form of Continental formatting from Section~\ref{sec:AltBasic}. We enable alternate formatting, set up tags, and define an article with head-words: -% \AltFormatActive -%\newcommand{\RefArticle}[4]{%^^A -% \def\check{#2}%^^A -% \ifx\check\empty -% \noindent\ForgetThis#1\ {#4} -% \else -% \noindent\ForceName#1\ ``\ForceName#2'' -% \ForceName#3\ {#4} -% \fi -%} -% \begin{quote}\small -% \StartNum -% \begin{verbatim} -%\AltFormatActive -%\PretagName[Greta]{\textSC{Garbo}}{Garbo, Greta} -%\PretagName[Heinz]{\textSC{Rühmann}}{Ruehmann, Heinz} -%\PretagName[Heinrich Wilhelm]{\textSC{Rühmann}}% -% {Ruehmann, Heinrich Wilhelm} +% \end{enumerate} % -%\newcommand{\RefArticle}[4]{% -% \def\check{#2}% -% \ifx\check\empty -% \noindent\ForgetThis#1\ {#4} -% \else -% \noindent\ForceName#1\ ``\ForceName#2'' -% \ForceName#3\ {#4} -% \fi -%}\end{verbatim} +% \cmd{\IndexRef}\Info{Combining xrefs} will not merge multiple cross-references and it will not allow more than one cross-reference. For multiple cross-references one must use something like: +% \begin{quote} +% \begin{tabular}{ll} +% source: & |\IndexRef{bar}{baz; foo}|\\[0.5ex] +% index: & bar, \textit{see} baz; foo\\ +% \end{tabular} % \end{quote} % -% \cmd{\RefArticle} either formats the name from the first argument and appends the fourth argument, ignoring the others if the second is empty, or it formats the first three arguments and appends the fourth. We determine what those arguments mean by including specific naming macros. -% \begin{quote}\small -% \ContinueNum +% There\Info{Multiple targets} is a special case where one cross-reference can point to multiple targets, such as demonstrated in the example below: +% +% \begin{quote}\small\leavevmode\PatInfo{\ShowPattern{\textit{Snellius}}!PRE\break \ShowPattern{\textit{Snellius}}!PN\break \ShowPattern[W.]{Snel van Royen}!MN\break \ShowPattern[R.]{Snel van Royen}!MN}\vspace{-5ex} +% \StartNum % \begin{verbatim} -%\RefArticle% -% {\Name[Greta]{\textSC{Garbo}}}% -% {}{}% -% {(18 September 1905\,--\,15 April 1990) was a Swedish -% film actress during the 1920s and 1930s.} +%\PretagName{\textit{Snellius}}{Snellius} +%\IndexRef{\textit{Snellius}} +% {Snel van Royen, R.; Snel van Royen, W.} +%Both \Name[W.]{Snel van Royen}[Willebrord] and +%his son \Name[R.]{Snel van Royen}[Rudolph] were known +%by the Latin moniker \Name{\textit{Snellius}}.\end{verbatim} % -%\RefArticle% -% {% -% \IndexRef[Heinrich Wilhelm]{\textSC{Rühmann}}% -% {\textSC{Rühmann}, Heinz}% -% \SubvertThis\FName[Heinrich Wilhelm]{\textSC{Rühmann}}% -% }% -% {\SubvertThis\FName[Heinz]{\textSC{Rühmann}}}% -% {\Name[Heinz]{\textSC{Rühmann}}}% -% {(7 March 1902\,--\,3 October 1994) was a German actor -% in over 100 films.} -% -%\AltFormatInactive\end{verbatim} +% \smallskip +% \IndexRef{\textit{Snellius}} +% {Snel van Royen, R.; Snel van Royen, W.} +% Both \Name[W.]{Snel van Royen}[Willebrord] and +% his son \Name[R.]{Snel van Royen}[Rudolph] were known +% by the Latin moniker \Name{\textit{Snellius}}. % \end{quote} % -% \begin{quote} -%\RefArticle%^^A -% {\Name[Greta]{\textSC{Garbo}}}%^^A -% {}{}%^^A -% {(18 September 1905\,--\,15 April 1990) was a Swedish -% film actress during the 1920s and 1930s.} -% -%\RefArticle%^^A -% {%^^A -% \IndexRef[Heinrich Wilhelm]{\textSC{Rühmann}}%^^A -% {\textSC{Rühmann}, Heinz}%^^A -% \SubvertThis\FName[Heinrich Wilhelm]{\textSC{Rühmann}}%^^A -% }%^^A -% {\SubvertThis\FName[Heinz]{\textSC{Rühmann}}}%^^A -% {\Name[Heinz]{\textSC{Rühmann}}}%^^A -% {(7 March 1902\,--\,3 October 1994) was a German actor -% in over 100 films.} -% \end{quote} +% \cmd{\IndexRef}\Info{Location matters} prevents page numbers in cross-references, so one must plan how to set up complex cross-references. Above, |\Name{\textit{Snellius}}| produces no index entry because \cmd{\IndexRef} comes first. % -% \AltFormatInactive % \ReturnLink % \newpage % % \subsubsection{Index Sorting} % \label{sec:IndexSort} % +% Here we introduce the index sorting macros, with examples of error prevention: +% \begin{center}\small\MyStretch +% \begin{tabular}{ll}\toprule +% potential sorting problems & page~\pageref{page:DebugSort}\\ +% \rowcolor{grey}example reference work & page~\pageref{page:ContinentalXref}\\\bottomrule +% \end{tabular} +% \end{center} +% % \DescribeMacro{\IndexActual} -% The general practice for sorting with \texttt{makeindex -s} involves creating your own |.ist| file (pages 659--65 in \textit{The Latex Companion}). The following form works with both \texttt{makeindex} and \texttt{texindy}: |\index{|\meta{sort key}|@|\meta{actual}|}|. By default, the ``actual'' character is |@|. If one needs to change the ``actual'' character, such as when using \texttt{gind.ist} with \texttt{.dtx} files, one would put |\IndexActual{=}| in the preamble (or driver section) before using \cmd{\PretagName}.\medskip +% Using \cmd{\index\{}\meta{sort key}\texttt{@}\meta{actual}\texttt{\}} works with both \texttt{makeindex} and \texttt{texindy}.\footnote{The general practice for sorting with \texttt{makeindex -s} involves creating an \texttt{.ist} file (pages 659--65 in \textit{The Latex Companion}).} +% By default, the ``actual'' character is |@|. If one needs to change the ``actual'' character, such as when using \texttt{gind.ist} with \texttt{.dtx} files, one would put |\IndexActual{=}| in the preamble (or driver section) before using \cmd{\PretagName}.\medskip % +% Effects of \cmd{\IndexActual}\Info{\cmd{\global}} are local in scope. Use \cmd{\global} to make it otherwise, but that will affect every use of \cmd{\PretagName} thereafter. We demonstrate this scoping below as it pertains to \texttt{gind.ist} in a \texttt{dtx} file: +% \begin{quote}\small\leavevmode\PatInfo{\ShowPattern{Ægidius}!PRE}\vspace{-5ex} +% \StartNum +% \begin{verbatim} +%\PretagName{Ægidius}{Aegidius} +%\begingroup +% \IndexActual{@} +% \ShowIdxPageref{Ægidius}\qquad +%\endgroup +%\ShowIdxPageref{Ægidius}\end{verbatim} +% +%\PretagName{Ægidius}{Aegidius} +%\begingroup +% \IndexActual{@} +% \ShowIdxPageref{Ægidius}\qquad +%\endgroup +%\ShowIdxPageref{Ægidius} +% \end{quote} +% % \noindent \DescribeMacro{\PretagName} -% The \textsf{nameauth} package enables automatic index sorting using a ``pretag'' (see Section~\ref{sec:NamePatterns}).\Version{2.0} \cmd{\PretagName} creates a sort key terminated with the ``actual'' character. Do not put the ``actual'' character in the ``pretag'': +% The \textsf{nameauth} package enables automatic index sorting using a ``pretag'' (cf. Section~\ref{sec:NamePatterns}). Unless the \texttt{nopretag} option is used (which results in warnings), \cmd{\PretagName} creates a sort key terminated with the ``actual'' character. Do not put the ``actual'' character in the ``pretag'': +% % \begin{quote} -% \fbox{\mystrut\ \cmd{\PretagName}\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate}\marg{tag} } +% \fbox{ +% \begin{tabular}{l} +% {\Large\strut}\cmd{\PretagName}\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate}\marg{tag}\\ +% \end{tabular} +% } % \end{quote} % -% One need only ``pretag'' names once in the preamble. Thereafter, they will be sorted automatically. For example: -% \begin{quote}\small +% One can ``pretag'' any name, any cross-reference, and even excluded names. Once made, sorting tags cannot be unmade. If one uses \cmd{\PretagName} in the preamble, those names will be sorted automatically. For example: +% +% \begin{quote}\small\leavevmode\PatInfo{\ShowPattern{Æthelred, II}!PRE\break \ShowPattern[W.E.B.]{Du~Bois}!PRE\break \ShowPattern{Æthelred, II}!MN\break \ShowPattern[W.E.B.]{Du~Bois}!MN}\vspace{-5ex} % \StartNum % \begin{verbatim} -%\PretagName[Jan]{Łukasiewicz}{Lukasiewicz, Jan} %\PretagName{Æthelred, II}{Aethelred 2} -%\PretagName[W.E.B.]{Du~Bois}{Dubois, W.E.B.}\end{verbatim} +%\PretagName[W.E.B.]{Du~Bois}{Dubois, William}\end{verbatim} % \end{quote} % -% Every reference to \Name*[Jan]{Łukasiewicz}, \LAeth, and \LDuBois\ is automatically tagged and sorted. One also must ``pretag'' names that contain spaces, macros, active characters, control spaces, non-breaking spaces, and anything that is not basic ASCII. That can differ when using \texttt{xindy} and Unicode-based \LaTeX.\medskip -% -% For example, the\Info{particles and\break languages} sort tag \texttt{de Soto} precedes \texttt{deal} due to the space: \texttt{de\textvisiblespace}. The sort tag \texttt{Desoto} falls between \texttt{derp} and \texttt{determinism}. German \textsf{ä ö ü ß} map to English \textsf{ae oe ue ss}. Yet Norwegian \textsf{æ ø å} follow \textsf{z} in that order. Check a style guide regarding collating sequences, spaces, and sorting. This is where using \texttt{xindy} can be very helpful. See also Section~\ref{sec:NameParticles}.\medskip -% -% One\Info{sub-entries} can sort names by creating sub-entries, which depends on the index style and formatting files: \cmd{\PretagName[Some]\{Name\}\{}\meta{category}\texttt{!Name, Some\}}. See the documentation for \texttt{xindy} and \texttt{makeindex}. -% -% Below we show how \cmd{\PretagName} helps one to avoid manually sorting cross-references (cf. Section~\ref{sec:NameParticles}): +% Every reference to \LAeth\ and \LDuBois\ is automatically tagged and sorted. One should ``pretag'' all names that contain active characters or macros. That can differ when using \texttt{xindy} and Unicode-based \LaTeX. We keep this example simple and do not use alternate formatting (cf. Sections~\ref{sec:NameAncient}, \ref{sec:AltFormat}). The name patterns are: \texttt{\ShowPattern{\textit{Doctor angelicus}}!PRE \ShowPattern{\textit{Doctor angelicus}}!PN \ShowPattern{Thomas, Aquinas}!MN \ShowPattern{\textit{Doctor angelicus}}!MN}: % % \begin{quote}\small % \StartNum % \begin{verbatim} %\PretagName{\textit{Doctor angelicus}}{Doctor angelicus} -%\IndexRef{\textit{Doctor angelicus}}{Thomas, Aquinas} +%\IndexRef{\textit{Doctor angelicus}}{Thomas Aquinas} % %Perhaps the greatest medieval theologian was %\Name{Thomas, Aquinas}, later known as @@ -3125,64 +2998,69 @@ the README.txt or README for more information. % % \smallskip % \PretagName{\textit{Doctor angelicus}}{Doctor Angelicus} -% \IndexRef{\textit{Doctor angelicus}}{Thomas, Aquinas} +% \IndexRef{\textit{Doctor angelicus}}{Thomas Aquinas} % Perhaps the greatest medieval theologian was % \Name{Thomas, Aquinas}, later known as % \Name{\textit{Doctor angelicus}}. % \end{quote} % -% \cmd{\PretagName} differs from the other tagging macros because its function is sorting entries, not appending information to entries: -% \begin{itemize} -% \item You can ``pretag'' any name and any cross-reference. -% \item You can ``tag'' and ``untag'' only page-reference names, not xrefs, but you can turn a page-reference name into a \textit{see also} xref. -% \item You can undo a ``tag'' but you cannot undo a ``pretag.'' -% \end{itemize} -% \newpage -% -% \begin{center}\bfseries Debugging Problems with Sorting\end{center} +% Spaces change sorting. For example, the\Info{Particles and\break languages} sort tag \texttt{De\textvisiblespace Soto} precedes \texttt{deal} due to the space therein. The sort tag \texttt{DeSoto} falls between \texttt{derp} and \texttt{determinism}. German \textsf{ä ö ü ß} map to English \textsf{ae oe ue ss}. Yet Norwegian \textsf{æ ø å} follow \textsf{z} in that order. Check a style guide regarding collating sequences, spaces, and sorting. This is where using \texttt{xindy} can be very helpful. See also Section~\ref{sec:NameParticles}.\medskip +% +% One\Info{Sub-entries} can sort names by creating sub-entries, which depends on the index style and formatting files: \cmd{\PretagName[Some]\{Name\}\{}\meta{category}\texttt{!Name, Some\}}. See also the documentation for \texttt{xindy} and \texttt{makeindex}. % -% \bgroup If an entry is incorrect in the index, check the following: +% \begin{center}\bfseries Potential Sorting Problems\end{center} +% \phantomsection +% \label{page:DebugSort} +% If an entry is sorted incorrectly in the index, check the following: % \begin{itemize} % \item Are there any active characters, internal spaces, or control sequences in the name arguments? Use \cmd{\PretagName}. % \item Is alternate formatting used consistently? Are any names used within sections of alternate formatting ever used outside of them? % \item Are macros in the name arguments that can expand differently under different conditions preceded by \cmd{\noexpand}? % \end{itemize} % -% Since 2018 changes in the way that Unicode characters are handled in \texttt{pdflatex} and \texttt{latex} have made indexing simpler and more intuitive, e.g.\medskip -% +% Since 2018, changes in the way that \texttt{pdflatex} and \texttt{latex} handle Unicode characters have made indexing simpler and more intuitive, e.g. +% % \def\arrow{\ \(\rightarrow\)\ } % \def\midrowa{\arrow\quad} % \def\midrowb{\hphantom{\arrow}\quad} % \def\midrow{\midrowb} % \begin{center}\MyStretch -% \begin{tabular}{ll>{\hspace{-1em}\midrow}lll>{\hspace{-1em}\midrow}l}\toprule +% \begin{tabular}{l@{\ }l>{\hspace{-1em}\midrow}ll@{\ }l>{\hspace{-1em}\midrow}l}\toprule % pre-2018 & text & index & post-2018 & text & index\gdef\midrow{\midrowa}\\\midrule -% & ä & \texttt{\cmd{\IeC\textvisiblespace}\{\cmd{\"a}\}} & & ä & \texttt{ä}\\ -% \rowcolor{black!7!white} & æ & \texttt{\cmd{\IeC\textvisiblespace}\{\cmd{\ae\textvisiblespace}\}} -% & & æ & \texttt{æ}\\\bottomrule +% \rowcolor{grey} & ä & \texttt{\cmd{\IeC\textvisiblespace}\{\cmd{\"a}\}} & & ä & \texttt{ä}\\ +% & æ & \texttt{\cmd{\IeC\textvisiblespace}\{\cmd{\ae\textvisiblespace}\}} +% & & æ & \texttt{æ}\\\bottomrule % \end{tabular} % \end{center} +% % One can test for this change and take different approaches with: -% \begin{quote} +% \begin{quote}\small % \cmd{\IfFileExists\{utf8-2018.def\}}\marg{yes}\marg{no} % \end{quote} +% % One also should look at the entries in the \texttt{.idx} or \texttt{.ind} files to see how the name arguments and other index entry components are turned into index entries. If there are entries that do not work, one can find the corresponding page numbers in order to identify the problem. % -% Extra spaces\Warn{} are significant when sorting index entries, yet usually are not significant in the body text. Hidden spaces, tokens, macros, and control sequences create unique index entries that look similar, yet expand and sort differently. Some macros can add spaces to index entries. For example, index tags in this manual that include \cmd{\dag} show up as \cmd{\dag\textvisiblespace\textvisiblespace} in the index (two trailing spaces). Below we show a general form of macro that adds extra spaces to index entries: +% Extra spaces\Warn{} are significant when sorting index entries, yet usually are not significant in the body text. Hidden spaces, tokens, macros, and control sequences create unique index entries that look similar, yet expand and sort differently. Some macros can add spaces to index entries. +% +% This is not an issue with the \textsf{nameauth} package as such. Rather, it stems from the use of \cmd{\protected@edef}. This package requires \cmd{\protected@edef} in any situation where the macros that generate index entries are written to the \texttt{aux} file for execution there, such as in the \textsf{memoir} class. Without \cmd{\protected@edef}, any active Unicode characters would start expanding, thus making different index entries than those one might make by hand. Since we do not want a ``package way'' to index names and a ``regular way'' that is different and hard to integrate with the ``package way'', this is an unavoidable necessity. +% \newpage +% +% Below we show the general minimal working example: % \begin{quote}\small % \StartNum % \begin{verbatim} %\newcommand\Idx[1]{% % \protected@edef\arg{#1}% % \index{\arg}}\end{verbatim} -% \end{quote} +% \medskip % -% \begin{center}\MyStretch\footnotesize -% \begin{tabular}{l>{\hspace{-1em}\arrow\ }l}\toprule -% |\Idx{\textsc{football}}| & \cmd{\indexentry}\texttt{\{\cmd{\textsc\textvisiblespace\textvisiblespace}\{football\}\}\{}\meta{page}\texttt{\}}\\ -% \rowcolor{black!7!white}|\index{\textsc{football}}| & \cmd{\indexentry}\texttt{\{\cmd{\textsc}\{football\}\}\{}\meta{page}\texttt{\}}\\\bottomrule -% \end{tabular} -% \end{center}\egroup +% The macro \cmd{\Idx\{}\cmd{\textsc\{football\}\}} produces:\\ +% \hbox{}\qquad\cmd{\indexentry}\texttt{\{\cmd{\textsc\textvisiblespace\textvisiblespace}\{football\}\}\{}\meta{page}\texttt{\}}\\[1ex] +% The macro \cmd{\index\{}\cmd{\textsc\{football\}\}} produces:\\ +% \hbox{}\qquad\cmd{\indexentry}\texttt{\{\cmd{\textsc}\{football\}\}\{}\meta{page}\texttt{\}} +% \end{quote} +% +% The debugging macros will not help at this point. We must inspect the \texttt{idx} file. The problem with the debugging macros is that they show how an index entry will appear on the page, more or less, but not how it will appear in the \texttt{idx} file, which determines sorting. % % \ReturnLink % @@ -3193,14 +3071,17 @@ the README.txt or README for more information. % This macro creates a tag appended to all index entries for a corresponding \cmd{\Name}. % \DescribeMacro{\UntagName} % The tag persists until one changes it with \cmd{\TagName} or destroys it with \cmd{\UntagName}. -% Tags can include life dates, regnal dates, and other information. Both \cmd{\TagName} and \cmd{\UntagName} handle their arguments like \cmd{\IndexName}: +% Tags can include life dates, regnal dates, and other information. Both \cmd{\TagName} and \cmd{\UntagName} have \emph{global scope} and handle arguments like \cmd{\IndexName}: % \begin{quote} -% \fbox{\vbox{\hbox{\mystrut\ \cmd{\TagName}\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate}\marg{tag} }\par -% \hbox{\mystrut\ \cmd{\UntagName}\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate} }}} +% \fbox{ +% \begin{tabular}{l} +% {\Large\strut}\cmd{\TagName}\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate}\marg{tag}\vspace{-2pt}\\ +% {\Large\strut}\cmd{\UntagName}\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate}\\ +% \end{tabular} +% } % \end{quote} -% \newpage -% -% All the indexing macros are keyed to the name patterns. \cmd{\PretagName} generates the leading sort key. \cmd{\TagName} and \cmd{\UntagName} affect the trailing content: +% +% All the indexing macros are keyed to the name patterns. \cmd{\PretagName} generates the leading sort key. \cmd{\TagName} and \cmd{\UntagName} affect the trailing content. The following graphic illustrates the ``segments'' of an index entry and the \textsf{nameauth} macros that affect the respective segments: % % \begin{center}\small\MyStretch % \begin{tabular}{r@{\,\vrule width0.5pt\,}c@{\,\vrule width0.5pt\,}c@{\,\vrule width0.5pt\,}l} @@ -3210,29 +3091,25 @@ the README.txt or README for more information. % & & & \quad\cmd{\UntagName}\\ % \end{tabular} % \end{center} -% \noindent % -% Tags\Info{scholarly\break helps} created by \cmd{\TagName} can be helpful in the indexes of academic texts by adding dates, titles, etc. \cmd{\TagName} causes the \textsf{nameauth} indexing macros to append ``\texttt{,\textvisiblespace pope}'' to the index entries for the popes below: -% \begin{quote}\small +% Tags\Info{Scholarly\break helps} created by \cmd{\TagName} can be helpful in the indexes of academic texts by adding dates, titles, etc. \cmd{\TagName} causes the \textsf{nameauth} indexing macros to append ``\texttt{,\textvisiblespace pope}'' to the index entries created below: +% \begin{quote}\small\leavevmode\PatInfo{\ShowPattern{Gregory, I}!TAG\break \ShowPattern{Gregory, I}!MN\break \ShowPattern{Gregory, the Great}!PN}\vspace{-5ex} % \StartNum % \begin{verbatim} -%\TagName{Leo, I}{, pope} %\TagName{Gregory, I}{, pope} -%Pope \Name{Leo, I} was known as \AKA{Leo, I}{Leo, the Great}.\\ -%Pope \Name{Gregory, I} was known as \Name{Gregory, I} -%``\ForceFN\AKA*{Gregory, I}{Gregory, the Great}.''\end{verbatim} +%Pope \Name*{Gregory, I} was known as \Name{Gregory, I} +%``the Great''.\IndexRef{Gregory, the Great}{Gregory I}\end{verbatim} % % \smallskip -% Pope \Name{Leo, I} was known as \AKA{Leo, I}{Leo, the Great}.\\ -% Pope \Name{Gregory, I} was known as \Name{Gregory, I} -% ``\ForceFN\AKA*{Gregory, I}{Gregory, the Great}.'' +% Pope \Name*{Gregory, I} was known as \Name{Gregory, I} +% ``the Great''.\IndexRef{Gregory, the Great}{Gregory I} % \end{quote} % -% \cmd{\TagName} works with all names, but not with cross-references from \cmd{\IndexRef}, \cmd{\AKA}, etc. (cf. Sections~\ref{sec:IndexXref}, \ref{sec:AKA}). Tags also can be daggers, asterisks, and so on. For example, all fictional names in the index of this manual are tagged with \S. One must add any desired spaces to the start of the tag.\medskip +% \cmd{\TagName} works with all names, but not with cross-references from \cmd{\IndexRef}, \cmd{\AKA}, etc. (cf. Sections~\ref{sec:GeneralIndex}, \ref{sec:AKA}). Tags also can be daggers, asterisks, and so on. For example, all fictional names in the index of this manual are tagged with \S. One must add any desired spaces to the start of the tag.\medskip % -% We\Info{same name\break game} can format and index one name as two different people with \cmd{\TagName} and \cmd{\ForgetThis} (Section~\ref{sec:NameControl}). The index tags group together their respective entries. In a normal \LaTeX\ document one would write, e.g.: +% We\Info{Same name\break game} can format and index one name as two different people with \cmd{\TagName} and \cmd{\ForgetThis} (Section~\ref{sec:NameControl}). The index tags group together their respective entries. In a normal \LaTeX\ document one would write, e.g.: % -% \begin{quote}\small +% \begin{quote}\small\leavevmode\PatInfo{\ShowPattern[E.]{Humperdinck}!TAG\break \ShowPattern[E.]{Humperdinck}!MN}\vspace{-4.5ex} % \StartNum % \begin{verbatim} %\TagName[E.]{Humperdinck}{ (composer)} @@ -3253,13 +3130,12 @@ the README.txt or README for more information. % \ForgetThis\Name[E.]{Humperdinck}[Engelbert]. % \end{quote} % -% One\Info{special tags} can use \cmd{\TagName} to create ``special'' index entries for names with the general form \cmd{\TagName\{}\meta{Name}\texttt{\}\{\textbar}\meta{Macro}\texttt{\}}, when \cmd{\def}\texttt{\textbackslash}\meta{Macro}\texttt{\#1\{\#1\}} exists. These\Version{3.3} tags are compatible with \textsf{hyperref}.\footnote{Before version 3.3 these special tags did not work with \textsf{hyperref}. The fix was inspired by the answer of \Name[Heiko]{Oberdiek} in: \url{https://tex.stackexchange.com/questions/201720/index-produces-invalid-idx-entry-with-manual-style-commaparse-hyperref}} +% One\Info{Special tags} can use \cmd{\TagName} to create ``special'' index entries for names with the general form \cmd{\TagName}\meta{name args}\texttt{\{\textbar}\meta{Macro}\texttt{\}},\Version{3.3} when \cmd{\def}\texttt{\textbackslash}\meta{Macro}\texttt{\#1\{\#1\}} exists. These tags are compatible with \textsf{hyperref}.\footnote{Before version 3.3 these special tags did not work with \textsf{hyperref}. The fix was inspired by \Name*[Heiko]{Oberdiek} in \href{https://tex.stackexchange.com/questions/201720/index-produces-invalid-idx-entry-with-manual-style-commaparse-hyperref}{this question}.} +% +% For example, using the \textsf{ltxdoc} class with \textsf{hypdoc} does not create hyperlinked page entries with \textsf{nameauth}. This behavior does not affect normal \LaTeX\ documents that use \textsf{nameauth} and \textsf{hyperref}. In this manual we had to tag every name with \cmd{\TagName}\meta{name args}\texttt{\{\textbar hyperpage\}} in the driver section of the \texttt{dtx} file. +% +% In the ``commented'' package documentation part of a \texttt{dtx} file, the vertical bar is active. This adds an extra layer of complexity. Index tags in the documentation part must use the form: \cmd{\TagName}\meta{name args}\texttt{\{}\cmd{\string}\texttt{\textbar hyperpage\}}. % -% For example, using the \textsf{ltxdoc} class with \textsf{hypdoc} does not create hyperlinked page entries with \textsf{nameauth}. This behavior does not affect normal \LaTeX\ documents that use \textsf{nameauth} and \textsf{hyperref}. When creating this manual, we had to tag every name with: \cmd{\TagName\{}\meta{Name}\}\texttt{\{\textbar hyperpage\}} in the driver section of the \texttt{dtx} file. -% -% In the ``commented'' package documentation part of a \texttt{dtx} file, the vertical bar is active. This adds an extra layer of complexity. Index tags in the documentation part must use the form: \cmd{\TagName\{}\meta{Name}\texttt{\}\{}\cmd{\string}\texttt{\textbar hyperpage\}}. -% \newpage -% % Below we use the conventions of this manual to create a special tag: % \begin{quote}\small % \StartNum @@ -3268,15 +3144,20 @@ the README.txt or README for more information. %\TagName[Lost]{Name}{\,\S|Orphan{perdit}} %\Name[Lost]{Name}\end{verbatim} % -% \smallskip -% \MyStretch\Name[Lost]{Name}\\ +% \smallskip\MyStretch +% \Name[Lost]{Name}\\ % \texttt{idx} file: |\indexentry{Name, Lost\,\S |\texttt{\textbar}|Orphan{perdit}}{|\meta{page}|}|\\ % \texttt{ind} file: |\item Name, Lost\,\S \pfill \Orphan{perdit}{|\meta{page}|}| % \end{quote} % -% The \textsf{microtype} package and its \texttt{Spacing} environment may be the best solution to fix index entries and sub-entries that break badly across columns or pages. Suppose, however, that we wanted to insert manual breaks into an index at will, preferably after the final page reference in an entry. +% When \cmd{\IndexRef}\Info{Error\break prevention} calls \cmd{\@nameauth@Index}, a tag of the form \meta{some text}\texttt{\textbar}\meta{some macro} is reduced to \meta{some text}, allowing a new \texttt{\textbar}\meta{cross-reference} macro to be added. This keeps cross-references from breaking.\medskip +% +% The \textsf{microtype}\Info{Manual breaks\break and entries} package and its \texttt{Spacing} environment may be the best solution to fix index entries and sub-entries that break badly across columns or pages. Suppose, however, that we wanted to insert manual breaks into an index at the very end of the editing and proofreading passes. That is fairly easy to do. +% +% We cannot just insert something like \cmd{\newpage} or \cmd{\columnbreak} directly into an index. Instead, we create a helper macro that takes an argument and adds a break after that argument. That is, for example, how macros like \cmd{\textbf} use implied page references: \cmd{\index\{Doe, John\string|textbf\}}. % -% We cannot just insert something like \cmd{\newpage}. In order to accomplish our goal, we need a helper macro that can take an argument. Below we use \cmd{\newpage}, but if we instead make use of the \textsf{multicol} or \textsf{idxlayout} packages we can replace that with \cmd{\columnbreak}. Two macros illustrate a similar concept: +% Below we use \cmd{\newpage}, but if we instead make use of the \textsf{multicol} or \textsf{idxlayout} packages we can replace that with \cmd{\columnbreak}. On line 1 we define the \cmd{\Endbreak} macro that will break the index page or column at the end of an entry. On line 3 we do the same for somewhere in the middle of an index entry. In the latter case there will be a comma that we must \cmd{\@gobble} after a page reference: +% % \begin{quote}\small % \StartNum % \begin{verbatim} @@ -3286,27 +3167,36 @@ the README.txt or README for more information. %\makeatother\end{verbatim} % \end{quote} % -% Putting a break into the middle of an index entry is quite sketchy and probably should be avoided, but it can be done by using \cmd{\@gobble} to eat the comma after the break. Instead, breaking after the entry is preferable. That entry is a list of page numbers corresponding to several pages: -% \begin{quote} -% (page 10) \cmd{\Name\{Some, Name\}}\\ -% \dots\\ -% (page 15) \cmd{\Name\{Some, Name\}}\\ -% \dots\\ -% (page 18) \cmd{\TagName\{Some, Name\textbar EndBreak\}\%}\\ -% \hphantom{(page 18)} \cmd{\Name\{Some, Name\}} -% \end{quote} +% Using \cmd{\MidBreak} to insert a break into the middle of an index entry does work to some extent, but what it does is quite sketchy and error-prone. We avoid using it for these reasons, but we just wanted to show that it can be done. % -% If all instances of \cmd{\Name\{Some, Name\}} on page 18 have the same tag, there will be no duplicate page entries, \textsf{hyperref} will work, and the index will break after: -% \begin{quote} -% \texttt{Some Name \dots\ 10, 15, 18} +% Instead, we use \cmd{\EndBreak} after the last page in a given entry. This method works for manual index entries and for the \textsf{nameauth} macros. If all instances of \cmd{\Name\{Some, Name\}} on page 18 have the same tag, there will be no duplicate page entries, hyperlinks will work, and the index will break as indicated: +% +% \begin{quote}\footnotesize\MyStretch +% \begin{tabular}{p{0.055\textwidth}@{\ }p{0.4\textwidth}@{\ }l}\toprule +% Page & Macro & Index Result\\\midrule +% \rowcolor{grey}10 & \cmd{\Name\{Some, Name\}}\dotfill \hbox{} & Some Name, 10\\ +% \rowcolor{grey} & \cmd{\index\{Topic\}}\dotfill \hbox{} & Topic, 10\\ +% 15 & \cmd{\Name\{Some, Name\}}\dotfill \hbox{} & Some Name, 10, 15\\ +% & \cmd{\index\{Topic\}}\dotfill \hbox{} & Topic, 10, 15\\ +% \rowcolor{grey}18 & \cmd{\TagName\{Some, Name\textbar EndBreak\}\%} & \\ +% \rowcolor{grey} & \cmd{\Name\{Some, Name\}}\dotfill \hbox{} & Some Name, 10, 15, 18\meta{break}\\ +% \rowcolor{grey} & \cmd{\index\{Topic\textbar EndBreak\}}\dotfill \hbox{} & Topic, 10, 15, 18\meta{break}\\ +% \end{tabular} % \end{quote} -% -% We\Info{manual entries} can use the same macros in manual index entries. We may need to look at the \texttt{idx} or \texttt{ind} files to craft matching entries on the page that corresponds to the placement of the break:\footnote{Results vary, depending on what distribution of \LaTeX\ is being used and how old it is. As we saw in the previous section, any name with active characters needs to be handled differently before 2018 than after 2018.} -% \begin{quote} -% (page 18) \cmd{\SkipIndex}\cmd{\Name\{Some, Name\}\%}\\ -% \hphantom{(page 18)} \cmd{\index\{Some Name\textbar EndBreak\}} +% +% We do not have to supply an argument to \cmd{\EndBreak} because, as with the font switching example above, the page reference is implied. +% +% We can intermix \textsf{nameauth} macros with manual index entries. We may need to look at the \texttt{idx} or \texttt{ind} files to craft matching entries on the page where the break occurs. Instead of using \cmd{\TagName}, we can do this: +% +% \begin{quote}\footnotesize\MyStretch +% \begin{tabular}{p{0.055\textwidth}@{\ }p{0.4\textwidth}@{\ }l} +% 18 & \cmd{\SkipIndex}\cmd{\Name\{Some, Name\}\%}\hfill\hbox{} & \\ +% & \cmd{\index\{Some Name\textbar EndBreak\}}\dotfill \hbox{} & Some Name, 10, 15, 18\meta{break}\\\bottomrule +% \end{tabular} % \end{quote} -% +% +% Results for manual entries may vary, depending on what distribution of \LaTeX\ is being used and how old it is. As we saw in the previous section, any name with active characters needs to be handled differently before 2018 than after 2018. All instances of \cmd{\index\{Some Name\textbar EndBreak\}} must fall on the same page. +% % \ReturnLink % \newpage % @@ -3316,22 +3206,30 @@ the README.txt or README for more information. % \DescribeMacro{\NameAddInfo} % Unlike index tags, ``text tags'' are not printed automatically with every name managed by \textsf{nameauth}. Sections~\ref{sec:NameTests} and~\ref{sec:Hooksii} have more examples. The macro is \cmd{\long}, allowing for some complexity in the \meta{tag} argument: % \begin{quote} -% \fbox{\mystrut\ \cmd{\NameAddInfo}\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate}\marg{tag} } -% \end{quote} +% \fbox{ +% \begin{tabular}{l} +% {\Large\strut}\cmd{\NameAddInfo}\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate}\marg{tag}\\ +% \end{tabular} +% } +% \end{quote}\PatInfo{\ShowPattern[George]{Washington}!DB\break \ShowPattern[George]{Washington}!MN} % -% For example, |\NameAddInfo[George]{Washington}{(1732--99)}|\NameAddInfo[George]{Washington}{(1732--99)} makes a text tag but does not print whenever \cmd{\Wash} ``\Wash'' is used.\medskip +% For example, |\NameAddInfo[George]{Washington}{(1732--99)}|\NameAddInfo[George]{Washington}{(1732--99)} makes a text tag but does not print whenever \cmd{\Wash} \Wash\ is used.\medskip % % \DescribeMacro{\NameQueryInfo} % To print the text tag macro associated with a name, we use \cmd{\NameQueryInfo}, which calls the appropriate macro in the name info data set: % \begin{quote} -% \fbox{\mystrut\ \cmd{\NameQueryInfo}\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate} } +% \fbox{ +% \begin{tabular}{l} +% {\Large\strut}\cmd{\NameQueryInfo}\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate}\\ +% \end{tabular} +% } % \end{quote} % % \NameAddInfo[Ulysses S.]{Grant}{(president from 1869 to 1877)} % \NameAddInfo[Schuyler]{Colfax}{\footnote{He was the seventeenth % US vice-president, holding office during the first term (1869--73) % of \Name[Ulysses S.]{Grant} \NameQueryInfo[Ulysses S.]{Grant}.}} -% |\NameQueryInfo[George]{Washington}| expands to \NameQueryInfo[George]{Washington}. One can insert a space at its start or use signs like asterisks, daggers, and even footnotes, such as one for \Name[Schuyler]{Colfax}.\NameQueryInfo[Schuyler]{Colfax} Below is the source for footnote \arabic{footnote}: +% |\NameQueryInfo[George]{Washington}|\PatInfo{\ShowPattern[George]{Washington}!DB\break \ShowPattern[Ulysses S.]{Grant}!DB\break \ShowPattern[Schuyler]{Colfax}!DB\break \ShowPattern[Schuyler]{Colfax}!MN\break \ShowPattern[Ulysses S.]{Grant}!MN} expands to \NameQueryInfo[George]{Washington}. One can insert a space at its start or use signs like asterisks, daggers, and even footnotes, such as one for \Name[Schuyler]{Colfax}.\NameQueryInfo[Schuyler]{Colfax} Below is the source for footnote \arabic{footnote}: % \begin{quote}\small % \StartNum % \begin{verbatim} @@ -3343,13 +3241,13 @@ the README.txt or README for more information. % \texttt{\dots}|\Name[Schuyler]{Colfax}.\NameQueryInfo[Schuyler]{Colfax}| % \end{quote} % -% Since\Warn{} one can nest ``text tags'' or have them call each other, one can build complex relations. Yet one must protect against a stack overflow by using Boolean flags to stop the recursion: +% One can\Warn{} nest ``text tags'' and have them call each other. Therefore, one must protect against a stack overflow by using Boolean flags to stop the recursion: % \begin{quote}\small % \newif\ifA % \newif\ifB -% \NameAddInfo{A}{%^^A +% \NameAddInfo{A}{^^A % \Atrue A \ifB Stop \else \NameQueryInfo{B} \fi \Afalse} -% \NameAddInfo{B}{%^^A +% \NameAddInfo{B}{^^A % \Btrue B \ifA Stop \else \NameQueryInfo{A} \fi \Bfalse} % \StartNum % \begin{verbatim} @@ -3361,27 +3259,644 @@ the README.txt or README for more information. % \Btrue B \ifA Stop \else \NameQueryInfo{A} \fi \Bfalse}\end{verbatim} % \medskip % -% \begin{tabular}{@{}l@{ \(\rightarrow\) }l} +% \MyStretch\begin{tabular}{@{}l@{ \(\rightarrow\) }l} % \cmd{\NameQueryInfo\{A\}} & \NameQueryInfo{A}\\ % \cmd{\NameQueryInfo\{B\}} & \NameQueryInfo{B}\\ % \end{tabular} % \end{quote} -% +% % \DescribeMacro{\NameClearInfo} % \cmd{\NameAddInfo} will replace one text tag with another text tag, but it does not delete a text tag. That is the role of \cmd{\NameClearInfo}. The syntax is: +% \begin{quote} +% \fbox{ +% \begin{tabular}{l} +% {\Large\strut}\cmd{\NameClearInfo}\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate}\\ +% \end{tabular} +% } +% \end{quote} +% +% After using\PatInfo{\ShowPattern[George]{Washington}!DB} |\NameClearInfo[George]{Washington}|\NameClearInfo[George]{Washington}, the next attempt to query the tag |\NameQueryInfo[George]{Washington}| will produce nothing\NameQueryInfo[George]{Washington}. +% +% \ReturnLink +% \newpage +% +% \subsection{Basic Formatting} +% \label{sec:Formatting} +% +% Below are color-coded forms and formats of names, showing most (but not all) of the variations that can occur. The next several sections will explain such variations (and quite a few more) in detail:\medskip +% +% \begin{tcolorbox}[colframe=naslate,sidebyside,lower separated=true,adjusted title={\hfil Full Forms, Front Matter\hspace{5em} Short Forms, Front matter}]\centering +% {\cmd{\NamesInactive}}\NamesInactive +% \begin{tcolorbox}[left=2mm,right=2mm,bottom=1mm,colback=white,adjusted title={\sffamily\bfseries\hfil First Use (Default)}]\small +% \begin{tabular}{@{}ll@{}} +% \cmd{\Name} & \ForgetThis\Pat\\ +% & \ForgetThis\Eliz\\ +% & \ForgetThis\Yamt\\ +% & (cf. Section~\ref{sec:NameControl})\\ +% \end{tabular} +% \end{tcolorbox} +% \begin{tcolorbox}[left=2mm,right=2mm,bottom=1mm,colback=white,adjusted title={\sffamily\bfseries\hfil Later Use (\texttt{*} or \cmd{\L}\meta{macro})}]\small +% \begin{tabular}{@{}ll@{}} +% \cmd{\Name*} & \LPat\\ +% & \LEliz\\ +% & \LYamt\\ +% \end{tabular} +% \end{tcolorbox} +% \begin{tcolorbox}[left=2mm,right=2mm,bottom=1mm,colback=white,adjusted title={\sffamily\bfseries\hfil Long, with \cmd{\DropAffix}}]\small +% \begin{tabular}{@{}ll@{}} +% \cmd{\DropAffix}\cmd{\L}\meta{macro}\\ \SubvertThis\DropAffix\LPat\\ +% \end{tabular} +% \end{tcolorbox} +% \tcblower\centering +% {\cmd{\NamesInactive}}\NamesInactive +% \begin{tcolorbox}[left=2mm,right=2mm,bottom=1mm,colback=white,adjusted title={\sffamily\bfseries\hfil Later Use (Default)}]\small +% \begin{tabular}{@{}ll@{}} +% \cmd{\Name} & \SubvertThis\Pat; \SubvertThis\Eliz\\ +% & \SubvertThis\Yamt\\ +% \cmd{\FName}, & \SubvertThis\SPat; \SubvertThis\SEliz\\ +% \cmd{\S}\meta{macro} & \SubvertThis\SYamt\\ +% \end{tabular} +% \end{tcolorbox} +% \begin{tcolorbox}[left=2mm,right=2mm,bottom=1mm,colback=white,adjusted title={\sffamily\bfseries\hfil Later Use (\cmd{\ForceName})}]\small +% \begin{tabular}{@{}ll@{}} +% \cmd{\Name} & \SubvertThis\ForceName\Pat; \SubvertThis\ForceName\Eliz\\ +% & \SubvertThis\ForceName\Yamt\\ +% \cmd{\FName}, & \SubvertThis\ForceName\SPat; \SubvertThis\ForceName\SEliz\\ +% \cmd{\S}\meta{macro} & \SubvertThis\ForceName\SYamt\\ +% \end{tabular} +% \end{tcolorbox} +% \begin{tcolorbox}[left=2mm,right=2mm,bottom=1mm,colback=white,adjusted title={\sffamily\bfseries\hfil Later Use (\cmd{\ForceFN})}]\small +% \begin{tabular}{@{}ll@{}} +% \cmd{\FName}, \cmd{\S}\meta{macro} & \SubvertThis\ForceFN\SYamt\\ +% \end{tabular} +% \end{tcolorbox} +% \end{tcolorbox} +% \vfil +% \begin{tcolorbox}[colframe=naslate,sidebyside,lower separated=true,adjusted title={\hfil Full Forms, Main Matter\hspace{5em} Short Forms, Main Matter}]\centering +% \cmd{\NamesActive}\NamesActive +% \begin{tcolorbox}[left=2mm,right=2mm,bottom=1mm,colback=white,adjusted title={\sffamily\bfseries\hfil First Use (Default)}]\small +% \begin{tabular}{@{}ll@{}} +% \cmd{\Name} & \ForgetThis\Pat\\ +% & \ForgetThis\Eliz\\ +% & \ForgetThis\Yamt\\ +% & (cf. Section~\ref{sec:NameControl})\\ +% \end{tabular} +% \end{tcolorbox} +% \begin{tcolorbox}[left=2mm,right=2mm,bottom=1mm,colback=white,adjusted title={\sffamily\bfseries\hfil Later Use (\texttt{*} or \cmd{\L}\meta{macro})}]\small +% \begin{tabular}{@{}ll@{}} +% \cmd{\Name*} & \LPat\\ +% & \LEliz\\ +% & \LYamt\\ +% \end{tabular} +% \end{tcolorbox} +% \begin{tcolorbox}[left=2mm,right=2mm,bottom=1mm,colback=white,adjusted title={\sffamily\bfseries\hfil Long, with \cmd{\DropAffix}}]\small +% \begin{tabular}{@{}ll@{}} +% \cmd{\DropAffix}\cmd{\L}\meta{macro}\\ \SubvertThis\DropAffix\LPat\\ +% \end{tabular} +% \end{tcolorbox} +% \tcblower\centering +% \cmd{\NamesActive}\NamesActive +% \begin{tcolorbox}[left=2mm,right=2mm,bottom=1mm,colback=white,adjusted title={\sffamily\bfseries\hfil Later Use (Default)}]\small +% \begin{tabular}{@{}ll@{}} +% \cmd{\Name} & \SubvertThis\Pat; \SubvertThis\Eliz\\ +% & \SubvertThis\Yamt\\ +% \cmd{\FName}, & \SubvertThis\SPat; \SubvertThis\SEliz\\ +% \cmd{\S}\meta{macro} & \SubvertThis\SYamt\\ +% \end{tabular} +% \end{tcolorbox} +% \begin{tcolorbox}[left=2mm,right=2mm,bottom=1mm,colback=white,adjusted title={\sffamily\bfseries\hfil Later Use (\cmd{\ForceName})}]\small +% \begin{tabular}{@{}ll@{}} +% \cmd{\Name} & \SubvertThis\ForceName\Pat; \SubvertThis\ForceName\Eliz\\ +% & \SubvertThis\ForceName\Yamt\\ +% \cmd{\FName}, & \SubvertThis\ForceName\SPat; \SubvertThis\ForceName\SEliz\\ +% \cmd{\S}\meta{macro} & \SubvertThis\ForceName\SYamt\\ +% \end{tabular} +% \end{tcolorbox} +% \begin{tcolorbox}[left=2mm,right=2mm,bottom=1mm,colback=white,adjusted title={\sffamily\bfseries\hfil Later Use (\cmd{\ForceFN})}]\small +% \begin{tabular}{@{}ll@{}} +% \cmd{\FName}, \cmd{\S}\meta{macro} & \SubvertThis\ForceFN\SYamt\\ +% \end{tabular} +% \end{tcolorbox} +% \end{tcolorbox} +% \newpage +% +% Since\Info{Naming system\break behavior} formatting is related closely to name usage (the existence of a name control sequence), we use similar descriptors for these distinct topics. A name's classification, elements, and control sequence are determined in the syntactic element layer. A name's displayed form is determined in the name display layer. Finally, a name's typographic form is determined by the format hook dispatcher and formatting hooks. Here is the general layout: +% +% \begin{tcolorbox}[colframe=naslate,colback=white,adjusted title={\bfseries Syntactic Element Layer}] +% \cmd{\@nameauth@Parse}: Determine name category, capitalization, punctuation, elements to be used, and pass on to\dots +% \begin{tcolorbox}[colframe=nablue,adjusted title={\sffamily\bfseries Name Display Layer}] +% \cmd{\@nameauth@NonWest}: Consult rules, construct displayed form.\\ +% \cmd{\@nameauth@West}: Consult rules, construct displayed form.\\ +% \cmd{\@nameauth@Form}: ``Magic Eight Ball'' of rules for name forms. Includes checking if a name control sequence exists, checking which is the calling macro, and so on. +% Pass the information to\dots +% \begin{tcolorbox}[colframe=nared,colback=white,adjusted title={\sffamily\bfseries Format Hook Dispatcher}] +% \cmd{\@nameauth@Hook}: Check the name to be printed for a final full stop. Check which naming system we are using. Call a formatting hook to print the name in the text. +% \end{tcolorbox} +% \end{tcolorbox} +% \cmd{\@nameauth@Parse}: Instantiate name control sequence. +% \end{tcolorbox} +% +% The different forms and formats seen on the previous page are a result of all three layers interacting. Sections~\ref{sec:Formatting} and~\ref{sec:AltFormat} (with its subsections) deal mostly with the format hook dispatcher and formatting hooks, but they also interact with the name display layer. Section~\ref{sec:NameDecisions} (with its subsections) deals mostly with the syntactic element and name display layers, but also in some cases with the format hook dispatcher and formatting hooks. The following concepts flow from this layout and affect both form and formatting: +% \begin{itemize} +% \item \textbf{Name first use} +% \begin{itemize} +% \item No name control sequence exists. +% \item A name is printed with its long form (default). +% \item The ``first-use'' formatting hook is used (default). +% \item When the name is printed, a name control sequence is created. +% \end{itemize} +% \item \textbf{Name subsequent use} +% \begin{itemize} +% \item A name control sequence already exists. +% \item A name is printed using a shorter form (default). +% \item The ``subsequent-use'' formatting hook is used (default). +% \end{itemize} +% \end{itemize} +% +% The parser and related macros create name forms and formats only in the text. Macros in name arguments affect both text and index (Section~\ref{sec:AltFormat}).\medskip +% +% \DescribeMacro{\NamesActive} +% Independent ``main-matter'' and ``front-matter'' systems are used to format first and subsequent name uses. +% \DescribeMacro{\NamesInactive} +% \cmd{\NamesInactive} and the \texttt{frontmatter} option enable the front-matter system. \cmd{\NamesActive} +% switches names to the main-matter system. The \texttt{mainmatter} option is the default setting for names. +% \medskip +% +% These\Info{\cmd{\global}} two macros can be used explicitly as a pair or singly within an explicit local scope. Use \cmd{\global} to force a global effect.\medskip +% +% \DescribeMacro{\NamesFormat} +% The main-matter system uses \cmd{\NamesFormat} to post-process first occurrences of names and +% \DescribeMacro{\MainNameHook} +% \cmd{\MainNameHook} for subsequent uses. The front-matter system uses \cmd{\FrontNamesFormat} +% \DescribeMacro{\FrontNamesFormat} +% for first uses and \cmd{\FrontNameHook} for subsequent uses. The \texttt{alwaysformat} +% \DescribeMacro{\FrontNameHook} +% option causes only \cmd{\NamesFormat} and \cmd{\FrontNamesFormat} to be used.\footnote{The names of these macros grew from \cmd{\NamesFormat}, originally the only formatting hook.} +% Section~\ref{sec:NamePatterns} shows how name control sequences are keyed either to the main-matter system or to the front-matter system. +% The two formatting systems are distinct, useful for separate document elements. We color-code them below:\smallskip +% +% \begin{center}\small\vspace{2ex}\PatInfo{\textrm{front-matter}\hfill\break \ShowPattern[Rudolph]{Carnap}!NF\break \ShowPattern[Nicolas]{Malebranche}!NF\break \textrm{main-matter}\hfill\break \ShowPattern[Rudolph]{Carnap}!MN\break \ShowPattern[Nicolas]{Malebranche}!MN}\vspace{-2ex}\MyStretch +% \NamesInactive +% \begin{tabular}{ll}\toprule +% Front-matter system: & \cmd{\NamesInactive}\\\midrule +% \rowcolor{grey}|\Name[Rudolph]{Carnap}| & \Name[Rudolph]{Carnap}\\ +% |\Name[Rudolph]{Carnap}| & \Name[Rudolph]{Carnap}\\ +% \rowcolor{grey}|\Name[Nicolas]{Malebranche}| & \Name[Nicolas]{Malebranche}\\ +% |\Name[Nicolas]{Malebranche}| & \Name[Nicolas]{Malebranche}\\\bottomrule +% \end{tabular}\\[4ex] +% +% \NamesActive +% \begin{tabular}{ll}\toprule +% Main-matter system: & \cmd{\NamesActive}\\\midrule +% \rowcolor{grey}|\Name[Rudolph]{Carnap}| & \Name[Rudolph]{Carnap}\\ +% |\Name[Rudolph]{Carnap}| & \Name[Rudolph]{Carnap}\\ +% \rowcolor{grey}|\Name[Nicolas]{Malebranche}| & \Name[Nicolas]{Malebranche}\\ +% |\Name[Nicolas]{Malebranche}| & \Name[Nicolas]{Malebranche}\\\bottomrule +% \end{tabular} +% \end{center} +% +% We achieved that color coding using the following macros and the \textsf{xcolor} package: +% \begin{quote}\small +% \StartNum +% \begin{verbatim} +%\renewcommand*\FrontNamesFormat[1]{\color{red}\sffamily #1} +%\renewcommand*\FrontNameHook[1]{\color{darkgray}\sffamily #1} +%\renewcommand*\NamesFormat[1]{\color{blue}\sffamily #1} +%\renewcommand*\MainNameHook[1]{\sffamily #1}\end{verbatim} +% \end{quote} +% +% \DescribeMacro{\ForceName} +% We show examples of \cmd{\ForceName} in Sections~\ref{sec:NameControl}, \ref{sec:AKA}, and~\ref{sec:Hooksii}. Use this prefix macro to force ``first use'' formatting for the next \cmd{\Name}, etc.,\Version{3.1} but without changing any name control sequences. Thus: % \begin{quote}\small -% \fbox{\mystrut\ \cmd{\NameClearInfo}\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate} } +% \hphantom{\cmd{\ForceName}}\PatInfo{\ShowPattern[Rudolph]{Carnap}!MN}\cmd{\Name[Rudolph]\{Carnap\}} \Name[Rudolph]{Carnap}\\ +% \cmd{\ForceName}\cmd{\Name[Rudolph]\{Carnap\}} \ForceName\Name[Rudolph]{Carnap} % \end{quote} % -% After using |\NameClearInfo[George]{Washington}|\NameClearInfo[George]{Washington}, the next attempt to query the tag |\NameQueryInfo[George]{Washington}| will produce nothing\NameQueryInfo[George]{Washington}.\footnote{Had any information from a text tag been present, it would have appeared between ``nothing'' and the full stop.} +% Below\Info{\texttt{alwaysformat}} we simulate \texttt{alwaysformat} via package internals: +% \makeatletter\@nameauth@AlwaysFormattrue\makeatother% +% \ForgetName[M.T.]{Cicero}\ForgetName{Elizabeth, I}% +% \begin{itemize} +% \item Front matter: \NamesInactive \Name[Albert]{Einstein}, \Name[Albert]{Einstein}; \Name{Confucius}, \Name{Confucius}.\\ Patterns: \texttt{\ShowPattern[Albert]{Einstein}!NF \ShowPattern{Confucius}!NF} +% \item Main matter: \NamesActive \Name[M.T.]{Cicero}, \Name[M.T.]{Cicero}; \Name{Elizabeth, I}, \Name{Elizabeth, I}.\\ Patterns: \texttt{\ShowPattern[M.T.]{Cicero}!MN \ShowPattern{Elizabeth, I}!MN} +% \end{itemize} +% \makeatletter\@nameauth@AlwaysFormatfalse\makeatother +% \newpage +% +% The name parser\Info{Hook caveats} determines what syntactic name elements exist and how they are constituted. It passes that information to macros that determine the form of non-Western or Western names to be displayed. They in turn call the format hook dispatcher for post-processing, which calls the formatting hooks using the pattern: +% \begin{quote}\small +% \cmd{\bgroup}\meta{Hook}\texttt{\{\#1\}}\cmd{\egroup}. +% \end{quote} +% Thus, one can create hooks that take either no arguments or one argument, e.g.: +% \begin{quote}\small\MyStretch +% \cmd{\renewcommand*}\cmd{\NamesFormat\{}\meta{content}\texttt{\}}\\ +% \cmd{\renewcommand*}\cmd{\NamesFormat[1]\{}\meta{content}\texttt{\}} +% \end{quote} +% A hook that takes one argument can discard it and invoke \cmd{\NameParser} (Page~\pageref{page:Intermediate}). Due to the dispatcher design, both the following achieve the same effect, giving the choice of non-robust and robust forms: +% \begin{quote}\small\MyStretch +% \cmd{\renewcommand*}\cmd{\NamesFormat\{}\cmd{\itshape}\texttt{\}}\\ +% \cmd{\renewcommand*}\cmd{\NamesFormat\{}\cmd{\textit}\texttt{\}} +% \end{quote} +% +% The\Info{Applied to\break footnotes} independent systems of names work with footnotes. Names in the body text, such as \Harnack, normally affect name forms in the footnotes.\footnote{We have \Harnack\ from \cmd{\Harnack} instead of \ForgetThis\Harnack.} +% In footnote \arabic{footnote} \cmd{\MainNameHook} is called instead of \cmd{\NamesFormat} because \Harnack\ already had occurred above. We can use the front-matter system to change that: +% \makeatletter +% \let\@oldfntext\@makefntext +% \long\def\@makefntext#1{\NamesInactive\@oldfntext{#1}\NamesActive} +% \makeatother +% \begin{quote}\small\leavevmode\PatInfo{\ShowPattern[Adolf]{Harnack}!MN\break \ShowPattern[Adolf]{Harnack}!NF}\vspace{-5ex} +% \StartNum +% \begin{verbatim} +%\begingroup +%\makeatletter +%\let\@oldfntext\@makefntext +%\long\def\@makefntext#1{\NamesInactive\@oldfntext{#1}\NamesActive} +%\makeatother\end{verbatim} +% \end{quote} % +% When we create another footnote, we see very different results.\footnote{We have \Harnack\ from \cmd{\Harnack}, then \Harnack.} +% Footnote \arabic{footnote} shows a different result. One can synchronize the two systems with \cmd{\ForgetThis} and \cmd{\SubvertThis} (Section~\ref{sec:NameControl}). Below we revert footnotes with: +% \makeatletter +% \let\@makefntext\@oldfntext +% \makeatother +% \begin{quote}\small +% \ContinueNum +% \begin{verbatim} +% \makeatletter +% \let\@makefntext\@oldfntext +% \makeatother\end{verbatim} +% \end{quote} % \ReturnLink +% \vfill +% +% \begingroup^^A Local format hook redefinition +% \AltFormatActive +% \begin{verse} +% Eyn Chriſten menſch iſt eyn freyer herr / über alle ding /\\ +% \qquad und niemande unterthan.\\ +% Eyn Chriſten menſch iſt eyn dienſtpar knecht aller ding\\ +% \qquad und yderman unterthan.\\[1ex]\hfill---\Luth, \textit{Von der Freiheit eines Christenmenschen} +% \end{verse} +% \newpage +% +% \subsection{Alternate Formatting} +% \label{sec:AltFormat} +% +% \noindent The\Info{In this section, the name patterns do not fit in the margin.} formatting hooks only affect names in the body text. Continental formatting occurs in both the text and in the index. One needs to format those names with macros in the name arguments. +% +% We already saw the use of macros in name arguments for Roman names (page~\pageref{page:Romani}). We did not use alternate formatting there because we knew that we would not use an \meta{SNN}\texttt{,}\meta{Affix} pair; we would not use \cmd{\CapThis}; and we used \cmd{\noexpand} before the macros in the arguments. +% +% In larger contexts, however, these constraints might not hold. The following scenarios, especially where there is segmentation of input, can be problematic: +% \begin{itemize} +% \item Using a comma-delimited required name argument pair as the argument of a robust macro like \cmd{\textsc} will halt \LaTeX\ with errors. The \textsf{nameauth} macros will split that pair, which will break the robust macro:\\[1ex] +% \bgroup\small\MyStretch\begin{tabular}{@{\qquad}ll} +% Bad & \cmd{\Name\{}\cmd{\textsc\{}\meta{SNN}\texttt{,}\meta{Affix}\texttt{\}\}}\\ +% Good & \cmd{\Name\{}\cmd{\textsc\{}\meta{SNN}\texttt{\},}\cmd{\textsc\{}\meta{Affix}\texttt{\}\}}\\ +% \end{tabular}\egroup\\[1ex] +% Not even alternate formatting can fix this issue; one simply must avoid the problem when encoding names. +% \item Using \cmd{\CapThis} with a name whose leading element in any one argument is neither a letter nor an active Unicode character, such as a macro. This may work in normal formatting or it may fail, depending on the macro. Use alternate formatting to have \cmd{\CapThis} activate the alternate capitalization mechanism. +% \item In a name argument, using a macro that contains a conditional statement can cause the macro to expand to different results. When such conditional changes occur, spurious results follow. Use \cmd{\noexpand} in the name arguments to fix this. +% \end{itemize} +% +% \subsubsection{Basic Features} +% \label{sec:AltBasic} +% +% What we call ``basic'' alternate formatting is meant to be a temporary stop on the road to ``advanced'' usage, which is more robust. For reasons shown above, it is quite helpful to use \cmd{\noexpand} before macros in name arguments: +% +% \begin{center}\small\MyStretch +% \begin{tabular}{ll} +% |\Name[Martin]{\textSC{Luther}}| & {\color{nared}|%| \textit{basic; good}}\\ +% |\Name[Martin]{\noexpand\textSC{Luther}}| & {\color{nared}|%| \textit{advanced; better}}\\ +% \end{tabular} +% \end{center} +% +% The reason why the basic features work is because the built-in formatting macros discussed below have their effects set when alternate formatting is enabled. If one does not use the macros in names apart from alternate formatting and one does not change the Boolean flags that govern them, the basic features may suffice. +% +% \begin{center}\bfseries Enabling and Disabling\end{center} +% The first thing we need to know is how to enable and disable alternate formatting. The macros that accomplish this are global in scope and cannot be isolated in a local scope. Normally, they are used in pairs, except with the \texttt{altformat} option. +% +% At the start of this section we used \cmd{\AltFormatActive} to enable alternate formatting and activate the formatting macros (see below). At the end of this section we must use \cmd{\AltFormatInactive} to deactivate and disable them.\medskip +% +% \DescribeMacro{\AltFormatActive} +% Both the \texttt{altformat} option and \cmd{\AltFormatActive} enable and activate alternate formatting. Both cause \cmd{\CapThis} to work via \cmd{\AltCaps} instead of the normal way. \cmd{\AltFormatActive} countermands \cmd{\AltFormatActive*}. +% \begin{itemize} +% \item \emph{Enabled} means that the alternate formatting mechanism inhibits the normal behavior of \cmd{\CapThis}. +% \item \emph{Disabled} means that the normal behavior of \cmd{\CapThis} is again in force and alternate formatting is inhibited. +% \item \emph{Activated} means that \cmd{\textSC} and other alternate formatting macros below format their arguments. +% \item \emph{Deactivated} means that \cmd{\textSC} and other macros below do not format their arguments. +% \end{itemize} +% +% \DescribeMacro{\AltFormatActive*} +% The starred form \cmd{\AltFormatActive*} enables alternate formatting but deactivates the special formatting macros, preventing them from changing their arguments. It countermands both the \texttt{altformat} option and \cmd{\AltFormatActive}. It causes \cmd{\CapThis} only to work via \cmd{\AltCaps}.\medskip +% +% \DescribeMacro{\AltFormatInactive} +% This macro both disables and deactivates alternate formatting. This reverts globally to standard formatting and the normal function of \cmd{\CapThis}. +% +% \begin{center}\MyStretch +% \begin{tabular}{lcc}\toprule +% Macro & Enabled & Activated\\\midrule +% \cmd{\AltFormatActive} & \YES & \YES\\ +% \cmd{\AltFormatActive*} & \YES & \NO\\ +% \cmd{\AltFormatInactive} & \NO & \NO\\\bottomrule +% \end{tabular} +% \end{center}\leavevmode +% +% \begin{tcolorbox}[colback=white,colframe=nared] +% \centering All three macros \emph{always} make global changes.\\ This differs from other macros in \textsf{nameauth}. +% \end{tcolorbox}\smallskip +% +% \begin{center}\bfseries Basic Alternate Formatting\end{center} +% \DescribeMacro{\textSC} +% Continental formatting can be as simple as using the short macro \cmd{\textSC}. Three other macros also implement alternate formatting. +% \DescribeMacro{\textIT} +% These macros make changes only when alternate formatting is active. +% \DescribeMacro{\textBF} +% We sort the index entry with \cmd{\PretagName} (Section~\ref{sec:IndexSort}): +% \DescribeMacro{\textUC} +% \begin{quote}\small +% \StartNum +% \begin{verbatim} +%\PretagName[Greta]{\textSC{Garbo}}{Garbo, Greta} +%\PretagName[Ada]{\textIT{Lovelace}}{Lovelace, Ada} +%\PretagName[Charles]{\textBF{Babbage}}{Babbage, Charles} +%\PretagName{\textUC{Tokugawa}, Ieyasu}{Tokugawa Ieyasu}\end{verbatim} +% +% \smallskip\MyStretch +% |\Name[Greta]{\textSC{Garbo}}|\dotfill \Name[Greta]{\textSC{Garbo}}; \Name[Greta]{\textSC{Garbo}}\\ +% |\Name[Ada]{\textIT{Lovelace}}|\dotfill \Name[Ada]{\textIT{Lovelace}}; \Name[Ada]{\textIT{Lovelace}}\\ +% |\Name[Charles]{\textBF{Babbage}}|\dotfill \Name[Charles]{\textBF{Babbage}}; \Name[Charles]{\textBF{Babbage}}\\ +% |\Name{\textUC{Tokugawa}, Ieyasu}|\dotfill \Name{\textUC{Tokugawa}, Ieyasu}; \Name{\textUC{Tokugawa}, Ieyasu} +% \end{quote} +% +% Font substitutions might occur with these macros.\footnote{Since we switch to Latin Modern Sans in the formatting hooks, the switch to small caps forces a substitution to Latin Modern Roman. This action varies with the font being used.} +% They \emph{always format their arguments} when using the \texttt{altformat} option or after \cmd{\AltFormatActive}. Likewise, they \emph{never format their arguments} when \cmd{\AltFormatActive*} is used. Still, \cmd{\CapName}, \cmd{\RevComma}, and \cmd{\RevName} can modify the effects of alternate formatting, but only in the text, not the index: +% +% \begin{center}\small\MyStretch +% \begin{tabular}{rl}\toprule +% |\CapName\Name*[Greta]{\textSC{Garbo}}| & \CapName\Name*[Greta]{\textSC{Garbo}}\\ +% \rowcolor{grey}|\RevComma\Name*[Ada]{\textIT{Lovelace}}| & \RevComma\Name*[Ada]{\textIT{Lovelace}}\\ +% |\RevName\Name*{\textUC{Tokugawa}, Ieyasu}| & \RevName\Name*{\textUC{Tokugawa}, Ieyasu}\\\bottomrule +% \end{tabular} +% \end{center} +% +% Here is a more practical example on how to format the required argument \marg{SNN\texttt{,\,}Affix} as two separate arguments: +% \begin{quote}\small +% \StartNum +% \begin{verbatim} +%\PretagName[J.D.]{\textSC{Rockefeller},\textSC{III}} +% {Rockefeller, John D 3} +%\PretagName{\textUC{Fukuyama}, Takeshi}{Fukuyama Takeshi} +%\begin{nameauth} +% \< JRIII & J.D. & \textSC{Rockefeller},\textSC{III} & > +% \< Fukuyama & & \textUC{Fukuyama}, Takeshi & > +%\end{nameauth}\end{verbatim} +% \end{quote} +% +% From above we get \JRIII, then \JRIII. This works also for non-Western names. Applying the macros above, we get: +% \begin{center}\small\MyStretch +% \begin{tabular}{rl}\toprule +% \rowcolor{grey}|\Fukuyama| & \Fukuyama \\ +% |\Fukuyama| & \Fukuyama \\\bottomrule +% \end{tabular} +% \end{center} +% +% Only the new syntax allows one to use alternate names in the text. For example, ``|\LFukuyama[Sensei]| \LFukuyama[Sensei] wrote \textit{Nihon Fukuin R\=uteru Ky\=okai Shi} in 1954, after studying in the US in the 1930s''.\smallskip +% +% \begin{tcolorbox}[colback=white,colframe=nared] +% \centering Using names designed for alternate formatting also with regular formatting will produce inconsistent formatting and spurious index entries. +% \end{tcolorbox}\leavevmode +% +% \begin{center}\bfseries Example Reference Work\end{center} +% \phantomsection +% \label{page:ContinentalXref} +% This example uses basic Continental formatting. We build on our knowledge so far to construct head-words and articles. Below we use alternate formatting, sort index entries, set up a cross-reference, and define an article macro: +% \AltFormatActive +%\newcommand{\RefArticle}[3]{^^A +% \def\check{#2}^^A +% \ifx\check\empty +% \noindent\ForgetThis#1\ #3 +% \else +% \noindent\ForgetThis#1\ #2\ #3 +% \fi +%} +% \begin{quote}\small +% \StartNum +% \begin{verbatim} +%\PretagName[Greta]{\textSC{Garbo}}{Garbo, Greta} +%\PretagName{\textSC{Misora}, Hibari}{Misora Hibari} +%\PretagName[Heinz]{\textSC{Rühmann}}{Ruehmann, Heinz} +%\PretagName[Heinrich Wilhelm]{\textSC{Rühmann}}% +% {Ruehmann, Heinrich Wilhelm} +%\IndexRef[Heinrich Wilhelm]{\textSC{Rühmann}}% +% {\textSC{Rühmann}, Heinz}% +% +%\newcommand{\RefArticle}[3]{% +% \def\check{#2}% +% \ifx\check\empty +% \noindent\ForgetThis#1\ #3 +% \else +% \noindent\ForgetThis#1\ #2\ #3 +% \fi +%}\end{verbatim} +% \end{quote} +% \IndexRef[Heinrich Wilhelm]{\textSC{Rühmann}}{\textSC{Rühmann}, Heinz} +% +% \cmd{\RefArticle} either formats the name from the first argument and appends the third argument, ignoring the the second if it is empty, or it formats the first two arguments and appends the third. We determine what those arguments mean by including specific naming macros. That includes using \cmd{\RevComma} for Western names, but not for Eastern ones. +% \begin{quote}\small +% \ContinueNum +% \begin{verbatim} +%\RefArticle +% {\RevComma\Name[Greta]{\textSC{Garbo}}} +% {} +% {(18 September 1905\,--\,15 April 1990) was a Swedish +% film actress during the 1920s and 1930s.} +% +%\RefArticle +% {\Name{\textSC{Misora}, Hibari}} +% {} +% {(W: ``\RevName\Name*{\textSC{Misora}, Hibari}''; +% 29 May 1937\,--\,24 June 1989) was a Japanese singer +% and actress noted for her positive message.} +% +%\RefArticle +% {\RevComma\Name[Heinrich Wilhelm]{\textSC{Rühmann}}} +% {``\SubvertThis\ForceName\FName[Heinz]{\textSC{Rühmann}}''} +% {(7 March 1902\,--\,3 October 1994) was a German actor +% in over 100 films.} +%\AltFormatInactive\end{verbatim} +% \end{quote} +% +% \begin{quote}\small +%\RefArticle +% {\RevComma\Name[Greta]{\textSC{Garbo}}} +% {} +% {(18 September 1905\,--\,15 April 1990) was a Swedish +% film actress during the 1920s and 1930s.} +% +%\RefArticle +% {\Name{\textSC{Misora}, Hibari}} +% {}% +% {(W: ``\RevName\Name*{\textSC{Misora}, Hibari}''; +% 29 May 1937\,--\,24 June 1989) was a Japanese singer +% and actress noted for her positive message.} +% +%\RefArticle +% {\RevComma\Name[Heinrich Wilhelm]{\textSC{Rühmann}}} +% {``\SubvertThis\ForceName\FName[Heinz]{\textSC{Rühmann}}''} +% {(7 March 1902\,--\,3 October 1994) was a German actor +% in over 100 films.} +% \end{quote} +% +% \subsubsection[Advanced Features]{Advanced Formatting Features} +% \label{sec:AltAdvanced} +% +% Advanced features involve a dance of sorts between the name argument macros and the formatting hooks. We are moving from immutability to changeability. Yet so far, we have heard that this could change conditional statements and create spurious index entries. +% +% Using \cmd{\noexpand} befor macros in name arguments that expand conditionally will solve this problem for us: +% \begin{itemize} +% \item The use of \cmd{\noexpand} isolates the global state of \cmd{\textSC} and the other formatting macros from local changes in the formatting hooks. +% \item Indexing never occurs within the formatting hooks. +% \item Special triggering macros in the formatting hooks isolate local changes. +% \end{itemize} +% +% As a result of these points, advanced alternate formatting works as expected. It uses a similar approach as did the Boolean flags for Roman names (page~\pageref{page:Romani}). +% \smallskip +% +% \begin{tcolorbox}[colback=white,colframe=nared] +% \centering Using \cmd{\noexpand} is key to consistent index entries. +% \end{tcolorbox}\smallskip +% \newpage +% +% \begin{center}\bfseries Alternate Capitalization\end{center} +% When alternate formatting is enabled, \cmd{\CapThis}\DescribeMacro{\AltCaps}\ causes \cmd{\AltCaps} to format its argument only in a formatting hook. It is enabled whenever alternate formatting is enabled, but it works independently of \cmd{\AltOn} and \cmd{\AltOff} below: +% \begin{quote} +% \fbox{ +% \begin{tabular}{l} +% {\Large\strut}\cmd{\noexpand}\cmd{\AltCaps}\marg{Arg}\\ +% \end{tabular} +% } +% \end{quote} +% +% We introduce this macro with a silly example, disabling indexing in the process: +% \IndexInactive +% \begin{quote}\small +% \StartNum +% \begin{verbatim} +%\IndexInactive +%What's in \Name[\noexpand\AltCaps{a}]{Name}? +%\CapThis\Name*[\noexpand\AltCaps{a}]{Name} smells not, +%but a rose does, even if it has a +%\Name[\noexpand\AltCaps{a}]{Name}.\end{verbatim} +% +% What's in \Name[\noexpand\AltCaps{a}]{Name}? +% \CapThis\Name*[\noexpand\AltCaps{a}]{Name} smells not, +% but a rose does, even if it has a +% \Name[\noexpand\AltCaps{a}]{Name}. +% \end{quote} +% +% \begin{center}\bfseries Advanced Alternate Formatting\end{center} +% Advanced features come with ``some assembly required''. An author must put one of the trigger macros below into one or more of the \textsf{nameauth} formatting hooks. These macros change the state of the formatting macros.\medskip +% +% Vaguely reminiscent of\DescribeMacro{\AltOff}\ an automobile's manual clutch and gearbox, \cmd{\AltOff} deactivates \cmd{\textSC}, \cmd{\textBF}, \cmd{\textIT}, and \cmd{\textUC} only in a formatting hook.\medskip +% +% Likewise, \cmd{\AltOn}\DescribeMacro{\AltOn}\ activates \cmd{\textSC}, \cmd{\textBF}, \cmd{\textIT}, and \cmd{\textUC} only in a formatting hook.\medskip +% +% Continuing the example (indexing suppressed), we redefine \cmd{\MainNameHook} to suppress small caps. Note the copious use of \cmd{\noexpand}: +% \renewcommand*\MainNameHook{\sffamily\AltOff} +% \begin{quote}\small +% \ContinueNum +% \begin{verbatim} +%\renewcommand*\MainNameHook% +% {\sffamily\AltOff}% we match the manual +% +%\CapThis\Name +% [\noexpand\textSC{\noexpand\AltCaps{a} Name}] +% {\noexpand\textSC{Problem}} +%will not become a \Name +% [\noexpand\textSC{\noexpand\AltCaps{a} Name}] +% {\noexpand\textSC{Problem}}, +%even if it smells like a rose. +%\IndexActive\end{verbatim} +% +%\CapThis\Name +% [\noexpand\textSC{\noexpand\AltCaps{a} Name}] +% {\noexpand\textSC{Problem}} +%will not become a \Name +% [\noexpand\textSC{\noexpand\AltCaps{a} Name}] +% {\noexpand\textSC{Problem}}, +%even if it smells like a rose. +% \end{quote} +% \IndexActive +% +% Now indexing is active again. Using the same \cmd{\MainNameHook} defined above, consider the following in a document preamble: +% \begin{quote}\small +% \StartNum +% \begin{verbatim} +%\begin{nameauth} +% \< Luth & Martin & \noexpand\textSC{Luther} & > +% \< Cath & Catherine \noexpand\AltCaps{d}e' +% & \noexpand\textSC{Medici} & > +%\end{nameauth} +%\PretagName[Martin]{\noexpand\textSC{Luther}}{Luther, Martin} +%\PretagName[Catherine \noexpand\AltCaps{d}e'] +% {\noexpand\textSC{Medici}}{Medici, Catherine de}\end{verbatim} +% \end{quote} +% +% In the body text, we see \cmd{\ForgetThis}\cmd{\Luth} \ForgetThis\Luth\ and \cmd{\Luth} \Luth. Likewise \cmd{\Cath} \Cath, then \cmd{\Cath} \Cath. Medieval Italian differs from modern Italian with respect to particles. To get \LCath[\noexpand\AltCaps{d}e'] in the text, use |\LCath[\noexpand\AltCaps{d}e']|, with which \cmd{\CapThis} also works. The index entry should be ``\ShowIdxPageref*[Catherine \noexpand\AltCaps{d}e']{\noexpand\textSC{Medici}}\,'', instead of ``\ShowIdxPageref*[Catherine]{de'~\textSC{Medici}}''.\medskip +% +% \phantomsection +% \label{page:Inflections} +% We\Info{Name inflections} can design grammatical inflections either with or without alternate formatting. \cmd{\DoGentrue} occurs only in the formatting hook, keeping the index entries consistent via \cmd{\noexpand}. Highly inflected languages require two Boolean flags per case and nested conditional statements.\footnote{We hide the same information that we did on page~\pageref{page:Sobriquets}. A copy of this example is in \texttt{examples.tex}, located with this manual.} In the example below we do not use the formatting in this manual and we hide the special tags used herein. In the preamble of a document we would have: +% +% \begin{quote}\small +% \StartNum +% \begin{verbatim} +%\newif\ifGenitive +%\newif\ifDoGen +%\newcommand*\JEFF{\ifDoGen\textSC{Jefferson's}\else +% \textSC{Jefferson}\fi} +%\begin{nameauth} +% \< Jeff & Thomas & \noexpand\JEFF & > +%\end{nameauth} +%\PretagName[Thomas]{\noexpand\JEFF}{Jefferson, Thomas} +%\TagName[Thomas]{\noexpand\JEFF}{, pres.}\end{verbatim} +% \end{quote} +% +% In the preamble or document text, we can have: +% \renewcommand*\NamesFormat[1]{\ifGenitive\DoGentrue\fi#1\global\Genitivefalse} +% \renewcommand*\MainNameHook[1]{\ifGenitive\DoGentrue\fi\AltOff#1\global\Genitivefalse} +% \begin{quote}\small +% \ContinueNum +% \begin{verbatim} +%\renewcommand*\NamesFormat[1] +% {\ifGenitive\DoGentrue\fi#1\global\Genitivefalse} +%\renewcommand*\MainNameHook[1] +% {\ifGenitive\DoGentrue\fi\AltOff#1\global\Genitivefalse} +% +%Consider \Genitivetrue\Jeff\ legacy. More on \Jeff\ later. +%\Genitivetrue\Jeff\ reputation has declined in recent decades.\end{verbatim} +% +% \smallskip +% Consider \Genitivetrue\Jeff\ legacy. More on \Jeff\ later. +% \Genitivetrue\Jeff\ reputation has declined in recent decades. +% \end{quote} +% +% Now we end the scope, resume normal formatting, and do not use the names in this section outside of it.\footnote{In a \texttt{dtx} file it is best to put the \texttt{nameauth} environment, \cmd{\PretagName}, and \cmd{\TagName} macros in the driver section, especially when names contain macros.} +% \AltFormatInactive +% \endgroup^^A Local format hook redefinition +% +% \ReturnLink +% \vfill +% +% \noindent Perhaps one can use the \textsf{nameauth package}\dots +% \begin{verse} +% There in the ring where name and image meet\\[1ex]\hfill---\Name[W.H.]{Auden}, ``Perhaps'' +% \end{verse} % \newpage % % \subsection{Name Decisions} % \label{sec:NameDecisions} % -% The macros in this section force and detect name states. Below we keep names consistent with \textsf{beamer} overlays using some of the macros explained in this section. Otherwise, name forms will change as one advances the slides:\footnote{A copy of this example is in \texttt{examples.tex}, collocated with this manual.} +% The macros in this section force and detect name states. Below we keep names consistent with \textsf{beamer} overlays using some of the macros explained in this section. Otherwise, name forms will change as one advances the slides:\footnote{A copy of this example is in \texttt{examples.tex}, located with this manual.} % \begin{quote}\small % \StartNum % \begin{verbatim} @@ -3396,8 +3911,7 @@ the README.txt or README for more information. % \begin{itemize}\footnotesize % \item<1-> Original\ForgetName[George]{Washington}% % \ForgetName[George]{Washington's}\\ -% \Name[Martin]{Van Buren} changes -% after the first overlay. +% This version of \Name[Ulysses S.]{Grant} changes. % \begin{enumerate} % \item<2-> \IfMainName[George]{Washington's}{He}% % {\Name[George]{Washington}} @@ -3411,7 +3925,7 @@ the README.txt or README for more information. % \end{enumerate} % \item<1-> Reordered\ForgetName[George]{Washington}% % \ForgetName[George]{Washington's}\\ -% \ForgetThis\Name[Ulysses S.]{Grant} +% This version of \ForgetThis\Name[Ulysses S.]{Grant} % does not change. % \begin{enumerate} % \item<3-> \IfMainName[George]{Washington}{His}% @@ -3429,7 +3943,6 @@ the README.txt or README for more information. % %\end{document}\end{verbatim} %\IndexName[George]{Washington} -%\IndexName[Martin]{Van Buren} %\IndexName[Ulysses S.]{Grant} % \end{quote} % @@ -3438,50 +3951,111 @@ the README.txt or README for more information. % \subsubsection{Making Decisions} % \label{sec:NameControl} % -% By\Info{Naming system\break behavior} default, the macros below produce global effects. They change both the \texttt{!MN} and \texttt{!NF} data sets (Section~\ref{sec:NamePatterns}). With \cmd{\ForceName} (Section~\ref{sec:Formatting}), they change formatting. Apart from \cmd{\ForceName}, they also change long or short name forms and the outcome of the testing macros in the next section: -% -% \begin{center}\small\MyStretch -% \begin{tabular}{lccc}\toprule -% \bfseries Defaults & \bfseries Name Length & \bfseries Format Hooks & \bfseries Test Path\\\midrule -% \bfseries Pre-First Use & Long & First & False\\ -% \rowcolor{black!7!white}\bfseries Subsequent Use\quad\hbox{} & Long or short & Subsequent & True\\\bottomrule -% \end{tabular}\medskip\\ +% By default, the macros below produce global effects. They change both the \texttt{!MN} and \texttt{!NF} data sets (Section~\ref{sec:NamePatterns}). With \cmd{\ForceName} (Section~\ref{sec:Formatting}), they change formatting. Apart from \cmd{\ForceName}, they also change long or short name forms and the outcome of both indexing error protection (Section~\ref{sec:GeneralIndex}) and the name testing macros (Section~\ref{sec:NameTests}).\medskip % -% \begin{tabular}{lll}\toprule -% \bfseries Modifications & \bfseries Form & \bfseries Function\\\midrule -% \hfill|\SubvertThis\LAnth| & \SubvertThis\LAnth & force subsequent use \hbox to 3.02em{\hfill}\\ -% & & force long form\\ -% \rowcolor{black!7!white} |\ForceName\SAnth| & \ForceName\SAnth & default subsequent use\\ -% \rowcolor{black!7!white} & & force first-use format\\ -% |\ForgetThis\SAnth| & \ForgetThis\SAnth & force first use; default long\\ -% & & default first-use format\\ -% \rowcolor{black!7!white}|\SAnth| & \SAnth & default subsequent use\\ -% \rowcolor{black!7!white} & & default short form\\\bottomrule -% \end{tabular} -% \end{center} -% % \DescribeMacro{\ForgetName} -% This macro takes the same arguments as \cmd{\Name}. It ``forgets'' a name, forcing a ``pre-first use'' state that will trigger a first-time name use: +% This macro takes the same arguments as \cmd{\Name}, but it prints no output. It ``forgets'' a name, forcing a ``pre-first use'' state that will trigger a first-time name use the next time a naming macro makes reference to the name: % \begin{quote} -% \fbox{\mystrut\ \cmd{\ForgetName}\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate}\ } +% \fbox{ +% \begin{tabular}{l} +% {\Large\strut}\cmd{\ForgetName}\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate}\\ +% \end{tabular} +% } % \end{quote} -% -% \DescribeMacro{\ForgetThis} -% This prefix macro causes the next instance of a naming macro or shorthand to ``forget'' a name before printing it.\Version{3.1} After knowing |\Einstein| ``\Einstein'' we forget him and again have a first reference: |\ForgetThis\Einstein| ``\ForgetThis\Einstein.''\medskip +% This macro ``unprotects'' names like \cmd{\IncludeName*} ``unprotects'' cross-references, allowing one to make a \textit{see} reference to a name, even if that name already has index page references. If one is using a single name index, that could be an error. If one is using multiple indexes for names, however, that could be necessary.\medskip % % \DescribeMacro{\SubvertName} -% This macro takes the same arguments as \cmd{\Name}. It ``subverts'' a name, creating a name pattern control sequence and forcing a ``subsequent use'' case: -% \begin{quote}\small -% \fbox{\mystrut\ \cmd{\SubvertName}\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate}\ } +% This macro takes the same arguments as \cmd{\Name}, but it produces no output in the text. It ``subverts'' a name by creating a name pattern control sequence, forcing a ``subsequent use'', and ``protecting'' a name from being used as a \textit{see} reference (similar to \cmd{\ExcludeName} and cross-references): +% \begin{quote} +% \fbox{ +% \begin{tabular}{l} +% {\Large\strut}\cmd{\SubvertName}\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate}\\ +% \end{tabular} +% } % \end{quote} % +% \DescribeMacro{\ForgetThis} +% This prefix macro causes the next instance of a naming macro or shorthand to ``forget'' a name before printing it.\Version{3.1} After knowing |\Einstein| ``\Einstein'' we forget him and again have a first reference: |\ForgetThis\Einstein| ``\ForgetThis\Einstein''.\medskip +% +% This\Warn{} macro does not affect the index unless one uses \cmd{\ForgetThis} in a situation where a naming macro produces no output in the text. That results in the same outcome as a careless use of \cmd{\ForgetName}: +% \begin{center}\small\MyStretch +% \begin{tabular}{c@{\ \ }p{0.43\textwidth}@{\ }p{0.22\textwidth}}\toprule +% Page & Macro & Index Result\\\midrule +% \rowcolor{grey}^^A +% 10 & \cmd{\ForgetThis}\cmd{\JustIndex}\cmd{\Einstein} & Einstein, Albert, 10\\ +% 12 & \cmd{\IndexRef[Albert]\{Einstein\}\%} & \\ +% & \texttt{\{Smart Dude\}}\dotfill \hbox{} & Einstein, Albert, 10, \textit{see} Smart Dude\\\bottomrule +% \end{tabular} +% \end{center} +% +% % \DescribeMacro{\SubvertThis} -% This prefix macro causes the next instance of a naming macro or shorthand to ``subvert'' a name before printing it.\Version{3.1} As in the table on page~\pageref{page:Priorities}, \cmd{\ForgetThis} has a higher priority than \cmd{\SubvertThis} and nullifies it when used together.\medskip +% This prefix macro causes the next instance of a naming macro or shorthand to ``subvert'' a name before printing it.\Version{3.1} As indicated in the table on page~\pageref{page:Priorities}, \cmd{\ForgetThis} has a higher priority than \cmd{\SubvertThis} and negates it. The caveat regarding naming macro output applies to both \cmd{\SubvertThis} and \cmd{\ForgetThis}. +% \vfil +% +% \begin{tcolorbox}[colback=white,colframe=nared] +% \centering We advise one to avoid using \cmd{\ForgetThis} and \cmd{\SubvertThis}\\ before any naming macro that produces no output in the text. +% \end{tcolorbox}\medskip +% \newpage +% +% \begin{center}\bfseries Name Decision and Formatting Summary\end{center} +% \phantomsection +% +% \begin{itemize}\small +% \item[First Use:] \cmd{\Bailey} \dotfill \ForgetThis\Bailey\\ +% Name control sequence (cseq) undefined, then created with text output. Index \textit{see} protection set. +% Default name form (long). Default first-use format hooks. +% +% \item[Later Use:] \cmd{\Bailey} \dotfill \Bailey\\ +% No change to extant name cseq. No change to index \textit{see} protection. +% Default name form (short). Default later-use format hooks. +% +% \item[Forgotten:] \cmd{\ForgetName[Betsey]\{Bailey\}} \dotfill (no output)\ForgetName[Betsey]{Bailey}\\ +% \emph{Name cseq deleted. Index \textit{see} protection removed. Force first use.} +% Next use of \cmd{\Bailey} will be a first use. +% +% \item[Subverted:] \cmd{\SubvertName[Betsey]\{Bailey\}} \dotfill (no output)\SubvertName[Betsey]{Bailey}\\ +% \emph{Name cseq created. Index \textit{see} protection set. Force later use.} +% Next use of \cmd{\Bailey} will be a later use. +% +% \item[\cmd{\ForgetThis}:] \cmd{\ForgetThis}\cmd{\Bailey} \dotfill \ForgetThis\Bailey\\ +% \emph{Name cseq deleted, then created. Index \textit{see} protection removed, then set. Force first use.} Default form (long). Default first-use format hooks. Next use of \cmd{\Bailey} will be a later use if output occurs. +% +% \item[\cmd{\SubvertThis}:] \cmd{\SubvertThis}\cmd{\Bailey} \dotfill \SubvertThis\Bailey\\ +% \emph{Name cseq created if undefined. Index \textit{see} protection set. +% Force later use.} Default form (short). Default later-use format hooks. Next use of \cmd{\Bailey} will be a later use if output occurs. +% +% \item[Long Use:] \cmd{\LBailey} \dotfill \LBailey\\ +% No change to extant name cseq. No change to index \textit{see} protection. +% \emph{Force long name form.} No change to format hooks. +% +% \item[``Short'', first:] \cmd{\ForgetThis}\cmd{\SBailey} \dotfill \ForgetThis\SBailey\\ +% \emph{Name cseq deleted, then created}. \emph{Index \textit{see} protection removed, then set}. \emph{First use forces long form.} Default first-use format hooks. +% +% \item[Short, later:] \cmd{\SBailey} \dotfill \SBailey\\ +% No change to extant name cseq. No change to index \textit{see} protection. +% \emph{Force first name or short name.} No change to format hooks. +% +% \item[Forced, later:] \cmd{\ForceName}\cmd{\Bailey} \dotfill \ForceName\Bailey\\ +% No change to extant name cseq. No change to index \textit{see} protection. Default name form. \emph{Force first-use hooks.} +% +% \item[Forced, long:] \cmd{\ForceName}\cmd{\LBailey} \dotfill \ForceName\LBailey\\ +% No change to extant name cseq. No change to index \textit{see} protection. \emph{Force long name form. Force first-use hooks.} +% +% \item[Forced, short:] \cmd{\ForceName}\cmd{\SBailey} \dotfill \ForceName\SBailey\\ +% No change to extant name cseq. No change to index \textit{see} protection. +% \emph{Force first name or short name if subsequent use. Force first-use hooks.} +% \end{itemize} +% \medskip % % \DescribeMacro{\LocalNames} -% \cmd{\LocalNames} restricts the effects of the macros above to the current naming system. +% By default, \cmd{\ForgetName}, \cmd{\SubvertName}, \cmd{\ForgetThis}, and \cmd{\SubvertThis} are not limited either by scope or by the active naming system. % \DescribeMacro{\GlobalNames} -% \cmd{\GlobalNames} restores the default behavior. We define a macro that reports whether a name exists in the main matter, front matter, both, or none: +% \cmd{\LocalNames} restricts the effects of these macros to the current naming system, but not to scope. \cmd{\GlobalNames} restores the default behavior that affects both systems. Both macros always have global scope. +% +% To see how these two macros work, in the following example we define a macro that reports whether or not |\Name[Charlie]{Chaplin}| exists. This macro gives four possible results: the name exists in the main matter, it exists in the front matter, it exists in both systems, or it does not exist (see Section~\ref{sec:NameTests}): +% \newpage +% % \def\CheckChuck{{\bfseries\IfFrontName[Charlie]{Chaplin}% % {\IfMainName[Charlie]{Chaplin}{both}{front}}% % {\IfMainName[Charlie]{Chaplin}{main}{none}}}}% @@ -3492,130 +4066,187 @@ the README.txt or README for more information. % {\IfMainName[Charlie]{Chaplin}{both}{front}}% % {\IfMainName[Charlie]{Chaplin}{main}{none}}}}\end{verbatim} % \end{quote} -% -% We start with no extant name: -% \begin{quote}\small\MyStretch -% |\CheckChuck|\dotfill\CheckChuck\qquad\qquad\qquad\hbox{} +% \noindent +% We start in the ``main-matter'' system with no extant name: +% \begin{quote}\small\MyStretch\ForgetName[Charlie]{Chaplin} +% |\CheckChuck|\dotfill \CheckChuck\qquad\qquad\qquad\hbox{} % \end{quote} -% % We create a name in the ``main matter'': % \begin{quote}\small\MyStretch -% |\Name*[Charlie]{Chaplin}|\dotfill\Name*[Charlie]{Chaplin}\qquad\qquad\qquad\hbox{}\\ -% |\CheckChuck|\dotfill\CheckChuck\qquad\qquad\qquad\hbox{} +% |\Name[Charlie]{Chaplin}|\dotfill \Name[Charlie]{Chaplin}\qquad\qquad\qquad\hbox{}\\ +% |\CheckChuck|\dotfill \CheckChuck\qquad\qquad\qquad\hbox{} % \end{quote} -% -% We switch to the ``front-matter'' and create a name, but since we are using the \texttt{quote} environment, we add \cmd{\global}: +% We switch to the ``front-matter'' system and create a name, but since we are using the \texttt{quote} environment, we add \cmd{\global}: % \begin{quote}\small\MyStretch % |\global\NamesInactive|\global\NamesInactive\\ -% |\Name*[Charlie]{Chaplin}|\dotfill\Name*[Charlie]{Chaplin}\qquad\qquad\qquad\hbox{}\\ -% |\CheckChuck|\dotfill\CheckChuck\qquad\qquad\qquad\hbox{} +% |\Name[Charlie]{Chaplin}|\dotfill \Name[Charlie]{Chaplin}\qquad\qquad\qquad\hbox{}\\ +% |\CheckChuck|\dotfill \CheckChuck\qquad\qquad\qquad\hbox{} % \end{quote} +% We now have two names. Their patterns are: \texttt{\ShowPattern[Charlie]{Chaplin}!MN} for the main matter and \texttt{\ShowPattern[Charlie]{Chaplin}!NF} for the front matter (Section~\ref{sec:NamePatterns}). % -% We now have two names. Their patterns are: -% \begin{quote}\small\MyStretch -% \texttt{\ShowPattern[Charlie]{Chaplin}!MN}\\ -% \texttt{\ShowPattern[Charlie]{Chaplin}!NF} -% \end{quote} -% -% We use \cmd{\Localnames} to make \cmd{\ForgetName} and \cmd{\SubvertName} work with only the front-matter system. Then we ``forget'' the front-matter name: +% We use \cmd{\LocalNames} to make both \cmd{\ForgetName} and \cmd{\SubvertName} work with only the current system. When we ``forget'' the name, the current system is front matter, so we forget the front-matter name: % \begin{quote}\small\MyStretch % |\LocalNames|\LocalNames\\ % |\ForgetName[Charlie]{Chaplin}|\ForgetName[Charlie]{Chaplin}\\ -% |\CheckChuck|\dotfill\CheckChuck\qquad\qquad\qquad\hbox{} +% |\CheckChuck|\dotfill \CheckChuck\qquad\qquad\qquad\hbox{} % \end{quote} -% % Next we ``subvert'' the front-matter name to ``remember'' it again and switch to main matter, again using \cmd{\global} to ignore scoping. % \begin{quote}\small\MyStretch % |\SubvertName[Charlie]{Chaplin}|\SubvertName[Charlie]{Chaplin}\\ % |\global\NamesActive|\global\NamesActive\\ -% |\CheckChuck|\dotfill\CheckChuck\qquad\qquad\qquad\hbox{} +% |\CheckChuck|\dotfill \CheckChuck\qquad\qquad\qquad\hbox{} % \end{quote} -% -% We forget the main-matter name and additionally reset the default behavior so that \cmd{\ForgetName} and \cmd{\SubvertName} work with both systems: +% Now the current system is main matter. We then forget the main-matter name only. Additionally, we use \cmd{\GlobalNames} to reset the default behavior so that \cmd{\ForgetName} and \cmd{\SubvertName} work with both systems again: % \begin{quote}\small\MyStretch % |\ForgetName[Charlie]{Chaplin}|\ForgetName[Charlie]{Chaplin}\\ % |\GlobalNames|\GlobalNames\\ -% |\CheckChuck|\dotfill\CheckChuck\qquad\qquad\qquad\hbox{} +% |\CheckChuck|\dotfill \CheckChuck\qquad\qquad\qquad\hbox{} % \end{quote} -% % Finally, we forget everything. Even though we are in a main-matter section, the front-matter name also goes away: % \begin{quote}\small\MyStretch % |\ForgetName[Charlie]{Chaplin}|\ForgetName[Charlie]{Chaplin}\\ -% |\CheckChuck|\dotfill\CheckChuck\qquad\qquad\qquad\hbox{} +% |\CheckChuck|\dotfill \CheckChuck\qquad\qquad\qquad\hbox{} % \end{quote} -% % \ReturnLink -% +% \newpage +% % \subsubsection{Testing Decisions} % \label{sec:NameTests} % -% The macros in this section test for the presence or absence of a name, then expand based on the result. For example, they can synchronize information between a float and body text by each testing whether a name exists and making decisions about the information accordingly.\medskip +% The macros in this section test for the presence or absence of a name, then expand to a result based on the outcome of the test.\medskip +% +% \DescribeMacro{\GlobalNameTest} +% The default behavior encapsulates the decision paths in a local scope, insulating any changes therein. +% \DescribeMacro{\LocalNameTest} +% If this is not desired, use the \texttt{globaltest} option or \cmd{\GlobalNameTest}. \cmd{\LocalNameTest} will enable it again.\Version{3.5} These commands affect assignment statements in test paths. By default, one must explicitly use \cmd{\global} when desired. See also the example below.\medskip % % \DescribeMacro{\IfMainName} % In order to test whether or not a ``main matter'' name control sequence exists, use this long macro that can accommodate paragraph breaks: -% \begin{quote}\small -% \fbox{\mystrut\ \cmd{\IfMainName}\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate}\marg{yes}\marg{no} } +% \begin{quote} +% \fbox{ +% \begin{tabular}{@{}l@{}} +% {\Large\strut}\cmd{\IfMainName}\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate}\marg{yes}\marg{no}\\ +% \end{tabular} +% } % \end{quote} -% -% For example, because we have not seen the equivalent of |\Name[Bob]{Hope}| or |\SubvertName[Bob]{Hope}|, we try the following test and get: -% \begin{quote}\small\MyStretch -% |\IfMainName[Bob]{Hope}{Bob here!}{No Bob.}|\dotfill \IfMainName[Bob]{Hope}{Bob here!}{No Bob.} +% +% For example we have not encountered |\Name[Bob]{Hope}| yet. Using \cmd{\IndexName} does not affect the tests in this section. We could do the following test that will reflect whether or not the name is present: +% \begin{quote}\small +% \StartNum +% \begin{verbatim} +%I heard someone say: \IfMainName[Bob]{Hope} +% {Bob here!} +% {No Bob here.}\IndexName[Bob]{Hope}\end{verbatim} +% +% I heard someone say: \IfMainName[Bob]{Hope} +% {Bob here!} +% {No Bob.}\IndexName[Bob]{Hope} % \end{quote} % -% Still, we can create an index entry here with \IndexName[Bob]{Hope}|\IndexName[Bob]{Hope}| and it will not affect the test above. Since, however, we have encountered the equivalent of |\Name{Elizabeth,I}| many times in the document, we get the following result: +% Now we test for |\Name{Elizabeth,I}|, a name that has occurred, and we also show the difference between local and global test paths: % \begin{quote}\small -% |\IfMainName{Elizabeth,I}{Bess here!}{No Bess.}|\dotfill\IfMainName{Elizabeth,I}{Bess here!}{No Bess.} +% \StartNum +% \begin{verbatim} +%\GlobalNameTest +%\def\msg{We are unsure about \LEliz} +%\IfMainName{Elizabeth,I} +% {\def\msg{We really do know of \LEliz}} +% {\def\msg{We do not know of \LEliz}} +% \msg\quad (\cmd{\GlobalNameTest}). +% +%\LocalNameTest +%\def\msg{We are unsure about \LEliz} +%\IfMainName{Elizabeth,I} +% {\def\msg{We really do know of \LEliz}} +% {\def\msg{We do not know of \LEliz}} +% \msg\quad (\cmd{\LocalNameTest}).\end{verbatim} +% \smallskip +% +% \GlobalNameTest +% \def\msg{We are unsure about \LEliz} +% \IfMainName{Elizabeth,I} +% {\def\msg{We really do know of \LEliz}} +% {\def\msg{We do not know of \LEliz}} +% \msg\quad (\cmd{\GlobalNameTest}). +% +% \LocalNameTest +% \def\msg{We are unsure about \LEliz} +% \IfMainName{Elizabeth,I} +% {\def\msg{We really do know of \LEliz}} +% {\def\msg{We do not know of \LEliz}} +% \msg\quad (\cmd{\LocalNameTest}). % \end{quote} +% We see that the default keeps local any assignments made in the test paths.\medskip % % \DescribeMacro{\IfFrontName} % In order to test whether or not a ``front matter'' name control sequence exists, use this long macro that can accommodate paragraph breaks. Its syntax is: -% \begin{quote}\small -% \fbox{\mystrut\ \cmd{\IfFrontName}\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate}\marg{yes}\marg{no} } +% \begin{quote} +% \fbox{ +% \begin{tabular}{@{}l@{}} +% {\Large\strut}\cmd{\IfFrontName}\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate}\marg{yes}\marg{no}\\ +% \end{tabular} +% } % \end{quote} -% This macro works like \cmd{\IfMainName}, except using the ``front matter'' name control sequences as the test subject. +% This macro works just like \cmd{\IfMainName}, except using the ``front matter'' name control sequences as the test subject. These testing macros prove their worth especially through combination. For example, on the next page we do a test based on Section~\ref{sec:Formatting}. +% \newpage % % \phantomsection\label{page:Carnap} -% For example, based on Section~\ref{sec:Formatting}, we see that ``\ignorespaces -% \IfFrontName[Rudolph]{Carnap}% -% {\IfMainName[Rudolph]{Carnap}% -% {\Name[Rudolph]{Carnap} is both}% -% {\Name[Rudolph]{Carnap} is only front-matter}}% -% {\IfMainName[Rudolph]{Carnap}% -% {\Name[Rudolph]{Carnap} is only main-matter}% -% {\Name[Rudolph]{Carnap} is not mentioned}}'' a main-matter and front-matter name with the following test: % \begin{quote}\small % \StartNum % \begin{verbatim} -%\IfFrontName[Rudolph]{Carnap}% +%\IfFrontName[Rudolph]{Carnap} %{% -% \IfMainName[Rudolph]{Carnap}% -% {\Name[Rudolph]{Carnap} is both}% -% {\Name[Rudolph]{Carnap} is only front-matter}% +% \IfMainName[Rudolph]{Carnap} +% {\Name[Rudolph]{Carnap} is in both main- and front-matter text.} +% {\Name[Rudolph]{Carnap} is only in front-matter text.} %}% %{% -% \IfMainName[Rudolph]{Carnap}% -% {\Name[Rudolph]{Carnap} is only main-matter}% -% {\Name[Rudolph]{Carnap} is not mentioned}% +% \IfMainName[Rudolph]{Carnap} +% {\Name[Rudolph]{Carnap} is only in main-matter text.} +% {\Name[Rudolph]{Carnap} has not been mentioned.} %}\end{verbatim} +% +% \IfFrontName[Rudolph]{Carnap} +% {% +% \IfMainName[Rudolph]{Carnap} +% {\Name[Rudolph]{Carnap} is in both main- and front-matter text.} +% {\Name[Rudolph]{Carnap} is only in front-matter text.} +% }% +% {% +% \IfMainName[Rudolph]{Carnap} +% {\Name[Rudolph]{Carnap} is only in main-matter text.} +% {\Name[Rudolph]{Carnap} has not been mentioned.} +% } % \end{quote} % % \DescribeMacro{\IfAKA} % This macro tests whether or not a regular or excluded form of cross-reference control sequence exists. The syntax is: -% \begin{quote}\small -% \fbox{\mystrut\ \cmd{\IfAKA}\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate}\marg{y}\marg{n}\marg{excluded} } +% \begin{quote} +% \fbox{ +% \begin{tabular}{@{}l@{}} +% {\Large\strut}^^A +% \cmd{\IfAKA}\oarg{FNN}\marg{SNN|,|Affix}\oarg{Alternate}\marg{y}\marg{n}\marg{excl}\\ +% \end{tabular} +% } % \end{quote} % -% This macro works like \cmd{\IfMainName}, although it has an additional \meta{excluded} branch in order to detect the activity of \cmd{\ExcludeName} (Section~\ref{sec:IndexXref}). -% -% Cross-references are governed by name control sequences ending in \texttt{!PN} (Section~\ref{sec:NamePatterns}). Regular cross-reference control sequences (the \marg{y} path) expand to empty. Excluded control sequences (the \marg{excluded} path) expand to \texttt{!}. +% This macro also works like \cmd{\IfMainName}, except that it has an additional \meta{excl} branch in order to detect the activity of \cmd{\ExcludeName} (Section~\ref{sec:GeneralIndex}). % -%\cmd{\ExcludeName} creates excluded xrefs; \cmd{\IncludeName} destroys them. Regular xrefs are created by \cmd{\IndexRef}, \cmd{\AKA}, \cmd{\AKA*}, and \cmd{\PName}; they are destroyed by \cmd{\IncludeName*}. Here is how we use this logic: -% -% \begin{enumerate} -% \item In the text we refer to former pro-wrestler and Minnesota governor \Name[Jesse]{Ventura}, |\Name[Jesse]{Ventura}|. -% \item We establish his lesser-known legal name as an alias: ``\IndexRef[James]{Janos}{Ventura, Jesse}\Name[James]{Janos},''\\ |\IndexRef[James]{Janos}{Ventura,|\,|Jesse}\Name[James]{Janos}|. +% Cross-references\Version{3.5} are governed by name control sequences ending in \texttt{!PN} (Section~\ref{sec:NamePatterns}). +% \begin{itemize} +% \item Excluded control sequences (the \meta{excl} path) expand to the value of \cmd{\@nameauth@Exclude}. +% \item Regular cross-references (the \meta{y} path) do not expand to that value. At present, they are empty. +% \item \cmd{\ExcludeName} creates excluded xrefs. \cmd{\IncludeName} destroys them. +% \item Regular xrefs are created by \cmd{\IndexRef}, \cmd{\AKA}, \cmd{\PName} and their starred forms. Regular xrefs are destroyed by \cmd{\IncludeName*}. +% \end{itemize} % -% \item We get the result: ``\IfAKA[James]{Janos}{\Name*[Jesse]{Ventura} is a stage name}{\Name*[Jesse]{Ventura} is a regular name}{}.'' If we do not use \cmd{\ExcludeName}, we can leave the \marg{excluded} branch empty: +% Based on the known facts above, here we offer some examples about how to use this logic: +% \begin{enumerate} +% \item In the\PatInfo{\ShowPattern[Jesse]{Ventura}!MN\break \ShowPattern[James]{Janos}!PN\break \ShowPattern[James]{Janos}!MN} text we refer to former pro-wrestler and Minnesota governor \Name[Jesse]{Ventura}, |\Name[Jesse]{Ventura}|. +% \item We establish his lesser-known legal name as an alias: ``\IndexRef[James]{Janos}{Ventura, Jesse}\Name[James]{Janos}'',\\ |\IndexRef[James]{Janos}{Ventura,|\,|Jesse}\Name[James]{Janos}|. +% +% \item We get the result: ``\IfAKA[James]{Janos}{\Name*[Jesse]{Ventura} is a stage name}{\Name*[Jesse]{Ventura} is a regular name}{}''. If we do not use \cmd{\ExcludeName}, we can leave the \meta{excl} branch empty: +% \end{enumerate} % \begin{quote}\small % \StartNum % \begin{verbatim} @@ -3624,16 +4255,19 @@ the README.txt or README for more information. % {\Name*[Jesse]{Ventura} is a regular name}% % {}\end{verbatim} % \end{quote} -% \end{enumerate} % -% Otherwise, based on Section~\ref{sec:IndexXref}, we get: ``\IfAKA{Grinch}{\Name{Grinch} is an alias}{\Name{Grinch} is not an alias}{\Name{Grinch} is excluded}'': -% \begin{quote}\small +% Otherwise, based on Section~\ref{sec:GeneralIndex}, we get: +% ``\IfAKA{Grinch} +% {\Name{Grinch} is an alias} +% {\Name{Grinch} is not an alias} +% {\Name{Grinch} is excluded}'': +% \begin{quote}\small\leavevmode\PatInfo{\ShowPattern{Grinch}!PN}\vspace{-5ex} % \StartNum % \begin{verbatim} -%\IfAKA{Grinch}% +%``\IfAKA{Grinch}% % {\Name{Grinch} is an alias}% % {\Name{Grinch} is not an alias}% -% {\Name{Grinch} is excluded}\end{verbatim} +% {\Name{Grinch} is excluded}''\end{verbatim} % \end{quote} % % We can combine all these macros create a complete test: @@ -3656,39 +4290,47 @@ the README.txt or README for more information. % {excluded path}\end{verbatim} % \end{quote} % -% We can use the text tag macros with the conditional macros to present information that depends on what names have already occurred. One must avoid unbounded recursion that results in a stack overflow (Section~\ref{sec:TextTags}): -% \begin{quote}\small +% If\Info{Sync with floats} one uses names in floats and in the text, the testing macros can synchronize a float with the text. Assume that we want to print a full name for whichever appears first, like \LJWG[Johann Wolfgang von] instead of \LJWG. In both the text and the float we use the following: +% \begin{quote}\small\leavevmode\PatInfo{\ShowPattern[J.W. von]{Goethe}!MN}\vspace{-5ex} +% \StartNum +% \begin{verbatim} +%\IfMainName[J.W. von]{Goethe} +% {\Name*[J.W. von]{Goethe}} +% {\Name*[J.W. von]{Goethe}[Johann Wolfgang von]}\end{verbatim} +% \end{quote} +% +% Text tags can work\Info{Sync with events} with the conditional macros to prevent anachronistic references. This aids working with history texts, game books, and so on. One must avoid unbounded recursion that results in a stack overflow (Section~\ref{sec:TextTags}): +% \begin{quote}\small\leavevmode\PatInfo{\ShowPattern{Paul}!PN\break \ShowPattern{Saul, of Tarsus}!DB\break \ShowPattern{Jesus, Christ}!MN\break \ShowPattern[Lucius]{Sergius Paulus}!MN\break \ShowPattern{Paul}!MN\break \ShowPattern{Saul, of Tarsus}!MN}\vspace{-5ex} % \StartNum % \begin{verbatim} %\IndexRef{Paul}{Saul of Tarsus} -%\NameAddInfo{Saul, of Tarsus}{\IfMainName{Jesus, Christ} +%\NameAddInfo{Saul, of Tarsus} +% {\IfMainName{Jesus, Christ} % {\IfMainName[Lucius]{Sergius Paulus} -% {renames himself \Name{Paul}} +% {renamed himself \Name{Paul}} % {a preacher to the Gentiles}} % {wrote that he persecuted Christians}} +%\Name{Saul, of Tarsus} \NameQueryInfo{Saul, of Tarsus}. +%He saw a vision of \Name{Jesus, Christ} on the road to Damascus. +%\Name{Saul, of Tarsus} became \NameQueryInfo{Saul, of Tarsus}. +%After converting \Name[Lucius]{Sergius Paulus}, +%\Name{Saul, of Tarsus} \NameQueryInfo{Saul, of Tarsus}.\end{verbatim} % -%\Name{Saul, of Tarsus} \NameQueryInfo{Saul, of Tarsus}. He -%saw a vision of \Name{Jesus, Christ} on the road to Damascus -%and became \NameQueryInfo{Saul, of Tarsus}. After converting -%\Name[Lucius]{Sergius Paulus}, \Name{Saul, of Tarsus} -%\NameQueryInfo{Saul, of Tarsus} in honor of that.\end{verbatim} -% -% \smallskip % \IndexRef{Paul}{Saul of Tarsus} -% \NameAddInfo{Saul, of Tarsus}{\IfMainName{Jesus, Christ} -% {\IfMainName[Lucius]{Sergius Paulus} -% {renamed himself \Name{Paul}} -% {a preacher to the Gentiles}} -% {wrote that he persecuted Christians}} -% -% \Name{Saul, of Tarsus} \NameQueryInfo{Saul, of Tarsus}. He -% saw a vision of \Name{Jesus, Christ} on the road to Damascus -% and became \NameQueryInfo{Saul, of Tarsus}. After converting -% \Name[Lucius]{Sergius Paulus}, \Name{Saul, of Tarsus} -% \NameQueryInfo{Saul, of Tarsus} in honor of that. +% \NameAddInfo{Saul, of Tarsus} +% {\IfMainName{Jesus, Christ} +% {\IfMainName[Lucius]{Sergius Paulus} +% {renamed himself \Name{Paul}} +% {a preacher to the Gentiles}} +% {wrote that he persecuted Christians}} +% \Name{Saul, of Tarsus} \NameQueryInfo{Saul, of Tarsus}. +% He saw a vision of \Name{Jesus, Christ} on the road to Damascus. +% \Name{Saul, of Tarsus} became \NameQueryInfo{Saul, of Tarsus}. +% After converting \Name[Lucius]{Sergius Paulus}, +% \Name{Saul, of Tarsus} \NameQueryInfo{Saul, of Tarsus}. % \end{quote} % -% Using these tests inside other macros or passing control sequences to them may create false results (see \textit{The \TeX book}, 212--15). That is why \textsf{nameauth} uses token registers to save name arguments (Section~\ref{sec:Hooksii}. Consider using \cmd{\noexpand} in macros passed as name arguments and see also Section~\ref{sec:Unicode}. Using the \textsf{trace} package, \cmd{\show}, or \cmd{\meaning} can help one mitigate problems. +% Using these tests\Info{Caveats} inside other macros or passing control sequences to them may create false results (see \textit{The \TeX book}, 212--15). That is why \textsf{nameauth} uses token registers to save name arguments (Section~\ref{sec:Hooksii}. Consider using \cmd{\noexpand} in macros passed as name arguments and see also Section~\ref{sec:Unicode}. Using the \textsf{trace} package, \cmd{\show}, or \cmd{\meaning} can help one mitigate problems. % % \ReturnLink % \newpage @@ -3696,166 +4338,161 @@ the README.txt or README for more information. % \subsection{Alternate Name Macros} % \label{sec:AKA} % -% The\Version{3.0} macros in this section predate \cmd{\IndexRef} and have a syntax and behavior recalling early package versions.\footnote{Before version 3.0 the lack of modularity resulted in separate name parsing, name display, and indexing for the naming macros and the alternate name macros. The version 3 series has corrected many early missteps while remaining compatible.} -% Using \cmd{\IndexRef} with \cmd{\Name} can be more flexible (cf. page~\pageref{page:ManualXref}). To save space, we show the syntax of these macros using \meta{SAFX} as the equivalent of \meta{SNN|,| Affix}. Common properties include: +% The\Version{3.0} macros in this section predate \cmd{\IndexRef} and are less flexible than just using \cmd{\IndexRef} with \cmd{\Name} (cf. page~\pageref{page:IdxVariants}). We recommend the macros below only for backward compatibility, or if one likes using them. To save space, we show the syntax of these macros using \meta{SAFX} as the equivalent of \meta{SNN|,| Affix}. % % \begin{itemize} % \item These macros do not create page references. -% \item The target \oarg{FNN}\marg{SAFX} comes before the xref printed in the text: \oarg{xref FNN}\marg{xref SAFX}\oarg{xref Alternate}. -% \item The obsolete syntax cannot be used with \oarg{FNN}\marg{SAFX}. -% \item Only the \meta{SAFX} and \meta{xref SAFX} arguments are able to use comma-delimited suffixes. +% \item Opposite of \cmd{\IndexRef}, the target \oarg{FNN}\marg{SAFX} comes first; then the cross-reference \oarg{xref FNN}\marg{xref SAFX}\oarg{xref Alternate}. +% \item The obsolete syntax cannot be used with \oarg{FNN}\marg{SAFX}; it can be used with \oarg{xref FNN}\marg{xref SAFX}\oarg{xref Alternate}. +% \item Only \meta{SAFX} and \meta{xref SAFX} can have comma-delimited suffixes. % \item One cannot use \cmd{\TagName} with a cross-reference, but one can sort it with \cmd{\PretagName}\oarg{xref FNN}\marg{xref SAFX}\marg{sort tag}. % \end{itemize} % % \DescribeMacro{\AKA} % \cmd{\AKA} (\textit{also known as}) and its starred form display an alias in the text and create a cross-reference in the index. % \DescribeMacro{\AKA*} -% They display and format names differently than the name macros: +% They format names differently than \cmd{\Name}, etc.: % \begin{quote}\small -% \fbox{\vbox{\hbox{\mystrut\ \cmd{\AKA\ }\oarg{FNN}\marg{SAFX}\oarg{xref FNN}\marg{xref SAFX}\oarg{xref Alternate} }\par -% \hbox{\mystrut\ \cmd{\AKA*}\oarg{FNN}\marg{SAFX}\oarg{xref FNN}\marg{xref SAFX}\oarg{xref Alternate} }}} +% \fbox{ +% \begin{tabular}{@{}l@{}} +% {\Large\strut}\cmd{\AKA\ }\oarg{FNN}\marg{SAFX}\oarg{xref FNN}\marg{xref SAFX}\oarg{xref Alternate} \vspace{-2pt}\\ +% {\Large\strut}\cmd{\AKA*}\oarg{FNN}\marg{SAFX}\oarg{xref FNN}\marg{xref SAFX}\oarg{xref Alternate}\\ +% \end{tabular} +% } % \end{quote} % -% Both macros create a cross-reference in the index from the \meta{xref FNN}, \meta{xref SAFX}, and \meta{xref Alternate} arguments to a target defined by \meta{FNN} and \meta{SAFX}, regardless of whether that name exists. The order of the name and cross-reference in \cmd{\AKA} is opposite that of \cmd{\IndexRef}. Otherwise the \meta{xref Alternate} argument would be ambiguous with \meta{FNN}. \cmd{\AKA} prints a long form of the cross-reference name in the text. \cmd{\SeeAlso} works with \cmd{\AKA}, \cmd{\AKA*}, and \cmd{\PName}. -% -% \cmd{\AKA} prints the \meta{xref FNN} and \meta{xref SAFX} arguments in the body text. If \meta{xref Alternate} is present with \meta{xref FNN}, \cmd{\AKA} swaps them in the text. If \meta{xref Alternate} is present without \meta{xref FNN}, the old syntax is triggered, which we do not recommend. The caps and reversing macros work with \cmd{\AKA}. -% -% \cmd{\AKA*}\Version{3.0} prints short name references like \cmd{\FName}, meaning that \cmd{\ForceFN} works with it in the same manner. For the older behavior of \cmd{\AKA*} use the \texttt{oldAKA} option or always precede \cmd{\AKA*} with \cmd{\ForceFN}. +% \begin{itemize} +% \item Both macros create a cross-reference in the index from the \meta{xref FNN}, \meta{xref SAFX}, and \meta{xref Alternate} arguments to a target defined by \meta{FNN} and \meta{SAFX}. +% \item The order of the name and cross-reference in \cmd{\AKA} is opposite that of \cmd{\IndexRef} in order to avoid ambiguity. +% \item \cmd{\AKA} prints a long form of the cross-reference name in the text. \cmd{\SeeAlso} works with \cmd{\AKA}, \cmd{\AKA*}, \cmd{\PName}, and \cmd{\PName*}. +% \item \cmd{\AKA} prints the \meta{xref FNN} and \meta{xref SAFX} arguments in the text. +% \item If \meta{xref Alternate} is present with \meta{xref FNN}, or if \meta{xref Affix} when \meta{xref FNN} is absent, \cmd{\AKA} swaps them only in the text. +% \item If \meta{xref Alternate} is present without \meta{xref FNN} and \meta{xref Affix}, the obsolete syntax is used. +% \item \cmd{\AKA*}\Version{3.0} is analogous to \cmd{\FName} and \cmd{\ForceFN} works with it. The \texttt{oldAKA} option implies \cmd{\ForceFN} with every use of \cmd{\AKA*}. +% \item Neither\Version{3.5} \cmd{\AKA} nor its derivatives permit the effects of \cmd{\ForgetThis} and \cmd{\SubvertThis} to ``pass through'' because they produce output in the text. The \texttt{oldreset} option negates this. +% \end{itemize} % -% We make cross-references to \Name[Bob]{Hope}, where all of the forms below create the cross-reference ``\ShowIdxPageref*[Leslie Townes]{Hope} \textit{see} \ShowIdxPageref*[Bob]{Hope}'': -% \begin{center}\small\MyStretch +% We make cross-references to \Name[Bob]{Hope}; all of the forms below will create the cross-reference ``\ShowIdxPageref*[Leslie Townes]{Hope} \textit{see} \ShowIdxPageref*[Bob]{Hope}'': +% \begin{center}\footnotesize\vspace{2ex}\Info{\strut\footnotesize Name Pattern(s):\hfill \break \ttfamily \ShowPattern[Bob]{Hope}!MN\break \ShowPattern[Leslie Townes]{Hope}!PN}\vspace{-2ex}\MyStretch % \begin{tabular}{p{0.6\textwidth}l}\toprule -% \footnotesize|\AKA[Bob]{Hope}[Leslie Townes]{Hope}| & \AKA[Bob]{Hope}[Leslie Townes]{Hope}\\ -% \rowcolor{black!7!white}\footnotesize|\RevComma\AKA[Bob]{Hope}[Leslie Townes]{Hope}| & \RevComma\AKA[Bob]{Hope}[Leslie Townes]{Hope}\\ -% \footnotesize|\AKA[Bob]{Hope}[Leslie Townes]{Hope}[Lester T.]| & \AKA[Bob]{Hope}[Leslie Townes]{Hope}[Lester T.]\\ -% \rowcolor{black!7!white}\footnotesize|\AKA*[Bob]{Hope}[Leslie Townes]{Hope}| & \AKA*[Bob]{Hope}[Leslie Townes]{Hope}\\ -% \footnotesize|\AKA*[Bob]{Hope}[Leslie Townes]{Hope}[Lester]| & \AKA*[Bob]{Hope}[Leslie Townes]{Hope}[Lester]\\\bottomrule +% |\AKA[Bob]{Hope}[Leslie Townes]{Hope}| & \AKA[Bob]{Hope}[Leslie Townes]{Hope}\\ +% \rowcolor{grey}|\RevComma\AKA[Bob]{Hope}[Leslie Townes]{Hope}| & \RevComma\AKA[Bob]{Hope}[Leslie Townes]{Hope}\\ +% |\AKA[Bob]{Hope}[Leslie Townes]{Hope}[Lester T.]| & \AKA[Bob]{Hope}[Leslie Townes]{Hope}[Lester T.]\\ +% \rowcolor{grey}|\AKA*[Bob]{Hope}[Leslie Townes]{Hope}| & \AKA*[Bob]{Hope}[Leslie Townes]{Hope}\\ +% |\AKA*[Bob]{Hope}[Leslie Townes]{Hope}[Lester]| & \AKA*[Bob]{Hope}[Leslie Townes]{Hope}[Lester]\\\bottomrule % \end{tabular} % \end{center} -% \newpage % -% Next we have references to \KeepAffix\Name*{Louis, XIV}, \Name{Lao-tzu}, and \KeepAffix\Name*{Gregory, I}, as well as \Name[Lafcadio]{Hearn} and \Name[Charles]{du Fresne}: -% \begin{center}\small\MyStretch -% \begin{tabular}{p{0.6\textwidth}l}\toprule -% |\AKA{Louis, XIV}{Sun King}| & \AKA{Louis, XIV}{Sun King}\\ -% \rowcolor{black!7!white}|\AKA*{Louis, XIV}{Sun King}| & \AKA{Louis, XIV}{Sun King}\\ +% Next we refer to \KeepAffix\Name*{Louis, XIV}, and \Name{Lao-tzu}, as well as \Name[Lafcadio]{Hearn} and \Name[Charles]{du~Fresne}. The caps and reversing macros work. Even with \cmd{\ForceName}, the formatting hooks do not change. \cmd{\AKA} and its derivatives use only \cmd{\MainNamesHook} and \cmd{\FrontNamesHook}. +% +% \begin{center}\small\vspace{2ex}\PatInfo{\ShowPattern{Louis, XIV}!MN\break \ShowPattern{Lao-tzu}!MN\break \ShowPattern[Lafcadio]{Hearn}!MN\break \ShowPattern[Charles]{du~Fresne}!MN\break \ShowPattern{Sun King}!PN\break \ShowPattern{Li, Er}!PN\break \ShowPattern{du~Cange}!PN\break \ShowPattern{Koizumi, Yakumo}!PN}\vspace{-2ex}\MyStretch +% \begin{tabular}{p{0.65\textwidth}l}\toprule +% \rowcolor{grey}|\AKA{Louis, XIV}{Sun King}| & \AKA{Louis, XIV}{Sun King}\\ +% |\ForceName\AKA{Louis, XIV}{Sun King}| & \ForceName\AKA{Louis, XIV}{Sun King}\\ +% \rowcolor{grey}|\AKA*{Louis, XIV}{Sun King}| & \AKA{Louis, XIV}{Sun King}\\ % |\AKA{Lao-tzu}{Li, Er}| & \AKA{Lao-tzu}{Li, Er}\\ -% \rowcolor{black!7!white}|\AKA*{Lao-tzu}{Li, Er}| & \AKA*{Lao-tzu}{Li, Er}\\ -% |\AKA[Charles]{du Fresne}{du Cange}| & \AKA[Charles]{du Fresne}{du Cange}\\ -% \rowcolor{black!7!white}|\CapThis\AKA[Charles]{du Fresne}{du Cange}| & \CapThis\AKA[Charles]{du Fresne}{du Cange}\\ -% \footnotesize|\CapName\AKA[Lafcadio]{Hearn}{Koizumi, Yakumo}| & \CapName\AKA[Lafcadio]{Hearn}{Koizumi, Yakumo}\\ -% \rowcolor{black!7!white}\footnotesize|\RevName\AKA[Lafcadio]{Hearn}{Koizumi, Yakumo}| & \RevName\AKA[Lafcadio]{Hearn}{Koizumi, Yakumo}\\ -% \footnotesize|\AKA{Gregory, I}{Gregory}[the Great]| & \AKA{Gregory, I}{Gregory}[the Great]\\ -% \rowcolor{black!7!white}\footnotesize|\AKA*{Gregory, I}{Gregory}[the Great]| & \AKA*{Gregory, I}{Gregory}[the Great]\\ -% \footnotesize|\ForceFN\AKA*{Gregory, I}{Gregory}[the Great]| & \ForceFN\AKA*{Gregory, I}{Gregory}[the Great]\\\bottomrule +% \rowcolor{grey}|\AKA*{Lao-tzu}{Li, Er}| & \AKA*{Lao-tzu}{Li, Er}\\ +% |\AKA[Charles]{du~Fresne}{du~Cange}| & \AKA[Charles]{du~Fresne}{du~Cange}\\ +% \rowcolor{grey}|\CapThis\AKA[Charles]{du~Fresne}{du~Cange}| & \CapThis\AKA[Charles]{du~Fresne}{du~Cange}\\ +% |\CapName\AKA[Lafcadio]{Hearn}{Koizumi, Yakumo}| & \CapName\AKA[Lafcadio]{Hearn}{Koizumi, Yakumo}\\ +% \rowcolor{grey}|\RevName\AKA[Lafcadio]{Hearn}{Koizumi, Yakumo}| & \RevName\AKA[Lafcadio]{Hearn}{Koizumi, Yakumo}\\\bottomrule % \end{tabular} % \end{center}\medskip % -% \noindent\cmd{\AKA}\Info{\texttt{formatAKA}} and its derivatives use \cmd{\MainNamesHook} and \cmd{\FrontNamesHook} to print the cross-reference because that helped keep cross-references distinct from names in early package versions. -% -% The \texttt{formatAKA} package option allows first-use formatting of alternate names, but cross-references use their own system for being ``first'' (Section~\ref{sec:NamePatterns}). We simulate \texttt{formatAKA} and use |\AKA{Elizabeth,I}[Good Queen]{Bess}|. The colors indicate which hooks are used. -% \begin{quote}\small\MyStretch -% \makeatletter\@nameauth@AKAFormattrue\makeatother\NamesInactive -% \emph{Front Matter:} \ForgetThis\LEliz\ was known as ``\AKA{Elizabeth,I}[Good Queen]{Bess}.''\\ -% Again we mention Queen \Eliz, ``\AKA{Elizabeth, I}[Good Queen]{Bess}.''\\ -% \cmd{\ForceName}: \ForceName\AKA{Elizabeth, I}[Good Queen]{Bess}. +% In order to format\Info{\texttt{formatAKA}} cross-references like names, either avoid using these older macros or use the \texttt{formatAKA} option. That allows \cmd{\ForceName} to work properly, but cross-references use their own system for being ``first'' (Section~\ref{sec:NamePatterns}). We simulate \texttt{formatAKA} and use |\AKA{Elizabeth,I}[Good Queen]{Bess}|: % -% \NamesActive -% \emph{Main Matter:} \ForgetThis\LEliz\ was known as ``\AKA{Elizabeth,I}[Good Queen]{Bess}.''\\ -% Again we mention Queen \Eliz, ``\AKA{Elizabeth, I}[Good Queen]{Bess}.''\\ -% \cmd{\ForceName}: \ForceName\AKA{Elizabeth, I}[Good Queen]{Bess}. -% \end{quote} +% \begin{center}\small\vspace{2ex}\PatInfo{\ShowPattern{Elizabeth, I}!NF\break \ShowPattern[Good Queen]{Bess}!PN\break \ShowPattern{Elizabeth, I}!MN}\vspace{-2ex}\MyStretch +% \makeatletter\@nameauth@AKAFormattrue\makeatother +% \begin{tabular}{rlll}\toprule +% \global\NamesInactive Front Matter: & \ForgetThis\Eliz & \Eliz & \AKA{Elizabeth,I}[Good Queen]{Bess}\\ +% \rowcolor{grey}\global\NamesActive Main Matter: & \ForgetThis\Eliz & \Eliz & \AKA{Elizabeth, I}[Good Queen]{Bess}\\ +% Using \cmd{\ForceName}: & & & \ForceName\AKA{Elizabeth, I}[Good Queen]{Bess}\\\bottomrule +% \end{tabular} +% \end{center} +% +% The first appearance of \AKA{Elizabeth,I}[Good Queen]{Bess} uses either \cmd{\NamesFormat} or \cmd{\FrontNamesFormat}. After that, only \cmd{\mainNameHook} and \cmd{\FrontNameHook} can be used without \cmd{\ForceName}, which triggers the first-use hooks.\medskip % -% The first appearance of the cross-reference uses the first-use hooks of whatever naming system is active. Thereafter we only use the subsequent-use hooks of both systems unless we use \cmd{\ForceName}.\medskip -% % Below\Info{\texttt{alwaysformat}} we compare the behavior of the \texttt{alwaysformat} option, where all regular names use only \cmd{\NamesFormat} and \cmd{\FrontNamesFormat}: -% -% \begin{quote}\small\MyStretch -% \makeatletter\@nameauth@AlwaysFormattrue\makeatother\NamesInactive -% \emph{Front Matter:} \ForgetThis\LEliz\ was known as ``\AKA{Elizabeth, I}[Good Queen]{Bess}.''\\ -% Again we mention Queen \Eliz, ``\AKA{Elizabeth, I}[Good Queen]{Bess}.''\\ -% \cmd{\ForceName}: \ForceName\AKA{Elizabeth, I}[Good Queen]{Bess}. % -% \NamesActive -% \emph{Main Matter:} \ForgetThis\LEliz\ was known as ``\AKA{Elizabeth, I}[Good Queen]{Bess}.''\\ -% Again we mention Queen \Eliz, ``\AKA{Elizabeth, I}[Good Queen]{Bess}.''\\ -% \cmd{\ForceName}: \ForceName\AKA{Elizabeth, I}[Good Queen]{Bess}. +% \begin{quote}\small\MyStretch +% \makeatletter\@nameauth@AlwaysFormattrue\makeatother +% \ForgetThis\LEliz\ was known as ``\AKA{Elizabeth,I}[Good Queen]{Bess}''. Again we mention Queen \Eliz, ``\AKA{Elizabeth, I}[Good Queen]{Bess}''. Using \cmd{\ForceName}: \ForceName\AKA{Elizabeth, I}[Good Queen]{Bess}. % \end{quote} % % \DescribeMacro{\PName} % These convenience macros (an early feature) print a main name and a cross-reference in parentheses: % \DescribeMacro{\PName*} % \begin{quote}\small -% \fbox{\vbox{\hbox{\mystrut\ \cmd{\PName\ }\oarg{FNN}\marg{SAFX}\oarg{xref\,FNN}\marg{xref\,SAFX}\oarg{xref\,Alternate}\ }\par -% \hbox{\mystrut\ \cmd{\PName*}\oarg{FNN}\marg{SAFX}\oarg{xref\,FNN}\marg{xref\,SAFX}\oarg{xref\,Alternate}\ }}} +% \fbox{ +% \begin{tabular}{@{}l@{}} +% {\Large\strut}\cmd{\PName\ }\oarg{FNN}\marg{SAFX}\oarg{xref\,FNN}\marg{xref\,SAFX}\oarg{xref\,Alternate}\vspace{-2pt}\\ +% {\Large\strut}\cmd{\PName*}\oarg{FNN}\marg{SAFX}\oarg{xref\,FNN}\marg{xref\,SAFX}\oarg{xref\,Alternate}\\ +% \end{tabular} +% } % \end{quote} % The starred form \cmd{\PName*} is like the starred form \cmd{\Name*} to the extent that it prints a long form of \meta{FNN}\meta{SAFX}. It does not affect the cross-reference arguments \meta{xref FNN}\meta{xref SAFX}\meta{xref Alternate}. -% -% Except \cmd{\SkipIndex}, prefix macros only affect \meta{FNN}\meta{SAFX}, not the cross-reference, which always takes a long form. \cmd{\SkipIndex} keeps both names out of the index. \cmd{\PName} cannot use the obsolete syntax for the main name, but it can do so for the alternate name. -% -% \begin{center}\footnotesize\MyStretch -% \begin{tabular}{p{0.45\textwidth}l}\toprule -% \bfseries\small Recommended Macro\,/\,Output & \bfseries\small Index\\\midrule -% |\PName[Mark]{Twain}%|\newline| [Samuel L.]{Clemens}| & \\ -% \PName[Mark]{Twain}[Samuel L.]{Clemens} & \ShowIdxPageref*[Samuel L.]{Clemens} \textit{see} \ShowIdxPageref*[Mark]{Twain}\\ -% \PName[Mark]{Twain}[Samuel L.]{Clemens} & \ShowIdxPageref*[Samuel L.]{Clemens} \textit{see} \ShowIdxPageref*[Mark]{Twain}\\ -% \rowcolor{black!7!white}|\PName*[Mark]{Twain}%|\newline| [Samuel L.]{Clemens}[Sam]| & \\ -% \rowcolor{black!7!white}\PName*[Mark]{Twain}[Samuel L.]{Clemens}[Sam] & \ShowIdxPageref*[Samuel L.]{Clemens} \textit{see} \ShowIdxPageref*[Mark]{Twain}\\ -% |\PName{Voltaire}%|\newline| [François-Marie]{Arouet}| & \\ -% \PName{Voltaire}[François-Marie]{Arouet} & \ShowIdxPageref*[François-Marie]{Arouet} \textit{see} \ShowIdxPageref*{Voltaire}\\ -% \PName{Voltaire}[François-Marie]{Arouet} & \ShowIdxPageref*[François-Marie]{Arouet} \textit{see} \ShowIdxPageref*{Voltaire}\\ -% \rowcolor{black!7!white}|\PName{William, I}%|\newline| {William, the Conqueror}| & \\ -% \rowcolor{black!7!white}\PName{William, I}{William, the Conqueror} & \ShowIdxPageref*{William, the Conqueror} \textit{see} \ShowIdxPageref*{William, I}\\ -% \rowcolor{black!7!white}\PName{William, I}{William, the Conqueror} & \ShowIdxPageref*{William, the Conqueror} \textit{see} \ShowIdxPageref*{William, I}\\ -% |\PName*{William, I}%|\newline| {William, the Conqueror}| & \\ -% \PName*{William, I}{William, the Conqueror} & \ShowIdxPageref*{William, the Conqueror} \textit{see} \ShowIdxPageref*{William, I}\\ -% \rowcolor{black!7!white}|\PretagName%|\newline| {\textit{Doctor mellifluus}}%|\newline| {Doctor mellifluus}| & \\ -% \rowcolor{black!7!white}|\PName{Bernard, of Clairvaux}%|\newline| {\textit{Doctor mellifluus}}| & \\ -% \rowcolor{black!7!white}\PName{Bernard, of Clairvaux}{\textit{Doctor mellifluus}} & \ShowIdxPageref*{\textit{Doctor mellifluus}} \textit{see} \ShowIdxPageref*{Bernard, of Clairvaux}\\ -% \rowcolor{black!7!white}\PName{Bernard, of Clairvaux}{\textit{Doctor mellifluus}} & \ShowIdxPageref*{\textit{Doctor mellifluus}} \textit{see} \ShowIdxPageref*{Bernard, of Clairvaux}\\ -% |\ForgetThis\PName{Lao-tzu}{Li, Er}| & \\ +% +% \begin{itemize} +% \item Most prefix macros only affect \meta{FNN}\meta{SAFX}, not the cross-reference, which always has a long form. +% \item \cmd{\SkipIndex} keeps both names out of the index. +% \item \cmd{\PName} allows the obsolete syntax only for the alternate name. +% \item Even though it is permitted, please avoid using the obsolete syntax with the xref part of \cmd{\PName}, such as \cmd{\PName\{Lao-tzu\}\{Li\}[Er]} and \cmd{\PName\{William, I\}\{William\}[the Conqueror]}. +% \end{itemize} +% +% Alternate names for the non-Western syntax do not work with the name portion of \cmd{\PName}; only the cross-reference portion can support it. If we attempted to use |\SkipIndex\PName*{William, I}[William]{the Conqueror}|, this macro would put ``\SkipIndex\PName*{William, I}[William]{the Conqueror}'' in the body text, but its index entry would be incorrect: ``\ShowIdxPageref*[William]{the Conqueror} \textit{see} \ShowIdxPageref*{William, I}''. We use |\ForgetName{William, I}|\ForgetName{William, I} to prepare for the example below that shows the preferred usage of these macros:\footnote{The xref pattern \texttt{\ShowPattern{\textit{Doctor mellifluus}}!PN} is too large for the margin note. With \texttt{pdflatex} and \texttt{latex}, in \texttt{\ShowPattern[François-Marie]{Arouet}!PN} the glyphs \texttt{Ãğ} correspond to the Unicode encoding macro \cmd{\IeC\{}\cmd{\c\ c\}}.} +% +% \begin{center}\small\vspace{2ex}\PatInfo{\scriptsize\ShowPattern[Mark]{Twain}!MN\break \ShowPattern[Samuel L.]{Clemens}!PN\break \ShowPattern{Voltaire}!MN\break \ShowPattern[François-Marie]{Arouet}!PN\break \ShowPattern{William, I}!MN\break \ShowPattern{William, the Conqueror}!PN\break \ShowPattern{Bernard, of Clairvaux}!MN\break \ShowPattern{Lao-tzu}!MN\break \ShowPattern{Li, Er}!PN}\vspace{-2ex}\MyStretch +% \begin{tabular}{p{0.42\textwidth}@{\ \ }p{0.46\textwidth}}\toprule +% \bfseries\small Macro/Output & \bfseries\small Index\\\midrule +% \rowcolor{grey}\multicolumn{2}{l}{\cmd{\PName[Mark]\{Twain\}[Samuel L.]\{Clemens\}}}\\ +% \rowcolor{grey}\PName[Mark]{Twain}[Samuel L.]{Clemens} & \ShowIdxPageref*[Samuel L.]{Clemens} \textit{see} \ShowIdxPageref*[Mark]{Twain}\\ +% \rowcolor{grey}\PName[Mark]{Twain}[Samuel L.]{Clemens} & \ShowIdxPageref*[Samuel L.]{Clemens} \textit{see} \ShowIdxPageref*[Mark]{Twain}\\ +% \multicolumn{2}{l}{\cmd{\PName*[Mark]\{Twain\}[Samuel L.]\{Clemens\}[Sam]}}\\ +% \PName*[Mark]{Twain}[Samuel L.]{Clemens}[Sam] & \ShowIdxPageref*[Samuel L.]{Clemens} \textit{see} \ShowIdxPageref*[Mark]{Twain}\\ +% \rowcolor{grey}\multicolumn{2}{l}{\cmd{\PName\{Voltaire\}[François-Marie]\{Arouet\}}}\\ +% \rowcolor{grey}\PName{Voltaire}[François-Marie]{Arouet} & \ShowIdxPageref*[François-Marie]{Arouet} \textit{see} \ShowIdxPageref*{Voltaire}\\ +% \rowcolor{grey}\PName{Voltaire}[François-Marie]{Arouet} & \ShowIdxPageref*[François-Marie]{Arouet} \textit{see} \ShowIdxPageref*{Voltaire}\\ +% \multicolumn{2}{l}{\cmd{\PName\{William, I\}\{William, the Conqueror\}}}\\ +% \PName{William, I}{William, the Conqueror} & \ShowIdxPageref*{William, the Conqueror} \textit{see} \ShowIdxPageref*{William, I}\\ +% \PName{William, I}{William, the Conqueror} & \ShowIdxPageref*{William, the Conqueror} \textit{see} \ShowIdxPageref*{William, I}\\ +% \rowcolor{grey}\multicolumn{2}{l}{\cmd{\PretagName\{}\cmd{\textit\{Doctor mellifluus\}\}\{Doctor mellifluus\}}}\\ +% \rowcolor{grey}\multicolumn{2}{l}{\cmd{\PName\{Bernard, of Clairvaux\}\{}\cmd{\textit\{Doctor mellifluus\}}}\\ +% \rowcolor{grey}\PName{Bernard, of Clairvaux}{\textit{Doctor mellifluus}} & \ShowIdxPageref*{\textit{Doctor mellifluus}} \textit{see} \ShowIdxPageref*{Bernard, of Clairvaux}\\ +% \rowcolor{grey}\PName{Bernard, of Clairvaux}{\textit{Doctor mellifluus}} & \ShowIdxPageref*{\textit{Doctor mellifluus}} \textit{see} \ShowIdxPageref*{Bernard, of Clairvaux}\\ +% \multicolumn{2}{l}{\cmd{\ForgetThis}\cmd{\PName\{Lao-tzu\}\{Li, Er\}}}\\ % \ForgetThis\PName{Lao-tzu}{Li, Er} & \ShowIdxPageref*{Li, Er} \textit{see} \ShowIdxPageref*{Lao-tzu}\\ -% \PName{Lao-tzu}{Li, Er} & \ShowIdxPageref*{Li, Er} \textit{see} \ShowIdxPageref*{Lao-tzu}\\\midrule -% \bfseries\small Discouraged Macro\,/\,Output & \bfseries\small Index\\\midrule -% |\PName{William, I}{William}%|\newline| [the Conqueror]| & \\ -% \PName{William, I}{William}[the Conqueror] & \ShowIdxPageref*{William}[the Conqueror] \textit{see} \ShowIdxPageref*{William, I}\\ -% \rowcolor{black!7!white}|\PName{Lao-tzu}{Li}[Er]| & \\ -% \rowcolor{black!7!white}\PName{Lao-tzu}{Li}[Er] & \ShowIdxPageref*{Li}[Er] \textit{see} \ShowIdxPageref*{Lao-tzu}\\\bottomrule +% \PName{Lao-tzu}{Li, Er} & \ShowIdxPageref*{Li, Er} \textit{see} \ShowIdxPageref*{Lao-tzu}\\\bottomrule % \end{tabular} % \end{center} % -% The newer non-Western syntax does not work with \cmd{\PName}. If we attempted to use |\SkipIndex\PName*{William, I}[William]{the Conqueror}|, this macro would put ``\SkipIndex\PName*{William, I}[William]{the Conqueror}'' in the body text, but its index entry would be incorrect: ``\ShowIdxPageref*[William]{the Conqueror} \textit{see} \ShowIdxPageref*{William, I}''. -% % \ReturnLink +% \BigBlank % \newpage % +% \begingroup^^A General format hook redefinition. % \subsection{Longer Examples} % \label{sec:Hooks} % -% Examples from the remainder of this manual are in \texttt{examples.tex}, included with the \textsf{nameauth} documentation. -% -% When\Info{\texttt{dtx} files} creating package documentation, any name that has a macro in its argument should be set up in the driver section (the \texttt{nameauth} environment and tags from \cmd{\PretagName} and \cmd{\TagName}). Otherwise, errors can result. -% -% \begingroup^^A Start of hook macro redefinition. -% \subsubsection{Hooks: Intro} -% \label{sec:Hooksi} -% -% In these sections on advanced topics we reset all formatting hooks to do nothing. This helps us focus on the modifications made hereafter. +% For the rest of this manual, many examples are in \texttt{examples.tex} with the \textsf{nameauth} documentation. Here we set the formatting hooks to the package default. % \renewcommand*\NamesFormat{} % \renewcommand*\FrontNamesFormat{} % \renewcommand*\MainNameHook{} % \renewcommand*\FrontNameHook{} % -% Before we get to the use of text tags and name conditionals in name formatting, we seek to illustrate that something more complex than a font switch can occur in \cmd{\NamesFormat}. Below we put the first mention of a name in boldface, along with a marginal notation if possible. +% A reminder: When\Info{\texttt{dtx} files} creating package documentation, any name that has a macro in its argument should be set up in the driver section (the \texttt{nameauth} environment and tags from \cmd{\PretagName} and \cmd{\TagName}). Otherwise, errors can result. +% +% \subsubsection{Hooks: Intro} +% \label{sec:Hooksi} +% +% Before we get to the use of text tags and name conditionals in name formatting, we seek to illustrate that something more complex than a font switch can occur in \cmd{\NamesFormat}. Below we put the first mention of a name in boldface, along with a marginal notation if possible. Unlike the rest of this section, we do not change formatting macros within a scope. Instead, we illustrate a different approach using \cmd{\let} to save the old value, then restore it later. % \begin{quote}\small % \StartNum % \begin{verbatim} %\let\OldFormat\NamesFormat %\renewcommand*\NamesFormat[1]{\textbf{#1}\unless\ifinner % \marginpar{\raggedleft\scriptsize #1}\fi} -%\let\NamesFormat\OldFormat %\PretagName{Vlad, Ţepeş}{Vlad Tepes} % for accented names -%\TagName{Vlad, II}{ Dracul} % for index information +%\TagName{Vlad, II}{ Dracul} % for index information %\TagName{Vlad, III}{ Dracula}\end{verbatim} % % \medskip Within the document after the preamble: @@ -3880,18 +4517,19 @@ the README.txt or README for more information. % \end{quote} % Now we have reverted to the default \cmd{\NamesFormat} and we get: % \begin{itemize} -% \item |\ForgetThis\Name{Vlad, III}[III Dracula]|\dotfill \ForgetThis\Name{Vlad, III}[III Dracula] -% \item |\Name*{Vlad, III}|\dotfill \Name*{Vlad, III} -% \item |\Name{Vlad, III}|\dotfill \Name{Vlad, III} +% \item \cmd{\ForgetThis}\cmd{\Name\{Vlad, III\}[III Dracula]}\dotfill \ForgetThis\Name{Vlad, III}[III Dracula] +% \item \cmd{\Name*\{Vlad, III\}}\dotfill \Name*{Vlad, III} +% \item \cmd{\Name\{Vlad, III\}}\dotfill \Name{Vlad, III} % \end{itemize} -% We also set up the cross-reference |\IndexRef{Dracula}{Vlad III}|\IndexRef{Dracula}{Vlad III}. Compare the examples for \LDem\ in Section~\ref{sec:NameParticles}. -% +% We also set up the cross-reference \cmd{\IndexRef\{Dracula\}\{Vlad III\}}\IndexRef{Dracula}{Vlad III}. Compare the examples for \LDem\ in Section~\ref{sec:NameAncient}. +% % \ReturnLink % \newpage -% +% % \subsubsection{Hooks: Life Dates} % \label{sec:Hooksii} -% We can use name conditionals (Section~\ref{sec:NameTests}) and text tags (Section~\ref{sec:TextTags}) to add life information to names when desired. +% \begingroup^^A Local format hook redefinition +% We can use name conditionals (Section~\ref{sec:NameTests}) and text tags (Section~\ref{sec:TextTags}) to add life information to names when desired. We begin a local scope to isolate any changes to the formatting hooks. % % \DescribeMacro{\if@nameauth@InName} % The example \cmd{\NamesFormat} below adds a text tag to the first occurrences of main-matter names. @@ -3901,17 +4539,14 @@ the README.txt or README for more information. % \DescribeMacro{\@nameauth@toksa} % This package makes three token registers available to facilitate using the name conditional macros as we do below. % \DescribeMacro{\@nameauth@toksb} -% These registers are necessary for names that contain accents and diacritics.\footnote{In \cmd{\AKA} these registers correspond to the \emph{last} three arguments, the xref.} -% \DescribeMacro{\@nameauth@toksc} -% +% These registers are necessary for names that contain accents and\DescribeMacro{\@nameauth@toksc} +% diacritics.\footnote{In \cmd{\AKA} these registers correspond to the \emph{last} three arguments, the xref.} % -% Below the first use of a name is in small caps. Text tags are in boldface with naming macros, and roman with \cmd{\AKA}. Just because we set up a cross-reference does not mean that we use \cmd{\AKA} by default, as was the case in early versions of \textsf{nameauth}. We use \cmd{\ForceName} to use it more than once with \cmd{\AKA}: +% Below the first use of a name is in small caps. Text tags are in boldface with naming macros, and roman with \cmd{\AKA}. Just because we set up a cross-reference does not mean that we have to use \cmd{\AKA}. We use \cmd{\ForceName} as needed with \cmd{\AKA}. In the document preamble we set up the following: % \begin{quote}\small % \StartNum % \begin{verbatim} -%\newif\ifNoTag% allows us to work around \ForgetName -%\let\OldFormat\NamesFormat -%\let\OldFrontFormat\FrontNamesFormat +%\newif\ifNoTag %\makeatletter %\renewcommand*\NamesFormat[1]{\begingroup% % \protected@edef\temp{\endgroup\textsc{#1}% @@ -3931,11 +4566,9 @@ the README.txt or README for more information. %\makeatother %\let\FrontNamesFormat\NamesFormat\end{verbatim} % \end{quote} -% \let\OldFormat\NamesFormat -% \let\OldFrontFormat\FrontNamesFormat % \makeatletter -% \renewcommand*\NamesFormat[1]{\begingroup%^^A -% \protected@edef\temp{\endgroup\textsc{#1}%^^A +% \renewcommand*\NamesFormat[1]{\begingroup^^A +% \protected@edef\temp{\endgroup\textsc{#1}^^A % \unless\ifNoTag % \if@nameauth@InName % {\bfseries\noexpand\NameQueryInfo @@ -3947,12 +4580,13 @@ the README.txt or README for more information. % [\unexpanded\expandafter{\the\@nameauth@toksa}] % {\unexpanded\expandafter{\the\@nameauth@toksb}} % [\unexpanded\expandafter{\the\@nameauth@toksc}]}\fi -% \fi}\temp\global\NoTagfalse}%^^A +% \fi}\temp\global\NoTagfalse}^^A % \makeatother +% \let\FrontNamesFormat\NamesFormat % % We print tags in the first use hooks unless \cmd{\NoTag} is set true. This method uses the two \(\epsilon\)-\TeX{} primitives \cmd{\noexpand} and \cmd{\unexpanded} to avoid repetition of \cmd{\expandafter}. Since \textsf{nameauth} depends on \textsf{etoolbox}, we assume \(\epsilon\)-\TeX. -% -% Before we can refer to any text tags, we must create them. Using the approach above, we include a leading space in the text tags. The leading space is needed only when a text tag appears.\footnote{Another way to add that space is to put it in the conditional path of the formatting hook and leave it out of the text tags entirely: \dots\texttt{\{ \}}\cmd{\noexpand}\cmd{\NameQueryInfo}\dots} +% +% Before we can refer to any text tags, we must create them. Using the approach above, we include a leading space in the text tags. The leading space is needed only when a text tag appears.\footnote{Another way to add that space is to put it in the conditional path of the formatting hook and leave it out of the text tags: \dots\texttt{\{ \}}\cmd{\noexpand}\cmd{\NameQueryInfo}\dots} % We also set up a cross-reference, which we will use regardless of whether we also use \cmd{\AKA}. The cross-reference will be created only once and skipped thereafter: % \begin{quote}\small % \ContinueNum @@ -3967,19 +4601,21 @@ the README.txt or README for more information. % \NameAddInfo{Atatürk}{ (in 1934, a special surname)} % \IndexRef{Atatürk}{Kemal, Mustafa} % \newpage -% +% % Now we begin with the first example, which, after all the setup, looks deceptively simple, but highly reusable without extra work: % \begin{quote}\small % \ContinueNum % \begin{verbatim} %\ForgetThis\Wash held office 1789--97. %No tags: \Wash.\\ -%First use, dates suppressed: \NoTagtrue\ForgetThis\Wash.\end{verbatim} +%First use, dates suppressed: \NoTagtrue\ForgetThis\Wash.\\ +%Subsequent use with format and dates: \ForceName\Wash.\end{verbatim} % % \smallskip % \ForgetThis\Wash\ held office 1789--97.\\ % No tags: \Wash.\\ -% First use, dates suppressed: \NoTagtrue\ForgetThis\Wash. +% First use, dates suppressed: \NoTagtrue\ForgetThis\Wash.\\ +% Subsequent use with format and dates: \ForceName\Wash. % \end{quote} % % Since we already set up a cross-reference with \cmd{\IndexRef}, we can use just the the naming macros with ``Atatürk'' and get the desired formatting without any page references in the index: @@ -4023,36 +4659,30 @@ the README.txt or README for more information. % First use, no tag: % \NoTagtrue\ForceName\AKA[Mustafa]{Kemal}{Atatürk}. % \end{quote}% -% Please remember to reset the formatting: -% \begin{quote}\small -% \ContinueNum -% \begin{verbatim} -%\let\NamesFormat\OldFormat -%\let\FrontNamesFormat\OldFrontFormat\end{verbatim} -% \end{quote} -% \let\NamesFormat\OldFormat -% \let\FrontNamesFormat\OldFrontFormat +% Now we end the scope to revert any changes to formatting hooks. +% \endgroup^^A Local format hook redefinition % % \ReturnLink -% \newpage -% +% % \subsubsection{Hooks: Advanced} % \label{sec:Hooksiii} -% \AltFormatActive\begingroup +% \AltFormatActive +% In this section we invoke \cmd{\AltFormatActive} and create several scopes containing respective examples. Some macros in this section normally should be defined in a document preamble. We define them locally and ensure that names do not use them when they are undefined. This is not best practices, but it makes sense for this manual's need for multiple redefinitions. +% \newpage % -% \begin{center}\bfseries Alternate Formatting\end{center} +% \begin{center}\bfseries Alternate Formatting: Details\end{center} +% \phantomsection +% Here we discuss the implementation details of alternate formatting, which will engage the rest of the section. This framework provides features that aid both error protection and ease of hook design. Names that use alternate formatting may cause spurious index entries if used also in the default formatting regime. % -% \noindent The\Version{3.1} alternate formatting framework provides features that aid both error protection and ease of use. This section uses \cmd{\AltFormatActive}. We do not use the names in this section elsewhere. A name designed for the alternate formatting regime may cause spurious index entries when used in the default formatting regime. +% Both \cmd{\AltFormatActive} and \cmd{\AltFormatActive*} globally set the internal Boolean flag \cmd{\@nameauth@AltFormattrue}, enabling alternate formatting. \cmd{\AltFormatActive} globally sets \cmd{\@nameauth@DoAlttrue}, which activates formatting. Both flags are reset globally by \cmd{\AltFormatInactive} and normal formatting resumes. % -% Both \cmd{\AltFormatActive} and \cmd{\AltFormatActive*} set the internal Boolean flag \cmd{\@nameauth@AltFormattrue}, enabling alternate formatting. \cmd{\AltFormatActive} sets \cmd{\@nameauth@DoAlttrue}, which activates formatting. \cmd{\AltFormatInactive} sets both flags false. +% \cmd{\AltFormatActive*} normally suppresses formatting changes but it still forces \cmd{\CapThis} to work through \cmd{\AltCaps}. One can leverage this to get the default look of \textsf{nameauth} while mitigating errors if many names use macros in their arguments. % -% \cmd{\AltFormatActive*} normally suppresses formatting changes but it still forces \cmd{\CapThis} to work through \cmd{\AltCaps}. This produces the default look of \textsf{nameauth} and prevents Continental formatting, but it also reduces spurious index entries and errors if many names use macros in their arguments. -% % Alternate formatting protects against errors created when \cmd{\@nameauth@Cap} (used by \cmd{\CapThis}) gets a failure result from \cmd{\@nameauthUTFtest}, but that result is neither a letter nor a macro that expands to a sequence of letters. Protected macros and other cases may create errors if \cmd{\MakeUppercase} is applied to them. \cmd{\AltCaps} and \cmd{\CapThis} work together to avoid this problem (Section~\ref{sec:AltFormat}). % -% \begin{center}\bfseries Continental Format\end{center} -% -% \noindent Here we look in greater detail at how \textsf{nameauth} implements the advanced version of Continental formatting. Font changes occur in the short macros \cmd{\textSC}, \cmd{\textIT}, \cmd{\textBF}, and \cmd{\textUC}. They all look similar to \cmd{\textSC}: +% \begin{center}\bfseries Continental Format: Predefined\end{center} +% \phantomsection +% Here we look in greater detail at how \textsf{nameauth} implements the advanced version of Continental formatting. Font changes occur in the short macros \cmd{\textSC}, \cmd{\textIT}, \cmd{\textBF}, and \cmd{\textUC}. They all look similar to \cmd{\textSC}: % \begin{quote}\small % \StartNum % \begin{verbatim} @@ -4060,8 +4690,8 @@ the README.txt or README for more information. % \if@nameauth@DoAlt\textsc{#1}\else#1\fi %}\end{verbatim} % \end{quote} -% -% If the \texttt{altformat} option or \cmd{\AltFormatActive} is used, formatting occurs in both the text and in the index. We want small caps on by default in the text and index, then off in subsequent uses. Thus, we use \cmd{\AltFormatActive}, then redefine \cmd{\MainNameHook} because it is the subsequent use hook. \cmd{\AltOff} deactivates formatting only in the formatting hooks: +% +% If the \texttt{altformat} option or \cmd{\AltFormatActive} is used, formatting occurs in both the text and in the index. \cmd{\AltOff} deactivates formatting only in the formatting hooks: % \begin{quote}\small % \ContinueNum % \begin{verbatim} @@ -4070,7 +4700,7 @@ the README.txt or README for more information. %}\end{verbatim} % \end{quote} % -% \cmd{\CapThis} now triggers \cmd{\AltCaps} to capitalize its argument: +% \cmd{\CapThis} triggers \cmd{\AltCaps} to capitalize its argument: % \begin{quote}\small % \ContinueNum % \begin{verbatim} @@ -4083,18 +4713,23 @@ the README.txt or README for more information. % % We must put \cmd{\noexpand} before \cmd{\textSC}, \cmd{\AltCaps}, and so on to prevent them from expanding outside of the formatting hooks. % -% Before we alter the formatting hooks, we either can \cmd{\let} the hook macros to recall them later or we can use \cmd{\begingroup} and \cmd{\endgroup} to create a new scope that localizes any changes. We use scoping in this section. +% Before we alter the formatting hooks, either we can \cmd{\let} the hook macros to recall them later or we can use \cmd{\begingroup} and \cmd{\endgroup} to create a new scope that localizes any changes. We use scoping in this section. +% \newpage % -% This final step \emph{does not come} from the \textsf{nameauth} source. We must redefine the formatting hooks ourselves. One of the simplest ways to do this when using the \texttt{altformat} option or \cmd{\AltFormatActive} is: +% \begin{center}\bfseries Continental Format: User-Defined\end{center} +% \phantomsection +% \begingroup^^A Local format hook redefinition +% The user must implement this final step. We use \cmd{\AltFormatActive}, then redefine \cmd{\MainNameHook} to have small caps on by default in the index and first uses in the text, then off in subsequent uses in the text: % \begin{quote}\small -% \ContinueNum +% \StartNum % \begin{verbatim} %\renewcommand*\MainNameHook{\AltOff} %\let\FrontNameHook\MainNameHook\end{verbatim} % \end{quote} +%\renewcommand*\MainNameHook{\AltOff} +%\let\FrontNameHook\MainNameHook % -% \renewcommand*\MainNameHook{\AltOff}\let\FrontNameHook\MainNameHook -% To suppress all formatting in the front-matter text, one need simply to use |\let\FrontNamesFormat\MainNameHook|. Continental formatting usually alters at least one element in the required name argument, as we see below: +% To suppress all formatting in the front-matter text, one need simply to use \cmd{\let}\cmd{\FrontNamesFormat}\cmd{\MainNameHook}. We do not do that here. Usually, we set up the names and any related macros in the preamble: % \begin{quote}\small % \ContinueNum % \begin{verbatim} @@ -4108,7 +4743,7 @@ the README.txt or README for more information. %\end{nameauth}\end{verbatim} % \end{quote} % -% Now we must ensure that these names are sorted properly in the index. When sorting names, be sure to use \cmd{\noexpand} before the macros: +% Likewise in the preamble, we must ensure that these names are sorted properly in the index. When sorting names, be sure to use \cmd{\noexpand} as well: % \begin{quote}\small % \ContinueNum % \begin{verbatim} @@ -4124,27 +4759,27 @@ the README.txt or README for more information. % \begin{center} % \small\noindent\begin{tabular}{llll}\toprule % First & Next & Long & Short \\\midrule -% |\Adams| & |\Adams| & |\LAdams| & |\SAdams|\\ -% \Adams & \Adams & \LAdams & \SAdams\\ -% \rowcolor{black!7!white}|\SDJR| & |\SDJR| & |\LSDJR| & |\SSDJR|\\ -% \rowcolor{black!7!white}\SDJR & \SDJR & \LSDJR & \SSDJR\\ -% |\HAR| & |\HAR| & |\LHAR| & |\SHAR|\\ -% \HAR & \HAR & \LHAR & \SHAR\\ -% \rowcolor{black!7!white}|\Mencius| & |\Mencius| & |\LMencius| & |\SMencius|\\ -% \rowcolor{black!7!white}\Mencius & \Mencius & \LMencius & \SMencius\\\bottomrule +% \rowcolor{grey}\cmd{\Adams} & \cmd{\Adams} & \cmd{\LAdams} & \cmd{\SAdams}\\ +% \rowcolor{grey}\Adams & \Adams & \LAdams & \SAdams\\ +% \cmd{\SDJR} & \cmd{\SDJR} & \cmd{\LSDJR} & \cmd{\SSDJR}\\ +% \SDJR & \SDJR & \LSDJR & \SSDJR\\ +% \rowcolor{grey}\cmd{\HAR} & \cmd{\HAR} & \cmd{\LHAR} & \cmd{\SHAR}\\ +% \rowcolor{grey}\HAR & \HAR & \LHAR & \SHAR\\ +% \cmd{\Mencius} & \cmd{\Mencius} & \cmd{\LMencius} & \cmd{\SMencius}\\ +% \Mencius & \Mencius & \LMencius & \SMencius\\\bottomrule % \end{tabular} % \end{center} % % \begin{itemize}\small % \item Punctuation detection works: \ForceName\LSDJR. Also \LSDJR. Then \ForceName\SDJR. Now \SDJR. (We used \cmd{\ForceName} for formatting.) -% \item \cmd{\ForceName}\cmd{\DropAffix}\cmd{\LSDJR} gives \ForceName\DropAffix\LSDJR. Otherwise, only using the macro \cmd{\DropAffix}\cmd{\LSDJR} gives \DropAffix\LSDJR. +% \item \cmd{\ForceName}\cmd{\DropAffix}\cmd{\LSDJR} gives \ForceName\DropAffix\LSDJR. Otherwise, using the macro \cmd{\DropAffix}\cmd{\LSDJR} gives \DropAffix\LSDJR. % \item \cmd{\RevComma}\cmd{\LAdams} yields \RevComma\LAdams. All the reversing macros work. % \item \cmd{\ForceName}\cmd{\ForceFN}\cmd{\SHAR} produces \ForceName\ForceFN\SHAR. \cmd{\ForceFN}\cmd{\SHAR} produces \ForceFN\SHAR. If we add \cmd{\CapThis} we get \CapThis\ForceName\ForceFN\SHAR\ and \CapThis\ForceFN\SHAR.\footnote{The way that Continental resources treat certain affixes relates to similar issues in [\hyperlink{Mulvany}{Mulvany}, 168--73]. Handling non-Western names in Western sources can be a gray area. One ought take care to be culturally sensitive in these matters.} % \item One must include all the macros in the name arguments. % \end{itemize} % % \makeatletter\@nameauth@AKAFormattrue\makeatother -% If we use the \texttt{formatAKA} option we can refer to \Mencius\ as \AKA{\noexpand\textSC{Mencius}}{\noexpand\textSC{Meng}, Ke}, and again \AKA{\noexpand\textSC{Mencius}}{\noexpand\textSC{Meng}, Ke}. We get that with: +% With the \texttt{formatAKA} option we refer to \Mencius\ as \AKA{\noexpand\textSC{Mencius}}{\noexpand\textSC{Meng}, Ke} and \AKA{\noexpand\textSC{Mencius}}{\noexpand\textSC{Meng}, Ke}: % \begin{quote}\small % \ContinueNum % \begin{verbatim} @@ -4152,14 +4787,18 @@ the README.txt or README for more information. %\AKA{\noexpand\textSC{Mencius}}{\noexpand\textSC{Meng}, Ke}\end{verbatim} % \end{quote} % \makeatletter\@nameauth@AKAFormatfalse\makeatother +% \endgroup^^A Local format hook redefinition % % \begin{center}\bfseries Rolling Your Own: Basic\end{center} +% \phantomsection +% \begingroup^^A Local format hook redefinition +% Here we set out on the path to custom formatting by using package features that have been implemented already and look similar to the solutions in Section~\ref{sec:AltFormat}. % -% \noindent Here we set out on the path to custom formatting by using package features that have been implemented already and look similar to the solutions in Section~\ref{sec:AltFormat}. +% When\Warn{} redesigning formatting hooks, we recommend using \cmd{\AltFormatActive} or the \texttt{altformat} option to enable alternate formatting and prevent \cmd{\CapThis} from breaking custom formatting macros. % -% When\Warn{} redesigning formatting hooks, one should use \cmd{\AltFormatActive} or the \texttt{altformat} option to enable alternate formatting and prevent \cmd{\CapThis} from breaking custom formatting macros. +% We recommend examining the internal package flag \cmd{\@nameauth@DoAlt}, which activates alternate formatting, \cmd{\@nameauth@DoCaps}, which handles capitalization, and \cmd{\@nameauth@InHook}, which is true when the formatting hooks are called. See page~\pageref{page:Hooks} and following. If you create your own macros, they will look similar. % -% We recommend examining the internal package flag \cmd{\@nameauth@DoAlt}, which activates alternate formatting, \cmd{\@nameauth@DoCaps}, which handles capitalization, and \cmd{\@nameauth@InHook}, which is true when the formatting hooks are called. See page~\pageref{page:Hooks} and following. If you create your own macros, they will look similar: +% Normally we define a macro for use in name arguments in the document preamble in order to ensure that it is always defined: % \begin{quote}\small % \StartNum % \begin{verbatim} @@ -4178,42 +4817,48 @@ the README.txt or README for more information. %\renewcommand*\MainNameHook{\AltOff} %\let\FrontNameHook\MainNameHook\end{verbatim} % \end{quote} +%\renewcommand*\MainNameHook{\AltOff} +%\let\FrontNameHook\MainNameHook % % When sorting names, be sure to use \cmd{\noexpand} as shown previously: % \begin{quote}\small % \ContinueNum % \begin{verbatim} -%\PretagName[Pierre-Jean]% -% {\noexpand\Fbox{\noexpand\AltCaps{d}e Smet}}% -% {de Smet, Pierre-Jean} -% %\begin{nameauth} % \< deSmet & Pierre-Jean & -% \noexpand\Fbox{\noexpand\AltCaps{d}e Smet} & > -%\end{nameauth}\end{verbatim} +% \noexpand\Fbox{\noexpand\AltCaps{d}e~Smet} & > +%\end{nameauth} +% +%\PretagName[Pierre-Jean]% +% {\noexpand\Fbox{\noexpand\AltCaps{d}e~Smet}}% +% {de~Smet, Pierre-Jean}\end{verbatim} % \end{quote} % % Now we show how the formatting hooks work in the body text. One can check the index to see that it is formatted properly and consistently. % -% \begin{center}\footnotesize -% \begin{tabular}{llll}\toprule -% First & Next & Long & Short \\\midrule -% |\deSmet| & |\deSmet| & |\LdeSmet| & |\SdeSmet|\\ -% \deSmet & \deSmet & \LdeSmet & \SdeSmet\\\bottomrule +% \begin{center}\small +% \begin{tabular}{rll}\toprule +% First & \cmd{\deSmet} & \deSmet\\ +% \rowcolor{grey}Next & \cmd{\deSmet} & \deSmet\\ +% Long & \cmd{\LdeSmet} & \LdeSmet\\ +% \rowcolor{grey}Short & \cmd{\SdeSmet} & \SdeSmet\\ +% & \cmd{\CapThis}\cmd{\deSmet} & \CapThis\deSmet\\ +% \rowcolor{grey} & \cmd{\ForceName}\cmd{\CapThis}\cmd{\deSmet} & \ForceName\CapThis\deSmet\\\bottomrule % \end{tabular} % \end{center} % -% The capitalized version |\CapThis\deSmet| is \CapThis\deSmet. This also works for a formatted use via \cmd{\ForceName}: \ForceName\CapThis\deSmet. -% % Some formatting, such as the use of \cmd{\textSC}, is fairly standard. Other formatting, such as \cmd{\Fbox} above, is ornamental and may be handled better with custom features (Section~\ref{sec:Customize}), but those features appear only in the text. +% \endgroup^^A Local format hook redefinition % \newpage % % \begin{center}\bfseries Rolling Your Own: Intermediate\end{center} -% -% \noindent \hspace{-0.47em}``Intermediate'' and ``advanced'' refer to the way hooks were designed before version 3.1. We begin the journey to more customized formatting by looking at \cmd{\NameParser}, whose logic Sections~\ref{sec:InternalMacros} and~\ref{sec:UserInterface} show in detail.\medskip +% \phantomsection +% \label{page:Intermediate} +% \begingroup^^A Local format hook redefinition +% ``Intermediate'' and ``advanced'' refer to the way that formatting hooks were designed before version 3.1. We begin the journey to more customized formatting by looking at \cmd{\NameParser}, whose logic Sections~\ref{sec:InternalMacros} and~\ref{sec:UserInterface} show in detail.\medskip % % \DescribeMacro{\NameParser} -% This user-accessible parser (Section~\ref{sec:UserInterface}) builds a printed name from the internal macros \cmd{\FNN}, \cmd{\SNN}, \cmd{\rootb} and \cmd{\suffb}.\Version{3.1} It uses the following Boolean flags:\footnote{These exclude all capitalization macros.} +% This user-accessible parser (Section~\ref{sec:UserInterface}) builds a printed name from internal, locally-scoped macros \cmd{\FNN}, \cmd{\SNN}, \cmd{\rootb} and \cmd{\suffb}.\Version{3.1} It uses only these Boolean flags:\footnote{The capitalization macros interact with the internal macros before the name parser, therefore, they do not directly engage the output of the name parser.} % \begin{quote}\small\MyStretch % Only one or the other of these can be true to avoid undocumented behavior.\smallskip\\ % |\if@nameauth@FullName|\hfill Print a full name if true.\\ @@ -4224,23 +4869,22 @@ the README.txt or README for more information. % |\if@nameauth@RevThisComma|\hfill Reverse Western name, add comma. % \end{quote} % -% We create a hook that can ignore ignore the output of \cmd{\@nameauth@Name}, which is the \texttt{\#1} in the hook dispatcher's code \cmd{\bgroup}\meta{Hook}\texttt{\{\#1\}}\cmd{\egroup}: +% We create a hook that can ignore the output of \cmd{\@nameauth@Name}, which is the \texttt{\#1} in the hook dispatcher's code \cmd{\bgroup}\meta{Hook}\texttt{\{\#1\}}\cmd{\egroup}: % \begin{quote}\small\MyStretch -% |\renewcommand*|\meta{FirstHook}|[1]{|\texttt{\dots}\cmd{\NameParser}\texttt{\dots}|}| +% \cmd{\renewcommand*}\meta{FirstHook}\texttt{[1]\{\dots}\cmd{\NameParser}\texttt{\dots\}} % \end{quote} % % With the \texttt{altformat} option or \cmd{\AltFormatActive} we can design a subsequent-use hook that deactivates formatting inside of it: % \begin{quote}\small\MyStretch -% |\renewcommand*|\meta{SubsequentHook}|[1]{|\texttt{\dots}\cmd{\AltOff}\cmd{\NameParser}\texttt{\dots}|}| +% \cmd{\renewcommand*}\meta{SubsequentHook}\texttt{[1]\{\dots}\cmd{\AltOff}\cmd{\NameParser}\texttt{\dots\}} % \end{quote} % % If we used \cmd{\AltFormatActive*}, where the formatting macros are enabled, but deactivated, then we might want a hook that activates the macros: % \begin{quote}\small\MyStretch -% |\renewcommand*|\meta{Hook}|[1]{|\texttt{\dots}\cmd{\AltOn}\cmd{\NameParser}\texttt{\dots}|}| +% \cmd{\renewcommand*}\meta{Hook}\texttt{[1]\{\dots}\cmd{\AltOn}\cmd{\NameParser}\texttt{\dots\}} % \end{quote} -% -% Within the hooks we can use the user-level parser as often as we want. We also can change internal Boolean flags, for example: -% \begingroup +% +% Within the hooks we can use the user-side parser as often as we want. We also can change internal Boolean flags, for example: % \begin{quote}\small % \StartNum % \begin{verbatim} @@ -4257,74 +4901,53 @@ the README.txt or README for more information. % % \smallskip % \makeatletter -% \renewcommand*\NamesFormat[1]{\small%^^A -% \hbox to 3.5em{[now]\hfill}\space\NameParser\\%^^A -% \@nameauth@FullNametrue%^^A -% \hbox to 3.5em{[long]\hfill}\space\NameParser\\%^^A -% \@nameauth@FullNamefalse%^^A -% \@nameauth@FirstNametrue%^^A +% \renewcommand*\NamesFormat[1]{\small^^A +% \hbox to 3.5em{[now]\hfill}\space\NameParser\\^^A +% \@nameauth@FullNametrue^^A +% \hbox to 3.5em{[long]\hfill}\space\NameParser\\^^A +% \@nameauth@FullNamefalse^^A +% \@nameauth@FirstNametrue^^A % \hbox to 3.5em{[short]\hfill}\space\NameParser} % \makeatother % \let\MainNameHook\NamesFormat % -% |\JRIV| displays: -% +% One instance of \cmd{\JRIV} displays: +% % \JRIV % \end{quote} -% \endgroup % -% The proof of concept above is interesting, but not very useful. Now we move on toward more useful designs, based on Sections~\ref{sec:Hooksi} and~\ref{sec:Hooksii}. +% The proof of concept above is interesting, but not very useful in a practical setting. Now we move on toward more useful and practical designs. % \newpage -% -% We begin by defining a name that is composed only of macros: -% \begingroup -% \newif\ifSpecialFN -% \newif\ifSpecialSN -% \newif\ifRevertSN -% \newcommand*\WM{\ifSpecialFN Wm.\else William\fi} -% \newcommand*\SHK{\ifRevertSN \textSC{Shakespeare}\else -% \ifSpecialSN \noexpand\AltCaps{t}he Bard\else -% \textSC{Shakespeare}\fi\fi} -% \newcommand*\Revert{\RevertSNtrue} +% % \makeatletter -% \renewcommand*\NamesFormat[1]{%^^A -% \RevertSNfalse\SpecialFNfalse\SpecialSNfalse#1%^^A -% \unless\ifinner\marginpar{%^^A -% \footnotesize\raggedleft%^^A -% \@nameauth@FullNametrue%^^A -% \@nameauth@FirstNamefalse%^^A -% \@nameauth@EastFNfalse%^^A -% \SpecialFNtrue\SpecialSNfalse%^^A -% \NameParser}%^^A +% \renewcommand*\NamesFormat[1]{^^A +% \RevertSNfalse\SpecialFNfalse\SpecialSNfalse#1^^A +% \unless\ifinner\marginpar{^^A +% \footnotesize\raggedleft^^A +% \@nameauth@FullNametrue^^A +% \@nameauth@FirstNamefalse^^A +% \@nameauth@EastFNfalse^^A +% \SpecialFNtrue\SpecialSNfalse^^A +% \NameParser}^^A % \fi\global\RevertSNfalse} -% \renewcommand*\MainNameHook[1]{%^^A -% \AltOff\SpecialFNfalse\SpecialSNtrue#1%^^A +% \renewcommand*\MainNameHook[1]{^^A +% \AltOff\SpecialFNfalse\SpecialSNtrue#1^^A % \unless\ifinner % \unless\ifRevertSN -% \marginpar{%^^A -% \footnotesize\raggedleft%^^A -% \@nameauth@FullNamefalse%^^A -% \@nameauth@FirstNamefalse%^^A -% \@nameauth@EastFNfalse%^^A -% \SpecialFNfalse\SpecialSNfalse%^^A -% \NameParser}%^^A +% \marginpar{^^A +% \footnotesize\raggedleft^^A +% \@nameauth@FullNamefalse^^A +% \@nameauth@FirstNamefalse^^A +% \@nameauth@EastFNfalse^^A +% \SpecialFNfalse\SpecialSNfalse^^A +% \NameParser}^^A % \fi % \fi\global\RevertSNfalse} % \makeatother +% We begin in the document preamble by defining a series of conditionals and macros whose default expansion produces the index entry, yet whose other expansions occur only in the formatting hooks. Then we create a name that is composed only of macros, using \cmd{\noexpand} with \cmd{\WM} and \cmd{\SHK}. We use \cmd{\PretagName} to sort the names. \cmd{\Revert} is used to print a last name without a margin note. % \begin{quote}\small % \StartNum % \begin{verbatim} -%\begin{nameauth} -% \< Shak & \noexpand\WM & \noexpand\SHK & > -%\end{nameauth} -%\PretagName[\noexpand\WM]{\noexpand\SHK}{Shakespeare, William} -%\PretagName[Robert]{\textSC{Burns}}{Burns, Robert}\end{verbatim} -% \end{quote} -% -% Now we define the flags by which the macros \cmd{\WM} and \cmd{\SHK} expand differently in the formatting hooks than in the index: -% \begin{quote}\small -% \ContinueNum -% \begin{verbatim} %\newif\ifSpecialFN %\newif\ifSpecialSN %\newif\ifRevertSN @@ -4333,13 +4956,20 @@ the README.txt or README for more information. % \ifSpecialSN \noexpand\AltCaps{t}he Bard\else % \textSC{Shakespeare}\fi\fi} %\newcommand*\Revert{\RevertSNtrue} -%\makeatletter\end{verbatim} +% +%\begin{nameauth} +% \< Shak & \noexpand\WM & \noexpand\SHK & > +%\end{nameauth} +% +%\PretagName[\noexpand\WM]{\noexpand\SHK}{Shakespeare, William} +%\PretagName[Robert]{\textSC{Burns}}{Burns, Robert}\end{verbatim} % \end{quote} % -% Finally, we define the two formatting hooks that trigger these changes: +% Below we define the two formatting hooks that structure the ways in which these macros can expand when printed in the text. \cmd{\NamesFormat} allows only the canonical name via \cmd{\RevertSNfalse}, \cmd{\SpecialFNfalse}, and \cmd{\SpecialSNfalse}. We print the canonical name in the body text. If allowed, we print a margin paragraph with an alternate full name using \cmd{\NameParser} and two flags. Both hooks set \cmd{\RevertSNfalse} so that \cmd{\Revert} works on a per-name basis. The subsequent-use hook disables formatting with \cmd{\AltOff}, but it allows variant forms. % \begin{quote}\small % \ContinueNum % \begin{verbatim} +%\makeatletter %\renewcommand*\NamesFormat[1]{% % \RevertSNfalse\SpecialFNfalse\SpecialSNfalse#1% % \unless\ifinner\marginpar{% @@ -4366,38 +4996,30 @@ the README.txt or README for more information. %\makeatother\end{verbatim} % % \smallskip -% \Shak\ \cmd{\Shak} is the national poet of England in much the same way as \Name[Robert]{\textSC{Burns}} |\Name[Robert]{\textSC{Burns}}| is that of Scotland. With the latter's rise of influence in the 1800s, \Revert\Shak\ \cmd{\Revert}\cmd{\Shak} became known as ``\Shak'' \cmd{\Shak}. +% \ForgetThis\Shak\ \cmd{\ForgetThis}\cmd{\Shak} is the national poet of England in much the same way that \Name[Robert]{\textSC{Burns}} \cmd{\Name[Robert]\{}\cmd{\textSC\{Burns\}\}} is that of Scotland. With the latter's rise of influence in the 1800s, \Revert\Shak\ \cmd{\Revert}\cmd{\Shak} became known as ``\Shak'' \cmd{\Shak}. % \end{quote} -% \endgroup -% -% First, we put macros \cmd{\WM} and \cmd{\SHK} in name arguments using \cmd{\noexpand}. That will make the index work properly. We use \cmd{\PretagName} to sort the names. We set up three flags. One is for \cmd{\WM} and two are for \cmd{\SHK}. \cmd{\Revert} is used to print a last name without a margin note. -% -%In the first-use hook we allow only the canonical name via \cmd{\RevertSNfalse}, \cmd{\SpecialFNfalse}, and \cmd{\SpecialSNfalse}. The default global formatting state is set by \cmd{\AltFormatActive}. We print the canonical name in the body text. If not in inner horizontal mode, we print a margin paragraph with an alternate full name using \cmd{\NameParser} and two flags. Both hooks set \cmd{\RevertSNfalse} so that \cmd{\Revert} works on a per-name basis. The subsequent-use hook disables formatting with \cmd{\AltOff}, but it allows variant forms. +% \endgroup^^A Local format hook redefinition % % \begin{center}\bfseries Rolling Your Own: Advanced\end{center} -% -% Here\Warn{} is how formatting hooks were designed before version 3.0. Updating these older hooks is helpful, but may not be necessary. Here we do not use the internal package macros. We only use \cmd{\NameParser} in the hooks to produce output. We still recommend using \cmd{\AltFormatActive} to prevent problems with \cmd{\CapThis}. -% -% \newif\ifFbox -% \newif\ifFirstCap -% \newif\ifInHook -% \Fboxtrue -% Three flags replace package internals. \texttt{\textbackslash @nameauth@DoAlt} activates formatting; \texttt{\textbackslash @nameauth@DoCaps} is set by \cmd{\CapThis}; and \texttt{\textbackslash @nameauth@InHook} is set by the hook dispatcher. Setting \texttt{\textbackslash Fboxtrue} is equivalent to using \cmd{\AltFormatActive}: +% \phantomsection +% \begingroup^^A Local format hook redefinition +% Here is how formatting hooks were designed before version 3.0. Updating older hooks may be helpful, but is not necessary. We\Warn{} do not use the internal package macros. We only use \cmd{\NameParser} in the hooks to produce output. We still recommend using \cmd{\AltFormatActive} to mitigate errors. In the preamble, three flags replace package internals.\footnote{The internal flag \texttt{\textbackslash @nameauth@DoAlt} activates formatting, \cmd{\CapThis} sets \texttt{\textbackslash @nameauth@DoCaps} true, and \texttt{\textbackslash @nameauth@InHook} is set by the hook dispatcher.} +% Setting \texttt{\textbackslash Fboxtrue} is equivalent to using \cmd{\AltFormatActive}: % \begin{quote}\small % \StartNum % \begin{verbatim} -%\newif\ifFbox% Replaces \@nameauth@DoAlt -%\newif\ifFirstCap% Replaces \@nameauth@DoCaps -%\newif\ifInHook% Replaces \@nameauth@InHook +%\newif\ifFbox% Replaces \@nameauth@DoAlt +%\newif\ifFirstCap% Replaces \@nameauth@DoCaps +%\newif\ifInHook% Replaces \@nameauth@InHook %\Fboxtrue\end{verbatim} % \end{quote} % -% \renewcommand*\Fbox[1]{\ifFbox\protect\fbox{#1}\else#1\fi} -% The formatting macro is like what we have seen, except it refers to \texttt{\textbackslash ifFbox}: +% \newcommand*\Fbox[1]{\ifFbox\protect\fbox{#1}\else#1\fi} +% Also in the preamble, the formatting macro is like what we have seen, except it refers to \texttt{\textbackslash ifFbox}:\footnote{As previously noted, we define \cmd{\Fbox} locally in this manual because it has multiple definitions, but are very careful where we use names with it.} % \begin{quote}\small % \ContinueNum % \begin{verbatim} -%\renewcommand*\Fbox[1]{% +%\newcommand*\Fbox[1]{% % \ifFbox\protect\fbox{#1}\else#1\fi %}\end{verbatim} % \end{quote} @@ -4433,7 +5055,7 @@ the README.txt or README for more information. %\renewcommand*\CapThis{\FirstCaptrue}\end{verbatim} % \end{quote} % -% We have to reproduce the logic and macros that the package would have provided. That means defining everything, including \cmd{\NamesFormat}, from scratch: +% We have to reproduce the logic and macros that the package would have provided. That means defining everything, including \cmd{\NamesFormat}, from scratch: % \begin{quote}\small % \ContinueNum % \begin{verbatim} @@ -4458,18 +5080,19 @@ the README.txt or README for more information. % \end{quote} % % Because we use \cmd{\noexpand}, our ``old-style'' macros will index the following names under the same entry as the ``new-style'' macros. -% \begin{center}\footnotesize -% \begin{tabular}{llll}\toprule -% First & Next & Long & Short \\\midrule -% |\deSmet| & |\deSmet| & |\LdeSmet| & |\SdeSmet|\\ -% \ForgetThis\deSmet & \deSmet & \LdeSmet & \SdeSmet\\\bottomrule +% +% \begin{center}\small +% \begin{tabular}{rll}\toprule +% First & \cmd{\deSmet} & \ForgetThis\deSmet\\ +% \rowcolor{grey}Next & \cmd{\deSmet} & \deSmet\\ +% Long & \cmd{\LdeSmet} & \LdeSmet\\ +% \rowcolor{grey}Short & \cmd{\SdeSmet} & \SdeSmet\\ +% & \cmd{\CapThis}\cmd{\deSmet} & \CapThis\deSmet\\ +% \rowcolor{grey} & \cmd{\ForceName}\cmd{\CapThis}\cmd{\deSmet} & \ForceName\CapThis\deSmet\\\bottomrule % \end{tabular} % \end{center} % -% The capitalized version |\CapThis\deSmet| is \CapThis\deSmet. This also works for a formatted use via \cmd{\ForceName}: \ForceName\CapThis\deSmet. -% % We can reuse\Warn{} new-style names with old-style macros, shown below in abbreviated fashion. We keep the flags \texttt{\textbackslash ifFirstCap} and \texttt{\textbackslash ifInHook}. We also keep the redefined \cmd{\AltCaps}, \cmd{\CapThis}, and \cmd{\NamesFormat}. We then add: -% \newif\ifCaps % \Capstrue % \renewcommand*\textSC[1]{\ifCaps\textsc{#1}\else#1\fi} % \renewcommand*\MainNameHook[1] @@ -4495,22 +5118,23 @@ the README.txt or README for more information. % \begin{center} % \small\noindent\begin{tabular}{llll}\toprule % First & Next & Long & Short \\\midrule -% \ForgetThis\Adams & \Adams & \LAdams & \SAdams\\ -% \rowcolor{black!7!white}\ForgetThis\SDJR & \SDJR & \LSDJR & \SSDJR\\ -% \ForgetThis\HAR & \HAR & \LHAR & \SHAR\\ -% \rowcolor{black!7!white}\ForgetThis\Mencius & \Mencius & \LMencius & \SMencius\\\bottomrule +% \rowcolor{grey}\ForgetThis\Adams & \Adams & \LAdams & \SAdams\\ +% \ForgetThis\SDJR & \SDJR & \LSDJR & \SSDJR\\ +% \rowcolor{grey}\ForgetThis\HAR & \HAR & \LHAR & \SHAR\\ +% \ForgetThis\Mencius & \Mencius & \LMencius & \SMencius\\\bottomrule % \end{tabular} % \end{center} % % \begin{itemize}\small % \item Punctuation detection works: \ForceName\LSDJR. Also \LSDJR. Then \ForceName\SDJR. Now \SDJR. (We used \cmd{\ForceName} for formatting.) -% \item \cmd{\ForceName}\cmd{\DropAffix}\cmd{\LSDJR} gives \ForceName\DropAffix\LSDJR. Otherwise, only using the macro \cmd{\DropAffix}\cmd{\LSDJR} gives \DropAffix\LSDJR. +% \item \cmd{\ForceName}\cmd{\DropAffix}\cmd{\LSDJR} gives \ForceName\DropAffix\LSDJR. Otherwise, using the macro \cmd{\DropAffix}\cmd{\LSDJR} gives \DropAffix\LSDJR. % \item \cmd{\RevComma}\cmd{\LAdams} yields \RevComma\LAdams. All the reversing macros work. % \item \cmd{\ForceName}\cmd{\ForceFN}\cmd{\SHAR} produces \ForceName\ForceFN\SHAR. \cmd{\ForceFN}\cmd{\SHAR} produces \ForceFN\SHAR. If we add \cmd{\CapThis} we get \CapThis\ForceName\ForceFN\SHAR\ and \CapThis\ForceFN\SHAR. % \end{itemize} % -% We now resume normal formatting with \cmd{\AltFormatInactive} and close the scope that we began at the start of Section~\ref{sec:Hooksi}. -% \AltFormatInactive\endgroup +% We now close the scope of this current example and resume normal formatting. +% \endgroup^^A Local format hook redefinition +% \AltFormatInactive % % \ReturnLink % \newpage @@ -4527,7 +5151,7 @@ the README.txt or README for more information. % \DescribeMacro{\NameauthFName} % \cmd{\FName}, or an S-shorthand, sets \cmd{\@nameauth@FirstNametrue}, then calls \cmd{\NameauthFName}. One should not modify \cmd{\Name} and \cmd{\FName} directly. % -% Next we see a minimal working example that implements the obsolete syntax. We use few internal Boolean values, save those governing name forms. We do not implement short forms or any other features in \textsf{nameauth}. We must index the names with \cmd{\IndexName}. This example shows how to hook these redefined macros into the user interface: +% Since \textsf{nameauth} depends on \textsf{xargs}, we use that in a minimal working example that implements the obsolete syntax (Section~\ref{sec:Obsolete}). We use few internal Boolean values, save those governing name forms. We do not implement short forms or any other features in \textsf{nameauth}. We must index the names with \cmd{\IndexName}. This example shows how to hook these redefined macros into the user interface. Note that the \texttt{quote} environment creates a local scope that we leverage below: % % \begin{quote}\small % \StartNum @@ -4560,10 +5184,10 @@ the README.txt or README for more information. %\IndexName{Dagobert}[I] %\IndexName{Aristotle}\end{verbatim} % \makeatletter -% \newcommandx*\MyName[3][1=\@empty, 3=\@empty]{%^^A -% \protected@edef\a{\trim@spaces{#1}}%^^A -% \protected@edef\b{\trim@spaces{#2}}%^^A -% \protected@edef\c{\trim@spaces{#3}}%^^A +% \newcommandx*\MyName[3][1=\@empty, 3=\@empty]{^^A +% \protected@edef\a{\trim@spaces{#1}}^^A +% \protected@edef\b{\trim@spaces{#2}}^^A +% \protected@edef\c{\trim@spaces{#3}}^^A % \ifx\b\empty fail \else % \ifx\a\empty % \ifx\c\empty \hbox to 5em{Mononym:\hfill} {\b}\else @@ -4573,8 +5197,8 @@ the README.txt or README for more information. % \hbox to 5em{Alternate:\hfill} {\c\ \b}\fi % \fi % \fi -% \global\@nameauth@FullNamefalse%^^A -% \global\@nameauth@FirstNamefalse%^^A +% \global\@nameauth@FullNamefalse^^A +% \global\@nameauth@FirstNamefalse^^A % } % \makeatother % \let\MyLName\MyName @@ -4598,29 +5222,30 @@ the README.txt or README for more information. % The previous example is not particularly useful. There is, however, a more practical use for these macros. One could choose to implement additional features, then pass the information in the name argument token registers to the extant parsing macros of \textsf{nameauth} (cf. Section~\ref{sec:Hooksii}). % \newpage % -% Below we introduce formatting that is additional to, inter-operative with, yet distinct from the formatting hooks: +% We continue to use features of \textsf{xargs}, as well as the local scope of a \texttt{quote} environment. Below we introduce formatting that is additional to, inter-operative with, yet distinct from the formatting hooks: +% % \begin{quote}\small % \StartNum % \begin{verbatim} %\makeatletter %\newcommandx*\MyName[3][1=\@empty, 3=\@empty]{% -% \@nameauth@toksa\expandafter{#1}% -% \@nameauth@toksb\expandafter{#2}% -% \@nameauth@toksc\expandafter{#3}% +% \global\@nameauth@toksa\expandafter{#1}% +% \global\@nameauth@toksb\expandafter{#2}% +% \global\@nameauth@toksc\expandafter{#3}% % \hbox to 4em{Normal: \hfill}% % \fcolorbox{black}{gray!25!white}{\@nameauth@Name[#1]{#2}[#3]}% %} %\newcommandx*\MyLName[3][1=\@empty, 3=\@empty]{% -% \@nameauth@toksa\expandafter{#1}% -% \@nameauth@toksb\expandafter{#2}% -% \@nameauth@toksc\expandafter{#3}% +% \global\@nameauth@toksa\expandafter{#1}% +% \global\@nameauth@toksb\expandafter{#2}% +% \global\@nameauth@toksc\expandafter{#3}% % \hbox to 4em{Long: \hfill}% % \fcolorbox{black}{green!25!white}{\@nameauth@Name[#1]{#2}[#3]}% %} %\newcommandx*\MyFName[3][1=\@empty, 3=\@empty]{% -% \@nameauth@toksa\expandafter{#1}% -% \@nameauth@toksb\expandafter{#2}% -% \@nameauth@toksc\expandafter{#3}% +% \global\@nameauth@toksa\expandafter{#1}% +% \global\@nameauth@toksb\expandafter{#2}% +% \global\@nameauth@toksc\expandafter{#3}% % \hbox to 4em{Short: \hfill}% % \fcolorbox{black}{yellow!25!white}{\@nameauth@Name[#1]{#2}[#3]}% %} @@ -4631,28 +5256,27 @@ the README.txt or README for more information. %\renewcommand*\NameauthName{\MyName} %\renewcommand*\NameauthLName{\MyLName} %\renewcommand*\NameauthFName{\MyFName}\end{verbatim} -% % \makeatletter -% \newcommandx*\MyName[3][1=\@empty, 3=\@empty]{%^^A -% \@nameauth@toksa\expandafter{#1}%^^A -% \@nameauth@toksb\expandafter{#2}%^^A -% \@nameauth@toksc\expandafter{#3}%^^A -% \hbox to 4em{Normal: \hfill}%^^A -% \fcolorbox{black}{gray!25!white}{\@nameauth@Name[#1]{#2}[#3]}%^^A +% \newcommandx*\MyName[3][1=\@empty, 3=\@empty]{^^A +% \global\@nameauth@toksa\expandafter{#1}^^A +% \global\@nameauth@toksb\expandafter{#2}^^A +% \global\@nameauth@toksc\expandafter{#3}^^A +% \hbox to 4em{Normal: \hfill}^^A +% \fcolorbox{black}{gray!25!white}{\@nameauth@Name[#1]{#2}[#3]}^^A % } -% \newcommandx*\MyLName[3][1=\@empty, 3=\@empty]{%^^A -% \@nameauth@toksa\expandafter{#1}%^^A -% \@nameauth@toksb\expandafter{#2}%^^A -% \@nameauth@toksc\expandafter{#3}%^^A -% \hbox to 4em{Long: \hfill}%^^A -% \fcolorbox{black}{green!25!white}{\@nameauth@Name[#1]{#2}[#3]}%^^A +% \newcommandx*\MyLName[3][1=\@empty, 3=\@empty]{^^A +% \global\@nameauth@toksa\expandafter{#1}^^A +% \global\@nameauth@toksb\expandafter{#2}^^A +% \global\@nameauth@toksc\expandafter{#3}^^A +% \hbox to 4em{Long: \hfill}^^A +% \fcolorbox{black}{green!25!white}{\@nameauth@Name[#1]{#2}[#3]}^^A % } -% \newcommandx*\MyFName[3][1=\@empty, 3=\@empty]{%^^A -% \@nameauth@toksa\expandafter{#1}%^^A -% \@nameauth@toksb\expandafter{#2}%^^A -% \@nameauth@toksc\expandafter{#3}%^^A -% \hbox to 4em{Short: \hfill}%^^A -% \fcolorbox{black}{yellow!25!white}{\@nameauth@Name[#1]{#2}[#3]}%^^A +% \newcommandx*\MyFName[3][1=\@empty, 3=\@empty]{^^A +% \global\@nameauth@toksa\expandafter{#1}^^A +% \global\@nameauth@toksb\expandafter{#2}^^A +% \global\@nameauth@toksc\expandafter{#3}^^A +% \hbox to 4em{Short: \hfill}^^A +% \fcolorbox{black}{yellow!25!white}{\@nameauth@Name[#1]{#2}[#3]}^^A % } % \makeatother % \renewcommand*\NamesFormat[1]{\hbox to 9em{\hfil\scshape#1\hfil}} @@ -4662,107 +5286,455 @@ the README.txt or README for more information. % \renewcommand*\NameauthFName{\MyFName} % % \smallskip -% |\ForgetName[Adolf]{Harnack}|\ForgetName[Adolf]{Harnack}\\[1ex] +% \cmd{\ForgetName[Adolf]\{Harnack\}}\ForgetName[Adolf]{Harnack}\\[1ex] % \begin{tabular}{@{}rl} -% |\Harnack| & \Harnack\\ -% |\LHarnack[Adolf von]| & \LHarnack[Adolf von]\\ -% |\Harnack| & \Harnack\\ -% |\SHarnack| & \SHarnack\\ +% \cmd{\Harnack} & \Harnack\\ +% \cmd{\LHarnack[Adolf von]} & \LHarnack[Adolf von]\\ +% \cmd{\Harnack} & \Harnack\\ +% \cmd{\SHarnack} & \SHarnack\\ % \end{tabular} -% \end{quote} +% \end{quote}\medskip % -% After\Version{3.3} the name is printed in the body text, the internal macros \emph{globally} set \cmd{\@nameauth@FullNamefalse} and \cmd{\@nameauth@FirstNamefalse}, as well as other flags related to the prefix macros. This prevents certain cases of undocumented behavior in versions of \textsf{nameauth} before 3.3, where resetting flags locally could cause unexpected name forms. If an existing document leverages the local resetting of flags, one can use the \texttt{oldreset} option. Compare Section~\ref{sec:IndexControl}.\medskip +% After\Version{3.3} the name is printed in the body text, the internal macros \emph{globally} set \cmd{\@nameauth@FullNamefalse} and \cmd{\@nameauth@FirstNamefalse}, as well as other flags related to the prefix macros. This prevents certain cases of undocumented behavior in versions of \textsf{nameauth} before 3.3, where resetting flags locally could cause unexpected name forms. If an existing document leverages the local resetting of flags, one can use the \texttt{oldreset} option. Compare Section~\ref{sec:GeneralIndex}.\medskip +% +% Like\Info{\cmd{\global}} many of the macros in this package, these macros can be redefined or used locally within a scope without making global changes to the document unless you specifically use \cmd{\global}. +% \endgroup^^A General format hook redefinition % -% Like\Info{\cmd{\global}} many of the macros in this package, these naming macros can be redefined or used locally within a scope without making global changes to the document unless you specifically use \cmd{\global}. -% % \ReturnLink % \newpage -% \endgroup^^A End of hook macro redefinition. % % \subsection{Technical Notes} % \label{sec:TechNotes} -% -% \hfil This manual was created with -% \fbox{\mystrut\ \bfseries\ifxetex xelatex (pdf)%^^A +% +% \subsubsection{General} +% \label{sec:GenNotes} +% +% About the package itself: +% \begin{itemize} +% \item Current features\Version{3.5} allow \textsf{nameauth} to meet its goals: stability, professional features, and backward-compatibility. +% \begin{itemize} +% \item Internal macros not in a local scope start with \cmd{\@nameauth@}. No more assumptions of ``throwaway'' macro names. +% \item Index control has become stricter and more sensitive to the order of both name and xref creation. +% \item It is now easy to have a separate index of persons when using packages and classes that enable that. +% \item Internals of all macros that handle name arguments use a standard, optimized logic. +% \end{itemize} +% \item We keep \textsf{xargs} for backward compatibility. Future package versions will use \textsf{xparse} instead of \textsf{xargs} and shed all compatibility options. A ``maintenance'' version will be preserved for backward compatibility. +% \item The package works with both \texttt{texindy} and \texttt{makeindex}. +% \end{itemize} +% +% \noindent About the manual (which is the test suite): +% \begin{itemize} +% \item It has been reworked and expanded. Many months of testing has yielded better explanations that reflect best practices. +% \item We now emphasize current workflows and de-emphasize older, less-relevant macros and the obsolete syntax. +% \item It is compatible with both A4 and US letter formats. +% \item We mention when this manual changes package internals, does actions that are not visually discernible, or deviates from ``normal'' usage. +% \end{itemize} +% +% \noindent About package building: +% \begin{itemize} +% \item Consult \texttt{README.md} for building instructions. +% \item The \textsf{nameauth} package requires \textsf{etoolbox}, \textsf{suffix}, \textsf{trimspaces}, and \textsf{xargs}. +% \item The package and manual build on current and older \LaTeX\ distributions. +% \item The \texttt{dvi} test modes (\texttt{latex} and \texttt{dvilualatex}) use \texttt{dvipdf} to make \textit{TikZ} and \textsf{tcolorbox} render properly. The \texttt{pdf} test modes use \texttt{pdflatex}, \texttt{lualatex}, and \texttt{xelatex}. All modes use \texttt{makeindex}. +% \item This release was tested ``officially'' on Linux (Manjaro; vanilla TL 2020 and 2017) and Windows 10 (Mik\TeX). The CTAN release is created with the latest vanilla TL release on Manjaro. +% \end{itemize}\bigskip +% +% \begin{center}\bfseries This manual was created with +% {\ttfamily\ifxetex xelatex (pdf)^^A % \else % \ifluatex -% \ifpdf lualatex (pdf)%^^A -% \else lualatex (dvi)%^^A +% \ifpdf lualatex (pdf)^^A +% \else lualatex (dvi)^^A % \fi % \else -% \ifpdf pdflatex%^^A -% \else latex (dvi)%^^A +% \ifpdf pdflatex^^A +% \else latex (dvi)^^A % \fi % \fi -% \fi\ } +% \fi}.\end{center} % -% \ifDoTikZ\begin{tcolorbox}[colback=white,colframe=nared,adjusted title={\hfil Thanks}]\else -% \begin{center}\large\bfseries Thanks\end{center}\fi -% \noindent Thanks to \Name[Marc van]{Dongen}, \Name[Enrico]{Gregorio}, \Name[Philipp]{Stephani}, \Name*[Heiko]{Oberdiek}, \Name[Uwe]{Lueck}, \Name[Dan]{Luecking} and \Name[Robert]{Schlicht} for assistance in early versions of this package. Thanks also to users for valuable feedback.\vfil -% \ifDoTikZ\end{tcolorbox}\fi -% -% \subsubsection{General} -% \label{sec:GenNotes} -% -% About the package itself: +% \ReturnLink +% \newpage +% +% \subsubsection{Package Warnings} +% \label{sec:Warnings} +% \medskip +% +% \begin{center}\bfseries Standard and Verbose Warnings\end{center} +% Package warnings\Info{Standard warnings} result if one redefines name shorthands in the \texttt{nameauth} environment. That could be a problem. Yet if one uses, for example, a new \texttt{nameauth} environment per chapter, such warnings might be harmless. For example: +% \begin{quote}\small\StartNum +% \begin{verbatim} +%\PretagName[E.\,B.]{White}{White, Elwyn} +%\begin{nameauth} +% \< White & E.B. & White & > % v.1 +% \< White & E.\,B. & White & > % v.2 +%\end{nameauth}\end{verbatim} +%\begin{nameauth} +% \< White & E.B. & White & > +% \< White & E.\,B. & White & > +%\end{nameauth} +% \cmd{\White} gives ``\White''. We lost the first version when we redefined it. We ``forget'' \White\ for later (Section~\ref{sec:NameControl}) with |\ForgetName[E.\,B.]{White}|.\ForgetName[E.\,B.]{White}\footnote{There should be two package warnings for redefining \cmd{\White}. We defined it in the \texttt{dtx} driver, then redefined it twice above.} +% \end{quote} +% +% Additionally,\Version{3.5} the following situations cause package warnings, especially since the indexing macros have been made stricter: % \begin{itemize} -% \item For version 3.2 behavior, use both the \texttt{oldpass} and \texttt{oldreset} options. -% \item For version 2.6 behavior, use \texttt{oldpass}, \texttt{oldreset}, and \texttt{oldAKA}. -% \item The package works with both \texttt{xindy} and \texttt{makeindex}. -% \item Name\Version{3.0} output, index entry creation, and index cross-reference creation occur in independent modules. -% \item Use\Version{3.0} the \texttt{verbose} option for warnings about indexing. -% \item The \texttt{nameauth} environment always will emit warnings as needed. -% \item The\Version{2.6} \texttt{comma} option and the older syntax are no longer restrictive, save with \cmd{\AKA} and its derivatives. See Sections~\ref{sec:Obsolete}, \ref{sec:Affix}, and~\ref{sec:AKA}. -% \item No\Version{2.5} formatting is selected by default. +% \item \emph{Ignore \& reset:} \cmd{\IndexName} and \cmd{\IndexRef} warn if \cmd{\SkipIndex} is active, and they reset its flag unless the \texttt{oldreset} option is used. +% \item \emph{Ignore \& reset:} \cmd{\IndexName} warns if it or a naming macro that contains it was preceded by \cmd{\SeeAlso}, whose Boolean flag is then reset. +% \item \emph{Ignore:} \cmd{\IndexRef} warns if one tries to create a \textit{see} reference from an extant name and ignores the attempt unless the \texttt{oldsee} option is used. +% \item \emph{Ignore:} \cmd{\PretagName} warns if the \texttt{nopretag} option is used and it produces no sort tags in that case. +% \item \emph{Warn:} \cmd{\PName} and \cmd{\PName*} warn if \cmd{\@nameauth@SkipIndextrue} on exit (only if the \texttt{oldreset} option is used). % \end{itemize} -% \noindent About the manual: +% +% Package warnings\Info{Verbose warnings} result from the following \emph{only} when using the \texttt{verbose} option. The macros either allow or ignore certain actions: +% % \begin{itemize} -% \item This manual is the test suite. -% \item This manual is designed for both current and older \LaTeX\ distributions. -% \item This\Version{3.3} manual has been redesigned. -% \item It is compatible with both A4 and US letter formats. -% \item We mention when this manual changes package internals. +% \item \emph{Allow:} \cmd{\ExcludeName} with an extant name. +% \item \emph{Allow:} \cmd{\PretagName} to sort cross-references. +% \item \emph{Allow:}\Version{3.5} \cmd{\IndexRef} with the \texttt{oldsee} option. +% \item \emph{Ignore:} make an index page reference from an xref or excluded name. +% \item \emph{Ignore:} make the same cross-reference multiple times. +% \item \emph{Ignore:} use \cmd{\ExcludeName} with a cross-reference. +% \item \emph{Ignore:} use \Version{3.3} \cmd{\IncludeName} with an xref (but \cmd{\IncludeName*} works. +% \item \emph{Ignore:} use \cmd{\TagName} and \cmd{\UntagName} with a cross-reference. % \end{itemize} -% About package building: +% \ReturnLink +% \newpage +% +% \subsubsection[Debugging/Errors]{Debugging and Avoiding Errors} +% \label{sec:Errors} +% \medskip +% +% \begin{center}\bfseries Debugging Macros\end{center} +% \DescribeMacro{\ShowPattern} +% We use \cmd{\ShowPattern} in Section~\ref{sec:NamePatterns} to illustrate name control patterns. It displays how\Version{3.3} the name arguments create name patterns that form name control sequences. One can debug pattern collisions and other issues with this macro: +% \begin{quote} +% \fbox{ +% \begin{tabular}{l} +% {\Large\strut}\cmd{\ShowPattern}\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate}\\ +% \end{tabular}% +% } +% \end{quote} +% +% Thus, |\texttt{\ShowPattern[Hernando]{de~Soto}}| will produce the output \JustIndex\Soto\texttt{\ShowPattern[Hernando]{de~Soto}}. As we have seen above, using \textsf{inputenc}/\textsf{fontenc} will cause names like |\texttt{\ShowPattern{Boëthius}}| to produce \texttt{\ShowPattern{Boëthius}}\JustIndex\Name{Bo\"ethius}.\medskip +% +% \DescribeMacro{\ShowIdxPageref} +% \cmd{\ShowIdxPageref} displays a full index entry in the text. +% Its counterpart is \cmd{\ShowIdxPageref*}, +% \DescribeMacro{\ShowIdxPageref*} +% which shows a short index entry. Both only show names formatted as page references, even if they are cross-references\Version{3.3}: +% \begin{quote} +% \fbox{ +% \begin{tabular}{l} +% {\Large\strut}\cmd{\ShowIdxPageref\ }\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate}\vspace{-2pt}\\ +% {\Large\strut}\cmd{\ShowIdxPageref*}\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate}\\ +% \end{tabular} +% } +% \end{quote} +% +% Index styles, \cmd{\PretagName}, and \cmd{\TagName} affect the output of \cmd{\ShowIdxPageref}. Active characters and macros appear as printed, not as in \texttt{idx} files. In a normal \LaTeX\ document without hyperlinks, for example, we would get: +% +% \begin{quote}\small +% \StartNum +% \begin{verbatim} +%\PretagName[Hernando]{de~Soto}{Desoto, Hernando} +%\texttt{\ShowIdxPageref[Hernando]{de~Soto}}\\\end{verbatim} +% +% \IndexActual{@}\UntagName[Hernando]{de~Soto} +% \texttt{\ShowIdxPageref[Hernando]{de~Soto}} +% \TagName[Hernando]{de~Soto}{\string|hyperpage} +% \end{quote} +% +% Throughout this manual, \cmd{\ShowIdxPageref*} illustrates basic index entries that do not contain sorting information or tags. The simple index entry of \Name*[Hernando]{de~Soto} is |``\ShowIdxPageref*[Hernando]{de~Soto}''| ``\ShowIdxPageref*[Hernando]{de~Soto}''. +% +% \begin{center}\bfseries Avoiding Common Errors: General\end{center} % \begin{itemize} -% \item The \textsf{nameauth} package requires \textsf{etoolbox}, \textsf{suffix}, \textsf{trimspaces}, and \textsf{xargs}. The \texttt{dtx} file encoding is UTF-8; we assume Unicode support. -% \item We tested this release in \texttt{dvi} mode (\texttt{latex} and \texttt{dvilualatex}), and in \texttt{pdf} mode (\texttt{pdflatex}, \texttt{lualatex}, and \texttt{xelatex}). We used \texttt{makeindex}. -% \item This release has been tested on GNU/Linux (distro TL 2017 and vanilla TL 2019), and Windows (Mik\TeX, using GNU make via Cygwin.) -% \item The release uploaded to CTAN is generated using \texttt{pdflatex} in GNU/Linux. +% \item A missing square bracket or curly brace can cause errors like ``\texttt{Paragraph ended}'' and ``\texttt{Missing} \meta{grouping token} \texttt{inserted.}'' +% \item In the \texttt{nameauth} environment, \cmd{\<} \meta{arg1} \texttt{\&} \meta{arg2} \texttt{\&} \meta{arg3} \texttt{\&} \meta{arg4} \texttt{>}\\ +% is a macro that cannot miss a delimiter, an argument, or an ampersand. +% \item Generally use \cmd{\noexpand} before macros in name arguments, which is required if the macros contain conditional statements. +% \item Ensure that macros and conditionals used in name arguments are defined in the preamble or outermost scope (see below). +% \item Do not format \meta{SNN},\meta{Affix} together as a pair. Format \meta{SNN} and \meta{Affix} separately (Section~\ref{sec:AltFormat}). The comma will segment the input into two arguments, which could cause errors. +% \item Using \cmd{\CapThis} on a name with macros in its arguments while not using alternate formatting (Section~\ref{sec:AltFormat}) could trigger an error. Normally \cmd{\CapThis} also segments the input, which could cause errors. +% \item Something like |\edef\foo{\CapThis\Name{bar}}| will fail. Yet one can use |\CapThis\Name{bar}| as an argument to a macro defined with either \cmd{\edef} or \cmd{\xdef}. +% \item In \texttt{dtx} files, put the \texttt{nameauth} environment and tags in the \texttt{<driver>} section preamble that inputs the \texttt{dtx} file as documentation. +% \item \cmd{\Name\ }\oarg{FNN}\marg{SNN}\texttt{[\cmd{\ignorespaces}]} prints only \meta{SNN}.\\ +% \cmd{\Name*}\oarg{FNN}\marg{SNN, Affix}\texttt{[\cmd{\ignorespaces}]} prints \meta{SNN} \meta{Affix}.\\ +% \cmd{\FName}\oarg{FNN}\marg{SNN}\texttt{[\cmd{\ignorespaces}]} either prints \meta{SNN}\\ +% \hbox{}\qquad or acts like the macro \cmd{\leavevmode}.\\ +% \cmd{\Name\ }\marg{SNN, Affix}\texttt{[\cmd{\ignorespaces}]} prints only \meta{SNN}^^A +% \texttt{\textvisiblespace}.\\ +% \cmd{\FName}\marg{SNN, Affix}\texttt{[\cmd{\ignorespaces}]} either prints \meta{SNN}^^A +% \texttt{\textvisiblespace}\\ +% \hbox{}\qquad or acts like the macros \cmd{\leavevmode}\cmd{\space}. +% \end{itemize} +% +% \begin{center}\bfseries Avoiding Common Errors: Indexing\end{center} +% \begin{itemize} +% \item Be sure to define all \textit{see} references with \cmd{\IndexRef} \emph{before} making any \cmd{\Name} references to them. Otherwise \cmd{\IndexRef} will generate a warning that it could not create a \textit{see} reference. +% \item Be sure to define all \textit{see also} references with \cmd{\SeeAlso}\cmd{\IndexRef} \emph{after} making all needed \cmd{\Name} references to the respective names. Otherwise \cmd{\IndexName} and the naming macros will not create page references to the respective \cmd{\Name} thereafter. +% \item Two names may look identical on the page, but their internal name patterns can differ (Sections~\ref{sec:IndexSort} and~\ref{sec:NamePatterns}). This will create spurious index entries. Check the \texttt{idx} file and possibly use (below). +% \item To fix spurious entries, compare index entries with names in the text. +% \begin{itemize} +% \item Check if naming macros always use the same arguments. +% \item Check sorting tags (\cmd{\PretagName} (Section~\ref{sec:IndexSort}). +% \item Check use of active Unicode characters (Section~\ref{sec:Unicode}). +% \item Use \cmd{\ShowPattern} and \cmd{\ShowIdxPageref} (below). +% \item Check if macros in name arguments did not follow \cmd{\noexpand}. +% \end{itemize} +% \item Check \textsf{nameauth} package warnings. Set the \texttt{verbose} option, which will offer a number of ``informational'' warnings that could be of assistance with the index. +% \end{itemize} +% +% \begin{center}\bfseries Macros in Name Arguments\end{center} +% \begin{itemize} +% \item Use alternate formatting to avoid potential problems, especially when using \cmd{\CapThis} (Sections~\ref{sec:AltFormat}, \ref{sec:Hooksiii}). +% \item Use \cmd{\noexpand}\meta{macro} in name macro arguments as a best practice. This is required for all such macros that contain conditional statements. +% \item Macros used in name arguments must be defined either in the preamble or in the outermost document environment scope to avoid \texttt{Undefined control sequence} errors. +% \item Boolean flags (\texttt{\textbackslash if}\meta{flag}) used in formatting hooks must be defined either in the preamble or in the outermost document scope. +% \item The \cmd{\global} modifier does not work with \cmd{\newif} and \cmd{\newcommand}.\footnote{See \href{https://tex.stackexchange.com/questions/51733/global-renewcommand-equivalent-of-global-def}{this page} on redefining \cmd{\newcommand}, with the caveats that apply.} +% Yet \cmd{\global} can precede a macro defined with \cmd{\newcommand}, and the first \cmd{\def} used therein may be global. +% \end{itemize} +% +% \textit{The \TeX book}, pages 275--277, shows what \cmd{\global} can and cannot do. In the following example, we declare a Boolean flag and a macro in the outer scope, then make several declarations and assignments in the inner scope. After the inner scope ends, we test to see what has happened: +% +% \newif\ifCondA +% \newcommand\MacroA{} +% \begingroup^^A Demo local scope +% \newif\ifCondB +% \global\newif\ifCondC +% \global\newcommand\MacroB{} +% \newcommand\MacroC{\def\MacroD{}} +% \global\MacroC +% \global\CondAtrue +% \endgroup^^A Demo local scope +% \begin{quote}\small +% \StartNum +% \begin{verbatim} +%\newif\ifCondA +%\newcommand\MacroA{} +%\begingroup +% \newif\ifCondB +% \global\newif\ifCondC +% \global\newcommand\MacroB{} +% \newcommand\MacroC{\def\MacroD{}} +% \global\MacroC +% \global\CondAtrue +%\endgroup\end{verbatim} +% \end{quote} +% +%\begin{itemize} +% \item \ifdefined\CondAtrue \texttt{\textbackslash ifCondA} is defined \else \texttt{\textbackslash ifCondA} is not defined \fi in the outer scope (outer definition). +% \item \ifdefined\MacroA \cmd{\MacroA} is \else \cmd{\MacroA} is not \fi defined in the outer scope (outer definition). +% \item \ifdefined\CondBtrue \texttt{\textbackslash ifCondB} is defined \else \texttt{\textbackslash ifCondB} is not defined \fi in the outer scope (local definition). +% \item \ifdefined\CondCtrue \texttt{\textbackslash ifCondC} is defined \else \texttt{\textbackslash ifCondC} is not defined \fi in the outer scope (no \cmd{\global}\cmd{\newif}). +% \item \ifdefined\MacroB \cmd{\MacroB} is defined \else +% \cmd{\MacroB} is not defined \fi in the outer scope (no \cmd{\global}\cmd{\newcommand}). +% \item \cmd{\MacroC} \ifdefined\MacroC is defined \else is not defined \fi in the outer scope (local definition). +% \item \cmd{\MacroD} \ifdefined\MacroD is defined \else is not defined \fi in the outer scope (\cmd{\global} affects \cmd{\def} in \cmd{\MacroC}). +% \item \ifCondA \texttt{\textbackslash ifCondA} is true \else \texttt{\textbackslash ifCondA} is false \fi (\cmd{\global} assignment works, not instantiation). % \end{itemize} +% +% Any macro that is used in the argument of a naming macro must be defined in all scopes in which that name is used. Below we deactivate indexing and show this: +% \begin{quote}\small +% \IndexInactive +% \StartNum +% \begin{verbatim} +%\begin{nameauth} +% \< Testi & & \noexpand\TESTi & > +% \< Testii & & \noexpand\TESTii & > +%\end{nameauth} +%\def\TESTi{Test One} +%\indent \hbox to 10em{(Outer 1) \Testi\hfill} +%\bgroup +% (Inner 1) \Testi\\ +% \def\TESTii{Test Two} +% \hbox to 10em{(Inner 2) \Testii\hfill} +%\egroup +%(Outer 2) \unless\ifdefined\TESTii \cmd{\TESTii} undefined\fi\end{verbatim} +% +%\begin{nameauth} +% \< Testi & & \noexpand\TESTi & > +% \< Testii & & \noexpand\TESTii & > +%\end{nameauth} +%\def\TESTi{Test One} +%\indent \hbox to 10em{(Outer 1) \Testi\hfill} +%\bgroup +% (Inner 1) \Testi\\ +% \def\TESTii{Test Two} +% \hbox to 10em{(Inner 2) \Testii\hfill} +%\egroup +%(Outer 2) \unless\ifdefined\TESTii \cmd{\TESTii} undefined\fi +% \end{quote} + +% \ReturnLink % \newpage +% +% \subsubsection{Obsolete Syntax} +% \label{sec:Obsolete} +% +% This non-Western syntax limits alternate names and xrefs, excludes comma-delimited names, and complicates indexing. It is a ghost of \textsf{nameauth} past. +% \begin{quote} +% \fbox{ +% \begin{tabular}{ll} +% {\Large\strut}\cmd{\Name}\marg{SNN}\oarg{Alternate} & \color{nared}\texttt{\%} \textit{obsolete syntax}\\ +% \end{tabular} +% } +% \end{quote} +% +% \begin{itemize} +% \item One must \emph{leave empty} the first optional \meta{FNN} argument. +% \item One must \emph{never} use the comma-delimited argument \meta{SNN, Affix}. +% \item Instead, these names \emph{always} use the final optional \meta{Alternate} argument, which acts like \meta{Affix} and affects both name and index patterns (Section~\ref{sec:NamePatterns}). +% \item These names take the form \meta{SNN Alternate} in the index. +% \end{itemize} +% In this manual we designate these names with a double dagger (\ddag): +% +% \begin{quote}\small\MyStretch +% |\Name{Henry}[VIII] | {\color{nared}|%| \textit{Ancient}}\\ +% |\Name{Chiang}[Kai-shek] | {\color{nared}|%| \textit{Eastern}}\\ +% |\begin{nameauth}|\\ +% | \< Dagb & & Dagobert & I > | {\color{nared}|%| \textit{Ancient}}\\ +% | \< Yosh & & Yoshida & Shigeru > | {\color{nared}|%| \textit{Eastern}}\\ +% | \< OFukuyama & & |\\ +% | \textUC{Fukuyama} & Takeshi > | {\color{nared}|%| \textit{Alt. format}}\\ +% |\end{nameauth}| +% \end{quote} +% +% \begin{center}\small\PatInfo{\ShowPattern{Henry}[VIII]!MN\break \ShowPattern{Chiang}[Kai-shek]!MN\break \ShowPattern{Dagobert}[I]!MN\break \ShowPattern{Yoshida}[Shigeru]!MN}\MyStretch +% \begin{tabular}{ll}\toprule +% |\ForgetThis\Name{Henry}[VIII]| & \ForgetThis\Name{Henry}[VIII]\ddag\\ +% |\Name{Henry}[VIII]| & \Name{Henry}[VIII]\ddag\\ +% \rowcolor{grey}^^A +% |\ForgetThis\Name{Chiang}[Kai-shek]| & \ForgetThis\Name{Chiang}[Kai-shek]\ddag\\ +% \rowcolor{grey}^^A +% |\Name{Chiang}[Kai-shek]| & \Name{Chiang}[Kai-shek]\ddag\\ +% |\Dagb| & \Dagb\ddag\\ +% |\Dagb| & \Dagb\ddag\\ +% \rowcolor{grey}|\CapName\Yosh| & \CapName\Yosh\ddag\\ +% \rowcolor{grey}|\CapName\RevName\LYosh| & \CapName\RevName\LYosh\ddag\\ +% |\AltFormatActive| \AltFormatActive\\ +% |\ForgetThis\OFukuyama| & \ForgetThis\OFukuyama\ddag\\ +% |\OFukuyama| & \OFukuyama\ddag\\ +% |\AltFormatInactive| \AltFormatInactive\\\bottomrule +% \end{tabular} +% \end{center} +% +% Regardless of its flaws,\Version{2.6} the obsolete syntax shares name patterns, index tags, text tags, and index entries with the current syntax: +% \begin{quote}\small\MyStretch +% \begin{tabular}{@{}lll} +% Obsolete syntax: & \cmd{\ForgetThis}\cmd{\Name\{Henry\}[VIII]} & \ForgetThis\Name{Henry}[VIII]\ddag\\ +% Current syntax: & \cmd{\Name\{Henry, VIII\}} & \Name{Henry, VIII}\\ +% \end{tabular} +% \end{quote} +% +% \ReturnLink +% \bigskip +% +% \subsubsection[Name Patterns]{Name Pattern Overview} +% \label{sec:NamePatterns} +% +% The table below shows how the macro arguments generate name patterns central to \textsf{nameauth}. The \meta{Alternate} argument only affects patterns when using the obsolete syntax. The naming macro arguments create internal control sequences that affect names in both the text and the index:\medskip +% \begin{center}\MyStretch +% \begin{tabular}{lll}\toprule +% Macro Arguments & Patterns & Type\\\midrule +% \rowcolor{grey}\oarg{FNN}\marg{SNN} & \meta{FNN}!\meta{SNN} & \normalfont Western\\ +% \oarg{FNN}\marg{SNN, Affix} & \meta{FNN}!\meta{SNN},\meta{Affix} & \normalfont Western\\ +% \rowcolor{grey}\hphantom{\oarg{FNN}}\marg{SNN, Affix} & \meta{SNN},\meta{Affix} & \normalfont non-Western\\ +% \hphantom{\oarg{FNN}}\marg{SNN}\oarg{Alt} & \meta{SNN},\meta{Alt} & \normalfont obsolete\\ +% \rowcolor{grey}\hphantom{\oarg{FNN}}\marg{SNN} & \meta{SNN} & \normalfont non-Western\\\bottomrule +% \end{tabular} +% \end{center}\medskip +% +% The internal parser \cmd{\@nameauth@Parse} determines the type of name through the presence or absence of certain arguments. Then it assigns name control sequences keyed to the type of name pattern and the current naming system. Other macros do similar tasks with name control sequences associated with other data sets. % -% \subsubsection{Active Unicode} -% \label{sec:Unicode} +% First we show name patterns generated from name elements and the type of name. ``Non-native'' Eastern names are marked by a dagger (\dag); names that use the obsolete syntax are marked by a double dagger (\ddag).\medskip +% \begin{center}\footnotesize\MyStretch +% \begin{tabular}{rll}\toprule +% Macro & Body Text & \cmd{\ShowPattern}\\\midrule +% \rowcolor{grey}\cmd{\ForgetThis}\cmd{\Harnack[Adolf von]} & \ForgetThis\Harnack[Adolf von] & \texttt{\ShowPattern[Adolf]{Harnack}}\\ +% \rowcolor{grey}\cmd{\LHarnack} & \LHarnack & \texttt{\ShowPattern[Adolf]{Harnack}}\\ +% \cmd{\ForgetThis}\cmd{\Pat} & \ForgetThis\Pat & \texttt{\ShowPattern[George S.]{Patton, Jr.}}\\ +% \cmd{\DropAffix}\cmd{\LPat} & \DropAffix\LPat & \texttt{\ShowPattern[George S.]{Patton, Jr.}}\\ +% \rowcolor{grey}\cmd{\ForgetThis}\cmd{\Noguchi} & \ForgetThis\Noguchi & \texttt{\ShowPattern[Hideyo]{Noguchi}}\\ +% \rowcolor{grey}\cmd{\RevName}\cmd{\LNoguchi} & \RevName\LNoguchi\dag & \texttt{\ShowPattern[Hideyo]{Noguchi}}\\ +% \cmd{\ForgetThis}\cmd{\Yamt} & \ForgetThis\Yamt & \texttt{\ShowPattern{Yamamoto,Isoroku}}\\ +% \cmd{\RevName}\cmd{\LYamt} & \RevName\LYamt & \texttt{\ShowPattern{Yamamoto,Isoroku}}\\ +% \rowcolor{grey}\cmd{\ForgetThis}\cmd{\Name\{Henry,VIII\}} & \ForgetThis\Name{Henry,VIII} & \texttt{\ShowPattern{Henry,VIII}}\\ +% \rowcolor{grey}\cmd{\Name*\{Henry\}[VIII]} & \Name*{Henry}[VIII]\ddag & \texttt{\ShowPattern{Henry,VIII}}\\ +% \cmd{\ForgetThis}\cmd{\Dem[I Soter]} & \ForgetThis\Dem[I Soter] & \texttt{\ShowPattern{Demetrius,I}}\\ +% \cmd{\LDem} & \LDem & \texttt{\ShowPattern{Demetrius,I}}\\ +% \rowcolor{grey}\cmd{\ForgetThis}\cmd{\Aris} & \ForgetThis\Aris & \texttt{\ShowPattern{Aristotle}}\\ +% \rowcolor{grey}\cmd{\Aris} & \Aris & \texttt{\ShowPattern{Aristotle}}\\\bottomrule +% \end{tabular} +% \ForgetName{Demetrius, I}\ForgetName[Adolf]{Harnack} +% \end{center}\medskip +% +% \noindent Six suffixes are appended to these patterns to create independent data sets:\medskip +% \begin{center}\small\MyStretch +% \begin{tabular}{llll}\toprule +% Description & Pattern & Mnemonic & Example\\\midrule +% \rowcolor{grey}Front-matter names & \meta{pattern}\texttt{!NF} & ``name front'' & \texttt{\ShowPattern[Adolf]{Harnack}{!NF}}\\ +% Main-matter names & \meta{pattern}\texttt{!MN} & ``main name'' & \texttt{\ShowPattern[Hideyo]{Noguchi}{!MN}}\\ +% \rowcolor{grey}Index cross-refs & \meta{pattern}\texttt{!PN} & ``pseudonym'' & \texttt{\ShowPattern{Yamamoto, Isoroku}{!PN}}\\ +% Index sorting tags & \meta{pattern}\texttt{!PRE} & ``pretag'' & \texttt{\ShowPattern{Henry, VIII}{!PRE}}\\ +% \rowcolor{grey}Index info tags & \meta{pattern}\texttt{!TAG} & ``tag'' & \texttt{\ShowPattern{Demetrius, I}{!TAG}}\\ +% ``Text tag'' database & \meta{pattern}\texttt{!DB} & ``database'' & \texttt{\ShowPattern{Aristotle}{!DB}}\\\bottomrule +% \end{tabular} +% \end{center} +% \newpage +% +% \noindent The following macros \emph{write} to these data sets; others also can read from them: +% \begin{center}\small\MyStretch +% \begin{tabular}{lcccccc}\toprule[1pt] +% Macros & \ttfamily \,!NF\, & \ttfamily \,!MN\, & \ttfamily \,!PN\, & \ttfamily !PRE & \ttfamily !TAG & \ttfamily \,!DB\,\\\midrule +% \cmd{\Name} \cmd{\Name*} \cmd{\FName} & \YES & \YES & \NO & \NO & \NO & \NO\\ +% \cmd{\ForgetName} \cmd{\SubvertName} & \YES & \YES & \NO & \NO & \NO & \NO\\\midrule +% \cmd{\PName}\cmd{\PName*} & \YES & \YES & \YES & \NO & \NO & \NO\\\midrule +% \cmd{\AKA} \cmd{\AKA*} \cmd{\IndexRef} & \NO & \NO & \YES & \NO & \NO & \NO\\ +% \cmd{\ExcludeName} & \NO & \NO & \YES & \NO & \NO & \NO\\ +% \cmd{\IncludeName} \cmd{\IncludeName*} & \NO & \NO & \YES & \NO & \NO & \NO\\\midrule +% \cmd{\PretagName} & \NO & \NO & \NO & \YES & \NO & \NO\\\midrule +% \cmd{\TagName} \cmd{\UntagName} & \NO & \NO & \NO & \NO & \YES & \NO\\\midrule +% \cmd{\NameAddInfo} \cmd{\NameClearInfo} & \NO & \NO & \NO & \NO & \NO & \YES\\\bottomrule +% \end{tabular} +% \end{center}\leavevmode % -% With |\usepackage[T1]{fontenc}| we can use many active Unicode characters automatically.\footnote{As of release, most documents typeset with \texttt{latex} and \texttt{pdflatex} do not require explicit loading of either \textsf{inputenc} or \textsf{inputenx}.} -% We already covered using \cmd{\PretagName} to sort names with these characters (Section~\ref{sec:IndexSort}). -% Below we group by accents and diacritical marks: +% \ReturnLink % -% \begin{center}\small\setstretch{1.4} +% \subsubsection[Active Unicode]{Active Unicode Characters} +% \label{sec:Unicode} +% +% \leavevmode\begin{center}\bfseries General Information\end{center} +% Below we group characters by accents and diacritical marks: +% \begin{center}\large\setstretch{1.3} % \def\Bullet#1{\setbox0\hbox{#1}\raise 0.4ex\hbox to\wd0{\hfil\tiny\textbullet\hfil}} % \def\bullet#1{\setbox0\hbox{#1}\raise 0.2ex\hbox to\wd0{\hfil\tiny\textbullet\hfil}} % \begin{tabular}{lll}\toprule -% acute & Á Ć É Ǵ \Bullet{H} Í Ĺ Ń Ó Ŕ Ś Ú Ý Ź & á ć é ǵ \bullet{h} í ĺ ń ó ŕ ś ú ý ź \strut\\ -% \rowcolor{black!7!white}grave & À \Bullet{C} È \Bullet{G} \Bullet{H} Ì Ò Ù & à \bullet{c} è \bullet{g} \bullet{h} ì ò ù \strut\\ +% acute & Á Ć É Ǵ \Bullet{H} Í Ĺ & á ć é ǵ \bullet{h} í ĺ \strut\\ +% & Ń Ó Ŕ Ś Ú Ý Ź & ń ó ŕ ś ú ý ź \strut\\ +% \rowcolor{grey}grave & À \Bullet{C} È \Bullet{G} \Bullet{H} Ì Ò Ù & à \bullet{c} è \bullet{g} \bullet{h} ì ò ù \strut\\ % circumflex &  Ĉ Ê Ĝ Ĥ Î Ĵ Ô Ŝ Û Ŵ Ŷ & â ĉ ê ĝ ĥ î ĵ ô ŝ û ŵ ŷ \strut\\ -% \rowcolor{black!7!white}tilde & à \Bullet{C} \Bullet{E} \Bullet{G} \Bullet{H} Ĩ Ñ Õ Ũ & ã \bullet{c} \bullet{e} \bullet{g} \Bullet{h} ĩ ñ õ ũ \strut\\ +% \rowcolor{grey}tilde & à \Bullet{C} \Bullet{E} \Bullet{G} \Bullet{H} Ĩ Ñ Õ Ũ & ã \bullet{c} \bullet{e} \bullet{g} \Bullet{h} ĩ ñ õ ũ \strut\\ % diaresis\footnotemark & Ä \Bullet{C} Ë \Bullet{G} \Bullet{H} Ï Ö Ü Ÿ & ä \bullet{c} ë \bullet{g} \bullet{h} ï ö ü ÿ \strut\\ -% \rowcolor{black!7!white}cedilla & \Bullet{A} Ç \Bullet{E} Ģ Ķ Ļ Ņ Ŗ Ş Ţ & \bullet{a} ç \bullet{e} ģ ķ ļ ņ ŗ ş ţ \strut\\ +% \rowcolor{grey}cedilla & \Bullet{A} Ç \Bullet{E} Ģ Ķ Ļ Ņ Ŗ Ş Ţ & \bullet{a} ç \bullet{e} ģ ķ ļ ņ ŗ ş ţ \strut\\ % macron & Ā \Bullet{C} Ē Ḡ \Bullet{H} Ī Ō Ū Ǣ Ȳ & ā \bullet{c} ē ḡ \bullet{h} ī ō ū ǣ ȳ \strut\\ -% \rowcolor{black!7!white}breve & Ă \Bullet{C} \Bullet{E} Ğ \Bullet{H} Ĭ Ŏ Ŭ & ă \bullet{c} \bullet{e} ğ \bullet {h} ĭ ŏ ŭ \strut\\ -% dot\,/\,dotless & Ḃ Ċ Ė Ġ \Bullet{H} İ Ż & ḃ ċ ė ġ \bullet{h} ı ż \strut\\ -% \rowcolor{black!7!white}ogonek & Ą \Bullet{C} Ę \Bullet{G} \Bullet{H} Į Ǫ Ų & ą \bullet{c} ę \bullet{g} \bullet{h} į ǫ ų \strut\\ -% caron & Ǎ Č Ď Ě Ǧ Ǐ Ǩ Ľ Ň Ǒ Ř Š Ť Ǔ Ž & ǎ č ď ě ǧ ǐ ǰ ǩ ľ ň ǒ ř š ť ǔ ž \strut\\ -% \rowcolor{black!7!white}various & Å Æ Ð (eth) Đ (stroke) IJ\ Ł Ŋ & å æ ð đ ij\ ł ŋ \strut\\ -% \rowcolor{black!7!white} & Ø Œ Ő Ů Ű Ș Ț Þ & ø œ ő ů ű ș ß ț þ \strut\\\bottomrule +% \rowcolor{grey}breve & Ă \Bullet{C} \Bullet{E} Ğ \Bullet{H} Ĭ Ŏ Ŭ & ă \bullet{c} \bullet{e} ğ \bullet {h} ĭ ŏ ŭ \strut\\ +% dot/dotless & Ḃ Ċ Ė Ġ \Bullet{H} İ Ż & ḃ ċ ė ġ \bullet{h} ı ż \strut\\ +% \rowcolor{grey}ogonek & Ą \Bullet{C} Ę \Bullet{G} \Bullet{H} Į Ǫ Ų & ą \bullet{c} ę \bullet{g} \bullet{h} į ǫ ų \strut\\ +% caron & Ǎ Č Ď Ě Ǧ Ǐ Ǩ Ľ & ǎ č ď ě ǧ ǐ ǰ ǩ ľ \strut\\ +% & Ň Ǒ Ř Š Ť Ǔ Ž & ň ǒ ř š ť ǔ ž \strut\\ +% \rowcolor{grey}various & Å Æ Ð (eth) Đ (stroke) IJ\ Ł & å æ ð đ ij\ ł \strut\\ +% \rowcolor{grey} & Ŋ Ø Œ Ő Ů Ű Ș Ț Þ & ŋ ø œ ő ů ű ș ß ț þ \strut\\\bottomrule % \end{tabular} % \footnotetext{A diaresis mark is one way to indicate an umlaut, a sound change. German originally used a superscript \textsf{e} over \textsf{a}, \textsf{o}, and \textsf{u}. The cursive form of \textsf{e} simplified to a diaresis mark in the 1800s. A diaresis mark also signals a diaresis: reading a diphthong as two monophthongs.} % \end{center} -% -% Additional Unicode characters can be made available when using fonts with TS1 glyphs (pages 455--463 in \textit{The Latex Companion}). Compare the list: \url{http://tug.ctan.org/info/symbols/comprehensive/} or \texttt{texdoc comprehensive}. +% \newpage +% +% With |\usepackage[T1]{fontenc}|, \texttt{latex} and \texttt{pdflatex} can use many active Unicode characters automatically. Use \cmd{\PretagName} to sort names with these characters (Section~\ref{sec:IndexSort}). Currently, most documents typeset with \texttt{latex} and \texttt{pdflatex} do not require explicit loading of either \textsf{inputenc} or \textsf{inputenx}. +% +% Additional Unicode characters can be made available when using fonts with TS1 glyphs (pages 455--463 in \textit{The Latex Companion}). Compare the list on \href{http://tug.ctan.org/info/symbols/comprehensive/}{this page} or type \texttt{texdoc comprehensive} in a terminal window. +% +% Active Unicode characters work much like macros. When using a font with TS1 glyphs and slots, the following preamble snippet is an example of how one might add more Unicode characters, such as a long s (\textit{s-medialis}): % -% When using a font with TS1 glyphs and slots, the following preamble snippet lets one add more Unicode characters. That enables one to write, ``In Congreſs, July 4, 1776'' as |``In Congreſs, July 4, 1776''|: % \begin{quote}\small % \StartNum % \begin{verbatim} @@ -4772,12 +5744,25 @@ the README.txt or README for more information. %\usepackage{newunicodechar} %\DeclareTextSymbolDefault{\textlongs}{TS1} %\DeclareTextSymbol{\textlongs}{TS1}{115} -%\newunicodechar{ſ}{\textlongs}\end{verbatim} +%\newunicodechar{ſ}{\textlongs} +% +%In Congreſs, July 4, 1776\end{verbatim} +% +%In Congreſs, July 4, 1776 % \end{quote} -% +% % Many\Warn{} Unicode characters have native support in \texttt{xelatex} and \texttt{lualatex}, but not in \texttt{pdflatex}. Yet the latter has certain features (e.g., with respect to \textsf{microtype}) that others lack. The features of \texttt{makeindex} do not always equate to those in \texttt{xindy}. Those differences impact design choices. % -% Before\Warn{} 2018, some index styles excluded characters with macrons, e.g., \textsf{ā}. Even now, control sequences like \cmd{\=a} in the index create undocumented behavior when using \texttt{makeindex} and \texttt{gind.ist}, which changes the ``actual'' character from~\texttt{@} to~\texttt{=}. Since 2018, names like \ifPDFTeX\IfFileExists{utf8-2018.def}{\Name{Ghazāli}}{\Name{Ghazali}}\else\Name{Ghazāli}\fi\ work properly due to new Unicode conventions. We allow for backward compatibility using the \textsf{iftex} package thus: +% \begin{center}\bfseries Compatibility: Old and New\end{center} +% As mentioned\Warn{} in Section~\ref{sec:IndexSort}, before 2018, some index styles could not work with characters that contained macrons: +% \begin{center}\large +% \begin{tabular}{ll} +% Ā Ē Ḡ Ī Ō Ū Ǣ Ȳ & ā ē ḡ ī ō ū ǣ ȳ\\ +% \end{tabular} +% \end{center} +% Since 2018, those restrictions have been removed due to better handling of Unicode characters in \texttt{latex} and \texttt{pdflatex}. +% +% If compiled on a recent version of \LaTeX, one will see a macron in the name below. To allow the manual to compile on older versions, the following code prints a version without the macron as needed: % \begin{quote}\small % \StartNum % \begin{verbatim} @@ -4786,41 +5771,46 @@ the README.txt or README for more information. % {\Name{Ghazāli}}{\Name{Ghazali}}% % \else\Name{Ghazāli}% %\fi\end{verbatim} +% +%\ifPDFTeX^^A +% \IfFileExists{utf8-2018.def}^^A +% {\Name{Ghazāli}}{\Name{Ghazali}}^^A +% \else\Name{Ghazāli}\fi % \end{quote} % +% Even now,\Warn{} although one can use the Unicode characters with macrons, control sequences like \cmd{\=a} in the index will cause undocumented behavior when using \texttt{makeindex} and \texttt{gind.ist}. The latter index style, used for \texttt{dtx} files, changes the ``actual'' character from~\texttt{@} to~\texttt{=}. +% \newpage +% +% \begin{center}\bfseries Fragility of Active Unicode\end{center} % \TeX\Warn{} macros that partition their arguments can break active Unicode characters. Consider the simple macro |\def\foo#1#2#3!{<#1#2><#3>}|. It takes three undelimited arguments and groups the first two, then the third: % % \begin{center}\MyStretch % \def\foo#1#2#3!{<#1#2><#3>} % \begin{tabular}{llll}\toprule % Argument & Macro & Engine & Result\\\midrule -% |abc| & |\foo abc!| & (any) & \foo abc!\\ -% |{æ}bc| & |\foo {æ}bc!| & (any) & \foo {æ}bc!\\ -% |\ae bc| & |\foo \ae bc!| & (any) & \foo \ae bc!\\ -% \rowcolor{black!7!white}|æbc| & |\foo æbc!| & \texttt{xelatex} & \ifxetex\foo æbc!\else<æb><c>\fi\\ -% \rowcolor{black!7!white}|æbc| & |\foo æbc!| & \texttt{lualatex} & \ifluatex\foo æbc!\else<æb><c>\fi\\ -% |æbc| & |\foo æbc!| & \texttt{pdflatex} & \unless\ifxetex\unless\ifluatex\foo æbc!\else<æ><bc>\fi\else<æ><bc>\fi\\ -% |æbc| & |\foo æbc!| & \texttt{latex} & \unless\ifxetex\unless\ifluatex\foo æbc!\else<æ><bc>\fi\else<æ><bc>\fi\\\bottomrule +% \rowcolor{grey}|abc| & |\foo abc!| & (any) & \foo abc!\\ +% \rowcolor{grey}|{æ}bc| & |\foo {æ}bc!| & (any) & \foo {æ}bc!\\ +% \rowcolor{grey}|\ae bc| & |\foo \ae bc!| & (any) & \foo \ae bc!\\ +% |æbc| & |\foo æbc!| & \texttt{xelatex} & \ifxetex\foo æbc!\else<æb><c>\fi\\ +% |æbc| & |\foo æbc!| & \texttt{lualatex} & \ifluatex\foo æbc!\else<æb><c>\fi\\ +% \rowcolor{grey}|æbc| & |\foo æbc!| & \texttt{pdflatex} & \unless\ifxetex\unless\ifluatex\foo æbc!\else<æ><bc>\fi\else<æ><bc>\fi\\ +% \rowcolor{grey}|æbc| & |\foo æbc!| & \texttt{latex} & \unless\ifxetex\unless\ifluatex\foo æbc!\else<æ><bc>\fi\else<æ><bc>\fi\\\bottomrule % \end{tabular} % \end{center} % % The letter \texttt{a} is one argument. Since \texttt{\{æ\}} is in a group, it is one argument. The macro \cmd{\ae} also is one argument. Thus, the first two glyphs are grouped together in |#1#2| and \texttt{c} is left by itself in |#3|. Both \texttt{xelatex} and \texttt{lualatex} likewise treat the Unicode letter \texttt{æ} as one argument. -% +% % In \texttt{latex} and \texttt{pdflatex}, however, \texttt{æ} is an active Unicode control sequence that uses two arguments: |#1#2|. The tail of the input, \texttt{bc}, is crowded into |#3|. Any macro where this |#1#2| pair is divided into |#1| and |#2| will produce one of two errors: \texttt{Unicode char \dots not set up for LaTeX} or \texttt{Argument of \textbackslash UTFviii@two@octets has an extra \}}. % +% \begin{center}\bfseries Testing for Fragility\end{center} % We\Version{3.0} test if \cmd{\Umathchar} is not defined. If so, we check if the leading token of the argument matches the start of an active Unicode control sequence: If \cmd{\@car}\meta{test}\cmd{\@nil} is equal to \cmd{\@car ß}\cmd{\@nil} (page~\pageref{page:CapSystem}) we capitalize |#1#2|, otherwise just |#1|. Should |#1| be a protected macro or something that does not expand to a sequence of letters, we use alternate formatting and \cmd{\AltCaps} (Section~\ref{sec:AltAdvanced}). % -% A\Warn{} macro defined like |\edef\foo{\CapThis\Name{bar}}| will fail. However, |\CapThis\Name{bar}| can be an argument to a macro defined with \cmd{\edef} or \cmd{\xdef}. -% -% \LaTeX\Warn{} removes spaces between undelimited macro arguments, except the trailing argument. We use \cmd{\trim@spaces} to address this in \textsf{nameauth}. Explicit spacing macros change the results, but also require sorting with \cmd{\PretagName}. See also Sections~\ref{sec:ErrorProt} and~\ref{sec:NameParticles}, as well as Section~\ref{sec:IndexSort}. -% % \ReturnLink -% \newpage -% +% % \subsubsection{\LaTeX\ Engines} % \label{sec:TeXengines} -% -% The following preamble snippet lets one build \textsf{nameauth} also with older TL versions. We do not load \texttt{iftex.sty} if it does not exist. We load the transitional packages when \textsf{iftex} is absent or older than 2019:\footnote{A copy of this example is in \texttt{examples.tex}, collocated with this manual.} +% +% This preamble snippet lets us build \textsf{nameauth}, e.g., on TL 2017. We load \texttt{iftex.sty} only if it exists. We load transitional packages when \textsf{iftex} is absent or old:\footnote{A copy of this example is in \texttt{examples.tex}, located with this manual.} % \begin{quote}\small % \StartNum % \begin{verbatim} @@ -4832,17 +5822,21 @@ the README.txt or README for more information. %\fi\end{verbatim} % \end{quote} % -% Next we test for the \LaTeX\ engine and include packages accordingly. We could just include \textsf{inputenc} either way, but we are illustrating a point about testing. Some statements below should be modified, depending on one's workflow. +% If we +% Next we test for the \LaTeX\ engine and include packages accordingly. We could just include \textsf{inputenc} either way, but we are illustrating a point about testing. +% +% Some statements below should be modified at need. The font packages do affect \textsf{nameauth} indirectly. The use of \textit{TikZ} does not, but it is easy to let such concerns also use the test below. With \textsf{fontspec}, Latin Modern is the default. Otherwise, Computer Modern is the default. If we \emph{only} make \texttt{pdf} documents, the test below simplifies to a test for for \cmd{\Umathchar}, then loading either \textsf{fontspec} (success) or \textsf{fontenc} (failure). +% % \begin{quote}\small % \ContinueNum % \begin{verbatim} -%\newif\ifDoTikZ % Perhaps not needed +%\newif\ifDoTikZ % If dvi-only workflow %\ifxetex % \usepackage{fontspec} % \usepackage{polyglossia} % \setdefaultlanguage{american} % Use own language % \usepackage{tikz} -% \DoTikZtrue % Perhaps not needed +% \DoTikZtrue % If dvi-only workflow %\else % \ifluatex % \ifpdf @@ -4850,7 +5844,7 @@ the README.txt or README for more information. % \usepackage{polyglossia} % \setdefaultlanguage{american} % Use own language % \usepackage{tikz} -% \DoTikZtrue % Perhaps not needed +% \DoTikZtrue % If dvi-only workflow % \else % \IfFileExists{utf8-2018.def}{} % {\usepackage[utf8]{inputenc}} @@ -4865,26 +5859,39 @@ the README.txt or README for more information. % \usepackage[TS1,T1]{fontenc} % \usepackage[american]{babel} % Use own language % \usepackage{lmodern} -% \ifpdf % Perhaps not needed -% \usepackage{tikz} -% \DoTikZtrue % Perhaps not needed +% \ifpdf +% \usepackage{tikz} % If dvi-only workflow +% \DoTikZtrue % If dvi-only workflow % \fi % \fi %\fi\end{verbatim} % \end{quote} +% +% To avoid problems, \texttt{\textbackslash ifDoTikZ} can help one conditionally load \textit{TikZ}. One can observe some \texttt{dvi} viewers (e.g., \texttt{yap}, \texttt{dviout}) crash either when loading or at some later point if one loads \textit{TikZ}. Neither \texttt{xdvi} nor \texttt{advi} crash. +% +% Using \texttt{xdvi} or \texttt{advi} (from \href{http://cristal.inria.fr/whizzytex/}{Whizzy\TeX}) may result in certain aspects of \textit{TikZ} not rendering correctly until conversion to \texttt{ps}/\texttt{pdf}. Using either \texttt{dvipdf} or \texttt{dvips} with \texttt{ps2pdf} will fix that. Using \texttt{dvipdfm} does not help here. % \newpage -% -% For the sake of comparing \texttt{dvi} viewers \texttt{xdvi}, \texttt{yap}, and others, we load \textsf{tikz} only when making a \texttt{pdf} because some \texttt{dvi} viewers crash otherwise. This may be wholly unnecessary in a \texttt{dvips} workflow or the like. With \textsf{fontspec}, Latin Modern is the default. If we only make \texttt{pdf} documents, the test simplifies to testing for \cmd{\Umathchar}, then loading either \textsf{fontspec} (success) or \textsf{fontenc} (failure). % -%In the body text we can use something like the test below for \fbox{\ifDoTikZ doing \texttt{pdf} things\else doing \texttt{dvi} things\fi} +% In the body text we can use something like the test below for: +% +% \begin{center}\fbox{\ifxetex doing \texttt{pdf} things\else \ifpdf doing \texttt{pdf} things\else doing \texttt{dvi} things\fi\fi}\end{center} +% % \begin{quote}\small +% \StartNum % \begin{verbatim} -%\ifDoTikZ -% doing \texttt{pdf} things\else -% doing \texttt{dvi} things\fi\end{verbatim} +%\ifxetex +% doing \texttt{pdf} things +%\else +% \ifpdf +% doing \texttt{pdf} things +% \else +% doing \texttt{dvi} things +% \fi +%\fi\end{verbatim} % \end{quote} % % The following equivalent conditional statements can help a macro or just the body text to work under multiple engines: +% % \begin{quote}\small % \StartNum % \begin{verbatim} @@ -4901,7 +5908,7 @@ the README.txt or README for more information. % \fi %\fi\end{verbatim} % \end{quote} -% +% % \begin{quote}\small % \StartNum % \begin{verbatim} @@ -4918,28 +5925,33 @@ the README.txt or README for more information. %\else xelatex% %\fi\end{verbatim} % \end{quote} -% % \ReturnLink % \BigBlank % \newpage -% +% % \StopEventually{^^A +% \FontDebugfalse^^A prevents font debugging errors % \let\emph\oldemph % \newgeometry{textwidth=160mm,textheight=237mm,right=25mm} % \IndexProtect\PrintChanges\newpage\PrintIndex % } -% -% \section{Implementation} -% % \iffalse %<*package> % \fi +% +% \section{Implementation} % \small +% % \subsection{Flags and Registers} +% \begin{center}\normalsize\bfseries General Process Flow Control\end{center} % -% The flags below are grouped according to function. We begin with flow control\medskip +% \noindent{\normalsize\bfseries Warning Levels}\medskip\\ +% This flag controls how many warnings you get. Defaults to few warnings. Verbose gives you plenty of warnings about cross-references and page entries in the index. +% \begin{macrocode} +\newif\if@nameauth@Verbose +% \end{macrocode}\medskip % -% \noindent{\large\bfseries Who Called Me?}\medskip\\ +% \noindent{\normalsize\bfseries Who Called Me?}\medskip\\ % Various macros use these flags to protect against stack overflows or choose the right output. % \begin{macrocode} \newif\if@nameauth@InAKA @@ -4947,16 +5959,29 @@ the README.txt or README for more information. \newif\if@nameauth@Xref % \end{macrocode}\smallskip % -% \noindent{\large\bfseries Core Macro Locks}\medskip\\ -% The macros \cmd{\@nameauth@Name} and \cmd{\AKA}, with some auxiliary macros, process names in a ``locked'' state to avoid a stack overflow. The \texttt{BigLock} always locks the macros, preventing execution. See also Sections~\ref{sec:Hooksii} and~\ref{sec:Hooksiii}. +% \noindent{\normalsize\bfseries Core Macro Locks}\medskip\\ +% \cmd{\@nameauth@Name}, \cmd{\AKA}, and other macros use a lock to avoid a stack overflow. With \texttt{\textbackslash @nameauth@BigLock} one prevents execution. See also Sections~\ref{sec:Hooksii} and~\ref{sec:Hooksiii}. % \begin{macrocode} \newif\if@nameauth@Lock \newif\if@nameauth@BigLock \newif\if@nameauth@InHook % \end{macrocode}\smallskip % -% \noindent{\large\bfseries Indexing}\medskip\\ -% The indexing flags permit or prevent indexing and tags. \cmd{\IndexActive} and \cmd{\IndexInctive} or the \texttt{index} and \texttt{noindex} options toggle the first flag; \cmd{\SkipIndex} toggles the second. \cmd{\JustIndex} toggles the third, which makes the core naming engine act like a call to \cmd{\IndexName}: +% \noindent{\normalsize\bfseries Name Decision Paths}\medskip\\ +% \cmd{\IfMainName}, \cmd{\IfFrontName}, and \cmd{\IfAKA} use locally-scoped paths by default. This flag causes that scoping not to be used. +% \begin{macrocode} +\newif\if@nameauth@GlobalScope +% \end{macrocode}\smallskip +% +% \noindent{\normalsize\bfseries Debugging}\medskip\\ +% Both flags below are used to show name patterns and index entries in the text. +% \begin{macrocode} +\newif\if@nameauth@IdxDebug +\newif\if@nameauth@LongIdxDebug +% \end{macrocode}\smallskip +% +% \noindent{\normalsize\bfseries Indexing}\medskip\\ +% The indexing flags permit or prevent indexing and tags. \cmd{\IndexActive} and \cmd{\IndexInctive} or the \texttt{index} and \texttt{noindex} options toggle the first flag; \cmd{\SkipIndex} toggles the second. \cmd{\JustIndex} toggles the third, which makes the core naming engine \cmd{\@nameauth@Name} act like a call to \cmd{\IndexName}: % \begin{macrocode} \newif\if@nameauth@DoIndex \newif\if@nameauth@SkipIndex @@ -4966,12 +5991,13 @@ the README.txt or README for more information. % \begin{macrocode} \newif\if@nameauth@Pretag % \end{macrocode} -% This flag determines whether \cmd{\IndexRef} creates a \textit{see} reference or a \textit{see also} reference. +% The first flag determines whether \cmd{\IndexRef} creates a \textit{see} reference or a \textit{see also} reference. The second determines how strict to be with \textit{see} references. % \begin{macrocode} \newif\if@nameauth@SeeAlso +\newif\if@nameauth@OldSee % \end{macrocode}\smallskip % -% \noindent{\large\bfseries Formatting}\medskip\\ +% \noindent{\normalsize\bfseries Formatting}\medskip\\ % \cmd{\NamesActive} and \cmd{\NamesInactive}, with the \texttt{mainmatter} and \texttt{frontmatter} options, toggle formatting hooks via \texttt{\textbackslash if@nameauth@MainFormat}. \texttt{\textbackslash if@nameauth@AKAFormat} permits \cmd{\AKA} to call the first-use hooks once. % \begin{macrocode} \newif\if@nameauth@MainFormat @@ -4981,10 +6007,11 @@ the README.txt or README for more information. % \begin{macrocode} \newif\if@nameauth@LocalNames % \end{macrocode}\medskip -% These two flags are used only for backward compatibility. The first broadly determines how per-name flags are reset, while the second affects the behavior of \cmd{\JustIndex}. +% These three flags are used only for backward compatibility. The first broadly determines how per-name flags are reset; the second affects the behavior of \cmd{\JustIndex}; and the third toggles whether or not the name argument token registers are set globally. % \begin{macrocode} \newif\if@nameauth@OldReset \newif\if@nameauth@OldPass +\newif\if@nameauth@OldToks % \end{macrocode}\medskip % These two flags trigger \cmd{\ForgetName} and \cmd{\SubvertName} within \cmd{\@nameauth@Name}. % \begin{macrocode} @@ -4995,11 +6022,11 @@ the README.txt or README for more information. % \begin{macrocode} \newif\if@nameauth@FirstFormat \newif\if@nameauth@AlwaysFormat -% \end{macrocode}\medskip +% \end{macrocode} % -% \noindent Next we move from general flow control to specific modification of name forms.\medskip +% \begin{center}\normalsize\bfseries Specific Name Form Modifications\end{center} % -% \noindent{\large\bfseries Affix Commas}\medskip\\ +% \noindent{\normalsize\bfseries Affix Commas}\medskip\\ % The \texttt{comma} and \texttt{nocomma} options toggle the first flag value below. \cmd{\ShowComma} and \cmd{\NoComma} respectively toggle the second and third. % \begin{macrocode} \newif\if@nameauth@AlwaysComma @@ -5007,20 +6034,20 @@ the README.txt or README for more information. \newif\if@nameauth@NoComma % \end{macrocode}\medskip % -% \noindent{\large\bfseries Name Breaking}\medskip\\ +% \noindent{\normalsize\bfseries Name Breaking}\medskip\\ % \cmd{\KeepAffix} toggles the first flag below, while \cmd{\KeepName} toggles the second. Both affect the use of non-breaking spaces in the text. % \begin{macrocode} \newif\if@nameauth@NBSP \newif\if@nameauth@NBSPX % \end{macrocode}\medskip % -% \noindent{\large\bfseries Detect Punctuation}\medskip\\ +% \noindent{\normalsize\bfseries Detect Punctuation}\medskip\\ % This Boolean value is used to prevent double full stops at the end of a name in the text. % \begin{macrocode} \newif\if@nameauth@Punct % \end{macrocode}\medskip % -% \noindent{\large\bfseries Long and Short Names}\medskip\\ +% \noindent{\normalsize\bfseries Long and Short Names}\medskip\\ % \texttt{\textbackslash if@nameauth@FullName} is true for a long name reference. \texttt{\textbackslash if@nameauth@FirstName} disables full-name references and causes only Western forenames to be displayed. The default is to reset both globally on a per-name basis. % % \texttt{\textbackslash if@nameauth@AltAKA} is toggled respectively by \cmd{\AKA} and \cmd{\AKA*} to print a longer or shorter name. \texttt{\textbackslash if@nameauth@OldAKA} forces the pre-3.0 behavior of \cmd{\AKA*}. @@ -5035,7 +6062,7 @@ the README.txt or README for more information. \newif\if@nameauth@EastFN % \end{macrocode}\medskip % -% \noindent{\large\bfseries Eastern Names}\medskip\\ +% \noindent{\normalsize\bfseries Eastern Names}\medskip\\ % The next flags values govern name reversing and full surname capitalization. The first of each pair is a global state. The second of each pair is an individual state. % \begin{macrocode} \newif\if@nameauth@RevAll @@ -5044,14 +6071,14 @@ the README.txt or README for more information. \newif\if@nameauth@AllThis % \end{macrocode}\medskip % -% \noindent{\large\bfseries Last-Comma-First}\medskip\\ +% \noindent{\normalsize\bfseries Last-Comma-First}\medskip\\ % This pair of flags deals with Western names reordered in a list according to surname. % \begin{macrocode} \newif\if@nameauth@RevAllComma \newif\if@nameauth@RevThisComma % \end{macrocode}\medskip % -% \noindent{\large\bfseries Cap First Letter and Format}\medskip\\ +% \noindent{\normalsize\bfseries Cap First Letter and Format}\medskip\\ % The next flags deal with first-letter capitalization. \cmd{\CapThis} sets the first Boolean value. The second is triggered by \cmd{\@nameauth@UTFtest} when it encounters an active Unicode character. The third is a fallback triggered by \cmd{\AccentCapThis}. The fourth disables \cmd{\CapThis} for alternate formatting. The fifth toggles alternate formatting. % \begin{macrocode} \newif\if@nameauth@DoCaps @@ -5059,37 +6086,31 @@ the README.txt or README for more information. \newif\if@nameauth@Accent \newif\if@nameauth@AltFormat \newif\if@nameauth@DoAlt -% \end{macrocode}\medskip -% -% \noindent{\large\bfseries Warning Levels}\medskip\\ -% This flag controls how many warnings you get. Defaults to few warnings. Verbose gives you plenty of warnings about cross-references in the index. -% \begin{macrocode} -\newif\if@nameauth@Verbose -% \end{macrocode}\medskip +% \end{macrocode} % -% \noindent{\large\bfseries Name Argument Token Registers}\vspace{-1.5ex} +% \begin{center}\normalsize\bfseries Name Argument Token Registers\end{center} % \begin{macro}{\@nameauth@toksa} % \begin{macro}{\@nameauth@toksb} % \begin{macro}{\@nameauth@toksc} % These three token registers contain the current values of the name arguments passed to \cmd{\Name}, its variants, and the cross-reference arguments of \cmd{\AKA}. Users can access them especially in formatting hooks. % \begin{macrocode} -\newtoks\@nameauth@toksa% -\newtoks\@nameauth@toksb% -\newtoks\@nameauth@toksc% +\newtoks\@nameauth@toksa +\newtoks\@nameauth@toksb +\newtoks\@nameauth@toksc % \end{macrocode} % \end{macro} % \end{macro} % \end{macro} % These three token registers contain the current values of the name arguments in each line of the \texttt{nameauth} environment. % \begin{macrocode} -\newtoks\@nameauth@etoksb% -\newtoks\@nameauth@etoksc% -\newtoks\@nameauth@etoksd% +\newtoks\@nameauth@etoksb +\newtoks\@nameauth@etoksc +\newtoks\@nameauth@etoksd % \end{macrocode} % % \subsection{Hooks} % \begin{macro}{\NamesFormat} -% Post-process ``first'' instance of final complete name form in text. See Sections~\ref{sec:Formatting} and~\ref{sec:Hooksi}f. Called when both |\@nameauth@MainFormat| and |\@nameauth@FirstFormat| are true. +% Post-process ``first'' instance of final complete name form in text. See Sections~\ref{sec:Formatting} and~\ref{sec:Hooksi}. Called when both |\@nameauth@MainFormat| and |\@nameauth@FirstFormat| are true. % \begin{macrocode} \newcommand*\NamesFormat{} % \end{macrocode} @@ -5136,36 +6157,46 @@ the README.txt or README for more information. \newcommand*\NameauthFName{\@nameauth@Name} % \end{macrocode} % \end{macro} +% \begin{macro}{\NameauthIndex} +% \changes{3.5}{2020/11/23}{Added} +% Customization hook that allows one to redefine what happens when any naming or indexing function calls the equivalent of \cmd{\index}. See Section~\ref{sec:GeneralIndex}. +% \begin{macrocode} +\newcommand*\NameauthIndex{\index} +% \end{macrocode} +% \end{macro} % % \subsection{Package Options} % The following package options interact with many of the prior Boolean values. % \begin{macrocode} -\DeclareOption{comma}{\@nameauth@AlwaysCommatrue} -\DeclareOption{nocomma}{\@nameauth@AlwaysCommafalse} \DeclareOption{mainmatter}{\@nameauth@MainFormattrue} \DeclareOption{frontmatter}{\@nameauth@MainFormatfalse} +\DeclareOption{alwaysformat}{\@nameauth@AlwaysFormattrue} \DeclareOption{formatAKA}{\@nameauth@AKAFormattrue} -\DeclareOption{oldAKA}{\@nameauth@OldAKAtrue} -\DeclareOption{oldreset}{\@nameauth@OldResettrue} -\DeclareOption{oldpass}{\@nameauth@OldPasstrue} \DeclareOption{index}{\@nameauth@DoIndextrue} \DeclareOption{noindex}{\@nameauth@DoIndexfalse} \DeclareOption{pretag}{\@nameauth@Pretagtrue} \DeclareOption{nopretag}{\@nameauth@Pretagfalse} -\DeclareOption{allcaps}{\@nameauth@AllCapstrue} +\DeclareOption{verbose}{\@nameauth@Verbosetrue} +\DeclareOption{globaltest}{\@nameauth@GlobalScopetrue} +\DeclareOption{oldAKA}{\@nameauth@OldAKAtrue} +\DeclareOption{oldreset}{\@nameauth@OldResettrue} +\DeclareOption{oldpass}{\@nameauth@OldPasstrue} +\DeclareOption{oldtoks}{\@nameauth@OldTokstrue} +\DeclareOption{oldsee}{\@nameauth@OldSeetrue} +\DeclareOption{nocomma}{\@nameauth@AlwaysCommafalse} +\DeclareOption{comma}{\@nameauth@AlwaysCommatrue} \DeclareOption{normalcaps}{\@nameauth@AllCapsfalse} +\DeclareOption{allcaps}{\@nameauth@AllCapstrue} +\DeclareOption{notreversed}% + {\@nameauth@RevAllfalse\@nameauth@RevAllCommafalse} \DeclareOption{allreversed}% {\@nameauth@RevAlltrue\@nameauth@RevAllCommafalse} \DeclareOption{allrevcomma}% {\@nameauth@RevAllfalse\@nameauth@RevAllCommatrue} -\DeclareOption{notreversed}% - {\@nameauth@RevAllfalse\@nameauth@RevAllCommafalse} -\DeclareOption{alwaysformat}{\@nameauth@AlwaysFormattrue} +\DeclareOption{noformat}{\renewcommand*\NamesFormat{}} \DeclareOption{smallcaps}{\renewcommand*\NamesFormat{\scshape}} \DeclareOption{italic}{\renewcommand*\NamesFormat{\itshape}} \DeclareOption{boldface}{\renewcommand*\NamesFormat{\bfseries}} -\DeclareOption{noformat}{\renewcommand*\NamesFormat{}} -\DeclareOption{verbose}{\@nameauth@Verbosetrue} \DeclareOption{altformat}{% \@nameauth@AltFormattrue\@nameauth@DoAlttrue} \ExecuteOptions% @@ -5174,31 +6205,58 @@ the README.txt or README for more information. \ProcessOptions\relax % \end{macrocode} % -% Now we load the required packages. They facilitate the first\,/\,subsequent name uses, the parsing of arguments, and the implementation of starred forms. +% Now we load the required packages. They facilitate the first/subsequent name uses, the parsing of arguments, and the implementation of starred forms. % \begin{macrocode} \RequirePackage{etoolbox} -\RequirePackage{suffix} \RequirePackage{trimspaces} +\RequirePackage{suffix} \RequirePackage{xargs} % \end{macrocode} % -% The \textsf{etoolbox} package is essential for processing name control sequences. Using \textsf{xargs} allows the optional arguments to work. Using \textsf{suffix} facilitated the starred form of macros. Finally, \textsf{trimspaces} helps the fault tolerance of name arguments. -% \BigBlank -% \newpage -% % \subsection{Internal Macros} % \label{sec:InternalMacros} % -% \noindent{\large\bfseries Name Control Sequence: Who Am I?} +% \noindent{\normalsize\bfseries Internal Values} +% \begin{macro}{\@nameauth@Actual} +% \changes{2.0}{2015/11/11}{Added} +% \changes{3.5}{2020/11/23}{Use \cmd{\def}} +% This sets the ``actual'' character used by \textsf{nameauth} for index sorting. This lets one use, for example, |\global\IndexActual{=}|. +% \begin{macrocode} +\def\@nameauth@Actual{@} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\@nameauth@Exclude} +% \changes{3.5}{2020/11/23}{Added} +% This makes an xref into an ``exclusion''. An exclusion is any name control sequence ending in \texttt{!PN} that expands to this value. See \cmd{\ExcludeName}. +% \begin{macrocode} +\newcommand*\@nameauth@Exclude{!} +% \end{macrocode} +% \end{macro} +% +% \noindent{\normalsize\bfseries Name Control Sequence: Who Am I?} % \begin{macro}{\@nameauth@Clean} -% Thanks to \Name*[Heiko]{Oberdiek}, this macro produces a ``sanitized'' string used to make a (hopefully) unique control sequence for a name. We can test the existence of that control string to determine first occurrences of a name or cross-reference. +% Thanks to \Name*[Heiko]{Oberdiek}, this macro produces a ``sanitized'' string to make a control sequence for a name. Testing the existence of that control sequence is the core of \textsf{nameauth}. % \begin{macrocode} \newcommand*\@nameauth@Clean[1] {\expandafter\zap@space\detokenize{#1} \@empty} % \end{macrocode} -% \end{macro}\medskip +% \end{macro} +% +% \begin{macro}{\@nameauth@MakeCS} +% \changes{3.5}{2020/11/23}{Added} +% Unless we are in \cmd{\AKA}, create a name control sequence in the core name engine. +% \begin{macrocode} +\newcommand*\@nameauth@MakeCS[1] +{% + \unless\ifcsname#1\endcsname + \unless\if@nameauth@InAKA\csgdef{#1}{}\fi + \fi +} +% \end{macrocode} +% \end{macro} % -% \noindent{\large\bfseries Parsing: Root and Suffix} +% \noindent{\normalsize\bfseries Parsing: Root and Suffix} % \begin{macro}{\@nameauth@Root} % The following two macros return everything before a comma in \meta{SNN}. % \begin{macrocode} @@ -5219,7 +6277,7 @@ the README.txt or README for more information. % \begin{macro}{\@nameauth@TrimTag} % \changes{3.0}{2016/10/26}{Added} % \changes{3.2}{2017/03/22}{Renamed} -% The following two macros return everything before a vertical bar (\verb+|+) in an index tag. +% The following two macros return everything before a vertical bar (\texttt{\textbar}) in an index tag. % \begin{macrocode} \newcommand*\@nameauth@TrimTag[1]{\@nameauth@@TrimTag#1|\\} % \end{macrocode} @@ -5248,8 +6306,9 @@ the README.txt or README for more information. % \changes{3.2}{2017/03/22}{Renamed} % Throw out the radix; return the suffix with no leading spaces. We use this when printing the suffix. % \begin{macrocode} -\def\@nameauth@@Suffix#1,#2,#3\\% - {\ifx\\#2\\\@empty\else\trim@spaces{#2}\fi} +\def\@nameauth@@Suffix#1,#2,#3\\{% + \ifx\\#2\\\@empty\else\trim@spaces{#2}\fi +} % \end{macrocode} % \end{macro} % @@ -5269,33 +6328,39 @@ the README.txt or README for more information. % \end{macrocode} % \end{macro} % -% \noindent{\large\bfseries Parsing: Capitalization} +% \noindent{\normalsize\bfseries Parsing: Capitalization} % \begin{macro}{\@nameauth@TestToks} % \phantomsection % \label{page:CapSystem} % \changes{3.2}{2017/03/22}{Added} +% \changes{3.5}{2020/11/23} {Fix namespace} % Test if the leading token is the same as the leading token of an active Unicode character, using an \textit{Esszett} (\texttt{ß}) as the control. We only run this macro if we are in the \textsf{inputenc} regime. % \begin{macrocode} \newcommand*\@nameauth@TestToks[1] {% \toks@\expandafter{\@car#1\@nil}% - \edef\one{\the\toks@}% + \edef\@nameauth@one{\the\toks@}% \toks@\expandafter{\@carß\@nil}% - \edef\two{\the\toks@}% - \ifx\one\two\@nameauth@UTFtrue\else\@nameauth@UTFfalse\fi + \edef\@nameauth@two{\the\toks@}% + \ifx\@nameauth@one\@nameauth@two + \@nameauth@UTFtrue% + \else + \@nameauth@UTFfalse% + \fi } % \end{macrocode} % \end{macro} % % \begin{macro}{\@nameauth@UTFtest} % \changes{3.0}{2016/10/26}{Added} -% \changes{3.1}{2017/01/13}{Override bypasses test} +% \changes{3.1}{2017/01/13}{Can skip test} % \changes{3.2}{2017/03/22}{Non-suffix only} -% Before we attempt at capitalizing anything, we need to determine if we are running under \texttt{xelatex} or \texttt{lualatex} by testing for \cmd{\Umathchar}. Then we see if \textsf{inputenc} is loaded. We set up the comparison and pass off to \cmd{\@nameauth@TestToks}. +% \changes{3.5}{2020/11/23}{Fix namespace} +% We choose how to capitalize a letter by determining if we are running under \texttt{xelatex} or \texttt{lualatex}. We test for \cmd{\Umathchar}. Then we see if \textsf{inputenc} is loaded. We set up the comparison and pass off to \cmd{\@nameauth@TestToks}. % \begin{macrocode} \newcommand*\@nameauth@UTFtest[1] {% - \def\testarg{#1}% + \def\@nameauth@testarg{#1}% \ifdefined\Umathchar \@nameauth@UTFfalse% \else @@ -5303,7 +6368,8 @@ the README.txt or README for more information. \if@nameauth@Accent \@nameauth@UTFtrue\@nameauth@Accentfalse% \else - \expandafter\@nameauth@TestToks\expandafter{\testarg}% + \expandafter\@nameauth@TestToks% + \expandafter{\@nameauth@testarg}% \fi \else \@nameauth@UTFfalse% @@ -5315,14 +6381,23 @@ the README.txt or README for more information. % % \begin{macro}{\@nameauth@UTFtestS} % \changes{3.2}{2017/03/22}{Added} +% \changes{3.5}{2020/11/23}{Fix namespace} % This test is like the one above, but a special case when we have a suffix. We have to do a bit more in the way of expansion to get the comparison to work properly. Moreover, we only use this when the regular suffix macro is not \cmd{\@empty}. % \begin{macrocode} \newcommand*\@nameauth@UTFtestS[1] {% - \let\ex\expandafter% - \ex\def\ex\testarg\ex{\@nameauth@GetSuff{#1}}% - \ex\toks@\ex\ex\ex{\testarg}% - \ex\def\ex\test@rg\ex{\the\toks@}% + \expandafter\def\expandafter\@nameauth@testarg% + \expandafter{\@nameauth@GetSuff{#1}}% +% \end{macrocode} +% This following token register assignment looks weird, but it is how we get a test that works. +% \begin{macrocode} + \expandafter\toks@% + \expandafter\expandafter\expandafter{\@nameauth@testarg}% +% \end{macrocode} +% We take that token register and assign its value to a macro to do the test. +% \begin{macrocode} + \expandafter\def\expandafter\@nameauth@test@rg% + \expandafter{\the\toks@}% \ifdefined\Umathchar \@nameauth@UTFfalse% \else @@ -5330,7 +6405,8 @@ the README.txt or README for more information. \if@nameauth@Accent \@nameauth@UTFtrue\@nameauth@Accentfalse% \else - \expandafter\@nameauth@TestToks\expandafter{\test@rg}% + \expandafter\@nameauth@TestToks% + \expandafter{\@nameauth@test@rg}% \fi \else \@nameauth@UTFfalse% @@ -5354,8 +6430,9 @@ the README.txt or README for more information. % \changes{3.2}{2017/03/22}{Renamed, use \cmd{\MakeUppercase}} % Helper macro for the one above. % \begin{macrocode} -\def\@nameauth@C@p#1#2\\% - {\expandafter\trim@spaces\expandafter{\MakeUppercase{#1}#2}} +\def\@nameauth@C@p#1#2\\{% + \expandafter\trim@spaces\expandafter{\MakeUppercase{#1}#2}% +} % \end{macrocode} % \end{macro} % @@ -5372,80 +6449,424 @@ the README.txt or README for more information. % \changes{3.2}{2017/03/22}{Use \cmd{\MakeUppercase}} % Helper macro for the one above. % \begin{macrocode} -\def\@nameauth@C@pUTF#1#2#3\\% - {\expandafter\trim@spaces\expandafter{\MakeUppercase{#1#2}#3}} +\def\@nameauth@C@pUTF#1#2#3\\{% + \expandafter\trim@spaces\expandafter{\MakeUppercase{#1#2}#3}% +} % \end{macrocode} % \end{macro} % -% \noindent{\large\bfseries Parsing: Punctuation Detection} +% \begin{macro}{\@nameauth@CapArgs} +% \changes{3.5}{2020/11/23}{Added} +% Capitalize the first letter of all name arguments. Implements capitalization on demand in the body text (not the index) when not in alternate formatting. We only use this macro in the local scope of \cmd{\@nameauth@Parse}. +% \begin{macrocode} +\newcommand*\@nameauth@CapArgs[3] +{% + \ifdefined\@nameauth@InParser + \unless\if@nameauth@AltFormat + \let\carga\arga% + \let\crootb\rootb% + \let\csuffb\suffb% + \let\cargc\argc% +% \end{macrocode} +% We test the first argument for active Unicode characters, then cap the first letter. +% \begin{macrocode} + \unless\ifx\arga\@empty + \def\test{#1}% + \expandafter\@nameauth@UTFtest\expandafter{\test}% +% \end{macrocode} +% Capitalize the first active Unicode character. +% \begin{macrocode} + \if@nameauth@UTF + \expandafter\def\expandafter\carga\expandafter{% + \expandafter\@nameauth@CapUTF\expandafter{\test}}% +% \end{macrocode} +% Capitalize the first character (not active Unicode). +% \begin{macrocode} + \else + \expandafter\def\expandafter\carga\expandafter{% + \expandafter\@nameauth@Cap\expandafter{\test}}% + \fi + \fi +% \end{macrocode} +% We test the root surname for active Unicode characters, then cap the first letter. +% \begin{macrocode} + \def\test{#2}% + \expandafter\@nameauth@UTFtest\expandafter{\test}% +% \end{macrocode} +% Capitalize the first active Unicode character. +% \begin{macrocode} + \if@nameauth@UTF + \expandafter\def\expandafter\crootb\expandafter{% + \expandafter\@nameauth@CapUTF\expandafter{\rootb}}% +% \end{macrocode} +% Capitalize the first character (not active Unicode). +% \begin{macrocode} + \else + \expandafter\def\expandafter\crootb\expandafter{% + \expandafter\@nameauth@Cap\expandafter{\rootb}}% + \fi +% \end{macrocode} +% We test the suffix for active Unicode characters, then cap the first letter. +% \begin{macrocode} + \unless\ifx\suffb\@empty + \def\test{#2}% + \expandafter\@nameauth@UTFtestS\expandafter{\test}% + \protected@edef\test{\@nameauth@GetSuff{#2}}% +% \end{macrocode} +% Capitalize the first active Unicode character. +% \begin{macrocode} + \if@nameauth@UTF + \protected@edef\test{\@nameauth@Suffix{#2}}% + \expandafter\def\expandafter\csuffb\expandafter{% + \expandafter\@nameauth@CapUTF\expandafter{\test}}% +% \end{macrocode} +% Capitalize the first character (not active Unicode). +% \begin{macrocode} + \else + \edef\@nameauth@test{\@nameauth@Suffix{#2}}% + \expandafter\def\expandafter\csuffb\expandafter{% + \expandafter\@nameauth@Cap\expandafter{\test}}% + \fi + \fi +% \end{macrocode} +% We test the final argument for active Unicode characters, then cap the first letter. +% \begin{macrocode} + \unless\ifx\argc\@empty + \def\test{#3}% + \expandafter\@nameauth@UTFtest\expandafter{\test}% +% \end{macrocode} +% Capitalize the first active Unicode character. +% \begin{macrocode} + \if@nameauth@UTF + \expandafter\def\expandafter\cargc\expandafter{% + \expandafter\@nameauth@CapUTF\expandafter{\test}}% +% \end{macrocode} +% Capitalize the first character (not active Unicode). +% \begin{macrocode} + \else + \expandafter\def\expandafter\cargc\expandafter{% + \expandafter\@nameauth@Cap\expandafter{\test}}% + \fi + \fi +% \end{macrocode} +% Let the arguments be the macros with caps. +% \begin{macrocode} + \let\arga\carga% + \let\rootb\crootb% + \let\suffb\csuffb% + \let\argc\cargc% + \fi + \fi +} +% \end{macrocode} +% \end{macro} +% +% \noindent{\normalsize\bfseries Parsing: Punctuation Detection and Alteration} % \begin{macro}{\@nameauth@TestDot} -% This macro, based on a snippet by \Name*[Uwe]{Lueck}, checks for a period at the end of its argument. It determines whether we need to call \cmd{\@nameauth@CheckDot} below. +% \changes{3.5}{2020/11/23}{Redesigned} +% This macro, based on a snippet by \Name*[Uwe]{Lueck}, checks for a full stop at the end of its argument using the two internal helper macros below. % \begin{macrocode} \newcommand*\@nameauth@TestDot[1] {% - \def\TestDot##1.\TestEnd##2\\{\TestPunct{##2}}% - \def\TestPunct##1{% - \ifx\TestPunct##1\TestPunct% +% \end{macrocode} +% If no full stop is present, \texttt{\#\#1} is associated with the first \cmd{\@End.}. The second \cmd{\@End} gets absorbed as a parameter, leaving \texttt{\#\#2} empty. If a full stop is present, \texttt{\#\#2} will contain it. +% \begin{macrocode} + \def\@nameauth@TestD@t##1.\@End##2\\{\@nameauth@TestPunct{##2}}% +% \end{macrocode} +% The two control sequences are equal if \texttt{\#\#1} is empty (no full stop). If \texttt{\#\#1} is not empty, it sets \cmd{\@nameauth@Puncttrue}, which triggers the call to \cmd{\@nameauth@CheckDot} below. +% \begin{macrocode} + \def\@nameauth@TestPunct##1% + {% + \ifx\@nameauth@TestPunct##1\@nameauth@TestPunct \else - \@nameauth@Puncttrue% + \global\@nameauth@Puncttrue% \fi }% - \@nameauth@Punctfalse% - \TestDot#1\TestEnd.\TestEnd\\% + \global\@nameauth@Punctfalse% + \@nameauth@TestD@t#1\@End.\@End\\% } % \end{macrocode} % \end{macro} % % \begin{macro}{\@nameauth@CheckDot} -% We assume that \cmd{\expandafter} precedes the invocation of \cmd{\@nameauth@CheckDot}, which only is called if the terminal character of the input is a period. We evaluate the lookahead \cmd{\@token} while keeping it on the list of input tokens. +% We assume that \cmd{\expandafter} precedes the invocation of \cmd{\@nameauth@CheckDot}, which only is called if the terminal character of the input is a period. We evaluate the lookahead \cmd{\@nameauth@token} while keeping it on the list of input tokens. % \begin{macrocode} -\newcommand*\@nameauth@CheckDot% - {\futurelet\@token\@nameauth@EvalDot} +\newcommand*\@nameauth@CheckDot + {\futurelet\@nameauth@token\@nameauth@EvalDot} % \end{macrocode} % \end{macro} % % \begin{macro}{\@nameauth@EvalDot} -% If \cmd{\@token} is a full stop, we gobble the token. +% If \cmd{\@nameauth@token} is a full stop, we gobble the next token. Note that we cannot have this conditional statement span more than one line. +% \begin{macrocode} +\newcommand*\@nameauth@EvalDot +{% + \let\@nameauth@stop=.% + \ifx\@nameauth@token\@nameauth@stop\expandafter\@gobble \fi +} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\@nameauth@AddPunct} +% \changes{3.5}{2020/11/23}{Added} +% Here we govern whether spaces between name elements break or not, and whether to add commas or not. This all occurs in the text, not the index. The priority from highest to lowest is no commas, show commas, and always show commas. Much applies only to Western names, thus we check of \meta{FNN} is empty or not. We only use this macro in the local scope of \cmd{\@nameauth@Parse}. +% \begin{macrocode} +\newcommand*\@nameauth@AddPunct +{% + \ifdefined\@nameauth@InParser + \def\Space{ }% + \def\SpaceX{ }% +% \end{macrocode} +% \cmd{\SpaceX} is used for the space between a Western name and an affix, specifically tied to \cmd{\KeepAffix}. \cmd{\Space} is used for all other spaces between name elements. +% \begin{macrocode} + \if@nameauth@NBSP \edef\Space{\nobreakspace}\fi + \if@nameauth@NBSPX \edef\SpaceX{\nobreakspace}\fi +% \end{macrocode} +% Western names have a set of comma-use conventions that differ from all other name forms, so we only use the following logic if \meta{FNN} is not empty, thus, a Western name. +% \begin{macrocode} + \unless\ifx\arga\@empty + \if@nameauth@AlwaysComma + \def\Space{, }% + \if@nameauth@NBSP \edef\Space{,\nobreakspace}\fi + \fi + \if@nameauth@ShowComma + \def\Space{, }% + \if@nameauth@NBSP \edef\Space{,\nobreakspace}\fi + \fi + \if@nameauth@NoComma + \def\Space{ }% + \if@nameauth@NBSP \edef\Space{\nobreakspace}\fi + \fi + \fi + \fi +} +% \end{macrocode} +% \end{macro} +% +% \noindent{\normalsize\bfseries Parsing: Name Argument Loading} +% \begin{macro}{\@nameauth@LoadArgs} +% \changes{3.5}{2020/11/23}{Added} +% Assign name arguments to internal macros to determine name syntax. This is used in all macros that take name arguments. +% \begin{macrocode} +\newcommand*\@nameauth@LoadArgs[3] +{% +% \end{macrocode} +% We want these arguments to expand to \cmd{\@empty} (or not) when we test them. +% \begin{macrocode} + \protected@edef\@nameauth@A{\trim@spaces{#1}}% + \protected@edef\@nameauth@B{\@nameauth@Root{#2}}% + \protected@edef\@nameauth@SB{\@nameauth@Suffix{#2}}% + \protected@edef\@nameauth@C{\trim@spaces{#3}}% +% \end{macrocode} +% Make (usually) unique control sequence values from the name arguments. +% \begin{macrocode} + \def\@nameauth@csb{\@nameauth@Clean{#2}}% + \def\@nameauth@csbc{\@nameauth@Clean{#2,#3}}% + \def\@nameauth@csab{\@nameauth@Clean{#1!#2}}% +} +% \end{macrocode} +% \end{macro} +% +% \noindent{\normalsize\bfseries Parsing: Standard Parsing Logic} +% \begin{macro}{\@nameauth@Choice} +% \changes{3.5}{2020/11/23}{Added} +% This standard logic applies to all macros that take name arguments. +% \begin{macrocode} +\newcommand\@nameauth@Choice[3] +{% + \ifx\@nameauth@A\@empty + \ifx\@nameauth@C\@empty +% \end{macrocode} +% This decision path is for non-Western names. The \texttt{\#1} argument recurs below where \cmd{\@nameauth@SB} is present. Thus, for output to the text, the \texttt{\#1} argument must test both \cmd{\@nameauth@C} and \cmd{\@nameauth@SB}, and swap the former with the latter if necessary. For output to the index or for handling control sequences, one ignores \cmd{\@nameauth@C}. +% \begin{macrocode} + #1% + \else + \ifx\@nameauth@SB\@empty +% \end{macrocode} +% The \texttt{\#2} argument is only for non-Western names that use the obsolete syntax. In the \texttt{\#2} argument \cmd{\@nameauth@SB} never occurs. For indexing and control sequences, one cannot ignore the use of \cmd{\@nameauth@C} in this path. +% \begin{macrocode} + #2% + \else +% \end{macrocode} +% But if both \cmd{\@nameauth@SB} and \cmd{\@nameauth@C} are present, we invoke the \texttt{\#1} argument instead and let it do any further testing and processing. +% \begin{macrocode} + #1% + \fi + \fi + \else +% \end{macrocode} +% This decision path is for Western names. In those cases where one must work with name forms in the text, somewhere in the \texttt{\#3} argument one must test for \cmd{\@nameauth@C} and swap it for \cmd{\@nameauth@A}, as well as accounting for the presence or absence of \cmd{\@nameauth@SB}. Otherwise, for indexing and control sequences, one ignores \cmd{\@nameauth@C} in this path and handles \cmd{\@nameauth@SB} appropriately. +% \begin{macrocode} + #3% + \fi +} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\@nameauth@Flags} +% \changes{3.5}{2020/09/25}{Added} +% Reset flags after the naming macros and \cmd{\AKA} and friends create output in the text. This is not the only place where formatting flags are reset, but the other places in the core naming engine and name parser are special-use cases designed for the use of \cmd{\JustIndex} and macros like \cmd{\PName}. % \begin{macrocode} -\newcommand*\@nameauth@EvalDot% +\newcommand*\@nameauth@Flags {% - \let\@period=.% - \ifx\@token\@period\expandafter\@gobble \fi + \if@nameauth@OldReset +% \end{macrocode} +% The \texttt{oldreset} option implies not only a difference in scope regarding how flags are reset, but it also lets the effects of \cmd{\ForgetThis} and \cmd{\SubvertThis} to pass through \cmd{\AKA} and \cmd{\AKA*}. Regardless, we only reset \texttt{\textbackslash if@nameauth@AltAKA} here due to macros like \cmd{\PName}. +% \begin{macrocode} + \if@nameauth@InAKA + \@nameauth@AltAKAfalse% + \fi + \@nameauth@SkipIndexfalse% + \if@nameauth@InName + \@nameauth@Forgetfalse% + \@nameauth@Subvertfalse% + \fi + \@nameauth@NBSPfalse% + \@nameauth@NBSPXfalse% + \@nameauth@DoCapsfalse% + \@nameauth@Accentfalse% + \@nameauth@AllThisfalse% + \@nameauth@ShowCommafalse% + \@nameauth@NoCommafalse% + \@nameauth@RevThisfalse% + \@nameauth@RevThisCommafalse% + \@nameauth@ShortSNNfalse% + \@nameauth@EastFNfalse% + \else +% \end{macrocode} +% \newpage\noindent +% The current way that the flags are reset makes them both global and more uniform, hopefully eliminating a few chances for errors that might be quite difficult to debug. +% \begin{macrocode} + \if@nameauth@InAKA + \global\@nameauth@AltAKAfalse% + \fi + \global\@nameauth@SkipIndexfalse% + \global\@nameauth@Forgetfalse% + \global\@nameauth@Subvertfalse% + \global\@nameauth@NBSPfalse% + \global\@nameauth@NBSPXfalse% + \global\@nameauth@DoCapsfalse% + \global\@nameauth@Accentfalse% + \global\@nameauth@AllThisfalse% + \global\@nameauth@ShowCommafalse% + \global\@nameauth@NoCommafalse% + \global\@nameauth@RevThisfalse% + \global\@nameauth@RevThisCommafalse% + \global\@nameauth@ShortSNNfalse% + \global\@nameauth@EastFNfalse% + \fi } % \end{macrocode} % \end{macro} % -% \noindent{\large\bfseries Error Detection} +% \noindent{\normalsize\bfseries Error Detection and Debugging} % \begin{macro}{\@nameauth@Error} % \changes{3.0}{2016/10/26}{Added} % \changes{3.01}{2016/10/27}{Fixed} -% One can cause \textsf{nameauth} to halt with an error by leaving a required name argument empty, providing an argument that expands to empty, or creating an empty root within a root\,/\,suffix pair. +% \changes{3.5}{2020/11/23}{Fix namespace} +% One can cause \textsf{nameauth} to halt with an error by leaving a required name argument empty, providing an argument that expands to empty, or creating an empty root within a malformed root/suffix pair. We provide meaningful feedback regarding these cases. % \begin{macrocode} \newcommand*\@nameauth@Error[2] {% - \edef\msga{#2 SNN arg empty}% - \edef\msgb{#2 SNN arg malformed}% - \protected@edef\testname{\trim@spaces{#1}}% - \protected@edef\testroot{\@nameauth@Root{#1}}% - \ifx\testname\@empty - \PackageError{nameauth}{\msga}% + \edef\@nameauth@msga{#2 SNN arg empty}% + \edef\@nameauth@msgb{#2 SNN arg malformed}% + \protected@edef\@nameauth@testname{\trim@spaces{#1}}% + \protected@edef\@nameauth@testroot{\@nameauth@Root{#1}}% + \ifx\@nameauth@testname\@empty + \PackageError{nameauth}{\@nameauth@msga}% \fi - \ifx\testroot\@empty - \PackageError{nameauth}{\msgb}% + \ifx\@nameauth@testroot\@empty + \PackageError{nameauth}{\@nameauth@msgb}% \fi } % \end{macrocode} % \end{macro} -% \newpage % -% \noindent{\large\bfseries Core Name Engine} +% \begin{macro}{\@nameauth@Debug} +% \changes{3.3}{2020/02/20}{added} +% \changes{3.5}{2020/11/23}{use index hook, optimize logic, fix namespace, use Boolean flags} +% In this Swiss-army knife for debugging, we set up a local scope because we make changes that would otherwise affect normal \textsf{nameauth} output. We redefine \cmd{\NameauthIndex} to print an argument in the text instead of the index, and we force indexing to occur. +% \begin{macrocode} +\newcommandx*\@nameauth@Debug[3][1=\@empty, 3=\@empty] +{% + \begingroup% + \def\NameauthIndex##1{##1}% + \@nameauth@DoIndextrue% +% \end{macrocode} +% Process and load the arguments into the appropriate macros. +% \begin{macrocode} + \@nameauth@LoadArgs{#1}{#2}{#3}% + \@nameauth@Error{#2}{macro \string\@nameauth@Debug}% +% \end{macrocode} +% \newpage\noindent +% Below, given \cmd{\@nameauth@IdxDebugfalse} and \cmd{\@nameauth@LongIdxDebugfalse}, we produce the output of \cmd{\ShowPattern}. +% +% Otherwise we locally delete any tag and xref control sequences as needed. They will be restored when the scope ends. If \cmd{\ShowIdxPageref} set \cmd{\@nameauth@IdxDebugtrue} and \cmd{\@nameauth@LongIdxDebugtrue} we produce a full index entry that shows all the tags and the ``actual'' character as well as the name. If \cmd{\ShowIdxPageref*} set \cmd{\@nameauth@IdxDebugtrue} we produce a short index entry that shows only the name. % +% \begin{macrocode} + \@nameauth@Choice% +% \end{macrocode} +% Non-Western names, current syntax. +% \begin{macrocode} + {% + \unless\if@nameauth@IdxDebug + \@nameauth@csb% + \else + \csundef{\@nameauth@csb!PN}% + \unless\if@nameauth@LongIdxDebug + \csundef{\@nameauth@csb!PRE}% + \csundef{\@nameauth@csb!TAG}% + \fi + \IndexName[#1]{#2}[#3]% + \fi + }% +% \end{macrocode} +% Non-Western names, obsolete syntax. +% \begin{macrocode} + {% + \unless\if@nameauth@IdxDebug + \@nameauth@csbc% + \else + \csundef{\@nameauth@csbc!PN}% + \unless\if@nameauth@LongIdxDebug + \csundef{\@nameauth@csbc!PRE}% + \csundef{\@nameauth@csbc!TAG}% + \fi + \IndexName[#1]{#2}[#3]% + \fi + }% +% \end{macrocode} +% Western names. +% \begin{macrocode} + {% + \unless\if@nameauth@IdxDebug + \@nameauth@csab% + \else + \csundef{\@nameauth@csab!PN}% + \unless\if@nameauth@LongIdxDebug + \csundef{\@nameauth@csab!PRE}% + \csundef{\@nameauth@csab!TAG}% + \fi + \IndexName[#1]{#2}[#3]% + \fi + }% +% \end{macrocode} +% We close the scope and reset the flags. +% \begin{macrocode} + \endgroup% + \global\@nameauth@IdxDebugfalse% + \global\@nameauth@LongIdxDebugfalse% +} +% \end{macrocode} +% \end{macro} +% \newpage +% +% \noindent{\normalsize\bfseries Core Name Engine} % \begin{macro}{\@nameauth@Name} -% \changes{0.85}{2012/02/05}{Hide commas} -% \changes{1.5}{2013/02/22}{Reversing\,/\,caps} +% \changes{1.5}{2013/02/22}{Reversing/caps} % \changes{2.0}{2015/11/11}{Trim spaces; fix tags} % \changes{2.1}{2015/11/24}{Fix Unicode} -% \changes{2.3}{2016/01/05}{Internal} +% \changes{2.3}{2016/01/05}{Now internal} % \changes{2.4}{2016/03/15}{Set token regs} % \changes{2.41}{2016/03/17}{Fix token regs} % \changes{2.5}{2016/04/06}{Fix old syntax} @@ -5460,7 +6881,7 @@ the README.txt or README for more information. % \end{macrocode} % Both \cmd{\@nameauth@Name} and \cmd{\AKA} engage the lock below, preventing a stack overflow. Tell the formatting mechanism that it is being called from \cmd{\@nameauth@Name}. % \begin{macrocode} - \if@nameauth@BigLock\@nameauth@Locktrue\fi + \if@nameauth@BigLock \@nameauth@Locktrue\fi \unless\if@nameauth@Lock \@nameauth@Locktrue% \@nameauth@InNametrue% @@ -5488,277 +6909,169 @@ the README.txt or README for more information. \fi \else % \end{macrocode} -% Delete\,/\,create name cseq if directed. If the delete flag is set, the create flag is ignored. Ensure that names are printed in horizontal mode. Wrap the name with two index entries in case a page break occurs between name elements. +% Create or delete name cseq if directed, with deletion override. Ensure that names are printed in horizontal mode. Wrap the name with two index entries in case a page break occurs between name elements. % \begin{macrocode} - \if@nameauth@Forget - \ForgetName[#1]{#2}[#3]% - \else - \if@nameauth@Subvert - \SubvertName[#1]{#2}[#3]% - \fi - \fi + \if@nameauth@Subvert \SubvertName[#1]{#2}[#3]\fi + \if@nameauth@Forget \ForgetName[#1]{#2}[#3]\fi \leavevmode\hbox{}% - \unless\if@nameauth@SkipIndex\IndexName[#1]{#2}[#3]\fi + \unless\if@nameauth@SkipIndex \IndexName[#1]{#2}[#3]\fi \if@nameauth@MainFormat - \@nameauth@Parse[#1]{#2}[#3]{!MN}% + \@nameauth@Parse{#1}{#2}{#3}{!MN}% \else - \@nameauth@Parse[#1]{#2}[#3]{!NF}% + \@nameauth@Parse{#1}{#2}{#3}{!NF}% \fi - \unless\if@nameauth@SkipIndex\IndexName[#1]{#2}[#3]\fi + \unless\if@nameauth@SkipIndex \IndexName[#1]{#2}[#3]\fi % \end{macrocode} -% Reset all the ``per name'' Boolean values. The default is global. +% Reset all the ``per name'' Boolean values after printing a name. The default is global. % \begin{macrocode} - \if@nameauth@OldReset - \@nameauth@SkipIndexfalse% - \@nameauth@Forgetfalse% - \@nameauth@Subvertfalse% - \@nameauth@NBSPfalse% - \@nameauth@NBSPXfalse% - \@nameauth@DoCapsfalse% - \@nameauth@Accentfalse% - \@nameauth@AllThisfalse% - \@nameauth@ShowCommafalse% - \@nameauth@NoCommafalse% - \@nameauth@RevThisfalse% - \@nameauth@RevThisCommafalse% - \@nameauth@ShortSNNfalse% - \@nameauth@EastFNfalse% - \else - \global\@nameauth@SkipIndexfalse% - \global\@nameauth@Forgetfalse% - \global\@nameauth@Subvertfalse% - \global\@nameauth@NBSPfalse% - \global\@nameauth@NBSPXfalse% - \global\@nameauth@DoCapsfalse% - \global\@nameauth@Accentfalse% - \global\@nameauth@AllThisfalse% - \global\@nameauth@ShowCommafalse% - \global\@nameauth@NoCommafalse% - \global\@nameauth@RevThisfalse% - \global\@nameauth@RevThisCommafalse% - \global\@nameauth@ShortSNNfalse% - \global\@nameauth@EastFNfalse% - \fi + \@nameauth@Flags% \fi \@nameauth@Lockfalse% \@nameauth@InNamefalse% % \end{macrocode} -% Close the ``locked'' branch. +% Close the ``locked'' branch and complete the full stop detection and removal. This conditional statement must be on one line. % \begin{macrocode} \fi -% \end{macrocode} -% Call the full stop detection. -% \begin{macrocode} \if@nameauth@Punct\expandafter\@nameauth@CheckDot\fi } % \end{macrocode} % \end{macro} % +% \noindent{\normalsize\bfseries Core Name Engine: Syntactic Element Layer} % \begin{macro}{\@nameauth@Parse} % \changes{3.0}{2016/10/26}{Added} % \changes{3.1}{2017/01/13}{New workflow, caps} % \changes{3.2}{2017/03/22}{Fix alt. format, affixes, use \cmd{\MakeUppercase}} -% Parse and print a name in the text. The final required argument tells us which naming system we are in (Section~\ref{sec:NamePatterns}). Both \cmd{\@nameauth@Name} and \cmd{\AKA} call this parser. +% \changes{3.5}{2020/11/23}{Global token regs, optimize logic, fix namespace} +% Parse and print a name in the text. The final required argument tells us which naming system we are in (Section~\ref{sec:NamePatterns}). Both \cmd{\@nameauth@Name} and \cmd{\AKA} call this parser, which only works in a locked state. % \begin{macrocode} -\newcommandx*\@nameauth@Parse[4][1=\@empty, 3=\@empty] +\newcommand\@nameauth@Parse[4] {% - \if@nameauth@BigLock\@nameauth@Lockfalse\fi + \if@nameauth@BigLock \@nameauth@Lockfalse\fi \if@nameauth@Lock - \let\ex\expandafter% -% \end{macrocode} -% We want these arguments to expand to \cmd{\@empty} (or not) when we test them. -% \begin{macrocode} - \protected@edef\arga{\trim@spaces{#1}}% - \protected@edef\rootb{\@nameauth@Root{#2}}% - \protected@edef\suffb{\@nameauth@Suffix{#2}}% - \protected@edef\argc{\trim@spaces{#3}}% -% \end{macrocode} -% \newpage -% \noindent If global caps. reversing, and commas are true, set the local flags true. -% \begin{macrocode} - \if@nameauth@AllCaps\@nameauth@AllThistrue\fi - \if@nameauth@RevAll\@nameauth@RevThistrue\fi - \if@nameauth@RevAllComma\@nameauth@RevThisCommatrue\fi -% \end{macrocode} -% Make (usually) unique control sequence values from the name arguments. -% \begin{macrocode} - \def\csb{\@nameauth@Clean{#2}}% - \def\csbc{\@nameauth@Clean{#2,#3}}% - \def\csab{\@nameauth@Clean{#1!#2}}% % \end{macrocode} % Make token register copies of the current name args to be available for the hook macros. % \begin{macrocode} - \@nameauth@toksa\expandafter{#1}% - \@nameauth@toksb\expandafter{#2}% - \@nameauth@toksc\expandafter{#3}% -% \end{macrocode} -% Implement capitalization on demand in the body text if not in Continental mode. -% \begin{macrocode} - \if@nameauth@DoCaps - \let\carga\arga% - \let\crootb\rootb% - \let\csuffb\suffb% - \let\cargc\argc% - \unless\if@nameauth@AltFormat + \if@nameauth@OldToks + \@nameauth@toksa\expandafter{#1}% + \@nameauth@toksb\expandafter{#2}% + \@nameauth@toksc\expandafter{#3}% + \else + \global\@nameauth@toksa\expandafter{#1}% + \global\@nameauth@toksb\expandafter{#2}% + \global\@nameauth@toksc\expandafter{#3}% + \fi % \end{macrocode} -% We test the first optarg for active Unicode characters. Then we capitalize the first letter. +% If global caps. reversing, and commas are true, set the per-name flags true. % \begin{macrocode} - \unless\ifx\arga\@empty - \def\test{#1}% - \ex\@nameauth@UTFtest\ex{\test}% - \if@nameauth@UTF - \ex\def\ex\carga\ex{\ex\@nameauth@CapUTF\ex{\test}}% - \else - \ex\def\ex\carga\ex{\ex\@nameauth@Cap\ex{\test}}% - \fi - \fi + \if@nameauth@AllCaps \@nameauth@AllThistrue\fi + \if@nameauth@RevAll \@nameauth@RevThistrue\fi + \if@nameauth@RevAllComma \@nameauth@RevThisCommatrue\fi % \end{macrocode} -% We test the root surname for active Unicode characters. Then we capitalize the first letter. +% Now we enter a local scope where we can use simple control strings without +% needing to worry about collisions. We process and load the arguments into the appropriate macros. % \begin{macrocode} - \def\test{#2}% - \ex\@nameauth@UTFtest\ex{\test}% - \if@nameauth@UTF - \ex\def\ex\crootb\ex{\ex\@nameauth@CapUTF\ex{\rootb}}% - \else - \ex\def\ex\crootb\ex{\ex\@nameauth@Cap\ex{\rootb}}% - \fi + \begingroup% + \def\@nameauth@InParser{}% + \@nameauth@LoadArgs{#1}{#2}{#3}% % \end{macrocode} -% We test the suffix for active Unicode characters. Then we capitalize the first letter. +% Copy the protected control sequences to local, unprotected ones for backward compatibility and readability. % \begin{macrocode} - \unless\ifx\suffb\@empty - \def\test{#2}% - \ex\@nameauth@UTFtestS\ex{\test}% - \protected@edef\test{\@nameauth@GetSuff{#2}}% - \if@nameauth@UTF - \protected@edef\test{\@nameauth@Suffix{#2}}% - \ex\def\ex\csuffb\ex{\ex\@nameauth@CapUTF\ex{\test}}% - \else - \edef\test{\@nameauth@Suffix{#2}}% - \ex\def\ex\csuffb\ex{\ex\@nameauth@Cap\ex{\test}}% - \fi - \fi + \let\arga\@nameauth@A% + \let\rootb\@nameauth@B% + \let\suffb\@nameauth@SB% + \let\argc\@nameauth@C% % \end{macrocode} -% We test the final optarg for active Unicode characters. Then we capitalize the first letter. +% Capitalization on demand in the body text if not in alternate formatting. % \begin{macrocode} - \unless\ifx\argc\@empty - \def\test{#3}% - \ex\@nameauth@UTFtest\ex{\test}% - \if@nameauth@UTF - \ex\def\ex\cargc\ex{\ex\@nameauth@CapUTF\ex{\test}}% - \else - \ex\def\ex\cargc\ex{\ex\@nameauth@Cap\ex{\test}}% - \fi - \fi + \if@nameauth@DoCaps + \@nameauth@CapArgs{#1}{#2}{#3}% \fi - \let\arga\carga% - \let\rootb\crootb% - \let\suffb\csuffb% - \let\argc\cargc% - \fi % \end{macrocode} -% We capitalize the entire surname when desired; different from above. +% We capitalize the entire surname when desired; different from above and overrides it. % \begin{macrocode} - \if@nameauth@AllThis - \protected@edef\rootb{\MakeUppercase{\@nameauth@Root{#2}}}% - \fi + \if@nameauth@AllThis + \protected@edef\rootb% + {\MakeUppercase{\@nameauth@Root{#2}}}% + \fi % \end{macrocode} % Use non-breaking spaces and commas as desired. % \begin{macrocode} - \edef\Space{\space}% - \edef\SpaceX{\space}% - \if@nameauth@NBSP\edef\Space{\nobreakspace}\fi - \if@nameauth@NBSPX\edef\SpaceX{\nobreakspace}\fi - \unless\ifx\arga\@empty - \if@nameauth@AlwaysComma - \edef\Space{,\space}% - \if@nameauth@NBSP\edef\Space{,\nobreakspace}\fi - \fi - \if@nameauth@ShowComma - \edef\Space{,\space}% - \if@nameauth@NBSP\edef\Space{,\nobreakspace}\fi - \fi - \if@nameauth@NoComma - \edef\Space{\space}% - \if@nameauth@NBSP\edef\Space{\nobreakspace}\fi - \fi - \fi + \@nameauth@AddPunct% % \end{macrocode} % We parse names by attaching ``meaning'' to patterns of macro arguments primarily via \cmd{\FNN} and \cmd{\SNN}. Then we call the name printing macros, based on the optional arguments. % \begin{macrocode} - \let\SNN\rootb% - \ifx\arga\@empty - \ifx\argc\@empty + \let\SNN\rootb% + \@nameauth@Choice% % \end{macrocode} -% When \cmd{\arga}, \cmd{\argc}, and \cmd{\suffb} are empty, we have a mononym. When \cmd{\suffb} is not empty, we have a ``native'' Eastern name or non-Western name. +% Non-Western names, current syntax. +% We test \cmd{\argc} and \cmd{\suffb} as needed. % \begin{macrocode} - \let\FNN\suffb% - \let\SNN\rootb% - \@nameauth@NonWest{\csb#4}% - \else + {% + \ifx\argc\@empty + \let\FNN\suffb% + \else + \let\FNN\argc% + \fi + \@nameauth@NonWest{\@nameauth@csb#4}% + \@nameauth@MakeCS{\@nameauth@csb#4}% + }% % \end{macrocode} -% When \cmd{\arga} and \cmd{\suffb} are empty, but \cmd{\argc} is not, we have the older syntax. When \cmd{\arga} is empty, but \cmd{\argc} and \cmd{\suffb} are not, we have alternate names for non-Western names. +% Non-Western names, obsolete syntax. Here \cmd{\argc} is significant. % \begin{macrocode} - \ifx\suffb\@empty - \let\FNN\argc% - \let\SNN\rootb% - \@nameauth@NonWest{\csbc#4}% + {% + \let\FNN\argc% + \@nameauth@NonWest{\@nameauth@csbc#4}% + \@nameauth@MakeCS{\@nameauth@csbc#4}% + }% +% \end{macrocode} +% Western names. +% We test for \cmd{\argc} and swap it for \cmd{\arga} and account for \cmd{\suffb}. +% \begin{macrocode} + {% + \ifx\argc\@empty + \let\FNN\arga% \else \let\FNN\argc% - \let\SNN\rootb% - \@nameauth@NonWest{\csb#4}% \fi - \fi - \else + \unless\ifx\suffb\@empty + \def\SNN{\rootb\Space\suffb}% + \if@nameauth@ShortSNN + \let\SNN\rootb% + \fi + \fi + \@nameauth@West{\@nameauth@csab#4}% + \@nameauth@MakeCS{\@nameauth@csab#4}% + }% % \end{macrocode} -% When \cmd{\arga} is not empty, we have either a Western name or a ``non-native'' Eastern name. When \cmd{\argc} is not empty, we use alternate names. When \cmd{\suffb} is not empty we use suffixed forms. +% We end the local group and reset the flags for name forms here. % \begin{macrocode} - \ifx\argc\@empty - \let\FNN\arga% - \else - \let\FNN\argc% - \fi - \unless\ifx\suffb\@empty - \def\SNN{\rootb\Space\suffb}% - \if@nameauth@ShortSNN\let\SNN\rootb\fi - \fi - \@nameauth@West{\csab#4}% + \endgroup% + \if@nameauth@OldReset + \@nameauth@FullNamefalse% + \@nameauth@FirstNamefalse% + \@nameauth@FirstFormatfalse% + \else + \global\@nameauth@FullNamefalse% + \global\@nameauth@FirstNamefalse% + \global\@nameauth@FirstFormatfalse% \fi \fi } % \end{macrocode} % \end{macro} % +% \noindent{\normalsize\bfseries Core Name Engine: Name Display Layer} % \begin{macro}{\@nameauth@NonWest} % \changes{3.0}{2016/10/26}{Added} % \changes{3.02}{2016/11/01}{Restrict \cmd{\ForceFN}} % \changes{3.3}{2020/02/20}{global flag reset} -% Print non-Western names from \cmd{\@nameauth@name} and \cmd{\AKA}. We inherit internal macros from the parser and do nothing apart from the locked state. +% Arrange forms of non-Western names. We inherit macros from the parser and only use this macro in the local scope of the parser. % \begin{macrocode} \newcommand*\@nameauth@NonWest[1] {% - \if@nameauth@BigLock\@nameauth@Lockfalse\fi - \if@nameauth@Lock - \unless\ifcsname#1\endcsname - \@nameauth@FirstFormattrue% - \fi - \if@nameauth@InAKA - \if@nameauth@AltAKA - \if@nameauth@OldAKA\@nameauth@EastFNtrue\fi - \@nameauth@FullNamefalse% - \@nameauth@FirstNametrue% - \else - \@nameauth@FullNametrue% - \@nameauth@FirstNamefalse% - \fi - \else - \unless\ifcsname#1\endcsname - \@nameauth@FullNametrue% - \@nameauth@FirstNamefalse% - \fi - \fi - \if@nameauth@FirstName - \@nameauth@FullNamefalse% - \fi + \ifdefined\@nameauth@InParser + \@nameauth@Form{#1}% \ifx\FNN\@empty \@nameauth@Hook{\SNN}% \else @@ -5780,19 +7093,6 @@ the README.txt or README for more information. \fi \fi \fi - \unless\ifcsname#1\endcsname - \unless\if@nameauth@InAKA\csgdef{#1}{}\fi - \fi -% \end{macrocode} -% We have to reset these flags here because both the naming and cross-referencing macros use the parser. -% \begin{macrocode} - \if@nameauth@OldReset - \@nameauth@FullNamefalse% - \@nameauth@FirstNamefalse% - \else - \global\@nameauth@FullNamefalse% - \global\@nameauth@FirstNamefalse% - \fi \fi } % \end{macrocode} @@ -5801,32 +7101,12 @@ the README.txt or README for more information. % \begin{macro}{\@nameauth@West} % \changes{3.0}{2016/10/26}{Added} % \changes{3.3}{2020/02/20}{global flag reset} -% Print Western names and ``non-native'' Eastern names from \cmd{\@nameauth@name} and \cmd{\AKA}. We inherit internal macros from the parser and do nothing apart from the locked state. +% Arrange forms of Western names and ``non-native'' Eastern names. We inherit macros from the parser and only use this macro in the local scope of the parser. % \begin{macrocode} \newcommand*\@nameauth@West[1] {% - \if@nameauth@BigLock\@nameauth@Lockfalse\fi - \if@nameauth@Lock - \unless\ifcsname#1\endcsname - \@nameauth@FirstFormattrue% - \fi - \if@nameauth@InAKA - \if@nameauth@AltAKA - \@nameauth@FullNamefalse% - \@nameauth@FirstNametrue% - \else - \@nameauth@FullNametrue% - \@nameauth@FirstNamefalse% - \fi - \else - \unless\ifcsname#1\endcsname - \@nameauth@FullNametrue% - \@nameauth@FirstNamefalse% - \fi - \fi - \if@nameauth@FirstName - \@nameauth@FullNamefalse% - \fi + \ifdefined\@nameauth@InParser + \@nameauth@Form{#1}% \if@nameauth@FullName \if@nameauth@RevThis \@nameauth@Hook{\SNN\SpaceX\FNN}% @@ -5845,230 +7125,165 @@ the README.txt or README for more information. \@nameauth@Hook{\rootb}% \fi \fi + \fi +} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\@nameauth@Form} +% \changes{3.5}{2020/11/23}{Added} +% Set up the flags per the formatting rules for first, subsequent, long, and short uses. We only use this macro in the local scope of the parser. +% \begin{macrocode} +\newcommand*\@nameauth@Form[1] +{% + \ifdefined\@nameauth@InParser +% \end{macrocode} +% If the name does not exist yet or if the \texttt{alwaysformat} option is used, force first-use formatting, force a long name, and inhibit a short name. +% \begin{macrocode} \unless\ifcsname#1\endcsname - \unless\if@nameauth@InAKA\csgdef{#1}{}\fi + \@nameauth@FirstFormattrue% + \@nameauth@FullNametrue% + \@nameauth@FirstNamefalse% + \else + \if@nameauth@AlwaysFormat \@nameauth@FirstFormattrue\fi \fi % \end{macrocode} -% We have to reset these flags here because both the naming and cross-referencing macros use the parser. +% If we are not in \cmd{\AKA}, if a short name form is desired, inhibit a long form. % \begin{macrocode} - \if@nameauth@OldReset - \@nameauth@FullNamefalse% - \@nameauth@FirstNamefalse% + \unless\if@nameauth@InAKA + \if@nameauth@FirstName \@nameauth@FullNamefalse\fi \else - \global\@nameauth@FullNamefalse% - \global\@nameauth@FirstNamefalse% +% \end{macrocode} +% If we are in \cmd{\AKA} use special formatting rules. \cmd{\AKA*} acts like \cmd{\FName}, while \cmd{\AKA} acts like \cmd{\Name*}. Both prefer using the subsequent-use hooks unless the \texttt{formatAKA} option or the \texttt{alwaysformat} option are used. +% \begin{macrocode} + \if@nameauth@AltAKA + \if@nameauth@OldAKA \@nameauth@EastFNtrue\fi + \@nameauth@FullNamefalse% + \@nameauth@FirstNametrue% + \else + \@nameauth@FullNametrue% + \@nameauth@FirstNamefalse% + \fi + \unless\if@nameauth@AlwaysFormat + \unless\if@nameauth@AKAFormat + \@nameauth@FirstFormatfalse% + \fi + \fi \fi \fi } % \end{macrocode} % \end{macro} % -% \noindent{\large\bfseries Format Hook Dispatcher} +% \noindent{\normalsize\bfseries Core Name Engine: Format Hook Dispatcher} % \begin{macro}{\@nameauth@Hook} % \changes{2.4}{2016/03/15}{Current form} % \changes{2.5}{2016/04/06}{Improve hooks} % \changes{3.0}{2016/10/26}{Fix punct. detection} -% Flags help the dispatcher invoke the correct formatting hooks. The flags control which hook is called (first\,/\,subsequent use, name type). The first set of tests handles formatting within \cmd{\AKA}. The second set of tests handles regular name formatting. +% \changes{3.5}{2020/11/23} {Fix namespace} +% Boolean flags control which hook is called (first/subsequent use, name type). We only use this macro in the local scope of the parser. % \begin{macrocode} \newcommand*\@nameauth@Hook[1] {% - \if@nameauth@BigLock\@nameauth@Lockfalse\fi - \if@nameauth@Lock + \ifdefined\@nameauth@InParser +% \end{macrocode} +% We tell the formatting hooks that they are in the hook dispatcher to enable alternate formatting. We test the printed name form to see if it has a trailing full stop. +% \begin{macrocode} \@nameauth@InHooktrue% \protected@edef\test{#1}% \expandafter\@nameauth@TestDot\expandafter{\test}% - \if@nameauth@InAKA - \if@nameauth@AlwaysFormat - \@nameauth@FirstFormattrue% - \else - \unless\if@nameauth@AKAFormat - \@nameauth@FirstFormatfalse\fi - \fi - \if@nameauth@MainFormat - \if@nameauth@FirstFormat - \bgroup\NamesFormat{#1}\egroup% - \else - \bgroup\MainNameHook{#1}\egroup% - \fi + \if@nameauth@MainFormat +% \end{macrocode} +% We use the formatting hooks for the main-matter system. +% \begin{macrocode} + \if@nameauth@FirstFormat + \bgroup\NamesFormat{#1}\egroup% \else - \if@nameauth@FirstFormat - \bgroup\FrontNamesFormat{#1}\egroup% - \else - \bgroup\FrontNameHook{#1}\egroup% - \fi + \bgroup\MainNameHook{#1}\egroup% \fi \else - \if@nameauth@AlwaysFormat - \@nameauth@FirstFormattrue% - \fi - \if@nameauth@MainFormat - \if@nameauth@FirstFormat - \bgroup\NamesFormat{#1}\egroup% - \else - \bgroup\MainNameHook{#1}\egroup% - \fi +% \end{macrocode} +% We use the formatting hooks for the front-matter system. +% \begin{macrocode} + \if@nameauth@FirstFormat + \bgroup\FrontNamesFormat{#1}\egroup% \else - \if@nameauth@FirstFormat - \bgroup\FrontNamesFormat{#1}\egroup% - \else - \bgroup\FrontNameHook{#1}\egroup% - \fi + \bgroup\FrontNameHook{#1}\egroup% \fi \fi % \end{macrocode} -% We have to reset this flag here because both the naming and cross-referencing macros use the parser. +% We tell the formatting hooks that they are not in the hook dispatcher. % \begin{macrocode} - \if@nameauth@OldReset - \@nameauth@FirstFormatfalse% - \else - \global\@nameauth@FirstFormatfalse% - \fi \@nameauth@InHookfalse% \fi } % \end{macrocode} % \end{macro} % -% \noindent{\large\bfseries Indexing Internals} +% \noindent{\normalsize\bfseries Indexing Internals: Entry Formatter} % \begin{macro}{\@nameauth@Index} % \changes{0.94}{2012/02/15}{Added} % \changes{2.0}{2015/11/11}{New tagging} -% \changes{3.3}{2020/02/20}{Tags support hyperref} -% If the indexing flag is true, create an index entry, otherwise do nothing. Add tags automatically if they exist. +% \changes{3.3}{2020/02/20}{Support hyperref} +% \changes{3.5}{2020/11/23}{Fix namespace} +% This is the core index mechanism. If the indexing flag is true, create an index entry, otherwise do nothing. Add any tags automatically if they exist. % \begin{macrocode} \newcommand*\@nameauth@Index[2] {% - \let\ex\expandafter% \if@nameauth@DoIndex +% \end{macrocode} +% If an index tag exists for the entry, get it. Also create a short version of the tag without any vertical bar or trailing macro. If we are creating a cross-reference, use the short tag, otherwise use the long tag. +% \begin{macrocode} \ifcsname#1!TAG\endcsname - \protected@edef\Tag{\csname#1!TAG\endcsname}% - \ex\def\ex\ShortTag\ex{\ex\@nameauth@TrimTag\ex{\Tag}}% + \protected@edef\@nameauth@Tag{\csname#1!TAG\endcsname}% + \expandafter\def\expandafter\@nameauth@ShortTag\expandafter{% + \expandafter\@nameauth@TrimTag\expandafter{\@nameauth@Tag}}% +% \end{macrocode} +% Create entries with a sorting tag and an info tag. +% \begin{macrocode} \ifcsname#1!PRE\endcsname - \protected@edef\Pre{\csname#1!PRE\endcsname}% + \protected@edef\@nameauth@Pre{\csname#1!PRE\endcsname}% \if@nameauth@Xref - \protected@edef\Entry{\Pre#2\ShortTag}% + \protected@edef\@nameauth@IdxEntry% + {\@nameauth@Pre#2\@nameauth@ShortTag}% \else - \protected@edef\Entry{\Pre#2\Tag}% + \protected@edef\@nameauth@IdxEntry% + {\@nameauth@Pre#2\@nameauth@Tag}% \fi \else +% \end{macrocode} +% Create entries with just an info tag. +% \begin{macrocode} \if@nameauth@Xref - \protected@edef\Entry{#2\ShortTag}% + \protected@edef\@nameauth@IdxEntry% + {#2\@nameauth@ShortTag}% \else - \protected@edef\Entry{#2\Tag}% + \protected@edef\@nameauth@IdxEntry% + {#2\@nameauth@Tag}% \fi \fi \else +% \end{macrocode} +% Create entries with just a sorting tag. +% \begin{macrocode} \ifcsname#1!PRE\endcsname - \protected@edef\Pre{\csname#1!PRE\endcsname}% - \protected@edef\Entry{\Pre#2}% + \protected@edef\@nameauth@Pre{\csname#1!PRE\endcsname}% + \protected@edef\@nameauth@IdxEntry{\@nameauth@Pre#2}% \else - \protected@edef\Entry{#2}% + \protected@edef\@nameauth@IdxEntry{#2}% \fi \fi - \ex\index\ex{\Entry}% - \fi -} -% \end{macrocode} -% \end{macro} -% -% \begin{macro}{\@nameauth@Actual} -% \changes{2.0}{2015/11/11}{Added} -% This sets the ``actual'' character used by \textsf{nameauth} for index sorting. -% \begin{macrocode} -\newcommand*\@nameauth@Actual{@} % \end{macrocode} -% \end{macro} -% -% \noindent{\large\bfseries Debugging Help} -% \begin{macro}{\@nameauth@Debug} -% \changes{3.3}{2020/02/20}{added} -% This Swiss-army knife for debugging shows name control sequence patterns, full index entries with tags, and short index entries with just the name. Other macros call it to get the desired info. We set up a local scope, redefine \cmd{\index} to print an argument in the text, force indexing to occur, and ignore whether we are working with xrefs. -% \begin{macrocode} -\newcommandx*\@nameauth@Debug[3][1=\@empty, 3=\@empty] -{% - \bgroup% - \def\index##1{##1}% - \@nameauth@DoIndextrue% - \protected@edef\arga{\trim@spaces{#1}}% - \protected@edef\argc{\trim@spaces{#3}}% - \protected@edef\suffb{\@nameauth@Suffix{#2}}% - \def\csb{\@nameauth@Clean{#2}}% - \def\csbc{\@nameauth@Clean{#2,#3}}% - \def\csab{\@nameauth@Clean{#1!#2}}% - \@nameauth@Error{#2}{macro \string\@nameauth@Debug}% -% \end{macrocode} -% We interleave printing name patterns (\cmd{\ShowPattern}), printing full index entries as if they were page refs (\cmd{\ShowIdxPageref*}), and printing short index entries (\cmd{\ShowIdxPageref}). Since we are in a local scope we delete the tag and xref control sequences as needed. They will be restored when the scope ends. We do not care about xrefs because we just want to see what happens with the name. We can always go to the \texttt{idx} and \texttt{ind} files if needed. +% Create entries with no tag. % \begin{macrocode} - \ifx\arga\@empty - \ifx\argc\@empty - \ifdefined\ShortIdxEntry - \csundef{\csb!PRE}% - \csundef{\csb!TAG}% - \csundef{\csb!PN}% - \IndexName[#1]{#2}[#3]% - \else - \ifdefined\LongIdxEntry - \csundef{\csb!PN}% - \IndexName[#1]{#2}[#3]% - \else - \csb% - \fi - \fi - \else - \ifx\suffb\@empty - \ifdefined\ShortIdxEntry - \csundef{\csbc!PRE}% - \csundef{\csbc!TAG}% - \csundef{\csbc!PN}% - \IndexName[#1]{#2}[#3]% - \else - \ifdefined\LongIdxEntry - \csundef{\csbc!PN}% - \IndexName[#1]{#2}[#3]% - \else - \csbc% - \fi - \fi - \else - \ifdefined\ShortIdxEntry - \csundef{\csb!PRE}% - \csundef{\csb!TAG}% - \csundef{\csb!PN}% - \IndexName[#1]{#2}[#3]% - \else - \ifdefined\LongIdxEntry - \csundef{\csb!PN}% - \IndexName[#1]{#2}[#3]% - \else - \csb% - \fi - \fi - \fi - \fi - \else - \ifdefined\ShortIdxEntry - \csundef{\csab!PRE}% - \csundef{\csab!TAG}% - \csundef{\csab!PN}% - \IndexName[#1]{#2}[#3]% - \else - \ifdefined\LongIdxEntry - \csundef{\csab!PN}% - \IndexName[#1]{#2}[#3]% - \else - \csab% - \fi - \fi - \fi - \global\undef{\LongIdxEntry}% - \global\undef{\ShortIdxEntry}% - \egroup% + \expandafter\NameauthIndex\expandafter{\@nameauth@IdxEntry}% + \fi } % \end{macrocode} % \end{macro} % % \subsection[Prefix Macros]{User Interface Macros: Prefix Macros} -% \noindent{\large\bfseries Syntactic Formatting\,---\,Capitalization} +% \noindent{\normalsize\bfseries Syntactic Formatting\,---\,Capitalization} % \begin{macro}{\CapThis} % \changes{0.94}{2012/02/15}{Added} % Tells the root capping macro to cap the first character of all name elements. @@ -6081,8 +7296,11 @@ the README.txt or README for more information. % \changes{2.1}{2015/11/24}{Added} % Overrides the automatic test for active Unicode characters. This is a fall-back in case the automatic test for active Unicode characters fails. % \begin{macrocode} -\newcommand*\AccentCapThis% - {\@nameauth@Accenttrue\@nameauth@DoCapstrue} +\newcommand*\AccentCapThis +{% + \@nameauth@Accenttrue% + \@nameauth@DoCapstrue% +} % \end{macrocode} % \end{macro} % @@ -6110,7 +7328,7 @@ the README.txt or README for more information. % \end{macrocode} % \end{macro} % -% \noindent{\large\bfseries Syntactic Formatting\,---\,Reversing} +% \noindent{\normalsize\bfseries Syntactic Formatting\,---\,Reversing} % \begin{macro}{\RevName} % \changes{1.5}{2013/02/22}{Added} % Reverse name order. @@ -6143,41 +7361,40 @@ the README.txt or README for more information. % \end{macrocode} % \end{macro} % -% \noindent{\large\bfseries Syntactic Formatting\,---\,Reversing with Commas} +% \noindent{\normalsize\bfseries Syntactic Formatting\,---\,Reversing with Commas} % \begin{macro}{\RevComma} % \changes{1.5}{2013/02/22}{Added} % Last name, comma, first name. % \begin{macrocode} -\newcommand*\RevComma% - {\@nameauth@RevThisCommatrue} +\newcommand*\RevComma{\@nameauth@RevThisCommatrue} % \end{macrocode} % \end{macro} % % \begin{macro}{\ReverseCommaInactive} -% Turn off global ``last-name-comma-first.'' +% Turn off global ``last-name-comma-first''. % \changes{1.5}{2013/02/22}{Added} % \begin{macrocode} -\newcommand*\ReverseCommaInactive% - {\@nameauth@RevAllCommafalse} +\newcommand*\ReverseCommaInactive{\@nameauth@RevAllCommafalse} % \end{macrocode} % \end{macro} % % \begin{macro}{\ReverseCommaActive} -% Turn on global ``last-name-comma-first.'' Activates \cmd{\RevComma} for every name. +% Turn on global ``last-name-comma-first''. Activates \cmd{\RevComma} for every name. % \changes{1.5}{2013/02/22}{Added} % \begin{macrocode} -\newcommand*\ReverseCommaActive% - {\@nameauth@RevAllCommatrue} +\newcommand*\ReverseCommaActive{\@nameauth@RevAllCommatrue} % \end{macrocode} % \end{macro} +% \newpage % -% \noindent{\large\bfseries Alternate Formatting} +% \noindent{\normalsize\bfseries Alternate Formatting} % \phantomsection\label{page:Hooks} % \begin{macro}{\AltFormatActive} % \changes{3.1}{2017/01/13}{Added} % Turn on alternate formatting, engage the formatting macros. % \begin{macrocode} -\newcommand*\AltFormatActive{% +\newcommand*\AltFormatActive +{% \global\@nameauth@AltFormattrue% \global\@nameauth@DoAlttrue% } @@ -6188,7 +7405,8 @@ the README.txt or README for more information. % \changes{3.1}{2017/01/13}{Added} % Turn on alternate formatting, disengage the formatting macros. % \begin{macrocode} -\WithSuffix{\newcommand*}\AltFormatActive*{% +\WithSuffix{\newcommand*}\AltFormatActive* +{% \global\@nameauth@AltFormattrue% \global\@nameauth@DoAltfalse% } @@ -6199,7 +7417,8 @@ the README.txt or README for more information. % Turn off alternate formatting altogether. % \changes{3.1}{2017/01/13}{Added} % \begin{macrocode} -\newcommand*\AltFormatInactive{% +\newcommand*\AltFormatInactive +{% \global\@nameauth@AltFormatfalse% \global\@nameauth@DoAltfalse% } @@ -6210,9 +7429,12 @@ the README.txt or README for more information. % Locally turn on alternate formatting. % \changes{3.1}{2017/01/13}{Added} % \begin{macrocode} -\newcommand*\AltOn{% +\newcommand*\AltOn +{% \if@nameauth@InHook - \if@nameauth@AltFormat\@nameauth@DoAlttrue\fi + \if@nameauth@AltFormat + \@nameauth@DoAlttrue% + \fi \fi } % \end{macrocode} @@ -6222,9 +7444,12 @@ the README.txt or README for more information. % Locally turn off alternate formatting. % \changes{3.1}{2017/01/13}{Added} % \begin{macrocode} -\newcommand*\AltOff{% +\newcommand*\AltOff +{% \if@nameauth@InHook - \if@nameauth@AltFormat\@nameauth@DoAltfalse\fi + \if@nameauth@AltFormat + \@nameauth@DoAltfalse% + \fi \fi } % \end{macrocode} @@ -6235,10 +7460,16 @@ the README.txt or README for more information. % \changes{3.2}{2017/03/22}{Use \cmd{\MakeUppercase}} % Alternate discretionary capping macro triggered by \cmd{\CapThis}. % \begin{macrocode} -\newcommand*\AltCaps[1]{% +\newcommand*\AltCaps[1] +{% \if@nameauth@InHook - \if@nameauth@DoCaps\MakeUppercase{#1}\else#1\fi - \else#1% + \if@nameauth@DoCaps + \MakeUppercase{#1}% + \else + #1% + \fi + \else + #1% \fi } % \end{macrocode} @@ -6248,40 +7479,64 @@ the README.txt or README for more information. % \changes{3.1}{2017/01/13}{Added} % Alternate formatting macro: small caps when active. % \begin{macrocode} -\newcommand*\textSC[1]{% - \if@nameauth@DoAlt\textsc{#1}\else#1\fi} +\newcommand*\textSC[1] +{% + \if@nameauth@DoAlt + \textsc{#1}% + \else + #1% + \fi +} % \end{macrocode} % \end{macro} -% +% % \begin{macro}{\textUC} % \changes{3.1}{2017/01/13}{Added} % \changes{3.2}{2017/03/22}{Use \cmd{\MakeUppercase}} % Alternate formatting macro: uppercase when active. % \begin{macrocode} -\newcommand*\textUC[1]{% - \if@nameauth@DoAlt\MakeUppercase{#1}\else#1\fi} +\newcommand*\textUC[1] +{% + \if@nameauth@DoAlt + \MakeUppercase{#1}% + \else + #1% + \fi +} % \end{macrocode} % \end{macro} -% +% % \begin{macro}{\textIT} % \changes{3.1}{2017/01/13}{Added} % Alternate formatting macro: italic when active. % \begin{macrocode} -\newcommand*\textIT[1]{% - \if@nameauth@DoAlt\textit{#1}\else#1\fi} +\newcommand*\textIT[1] +{% + \if@nameauth@DoAlt + \textit{#1}% + \else + #1% + \fi +} % \end{macrocode} % \end{macro} -% +% % \begin{macro}{\textBF} % \changes{3.1}{2017/01/13}{Added} % Alternate formatting macro: boldface when active. % \begin{macrocode} -\newcommand*\textBF[1]{% - \if@nameauth@DoAlt\textbf{#1}\else#1\fi} +\newcommand*\textBF[1] +{% + \if@nameauth@DoAlt + \textbf{#1}% + \else + #1% + \fi +} % \end{macrocode} % \end{macro} % -% \noindent{\large\bfseries Syntactic Formatting\,---\,Affixes} +% \noindent{\normalsize\bfseries Syntactic Formatting\,---\,Affixes} % \begin{macro}{\ShowComma} % \changes{1.4}{2012/07/24}{Added} % Put comma between name and suffix one time. @@ -6318,11 +7573,15 @@ the README.txt or README for more information. % \changes{3.1}{2017/01/13}{Added} % Use non-breaking spaces between name syntactic forms. % \begin{macrocode} -\newcommand*\KeepName{\@nameauth@NBSPtrue\@nameauth@NBSPXtrue} +\newcommand*\KeepName +{% + \@nameauth@NBSPtrue% + \@nameauth@NBSPXtrue% +} % \end{macrocode} % \end{macro} % -% \noindent{\large\bfseries Post-Processing\,---\,Main Versus Front Matter} +% \noindent{\normalsize\bfseries Post-Processing\,---\,Main Versus Front Matter} % \begin{macro}{\NamesInactive} % Switch to the ``non-formatted'' species of names. % \begin{macrocode} @@ -6337,7 +7596,7 @@ the README.txt or README for more information. % \end{macrocode} % \end{macro} % -% \noindent{\large\bfseries Name Decisions\,---\,First\,/\,Subsequent Reference} +% \noindent{\normalsize\bfseries Name Decisions\,---\,First/Subsequent Reference} % \begin{macro}{\ForgetThis} % \changes{3.1}{2017/01/13}{Added} % Have the naming engine \cmd{\@nameauth@Name} call \cmd{\ForgetName} internally. @@ -6362,7 +7621,23 @@ the README.txt or README for more information. % \end{macrocode} % \end{macro} % -% \noindent{\large\bfseries Name Occurrence Tweaks} +% \begin{macro}{\LocalNameTest} +% \changes{3.5}{2020/11/23}{Added} +% Causes decision paths in the name decision macros to be in a local scope. +% \begin{macrocode} +\newcommand*\LocalNameTest{\global\@nameauth@GlobalScopefalse} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\GlobalNameTest} +% \changes{3.5}{2020/11/23}{Added} +% Causes decision paths in the name decision macros to have no scoping. +% \begin{macrocode} +\newcommand*\GlobalNameTest{\global\@nameauth@GlobalScopetrue} +% \end{macrocode} +% \end{macro} +% +% \noindent{\normalsize\bfseries Name Occurrence Tweaks} % \begin{macro}{\LocalNames} % \changes{2.3}{2016/01/05}{Added} % \changes{2.4}{2016/03/15}{Ensure global} @@ -6381,7 +7656,16 @@ the README.txt or README for more information. % \end{macrocode} % \end{macro} % -% \noindent{\large\bfseries Index Operations} +% \noindent{\normalsize\bfseries Index Operations} +% \begin{macro}{\IndexActual} +% \changes{2.0}{2015/11/11}{Added} +% \changes{3.5}{2020/11/23}{Use \cmd{\def}} +% Change the ``actual'' character from the default. This allows one to use, for example, |\global\IndexActual{=}|. +% \begin{macrocode} +\newcommand*\IndexActual[1]{\def\@nameauth@Actual{#1}} +% \end{macrocode} +% \end{macro} +% % \begin{macro}{\IndexInactive} % \changes{0.94}{2012/02/15}{Added} % Turn off global indexing of names. @@ -6390,6 +7674,14 @@ the README.txt or README for more information. % \end{macrocode} % \end{macro} % +% \begin{macro}{\IndexActive} +% \changes{0.94}{2012/02/15}{Added} +% Turn on global indexing of names. +% \begin{macrocode} +\newcommand*\IndexActive{\@nameauth@DoIndextrue} +% \end{macrocode} +% \end{macro} +% % \begin{macro}{\SkipIndex} % \changes{3.1}{2017/01/13}{Added} % Turn off the next instance of indexing in \cmd{\Name}, \cmd{\FName}, and starred forms. @@ -6406,23 +7698,6 @@ the README.txt or README for more information. % \end{macrocode} % \end{macro} % -% \begin{macro}{\IndexActive} -% \changes{0.94}{2012/02/15}{Added} -% Turn on global indexing of names. -% \begin{macrocode} -\newcommand*\IndexActive{\@nameauth@DoIndextrue} -% \end{macrocode} -% \end{macro} -% -% \begin{macro}{\IndexActual} -% \changes{2.0}{2015/11/11}{Added} -% Change the ``actual'' character from the default. -% \begin{macrocode} -\newcommand*\IndexActual[1] - {\global\renewcommand*\@nameauth@Actual{#1}} -% \end{macrocode} -% \end{macro} -% % \begin{macro}{\SeeAlso} % \changes{3.0}{2016/10/26}{Added} % Change the type of cross-reference from a \textit{see} reference to a \textit{see also} reference. Works once per xref, unless one uses \cmd{\Include*}, in which case, take care! @@ -6435,7 +7710,7 @@ the README.txt or README for more information. % \label{sec:UserInterface} % % \begin{macro}{\ShowPattern} -% \changes{3.3}{2020/02/20}{added} +% \changes{3.3}{2020/02/20}{Added} % This displays the pattern that the name arguments generate; maybe useful for debugging. % \begin{macrocode} \newcommand*\ShowPattern{\@nameauth@Debug} @@ -6443,75 +7718,58 @@ the README.txt or README for more information. % \end{macro} % % \begin{macro}{\ShowIdxPageref} -% \changes{3.3}{2020/02/20}{added} -% This displays the index entry that will be generated. This may be useful for debugging. +% \changes{3.3}{2020/02/20}{Added} +% \changes{3.5}{2020/11/23}{Fix namespace, use Boolean flags} +% This displays (expanded, as printed) the index entry that will be generated, but not exactly what is in the \texttt{idx} file. This may be useful for debugging. % \begin{macrocode} -\newcommand*\ShowIdxPageref% - {\def\LongIdxEntry{}\ShowPattern} +\newcommand*\ShowIdxPageref +{% + \global\@nameauth@IdxDebugtrue% + \global\@nameauth@LongIdxDebugtrue% + \@nameauth@Debug% +} % \end{macrocode} % \end{macro} % % \begin{macro}{\ShowIdxPageref*} -% \changes{3.3}{2020/02/20}{added} -% This displays an index entry with no tag. This may be useful for debugging. +% \changes{3.3}{2020/02/20}{Added} +% \changes{3.5}{2020/11/23}{Fix namespace, use Boolean flags} +% This displays a basic index entry with no tag. This may be useful for debugging. % \begin{macrocode} -\WithSuffix{\newcommand*}\ShowIdxPageref*% - {\def\ShortIdxEntry{}\ShowPattern} +\WithSuffix{\newcommand*}\ShowIdxPageref* +{% + \global\@nameauth@IdxDebugtrue% + \@nameauth@Debug% +} % \end{macrocode} % \end{macro} % % \begin{macro}{\NameParser} % \changes{3.0}{2016/10/26}{Added} -% \changes{3.03}{2016/11/01}{First name only for short forms} +% \changes{3.03}{2016/11/01}{Restrict first names} % \changes{3.1}{2017/01/13}{Fix old syntax; add NBSP} % \changes{3.2}{2017/03/22}{Fix alt. format, affixes} -% Generate a name form based on the current state of the \textsf{nameauth} macros in the locked path. Available for use only in the hook macros. +% \changes{3.5}{2020/11/23}{Optimize logic} +% Generate a name form based on the current state of the \textsf{nameauth} macros in the locked path. Available for use only in the hook macros. We only use this macro in the local scope of the parser. % \begin{macrocode} \newcommand*\NameParser {% \if@nameauth@InHook \let\SNN\rootb% - \ifx\arga\@empty + \@nameauth@Choice% % \end{macrocode} -% If the first optarg is empty, it is a non-Western name. The forename will be either the suffix or the final optarg. +% Non-Western names. +% We test both \cmd{\argc} and \cmd{\suffb} as needed. % \begin{macrocode} + {% \ifx\argc\@empty \let\FNN\suffb% \else \let\FNN\argc% \fi - \ifx\suffb\@empty -% \end{macrocode} -% Mononym case -% \begin{macrocode} - \ifx\FNN\@empty - \SNN% - \else -% \end{macrocode} -% Eastern or ancient name, using the older syntax, with name reversing and forcing -% \begin{macrocode} - \if@nameauth@FullName% - \if@nameauth@RevThis - \FNN\Space\SNN% - \else - \SNN\Space\FNN% - \fi - \else - \if@nameauth@FirstName - \if@nameauth@EastFN - \FNN% - \else - \SNN% - \fi - \else - \SNN% - \fi - \fi - \fi + \ifx\FNN\@empty + \SNN% \else -% \end{macrocode} -% Eastern or ancient name, using the new syntax, with name reversing and forcing -% \begin{macrocode} \if@nameauth@FullName \if@nameauth@RevThis \FNN\Space\SNN% @@ -6530,10 +7788,36 @@ the README.txt or README for more information. \fi \fi \fi - \else + }% +% \end{macrocode} +% Non-Western names, obsolete syntax. +% Using \cmd{\argc} in this path affects indexing. +% \begin{macrocode} + {% + \let\FNN\argc% + \if@nameauth@FullName% + \if@nameauth@RevThis + \FNN\Space\SNN% + \else + \SNN\Space\FNN% + \fi + \else + \if@nameauth@FirstName + \if@nameauth@EastFN + \FNN% + \else + \SNN% + \fi + \else + \SNN% + \fi + \fi + }% % \end{macrocode} -% Western name with name reversing and suffixes +% Western names. +% We test for \cmd{\argc} and swap it for \cmd{\arga}, and account for \cmd{\suffb}. % \begin{macrocode} + {% \ifx\argc\@empty \let\FNN\arga% \else @@ -6541,7 +7825,9 @@ the README.txt or README for more information. \fi \unless\ifx\suffb\@empty \def\SNN{\rootb\Space\suffb}% - \if@nameauth@ShortSNN\let\SNN\rootb\fi% + \if@nameauth@ShortSNN + \let\SNN\rootb% + \fi% \fi \if@nameauth@FullName \if@nameauth@RevThis @@ -6561,15 +7847,14 @@ the README.txt or README for more information. \SNN% \fi \fi - \fi + }% \fi } % \end{macrocode} % \end{macro} % -% \noindent{\large\bfseries Traditional Naming Interface} +% \noindent{\normalsize\bfseries Traditional Naming Interface} % \begin{macro}{\Name} -% \changes{2.3}{2016/01/05}{Interface macro} % \cmd{\Name} calls \cmd{\NameauthName}, the interface hook. % \begin{macrocode} \newcommand\Name{\NameauthName} @@ -6577,36 +7862,39 @@ the README.txt or README for more information. % \end{macro} % % \begin{macro}{\Name*} -% \changes{2.3}{2016/01/05}{Interface macro} % \cmd{\Name*} sets up a long name reference and calls \cmd{\NameauthLName}, the interface hook. % \begin{macrocode} -\WithSuffix{\newcommand*}\Name*% - {\@nameauth@FullNametrue\NameauthLName} +\WithSuffix{\newcommand*}\Name* +{% + \@nameauth@FullNametrue% + \NameauthLName% +} % \end{macrocode} % \end{macro} % % \begin{macro}{\FName} % \changes{0.9}{2012/02/10}{Added} -% \changes{2.3}{2016/01/05}{Interface macro} % \cmd{\FName} sets up a short name reference and calls \cmd{\NameauthFName}, the interface hook. % \begin{macrocode} -\newcommand\FName{\@nameauth@FirstNametrue\NameauthFName} +\newcommand\FName +{% + \@nameauth@FirstNametrue% + \NameauthFName% +} % \end{macrocode} % \end{macro} % % \begin{macro}{\FName*} -% \changes{2.3}{2016/01/05}{Interface macro} % \cmd{\FName} and \cmd{\FName*} are identical in function. % \begin{macrocode} -\WithSuffix{\newcommand*}\FName*% - {\@nameauth@FirstNametrue\NameauthFName} +\WithSuffix{\newcommand*}\FName*{\FName} % \end{macrocode} % \end{macro} -% -% \noindent{\large\bfseries Index Operations} +% +% \noindent{\normalsize\bfseries Index Operations} % \begin{macro}{\IndexProtect} -% \changes{3.3}{2020/02/20}{added} -% We shut down all output from the naming and indexing macros to protect against problems in the index in case a macro in an index entry should expand into one of the naming macros. +% \changes{3.3}{2020/02/20}{Added} +% We shut down all output from the naming and indexing macros to protect against problems in the index in case a macro in the index contains one of the naming macros. % \begin{macrocode} \newcommand*\IndexProtect {% @@ -6617,94 +7905,124 @@ the README.txt or README for more information. % \end{macro} % % \begin{macro}{\IndexName} -% \changes{0.75}{2012/01/19}{Current args} -% \changes{0.85}{2012/02/05}{Hide commas} % \changes{1.26}{2012/04/24}{Fix affixes} % \changes{2.0}{2015/11/11}{Fix spaces, tagging} % \changes{2.6}{2016/09/19}{Fix commas} % \changes{3.0}{2016/10/26}{Redesigned} % \changes{3.1}{2017/01/13}{Better tests} -% This creates an index entry with page references. It issues warnings if the \texttt{verbose} option is selected. It prints nothing. First we make copies of the arguments. +% \changes{3.5}{2020/11/23}{New warnings, new exclusion test, optimize logic, fix namespace} +% This creates an index entry with page references. It warns if the \cmd{\SkipIndex} prefix macro was used before it was called. It issues additional warnings if the \texttt{verbose} option is selected. It prints nothing. First we make copies of the arguments. % \begin{macrocode} \newcommandx*\IndexName[3][1=\@empty, 3=\@empty] {% - \protected@edef\arga{\trim@spaces{#1}}% - \protected@edef\rootb{\@nameauth@Root{#2}}% - \protected@edef\suffb{\@nameauth@Suffix{#2}}% - \protected@edef\argc{\trim@spaces{#3}}% - \def\csb{\@nameauth@Clean{#2}}% - \def\csbc{\@nameauth@Clean{#2,#3}}% - \def\csab{\@nameauth@Clean{#1!#2}}% % \end{macrocode} -% Test for malformed input. +% Process and load the arguments into the appropriate macros. +% \begin{macrocode} + \@nameauth@LoadArgs{#1}{#2}{#3}% + \def\@nameauth@space{ }% +% \end{macrocode} +% Test for malformed input. % \begin{macrocode} \@nameauth@Error{#2}{macro \string\IndexName}% % \end{macrocode} -% We create the appropriate index entries, calling \cmd{\@nameauth@Index} to handle sorting and tagging. We do not create an index entry for a cross-reference (code !PN for pseudonym), used by \cmd{\IndexRef}, \cmd{\Excludename}, \cmd{\Includename}, \cmd{\AKA}, and \cmd{\PName}. If the first optarg is empty, it is a non-Western name. +% Warn if \cmd{\SkipIndex} was called before \cmd{\IndexName}, and reset it unless the \texttt{oldreset} option was used. % \begin{macrocode} - \ifx\arga\@empty - \ifx\argc\@empty - \ifcsname\csb!PN\endcsname - \if@nameauth@Verbose + \if@nameauth@SkipIndex + \PackageWarning{nameauth}% + {\SkipIndex precedes \IndexName; check for problems}% + \unless\if@nameauth@OldReset + \@nameauth@SkipIndexfalse% + \fi + \fi +% \end{macrocode} +% Warn if \cmd{\SeeAlso} was called before \cmd{\IndexName} and reset it. +% \begin{macrocode} + \unless\if@nameauth@OldReset + \if@nameauth@SeeAlso + \global\@nameauth@SeeAlsofalse% + \PackageWarning{nameauth}% + {\SeeAlso precedes \IndexName or a naming macro and was reset}% + \fi + \fi +% \end{macrocode} +% We create the appropriate index entries, calling \cmd{\@nameauth@Index} to handle sorting and tagging. We do not create an index entry for a cross-reference or exclusion. +% \begin{macrocode} + \@nameauth@Choice% +% \end{macrocode} +% Non-Western names. +% We ignore \cmd{\@nameauth@C} and handle \cmd{\@nameauth@SB} appropriately. +% \begin{macrocode} + {% + \ifcsname\@nameauth@csb!PN\endcsname + \if@nameauth@Verbose + \edef\@nameauth@testex{\csname\@nameauth@csb!PN\endcsname}% + \ifx\@nameauth@testex\@nameauth@Exclude + \PackageWarning{nameauth}% + {macro \IndexName: Exclusion: #2 exists}% + \else \PackageWarning{nameauth}% {macro \IndexName: XRef: #2 exists}% \fi + \fi + \else + \ifx\@nameauth@SB\@empty + \@nameauth@Index{\@nameauth@csb}{\@nameauth@B}% \else - \ifx\suffb\@empty + \@nameauth@Index{\@nameauth@csb}% + {\@nameauth@B\@nameauth@space% + \@nameauth@SB}% + \fi + \fi + }% % \end{macrocode} -% mononym or Eastern\,/\,ancient name, new syntax +% Non-Western names, obsolete syntax. +% Using \cmd{\@nameauth@C} in this path affects indexing. % \begin{macrocode} - \@nameauth@Index{\csb}{\rootb}% + {% + \ifcsname\@nameauth@csbc!PN\endcsname + \if@nameauth@Verbose + \edef\@nameauth@testex{\csname\@nameauth@csbc!PN\endcsname}% + \ifx\@nameauth@testex\@nameauth@Exclude + \PackageWarning{nameauth}% + {macro \IndexName: Exclusion: #2 #3 exists}% \else - \@nameauth@Index{\csb}{\rootb\space\suffb}% + \PackageWarning{nameauth}% + {macro \IndexName: XRef: #2 #3 exists}% \fi \fi \else - \ifx\suffb\@empty - \ifcsname\csbc!PN\endcsname - \if@nameauth@Verbose - \PackageWarning{nameauth}% - {macro \IndexName: XRef: #2 #3 exists}% - \fi - \else + \@nameauth@Index{\@nameauth@csbc}% + {\@nameauth@B\@nameauth@space% + \@nameauth@C}% + \fi + }% % \end{macrocode} -% Eastern or ancient name, older syntax +% Western names. +% We ignore \cmd{\@nameauth@C} and handle \cmd{\@nameauth@SB} appropriately. % \begin{macrocode} - \@nameauth@Index{\csbc}{\rootb\space\argc}% - \fi - \else - \ifcsname\csb!PN\endcsname - \if@nameauth@Verbose - \PackageWarning{nameauth}% - {macro \IndexName: XRef: #2 exists}% - \fi + {% + \ifcsname\@nameauth@csab!PN\endcsname + \if@nameauth@Verbose + \edef\@nameauth@testex{\csname\@nameauth@csab!PN\endcsname}% + \ifx\@nameauth@testex\@nameauth@Exclude + \PackageWarning{nameauth}% + {macro \IndexName: Exclusion: #1 #2 exists}% \else -% \end{macrocode} -% Eastern or ancient name, new syntax, alternate name ignored -% \begin{macrocode} - \@nameauth@Index{\csb}{\rootb\space\suffb}% + \PackageWarning{nameauth}% + {macro \IndexName: XRef: #1 #2 exists}% \fi \fi - \fi - \else - \ifcsname\csab!PN\endcsname - \if@nameauth@Verbose - \PackageWarning{nameauth}% - {macro \IndexName: XRef: #1 #2 exists}% - \fi \else -% \end{macrocode} -% Western name, without and with affix -% \begin{macrocode} - \ifx\suffb\@empty - \@nameauth@Index{\csab}% - {\rootb,\space\arga}% + \ifx\@nameauth@SB\@empty + \@nameauth@Index{\@nameauth@csab}% + {\@nameauth@B,\@nameauth@space\@nameauth@A}% \else - \@nameauth@Index{\csab}% - {\rootb,\space\arga,\space\suffb}% + \@nameauth@Index{\@nameauth@csab}% + {\@nameauth@B,\@nameauth@space% + \@nameauth@A,\@nameauth@space\@nameauth@SB}% \fi \fi - \fi + }% } % \end{macrocode} % \end{macro} @@ -6712,131 +8030,276 @@ the README.txt or README for more information. % \begin{macro}{\IndexRef} % \changes{3.0}{2016/10/26}{Added} % \changes{3.1}{2017/01/13}{Better tests} -% \changes{3.3}{2020/02/20}{global flag reset} -% This creates an index cross-reference that is not already a pseudonym. It prints nothing. First we make copies of the arguments to test them and make parsing decisions. +% \changes{3.3}{2020/02/20}{Global flag reset} +% \changes{3.5}{2020/11/23}{Strict \textit{see} refs, new warnings, new exclusion test, optimize logic, fix namespace} +% Create a cross-reference that is not already an exclusion or a cross-reference. Print nothing. % \begin{macrocode} \newcommandx*\IndexRef[4][1=\@empty, 3=\@empty] {% - \protected@edef\arga{\trim@spaces{#1}}% - \protected@edef\rootb{\@nameauth@Root{#2}}% - \protected@edef\suffb{\@nameauth@Suffix{#2}}% - \protected@edef\argc{\trim@spaces{#3}}% - \protected@edef\target{#4}% - \def\csb{\@nameauth@Clean{#2}}% - \def\csbc{\@nameauth@Clean{#2,#3}}% - \def\csab{\@nameauth@Clean{#1!#2}}% - \let\ex\expandafter% +% \end{macrocode} +% Process and load the arguments into the appropriate macros. +% \begin{macrocode} + \@nameauth@LoadArgs{#1}{#2}{#3}% + \protected@edef\@nameauth@Target{#4}% + \def\@nameauth@space{ }% % \end{macrocode} % Test for malformed input. % \begin{macrocode} \@nameauth@Error{#2}{macro \string\IndexRef}% \@nameauth@Xreftrue% % \end{macrocode} -% We create either \textit{see also} entries or \textit{see} entries. The former are unrestricted. The latter are only created if they do not already exist as main entries. +% Warn if \cmd{\SkipIndex} was called before \cmd{\IndexName}, and reset it unless the \texttt{oldreset} option was used. % \begin{macrocode} - \ifx\arga\@empty - \ifx\argc\@empty - \ifcsname\csb!PN\endcsname - \if@nameauth@Verbose + \if@nameauth@SkipIndex + \PackageWarning{nameauth}% + {\SkipIndex preceded \IndexRef; check for problems}% + \unless\if@nameauth@OldReset + \@nameauth@SkipIndexfalse% + \fi + \fi +% \end{macrocode} +% We create either \textit{see also} entries or \textit{see} entries. The former are unrestricted with respect to names, not to extant cross-references. The latter are only created if they do not already exist as either page entries or cross-references. +% \begin{macrocode} + \@nameauth@Choice% +% \end{macrocode} +% Mononym or Eastern/ancient name, new syntax. First check if an xref or excluded, and if so, do nothing except issue warnings if so desired. +% \begin{macrocode} + {% + \ifcsname\@nameauth@csb!PN\endcsname + \if@nameauth@Verbose + \edef\@nameauth@testex{\csname\@nameauth@csb!PN\endcsname}% + \ifx\@nameauth@testex\@nameauth@Exclude + \PackageWarning{nameauth}% + {macro \IndexRef: Exclusion: #2 exists}% + \else \PackageWarning{nameauth}% {macro \IndexRef: XRef: #2 exists}% \fi - \else - \ifx\suffb\@empty + \fi % \end{macrocode} -% mononym or Eastern\,/\,ancient name, new syntax +% If no xref or exclusion control sequence exists, either create a \textit{see also} or a \textit{see} reference. If the latter, forbid a \textit{see} reference to an extant name unless the \texttt{oldsee} option is used; then allow, but issue a warning. % \begin{macrocode} - \if@nameauth@SeeAlso - \@nameauth@Index{\csb}{\rootb|seealso{\target}}% + \else + \ifx\@nameauth@SB\@empty + \if@nameauth@SeeAlso + \@nameauth@Index{\@nameauth@csb}% + {\@nameauth@B|seealso{\@nameauth@Target}}% + \csgdef{\@nameauth@csb!PN}{}% + \else + \unless\if@nameauth@OldSee + \unless\ifcsname\@nameauth@csb!MN\endcsname + \unless\ifcsname\@nameauth@csb!NF\endcsname + \@nameauth@Index{\@nameauth@csb}% + {\@nameauth@B|see{\@nameauth@Target}}% + \csgdef{\@nameauth@csb!PN}{}% + \else + \PackageWarning{nameauth}% + {macro \IndexRef: Extant name #2 stops see ref.}% + \fi + \else + \PackageWarning{nameauth}% + {macro \IndexRef: Extant name #2 stops see ref.}% + \fi \else - \@nameauth@Index{\csb}{\rootb|see{\target}}% + \if@nameauth@Verbose + \PackageWarning{nameauth}% + {macro \IndexRef: Non-strict XRef #2 created}% + \fi + \@nameauth@Index{\@nameauth@csb}% + {\@nameauth@B|see{\@nameauth@Target}}% + \csgdef{\@nameauth@csb!PN}{}% \fi + \fi +% \end{macrocode} +% \newpage\noindent +% When the suffix is non-empty, either create a \textit{see also} or a \textit{see} reference. If the latter, forbid a \textit{see} reference to an extant name unless the \texttt{oldsee} option is used; then allow and warn. +% \begin{macrocode} + \else + \if@nameauth@SeeAlso + \@nameauth@Index{\@nameauth@csb}% + {\@nameauth@B\@nameauth@space% + \@nameauth@SB|seealso{\@nameauth@Target}}% + \csgdef{\@nameauth@csb!PN}{}% \else - \if@nameauth@SeeAlso - \@nameauth@Index{\csb}% - {\rootb\space\suffb|seealso{\target}}% + \unless\if@nameauth@OldSee + \unless\ifcsname\@nameauth@csb!MN\endcsname + \unless\ifcsname\@nameauth@csb!NF\endcsname + \@nameauth@Index{\@nameauth@csb}% + {\@nameauth@B\@nameauth@space% + \@nameauth@SB|see{\@nameauth@Target}}% + \csgdef{\@nameauth@csb!PN}{}% + \else + \PackageWarning{nameauth}% + {macro \IndexRef: Extant name #2 stops see ref.}% + \fi + \else + \PackageWarning{nameauth}% + {macro \IndexRef: Extant name #2 stops see ref.}% + \fi \else - \@nameauth@Index{\csb}% - {\rootb\space\suffb|see{\target}}% + \if@nameauth@Verbose + \PackageWarning{nameauth}% + {macro \IndexRef: Non-strict XRef #2 created}% + \fi + \@nameauth@Index{\@nameauth@csb}% + {\@nameauth@B\@nameauth@space% + \@nameauth@SB|see{\@nameauth@Target}}% + \csgdef{\@nameauth@csb!PN}{}% \fi \fi - \csgdef{\csb!PN}{}% \fi - \else - \ifx\suffb\@empty - \ifcsname\csbc!PN\endcsname - \if@nameauth@Verbose - \PackageWarning{nameauth}% - {macro \IndexRef: XRef: #2 #3 exists}% - \fi - \else + \fi + }% % \end{macrocode} -% Eastern or ancient name, older syntax +% Eastern or ancient name, obsolete syntax. First check if an xref or excluded. % \begin{macrocode} - \if@nameauth@SeeAlso - \@nameauth@Index{\csbc}% - {\rootb\space\argc|seealso{\target}}% - \else - \@nameauth@Index{\csbc}% - {\rootb\space\argc|see{\target}}% - \fi - \csgdef{\csbc!PN}{}% + {% + \ifcsname\@nameauth@csbc!PN\endcsname + \if@nameauth@Verbose + \edef\@nameauth@testex{\csname\@nameauth@csbc!PN\endcsname}% + \ifx\@nameauth@testex\@nameauth@Exclude + \PackageWarning{nameauth}% + {macro \IndexRef: Exclusion: #2 #3 exists}% + \else + \PackageWarning{nameauth}% + {macro \IndexRef: XRef: #2 #3 exists}% \fi + \fi +% \end{macrocode} +% \newpage\noindent +% If no xref control sequence exists, either create a \textit{see also} or a \textit{see} reference. If the latter, forbid a \textit{see} reference to an extant name unless the \texttt{oldsee} option is used; then allow, but issue a warning. +% \begin{macrocode} + \else + \if@nameauth@SeeAlso + \@nameauth@Index{\@nameauth@csbc}% + {\@nameauth@B\@nameauth@space% + \@nameauth@C|seealso{\@nameauth@Target}}% + \csgdef{\@nameauth@csbc!PN}{}% \else - \ifcsname\csb!PN\endcsname - \if@nameauth@Verbose + \unless\if@nameauth@OldSee + \unless\ifcsname\@nameauth@csbc!MN\endcsname + \unless\ifcsname\@nameauth@csbc!NF\endcsname + \@nameauth@Index{\@nameauth@csbc}% + {\@nameauth@B\@nameauth@space% + \@nameauth@C|see{\@nameauth@Target}}% + \csgdef{\@nameauth@csbc!PN}{}% + \else + \PackageWarning{nameauth}% + {macro \IndexRef: Extant name #2 #3 stops see ref.}% + \fi + \else \PackageWarning{nameauth}% - {macro \IndexRef: XRef: #2 exists}% + {macro \IndexRef: Extant name #2 #3 stops see ref.}% \fi \else -% \end{macrocode} -% Eastern or ancient name, new syntax, alternate name ignored -% \begin{macrocode} - \if@nameauth@SeeAlso - \@nameauth@Index{\csb}% - {\rootb\space\suffb|seealso{\target}}% - \else - \@nameauth@Index{\csb}% - {\rootb\space\suffb|see{\target}}% + \if@nameauth@Verbose + \PackageWarning{nameauth}% + {macro \IndexRef: Non-strict XRef #2 #3 created}% \fi - \csgdef{\csb!PN}{}% + \@nameauth@Index{\@nameauth@csbc}% + {\@nameauth@B\@nameauth@space% + \@nameauth@C|see{\@nameauth@Target}}% + \csgdef{\@nameauth@csbc!PN}{}% \fi \fi \fi - \else - \ifcsname\csab!PN\endcsname + }% +% \end{macrocode} +% Western name, without and with affix. First check if an xref or excluded. +% \begin{macrocode} + {% + \ifcsname\@nameauth@csab!PN\endcsname \if@nameauth@Verbose - \PackageWarning{nameauth}% - {macro \IndexRef: XRef: #1 #2 exists}% + \edef\@nameauth@testex{\csname\@nameauth@csab!PN\endcsname}% + \ifx\@nameauth@testex\@nameauth@Exclude + \PackageWarning{nameauth}% + {macro \IndexRef: Exclusion: #1 #2 exists}% + \else + \PackageWarning{nameauth}% + {macro \IndexRef: XRef: #1 #2 exists}% + \fi \fi - \else % \end{macrocode} -% Western name, without and with affix +% \newpage\noindent +% If no xref control sequence exists, either create a \textit{see also} or a \textit{see} reference. If the latter, forbid a \textit{see} reference to an extant name unless the \texttt{oldsee} option is used; then allow, but issue a warning. % \begin{macrocode} - \ifx\suffb\@empty + \else + \ifx\@nameauth@SB\@empty \if@nameauth@SeeAlso - \@nameauth@Index{\csab}% - {\rootb,\space\arga|seealso{\target}}% + \@nameauth@Index{\@nameauth@csab}% + {\@nameauth@B,\@nameauth@space% + \@nameauth@A|seealso{\@nameauth@Target}}% + \csgdef{\@nameauth@csab!PN}{}% \else - \@nameauth@Index{\csab}% - {\rootb,\space\arga|see{\target}}% + \unless\if@nameauth@OldSee + \unless\ifcsname\@nameauth@csab!MN\endcsname + \unless\ifcsname\@nameauth@csab!NF\endcsname + \@nameauth@Index{\@nameauth@csab}% + {\@nameauth@B,\@nameauth@space% + \@nameauth@A|see{\@nameauth@Target}}% + \csgdef{\@nameauth@csab!PN}{}% + \else + \PackageWarning{nameauth}% + {macro \IndexRef: Extant name #1 #2 stops see ref.}% + \fi + \else + \PackageWarning{nameauth}% + {macro \IndexRef: Extant name #1 #2 stops see ref.}% + \fi + \else + \if@nameauth@Verbose + \PackageWarning{nameauth}% + {macro \IndexRef: Non-strict XRef #1 #2 created}% + \fi + \@nameauth@Index{\@nameauth@csab}% + {\@nameauth@B,\@nameauth@space% + \@nameauth@A|see{\@nameauth@Target}}% + \csgdef{\@nameauth@csab!PN}{}% + \fi \fi +% \end{macrocode} +% When the suffix is non-empty, either create a \textit{see also} or a \textit{see} reference. If the latter, forbid a \textit{see} reference to an extant name unless the \texttt{oldsee} option is used; then allow and warn. +% \begin{macrocode} \else \if@nameauth@SeeAlso - \@nameauth@Index{\csab}% - {\rootb,\space\arga,\space\suffb|seealso{\target}}% + \@nameauth@Index{\@nameauth@csab}% + {\@nameauth@B,\@nameauth@space% + \@nameauth@A,\@nameauth@space% + \@nameauth@SB|seealso{\@nameauth@Target}}% + \csgdef{\@nameauth@csab!PN}{}% \else - \@nameauth@Index{\csab}% - {\rootb,\space\arga,\space\suffb|see{\target}}% + \unless\if@nameauth@OldSee + \unless\ifcsname\@nameauth@csab!MN\endcsname + \unless\ifcsname\@nameauth@csab!NF\endcsname + \@nameauth@Index{\@nameauth@csab}% + {\@nameauth@B,\@nameauth@space% + \@nameauth@A,\@nameauth@space% + \@nameauth@SB|see{\@nameauth@Target}}% + \csgdef{\@nameauth@csab!PN}{}% + \else + \PackageWarning{nameauth}% + {macro \IndexRef: Extant name #1 #2 stops see ref.}% + \fi + \else + \PackageWarning{nameauth}% + {macro \IndexRef: Extant name #1 #2 stops see ref.}% + \fi + \else + \if@nameauth@Verbose + \PackageWarning{nameauth}% + {macro \IndexRef: Non-strict XRef #1 #2 created}% + \fi + \@nameauth@Index{\@nameauth@csab}% + {\@nameauth@B,\@nameauth@space% + \@nameauth@A,\@nameauth@space% + \@nameauth@SB|see{\@nameauth@Target}}% + \csgdef{\@nameauth@csab!PN}{}% + \fi \fi \fi - \csgdef{\csab!PN}{}% \fi - \fi + }% \@nameauth@Xreffalse% -% \end{macrocode} -% This may not be necessary, but we do it for consistency. -% \begin{macrocode} \if@nameauth@OldReset \@nameauth@SeeAlsofalse% \else @@ -6850,103 +8313,117 @@ the README.txt or README for more information. % \changes{0.94}{2012/02/15}{Added} % \changes{2.3}{2016/01/05}{New xref test} % \changes{3.0}{2016/10/26}{Redesigned} -% \changes{3.3}{2020/02/20}{More accurate warnings} -% This macro prevents a name from being indexed. +% \changes{3.3}{2020/02/20}{Better warnings} +% \changes{3.5}{2020/11/23}{New warnings, new exclusion test, fix bug in old syntax, new logic, fix namespace} +% Prevent a name from being indexed. Now, the set of macro expansions that comprise an exclusion contains one member: the value of \cmd{\@nameauth@Exclude}. Formerly, an exclusion was the set of all non-empty strings, preventing any other features from being added. % \begin{macrocode} \newcommandx*\ExcludeName[3][1=\@empty, 3=\@empty] {% - \protected@edef\arga{\trim@spaces{#1}}% - \protected@edef\argc{\trim@spaces{#3}}% - \protected@edef\suffb{\@nameauth@Suffix{#2}}% - \def\csb{\@nameauth@Clean{#2}}% - \def\csbc{\@nameauth@Clean{#2,#3}}% - \def\csab{\@nameauth@Clean{#1!#2}}% % \end{macrocode} -% Below we parse the name arguments and create a non-empty pseudonym macro. +% Process and load the arguments into the appropriate macros. % \begin{macrocode} + \@nameauth@LoadArgs{#1}{#2}{#3}% \@nameauth@Error{#2}{macro \string\ExcludeName}% - \ifx\arga\@empty - \ifx\argc\@empty +% \end{macrocode} +% Below we parse the name arguments and create an excluded form of cross-reference, unless one already exists. +% \begin{macrocode} + \@nameauth@Choice% +% \end{macrocode} +% Non-Western names. Verbose warnings let one know that an extant name is being excluded, but the operation is still allowed. +% \begin{macrocode} + {% + \if@nameauth@Verbose + \ifcsname\@nameauth@csb!MN\endcsname + \PackageWarning{nameauth}% + {macro \ExcludeName: Name: #2 exists}% + \fi + \ifcsname\@nameauth@csb!NF\endcsname + \PackageWarning{nameauth}% + {macro \ExcludeName: Name: #2 exists}% + \fi + \fi +% \end{macrocode} +% One cannot exclude an extant cross-reference or exclusion. Verbose warnings only. +% \begin{macrocode} + \ifcsname\@nameauth@csb!PN\endcsname \if@nameauth@Verbose - \ifcsname\csb!MN\endcsname - \PackageWarning{nameauth}% - {macro \ExcludeName: Reference: #2 exists}% - \fi - \ifcsname\csb!NF\endcsname + \edef\@nameauth@testex{\csname\@nameauth@csb!PN\endcsname}% + \ifx\@nameauth@testex\@nameauth@Exclude \PackageWarning{nameauth}% - {macro \ExcludeName: Reference: #2 exists}% - \fi - \fi - \ifcsname\csb!PN\endcsname - \if@nameauth@Verbose + {macro \ExcludeName: Exclusion: #2 exists}% + \else \PackageWarning{nameauth}% - {macro \ExcludeName: Xref: #2 exists}% + {macro \ExcludeName: XRef: #2 exists}% \fi - \else - \csgdef{\csb!PN}{!}% \fi \else - \ifx\suffb\@empty - \if@nameauth@Verbose - \ifcsname\csbc!MN\endcsname - \PackageWarning{nameauth}% - {macro \ExcludeName: Reference: #2 #3 exists}% - \fi - \ifcsname\csbc!NF\endcsname - \PackageWarning{nameauth}% - {macro \ExcludeName: Reference: #2 #3 exists}% - \fi - \fi - \csgdef{\csbc!PN}{!}% - \ifcsname\csbc!PN\endcsname - \if@nameauth@Verbose - \PackageWarning{nameauth}% - {macro \ExcludeName: Xref: #2 #3 exists}% - \fi - \else - \csgdef{\csbc!PN}{!}% - \fi - \else - \if@nameauth@Verbose - \ifcsname\csb!MN\endcsname - \PackageWarning{nameauth}% - {macro \ExcludeName: Reference: #2 exists}% - \fi - \ifcsname\csb!NF\endcsname - \PackageWarning{nameauth}% - {macro \ExcludeName: Reference: #2 exists}% - \fi - \fi - \ifcsname\csb!PN\endcsname - \if@nameauth@Verbose - \PackageWarning{nameauth}% - {macro \ExcludeName: Xref: #2 exists}% - \fi + \csxdef{\@nameauth@csb!PN}{\@nameauth@Exclude}% + \fi + }% +% \end{macrocode} +% Non-Western names, obsolete syntax. Verbose warnings let one know that an extant name is being excluded, but the operation is still allowed. +% \begin{macrocode} + {% + \if@nameauth@Verbose + \ifcsname\@nameauth@csbc!MN\endcsname + \PackageWarning{nameauth}% + {macro \ExcludeName: Name: #2 #3 exists}% + \fi + \ifcsname\@nameauth@csbc!NF\endcsname + \PackageWarning{nameauth}% + {macro \ExcludeName: Name: #2 #3 exists}% + \fi + \fi +% \end{macrocode} +% One cannot exclude an extant cross-reference or exclusion. Verbose warnings only. +% \begin{macrocode} + \ifcsname\@nameauth@csbc!PN\endcsname + \if@nameauth@Verbose + \edef\@nameauth@testex{\csname\@nameauth@csbc!PN\endcsname}% + \ifx\@nameauth@testex\@nameauth@Exclude + \PackageWarning{nameauth}% + {macro \ExcludeName: Exclusion: #2 #3 exists}% \else - \csgdef{\csb!PN}{!}% + \PackageWarning{nameauth}% + {macro \ExcludeName: XRef: #2 #3 exists}% \fi \fi + \else + \csxdef{\@nameauth@csbc!PN}{\@nameauth@Exclude}% \fi - \else + }% +% \end{macrocode} +% Western names. Verbose warnings let one know that an extant name is being excluded, but the operation is still allowed. +% \begin{macrocode} + {% \if@nameauth@Verbose - \ifcsname\csab!MN\endcsname + \ifcsname\@nameauth@csab!MN\endcsname \PackageWarning{nameauth}% - {macro \ExcludeName: Reference: #1 #2 exists}% + {macro \ExcludeName: Name: #1 #2 exists}% \fi - \ifcsname\csab!NF\endcsname + \ifcsname\@nameauth@csab!NF\endcsname \PackageWarning{nameauth}% - {macro \ExcludeName: Reference: #1 #2 exists}% + {macro \ExcludeName: Name: #1 #2 exists}% \fi \fi - \ifcsname\csab!PN\endcsname +% \end{macrocode} +% One cannot exclude an extant cross-reference or exclusion. Verbose warnings only. +% \begin{macrocode} + \ifcsname\@nameauth@csab!PN\endcsname \if@nameauth@Verbose - \PackageWarning{nameauth}% - {macro \ExcludeName: Xref: #1 #2 exists}% + \edef\@nameauth@testex{\csname\@nameauth@csab!PN\endcsname}% + \ifx\@nameauth@testex\@nameauth@Exclude + \PackageWarning{nameauth}% + {macro \ExcludeName: Exclusion: #1 #2 exists}% + \else + \PackageWarning{nameauth}% + {macro \ExcludeName: XRef: #1 #2 exists}% + \fi \fi \else - \csgdef{\csab!PN}{!}% + \csxdef{\@nameauth@csab!PN}{\@nameauth@Exclude}% \fi - \fi + }% } % \end{macrocode} % \end{macro} @@ -6954,61 +8431,57 @@ the README.txt or README for more information. % \begin{macro}{\IncludeName} % \changes{3.0}{2016/10/26}{Added} % \changes{3.3}{2020/02/20}{Added warnings} -% This macro allows a name to be indexed if it is not a cross-reference. +% \changes{3.5}{2020/11/23}{New exclusion test, optimize logic, fix namespace} +% This macro allows a name to be indexed once again only if it had been excluded. % \begin{macrocode} \newcommandx*\IncludeName[3][1=\@empty, 3=\@empty] {% - \protected@edef\arga{\trim@spaces{#1}}% - \protected@edef\argc{\trim@spaces{#3}}% - \protected@edef\suffb{\@nameauth@Suffix{#2}}% - \def\csb{\@nameauth@Clean{#2}}% - \def\csbc{\@nameauth@Clean{#2,#3}}% - \def\csab{\@nameauth@Clean{#1!#2}}% % \end{macrocode} -% Below we parse the name arguments and undefine only an ``excluded'' name. +% Process and load the arguments into the appropriate macros. % \begin{macrocode} + \@nameauth@LoadArgs{#1}{#2}{#3}% \@nameauth@Error{#2}{macro \string\IncludeName}% - \ifx\arga\@empty - \ifx\argc\@empty - \ifcsname\csb!PN\endcsname - \edef\testex{\csname\csb!PN\endcsname}% - \unless\ifx\testex\@empty\global\csundef{\csb!PN}% - \else - \if@nameauth@Verbose - \PackageWarning{nameauth}% - {macro \IncludeName: Xref: #2 exists}% - \fi + \@nameauth@Choice% +% \end{macrocode} +% Non-Western names. +% \begin{macrocode} + {% + \ifcsname\@nameauth@csb!PN\endcsname + \edef\@nameauth@testex{\csname\@nameauth@csb!PN\endcsname}% + \ifx\@nameauth@testex\@nameauth@Exclude + \global\csundef{\@nameauth@csb!PN}% + \else + \if@nameauth@Verbose + \PackageWarning{nameauth}% + {macro \IncludeName: Xref: #2 exists}% \fi \fi - \else - \ifx\suffb\@empty - \ifcsname\csbc!PN\endcsname - \edef\testex{\csname\csbc!PN\endcsname}% - \unless\ifx\testex\@empty\global\csundef{\csbc!PN}% - \else - \if@nameauth@Verbose - \PackageWarning{nameauth}% - {macro \IncludeName: Xref: #2 #3 exists}% - \fi - \fi - \fi + \fi + }% +% \end{macrocode} +% Non-Western names, obsolete syntax. +% \begin{macrocode} + {% + \ifcsname\@nameauth@csbc!PN\endcsname + \edef\@nameauth@testex{\csname\@nameauth@csbc!PN\endcsname}% + \ifx\@nameauth@testex\@nameauth@Exclude + \global\csundef{\@nameauth@csbc!PN}% \else - \ifcsname\csb!PN\endcsname - \edef\testex{\csname\csb!PN\endcsname}% - \unless\ifx\testex\@empty\global\csundef{\csb!PN}% - \else - \if@nameauth@Verbose - \PackageWarning{nameauth}% - {macro \IncludeName: Xref: #2 exists}% - \fi - \fi + \if@nameauth@Verbose + \PackageWarning{nameauth}% + {macro \IncludeName: Xref: #2 #3 exists}% \fi \fi \fi - \else - \ifcsname\csab!PN\endcsname - \edef\testex{\csname\csab!PN\endcsname}% - \unless\ifx\testex\@empty\global\csundef{\csab!PN}% + }% +% \end{macrocode} +% Western names. +% \begin{macrocode} + {% + \ifcsname\@nameauth@csab!PN\endcsname + \edef\@nameauth@testex{\csname\@nameauth@csab!PN\endcsname}% + \ifx\@nameauth@testex\@nameauth@Exclude + \global\csundef{\@nameauth@csab!PN}% \else \if@nameauth@Verbose \PackageWarning{nameauth}% @@ -7016,230 +8489,216 @@ the README.txt or README for more information. \fi \fi \fi - \fi + }% } % \end{macrocode} % \end{macro} % % \begin{macro}{\IncludeName*} % \changes{3.0}{2016/10/26}{Added} -% \changes{3.1}{2017/01/13}{Fixed} -% This macro allows any name to be indexed, undefining cross-references. +% \changes{3.5}{2020/11/23}{Optimize logic, fix namespace} +% This macro allows any name to be indexed by voiding any exclusion or cross-reference. % \begin{macrocode} \WithSuffix{\newcommandx*}\IncludeName*[3][1=\@empty, 3=\@empty] {% - \protected@edef\arga{\trim@spaces{#1}}% - \protected@edef\argc{\trim@spaces{#3}}% - \protected@edef\suffb{\@nameauth@Suffix{#2}}% - \def\csb{\@nameauth@Clean{#2}}% - \def\csbc{\@nameauth@Clean{#2,#3}}% - \def\csab{\@nameauth@Clean{#1!#2}}% -% \end{macrocode} -% Below we parse the name arguments and undefine an xref control sequence. -% \begin{macrocode} + \@nameauth@LoadArgs{#1}{#2}{#3}% \@nameauth@Error{#2}{macro \string\IncludeName*}% - \ifx\arga\@empty - \ifx\argc\@empty - \global\csundef{\csb!PN}% - \else - \ifx\suffb\@empty - \global\csundef{\csbc!PN}% - \else - \global\csundef{\csb!PN}% - \fi - \fi - \else - \global\csundef{\csab!PN}% - \fi + \@nameauth@Choice% + {\global\csundef{\@nameauth@csb!PN}}% + {\global\csundef{\@nameauth@csbc!PN}}% + {\global\csundef{\@nameauth@csab!PN}}% } % \end{macrocode} % \end{macro} % % \begin{macro}{\PretagName} % \changes{2.0}{2015/11/11}{Added} -% This creates an index entry tag that is applied before a name. +% \changes{3.5}{2020/11/23}{New warnings, new exclusion test, optimize logic, fix namespace} +% This creates an index entry tag that is applied before a name by \cmd{\@nameauth@Index}. % \begin{macrocode} \newcommandx*\PretagName[4][1=\@empty, 3=\@empty] {% - \protected@edef\arga{\trim@spaces{#1}}% - \protected@edef\argc{\trim@spaces{#3}}% - \protected@edef\suffb{\@nameauth@Suffix{#2}}% - \def\csb{\@nameauth@Clean{#2}}% - \def\csbc{\@nameauth@Clean{#2,#3}}% - \def\csab{\@nameauth@Clean{#1!#2}}% % \end{macrocode} -% We parse the arguments, defining the sort tag control sequences used by\newline \cmd{\@nameauth@Index}. +% Process and load the arguments into the appropriate macros. % \begin{macrocode} + \@nameauth@LoadArgs{#1}{#2}{#3}% \@nameauth@Error{#2}{macro \string\PretagName}% - \ifx\arga\@empty - \ifx\argc\@empty - \ifcsname\csb!PN\endcsname +% \end{macrocode} +% Sort only when permitted. +% \begin{macrocode} + \if@nameauth@Pretag + \@nameauth@Choice% +% \end{macrocode} +% Non-Western names. Verbose warnings let us know if we are sorting either exclusions or cross-references. The former will be ignored. The latter will be used. +% \begin{macrocode} + {% + \ifcsname\@nameauth@csb!PN\endcsname \if@nameauth@Verbose - \PackageWarning{nameauth}% - {macro \PretagName: tagging xref: #2}% + \edef\@nameauth@testex{\csname\@nameauth@csb!PN\endcsname}% + \ifx\@nameauth@testex\@nameauth@Exclude + \PackageWarning{nameauth}% + {macro \PretagName: tagging exclusion: #2}% + \else + \PackageWarning{nameauth}% + {macro \PretagName: tagging xref: #2}% + \fi \fi \fi - \if@nameauth@Pretag\csgdef{\csb!PRE}{#4\@nameauth@Actual}\fi - \else - \ifx\suffb\@empty - \ifcsname\csbc!PN\endcsname - \if@nameauth@Verbose + \csgdef{\@nameauth@csb!PRE}{#4\@nameauth@Actual}% + }% +% \end{macrocode} +% Non-Western names, obsolete syntax. Verbose warnings let us know if we are sorting either exclusions or cross-references. The former will be ignored. The latter will be used. +% \begin{macrocode} + {% + \ifcsname\@nameauth@csbc!PN\endcsname + \if@nameauth@Verbose + \edef\@nameauth@testex{\csname\@nameauth@csbc!PN\endcsname}% + \ifx\@nameauth@testex\@nameauth@Exclude + \PackageWarning{nameauth}% + {macro \PretagName: tagging exclusion: #2 #3}% + \else \PackageWarning{nameauth}% {macro \PretagName: tagging xref: #2 #3}% \fi \fi - \if@nameauth@Pretag\csgdef{\csbc!PRE}{#4\@nameauth@Actual}\fi - \else - \ifcsname\csb!PN\endcsname - \if@nameauth@Verbose + \fi + \csgdef{\@nameauth@csbc!PRE}{#4\@nameauth@Actual}% + }% +% \end{macrocode} +% Western names. Verbose warnings let us know if we are sorting either exclusions or cross-references. The former will be ignored. The latter will be used. +% \begin{macrocode} + {% + \ifcsname\@nameauth@csab!PN\endcsname + \if@nameauth@Verbose + \edef\@nameauth@testex{\csname\@nameauth@csab!PN\endcsname}% + \ifx\@nameauth@testex\@nameauth@Exclude \PackageWarning{nameauth}% - {macro \PretagName: tagging xref: #2}% + {macro \PretagName: tagging exclusion: #1 #2}% + \else + \PackageWarning{nameauth}% + {macro \PretagName: tagging xref: #1 #2}% \fi \fi - \if@nameauth@Pretag\csgdef{\csb!PRE}{#4\@nameauth@Actual}\fi \fi - \fi + \csgdef{\@nameauth@csab!PRE}{#4\@nameauth@Actual}% + }% \else - \ifcsname\csab!PN\endcsname - \if@nameauth@Verbose - \PackageWarning{nameauth}% - {macro \PretagName: tagging xref: #1 #2}% - \fi - \fi - \if@nameauth@Pretag\csgdef{\csab!PRE}{#4\@nameauth@Actual}\fi + \PackageWarning{nameauth}% + {macro \PretagName: deactivated}% \fi } % \end{macrocode} % \end{macro} -% +% % \begin{macro}{\TagName} % \changes{1.2}{2012/02/25}{Added} % \changes{1.9}{2015/07/09}{Fix cs collisions} % \changes{2.0}{2015/11/11}{Redesign tagging} -% This creates an index entry tag for a name that is not used as a cross-reference. +% \changes{3.5}{2020/11/23}{New warnings, new exclusion test, optimize logic, fix namespace} +% This creates an index entry tag for a name that is not either an exclusion or a cross-reference. % \begin{macrocode} \newcommandx*\TagName[4][1=\@empty, 3=\@empty] {% - \protected@edef\arga{\trim@spaces{#1}}% - \protected@edef\argc{\trim@spaces{#3}}% - \protected@edef\suffb{\@nameauth@Suffix{#2}}% - \def\csb{\@nameauth@Clean{#2}}% - \def\csbc{\@nameauth@Clean{#2,#3}}% - \def\csab{\@nameauth@Clean{#1!#2}}% % \end{macrocode} -% We parse the arguments, defining the macros used by \cmd{\@nameauth@Index}. +% Process and load the arguments into the appropriate macros. % \begin{macrocode} + \@nameauth@LoadArgs{#1}{#2}{#3}% \@nameauth@Error{#2}{macro \string\TagName}% - \ifx\arga\@empty - \ifx\argc\@empty - \ifcsname\csb!PN\endcsname - \if@nameauth@Verbose + \@nameauth@Choice% +% \end{macrocode} +% Non-Western names. +% \begin{macrocode} + {% + \ifcsname\@nameauth@csb!PN\endcsname + \if@nameauth@Verbose + \edef\@nameauth@testex{\csname\@nameauth@csb!PN\endcsname}% + \ifx\@nameauth@testex\@nameauth@Exclude + \PackageWarning{nameauth}% + {macro \TagName: not tagging exclusion: #2}% + \else \PackageWarning{nameauth}% {macro \TagName: not tagging xref: #2}% \fi - \else - \csgdef{\csb!TAG}{#4}% \fi \else - \ifx\suffb\@empty - \ifcsname\csbc!PN\endcsname - \if@nameauth@Verbose - \PackageWarning{nameauth}% - {macro \TagName: not tagging xref: #2 #3}% - \fi - \else - \csgdef{\csbc!TAG}{#4}% - \fi - \else - \ifcsname\csb!PN\endcsname - \if@nameauth@Verbose - \PackageWarning{nameauth}% - {macro \TagName: not tagging xref: #2}% - \fi + \csgdef{\@nameauth@csb!TAG}{#4}% + \fi + }% +% \end{macrocode} +% Non-Western names, obsolete syntax. +% \begin{macrocode} + {% + \ifcsname\@nameauth@csbc!PN\endcsname + \if@nameauth@Verbose + \edef\@nameauth@testex{\csname\@nameauth@csbc!PN\endcsname}% + \ifx\@nameauth@testex\@nameauth@Exclude + \PackageWarning{nameauth}% + {macro \TagName: not tagging exclusion: #2 #3}% \else - \csgdef{\csb!TAG}{#4}% + \PackageWarning{nameauth}% + {macro \TagName: not tagging xref: #2 #3}% \fi \fi + \else + \csgdef{\@nameauth@csbc!TAG}{#4}% \fi - \else - \ifcsname\csab!PN\endcsname + }% +% \end{macrocode} +% Western names. +% \begin{macrocode} + {% + \ifcsname\@nameauth@csab!PN\endcsname \if@nameauth@Verbose - \PackageWarning{nameauth}% - {macro \TagName: not tagging xref: #1 #2}% + \edef\@nameauth@testex{\csname\@nameauth@csab!PN\endcsname}% + \ifx\@nameauth@testex\@nameauth@Exclude + \PackageWarning{nameauth}% + {macro \TagName: not tagging exclusion: #1 #2}% + \else + \PackageWarning{nameauth}% + {macro \TagName: not tagging xref: #1 #2}% + \fi \fi \else - \csgdef{\csab!TAG}{#4}% + \csgdef{\@nameauth@csab!TAG}{#4}% \fi - \fi + }% } % \end{macrocode} % \end{macro} -% +% % \begin{macro}{\UntagName} % \changes{1.2}{2012/02/25}{Added} % \changes{1.9}{2015/07/09}{Global undef, no cs collisions} % \changes{2.0}{2015/11/11}{Redesign tagging} +% \changes{3.5}{2020/11/23}{Optimize logic, fix namespace} % This deletes an index tag. % \begin{macrocode} \newcommandx*\UntagName[3][1=\@empty, 3=\@empty] {% - \protected@edef\arga{\trim@spaces{#1}}% - \protected@edef\argc{\trim@spaces{#3}}% - \protected@edef\suffb{\@nameauth@Suffix{#2}}% - \def\csb{\@nameauth@Clean{#2}}% - \def\csbc{\@nameauth@Clean{#2,#3}}% - \def\csab{\@nameauth@Clean{#1!#2}}% -% \end{macrocode} -% We parse the arguments, undefining the index tag macros. -% \begin{macrocode} + \@nameauth@LoadArgs{#1}{#2}{#3}% \@nameauth@Error{#2}{macro \string\UntagName}% - \ifx\arga\@empty - \ifx\argc\@empty - \global\csundef{\csb!TAG}% - \else - \ifx\suffb\@empty - \global\csundef{\csbc!TAG}% - \else - \global\csundef{\csb!TAG}% - \fi - \fi - \else - \global\csundef{\csab!TAG}% - \fi + \@nameauth@Choice% + {\global\csundef{\@nameauth@csb!TAG}}% + {\global\csundef{\@nameauth@csbc!TAG}}% + {\global\csundef{\@nameauth@csab!TAG}}% } % \end{macrocode} % \end{macro} -% -% \noindent{\large\bfseries Name Info Data Set: ``Text Tags''} +% +% \noindent{\normalsize\bfseries Name Info Data Set: ``Text Tags''} % \begin{macro}{\NameAddInfo} % \changes{2.4}{2016/03/15}{Added} +% \changes{3.5}{2020/11/23}{Optimize logic, fix namespace} % This creates a macro that expands to information associated with a given name, similar to an index tag, but usable in the body text. % \begin{macrocode} \newcommandx\NameAddInfo[4][1=\@empty, 3=\@empty] {% - \protected@edef\arga{\trim@spaces{#1}}% - \protected@edef\argc{\trim@spaces{#3}}% - \protected@edef\Suff{\@nameauth@Suffix{#2}}% - \def\csb{\@nameauth@Clean{#2}}% - \def\csbc{\@nameauth@Clean{#2,#3}}% - \def\csab{\@nameauth@Clean{#1!#2}}% -% \end{macrocode} -% We parse the arguments, defining the text tag control sequences. -% \begin{macrocode} + \@nameauth@LoadArgs{#1}{#2}{#3}% \@nameauth@Error{#2}{macro \string\NameAddInfo}% - \ifx\arga\@empty - \ifx\argc\@empty - \csgdef{\csb!DB}{#4}% - \else - \ifx\Suff\@empty - \csgdef{\csbc!DB}{#4}% - \else - \csgdef{\csb!DB}{#4}% - \fi - \fi - \else - \csgdef{\csab!DB}{#4}% - \fi + \@nameauth@Choice% + {\csgdef{\@nameauth@csb!DB}{#4}}% + {\csgdef{\@nameauth@csbc!DB}{#4}}% + {\csgdef{\@nameauth@csab!DB}{#4}}% } % \end{macrocode} % \end{macro} @@ -7247,255 +8706,320 @@ the README.txt or README for more information. % \begin{macro}{\NameQueryInfo} % \changes{2.4}{2016/03/15}{Added} % \changes{3.1}{2017/01/13}{Short macro} -% \changes{3.3}{2020/02/20}{lock added} +% \changes{3.3}{2020/02/20}{Lock added} +% \changes{3.5}{2020/11/23}{Optimize logic, fix namespace} % This prints the information created by \cmd{\NameAddInfo} if it exists. % \begin{macrocode} \newcommandx*\NameQueryInfo[3][1=\@empty, 3=\@empty] {% - \protected@edef\arga{\trim@spaces{#1}}% - \protected@edef\argc{\trim@spaces{#3}}% - \protected@edef\Suff{\@nameauth@Suffix{#2}}% - \def\csb{\@nameauth@Clean{#2}}% - \def\csbc{\@nameauth@Clean{#2,#3}}% - \def\csab{\@nameauth@Clean{#1!#2}}% \unless\if@nameauth@BigLock -% \end{macrocode} -% We parse the arguments, invoking the tag macros to expand to their contents. -% \begin{macrocode} + \@nameauth@LoadArgs{#1}{#2}{#3}% \@nameauth@Error{#2}{macro \string\NameQueryInfo}% - \ifx\arga\@empty - \ifx\argc\@empty - \ifcsname\csb!DB\endcsname\csname\csb!DB\endcsname\fi - \else - \ifx\Suff\@empty - \ifcsname\csbc!DB\endcsname\csname\csbc!DB\endcsname\fi - \else - \ifcsname\csb!DB\endcsname\csname\csb!DB\endcsname\fi - \fi - \fi - \else - \ifcsname\csab!DB\endcsname\csname\csab!DB\endcsname\fi - \fi - \fi + \@nameauth@Choice% + {\ifcsname\@nameauth@csb!DB\endcsname + \csname\@nameauth@csb!DB\endcsname\fi}% + {\ifcsname\@nameauth@csbc!DB\endcsname + \csname\@nameauth@csbc!DB\endcsname\fi}% + {\ifcsname\@nameauth@csab!DB\endcsname + \csname\@nameauth@csab!DB\endcsname\fi}% + \fi } % \end{macrocode} % \end{macro} % % \begin{macro}{\NameClearInfo} % \changes{2.4}{2016/03/15}{Added} +% \changes{3.5}{2020/11/23}{Optimize logic, fix namespace} % This deletes a text tag. It has the same structure as \cmd{\UntagName}. % \begin{macrocode} \newcommandx*\NameClearInfo[3][1=\@empty, 3=\@empty] {% - \protected@edef\arga{\trim@spaces{#1}}% - \protected@edef\argc{\trim@spaces{#3}}% - \protected@edef\Suff{\@nameauth@Suffix{#2}}% - \def\csb{\@nameauth@Clean{#2}}% - \def\csbc{\@nameauth@Clean{#2,#3}}% - \def\csab{\@nameauth@Clean{#1!#2}}% -% \end{macrocode} -% We parse the arguments, undefining the text tag control sequences. -% \begin{macrocode} + \@nameauth@LoadArgs{#1}{#2}{#3}% \@nameauth@Error{#2}{macro \string\NameClearInfo}% - \ifx\arga\@empty - \ifx\argc\@empty - \global\csundef{\csb!DB}% - \else - \ifx\Suff\@empty - \global\csundef{\csbc!DB}% - \else - \global\csundef{\csb!DB}% - \fi - \fi - \else - \global\csundef{\csab!DB}% - \fi + \@nameauth@Choice% + {\global\csundef{\@nameauth@csb!DB}}% + {\global\csundef{\@nameauth@csbc!DB}}% + {\global\csundef{\@nameauth@csab!DB}}% } % \end{macrocode} % \end{macro} -% -% \noindent{\large\bfseries Name Decisions} +% \BigBlank +% \newpage +% +% \noindent{\normalsize\bfseries Name Decisions} % \begin{macro}{\IfMainName} % \changes{2.3}{2016/01/05}{Added} -% This macro expands one path if a main matter name exists, or else the other. +% \changes{3.5}{2020/11/23}{Optimize logic, fix namespace, local or global scope} +% This macro expands one path if a main matter name exists, or else the other. The state of \texttt{\textbackslash if@nameauth@GlobalScope} determines whether or not the paths are in a local scope. % \begin{macrocode} \newcommandx\IfMainName[5][1=\@empty, 3=\@empty] {% - \protected@edef\arga{\trim@spaces{#1}}% - \protected@edef\argc{\trim@spaces{#3}}% - \protected@edef\suffb{\@nameauth@Suffix{#2}}% - \def\csb{\@nameauth@Clean{#2}}% - \def\csbc{\@nameauth@Clean{#2,#3}}% - \def\csab{\@nameauth@Clean{#1!#2}}% -% \end{macrocode} -% Below we parse the name arguments and choose the path. -% \begin{macrocode} + \@nameauth@LoadArgs{#1}{#2}{#3}% \@nameauth@Error{#2}{macro \string\IfMainName}% - \ifx\arga\@empty - \ifx\argc\@empty - \ifcsname\csb!MN\endcsname{#4}\else{#5}\fi + \@nameauth@Choice% + {% + \ifcsname\@nameauth@csb!MN\endcsname + \if@nameauth@GlobalScope + #4% + \else + {#4}% + \fi \else - \ifx\suffb\@empty - \ifcsname\csbc!MN\endcsname{#4}\else{#5}\fi + \if@nameauth@GlobalScope + #5% \else - \ifcsname\csb!MN\endcsname{#4}\else{#5}\fi + {#5}% \fi \fi - \else - \ifcsname\csab!MN\endcsname{#4}\else{#5}\fi - \fi + }% + {% + \ifcsname\@nameauth@csbc!MN\endcsname + \if@nameauth@GlobalScope + #4% + \else + {#4}% + \fi + \else + \if@nameauth@GlobalScope + #5% + \else + {#5}% + \fi + \fi + }% + {% + \ifcsname\@nameauth@csab!MN\endcsname + \if@nameauth@GlobalScope + #4% + \else + {#4}% + \fi + \else + \if@nameauth@GlobalScope + #5% + \else + {#5}% + \fi + \fi + }% } % \end{macrocode} % \end{macro} -% +% % \begin{macro}{\IfFrontName} % \changes{2.3}{2016/01/05}{Added} -% This macro expands one path if a front matter name exists, or else the other. +% \changes{3.5}{2020/11/23}{Optimize logic, fix namespace, local or global scope} +% This macro expands one path if a front matter name exists, or else the other. The state of \texttt{\textbackslash if@nameauth@GlobalScope} determines whether or not the paths are in a local scope. % \begin{macrocode} \newcommandx\IfFrontName[5][1=\@empty, 3=\@empty] {% - \protected@edef\arga{\trim@spaces{#1}}% - \protected@edef\argc{\trim@spaces{#3}}% - \protected@edef\suffb{\@nameauth@Suffix{#2}}% - \def\csb{\@nameauth@Clean{#2}}% - \def\csbc{\@nameauth@Clean{#2,#3}}% - \def\csab{\@nameauth@Clean{#1!#2}}% -% \end{macrocode} -% Below we parse the name arguments and choose the path. -% \begin{macrocode} + \@nameauth@LoadArgs{#1}{#2}{#3}% \@nameauth@Error{#2}{macro \string\IfFrontName}% - \ifx\arga\@empty - \ifx\argc\@empty - \ifcsname\csb!NF\endcsname{#4}\else{#5}\fi + \@nameauth@Choice% + {% + \ifcsname\@nameauth@csb!NF\endcsname + \if@nameauth@GlobalScope + #4% + \else + {#4}% + \fi \else - \ifx\suffb\@empty - \ifcsname\csbc!NF\endcsname{#4}\else{#5}\fi + \if@nameauth@GlobalScope + #5% \else - \ifcsname\csb!NF\endcsname{#4}\else{#5}\fi + {#5}% \fi \fi - \else - \ifcsname\csab!NF\endcsname{#4}\else{#5}\fi - \fi + }% + {% + \ifcsname\@nameauth@csbc!NF\endcsname + \if@nameauth@GlobalScope + #4% + \else + {#4}% + \fi + \else + \if@nameauth@GlobalScope + #5% + \else + {#5}% + \fi + \fi + }% + {% + \ifcsname\@nameauth@csab!NF\endcsname + \if@nameauth@GlobalScope + #4% + \else + {#4}% + \fi + \else + \if@nameauth@GlobalScope + #5% + \else + {#5}% + \fi + \fi + }% } % \end{macrocode} % \end{macro} -% +% \newpage +% % \begin{macro}{\IfAKA} % \changes{2.3}{2016/01/05}{Added} % \changes{2.4}{2016/03/15}{Test for excluded} % \changes{3.0}{2016/10/26}{Redesigned} -% This macro expands one path if a cross-reference exists, another if it does not exist, and a third if it is excluded. +% \changes{3.5}{2020/11/23}{New exclusion test, optimize logic, fix namespace, local or global scope} +% This macro expands one path if a cross-reference exists, another if it does not exist, and a third if it is excluded. The state of \texttt{\textbackslash if@nameauth@GlobalScope} determines whether or not the paths are in a local scope. % \begin{macrocode} \newcommandx\IfAKA[6][1=\@empty, 3=\@empty] {% - \protected@edef\arga{\trim@spaces{#1}}% - \protected@edef\argc{\trim@spaces{#3}}% - \protected@edef\suffb{\@nameauth@Suffix{#2}}% - \def\csb{\@nameauth@Clean{#2}}% - \def\csbc{\@nameauth@Clean{#2,#3}}% - \def\csab{\@nameauth@Clean{#1!#2}}% + \@nameauth@LoadArgs{#1}{#2}{#3}% + \@nameauth@Error{#2}{macro \string\IfAKA}% % \end{macrocode} % For each class of name we test first if a cross-reference exists, then if it is excluded. % \begin{macrocode} - \@nameauth@Error{#2}{macro \string\IfAKA}% - \ifx\arga\@empty - \ifx\argc\@empty - \ifcsname\csb!PN\endcsname - \edef\testex{\csname\csb!PN\endcsname}% - \ifx\testex\@empty{#4}\else{#6}\fi - \else{#5}\fi + \@nameauth@Choice% + {% + \ifcsname\@nameauth@csb!PN\endcsname + \edef\@nameauth@testex{\csname\@nameauth@csb!PN\endcsname}% + \ifx\@nameauth@testex\@nameauth@Exclude + \if@nameauth@GlobalScope + #6% + \else + {#6}% + \fi + \else + \if@nameauth@GlobalScope + #4% + \else + {#4}% + \fi + \fi \else - \ifx\suffb\@empty - \ifcsname\csbc!PN\endcsname - \edef\testex{\csname\csbc!PN\endcsname}% - \ifx\testex\@empty{#4}\else{#6}\fi - \else{#5}\fi + \if@nameauth@GlobalScope + #5% \else - \ifcsname\csb!PN\endcsname - \edef\testex{\csname\csb!PN\endcsname}% - \ifx\testex\@empty{#4}\else{#6}\fi - \else{#5}\fi + {#5}% \fi \fi - \else - \ifcsname\csab!PN\endcsname - \edef\testex{\csname\csab!PN\endcsname}% - \ifx\testex\@empty{#4}\else{#6}\fi - \else{#5}\fi - \fi + }% + {% + \ifcsname\@nameauth@csbc!PN\endcsname + \edef\@nameauth@testex{\csname\@nameauth@csbc!PN\endcsname}% + \ifx\@nameauth@testex\@nameauth@Exclude + \if@nameauth@GlobalScope + #6% + \else + {#6}% + \fi + \else + \if@nameauth@GlobalScope + #4% + \else + {#4}% + \fi + \fi + \else + \if@nameauth@GlobalScope + #5% + \else + {#5}% + \fi + \fi + }% + {% + \ifcsname\@nameauth@csab!PN\endcsname + \edef\@nameauth@testex{\csname\@nameauth@csab!PN\endcsname}% + \ifx\@nameauth@testex\@nameauth@Exclude + \if@nameauth@GlobalScope + #6% + \else + {#6}% + \fi + \else + \if@nameauth@GlobalScope + #4% + \else + {#4}% + \fi + \fi + \else + \if@nameauth@GlobalScope + #5% + \else + {#5}% + \fi + \fi + }% } % \end{macrocode} % \end{macro} % -% \noindent{\large\bfseries Changing Name Decisions} +% \noindent{\normalsize\bfseries Changing Name Decisions} % \begin{macro}{\ForgetName} -% \changes{0.75}{2012/01/19}{Current args} % \changes{1.9}{2015/07/09}{Global undef} % \changes{2.3}{2016/01/05}{Global or local} -% This undefines a control sequence to force a ``first use.'' +% \changes{3.5}{2020/11/23}{Optimize logic, fix namespace} +% This undefines a control sequence to force a ``first use''. % \begin{macrocode} \newcommandx*\ForgetName[3][1=\@empty, 3=\@empty] {% - \protected@edef\arga{\trim@spaces{#1}}% - \protected@edef\argc{\trim@spaces{#3}}% - \protected@edef\suffb{\@nameauth@Suffix{#2}}% - \def\csb{\@nameauth@Clean{#2}}% - \def\csbc{\@nameauth@Clean{#2,#3}}% - \def\csab{\@nameauth@Clean{#1!#2}}% +% \end{macrocode} +% Process and load the arguments into the appropriate macros. +% \begin{macrocode} + \@nameauth@LoadArgs{#1}{#2}{#3}% \@nameauth@Error{#2}{macro \string\ForgetName}% % \end{macrocode} % Now we parse the arguments, undefining the control sequences either by current name type (via |@nameauth@MainFormat|) or completely (toggled by |@nameauth@LocalNames|). % \begin{macrocode} - \ifx\arga\@empty - \ifx\argc\@empty - \if@nameauth@LocalNames - \if@nameauth@MainFormat - \global\csundef{\csb!MN}% - \else - \global\csundef{\csb!NF}% - \fi + \@nameauth@Choice% +% \end{macrocode} +% Non-Western names. +% \begin{macrocode} + {% + \if@nameauth@LocalNames + \if@nameauth@MainFormat + \global\csundef{\@nameauth@csb!MN}% \else - \global\csundef{\csb!MN}% - \global\csundef{\csb!NF}% + \global\csundef{\@nameauth@csb!NF}% \fi \else - \ifx\suffb\@empty - \if@nameauth@LocalNames - \if@nameauth@MainFormat - \global\csundef{\csbc!MN}% - \else - \global\csundef{\csbc!NF}% - \fi - \else - \global\csundef{\csbc!MN}% - \global\csundef{\csbc!NF}% - \fi + \global\csundef{\@nameauth@csb!MN}% + \global\csundef{\@nameauth@csb!NF}% + \fi + }% +% \end{macrocode} +% Non-Western names, obsolete syntax. +% \begin{macrocode} + {% + \if@nameauth@LocalNames + \if@nameauth@MainFormat + \global\csundef{\@nameauth@csbc!MN}% \else - \if@nameauth@LocalNames - \if@nameauth@MainFormat - \global\csundef{\csb!MN}% - \else - \global\csundef{\csb!NF}% - \fi - \else - \global\csundef{\csb!MN}% - \global\csundef{\csb!NF}% - \fi + \global\csundef{\@nameauth@csbc!NF}% \fi + \else + \global\csundef{\@nameauth@csbc!MN}% + \global\csundef{\@nameauth@csbc!NF}% \fi - \else + }% +% \end{macrocode} +% Western names. +% \begin{macrocode} + {% \if@nameauth@LocalNames \if@nameauth@MainFormat - \global\csundef{\csab!MN}% + \global\csundef{\@nameauth@csab!MN}% \else - \global\csundef{\csab!NF}% + \global\csundef{\@nameauth@csab!NF}% \fi \else - \global\csundef{\csab!MN}% - \global\csundef{\csab!NF}% + \global\csundef{\@nameauth@csab!MN}% + \global\csundef{\@nameauth@csab!NF}% \fi - \fi + }% } % \end{macrocode} % \end{macro} @@ -7504,97 +9028,89 @@ the README.txt or README for more information. % \changes{0.9}{2012/02/10}{Added} % \changes{2.3}{2016/01/05}{Global or local} % \changes{3.1}{2017/01/13}{Fix old syntax} -% This defines a control sequence to force a ``subsequent use.'' +% \changes{3.5}{2020/11/23}{Optimize logic, fix namespace} +% This defines a control sequence to force a ``subsequent use''. % \begin{macrocode} \newcommandx*\SubvertName[3][1=\@empty, 3=\@empty] {% - \protected@edef\arga{\trim@spaces{#1}}% - \protected@edef\argc{\trim@spaces{#3}}% - \protected@edef\suffb{\@nameauth@Suffix{#2}}% - \def\csb{\@nameauth@Clean{#2}}% - \def\csbc{\@nameauth@Clean{#2,#3}}% - \def\csab{\@nameauth@Clean{#1!#2}}% -% \end{macrocode} -% We make copies of the arguments to test them. -% \begin{macrocode} + \@nameauth@LoadArgs{#1}{#2}{#3}% \@nameauth@Error{#2}{macro \string\SubvertName}% % \end{macrocode} % Now we parse the arguments, defining the control sequences either locally by section type or globally. |@nameauth@LocalNames| toggles the local or global behavior, while we select the type of name with |@nameauth@MainFormat|. % \begin{macrocode} - \ifx\arga\@empty - \ifx\argc\@empty - \if@nameauth@LocalNames - \if@nameauth@MainFormat - \csgdef{\csb!MN}{}% - \else - \csgdef{\csb!NF}{}% - \fi + \@nameauth@Choice% +% \end{macrocode} +% Non-Western names. +% \begin{macrocode} + {% + \if@nameauth@LocalNames + \if@nameauth@MainFormat + \csgdef{\@nameauth@csb!MN}{}% \else - \csgdef{\csb!MN}{}% - \csgdef{\csb!NF}{}% + \csgdef{\@nameauth@csb!NF}{}% \fi \else - \ifx\suffb\@empty - \if@nameauth@LocalNames - \if@nameauth@MainFormat - \csgdef{\csbc!MN}{}% - \else - \csgdef{\csbc!NF}{}% - \fi - \else - \csgdef{\csbc!MN}{}% - \csgdef{\csbc!NF}{}% - \fi - \else - \if@nameauth@LocalNames - \if@nameauth@MainFormat - \csgdef{\csb!MN}{}% - \else - \csgdef{\csb!NF}{}% - \fi - \else - \csgdef{\csb!MN}{}% - \csgdef{\csb!NF}{}% - \fi + \csgdef{\@nameauth@csb!MN}{}% + \csgdef{\@nameauth@csb!NF}{}% + \fi + }% +% \end{macrocode} +% Non-Western names, obsolete syntax. +% \begin{macrocode} + {% + \if@nameauth@LocalNames + \if@nameauth@MainFormat + \csgdef{\@nameauth@csbc!MN}{}% + \else + \csgdef{\@nameauth@csbc!NF}{}% \fi + \else + \csgdef{\@nameauth@csbc!MN}{}% + \csgdef{\@nameauth@csbc!NF}{}% \fi - \else + }% +% \end{macrocode} +% Western names. +% \begin{macrocode} + {% \if@nameauth@LocalNames \if@nameauth@MainFormat - \csgdef{\csab!MN}{}% + \csgdef{\@nameauth@csab!MN}{}% \else - \csgdef{\csab!NF}{}% + \csgdef{\@nameauth@csab!NF}{}% \fi \else - \csgdef{\csab!MN}{}% - \csgdef{\csab!NF}{}% + \csgdef{\@nameauth@csab!MN}{}% + \csgdef{\@nameauth@csab!NF}{}% \fi - \fi + }% } % \end{macrocode} % \end{macro} -% -% \noindent{\large\bfseries Alternate Names} +% +% \noindent{\normalsize\bfseries Alternate Names} % \begin{macro}{\AKA} -% \changes{0.85}{2012/02/05}{Hide commas} % \changes{1.26}{2012/04/24}{Fix affixes} -% \changes{1.5}{2013/02/22}{Reversing, caps} -% \changes{2.0}{2015/11/11}{Trim spaces; fix tagging} +% \changes{1.5}{2013/02/22}{Reversing/caps} +% \changes{2.0}{2015/11/11}{Trim spaces; fix tags} % \changes{2.1}{2015/11/24}{Fix Unicode} % \changes{2.3}{2016/01/05}{Fix starred mode} % \changes{2.41}{2016/03/17}{Fix token regs} % \changes{2.6}{2016/09/19}{Fix index commas} % \changes{3.0}{2016/10/26}{Redesigned} % \changes{3.1}{2017/01/13}{Can skip index} -% \changes{3.3}{2020/02/20}{global flag reset} +% \changes{3.3}{2020/02/20}{Global flag reset} +% \changes{3.5}{2020/11/23}{Fix namespace} % \cmd{\AKA} prints an alternate name and creates index cross-references. It prevents multiple generation of cross-references and suppresses double periods. % \begin{macrocode} \newcommandx*\AKA[5][1=\@empty, 3=\@empty, 5=\@empty] {% % \end{macrocode} -% Prevent entering \cmd{\AKA} via itself or \cmd{\@nameauth@Name}. Prevent the index-only flag. Tell the formatting system that \cmd{\AKA} is running. +% Prevent entering \cmd{\AKA} via itself or \cmd{\@nameauth@Name}. Prevents and resets \cmd{\JustIndex}. Tell the formatting system that \cmd{\AKA} is running. % \begin{macrocode} - \if@nameauth@BigLock\@nameauth@Locktrue\fi + \if@nameauth@BigLock + \@nameauth@Locktrue% + \fi \unless\if@nameauth@Lock \@nameauth@Locktrue% \@nameauth@InAKAtrue% @@ -7612,69 +9128,45 @@ the README.txt or README for more information. % Names occur in horizontal mode; we ensure that. Next we make copies of the target name arguments and we parse and print the cross-reference name. % \begin{macrocode} \leavevmode\hbox{}% - \protected@edef\argi{\trim@spaces{#1}}% - \protected@edef\rooti{\@nameauth@Root{#2}}% - \protected@edef\suffi{\@nameauth@Suffix{#2}}% - \@nameauth@Parse[#3]{#4}[#5]{!PN}% + \protected@edef\@nameauth@Ai{\trim@spaces{#1}}% + \protected@edef\@nameauth@Bi{\@nameauth@Root{#2}}% + \protected@edef\@nameauth@Si{\@nameauth@Suffix{#2}}% + \@nameauth@Parse{#3}{#4}{#5}{!PN}% + \def\@nameauth@space{ }% % \end{macrocode} +% \newpage\noindent % Create an index cross-reference based on the arguments. % \begin{macrocode} \unless\if@nameauth@SkipIndex - \ifx\argi\@empty - \ifx\suffi\@empty - \IndexRef[#3]{#4}[#5]{\rooti}% + \ifx\@nameauth@Ai\@empty + \ifx\@nameauth@Si\@empty + \IndexRef[#3]{#4}[#5]{\@nameauth@Bi}% \else - \IndexRef[#3]{#4}[#5]{\rooti\space\suffi}% + \IndexRef[#3]{#4}[#5]% + {\@nameauth@Bi\@nameauth@space% + \@nameauth@Si}% \fi \else - \ifx\suffi\@empty - \IndexRef[#3]{#4}[#5]{\rooti,\space\argi}% + \ifx\@nameauth@Si\@empty + \IndexRef[#3]{#4}[#5]% + {\@nameauth@Bi,\@nameauth@space\@nameauth@Ai}% \else - \IndexRef[#3]{#4}[#5]{\rooti,\space\argi,\space\suffi}% + \IndexRef[#3]{#4}[#5]% + {\@nameauth@Bi,\@nameauth@space% + \@nameauth@Ai,\@nameauth@space\@nameauth@Si}% \fi \fi \fi % \end{macrocode} % Reset all the ``per name'' Boolean values. The default is global. % \begin{macrocode} - \if@nameauth@OldReset - \@nameauth@SkipIndexfalse% - \@nameauth@AltAKAfalse% - \@nameauth@NBSPfalse% - \@nameauth@NBSPXfalse% - \@nameauth@DoCapsfalse% - \@nameauth@Accentfalse% - \@nameauth@AllThisfalse% - \@nameauth@ShowCommafalse% - \@nameauth@NoCommafalse% - \@nameauth@RevThisfalse% - \@nameauth@RevThisCommafalse% - \@nameauth@ShortSNNfalse% - \@nameauth@EastFNfalse% - \else - \global\@nameauth@SkipIndexfalse% - \global\@nameauth@AltAKAfalse% - \global\@nameauth@NBSPfalse% - \global\@nameauth@NBSPXfalse% - \global\@nameauth@DoCapsfalse% - \global\@nameauth@Accentfalse% - \global\@nameauth@AllThisfalse% - \global\@nameauth@ShowCommafalse% - \global\@nameauth@NoCommafalse% - \global\@nameauth@RevThisfalse% - \global\@nameauth@RevThisCommafalse% - \global\@nameauth@ShortSNNfalse% - \global\@nameauth@EastFNfalse% - \fi + \@nameauth@Flags% \@nameauth@Lockfalse% \@nameauth@InAKAfalse% % \end{macrocode} -% Close the ``locked'' branch. +% Close the ``locked'' branch and call the full stop detection. This conditional statement must be on one line. % \begin{macrocode} \fi -% \end{macrocode} -% Call the full stop detection. -% \begin{macrocode} \if@nameauth@Punct\expandafter\@nameauth@CheckDot\fi } % \end{macrocode} @@ -7684,22 +9176,52 @@ the README.txt or README for more information. % \changes{0.9}{2012/02/10}{Added} % This starred form sets a Boolean to print only the alternate name argument, if that exists, and calls \cmd{\AKA}. % \begin{macrocode} -\WithSuffix{\newcommand*}\AKA*{\@nameauth@AltAKAtrue\AKA} +\WithSuffix{\newcommand*}\AKA*{\@nameauth@AltAKAtrue \AKA} % \end{macrocode} % \end{macro} % % \begin{macro}{\PName} % \changes{2.3}{2016/01/05}{Work with hooks} % \changes{3.1}{2017/01/13}{Can skip index} -% \cmd{\PName} is a convenience macro that calls \cmd{\NameauthName}, then \cmd{\AKA}. It prevents the index-only feature from triggering. +% \changes{3.5}{2020/11/23}{Warning and flag resets added} +% \cmd{\PName} is a convenience macro that calls \cmd{\NameauthName}, then \cmd{\AKA}. % \begin{macrocode} \newcommandx*\PName[5][1=\@empty,3=\@empty,5=\@empty] {% - \@nameauth@JustIndexfalse% +% \end{macrocode} +% If we used \cmd{\JustIndex}, we ignore and reset its flag to false. +% \begin{macrocode} + \if@nameauth@OldReset + \@nameauth@JustIndexfalse% + \else + \global\@nameauth@JustIndexfalse% + \fi +% \end{macrocode} +% If we used \cmd{\SkipIndex}, we reset the flag of \cmd{\SeeAlso} and activate \cmd{\SkipIndex}for both \cmd{\NameauthName} and \cmd{\AKA}. +% \begin{macrocode} \if@nameauth@SkipIndex - \NameauthName[#1]{#2}\space(\SkipIndex\AKA[#1]{#2}[#3]{#4}[#5])% + \unless\if@nameauth@OldReset + \global\@nameauth@SeeAlsofalse% + \fi + \NameauthName[#1]{#2} (\SkipIndex\AKA[#1]{#2}[#3]{#4}[#5])% \else - \NameauthName[#1]{#2}\space(\AKA[#1]{#2}[#3]{#4}[#5])% +% \end{macrocode} +% Otherwise, if we used \cmd{\SeeAlso} we set the flag of \cmd{\SeeAlso} false for \cmd{\NameauthName} and true for \cmd{\AKA}. The ``normal'' case after that is trivial. +% \begin{macrocode} + \if@nameauth@SeeAlso + \@nameauth@SeeAlsofalse\NameauthName[#1]{#2} + \@nameauth@SeeAlsotrue(\AKA[#1]{#2}[#3]{#4}[#5])% + \else + \NameauthName[#1]{#2} + (\AKA[#1]{#2}[#3]{#4}[#5])% + \fi + \fi +% \end{macrocode} +% Warn if \cmd{\SkipIndex} remains in effect (potentially due to the \texttt{oldreset} option). Normally, this state should not occur. +% \begin{macrocode} + \if@nameauth@SkipIndex + \PackageWarning{nameauth}% + {\SkipIndex still active after \PName; check for problems}% \fi } % \end{macrocode} @@ -7708,108 +9230,111 @@ the README.txt or README for more information. % \begin{macro}{\PName*} % This sets up a long name reference and calls \cmd{\PName}. % \begin{macrocode} -\WithSuffix{\newcommand*}\PName*{\@nameauth@FullNametrue\PName} +\WithSuffix{\newcommand*}\PName*{\@nameauth@FullNametrue \PName} % \end{macrocode} % \end{macro} % -% \noindent{\large\bfseries Simplified Interface} +% \noindent{\normalsize\bfseries Quick Interface} % \begin{environment}{nameauth} % \changes{1.6}{2013/03/10}{Environment added} -% \changes{1.9}{2015/07/09}{Bugfix} % \changes{2.0}{2015/11/11}{Better arg handling} -% \changes{2.11}{2015/11/29}{Bugfix} % \changes{2.41}{2016/03/17}{No local \cmd{\newtoks}} -% The \texttt{nameauth} environment creates macro shorthands. First we define a control sequence \cmd{\<} that takes four parameters, delimited by three ampersands and \texttt{>}. +% \changes{3.5}{2020/11/23}{Fix namespace} +% The \texttt{nameauth} environment creates macro shorthands. First we define a control sequence \cmd{\<} that takes four parameters, delimited by three ampersands and \texttt{>}. This macro is defined only within the \texttt{nameauth} environment, but the shorthand macros that it creates are globally defined. % \begin{macrocode} \newenvironment{nameauth}{% \begingroup% \let\ex\expandafter% \csdef{<}##1&##2&##3&##4>{% - \protected@edef\@arga{\trim@spaces{##1}}% - \protected@edef\@testb{\trim@spaces{##2}}% - \protected@edef\@testd{\trim@spaces{##4}}% - \@nameauth@etoksb\expandafter{##2}% - \@nameauth@etoksc\expandafter{##3}% - \@nameauth@etoksd\expandafter{##4}% + \protected@edef\@arga@{\trim@spaces{##1}}% + \protected@edef\@larga@{L\trim@spaces{##1}}% + \protected@edef\@sarga@{S\trim@spaces{##1}}% + \protected@edef\@testb@{\trim@spaces{##2}}% + \protected@edef\@testd@{\trim@spaces{##4}}% + \@nameauth@etoksb\ex{##2}% + \@nameauth@etoksc\ex{##3}% + \@nameauth@etoksd\ex{##4}% % \end{macrocode} % The first argument must have some text to create a set of control sequences with it. The third argument is the required name argument. Redefining a shorthand creates a warning. % \begin{macrocode} - \ifx\@arga\@empty + \ifx\@arga@\@empty \PackageError{nameauth}% {environment nameauth: Control sequence missing}% \fi \@nameauth@Error{##3}{environment nameauth}% - \ifcsname\@arga\endcsname + \ifcsname\@arga@\endcsname \PackageWarning{nameauth}% {environment nameauth: Shorthand macro already exists}% \fi % \end{macrocode} -% Set up shorthands according to name form. We have to use \cmd{\expandafter}, not the \(\epsilon\)-\TeX{} way, due to \cmd{\protected@edef} in the naming macros. +% Set up shorthands according to name form. We have to use \cmd{\ex}, not the \(\epsilon\)-\TeX{} way, due to \cmd{\protected@edef} in the naming macros. +% \newpage % -% We begin with mononyms and non-Western names that use the new syntax. We use one \cmd{\expandafter} per token because we only have one argument to expand first. +% We begin with mononyms and non-Western names that use the new syntax. We use one \cmd{\ex} per token because we only have one argument to expand first. % \begin{macrocode} - \ifx\@testd\@empty - \ifx\@testb\@empty - \ex\csgdef\ex{\ex\@arga\ex}% + \ifx\@testd@\@empty + \ifx\@testb@\@empty + \ex\csgdef\ex{\ex\@arga@\ex}% \ex{\ex\NameauthName\ex{\the\@nameauth@etoksc}}% - \ex\csgdef\ex{\ex L\ex\@arga\ex}% + \ex\csgdef\ex{\ex\@larga@\ex}% \ex{\ex\@nameauth@FullNametrue% \ex\NameauthLName\ex{\the\@nameauth@etoksc}}% - \ex\csgdef\ex{\ex S\ex\@arga\ex}% + \ex\csgdef\ex{\ex\@sarga@\ex}% \ex{\ex\@nameauth@FirstNametrue% \ex\NameauthFName\ex{\the\@nameauth@etoksc}}% \else % \end{macrocode} -% Next we have Western names with no alternate names. Here we have two arguments to expand in reverse order, so we need three, then one uses of \cmd{\expandafter} per token. +% Next we have Western names with no alternate names. Here we have two arguments to expand in reverse order, so we need three, then one uses of \cmd{\ex} per token. % \begin{macrocode} - \ex\ex\ex\csgdef\ex\ex\ex{\ex\ex\ex\@arga\ex\ex\ex}% + \ex\ex\ex\csgdef\ex\ex\ex{\ex\ex\ex\@arga@\ex\ex\ex}% \ex\ex\ex{\ex\ex\ex\NameauthName% \ex\ex\ex[\ex\the\ex\@nameauth@etoksb\ex]% \ex{\the\@nameauth@etoksc}}% - \ex\ex\ex\csgdef\ex\ex\ex{\ex\ex\ex L\ex\ex\ex\@arga% - \ex\ex\ex}\ex\ex\ex{\ex\ex\ex\@nameauth@FullNametrue% + \ex\ex\ex\csgdef\ex\ex\ex{\ex\ex\ex\@larga@\ex\ex\ex}% + \ex\ex\ex{\ex\ex\ex\@nameauth@FullNametrue% \ex\ex\ex\NameauthLName% \ex\ex\ex[\ex\the\ex\@nameauth@etoksb\ex]% \ex{\the\@nameauth@etoksc}}% - \ex\ex\ex\csgdef\ex\ex\ex{\ex\ex\ex S\ex\ex\ex\@arga% - \ex\ex\ex}\ex\ex\ex{\ex\ex\ex\@nameauth@FirstNametrue% + \ex\ex\ex\csgdef\ex\ex\ex{\ex\ex\ex\@sarga@\ex\ex\ex}% + \ex\ex\ex{\ex\ex\ex\@nameauth@FirstNametrue% \ex\ex\ex\NameauthFName% \ex\ex\ex[\ex\the\ex\@nameauth@etoksb\ex]% \ex{\the\@nameauth@etoksc}}% \fi \else % \end{macrocode} -% Below are ``native'' Eastern names with alternates and the older syntax. Again, we have three or one use of \cmd{\expandafter} per step before the respective arguments. +% Below are ``native'' Eastern names with alternates and the older syntax. Again, we have three or one use of \cmd{\ex} per step before the respective arguments. % \begin{macrocode} - \ifx\@testb\@empty - \ex\ex\ex\csgdef\ex\ex\ex{\ex\ex\ex\@arga\ex\ex\ex}% + \ifx\@testb@\@empty + \ex\ex\ex\csgdef\ex\ex\ex{\ex\ex\ex\@arga@\ex\ex\ex}% \ex\ex\ex{\ex\ex\ex\NameauthName% \ex\ex\ex{\ex\the\ex\@nameauth@etoksc\ex}% \ex[\the\@nameauth@etoksd]}% - \ex\ex\ex\csgdef\ex\ex\ex{\ex\ex\ex L\ex\ex\ex\@arga% - \ex\ex\ex}\ex\ex\ex{\ex\ex\ex\@nameauth@FullNametrue% + \ex\ex\ex\csgdef\ex\ex\ex{\ex\ex\ex\@larga@\ex\ex\ex}% + \ex\ex\ex{\ex\ex\ex\@nameauth@FullNametrue% \ex\ex\ex\NameauthLName% \ex\ex\ex{\ex\the\ex\@nameauth@etoksc\ex}% \ex[\the\@nameauth@etoksd]}% - \ex\ex\ex\csgdef\ex\ex\ex{\ex\ex\ex S\ex\ex\ex\@arga% - \ex\ex\ex}\ex\ex\ex{\ex\ex\ex\@nameauth@FirstNametrue% + \ex\ex\ex\csgdef\ex\ex\ex{\ex\ex\ex\@sarga@\ex\ex\ex}% + \ex\ex\ex{\ex\ex\ex\@nameauth@FirstNametrue% \ex\ex\ex\NameauthFName% \ex\ex\ex{\ex\the\ex\@nameauth@etoksc\ex}% \ex[\the\@nameauth@etoksd]}% \else % \end{macrocode} -% Here are Western names with alternates. We have three arguments to expand, so we have seven, three, and one respective use of \cmd{\expandafter}. +% \newpage\noindent +% Here are Western names with alternates. We have three arguments to expand, so we have seven, three, and one respective use of \cmd{\ex}. % \begin{macrocode} \ex\ex\ex\ex\ex\ex\ex\csgdef\ex\ex\ex\ex\ex\ex\ex{% - \ex\ex\ex\ex\ex\ex\ex\@arga\ex\ex\ex\ex\ex\ex\ex}% + \ex\ex\ex\ex\ex\ex\ex\@arga@\ex\ex\ex\ex\ex\ex\ex}% \ex\ex\ex\ex\ex\ex\ex{\ex\ex\ex\ex\ex\ex\ex\NameauthName% \ex\ex\ex\ex\ex\ex\ex[\ex\ex\ex\the% \ex\ex\ex\@nameauth@etoksb\ex\ex\ex]% \ex\ex\ex{\ex\the\ex\@nameauth@etoksc\ex}% \ex[\the\@nameauth@etoksd]}% \ex\ex\ex\ex\ex\ex\ex\csgdef\ex\ex\ex\ex\ex\ex\ex{% - \ex\ex\ex\ex\ex\ex\ex L\ex\ex\ex\ex\ex\ex\ex\@arga% - \ex\ex\ex\ex\ex\ex\ex}\ex\ex\ex\ex\ex\ex\ex{% + \ex\ex\ex\ex\ex\ex\ex\@larga@\ex\ex\ex\ex\ex\ex\ex}% + \ex\ex\ex\ex\ex\ex\ex{% \ex\ex\ex\ex\ex\ex\ex\@nameauth@FullNametrue% \ex\ex\ex\ex\ex\ex\ex\NameauthLName% \ex\ex\ex\ex\ex\ex\ex[\ex\ex\ex\the\ex\ex\ex% @@ -7817,8 +9342,8 @@ the README.txt or README for more information. \ex\ex\ex{\ex\the\ex\@nameauth@etoksc\ex}% \ex[\the\@nameauth@etoksd]}% \ex\ex\ex\ex\ex\ex\ex\csgdef\ex\ex\ex\ex\ex\ex\ex{% - \ex\ex\ex\ex\ex\ex\ex S\ex\ex\ex\ex\ex\ex\ex\@arga% - \ex\ex\ex\ex\ex\ex\ex}\ex\ex\ex\ex\ex\ex\ex{% + \ex\ex\ex\ex\ex\ex\ex\@sarga@\ex\ex\ex\ex\ex\ex\ex}% + \ex\ex\ex\ex\ex\ex\ex{% \ex\ex\ex\ex\ex\ex\ex\@nameauth@FirstNametrue% \ex\ex\ex\ex\ex\ex\ex\NameauthFName% \ex\ex\ex\ex\ex\ex\ex[\ex\ex\ex\the\ex\ex\ex% @@ -7832,7 +9357,1495 @@ the README.txt or README for more information. % \end{macrocode} % \end{environment} % \Finale -\endinput -%\iffalse +% \endinput %</package> -%\fi +%<*examples> +%<<examplesvb +\documentclass[oneside]{article} +% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% Backward compatibility for older distributions of LaTeX. +% +% Include the iftex package only if it exists. If the iftex +% package is older than 2019, include additional packages +% that aid using multiple LaTeX engines. +% +\IfFileExists{iftex.sty}{\usepackage{iftex}}{} +\unless\ifdefined\RequireTUTeX + \usepackage{ifxetex} + \usepackage{ifluatex} + \usepackage{ifpdf} +\fi +% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% Compatibility for multiple LaTeX engines. +% +\ifxetex + \usepackage{fontspec} + \usepackage{polyglossia} + \setdefaultlanguage{american} +\else + \ifluatex + \ifpdf + \usepackage{fontspec} + \usepackage{polyglossia} + \setdefaultlanguage{american} + \else + \IfFileExists{utf8-2018.def}{} + {\usepackage[utf8]{inputenc}} + \usepackage[TS1,T1]{fontenc} + \usepackage[american]{babel} + \usepackage{lmodern} + \fi + \else + \IfFileExists{utf8-2018.def}{} + {\usepackage[utf8]{inputenc}} + \usepackage[TS1,T1]{fontenc} + \usepackage[american]{babel} + \usepackage{lmodern} + \fi +\fi +% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% Remainder of package inclusions +% +\usepackage[textwidth=137mm,textheight=237mm, + right=25mm,marginparwidth=39mm,nohead]{geometry} +\usepackage{booktabs} +\usepackage{colortbl} +\usepackage{index} +\usepackage{nameauth}[2020/11/23] +\usepackage{verbatim} +\usepackage{xcolor} +\colorlet{grey}{black!7!white} +\usepackage[colorlinks=true]{hyperref} +% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% We set up indexing, put margin paragraphs on the left, +% and set up the counter for line numbering in verbatim +% environments. +% +\makeindex +\newindex{per}{rdx}{rnd}{Index of Persons} +\renewcommand\NameauthIndex{\index[per]} +\reversemarginpar +\newcounter{VerbLine} +% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% Global definitions of conditionals for examples +% For Scipio Africanus +\newif\ifSkipGens +\newif\ifNoGens +\newif\ifSkipAgnomen +\newif\ifNoAgnomen +% For Thomas Jefferson +\newif\ifGenitive +\newif\ifDoGen +% For George Washington/Mustafa Kemal +\newif\ifNoTag +% For William Shakespeare +\newif\ifSpecialFN +\newif\ifSpecialSN +\newif\ifRevertSN +% For advanced hooks +\newif\ifFbox +\newif\ifFirstCap +\newif\ifInHook +\Fboxtrue +\newif\ifCaps +% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% Global definitions of macros for examples +% For Scipio Africanus +\newcommand*\SCIPi{\ifNoGens + Publius\else Publius Cornelius\fi} +\newcommand*\SCIPii{\ifNoAgnomen + Scipio\else Scipio Africanus\fi} +\newcommand*\ScipioOnly{\SkipAgnomentrue\Scipio} +\newcommand*\CSA{\ifNoGens\ifNoAgnomen + Scipio\else + Scipio Africanus\fi + \else\ifNoAgnomen + Cornelius Scipio\else + Cornelius Scipio Africanus\fi\fi} +\ExcludeName[Publius]{\noexpand\CSA} +% For Thomas Jefferson +\newcommand\JEFF{\ifDoGen\textSC{Jefferson's}\else\textSC{Jefferson}\fi} +% For William Shakespeare +\newcommand*\WM{\ifSpecialFN Wm.\else William\fi} +\newcommand*\SHK{\ifRevertSN \textSC{Shakespeare}\else + \ifSpecialSN \noexpand\AltCaps{t}he Bard\else + \textSC{Shakespeare}\fi\fi} +\newcommand*\Revert{\RevertSNtrue} +% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% We include a few macros from ltxdoc.cls and doc.sty. +% These are copyright by the LaTeX dev team. +% +\makeatletter +\DeclareRobustCommand\meta[1]{% + \ensuremath\langle + \ifmmode \expandafter \nfss@text \fi + {% + \meta@font@select + \edef\meta@hyphen@restore + {\hyphenchar\the\font\the\hyphenchar\font}% + \hyphenchar\font\m@ne + \language\l@nohyphenation + #1\/% + \meta@hyphen@restore + }\ensuremath\rangle +} +\def\meta@font@select{\itshape} +\def\cmd#1{\cs{\expandafter\cmd@to@cs\string#1}} +\def\cmd@to@cs#1#2{\char\number`#2\relax} +\DeclareRobustCommand\cs[1]{\texttt{\char`\\#1}} +\providecommand\marg[1]{% + {\ttfamily\char`\{}\meta{#1}{\ttfamily\char`\}}} +\providecommand\oarg[1]{% + {\ttfamily[}\meta{#1}{\ttfamily]}} +\providecommand\parg[1]{% + {\ttfamily(}\meta{#1}{\ttfamily)}} +\makeatother +% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% We establish name shorthands. Note the heavy use of \noexpand +% in the macro arguments below. This is intrinsic to the proper +% function of such arguments (advanced alternate formatting). +% +\begin{nameauth} + \< Adams & John & \noexpand\textSC{Adams} & > + \< SDJR & Sammy & \noexpand\textSC{Davis}, \noexpand\textSC{Jr}. & > + \< Dem & & Demetrius, I & > + \< deSmet & Pierre-Jean & \noexpand\Fbox{\noexpand\AltCaps{d}e~Smet} & > + \< HAR & & Harun, \noexpand\textSC{\noexpand\AltCaps{a}l-Rashid} & > + \< Harnack & Adolf & Harnack & > + \< Jeff & Thomas & \noexpand\JEFF & > + \< Mencius & & \noexpand\textSC{Mencius} & > + \< Scipio & \noexpand\SCIPi & \noexpand\SCIPii & > + \< OScipio & Publius & \noexpand\CSA & > + \< Shak & \noexpand\WM & \noexpand\SHK & > + \< Sutorius & Quintus & \noexpand\SUTOR & > + \< Wash & George & Washington & > +\end{nameauth} +% +% We could add name info database tags (text tags) either +% in the preamble or in the document environment. We will do +% the latter in this example file. +% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% Below we establish sort tags for names. We also can do that +% later on in the body text. Note again the consistent use of +% \noexpand with alternate formatting. +% +\PretagName[John]{\noexpand\textSC{Adams}}{Adams, John} +\PretagName[Sammy]{\noexpand\textSC{Davis}, \noexpand\textSC{Jr}.}{Davis, Sammy, Jr.} +\PretagName{Demetrius, I}{Demetrius 1} +\PretagName[Pierre-Jean]{\noexpand\Fbox{\noexpand\AltCaps{d}e~Smet}}{de~Smet, Pierre-Jean} +\PretagName{Harun, \noexpand\textSC{\noexpand\AltCaps{a}l-Rashid}}{Harun al-Rashid} +\PretagName[Thomas]{\noexpand\JEFF}{Jefferson, Thomas} +\PretagName{\noexpand\textSC{Mencius}}{Mencius} +\PretagName{\noexpand\textSC{Meng}, Ke}{Meng Ke} +\PretagName[\noexpand\SCIPi]{\noexpand\SCIPii}{Scipio Africanus} +\PretagName[Publius]{\noexpand\CSA}{Cornelius Scipio Africanus} +\PretagName[Quintus]{\noexpand\SUTOR}{Naevius Sutorius} +\PretagName[\noexpand\WM]{\noexpand\SHK}{Shakespeare, William} +\PretagName{Vlad, Ţepeş}{Vlad Tepes} +\TagName[John]{\noexpand\textSC{Adams}}{, president} +\TagName{Demetrius, I}{ Soter, king} +\TagName[Thomas]{\noexpand\JEFF}{, president} +\TagName{Vlad, II}{ Dracul} +\TagName{Vlad, III}{ Dracula} +\TagName[Martin]{Van Buren}{, president} +\TagName[Ulysses S.]{Grant}{, president} +\TagName[George]{Washington}{, president} +% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% We set up line numbering in verbatim environments. +% +\makeatletter +\newcommand*\ClearNum{\def\verbatim@processline{\the\verbatim@line\par}} +\newcommand*\StartNum{\setcounter{VerbLine}{0}\def\verbatim@processline{\stepcounter{VerbLine}\leavevmode\llap{\footnotesize\normalfont\theVerbLine\quad}\the\verbatim@line\par}} +\newcommand*\ContinueNum{\def\verbatim@processline{\stepcounter{VerbLine}\leavevmode\llap{\footnotesize\normalfont\theVerbLine\quad}\the\verbatim@line\par}} +\makeatother +% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% The default verbatim format is no line numbers. +% We add title, author, and date. +% +\ClearNum +\title{\bfseries Longer Examples} +\author{Charles P. Schaum} +\date{2020/11/23} + +\begin{document} +\maketitle + +\phantomsection +\pdfbookmark[1]{\contentsname}{toc} +\tableofcontents +\newpage + +\section{Particles} + +First we use variants with the \meta{Alternate} argument: + +\NameAddInfo{Demetrius, I}{ Soter} +\begin{quote}\small +\StartNum +\begin{verbatim} +\NameAddInfo{Demetrius, I}{ Soter} +\PretagName{Demetrius, I}{Demetrius 1} +\TagName{Demetrius, I}{ Soter, king} +\begin{nameauth} +\< Dem & & Demetrius, I & > +\end{nameauth} +\end{verbatim} + + \smallskip + \begin{tabular}{ll}\toprule + \cmd{\Dem[I Soter]} & \Dem[I Soter]\\ + \rowcolor{grey}% + \cmd{\LDem} & \LDem\\ + \cmd{\Dem} & \Dem\\\bottomrule + \end{tabular} + \end{quote} + +\begingroup% +\makeatletter +\renewcommand*\NamesFormat[1]{% + \begingroup% + \protected@edef\temp{\endgroup% + {#1\noexpand\NameQueryInfo + [\unexpanded\expandafter{\the\@nameauth@toksa}] + {\unexpanded\expandafter{\the\@nameauth@toksb}} + [\unexpanded\expandafter{\the\@nameauth@toksc}]% + }% + }% + \temp% +} +\makeatother +For a more automated approach, we use ``text tags'': + +\begin{quote}\small +\ContinueNum +\begin{verbatim} +\makeatletter +\makeatletter +\renewcommand*\NamesFormat[1]{% + \begingroup% + \protected@edef\temp{\endgroup% + {#1\noexpand\NameQueryInfo + [\unexpanded\expandafter{\the\@nameauth@toksa}] + {\unexpanded\expandafter{\the\@nameauth@toksb}} + [\unexpanded\expandafter{\the\@nameauth@toksc}]% + }% + }% + \temp% +} +\makeatother +\end{verbatim} + +\smallskip + \begin{tabular}{ll}\toprule + \cmd{\ForgetThis}\cmd{\Dem} & \ForgetThis\Dem\\ + \rowcolor{grey}% + \cmd{\LDem} & \LDem\\ + \cmd{\Dem} & \Dem\\\bottomrule + \end{tabular} +\end{quote} +\endgroup + +\vfil +\noindent And now for something completely different\dots + + We mention the Electric Boogaloo\index{Boogaloo, Electric} + by \Name{Ollie~\& Jerry}.\\ + +\noindent The index references made here will put: + + ``Boogaloo, Electric'' in the main index + + and ``\ShowIdxPageref*{Ollie~\& Jerry}'' in the index of names. +\newpage + +\section{Roman Names} + + We define all macros and conditionals used in naming macro arguments in the preamble. We use \cmd{\noexpand} in the naming macro arguments to prevent error. Since we do not use \cmd{\CapThis} in the examples below, we skip alternate formatting for simplicity, yet we still recommend it: + \begin{quote}\small + \StartNum + \begin{verbatim} +\newif\ifSkipGens +\newif\ifNoGens +\newif\ifSkipAgnomen +\newif\ifNoAgnomen +\newcommand*\SCIPi{\ifNoGens + Publius\else Publius Cornelius\fi} +\newcommand*\SCIPii{\ifNoAgnomen + Scipio\else Scipio Africanus\fi} +\newcommand*\ScipioOnly{\SkipAgnomentrue\Scipio} +\begin{nameauth} + \< Scipio & \noexpand\SCIPi & \noexpand\SCIPii & > +\end{nameauth} +\PretagName[\noexpand\SCIPi]{\noexpand\SCIPii}{Scipio Africanus}\end{verbatim} + \end{quote} + + We begin a new scope below, redefining the formatting hooks, which affect only names printed in the text. If the local Boolean flags are false, one gets longer name forms. If the flags are true, one gets shorter forms. This approach allows the global state of the flags to be false by default, meaning that one need not remember to set any of them true in the preamble. That results in one less thing to remember, and one less problem to fix. +\begingroup +\renewcommand*\NamesFormat[1] + {\ifSkipGens\NoGenstrue\fi\ifSkipAgnomen\NoAgnomentrue\fi#1% + \global\SkipGensfalse\global\SkipAgnomenfalse} +\renewcommand*\MainNameHook[1] + {\ifSkipGens\NoGenstrue\fi\ifSkipAgnomen\NoAgnomentrue\fi#1% + \global\SkipGensfalse\global\SkipAgnomenfalse} + \begin{quote}\small + \ContinueNum + \begin{verbatim} +\renewcommand*\NamesFormat[1] + {\ifSkipGens\NoGenstrue\fi\ifSkipAgnomen\NoAgnomentrue\fi#1% + \global\SkipGensfalse\global\SkipAgnomenfalse} +\renewcommand*\MainNameHook[1] + {\ifSkipGens\NoGenstrue\fi\ifSkipAgnomen\NoAgnomentrue\fi#1% + \global\SkipGensfalse\global\SkipAgnomenfalse}\end{verbatim} + \end{quote} + + The index always shows the name determined by the global state of \cmd{\NoGens} and \cmd{\NoAgnomen}, which we set up as false, meaning a maximally long name form. In the body text we have: + \begin{quote}\small + \ForgetThis\ScipioOnly\ \cmd{\ScipioOnly} was born around 236 \textsc{bc} into the Scipio branch of the Cornelius clan, one of six large patrician clans. \ScipioOnly\ \cmd{\ScipioOnly} rose to military fame during the Second Punic War. Thereafter he was known as \Scipio\ \cmd{\Scipio}. + \end{quote} + + Below we show more information about popular name forms by way of comparison with scholarly name forms.\medskip + + The \textit{Oxford Classical Dictionary} and other scholarly sources index according to the \textit{nomen}. That approach moves the \textit{nomen} from \meta{FNN} to \meta{SNN}. + + The two methods do not clash \textit{per se} in the text, but they make incompatible index entries. In this case, since we have indexed \ScipioOnly\ under the popular form above, we use \cmd{\ExcludeName} to exclude the scholarly form below. + + In the document preamble we define the following Boolean flags and macros. We use a nested conditional in \meta{SNN}. The default still is to show all names so that they can be indexed that way: + \begin{quote}\small + \StartNum + \begin{verbatim} +\newif\ifSkipGens % These flags remain the same as above. +\newif\ifNoGens +\newif\ifSkipAgnomen +\newif\ifNoAgnomen +\global\def\CSA{\ifNoGens\ifNoAgnomen + Scipio\else + Scipio Africanus\fi + \else\ifNoAgnomen + Cornelius Scipio\else + Cornelius Scipio Africanus\fi\fi} +\ExcludeName[Publius]{\noexpand\CSA} +\begin{nameauth} + \< OScipio & Publius & \noexpand\CSA & > % O for Oxford +\end{nameauth} +\PretagName[Publius]{\noexpand\CSA}{Cornelius Scipio Africanus}\end{verbatim} + \end{quote} + + We keep the same formatting macros that we defined above. By the way, these formatting macros could work with regular names as well as Roman names, e.g., \LDem, because they have no side effects. + + The scholarly form of Roman names has a different name pattern, so it is not compatible with the popular version. Nevertheless, we show what the index entries would be in a normal \LaTeX\ document without hyperlinks: + \begin{quote}\small\IndexActual{@} + \textbf{Simplified Name Patterns:}\\ + Scholarly: \texttt{\ShowPattern[Publius]{\noexpand\CSA}}\\ + \setbox0\hbox{Scholarly:}\hbox to \wd0{Popular:\hfill} \texttt{\ShowPattern[\noexpand\SCIPi]{\noexpand\SCIPii}}\\ + + \textbf{Full Index Entries:} + \UntagName[Publius]{\noexpand\CSA} + \UntagName[\noexpand\SCIPi]{\noexpand\SCIPii}\\ + Scholarly:\\ \hbox{}\quad\texttt{\ShowIdxPageref[Publius]{\noexpand\CSA}}\\ + Popular:\\ \hbox{}\quad\texttt{\ShowIdxPageref[\noexpand\SCIPi]{\noexpand\SCIPii}} + \TagName[Publius]{\noexpand\CSA}{\string|hyperpage} + \TagName[\noexpand\SCIPi]{\noexpand\SCIPii}{\string|hyperpage}\\ + + \textbf{Basic Index Entries:}\\ + \UntagName[Publius]{\noexpand\CSA} + Scholarly:\\ \hbox{}\quad\ShowIdxPageref*[Publius]{\noexpand\CSA}\\ + Popular:\\ \hbox{}\quad\ShowIdxPageref*[\noexpand\SCIPi]{\noexpand\SCIPii} + \end{quote} + + Below we compare some differences between the scholarly and popular forms, and how to get equivalent forms in the text while understanding that they would be two separate forms in the index. + \begin{center}\small + \begin{tabular}{p{0.51\textwidth}@{\ \ }l} + \multicolumn{2}{l}{\textbf{First use:}}\\ + scholarly:\dotfill \cmd{\OScipio} & \OScipio\\ + popular:\dotfill \cmd{\Scipio} & \ForgetThis\Scipio\\[2ex] + + \multicolumn{2}{l}{\textbf{Subsequent use:}}\\ + scholarly:\dotfill \cmd{\OScipio} & \OScipio\\ + scholarly:\dotfill \cmd{\SkipGenstrue}\cmd{\OScipio} & \SkipGenstrue\OScipio\\ + popular:\dotfill \cmd{\Scipio} & \SkipGenstrue\Scipio\\[2ex] + + \multicolumn{2}{l}{\textbf{Subsequent use, full, no \textit{agnomen}:}}\\ + scholarly:\dotfill \cmd{\SkipAgnomentrue}\cmd{\LOScipio} & \SkipAgnomentrue\LOScipio\\ + popular:\dotfill \cmd{\SkipAgnomentrue}\cmd{\LScipio} & \SkipAgnomentrue\LScipio\\[2ex] + + \multicolumn{2}{l}{\textbf{Subsequent use, shortest forms:}}\\ + scholarly:\dotfill \cmd{\SkipAgnomentrue}\cmd{\OScipio} & \SkipAgnomentrue\OScipio\\ + \hfill\cmd{\SkipGenstrue}\cmd{\SkipAgnomentrue}\cmd{\OScipio} & \SkipGenstrue\SkipAgnomentrue\OScipio\\ + popular:\dotfill \cmd{\SkipAgnomentrue}\cmd{\Scipio\ } & \SkipAgnomentrue\Scipio\\[2ex] + + \multicolumn{2}{l}{\textbf{Subsequent use, personal name:}}\\ + scholarly:\dotfill \cmd{\SOScipio} & \SOScipio\\ + popular:\dotfill \cmd{\SScipio} & \SScipio\\ + popular:\dotfill \cmd{\SkipGenstrue}\cmd{\SScipio} & \SkipGenstrue\SScipio + \end{tabular} + \end{center} + \endgroup +\newpage + +\section{Inflected Name Forms} + +\begingroup +Below we use alternate formatting, sort index entries, and set up a cross-reference, then redefine the hook macros locally. +\AltFormatActive + \renewcommand*\NamesFormat[1]{\ifGenitive\DoGentrue\fi#1\global\Genitivefalse} + \renewcommand*\MainNameHook[1]{\ifGenitive\DoGentrue\fi\AltOff#1\global\Genitivefalse} + \begin{quote}\small + \StartNum + \begin{verbatim} +\begin{nameauth} + \< Jeff & Thomas & \noexpand\JEFF & > +\end{nameauth} +\PretagName[Thomas]{\noexpand\JEFF}{Jefferson, Thomas} +\TagName[Thomas]{\noexpand\JEFF}{, president} +\renewcommand*\NamesFormat[1] + {\ifGenitive\DoGentrue\fi#1\global\Genitivefalse} +\renewcommand*\MainNameHook[1] + {\ifGenitive\DoGentrue\fi\AltOff#1\global\Genitivefalse} + +Consider \Genitivetrue\Jeff\ legacy. More on \Jeff\ later. +\Genitivetrue\Jeff\ reputation has declined in recent decades. +\end{verbatim} + + \smallskip + Consider \Genitivetrue\Jeff\ legacy. More on \Jeff\ later. + \Genitivetrue\Jeff\ reputation has declined in recent decades. + \end{quote} +\AltFormatInactive +\endgroup +\newpage + +\section{Example Reference Work} + +Below we use alternate formatting, sort index entries, set up a cross-reference, and define a reference article macro: + +\AltFormatActive +\PretagName[Greta]{\textSC{Garbo}}{Garbo, Greta} +\PretagName{\textSC{Misora}, Hibari}{Misora Hibari} +\PretagName[Heinz]{\textSC{Rühmann}}{Ruehmann, Heinz} +\PretagName[Heinrich Wilhelm]{\textSC{Rühmann}}% + {Ruehmann, Heinrich Wilhelm} +\IndexRef[Heinrich Wilhelm]{\textSC{Rühmann}}% + {\textSC{Rühmann}, Heinz}% +\newcommand{\RefArticle}[3]{% + \def\check{#2}% + \ifx\check\empty + \noindent\ForgetThis#1\ #3 + \else + \noindent\ForgetThis#1\ #2\ #3 + \fi +} +\begin{quote}\small +\StartNum +\begin{verbatim} +\AltFormatActive +\PretagName[Greta]{\textSC{Garbo}}{Garbo, Greta} +\PretagName{\textSC{Misora}, Hibari}{Misora Hibari} +\PretagName[Heinz]{\textSC{Rühmann}}{Ruehmann, Heinz} +\PretagName[Heinrich Wilhelm]{\textSC{Rühmann}}% + {Ruehmann, Heinrich Wilhelm} +\IndexRef[Heinrich Wilhelm]{\textSC{Rühmann}}% + {\textSC{Rühmann}, Heinz}% +\newcommand{\RefArticle}[3]{% + \def\check{#2}% + \ifx\check\empty + \noindent\ForgetThis#1\ #3 + \else + \noindent\ForgetThis#1\ #2\ #3 + \fi +} +\end{verbatim} +\end{quote} + +\cmd{\RefArticle} prints only the first and third arguments if the second is empty, else it prints all three. We determine what those arguments mean by including specific naming macros. That includes using \cmd{\RevComma} for Western names, but not for Eastern ones. + +\begin{quote}\small +\ContinueNum +\begin{verbatim} +\RefArticle + {\RevComma\Name[Greta]{\textSC{Garbo}}} + {} + {(18 September 1905\,--\,15 April 1990) was a Swedish + film actress during the 1920s and 1930s.} + +\RefArticle + {\Name{\textSC{Misora}, Hibari}} + {} + {(W: ``\RevName\Name*{\textSC{Misora}, Hibari}''; + 29 May 1937\,--\,24 June 1989) was a Japanese singer + and actress noted for her positive message.} + +\RefArticle + {\RevComma\Name[Heinrich Wilhelm]{\textSC{Rühmann}}} + {``\SubvertThis\ForceName\FName[Heinz]{\textSC{Rühmann}}''} + {(7 March 1902\,--\,3 October 1994) was a German actor + in over 100 films.} +\AltFormatInactive +\end{verbatim} +\end{quote} + +\begin{quote}\small +\RefArticle + {\RevComma\Name[Greta]{\textSC{Garbo}}} + {} + {(18 September 1905\,--\,15 April 1990) was a Swedish + film actress during the 1920s and 1930s.} + +\RefArticle + {\Name{\textSC{Misora}, Hibari}} + {}% + {(W: ``\RevName\Name*{\textSC{Misora}, Hibari}''; + 29 May 1937\,--\,24 June 1989) was a Japanese singer + and actress noted for her positive message.} + +\RefArticle + {\RevComma\Name[Heinrich Wilhelm]{\textSC{Rühmann}}} + {``\SubvertThis\ForceName\FName[Heinz]{\textSC{Rühmann}}''} + {(7 March 1902\,--\,3 October 1994) was a German actor + in over 100 films.} +\end{quote} + +\AltFormatInactive +\newpage + +\section{Beamer MWE} +One must use the macros that control and detect names, otherwise name forms will change as one advances the slides: +\begin{quote}\small +\StartNum +\begin{verbatim} +\documentclass{beamer} +\usepackage{nameauth} +\mode<presentation> +\beamerdefaultoverlayspecification{<+->} + +\begin{document} + +\begin{frame}{Move Text Without Retyping Names} + \begin{itemize}\footnotesize + \item<1-> Original\ForgetName[George]{Washington}% + \ForgetName[George]{Washington's}\\ + This version of \Name[Ulysses S.]{Grant} changes. + \begin{enumerate} + \item<2-> \IfMainName[George]{Washington's}{He}% + {\Name[George]{Washington}} + became the first president + of the United States. + \item<3-> \IfMainName[George]{Washington}{His}% + {\SkipIndex\Name*[George]{Washington's}} + military successes during the Seven Years War + readied him to command the army + of the Continental Congress. + \end{enumerate} + \item<1-> Reordered\ForgetName[George]{Washington}% + \ForgetName[George]{Washington's}\\ + This version of \ForgetThis\Name[Ulysses S.]{Grant} + does not change. + \begin{enumerate} + \item<3-> \IfMainName[George]{Washington}{His}% + {\SkipIndex\Name*[George]{Washington's}} + military successes during the Seven Years War + readied him to command the army + of the Continental Congress. + \item<2-> \IfMainName[George]{Washington's}{He}% + {\Name[George]{Washington}} + became the first president + of the United States. + \end{enumerate} + \end{itemize} +\end{frame} + +\end{document} +\end{verbatim} +\IndexName[George]{Washington} +\IndexName[Ulysses S.]{Grant} +\end{quote} + +The overlays, numbered progressively from one to three, begin by deleting name control sequence patterns. Uncontrolled names will change. Name conditionals ensure specific, context-dependent forms based on what name has appeared. These conditionals allow the text to be order-independent. +\newpage + +\section{Hooks: Intro} +\label{sec:Hooksi} + +Here we show that something more complex than a font switch can occur in \cmd{\NamesFormat}. Below we put the first mention of a name in boldface, along with a marginal notation if possible. +\begin{quote}\small +\StartNum +\begin{verbatim} +\let\OldFormat\NamesFormat +\renewcommand*\NamesFormat[1]{\textbf{#1}\unless\ifinner + \marginpar{\raggedleft\scriptsize #1}\fi} +\PretagName{Vlad, Ţepeş}{Vlad Tepes} % for accented names +\TagName{Vlad, II}{ Dracul} % for index information +\TagName{Vlad, III}{ Dracula} +\end{verbatim} + +\medskip Within the document after the preamble: +\let\OldFormat\NamesFormat +\renewcommand*\NamesFormat[1]{\textbf{#1}\unless\ifinner + \marginpar{\raggedleft\scriptsize #1}\fi} +\ContinueNum +\begin{verbatim}\Name{Vlad, III}[III Dracula], known as +\AKA{Vlad III}{Vlad, Ţepeş} (the Impaler) +after his death, was the son of \Name{Vlad, II}[II Dracul], +a member of the Order of the Dragon. Later references to +``\Name*{Vlad, III}'' and ``\Name{Vlad, III}'' appear thus. +\end{verbatim} + +\Name{Vlad, III}[III Dracula], known as +\AKA{Vlad III}{Vlad, Ţepeş} (the Impaler) +after his death, was the son of \Name{Vlad, II}[II Dracul], +a member of the Order of the Dragon. Later references to +``\Name*{Vlad, III}'' and ``\Name{Vlad, III}'' appear thus. + +\let\NamesFormat\OldFormat +\begin{verbatim}\let\NamesFormat\OldFormat\end{verbatim} +\end{quote} +Now we have reverted to the default \cmd{\NamesFormat} and we get: +\begin{itemize} + \item \cmd{\ForgetThis}\cmd{\Name\{Vlad, III\}[III Dracula]}\dotfill \ForgetThis\Name{Vlad, III}[III Dracula] + \item \cmd{\Name*\{Vlad, III\}}\dotfill \Name*{Vlad, III} + \item \cmd{\Name\{Vlad, III\}}\dotfill \Name{Vlad, III} +\end{itemize} +We also set up the cross-reference \cmd{\IndexRef\{Dracula\}\{Vlad III\}}\IndexRef{Dracula}{Vlad III}. +\newpage + +\section{Hooks: Life Dates} +\label{sec:Hooksii} +\begingroup +Here we add name conditionals and ``text tags'' to add information to names when desired. The example \cmd{\NamesFormat} below adds a text tag to the first occurrences of main-matter names. + +Below we use the three token registers available in \textsf{nameauth} to use the name conditional macros. In \cmd{\AKA} these token registers are copies of the \textbf{last} three arguments, corresponding to the pseudonym. We assume that we will not be using the \texttt{alwaysformat} option, meaning that we only call this hook once for a first use of \cmd{\AKA}. We also use a different formatting for the naming macros on the one hand and \cmd{\AKA} on the other: + +The first use of a name is in small caps. Text tags are in boldface with naming macros, and roman with \cmd{\AKA}. Just because we set up a cross-reference does not mean that we have to use \cmd{\AKA}. We use \cmd{\ForceName} as needed with \cmd{\AKA}. In the document preamble we set up the following: +\begin{quote}\small +\StartNum +\begin{verbatim} +\newif\ifNoTag +\makeatletter +\renewcommand*\NamesFormat[1]{\begingroup% + \protected@edef\temp{\endgroup\textsc{#1}% + \unless\ifNoTag + \if@nameauth@InName + {\bfseries\noexpand\NameQueryInfo + [\unexpanded\expandafter{\the\@nameauth@toksa}] + {\unexpanded\expandafter{\the\@nameauth@toksb}} + [\unexpanded\expandafter{\the\@nameauth@toksc}]}\fi + \if@nameauth@InAKA + {\normalfont\noexpand\NameQueryInfo + [\unexpanded\expandafter{\the\@nameauth@toksa}] + {\unexpanded\expandafter{\the\@nameauth@toksb}} + [\unexpanded\expandafter{\the\@nameauth@toksc}]}\fi + \fi}\temp\global\NoTagfalse% +} +\makeatother +\let\FrontNamesFormat\NamesFormat +\end{verbatim} +\end{quote} +\makeatletter +\renewcommand*\NamesFormat[1]{\begingroup% + \protected@edef\temp{\endgroup\textsc{#1}% + \unless\ifNoTag + \if@nameauth@InName + {\bfseries\noexpand\NameQueryInfo + [\unexpanded\expandafter{\the\@nameauth@toksa}] + {\unexpanded\expandafter{\the\@nameauth@toksb}} + [\unexpanded\expandafter{\the\@nameauth@toksc}]}\fi + \if@nameauth@InAKA + {\normalfont\noexpand\NameQueryInfo + [\unexpanded\expandafter{\the\@nameauth@toksa}] + {\unexpanded\expandafter{\the\@nameauth@toksb}} + [\unexpanded\expandafter{\the\@nameauth@toksc}]}\fi + \fi}\temp\global\NoTagfalse}% +\makeatother +\let\FrontNamesFormat\NamesFormat + +We print tags in the first use hooks unless \cmd{\NoTag} is set true. This method uses the two \(\epsilon\)-\TeX{} primitives \cmd{\noexpand} and \cmd{\unexpanded} to avoid repetition of \cmd{\expandafter}. Since \textsf{nameauth} depends on \textsf{etoolbox}, we assume \(\epsilon\)-\TeX. + +Before we can refer to any text tags, we must create them. Using the approach above, we include a leading space in the text tags. The leading space is needed only when a text tag appears.\footnote{Another way to add that space is to put it in the conditional path of the formatting hook and leave it out of the text tags entirely: \dots\texttt{\{ \}}\cmd{\noexpand}\cmd{\NameQueryInfo}\dots} +We also set up a cross-reference, which we will use regardless of whether we also use \cmd{\AKA}. The cross-reference will be created only once and skipped thereafter: +\begin{quote}\small +\ContinueNum +\begin{verbatim} +\NameAddInfo[George]{Washington}{ (1732--99)} +\NameAddInfo[Mustafa]{Kemal}{ (1881--1938)} +\NameAddInfo{Atatürk}{ (in 1934, a special surname)} +\IndexRef{Atatürk}{Kemal, Mustafa} +\end{verbatim} +\end{quote} +\NameAddInfo[George]{Washington}{ (1732--99)} +\NameAddInfo[Mustafa]{Kemal}{ (1881--1938)} +\NameAddInfo{Atatürk}{ (in 1934, a special surname)} +\IndexRef{Atatürk}{Kemal, Mustafa} +\pagebreak + +Now we begin with the first example, which, after all the setup, looks deceptively simple, but highly reusable without extra work: +\begin{quote}\small +\ContinueNum +\begin{verbatim} +\ForgetThis\Wash held office 1789--97. +No tags: \Wash.\\ +First use, dates suppressed: \NoTagtrue\ForgetThis\Wash.\\ +Subsequent use with format and dates: \ForceName\Wash. +\end{verbatim} + +\smallskip +\ForgetThis\Wash\ held office 1789--97.\\ +No tags: \Wash.\\ +First use, dates suppressed: \NoTagtrue\ForgetThis\Wash.\\ +Subsequent use with format and dates: \ForceName\Wash. +\end{quote} + +Since we already set up a cross-reference with \cmd{\IndexRef}, we can use just the the naming macros with ``Atatürk'' and get the desired formatting without any page references in the index: + +\begin{quote}\small +\ContinueNum +\begin{verbatim} +\Name[Mustafa]{Kemal} was granted the name +\Name{Atatürk}. We mention \Name[Mustafa]{Kemal} +and \Name{Atatürk} again. + +First use, no tag: +\NoTagtrue\ForgetThis\Name{Atatürk}. +\end{verbatim} + +\smallskip +\Name[Mustafa]{Kemal} was granted the name +\Name{Atatürk}. We mention \Name[Mustafa]{Kemal} +and \Name{Atatürk} again. + +First use, no tag: +\NoTagtrue\ForgetThis\Name{Atatürk}. +\end{quote} + +Since we set up distinct formatting for \cmd{\AKA} (\cmd{\normalfont} instead of boldface for text tags associated with cross-references), we now simulate the \texttt{formatAKA} package option and use \cmd{\ForceName} with \cmd{\AKA}: +\begin{quote}\small +\ContinueNum +\begin{verbatim} +\makeatletter\@nameauth@AKAFormattrue\makeatother +\ForgetThis\Name[Mustafa]{Kemal} was granted the name +\ForceName\AKA[Mustafa]{Kemal}{Atatürk}. We mention +\Name[Mustafa]{Kemal} and \AKA[Mustafa]{Kemal}{Atatürk} again. + +First use, no tag: +\NoTagtrue\ForceName\AKA[Mustafa]{Kemal}{Atatürk}. +\end{verbatim} + +\smallskip +\makeatletter\@nameauth@AKAFormattrue\makeatother +\ForgetThis\Name[Mustafa]{Kemal} was granted the name +\ForceName\AKA[Mustafa]{Kemal}{Atatürk}. We mention +\Name[Mustafa]{Kemal} and \AKA[Mustafa]{Kemal}{Atatürk} again. + +First use, no tag: +\NoTagtrue\ForceName\AKA[Mustafa]{Kemal}{Atatürk}. +\end{quote} + +We show an alternate part of this example on the next page that does not appear in the manual, but works identically to that above. +\newpage + +We change the look of the page reference just to see if it works. Since we are in a local scope, note the use of \cmd{\global}: + +\begin{quote}\small +\ContinueNum +\begin{verbatim} +\global\def\fett#1{\textbf{\sffamily #1}} +\TagName[Mustafa]{Kemal}{|fett} +\end{verbatim} +\end{quote} +\global\def\fett#1{\textbf{\sffamily #1}} +\TagName[Mustafa]{Kemal}{|fett} + +This version does not use $\epsilon$-\TeX primitives. We ``forget'' names as needed and replay the text on the previous page with the new version: + +\makeatletter +\renewcommand*\NamesFormat[1]{% + \let\ex\expandafter% + \textsc{#1}% + \if@nameauth@InName + \ifNoTag + \else + \bfseries% + \ex\ex\ex\ex\ex\ex\ex\NameQueryInfo\ex\ex\ex\ex\ex\ex\ex[% + \ex\ex\ex\the\ex\ex\ex\@nameauth@toksa\ex\ex\ex]% + \ex\ex\ex{\ex\the\ex\@nameauth@toksb\ex}% + \ex[\the\@nameauth@toksc]% + \fi\fi + \if@nameauth@InAKA + \ifNoTag + \else + \normalfont% + \ex\ex\ex\ex\ex\ex\ex\NameQueryInfo\ex\ex\ex\ex\ex\ex\ex[% + \ex\ex\ex\the\ex\ex\ex\@nameauth@toksa\ex\ex\ex]% + \ex\ex\ex{\ex\the\ex\@nameauth@toksb\ex}% + \ex[\the\@nameauth@toksc]% + \fi\fi + \global\NoTagfalse} +\makeatother +\begin{quote}\small +\ContinueNum +\begin{verbatim} +\newif\ifNoTag +\makeatletter +\renewcommand*\NamesFormat[1]{% + \let\ex\expandafter% + \textsc{#1}% + \if@nameauth@InName + \ifNoTag + \else + \bfseries% + \ex\ex\ex\ex\ex\ex\ex\NameQueryInfo\ex\ex\ex\ex\ex\ex\ex[% + \ex\ex\ex\the\ex\ex\ex\@nameauth@toksa\ex\ex\ex]% + \ex\ex\ex{\ex\the\ex\@nameauth@toksb\ex}% + \ex[\the\@nameauth@toksc]% + \fi\fi + \if@nameauth@InAKA + \ifNoTag + \else + \normalfont% + \ex\ex\ex\ex\ex\ex\ex\NameQueryInfo\ex\ex\ex\ex\ex\ex\ex[% + \ex\ex\ex\the\ex\ex\ex\@nameauth@toksa\ex\ex\ex]% + \ex\ex\ex{\ex\the\ex\@nameauth@toksb\ex}% + \ex[\the\@nameauth@toksc]% + \fi\fi + \global\NoTagfalse} +\makeatother +\end{verbatim} + +\smallskip +With \cmd{\Name}:\\ +\ForgetThis\Name[Mustafa]{Kemal} was granted the name +\ForgetThis\Name{Atatürk}. We mention \Name[Mustafa]{Kemal} +and \Name{Atatürk} again. + +First use, no tag: \NoTagtrue\ForgetThis\Name{Atatürk}.\bigskip + +With \cmd{\AKA}:\\ +\makeatletter\@nameauth@AKAFormattrue\makeatother +\ForgetThis\Name[Mustafa]{Kemal} was granted the name +\ForceName\AKA[Mustafa]{Kemal}{Atatürk}. We mention +\Name[Mustafa]{Kemal} and \AKA[Mustafa]{Kemal}{Atatürk} again. + +First use, no tag: \NoTagtrue\ForceName\AKA[Mustafa]{Kemal}{Atatürk}. +\end{quote} + +Now we end the scope. +\endgroup +\newpage + +\section{Hooks: Advanced} +\label{sec:Hooksiii} +\AltFormatActive +In this section we invoke \cmd{\AltFormatActive} and create several scopes containing respective examples. Some macros in this section normally should be defined in a document preamble. We define them locally and ensure that names do not use them when they are undefined. This is not best practices, but it makes sense for this manual's need for multiple redefinitions. + +\begin{center}\bfseries Continental Format: User-Defined\end{center} +\phantomsection +\begingroup +The user must implement this final step. We use \cmd{\AltFormatActive}, then redefine \cmd{\MainNameHook} to have small caps on by default in the index and first uses in the text, then off in subsequent uses in the text: +\begin{quote}\small +\StartNum +\begin{verbatim} +\renewcommand*\MainNameHook{\AltOff} +\let\FrontNameHook\MainNameHook +\end{verbatim} +\end{quote} +\renewcommand*\MainNameHook{\AltOff} +\let\FrontNameHook\MainNameHook + +Usually, we set up the names and any related macros in the preamble: +\begin{quote}\small +\ContinueNum +\begin{verbatim} +\begin{nameauth} + \< Adams & John & \noexpand\textSC{Adams} & > + \< SDJR & Sammy & \noexpand\textSC{Davis}, + \noexpand\textSC{Jr}. & > + \< HAR & & Harun, \noexpand\textSC% + {\noexpand\AltCaps{a}l-Rashid} & > + \< Mencius & & \noexpand\textSC{Mencius} & > +\end{nameauth} +\end{verbatim} +\end{quote} + +Likewise in the preamble, we must ensure that these names are sorted properly in the index. When sorting names, be sure to use \cmd{\noexpand} as well: +\begin{quote}\small +\ContinueNum +\begin{verbatim} +\PretagName[John]{\noexpand\textSC{Adams}}{Adams, John} +\PretagName[Sammy]% + {\noexpand\textSC{Davis}, \noexpand\textSC{Jr}.}% + {Davis, Sammy, Jr.} +\PretagName{Harun, \noexpand\textSC% + {\noexpand\AltCaps{a}l-Rashid}}{Harun al-Rashid} +\PretagName{\noexpand\textSC{Mencius}}{Mencius} +\end{verbatim} +\end{quote} + +\begin{center} +\small\noindent\begin{tabular}{llll}\toprule + First & Next & Long & Short \\\midrule + \cmd{\Adams} & \cmd{\Adams} & \cmd{\LAdams} & \cmd{\SAdams}\\ + \Adams & \Adams & \LAdams & \SAdams\\ + \rowcolor{grey}\cmd{\SDJR} & \cmd{\SDJR} & \cmd{\LSDJR} & \cmd{\SSDJR}\\ + \rowcolor{grey}\SDJR & \SDJR & \LSDJR & \SSDJR\\ + \cmd{\HAR} & \cmd{\HAR} & \cmd{\LHAR} & \cmd{\SHAR}\\ + \HAR & \HAR & \LHAR & \SHAR\\ + \rowcolor{grey}\cmd{\Mencius} & \cmd{\Mencius} & \cmd{\LMencius} & \cmd{\SMencius}\\ + \rowcolor{grey}\Mencius & \Mencius & \LMencius & \SMencius\\\bottomrule +\end{tabular} +\end{center} + +\begin{itemize}\small + \item Punctuation detection works: \ForceName\LSDJR. Also \LSDJR. Then \ForceName\SDJR. Now \SDJR. (We used \cmd{\ForceName} for formatting.) + \item \cmd{\ForceName}\cmd{\DropAffix}\cmd{\LSDJR} gives \ForceName\DropAffix\LSDJR. Just \cmd{\DropAffix}\cmd{\LSDJR} gives \DropAffix\LSDJR. + \item \cmd{\RevComma}\cmd{\LAdams} yields \RevComma\LAdams. All the reversing macros work. + \item \cmd{\ForceName}\cmd{\ForceFN}\cmd{\SHAR} produces \ForceName\ForceFN\SHAR. \cmd{\ForceFN}\cmd{\SHAR} produces \ForceFN\SHAR. If we add \cmd{\CapThis} we get \CapThis\ForceName\ForceFN\SHAR\ and \CapThis\ForceFN\SHAR. + \item One must include all the macros in the name arguments. +\end{itemize} + +\makeatletter\@nameauth@AKAFormattrue\makeatother +With the \texttt{formatAKA} option we refer to \Mencius\ as \AKA{\noexpand\textSC{Mencius}}{\noexpand\textSC{Meng}, Ke} and \AKA{\noexpand\textSC{Mencius}}{\noexpand\textSC{Meng}, Ke}: +\begin{quote}\small +\ContinueNum +\begin{verbatim} +\PretagName{\noexpand\textSC{Meng}, Ke}{Meng Ke} +\AKA{\noexpand\textSC{Mencius}}{\noexpand\textSC{Meng}, Ke} +\end{verbatim} +\end{quote} +\makeatletter\@nameauth@AKAFormatfalse\makeatother +\endgroup + +\begin{center}\bfseries Rolling Your Own: Basic\end{center} +\phantomsection +\begingroup +Here we set out on the path to custom formatting by using package features that have been implemented already. When redesigning formatting hooks, we recommend using \cmd{\AltFormatActive} or the \texttt{altformat} option to enable alternate formatting and prevent \cmd{\CapThis} from breaking custom formatting macros. + +We recommend examining the internal package flag \cmd{\@nameauth@DoAlt}, which activates alternate formatting, \cmd{\@nameauth@DoCaps}, which handles capitalization, and finally \cmd{\@nameauth@InHook}, which is true when the formatting hooks are called. If you create your own macros, they will look similar. + +Normally we define a macro for use in name arguments in the document preamble in order to ensure that it is always defined: +\begin{quote}\small +\StartNum +\begin{verbatim} +\makeatletter +\newcommand*\Fbox[1]{% + \if@nameauth@DoAlt\protect\fbox{#1}\else#1\fi +} +\makeatother +\end{verbatim} +\end{quote} +\makeatletter +\newcommand*\Fbox[1]{% + \if@nameauth@DoAlt\protect\fbox{#1}\else#1\fi +} +\makeatother + +Since \cmd{\AltCaps} is part of \textsf{nameauth}, you need not reinvent that wheel. Just use it. The final step is redefining the hooks, which can be as simple as: +\begin{quote}\small +\ContinueNum +\begin{verbatim} +\renewcommand*\MainNameHook{\AltOff} +\let\FrontNameHook\MainNameHook +\end{verbatim} +\end{quote} +\renewcommand*\MainNameHook{\AltOff} +\let\FrontNameHook\MainNameHook + +When sorting names, be sure to use \cmd{\noexpand} as shown previously: +\begin{quote}\small +\ContinueNum +\begin{verbatim} +\begin{nameauth} + \< deSmet & Pierre-Jean & + \noexpand\Fbox{\noexpand\AltCaps{d}e~Smet} & > +\end{nameauth} + +\PretagName[Pierre-Jean]% + {\noexpand\Fbox{\noexpand\AltCaps{d}e~Smet}}% + {de~Smet, Pierre-Jean} +\end{verbatim} +\end{quote} + +Now we show how the formatting hooks work in the body text. One can check the index to see that it is formatted properly and consistently. + +\begin{center}\small +\begin{tabular}{rll}\toprule + First & \cmd{\deSmet} & \deSmet\\ + \rowcolor{grey}Next & \cmd{\deSmet} & \deSmet\\ + Long & \cmd{\LdeSmet} & \LdeSmet\\ + \rowcolor{grey}Short & \cmd{\SdeSmet} & \SdeSmet\\ + & \cmd{\CapThis}\cmd{\deSmet} & \CapThis\deSmet\\ + \rowcolor{grey} & \cmd{\ForceName}\cmd{\CapThis}\cmd{\deSmet} & \ForceName\CapThis\deSmet\\\bottomrule +\end{tabular} +\end{center} + +With \cmd{\CapThis}\cmd{\deSmet}: \CapThis\deSmet. \cmd{\ForceName}\cmd{\CapThis}\cmd{\deSmet}: \ForceName\CapThis\deSmet.\medskip + +Some formatting, such as the use of \cmd{\textSC}, is fairly standard. Other formatting, such as \cmd{\Fbox} above, is ornamental and may be handled better with custom features, but those features appear only in the text. +\endgroup + +\begin{center}\bfseries Rolling Your Own: Intermediate\end{center} +\phantomsection +\begingroup +``Intermediate'' and ``advanced'' refer to the way that formatting hooks were designed before version 3.1. The user-accessible \cmd{\NameParser} builds a printed name from the internal, locally-scoped macros \cmd{\FNN}, \cmd{\SNN}, \cmd{\rootb} and \cmd{\suffb}. + +We create a hook that can ignore the output of \cmd{\@nameauth@Name}, which is the \texttt{\#1} in the hook dispatcher's code \cmd{\bgroup}\meta{Hook}\texttt{\{\#1\}}\cmd{\egroup}: +\begin{quote}\small + \cmd{\renewcommand*}\meta{FirstHook}\texttt{[1]\{\dots}\cmd{\NameParser}\texttt{\dots\}} +\end{quote} + +With the \texttt{altformat} option or \cmd{\AltFormatActive} we can design a subsequent-use hook that deactivates formatting inside of it: +\begin{quote}\small + \cmd{\renewcommand*}\meta{SubsequentHook}\texttt{[1]\{\dots}\cmd{\AltOff}\cmd{\NameParser}\texttt{\dots\}} +\end{quote} + +If we used \cmd{\AltFormatActive*}, where the formatting macros are enabled, but deactivated, then we might want a hook that activates the macros: +\begin{quote}\small + \cmd{\renewcommand*}\meta{Hook}\texttt{[1]\{\dots}\cmd{\AltOn}\cmd{\NameParser}\texttt{\dots\}} +\end{quote} + +\makeatletter +\renewcommand*\NamesFormat[1]{% + \RevertSNfalse\SpecialFNfalse\SpecialSNfalse#1% + \unless\ifinner\marginpar{% + \footnotesize\raggedleft% + \@nameauth@FullNametrue% + \@nameauth@FirstNamefalse% + \@nameauth@EastFNfalse% + \SpecialFNtrue\SpecialSNfalse% + \NameParser}% + \fi\global\RevertSNfalse} +\renewcommand*\MainNameHook[1]{% + \AltOff\SpecialFNfalse\SpecialSNtrue#1% + \unless\ifinner + \unless\ifRevertSN + \marginpar{% + \footnotesize\raggedleft% + \@nameauth@FullNamefalse% + \@nameauth@FirstNamefalse% + \@nameauth@EastFNfalse% + \SpecialFNfalse\SpecialSNfalse% + \NameParser}% + \fi + \fi\global\RevertSNfalse} +\makeatother +We begin in the document preamble by defining a series of conditionals and macros whose default expansion produces the index entry, yet whose other expansions occur only in the formatting hooks. Then we create a name that is composed only of macros, using \cmd{\noexpand} with \cmd{\WM} and \cmd{\SHK}. We use \cmd{\PretagName} to sort the names. \cmd{\Revert} is used to print a last name without a margin note. +\begin{quote}\small +\StartNum +\begin{verbatim} +\newif\ifSpecialFN +\newif\ifSpecialSN +\newif\ifRevertSN +\newcommand*\WM{\ifSpecialFN Wm.\else William\fi} +\newcommand*\SHK{\ifRevertSN \textSC{Shakespeare}\else + \ifSpecialSN \noexpand\AltCaps{t}he Bard\else + \textSC{Shakespeare}\fi\fi} +\newcommand*\Revert{\RevertSNtrue} + +\begin{nameauth} + \< Shak & \noexpand\WM & \noexpand\SHK & > +\end{nameauth} + +\PretagName[\noexpand\WM]{\noexpand\SHK}{Shakespeare, William} +\PretagName[Robert]{\textSC{Burns}}{Burns, Robert} +\end{verbatim} +\end{quote} + +Below we define the two formatting hooks that structure the ways in which these macros can expand when printed in the text. \cmd{\NamesFormat} allows only the canonical name via \cmd{\RevertSNfalse}, \cmd{\SpecialFNfalse}, and \cmd{\SpecialSNfalse}. We print the canonical name in the body text. If allowed, we print a margin paragraph with an alternate full name using \cmd{\NameParser} and two flags. Both hooks set \cmd{\RevertSNfalse} so that \cmd{\Revert} works on a per-name basis. The subsequent-use hook disables formatting with \cmd{\AltOff}, but it allows variant forms. + +\begin{quote}\small +\ContinueNum +\begin{verbatim} +\makeatletter +\renewcommand*\NamesFormat[1]{% + \RevertSNfalse\SpecialFNfalse\SpecialSNfalse#1% + \unless\ifinner\marginpar{% + \footnotesize\raggedleft% + \@nameauth@FullNametrue% + \@nameauth@FirstNamefalse% + \@nameauth@EastFNfalse% + \SpecialFNtrue\SpecialSNfalse% + \NameParser}% + \fi\global\RevertSNfalse} +\renewcommand*\MainNameHook[1]{% + \AltOff\SpecialFNfalse\SpecialSNtrue#1% + \unless\ifinner + \unless\ifRevertSN + \marginpar{% + \footnotesize\raggedleft% + \@nameauth@FullNamefalse% + \@nameauth@FirstNamefalse% + \@nameauth@EastFNfalse% + \SpecialFNfalse\SpecialSNfalse% + \NameParser}% + \fi + \fi\global\RevertSNfalse} +\makeatother +\end{verbatim} + +\smallskip +\Shak\ \cmd{\Shak} is the national poet of England in much the same way that \Name[Robert]{\textSC{Burns}} \cmd{\Name[Robert]\{}\cmd{\textSC\{Burns\}\}} is that of Scotland. With the latter's rise of influence in the 1800s, \Revert\Shak\ \cmd{\Revert}\cmd{\Shak} became known as ``\Shak'' \cmd{\Shak}. +\end{quote} +\endgroup + +\begin{center}\bfseries Rolling Your Own: Advanced\end{center} +\phantomsection +\begingroup +Here is how formatting hooks were designed before version 3.0. Updating older hooks may be helpful, but is not necessary. We do not use the internal package macros. We only use \cmd{\NameParser} in the hooks to produce output. We still recommend using \cmd{\AltFormatActive} to mitigate errors. In the preamble, three flags replace package internals.\footnote{The internal flag \texttt{\textbackslash @nameauth@DoAlt} activates formatting, \cmd{\CapThis} sets \texttt{\textbackslash @nameauth@DoCaps} true, and \texttt{\textbackslash @nameauth@InHook} is set by the hook dispatcher.} +Setting \texttt{\textbackslash Fboxtrue} is equivalent to using \cmd{\AltFormatActive}: +\begin{quote}\small +\StartNum +\begin{verbatim} +\newif\ifFbox% Replaces \@nameauth@DoAlt +\newif\ifFirstCap% Replaces \@nameauth@DoCaps +\newif\ifInHook% Replaces \@nameauth@InHook +\Fboxtrue +\end{verbatim} +\end{quote} + +\newcommand*\Fbox[1]{\ifFbox\protect\fbox{#1}\else#1\fi} +Also in the preamble, the formatting macro is like what we have seen, except it refers to \texttt{\textbackslash ifFbox}:\footnote{We define \cmd{\Fbox} locally because it has multiple definitions, but are very careful where we use names with it.} +\begin{quote}\small +\ContinueNum +\begin{verbatim} +\newcommand*\Fbox[1]{% + \ifFbox\protect\fbox{#1}\else#1\fi +} +\end{verbatim} +\end{quote} + +\renewcommand*\AltCaps[1]{% + \ifInHook + \ifFirstCap\MakeUppercase{#1}\else#1\fi + \else + #1% + \fi +} +Our new \cmd{\AltCaps} works like the built-in version, except it does not use the internal macros and flags: + \begin{quote}\small + \ContinueNum + \begin{verbatim} +\renewcommand*\AltCaps[1]{% + \ifInHook + \ifFirstCap\MakeUppercase{#1}\else#1\fi + \else + #1% + \fi +} +\end{verbatim} +\end{quote} + +\renewcommand*\CapThis{\FirstCaptrue} +\renewcommand*\NamesFormat[1] + {\InHooktrue\NameParser\global\FirstCapfalse} +\renewcommand*\MainNameHook[1] + {\Fboxfalse\InHooktrue\NameParser\global\FirstCapfalse} +\let\FrontNamesFormat\Namesformat +\let\FrontNameHook\MainNameHook +Here we redefine \cmd{\CapThis} to use our flag instead of the internal flag: +\begin{quote}\small +\ContinueNum +\begin{verbatim} +\renewcommand*\CapThis{\FirstCaptrue} +\end{verbatim} +\end{quote} + +We have to reproduce the logic and macros that the package would have provided. That means defining everything, including \cmd{\NamesFormat}, from scratch: +\begin{quote}\small +\ContinueNum +\begin{verbatim} +\renewcommand*\NamesFormat[1] + {\InHooktrue\NameParser\global\FirstCapfalse} +\end{verbatim} +\end{quote} + +Changes to \texttt{\textbackslash ifInHook} (default false) and \texttt{\textbackslash ifFbox} (default true) are local to the scope in which the hook macros are called. \texttt{\textbackslash ifFirstCap} must be set globally. Below we reproduce the logic of \cmd{\AltOff} before \cmd{\NameParser}: +\begin{quote}\small +\ContinueNum +\begin{verbatim} +\renewcommand*\MainNameHook[1] +{\Fboxfalse\InHooktrue\NameParser\global\FirstCapfalse} +\end{verbatim} +\end{quote} + +We avoid spurious index entries in the front matter by using the same hooks. +\begin{quote}\small +\ContinueNum +\begin{verbatim} +\let\FrontNamesFormat\Namesformat +\let\FrontNameHook\MainNameHook +\end{verbatim} +\end{quote} + +Because we use \cmd{\noexpand}, our ``old-style'' macros will index the following names under the same entry as the ``new-style'' macros. +\begin{center}\small +\begin{tabular}{rll}\toprule + First & \cmd{\deSmet} & \ForgetThis\deSmet\\ + \rowcolor{grey}Next & \cmd{\deSmet} & \deSmet\\ + Long & \cmd{\LdeSmet} & \LdeSmet\\ + \rowcolor{grey}Short & \cmd{\SdeSmet} & \SdeSmet\\ + & \cmd{\CapThis}\cmd{\deSmet} & \CapThis\deSmet\\ + \rowcolor{grey} & \cmd{\ForceName}\cmd{\CapThis}\cmd{\deSmet} & \ForceName\CapThis\deSmet\\\bottomrule +\end{tabular} +\end{center} + +With \cmd{\CapThis}\cmd{\deSmet}: \CapThis\deSmet. \cmd{\ForceName}\cmd{\CapThis}\cmd{\deSmet}: \ForceName\CapThis\deSmet.\medskip + +We can reuse new-style names with old-style macros, shown below in abbreviated fashion. We keep the flags \texttt{\textbackslash ifFirstCap} and \texttt{\textbackslash ifInHook}. We also keep the redefined \cmd{\AltCaps}, \cmd{\CapThis}, and \cmd{\NamesFormat}. We then add: +\Capstrue +\renewcommand*\textSC[1]{% + \ifCaps\textsc{#1}\else#1\fi +} +\renewcommand*\MainNameHook[1] +{% + \Capsfalse\InHooktrue\NameParser% + \global\FirstCapfalse% +} +\let\FrontNameHook\MainNameHook +\begin{quote}\small +\StartNum +\begin{verbatim} +\newif\ifCaps +\Capstrue +\renewcommand*\textSC[1]{% + \ifCaps\textsc{#1}\else#1\fi +} +\renewcommand*\MainNameHook[1] +{% + \Capsfalse\InHooktrue\NameParser% + \global\FirstCapfalse% +} +\let\FrontNameHook\MainNameHook +\end{verbatim} +\end{quote} + +The names below have the same declarations and index entries as they did above. They look and work the same but use different back-end macros: +\begin{center} +\small\noindent\begin{tabular}{llll}\toprule + First & Next & Long & Short \\\midrule + \ForgetThis\Adams & \Adams & \LAdams & \SAdams\\ + \rowcolor{grey}\ForgetThis\SDJR & \SDJR & \LSDJR & \SSDJR\\ + \ForgetThis\HAR & \HAR & \LHAR & \SHAR\\ + \rowcolor{grey}\ForgetThis\Mencius & \Mencius & \LMencius & \SMencius\\\bottomrule +\end{tabular} +\end{center} + +\begin{itemize}\small + \item Punctuation detection works: \ForceName\LSDJR. Also \LSDJR. Then \ForceName\SDJR. Now \SDJR. (We used \cmd{\ForceName} for formatting.) + \item \cmd{\ForceName}\cmd{\DropAffix}\cmd{\LSDJR} gives \ForceName\DropAffix\LSDJR. Just \cmd{\DropAffix}\cmd{\LSDJR} gives \DropAffix\LSDJR. + \item \cmd{\RevComma}\cmd{\LAdams} yields \RevComma\LAdams. All the reversing macros work. + \item \cmd{\ForceName}\cmd{\ForceFN}\cmd{\SHAR} produces \ForceName\ForceFN\SHAR. \cmd{\ForceFN}\cmd{\SHAR} produces \ForceFN\SHAR. If we add \cmd{\CapThis} we get \CapThis\ForceName\ForceFN\SHAR\ and \CapThis\ForceFN\SHAR. +\end{itemize} + +We now close the scope of this current example and resume normal formatting. +\endgroup +\AltFormatInactive +\newpage + +\section{Customization} + +Assuming that redefining hooks and adding control sequences is insufficient, one could redesign the core name macros partially or wholly, then hook those modifications into the \textsf{nameauth} package without needing to patch the style file itself. + +All these macros are set by default to \cmd{\@nameauth@Name}, the internal name parser. \cmd{\Name}, or an unmodified shorthand, calls \cmd{\NameauthName}. \cmd{\Name*}, or an L-shorthand, sets \cmd{\@nameauth@FullNametrue}, then calls \cmd{\NameauthLName}. \cmd{\FName}, or an S-shorthand, sets \cmd{\@nameauth@FirstNametrue}, then calls \cmd{\NameauthFName}. One should not modify \cmd{\Name} and \cmd{\FName} directly. + +We use features of \textsf{xargs}. Below we introduce formatting that is additional to, inter-operative with, yet distinct from the formatting hooks: +\begin{quote}\small +\StartNum +\begin{verbatim} +\makeatletter +\newcommandx*\MyName[3][1=\@empty, 3=\@empty]{% + \global\@nameauth@toksa\expandafter{#1}% + \global\@nameauth@toksb\expandafter{#2}% + \global\@nameauth@toksc\expandafter{#3}% + \hbox to 4em{Normal: \hfill}% + \fcolorbox{black}{gray!25!white}{\@nameauth@Name[#1]{#2}[#3]}% +} +\newcommandx*\MyLName[3][1=\@empty, 3=\@empty]{% + \global\@nameauth@toksa\expandafter{#1}% + \global\@nameauth@toksb\expandafter{#2}% + \global\@nameauth@toksc\expandafter{#3}% + \hbox to 4em{Long: \hfill}% + \fcolorbox{black}{green!25!white}{\@nameauth@Name[#1]{#2}[#3]}% +} +\newcommandx*\MyFName[3][1=\@empty, 3=\@empty]{% + \global\@nameauth@toksa\expandafter{#1}% + \global\@nameauth@toksb\expandafter{#2}% + \global\@nameauth@toksc\expandafter{#3}% + \hbox to 4em{Short: \hfill}% + \fcolorbox{black}{yellow!25!white}{\@nameauth@Name[#1]{#2}[#3]}% +} +\makeatother +\renewcommand*\NamesFormat[1] + {\hbox to 9em{\hfil\scshape#1\hfil}} +\renewcommand*\MainNameHook[1]{\hbox to 9em{\hfil#1\hfil}} +\renewcommand*\NameauthName{\MyName} +\renewcommand*\NameauthLName{\MyLName} +\renewcommand*\NameauthFName{\MyFName} +\end{verbatim} + +\makeatletter +\newcommandx*\MyName[3][1=\@empty, 3=\@empty]{% + \global\@nameauth@toksa\expandafter{#1}% + \global\@nameauth@toksb\expandafter{#2}% + \global\@nameauth@toksc\expandafter{#3}% + \hbox to 4em{Normal: \hfill}% + \fcolorbox{black}{gray!25!white}{\@nameauth@Name[#1]{#2}[#3]}% +} +\newcommandx*\MyLName[3][1=\@empty, 3=\@empty]{% + \global\@nameauth@toksa\expandafter{#1}% + \global\@nameauth@toksb\expandafter{#2}% + \global\@nameauth@toksc\expandafter{#3}% + \hbox to 4em{Long: \hfill}% + \fcolorbox{black}{green!25!white}{\@nameauth@Name[#1]{#2}[#3]}% +} +\newcommandx*\MyFName[3][1=\@empty, 3=\@empty]{% + \global\@nameauth@toksa\expandafter{#1}% + \global\@nameauth@toksb\expandafter{#2}% + \global\@nameauth@toksc\expandafter{#3}% + \hbox to 4em{Short: \hfill}% + \fcolorbox{black}{yellow!25!white}{\@nameauth@Name[#1]{#2}[#3]}% +} +\makeatother +\renewcommand*\NamesFormat[1]{\hbox to 9em{\hfil\scshape#1\hfil}} +\renewcommand*\MainNameHook[1]{\hbox to 9em{\hfil#1\hfil}} +\renewcommand*\NameauthName{\MyName}% +\renewcommand*\NameauthLName{\MyLName}% +\renewcommand*\NameauthFName{\MyFName} + +\smallskip +\cmd{\ForgetName[Adolf]\{Harnack\}}\ForgetName[Adolf]{Harnack}\\[1ex] +\begin{tabular}{@{}rl} + \cmd{\Harnack} & \Harnack\\ + \cmd{\LHarnack[Adolf von]} & \LHarnack[Adolf von]\\ + \cmd{\Harnack} & \Harnack\\ + \cmd{\SHarnack} & \SHarnack\\ +\end{tabular} +\end{quote} +\newpage + +\section{\protect\LaTeX\ Engines} + +We use \texttt{american} for the language; one should use one's own. We use Latin Modern. We could load \textsf{tikz} using \texttt{\textbackslash ifDoTikZ} to avoid crashing some \texttt{dvi} viewers in a \texttt{dvi}-only workflow. + +\begin{quote}\small +\StartNum +\begin{verbatim} +\IfFileExists{iftex.sty}{\usepackage{iftex}}{} +\unless\ifdefined\RequireTUTeX + \usepackage{ifxetex} + \usepackage{ifluatex} + \usepackage{ifpdf} +\fi + +\newif\ifDoTikZ % If dvi-only workflow +\ifxetex + \usepackage{fontspec} + \usepackage{polyglossia} + \setdefaultlanguage{american} % Use own language + \usepackage{tikz} + \DoTikZtrue % If dvi-only workflow +\else + \ifluatex + \ifpdf + \usepackage{fontspec} + \usepackage{polyglossia} + \setdefaultlanguage{american} % Use own language + \usepackage{tikz} + \DoTikZtrue % If dvi-only workflow + \else + \IfFileExists{utf8-2018.def}{} + {\usepackage[utf8]{inputenc}} + \usepackage[TS1,T1]{fontenc} + \usepackage[american]{babel} % Use own language + \usepackage{lmodern} + % Perhaps add \usepackage{tikz} + \fi + \else + \IfFileExists{utf8-2018.def}{} + {\usepackage[utf8]{inputenc}} + \usepackage[TS1,T1]{fontenc} + \usepackage[american]{babel} % Use own language + \usepackage{lmodern} + \ifpdf + \usepackage{tikz} % If dvi-only workflow + \DoTikZtrue % If dvi-only workflow + \fi + \fi +\fi +\end{verbatim} +\end{quote} +\newpage + +In the body text we can use something like the test below for: + +\begin{center}\fbox{\ifxetex doing \texttt{pdf} things\else \ifpdf doing \texttt{pdf} things\else doing \texttt{dvi} things\fi\fi}\end{center} + +\begin{quote}\small +\begin{verbatim} +\ifxetex + doing \texttt{pdf} things +\else + \ifpdf + doing \texttt{pdf} things + \else + doing \texttt{dvi} things + \fi +\fi\end{verbatim} +\end{quote} + +The following equivalent conditional statements can help a macro or just the body text to work under multiple engines: +\begin{quote}\small +\StartNum +\begin{verbatim} +\ifxetex xelatex% +\else + \ifluatex + \ifpdf lualatex (pdf)% + \else lualatex (dvi)% + \fi + \else + \ifpdf pdflatex% + \else latex (dvi)% + \fi + \fi +\fi +\end{verbatim} + +\StartNum +\begin{verbatim} +\unless\ifxetex + \unless\ifluatex + \ifpdf pdflatex% + \else latex (dvi)% + \fi + \else + \ifpdf lualatex (pdf)% + \else lualatex (dvi)% + \fi + \fi +\else xelatex% +\fi +\end{verbatim} +\end{quote} +\newpage + +\phantomsection +\addcontentsline{toc}{section}{Index of Persons} +\printindex[per] + +\renewcommand\indexname{Index of Subjects} +\phantomsection +\addcontentsline{toc}{section}{Index of Subjects} +\printindex + +\end{document} +%examplesvb +%</examples> +\endinput |