diff options
| -rw-r--r-- | Master/texmf-dist/doc/latex/nameauth/nameauth.pdf | bin | 697723 -> 742683 bytes | |||
| -rw-r--r-- | Master/texmf-dist/source/latex/nameauth/nameauth.dtx | 2118 | ||||
| -rw-r--r-- | Master/texmf-dist/source/latex/nameauth/nameauth.ins | 4 | ||||
| -rw-r--r-- | Master/texmf-dist/tex/latex/nameauth/nameauth.sty | 268 |
4 files changed, 1538 insertions, 852 deletions
diff --git a/Master/texmf-dist/doc/latex/nameauth/nameauth.pdf b/Master/texmf-dist/doc/latex/nameauth/nameauth.pdf Binary files differindex 20b2fc82631..d9e7c55494a 100644 --- a/Master/texmf-dist/doc/latex/nameauth/nameauth.pdf +++ b/Master/texmf-dist/doc/latex/nameauth/nameauth.pdf diff --git a/Master/texmf-dist/source/latex/nameauth/nameauth.dtx b/Master/texmf-dist/source/latex/nameauth/nameauth.dtx index 1f69dbeec8f..7bbff7330cf 100644 --- a/Master/texmf-dist/source/latex/nameauth/nameauth.dtx +++ b/Master/texmf-dist/source/latex/nameauth/nameauth.dtx @@ -118,7 +118,7 @@ nameauth:| Name authority mechanism for consistency in text and index \endpreamble \postamble -Copyright (C) 2015 by Charles P. Schaum <charles dot schaum at comcast dot net> +Copyright (C) 2016 by Charles P. Schaum <charles dot schaum at comcast dot net> This work may be distributed and/or modified under the conditions of the LaTeX Project Public License (LPPL), either @@ -168,12 +168,13 @@ Running "make install" installs the files in the local TeX tree. %<package>\NeedsTeXFormat{LaTeX2e}[1999/12/01] %<package>\ProvidesPackage{nameauth} %<*package> - [2015/12/01 v2.2 Name authority mechanism for consistency in text and index] + [2016/01/05 v2.3 Name authority mechanism for consistency in text and index] %</package> %<*driver> \documentclass[11pt]{ltxdoc} \usepackage[textwidth=135mm,textheight=237mm,right=25mm,nohead]{geometry} \usepackage[numbered]{hypdoc} +\usepackage{enumitem} \usepackage{\jobname} \usepackage[ngerman,american]{babel} \usepackage{makeidx} @@ -204,6 +205,7 @@ Running "make install" installs the files in the local TeX tree. \newunicodechar{ṃ}{\d m} \fi \fi +\setlist{rightmargin=\leftmargin,itemsep=0pt} \frenchspacing \DisableCrossrefs \CodelineIndex @@ -211,11 +213,12 @@ Running "make install" installs the files in the local TeX tree. \begin{nameauth} \< Wash & George & Washington & > \< Soto & Hernando & de Soto & > - \< JRock & John David & Rockefeller, II & > + \< JRII & John David & Rockefeller, II & > + \< JRIV & John David & Rockefeller, IV & > \< JayR & John David & Rockefeller, IV & Jay > \< Aris & & Aristotle & > \< Eliz & & Elizabeth, I & > - \< Atil & & Atilla, the Hun & > + \< Attil & & Attila, the Hun & > \< Dagb & & Dagobert & I > \< Konoe & Fumimaro & Konoe & > \< Yamt & & Yamamoto, Isoroku & > @@ -238,7 +241,12 @@ Running "make install" installs the files in the local TeX tree. \< JWG & Johann Wolfgang von & Goethe & > \< Harnack & Adolf & Harnack & > \< Bier & Johann & Bier\-mann & > - \< Fukuyama & & \uppercase{Fukuyama}, T. & > + \< Howell & Thurston & \textsc{Howell},\textsc{III} &> + \< Fukuyama & & \uppercase{Fukuyama}, Takeshi & > + \< KempMed & & Thomas, à~Kempis & > + \< KempW & Thomas & à~Kempis & > + \< Lewis & Clive Staples & Lewis & C.S. > + \< Jack & Clive Staples & Lewis & Jack > \end{nameauth} \TagName[George]{Washington}{, president|hyperpage} \TagName[Hernando]{de Soto}{|hyperpage} @@ -246,7 +254,7 @@ Running "make install" installs the files in the local TeX tree. \TagName[John David]{Rockefeller, IV}{|hyperpage} \TagName{Aristotle}{|hyperpage} \TagName{Elizabeth, I}{, queen|hyperpage} -\TagName{Atilla, the Hun}{|hyperpage} +\TagName{Attila, the Hun}{|hyperpage} \TagName{Dagobert}[I]{, king|hyperpage} \TagName[Fumimaro]{Konoe}{, PM\dag|hyperpage} \TagName{Yamamoto, Isoroku}{|hyperpage} @@ -276,10 +284,11 @@ Running "make install" installs the files in the local TeX tree. \TagName[J.Q.]{Public}{*|hyperpage} \TagName[James Earl]{Carter, Jr.}{, president|hyperpage} \TagName{Jean, sans Peur}{, duke|hyperpage} +\PretagName[E.\,B.]{White}{White, E. B.} \TagName[E.\,B.]{White}{|hyperpage} \TagName{Anaximander}{|hyperpage} \TagName{Arai, Akino}{|hyperpage} -\TagName{Boris, the Animal}{|hyperpage} +\TagName{Boris, the Animal}{*|hyperpage} \TagName[Rudolph]{Carnap}{|hyperpage} \TagName[Patrick]{Cousot}{|hyperpage} \TagName[Marc van]{Dongen}{|hyperpage} @@ -295,7 +304,7 @@ Running "make install" installs the files in the local TeX tree. \TagName{John, Eriugena}{|hyperpage} \TagName[Yoko]{Kanno}{\dag|hyperpage} \TagName[Martin Luther]{King, Jr.}{|hyperpage} -\TagName[J.]{Kreskin}{|hyperpage} +\TagName[The Amazing]{Kreskin}{|hyperpage} \TagName{Lao-tzu}{|hyperpage} \TagName[Uwe]{Lueck}{|hyperpage} \TagName[Dan]{Luecking}{|hyperpage} @@ -328,12 +337,20 @@ Running "make install" installs the files in the local TeX tree. \TagName[Jan]{Łukasiewicz}{|hyperpage} \PretagName{Vlad, Ţepeş}{Vlad Tepes} \TagName[Patrick]{Cousot}{|hyperpage} -\PretagName[\normalfont{Mata}]{\textsc{Hari}}{Hari, Mata}% -\TagName[\normalfont{Mata}]{\textsc{Hari}}{|hyperpage} -\PretagName[\normalfont{Thurston}]{\textsc{Howell},\textsc{III}}{Howell, Thurston 3} -\TagName[\normalfont{Thurston}]{\textsc{Howell},\textsc{III}}{*|hyperpage} -\PretagName{\uppercase{Fukuyama}, T.}{Fukuyama, T} -\TagName{\uppercase{Fukuyama}, T.}{|hyperpage} +\PretagName[Greta]{\textsc{Garbo}}{Garbo, Greta} +\TagName[Greta]{\textsc{Garbo}}{|hyperpage} +\PretagName[Thurston]{\textsc{Howell},\textsc{III}}{Howell, Thurston 3} +\TagName[Thurston]{\textsc{Howell},\textsc{III}}{*|hyperpage} +\PretagName{\uppercase{Fukuyama}, Takeshi}{Fukuyama, T} +\TagName{\uppercase{Fukuyama}, Takeshi}{|hyperpage} +\PretagName{Thomas, à~Kempis}{Thomas a Kempis} +\TagName{Thomas, à~Kempis}{|hyperpage} +\TagName[Clive Staples]{Lewis}{|hyperpage} +\PretagName[Heinz]{\textsc{Rühmann}}{Ruehmann, Heinz} +\TagName[Heinz]{\textsc{Rühmann}}{|hyperpage} +\PretagName[Heinrich Wilhelm]{\textsc{Rühmann}}{Ruehmann, Heinrich Wilhelm} +\TagName{William, I}{|hyperpage} +\TagName[Charlie]{Chaplin}{|hyperpage} \IndexActual{=} \begin{document} \DocInput{\jobname.dtx} @@ -341,7 +358,7 @@ Running "make install" installs the files in the local TeX tree. %</driver> % \fi % -% \CheckSum{2700} +% \CheckSum{2989} % % \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 @@ -378,6 +395,7 @@ Running "make install" installs the files in the local TeX tree. % \changes{v2.0}{2015/11/11}{Use dtxgen template instead of dtxtut; update docs} % \changes{v2.1}{2015/11/24}{Isolate Unicode issues} % \changes{v2.2}{2015/12/01}{Add interface hooks and docs; fix bugs} +% \changes{v2.3}{2016/01/05}{Improve docs and hooks; add features} % \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} @@ -395,55 +413,52 @@ Running "make install" installs the files in the local TeX tree. % \end{abstract} % % {\small\tableofcontents} +% \setlength{\parskip}{0.15\baselineskip plus .15\baselineskip minus .15\baselineskip} % -% This manual is designed with a text block compatible with both US letter and A4. Macro cross refs are minimized to give a relatively ``clean'' index that illustrates this package's indexing functions.\clearpage +% \noindent This manual is designed to be compatible with A4 and US letter. Macro references are minimized for a ``clean'' index, showing how \textsf{nameauth} handles indexing.\clearpage % % \section{Introduction} % % \subsection{Preliminaries} % -% Books can reference hundreds of names. It takes time and money to check them. This package helps to format and index names consistently and automatically, helping you save time and money. Features include: -% \begin{multicols}{2} -% \begin{itemize}\setlength\itemsep{0pt}\small -% \item Simultaneously format, display, and index names using fewest keystrokes. -% \item Context automatically determines the syntactic form of names. -% \item The default uses longer name forms for the first use and shorter forms thereafter. -% \item Apply typesetting formats to fit your needs without retyping names. -% \item Move text in the document without retyping names. -% \item Show name variants in the text, yet index consistent name forms. -% \item Handle some cross-cultural naming conventions. -% \item Allow for different capitalizing and other conventions. -% \item Index different people with the same name by using tags. -% \item Process names in list environments and other special environments. -% \end{itemize} -% \end{multicols} +% When publications use hundreds of names, it takes time and money to check them. This package automates much of that work. \textbf{Context determines name forms} unless otherwise modified, meaning that \textbf{you usually do not have to retype names} when editing a document. You can \textbf{implement a name authority} that allows for name variants in the text and consistent index entries. With \textsf{nameauth} you can handle some \textbf{cross-cultural naming conventions.} Additionally, you can use \textbf{index sort keys and tags} automatically after assigning them. % -% I started using \LaTeX\ and wrote this package when translating old German and Latin texts. I learned much more than I expected regarding \LaTeX\ typesetting engines, font systems, indexing programs, class and package interactions, and naming conventions. Please consider the following general notes that apply to the development and use of this package: -% -% \begin{quote}\small -% As of version 2.0 you \emph{can} put control sequences in names, but with a few caveats; see Section~\ref{sec:accents}. Also, this package is more fault-tolerant and prevents or warns about malformed input. +% This package grew from generalized needs for translating old German and Latin texts. Design principles include: +% \begin{enumerate}\small +% \item Format and vary name forms according to standard syntax in the body text, independent of the index. +% \begin{itemize}[noitemsep] +% \item Default to long name references first, then shorter ones. +% \item Use alternate names only in the body text, not the index. +% \item Perform name caps and reversing only in the body text. +% \end{itemize} +% \item Perform typographic formatting of names only in the body text. Reflect source text typography with English conventions, but only \emph{after} syntactic formatting is complete. +% \item Allow typographic formatting to be customized and permit control sequences in names (Sections~\ref{sec:accents}, \ref{sec:formatting}, and~\ref{sec:IndexSort}) to allow Continental and non-English standards. +% \item Always aim to reduce keystrokes. +% \item Accommodate the broadest set of names while minimizing keystrokes. +% \end{enumerate} % -% This manual performs something of a ``torture test'' on this package. You might want to avoid doing that. +% This manual performs something of a ``torture test'' on this package. You might want to avoid doing that if you are a beginner. % -% This package depends on \textsf{etoolbox}, \textsf{ifxetex}, \textsf{ifluatex}, \textsf{suffix}, \textsf{trimspaces}, and \textsf{xargs}. It has been tested with \texttt{latex,} \texttt{lualatex,} \texttt{pdflatex,} and \texttt{xelatex.} It will work with \texttt{makeindex} and \texttt{texindy.} This documentation was typeset with \ifxetex\texttt{xelatex}\else\ifluatex\ifpdf\texttt{lualatex} in \texttt{pdf} mode\else\texttt{lualatex} in \texttt{dvi} mode\fi\else\ifpdf\texttt{pdflatex}\else\texttt{latex}\fi\fi\fi{} and \texttt{makeindex.} +% \textsf{Nameauth} depends on \textsf{etoolbox}, \textsf{ifxetex}, \textsf{ifluatex}, \textsf{suffix}, \textsf{trimspaces}, and \textsf{xargs}. It was tested with \texttt{latex,} \texttt{lualatex,} \texttt{pdflatex,} and \texttt{xelatex,} along with \texttt{makeindex} and \texttt{texindy.} This manual was typeset with \ifxetex\texttt{xelatex}\else\ifluatex\ifpdf\texttt{lualatex} in \texttt{pdf} mode\else\texttt{lualatex} in \texttt{dvi} mode\fi\else\ifpdf\texttt{pdflatex}\else\texttt{latex}\fi\fi\fi{} using \texttt{makeindex} and \texttt{gind.ist.} % % Indexing generally conforms to the standard in Nancy C. Mulvany, \emph{Indexing Books} (Chicago: University of Chicago Press, 1994). This should be suitable for a very wide application across a number of disciplines. -% \end{quote} % -% \vfill -% Thanks to \Name[Marc van]{Dongen}, \Name[Enrico]{Gregorio}, \Name[Philipp]{Stephani},\break \Name[Heiko]{Oberdiek}, \Name[Uwe]{Lueck}, and \Name[Robert]{Schlicht} for their assistance in the early versions of this package.\\ +% Thanks to \Name[Marc van]{Dongen}, \Name[Enrico]{Gregorio}, \Name[Philipp]{Stephani},\break \Name[Heiko]{Oberdiek}, \Name[Uwe]{Lueck}, and \Name[Robert]{Schlicht} for their assistance in the early versions of this package.\vfill % -% \bgroup\setlength{\fboxsep}{5pt}\noindent\fbox{\parbox{0.97\textwidth}{\strut This documentation uses names of living and historical figures because users refer to real people in their projects. At no time do I intending any statement of bias for or against a particular person, culture, or tradition. All names mentioned herein deserve respect for the impact and legacy of their bearers.}}\egroup +% \bgroup\setlength{\fboxsep}{5pt}\noindent\fbox{\parbox{0.97\textwidth}{\small\strut This documentation uses names of living and historical figures because users refer to real people. At no time do I intend any disrespect or statement of bias regarding any particular person, culture, or tradition. All names are used only for teaching purposes.}}\egroup %\clearpage % % \subsection{What's In A Name?} % \label{sec:NameTypes} % -% Personal name forms are ambiguous apart from historical and cultural contexts. The \textsf{nameauth} package helps you encode names in a way that anticipates and responds automatically to such contexts without the need to retype names. +% Name forms are ambiguous apart from historical and cultural contexts. The \textsf{nameauth} package helps you encode names from as many contexts as possible. +% +% In this manual we refer to three classes of names. A ``surnames'' argument, \meta{SNN}, denotes a ``required name,'' that is, a Western surname, an Eastern family name, or an ancient/medieval name.\footnote{Some professional literature speaks of forenames and optional surnames. See Mulvany, \emph{Indexing Books}, pages 152--82, which I used as a guide along with the \emph{Chicago Manual of Style}. That approach does not work in \LaTeX, where we use optional forenames for the same effect.} +% Other naming systems can be adapted to these categories, \emph{e.g.}, Icelandic, Hungarian, etc. % -% Below we see three categories of names with suggestions regarding what might be used therein.\footnote{These suggestions are not exhaustive. For special cases, one might have to decide how to handle, for example, Hungarian and Icelandic names as Eastern or Western.} Professional writing often calls for the full form of a person's name to be used in its first occurrence, with shorter forms used thereafter. This package adapts that principle to all the forms below. +% Professional writing often calls for the full form of a person's name to be used in its first occurrence, with shorter forms used thereafter. This package adapts that principle to all the forms below. % -%\begin{enumerate} +%\begin{enumerate}[noitemsep] %\item Western name:\\[1ex] %\begin{tikzpicture}[line/.style={draw,thick}]\normalsize % \node [matrix] (macro) at (0,1) @@ -461,7 +476,7 @@ Running "make install" installs the files in the local TeX tree. % \textit{baptismal name}\\ % \textit{Christian name}\\ % \textit{first and middle}\\\quad\textit{names}\\ -% \textit{praenomen}\\ +% \textit{praenomen} % }; & % \node[align=left](a2) % { @@ -473,7 +488,7 @@ Running "make install" installs the files in the local TeX tree. % \textit{place of origin}\\ % \textit{territory}\\ % \textit{nomen/cognomen}\\ -% \textit{patronym}\\ +% \textit{patronym} % }; & % \node[align=left](a3) % { @@ -483,7 +498,7 @@ Running "make install" installs the files in the local TeX tree. % \textit{notable attribute}\\ % \textit{place of origin}\\ % \textit{territory}\\ -% \textit{agnomen}\\ +% \textit{agnomen} % }; \\ % }; % \begin{scope}[every path/.style=line] @@ -505,11 +520,11 @@ Running "make install" installs the files in the local TeX tree. % { % \node[align=left](a1) % { -% Family\\ designator\\ +% Family\\ designator % }; & % \node[align=left](a2) % { -% (Multiple names are rare, but multi-\\character names do exist.)\\ +% (Multiple names are rare, but multi-\\character names do exist.) % };\\ % }; % \begin{scope}[every path/.style=line] @@ -530,7 +545,7 @@ Running "make install" installs the files in the local TeX tree. % { % \node[align=left](a1) % { -% Personal\\ name\\ +% Personal\\ name % }; & % \node[align=left](a2) % { @@ -539,7 +554,7 @@ Running "make install" installs the files in the local TeX tree. % \textit{notable feature}\\ % \textit{notable attribute}\\ % \textit{place of origin}\\ -% \textit{territory}\\ +% \textit{territory} % }; \\ % }; % \begin{scope}[every path/.style=line] @@ -557,276 +572,329 @@ Running "make install" installs the files in the local TeX tree. % % |\usepackage[|\meta{$option_1$}|,|\meta{$option_2$}|,|\dots|]{nameauth}|\medskip % -% \noindent Package options address the following: -% \begin{enumerate}\small\setlength{\itemsep}{0pt} -% \item The way name data are entered -% \item Semantic display of names (full/short, commas/none, reversed/caps) -% \item Typographic display of names (formatted or not) -% \item Indexing and sorting of names in the index +% \noindent From the user's perspective these options proceed from the most general to more specific details. Package options address the following: +% \begin{enumerate} +% \item Enable or disable features (formatting, indexing, index sorting) +% \item Affect the syntax of names (commas, capitalization, and reversing) +% \item Typographic display of names (formatted or not, and how) % \end{enumerate} -% {\hfill\bfseries Default options are in boldface.\hfill}\bigskip -% -%\noindent{\large\bfseries Show/Hide Affix Commas}\\[2ex] -% \begin{tabular}{p{0.22\textwidth}p{0.6\textwidth}} -% \quad\bfseries\texttt{nocomma} & \bfseries Suppress commas between surnames and affixes, following the \emph{Chicago Manual of Style} and other conventions.\\[1ex] -% \quad\texttt{comma} & Retain commas between surnames and affixes.\\[2ex] -% \end{tabular}\\ -% This option is set at load time. If you use \emph{modern standards} or Eastern names, choose the default |nocomma| option to get, \emph{e.g.}, \Name[James Earl]{Carter, Jr.}. +% {\hrulefill\bfseries Default options are in boldface.\hrulefill} % -% If you need to adopt \emph{older standards} that use commas between surnames and affixes, you have two choices: -% \begin{itemize}\small\setlength{\itemsep}{0pt} -% \item First, the |comma| option produces, \emph{e.g.}, \ForgetName[James Earl]{Carter, Jr.}\ShowComma\Name[James Earl]{Carter, Jr.}. Yet it limits the use of macros like \cmd{\AKA} and \cmd{\PName}.\footnote{Before version 0.9 the \textsf{nameauth} package assumed the |comma| option.} -% \item Second, Section~\ref{sec:Affix} shows how one can use \cmd{\ShowComma} with the |nocomma| option to get similar results, but with more flexibility. -% \end{itemize} +% \begin{center}\Large\bfseries Enable/Disable Features\end{center} % % \noindent{\large\bfseries Enable/Disable Formatting}\\[2ex] % \begin{tabular}{p{0.22\textwidth}p{0.6\textwidth}} % \quad\bfseries\texttt{mainmatter} & \bfseries Enable typographic formatting attributes (see formatting options below), starting at the beginning of a document.\\[1ex] % \quad\texttt{frontmatter} & Disable typographic formatting, but retain automatic full and short forms.\\[2ex] % \end{tabular}\\ -% The default starts formatting names immediately. Use the |frontmatter| option to suppress name formatting until you want it to start via \cmd{\NamesActive}. These options have no additional effects on the index. See Section~\ref{sec:SectionFormat}.\bigskip +% The default |mainmatter| option starts formatting names immediately. Use the |frontmatter| option to suppress name formatting until you want it to start via \cmd{\NamesActive}. These options have no additional effects on the index, but they implement two completely separate systems of first/subsequent names. These systems manage names in separate contexts. See Section~\ref{sec:DisableFormat}.\bigskip % % \noindent{\large\bfseries Enable/Disable Indexing}\\[2ex] % \begin{tabular}{p{0.22\textwidth}p{0.6\textwidth}} % \quad\bfseries\texttt{index} & \bfseries Create index entries in place with names.\\[1ex] % \quad\texttt{noindex} & Suppress indexing of names.\\[2ex] % \end{tabular}\\ -% The default starts indexing names right away. The |noindex| option disables the indexing of names until \cmd{\IndexActive} enables it. This applies only to naming and indexing macros in the \textsf{nameauth} package. See Section~\ref{sec:SectionIndex}.\clearpage +% The default |index| option enables name indexing right away. The |noindex| option disables the indexing of names until \cmd{\IndexActive} enables it. That can affect the use of index tags. This applies only to naming and indexing macros in the \textsf{nameauth} package. See Section~\ref{sec:SectionIndex}.\bigskip % % \noindent{\large\bfseries Enable/Disable Index Sorting}\\[2ex] % \begin{tabular}{p{0.22\textwidth}p{0.6\textwidth}} % \quad\bfseries\texttt{pretag} & \bfseries Create sort keys used with \texttt{makeindex}.\\[1ex] % \quad\texttt{nopretag} & Do not create sort keys. \\[2ex] % \end{tabular}\\ -% The default allows \cmd{\PretagName} to create sort keys used in \texttt{makeindex} / \texttt{texindy}. Seldom would one change this option. See Section~\ref{sec:IndexSort}.\bigskip +% The default allows \cmd{\PretagName} to create sort keys used in \texttt{makeindex} / \texttt{texindy}. Seldom would one change this option. See Section~\ref{sec:IndexSort}.\clearpage +% +% \begin{center}\Large\bfseries Affect the Syntax of Names\end{center} +% +%\noindent{\large\bfseries Show/Hide Affix Commas}\\[2ex] +% \begin{tabular}{p{0.22\textwidth}p{0.6\textwidth}} +% \quad\bfseries\texttt{nocomma} & \bfseries Suppress commas between surnames and affixes, following the \emph{Chicago Manual of Style} and other conventions.\\[1ex] +% \quad\texttt{comma} & Retain commas between surnames and affixes.\\[2ex] +% \end{tabular}\\ +% This option is set at load time. If you use \emph{modern standards} or Eastern names, choose the default |nocomma| option to get, \emph{e.g.}, \Name[James Earl]{Carter, Jr.}. +% +% 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 produces, \emph{e.g.}, \ForgetName[James Earl]{Carter, Jr.}\ShowComma\Name[James Earl]{Carter, Jr.}. Yet it limits the use of macros like \cmd{\AKA} and \cmd{\PName} and it prevents the use of Eastern and ancient names with the new syntax.\footnote{Before version 0.9 the \textsf{nameauth} package assumed the \texttt{comma} option by default and used the old syntax to encode names. Newer versions are backward-compatible.} +% \item Section~\ref{sec:Affix} shows how one can use \cmd{\ShowComma} with the |nocomma| option to get similar results, but with more flexibility. +% \end{enumerate}\medskip % % \noindent{\large\bfseries Capitalize Entire Surnames}\\[2ex] % \begin{tabular}{p{0.22\textwidth}p{0.6\textwidth}} % \quad\bfseries\texttt{normalcaps} & \bfseries Do not perform any special capitalization.\\[1ex] % \quad\texttt{allcaps} & Capitalize entire surnames, such as romanized Eastern names.\\[2ex] % \end{tabular}\\ -% This only affects names printed in the body text. See Section~\ref{sec:formatting} on how to get caps in both the body text and the index\,---\,easy with the simplified interface. Section~\ref{sec:Eastern} deals with capitalization on a section-level and per-name basis.\bigskip +% This only affects names printed in the body text. One of the design principles of this package keeps it consistent with English typography and syntax. Thus no syntactic or typographic changes are propagated into the index by default. +% +% Still, you can use this package with different conventions that involve both syntax and formatting. You can type in capitalized family names directly to get that effect. See also Section~\ref{sec:formatting} on how to use macros to get caps (\cmd{\uppercase}) or small caps (\cmd{\textsc}) in both the body text and the index. This becomes easy with the simplified interface. +% +% Section~\ref{sec:Eastern} deals with capitalization on a section-level and per-name basis.\bigskip % % \noindent{\large\bfseries Reverse Name Order}\\[2ex] % \begin{tabular}{p{0.22\textwidth}p{0.6\textwidth}} % \quad\bfseries\texttt{notreversed} & \bfseries Print names in the order specified by \cmd{\Name} and the other macros.\\[1ex] % \quad\texttt{allreversed} & Print name forms in ``smart'' reverse order.\\[1ex] -% \quad\texttt{allrevcomma} & Print all names in Western ``Surname, Forenames'' order.\\[2ex] +% \quad\texttt{allrevcomma} & Print all names in ``Surname, Forenames'' order, meant for Western names.\\[2ex] % \end{tabular}\\ -% See Sections~\ref{sec:Affix}, \ref{sec:Eastern}, and~\ref{sec:LastFirst} for related macros to control name reversing by section or by name. So-called ``last-comma-first'' lists of names are \emph{not} the same as the |comma| option.\bigskip +% See Section~\ref{sec:Eastern} for related macros to control name reversing by section or by name. This also affects how Eastern names will appear in the index. +% +% So-called ``last-comma-first'' lists of names via \texttt{allrevcomma} (Section~\ref{sec:LastFirst}) are \emph{not} the same as the \texttt{comma} option. They are designed for Western names.\clearpage +% +% \begin{center}\Large\bfseries Typographic Display of Names\end{center} +% +% Section~\ref{sec:formatting} explains in greater detail that typographic display is different from the syntactic formatting of names and occurs after syntactic formatting is complete. This package is designed with type hierarchies in mind. See Robert Bringhurst, \emph{The Elements of Typographic Style}, version 3.2 (Point Roberts, Washington: Hartley \& Marks, 2008), 53--60. +% +% Even though English typography was the design choice due to native access (for me) and global reach (thanks, England), a stint in Germany helped to make me aware of continental typography. Especially in recent versions, one can adapt this package for use in Continental and other typographic standards, as Section~\ref{sec:formatting} discusses. One must use sort tags, as Section~\ref{sec:IndexSort} explains. +% +% Continental standards require you to know the surname in advance and draw formatting into the syntactic elements of the surname. By default, \textsf{nameauth} uses a ``serendipitous ambiguity'' of ancient, Eastern, and suffixed name forms handled by the \meta{Surname, affix} pattern that is resolved subtly by several factors. I burden Continental users with a few more keystrokes in order to minimize keystrokes among the broadest group of users and names. +% +% If you intend to use this package for Continental publishing where the surname is formatted with small caps in the running text and the index, use the |noformat| option. Otherwise, the options below are meant generally for applications in English typography. The default is |smallcaps| because this package was developed to aid my editing and translation of older German and Latin documents into English. I do apologize for any inconvenience in design choices.\bigskip % % \noindent{\large\bfseries Formatting Attributes}\\[2ex] % \begin{tabular}{p{0.22\textwidth}p{0.6\textwidth}} -% \quad\texttt{alwaysformat} & If formatting is enabled by the |mainmatter| option or by \cmd{\NamesActive}, this option causes all names to have special typographic formatting.\\[1ex] +% \quad\texttt{alwaysformat} & If formatting is enabled by the |mainmatter| option or by \cmd{\NamesActive}, this option causes all names to have typographic formatting applied to them, whether first or subsequent uses.\\[1ex] % \quad\bfseries\texttt{smallcaps} & \bfseries Set the first use of a name in small caps.\\[1ex] % \quad\texttt{italic} & Italicize the first occurrence of a name.\\[1ex] % \quad\texttt{boldface} & Set the first use of a name in boldface.\\[1ex] % \quad\texttt{noformat} & Do not define a default format. Can be used with custom formatting.\\[2ex] % \end{tabular}\\ -% The default is |smallcaps| because this package was developed to aid the editing and translation of older German and Latin documents. Section~\ref{sec:formatting} details even more possibilities for presenting the first use of names. +% +% Section~\ref{sec:formatting} offers even more possibilities for presenting the first use of names. That includes typographic formatting that also adds names in margins.\footnote{Two books that helped my thinking about such typographic concepts include Bernhard Lohse, \emph{Luthers Theologie} (G\"ottingen: Vandenhoeck \& Ruprecht, 1995) and the five-volume series by Jaroslav J. Pelikan Jr., The Christian Tradition: A History of the Development of Doctrine (Chicago: Chicago UP, 1971--89). Each volume in the series has its own title.\\\indent\quad Given the use of small caps in the text and index in Lohse's volume, I looked at several possibilities and arrived at the current solution for Continental users. Pelikan's volumes pointed me to the idea of a typographic first use of names that could well be served by a margin paragraph. Being a history enthusiast, I implemented that design idea in this manual.} +% This allows one to implement some creative solutions for presenting names. % \clearpage % % \subsection{Quick Start Guide} % \label{sec:start} % %\subsubsection{Main Interface} -% See Section~\ref{sec:Naming} for a proper description of \cmd{\Name}. Here we see briefly how to work with the classes of names in Section~\ref{sec:NameTypes}. We abbreviate the command parameters \meta{forename(s)} with \meta{FNN} and \meta{surname(s)} with \meta{SNN}. The |nocomma| option works best with affixes, Eastern, and ancient names.\bigskip +% See Section~\ref{sec:Naming} for a proper description of \cmd{\Name}. Here we see briefly how to work with the classes of names in Section~\ref{sec:NameTypes}. We abbreviate the macro arguments \meta{forename(s)} with \meta{FNN} and \meta{surname(s)} with \meta{SNN}. Use the |nocomma| option especially when using Eastern names and ancient names.\bigskip % -%\noindent{\large\bfseries Western Names} -%\begin{quote} -%\begin{tikzpicture}[line/.style={draw,thick}] -% \node [matrix,column sep=2.5cm] (tipsi) at (1.5,2.5) -% { -% \node(opt){\small Add to force full name.}; & -% \node[text width=3.5cm,align=left](grp){\small Add only if text in brackets |[ ]| follows.}; \\ -% }; -% \node [matrix] (macro) at (1.1,1) -% { -% \node(cmd){\bfseries\cmd{\Name}}; & -% \node(star){\bfseries\texttt{*}}; & -% \node(arg1){\bfseries\bfseries\oarg{FNN}}; & -% \node(arg2){\bfseries\bfseries\marg{SNN}}; & -% \node(arg3){\bfseries\oarg{Alternate FNN}}; & -% \node(braces){\bfseries|{}|}; \\ -% }; -% \node [matrix,column sep=1em] (tipsii) at (1,-1) -% { -% \node[align=center](a1) -% { -% Forename(s)\\used in index\\(\emph{e.g.}: initials,\\legal name) -% }; & & & -% \node[align=center](a2) -% { -% Surname(s)\\Surname(s)|,| Affix -% }; & & -% \node[align=center](a3) -% { -% \meta{empty}\\Nickname(s)\\Full forenames, etc. -% }; \\ -% }; -% \begin{scope}[every path/.style=line] -% \path (opt) -- (star); -% \path (grp) -- (braces); -% \path (arg1) -- (a1); -% \path (arg2) -- (a2); -% \path (arg3) -- (a3); -% \end{scope} -%\end{tikzpicture} -%\end{quote} -% Usual forms: -% \begin{quote}\small +% \noindent{\large\bfseries Western Names} +% \begin{quote} +% \begin{tikzpicture}[line/.style={draw,thick}] +% \node [matrix,column sep=2.5cm] (tipsi) at (1.5,2.5) +% { +% \node(opt){\small Add to force full name.}; & +% \node[text width=3.5cm,align=left](grp){\small Add only if text in brackets |[ ]| follows.}; \\ +% }; +% \node [matrix] (macro) at (1.1,1) +% { +% \node(cmd){\bfseries\cmd{\Name}}; & +% \node(star){\bfseries\texttt{*}}; & +% \node(arg1){\bfseries\bfseries\oarg{FNN}}; & +% \node(arg2){\bfseries\bfseries\marg{SNN}}; & +% \node(arg3){\bfseries\oarg{Alternate names}}; & +% \node(braces){\bfseries|{}|}; \\ +% }; +% \node [matrix,column sep=1em] (tipsii) at (1,-1) +% { +% \node[align=center](a1) +% { +% Forename(s)\\used in index +% }; & & & +% \node[align=center](a2) +% { +% Surname(s)\\Surname(s)|,| affix\\``required name'' +% }; & & +% \node[align=center](a3) +% { +% \meta{empty}\\Nickname(s)\\Full forenames, etc. +% }; \\ +% }; +% \begin{scope}[every path/.style=line] +% \path (opt) -- (star); +% \path (grp) -- (braces); +% \path (arg1) -- (a1); +% \path (arg2) -- (a2); +% \path (arg3) -- (a3); +% \end{scope} +% \end{tikzpicture}\\ +% Usual forms:\\[2ex]\small % \cmd{\Name}\oarg{FNN}\marg{SNN}\hfill|\Name[George]{Washington}|\IndexName[George]{Washington}\\ -% \cmd{\Name}\oarg{FNN}\marg{SNN|,| Affix}\hfill|\Name[John David]{Rockefeller, II}|\IndexName[John David]{Rockefeller, II}\\[1ex] -% You must include the \meta{FNN} field with alternate forenames. The \meta{Alternate FNN} are swapped with the \meta{FNN}, but only in the body text:\\[1ex] -% \cmd{\Name}\oarg{FNN}\marg{SNN}\oarg{Alternate FNN}\\\hbox{}\hfill |\Name[Bob]{Hope}[Leslie Townes]|\IndexName[Bob]{Hope}\\ -% \cmd{\Name}\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate FNN}\\\hbox{}\hfill |\Name[John David]{Rockefeller, IV}[Jay]|\IndexName[John David]{Rockefeller, IV} -% \end{quote} -% The older syntax is \cmd{\Name}\marg{SNN}\oarg{Affix}. See Section~\ref{sec:obsolete} for its usage and its shortcomings. It remains for backward compatibility.\bigskip -% -%\noindent{\large\bfseries Eastern Names in the Text, Western-style Index} -%\begin{quote} -%\begin{tikzpicture}[line/.style={draw,thick}] -% \node [matrix,column sep=1.5cm] (tipsi) at (0.5,2) -% { -% \node(opt){\small Add to force full name.}; & -% \node[text width=3.5cm,align=left](grp){\small Add only if text in brackets |[ ]| follows.}; \\ -% }; -% \node [matrix] (macro) at (0,1) -% { -% \node(cmd){\bfseries\cmd{\Name}}; & -% \node(star){\bfseries\texttt{*}}; & -% \node(arg1){\bfseries\oarg{FNN}}; & -% \node(arg2){\bfseries\marg{SNN}}; & -% \node(braces){\bfseries|{}|}; \\ -% }; -% \node [matrix] (tipsii) at (0.5,0) -% { -% \node(a1) -% { -% \quad Given name -% }; & -% \node(a2) -% { -% \quad Family name -% }; \\ -% }; -% \begin{scope}[every path/.style=line] -% \path (opt) -- (star); -% \path (grp) -- (braces); -% \path (arg1) -- (a1); -% \path (arg2) -- (a2); -% \end{scope} -%\end{tikzpicture} -%\end{quote} -% Technically, these are Western name forms without affixes. The reversing macros (Section~\ref{sec:Eastern}) cause them to display in Eastern order in the body text only. The index entries are Western in fashion: \meta{SNN}, \meta{FNN}. This ``non-native'' form of Eastern names excludes all comma-delimited forms and the old syntax.\clearpage -% -%\noindent{\large\bfseries Eastern Names in the Text, Eastern-style Index} -%\begin{quote} -%\begin{tikzpicture}[line/.style={draw,thick}] -% \node [matrix,column sep=1cm] (tipsi) at (0.5,2) -% { -% \node(opt){\small Add to force full name.}; & -% \node[text width=3.5cm,align=left](grp){\small Add only if text in brackets |[ ]| follows.}; \\ -% }; -% \node [matrix] (macro) at (0,1) -% { -% \node(cmd){\bfseries\cmd{\Name}}; & -% \node(star){\bfseries\texttt{*}}; & -% \node(arg1){\bfseries\marg{SNN, FNN}}; & -% \node(braces){\bfseries|{}|}; \\ -% }; -% \node [matrix,column sep=1em] (tipsii) at (0.5,0) -% { -% \node(a1) -% { -% \quad Family name -% }; & -% \node(a2) -% { -% \quad Given name -% }; \\ -% }; -% \begin{scope}[every path/.style=line] -% \path (opt) -- (star); -% \path (grp) -- (braces); -% \path (arg1) -- (a1); -% \path (arg1) -- (a2); -% \end{scope} -%\end{tikzpicture} -%\end{quote} -% Usual form: -% \begin{quote}\small -% \cmd{\Name}\marg{SNN, FNN}\hfill|\Name{Yamamoto, Isoroku}|\IndexName{Yamamoto, Isoroku} +% \cmd{\Name}\oarg{FNN}\marg{SNN|,| affix}\hfill|\Name[John David]{Rockefeller, II}|\IndexName[John David]{Rockefeller, II}\\[2ex] +% You must include the \meta{FNN} field with alternate forenames. The \meta{Alternate names} are swapped with the \meta{FNN}, but only in the body text:\\[1ex] +% \cmd{\Name}\oarg{FNN}\marg{SNN}\oarg{Alternate names}\\\hbox{}\hfill |\Name[Bob]{Hope}[Leslie Townes]|\IndexName[Bob]{Hope}\\\hbox{}\hfill |\Name[Clive Staples]{Lewis}[C.S.]|\IndexName[Clive Staples]{Lewis}\\ +% \cmd{\Name}\oarg{FNN}\marg{SNN|,| affix}\oarg{Alternate names}\\\hbox{}\hfill |\Name[John David]{Rockefeller, IV}[Jay]|\IndexName[John David]{Rockefeller, IV}\\[2ex]\normalsize +% The older syntax is \cmd{\Name}\marg{SNN}\oarg{affix}. See Section~\ref{sec:obsolete} for its usage and its shortcomings. It remains for backward compatibility. +% \end{quote}\medskip +% +% \noindent{\large\bfseries Eastern Names in the Text, Western-style Index} +% \begin{quote} +% \begin{tikzpicture}[line/.style={draw,thick}] +% \node [matrix,column sep=1.5cm] (tipsi) at (0.5,2) +% { +% \node(opt){\small Add to force full name.}; & +% \node[text width=3.5cm,align=left](grp){\small Add only if text in brackets |[ ]| follows.}; \\ +% }; +% \node [matrix] (macro) at (0,1) +% { +% \node(cmd){\bfseries\cmd{\Name}}; & +% \node(star){\bfseries\texttt{*}}; & +% \node(arg1){\bfseries\oarg{FNN}}; & +% \node(arg2){\bfseries\marg{SNN}}; & +% \node(braces){\bfseries|{}|}; \\ +% }; +% \node [matrix] (tipsii) at (0.5,0) +% { +% \node(a1) +% { +% \quad Given name +% }; & +% \node(a2) +% { +% \quad Family name +% }; \\ +% }; +% \begin{scope}[every path/.style=line] +% \path (opt) -- (star); +% \path (grp) -- (braces); +% \path (arg1) -- (a1); +% \path (arg2) -- (a2); +% \end{scope} +% \end{tikzpicture}\\ +% Technically, these are Western name forms without affixes. The reversing macros (Section~\ref{sec:Eastern}) cause them to display in Eastern order in the body text only. The index entries are Western in fashion: \meta{SNN}, \meta{FNN}. This ``non-native'' form of Eastern names excludes both comma-delimited forms and the old syntax. % \end{quote} -% These names truly are Eastern names. They will take the form \meta{SNN FNN} in the index even if the reversing macros (Section~\ref{sec:Eastern}) put the names in Western order in the body text. We call this the ``native'' form of Eastern names. -% -% The old form of Eastern names is \cmd{\Name}\marg{SNN}\oarg{FNN}. Again, this is retained only for backward compatibility. Cf. Section~\ref{sec:obsolete}.\bigskip +% \clearpage % -%\noindent{\large\bfseries Ancient Names} -%\begin{quote} -%\begin{tikzpicture}[line/.style={draw,thick}] -% \node [matrix,column sep=1em] (tipsi) at (2,2) -% { -% \node(opt){\quad\small Add to force full name.}; & -% \node[text width=2.6cm,align=left](a1){\small Mononym\hfil\break Mononym, Affix}; & -% \node[text width=3.3cm,align=left](grp){\small Add only if text in brackets |[ ]| follows.}; \\ -% }; -% \node [matrix] (macro) at (1,1) -% { -% \node(cmd){\bfseries\cmd{\Name}}; & -% \node(star){\bfseries\texttt{*}}; & -% \node(arg1){\bfseries\marg{SNN}}; & -% \node(braces){\bfseries|{}|}; \\ -% };\\ -% \begin{scope}[every path/.style=line] -% \path (opt) -- (star); -% \path (grp) -- (braces); -% \path (arg1) -- (a1); -% \end{scope} -%\end{tikzpicture} -%\end{quote} -% Usual form: -% \begin{quote}\small +% \noindent{\large\bfseries Eastern Names in the Text, Eastern-style Index} +% \begin{quote} +% \begin{tikzpicture}[line/.style={draw,thick}] +% \node [matrix,column sep=1cm] (tipsi) at (0.5,2) +% { +% \node(opt){\small Add to force full name.}; & +% \node[text width=3.5cm,align=left](grp){\small Add only if text in brackets |[ ]| follows.}; \\ +% }; +% \node [matrix] (macro) at (0,1) +% { +% \node(cmd){\bfseries\cmd{\Name}}; & +% \node(star){\bfseries\texttt{*}}; & +% \node(arg1){\bfseries\marg{SNN, FNN}}; & +% \node(braces){\bfseries|{}|}; \\ +% }; +% \node [matrix,column sep=1em] (tipsii) at (0.5,0) +% { +% \node(a1) +% { +% \quad Family name +% }; & +% \node(a2) +% { +% \quad Given name +% }; \\ +% }; +% \begin{scope}[every path/.style=line] +% \path (opt) -- (star); +% \path (grp) -- (braces); +% \path (arg1) -- (a1); +% \path (arg1) -- (a2); +% \end{scope} +% \end{tikzpicture}\\ +% Usual form:\\[2ex]\small +% \cmd{\Name}\marg{SNN, FNN}\hfill|\Name{Yamamoto, Isoroku}|\IndexName{Yamamoto, Isoroku}\\[2ex] +% These names truly are Eastern names. They take the form \meta{SNN FNN} in the index even if the reversing macros (Section~\ref{sec:Eastern}) put the names in Western order in the body text. We call this the ``native'' Eastern form.\\[2ex]\normalsize +% The old form of Eastern names is \cmd{\Name}\marg{SNN}\oarg{FNN}. Again, this is retained only for backward compatibility. Cf. Section~\ref{sec:obsolete}. +% \end{quote}\medskip +% +% \noindent{\large\bfseries Ancient Names} +% \begin{quote} +% \begin{tikzpicture}[line/.style={draw,thick}] +% \node [matrix,column sep=1em] (tipsi) at (2,2) +% { +% \node(opt){\quad\small Add to force full name.}; & +% \node[text width=2.6cm,align=left](a1){\small Mononym\hfil\break Mononym, affix}; & +% \node[text width=3.3cm,align=left](grp){\small Add only if text in brackets |[ ]| follows.}; \\ +% }; +% \node [matrix] (macro) at (1,1) +% { +% \node(cmd){\bfseries\cmd{\Name}}; & +% \node(star){\bfseries\texttt{*}}; & +% \node(arg1){\bfseries\marg{SNN}}; & +% \node(braces){\bfseries|{}|}; \\ +% };\\ +% \begin{scope}[every path/.style=line] +% \path (opt) -- (star); +% \path (grp) -- (braces); +% \path (arg1) -- (a1); +% \end{scope} +% \end{tikzpicture} +% Usual form:\\[2ex]\small % \cmd{\Name}\marg{SNN}\hfill|\Name{Aristotle}|\IndexName{Aristotle}\\ -% \cmd{\Name}\marg{SNN, affix}\hfill|\Name{Elizabeth, I}|\IndexName{Elizabeth, I} +% \cmd{\Name}\marg{SNN, affix}\hfill|\Name{Elizabeth, I}|\IndexName{Elizabeth, I}\\ +% \hbox{}\hfill|\Name{Attila, the Hun}|\IndexName{Attila, the Hun}\\[2ex]\normalsize +% These forms are used for royalty, ancient figures, and other monomyms with or without suffixes.\footnote{Technically, the native Eastern forms and the \meta{Mononym, affix} forms are identical, although used in different contexts. You would not wish to reverse a royal name, for example.} +% The older syntax takes the form \cmd{\Name}\marg{Mononym}\oarg{affix}. Cf. Section~\ref{sec:obsolete}. % \end{quote} % -% \noindent These forms are used for royalty, ancient figures, and other monomyms.\footnote{Technically, the native Eastern forms and the \meta{Mononym, Affix} forms are identical, although used in different contexts. You would not wish to reverse a royal name, for example.} The older syntax is \cmd{\Name}\marg{Mononym}\oarg{Affix}. Cf. Section~\ref{sec:obsolete}. +% The main interface allows one to use \cmd{\Name}\meta{arguments} as a base for many other package macros. For example, all these are variants of a base pattern, where \meta{prefix macro} consist of one or more of \cmd{\CapThis,} \cmd{\CapName,} \cmd{\RevName,} \cmd{\RevComma,} \cmd{\ShowComma,} and \cmd{\KeepAffix:} +% +% \begin{center}\small +% \begin{tabular}{r@{\,}r@{}c@{\,}c@{ }l} +% \meta{prefix macro} & \cmd{\Name} & & \meta{arguments} \\ +% \meta{prefix macro} & \cmd{\Name} & |*| & \meta{arguments} \\ +% \meta{prefix macro} & \cmd{\FName} & & \meta{arguments} \\\hline +% & \cmd{\IndexName} & & \meta{arguments} \\ +% & \cmd{\ForgetName} & & \meta{arguments} \\ +% & \cmd{\SubvertName} & & \meta{arguments} \\ +% & \cmd{\PretagName} & & \meta{arguments} & \meta{sort key}\\ +% & \cmd{\TagName} & & \meta{arguments} & \meta{tag}\\ +% & \cmd{\UntagName} & & \meta{arguments} \\ +% & \cmd{\ExcludeName} & & \meta{arguments} \\ +% \end{tabular} +% \end{center} +% \clearpage % % \subsubsection{Simplefied Interface} % \label{sec:simplestart}% % % \DescribeEnv{nameauth} -% The |nameauth| environment allows one to save typing and aid consistency by using shorthands. It produces control sequences that are fully compatible with the main interface. Although not required, |nameauth| is best used in the document preamble to avoid undefined control sequences.\footnote{The |nameauth| environment uses \cmd{\ignorespaces} to mitigate the need for trailing \texttt{\%.}} +% The |nameauth| environment allows one to save typing and aid consistency by using shorthands. It replaces the use of \cmd{\Name,} \cmd{\Name*,} and \cmd{\FName,} but not the other naming macros. Thus one must remain aware of the main interface. % -% \begin{quote} +% The simplified interface produces control sequences that are fully compatible with the main interface. Although not required, |nameauth| is best used in the document preamble to avoid undefined control sequences.\footnote{The |nameauth| environment uses \cmd{\ignorespaces} to mitigate the need for trailing \texttt{\%.}} The italicized comments at right are not part of the example proper, but are there for explanation. Macro fields have uniform widths only to help compare argument types. +% +% \begin{quote}\small % |\begin{nameauth}|\\ -% | \<| \meta{cseq1} |&| \meta{arg1} |&| \meta{arg2} |&| \meta{arg3} |>|\\ -% | \<| \meta{cseq2} |&| \meta{arg1} |&| \meta{arg2} |&| \meta{arg3} |>| \dots\\ +% | \<| \meta{cseq1} |&| \meta{FNN} |&| \meta{SNN}\hphantom{\textit{affix, }} |& >|\hfill\emph{Western}\footnote{This is also the form used with ``non-native'' Eastern names using reversing macros, but leaving them in Western form in the index.}\\ +% | \<| \meta{cseq2} |&| \meta{FNN} |&| \meta{SNN, affix} |& >|\hfill\emph{Western}\\ +% | \<| \meta{cseq3} |&| \meta{FNN} |&| \meta{SNN}\hphantom{\textit{affix, }} |&| \meta{Alt. names} |>|\hfill\emph{W. nickname}\footnote{When the \meta{Alt. names} is used, \meta{FNN} never appears in the body text, but only in the index. See Section \ref{sec:Fname} to avoid possible difficulties. You could use \cmd{\AKA} to create a \emph{see} reference for the \AKA[John David]{Rockefeller, IV}[Jay]{Rockefeller} example on the next page; see Section~\ref{sec:AKA}.}\\ +% | \<| \meta{cseq4} |&| \meta{FNN} |&| \meta{SNN, affix} |&| \meta{Alt. names} |>|\hfill\emph{W. nickname}\\ +% | \<| \meta{cseq5} |&| \hphantom{\meta{FNN}} |&| \meta{SNN}\hphantom{\textit{affix, }} |& >|\hfill\emph{ancient/mono}\\ +% | \<| \meta{cseq6} |&| \hphantom{\meta{FNN}} |&| \meta{SNN, affix} |& >|\hfill\emph{royal/ancient}\\ +% | \<| \meta{cseq7} |&| \hphantom{\meta{FNN}} |&| \meta{SNN, FNN} |& >|\hfill\emph{Eastern}\footnote{``Native'' Eastern names can be reversed to use Western order in the body text, but they will always have an Eastern form in the index.}\\ +% | \<| \meta{cseq8} |&| \hphantom{\meta{FNN}} |&| \meta{SNN}\hphantom{\textit{affix, }} |&| \meta{FNN/affix} |>|\hfill\emph{old syntax}\footnote{This is the old syntax for Eastern and royal names.}\\ % |\end{nameauth}| % \end{quote} % -% Please bear in mind that |\<| in this context is a control sequence. If you forget it or just use |<| without the backslash you will get errors. Leading and trailing spaces in each |&|-delimited field are stripped, as is also the case in the main interface. There \emph{must} be four argument fields (three ampersands) per line. +% Each \meta{cseq} creates three macros. In the document text, |\|\meta{cseq} itself works like \cmd{\Name}. |\L|\meta{cseq} (think ``Long'') works like \cmd{\Name*}. |\S|\meta{cseq} (think ``Short'') works like \cmd{\FName}. Please bear in mind the following guidelines: % -% Each \meta{cseq} creates three macros. In the document text, |\|\meta{cseq} itself calls \cmd{\Name}. |\L|\meta{cseq} (think ``Long'') calls \cmd{\Name*}. |\S|\meta{cseq} (think ``Short'') calls \cmd{\FName}. In the document text, as with \cmd{\Name}, include trailing braces |{|\,|}| if text in brackets |[|\,|]| follows any of the shorthands. +% \begin{itemize}\small +% \item In this context, ``|\<|'' is an escape character and a control sequence. If you forget it or just use |<| without the backslash, you will get errors. +% \item There \emph{must} be four argument fields (three ampersands) per line. Leaving out an ampersand will cause an error. Think ``holy hand grenade of Antioch'' from \emph{Monty Python and the Holy Grail}. +% \item Leading and trailing spaces in each |&|-delimited field are stripped, as is also the case in the main interface. +% \item As in the main interface, medial spaces do not affect first-use control sequences, but they will affect name forms in the body text and index. +% \item In the document text, as with the main interface, include trailing braces |{|\,|}|, control spaces, or the like if text in brackets |[|\,|]| follows any of the shorthands, \emph{e.g.}, |\LWash{} [\emph{sic}].| +% \item The old syntax (Section~\ref{sec:obsolete}), triggered by an empty \meta{FNN} field, causes the \meta{Alt. names} field to be interpreted as either Eastern \meta{FNN} or an \meta{affix}. Due to its limitations and potential confusion, you are encouraged to avoid it unless you are using the \texttt{comma} option. +% \end{itemize} +% \clearpage % -% The following example illustrates a fairly complete set of names: +% The example below illustrates a fairly complete set of names, apart from some special cases covered elsewhere in the manual: % -% \begin{quote} +% \begin{quote}\small % |\begin{nameauth}|\\[0.2ex] % | \< Wash & George & Washington & >|\hfill\emph{Western}\\ % | \< Soto & Hernando & de Soto & >|\hfill\emph{particle}\\ -% | \< JRock & John David & Rockefeller, II & >|\hfill\emph{affix}\\ -% | \< JayR & John David & Rockefeller, IV & Jay >|\hfill\emph{nickname}\footnote{\cmd{\SJayR} always gives ``Jay.'' See Section \ref{sec:Fname} for possible difficulties when using this variation. Use \cmd{\AKA} to create a \emph{see} reference from \AKA[John David]{Rockefeller, IV}[Jay]{Rockefeller} to his full index entry: ``Rockefeller, John David, IV.'' For more on \cmd{\AKA} see Section~\ref{sec:AKA}.}\\ +% | \< JRII & John David & Rockefeller, II & >|\hfill\emph{affix}\\ +% | \< JRIV & John David & Rockefeller, IV & >|\hfill\emph{affix}\\ +% | \< JayR & John David & Rockefeller, IV & Jay >|\hfill\emph{nickname}\\ +% | \< Lewis & Clive Staples & Lewis & C.S. >|\hfill\emph{nickname}\\ +% | \< Jack & Clive Staples & Lewis & Jack >|\hfill\emph{nickname}\\ % | \< Aris & & Aristotle & >|\hfill\emph{ancient}\\ % | \< Eliz & & Elizabeth, I & >|\hfill\emph{royal}\\ -% | \< Atil & & Atilla, the Hun & >|\hfill\emph{ancient}\\ +% | \< Attil & & Attila, the Hun & >|\hfill\emph{ancient}\\ % | \< Konoe & Fumimaro & Konoe & >|\hfill\emph{Eastern/Western index}\\ % | \< Yamt & & Yamamoto, Isoroku & >|\hfill\emph{Eastern/Eastern index}\\ % |\end{nameauth}| % \end{quote} % -% The following control sequences in the body text illustrate how this environment works. Please pay attention to first and subsequent uses, as well as how the L and S versions and other control sequences modify names: +% Now we see how this works in the body text, which you can compare with the index. A dagger (\dag) indicates an Eastern name with a Western index form. % % \begin{multicols}{2}\small % \noindent\textbf{Basic Uses:}\\ @@ -839,44 +907,57 @@ Running "make install" installs the files in the local TeX tree. % \textbf{Particles:}\\ % |\Soto|\hfill \Soto \\ % |\Soto|\hfill \Soto \\ -% |\CapThis\Soto|\hfill \CapThis\Soto \\[1.1ex] +% |\CapThis\Soto|\hfill \CapThis\Soto \\[1ex] % \textbf{Affixes:}\\ -% |\JRock|\hfill \JRock \\ -% |\LJRock|\hfill \LJRock \\ -% |\JRock|\hfill \JRock \\[1.1ex] +% |\JRII|\hfill \JRII \\ +% |\LJRII|\hfill \LJRII \\ +% |\JRII|\hfill \JRII \\[1ex] % \textbf{Nicknames:} (See Section~\ref{sec:Fname})\\ -% |\JayR|\hfill \JayR \\ -% |\SJayR\ \JayR|\hfill \SJayR\ \JayR\\[1ex] +% |\JRIV|\hfill \JRIV \\ +% |\LJRIV[Jay]|\hfill \LJRIV[Jay] \\ +% |\SJRIV[Jay]|\hfill \SJRIV[Jay] \\ +% |\SJRIV[Jay] \JRIV|\hfill \SJRIV[Jay] \JRIV\\ +% |\LJayR|\hfill \LJayR \\ +% |\SJayR|\hfill \SJayR \\ +% |\SJayR\ \JayR|\hfill \SJayR\ \JayR\\ +% |\Lewis|\hfill \Lewis\\ +% |\Lewis|\hfill \Lewis\\ +% |\LJack|\hfill \LJack\\ +% |\SJack|\hfill \SJack\columnbreak\\ % \textbf{Ancient:}\\ % |\Aris|\hfill \Aris \\ -% |\Aris|\hfill \Aris \columnbreak\\ +% |\Aris|\hfill \Aris \\[3ex] % \textbf{Medieval/Royal:}\\ % |\Eliz|\hfill \Eliz \\ % |\Eliz|\hfill \Eliz \\ -% |\Atil|\hfill \Atil \\ -% |\Atil|\hfill \Atil \\[2ex] +% |\Atil|\hfill \Attil \\ +% |\Atil|\hfill \Attil \\[3ex] % \textbf{Western / Western Index:}\\ % |\Konoe|\hfill \Konoe \\ % |\LKonoe|\hfill \LKonoe \\ -% |\Konoe|\hfill \Konoe \\[2ex] +% |\Konoe|\hfill \Konoe \\[3ex] % \textbf{Eastern / Western Index:}\\ % |\CapName\RevName\LKonoe|\\\hbox{}\hfill \indent\dag\CapName\RevName\LKonoe \\ -% |\CapName\Konoe|\hfill \dag\CapName\Konoe \\[2ex] +% |\CapName\Konoe|\hfill \dag\CapName\Konoe \\[3.1ex] % \textbf{Eastern / Eastern Index:}\\ % |\CapName\Yamt|\hfill \CapName\Yamt \\ % |\CapName\LYamt|\hfill \CapName\LYamt \\ -% |\CapName\Yamt|\hfill \CapName\Yamt \\[2ex] +% |\CapName\Yamt|\hfill \CapName\Yamt \\[3.1ex] % \textbf{Western / Eastern Index:}\\ % |\RevName\LYamt|\hfill \RevName\LYamt \\ % |\Yamt|\hfill \Yamt % \end{multicols} % -% In this manual we use a dagger (\dag) to indicate all Eastern names with Western forms in the index. The user is encouraged to compare the index entries with the body text in order to understand better what the macros are doing.\clearpage +% Sections~\ref{sec:standards}, \ref{sec:accents}, and~\ref{sec:IndexSort} deal with the pitfalls of accents and capitalization, as well as why you should use \cmd{\PretagName} for any name with control sequences or extended Unicode under NFSS. This becomes very important when authors and publishers use medieval names as Western names. +% +% When tagging or pre-tagging names (Section~\ref{sec:IndexSort}), the \meta{Alternate names} field has no effect on index tags. \cmd{\JRIV} and \cmd{\JayR} need only one tag:\\[1ex] \hbox{}\qquad|\TagName[John David]{Rockefeller, IV}{|\meta{something}|}|\\[1ex] Likewise, \cmd{\Lewis} and \cmd{\Jack} need only one tag:\\[1ex]\hbox{}\qquad|\TagName[Clive Staples]{Lewis}{|\meta{something}|}|\\[1ex] Only in the \meta{Alternate names} field can one use control sequences without them affecting index sorting, unlike in the other fields. If the \meta{FNN} field is empty, then you have the situation below. % % \subsubsection{Older Syntax} % \label{sec:obsolete} % -% An ``obsolete'' syntax remains for backward compatibility with early versions of \textsf{nameauth} and with the |comma| option. Please avoid mixing the older and newer forms. The old form lacks some error checking and robustness contained in the new syntax and limits the use of several macros: +% An ``obsolete'' syntax remains for backward compatibility with early versions of \textsf{nameauth} and with the \texttt{comma} option. Please avoid mixing the older and newer forms to avoid possible confusion and error. +% +% The \texttt{comma} option causes Western names with affixes to have a comma. Yet that also causes Eastern and ancient names, or any names using a pattern like \meta{SNN, affix} or \meta{SNN, FNN} to display a comma where it should not occur. In that case the older syntax is needed. The old form lacks some error checking and robustness contained in the new syntax and limits the use of several macros, including \cmd{\AKA.} Section~\ref{sec:error} offers some cautions about the old syntax, as do many places in this manual. The form is: % % \begin{quote} % |\Name{Dagobert}[I]|\hfill\emph{royal name}\\ @@ -884,88 +965,19 @@ Running "make install" installs the files in the local TeX tree. % |\begin{nameauth}|\\[0.5ex] % | \< Dagb & & Dagobert & I >|\hfill\emph{royal name}\\ % | \< Yosh & & Yoshida & Shigeru >|\hfill\emph{Eastern name}\\ -% |\end{nameauth}| -% \end{quote} -% -% \noindent|\Dagb| gives \Dagb, while the next |\Dagb| produces \Dagb. In similar fashion as before, we see |\LDagb| \LDagb, |\CapName\Yosh| \CapName\Yosh, and |\CapName\RevName\LYosh| \CapName\RevName\LYosh. -% -% \begin{itemize} -% \item In the old syntax, |\Name{Henry}[VIII]| prints ``\Name{Henry}[VIII]'' and ``\Name{Henry}[VIII].'' If you mix |\Name{Henry}[VIII]| with the newer |\Name{Henry, VIII}| they both print \Name{Henry, VIII} and \Name{Henry, VIII} in the body text. Yet they generate different control sequences for both first/subsequent uses and index tags.\footnote{Technically you can mix the two, as I do here. This package is all about offering choices, not restricting authors. Yet you must force first and subsequent uses with \cmd{\ForgetName} and \cmd{\SubvertName}, and make common index tags, \emph{e.g.}: \cmd{\TagName}\texttt{\{Henry, VIII\}\{, king\}} and \cmd{\TagName}\texttt{\{Henry\}[VIII]\{, king\}}. That undermines the time-saving features offered by this package. Since authors have personal styles and workflows, this package tries its best to embrace the horror of inherent ambiguity in names and their usage.} -% -% \item\IndexInactive Erroneously typing |\Name[Henry]{VIII}| prints ``\Name*[Henry]{VIII}'' and ``\Name[Henry]{VIII},'' as well as producing a malformed index entry. As of version 2.0, this kind of malformed input creates no side effects for well-formed input. -% -% \item Avoid forms like |\Name[Henry]{VIII}[Tudor]| which gives ``\Name*[Henry]{VIII}[Tudor]'' and ``\Name[Henry]{VIII}[Tudor].'' Again, this classifies as malformed input. -% -% \item Also avoid |\Name{Henry, VIII}[Tudor]| unless you really want ``\Name*{Henry, VIII}[Tudor]'' and ``\Name{Henry, VIII}[Tudor]'' in the body text and ``Henry VIII'' in the index. -% -% \item One solution to incorporate the house designation adds ``Tudor'' as needed in the text to |\Name{Henry, VIII}| and uses a tag in the index: |\TagName{Henry, VIII}{ Tudor}| (see Section \ref{sec:TagName}). -% -% \item\IndexActive The older syntax will not work with some macros. From the film \emph{Men in Black III}, |\AKA{Boris}[the Animal]{Just Boris}| fails. \cmd{\PName} fails for the same reasons. See also Section~\ref{sec:AKA} +% |\end{nameauth}|\\[2ex] +% Here the \meta{FNN} fields are empty. That changes the final field from \meta{Alternate names} to \meta{affix/Eastern FNN}. % -% \item This form does work: |\Name{Boris,| |the| |Animal}| |\AKA{Boris,| |the| |Animal}{Just| |Boris}|. You get \Name{Boris, the Animal} being ``\AKA{Boris, the Animal}{Just Boris}.'' -% \end{itemize} -% \clearpage -% -% \subsubsection{Tips and Warnings} -% \label{sec:error} -% -% \begin{itemize} -% \item Keep it simple! Avoid unneeded macros and use the simplified interface. -% -% \item Check braces and brackets with naming macros to avoid errors like ``Paragraph ended\dots'' and ``Missing \meta{grouping token} inserted.'' -% -% \item For stage names, etc., try using \emph{e.g.}: |\Name[J.]{Kreskin}[The Amazing]| |(\AKA[J.]{Kreskin}[Joseph]{Kresge})|. As a result you get \Name[J.]{Kreskin}[The Amazing] (\AKA[J.]{Kreskin}[Joseph]{Kresge}). The corresponding index entry will be ``Kreskin, J.'' You must have a name in the first optional field for this to work. -% -% \item Let this package help your workflow as you need it, instead of trying to figure out all its intricacies. Special cases like ``Iron Mike'' Tyson as the nickname for \Name[Mike]{Tyson} may be handled in a number of ways. -% \begin{enumerate} -% \item Follow |``Iron Mike''| with |\IndexName[Mike]{Tyson}| and do whatever you want in the text. -% \item |\SubvertName[Mike]{Tyson}\FName[Mike]{Tyson}[Iron| |Mike]%|\\ |\Name[Mike]{Tyson}| gives ``\SubvertName[Mike]{Tyson}\FName[Mike]{Tyson}[Iron Mike] \Name[Mike]{Tyson}.'' You are responsible for typesetting the first use and you can \cmd{\let} the whole thing to a control sequence. -% \item Use |``\AKA[Mike]{Tyson}{Iron Mike}''| to create ``\AKA[Mike]{Tyson}{Iron Mike}'' in the text and a \emph{see}-type cross-reference to ``Tyson, Mike'' in the index. Be sure to have an occurrence of |\Name[Mike]{Tyson}| in the text. See also Section~\ref{sec:AKA}. -% \end{enumerate} -% -% \item Omit spaces between initials if possible; see also Bringhurst's \emph{Elements of Typographic Style}. If your publisher wants spaces between initials, use \cmd{\frenchspacing}\footnote{Although there should be no difference between \cmd{\frenchspacing} and \cmd{\nonfrenchspacing} when it comes to initials, some classes or packages may affect that.} or put thin spaces |\,| between them. Consider: -% \begin{quote} -% |\begin{nameauth}|\\ -% | \< White & E.\,B. & White & >|\\ -% |\end{nameauth}| -% \begin{nameauth} -% \< White & E.\,B. & White & > -% \end{nameauth} -% \end{quote} -% Compare the following: -% \begin{quote} -% |\White| and |\LWhite|\hfill (\White\ and \LWhite)\\ -% Normal:\hfill\frenchspacing \textsc{E. B. White} and E. B. White. +% |\Dagb| gives \Dagb, then \Dagb. In similar fashion, we see |\LDagb| \LDagb, |\CapName\Yosh| \CapName\Yosh, and |\CapName\RevName\LYosh| \CapName\RevName\LYosh. % \end{quote} % -% \item One way to spot errors is to compare index entries with names in the body text. All macros that produce output also emit meaningful warnings. \cmd{\PName} produces warnings via \cmd{\Name} and \cmd{\AKA}. +% In the old syntax, |\Name{Henry}[VIII]| prints ``\Name{Henry}[VIII]'' and ``\Name{Henry}[VIII].'' If you mix |\Name{Henry}[VIII]| with the newer |\Name{Henry, VIII}| they both print \Name{Henry, VIII} and \Name{Henry, VIII} in the body text. Yet they generate different control sequences for both first/subsequent uses and index tags.\footnote{Technically you can mix the two, as I do here. You must force first and subsequent uses with \cmd{\ForgetName} and \cmd{\SubvertName}. You must make common index tags, \emph{e.g.}: \cmd{\TagName}\texttt{\{Henry, VIII\}\{, king\}} and \cmd{\TagName}\texttt{\{Henry\}[VIII]\{, king\}}. That undermines the time-saving features offered by this package.} % -% \item Please pay greater attention to the warnings produced by \cmd{\IndexName}, \cmd{\TagName}, \cmd{\UntagName}, and \cmd{\ExcludeName}. Many other warnings are FYI. -% -% \item The |nameauth| environment only generates a warning when you overwrite a control sequence designator with a new name. -% -% \item Inserting an empty string in a required field will generate an error. -% \end{itemize}\clearpage -% -% \noindent Warnings result from: +% \IndexInactive% +% Avoid |\Name{Henry, VIII}[Tudor]| unless you want ``\Name*{Henry, VIII}[Tudor]'' and ``\Name{Henry, VIII}[Tudor]'' in the body text and ``Henry VIII Tudor'' in the index. +% \IndexActive% +% One solution adds ``Tudor'' as needed in the text after |\Name{Henry, VIII}| and uses a tag in the index: |\TagName{Henry, VIII}{ Tudor}| (see Section \ref{sec:TagName}). % -% \begin{itemize} -% \item Using a cross-reference \oarg{alternate FNN}\marg{alternate SNN}\oarg{alt. names} created by \cmd{\AKA} as a name reference in \cmd{\Name}, \cmd{\FName}, and \cmd{\PName}. They merely will print a name in the body text. -% \item Using a name reference \oarg{FNN}\marg{SNN}\oarg{Alternate names} created by \cmd{\Name}, \cmd{\FName}, and \cmd{\PName} as a cross-reference in \cmd{\AKA}. It merely will print a name in the body text. -% \item Using \cmd{\AKA} to create the same cross-reference multiple times or with a cross-reference created by \cmd{\ExcludeName}. It merely will print a name in the body text, but not the index. -% \item Using \cmd{\IndexName} to index a cross-reference made via \cmd{\AKA} or via the mechanism in \cmd{\ExcludeName} as a main entry. It will do nothing. -% \item Using \cmd{\TagName}, \cmd{\UntagName}, and \cmd{\PretagName} with cross-references. The first two will do nothing. However, \cmd{\PretagName} will ``pretag'' a cross-reference. This is the desired behavior. -% \item Using \cmd{\ExcludeName} with cross-references. It will do nothing. -% \item Using \cmd{\ExcludeName} to exclude a name that has already been used. Likewise, it will do nothing. -% \item Using \cmd{\Name}, \cmd{\FName}, \cmd{\PName}, and \cmd{\AKA} to refer to names and cross-references excluded by \cmd{\ExcludeName}. They merely will print a name in the body text. -% \item Using the |nameauth| environment to redefine shorthands, such as: -% \begin{quote} -% |\begin{nameauth}|\\ -% | \< White & E.\,B. & White & >|\\ -% | \< White & E. B. & White & >|\\ -% |\end{nameauth}| -% \end{quote} -% \end{itemize} % \clearpage % % \subsection{Naming Macros} @@ -1003,9 +1015,7 @@ Running "make install" installs the files in the local TeX tree. % % \cmd{\Name} displays and indexes names, as illustrated in Section~\ref{sec:PatRef}. It always prints the \meta{SNN} field. \cmd{\Name} prints the ``full name'' at the first occurrence, then the partial form thereafter. \cmd{\Name*} always prints the full name. % -% The \meta{Alternate names} field replaces the \meta{FNN} field in the text only if the \meta{FNN} field is not empty; see ``\Name[M.T.]{Cicero}[Marcus Tullius]'' above. One can use a nickname in some instances while keeping the indexed form constant. -% -%Thus, regarding their index entries and first/subsequent uses in \textsf{nameauth}, |\Name[M.T.]{Cicero}[Marcus Tullius]| and |\Name[M.T.]{Cicero}| are equivalent, while |\Name{Cicero}[Marcus Tullius]| and |\Name{Cicero}| are not. Generally avoid older forms like |\Name{Charles}[the Bald]|. +% The \meta{Alternate names} field replaces the \meta{FNN} field in the body text only. It does this if the \meta{FNN} field is not empty; see ``\Name[M.T.]{Cicero}[Marcus Tullius]'' above. Regarding their index entries, |\Name[M.T.]{Cicero}[Marcus Tullius]| and |\Name[M.T.]{Cicero}| are equivalent. This lets one use a nickname while keeping the indexed form constant. If the \meta{FNN} is empty, you get the old syntax for Eastern and royal names (Section~\ref{sec:obsolete}). % % \begin{quote} %|\begin{nameauth}|\\ @@ -1017,7 +1027,7 @@ Running "make install" installs the files in the local TeX tree. %\end{quote} % % \ForgetName[Albert]{Einstein}\ForgetName{Confucius}\ForgetName[M.T.]{Cicero}\ForgetName{Charles, the Bald}% -% Above we see the same setup with the simplified interface. In the body text, |\Einstein, \LEinstein, and \Einstein| produce \Einstein, \LEinstein, and \Einstein. |\CBald\ and \CBald| give \CBald\ and \CBald. The next section demonstrates that |\LCicero[Marcus Tullius]| allows for \Cicero\ to be both \LCicero[Marcus Tullius] and \LCicero. +% Here we have the equivalent with the simplified interface. |\Einstein,| |\LEinstein,| and |\Einstein| produce \Einstein, \LEinstein, and \Einstein. |\CBald| and |\CBald| give \CBald\ and \CBald. |\Confucius| yields \Confucius\ and \Confucius. |\Cicero| prints \Cicero\ and \Cicero, while |\LCicero[Marcus Tullius]| gives \LCicero[Marcus Tullius]. The next page explains why this form may be preferable in some cases for name variants when using the simplified interface. % \clearpage % % \subsubsection{Forenames: \texttt{\textbackslash FName}} @@ -1025,12 +1035,18 @@ Running "make install" installs the files in the local TeX tree. % % \DescribeMacro{\FName} % \DescribeMacro{\FName*} -% This casual friend of \cmd{\Name} prints only ``first'' names, but it will still print a full name when a first use occurs. \cmd{\FName} is intended for Western-style names. \cmd{\FName*} is only a synonym for \cmd{\FName}. The syntax is basically the same: +% \cmd{\FName} and its synonym \cmd{\FName*} print just forenames, but only in subsequent name uses.\footnote{The two macros are the same in case you edit \cmd{\Name*} by adding an |F| to get a first reference, just as you might edit \cmd{\Name} the same way to get the same result.} +% They are intended for Western-style names. The syntax is: % \begin{quote} % \cmd{\FName}\oarg{FNN}\marg{SNN}\oarg{Alternate names} % \end{quote} -% The first reference to \cmd{\FName} always is a full name. That prevents a first-name-only reference before a person has been introduced. Intentionally, \cmd{\FName} \emph{never} gives the first name with Eastern names. For examples we see below: -% \ForgetName[Albert]{Einstein}\ForgetName{Confucius}\ForgetName[M.T.]{Cicero}\ForgetName{Charles, the Bald}% +% This macro always prints full name when a name is first used. That prevents a first-name reference before a person has been introduced. To force a short name as a first reference, you could use a macro to incorporate: +% \begin{quote} +% \cmd{\SubvertName}\oarg{FNN}\marg{SNN}|%|\\ +% \cmd{\makeatletter}\cmd{\@nameauth@FirstFormattrue}\cmd{\makeatother}|%|\\ +% \cmd{\FName}\oarg{FNN}\marg{SNN} +% \end{quote} +% By design, \cmd{\FName} \emph{never} prints Eastern personal names so that ancient names also work (cf. Section~\ref{sec:PatRef}). Examples of general use include: \ForgetName[Albert]{Einstein}\ForgetName{Confucius}\ForgetName[M.T.]{Cicero}\ForgetName{Charles, the Bald}% % % \begin{quote}\small % \begin{tabular}{ll}\hline @@ -1045,9 +1061,9 @@ Running "make install" installs the files in the local TeX tree. % \end{tabular}\\ % \end{quote} % -% The \Cicero\ example shows how the \meta{Alternate names} field can work. Be careful with nicknames: |``\FName[Chesley B.]{Sullenberger, III}[Sully]''| produces ``\FName[Chesley B.]{Sullenberger, III}[Sully]'' and ``\FName[Chesley B.]{Sullenberger, III}[Sully].'' This is not a ``bug'' as such, as the \Name[M.T.]{Cicero} example illustrates. Names are very context-sensitive. +% With the simplified interface example from the previous page, |\SEinstein,| |\SConfucius,| |\SCicero,| and |\SCBald| give us \SEinstein, \SConfucius, \SCicero, and \SCBald. |\SCicero[Marcus Tullius]| gives \SCicero[Marcus Tullius]. However, with the macro |\FName[Chesley B.]{Sullenberger, III}[Sully]| we have ``\FName[Chesley B.]{Sullenberger, III}[Sully]'' and ``\FName[Chesley B.]{Sullenberger, III}[Sully].'' Please use caution! % -% With |\SEinstein,| |\SConfucius,| |\SCicero,| and |\SCBald| we get \SEinstein, \SConfucius, \SCicero, and \SCBald\ when using the simplified interface example from the previous page. |\SCicero[Marcus Tullius]| gives \SCicero[Marcus Tullius]. The simplified interface allows you to use a ``default nickname.'' In Section~\ref{sec:simplestart} |\SJayR| gives \ForgetName[John David]{Rockefeller, IV}\SJayR\ and \SJayR, but the index entry ``Rockefeller, John David, IV.'' Yet default nicknames are not always what they seem: +%\ForgetName[Clive Staples]{Lewis} This may not always be a ``bug.'' Remembering Section~\ref{sec:simplestart}, you can use \Lewis\ or ``\SJack.'' |\FName[Clive Staples]{Lewis}[C.S.]| or \cmd{\Lewis} gives the first form, while |\FName[Clive Staples]{Lewis}[Jack]| or \cmd{\Jack} gives the second. |\SJayR| gave \ForgetName[John David]{Rockefeller, IV}\SJayR\ and \SJayR, but the index entry remains ``Rockefeller, John David, IV.'' Using ``default nicknames'' in the simplified interface has some caveats: % % \begin{nameauth}% % \< Ches & Chesley B. & Sullenberger, III & >% @@ -1060,24 +1076,16 @@ Running "make install" installs the files in the local TeX tree. % |\end{nameauth}| % \end{quote} % -% \ForgetName[Chesley B.]{Sullenberger, III} The first use |\Ches| prints ``\Ches.'' Later, |\SChes| and |\SSully| print ``\SChes'' and ``\SSully.'' While |\SChes[Sully]| always gives, ``\SChes[Sully],'' |\SSully[Chesley B.]| prints ``\SSully[Chesley B.].'' -% -% |\SSully[Chesley B.]| expands to what it should be, not what you might expect it to be:\hfil |\FName[Chesley B.]{Sullenberger, III}[Sully][Chesley B.]|. Thus we prefer |\LCicero[Marcus Tullius]| and |\SCicero[Marcus Tullius]|: -% \begin{quote} -% |\begin{nameauth}|\\ -% | \< Cicero & M.T. & Cicero & >|\hfill \emph{preferred}\\ -% | \< Cicero & M.T. & Cicero & Marcus Tullius >|\hfill \emph{not preferred} -% |\end{nameauth}| -% \end{quote} +% \ForgetName[Chesley B.]{Sullenberger, III} The first use \cmd{\Ches} prints ``\Ches.'' Later, \cmd{\SChes} and \cmd{\SSully} print ``\SChes'' and ``\SSully.'' While |\SChes[Sully]| always gives ``\SChes[Sully],'' |\SSully[Chesley B.]| prints ``\SSully[Chesley B.].'' The \meta{Alternate names} field is always occupied when using \cmd{\Sully,} etc. Thus, the final |[Chesley B.]| is not a macro argument. +%\clearpage % -% This package offers preferred choices, but its design does not force you to use them because names and their uses have many variants.\clearpage % % \subsection{Affixes and Eastern Names} % % \subsubsection{Affixes Need Commas} % \label{sec:Affix} % -% Comma-delimited affixes handle several different name types. \emph{Always include a comma as an affix delimiter}, even when the |nocomma| option does not print the comma. Extra spaces and trailing commas are ignored. Other name types include royal, medieval, and Eastern names: +% Comma-delimited affixes handle several different name types. \emph{Always include a comma as an affix delimiter}, even when the |nocomma| option does not print the comma. Extra spaces between the comma and affix are ignored. Extra commas have no effect. Other name types include royal, medieval, and Eastern names: % % \begin{quote}\small\ForgetName{Sun, Yat-sen} % \begin{tabular}{ll}\hline @@ -1090,15 +1098,16 @@ Running "make install" installs the files in the local TeX tree. % \end{tabular} % \end{quote} % -% One must use comma-delimited suffixes when cross-referencing affixed Western names, royal names, some medieval names, and Eastern names with \cmd{\AKA}; see Section~\ref{sec:AKA}.\\ +% You cannot use the old syntax with the \Name[Oskar]{Hammerstein, II} example. One must use comma-delimited suffixes when cross-referencing affixed Western names, royal names, some medieval names, and Eastern names with \cmd{\AKA}; see Section~\ref{sec:AKA}.\medskip % % \DescribeMacro{\KeepAffix} -% Put \cmd{\KeepAffix} before \cmd{\Name} or \cmd{\AKA} if a line break or page break divides a \meta{SNN, affix} pair. This puts a non-breaking space between \emph{SNN} and \emph{affix} in the body text, but not in the index. Other options to fix bad breaks include using \cmd{\hbox}, kerning and spacing in the \textsf{microtype} package, etc.\\ +% Put \cmd{\KeepAffix} before \cmd{\Name} or \cmd{\AKA} if a line break or page break divides a \meta{SNN, affix} pair. This puts a non-breaking space between \meta{SNN} and \meta{affix} in the body text, but not in the index. Other options to fix bad breaks include using \cmd{\hbox}, kerning and spacing in the \textsf{microtype} package, etc.\medskip % % \DescribeMacro{\ShowComma} -% The |comma| option is restrictive and used to reproduce older texts. \cmd{\ShowComma} gets the same results on a per-name basis while using the default |nocomma| option. With |\ShowComma\Name[Louis]{Gossett, Jr.}| one gets \ShowComma\Name[Louis]{Gossett, Jr.}. One must use \cmd{\ShowComma} consistently or risk errors in the body text and index.\\ +% The \texttt{comma} option is restrictive and used to reproduce older texts. \cmd{\ShowComma} gets the same results on a per-name basis while using the default |nocomma| option. With |\ShowComma\Name[Louis]{Gossett, Jr.}| one gets \ShowComma\Name[Louis]{Gossett, Jr.}. One must use \cmd{\ShowComma} consistently or risk errors in the body text and index.\bigskip % -% Avoid using the older syntax, shown below, except with the |comma| option. It does not handle Western names with affixes and some other name types. \cmd{\AKA} and \cmd{\PName} cannot create cross-references to these forms. These older forms include: +% \noindent{\large\bfseries Compare Older Syntax}\\[2ex] +% Avoid using the older syntax, shown below, except with the \texttt{comma} option. The older syntax prevents Eastern and ancient names that use the \meta{SNN, affix} pattern from having unwanted commas in them with the \texttt{comma} option or with \cmd{\ShowComma.} \cmd{\AKA} and \cmd{\PName} cannot create cross-references to these forms. These older forms include: % % \begin{quote}\small\ForgetName{Henry}[VIII] % \begin{tabular}{ll}\hline @@ -1108,14 +1117,15 @@ Running "make install" installs the files in the local TeX tree. % {\large\strut}|\Name{Chiang}[Kai-shek]| & \Name{Chiang}[Kai-shek]\\\hline % \end{tabular} % \end{quote} -% These older forms work because no \meta{FNN} are present. Otherwise you would get weird nicknames. Again, please avoid using the older syntax.\clearpage +% These older forms work because no \meta{FNN} are present. Otherwise you would get weird nicknames. Again, to avoid potential frustration, please avoid using the older syntax unless you need it. +% \clearpage % % \subsubsection{Eastern Names} % \label{sec:Eastern} % % The \textsf{nameauth} package offers ``non-native'' and ``native'' ways to handle romanized Eastern names. \cmd{\RevName}\cmd{\Name}\oarg{Eastern FNN}\marg{Eastern SNN} will produce an Eastern name in the body text and the Western form \meta{SNN}, \meta{FNN} in the index, including the comma. We call this ``non-native'' mode. % -% In contrast, both \cmd{\Name}\marg{Eastern SNN, Eastern FNN} and the older syntax \cmd{\Name}\marg{Eastern SNN}\oarg{Eastern FNN} produce an Eastern name form in the body text: \meta{SNN} \meta{FNN} as well as in the index. This form has no comma in the index. We call this ``native'' mode. Offering these two modes gives the greatest flexibility in indexing requirements.\\ +% In contrast, both \cmd{\Name}\marg{Eastern SNN, Eastern FNN} and the older syntax \cmd{\Name}\marg{Eastern SNN}\oarg{Eastern FNN} produce an Eastern name form in the body text: \meta{SNN} \meta{FNN} as well as in the index. This form has no comma in the index. We call this ``native'' mode. Offering these two modes gives the greatest flexibility in indexing requirements.\bigskip % % \DescribeMacro{\ReverseActive} % \DescribeMacro{\ReverseInactive} @@ -1132,9 +1142,9 @@ Running "make install" installs the files in the local TeX tree. % {\large\strut}|\Name*{Arai, Akino}| & \Name*{Arai, Akino} & \RevName\Name*{Arai, Akino}\\ % {\large\strut}(|\Name*{Ishida}[Yoko]|) & (\Name*{Ishida}[Yoko]) & (\RevName\Name*{Ishida}[Yoko])\\ % {\large\strut}|\Name*{Yohko}| & \Name*{Yohko} & \RevName\Name*{Yohko}\\\hline -% \end{tabular}\\ +% \end{tabular} % \end{quote} -% \NamesActive +% \NamesActive\medskip % % \DescribeMacro{\AllCapsActive} % \DescribeMacro{\AllCapsInactive} @@ -1149,64 +1159,73 @@ Running "make install" installs the files in the local TeX tree. % {\large\strut}|\Name*{Shikata, Akiko}| & \CapName\Name*{Shikata, Akiko} & \CapName\RevName\Name*{Shikata, Akiko}\\ % {\large\strut}(|\Name*{Nogawa}[Sakura]|) & (\CapName\Name*{Nogawa}[Sakura]) & (\CapName\RevName\Name*{Nogawa}[Sakura])\\ % {\large\strut}|\Name*{Yohko}| & \CapName\Name*{Yohko} & \CapName\RevName\Name*{Yohko}\\\hline -% \end{tabular}\\ +% \end{tabular} % \end{quote} -% \NamesActive +% \NamesActive\smallskip % % Notice how capitalization is independent of formatting. The reversing and capitalization macros also work with \cmd{\AKA}. They affect only the text, not the index. For caps in the text and index see Section~\ref{sec:formatting}.\clearpage % % \subsection{Other Naming Topics} +% {\hfill\large\bfseries Language-Related Issues\hfill}\vspace{-2ex} +% \subsubsection{Particles} +% \label{sec:standards} % -% \subsubsection{Fault Tolerance} +% According to the \emph{Chicago Manual of Style}, English names with the particles \emph{de}, \emph{de\ la}, \emph{d'}, \emph{von}, \emph{van}, and \emph{ten} generally keep them with the last name, using varied capitalization. \emph{Le}, \emph{La}, and \emph{L'} always are capitalized unless preceded by \emph{de}.\medskip % -% Especially since version 2.0, the \textsf{nameauth} package tries to prevent malformed input from creating side effects. For example, the malformed |\Name[Henry]{VIII}| and the well-formed |\Name{Henry}[VIII]| used to create the same control sequence and thus affect each other. That no longer happens. Furthermore, we guard against empty required values being passed to naming macros. +% \DescribeMacro{\CapThis} +% In English, these particles go in the \meta{SNN} field of \cmd{\Name}, \emph{e.g.}, \ForgetName[Walter]{de la Mare}\Name[Walter]{de la Mare}. |\CapThis\Name[Walter]{de la Mare}| lets you capitalize \emph{de} when at the beginning of a sentence. \CapThis\Name[Walter]{de la Mare} will think it fair. \CapThis\Soto\ (using |\CapThis\Soto| from Section~\ref{sec:simplestart}) would agree. % -% To reduce errors, \cmd{\Name}, \cmd{\FName}, \cmd{\AKA}, and \cmd{\IndexName} ignore leading and trailing spaces\,---\,but not medial spaces\,---\,making the following equivalent: +% Connect one-character particles with surnames via |~| or \cmd{\nobreakspace} to avoid bad breaks and prevent \cmd{\CapThis} from eating the space between the particle and the surname. There are no issues when particles have two or more characters in them, as do those listed above.\medskip % -% \begin{quote}\small\ForgetName[Martin Luther]{King, Jr.} -% \begin{tabular}{ll} -% \textit{Macro Example} & \textit{Resulting text}\\ -% |\Name*[ Martin Luther]{King, Jr.}| & \Name*[ Martin Luther]{King, Jr.}\\ -% |\Name*[Martin Luther ]{King, Jr.}| & \Name*[Martin Luther ]{King, Jr.}\\ -% |\Name*[ Martin Luther ]{King, Jr.}| & \Name*[ Martin Luther ]{King, Jr.}\\ -% |\Name*[Martin Luther]{ King, Jr.}| & \Name*[Martin Luther]{ King, Jr.}\\ -% |\Name*[Martin Luther]{King, Jr. }| & \Name*[Martin Luther]{King, Jr. }\\ -% |\Name*[Martin Luther]{ King, Jr. }| & \Name*[Martin Luther]{ King, Jr. }\\ -% \end{tabular} +% \DescribeMacro{\AccentCapThis} +% \cmd{\CapThis} (and \cmd{\AccentCapThis}) always work and give the same desired results with \texttt{xelatex} and \texttt{lualatex}. With \texttt{pdflatex} you \emph{must} use \cmd{\AccentCapThis} when the first letter of the particle is an extended Unicode character. +% \begin{quote} +% |\PretagName{Thomas, à~Kempis}{Thomas a Kempis}|\hfill\emph{medieval}\\ +% |\PretagName[Thomas]{à~Kempis}{Thomas a Kempis}|\hfill\emph{Western}\\ +% |\begin{nameauth}|\\[0.2ex] +% | \< KempMed & & Thomas, à~Kempis & >|\hfill\emph{medieval}\\ +% | \< KempW & Thomas & à~Kempis & >|\hfill\emph{Western}\\ +% |\end{nameauth}| % \end{quote} % -% \subsubsection{Listing by Surname} -% \label{sec:LastFirst} +% You do not need either \cmd{\CapThis} or \cmd{\AccentCapThis} if you use the medieval forms \KempMed\ and \KempMed. It is important that you do not mix medieval and Western forms to avoid odd name forms and multiple index entries.\footnote{Properly speaking, ``à~Kempis'' and ``Aquinas'' are not surnames but suffixed place names. They create different index entries from Western names and look different in the text.} % -%\DescribeMacro{\ReverseCommaActive} -%\DescribeMacro{\ReverseCommaInactive} -%\DescribeMacro{\RevComma} -% The reversing macros \cmd{\ReverseCommaActive}, \cmd{\ReverseCommaInactive}, and \cmd{\RevComma}\ allow the easy generation of name lists ordered as \meta{surname}, \meta{forename(s)}. The first two are broad toggles, while the third works on a per-name basis. Eastern, medieval, and royal names do not work with these macros. Name formatting has been turned off to focus on reversing and commas: -% -% \NamesInactive -% \begin{quote}\small -% \begin{tabular}{lll} -% {\large\strut}\Name*[J.S.]{Mill}[John Stuart] & \RevComma\Name*[J.S.]{Mill}[John Stuart] & OK\\ -% {\large\strut}\Name*[Oskar]{Hammerstein, II} & \RevComma\Name*[Oskar]{Hammerstein, II} & OK\\ -% {\large\strut}\Name*{John, Eriugena} & \RevComma\Name*{John, Eriugena} & incompatible\\ -% {\large\strut}\Name*{Mao}[Tse-tung] & \RevComma\Name*{Mao}[Tse-tung] & incompatible\\ -% {\large\strut}\Name*{Anaximander} & \RevComma\Name*{Anaximander} & OK\\ -% \end{tabular} -% \end{quote} -% \NamesActive -% -% \subsubsection{Naming Standards} -% \label{sec:standards} +% \IndexInactive% +% Nevertheless, many people refer to such names as Western surnames, which purists might view as being incorrect. If you need to use the Western variant, you might have to use |\AccentCapThis\KempW| to get \SubvertName[Thomas]{à~Kempis}``\AccentCapThis\KempW.'' +% \begin{itemize}\small +% \item Use \cmd{\PretagName} in all names with extended Unicode characters under \texttt{pdflatex}, NFSS, \textsf{inputenc}, and \texttt{makeindex}. See Section~\ref{sec:IndexSort}. +% \item |\CapThis\KempW| halts execution with \texttt{Argument of \textbackslash UTFviii@two@ octets has an extra \}.} Section~\ref{sec:accents} explains why. +% \item |\AccentCapThis\Name[Thomas]{à Kempis}| gives ``\AccentCapThis\Name[Thomas]{à Kempis}'' (space removed) in the absence of a non-breaking space or an explicit \cmd{\space.} This is due to \TeX\ handling ``|#1#2#3\relax|.'' +% \item Under \texttt{pdflatex} \cmd{\AccentCapThis} should not be used if the first character of a particle is not accented. |\AccentCapThis\Soto| gives \AccentCapThis\Soto. A particle like |lé| would cause \cmd{\AccentCapThis} to fail. Section~\ref{sec:accents} explains more. +% \end{itemize} +% \IndexActive% +% To summarize, use non-breaking spaces when needed. With \texttt{pdflatex} and \textsf{inputenc}, use \cmd{\CapThis} when the first character of the particle is \texttt{a--z.} Use \cmd{\AccentCapThis} when the first character is extended Unicode. +% \clearpage +% You\marginpar{\small\raggedleft Alternates} could use name forms with braces, like |\Name[Thomas]{{à}~Kempis}|, and control sequences, like |\Name[Thomas]{\`a~Kempis}|. Using those forms consistently, with \cmd{\PretagName,} would require you to use \cmd{\CapThis,} never \cmd{\AccentCapThis}. That is because both |{à}| and |\`a| are passed as one macro argument, while under NFSS and \textsf{inputenc}, |à| is passed as two arguments in ``|#1#2#3\relax|'' (see Section~\ref{sec:accents}). % -% According to the \emph{Chicago Manual of Style}, English names with the particles \emph{de}, \emph{de\ la}, \emph{d'}, \emph{von}, \emph{van}, and \emph{ten} generally keep them with the last name, using varied capitalization. \emph{Le}, \emph{La}, and \emph{L'} always are capitalized unless preceded by \emph{de}. +% Non-English contexts do not necessarily bind particles to surnames. Using \cmd{\Name} and \cmd{\FName} with alternate forenames helps address this and may skirt the particle capitalization issue. See also Section~\ref{sec:Particles}. % -% \DescribeMacro{\CapThis} -% In English, these particles go in the \meta{SNN} field of \cmd{\Name}, \emph{e.g.}, \ForgetName[Walter]{de la Mare}\Name[Walter]{de la Mare}. To capitalize \emph{de} when it arises at the beginning of a sentence, use |\CapThis\Name[Walter]{de la Mare}|. \CapThis\Name[Walter]{de la Mare} will think it fair. In the rare case where the particle is but one character (unlike all those listed above), the capping macros will eat the space between particle and name. One workaround is to follow such a particle with \cmd{\nobreakspace}. +% \subsubsection{Formatting Initials} % -% \DescribeMacro{\AccentCapThis} -% \cmd{\CapThis} works in all cases under \texttt{xelatex} and \texttt{lualatex}. Using \texttt{pdflatex} causes \cmd{\CapThis} to fail and halt execution only when the initial character in \meta{SNN} is an extended Unicode character; see Section~\ref{sec:accents}. In this special and infrequent case, either substitute \cmd{\AccentCapThis}, or put the extended character in braces, or use control sequences. -% -% Non-English contexts do not always bind particles to surnames. Using \cmd{\Name} and \cmd{\FName} with alternate forenames helps address this. See also Section~\ref{sec:Particles}. +% Omit spaces between initials if possible; see also Bringhurst's \emph{Elements of Typographic Style}. If your publisher wants spaces between initials, try putting thin spaces |\,| between them. Remember also to use \cmd{PretagName} to get the correct index sorting: +% \begin{quote} +% |\PretagName[E.\,B.]{White}{White, E. B.}|\\ +% |\begin{nameauth}|\\ +% | \< White & E.\,B. & White & >|\\ +% |\end{nameauth}|\\ +% \begin{nameauth} +% \< White & E.\,B. & White & > +% \end{nameauth} +% +% \begin{tabular}{ll}\hline +% & \vrule width0.5pt\hphantom{\textsc{E.}}\vrule width0.5pt\,\vrule width0.5pt\hphantom{\textsc{B.}}\vrule width0.5pt\hphantom{\textsc{White} and }\vrule width0.5pt\hphantom{E.}\vrule width0.5pt\,\vrule width0.5pt\hphantom{B.}\vrule width0.5pt\hphantom{White}\\ +% \cmd{\White} and \cmd{\LWhite} & \White\ and \LWhite\\ +% & \vrule width0.5pt\hphantom{\textsc{E.}}\vrule width0.5pt\,\vrule width0.5pt\hphantom{\textsc{B.}}\vrule width0.5pt\hphantom{\textsc{White} and }\vrule width0.5pt\hphantom{E.}\vrule width0.5pt\,\vrule width0.5pt\hphantom{B.}\vrule width0.5pt\hphantom{White}\\\hline +% & \vrule width0.5pt\hphantom{\textsc{E.}}\vrule width0.5pt\ \vrule width0.5pt\hphantom{\textsc{B.}}\vrule width0.5pt\hphantom{\textsc{White}\,and }\vrule width0.5pt\hphantom{E.}\vrule width0.5pt\ \vrule width0.5pt\hphantom{B.}\vrule width0.5pt\hphantom{White}\\ +% Normal:\hfill & \textsc{E. B. White}\,and E. B. White.\\ +% & \vrule width0.5pt\hphantom{\textsc{E.}}\vrule width0.5pt\ \vrule width0.5pt\hphantom{\textsc{B.}}\vrule width0.5pt\hphantom{\textsc{White}\,and }\vrule width0.5pt\hphantom{E.}\vrule width0.5pt\ \vrule width0.5pt\hphantom{B.}\vrule width0.5pt\hphantom{White}\\\hline +% \end{tabular} +% \end{quote} % % \subsubsection{Hyphenation} % @@ -1221,26 +1240,56 @@ Running "make install" installs the files in the local TeX tree. % % \newcommand{\de}[1]{\foreignlanguage{ngerman}{#1}} % Bad breaks can be fixed with the \textsf{babel} or \textsf{polyglossia} packages. \Name[John]{Strietelmeier} can have a bad break in English, as you see. Using \textsf{babel}, we can use the following example so that |\de{\Name*[John]{Strietelmeier}}| generates \de{\Name*[John]{Strietelmeier}} and helps prevent bad breaks: -% % \begin{quote} % |\newcommand{\de}[1]{\foreignlanguage{ngerman}{#1}}| % \end{quote} % -% \subsubsection{Indexing and \textsf{babel}} -% \label{sec:babel} -% Using\marginpar{\raggedleft \textsf{texindy}} \textsf{babel} with Roman page numbers will put \cmd{\textlatin} in the index entries if one includes a language that does not use the Latin alphabet\,---\,even if the main language does. The \texttt{texindy} program will ignore such references. This issue can affect \textsf{nameauth.} One workaround for \texttt{texindy} could enclose text with any macros that write to the index in an environment or a \cmd{\long} macro defined like: +% \subsubsection{Listing by Surname} +% \label{sec:LastFirst} % -% \begin{quote} -% |\newcommand{\fix}[1]{\def\textlatin##1{##1}#1}| +%\DescribeMacro{\ReverseCommaActive} +%\DescribeMacro{\ReverseCommaInactive} +%\DescribeMacro{\RevComma} +% The reversing macros \cmd{\ReverseCommaActive}, \cmd{\ReverseCommaInactive}, and \cmd{\RevComma}\ allow the easy generation of name lists ordered as \meta{SNN}, \meta{FNN} or \meta{SNN}, \meta{Alt. names}. The first two are broad toggles, while the third works on a per-name basis. Eastern, medieval, and royal names do not work with these macros. Name formatting has been turned off to focus on reversing and commas: +% +% \NamesInactive +% \begin{quote}\small +% \begin{tabular}{lll} +% {\large\strut}\Name*[J.S.]{Mill}[John Stuart] & \RevComma\Name*[J.S.]{Mill}[John Stuart] & OK\\ +% {\large\strut}\Name*[Oskar]{Hammerstein, II} & \RevComma\Name*[Oskar]{Hammerstein, II} & OK\\ +% {\large\strut}\Name*{John, Eriugena} & \RevComma\Name*{John, Eriugena} & incompatible\\ +% {\large\strut}\Name*{Mao}[Tse-tung] & \RevComma\Name*{Mao}[Tse-tung] & incompatible\\ +% {\large\strut}\Name*{Anaximander} & \RevComma\Name*{Anaximander} & OK\\ +% \end{tabular} +% \end{quote} +% \NamesActive +% +% {\hfill\large\bfseries Technical-Related Issues\hfill}\vspace{-2ex} +% \subsubsection{Fault Tolerance} +% +% Especially since version 2.0, the \textsf{nameauth} package tries to prevent malformed input from creating side effects. For example, the malformed |\Name[Henry]{VIII}| no longer interferes with the well-formed |\Name{Henry}[VIII].| Furthermore, we guard against empty required values being passed to naming macros. +% +% To reduce errors, \cmd{\Name}, \cmd{\FName}, \cmd{\AKA}, and \cmd{\IndexName} ignore leading and trailing spaces\,---\,but not medial spaces\,---\,making the following equivalent: +% +% \begin{quote}\small\ForgetName[Martin Luther]{King, Jr.} +% \begin{tabular}{ll} +% \textit{Macro Example} & \textit{Resulting text}\\ +% |\Name*[ Martin Luther]{King, Jr.}| & \Name*[ Martin Luther]{King, Jr.}\\ +% |\Name*[Martin Luther ]{King, Jr.}| & \Name*[Martin Luther ]{King, Jr.}\\ +% |\Name*[ Martin Luther ]{King, Jr.}| & \Name*[ Martin Luther ]{King, Jr.}\\ +% |\Name*[Martin Luther]{ King, Jr.}| & \Name*[Martin Luther]{ King, Jr.}\\ +% |\Name*[Martin Luther]{King, Jr. }| & \Name*[Martin Luther]{King, Jr. }\\ +% |\Name*[Martin Luther]{ King, Jr. }| & \Name*[Martin Luther]{ King, Jr. }\\ +% \end{tabular} % \end{quote} % % \subsubsection{Detecting Punctuation} % -% In Western names, some affixes with full stops could appear at the end of a sentence. Such affixes include ``Jr.'' (junior), ``Sr.'' (senior), ``d.\,J.'' (\textit{der J\"ungere}), and ``d.\,\"A.'' (\textit{der \"Altere}). Consider this example, where some lines have two full stops and some do not: +% In Western names, some affixes with full stops could appear at the end of a sentence. Such affixes include ``Jr.'' (junior), ``Sr.'' (senior), ``d.\,J.'' (\textit{der J\"ungere}), and ``d.\,\"A.'' (\textit{der \"Altere}). Consider this example: % % \begin{quote}\footnotesize\ForgetName[Martin Luther]{King, Jr.} -% \begin{tabular}{l@{ }l@{\hbox to 1em{\hfil}}l} -% \textit{Macro Example} & & \textit{Resulting text}\\ +% \begin{tabular}{r@{\hbox to 1em{\hfil}}c@{\hbox to 1em{\hfil}}l} +% \textit{Macro Example} & \textit{periods} & \textit{Resulting text}\\ % |\Name[Martin Luther]{King, Jr.}.| & $2\rightarrow1$ & \Name[Martin Luther]{King, Jr.}.\\ % |\Name[Martin Luther]{King, Jr.}.| & $2\rightarrow1$ & \Name[Martin Luther]{King, Jr.}.\\ % |\Name[Martin Luther]{King, Jr.}|\texttt{\textvisiblespace} & $1\rightarrow0$ & \Name[Martin Luther]{King, Jr.}\\ @@ -1250,15 +1299,12 @@ Running "make install" installs the files in the local TeX tree. % \end{tabular}\footnotetext{Example of how to frustrate the full stop detection mechanism.} % \end{quote} % -% \cmd{\Name}, \cmd{\FName}, and \cmd{\AKA} all check for a trailing full stop in the printed name in the text. If it exists, and if the next token is also a full stop, they gobble the trailing full stop. Grouping tokens, among other items, can frustrate this detection, as shown in the previous example. +% \cmd{\Name}, \cmd{\FName}, and \cmd{\AKA} all check for a trailing full stop in the printed name in the text. If it exists, and if the next token is also a full stop, they gobble the trailing full stop. Grouping tokens, among other items, can frustrate this detection, as shown above. % % \subsubsection{Accented Names} % \label{sec:accents} % -% For texts that contain accented characters, using \texttt{xelatex} or \texttt{lualatex} with \texttt{xindy} (\texttt{texindy}) is recommended. Since version 2.1, \textsf{nameauth} generally does not require any special treatment for the leading character of the \meta{SNN} field. The only exception is when you need to use \cmd{\CapThis} under \texttt{pdflatex}. That is the case where you substitute \cmd{\AccentCapThis} (Section~\ref{sec:standards}).\footnote{The root of this problem is shown by this example: \texttt{\textbackslash def\textbackslash foo\#1\#2\#3\textbackslash relax\{<\#1\#2><\#3>\}.} With \texttt{\textbackslash foo abc\textbackslash relax} you get <ab><c>. With \texttt{\textbackslash foo æbc\textbackslash relax} you get <æ><bc>.\\[0.5ex] -%\indent Using \texttt{xelatex} and \texttt{lualatex} always gives you <ab><c> and <æb><c>, thus avoiding the problem. Using \texttt{pdflatex} with \cmd{\CapThis} yields \texttt{Argument of \textbackslash UTFviii@two@ octets has an extra \}.} Many extant word-capitalizing macros and even kernel macros like \cmd{\in@}\dots\cmd{\ifin@} cause errors when used as we do in \textsf{nameauth}.} -% -% Under NFSS and the |utf8| input encoding, the following glyphs generally are available to you: +% For texts that contain accented characters, using \texttt{xelatex} or \texttt{lualatex} with \texttt{xindy} (\texttt{texindy}) is recommended. Since version 2.1, \textsf{nameauth} only requires special treatment of the leading character in the \meta{SNN} field when you use \cmd{\CapThis} under \texttt{pdflatex}. In that case use \cmd{\AccentCapThis} (Section~\ref{sec:standards}) if the character is not \texttt{a--z} or in the list below, for use with NFSS and the |utf8| input encoding: % \begin{quote}\small % \begin{tabular}{llll} % \scshape À Á Â Ã Ä Å Æ & \scshape Ç È É Ê Ë & \scshape Ì Í Î Ï Ð Ñ & \scshape first use \\ @@ -1277,19 +1323,25 @@ Running "make install" installs the files in the local TeX tree. % Ś Ş ş Š š Ţ ţ Ť ť & Ů ů Ű ű & Ź ź Ż ż Ž ž & second use \\ % \end{tabular} % \end{quote} -% These glyphs do not cover some of the extended character sets completely. Unicode characters and control sequences are not interchangeable. Instead of getting long, then short references (if they were the same), you only get long ones below: +% These characters really act as control sequences, so you must use \cmd{\PretagName} (Section~\ref{sec:IndexSort}) to sort them properly. +% +% Examples |{æ}| and \cmd{\ae} always use argument |#1| if sent through the macro: |\def\foo#1#2#3\relax{<#1#2><#3>}.| With |\foo abc\relax| you always get <ab><c>. Both |\foo {æ}bc\relax| and |\foo \ae bc\relax| give <æb><c>. +% +% Using |æ| by itself gets tricky. In \texttt{xelatex} and \texttt{lualatex} this character always uses |#1| in |\foo æbc\relax| to get <æb><c>. Using \texttt{pdflatex} with NFSS causes problems; |\foo æbc\relax| gives <æ><bc>. With \textsf{inputenc} and \textsf{fontenc} |æ| by itself uses |#1#2|. It is ``two arguments wide.'' Any macro where this |#1#2| pair gets split into |#1| and |#2| will produce either the error \texttt{Unicode char \dots not set up for LaTeX} or the error \texttt{Argument of \textbackslash UTFviii@two@ octets has an extra \}}. Using \cmd{\CapThis} can trigger this kind of error in \texttt{pdflatex.} +% +% Unicode characters and control sequences are not interchangeable. The example below shows this difference because the names are all long instead of long, then short (if they were the same): % \begin{quote} % \IndexInactive% % |\Name[Johann]{Andre\"a}|\hfill \Name[Johann]{Andre\"a}\\ % \IndexActive% -% |\Name[Johann]{Andreä}|\hfill \Name[Johann]{Andreä}\\ +% |\Name[Johann]{Andreä}|\hfill \Name[Johann]{Andreä} instead of \Name[Johann]{Andreä}\\ % \IndexInactive% % |\Name{\AE thelred, II}|\hfill \Name{\AE thelred, II}\\ % \IndexActive% -% |\Name{Æthelred, II}|\hfill \Name{Æthelred, II} +% |\Name{Æthelred, II}|\hfill \Name{Æthelred, II} instead of \Name{Æthelred, II} % \end{quote} % -% Additional accents and glyphs can be used with Unicode input, NFSS, \textsf{inputenc}, and \textsf{fontenc} when using fonts with TS1 glyphs, \emph{e.g.}, |\usepackage{lmodern}| (per the table on pages 455--63 in \emph{The Latex Companion}). The example below lets you type, ``In Congreſs, July 4, 1776.'' +% Additional accents and glyphs can be used with Unicode input, NFSS, \textsf{inputenc}, and \textsf{fontenc} when using fonts with TS1 glyphs, \emph{e.g.}, |\usepackage{lmodern}| (per the table on pages 455--63 in \emph{The Latex Companion}). The following example lets you type, ``In Congreſs, July 4, 1776.'' % \begin{quote} % |\usepackage{newunicodechar}|\\ % |\DeclareTextSymbolDefault{\textlongs}{TS1}|\\ @@ -1301,40 +1353,6 @@ Running "make install" installs the files in the local TeX tree. % %One may use expandable control sequences in names (thanks \Name*[Robert]{Schlicht}). Also, you can define letters with \cmd{\edef} and \cmd{\noexpand} to use in names, as some do to ``protect'' accented letters in names. As of version 2.0 of \textsf{nameauth} helpful concerns expressed by \Name[Patrick]{Cousot} have been addressed. % -% \subsubsection{Index Sorting} -% \label{sec:IndexSort} -% -% The general practice for sorting with \texttt{makeindex -s} involves creating your own |.ist| file (pages 659--65 in \emph{The Latex Companion}). Otherwise use the following form that works with both \texttt{makeindex} and \texttt{texindy}: -% \begin{quote} -% |\index{|\meta{sortkey}|@|\meta{actual}|}| -% \end{quote} -%Before version 2.0 of \textsf{nameauth}, one had to sort and index a name like \Name[Jan]{Łukasiewicz} by putting it between \cmd{\IndexInactive} and \cmd{\IndexActive} while creating a manual index entry.\\ -% -% \DescribeMacro{\PretagName} -% Fortunately, the current versions of \textsf{nameauth} have adopted an easier solution. The syntax of \cmd{\PretagName} is like that of \cmd{\TagName}: -% \begin{quote} -% \cmd{\PretagName}\oarg{FNN}\marg{SNN}\oarg{Alternate names}\marg{tag} -% \end{quote} -% The \cmd{\PretagName} macro does not work exactly like the \cmd{\TagName} and \cmd{\UntagName} macros (see Section~\ref{sec:TagName} and following). The main differences are: -% \begin{itemize}\setlength{\itemsep}{0pt} -% \item You can ``pretag'' any name and any cross-reference. -% \item You can ``tag'' and ``untag'' only names, not cross-references. -% \item There is no command to undo a ``pretag.'' -% \end{itemize} -% The \cmd{\PretagName} macro creates a sort key terminated with the ``actual'' character, which is |@| by default. Do not include the ``actual'' character in the pretag. -% Now, sorting index entries is as simple as: -% \begin{quote} -% |\PretagName[Jan]{Łukasiewicz}{Lukasiewicz, Jan}|\\ -% |\PretagName{Æthelred, II}{Aethelred 2}| -% \end{quote} -% -% One need only pretag names once in the preamble. Every time that one refers to \Name[Jan]{Łukasiewicz} or \Name{Æthelred, II}, the proper index entry will be created. If you create a cross-reference with \cmd{\AKA} and you want to pretag it, see Section~\ref{sec:AKA}.\\ -% -% \DescribeMacro{\IndexActual} -% If you need to change the ``actual'' character, such as with \texttt{gind.ist}, put |\IndexActual{=}| in the preamble.\\ -% -% \bgroup\setlength{\fboxsep}{5pt}\noindent\fbox{\parbox{0.97\textwidth}{\strut\hfil You cannot use index tags if the \textsf{nameauth} indexing feature is inactive.\hfil}}\egroup\clearpage -% % This package tries to work with multiple languages and typesetting engines. The following preamble snippet illustrates how that can be done: % \begin{quote}\small % |\usepackage{ifxetex}|\\ @@ -1376,64 +1394,73 @@ Running "make install" installs the files in the local TeX tree. % \label{sec:formatting} % % There are two kinds of formatting at work: -% -% \begin{enumerate}\small\setlength{\itemsep}{0pt} +% \begin{enumerate}\small % \item \textbf{Syntactic Formatting:} This includes reversing names, capitalizing the first letter in the \meta{SNN} field in the body text, and capitalizing the root when \meta{SNN} is a \meta{root, suffix} pair. % \item \textbf{Typographic Formatting:} This happens after a name has been parsed and reordered as needed into the final form it will take in the text. % \end{enumerate} -% -% Neither type of formatting makes it into the index. However, there are ways around that. One way to get formatting into the text and the index is to make it part of the name arguments, using \cmd{\PretagName} to get proper sorting: -% -% \begin{quote}\small -% |\PretagName[\normalfont{Mata}]{\textsc{Hari}}{Hari, Mata}%|\\ -% |\Name[\normalfont{Mata}]{\textsc{Hari}}| +% Formatting\marginpar{\small\raggedleft Continental\\ small caps} does not affect the index. However, literal control sequences in the macro arguments of \cmd{\Name} and friends do make it into the index. Use this method with the \texttt{noformat} option to suppress default formatting. One also must use \cmd{\PretagName} to get proper index sorting: +% \NamesInactive +% \begin{quote} +% \indent|\PretagName[Greta]{\textsc{Garbo}}{Garbo, Greta}|\\ +% \indent|\Name[Greta]{\textsc{Garbo}}| % \end{quote} -% You get \Name[\normalfont{Mata}]{\textsc{Hari}}, then \Name[\normalfont{Mata}]{\textsc{Hari}}. But it gets more complicated. If you use a comma-delimited suffix you need to format the name and suffix separately, as we see on the next page. -% +% You get \Name[Greta]{\textsc{Garbo}}, then \Name[Greta]{\textsc{Garbo}}. Even if it ``looks the same,'' the name |\Name[\normalfont{Greta}]{\textsc{Garbo}}| is a different name with a different index entry. In other words, avoid putting excess formatting into names, so that you gain both flexibility and consistency. +% +% A comma delimiter will split the macro argument, potentially causing unbalanced braces. Avoid this by formatting the name and suffix separately: % \begin{quote}\small -% |\PretagName{\uppercase{Fukuyama}, T.}{Fukuyama, T.}|\\ -% |\PretagName[\normalfont{Thurston}]%|\\ -% | {\textsc{Howell},\textsc{III}}{Howell, Thurston 3}|\\[1ex] +% |\PretagName{\uppercase{Fukuyama},| |Takeshi}{Fukuyama,| |Takeshi}|\\ +% |\PretagName[Thurston]{\textsc{Howell},\textsc{III}}%|\\ +% | {Howell, Thurston 3}|\\[1ex] % |\begin{nameauth}|\\ -% | \< Fukuyama & & \uppercase{Fukuyama}, T. & >|\\ +% | \< Fukuyama & & \uppercase{Fukuyama}, Takeshi & >|\\ +% | \< Howell & Thurston & \textsc{Howell},\textsc{III} & >|\\ % |\end{nameauth}| % \end{quote} -% |\Name[\normalfont{Thurston}]{\textsc{Howell},\textsc{III}}| produces\break \Name[\normalfont{Thurston}]{\textsc{Howell},\textsc{III}}, then \Name[\normalfont{Thurston}]{\textsc{Howell},\textsc{III}}. Likewise the simplified \cmd{\Fukuyama} produces \Fukuyama\ and \Fukuyama.\\ +% \cmd{\Fukuyama} produces \Fukuyama\ and \Fukuyama. Of course, you could type all-capital surnames without control sequences. Likewise, \cmd{\Howell} generates \Howell\ and \Howell. +% \NamesActive\bigskip % % \DescribeMacro{\NameauthName} +% \DescribeMacro{\NameauthLName} % \DescribeMacro{\NameauthFName} -% These two macros are hooks into the simplified interface. If the method above will not suffice, you can use the extant macros as building blocks or even create your own naming macros that comply at least to the following template: +% These macros are set by default to \cmd{\@nameauth@Name}, the internal name parser. The main and simplified interfaces call them as respective synonyms for \cmd{\Name,} \cmd{\Name*,} and \cmd{\FName.} Should you desire to create your own naming macros, you can redefine them. Here is the minimal working example: % \begin{quote} % |\makeatletter|\\ % |\newcommandx*\MyName[3][1=\@empty, 3=\@empty]%|\\ -% | {|\meta{Something here}|}%|\\ +% | {|\meta{Name here}|}%|\\ +% |\newcommandx*\MyLName[3][1=\@empty, 3=\@empty]%|\\ +% | {|\meta{Long name here}|\@nameauth@FullNamefalse}%|\\ % |\newcommandx*\MyFName[3][1=\@empty, 3=\@empty]%|\\ -% | {|\meta{More stuff here}|}%|\\ +% | {|\meta{Short name here}|\@nameauth@FirstNamefalse}%|\\ % |\makeatother| % \end{quote} -% You can plug these macros into the simplified interface thus: +% \clearpage +% +% The macros above do not really work together with the rest of \textsf{nameauth} package, so be careful! You can hook these macros into the user interface thus: % \begin{quote} % \makeatletter% -% \newcommandx*\MyName[3][1=\@empty, 3=\@empty]{\meta{Something here}}% -% \newcommandx*\MyFName[3][1=\@empty, 3=\@empty]{\meta{More stuff here}}% +% \newcommandx*\MyName[3][1=\@empty, 3=\@empty]{\meta{Name here}}% +% \newcommandx*\MyLName[3][1=\@empty, 3=\@empty]{\meta{Long name here}\@nameauth@FullNamefalse}% +% \newcommandx*\MyFName[3][1=\@empty, 3=\@empty]{\meta{Short name here}\@nameauth@FirstNamefalse}% % \makeatother% % |\renewcommand*{\NameauthName}{\MyName}|\\ +% |\renewcommand*{\NameauthLName}{\MyLName}|\\ % |\renewcommand*{\NameauthFName}{\MyFName}|\\ % |\begin{nameauth}|\\ % | \< Silly & No Particular & Name & >|\\ % |\end{nameauth}|\\ -% |This is \Silly\ and \SSilly.|\\ +% |This is \Silly, \LSilly, and \SSilly.|\\ % \renewcommand*{\NameauthName}{\MyName}% +% \renewcommand*{\NameauthLName}{\MyLName}% % \renewcommand*{\NameauthFName}{\MyFName}% % \begin{nameauth} % \< Silly & No Particular & Name & > % \end{nameauth} -% This is \Silly\ and \SSilly. +% This is \Silly, \LSilly, and \SSilly. % \end{quote} -% Like \cmd{\NamesFormat} below, both \cmd{\NameauthName} and \cmd{\NameauthFName} respect scoping. Thus, \cmd{\Silly} now produces \IndexInactive\Silly\IndexActive.\\ +% Like \cmd{\NamesFormat} below, the macros \cmd{\NameauthName,} \cmd{\NameauthLName,} and \cmd{\NameauthFName} respect scoping unless you use \cmd{\global.} Now \cmd{\Silly} and |\Name[No Particular]{Name}| produce \IndexInactive\Silly\ and \Name[No Particular]{Name}\IndexActive.\bigskip % % \DescribeMacro{\NamesFormat} -% When formatting is active, \cmd{\NamesFormat} is called at the first instance of a name, and at every instance of a name when the \texttt{alwaysformat} option is used. Beyond using the package options, one also can redefine \cmd{\NamesFormat} to create custom effects. For example, one might change or suppress formatting in all footnotes: +% When formatting is active, \cmd{\NamesFormat} is called at the first instance of a name, and at every instance of a name when the \texttt{alwaysformat} option is used. Beyond using the package options, one also can redefine \cmd{\NamesFormat} to create custom effects. For example, one might change formatting in all footnotes: % % \begin{quote}\small % |\makeatletter|\\ @@ -1443,7 +1470,7 @@ Running "make install" installs the files in the local TeX tree. % |\makeatother| % \end{quote} % -% \noindent This approach will not print the first use of a name in the body text if it already occured in the footnotes unless one uses \cmd{\ForgetName} to force that. This example takes advantage of the deep scoping of \cmd{\@makefntext} in order to use a localized \cmd{\def} to make a temporary change. The next section shows how one can use a completely independent system of first and subsequent use in the footnotes.\clearpage +% \noindent This approach will not print the first use of a name in the body text if it already occured in the footnotes unless one uses \cmd{\ForgetName} to force that. This example takes advantage of the local scope of \cmd{\@makefntext}. % % A second example puts the mention of first names in boldface, with additional notations in the margin if possible: %\begin{quote}\small @@ -1460,11 +1487,10 @@ Running "make install" installs the files in the local TeX tree. % \Name{Vlad III, Dracula}, known as \AKA{Vlad III, Dracula}{Vlad, Ţepeş}, ``\AKA*{Vlad III, Dracula}{Vlad}[the Impaler]'' after his death, was the son of \Name{Vlad II, Dracul}, a member of the Order of the Dragon. Later references to ``\Name{Vlad III, Dracula}'' appear thus. % \end{quote} % -% The |quote| environment used above permits local changes to \cmd{\NamesFormat} so they revert back to the default: \ForgetName{Vlad III, Dracula}\Name{Vlad III, Dracula} and \Name{Vlad III, Dracula}. For references to ``Vlad'' instead of ``\Name{Vlad III, Dracula}'' one could use |\Name{Vlad, III Dracula}|.\footnote{Do not mix \cmd{\Name}\texttt{\{Vlad III, Dracula\}} with \cmd{\Name}\texttt{\{Vlad, III Dracula\}} or the old syntax, lest errors bite! You would get multiple index entries with \cmd{\Name}, unwanted cross-references with \cmd{\AKA} and unexpected forms in the text. The simplified interface helps one to avoid this.} -% +% Outside of the |quote| environment above, we have \ForgetName{Vlad III, Dracula}\Name{Vlad III, Dracula} and \Name{Vlad III, Dracula}. For references to ``Vlad'' instead of ``\Name{Vlad III, Dracula}'' one could use |\Name{Vlad, III Dracula}|. Do not mix these forms with each other or with the old syntax, lest errors bite! You would get multiple index entries, unwanted cross-references, and unexpected forms in the text. The simplified interface helps one to avoid this. % % \subsubsection{Disable Formatting} -% \label{sec:SectionFormat} +% \label{sec:DisableFormat} % % \DescribeMacro{\NamesActive} % \DescribeMacro{\NamesInactive} @@ -1492,7 +1518,7 @@ Running "make install" installs the files in the local TeX tree. % \end{tabular} % \end{quote} % -% Notice that we have two independent cases of ``first use'' above. Consider the two ``species'' of names to be ``non-formatted'' and ``formatted,'' intended for front matter and main matter. Yet one could use this, \emph{e.g.}, in footnotes: +% Notice that we have two independent cases of ``first use'' above. Consider the two ``species'' of names to be ``non-formatted'' and ``formatted,'' intended for front matter and main matter. Yet one could use this in footnotes to implement a different system of names (see also Section~\ref{sec:Tweaks}): % \begin{quote}\small % |\makeatletter|\\ % |\let\@oldfntext\@makefntext|\\ @@ -1501,43 +1527,160 @@ Running "make install" installs the files in the local TeX tree. % |}\makeatother| % \end{quote} % -% \subsection{Tweaks: \texttt{\textbackslash ForgetName} and \texttt{\textbackslash SubvertName}} +% \subsection{Name Decisions} +% \subsubsection{Testing Decisions} +% \label{sec:tests} +% +% Sometimes the behavior of your document may need to change if a name is present or not. The macros in this subsection help to make such changes possible. Only \cmd{\Name,} \cmd{\Name*,} \cmd{\PName,} \cmd{\AKA,} \cmd{\AKA*,} \cmd{\ForgetName,} \cmd{\SubvertName,} and \cmd{\ExcludeName} affect the results of these macros. +% +% The following macros can be useful for generating conditional output in the document, such as inserting a ``short biography'' footnote or callout text after a name, depending on a particular context. Authors also can use them to generate ``reminders to self'' if a name has or has not occurred yet in the document. Such reminders could be linked with the \textsf{comment}, \textsf{pdfcomment}, and similar packages to aid writing and name management.\medskip +% +% \DescribeMacro{\IfMainName} +% If you want to produce output or perform a task based on whether a ``main body'' name exists, use \cmd{\IfMainName}, whose syntax is: +% \begin{quote} +% \cmd{\IfMainName}\oarg{FNN}\marg{SNN}\oarg{Alternate names}\marg{yes}\marg{no} +% \end{quote} +% This is a long macro via \cmd{\newcommandx}, so you can have paragraph breaks in the \meta{yes} and \meta{no} paths. A ``main body'' name is capable of being formatted by this package, \emph{i.e.}, one created by the naming macros when the \texttt{mainmatter} option is used or after \cmd{\NamesActive}. It is distinguished from those names that occur in the front matter and those that have been used as cross-references. +% \clearpage +% +% For example, we can test if we have yet to encounter the name ``Bob Hope'' in this document. We get ``\IfMainName[Bob]{Hope}{I met \Name[Bob]{Hope}}{I have not met \Name[Bob]{Hope}}'' from the following: +% \begin{quote} +% |\IfMainName[Bob]{Hope}%|\\ +% |{I met \Name[Bob]{Hope}}%|\\ +% |{I have not met \Name[Bob]{Hope}}| +% \end{quote}% +% We will meet \FName[Bob]{Hope} in Section~\ref{sec:AKA}, so after this example we need to use the macro |\ForgetName[Bob]{Hope}| to ``forget'' that we saw this name.\ForgetName[Bob]{Hope}\medskip +% +% \DescribeMacro{\IfFrontName} +% If you want to produce output or perform a task based on whether a ``front matter'' name exists, use \cmd{\IfFrontName}, whose syntax is: +% \begin{quote} +% \cmd{\IfFrontName}\oarg{FNN}\marg{SNN}\oarg{Alternate names}\marg{yes}\marg{no} +% \end{quote} +% This macro works the same as \cmd{\IfMainName.} A ``front matter'' name is not capable of being formatted by this package, \emph{i.e.}, one created by the naming macros when the \texttt{frontmatter} option is used or after \cmd{\NamesInactive}. It is distinguished from those names that occur in the main matter and those that have been used as cross-references. +% +% For example, we can test whether a name has been used as a formatted name, an unformatted name, or both: +% \begin{quote} +% |\IfFrontName[Rudolph]{Carnap}%|\\ +% |{\IfMainName[Rudolph]{Carnap}%|\\ +% | {\Name[Rudolph]{Carnap} is both}%|\\ +% | {\Name[Rudolph]{Carnap} is only non-formatted}}%|\\ +% |{\IfMainName[Rudolph]{Carnap}%|\\ +% | {\Name[Rudolph]{Carnap} is only formatted}%|\\ +% | {\Name[Rudolph]{Carnap} is not mentioned}}| +% \end{quote}% +% From this we get the result that we expect from Section~\ref{sec:DisableFormat}, namely: +% \IfFrontName[Rudolph]{Carnap}% +% {\IfMainName[Rudolph]{Carnap}% +% {\Name[Rudolph]{Carnap} is both}% +% {\Name[Rudolph]{Carnap} is only non-formatted}}% +% {\IfMainName[Rudolph]{Carnap}% +% {\Name[Rudolph]{Carnap} is only formatted}% +% {\Name[Rudolph]{Carnap} is not mentioned}}. We will return to this topic later.\medskip +% +% \DescribeMacro{\IfAKA} +% If you want to produce output or perform a task based on whether a ``\emph{see}-reference'' name exists, use \cmd{\IfAKA}, whose syntax is: +% \begin{quote} +% \cmd{\IfAKA}\oarg{FNN}\marg{SNN}\oarg{Alt. names}\marg{y}\marg{n}\marg{excluded} +% \end{quote} +% This macro works similarly to \cmd{\IfMainName,} although it has an ``excluded'' branch in order to detect those names excluded from indexing by \cmd{\ExcludeName} (Section~\ref{sec:exclude}). A ``\emph{see}-reference'' name is printed in the body text but only exists as a cross-reference created by \cmd{\AKA} and \cmd{\AKA*}. From the following example we get ``\IfAKA[Jay]{Rockefeller}{\LJRIV\ has an alias}{\LJRIV\ does not have an alias}{\LJRIV\ is excluded}'': +% \begin{quote} +% |\IfAKA[Jay]{Rockefeller}%|\\ +% | {\LJRIV\ has an alias}%|\\ +% | {\LJRIV\ does not have an alias}%|\\ +% | {\LJRIV\ is excluded}| +% \end{quote} +% If you are confident that you will not be dealing with names generated by \cmd{\ExcludeName} then you can just leave the \meta{excluded} branch as |{}.| +% \clearpage +% +% A similar use of |\IfAKA{Confucius}| tells us that ``\IfAKA{Confucius}{\Name{Confucius} is an alias}{\Name{Confucius} is not an alias}{\Name{Confucius} is excluded}.'' Yet one might have to check further about \Name{Confucius} to see if it is used as a formatted name or a non-formatted name. +% +% Here we test for a name used with \cmd{\ExcludeName} (Section~\ref{sec:exclude}) to get the result, ``\ExcludeName{Grinch}\IfAKA{Grinch}{\Name{Grinch} is an alias}{\Name{Grinch} is not an alias}{\Name{Grinch} is excluded}'': +% \begin{quote} +% |\ExcludeName{Grinch}%|\\ +% |\IfAKA{Grinch}%|\\ +% | {\Name{Grinch} is an alias}%|\\ +% | {\Name{Grinch} is not an alias}%|\\ +% | {\Name{Grinch} is excluded}| +% \end{quote} +% +% \subsubsection{Changing Decisions} % \label{sec:Tweaks} % -% Perhaps the easiest way to avoid the ``interspecies clashes'' above are the two macros presented here. They are meant for tweaking text at or near final draft stage. They affect both front matter and main matter.\\ +% This section describes macros that change the status of whether a name has occurred. That also helps to avoid clashes between formatted and non-formatted names. They are meant for editing at or near the final draft stage. ``\emph{See}-reference'' names created by \cmd{\AKA} are not affected by these macros.\bigskip % % \DescribeMacro{\ForgetName} -% This macro is a ``dirty trick'' of sorts that takes the same optional and mandatory parameters used by \cmd{\Name}. It handles its arguments in the same way, except that it ignores the final parameter if \meta{FNN} are present. The syntax is: +% This macro is a ``dirty trick'' of sorts that takes the same optional and mandatory arguments used by \cmd{\Name}. It handles its arguments in the same way, except that it ignores the final argument if \meta{FNN} are present. The syntax is: % \begin{quote} % \cmd{\ForgetName}\oarg{FNN}\marg{SNN}\oarg{Alternate names} % \end{quote} -% -% \noindent This macro causes \cmd{\Name} and friends to ``forget'' prior uses of a name. The next use of that name will print as if it were a ``first use,'' even if it is not. Index entries and cross-references are \emph{never} forgotten by this package.\\ +% This macro causes \cmd{\Name} and friends globally to ``forget'' prior uses of a name. The next use of that name will print as if it were a ``first use,'' even if it is not. Index entries and cross-references are \emph{never} forgotten.\bigskip % % \DescribeMacro{\SubvertName} -% This macro is the opposite of the one above. It takes the same parameters. It handles its arguments in the same manner. The syntax is: +% This macro is the opposite of the one above. It takes the same arguments. It handles its arguments in the same manner. The syntax is: % \begin{quote} % \cmd{\SubvertName}\oarg{FNN}\marg{SNN}\oarg{Alternate names} % \end{quote} +% This macro causes \cmd{\Name} and friends globally to think that a prior use of a name already has occurred. The next use of that name will print as if it were a ``subsequent use,'' even if it is not.\bigskip % -% \noindent This macro causes \cmd{\Name} and friends to think that a prior use of a name already has occurred. The next use of that name will print as if it were a ``subsequent use,'' even if it is not. +% The default \marginpar{\small\raggedleft Scope} behavior of these two macros changes whether a name is ``forgotten'' or ``subverted'' simultaneously for front matter and main matter names, Remember the example above that gave us the answer, ``\IfFrontName[Rudolph]{Carnap}{\IfMainName[Rudolph]{Carnap}{\Name[Rudolph]{Carnap} is both}{\Name[Rudolph]{Carnap} is only non-formatted}}{\IfMainName[Rudolph]{Carnap}{\Name[Rudolph]{Carnap} is only formatted}{\Name[Rudolph]{Carnap} is not mentioned}}'': +% \begin{quote} +% |\IfFrontName[Rudolph]{Carnap}%|\\ +% |{\IfMainName[Rudolph]{Carnap}%|\\ +% | {\Name[Rudolph]{Carnap} is both}%|\\ +% | {\Name[Rudolph]{Carnap} is only non-formatted}}%|\\ +% |{\IfMainName[Rudolph]{Carnap}%|\\ +% | {\Name[Rudolph]{Carnap} is only formatted}%|\\ +% | {\Name[Rudolph]{Carnap} is not mentioned}}| +% \end{quote} % -% \subsection{Name Variant Macros} -% \subsubsection{\texttt{\textbackslash AKA}} -% \label{sec:AKA} +% Now watch closely: After we use \ForgetName[Rudolph]{Carnap}|\ForgetName[Rudolph]{Carnap}| we get the result, +% ``\IfFrontName[Rudolph]{Carnap}{\IfMainName[Rudolph]{Carnap}{\Name[Rudolph]{Carnap} is both}{\Name[Rudolph]{Carnap} is only non-formatted}}{\IfMainName[Rudolph]{Carnap}{\Name[Rudolph]{Carnap} is only formatted}{\Name[Rudolph]{Carnap} is not mentioned}}.'' Both the main matter name and the front matter name were forgotten! % -% \DescribeMacro{\AKA} -% \DescribeMacro{\AKA*} -% \cmd{\AKA} (meaning \textit{also known as}) handles pseudonyms, stage names, \emph{noms de plume}, and so on in order to replace typing manual cross-references in the index: +% This default behavior helps synchronize formatted and unformatted types of names. For example, if you wanted to use unformatted names in the footnotes and formatted names in the text (Section~\ref{sec:DisableFormat}), you could use, \emph{e.g.} \cmd{\SubvertName} right after the first use of a name in the body text, ensuring that all references in the text and notes would be short unless otherwise modified.\footnote{This manual takes advantage of that behavior at times in order to synchronize first and subsequent uses of names between formatted and unformatted sections of the body text.} % -% \begin{quote}\small -% |\Name{Jean, sans Peur}| |(\AKA{Jean,| |sans| |Peur}{Jean| |the| |Fearless})|\\ {\ttfamily was Duke of Burgundy 1404|--|1419.} +% \DescribeMacro{\LocalNames} +% \DescribeMacro{\GlobalNames} +% If, however, this ``global'' behavior of \cmd{\ForgetName} and \cmd{\SubvertName} is not desired, you can use \cmd{\LocalNames} to change that behavior and \cmd{\GlobalNames} to restore the default behavior. Both of these macros are global in scope. % -% \Name{Jean, sans Peur} (\AKA{Jean, sans Peur}{Jean the Fearless}) was Duke of Burgundy 1404--1419.% +% After \cmd{\LocalNames,} if you are in a ``front matter'' section via the \texttt{frontmatter} option or \cmd{\NamesInactive,} \cmd{\ForgetName} and \cmd{\SubvertName} will only affect unformatted names. If you are in a ``main matter'' section via the \texttt{mainmatter} option or \cmd{\NamesActive,} then \cmd{\ForgetName} and \cmd{\SubvertName} will only affect formatted names. The following example helps to illustrate local changes: +% \begin{quote}\small +% |\def\CheckChuck{%\IfFrontName[Charlie]{Chaplin}%|\\ +% | {\IfMainName[Charlie]{Chaplin}{both}{front}}%|\\ +% | {\IfMainName[Charlie]{Chaplin}{main}{none}}}%|\\[2ex] +% \def\CheckChuck{\IfFrontName[Charlie]{Chaplin}% +% {\IfMainName[Charlie]{Chaplin}{both}{front}}% +% {\IfMainName[Charlie]{Chaplin}{main}{none}}}% +% We begin by creating a formatted name in the main matter:\\ +% |\Name*[Charlie]{Chaplin}|\hfill\Name*[Charlie]{Chaplin}\\ +% |\CheckChuck|\hfill\CheckChuck\\[2ex] +% Now we switch to an unformatted section and create a name there:\\ +% |\NamesInactive|\NamesInactive\\ +% |\Name*[Charlie]{Chaplin}|\hfill\Name*[Charlie]{Chaplin}\\ +% |\CheckChuck|\hfill\CheckChuck\\[2ex] +% We now have two names. They look and behave the same, but are two different ``species'' with independent first and subsequent uses. We set the scope of \cmd{\ForgetName} and \cmd{\SubvertName} to local, then forget the name in the unformatted section:\\ +% |\LocalNames|\LocalNames\\ +% |\ForgetName[Charlie]{Chaplin}|\ForgetName[Charlie]{Chaplin}\\ +% |\CheckChuck|\hfill\CheckChuck\\[2ex] +% We ``subvert'' the name control sequence in the unformatted section, as if the name has occurred, and switch back to the main section: +% |\SubvertName[Charlie]{Chaplin}|\SubvertName[Charlie]{Chaplin}\\ +% |\NamesActive|\NamesActive\\ +% |\CheckChuck|\hfill\CheckChuck\\[2ex] +% We forget the formatted name and reset the default behavior:\\ +% |\ForgetName[Charlie]{Chaplin}|\ForgetName[Charlie]{Chaplin}\\ +% |\GlobalNames|\GlobalNames\\ +% |\CheckChuck|\hfill\CheckChuck\\[2ex] +% Finally, we forget everything:\\ +% |\ForgetName[Charlie]{Chaplin}|\ForgetName[Charlie]{Chaplin}\\ +% |\CheckChuck|\hfill\CheckChuck\\[2ex] % \end{quote} % -% Notice that ``Jean the Fearless'' receives no special formatting. This is intentional, as it reflects the idea of formatting only those names with main index entries. Nevertheless, the reversing and capitalizing mechanisms do work with \cmd{\AKA}. The syntax for \cmd{\AKA} is: +% \subsection{Name Variant Macros} +% \subsubsection{\texttt{\textbackslash AKA}} +% \label{sec:AKA} % +% \DescribeMacro{\AKA} +% \DescribeMacro{\AKA*} +% \cmd{\AKA} (meaning \textit{also known as}) handles pseudonyms, stage names, \emph{noms de plume}, and so on in order to replace typing manual cross-references in the index. The syntax for \cmd{\AKA} is: % \begin{quote} % \cmd{\AKA}\oarg{FNN}\marg{SNN}\oarg{Alt. FNN}\marg{Alt. SNN}\oarg{Alt. names}\\ % \cmd{\AKA*}\oarg{FNN}\marg{SNN}\oarg{Alt. FNN}\marg{Alt. SNN}\oarg{Alt. names} @@ -1545,74 +1688,124 @@ Running "make install" installs the files in the local TeX tree. % % \noindent Only the \meta{FNN} and \meta{SNN} arguments from \cmd{\Name} and friends may be cross-referenced. The new syntax allows \cmd{\AKA} to cross-reference all name types. Both macros create a cross-reference in the index from the \meta{Alt. FNN}, \meta{Alt. SNN}, and \meta{Alt. names} fields to a name defined by \meta{FNN} and \meta{SNN}, regardless of whether that name has been used. % -% Both macros print only the \meta{Alt. FNN} and \meta{Alt. SNN} fields in the body text. If the \meta{Alt. names} field is present, \cmd{\AKA} swaps \meta{Alt. names} with \meta{Alt. FNN} in the body text. \cmd{\AKA*} just prints \meta{Alt. names} (if present) in the body text. See also Section~\ref{sec:TagName}.\clearpage +% Both macros print only the \meta{Alt. FNN} and \meta{Alt. SNN} fields in the body text. If the \meta{Alt. names} field is present, \cmd{\AKA} swaps \meta{Alt. names} with \meta{Alt. FNN} in the body text, similar to the naming macros. % -% For the following name types, \cmd{\AKA} and \cmd{\AKA*} yield the same results, using \Name[Bob]{Hope}, \ForgetName{Louis, XIV}\Name{Louis, XIV}, and \Name{Lao-tzu} as examples: +% \cmd{\AKA*} has two functions. For Western names, where \meta{Alt. FNN} is present, \cmd{\AKA*} prints either just the \meta{Alt. FNN} or just the \meta{Alt. names} when they also are present. However, if \meta{Alt. FNN} is absent, \cmd{\AKA*} prints just \meta{Alt. names} if present, otherwise \meta{Alt. SNN}. See also Section~\ref{sec:TagName}. % +% Here is a simple example with the default system of formatting: % \begin{quote}\small -% \begin{tabular}{ll}\hline -% {\large\strut}|\AKA[Bob]{Hope}[Leslie Townes]{Hope}| & \AKA[Bob]{Hope}[Leslie Townes]{Hope}\\ -% {\large\strut}|\AKA{Louis, XIV}{Sun King}| & \AKA{Louis, XIV}{Sun King}\\ -% {\large\strut}|\AKA{Lao-tzu}{Li, Er}| & \AKA{Lao-tzu}{Li, Er}\\\hline -% \end{tabular} +% |\Name{Jean, sans Peur}| |(\AKA{Jean,| |sans| |Peur}{Jean| |the| |Fearless})|\\ {\ttfamily was Duke of Burgundy 1404|--|1419.} +% +% \Name{Jean, sans Peur} (\AKA{Jean, sans Peur}{Jean the Fearless}) was Duke of Burgundy 1404--1419. +% \end{quote} +% ``Jean the Fearless'' intentionally receives no formatting because I intend that only names with main index entries be formatted. One could put \cmd{\AKA} within a formatting macro to make that otherwise. Still, the reversing and capitalizing mechanisms do work with \cmd{\AKA}. +% +% This complex example shows the Continental style with no default formatting: +% \begin{quote}\small +% |\PretagName[Heinz]{\textsc{Rühmann}}{Ruehmann, Heinz}%|\\ +% |\PretagName[Heinrich Wilhelm]{\textsc{Rühmann}}%|\\ +% | {Ruehmann, Heinrich Wilhelm}%|\\ +% |\SubvertName[Heinz]{\textsc{Rühmann}}%|\\ +% |\AKA*[Heinz]{\textsc{Rühmann}}%|\\ +% | [Heinrich Wilhelm]{\textsc{Rühmann}} %|\\ +% |``\FName[Heinz]{\textsc{Rühmann}}'' %|\\ +% |\Name[Heinz]{\textsc{Rühmann}} %|\\ +% \texttt{(7 March 1902|-||-|3 October 1994) was a German film actor who\break appeared in over 100 films between 1926 and 1993.}\\[1ex] +% \NamesInactive +% \SubvertName[Heinz]{\textsc{Rühmann}}% +% \AKA*[Heinz]{\textsc{Rühmann}}% +% [Heinrich Wilhelm]{\textsc{Rühmann}} % +% ``\FName[Heinz]{\textsc{Rühmann}}'' % +% \Name[Heinz]{\textsc{Rühmann}} % +% (7 March 1902--3 October 1994) was a German film actor who appeared in over 100 films between 1926 and 1993. +% \NamesActive % \end{quote} +% First I want ``\Name*[Heinz]{\textsc{Rühmann}}'' to be the main name of reference, so \cmd{\SubvertName} causes \cmd{\FName} to print the short version. +% Second, I use \cmd{\AKA*} to print only the forenames ``Heinrich Wilhelm'' in the body text. Nevertheless, the index cross-reference will be complete. +% Third, \cmd{\FName} prints ``\FName[Heinz]{\textsc{Rühmann}}.'' Finally, \cmd{\Name} prints \Name[Heinz]{\textsc{Rühmann}}. Of course I used \cmd{\PretagName} to sort the index entries. +% \clearpage +% +% Using \Name[Bob]{Hope}, \ForgetName{Louis, XIV}\Name{Louis, XIV}, \Name{Lao-tzu}, and \Name{Gregory, I} as examples, we see how \cmd{\AKA} and \cmd{\AKA*} work: % -% \cmd{\AKA} ignores the \meta{Alt. names} field with the names above. The \meta{Alt. names} field as part of the cross-reference was envisaged for names like \Name{Gregory, I}: % \begin{quote}\small % \begin{tabular}{ll}\hline +% {\large\strut}|\AKA[Bob]{Hope}[Leslie Townes]{Hope}| & \AKA[Bob]{Hope}[Leslie Townes]{Hope}\\ +% {\large\strut}|\AKA*[Bob]{Hope}[Leslie Townes]{Hope}| & \AKA*[Bob]{Hope}[Leslie Townes]{Hope}\\ +% {\large\strut}|\AKA[Bob]{Hope}%|\\| [Leslie Townes]{Hope}[Lester T.]| & \AKA[Bob]{Hope}[Leslie Townes]{Hope}[Lester T.]\\ +% {\large\strut}|\AKA*[Bob]{Hope}%|\\| [Leslie Townes]{Hope}[Lester T.]| & \AKA*[Bob]{Hope}[Leslie Townes]{Hope}[Lester T.]\\\hline +% {\large\strut}|\AKA{Louis, XIV}{Sun King}| & \AKA{Louis, XIV}{Sun King}\\ +% {\large\strut}|\AKA*{Louis, XIV}{Sun King}| & \AKA{Louis, XIV}{Sun King}\\ +% {\large\strut}|\AKA{Lao-tzu}{Li, Er}| & \AKA{Lao-tzu}{Li, Er}\\ +% {\large\strut}|\AKA*{Lao-tzu}{Li, Er}| & \AKA{Lao-tzu}{Li, Er}\\\hline % {\large\strut}|\AKA{Gregory, I}{Gregory}[the Great]| & \AKA{Gregory, I}{Gregory}[the Great]\\ % {\large\strut}|\AKA*{Gregory, I}{Gregory}[the Great]| & \AKA*{Gregory, I}{Gregory}[the Great]\\\hline % \end{tabular} % \end{quote} -% Using |\Name*{Gregory,| |I}| |``\AKA*{Gregory,| |I}{Gregory}[the| |Great]''| prints \Name*{Gregory, I} ``\AKA*{Gregory, I}{Gregory}[the Great]'' in the text. The index has a \emph{see} reference from ``Gregory the Great'' to ``Gregory I.'' -% -% A few points for \cmd{\AKA} and \cmd{\AKA*} follow: -% \begin{itemize} -% \item With \cmd{\AKA}, \oarg{FNN}\marg{SNN} is the main name. The cross-reference is \oarg{Alt. FNN}\marg{Alt. SNN}\oarg{Alt. names}. Please do not think that \meta{Alt. FNN} belongs to the main name or \cmd{\AKA} will fail. -% \item \cmd{\AKA} fails with the old syntax: |\AKA{Louis}[XIV]{Sun King}|. \cmd{\AKA} and \cmd{\AKA*} fail with the old form: |\AKA{Gregory}[I]{Gregory}[the Great]|. +% The alternate form ``Lester T. Hope'' does not appear in the index, but only in the body text to allow for variations. \Name*{Gregory, I} ``\AKA*{Gregory, I}{Gregory}[the Great]'' happens with\\[1ex] +% \indent\quad|\Name*{Gregory,| |I}| |``\AKA*{Gregory,| |I}{Gregory}[the| |Great]''|\\[1ex] +% The index has a \emph{see} reference from ``Gregory the Great'' to ``Gregory I.'' Some helpful tips for \cmd{\AKA} and \cmd{\AKA*} follow: +% \begin{itemize}\small +% \item \oarg{FNN}\marg{SNN} is the main name. \oarg{Alt. FNN}\marg{Alt. SNN}\oarg{Alt. names} is the cross-reference. Forgetting this may cause errors. +% \item The old syntax causes \cmd{\AKA} and \cmd{\AKA*} to fail: |\AKA{Louis}[XIV]{Sun King}| and |\AKA{Gregory}[I]{Gregory}[the Great]|. % \item The \meta{Alt. SNN} field uses comma-delimited suffixes. % \item The \meta{Alt. names} field does not use comma-delimited suffixes. -% \item Eastern names work: One can refer to \Name[Lafcadio]{Hearn} as \CapName\AKA[Lafcadio]{Hearn}{Koizumi, Yakumo}: |\CapName\AKA[Lafcadio]{Hearn}{Koizumi, Yakumo}|. +% \item Eastern names work as pseudonyms, with all that entails. One can refer to \Name[Lafcadio]{Hearn} as \CapName\AKA[Lafcadio]{Hearn}{Koizumi, Yakumo}:\\\hbox{}\qquad|\CapName\AKA[Lafcadio]{Hearn}{Koizumi, Yakumo}|. % \item Particles work: \CapThis\AKA[Charles]{du Fresne}{du Cange} is the alternate name for \Name[Charles]{du Fresne}, which is capitalized via \cmd{\CapThis}\cmd{\AKA}. See also Section~\ref{sec:Particles}. -% \item Reversing works, \emph{e.g.} \cmd{\RevComma}: \RevComma\AKA[Bob]{Hope}[Leslie Townes]{Hope}. -% \item The name fields of \cmd{\PretagName} correspond with the \oarg{Alt. FNN}\marg{Alt. SNN}\oarg{Alt. names} fields of \cmd{\AKA}: |\AKA{Vlad| |III,| |Dracula}{Vlad,| |Ţepeş}| corresponds with |\PretagName{Vlad,| |Ţepeş}{Vlad| |Tepes}|. It fails with |\PretagName{Vlad}[Ţepeş]{Vlad| |Tepes}|. +% \item Reversing works, \emph{e.g.},\\\hbox{}\qquad \cmd{\RevComma}: \RevComma\AKA[Bob]{Hope}[Leslie Townes]{Hope}\\\hbox{}\qquad \cmd{\RevName}: \RevName\CapName\AKA[Lafcadio]{Hearn}{Koizumi, Yakumo} +% \item The name fields of \cmd{\PretagName} correspond with the \oarg{Alt. FNN}\marg{Alt. SNN}\oarg{Alt. names} fields of \cmd{\AKA}:\\[1ex]\hbox{}\qquad |\AKA{Vlad| |III,| |Dracula}{Vlad,| |Ţepeş}| matches\\\hbox{}\qquad |\PretagName{Vlad,| |Ţepeş}{Vlad| |Tepes}|\\[1ex] This form does not match: |\PretagName{Vlad}[Ţepeş]{Vlad| |Tepes}|. +% \item With stage names like \Name[The Amazing]{Kreskin}, if you want them in the index, use |\Name[The Amazing]{Kreskin}| to get ``Kreskin, The Amazing.'' \IndexInactive Otherwise use something like |\Name[J.]{Kreskin}[The Amazing]| to get \Name[J.]{Kreskin}[The Amazing] in the text and ``Kreskin, J.'' in the index.\\[1ex] Using \cmd{\AKA} with such names looks like: |\AKA[The Amazing]{Kreskin}| |[Joseph]{Kresge}| and |\AKA[J.]{Kreskin}[Joseph]{Kresge}|.\IndexActive You get \Name*[The Amazing]{Kreskin}, a.k.a. \AKA[The Amazing]{Kreskin}[Joseph]{Kresge}. +% \item Special cases like ``Iron Mike'' Tyson as the nickname for \Name[Mike]{Tyson} may be handled in a number of ways. +% \begin{enumerate}\small +% \item Follow |``Iron Mike''| with |\IndexName[Mike]{Tyson}| and do whatever you want in the text. This may be the easiest solution. +% \item Use |``\AKA[Mike]{Tyson}{Iron Mike}''| to create ``\AKA[Mike]{Tyson}{Iron Mike}'' in the text and a \emph{see}-type cross-reference to ``Tyson, Mike'' in the index. Be sure to have an occurrence of |\Name[Mike]{Tyson}| in the text. See also Section~\ref{sec:AKA}. This is the best solution in terms of how \textsf{nameauth} is designed. +% \item Always get ``Iron Mike Tyson'' with something like:\\[1ex] +% |\newcommand*{\Iron}{\SubvertName[Mike]{Tyson}%|\\ +% |\FName[Mike]{Tyson}[Iron Mike] \Name[Mike]{Tyson}}|\\[1ex] +% \newcommand*{\Iron}{\SubvertName[Mike]{Tyson}\FName[Mike]{Tyson}[Iron Mike] \Name[Mike]{Tyson}} +% |``\Iron''| gives you ``\Iron.''\footnote{In typesetting this manual I defined the macro \cmd{\Iron} and others like it on one continuous line because defining a macro over multiple lines with comment characters ending them in \textsf{ltxdoc} and a \texttt{.dtx} file caused extra spaces to be inserted.} You are responsible for typesetting the first use and creating a cross-reference. This solution runs somewhat contrary to the design principles of \textsf{nameauth}, but it may be helpful if you want the invariant name ``\Iron'' to recur and you want to save typing. +% \end{enumerate} % \end{itemize} % % \cmd{\AKA} will not create multiple cross-references. Handle the special case where one moniker applies to multiple people with a manual solution, \emph{e.g.}, ``Snellius'' for both \Name*[Willebrord]{Snel van Royen} and his son \Name*[Rudolph]{Snel van Royen}: -% -%\begin{quote}\footnotesize -% |\index{Snellius|\verb!|!{}|see{Snel|\,|van|\,|Royen,|\,|Rudolph;| |Snel|\,|van|\,|Royen,|\,|Willebrord}}| +%\begin{quote} +% |\index{Snellius|\verb!|!{}|see{Snel|\,|van|\,|Royen,|\,|Rudolph;%|\\ |Snel|\,|van|\,|Royen,|\,|Willebrord}}| % \index{Snellius|see{Snel van Royen, Rudolph;% % Snel van Royen, Willebrord}} %\end{quote} % -% Cross-references generated by \cmd{\AKA} and \cmd{\AKA*} are meant only to be \emph{see} references, never page entries. See also Section~\ref{sec:error}. In certain cases, the alternate name might need to be indexed with page numbers and \emph{see also} references. Do not use \cmd{\AKA} in those cases, rather, consider the following:\clearpage +% Cross-references generated by \cmd{\AKA} and \cmd{\AKA*} are meant only to be \emph{see} references, never page entries. See also Section~\ref{sec:error}. In certain cases, the alternate name might need to be indexed with page numbers and \emph{see also} references. Do not use \cmd{\AKA} in those cases, rather, consider the following: % % \label{manualxref}\label{Rambam}% -%\begin{itemize} +%\begin{itemize}\small % \item Refer to the person intended, \emph{e.g.}, \Name{Maimonides} (\AKA{Maimonides}{Moses ben-Maimon}):\\ |\Name{Maimonides}| |(\AKA{Maimonides}{Moses| |ben-Maimon})| % \item We now have a name and a \emph{see} reference. Now one must refer to the alternate name, \emph{e.g.}, \Name{Rambam}: |\Name{Rambam}|. % \item The alternate name must occur before making a cross-reference to the main name, in this case, \Name{Maimonides}. % \item Add \verb!\index{Rambam|seealso{Maimonides}}! at the end of the document to ensure that it is the last entry among the cross-references. Generally, \emph{see also} references follow \emph{see} references in an index entry.\footnote{Different standards exist for punctuating index entries and cross-references. Check with your publisher, style guide, docs for \textsf{xindy} and \textsf{makeindex}, and \textsf{http://tex.stackexchange.com}.} %\end{itemize} +% \clearpage % -% Even with the new syntax, using \textsf{makeindex} may require some manual entries: +% Using \cmd{\PretagName} helps avoid the need for manual index entries. Instead of doing a lot of extra work for some names, consider the following example: % -% \begin{quote}\small -% {\ttfamily\footnotesize|\index{Doctor Angelicus@\textit{Doctor Angelicus}%|\\ -% \verb+|see{Thomas Aquinas}}%+\\ -% \verb+\index{Thomas of Aquino|see{Thomas Aquinas}}%+\\ -% Perhaps the greatest medieval theologian was |\Name{Thomas, Aquinas}|\break -% (Thomas of Aquino), also known as |\textit{Doctor Angelicus}|. ``Aquinas'' is not a surname.} -% -% \index{Doctor Angelicus=\textit{Doctor Angelicus}% -% |see{Thomas Aquinas}}% -% \index{Thomas of Aquino|see{Thomas Aquinas}}% -% Perhaps the greatest medieval theologian was% -% \Name{Thomas, Aquinas} (Thomas of Aquino), also known as% -% \textit{Doctor Angelicus}. ``Aquinas'' is not a surname. +% \begin{quote} +% {\ttfamily% +% |\PretagName{\textit{Doctor Angelicus}}%|\\ +% | {Doctor Angelicus}%|\\ +% |Perhaps the greatest medieval theologian was|\\ +% |\Name{Thomas, Aquinas}|\\ +% |(\AKA{Thomas, Aquinas}{Thomas of Aquino})|,\\ +% also known as\\ +% |\AKA{Thomas, Aquinas}{\textit{Doctor Angelicus}}|.} +% +% \PretagName{\textit{Doctor Angelicus}}% +% {Doctor Angelicus}% +% Perhaps the greatest medieval theologian was +% \Name{Thomas, Aquinas} +% (\AKA{Thomas, Aquinas}{Thomas of Aquino}), +% also known as +% \AKA{Thomas, Aquinas}{\textit{Doctor Angelicus}}. % \end{quote} -% +% We use the medieval form: |\Name{Thomas, Aquinas}| because ``Aquinas'' is not a surname. Section~\ref{sec:standards} talks about those unfortunate situations where one must use the Western form |\Name[Thomas]{Aquinas}.| +% % \subsubsection{\texttt{\textbackslash PName}} % % \DescribeMacro{\PName} @@ -1621,34 +1814,93 @@ Running "make install" installs the files in the local TeX tree. % \cmd{\PName}\oarg{FNN}\marg{SNN}\oarg{other FNN}\marg{other SNN}\oarg{other alt.} % \end{quote} % -% Although \cmd{\PName} creates an easy shortcut, its drawbacks are many. It only can use the \meta{FNN}\meta{SNN} form of \cmd{\AKA}. It cannot use \cmd{\AKA*}. \cmd{\PName} really is ill-suited to work with \cmd{\CapName}, \cmd{\CapThis}, \cmd{\RevComma}, \cmd{\RevName}, and the related package options. Use it as needed, and \emph{caveat auctor}. +% Although \cmd{\PName} creates an easy shortcut, its drawbacks are many. It only can use the \meta{FNN}\meta{SNN} form of \cmd{\AKA}. Neither \cmd{\AKA*}, nor \cmd{\CapName}, \cmd{\CapThis}, \cmd{\RevComma}, \cmd{\RevName}, and the related package options work with \cmd{\PName.} % -% The author determines the name that is indexed (the first name) and the subsequent name that only occurs as a \emph{see} reference. That subsequent name is never shortened in the text. To do that, using the table below, one would type, \emph{e.g.}, |Arouet\IndexName{Voltaire}| or use the \Name{Rambam} example above. \cmd{\PName} can generate the following examples:\medskip +% The main name comes first, followed by the name that is only a \emph{see} reference. \cmd{\PName} can generate the following examples: +% +% \begin{quote}\small +% |\PName[Mark]{Twain}[Samuel L.]{Clemens}|\\\hbox{}\hfill \PName[Mark]{Twain}[Samuel L.]{Clemens}\\[1ex] +% |\PName*[Mark]{Twain}[Samuel L.]{Clemens}|\\\hbox{}\hfill \PName*[Mark]{Twain}[Samuel L.]{Clemens}\\[1ex] +% |\PName[Mark]{Twain}[Samuel L.]{Clemens}|\\\hbox{}\hfill \PName[Mark]{Twain}[Samuel L.]{Clemens}\\[2ex] +% |\PName{Voltaire}[François-Marie]{Arouet}|\\\hbox{}\hfill \PName{Voltaire}[François-Marie]{Arouet}\\[1ex] +% |\PName*{Voltaire}[François-Marie]{Arouet}|\\\hbox{}\hfill \PName*{Voltaire}[François-Marie]{Arouet}\\[1ex] +% |\PName{Voltaire}[François-Marie]{Arouet}|\\\hbox{}\hfill \PName{Voltaire}[François-Marie]{Arouet} +% \end{quote} % -% {\footnotesize% -% \begin{tabular}{p{0.55\textwidth}@{}p{0.37\textwidth}}\hline -% {\large\strut}|\PName[Mark]{Twain}[Samuel L.]{Clemens}| & \PName[Mark]{Twain}[Samuel L.]{Clemens}\\ -% {\large\strut}|\PName*[Mark]{Twain}[Samuel L.]{Clemens}| & \PName*[Mark]{Twain}[Samuel L.]{Clemens}\\ -% {\large\strut}|\PName[Mark]{Twain}[Samuel L.]{Clemens}| & \PName[Mark]{Twain}[Samuel L.]{Clemens}\\\hline -% {\large\strut}|\PName{Voltaire}[François-Marie]{Arouet}| & \PName{Voltaire}[François-Marie]{Arouet}\\ -% {\large\strut}|\PName*{Voltaire}[François-Marie]{Arouet}| & \PName*{Voltaire}[François-Marie]{Arouet}\\ -% {\large\strut}|\PName{Voltaire}[François-Marie]{Arouet}| & \PName{Voltaire}[François-Marie]{Arouet}\\\hline -% \end{tabular}}\\ +% \cmd{\PName} can be a bit sketchy with medieval names. You get \PName{William, I}{William, the Conqueror} with |\PName{William,| |I}{William,| |the Conqueror}.| Stay away from |\PName{William, I}{William}[the Conqueror]| because that is the old syntax that can break both \cmd{\AKA} and \cmd{\PName} if used in the leading arguments instead of in the trailing arguments. The old syntax can get you confused and lead you to type |\PName{William, I}[William]{the Conqueror}.| You would get a name that looked right in the body text but wrong in the index. % -% If one used |\PName{William, I}[William]{the Conqueror}| the body text would look right but the index cross-reference would be in error. Medieval and Eastern names are not suited for \cmd{\PName}. For them use \cmd{\AKA.}\clearpage +% Something like |\PName{Lao-tzu}{Li, Er}| ``\PName{Lao-tzu}{Li, Er}'' works well enough, but |\PName{Gregory, I}{Gregory}[the Great]|\ForgetName{Gregory, I} ``\PName{Gregory, I}{Gregory}[the Great]'' starts moving close to the old syntax. % % \subsection{Indexing Macros} +% +% \subsubsection{Indexing Control} +% \label{sec:SectionIndex} +% +% \DescribeMacro{\IndexActive} +% \DescribeMacro{\IndexInactive} +% Using the \texttt{noindex} option deactivates the indexing function of this package until \cmd{\IndexActive} occurs. Another macro, \cmd{\IndexInactive}, will deactivate indexing again. These can be used throughout the document, independently of \cmd{\ExcludeName}. They are global in scope, as are the other toggle macros in this package, so one must be explicit in turning indexing on and off.\medskip +% +% \noindent\textbf{You cannot use index tags if the \textsf{nameauth} indexing feature is inactive.} +% +% \subsubsection{Indexing and \textsf{babel}} +% \label{sec:babel} +% Using\marginpar{\small\raggedleft \textsf{texindy}} \textsf{babel} with Roman page numbers will put \cmd{\textlatin} in the index entries if one includes a language that does not use the Latin alphabet\,---\,even if the main language does. The \texttt{texindy} program will ignore such references. This issue can affect \textsf{nameauth.} +% +% One workaround for \texttt{texindy} redefines \cmd{\textlatin} to produce the page number itself within a certain scope like: +% \begin{quote} +% |\newcommand{\fixindex}[1]{\def\textlatin##1{##1}#1}| +% \end{quote} +% This solution has proven quite effective for me. One need only type +% \begin{quote} +% |\fixindex{%|\\ +% \meta{paragraphs of running text}|%|\\ +% |}| +% \end{quote} +% Of course, one can opt to check if \cmd{\textlatin} is defined, save its value, redefine it, then restore it, perhaps even in an environment. +% % \subsubsection{\texttt{\textbackslash IndexName}} % % \DescribeMacro{\IndexName} -% This macro creates an index entry like those created by \cmd{\Name} and friends. It prints no text in the body and permits no special formatting. The syntax is: +% This macro creates an index entry like those created by \cmd{\Name} and friends. It prints nothing in the body text. The syntax is: % \begin{quote} % \cmd{\IndexName}\oarg{FNN}\marg{SNN}\oarg{Alternate names} % \end{quote} % -% \cmd{\IndexName} complies with the new syntax. If \meta{FNN} are absent, it indexes \meta{Alternate names} as an affix using the old syntax; otherwise it ignores \meta{Alternate names}. If indexing is switched off (see Section~\ref{sec:SectionIndex}), this macro does nothing. It will not create index entries for names used with \cmd{\AKA} as cross-references. +% \cmd{\IndexName} complies with the new syntax, where a suffixed pair in \meta{SNN} is a name/affix pair that can be ancient or Eastern. If \meta{FNN} are present, it ignores \meta{Alternate names}. Otherwise, if \meta{FNN} are absent, \cmd{\IndexName} sees \meta{Alternate names} as an affix using the old syntax. +% +% After \cmd{\IndexInactive} this macro does nothing until \cmd{\IndexActive} appears. It will not create index entries for names used with \cmd{\AKA} as cross-references. % -% The indexing mechanism in the \textsf{nameauth} package follows \emph{Chicago Manual of Style} standards regarding Western names and affixes. Thus the name \LChes\ becomes ``Sullenberger, Chesley B., III'' in the index. This formatting only occurs for Western names (where \meta{FNN} are present). +% The indexing mechanism in the \textsf{nameauth} package follows \emph{Chicago Manual of Style} standards regarding Western names and affixes. Thus the name \LChes\ becomes ``Sullenberger, Chesley B., III'' in the index. Otherwise, if \meta{FNN} is absent, the comma would trigger ancient, medieval, and Eastern name forms in the index. +% +% \subsubsection{Index Sorting} +% \label{sec:IndexSort} +% +% The general practice for sorting with \texttt{makeindex -s} involves creating your own |.ist| file (pages 659--65 in \emph{The Latex Companion}). Otherwise use the following form that works with both \texttt{makeindex} and \texttt{texindy}: |\index{|\meta{sortkey}|@|\meta{actual}|}| +% +%Before version 2.0 of \textsf{nameauth}, one had to sort and index names like \Name[Jan]{Łukasiewicz} and \Name*{Æthelred, II} by putting them between \cmd{\IndexInactive} and \cmd{\IndexActive} while creating manual index entries.\medskip +% +% \DescribeMacro{\PretagName} +% Fortunately, the current versions of \textsf{nameauth} have adopted an easier solution. The syntax of \cmd{\PretagName} is like that of \cmd{\TagName}: +% \begin{quote} +% \cmd{\PretagName}\oarg{FNN}\marg{SNN}\oarg{Alternate names}\marg{tag} +% \end{quote} +% The \cmd{\PretagName} macro differs from the other tagging macros: +% \begin{itemize}\small +% \item You can ``pretag'' any name and any cross-reference. +% \item You can ``tag'' and ``untag'' only names, not cross-references. +% \item There is no command to undo a ``pretag.'' +% \end{itemize} +% \cmd{\PretagName} creates a sort key terminated with the ``actual'' character, which is |@| by default. Do not include the ``actual'' character in the pretag. +% Here is an example of its use: +% \begin{quote} +% |\PretagName[Jan]{Łukasiewicz}{Lukasiewicz, Jan}|\\ +% |\PretagName{Æthelred, II}{Aethelred 2}| +% \end{quote} +% +% One need only pretag names once in the preamble. Every time that one refers to \Name[Jan]{Łukasiewicz} or \Name{Æthelred, II}, the proper index entry will be created. If you create a cross-reference with \cmd{\AKA} and you want to pretag it, see Section~\ref{sec:AKA}.\medskip +% +% \DescribeMacro{\IndexActual} +% If you need to change the ``actual'' character, such as with \texttt{gind.ist}, put |\IndexActual{=}| in the preamble. % % \subsubsection{\texttt{\textbackslash TagName}} % \label{sec:TagName} @@ -1659,6 +1911,17 @@ Running "make install" installs the files in the local TeX tree. % \cmd{\TagName}\oarg{FNN}\marg{SNN}\oarg{Alternate names}\marg{tag} % \end{quote} % +% Tags are not ``pretags.'' To help sort that out, we look at what gets affected by these commands:\medskip +% +% \begin{tabular}{r@{\,\vrule width0.5pt\,}c@{\,\vrule width0.5pt\,}c@{\,\vrule width0.5pt\,}l} +% & \cmd{\PretagName} & \\ +% |\index{| & |Aethelred 2@| & |Æthelred II| & |, king}|\\ +% & & & \cmd{\TagName} and \cmd{\UntagName}\\ +% \end{tabular}\medskip +% +% All the tagging commands use the name arguments as a reference point. \cmd{\PretagName} generates the leading sort key while \cmd{\TagName} and \cmd{\UntagName} affect the trailing content of the index entry. +% \clearpage +% % Tags created by \cmd{\TagName} can be helpful in the indexes of history texts. Several features of this package are designed for historical research. Suppose you are working with medieval subject matter. The following macros come in handy: % \begin{quote}\small % \begin{tabular}{p{0.5\textwidth}p{0.28\textwidth}} @@ -1706,25 +1969,31 @@ Running "make install" installs the files in the local TeX tree. % % The tweaking macros \cmd{\ForgetName} and \cmd{\SubvertName} make it seem like you are dealing with three people who have the same name. The index tags will group together those entries with the same tag.\footnote{Since this document, unlike the example above, puts an asterisk by all fictional names in the index, it puts an asterisk at the beginning of the tags above and does not \cmd{\UntagName} \Name*[John]{Smith}, but retags him with an asterisk again.} % -% Please remember to note the differences between \cmd{\TagName} and \cmd{\UntagName} on the one hand and \cmd{\PretagName} on the other. See Section~\ref{sec:IndexSort}. -% % \subsubsection{Global Name Exclusion} % % \DescribeMacro{\ExcludeName} +% \label{sec:exclude} % This macro globally prevents the indexing of a particular name or cross-reference. If you do not use it at the beginning of the document, you may not exclude any name or cross-reference that has been used already. The syntax is: % \begin{quote} % \cmd{\ExcludeName}\oarg{FNN}\marg{SNN}\oarg{Alternate names} % \end{quote} % -% For example, |\ExcludeName[Kris]{Kringle}|\ExcludeName[Kris]{Kringle} will permit \Name[Kris]{Kringle} and \Name[Kris]{Kringle} to appear in the body text via |\Name[Kris]{Kringle}|, but no index entry can occur for this name. -% |\ExcludeName[Santa]{Claus}|\ExcludeName[Santa]{Claus} will prevent |\AKA[Kris]{Kringle}[Santa]{Claus}| \AKA[Kris]{Kringle}[Santa]{Claus} from generating a cross-reference in the index. Instead of the global \cmd{\ExcludeName}, it is likelier that you would enclose \cmd{\Name}, etc. between \cmd{\IndexInactive} and \cmd{\IndexActive}.\clearpage +% You will see excluded names printed in the body text with all the formatting and other features: +% \begin{quote} +% |\ExcludeName[Kris]{Kringle}|\ExcludeName[Kris]{Kringle}\\ +% |\Name[Kris]{Kringle}| and |\Name[Kris]{Kringle}|:\\ +% \Name[Kris]{Kringle} and \Name[Kris]{Kringle}. +% \end{quote} +% Nevertheless, no matter how many times you use \Name[Kris]{Kringle} in the body text, the name will never appear in the index. Remember the \Name{Grinch} from Section~\ref{sec:tests}? He will not appear in the index either. % -% \subsubsection{Indexing Control} -% \label{sec:SectionIndex} +% \cmd{\ExcludeName} also prevents cross-references. You may see output in the body text, but no \emph{see}-reference will appear in the index: +% \begin{quote} +% |\ExcludeName[Santa]{Claus}|\ExcludeName[Santa]{Claus}\\ +% |\AKA[Kris]{Kringle}[Santa]{Claus}| \AKA[Kris]{Kringle}[Santa]{Claus} +% \end{quote} % -% \DescribeMacro{\IndexActive} -% \DescribeMacro{\IndexInactive} -% Using the \texttt{noindex} option deactivates the indexing function of this package until \cmd{\IndexActive} occurs. Another macro, \cmd{\IndexInactive}, will deactivate indexing again. These can be used throughout the document, independently of \cmd{\ExcludeName}. They are global in scope, as are the other toggle macros in this package, so one must be explicit in turning indexing on and off. +% Instead of using \cmd{\ExcludeName}, which basically prevents the indexing mechanism of the naming macros from doing anything with a particular name, it is far likelier that you would use the index control macros (Section~\ref{sec:SectionIndex}). +% \clearpage % % \subsection{Variant Spellings} % @@ -1748,7 +2017,7 @@ Running "make install" installs the files in the local TeX tree. % % If you wanted to index the variants under only one name entry, it gets more complicated. You could do the following: % -% \begin{enumerate}\setlength{\itemsep}{0pt} +% \begin{enumerate}\small % \item Use |\ForgetName[W.E.B.]{Du Bois}| at the start of the section. % \item Wrap \cmd{\AltDuBois} between \cmd{\IndexInactive} and \cmd{\IndexActive}. % \item Call \cmd{\IndexName} with the authoritative form right after \cmd{\IndexActive}. @@ -1855,7 +2124,7 @@ Running "make install" installs the files in the local TeX tree. % \clearpage % % \noindent{\bfseries Old Syntax: Royal and Eastern}\\[2ex] -% Avoid these forms except with the |comma| option. |\Name{Ptolemy}[I Soter]| keeps the number with the affix. Use |\Name{Ptolemy I}[Soter]| to keep the number with the name. See also Section~\ref{sec:Affix}.\\[2ex]{\small +% Avoid these forms except with the \texttt{comma} option. |\Name{Ptolemy}[I Soter]| keeps the number with the affix. Use |\Name{Ptolemy I}[Soter]| to keep the number with the name. See also Section~\ref{sec:Affix}.\\[2ex]{\small % \begin{tabular}{p{0.53\textwidth}@{}p{0.42\textwidth}}\hline{\large\strut} % \textit{First reference}: \ForgetName{Henry}[VIII]\Name{Henry}[VIII] & |\Name*{Henry}[VIII]|\newline |\Name{Henry}[VIII]|\newline |\FName{Henry}[VIII]|\\[1ex]{\large\strut} % \textit{Subsequent full}: \Name*{Henry}[VIII] & |\Name*{Henry}[VIII]|\\[1ex]{\large\strut} @@ -1887,7 +2156,7 @@ Running "make install" installs the files in the local TeX tree. % % Avoid mixing old and new syntax. In the body text, |\Name{Antiochus, IV}| and |\Name{Antiochus,| |IV}[Epiphanes]| look alike, but their index entries differ. % -% \begin{itemize} +% \begin{itemize}\small % \item Use |\Name{Antiochus, IV Epiphanes}| to get \IndexInactive\Name{Antiochus, IV Epiphanes} and \Name{Antiochus, IV Epiphanes} in the text and ``Antiochus IV Epiphanes'' in the index. % % \item Use |\Name{Antiochus~IV, Epiphanes}| to get \Name{Antiochus~IV, Epiphanes} and \Name{Antiochus~IV, Epiphanes} in the text and ``Antiochus IV Epiphanes'' in the index.\IndexActive @@ -1937,10 +2206,51 @@ Running "make install" installs the files in the local TeX tree. % |\Harnack[Adolf von]\| |and| |\Harnack|:\\ % \indent \Harnack[Adolf von]\ and \Harnack\\[1ex] % You will not see \Harnack's ``von'' in the index because it was used only in the alternate forenames field. +% \index{Maimonides|seealso{Rambam}} % \index{Rambam|seealso{Maimonides}} % \clearpage % -%\StopEventually{^^A +% \subsection{Errors and Warnings} +% \label{sec:error} +% +% Here are some ways to avoid common errors: +% +% \begin{itemize}\small +% \item Keep it simple! Avoid unneeded macros and use the simplified interface. +% \item Check braces and brackets with naming macros to avoid errors like ``Paragraph ended\dots'' and ``Missing \meta{grouping token} inserted.'' +% \item Do not apply a formatting macro to an entire comma-delimited \meta{SNN, affix} pair. |\Name[Oskar]{\textsc{Hammerstein, II}}| fails due to unbalanced braces because it gets split up. Format each part instead \emph{e.g.}, |\Name[Oskar]{\textsc{Hammerstein},\textsc{II}}.|\IndexName[Oskar]{Hammerstein, II} +% \item With \texttt{pdflatex} use \cmd{\CapThis} when the first letter of a surname particle is \texttt{a--z}, otherwise use \cmd{\AccentCapThis} if it is extended Unicode. Doing otherwise may cause unbalanced braces and related errors. +% \item Consider using \cmd{\PretagName} with all names containing control sequences or extended Unicode; see Section~\ref{sec:IndexSort}. +% \item One way to spot errors is to compare index entries with names in the body text. All macros that produce output also emit meaningful warnings. \cmd{\PName} produces warnings via \cmd{\Name} and \cmd{\AKA}. +% \item Please pay greater attention to the warnings produced by \cmd{\IndexName}, \cmd{\TagName}, \cmd{\UntagName}, and \cmd{\ExcludeName}. Many other warnings are FYI. +% \end{itemize} +% The older syntax presents its own group of potential errors: +% \begin{itemize}\small\IndexInactive +% \item Erroneously typing |\Name[Henry]{VIII}| prints ``\Name*[Henry]{VIII}'' and ``\Name[Henry]{VIII},'' as well as producing a malformed index entry. +% \item Avoid forms like |\Name[Henry]{VIII}[Tudor]| which gives ``\Name*[Henry]{VIII}[Tudor]'' and ``\Name[Henry]{VIII}[Tudor].'' This is a Western name form, not an ancient form. It may act as malformed input if you mix it with proper medieval name forms, but it will not affect them adversely. +% \item The older syntax will not work with some macros. From the film \emph{Men in Black III}, |\AKA{Boris}[the Animal]{Just Boris}| fails. \cmd{\PName} fails for the same reasons. See also Section~\ref{sec:AKA} +% \item This form does work:\\ |\Name{Boris,| |the| |Animal}| |\AKA{Boris,| |the| |Animal}{Just| |Boris}|.\\ You get \Name{Boris, the Animal} being ``\AKA{Boris, the Animal}{Just Boris}.''\IndexActive +% \end{itemize} +% Warnings result from the following: +% \begin{itemize}\small +% \item Using a cross-reference \oarg{Alternate names}\marg{Alternate SNN}\oarg{Alt. names} created by \cmd{\AKA} as a name reference in \cmd{\Name}, \cmd{\FName}, and \cmd{\PName}. They merely will print a name in the body text. +% \item Using a name reference \oarg{FNN}\marg{SNN}\oarg{Alternate names} created by \cmd{\Name}, \cmd{\FName}, and \cmd{\PName} as a cross-reference in \cmd{\AKA}. It merely will print a name in the body text. +% \item Using \cmd{\AKA} to create the same cross-reference multiple times or with a cross-reference created by \cmd{\ExcludeName}. It merely will print a name in the body text, but not the index. +% \item Using \cmd{\IndexName} to index a cross-reference made via \cmd{\AKA} or via the mechanism in \cmd{\ExcludeName} as a main entry. It will do nothing. +% \item Using \cmd{\TagName}, \cmd{\UntagName}, and \cmd{\PretagName} with cross-references. The first two will do nothing. However, \cmd{\PretagName} will ``pretag'' a cross-reference. This is the desired behavior. +% \item Using \cmd{\ExcludeName} with cross-references. It will do nothing. +% \item Using \cmd{\ExcludeName} to exclude a name that has already been used. Likewise, it will do nothing. +% \item Using \cmd{\Name}, \cmd{\FName}, \cmd{\PName}, and \cmd{\AKA} to refer to names and cross-references excluded by \cmd{\ExcludeName}. They merely will print a name in the body text. +% \item Using the |nameauth| environment to redefine shorthands, such as:\\[2ex] +% |\PretagName[E.\,B.]{White}{White, E. B.}|\dots\\[1ex] +% |\begin{nameauth}|\\\IndexName[E.\,B.]{White} +% | \< White & E.\,B. & White & >|\\ +% | \< White & E. B. & White & >|\\ +% |\end{nameauth}|\\[1ex] +% Such redefinitions could generate unwanted index entries. +% \end{itemize} +% +% \clearpage%\StopEventually{^^A % \clearpage\PrintChanges % \clearpage\PrintIndex %} @@ -1953,18 +2263,22 @@ Running "make install" installs the files in the local TeX tree. % \small % \subsection{Boolean Values} % \noindent{\large\bfseries Affix Commas}\\[.5ex] -% The |comma| and |nocomma| options toggle the first value below, while \cmd{\ShowComma} toggles the second. Each instance of \cmd{\Name} and \cmd{\AKA} reset |@nameauth@ShowComma|. +% The \texttt{comma} and |nocomma| options toggle the first value below, while \cmd{\ShowComma} toggles the second. Each instance of \cmd{\Name} and \cmd{\AKA} reset |@nameauth@ShowComma|. % \begin{macrocode} \newif\if@nameauth@AlwaysComma \newif\if@nameauth@ShowComma % \end{macrocode}\medskip % \noindent{\large\bfseries Toggle Formatting}\\[.5ex] -% This value is toggled with \cmd{\NamesActive} and \cmd{\NamesInactive} or the |mainmatter| and |frontmatter| options. +% \cmd{\NamesActive} and \cmd{\NamesInactive} or the |mainmatter| and |frontmatter| options set this value below. % \begin{macrocode} \newif\if@nameauth@DoFormat +% \end{macrocode} +% The next value works with \cmd{\LocalNames} and \cmd{\GlobalNames}. +% \begin{macrocode} +\newif\if@nameauth@LocalNames % \end{macrocode}\medskip % \noindent{\large\bfseries Indexing}\\[.5ex] -% \cmd{\IndexActive} and \cmd{\IndexInctive}, with the |index| and |noindex| options, toggle the value below. +% \cmd{\IndexActive} and \cmd{\IndexInctive} or the |index| and |noindex| options set this below: % \begin{macrocode} \newif\if@nameauth@DoIndex % \end{macrocode} @@ -2011,23 +2325,30 @@ Running "make install" installs the files in the local TeX tree. % \end{macrocode} % \subsection{Hooks} % \begin{macro}{\NamesFormat} -% Change formatting of final complete name form in text. See Section~\ref{sec:formatting}. +% Change typographic formatting of final complete name form in text. See Section~\ref{sec:formatting}. % \begin{macrocode} \newcommand*{\NamesFormat}{} % \end{macrocode} % \end{macro} % \begin{macro}{\NameauthName} % \changes{v2.2}{2015/12/01}{Added} -% Hook into the simplified interface. See Section~\ref{sec:formatting}. +% Hook to create custom naming macros. Usually these three macros have the same control sequence, but they need not do so if you want something different. See Section~\ref{sec:formatting}. % \begin{macrocode} -\newcommand*{\NameauthName}{\Name} +\newcommand*{\NameauthName}{\@nameauth@Name} +% \end{macrocode} +% \end{macro} +% \begin{macro}{\NameauthLName} +% \changes{v2.3}{2016/01/05}{Added} +% Hook to create custom naming macros. Called after |@nameauth@FullName| is set true. See Section~\ref{sec:formatting}. +% \begin{macrocode} +\newcommand*{\NameauthLName}{\@nameauth@Name} % \end{macrocode} % \end{macro} % \begin{macro}{\NameauthFName} % \changes{v2.2}{2015/12/01}{Added} -% Hook into the simplified interface. See Section~\ref{sec:formatting}. +% Hook to create custom naming macros. Called after |@nameauth@FirstName| is set true. See Section~\ref{sec:formatting}. % \begin{macrocode} -\newcommand*{\NameauthFName}{\FName} +\newcommand*{\NameauthFName}{\@nameauth@Name} % \end{macrocode} % \end{macro} % \subsection{Package Options} @@ -2064,23 +2385,23 @@ Running "make install" installs the files in the local TeX tree. smallcaps} \ProcessOptions\relax % \end{macrocode} +% \clearpage\noindent % 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{ifluatex} \RequirePackage{ifxetex} -\RequirePackage{suffix} \RequirePackage{trimspaces} +\RequirePackage{suffix} \RequirePackage{xargs} % \end{macrocode} % This macro determines the ``actual'' character for index sorting. % \begin{macrocode} \newcommand*\@nameauth@Actual{@} % \end{macrocode} -% \clearpage % \subsection{Internal Macros} % \begin{macro}{\@nameauth@Clean} -% Thanks to \Name*[Heiko]{Oberdiek}, this macro produces a ``sanitized'' string, even using accented characters, based on the parameters of \cmd{\Name} and friends. With this we can construct a control sequence name and test for it to determine the existence of pseudonyms and the first or subsequent occurrences of a name. +% Thanks to \Name*[Heiko]{Oberdiek}, this macro produces a ``sanitized'' string, even using accented characters, based on the arguments of \cmd{\Name} and friends. With this we can construct a control sequence name and test for it to determine the existence of pseudonyms and the first or subsequent occurrences of a name. % \begin{macrocode} \newcommand*{\@nameauth@Clean}[1]% {\expandafter\zap@space\detokenize{#1} \@empty} @@ -2089,7 +2410,7 @@ Running "make install" installs the files in the local TeX tree. % % \begin{macro}{\@nameauth@Root} % \changes{v1.4}{2012/07/24}{Made more robust} -% The following two macros parse \meta{SNN} into a radix and a comma-delimited suffix, returning only the radix. They (and their parameters) are expandable in order to facilitate proper indexing functionality. They form the kernel of the suffix removal and comma suppression features. +% The following two macros parse \meta{SNN} into a radix and a comma-delimited suffix, returning only the radix. They (and their arguments) are expandable in order to facilitate proper indexing functionality. They form the kernel of the suffix removal and comma suppression features. % \begin{macrocode} \newcommand*{\@nameauth@Root}[1]% {\@nameauth@TrimRoot#1,\@empty\relax} @@ -2128,20 +2449,19 @@ Running "make install" installs the files in the local TeX tree. } % \end{macrocode} % \end{macro} -% +% \clearpage % \begin{macro}{\@nameauth@CRii} % \changes{v0.95}{2012/02/17}{Added} % \changes{v1.26}{2012/04/24}{Fixed} -% Grab the first letter as one parameter, and everything before \cmd{\relax} as the second. Capitalize the first and return it with the second. +% Grab the first letter as one argument, and everything before \cmd{\relax} as the second. Capitalize the first and return it with the second. % \begin{macrocode} \def\@nameauth@CRii#1#2\relax{\uppercase{#1}\@nameauth@Root{#2}} % \end{macrocode} % \end{macro} % -% % \begin{macro}{\@nameauth@CRiii} % \changes{v2.1}{2015/11/24}{added} -% This is called in \texttt{pdflatex} under \textsf{inputenc} where an accented Unicode character takes the first two parameters. Grab the first ``letter'' as two parameters and cap it, then everything before \cmd{\relax} as the third. Capitalize the first and return it with the second. +% This is called in \texttt{pdflatex} under \textsf{inputenc} where an accented Unicode character takes the first two arguments. Grab the first ``letter'' as two arguments and cap it, then everything before \cmd{\relax} as the third. Capitalize the first and return it with the second. % \begin{macrocode} \def\@nameauth@CRiii#1#2#3\relax{\uppercase{#1#2}\@nameauth@Root{#3}} % \end{macrocode} @@ -2155,10 +2475,10 @@ Running "make install" installs the files in the local TeX tree. {\uppercase{\@nameauth@Root{#1}}} % \end{macrocode} % \end{macro} -% \clearpage +% % \begin{macro}{\@nameauth@Suffix} % \changes{v0.9}{2012/02/10}{Added} -% The following two macros parse \meta{SNN} into a radix and a comma-delimited suffix, returning only the suffix. Anything before a comma is stripped off by |\@nameauth@Suffix|, but a comma must be present in the parameter. Leading spaces are removed to allow consistent formatting. +% The following two macros parse \meta{SNN} into a radix and a comma-delimited suffix, returning only the suffix. Anything before a comma is stripped off by |\@nameauth@Suffix|, but a comma must be present in the argument. Leading spaces are removed to allow consistent formatting. % \begin{macrocode} \newcommand*{\@nameauth@Suffix}[1]% {\@nameauth@TrimSuffix#1\relax} @@ -2175,7 +2495,7 @@ Running "make install" installs the files in the local TeX tree. % \end{macro} % % \begin{macro}{\@nameauth@TestDot} -% This macro, based on a snippet by \Name*[Uwe]{Lueck}, checks for a period at the end of its parameter. It determines whether we need to call \cmd{\@nameauth@CheckDot} below. +% 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. % \begin{macrocode} \newcommand*{\@nameauth@TestDot}[1]% {% @@ -2203,7 +2523,7 @@ Running "make install" installs the files in the local TeX tree. {\let\@period=.\ifx\@token\@period\expandafter\@gobble \fi} % \end{macrocode} % \end{macro} -% +% \clearpage % \begin{macro}{\@nameauth@FmtName} % \changes{v0.85}{2012/02/05}{Add comma suppression} % \changes{v0.94}{2012/02/15}{Add particle caps} @@ -2227,7 +2547,6 @@ Running "make install" installs the files in the local TeX tree. } % \end{macrocode} % \end{macro} -% \clearpage % % \begin{macro}{\@nameauth@Index} % \changes{v0.94}{2012/02/15}{Added} @@ -2255,157 +2574,17 @@ Running "make install" installs the files in the local TeX tree. } % \end{macrocode} % \end{macro} -% \clearpage\noindent -% \subsection{User Interface Macros} -% \begin{macro}{\CapThis} -% \changes{v0.94}{2012/02/15}{Added} -% Tells the root capping macro to cap an unaccented character. -% \begin{macrocode} -\newcommand*{\CapThis}{\@nameauth@DoCapstrue} -% \end{macrocode} -% \end{macro} -% \begin{macro}{\AccentCapThis} -% \changes{v2.1}{2015/11/24}{Added} -% Tells the root capping macro to cap an accented Unicode character. -% \begin{macrocode} -\newcommand*{\AccentCapThis}{\@nameauth@Accenttrue\@nameauth@DoCapstrue} -% \end{macrocode} -% \end{macro} -% \begin{macro}{\CapName} -% \changes{v1.5}{2013/02/22}{Added} -% Capitalize entire name. -% \begin{macrocode} -\newcommand*{\CapName}{\@nameauth@AllThistrue} -% \end{macrocode} -% \end{macro} -% \begin{macro}{\RevName} -% \changes{v1.5}{2013/02/22}{Added} -% Reverse name order. -% \begin{macrocode} -\newcommand*{\RevName}{\@nameauth@RevThistrue} -% \end{macrocode} -% \end{macro} -% \begin{macro}{\RevComma} -% \changes{v1.5}{2013/02/22}{Added} -% Last name, comma, first name. -% \begin{macrocode} -\newcommand*{\RevComma}% - {\@nameauth@RevThistrue\@nameauth@RevThisCommatrue} -% \end{macrocode} -% \end{macro} -% \begin{macro}{\ShowComma} -% \changes{v1.4}{2012/07/24}{Added} -% Put comma between name and suffix one time. -% \begin{macrocode} -\newcommand*{\ShowComma}{\@nameauth@ShowCommatrue} -% \end{macrocode} -% \end{macro} -% \begin{macro}{\KeepAffix} -% \changes{v1.9}{2015/07/09}{Added} -% Trigger a name-suffix pair to be separated by a non-breaking space. -% \begin{macrocode} -\newcommand*{\KeepAffix}{\@nameauth@NBSPtrue} -% \end{macrocode} -% \end{macro} -% -% \begin{macro}{\NamesInactive} -% Switch to the ``non-formatted'' species of names. -% \begin{macrocode} -\newcommand*{\NamesInactive}{\@nameauth@DoFormatfalse} -% \end{macrocode} -% \end{macro} -% -% \begin{macro}{\NamesActive} -% Switch to the ``formatted'' species of names. -% \begin{macrocode} -\newcommand*{\NamesActive}{\@nameauth@DoFormattrue} -% \end{macrocode} -% \end{macro} -% -% \begin{macro}{\AllCapsInactive} -% Turn off global surname capitalization. -% \changes{v1.5}{2013/02/22}{Added} -% \begin{macrocode} -\newcommand*{\AllCapsInactive}{\@nameauth@AllCapsfalse} -% \end{macrocode} -% \end{macro} -% -% \begin{macro}{\AllCapsActive} -% Turn on global surname capitalization. -% \changes{v1.5}{2013/02/22}{Added} -% \begin{macrocode} -\newcommand*{\AllCapsActive}{\@nameauth@AllCapstrue} -% \end{macrocode} -% \end{macro} -% -% \begin{macro}{\ReverseInactive} -% Turn off global name reversing. -% \changes{v1.5}{2013/02/22}{Added} -% \begin{macrocode} -\newcommand*{\ReverseInactive}{\@nameauth@RevAllfalse} -% \end{macrocode} -% \end{macro} -% -% \begin{macro}{\ReverseActive} -% Turn on global name reversing. -% \changes{v1.5}{2013/02/22}{Added} -% \begin{macrocode} -\newcommand*{\ReverseActive}{\@nameauth@RevAlltrue} -% \end{macrocode} -% \end{macro} -% -% \begin{macro}{\ReverseCommaInactive} -% Turn off global ``last-name-comma-first.'' -% \changes{v1.5}{2013/02/22}{Added} -% \begin{macrocode} -\newcommand*{\ReverseCommaInactive}% - {\@nameauth@RevAllfalse\@nameauth@RevAllCommafalse} -% \end{macrocode} -% \end{macro} -% -% \begin{macro}{\ReverseCommaActive} -% Turn on global ``last-name-comma-first.'' -% \changes{v1.5}{2013/02/22}{Added} -% \begin{macrocode} -\newcommand*{\ReverseCommaActive}% - {\@nameauth@RevAlltrue\@nameauth@RevAllCommatrue} -% \end{macrocode} -% \end{macro} -% -% \begin{macro}{\IndexInactive} -% \changes{v0.94}{2012/02/15}{Added} -% turn off global indexing of names. -% \begin{macrocode} -\newcommand*{\IndexInactive}{\@nameauth@DoIndexfalse} -% \end{macrocode} -% \end{macro} -% -% \begin{macro}{\IndexActive} -% \changes{v0.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{v2.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}{\Name} +% \clearpage +% \begin{macro}{\@nameauth@Name} % \changes{v0.85}{2012/02/05}{Add comma suppression} % \changes{v0.96}{2012/02/19}{Works w/ \textsf{microtype}, \textsf{memoir}} % \changes{v1.5}{2013/02/22}{Add reversing and caps} % \changes{v2.0}{2015/11/11}{Isolate malformed input; trim spaces; redesign tagging} % \changes{v2.1}{2015/11/24}{Isolate Unicode issues} +% \changes{v2.3}{2016/01/05}{Rename as internal macro} % Here is the heart of the package. \Name*[Marc van]{Dongen} provided the basic structure. Parsing, indexing, and formatting are in discrete elements. % \begin{macrocode} -\newcommandx*\Name[3][1=\@empty, 3=\@empty]% +\newcommandx*\@nameauth@Name[3][1=\@empty, 3=\@empty]% {% \let\ex\expandafter% \leavevmode\hbox{}% @@ -2513,7 +2692,7 @@ Running "make install" installs the files in the local TeX tree. \fi \fi % \end{macrocode} -% \clearpage\noindent Here we parse names. +% Here we parse names. % \begin{macrocode} \ifx\testa\@empty \ifx\testc\@empty @@ -2595,6 +2774,7 @@ Running "make install" installs the files in the local TeX tree. \fi \else % \end{macrocode} +% \clearpage\noindent % This is the section that handles the old syntax for royal names and native Eastern names. The first conditional below checks if we are trying to use an alternate name cross-reference as a main name (code !PN for pseudonym). If we are using a legitimate name, we generate an index entry. % \begin{macrocode} \ifcsname\csbc!PN\endcsname @@ -2604,7 +2784,6 @@ Running "make install" installs the files in the local TeX tree. \@nameauth@Index{\csbc}{\IndexSNN\ISpace\argc}% \fi % \end{macrocode} -% \clearpage\noindent % If formatting is active, we handle first and subsequent formatting of names in the main matter (code !MN for main matter name). First we handle subsequent uses. % \begin{macrocode} \if@nameauth@DoFormat @@ -2683,7 +2862,7 @@ Running "make install" installs the files in the local TeX tree. \else % \end{macrocode} % \clearpage\noindent -% This is the section that handles Western names and non-native Eastern names. The first pair of conditionals handle the |comma| option, \cmd{RevThisComma}, and alternate forenames. The next conditional below checks if we are trying to use an alternate name cross-reference as a main name (code !PN for pseudonym). If we are using a legitimate name, we generate an index entry. +% This is the section that handles Western names and non-native Eastern names. The first pair of conditionals handle the \texttt{comma} option, \cmd{\RevThisComma}, and alternate forenames. The next conditional below checks if we are trying to use an alternate name cross-reference as a main name (code !PN for pseudonym). If we are using a legitimate name, we generate an index entry. % \begin{macrocode} \if@nameauth@RevThisComma \protected@edef\ISpace{,\space}% @@ -2794,21 +2973,185 @@ Running "make install" installs the files in the local TeX tree. } % \end{macrocode} % \end{macro} +% \subsection{User Interface Macros} +% \begin{macro}{\CapThis} +% \changes{v0.94}{2012/02/15}{Added} +% Tells the root capping macro to cap an unaccented character. +% \begin{macrocode} +\newcommand*{\CapThis}{\@nameauth@DoCapstrue} +% \end{macrocode} +% \end{macro} +% \begin{macro}{\AccentCapThis} +% \changes{v2.1}{2015/11/24}{Added} +% Tells the root capping macro to cap an accented Unicode character. +% \begin{macrocode} +\newcommand*{\AccentCapThis}{\@nameauth@Accenttrue\@nameauth@DoCapstrue} +% \end{macrocode} +% \end{macro} +% \begin{macro}{\CapName} +% \changes{v1.5}{2013/02/22}{Added} +% Capitalize entire name. +% \begin{macrocode} +\newcommand*{\CapName}{\@nameauth@AllThistrue} +% \end{macrocode} +% \end{macro} +% \begin{macro}{\RevName} +% \changes{v1.5}{2013/02/22}{Added} +% Reverse name order. +% \begin{macrocode} +\newcommand*{\RevName}{\@nameauth@RevThistrue} +% \end{macrocode} +% \end{macro} +% \begin{macro}{\RevComma} +% \changes{v1.5}{2013/02/22}{Added} +% Last name, comma, first name. +% \begin{macrocode} +\newcommand*{\RevComma}% + {\@nameauth@RevThistrue\@nameauth@RevThisCommatrue} +% \end{macrocode} +% \end{macro} +% \begin{macro}{\ShowComma} +% \changes{v1.4}{2012/07/24}{Added} +% Put comma between name and suffix one time. +% \begin{macrocode} +\newcommand*{\ShowComma}{\@nameauth@ShowCommatrue} +% \end{macrocode} +% \end{macro} +% \begin{macro}{\KeepAffix} +% \changes{v1.9}{2015/07/09}{Added} +% Trigger a name-suffix pair to be separated by a non-breaking space. +% \begin{macrocode} +\newcommand*{\KeepAffix}{\@nameauth@NBSPtrue} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\NamesInactive} +% Switch to the ``non-formatted'' species of names. +% \begin{macrocode} +\newcommand*{\NamesInactive}{\@nameauth@DoFormatfalse} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\NamesActive} +% Switch to the ``formatted'' species of names. +% \begin{macrocode} +\newcommand*{\NamesActive}{\@nameauth@DoFormattrue} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\AllCapsInactive} +% Turn off global surname capitalization. +% \changes{v1.5}{2013/02/22}{Added} +% \begin{macrocode} +\newcommand*{\AllCapsInactive}{\@nameauth@AllCapsfalse} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\AllCapsActive} +% Turn on global surname capitalization. +% \changes{v1.5}{2013/02/22}{Added} +% \begin{macrocode} +\newcommand*{\AllCapsActive}{\@nameauth@AllCapstrue} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\ReverseInactive} +% Turn off global name reversing. +% \changes{v1.5}{2013/02/22}{Added} +% \begin{macrocode} +\newcommand*{\ReverseInactive}{\@nameauth@RevAllfalse} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\ReverseActive} +% Turn on global name reversing. +% \changes{v1.5}{2013/02/22}{Added} +% \begin{macrocode} +\newcommand*{\ReverseActive}{\@nameauth@RevAlltrue} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\ReverseCommaInactive} +% Turn off global ``last-name-comma-first.'' +% \changes{v1.5}{2013/02/22}{Added} +% \begin{macrocode} +\newcommand*{\ReverseCommaInactive}% + {\@nameauth@RevAllfalse\@nameauth@RevAllCommafalse} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\ReverseCommaActive} +% Turn on global ``last-name-comma-first.'' +% \changes{v1.5}{2013/02/22}{Added} +% \begin{macrocode} +\newcommand*{\ReverseCommaActive}% + {\@nameauth@RevAlltrue\@nameauth@RevAllCommatrue} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\IndexInactive} +% \changes{v0.94}{2012/02/15}{Added} +% turn off global indexing of names. +% \begin{macrocode} +\newcommand*{\IndexInactive}{\@nameauth@DoIndexfalse} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\IndexActive} +% \changes{v0.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{v2.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}{\LocalNames} +% \changes{v2.3}{2016/01/05}{Added} +% \cmd{\LocalNames} sets |@nameauth@LocalNames| true so \cmd{\ForgetName} and \cmd{\SubvertName} do not affect both formatted and unformatted names. +% \begin{macrocode} +\newcommand*\LocalNames{\@nameauth@LocalNamestrue} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\GlobalNames} +% \changes{v2.3}{2016/01/05}{Added} +% \cmd{\GlobalNames} sets |@nameauth@LocalNames| false, restoring the default behavior of \cmd{\ForgetName} and \cmd{\SubvertName}. +% \begin{macrocode} +\newcommand*\GlobalNames{\@nameauth@LocalNamesfalse} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\Name} +% \changes{v2.3}{2016/01/05}{Change to interface macro} +% \cmd{\Name} calls \cmd{\NameauthName,} the interface hook. +% \begin{macrocode} +\def\Name{\NameauthName} +% \end{macrocode} +% \end{macro} % % \begin{macro}{\Name*} % \changes{v1.4}{2012/07/24}{Refactored} -% \cmd{\Name*} sets a Boolean value and calls \cmd{\Name}. +% \cmd{\Name*} sets up a long name reference and calls \cmd{\NameauthLName,} the interface hook. % \begin{macrocode} -\WithSuffix\def\Name*{\@nameauth@FullNametrue\Name} +\WithSuffix\def\Name*{\@nameauth@FullNametrue\NameauthLName} % \end{macrocode} % \end{macro} % % \begin{macro}{\FName} % \changes{v0.9}{2012/02/10}{Added} % \changes{v1.4}{2012/07/24}{Refactored} -% \cmd{\FName} sets a Boolean value and calls \cmd{\Name}. +% \cmd{\FName} sets up a short name reference and calls \cmd{\NameauthFName,} the interface hook. % \begin{macrocode} -\def\FName{\@nameauth@FirstNametrue\Name} +\def\FName{\@nameauth@FirstNametrue\NameauthFName} % \end{macrocode} % \end{macro} % @@ -2816,10 +3159,10 @@ Running "make install" installs the files in the local TeX tree. % \changes{v1.4}{2012/07/24}{Refactored} % \cmd{\FName} and \cmd{\FName*} are identical. % \begin{macrocode} -\WithSuffix\def\FName*{\@nameauth@FirstNametrue\Name} +\WithSuffix\def\FName*{\@nameauth@FirstNametrue\NameauthFName} % \end{macrocode} % \end{macro} -% +% \clearpage\noindent % \begin{macro}{\AKA} % \changes{v0.85}{2012/02/05}{Add comma suppression} % \changes{v0.9}{2012/02/10}{Add starred mode; redesigned} @@ -2827,6 +3170,7 @@ Running "make install" installs the files in the local TeX tree. % \changes{v1.5}{2013/02/22}{Add reversing and caps} % \changes{v2.0}{2015/11/11}{Isolate malformed input; trim spaces; redesign tagging} % \changes{v2.1}{2015/11/24}{Isolate Unicode issues} +% \changes{v2.3}{2016/01/05}{Expand starred mode} % \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]% @@ -2850,7 +3194,6 @@ Running "make install" installs the files in the local TeX tree. \def\csde{\@nameauth@Clean{#4#5}}% \def\cscd{\@nameauth@Clean{#3!#4}}% % \end{macrocode} -% \clearpage\noindent % Test for malformed input. % \begin{macrocode} \ifx\testb\@empty @@ -2878,6 +3221,7 @@ Running "make install" installs the files in the local TeX tree. \if@nameauth@RevAll\@nameauth@RevThistrue\fi \if@nameauth@RevAllComma\@nameauth@RevThisCommatrue\fi % \end{macrocode} +% \clearpage\noindent % The code below handles non-breaking and regular spaces, as well as commas, in the text and the index by setting up which kind we want to use. These will be inserted as appropriate as the output is formatted. % \begin{macrocode} \protected@edef\ISpace{\space}% @@ -2894,7 +3238,6 @@ Running "make install" installs the files in the local TeX tree. \if@nameauth@NBSP\protected@edef\Space{,\nobreakspace}\fi \fi % \end{macrocode} -% \clearpage\noindent % The section below parses any ``surnames'' into name/suffix pairs and figures out how to capitalize and reverse them as needed, storing the results for the main parser. We have to handle several more combinations here than with \cmd{\Name} above. % \begin{macrocode} \protected@edef\Shortb{\@nameauth@Root{#2}}% @@ -2925,6 +3268,9 @@ Running "make install" installs the files in the local TeX tree. \let\SNNd\AllCapShort% \let\Reversed\AllCapShort% \fi +% \end{macrocode} +% \clearpage +% \begin{macrocode} \else \protected@edef\Suffd{\@nameauth@Suffix{#4}}% \protected@edef\ISNNd{\Shortd\ISpace\Suffd}% @@ -2940,7 +3286,7 @@ Running "make install" installs the files in the local TeX tree. \fi \fi % \end{macrocode} -% \clearpage\noindent Here we parse names. +% Here we parse names. % \begin{macrocode} \ifx\testc\@empty \ifx\teste\@empty @@ -2976,7 +3322,7 @@ Running "make install" installs the files in the local TeX tree. \fi \fi % \end{macrocode} -% \noindent Print an appropriate version of the pseudonym (capped, reversed, etc.) in the text with no special formatting even if no cross-reference was generated in the index. Again, \cmd{\expandafter} is used for the punctuation detection. +% \clearpage\noindent Print an appropriate version of the pseudonym (capped, reversed, etc.) in the text with no special formatting even if no cross-reference was generated in the index. Again, \cmd{\expandafter} is used for the punctuation detection. % \begin{macrocode} \if@nameauth@RevThisComma \protected@edef\ISpace{,\space}% @@ -2992,7 +3338,6 @@ Running "make install" installs the files in the local TeX tree. \fi \else % \end{macrocode} -% \clearpage\noindent % For name/affix using the old syntax: If a pseudonym has not been generated by \cmd{\AKA} or \cmd{\ExcludeName}, and if the proposed pseudonym is not already a mainmatter or frontmatter name, then generate a \textit{see} reference from the pseudonym to a name that will appear in the index. % \begin{macrocode} \ifcsname\csde!PN\endcsname @@ -3024,7 +3369,7 @@ Running "make install" installs the files in the local TeX tree. \fi \fi % \end{macrocode} -% Print an appropriate version of the pseudonym (capped, reversed, etc.) in the text with no special formatting even if no cross-reference was generated in the index. +% \clearpage\noindent Print an appropriate version of the pseudonym (capped, reversed, etc.) in the text with no special formatting even if no cross-reference was generated in the index. % \begin{macrocode} \if@nameauth@RevThisComma \protected@edef\ISpace{,\space}% @@ -3045,7 +3390,6 @@ Running "make install" installs the files in the local TeX tree. \fi \else % \end{macrocode} -% \clearpage\noindent % For Western names and affixes: If a pseudonym has not been generated by \cmd{\AKA} or \cmd{\ExcludeName}, and if the proposed pseudonym is not already a mainmatter or frontmatter name, then generate a \textit{see} reference from the pseudonym to a name that will appear in the index. % \begin{macrocode} \ifcsname\cscd!PN\endcsname @@ -3092,7 +3436,6 @@ Running "make install" installs the files in the local TeX tree. \fi \fi % \end{macrocode} -% \clearpage\noindent % \noindent Print an appropriate version of the pseudonym (capped, reversed, etc.) in the text with no special formatting even if no cross-reference was generated in the index. % \begin{macrocode} \if@nameauth@RevThisComma @@ -3105,10 +3448,14 @@ Running "make install" installs the files in the local TeX tree. \else \let\FNN\arge% \fi - \if@nameauth@RevThis - \ex\@nameauth@FmtName\ex{\ex\SNNd\ex\Space\FNN}% + \if@nameauth@AltAKA + \ex\@nameauth@FmtName\ex{\FNN}% \else - \ex\@nameauth@FmtName\ex{\ex\FNN\ex\space\SNNd}% + \if@nameauth@RevThis + \ex\@nameauth@FmtName\ex{\ex\SNNd\ex\Space\FNN}% + \else + \ex\@nameauth@FmtName\ex{\ex\FNN\ex\space\SNNd}% + \fi \fi \fi % \end{macrocode} @@ -3132,31 +3479,32 @@ Running "make install" installs the files in the local TeX tree. % % \begin{macro}{\AKA*} % \changes{v0.9}{2012/02/10}{Added} -% This starred form sets a Boolean to print only the alternate name parameter, if that exists, and calls \cmd{\AKA}. +% This starred form sets a Boolean to print only the alternate name argument, if that exists, and calls \cmd{\AKA}. % \begin{macrocode} \WithSuffix\def\AKA*{\@nameauth@AltAKAtrue\AKA} % \end{macrocode} % \end{macro} +% \clearpage\noindent % % \begin{macro}{\PName} % \changes{v0.85}{2012/02/05}{Add comma suppression} -% \cmd{\PName} is a convenience macro that calls \cmd{\Name}, then \cmd{\AKA}. +% \changes{v2.3}{2016/01/05}{Work directly with hooks} +% \cmd{\PName} is a convenience macro that calls \cmd{\NameauthName}, then \cmd{\AKA}. % \begin{macrocode} \newcommandx*\PName[5][1=\@empty,3=\@empty,5=\@empty]% {% - \Name[#1]{#2}\space(\AKA[#1]{#2}[#3]{#4}[#5])% + \NameauthName[#1]{#2}\space(\AKA[#1]{#2}[#3]{#4}[#5])% } % \end{macrocode} % \end{macro} % % \begin{macro}{\PName*} % \changes{v0.85}{2012/02/05}{Add comma suppression} -% This just calls \cmd{\Name*}, then \cmd{\AKA}. +% This sets up a long name reference and calls \cmd{\PName}. % \begin{macrocode} \WithSuffix\def\PName*{\@nameauth@FullNametrue\PName} % \end{macrocode} % \end{macro} -% \clearpage\noindent % % \begin{macro}{\TagName} % \changes{v1.2}{2012/02/25}{Added} @@ -3304,7 +3652,7 @@ Running "make install" installs the files in the local TeX tree. % \clearpage\noindent % % \begin{macro}{\IndexName} -% \changes{v0.75}{2012/01/19}{Use current parameters} +% \changes{v0.75}{2012/01/19}{Use current arguments} % \changes{v0.85}{2012/02/05}{Add comma suppression} % \changes{v1.26}{2012/04/24}{Fix name suffix sorting} % \changes{v2.0}{2015/11/11}{Isolate malformed input; trim spaces; redesign tagging} @@ -3391,6 +3739,7 @@ Running "make install" installs the files in the local TeX tree. % \begin{macro}{\ExcludeName} % \changes{v0.94}{2012/02/15}{Added} % \changes{v2.0}{2015/11/11}{Isolate malformed input} +% \changes{v2.3}{2016/01/05}{Distinguish excluded names from regular aliases} % This macro prevents a name from being formatted or indexed, making \cmd{\Name} and friends print their arguments, emit a warning, and continue. % \begin{macrocode} \newcommandx*\ExcludeName[3][1=\@empty, 3=\@empty]% @@ -3427,7 +3776,7 @@ Running "make install" installs the files in the local TeX tree. \PackageWarning{nameauth}% {macro \ExcludeName: Reference: #2 exists; no exclusion}% \else - \csgdef{\csb!PN}{}% + \csgdef{\csb!PN}{!}% \fi \fi \fi @@ -3444,7 +3793,7 @@ Running "make install" installs the files in the local TeX tree. \PackageWarning{nameauth}% {macro \ExcludeName: Reference: #2 #3 exists; no exclusion}% \else - \csgdef{\csbc!PN}{}% + \csgdef{\csbc!PN}{!}% \fi \fi \fi @@ -3462,7 +3811,7 @@ Running "make install" installs the files in the local TeX tree. \PackageWarning{nameauth}% {macro \ExcludeName: Reference: #1 #2 exists; no exclusion}% \else - \csgdef{\csab!PN}{}% + \csgdef{\csab!PN}{!}% \fi \fi \fi @@ -3471,10 +3820,129 @@ Running "make install" installs the files in the local TeX tree. % \end{macrocode} % \end{macro} % +% \begin{macro}{\IfAKA} +% \changes{v2.3}{2016/01/05}{Added} +% This macro expands one path if a see-reference name exists, another if it does not exist, and a third if it is excluded. +% \begin{macrocode} +\newcommandx\IfAKA[6][1=\@empty, 3=\@empty]% +{% + \protected@edef\testa{#1}% + \protected@edef\testb{\trim@spaces{#2}}% + \protected@edef\testc{#3}% + \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 and make parsing decisions. Below we parse the name arguments and create a pseudonym control sequence if it does not exist. +% \begin{macrocode} + \ifx\testb\@empty + \PackageError{nameauth}% + {macro \ExcludeName: Essential name missing}% + \else + \ifx\csb\@empty + \PackageError{nameauth}% + {macro \ExcludeName: Essential name malformed}% + \fi + \fi + \ifx\testa\@empty + \ifx\testc\@empty + \ifcsname\csb!PN\endcsname + \ifcsempty{\csb!PN}{#4}{#6}% + \else#5\fi + \else + \ifcsname\csbc!PN\endcsname + \ifcsempty{\csbc!PN}{#4}{#6}% + \else#5\fi + \fi + \else + \ifcsname\csab!PN\endcsname + \ifcsempty{\csab!PN}{#4}{#6}% + \else#5\fi + \fi +} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\IfFrontName} +% \changes{v2.3}{2016/01/05}{Added} +% This macro expands one path if a front matter name exists, or else the other if it does not exist. +% \begin{macrocode} +\newcommandx\IfFrontName[5][1=\@empty, 3=\@empty]% +{% + \protected@edef\testa{#1}% + \protected@edef\testb{\trim@spaces{#2}}% + \protected@edef\testc{#3}% + \def\csb{\@nameauth@Clean{#2}}% + \def\csbc{\@nameauth@Clean{#2#3}}% + \def\csab{\@nameauth@Clean{#1!#2}}% +% \end{macrocode} +% \clearpage\noindent +% We make copies of the arguments to test them and make parsing decisions. Below we parse the name arguments and create a pseudonym control sequence if it does not exist. +% \begin{macrocode} + \ifx\testb\@empty + \PackageError{nameauth}% + {macro \ExcludeName: Essential name missing}% + \else + \ifx\csb\@empty + \PackageError{nameauth}% + {macro \ExcludeName: Essential name malformed}% + \fi + \fi + \ifx\testa\@empty + \ifx\testc\@empty + \ifcsname\csb!NF\endcsname#4\else#5\fi + \else + \ifcsname\csbc!NF\endcsname#4\else#5\fi + \fi + \else + \ifcsname\csab!NF\endcsname#4\else#5\fi + \fi +} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\IfMainName} +% \changes{v2.3}{2016/01/05}{Added} +% This macro expands one path if a main matter name exists, or else the other if it does not exist. +% \begin{macrocode} +\newcommandx\IfMainName[5][1=\@empty, 3=\@empty]% +{% + \protected@edef\testa{#1}% + \protected@edef\testb{\trim@spaces{#2}}% + \protected@edef\testc{#3}% + \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 and make parsing decisions. Below we parse the name arguments and create a pseudonym control sequence if it does not exist. +% \begin{macrocode} + \ifx\testb\@empty + \PackageError{nameauth}% + {macro \ExcludeName: Essential name missing}% + \else + \ifx\csb\@empty + \PackageError{nameauth}% + {macro \ExcludeName: Essential name malformed}% + \fi + \fi + \ifx\testa\@empty + \ifx\testc\@empty + \ifcsname\csb!MN\endcsname#4\else#5\fi + \else + \ifcsname\csbc!MN\endcsname#4\else#5\fi + \fi + \else + \ifcsname\csab!MN\endcsname#4\else#5\fi + \fi +} +% \end{macrocode} +% \end{macro} +% % \begin{macro}{\ForgetName} -% \changes{v0.75}{2012/01/19}{New parameter added} +% \changes{v0.75}{2012/01/19}{New argument added} % \changes{v1.9}{2015/07/09}{Ensure global undef} % \changes{v2.0}{2015/11/11}{Isolate malformed input} +% \changes{v2.3}{2016/01/05}{Changed to allow global or local behavior} % This undefines a control sequence to force the ``first use'' option of \cmd{\Name}. % \begin{macrocode} \newcommandx*\ForgetName[3][1=\@empty, 3=\@empty]% @@ -3486,7 +3954,7 @@ Running "make install" installs the files in the local TeX tree. \def\csbc{\@nameauth@Clean{#2#3}}% \def\csab{\@nameauth@Clean{#1!#2}}% % \end{macrocode} -% We make copies of the arguments to test them and then we parse the arguments, undefining the control sequences. +% We make copies of the arguments to test them. % \begin{macrocode} \ifx\testb\@empty \PackageError{nameauth}% @@ -3497,26 +3965,56 @@ Running "make install" installs the files in the local TeX tree. {macro \ForgetName: Essential name malformed}% \fi \fi +% \end{macrocode} +% Now we parse the arguments, undefining the control sequences either locally by section type or globally. |@nameauth@LocalNames| toggles the local or global behavior, while |@nameauth@DoFormat| selects the type of name. +% \begin{macrocode} \ifx\testa\@empty \ifx\testc\@empty - \global\csundef{\csb!MN}% - \global\csundef{\csb!NF}% + \if@nameauth@LocalNames + \if@nameauth@DoFormat + \global\csundef{\csb!MN}% + \else + \global\csundef{\csb!NF}% + \fi + \else + \global\csundef{\csb!MN}% + \global\csundef{\csb!NF}% + \fi \else - \global\csundef{\csbc!MN}% - \global\csundef{\csbc!NF}% + \if@nameauth@LocalNames + \if@nameauth@DoFormat + \global\csundef{\csbc!MN}% + \else + \global\csundef{\csbc!NF}% + \fi + \else + \global\csundef{\csbc!MN}% + \global\csundef{\csbc!NF}% + \fi \fi \else + \if@nameauth@LocalNames + \if@nameauth@DoFormat + \global\csundef{\csab!MN}% + \else + \global\csundef{\csab!NF}% + \fi +% \end{macrocode} +% \clearpage\noindent +% \begin{macrocode} + \else \global\csundef{\csab!MN}% \global\csundef{\csab!NF}% + \fi \fi } % \end{macrocode} % \end{macro} -% \clearpage\noindent % % \begin{macro}{\SubvertName} % \changes{v0.9}{2012/02/10}{Added} % \changes{v2.0}{2015/11/11}{Isolate malformed input} +% \changes{v2.3}{2016/01/05}{Changed to allow global or local behavior} % This defines a control sequence to suppress the ``first use'' of \cmd{\Name}. % \begin{macrocode} \newcommandx*\SubvertName[3][1=\@empty, 3=\@empty]% @@ -3528,7 +4026,7 @@ Running "make install" installs the files in the local TeX tree. \def\csbc{\@nameauth@Clean{#2#3}}% \def\csab{\@nameauth@Clean{#1!#2}}% % \end{macrocode} -% We make copies of the arguments to test them and then we parse the arguments, defining the control sequences. +% We make copies of the arguments to test them. % \begin{macrocode} \ifx\testb\@empty \PackageError{nameauth}% @@ -3539,23 +4037,51 @@ Running "make install" installs the files in the local TeX tree. {macro \SubvertName: Essential name malformed}% \fi \fi +% \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 |@nameauth@DoFormat| selects the type of name. +% \begin{macrocode} \ifx\testa\@empty \ifx\testc\@empty - \csgdef{\csb!MN}{}% - \csgdef{\csb!NF}{}% + \if@nameauth@LocalNames + \if@nameauth@DoFormat + \csgdef{\csb!MN}{}% + \else + \csgdef{\csb!NF}{}% + \fi + \else + \csgdef{\csb!MN}{}% + \csgdef{\csb!NF}{}% + \fi \else - \csgdef{\csbc!MN}{}% - \csgdef{\csbc!NF}{}% + \if@nameauth@LocalNames + \if@nameauth@DoFormat + \csgdef{\csbc!MN}{}% + \else + \csgdef{\csbc!NF}{}% + \fi + \else + \csgdef{\csbc!MN}{}% + \csgdef{\csbc!NF}{}% + \fi \fi +% \end{macrocode} +% \clearpage\noindent +% \begin{macrocode} \else + \if@nameauth@LocalNames + \if@nameauth@DoFormat + \csgdef{\csab!MN}{}% + \else + \csgdef{\csab!NF}{}% + \fi + \else \csgdef{\csab!MN}{}% \csgdef{\csab!NF}{}% - \fi -} + \fi + \fi} % \end{macrocode} % \end{macro} % -% \clearpage\noindent % \begin{environment}{nameauth} % \changes{v1.6}{2013/03/10}{Added} % \changes{v2.0}{2015/11/11}{Redesigned argument handling} @@ -3577,8 +4103,8 @@ Running "make install" installs the files in the local TeX tree. \tokc\expandafter{##3}% \tokd\expandafter{##4}% \ifx\arga\@empty - \PackageError{nameauth}% - {environment nameauth: Control sequence missing}% + \PackageError{nameauth}% + {environment nameauth: Control sequence missing}% \else \ifx\testc\@empty \PackageError{nameauth}% @@ -3591,17 +4117,23 @@ Running "make install" installs the files in the local TeX tree. \ifx\testd\@empty \ifx\testb\@empty \ex\csgdef\ex{\ex\arga\ex}\ex{\ex\NameauthName\ex{\the\tokc}}% - \ex\csgdef\ex{\ex L\ex\arga\ex}\ex{\ex\NameauthName\ex*\ex{\the\tokc}}% - \ex\csgdef\ex{\ex S\ex\arga\ex}\ex{\ex\NameauthFName\ex{\the\tokc}}% + \ex\csgdef\ex{\ex L\ex\arga\ex}\ex{\ex\@nameauth@FullNametrue% + \ex\NameauthLName\ex{\the\tokc}}% + \ex\csgdef\ex{\ex S\ex\arga\ex}\ex{\ex\@nameauth@FirstNametrue% + \ex\NameauthFName\ex{\the\tokc}}% +% \end{macrocode} +% \clearpage\noindent +% \begin{macrocode} \else \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\tokb\ex]% \ex{\the\tokc}}% \ex\ex\ex\csgdef\ex\ex\ex{\ex\ex\ex L\ex\ex\ex\arga% - \ex\ex\ex}\ex\ex\ex{\ex\ex\ex\NameauthName\ex\ex\ex*% - \ex\ex\ex[\ex\the\ex\tokb\ex]\ex{\the\tokc}}% + \ex\ex\ex}\ex\ex\ex{\ex\ex\ex\@nameauth@FullNametrue% + \ex\ex\ex\NameauthLName\ex\ex\ex[\ex\the\ex\tokb\ex]\ex{\the\tokc}}% \ex\ex\ex\csgdef\ex\ex\ex{\ex\ex\ex S\ex\ex\ex\arga% - \ex\ex\ex}\ex\ex\ex{\ex\ex\ex\NameauthFName\ex\ex\ex[% + \ex\ex\ex}\ex\ex\ex{\ex\ex\ex\@nameauth@FirstNametrue% + \ex\ex\ex\NameauthFName\ex\ex\ex[% \ex\the\ex\tokb\ex]\ex{\the\tokc}}% \fi \else @@ -3610,10 +4142,12 @@ Running "make install" installs the files in the local TeX tree. \ex\ex\ex{\ex\ex\ex\NameauthName\ex\ex\ex{\ex\the\ex\tokc\ex}% \ex[\the\tokd]}% \ex\ex\ex\csgdef\ex\ex\ex{\ex\ex\ex L\ex\ex\ex\arga% - \ex\ex\ex}\ex\ex\ex{\ex\ex\ex\NameauthName% - \ex\ex\ex*\ex\ex\ex{\ex\the\ex\tokc\ex}\ex[\the\tokd]}% + \ex\ex\ex}\ex\ex\ex{\ex\ex\ex\@nameauth@FullNametrue% + \ex\ex\ex\NameauthLName\ex\ex\ex{% + \ex\the\ex\tokc\ex}\ex[\the\tokd]}% \ex\ex\ex\csgdef\ex\ex\ex{\ex\ex\ex S\ex\ex\ex\arga% - \ex\ex\ex}\ex\ex\ex{\ex\ex\ex\NameauthFName\ex\ex\ex{% + \ex\ex\ex}\ex\ex\ex{\ex\ex\ex\@nameauth@FirstNametrue% + \ex\ex\ex\NameauthFName\ex\ex\ex{% \ex\the\ex\tokc\ex}\ex[\the\tokd]}% \else \ex\ex\ex\ex\ex\ex\ex\csgdef\ex\ex\ex\ex\ex\ex\ex{% @@ -3624,12 +4158,14 @@ Running "make install" installs the files in the local TeX tree. \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\NameauthName\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\tokb% \ex\ex\ex]\ex\ex\ex{\ex\the\ex\tokc\ex}\ex[\the\tokd]}% \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\@nameauth@FirstNametrue% \ex\ex\ex\ex\ex\ex\ex\NameauthFName\ex\ex\ex\ex\ex\ex\ex[% \ex\ex\ex\the\ex\ex\ex\tokb\ex\ex\ex]% \ex\ex\ex{\ex\the\ex\tokc\ex}\ex[\the\tokd]}% diff --git a/Master/texmf-dist/source/latex/nameauth/nameauth.ins b/Master/texmf-dist/source/latex/nameauth/nameauth.ins index 27d91d5f245..1937e05f051 100644 --- a/Master/texmf-dist/source/latex/nameauth/nameauth.ins +++ b/Master/texmf-dist/source/latex/nameauth/nameauth.ins @@ -26,7 +26,7 @@ nameauth:| Name authority mechanism for consistency in text and index \endpreamble \postamble -Copyright (C) 2015 by Charles P. Schaum <charles dot schaum at comcast dot net> +Copyright (C) 2016 by Charles P. Schaum <charles dot schaum at comcast dot net> This work may be distributed and/or modified under the conditions of the LaTeX Project Public License (LPPL), either @@ -51,7 +51,7 @@ Running "make install" installs the files in the local TeX tree. } \endbatchfile %% -%% Copyright (C) 2015 by Charles P. Schaum <charles dot schaum at comcast dot net> +%% Copyright (C) 2016 by Charles P. Schaum <charles dot schaum at comcast dot net> %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License (LPPL), either diff --git a/Master/texmf-dist/tex/latex/nameauth/nameauth.sty b/Master/texmf-dist/tex/latex/nameauth/nameauth.sty index 368cfdd626a..3845762c79c 100644 --- a/Master/texmf-dist/tex/latex/nameauth/nameauth.sty +++ b/Master/texmf-dist/tex/latex/nameauth/nameauth.sty @@ -14,10 +14,11 @@ %% \NeedsTeXFormat{LaTeX2e}[1999/12/01] \ProvidesPackage{nameauth} - [2015/12/01 v2.2 Name authority mechanism for consistency in text and index] + [2016/01/05 v2.3 Name authority mechanism for consistency in text and index] \newif\if@nameauth@AlwaysComma \newif\if@nameauth@ShowComma \newif\if@nameauth@DoFormat +\newif\if@nameauth@LocalNames \newif\if@nameauth@DoIndex \newif\if@nameauth@Pretag \newif\if@nameauth@AllCaps @@ -36,8 +37,9 @@ \newif\if@nameauth@DoCaps \newif\if@nameauth@Accent \newcommand*{\NamesFormat}{} -\newcommand*{\NameauthName}{\Name} -\newcommand*{\NameauthFName}{\FName} +\newcommand*{\NameauthName}{\@nameauth@Name} +\newcommand*{\NameauthLName}{\@nameauth@Name} +\newcommand*{\NameauthFName}{\@nameauth@Name} \DeclareOption{comma}{\@nameauth@AlwaysCommatrue} \DeclareOption{nocomma}{\@nameauth@AlwaysCommafalse} \DeclareOption{mainmatter}{\@nameauth@DoFormattrue} @@ -71,8 +73,8 @@ \RequirePackage{etoolbox} \RequirePackage{ifluatex} \RequirePackage{ifxetex} -\RequirePackage{suffix} \RequirePackage{trimspaces} +\RequirePackage{suffix} \RequirePackage{xargs} \newcommand*\@nameauth@Actual{@} \newcommand*{\@nameauth@Clean}[1]% @@ -148,29 +150,7 @@ \fi \fi } -\newcommand*{\CapThis}{\@nameauth@DoCapstrue} -\newcommand*{\AccentCapThis}{\@nameauth@Accenttrue\@nameauth@DoCapstrue} -\newcommand*{\CapName}{\@nameauth@AllThistrue} -\newcommand*{\RevName}{\@nameauth@RevThistrue} -\newcommand*{\RevComma}% - {\@nameauth@RevThistrue\@nameauth@RevThisCommatrue} -\newcommand*{\ShowComma}{\@nameauth@ShowCommatrue} -\newcommand*{\KeepAffix}{\@nameauth@NBSPtrue} -\newcommand*{\NamesInactive}{\@nameauth@DoFormatfalse} -\newcommand*{\NamesActive}{\@nameauth@DoFormattrue} -\newcommand*{\AllCapsInactive}{\@nameauth@AllCapsfalse} -\newcommand*{\AllCapsActive}{\@nameauth@AllCapstrue} -\newcommand*{\ReverseInactive}{\@nameauth@RevAllfalse} -\newcommand*{\ReverseActive}{\@nameauth@RevAlltrue} -\newcommand*{\ReverseCommaInactive}% - {\@nameauth@RevAllfalse\@nameauth@RevAllCommafalse} -\newcommand*{\ReverseCommaActive}% - {\@nameauth@RevAlltrue\@nameauth@RevAllCommatrue} -\newcommand*{\IndexInactive}{\@nameauth@DoIndexfalse} -\newcommand*{\IndexActive}{\@nameauth@DoIndextrue} -\newcommand*{\IndexActual}[1]% - {\global\renewcommand*\@nameauth@Actual{#1}} -\newcommandx*\Name[3][1=\@empty, 3=\@empty]% +\newcommandx*\@nameauth@Name[3][1=\@empty, 3=\@empty]% {% \let\ex\expandafter% \leavevmode\hbox{}% @@ -481,9 +461,34 @@ \@nameauth@RevThisCommafalse% \if@nameauth@Punct\expandafter\@nameauth@CheckDot\fi } -\WithSuffix\def\Name*{\@nameauth@FullNametrue\Name} -\def\FName{\@nameauth@FirstNametrue\Name} -\WithSuffix\def\FName*{\@nameauth@FirstNametrue\Name} +\newcommand*{\CapThis}{\@nameauth@DoCapstrue} +\newcommand*{\AccentCapThis}{\@nameauth@Accenttrue\@nameauth@DoCapstrue} +\newcommand*{\CapName}{\@nameauth@AllThistrue} +\newcommand*{\RevName}{\@nameauth@RevThistrue} +\newcommand*{\RevComma}% + {\@nameauth@RevThistrue\@nameauth@RevThisCommatrue} +\newcommand*{\ShowComma}{\@nameauth@ShowCommatrue} +\newcommand*{\KeepAffix}{\@nameauth@NBSPtrue} +\newcommand*{\NamesInactive}{\@nameauth@DoFormatfalse} +\newcommand*{\NamesActive}{\@nameauth@DoFormattrue} +\newcommand*{\AllCapsInactive}{\@nameauth@AllCapsfalse} +\newcommand*{\AllCapsActive}{\@nameauth@AllCapstrue} +\newcommand*{\ReverseInactive}{\@nameauth@RevAllfalse} +\newcommand*{\ReverseActive}{\@nameauth@RevAlltrue} +\newcommand*{\ReverseCommaInactive}% + {\@nameauth@RevAllfalse\@nameauth@RevAllCommafalse} +\newcommand*{\ReverseCommaActive}% + {\@nameauth@RevAlltrue\@nameauth@RevAllCommatrue} +\newcommand*{\IndexInactive}{\@nameauth@DoIndexfalse} +\newcommand*{\IndexActive}{\@nameauth@DoIndextrue} +\newcommand*{\IndexActual}[1]% + {\global\renewcommand*\@nameauth@Actual{#1}} +\newcommand*\LocalNames{\@nameauth@LocalNamestrue} +\newcommand*\GlobalNames{\@nameauth@LocalNamesfalse} +\def\Name{\NameauthName} +\WithSuffix\def\Name*{\@nameauth@FullNametrue\NameauthLName} +\def\FName{\@nameauth@FirstNametrue\NameauthFName} +\WithSuffix\def\FName*{\@nameauth@FirstNametrue\NameauthFName} \newcommandx*\AKA[5][1=\@empty, 3=\@empty, 5=\@empty]% {% \let\ex\expandafter% @@ -719,10 +724,14 @@ \else \let\FNN\arge% \fi - \if@nameauth@RevThis - \ex\@nameauth@FmtName\ex{\ex\SNNd\ex\Space\FNN}% + \if@nameauth@AltAKA + \ex\@nameauth@FmtName\ex{\FNN}% \else - \ex\@nameauth@FmtName\ex{\ex\FNN\ex\space\SNNd}% + \if@nameauth@RevThis + \ex\@nameauth@FmtName\ex{\ex\SNNd\ex\Space\FNN}% + \else + \ex\@nameauth@FmtName\ex{\ex\FNN\ex\space\SNNd}% + \fi \fi \fi \@nameauth@NBSPfalse% @@ -738,7 +747,7 @@ \WithSuffix\def\AKA*{\@nameauth@AltAKAtrue\AKA} \newcommandx*\PName[5][1=\@empty,3=\@empty,5=\@empty]% {% - \Name[#1]{#2}\space(\AKA[#1]{#2}[#3]{#4}[#5])% + \NameauthName[#1]{#2}\space(\AKA[#1]{#2}[#3]{#4}[#5])% } \WithSuffix\def\PName*{\@nameauth@FullNametrue\PName} \newcommandx*\TagName[4][1=\@empty, 3=\@empty]% @@ -945,7 +954,7 @@ \PackageWarning{nameauth}% {macro \ExcludeName: Reference: #2 exists; no exclusion}% \else - \csgdef{\csb!PN}{}% + \csgdef{\csb!PN}{!}% \fi \fi \fi @@ -962,7 +971,7 @@ \PackageWarning{nameauth}% {macro \ExcludeName: Reference: #2 #3 exists; no exclusion}% \else - \csgdef{\csbc!PN}{}% + \csgdef{\csbc!PN}{!}% \fi \fi \fi @@ -980,12 +989,99 @@ \PackageWarning{nameauth}% {macro \ExcludeName: Reference: #1 #2 exists; no exclusion}% \else - \csgdef{\csab!PN}{}% + \csgdef{\csab!PN}{!}% \fi \fi \fi \fi } +\newcommandx\IfAKA[6][1=\@empty, 3=\@empty]% +{% + \protected@edef\testa{#1}% + \protected@edef\testb{\trim@spaces{#2}}% + \protected@edef\testc{#3}% + \def\csb{\@nameauth@Clean{#2}}% + \def\csbc{\@nameauth@Clean{#2#3}}% + \def\csab{\@nameauth@Clean{#1!#2}}% + \ifx\testb\@empty + \PackageError{nameauth}% + {macro \ExcludeName: Essential name missing}% + \else + \ifx\csb\@empty + \PackageError{nameauth}% + {macro \ExcludeName: Essential name malformed}% + \fi + \fi + \ifx\testa\@empty + \ifx\testc\@empty + \ifcsname\csb!PN\endcsname + \ifcsempty{\csb!PN}{#4}{#6}% + \else#5\fi + \else + \ifcsname\csbc!PN\endcsname + \ifcsempty{\csbc!PN}{#4}{#6}% + \else#5\fi + \fi + \else + \ifcsname\csab!PN\endcsname + \ifcsempty{\csab!PN}{#4}{#6}% + \else#5\fi + \fi +} +\newcommandx\IfFrontName[5][1=\@empty, 3=\@empty]% +{% + \protected@edef\testa{#1}% + \protected@edef\testb{\trim@spaces{#2}}% + \protected@edef\testc{#3}% + \def\csb{\@nameauth@Clean{#2}}% + \def\csbc{\@nameauth@Clean{#2#3}}% + \def\csab{\@nameauth@Clean{#1!#2}}% + \ifx\testb\@empty + \PackageError{nameauth}% + {macro \ExcludeName: Essential name missing}% + \else + \ifx\csb\@empty + \PackageError{nameauth}% + {macro \ExcludeName: Essential name malformed}% + \fi + \fi + \ifx\testa\@empty + \ifx\testc\@empty + \ifcsname\csb!NF\endcsname#4\else#5\fi + \else + \ifcsname\csbc!NF\endcsname#4\else#5\fi + \fi + \else + \ifcsname\csab!NF\endcsname#4\else#5\fi + \fi +} +\newcommandx\IfMainName[5][1=\@empty, 3=\@empty]% +{% + \protected@edef\testa{#1}% + \protected@edef\testb{\trim@spaces{#2}}% + \protected@edef\testc{#3}% + \def\csb{\@nameauth@Clean{#2}}% + \def\csbc{\@nameauth@Clean{#2#3}}% + \def\csab{\@nameauth@Clean{#1!#2}}% + \ifx\testb\@empty + \PackageError{nameauth}% + {macro \ExcludeName: Essential name missing}% + \else + \ifx\csb\@empty + \PackageError{nameauth}% + {macro \ExcludeName: Essential name malformed}% + \fi + \fi + \ifx\testa\@empty + \ifx\testc\@empty + \ifcsname\csb!MN\endcsname#4\else#5\fi + \else + \ifcsname\csbc!MN\endcsname#4\else#5\fi + \fi + \else + \ifcsname\csab!MN\endcsname#4\else#5\fi + \fi +} \newcommandx*\ForgetName[3][1=\@empty, 3=\@empty]% {% \protected@edef\testa{#1}% @@ -1005,15 +1101,39 @@ \fi \ifx\testa\@empty \ifx\testc\@empty - \global\csundef{\csb!MN}% - \global\csundef{\csb!NF}% + \if@nameauth@LocalNames + \if@nameauth@DoFormat + \global\csundef{\csb!MN}% + \else + \global\csundef{\csb!NF}% + \fi + \else + \global\csundef{\csb!MN}% + \global\csundef{\csb!NF}% + \fi \else - \global\csundef{\csbc!MN}% - \global\csundef{\csbc!NF}% + \if@nameauth@LocalNames + \if@nameauth@DoFormat + \global\csundef{\csbc!MN}% + \else + \global\csundef{\csbc!NF}% + \fi + \else + \global\csundef{\csbc!MN}% + \global\csundef{\csbc!NF}% + \fi \fi \else + \if@nameauth@LocalNames + \if@nameauth@DoFormat + \global\csundef{\csab!MN}% + \else + \global\csundef{\csab!NF}% + \fi + \else \global\csundef{\csab!MN}% \global\csundef{\csab!NF}% + \fi \fi } \newcommandx*\SubvertName[3][1=\@empty, 3=\@empty]% @@ -1035,17 +1155,40 @@ \fi \ifx\testa\@empty \ifx\testc\@empty - \csgdef{\csb!MN}{}% - \csgdef{\csb!NF}{}% + \if@nameauth@LocalNames + \if@nameauth@DoFormat + \csgdef{\csb!MN}{}% + \else + \csgdef{\csb!NF}{}% + \fi + \else + \csgdef{\csb!MN}{}% + \csgdef{\csb!NF}{}% + \fi \else - \csgdef{\csbc!MN}{}% - \csgdef{\csbc!NF}{}% + \if@nameauth@LocalNames + \if@nameauth@DoFormat + \csgdef{\csbc!MN}{}% + \else + \csgdef{\csbc!NF}{}% + \fi + \else + \csgdef{\csbc!MN}{}% + \csgdef{\csbc!NF}{}% + \fi \fi \else + \if@nameauth@LocalNames + \if@nameauth@DoFormat + \csgdef{\csab!MN}{}% + \else + \csgdef{\csab!NF}{}% + \fi + \else \csgdef{\csab!MN}{}% \csgdef{\csab!NF}{}% - \fi -} + \fi + \fi} \newenvironment{nameauth}{% \begingroup% \let\ex\expandafter% @@ -1061,8 +1204,8 @@ \tokc\expandafter{##3}% \tokd\expandafter{##4}% \ifx\arga\@empty - \PackageError{nameauth}% - {environment nameauth: Control sequence missing}% + \PackageError{nameauth}% + {environment nameauth: Control sequence missing}% \else \ifx\testc\@empty \PackageError{nameauth}% @@ -1075,17 +1218,20 @@ \ifx\testd\@empty \ifx\testb\@empty \ex\csgdef\ex{\ex\arga\ex}\ex{\ex\NameauthName\ex{\the\tokc}}% - \ex\csgdef\ex{\ex L\ex\arga\ex}\ex{\ex\NameauthName\ex*\ex{\the\tokc}}% - \ex\csgdef\ex{\ex S\ex\arga\ex}\ex{\ex\NameauthFName\ex{\the\tokc}}% + \ex\csgdef\ex{\ex L\ex\arga\ex}\ex{\ex\@nameauth@FullNametrue% + \ex\NameauthLName\ex{\the\tokc}}% + \ex\csgdef\ex{\ex S\ex\arga\ex}\ex{\ex\@nameauth@FirstNametrue% + \ex\NameauthFName\ex{\the\tokc}}% \else \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\tokb\ex]% \ex{\the\tokc}}% \ex\ex\ex\csgdef\ex\ex\ex{\ex\ex\ex L\ex\ex\ex\arga% - \ex\ex\ex}\ex\ex\ex{\ex\ex\ex\NameauthName\ex\ex\ex*% - \ex\ex\ex[\ex\the\ex\tokb\ex]\ex{\the\tokc}}% + \ex\ex\ex}\ex\ex\ex{\ex\ex\ex\@nameauth@FullNametrue% + \ex\ex\ex\NameauthLName\ex\ex\ex[\ex\the\ex\tokb\ex]\ex{\the\tokc}}% \ex\ex\ex\csgdef\ex\ex\ex{\ex\ex\ex S\ex\ex\ex\arga% - \ex\ex\ex}\ex\ex\ex{\ex\ex\ex\NameauthFName\ex\ex\ex[% + \ex\ex\ex}\ex\ex\ex{\ex\ex\ex\@nameauth@FirstNametrue% + \ex\ex\ex\NameauthFName\ex\ex\ex[% \ex\the\ex\tokb\ex]\ex{\the\tokc}}% \fi \else @@ -1094,10 +1240,12 @@ \ex\ex\ex{\ex\ex\ex\NameauthName\ex\ex\ex{\ex\the\ex\tokc\ex}% \ex[\the\tokd]}% \ex\ex\ex\csgdef\ex\ex\ex{\ex\ex\ex L\ex\ex\ex\arga% - \ex\ex\ex}\ex\ex\ex{\ex\ex\ex\NameauthName% - \ex\ex\ex*\ex\ex\ex{\ex\the\ex\tokc\ex}\ex[\the\tokd]}% + \ex\ex\ex}\ex\ex\ex{\ex\ex\ex\@nameauth@FullNametrue% + \ex\ex\ex\NameauthLName\ex\ex\ex{% + \ex\the\ex\tokc\ex}\ex[\the\tokd]}% \ex\ex\ex\csgdef\ex\ex\ex{\ex\ex\ex S\ex\ex\ex\arga% - \ex\ex\ex}\ex\ex\ex{\ex\ex\ex\NameauthFName\ex\ex\ex{% + \ex\ex\ex}\ex\ex\ex{\ex\ex\ex\@nameauth@FirstNametrue% + \ex\ex\ex\NameauthFName\ex\ex\ex{% \ex\the\ex\tokc\ex}\ex[\the\tokd]}% \else \ex\ex\ex\ex\ex\ex\ex\csgdef\ex\ex\ex\ex\ex\ex\ex{% @@ -1108,12 +1256,14 @@ \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\NameauthName\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\tokb% \ex\ex\ex]\ex\ex\ex{\ex\the\ex\tokc\ex}\ex[\the\tokd]}% \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\@nameauth@FirstNametrue% \ex\ex\ex\ex\ex\ex\ex\NameauthFName\ex\ex\ex\ex\ex\ex\ex[% \ex\ex\ex\the\ex\ex\ex\tokb\ex\ex\ex]% \ex\ex\ex{\ex\the\ex\tokc\ex}\ex[\the\tokd]}% @@ -1125,7 +1275,7 @@ }\ignorespaces% }{\endgroup\ignorespaces} %% -%% Copyright (C) 2015 by Charles P. Schaum <charles dot schaum at comcast dot net> +%% Copyright (C) 2016 by Charles P. Schaum <charles dot schaum at comcast dot net> %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License (LPPL), either |