summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/nameauth/nameauth.dtx
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2015-07-11 22:21:46 +0000
committerKarl Berry <karl@freefriends.org>2015-07-11 22:21:46 +0000
commitd951ff19d719f6e02f9e6eb48a5c19f1b94c2076 (patch)
tree8933313275283add3efc658b8a8468f2a5effada /Master/texmf-dist/source/latex/nameauth/nameauth.dtx
parentf94a0ae45b3e579bab72300a7b4ad72d038af610 (diff)
nameauth (11jul15)
git-svn-id: svn://tug.org/texlive/trunk@37840 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/source/latex/nameauth/nameauth.dtx')
-rw-r--r--Master/texmf-dist/source/latex/nameauth/nameauth.dtx1697
1 files changed, 999 insertions, 698 deletions
diff --git a/Master/texmf-dist/source/latex/nameauth/nameauth.dtx b/Master/texmf-dist/source/latex/nameauth/nameauth.dtx
index 36e0b5b5f7e..d4a81496bf6 100644
--- a/Master/texmf-dist/source/latex/nameauth/nameauth.dtx
+++ b/Master/texmf-dist/source/latex/nameauth/nameauth.dtx
@@ -26,7 +26,7 @@
%<package>\NeedsTeXFormat{LaTeX2e}[2005/12/01]
%<package>\ProvidesPackage{nameauth}
%<*package>
- [2013/09/19 v1.8 name authority macros to aid consistent display and indexing of names]
+ [2015/07/09 v1.9 name authority macros to aid consistent display and indexing of names]
%</package>
%
%<*driver>
@@ -58,7 +58,7 @@
\usepackage{makeidx}
\usepackage{multicol}
\usepackage[toc]{multitoc}
-\usepackage{nameauth}[2013/09/19]
+\usepackage{nameauth}[2015/07/09]
\usepackage{hypdoc}
\usepackage{tikz}
\makeindex
@@ -77,11 +77,31 @@
\< Konoe & Fumimaro & Konoe & >
\< Yamt & & Yamamoto, Isoroku & >
\< Yosh & & Yoshida & Shigeru >
+ \< Einstein & Albert & Einstein & >
+ \< Cicero & M.T. & Cicero & >
+ \< Confucius & & Confucius & >
+ \< CBald & & Charles, the Bald & >
+ \< Smith & John & Smith & >
+ \< JQP & J.Q. & Public & >
+ \< Patton & George S. & Patton, Jr. & >
+ \< Francis & & Francis, I & >
+ \< Dem & & Demetrius, I Soter & >
+ \< Sun & & Sun, Yat-sen & >
+ \< Plato & & Plato & >
+ \< Henry & & Henry & VIII >
+ \< Ptol & & Ptolemy & I Soter >
+ \< Mao & & Mao & Tse-tung >
+ \< DLM & Walter & de la Mare & >
+ \< JWG & Johann Wolfgang von & Goethe & >
+ \< Harnack & Adolf & Harnack & >
\end{nameauth}
-\TagName{Louis}[the Pious]{, emperor}
+\TagName{Antiochus, IV}{ Epiphanes, king}
+\TagName{Chiang}[Kai-shek]{, president}
+\TagName{Sun, Yat-sen}{, president}
+\TagName{Mao}[Tse-tung]{, chairman}
\TagName{Ptolemy I}[Soter]{, king}
\TagName{Henry}[VIII]{, king}
-\TagName{Charles}[the Bald]{, emperor}
+\TagName{Charles, the Bald}{, emperor}
\TagName{Francis, I}{, king}
\TagName{Demetrius, I Soter}{, king}
\TagName{Charles, V}{, emperor}
@@ -93,6 +113,9 @@
\TagName{Gregory, I}{, pope}
\TagName[Fumimaro]{Konoe}{, PM}
\TagName{Yoshida}[Shigeru]{, PM}
+\TagName[James Earl]{Carter, Jr.}{, president}
+\TagName[John]{Smith}{*}
+\TagName[J.Q.]{Public}{*}
\begin{document}
\DocInput{nameauth.dtx}
\PrintChanges
@@ -101,7 +124,7 @@
%</driver>
% \fi
%
-% \CheckSum{1678}
+% \CheckSum{1821}
%
% \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
@@ -119,25 +142,25 @@
% Grave accent \` Left brace \{ Vertical bar \|
% Right brace \} Tilde \~}
%
-%
% \changes{v0.7}{2011/12/26}{Initial version}
-% \changes{v0.75}{2012/01/19}{New features added and described}
-% \changes{v0.8}{2012/01/29}{Improved function and compatibility; added quick start guide}
-% \changes{v0.85}{2012/02/05}{Added comma suppression, new class options, and more functionality}
-% \changes{v0.86}{2012/02/06}{Fixed some regressions}
-% \changes{v0.9}{2012/02/10}{Added first name formatting; comma and suffix handling expandable}
-% \changes{v0.94}{2012/02/15}{Build with all major \LaTeX{} engines; Added index suppression, error checking, name particle caps}
+% \changes{v0.75}{2012/01/19}{Add new features.}
+% \changes{v0.8}{2012/01/29}{Improve functionality, compatibility, and docs.}
+% \changes{v0.85}{2012/02/05}{Add comma suppression, new options, more features.}
+% \changes{v0.86}{2012/02/06}{Fix regressions.}
+% \changes{v0.9}{2012/02/10}{Add first name formatting; comma and affix handling expandable.}
+% \changes{v0.94}{2012/02/15}{Build with all major \LaTeX{} engines. add index suppression, error checking, name particle caps.}
% \changes{v0.95}{2012/02/17}{Bugfixes}
% \changes{v0.96}{2012/02/19}{Bugfixes}
-% \changes{v1.0}{2012/02/20}{Works fully with \textsf{microtype} and \textsf{memoir}}
-% \changes{v1.1}{2012/03/08}{Fixed errors when emitting warnings}
-% \changes{v1.2}{2012/03/25}{Added tagging features; extensively edited documentation}
-% \changes{v1.26}{2012/04/24}{First-letter caps fixed; fixed sorting of name suffixes in index}
-% \changes{v1.4}{2012/07/24}{Fixed issues moving argument problems, added several features}
-% \changes{v1.5}{2013/02/22}{Minor bugfixes; added several features}
-% \changes{v1.6}{2013/03/10}{Added |nameauth| environment}
-% \changes{v1.7}{2013/04/02}{Change options processing to prevent errors}
-% \changes{v1.8}{2013/09/19}{Document undesirable behavior of protected accenting macros in names}
+% \changes{v1.0}{2012/02/20}{Works fully with \textsf{microtype} and \textsf{memoir}.}
+% \changes{v1.1}{2012/03/08}{Fix errors when emitting warnings.}
+% \changes{v1.2}{2012/03/25}{Add tagging features; improve documentation.}
+% \changes{v1.26}{2012/04/24}{Fix first-letter caps \& sorting of name affixes in index.}
+% \changes{v1.4}{2012/07/24}{Fix moving arguments \& other bugs; add features.}
+% \changes{v1.5}{2013/02/22}{Minor bugfixes; add features.}
+% \changes{v1.6}{2013/03/10}{Add |nameauth| environment.}
+% \changes{v1.7}{2013/04/02}{Change options processing to prevent errors.}
+% \changes{v1.8}{2013/09/19}{Warn users to avoid protected accenting macros in names.}
+% \changes{v1.9}{2015/07/09}{Improve Eastern name support. Fix potential name collisions with the simplified interface. Ensure global undefining of names and tags. Rewrite documentation.}
%
% \DoNotIndex{\@empty, \@gobble, \@period, \@token, \protected@edef, \zap@space, \bfseries, \bgroup, \csgdef, \csname, \csundef, \DeclareOption, \def, \detokenize, \edef, \egroup, \else, \endcsname, \endinput, \ExecuteOptions, \expandafter, \fi, \Forenames, \futurelet, \hbox, \if, \ifcsname, \ifx, \ignorespaces, \index, \itshape, \leavevmode, \let, \newcommand, \newcommandx, \newenvironment, \newif, \PackageWarning, \ProcessOptions, \relax, \renewcommand, \RequirePackage, \scshape, \space, \textbackslash, \uppercase, \WithSuffix}
%
@@ -148,150 +171,244 @@
% \maketitle
%
% \begin{abstract}
-% \noindent The \textsf{nameauth} package automates the formatting and indexing of names, facilitating the implementation of a \textbf{name authority}. This allows one to move blocks of text without retyping names, making it easier to go from drafts to a final manuscript. This package mainly supports Western names, with basic features for ancient, royal, and Eastern names.
+% \noindent The \textsf{nameauth} package automates the formatting and indexing of names.\footnote{I omit the ``Implementation'' section to show the naming macros with a ``normal'' index.} This aids the use of a \textbf{name authority} and the process of textual reordering and revision without needing to retype name references.
% \end{abstract}
%
% \tableofcontents
%
% \section{Introduction}
%
-% Book-length studies can engage more than 500 different names. Editors and proofreaders cost money when checking those names. This package provides basic tools for consistently and automatically formatting names for the body text and the index. The goal is to reduce error, streamline work, and become a more cost-effective author. Features include:
+% \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 Format, print, and index names all at once.
-% \item Automatically print a full name the first time it appears, with full or shorter forms thereafter.
-% \item Automatically apply typesetting to names, recalling German \emph{Sperr\-druck}.
-% \item Rearrange text without retyping the names therein.
-% \item Allow predictable name variants in the text, yet index consistent name forms, thus abstracting the concept of a name.
-% \item Provide for some cross-cultural features in name ordering, capitalization, and indexing.
-% \item ``Tag'' and ``untag'' names in the index in order to index different people with the same name.
-% \item Macros can be used in the body text, in a \cmd{\marginpar}, in tabular material, and in list environments like \texttt{enumerate}, among others.
+% \item Simultaneously format, display, and index names.
+% \item Change the syntactic format, typographical display, and other name features without retyping names.
+% \item Display first and subsequent uses of names for professional writing. Default is a full name for the first use and shorter forms thereafter.
+% \item Apply various custom typesetting formats to fit your needs without retyping names.
+% \item Move text without retyping names.
+% \item Show name variants in the text, yet index consistent name forms.
+% \item Process different names according to cross-cultural naming conventions. These include mononyms, names with epithets, names with particles, and Eastern names in addition to basic Western names.
+% \item Allow for different capitalizing and other conventions.
+% \item Index different people with the same name by using a tag feature.
+% \item Process names in list environments and other special environments.
% \end{itemize}
% \end{multicols}
%
-% \subsection{Design Notes and Thanks}
+% I started using \LaTeX\ and wrote this package for translating old German and Latin texts. Only in recent years have WYSIWYG apps become useful here. I learned much more than I expected regarding different \LaTeX\ typesetting engines, different font systems, different indexing programs, different package interactions, and different naming conventions. In order to meet my cross-cultural needs amid such challenges, I encountered some technical restrictions:
%
-% This package depends on \textsf{etoolbox}, \textsf{suffix}, \textsf{trimspaces}, and \textsf{xargs}. As of version 1.4 it has been refactored extensively with robustness and modularity in mind. It has been tested with \textsf{latex}, \textsf{lualatex}, \textsf{pdflatex} and \textsf{xelatex}. It will work with \textsf{makeindex} and \textsf{texindy}. This document was typeset with \ifxetex\textsf{xelatex}\else\ifluatex\ifpdf\textsf{lualatex} in \texttt{pdf} mode\else\textsf{lualatex} in \texttt{dvi} mode\fi\else\ifpdf\textsf{pdflatex}\else\textsf{latex}\fi\fi\fi{} and \textsf{makeindex}.
+% Please avoid using control sequences like \cmd{\protected@edef} and \cmd{\noexpand} in names because this package uses \cmd{\protected@edef} as it parses its input (cf. Section~\ref{sec:accents}). This is done in order to get name display and indexing to work under the constraints mentioned above. I advise the casual user not to perform a ``torture test'' on this package like I do in this manual.
%
-% Thanks to \Name[Marc van]{Dongen}, \Name[Enrico]{Gregorio}, \Name[Philipp]{Stephani}, \Name[Heiko]{Oberdiek}, \Name[Uwe]{Lueck}, and \Name[Robert]{Schlicht} for their assistance. The light of their knowledge banished the umbra of my ignorance.
+% This package depends on \textsf{etoolbox}, \textsf{suffix}, \textsf{trimspaces}, and \textsf{xargs}. It has been tested with \textsf{latex}, \textsf{lualatex}, \textsf{pdflatex} and \textsf{xelatex}. It will work with \textsf{makeindex} and \textsf{texindy}. This manual was typeset with \ifxetex\textsf{xelatex}\else\ifluatex\ifpdf\textsf{lualatex} in \texttt{pdf} mode\else\textsf{lualatex} in \texttt{dvi} mode\fi\else\ifpdf\textsf{pdflatex}\else\textsf{latex}\fi\fi\fi{} and \textsf{makeindex}.
%
-% \subsection{Disclaimer}
-% This documentation uses names of living and historical figures because users refer to real people in their projects. At no time herein 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.
-% \subsection{Caveat}
-% Throughout this manual I perform a ``torture test'' of sorts on several macros in this package, disregarding the advice I offer the reader. General authors may never encounter some of these cases, as in Sections~\ref{sec:formatting} and~\ref{sec:Tweaks}.
-% \clearpage
+% 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.
+%
+% 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.
+%
+% Thanks to \Name[Marc van]{Dongen}, \Name[Enrico]{Gregorio}, \Name[Philipp]{Stephani}, \Name[Heiko]{Oberdiek}, \Name[Uwe]{Lueck}, and \Name[Robert]{Schlicht} for their assistance.
+%
+% \subsection{What's In A Name?}
+% \label{sec:NameTypes}
+%
+% Here a name denotes a person. Apart from historical and cultural contexts, name forms are ambiguous. The \textsf{nameauth} package uses Boolean switches and macros to show names in specific contexts without the need to retype the names.
+%
+% We see three categories of names, shown below. For special cases, one might have to decide how to handle 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. Some publications call for the first use of a name to be typeset differently than subsequent uses. The subsequent package options set broad parameters for such needs.\\
+%
+%\begin{tikzpicture}[line/.style={draw,thick}]
+% \node [matrix] (macro) at (0,1)
+% {
+% \node(type){\strut Western name:}; &
+% \node(arg1){\strut\textbf{Forename(s)}}; &
+% \node(arg2){\strut\textbf{Surname(s)}}; &
+% \node(arg3){\strut\textbf{Sobriquet, etc.}};\\
+% };
+% \node [matrix,column sep=1em] (tipsii) at (1,-2)
+% {
+% \node[align=left](a1)
+% {
+% Personal name(s):\\
+% \textit{baptismal name}\\
+% \textit{Christian name}\\
+% \textit{first and middle}\\\quad\textit{names}\\
+% \textit{praenomen}\\
+% }; &
+% \node[align=left](a2)
+% {
+% Family designator:\\
+% \textit{father's family}\\
+% \textit{mother's family}\\
+% \textit{ancestor}\\
+% \textit{occupation}\\
+% \textit{place of origin}\\
+% \textit{territory}\\
+% \textit{nomen/cognomen}\\
+% \textit{patronym}\\
+% }; &
+% \node[align=left](a3)
+% {
+% Sobriquet / title:\\
+% \textit{senior, junior, III\dots}\\
+% \textit{notable feature}\\
+% \textit{notable attribute}\\
+% \textit{place of origin}\\
+% \textit{territory}\\
+% \textit{agnomen}\\
+% }; \\
+% };
+% \begin{scope}[every path/.style=line]
+% \path (arg1) -- (a1);
+% \path (arg2) -- (a2);
+% \path (arg3) -- (a3);
+% \end{scope}
+%\end{tikzpicture}
+%
+%\begin{tikzpicture}[line/.style={draw,thick}]
+% \node [matrix] (macro) at (0,1)
+% {
+% \node(type){\strut Eastern name:}; &
+% \node(arg1){\strut\textbf{Family name}}; &
+% \node(arg2){\strut\textbf{Given name}};\\
+% };
+% \node [matrix,column sep=1em] (tipsii) at (2,-1)
+% {
+% \node[align=left](a1)
+% {
+% Family designator\\
+% }; & & & & &
+% \node[align=left](a2)
+% {
+% (Multiple names are rare, but multi-\\character names do exist.)\\
+% };\\
+% };
+% \begin{scope}[every path/.style=line]
+% \path (arg1) -- (a1);
+% \path (arg2) -- (a2);
+% \end{scope}
+%\end{tikzpicture}
+%
+%\begin{tikzpicture}[line/.style={draw,thick}]
+% \node [matrix] (macro) at (0,1)
+% {
+% \node(type){\strut Ancient name:}; &
+% \node(arg1){\strut\textbf{Given name}}; &
+% \node(arg2){\strut\textbf{Sobriquet, etc.}};\\
+% };
+% \node [matrix,column sep=1em] (tipsii) at (1,-1.5)
+% {
+% \node[align=left](a1)
+% {
+% Personal name\\
+% }; & & & & &
+% \node[align=left](a2)
+% {
+% Sobriquet / title:\\
+% \textit{senior, junior, III\dots}\\
+% \textit{notable feature}\\
+% \textit{notable attribute}\\
+% \textit{place of origin}\\
+% \textit{territory}\\
+% }; \\
+% };
+% \begin{scope}[every path/.style=line]
+% \path (arg1) -- (a1);
+% \path (arg2) -- (a2);
+% \end{scope}
+%\end{tikzpicture}
%
% \section{Usage}
%
% \subsection{Package Options}
% \label{sec:options}
-% Package options fall into several categories. Default options are in boldface:\\
-%
-% \begin{tabular}{p{0.2\textwidth}p{0.6\textwidth}}
-% & {\large\bfseries Show/Hide Suffix Commas}\\[1ex]
-% \bfseries\texttt{nocomma} & \bfseries Suppress commas between surnames and suffixes, following modern styles like \emph{Chicago Manual of Style}. Commas can be forced on a per-use basis with \cmd{\ShowComma}. See Section~\ref{sec:suffix}.\\[1ex]
-% \texttt{comma} & Retain commas between all surnames and suffixes. This imposes limits on certain macros.\\[2ex]
-% \end{tabular}
%
-% \noindent These options are the ``most global'' because they affect names in both the text and the index. The |comma| option, meant for use with older texts, restricts name forms and available macros. The \cmd{\ShowComma} macro allows the general benefits of |nocomma| while allowing the more limited |comma| behavior on a per-use basis at the cost of greater complexity.
+% Package options are designed to address how one expects name data to be entered, how names are displayed both semantically and typographically, and how they are indexed in different document sections. \textbf{Default options are in boldface}:\\
%
-%The above options are meant to be invoked at load time and left alone thereafter. Below we start those options that represent states of behavior capable of being toggled on and off.\\
-%
-% \begin{tabular}{p{0.2\textwidth}p{0.6\textwidth}}
-% & {\large\bfseries Enable/Disable Formatting}\\[1ex]
-% \bfseries\texttt{mainmatter} & \bfseries Enable formatting attributes (see below), starting at the beginning of a document.\\[1ex]
-% \texttt{frontmatter} & Disable formatting \emph{before} the invocation of \cmd{\NamesActive} while retaining automatic full and short forms. This option fits well, e.g., with a foreword from a contributor. See Section~\ref{sec:SectionFormat}.\\[1ex]
-% & {\large\bfseries Enable/Disable Indexing}\\[1ex]
-% \bfseries\texttt{index} & \bfseries Create index entries in place with names.\\[1ex]
-% \texttt{noindex} & Prevent indexing before the invocation of the macro \cmd{\IndexActive}. See Section~\ref{sec:SectionIndex}.\\[2ex]
-% \end{tabular}
+%\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 only at load time. The default |nocomma| option works better with Eastern names and modern standards, \emph{e.g.}, \Name[James Earl]{Carter, Jr.}. The |comma| option works with Western names and older standards, putting a comma before affixes, \emph{e.g.}, \ForgetName[James Earl]{Carter, Jr.}\ShowComma\Name[James Earl]{Carter, Jr.}. One can switch options without retyping names and force commas with \cmd{\ShowComma} (Section~\ref{sec:Affix}).
%
-% The options above broadly affect whether formatting and indexing are ``on'' or ``off.'' They set the initial states of formatting and indexing, which can be toggled on and off respectively with \cmd{\NamesActive} and \cmd{\IndexActive} on the one hand and \cmd{\NamesInactive} and \cmd{\IndexInactive} on the other.
+% Before version 0.9 the \textsf{nameauth} package assumed the |comma| option and its limits on \cmd{\AKA} and \cmd{\PName}. The older syntax remains only for backward compatibility.\\
%
-% This package makes a distinction between \textit{formatting}, i.e., font weight, style, family, placement, and so on, and \textit{form}, i.e., capitalization and name order. The options on the next page alter the printing and capitalization of names apart from their formatting, but they do not change index entries:
+% \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. See Section~\ref{sec:SectionFormat}.\\[2ex]
+% \end{tabular}\\
+% The default starts formatting names immediately. The |frontmatter| option is equivalent to \cmd{\NamesInactive}. It disables typographic name formatting until formatting is enabled with \cmd{\NamesActive}. It has no effect on syntactic name formatting, \emph{i.e.}, the use of longer or shorter names depending on the context. It is designed for material provided by editors and contributors.\\
%
-% \begin{tabular}{p{0.2\textwidth}p{0.6\textwidth}}
-% & {\large\bfseries Capitalize Entire Surnames}\\[1ex]
-% \bfseries\texttt{normalcaps} & \bfseries Do not perform any special capitalization.\\[1ex]
-% \texttt{allcaps} & Capitalize entire surnames in the manner of some romanized Japanese contexts. Note that this only affects the printed form; no capitalization occurs in the index. In that case, the user should type in the caps manually.\\[1ex]
-% & {\large\bfseries Reverse Name Order}\\[1ex]
-% \bfseries\texttt{notreversed} & \bfseries Print names in the order specified by \cmd{\Name} and the other macros.\\[1ex]
-% \texttt{allreversed} & Print name forms in ``smart'' reverse order. See Sections~\ref{sec:suffix} and~\ref{sec:Eastern}.\\[1ex]
-% \texttt{allrevcomma} & Not the same as the |comma| option or the \cmd{\ShowComma} macro. This causes all names to print in reverse Western order, with a comma between the surname and the other names.\\[2ex]
-% \end{tabular}
+% \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. See Section~\ref{sec:SectionIndex}.\\[2ex]
+% \end{tabular}\\
+% The default starts indexing names right away. The |noindex| option is equivalent to \cmd{\IndexInactive}. It disables the indexing of names until \cmd{\IndexActive} enables it. This applies only to naming and indexing macros in the \textsf{nameauth} package.
+% \clearpage
%
-% Macros that toggle the states represented by these options include \cmd{\AllCapsActive} and \cmd{\AllCapsInactive} for capitalizing entire surnames, \cmd{\ReverseActive} and \cmd{\ReverseInactive} for reversing name order, and \cmd{\ReverseCommaActive} and \cmd{\ReverseCommaInactive} to aid making lists in last-comma-first order. An even finer grain of control exists with the macros \cmd{\CapName}, \cmd{\RevName}, and \cmd{\RevComma}, which activate these features on a per-use basis.\\
+% \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, \emph{e.g.}, romanized Eastern names. See Section~\ref{sec:Eastern}. \\[2ex]
+% \end{tabular}\\
+% This only affects the body text. To get caps in both the body text and the index, the user should type in the caps manually. Section-level control of family name capitalization occurs with \cmd{\AllCapsActive} and \cmd{\AllCapsInactive}. \cmd{\CapName} has the same effect on the individual instance of a name.\medskip
%
-% \begin{tabular}{p{0.2\textwidth}p{0.6\textwidth}}
-% & {\large\bfseries Formatting Attributes}\\[1ex]
-% \texttt{alwaysformat} & With the \texttt{mainmatter} option or after \cmd{\NamesActive}, this option causes the formatting options below to affect every occurrence of \cmd{\Name}, not just the first use of a name. This recalls some contexts where German \emph{Sperrdruck} is used. See also the material on custom formatting (Section~\ref{sec:formatting}).\\[1ex]
-% \bfseries\texttt{smallcaps} & \bfseries Set the first use of a name in small caps.\\[1ex]
-% \texttt{italic} & Italicize the first occurrence of a name.\\[1ex]
-% \texttt{boldface} & Set the first use of a name in boldface.\\[1ex]
-% \texttt{noformat} & This is a ``do nothing'' format that merely suppresses the ``look'' of formatting without disabling the mechanism itself.\\
-% \end{tabular}
+% \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. See Sections~\ref{sec:Affix} and~\ref{sec:Eastern}.\\[1ex]
+% \quad\texttt{allrevcomma} & Print all names in Western ``Surname, Forenames'' order. See Section~\ref{sec:LastFirst}.\\[2ex]
+% \end{tabular}\\
+% \cmd{\ReverseActive} and \cmd{\ReverseInactive} are used for reversing name order at the section level. \cmd{\ReverseCommaActive} and \cmd{\ReverseCommaInactive} can be used to create lists for educators and officials in the Western-style last-comma-first order, which is \emph{not} the same as the |comma| option or \cmd{\ShowComma}. For individual instances of names, \cmd{\RevName} and \cmd{\RevComma} have the same respective effects.\medskip
+%
+% \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\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. See Section~\ref{sec: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.
% \clearpage
%
% \subsection{Quick Start Guide}
% \label{sec:start}
%
-% This page introduces basic concepts. The next pages offer simplified approaches and hints to avoid errors. Read the columns below in a left to right, top to bottom order. The basic patterns for \cmd{\Name}\oarg{arg1}\marg{arg2}\oarg{arg3} are:\\
+%\subsubsection{Main Interface}
+% \DescribeMacro{\Name}
+% The main workhorse of this package is \cmd{\Name.} More detail begins in Section~\ref{sec:Naming}. This overview shows 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}. Note again that the |nocomma| option generally works best, especially with Eastern, medieval, and ancient names.\\
%
+%\noindent{\large\bfseries Western Names}\\[1ex]
%\begin{tikzpicture}[line/.style={draw,thick}]
-% \node [matrix,column sep=4cm] (tipsi) at (3,3)
+% \node [matrix,column sep=4cm] (tipsi) at (1.5,2.5)
% {
-% \node[text width=2cm,align=left](opt){\footnotesize Add to force full name.}; &
-% \node[text width=4cm,align=left](grp){\footnotesize Add before immediately subsequent |[|text in brackets|]| if \meta{arg3} not used; else omit.}; \\
+% \node(opt){\quad\small Add to force full name.}; &
+% \node[text width=3cm,align=left](grp){\small Add only if text in brackets |[ ]| follows.}; \\
% };
% \node [matrix] (macro) at (2,1)
% {
-% \node(cmd){\bfseries\texttt{\textbackslash Name}}; &
+% \node(cmd){\bfseries\cmd{\Name}}; &
% \node(star){\bfseries\texttt{*}}; &
-% \node(arg1){\bfseries\texttt{[}\textit{arg1}\texttt{]}}; &
-% \node(arg2){\bfseries\texttt{\{}\textit{arg2}\texttt{\}}}; &
-% \node(arg3){\bfseries\texttt{[}\textit{arg3}\texttt{]}}; &
-% \node(braces){\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 (3,-2.5)
+% \node [matrix,column sep=1em] (tipsii) at (1.5,-1)
% {
% \node[align=left](a1)
% {
-% \textit{forename(s)}\\
-% \textit{forename(s)}\\
-% \textit{forename(s)}\\
-% \textit{forename(s)}\\
-% \meta{empty}\\
-% \meta{empty}\\
-% \meta{empty}\\
-% \textit{Eastern FNN}\\
-% \meta{empty}\\
-% \meta{empty}\\
+% Forename(s)\\used in index\\(\emph{e.g.}: initials,\\legal name)
% }; & & &
% \node[align=left](a2)
% {
-% \textit{surname(s)}\\
-% \textit{surname(s)}\texttt{, }\textit{Suffix}$^1$\\
-% \textit{surname(s)}\\
-% \textit{surname(s)}\texttt{, }\textit{Suffix}$^1$\\
-% \textit{mononym}\\
-% \textit{mononym}\texttt{, }\textit{Affix}$^1$\\
-% \textit{mononym}\\
-% \textit{Eastern SNN}$^4$\\
-% \textit{Eastern SNN}\texttt{, }\textit{FNN}$^{1,5}$\\
-% \textit{Eastern SNN}\\
+% Surname(s)\\Surname(s)|,| Affix
% }; & &
% \node[align=left](a3)
% {
-% \meta{empty}\\
-% \meta{empty}\\
-% \textit{Nickname(s)}$^2$\\
-% \textit{Nickname(s)}$^2$\\
-% \meta{empty}\\
-% \meta{empty}\\
-% \textit{Affix}$^3$\\
-% \meta{empty}\\
-% \meta{empty}\\
-% \textit{Eastern FNN}$^{3,5}$\\
+% \meta{empty}\\Nickname(s)\\Full forenames, etc.
% }; \\
% };
% \begin{scope}[every path/.style=line]
@@ -303,42 +420,128 @@
% \end{scope}
%\end{tikzpicture}
%
-% \indent\textsuperscript{1}The pattern \cmd{\Name}\oarg{forenames}\marg{surnames, suffix} and all patterns thereafter with the mandatory argument \meta{Name$_1$, Name$_2$} cannot be used with the |comma| option or in an instance where \cmd{\ShowComma} is used.\\[1ex]
-% \indent\textsuperscript{2}The presence of a nickname is determined when both forename and nickname are present. In that case, the latter is swapped with the former.\\[1ex]
-% \indent\textsuperscript{3}When \meta{arg1} is empty, \meta{arg3} is an affix. That form cannot be used with \cmd{\PName} and \cmd{\AKA}, but it does work with |comma| and \cmd{\ShowComma}.\\[1ex]
-% \indent\textsuperscript{4}When expressing Eastern names via \cmd{\Name}\oarg{Eastern FNN}\marg{Eastern SNN}, they will appear in the index as the Western form \meta{SNN, FNN} even if \cmd{\RevName} is used to create an Eastern word order in the text.\\[1ex]
-% \indent\textsuperscript{5}When expressing Eastern names using the form \cmd{\Name}\marg{Eastern SNN, FNN} or \cmd{\Name}\marg{Eastern SNN}\oarg{Eastern FNN}, such names will appear in the index using the Eastern form \meta{SNN FNN} even if \cmd{\RevName} is used to create a Western word order in the text.\\[1.5ex]
-% \indent If given the choice, use the |nocomma| option and the \meta{Name$_1$, Name$_2$} forms for suffixes and affixes in order to take advantage of extra space removal and other features that minimize possible errors.
-% \clearpage
+% \noindent Use \cmd{\Name}\oarg{FNN}\marg{SNN} and \cmd{\Name}\oarg{FNN}\marg{SNN|,| Affix}. For nicknames and alternate forenames use \cmd{\Name}\oarg{FNN}\marg{SNN}\oarg{Alternate FNN} and \cmd{\Name}\oarg{FNN}\marg{SNN|,| Affix}\oarg{Alternate FNN}. The \meta{Alternate FNN} are swapped with the non-empty \meta{FNN}, but only in the body text. The older, obsolete syntax is \cmd{\Name}\marg{SNN}\oarg{Affix}.
%
-% \DescribeMacro{nameauth} A simplified interface has been introduced as of version 1.6. The |nameauth| environment (best used in the document preamble) sets up a list of shorthands used in place of \cmd{\Name}, \cmd{\Name*}, and \cmd{\FName}. The syntax is:
+%\begin{multicols}{2}
+%\noindent{\large\bfseries Eastern Names in the Text, Western-style Index}\\[1ex]
+%\begin{tikzpicture}[line/.style={draw,thick}]
+% \node [matrix,column sep=1em] (tipsi) at (0,2)
+% {
+% \node(opt){\small For full name.}; &
+% \node(grp){\small If brackets follow.}; \\
+% };
+% \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}
+% One uses the |allreversed| option or \cmd{\ReverseActive} or \cmd{\RevName} as appropriate (see above). The names in the body text will be in Eastern order, while they are indexed in Western fashion: \meta{SNN}, \meta{FNN}. This is the ``non-native'' form of Eastern names.\columnbreak
+%
+%\noindent{\large\bfseries Eastern Names in the Text, Eastern-style Index}\\[1ex]
+%\begin{tikzpicture}[line/.style={draw,thick}]
+% \node [matrix,column sep=1em] (tipsi) at (0,2)
+% {
+% \node(opt){\small For full name.}; &
+% \node(grp){\small If brackets follow.}; \\
+% };
+% \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[align=left](a1)
+% {
+% \quad Family name
+% }; &
+% \node[align=left](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}
+%
+% \noindent These names names will appear in the index using the Eastern form \meta{SNN FNN} even if \cmd{\RevName} and friends are used to create a Western-order name in the body text. This is the ``native'' form of Eastern names. The older, obsolete syntax is \cmd{\Name}\marg{SNN}\oarg{FNN}
+%\end{multicols}
+%\clearpage
+%\noindent{\large\bfseries Ancient Names}\\[-1.5ex]
+%\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=3cm,align=left](a1){\small Mononym\break Mononym, Affix}; &
+% \node[text width=3cm,align=left](grp){\small Add only if text in brackets |[ ]| follows.}; \\
+% };
+% \node [matrix] (macro) at (1,1)
+% {
+% \node(cmd){\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}
+%
+% \noindent Use the forms \cmd{\Name}\marg{Mononym} or \cmd{\Name}\marg{Mononym|,| Affix}. The older, obsolete syntax is \cmd{\Name}\marg{Mononym}\oarg{Affix}.\vspace{-1.5ex}
+%
+% \subsubsection{Simplefied Interface}
+%
+% \DescribeMacro{nameauth} The |nameauth| environment saves typing via shorthands. It is best used in the document preamble. Otherwise one must add |%| at the end of each line.\vspace{-1ex}
%
% \begin{quote}
% |\begin{nameauth}|\\
-% | \<| \meta{cseq-abbreviation1} |&| \meta{arg1} |&| \meta{arg2} |&| \meta{arg3} |>|\\
-% | \<| \meta{cseq-abbreviation2} |&| \meta{arg1} |&| \meta{arg2} |&| \meta{arg3} |>| \dots\\
+% | \<| \meta{cseq1} |&| \meta{arg1} |&| \meta{arg2} |&| \meta{arg3} |>|\\
+% | \<| \meta{cseq2} |&| \meta{arg1} |&| \meta{arg2} |&| \meta{arg3} |>| \dots\\
% |\end{nameauth}|
-% \end{quote}
-% Each instance of \meta{cseq-abbreviation} creates three macros. The control sequence itself is an abbreviation for \cmd{\Name}. The form with an L prefixed stands in for \cmd{\Name*}. The form with an S prefixed stands in for \cmd{\FName}. There must be four arguments per line. Placement of ampersands is key to avoiding error. Leading and trailing spaces are stripped.
+% \end{quote}\vspace{-1ex}
+% Each \meta{cseq} creates three macros. |\|\meta{cseq} itself calls \cmd{\Name}. |\L|\meta{cseq} (think ``Long'') calls \cmd{\Name*}. |\S|\meta{cseq} (think ``Short'') calls \cmd{\FName}. In the text, include trailing braces |{|\,|}| if text in brackets |[|\,|]| follows. Leading and trailing spaces in each field are stripped. There \emph{must} be four argument fields per line:\vspace{-0.5ex}
%
-% The next example shows most of the name forms from the previous page:
% \begin{quote}
-%|\begin{nameauth}|\\
-%| \< Wash & George & Washington & >|\\
-%| \< Soto & Hernando & de Soto & >|\\
-%| \< JRock & John David & Rockefeller, II & >|\\
-%| \< JayR & John David & Rockefeller, IV & Jay >|\\
-%| \< Aris & & Aristotle & >|\\
-%| \< Eliz & & Elizabeth, I & >|\\
-%| \< Dagb & & Dagobert & I >|\\
-%| \< Konoe & Fumimaro & Konoe & >|\\
-%| \< Yamt & & Yamamoto, Isoroku & >|\\
-%| \< Yosh & & Yoshida & Shigeru >|\\
+%|\begin{nameauth}|\\[0.2ex]
+%| \< Wash & George & Washington & >|\hfill\emph{Western}\\[0.2ex]
+%| \< Soto & Hernando & de Soto & >|\hfill\emph{particle}\\[0.2ex]
+%| \< JRock & John David & Rockefeller, II & >|\hfill\emph{affix}\\[0.2ex]
+%| \< JayR & John David & Rockefeller, IV & Jay >|\hfill\emph{nickname}\footnote{Careful here! \cmd{\SJayR} always gives ``Jay.'' See Section \ref{sec:Fname}.}\\[0.2ex]
+%| \< Aris & & Aristotle & >|\hfill\emph{ancient}\\[0.2ex]
+%| \< Eliz & & Elizabeth, I & >|\hfill\emph{royal}\\[0.2ex]
+%| \< Konoe & Fumimaro & Konoe & >|\hfill\emph{Eastern/Western index}\\[0.2ex]
+%| \< Yamt & & Yamamoto, Isoroku & >|\hfill\emph{Eastern/Eastern index}\\[0.2ex]
%|\end{nameauth}|
-% \end{quote}
-%
-% This example allows one to do the following:
-%
+% \end{quote}\vspace{-2ex}
% \begin{multicols}{2}
% \noindent|\Wash|: \Wash \\
% |\Wash|: \Wash \\
@@ -351,75 +554,85 @@
% |\JRock|: \JRock \\
% |\JRock|: \JRock \\
% |\JayR|: \JayR \\
-% |\SJayR{} \JayR|: \SJayR{} \JayR\\
+% |\SJayR\ \JayR|: \SJayR\ \JayR\\[1ex]
% |\Aris|: \Aris \\
% |\Eliz|: \Eliz \\
% |\Eliz|: \Eliz \\
-% |\Dagb|: \Dagb \\
-% |\Dagb|: \Dagb \\
% |\Konoe|: \Konoe \\
% |\RevName\LKonoe|: \RevName\LKonoe \\
% |\CapName\LKonoe|: \CapName\LKonoe \\
% |\CapName\RevName\LKonoe|: \\ \indent\CapName\RevName\LKonoe \\
-% |\CapName\Yamt|: \\ \indent\CapName\Yamt \\
+% |\Yamt|: \Yamt \\
+% |\CapName\LYamt|: \\ \indent\CapName\LYamt \\
% |\RevName\LYamt|: \RevName\LYamt \\
-% |\Yosh|: \Yosh
% \end{multicols}
%
-% As with |\TagName|, one must add extra comment delimiters if the environment is used in the text body. This environment can augment the other macros.
-% \subsubsection{Additional Hints}
-% \IndexInactive\NamesInactive
-% \begin{tabular}{lp{4in}}
-% Q:&Too many macros! I quit.\\[0.5ex]
-% A:&The macro you will use the most is \cmd{\Name}. Just use it until you discover that you need one of the other macros.\\[1ex]
-% Q:&I see ``Paragraph ended\dots'' or ``Missing \meta{grouping token} inserted'' and execution stops.\\[0.5ex]
-% A:&Check that the |{|braces|}| and |[|brackets|]| are balanced.\\[1ex]
-% Q:&There is too much space between the initials in the names.\\[0.5ex]
-% A:&Bringhurst's \emph{Elements of Typographic Style} calls for no spaces or thin spaces between initials. Use \cmd{\frenchspacing}.\\[1ex]
-% Q:&|\Name[Davey]{Jones}[a Monkee]| shows ``\Name[Davey]{Jones}[a Monkee]'' or just ``\Name[Davey]{Jones}[a Monkee].'' \cmd{\FName} gives ``\FName[Davey]{Jones}[a Monkee].''\\[0.5ex]
-% A:&\cmd{\Name}\oarg{Forenames}\marg{Surnames}\oarg{Nicknames} creates a nickname, not an affix or sobriquet.\\[1ex]
-% Q:&|\Name[Henry]{VIII}| prints either ``\Name*[Henry]{VIII}'' or ``\Name[Henry]{VIII}.'' Adding [Tudor] creates ``\Name*[Henry]{VIII}[Tudor]'' and ``\Name[Henry]{VIII}[Tudor].''\\[0.5ex]
-% A:&\cmd{\Name}\oarg{King}\marg{Affix} will not work. Even though Mulvany, \emph{Indexing Books}, talks about forenames and optional surnames for royals, we prevent ambiguity by encoding royal names as surnames with optional affixes. Use \cmd{\Name}\marg{King, Affix} if possible, or \cmd{\Name}\marg{King}\oarg{Affix} with the |comma| option. For example, |\Name{Henry, VIII}| gives ``\Name{Henry, VIII}'' and ``\Name{Henry, VIII}.'' Manually add ``Tudor'' in the text and use |\TagName{Henry, VIII}{, Tudor}| to add the tag automatically to the index entry.\ForgetName[Henry]{VIII}\ForgetName{Henry, VIII}\\[1ex]
-% Q:&|\Name{Aethelred, the really}[Unraedig]| shows ``\Name{Aethelred, the really}[Unraedig]'' or ``\Name{Aethelred, the really}[Unraedig].''\\[0.5ex]
-% A:&The form \cmd{\Name}\marg{Mononym, Affix\/$_1$}\oarg{Affix\/$_2$} creates two sobriquets, but badly. Use either \cmd{\Name}\marg{Mononym, Affix} or \cmd{\Name}\marg{Mononym}\oarg{Affix} with |comma|. Mix the forms either at your peril or at your whimsy.\\[1ex]
-% Q:&|\AKA{Boris}[the Animal]{Just Boris}| fails.\\[0.5ex]
-% A:&\cmd{\AKA} fails with the \marg{Mononym}\oarg{Affix} pattern in order to avoid the collision of optional arguments. See Section~\ref{sec:AKA}.\\[1ex]
-% Q:&So how do I deal with some stage names and the like?\\[0.5ex]
-% A:&Use a forename or first initials to prevent failure:\\[0.5ex]
-% &OK: |\Name[J.]{Kreskin}[The Amazing] |\Name[J.]{Kreskin}[The Amazing]\\&\quad|(\AKA[J.]{Kreskin}[Joseph]{Kresge})| (\AKA[J.]{Kreskin}[Joseph]{Kresge})\\[0.5ex]
-% &FAIL: |\Name{Kreskin}[The Amazing]|\\&\qquad|\AKA{Kreskin}[Joseph]{Kresge}|\\[1ex]
-% \end{tabular}
+% \subsubsection{Older Syntax}
%
-% \begin{tabular}{lp{4in}}
-% Q:&How do I refer to ``\SubvertName[Mike]{Tyson}\FName[Mike]{Tyson}[Iron Mike]'' \Name[Mike]{Tyson}?\\[0.5ex]
-% A:&Very carefully. One way uses |``\SubvertName[Mike]{Tyson}| |\FName[Mike]{Tyson}[Iron Mike]''| |\Name[Mike]{Tyson}| to produce the text above. Other manual methods are discussed on page \pageref{manualxref}. Using |``\AKA[Mike]{Tyson}{Iron Mike}''| creates ``\AKA[Mike]{Tyson}{Iron Mike}'' in the text and a \emph{see}-type cross-reference to the main name in the index.\\[1ex]
-% Q:&\cmd{\Name} has a full name in the source, but it is shorter in the text!\\[0.5ex]
-% A:&And you did not mean that to happen. Use \cmd{\Name*} in that case. It can be easy to forget that \cmd{\Name} auto-formats its arguments even if you type them out.\\[1ex]
-% \end{tabular}
-% \IndexActive\NamesActive
+% An older form of syntax remains for backward compatibility with early versions, especially with the |comma| option. It lacks some of the error checking and robustness of the new syntax and limits the use of several macros. Never mix the older and newer syntax! For the sake of completeness we have:
+%
+% \begin{quote}
+% |\Name{Dagobert}[I]|\hfill\emph{royal name}\\[0.5ex]
+% |\Name{Yoshida}[Shigeru]|\hfill\emph{Eastern name}\\[0.5ex]
+% |\begin{nameauth}|\\[0.5ex]
+% | \< Dagb & & Dagobert & I >|\hfill\emph{royal name}\\[0.5ex]
+% | \< Yosh & & Yoshida & Shigeru >|\hfill\emph{Eastern name}\\[0.5ex]
+%|\end{nameauth}|
+% \end{quote}
+%
+% \begin{multicols}{2}
+% \noindent|\Dagb|: \Dagb \\
+% |\Dagb|: \Dagb \\
+% |\LDagb|: \LDagb \\
+% |\CapName\Yosh|: \CapName\Yosh\\
+% |\CapName\RevName\LYosh|: \\ \indent\CapName\RevName\LYosh
+% \end{multicols}
+%
+% \begin{itemize}
+% \item This older syntax could produce weird results. |\Name{Henry}[VIII]| prints ``\Name{Henry}[VIII]'' and ``\Name{Henry}[VIII]'' as expected. \IndexInactive Using |\Name[Henry]{VIII}| (an error) prints either ``\Name*[Henry]{VIII}'' or just ``\Name[Henry]{VIII}.'' Both |\Name{Henry}[VIII]| and |\Name[Henry]{VIII}| produce the same ``first-use'' control sequence. |\Name[Henry]{VIII}[Tudor]| gives ``\Name*[Henry]{VIII}[Tudor]'' and ``\Name[Henry]{VIII}[Tudor].''
+%
+% The newer syntax fixes many of these problems. |\Name{Henry, VIII}| gives ``\Name{Henry, VIII}'' and ``\Name{Henry, VIII}.'' It produces unambiguous control sequences and index entries from those above. Avoid |\Name{Henry, VIII}[Tudor]|; this gives ``\Name*{Henry, VIII}[Tudor]'' and ``\Name{Henry, VIII}[Tudor]'' in the text and ``Henry VIII'' in the index. Instead of that, add ``Tudor'' manually to |\Name{Henry, VIII}| in the text and use a tag in the index (Section \ref{sec:TagName}).
+%
+% \item Avoid mixing the older and newer syntax! |\Name{Mononym, Affix}| and |\Name{Mononym}[Affix]| are different names! You get both \Name{Mononym, Affix} and \Name{Mononym}[Affix]. Index tags for |\Name*[Henry]{VIII}| will not work with |\Name{Henry, VIII}|, and vice versa.\ForgetName{Henry}[VIII]\ForgetName[Henry]{VIII}\ForgetName{Henry, VIII}
+%
+% \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. |\Name{Boris,| |the| |Animal}| |\AKA{Boris,| |the| |Animal}{Just| |Boris}| works, and you get \Name{Boris, the Animal} being ``\AKA{Boris, the Animal}{Just Boris}.''
+% \end{itemize}
+% \clearpage
%
-% \subsubsection{Error Handling}
+% \subsubsection{Tips and Warnings}
% \label{sec:error}
%
-% Version 1.5 introduces space removal in \meta{Name$_1$, Name$_2$} pairs that mitigates problems in both the text and in the index. Older versions of \texttt{nameauth} were susceptible to fragility and moving arguments. Version 1.4 and later of \textsf{nameauth} address many of these issues.
+% \begin{itemize}
+% \item Keep it simple! Avoid macros that you do not need.
%
-% Except for the indexing parts of macros, most of the macros in this package print any erroneous arguments in the text, but not in the index. To find errors, one can look at index entries for irregularities or examine package warnings. Unless there is a syntax error, all macros that produce output also emit meaningful warnings. Convenience macros like \cmd{\PName} produce warnings via their component macros, e.g., \cmd{\Name} and \cmd{\AKA}.
+% \item Use the simplified interface or check your use of braces and brackets with naming macros to avoid execution halting and errors like ``Paragraph ended\dots'' and ``Missing \meta{grouping token} inserted.''
%
-% Not all warnings are created equal. For example, the multiple creation of a cross-reference with \cmd{\AKA} will generate a warning, but it will have no ill effects and may be intentional. Other warnings, especially in the case of indexing macros, indicate that the macro produced no output.\\
+% \item For stage names, etc., try using, \emph{e.g.}, |\Name[J.]{Kreskin}[The Amazing]| |(\AKA[J.]{Kreskin}[Joseph]{Kresge})|. You get \Name[J.]{Kreskin}[The Amazing] (\AKA[J.]{Kreskin}[Joseph]{Kresge}), with ``Kreskin, J.'' in the index. You must have initials or something in the first optional field for this to work, or else it will fail.
+%
+% \item Special cases like \textsc{``Iron Mike'' Tyson}\IndexName[Mike]{Tyson} can be handled with the intricate use of \cmd{\ForgetName} and \cmd{\SubvertName}, but it is easier to use manual formatting along with \cmd{\IndexName}. Using |``\AKA[Mike]{Tyson}{Iron Mike}''| creates ``\AKA[Mike]{Tyson}{Iron Mike}'' in the text and a \emph{see}-type cross-reference to the main name in the index. See Section~\ref{sec:AKA}.
+%
+% \item Avoid spaces between initials in first names. Either use \cmd{\frenchspacing} or \emph{consistently} put fractional spaces between them. See also Bringhurst's \emph{Elements of Typographic Style}.
+%
+% \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 Not all warnings are created equal. For example, \cmd{\AKA} warns one if used multiple times for the same name. That may or may not be what one wants and is left to the author. Other warnings, especially in the case of indexing macros, indicate that the macro produced no output.\\
+% \end{itemize}
%
% \noindent Warnings result from:
%
% \begin{enumerate}\setlength{\itemsep}{-0.4ex}
% \item Using a cross-reference \oarg{alternate FNN}\marg{alternate SNN}\oarg{alt. names} created by \cmd{\AKA} as a reference in \cmd{\Name}, \cmd{\FName}, and \cmd{\PName}.
-% \item Using a reference \oarg{FNN}\marg{SNN}\oarg{alternate names} created by \cmd{\Name}, \cmd{\FName}, and \cmd{\PName} as a cross-reference in \cmd{\AKA}.
+% \item Using a reference \oarg{FNN}\marg{SNN}\oarg{Alternate names} created by \cmd{\Name}, \cmd{\FName}, and \cmd{\PName} as a cross-reference in \cmd{\AKA}.
% \item Using \cmd{\AKA} to create the same cross-reference multiple times.
% \item Using \cmd{\IndexName} to index a cross-reference as a main entry.
% \item Using \cmd{\TagName} to tag a cross-reference.
% \item Using \cmd{\ExcludeName} to exclude a name that has already been used.
+% \item Using \cmd{\Name}, \cmd{\FName}, \cmd{\PName}, and \cmd{\AKA} to refer to names and cross-references excluded by \cmd{\ExcludeName}.
% \end{enumerate}
% \clearpage
%
% \subsection{Naming Macros}
+% \label{sec:Naming}
%
% \subsubsection{Surnames: \texttt{\textbackslash Name} and \texttt{\textbackslash Name*}}
%
@@ -428,11 +641,11 @@
% This macro generates two forms of the name: a printed form in the text and a form of the name that occurs in the index.
% The general syntax is:
% \begin{quote}
-% \cmd{\Name}\oarg{forename(s)}\marg{surname(s)}\oarg{alternate names}\\
-% \cmd{\Name*}\oarg{forename(s)}\marg{surname(s)}\oarg{alternate names}
+% \cmd{\Name}\oarg{FNN}\marg{SNN}\oarg{Alternate names}\\
+% \cmd{\Name*}\oarg{FNN}\marg{SNN}\oarg{Alternate names}
% \end{quote}
%
-% From now on we will abbreviate \meta{forename(s)} with \meta{FNN} and \meta{surname(s)} with \meta{SNN} at various points. The following table helps to show how the syntax description works with first and subsequent references:
+% \noindent Here we see how the syntax works:
%
% \begin{quote}\small
% \begin{tabular}{ll}\hline
@@ -440,35 +653,43 @@
% {\large\strut}|\Name*[Albert]{Einstein}| & \Name*[Albert]{Einstein}\\
% {\large\strut}|\Name[Albert]{Einstein}| & \Name[Albert]{Einstein}\\\hline
% {\large\strut}|\Name{Confucius}| & \Name{Confucius}\\
-% {\large\strut}|\Name*{Confucius}| & \Name{Confucius}\\
-% {\large\strut}|\Name{Confucius}| & \Name*{Confucius}\\\hline
+% {\large\strut}|\Name*{Confucius}| & \Name*{Confucius}\\
+% {\large\strut}|\Name{Confucius}| & \Name{Confucius}\\\hline
% {\large\strut}|\Name[M.T.]{Cicero}[Marcus Tullius]| & \Name[M.T.]{Cicero}[Marcus Tullius]\\
% {\large\strut}|\Name*[M.T.]{Cicero}[Marcus Tullius]| & \Name*[M.T.]{Cicero}[Marcus Tullius]\\
% {\large\strut}|\Name[M.T.]{Cicero}[Marcus Tullius]| & \Name[M.T.]{Cicero}[Marcus Tullius]\\\hline
-% {\large\strut}|\Name{Charles}[the Bald]| & \Name{Charles}[the Bald]\\
-% {\large\strut}|\Name*{Charles}[the Bald]| & \Name*{Charles}[the Bald]\\
-% {\large\strut}|\Name{Charles}[the Bald]| & \Name{Charles}[the Bald]\\\hline
+% {\large\strut}|\Name{Charles, the Bald}| & \Name{Charles, the Bald}\\
+% {\large\strut}|\Name*{Charles, the Bald}| & \Name*{Charles, the Bald}\\
+% {\large\strut}|\Name{Charles, the Bald}| & \Name{Charles, the Bald}\\\hline
% \end{tabular}
% \end{quote}
%
-% \cmd{\Name} connects the \meta{FNN} to the \meta{SNN} to create respective printed and indexed forms, as illustrated in Section~\ref{sec:PatRef} and thereafter. The invocation of \cmd{\Name} always prints the \meta{SNN} field. \cmd{\Name} prints the ``full name'' at the first occurrence, then only the partial form thereafter. \cmd{\Name*} always prints the full name.
+% \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.
%
-% Nicknames and sobriquets of some historical figures are implemented in slightly different ways. A nickname assumes the presence of \meta{FNN} and \meta{SNN} (see the example for \Name[M.T.]{Cicero}[Marcus Tullius] above). The \meta{alternate names} field allows a nickname to replace the \meta{FNN} field in the text while keeping the \meta{FNN} field in the index. Nicknames are truly optional. As long as the \meta{FNN} and \meta{SNN} fields are consistent, the index entries will be consistent. The shorter name printed by \cmd{\Name} will not print forenames or nicknames. See also Section~\ref{sec:start} and \cmd{\FName} below.
+% The \meta{Alternate names} field replaces the \meta{FNN} field in the text only if the \meta{FNN} field is not empty; see the example for \Name[M.T.]{Cicero}[Marcus Tullius] above. One can use a nickname in some instances while keeping the indexed form constant. Thus, |\Name[M.T.]{Cicero}[Marcus Tullius]| and |\Name[M.T.]{Cicero}| are equivalent, while |\Name{Cicero}[Marcus Tullius]| and |\Name{Cicero}| are not. If you are using the newer syntax, avoid forms like |\Name{Charles}[the Bald]|.
%
-% In the example of \Name*{Charles}[the Bald] above, ``the Bald'' is not a nickname because no \meta{FNN} are present. In that case the \meta{alternate names} field is appended to the \meta{SNN} in both the printed form \emph{and} in the index form. This behavior implies that, while ``the Bald'' uses an optional parameter, it is not truly optional once used.
-%
-% Later we shall see that a similar effect, perhaps more preferable, can be achieved with the default \texttt{nocomma} option and |\Name{Charles, the Bald}|, as seen in Section~\ref{sec:suffix}. One must always be consistent in using these forms. Otherwise one may get bogus index entries and errors in the text that are difficult to track.
-% \clearpage
+% \begin{quote}
+%|\begin{nameauth}% In the preamble!|\\[0.2ex]
+%| \< Einstein & Albert & Einstein & >|\\[0.2ex]
+%| \< Cicero & M.T. & Cicero & >|\\[0.2ex]
+%| \< Confucius & & Confucius & >|\\[0.2ex]
+%| \< CBald & & Charles, the Bald & >|\\[0.2ex]
+%|\end{nameauth}|
+%\end{quote}
%
+% \ForgetName[Albert]{Einstein}\ForgetName{Confucius}\ForgetName[M.T.]{Cicero}\ForgetName{Charles, the Bald}%
+% Above we see the same setup with the new interface in the preamble. In the body text, |\Einstein, \LEinstein, and \Einstein| produce \Einstein, \LEinstein, and \Einstein. |\CBald\ and \CBald| give \CBald\ and \CBald. In the next section we shall see why |\Cicero[Marcus Tullius]| is preferred to get \Cicero[Marcus Tullius].
% \subsubsection{Forenames: \texttt{\textbackslash FName}}
+% \label{sec:Fname}
%
% \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:
% \begin{quote}
-% \cmd{\FName}\oarg{FNN}\marg{SNN}\oarg{alternate names}
+% \cmd{\FName}\oarg{FNN}\marg{SNN}\oarg{Alternate names}
% \end{quote}
-% The following table shows the output at a glance:\ForgetName[Albert]{Einstein}\ForgetName{Confucius}\ForgetName[M.T.]{Cicero}\ForgetName{Charles}[the Bald]
+% 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. You must type the first name and then use \cmd{\IndexName}. For examples we see below:
+% \ForgetName[Albert]{Einstein}\ForgetName{Confucius}\ForgetName[M.T.]{Cicero}\ForgetName{Charles, the Bald}%
%
% \begin{quote}\small
% \begin{tabular}{ll}\hline
@@ -478,45 +699,67 @@
% {\large\strut}|\FName{Confucius}|& \FName{Confucius}\\\hline
% {\large\strut}|\FName[M.T.]{Cicero}[Marcus Tullius]| & \FName[M.T.]{Cicero}[Marcus Tullius]\\
% {\large\strut}|\FName[M.T.]{Cicero}[Marcus Tullius]| & \FName[M.T.]{Cicero}[Marcus Tullius]\\\hline
-% {\large\strut}|\FName{Charles}[the Bald]| & \FName{Charles}[the Bald]\\
-% {\large\strut}|\FName{Charles}[the Bald]| & \FName{Charles}[the Bald]\\\hline
-% \end{tabular}
+% {\large\strut}|\FName{Charles, the Bald}| & \FName{Charles, the Bald}\\
+% {\large\strut}|\FName{Charles, the Bald}| & \FName{Charles, the Bald}\\\hline
+% \end{tabular}\\
% \end{quote}
%
-% See how the first reference is a full name? That prevents an accidental reference to a first name before a person has been introduced. Nicknames are used by including them in the \meta{alternate names} field in addition to \meta{FNN}. For example, aviation hero \Name[Chesley B.]{Sullenberger, III} can be noted as:
+% Nicknames are used instead of the regular first names by including them in the \meta{Alternate names} field. For example, when writing of aviation hero \Name[Chesley B.]{Sullenberger, III} use |``\FName[Chesley B.]{Sullenberger, III}[Sully]''| to get the nickname ``\FName[Chesley B.]{Sullenberger, III}[Sully].''
%
-% \begin{quote}|``\FName[Chesley B.]{Sullenberger, III}[Sully]''|\quad``\FName[Chesley B.]{Sullenberger, III}[Sully]''\end{quote}
-%
-%\noindent A good way to cut keystrokes would be to assign the above macro to the control sequence \cmd{\Sully}.
+% With the simplified interface, |\SEinstein, \SConfucius, and \SCBald| give \SEinstein, \SConfucius, and \SCBald. You must choose whether you want the nickname or the formal name as the default. For example:
+% \begin{nameauth}%
+% \< Ches & Chesley B. & Sullenberger, III & >%
+% \< Sully & Chesley B. & Sullenberger, III & Sully >%
+% \end{nameauth}%
+% \begin{quote}
+% |\begin{nameauth}|\\
+% | \< Ches & Chesley B. & Sullenberger, III & >|\\
+% | \< Sully & Chesley B. & Sullenberger, III & Sully >|\\
+%|\end{nameauth}|
+% \end{quote}
+% Subsequent references to |\SChes| produce ``\SChes.'' Subsequent references to |\SSully| produce ``\SSully.'' Now here it gets tricky: |\SChes[Sully]| gives ``\SChes[Sully]'' as expected. However, |\SSully[Chesley B.]| expands to what it says, not what you mean: |\FName[Chesley B.]{Sullenberger, III}[Sully][Chesley B.]|. That clearly gives you ``\SSully[Chesley B.].'' Use the nickname field with caution!
%
% \subsubsection{Full Stop Detection}
%
-% Suffixes and initials could result in the period of an abbreviation like ``Jr.,'' ``Sr.,'' and ``d.\,\"{A}.'' (\textit{der \"{A}ltere}) followed by the sentence full stop. These macros check for such collisions and drop the extra full stop as needed:
+% Affixes and initials could result in the period of an abbreviation like ``Jr.,'' ``Sr.,'' ``d.\,J.'' (\textit{der J\"ungere}), and ``d.\,\"A.'' (\textit{der \"Altere}) followed by the sentence full stop. These macros check for such collisions and drop the extra full stop as needed:
%
% \begin{quote}\small\ForgetName[Martin Luther]{King, Jr.}
% \begin{tabular}{ll}
% {\large\strut}|\Name[Martin Luther]{King, Jr.}.| & \Name[Martin Luther]{King, Jr.}.\\
% {\large\strut}|\Name[Martin Luther]{King, Jr.}.| & \Name[Martin Luther]{King, Jr.}.\\
-% {\large\strut}|\Name[Martin Luther]{King, Jr.}| & \Name[Martin Luther]{King, Jr.} (e.g., in a sentence)\\
+% {\large\strut}|\Name[Martin Luther]{King, Jr.}| & \Name[Martin Luther]{King, Jr.} (\emph{e.g.}, in a sentence)\\
% {\large\strut}|\Name*[Martin Luther]{King, Jr.}.| & \Name*[Martin Luther]{King, Jr.}.\\
% {\large\strut}|\Name*[Martin Luther]{King, Jr.}| & \Name*[Martin Luther]{King, Jr.}
% \end{tabular}
% \end{quote}
-% \IndexInactive
%
-% See Section~\ref{sec:suffix} for more on comma-delimited suffixes. Full-stop detection also works with \cmd{\FName} in cases like the fictional \FName[J.R.]{Wing, III} where one might discuss |``who shot \FName[J.R.]{Wing, III}.''| ``who shot \FName[J.R.]{Wing, III}.''\IndexActive
+% \noindent Full-stop detection also works with \cmd{\FName}. If a name reference is enclosed, \emph{e.g.}, between grouping tokens, detection will not work.
%
% \subsection{Affixes and Eastern Names}
%
-% \subsubsection{Comma-Delimited Suffixes}
-% \label{sec:suffix}
+% \subsubsection{Comma-Delimited Affixes}
+% \label{sec:Affix}
%
-% Before we consider the topic of non-Western names, we must first engage the concept of suffixes and affixes as expressed in the \meta{Name$_1$, Name$_2$} pattern used in the mandatory argument of \cmd{\Name}.
+% Comma-delimited affixes handle several different name types. The first is Western names with affixes. One must use |\Name[Oskar]{Hammerstein, II}| to get \Name[Oskar]{Hammerstein, II} and \Name[Oskar]{Hammerstein, II}. \emph{Always include a comma as an affix delimiter.} Extra spaces and trailing commas are ignored. Other name types include royal, medieval, and Eastern names:
+%
+% \begin{quote}\ForgetName{Sun, Yat-sen}
+% \begin{tabular}{ll}\hline
+% {\large\strut}|\Name{Louis, XIV}| & \Name{Louis, XIV}\\
+% {\large\strut}|\Name{Louis, XIV}| & \Name{Louis, XIV}\\\hline
+% {\large\strut}|\Name{Sun, Yat-sen}| & \Name{Sun, Yat-sen}\\
+% {\large\strut}|\Name{Sun, Yat-sen}| & \Name{Sun, Yat-sen}\\\hline
+% \end{tabular}
+% \end{quote}
+%
+% One can type |\Name*{Louis, XIV}, the| |``\AKA{Louis, XIV}{Sun King}''| and get \Name*{Louis, XIV}, the ``\AKA{Louis, XIV}{Sun King}'' in the text with an appropriate \emph{see} reference from ``Sun King'' to ``Louis XIV'' in the index (Section \ref{sec:AKA}).
+%
+% \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.
%
% \DescribeMacro{\ShowComma}
-% The |comma| option is restrictive, but helpful in reproducing older texts. \cmd{\ShowComma} permits the default |nocomma| option, yet forces a comma to appear between the name and suffix: |\ShowComma\Name[Louis]{Gossett, Jr.}| \ShowComma\Name[Louis]{Gossett, Jr.}. A caveat is that one must use \cmd{\ShowComma} consistently with that name thereafter or risk errors.
+% 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 |comma| option and \cmd{\ShowComma} restrict the use of some royal names and Eastern names. \cmd{\AKA} and \cmd{\PName} cannot create cross-references to these forms, but \cmd{\AKA} can cross-reference \emph{from} these forms in its second set of arguments. These restricted forms are shown below:
+% Avoid using the older syntax, shown below. 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. Thus we have:
%
% \begin{quote}\ForgetName{Henry}[VIII]
% \begin{tabular}{ll}\hline
@@ -526,111 +769,96 @@
% {\large\strut}|\Name{Chiang}[Kai-shek]| & \Name{Chiang}[Kai-shek]\\\hline
% \end{tabular}
% \end{quote}
-%
-% \noindent We remember that these forms work because no \meta{FNN} are present, only the \cmd{\Name}\marg{mononym}\oarg{affix} type pattern. Of course, the mononym field can have more than one word in it, as can the affix.
-%
-% Using the default package option \texttt{nocomma} with comma-delimited suffixes offers a more robust method that can handle several different name types quite flexibly. We begin with the idea of a name and a suffix. One cannot write |\Name[Oskar]{Hammerstein}[II]| without getting the likes of ``II Hammerstein.'' On the other hand, |\Name[Oskar]{Hammerstein, II}| produces \Name[Oskar]{Hammerstein, II} the first time and \Name[Oskar]{Hammerstein, II} thereafter. One must always include a comma as a suffix delimiter; trailing commas are ignored. Automatic space removal and formatting helps reduce potential error.
-%
-% We can move beyond suffixes to work with more complex examples, including royal names and basic Eastern name forms:
-%
-% \begin{quote}\ForgetName{Sun, Yat-sen}
-% \begin{tabular}{ll}\hline
-% {\large\strut}|\Name{Louis, XIV}| & \Name{Louis, XIV}\\
-% {\large\strut}|\Name{Louis, XIV}| & \Name{Louis, XIV}\\\hline
-% {\large\strut}|\Name{Sun, Yat-sen}| & \Name{Sun, Yat-sen}\\
-% {\large\strut}|\Name{Sun, Yat-sen}| & \Name{Sun, Yat-sen}\\\hline
-% \end{tabular}
-% \end{quote}
-%
-% \noindent The benefit to using this form is that one can type |\Name*{Louis, XIV}, the| |``\AKA{Louis, XIV}{Sun King}''| and get \Name*{Louis, XIV}, the ``\AKA{Louis, XIV}{Sun King}'' in the text with an appropriate \emph{see} reference from ``Sun King'' to ``Louis XIV'' in the index. The first method shown above prevents such usage.
-%
-% Suffix and sobriquet features generally produce the same \emph{output}, yet internally they are \emph{different}. For example, they do not respect each other's first use. One can force them to cooperate, as in Section~\ref{sec:formatting}, but it is not trivial. Users should avoid mixing the two suffix methods shown here.
+% These older forms work because no \meta{FNN} are present. Otherwise you would get weird nicknames. Again, please avoid using the older syntax.
%
% \subsubsection{Eastern Names}
% \label{sec:Eastern}
%
-% This section will work with both \cmd{\Name}\marg{Eastern SNN}\oarg{Eastern FNN} and \cmd{\Name}\marg{Eastern SNN, Eastern FNN}. We have already shown the advantages of preferring the latter form. In particular, this section addresses some features seen in romanized Japanese contexts. Nevertheless, its use may be broader.
-%
-% One sees in many non-Western contexts that the family name comes first, followed by personal names. The \textsf{nameauth} package offers two routes to that result. Those routes depend on how \cmd{\Name} assembles index entries. \cmd{\Name}\oarg{Eastern FNN}\marg{Eastern SNN} will produce an index entry of the form \meta{Eastern SNN}, \meta{Eastern FNN}. There exists a comma between the names and the default output order is Western. We will see how to change that below.
+% The \textsf{nameauth} package offers two ways to handle romanized Eastern names. \cmd{\RevName}\cmd{\Name}\oarg{Eastern FNN}\marg{Eastern SNN} and equivalents will produce an Eastern name in the body text and the Western form \meta{SNN}, \meta{FNN} in the index, including the comma. One might call this ``non-native'' mode.
%
-% In contrast, both \cmd{\Name}\marg{Eastern SNN}\oarg{Eastern FNN} and \cmd{\Name}\marg{Eastern SNN, Eastern FNN} produce an index entry of the form \meta{Eastern SNN} \meta{Eastern FNN}. No comma is present in the latter form. Furthermore, in the latter two cases, the default output order is Eastern.
+% 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 form \meta{SNN} \meta{FNN} in the body text and index without any comma. This can be called ``native'' mode. The goal for offering these two ``modes'' is to allow for greatest flexibility in indexing requirements, not favoring one over another.
%
% \DescribeMacro{\ReverseActive}
% \DescribeMacro{\ReverseInactive}
% \DescribeMacro{\RevName}
-% The way we get these two methods to meet is the reverse output mechanism. One can use the class options described in Section~\ref{sec:options}. One may activate and deactivate reversal with \cmd{\ReverseActive} and \cmd{\ReverseInactive}. One also may activate reversal for one time with \cmd{\RevName}. Using these methods, Western word order can be made to look Eastern and vice-versa. Therefore, the key is to decide the index entry format and choose the name encoding.
+% The reverse output mechanism makes the ``non-native'' mode compatible with the ``native'' mode in the body text. One chooses the style of index entry desired, then uses the ``native'' or ``non-native'' approach as desired. In addition to the class options described in Section~\ref{sec:options}, \cmd{\ReverseActive} and \cmd{\ReverseInactive} toggle reversing on a larger scale, while \cmd{\RevName} is used once per \cmd{\Name}.
%
-% The reversing mechanism intelligently swaps name patterns. To illustrate this, we turn off indexing and name formatting and always use full names. A list of Japanese music artists allows us to use \cmd{\RevName}\cmd{\Name}\dots\ and some creativity:
+% A list of Japanese music artists illustrates the use of \cmd{\RevName}. Both \Name[Aiko]{Nakano} and \Name[Yoko]{Kanno} are listed in Western order, then ``non-native'' Eastern order. The others are all listed in ``native'' Eastern mode, then reversed to Western order. Their index entries reflect that:
%
-% \NamesInactive\IndexInactive
+% \NamesInactive
% \begin{quote}
% \begin{tabular}{lll}\hline
+% {\large\strut} & \emph{unchanged} & |\RevName|\\
% {\large\strut}|\Name*[Aiko]{Nakano}| & \Name*[Aiko]{Nakano} & \RevName\Name*[Aiko]{Nakano}\\
% {\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\IndexActive\medskip
+% \NamesActive
%
% \DescribeMacro{\AllCapsActive}
% \DescribeMacro{\AllCapsInctive}
% \DescribeMacro{\CapName}
-% \vskip-2.8ex Full capitalization of surnames occurs with \cmd{\AllCapsActive}, \cmd{\AllCapsInactive}, and \cmd{\CapName}. These macros are analogous to the reversing macros above and may be used alone or with those macros, e.g. \cmd{\CapName}\cmd{\RevName}\cmd{\Name}:
+% Use \cmd{\AllCapsActive}, \cmd{\AllCapsInactive}, and \cmd{\CapName} for fully-capitalized family names in the body text. These macros are analogous to the reversing macros above and may be used alone or with those macros, \emph{e.g.} \cmd{\CapName}\cmd{\RevName}\cmd{\Name}:
%
-% \NamesInactive\IndexInactive
+% \NamesInactive
% \begin{quote}
% \begin{tabular}{lll}\hline
+% {\large\strut} & \emph{unchanged} & |\CapName\RevName|\\
% {\large\strut}|\Name*[Yoko]{Kanno}| & \CapName\Name*[Yoko]{Kanno} & \CapName\RevName\Name*[Yoko]{Kanno}\\
% {\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\IndexActive
+% \NamesActive
%
-% The reversing and capitalization macros also work with \cmd{\AKA}. They affect only the text, not the index. Whoever wants all-cap forms in the index will have to cap everything manually or modify the macros.
+% The reversing and capitalization macros also work with \cmd{\AKA}. They affect only the text, not the index. Whoever wants all-cap forms in the index will have to capitalize everything manually or modify the macros. Note also that the above examples include the older syntax. Remember that index entries for \Name*[Aiko]{Nakano} and \Name*[Yoko]{Kanno} are Western-form; the others are Eastern-form.
%
% \subsection{Other Naming Topics}
%
% \subsubsection{Listing by Surname}
+% \label{sec:LastFirst}
%
%\DescribeMacro{\ReverseCommaActive}
%\DescribeMacro{\ReverseCommaInactive}
%\DescribeMacro{\RevComma}
-% Another set of reversing macros, \cmd{\ReverseCommaActive}, \cmd{\ReverseCommaInactive}, and \cmd{\RevComma}, allows the easy generation of lists with surnames, followed by a comma, then forenames. The first two are broad toggles, while the third works on a per-use basis. Here is a good place to show incompatibility between Eastern, medieval, and royal names on the one hand and Western names on the other. An indiscriminate use of \cmd{\RevComma}\cmd{\Name}\dots\ can yield:
+% Another set of reversing macros, \cmd{\ReverseCommaActive}, \cmd{\ReverseCommaInactive}, and \cmd{\RevComma}, allows the easy generation of lists with surnames, followed by a comma, then forenames. The first two are broad toggles, while the third works on a per-name basis. Here is a good place to show incompatibility between Eastern, medieval, and royal names on the one hand and Western names on the other. An indiscriminate use of \cmd{\RevComma}\cmd{\Name}\dots\ can yield:
%
% \NamesInactive
% \begin{quote}
% \begin{tabular}{lll}
-% {\large\strut}\Name*[Jeremy]{Bentham} & \RevComma\Name*[Jeremy]{Bentham} & OK\\
% {\large\strut}\Name*[J.S.]{Mill}[John Stuart] & \RevComma\Name*[J.S.]{Mill}[John Stuart] & OK\\
-% {\large\strut}\Name*{John, Eriugena} & \RevComma\Name*{John, Eriugena} & FAIL\\
-% {\large\strut}\Name*{Albertus}[Magnus] & \RevComma\Name*{Albertus}[Magnus] & FAIL\\
+% {\large\strut}\Name*[Oskar]{Hammerstein, II} & \RevComma\Name*[Oskar]{Hammerstein, II} & OK\\
+% {\large\strut}\Name*{John, Eriugena} & \RevComma\Name*{John, Eriugena} & medieval incompatible\\
+% {\large\strut}\Name*{Mao}[Tse-tung] & \RevComma\Name*{Mao}[Tse-tung] & Eastern inconpatible\\
% {\large\strut}\Name*{Anaximander} & \RevComma\Name*{Anaximander} & OK\\
% \end{tabular}
% \end{quote}
% \NamesActive
%
-% There is no way around this ``fail'' here because that is exactly what we want to happen in the case of Eastern names. It is not possible for this package to be all things to all names, but it tries to be as broad as possible.
+% It is not possible for this package to be all things to all names, but it tries in good faith to be as cross-cultural as possible.
%
% \subsubsection{Naming Standards}
%
% \DescribeMacro{\CapThis}
-% 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'} are capitalized unless preceded by \emph{de}. In English, these particles go in the \meta{SNN} field of \cmd{\Name}, e.g., \ForgetName[Walter]{de la Mare}\Name[Walter]{de la Mare}. To capitalize the first particle in a subsequent \cmd{\Name} reference at the beginning of a sentence, use |\CapThis\Name[Walter]{de la Mare}|. \CapThis\Name[Walter]{de la Mare} will think it fair. \CapThis\Name{du Cange} (\AKA{du Cange}[Charles]{du Fresne}) would too, because \cmd{\CapThis} works universally as of version 1.4.
+% 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}.
%
-% Names foreign to English often associate these particles with the \meta{FNN} field of \cmd{\Name}. Yet these particles are not really first names. Using \cmd{\FName} with alternate forenames avoids that issue. See also Section~\ref{sec:Particles}.
+% 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. Non-English contexts do not always bind particles to surnames. Using \cmd{\FName} with alternate forenames allows greater flexibility here. See Section~\ref{sec:Particles}.
%
-% \subsubsection{Hyphenation}
+% \subsubsection{Hints for \textsf{babel}}
+% \label{sec:babel}
%
-% I find it helpful to use respectively the \textsf{babel} or \textsf{polyglossia} packages with name hyphenation. If one is using English as the main language, the default hyphenation patterns may not suffice. For example, the name \Name[John]{Strietelmeier} may break thus: ``Stri-etelmeier.'' That is fixed by creating a \cmd{\de} macro equivalent to |\newcommand{\de}[1]{\foreignlanguage{ngerman}{#1}}| (using \textsf{babel}) and writing |\de{\Name[John]{Strietelmeier}}|.
+% The\marginpar{\raggedleft Hyphens} simplified interface trivializes the consistent insertion of optional hyphens in names arguments. Name hyphenation also can be aided by using the \textsf{babel} or \textsf{polyglossia} packages. With English as the main language, a name of German origin might break poorly. For example, \Name[John]{Strietelmeier} might break thus: ``Stri-\break etelmeier.'' Using |\newcommand{\de}[1]{\foreignlanguage{ngerman}{#1}}| and |\de{\Name[John]{Strietelmeier}}| (with \textsf{babel}) prevents such breaks.
%
-% One can insert optional hyphens in the arguments of \cmd{\Name} and friends but that must be done \emph{consistently} to avoid variants being treated as different names.
+% 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 \textsf{texindy} program will ignore all such references. This issue can affect \textsf{nameauth.} One workaround for \textsf{texindy} could enclose text with any macros that write to the index in an environment or a \cmd{\long} macro defined like:
+% \begin{quote}|\newcommand{\fix}[1]{\def\textlatin##1{##1}#1}|\end{quote}
%
% \subsubsection{Accented Names}
% \label{sec:accents}
%
-% If you use accented names, \textsf{xindy} (or \textsf{texindy}) and \textsf{xelatex} or \textsf{lualatex} are strongly recommended. Nevertheless, if using NFSS, the following Unicode characters are available using \textsf{inputenc}/\textsf{fontenc}:
+% Using \textsf{xindy} (\textsf{texindy}) and \textsf{xelatex} or \textsf{lualatex} is recommended for accented names. Under NFSS these Unicode characters are available (with \textsf{inputenc}/\textsf{fontenc}):
% \begin{quote}
% \begin{tabular}{llll}
% \scshape À Á Â Ã Ä Å Æ & \scshape Ç È É Ê Ë & \scshape Ì Í Î Ï Ð Ñ & \scshape first use \\
@@ -652,23 +880,20 @@
%
% One may use expandable control sequences in names (thanks \Name*[Robert]{Schlicht}). Protected or unexpandable control sequences via |\protected@edef| or |\noexpand| may generate, respectively, empty index entries or unbalanced groups/erroneous entries in the auxiliary files. Thanks to \Name[Patrick]{Cousot} for pointing this out.
%
-% To accomplish proper sorting with accents and |makeindex -g|, consider creating your own |.ist| file (pages 659--65 in \emph{The Latex Companion}) or:
-% \begin{quote}\small
-% |\IndexInactive\Name{|\meta{actual}|}\index{|\meta{sortkey}|@|\meta{actual}|}\IndexActive|
-% \end{quote}
+%This cannot be changed because \textsf{nameauth} uses |\protected@edef| when it parses the name parameters. This is needed to work with \textsf{makeindex}, \textsf{texindy}, \textsf{microtype}, and other packages and \LaTeX\ engines.
%
-% Additional accents and glyphs can be used with Unicode input, NFSS, \textsf{inputenc}, and \textsf{fontenc} when using fonts with TS1 glyphs, e.g., |\usepackage{lmodern}| (per the table on pages 455--63 in \emph{The Latex Companion}):
+% 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}):
% \begin{quote}
+% |\usepackage{newunicodechar}|\\
% |\DeclareTextSymbolDefault{\textlongs}{TS1}|\\
% |\DeclareTextSymbol{\textlongs}{TS1}{115}|\\
-% |\newunicodechar{s}{\textlongs}|
-% \end{quote}
-% Similarly, the following allows |\Name{Ghazāli}| to generate \IndexInactive\Name{Ghaz{\=a}li}\IndexActive.:
-% \begin{quote}
-% |\usepackage{newunicodechar}|\\
-% |\newunicodechar{ā}{\=a}|
+% |\newunicodechar{ſ}{\textlongs}|
% \end{quote}
-% Indexing with control sequences like |\=a| will fail, whether with \textsf{nameauth} or manually, when using \textsf{makeindex} and \texttt{gind.ist}. The equal sign becomes an ``actual'' character instead of the |@| (thanks \Name[Dan]{Luecking}).
+% That lets you type ``In Congreſs, July 4, 1776.'' Similarly, the following allows |\Name{Ghazāli}| to generate \IndexInactive\Name{Ghaz\=ali}\IndexActive: |\newunicodechar{ā}{\=a}|
+%
+% To get proper sorting with accents and |makeindex -g|, consider creating your own |.ist| file (pages 659--65 in \emph{The Latex Companion}) or the following form:\break |\IndexInactive\Name{|\meta{actual}|}\index{|\meta{sortkey}|@|\meta{actual}|}\IndexActive.|
+%
+% Control sequences like |\=a| fail when using \textsf{makeindex} and \texttt{gind.ist} because the equal sign is an ``actual'' character instead of |@|. |\index{Gh{\=a}zali}| halts execution. |\index{Gh\=azali}| gives an ``azali'' entry sorted under ``Gh'' (thanks \Name[Dan]{Luecking}). This issue is not specific to \textsf{nameauth}.
%
% This package tries to work with multiple languages and typesetting engines. The following preamble snippet illustrates how that can be done:\\
%
@@ -721,44 +946,31 @@
% |\makeatother|
% \end{quote}
%
-% \noindent This approach synchronizes the ``first use'' feature in the text and the footnotes, but only suppresses the formatting. It takes advantage of the deep nesting of \cmd{\@makefntext} and a localized \cmd{\def} to make a temporary change.
+% \noindent This approach synchronizes the ``first use'' feature in the text and the footnotes, but only suppresses the formatting. It takes advantage of the deep nesting of \cmd{\@makefntext} and a localized \cmd{\def} to make a temporary change.\smallskip
%
-% A second example puts the mention of first names in the margin if possible:
-% \begin{quote}
+% A second example puts the mention of first names in boldface, with additional notations in the margin if possible:
+%\begin{quote}
% |\let\oldformat\NamesFormat|\\
-% |\renewcommand{\NamesFormat}[1]{\textbf{#1}%|\\
-% |\ifinner\else\marginpar{\scriptsize #1}\fi}|
-% \let\oldformat\NamesFormat
+% |\renewcommand{\NamesFormat}[1]%|\\
+% \hbox to 1cm{\hfil}|{\textbf{#1}\ifinner\else%|\break
+% \hbox to 1cm{\hfil}|\marginpar{\raggedleft\scriptsize #1}\fi}|%
%
-% \renewcommand{\NamesFormat}[1]{\textbf{#1}\ifinner\else\marginpar{\scriptsize #1}\fi}%
-% \bgroup\small\ttfamily%
-% |\Name{Vlad III}[Dracula]| was known as Vlad Ţepeş, ``The Impaler,''\break after his death. He was the son of |\Name{Vlad II}%| |[Dracul]|, a\break member of the Order of the Dragon. Later references to\break |\Name{Vlad III}[Dracula]| appear thus.\egroup
-%
-% \Name{Vlad III}[Dracula] was known as Vlad Ţepeş, ``The Impaler,'' after his death. He 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 forms above do not work with \cmd{\PName} and \cmd{\AKA}. Consistently use either the suffix mechanism (Section~\ref{sec:suffix}) or see Section~\ref{sec:pennames} regarding manual entries. If you use the suffix mechanism, you would use the following forms:
-%
-%\begin{quote}\ForgetName{Vlad III}[Dracula]\ForgetName{Vlad II}[Dracul]
% \let\oldformat\NamesFormat%
-% \renewcommand{\NamesFormat}[1]{\textbf{#1}\ifinner\else\marginpar{\scriptsize #1}\fi}%
+% \renewcommand{\NamesFormat}[1]{\textbf{#1}\ifinner\else\marginpar{\raggedleft\scriptsize #1}\fi}%
% \bgroup\small\ttfamily%
% |\Name{Vlad III, Dracula}| was known as |\AKA{Vlad III, Dracula}%|\break|{Vlad}[Ţepeş]|, |``\AKA*{Vlad III, Dracula}{Vlad}[the Impaler],''|\break after his death. He was the son of |\Name{Vlad II, Dracul}|, a\break member of the Order of the Dragon. Later references to\break |\Name{Vlad III, Dracula}| appear thus.\egroup
%
-% \Name{Vlad III, Dracula} was known as \AKA{Vlad III, Dracula}%
-% {Vlad}[Ţepeş], ``\AKA*{Vlad III, Dracula}{Vlad}[the Impaler],'' after his death. He 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.
+% \Name{Vlad III, Dracula} was known as \AKA{Vlad III, Dracula}{Vlad}[Ţepeş], ``\AKA*{Vlad III, Dracula}{Vlad}[the Impaler],'' after his death. He 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 redefinition of \cmd{\NamesFormat} above follows scoping rules. Since I used it in a quote environment, it reverts to normal and now we have: \ForgetName{Vlad III}[Dracula]\Name{Vlad III}[Dracula]. Later references produce \Name{Vlad III}[Dracula]. The ``Dracula'' example was manipulated extensively with the tweaking macros \cmd{\ForgetName} and \cmd{\SubvertName}. Mixing the comma-delimited suffix and third-parameter affix forms might cause errors.
+% The |quote| environment permits local changes to \cmd{\NamesFormat} so they revert back to give: \ForgetName{Vlad III, Dracula}\Name{Vlad III, Dracula} and \Name{Vlad III, Dracula}. For references to ``Vlad'' one could use |\Name{Vlad, III Dracula}| instead. Do not mix |\Name{Vlad III, Dracula}| with |\Name{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.
%
% \subsubsection{Disable Formatting}
% \label{sec:SectionFormat}
%
% \DescribeMacro{\NamesActive}
% \DescribeMacro{\NamesInactive}
-% Using the \texttt{frontmatter} option deactivates formatting until \cmd{\NamesActive} occurs. Another macro, \cmd{\NamesInactive}, will deactivate formatting again. These two macros toggle two independent systems of formatting and first use.\\
-%
-% Here we switch to the ``front matter'' mode with \cmd{\NamesInactive}:
+% Using the \texttt{frontmatter} option deactivates formatting until \cmd{\NamesActive} occurs. Another macro, \cmd{\NamesInactive}, will deactivate formatting again. These two macros toggle two independent systems of formatting and first use. Here we switch to the ``front matter'' mode with \cmd{\NamesInactive}:
% \NamesInactive
% \begin{quote}
% \begin{tabular}{ll}
@@ -768,7 +980,6 @@
%|\Name[Nicolas]{Malebranche}| & \Name[Nicolas]{Malebranche}\\
% \end{tabular}
% \end{quote}
-%
% Then we switch back to ``main matter'' mode with \cmd{\NamesActive}:
% \NamesActive
% \begin{quote}
@@ -780,91 +991,80 @@
% \end{tabular}
% \end{quote}
%
-% Notice that we have two independent cases of ``first use'' above. That is intended for different sections of the document, like front matter and main matter. It clashes when on the same page or on one nearby.
+% Notice that we have two independent cases of ``first use'' above. Consider the two ``species'' of names to be ``formatted'' and ``non-formatted,'' intended for independent sections of the document like front matter and main matter.
%
% \subsubsection{Tweaks: \texttt{\textbackslash ForgetName} and \texttt{\textbackslash SubvertName}}
% \label{sec:Tweaks}
%
-% Perhaps the easiest way to avoid the 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.
+% 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.
%
% \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:
% \begin{quote}
-% \cmd{\ForgetName}\oarg{FNN}\marg{SNN}\oarg{alternate names}
+% \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 with respect to typesetting. The next use will print as if it were a ``first use.'' Index entries and cross-references (see the next section) are \emph{never} forgotten.
+% \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.'' Index entries and cross-references are \emph{never} forgotten by this package.
%
% \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:
% \begin{quote}
-% \cmd{\SubvertName}\oarg{FNN}\marg{SNN}\oarg{alternate names}
+% \cmd{\SubvertName}\oarg{FNN}\marg{SNN}\oarg{Alternate names}
% \end{quote}
%
-% \noindent This macro causes \cmd{\Name} and friends to think that a prior use of a name already has occurred. The next use will print as if it were a ``subsequent use.''
+% \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.''
%
% \subsection{Name Variant Macros}
-% \subsubsection{Introduction}
-% \label{sec:pennames}
-%
-% \cmd{\AKA} handles pseudonyms, stage names, \emph{noms de plume}, and so on. Before we examine \cmd{\AKA} in detail, we should cover the manual solution that \cmd{\AKA} helps to automate. If needed, the \texttt{.idx} file can be a helpful reference when linking manual entries with \textsf{nameauth} entries. This remains the only solution for certain cases, especially with the \texttt{comma} option:
-%
-% \begin{quote}
-% \bgroup\ttfamily\small
-% \verb+\index{Jean the Fearless|see{Jean sans Peur}}%+\\
-% |\Name{Jean}[sans Peur]| (Jean the Fearless) reigned as Duke of\break Burgundy from 1404 to 1419.
-% \egroup
+% \subsubsection{\texttt{\textbackslash AKA}}
+% \label{sec:AKA}
%
-% \TagName{Jean}[sans Peur]{, duke}%
-% \index{Jean the Fearless|see{Jean sans Peur}}%
-% \Name{Jean}[sans Peur] (Jean the Fearless) reigned as Duke of Burgundy from 1404 to 1419.
-% \end{quote}
+% \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 suffix workaround would use |\Name{Jean, sans Peur}| and the author need merely type |\AKA{Jean, sans Peur}{Jean the Fearless}|. See also Section~\ref{sec:suffix}. Using \textsf{makeindex} also requires some manual entries:
% \begin{quote}
% \bgroup\ttfamily\small
-% \verb+\index{Doctor Angelicus@\textit{Doctor Angelicus}|see{Thomas Aquinas}}+
-% \verb+\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}|. His name ``Aquinas'' is not a surname.
+% |\Name{Jean, sans Peur}| (|\AKA{Jean, sans Peur}{Jean the Fearless}|) reigned as Duke of Burgundy from 1404 to 1419.
% \egroup
%
-% \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}. His name ``Aquinas'' is not a surname.
+% \TagName{Jean, sans Peur}{, duke}%
+% \Name{Jean, sans Peur} (\AKA{Jean, sans Peur}{Jean the Fearless}) reigned as Duke of Burgundy from 1404 to 1419.%
% \end{quote}
%
-% \subsubsection{\texttt{\textbackslash AKA}}
-% \label{sec:AKA}
+% Notice that ``John the Fearless'' receives no special formatting. This is intentional, as it reflects the idea of formatting only main index entries, not cross-references. Nevertheless, the reversing and capitalizing mechanisms do work with \cmd{\AKA}. The syntax for \cmd{\AKA} is:
%
-% \DescribeMacro{\AKA}
-% \DescribeMacro{\AKA*}
-% The primary macro that handles aliases is \cmd{\AKA}. Its syntax 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}
+% \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}
% \end{quote}
%
-% \noindent The \meta{FNN} and \meta{SNN} arguments \emph{do not include} the final optional argument of \cmd{\Name} to avoid ambiguity. \cmd{\AKA} will not create a \emph{see} reference to a name that uses the \meta{alternate names} field. That must be done manually (see above). This macro is designed mainly with Western names in mind.
+% \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 prevent double periods at the end of a sentence.
%
-% \cmd{\AKA} only prints the alternate name, not the name to which it refers. It assumes that a \cmd{\Name} macro occurs somewhere to create the page-indexed target of a cross-reference. \textbf{No error checking} occurs for this. The macro also prevents double periods. Following is a quick review of what works and what fails for examples using \Name[Bob]{Hope}, \ForgetName{Louis, XIV}\Name{Louis, XIV}, and \Name{Gregory, I}:
+% 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. Section~\ref{sec:TagName} further illustrates \cmd{\AKA}, \cmd{\AKA*}, and index tagging.
%
+% 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:
% \begin{quote}\footnotesize
% \begin{tabular}{ll}\hline
% {\large\strut}|\AKA[Bob]{Hope}[Leslie Townes]{Hope}| & \AKA[Bob]{Hope}[Leslie Townes]{Hope}\\
-% {\large\strut}\dag|\AKA[Bob]{Hope}[Leslie Townes]{Hope}[Lester T.]| & \AKA[Bob]{Hope}[Leslie Townes]{Hope}[Lester T.]\\\hline
-% {\large\strut}\ddag|\AKA{Louis, XIV}{Sun King}| & \AKA{Louis, XIV}{Sun King}\\
-% {\large\strut}|\AKA{Louis}[XIV]{Sun King}| & FAIL\\\hline
-% {\large\strut}\S|\AKA{Gregory, I}{Gregory}[the Great]| & \AKA{Gregory, I}{Gregory}[the Great]\\
+% {\large\strut}|\AKA{Louis, XIV}{Sun King}| & \AKA{Louis, XIV}{Sun King}\\
+% {\large\strut}|\AKA{Louis}[XIV]{Sun King}| & FAIL\\
+% {\large\strut}|\AKA{Lao-tzu}{Li, Er}| & \AKA{Lao-tzu}{Li, Er}\\\hline
+% \end{tabular}
+% \end{quote}
+% \cmd{\AKA} fails with the old syntax. One can use the \meta{Alt. names} field with the names above, but that field does not generate a cross-reference. The \meta{Alt. names} field (whis is a part of the cross-reference) was envisaged for names like \Name{Gregory, I}:
+% \begin{quote}\footnotesize
+% \begin{tabular}{ll}\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]\\
-% {\large\strut}|\AKA{Gregory}[I]{Gregory}[the Great]| & FAIL\\\hline
+% {\large\strut}|\AKA{Gregory}[I]{Gregory}[the Great]| & FAIL\\
+% {\large\strut}|\AKA*{Gregory}[I]{Gregory}[the Great]| & FAIL\\\hline
% \end{tabular}
-%
-% \smallskip\dag{} This succeeds, but replaces ``Leslie Townes'' with ``Lester T.'' in the text, while keeping ``Hope, Leslie Townes'' as the \emph{see} reference in the index.\\
-% \ddag{} This form uses the \texttt{nocomma} feature.\\
-% \S{} This produces different output, depending on whether \cmd{\AKA} or \cmd{\AKA*} is used.
% \end{quote}
+% |\Name*{Gregory,| |I}| |``\AKA*{Gregory,| |I}{Gregory}[the| |Great]''| produces \Name*{Gregory, I} ``\AKA*{Gregory, I}{Gregory}[the Great]'' in the text and a \emph{see} reference from Gregory the Great to Gregory I in the index. This may look like the old syntax, but it is not. The comma-delimited affix form in \meta{Alt. SNN} is designed for Eastern names, while \meta{Alt. names} is not. One can refer to \Name[Lafcadio]{Hearn} with |\CapName\AKA[Lafcadio]{Hearn}{Koizumi, Yakumo}|: \CapName\AKA[Lafcadio]{Hearn}{Koizumi, Yakumo}.
+%
+% Using \cmd{\RevComma} before |\AKA[Bob]{Hope}[Leslie Townes]{Hope}| produces \RevComma\AKA[Bob]{Hope}[Leslie Townes]{Hope}, while \cmd{\RevName} omits the comma. \CapThis\AKA[Charles]{du Fresne}{du Cange} refers to \Name[Charles]{du Fresne}: |\CapThis\AKA[Charles]{du Fresne}{du Cange}|. See also Section~\ref{sec:Particles} on how to deal with different standards for particles.
%
-% \cmd{\AKA} prints an alternate name and creates a cross reference in the index. The target of this cross-reference is either \meta{SNN}, \meta{FNN} or just \meta{SNN}. In the cross-reference, the \meta{alternate names} replace the \meta{alternate FNN} if both exist. Otherwise the \meta{alternate names} follow the \meta{alternate SNN}:
+% Here we show \cmd{\AKA} used as a name in the running text:
%
% \begin{quote}
% \bgroup\ttfamily
@@ -873,36 +1073,41 @@
%
% Today we consider \AKA[George]{Eliot}[Mary Anne]{Evans} and her literary contributions as \Name[George]{Eliot}.
% \end{quote}
-%
-% \noindent If the starred form \cmd{\AKA*} is used with the template \meta{none}\meta{alternate SNN}\meta{alt. names}, it only prints the \meta{alt. names}. With the same template, \cmd{\AKA} prints \meta{alternate SNN} followed by \meta{alt. names}. Section~\ref{sec:TagName} further illustrates the usefulness of \cmd{\AKA}, \cmd{\AKA*}, and index tagging.
%
-% The cross-references generated by \cmd{\AKA} and \cmd{\AKA*} are meant to be \emph{see} references and thus the other macros in this package will not create page references for these cross-references. See also Section~\ref{sec:error}. In certain cases, the alternate name might need to be indexed with page numbers. Do not use \cmd{\AKA} in those cases. Use \cmd{\Name} for both the main and the alternate names. Then, only after both instances of \cmd{\Name} have been invoked, create manual cross-references with \cmd{\index}, e.g.:\\
-%
-% \label{manualxref}%
-% \bgroup\footnotesize\label{Rambam}
-% \begin{tabular}{p{0.7in}ll}\hline
-% {\large\strut}Authoritative Name & Alternate Name\newline & Example of Use\newline\\\hline
-% {\large\strut}\Name{Maimonides} & \AKA{Maimonides}{Moses ben-Maimon} & |\Name{Maimonides}|\\
-% &&|\AKA{Maimonides}{Moses ben-Maimon}|\\
-% {\large\strut}\Name{Maimonides} & \Name{Rambam} & |\Name{Rambam}%|\\& & \verb!\index{Rambam|seealso{Maimonides}}!\\\hline
-% \end{tabular}
-% \index{Rambam|seealso{Maimonides}}\egroup
+% 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}%
+% Refer, \emph{e.g.}, to |\Name{Maimonides}| |(\AKA{Maimonides}{Moses| |ben-Maimon})|: \Name{Maimonides} (\AKA{Maimonides}{Moses ben-Maimon}). That is a name and a \emph{see} reference. Now one must refer to |\Name{Rambam}|: \Name{Rambam} before making a cross-reference to \Name{Maimonides}. Add \verb!\index{Rambam|seealso{Maimonides}}! at the end of the document to ensure that it is the last 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}.}
+%
+% \cmd{\AKA} purposefully will not create multiple instances of a cross-reference. To deal with the special case where one moniker applies to multiple people, \emph{e.g.}, ``Snellius'' for both \Name*[Willebrord]{Snel van Royen} and his son \Name*[Rudolph]{Snel van Royen}, use a manual solution:\\[2ex]
+%|\index{Snellius|\verb!|!{}|see{Snel|\,|van|\,|Royen,|\,|Rudolph;| |Snel|\,|van|\,|Royen,|\,|Willebrord}}|
+%\index{Snellius|see{Snel van Royen, Rudolph; Snel van Royen, Willebrord}}
+%
+% The old syntax (|\Name{Jean}[sans Peur]|) does not work with \cmd{\AKA}. Even with the new syntax, using \textsf{makeindex} may require some manual entries:
%
-% \bigskip\cmd{\AKA} will not create multiple instances of a cross-reference. This allows the macro \cmd{\ExcludeName} to work, but it also prevents the special case where one moniker applies to multiple people, e.g.: \PName*[Willebrord]{Snel van Royen}{Snellius} and his son \PName*[Rudolph]{Snel van Royen}{Snellius}. \cmd{\AKA} produces the first cross-reference; the user manually creates the second:
-% \index{Snellius|see{Snel van Royen, Rudolph}}%
% \begin{quote}
-% \verb!\index{Snellius|see{Snel van Royen, Rudolph}}!
+% \bgroup\ttfamily\small
+% \verb+\index{Doctor Angelicus@\textit{Doctor Angelicus}|see{Thomas Aquinas}}+
+% \verb+\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}|. His name ``Aquinas'' is not a surname.
+% \egroup
+%
+% \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}. His name ``Aquinas'' is not a surname.
% \end{quote}
%
% \subsubsection{\texttt{\textbackslash PName}}
%
% \DescribeMacro{\PName}
-% \cmd{\PName} is a ``convenience macro'' that sacrifices flexibility for simplicity. It uses only the \meta{FNN}\meta{SNN} use of \cmd{\AKA}. It does not use \cmd{\AKA*}. It is meant for Western-style names. It calls formats a Western-style ``main'' name followed by a cross-reference in parentheses. The syntax is:
+% \cmd{\PName} is a ``convenience macro'' meant for English-style Western names that sacrifices flexibility for simplicity. It generates a Western-style main name followed by a cross-reference in parentheses with the following syntax:
% \begin{quote}
% \cmd{\PName}\oarg{FNN}\marg{SNN}\oarg{other FNN}\marg{other SNN}\oarg{other alt.}
% \end{quote}
%
-% The author determines the name that is indexed (the first name) and the subsequent name that only occurs as a \emph{see} reference. For example:
+% 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 if it is useful, and \emph{caveat auctor}.
+%
+% 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:
%
% \begin{quote}\footnotesize
% \begin{tabular}{@{}p{0.5\textwidth}@{}p{0.37\textwidth}@{}}\hline
@@ -915,24 +1120,28 @@
% \end{tabular}
% \end{quote}
%
+% 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.}
+%
% \subsection{Indexing Macros}
% \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:
% \begin{quote}
-% \cmd{\IndexName}\oarg{FNN}\marg{SNN}\oarg{alternate names}
+% \cmd{\IndexName}\oarg{FNN}\marg{SNN}\oarg{Alternate names}
% \end{quote}
%
-% \cmd{\IndexName} does not index \meta{alternate names} unless \meta{FNN} are absent, whereupon it treats \meta{alternate names} as an affix. If indexing is switched off (see Section~\ref{sec:SectionIndex}), this macro does nothing. It will not create index entries for names that have been used as cross-references.
+% \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.
+%
+% 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).
%
% \subsubsection{\texttt{\textbackslash TagName}}
% \label{sec:TagName}
%
% \DescribeMacro{\TagName}
-% This macro creates a tag that will appear in all index entries corresponding to the name arguments from the point of invocation of \cmd{\TagName} onward. \cmd{\TagName} and \cmd{\UntagName} handle their name arguments like \cmd{\IndexName}. For consistency throughout the document, tag names at the beginning. The syntax is:
+% This macro creates an index tag that will appear in all entries for a corresponding \cmd{\Name} from the point of invocation until the end of the document or corresponding \cmd{\UntagName}. Both \cmd{\TagName} and \cmd{\UntagName} handle their arguments like \cmd{\IndexName}. Tag names in the preamble if possible. If used in the body to create or switch index tags, put a comment delimiter at the end of the macro.
% \begin{quote}
-% \cmd{\TagName}\oarg{FNN}\marg{SNN}\oarg{alternate names}\marg{tag}
+% \cmd{\TagName}\oarg{FNN}\marg{SNN}\oarg{Alternate names}\marg{tag}
% \end{quote}
%
% 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:\\
@@ -940,43 +1149,52 @@
% \begin{tabular}{p{2in}p{2in}}
% |\TagName{Leo, I}{, pope}| |\TagName{Gregory, I}{, pope}| & Tag these names at the beginning of the document.\\
% \dots & \\
-% |\Name{Leo, I}| |\Name{Gregory, I}| & First references to \Name{Leo, I} and \ForgetName{Gregory, I}\Name{Gregory, I}\\
+% |\Name*{Leo, I}| |\Name*{Gregory, I}| & First references to \ForgetName{Leo, I}\Name*{Leo, I} and \ForgetName{Gregory, I}\Name*{Gregory, I}\\
% \dots & \\
% |\Name*{Leo, I} was known as| |\AKA{Leo, I}{Leo}[the Great].| & \Name*{Leo, I} was known as \AKA{Leo, I}{Leo}[the Great].\\
% \dots & \\
% |\Name{Gregory, I}| |``\AKA*{Gregory, I}%| |{Gregory}[the Great]''| & \Name{Gregory, I} ``\AKA*{Gregory, I}{Gregory}[the Great]'' was another major pope.\\
% \end{tabular}\\[1ex]
%
-% \cmd{\TagName} causes tags in the index entries to be inserted automatically from the point of invocation. \cmd{\AKA} prints the name and the sobriquet, while \cmd{\AKA*} only prints the sobriquet. The tag is literal text; it can be comma-delimited, in parentheses, or whatever an author might want.
+% \cmd{\TagName} causes the index entries for \Name*{Gregory, I} and \Name*{Leo, I} to have the tag ``,\textvisiblespace pope'' added automatically. One must add a space manually at the front of a tag if one wants it. Otherwise one could add asterisks, daggers, and so on instead of a space and some text, sich as regnal or life dates, etc. The tag is literal text for whatever you need. For example, all fictional names in the index of this manual have an asterisk without any spaces. Tagging aids scholarly indexing.
%
% \subsubsection{\texttt{\textbackslash UntagName}}
%
% \DescribeMacro{\UntagName}
% \cmd{\TagName} will replace one tag with another tag, but it does not remove a tag from a name. That is the role of \cmd{\UntagName}. The syntax is:
% \begin{quote}
-% \cmd{\UntagName}\oarg{FNN}\marg{SNN}\oarg{alternate names}
+% \cmd{\UntagName}\oarg{FNN}\marg{SNN}\oarg{Alternate names}
% \end{quote}
%
-% By using \cmd{\TagName} and \cmd{\UntagName}, one can disambiguate different people with the same name. For example:\\
+% By using \cmd{\TagName} and \cmd{\UntagName}, one can disambiguate different people with the same name. For example:
%
-% \begin{tabular}{p{2in}p{2in}}
-% |\ForgetName[John]{Smith}| |\TagName[John]{Smith}%| |{, the other one}| |\Name[John]{Smith}|\dots & This is the first reference to \ForgetName[John]{Smith}\TagName[John]{Smith}{, the other one}\Name[John]{Smith}, ``the other one'' in the index. Notice that it is tweaked.\newline\\[0.5ex]
-% |\ForgetName[John]{Smith}| |\TagName[John]{Smith}%| |{, the third}| |\Name[John]{Smith}|\dots & This refers to \ForgetName[John]{Smith}\TagName[John]{Smith}{, the third}\Name[John]{Smith} ``the third'' in the index. It is tweaked again as a ``first occurrence.''\newline\\[0.5ex]
-% |\SubvertName[John]{Smith}| |\UntagName[John]{Smith}| |\Name*[John]{Smith}| & This refers to the original \SubvertName[John]{Smith}\UntagName[John]{Smith}\Name*[John]{Smith}. It is tweaked in order to force a subsequent reference.\\[1ex]
-% \end{tabular}\\
-% \UntagName[John]{Smith}
+% \begin{quote}
+% \ttfamily This refers to |\Name*[John]{Smith}|.\\
+% Now another |\ForgetName[John]{Smith}%|\\
+% |\TagName[John]{Smith}{ (the other one)}\Name[John]{Smith}|.\\
+% Then a third |\ForgetName[John]{Smith}%|\\
+% |\TagName[John]{Smith}{ (the third)}\Name[John]{Smith}|.\\
+% Then the first |\UntagName[John]{Smith}\Name*[John]{Smith}|.\\
+%
+% \normalfont This refers to \Name*[John]{Smith}.\hfill\emph{index}: Smith, John\\
+% Now another \ForgetName[John]{Smith}\TagName[John]{Smith}{* (the other one)}\Name[John]{Smith}.\hfill\emph{index}: Smith, John (the other one)\\
+% Then a third \ForgetName[John]{Smith}\TagName[John]{Smith}{* (the third)}\Name[John]{Smith}.\hfill\emph{index}: Smith, John (the third)\\
+% Then the first \TagName[John]{Smith}{*}\Name*[John]{Smith}.\hfill\emph{index}: Smith, John
+% \end{quote}
+%
+% 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.
%
-% Tagging and untagging in this manner requires the author to juggle more info. With more freedom comes more responsibility. Also, if you use \cmd{\UntagName} within a scope, you may need to repeat it after leaving that scope.
+% Since this document 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.
%
-% \subsubsection{\texttt{\textbackslash ExcludeName}}
+% \subsubsection{Global Name Exclusion}
%
% \DescribeMacro{\ExcludeName}
-% This prevents \cmd{\Name}, etc. from both formatting and indexing a specific name, but \emph{only if that name has not been used}. See also Section~\ref{sec:error}. The syntax is:
+% 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}
+% \cmd{\ExcludeName}\oarg{FNN}\marg{SNN}\oarg{Alternate names}
% \end{quote}
%
-% To suppress only indexing but retain formatting, enclose \cmd{\Name}, etc. between \cmd{\IndexInactive} and \cmd{\IndexActive}.
+% 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. It is likelier that you would enclose \cmd{\Name}, etc. between \cmd{\IndexInactive} and \cmd{\IndexActive} (below) in order to suppress just one index entry.
%
% \subsubsection{Indexing Certain Sections}
% \label{sec:SectionIndex}
@@ -990,106 +1208,150 @@
% Handling variant name spellings can be complicated. For example, one might settle on the form \Name[W.E.B.]{Du Bois} in one's name authority. Yet an essay might use an alternate spelling for \Name[W.E.B.]{Du Bois}, namely, \IndexInactive\Name*[W.E.B.]{DuBois}\IndexActive, where the publisher would not grant the right to alter the spelling. In that case, do the following in that document section:
%
% \begin{enumerate}\setlength\itemsep{0pt}
-% \item Use |\ForgetName| for the first use when spaces are the only variation.
+% \item Use |\ForgetName| for the first use when spaces are the only variation between name forms because the mechanism for determining whether or not a name has occurred ignores spaces.
% \item Wrap \cmd{\Name} and friends between \cmd{\IndexInactive} and \cmd{\IndexActive}.
% \item Call \cmd{\IndexName} with the authoritative form right after \cmd{\IndexActive}.
+% \item Create a cross-reference in the index.
% \end{enumerate}
% This can look like:
% \begin{quote}%
% \gdef\DuBoisAlt{\IndexInactive\Name[W.E.B.]{DuBois}\IndexActive\IndexName[W.E.B.]{Du Bois}}%
-% |\def\DuBoisAlt{\IndexInactive\Name[W.E.B.]{DuBois}%|\\\hbox to 3pc{\hfil}|\IndexActive\IndexName[W.E.B.]{Du Bois}}|
+% |\gdef\DuBoisAlt{\IndexInactive\Name[W.E.B.]{DuBois}%|\\|\IndexActive\IndexName[W.E.B.]{Du Bois}}|\\
+% \verb!\index{DuBois, W.E.B.|see{Du Bois, W.E.B.}}!\dots\\[2ex]
+% \dots{}|\ForgetName[W.E.B.]{DuBois}|\dots|\DuBoisAlt|
% \end{quote}
%
-% The alternate section mentions |\ForgetName[W.E.B.]{DuBois}\DuBoisAlt| \ForgetName[W.E.B.]{DuBois}\DuBoisAlt, then just |\DuBoisAlt| \DuBoisAlt. The index will only hold the standard form of \Name[W.E.B.]{Du Bois}. This approach should only be used in those cases where minor variations in spelling do not cause the reader to question the identity of the person in question.
-%
+% The alternate section mentions \ForgetName[W.E.B.]{DuBois}\DuBoisAlt\index{DuBois, W.E.B.|see{Du Bois, W.E.B.}}, then just \DuBoisAlt\ thereafter. The index will only hold the standard entry for \Name*[W.E.B.]{Du Bois}: ``Du Bois, W.E.B.'' and a cross-reference from the variant ``DuBois, W.E.B.'' to the standard entry.
+% \clearpage
% \subsection{Naming Pattern Reference}
% \label{sec:PatRef}
+%
% \subsubsection{Basic Naming}
-% \label{sec:Basic}
-% When referring to a name for the first time, the following have the same result. We put the starred form first because its output is always longest:\\[2ex]
-% \begin{tabular}{p{0.4\textwidth}p{0.5\textwidth}}
-% First reference in the text:\newline\hbox to 1em{\hfil}\ForgetName[John]{Smith}\Name[John]{Smith} &
-% |\Name*[John]{Smith}|\newline |\Name[John]{Smith}|\newline |\FName[John]{Smith}|\\[0.5ex]
-% First mononym reference:\newline\hbox to 1em{\hfil}\ForgetName{Plato}\Name{Plato} &
-% |\Name*{Plato}|\newline |\Name{Plato}|\newline |\FName{Plato}|\\
-% \end{tabular}\\[2ex]
-% Subsequent references to names differ, based on the macro used:\\[1ex]
-% \begin{tabular}{p{0.4\textwidth}p{0.5\textwidth}}
-% Subsequent full name:\newline\hbox to 1em{\hfil}\Name*[John]{Smith} & |\Name*[John]{Smith}|\newline\\[0.5ex]
-% Subsequent surname: \Name[John]{Smith} & |\Name[John]{Smith}|\\[0.5ex]
-% Subsequent forename: \FName[John]{Smith} & |\FName[John]{Smith}|\\[0.5ex]
-% Subsequent mononym: \Name{Plato} & |\Name*{Plato}|\newline |\Name{Plato}|\newline |\FName{Plato}|\\
+% \noindent{\bfseries Western Names}\\[1ex]
+% \begin{tabular}{p{0.45\textwidth}@{}p{0.55\textwidth}}\hline{\large\strut}
+% \textit{First reference in the text}:\newline\hbox to 1em{\hfil}\ForgetName[John]{Smith}\Name[John]{Smith} &
+% |\Name*[John]{Smith}|\newline |\Name[John]{Smith}|\newline |\FName[John]{Smith}|\\{\large\strut}
+% \textit{Subsequent full name}:\newline\hbox to 1em{\hfil}\Name*[John]{Smith} & |\Name*[John]{Smith}|\newline\\{\large\strut}
+% \textit{Subsequent surname}: \Name[John]{Smith} & |\Name[John]{Smith}|\\{\large\strut}
+% \textit{Subsequent forename}: \FName[John]{Smith} & |\FName[John]{Smith}|\\\hline{\large\strut}
+% \textit{Long first reference}: \ForgetName[J.Q.]{Public}\newline\hbox to 1em{\hfil}\Name[J.Q.]{Public}[Jane Q.] & |\Name*[J.Q.]{Public}[Jane Q.]|\newline |\Name[J.Q.]{Public}[Jane Q.]|\newline |\FName[J.Q.]{Public}[Jane Q.]|\\{\large\strut}
+% \textit{Subsequent full}: \Name*[J.Q.]{Public} & |\Name*[J.Q.]{Public}|\\{\large\strut}
+% \textit{Alternate forenames}:\newline\hbox to 1em{\hfil}\Name*[J.Q.]{Public}[Jane Qetsiyah] & |\Name*[J.Q.]{Public}[Jane Qetsiyah]|\newline\\{\large\strut}
+% {\large\strut}\textit{Alternate forename}: \FName[J.Q.]{Public}[Janie] & |\FName[J.Q.]{Public}[Janie]|\\\hline
% \end{tabular}\\[2ex]
-% \clearpage
-% Nicknames and alternate forenames use both the first and third arguments of \cmd{\Name}. The index forms are constant even when the print forms change:\\[2ex]
-% \begin{tabular}{p{0.4\textwidth}p{0.5\textwidth}}
-% Long first ref: \ForgetName[J.Q.]{Public}\Name[J.Q.]{Public}[Jane Q.] & |\Name*[J.Q.]{Public}[Jane Q.]|\newline |\Name[J.Q.]{Public}[Jane Q.]|\newline |\FName[J.Q.]{Public}[Jane Q.]|\\[0.5ex]
-% Different forenames, same surname: \Name*[J.Q.]{Public}[Jane Qetsiyah] & |\Name*[J.Q.]{Public}[Jane Qetsiyah]|\newline\\[0.5ex]
-% Subsequent name: \Name*[J.Q.]{Public} & |\Name*[J.Q.]{Public}|\\[0.5ex]
-% Alternate forename: \FName[J.Q.]{Public}[Janie] & |\FName[J.Q.]{Public}[Janie]|\\[0.5ex]
-% \end{tabular}\\[2ex]
-% \indent These next examples are the ``limited'' variants that work with the \texttt{comma} option. \cmd{\AKA} and \cmd{\PName} cannot cross-reference to these forms. Sections~\ref{sec:suffix} and~\ref{sec:pennames} address this issue with different solutions.\\[2ex]
-% \begin{tabular}{p{0.4\textwidth}p{0.5\textwidth}}
-% First Eastern reference:\newline \ForgetName{Mao}[Tse-tung]\Name{Mao}[Tse-tung] & |\Name*{Mao}[Tse-tung]|\newline |\Name{Mao}[Tse-tung]|\\[0.5ex]
-% Subsequent refs: \Name*{Mao}[Tse-tung] & |\Name*{Mao}[Tse-tung]|\\[0.5ex]
-% Subsequent refs: \Name{Mao}[Tse-tung] & |\Name{Mao}[Tse-tung]|\newline |\FName{Mao}[Tse-tung]|\\[0.5ex]
-% First royal: \ForgetName{Louis}[the Pious]\Name{Louis}[the Pious] & |\Name*{Louis}[the Pious]|\newline |\Name{Louis}[the Pious]|\newline |\FName{Louis}[the Pious]|\\[0.5ex]
-% Subsequent refs: \Name*{Louis}[the Pious] & |\Name*{Louis}[the Pious]|\\[0.5ex]
-% Subsequent refs: \Name{Louis}[the Pious] & |\Name{Louis}[the Pious]|\newline |\FName{Louis}[the Pious]|\\[0.5ex]
-% First ancient ref:\newline \ForgetName{Ptolemy I}[Soter]\Name{Ptolemy I}[Soter] & |\Name*{Ptolemy I}[Soter]|\newline |\Name{Ptolemy I}[Soter]|\newline |\FName{Ptolemy I}[Soter]|\\[0.5ex]
-% Subsequent refs: \Name*{Ptolemy I}[Soter] & |\Name*{Ptolemy I}[Soter]|\\[0.5ex]
-% Subsequent refs: \Name{Ptolemy I}[Soter] & |\Name{Ptolemy I}[Soter]|\newline |\FName{Ptolemy I}[Soter]|\\[0.5ex]
-% First royal: \ForgetName{Henry}[VIII]\Name{Henry}[VIII] & |\Name*{Henry}[VIII]|\newline |\Name{Henry}[VIII]|\newline |\FName{Henry}[VIII]|\\[0.5ex]
-% Subsequent refs: \Name*{Henry}[VIII] & |\Name*{Henry}[VIII]|\\[0.5ex]
-% Subsequent refs: \Name{Henry}[VIII] & |\Name{Henry}[VIII]|\newline |\FName{Henry}[VIII]|\\
+%
+% \noindent{\bfseries Western Plus Affixes}\\[1ex]
+% Always use a comma to delimit name/affix pairs.\\[1ex]
+% \begin{tabular}{p{0.45\textwidth}@{}p{0.55\textwidth}}\hline{\large\strut}
+% \textit{First reference}:\newline\hbox to 1em{\hfil}\ForgetName[George S.]{Patton, Jr.}\Name[George S.]{Patton, Jr.} & |\Name*[George S.]{Patton, Jr.}|\newline |\Name[George S.]{Patton, Jr.}|\newline |\FName[George S.]{Patton, Jr.}|\\{\large\strut}
+% \textit{Subsequent full}:\newline\hbox to 1em{\hfil}\Name*[George S.]{Patton, Jr.} & |\Name*[George S.]{Patton, Jr.}|\newline\\{\large\strut}
+% \textit{Subsequent surname}: \Name[George S.]{Patton, Jr.} & |\Name[George S.]{Patton, Jr.}|\\{\large\strut}
+% {\large\strut}\textit{Subsequent forename}: \FName[George S.]{Patton, Jr.}[George] & |\FName[George S.]{Patton, Jr.}[George]|\\\hline
% \end{tabular}
+% \begin{quote}
+%|\begin{nameauth}% In the preamble!|\\[0.2ex]
+%| \< Smith & John & Smith & >|\\[0.2ex]
+%| \< JQP & J.Q. & Public & >|\\[0.2ex]
+%| \< Patton & George S. & Patton, Jr. & >|\\[0.2ex]
+%|\end{nameauth}|
+%\end{quote}
+%
+% \ForgetName[John]{Smith}\ForgetName[J.Q.]{Public}|\Smith, \LSmith, \Smith, and \SSmith| give \Smith, \LSmith, \Smith, and \SSmith. |\JQP[Jane Q.],| |\LJQP[Jane Q.],| |and| |\JQP[Jane Q.]| make \JQP[Jane Q.], \LJQP[Jane Q.], and \JQP[Jane Q.]. |\LJQP[Jane| |Qetsiyah]\| |and| |\SJQP[Janie]| produce \LJQP[Jane Qetsiyah]\ and \SJQP[Janie].
+%
+% \ForgetName[George S.]{Patton, Jr.}|\Patton,| |\LPatton,| |\Patton,| |and| |\SPatton| give \KeepAffix\Patton, \LPatton, \Patton, and \SPatton. For the alternate forename, |\SPatton[George]| yields \SPatton[George].\clearpage
+%
+% \noindent{\bfseries New Syntax: Royal, Eastern, and Ancient}\\[1ex]
+% Using |\Name{Demetrius, I Soter}| keeps the number with the affix. To keep the number with the name, use |\Name{Demetrius I, Soter}|. See also Section~\ref{sec:Affix}.\\[1ex]
+% \begin{tabular}{p{0.45\textwidth}@{}p{0.55\textwidth}}\hline{\large\strut}
+% {\large\strut}\textit{First reference}: \ForgetName{Francis, I}\Name{Francis, I} & |\Name*{Francis, I}|\newline |\Name{Francis, I}|\newline |\FName{Francis, I}|\\{\large\strut}
+% \textit{Subsequent full}: \Name*{Francis, I} & |\Name*{Francis, I}|\\{\large\strut}
+% \textit{Subsequent name}: \Name{Francis, I} & |\Name{Francis, I}|\newline |\FName{Francis, I}|\\{\large\strut}
+% \textit{First reference}: \newline\hbox to 1em{\hfil}\ForgetName{Demetrius, I Soter}\Name{Demetrius, I Soter} & |\Name*{Demetrius, I Soter}|\newline |\Name{Demetrius, I Soter}|\newline |\FName{Demetrius, I Soter}|\\{\large\strut}
+% \textit{Subsequent full name}: \newline\hbox to 1em{\hfil}\Name*{Demetrius, I Soter} & |\Name*{Demetrius, I Soter}|\newline\\{\large\strut}
+% {\large\strut}\textit{Subsequent name}: \Name{Demetrius, I Soter} & |\Name{Demetrius, I Soter}|\newline |\FName{Demetrius, I Soter}|\\\hline{\large\strut}
+% {\large\strut}\textit{First reference}: \ForgetName{Sun, Yat-sen}\Name{Sun, Yat-sen} & |\Name*{Sun, Yat-sen}|\newline |\Name{Sun, Yat-sen}|\newline |\FName{Sun, Yat-sen}|\\{\large\strut}
+% \textit{Subsequent full name}: \newline\hbox to 1em{\hfil}\Name*{Sun, Yat-sen} & |\Name*{Sun, Yat-sen}|\newline\\{\large\strut}
+% {\large\strut}\textit{Subsequent name}: \Name{Sun, Yat-sen} & |\Name{Sun, Yat-sen}|\newline |\FName{Sun, Yat-sen}|\\\hline{\large\strut}
+% {\large\strut}\textit{First mononym reference}:\newline\hbox to 1em{\hfil}\ForgetName{Plato}\Name{Plato} &
+% |\Name*{Plato}|\newline |\Name{Plato}|\newline |\FName{Plato}|\\{\large\strut}
+% {\large\strut}\textit{Subsequent mononym}: \Name{Plato} & |\Name*{Plato}|\newline |\Name{Plato}|\newline |\FName{Plato}|\\\hline
+% \end{tabular}
+% \begin{quote}
+%|\begin{nameauth}% In the preamble!|\\[0.2ex]
+%| \< Francis & & Francis, I & >|\\[0.2ex]
+%| \< Dem & & Demetrius, I Soter & >|\\[0.2ex]
+%| \< Sun & & Sun, Yat-sen & >|\\[0.2ex]
+%| \< Plato & & Plato & >|\\[0.2ex]
+%|\end{nameauth}|
+%\end{quote}
+%
+% \ForgetName{Francis, I}\ForgetName{Demetrius, I Soter}\ForgetName{Sun, Yat-sen}\ForgetName{Plato}|\Francis,| |\LFrancis,| |\Francis,| |and| |\SFrancis| give \Francis, \KeepAffix\LFrancis, \Francis, and \SFrancis. |\Dem,| |\LDem,| |\Dem,| |and \SDem| make \Dem, \LDem, \Dem, and \SDem. |\Sun,| |\LSun,| |\Sun,| |and \SSun| produce \Sun, \LSun, \Sun, and \SSun. |\Plato,| |\LPlato,| |\Plato,| |and \SPlato| yield \Plato, \LPlato, \Plato, and \SPlato.
+%
+% Note that |\KeepAffix\LFrancis| was used to prevent a bad break above. |\KeepAffix\Patton| prevented a bad break on the previous page.
% \clearpage
%
-% \subsubsection{Affixes}
-% \label{sec:Intermediate}
-% Always use a comma to delimit name/affix pairs. \cmd{\AKA} and \cmd{\PName} will cross-reference these forms. See also Section~\ref{sec:suffix}.\\[2ex]
-% \begin{tabular}{p{0.4\textwidth}p{0.5\textwidth}}
-% First: \ForgetName[George S.]{Patton, Jr.}\Name[George S.]{Patton, Jr.} & |\Name*[George S.]{Patton, Jr.}|\newline |\Name[George S.]{Patton, Jr.}|\newline |\FName[George S.]{Patton, Jr.}|\\[0.5ex]
-% Subsequent full:\newline\hbox to 1em{\hfil}\Name*[George S.]{Patton, Jr.} & |\Name*[George S.]{Patton, Jr.}|\newline\\[0.5ex]
-% Subsequent surname: \Name[George S.]{Patton, Jr.} & |\Name[George S.]{Patton, Jr.}|\\[0.5ex]
-% Subsequent forename: \FName[George S.]{Patton, Jr.}[George] & |\FName[George S.]{Patton, Jr.}[George]|\\
-% \end{tabular}\\[2ex]
-% \indent The next cases depend on the default \texttt{nocomma} option, whereby one can use comma suppression to implement forms of ancient, royal and Eastern names. \cmd{\AKA} and \cmd{\PName} will cross-reference these forms. Cf. the reference to \Name{Ptolemy I}[Soter] (Section~\ref{sec:Basic}). Using |\Name{Demetrius, I Soter}| keeps the number with the suffix. To keep the number with the name, use |\Name{Demetrius I, Soter}|.\\[2ex]
-% \begin{tabular}{p{0.4\textwidth}p{0.5\textwidth}}
-% First reference: \ForgetName{Francis, I}\Name{Francis, I} & |\Name*{Francis, I}|\newline |\Name{Francis, I}|\newline |\FName{Francis, I}|\\[0.5ex]
-% Subsequent full name: \Name*{Francis, I} & |\Name*{Francis, I}|\\[0.5ex]
-% Subsequent name: \Name{Francis, I} & |\Name{Francis, I}|\newline |\FName{Francis, I}|\\[0.5ex]
-% First reference: \newline\hbox to 1em{\hfil}\ForgetName{Demetrius, I Soter}\Name{Demetrius, I Soter} & |\Name*{Demetrius, I Soter}|\newline |\Name{Demetrius, I Soter}|\newline |\FName{Demetrius, I Soter}|\\[0.5ex]
-% Next full name: \newline\hbox to 1em{\hfil}\Name*{Demetrius, I Soter} & |\Name*{Demetrius, I Soter}|\newline\\[0.5ex]
-% Subsequent name: \Name{Demetrius, I Soter} & |\Name{Demetrius, I Soter}|\newline |\FName{Demetrius, I Soter}|\\[0.5ex]
-% First reference: \ForgetName{Sun, Yat-sen}\Name{Sun, Yat-sen} & |\Name*{Sun, Yat-sen}|\newline |\Name{Sun, Yat-sen}|\newline |\FName{Sun, Yat-sen}|\\[0.5ex]
-% Subsequent full name: \newline\hbox to 1em{\hfil}\Name*{Sun, Yat-sen} & |\Name*{Sun, Yat-sen}|\newline\\[0.5ex]
-% Subsequent name: \Name{Sun, Yat-sen} & |\Name{Sun, Yat-sen}|\newline |\FName{Sun, Yat-sen}|\\
-% \end{tabular}\\
+% \noindent{\bfseries Old Syntax: Royal and Eastern}\\[1ex]
+% Please note that these forms are not recommended. |\Name{Ptolemy}[I Soter]| keeps the number with the affix. To keep the number with the name, use |\Name{Ptolemy I}[Soter]|. See also Section~\ref{sec:Affix}.\\[1ex]
+% \begin{tabular}{p{0.45\textwidth}@{}p{0.55\textwidth}}\hline{\large\strut}
+% First ref: \ForgetName{Henry}[VIII]\Name{Henry}[VIII] & |\Name*{Henry}[VIII]|\newline |\Name{Henry}[VIII]|\newline |\FName{Henry}[VIII]|\\{\large\strut}
+% Subsequent refs: \Name*{Henry}[VIII] & |\Name*{Henry}[VIII]|\\{\large\strut}
+% Subsequent refs: \Name{Henry}[VIII] & |\Name{Henry}[VIII]|\newline |\FName{Henry}[VIII]|\\{\large\strut}
+% First ref: \ForgetName{Ptolemy}[I Soter]\Name{Ptolemy}[I Soter] & |\Name*{Ptolemy}[I Soter]|\newline |\Name{Ptolemy}[I Soter]|\newline |\FName{Ptolemy}[I Soter]|\\{\large\strut}
+% Subsequent refs: \Name*{Ptolemy}[I Soter] & |\Name*{Ptolemy}[I Soter]|\\{\large\strut}
+% Subsequent refs: \Name{Ptolemy}[I Soter] & |\Name{Ptolemy}[I Soter]|\newline |\FName{Ptolemy}[I Soter]|\\\hline{\large\strut}
+% First reference:\newline \hbox to 1em{\hfil}\ForgetName{Mao}[Tse-tung]\Name{Mao}[Tse-tung] & |\Name*{Mao}[Tse-tung]|\newline |\Name{Mao}[Tse-tung]|\\{\large\strut}
+% Subsequent refs: \Name*{Mao}[Tse-tung] & |\Name*{Mao}[Tse-tung]|\\{\large\strut}
+% Subsequent refs: \Name{Mao}[Tse-tung] & |\Name{Mao}[Tse-tung]|\newline |\FName{Mao}[Tse-tung]|\\\hline
+% \end{tabular}
+% \begin{quote}
+%|\begin{nameauth}% In the preamble!|\\[0.2ex]
+%| \< Henry & & Henry & VIII >|\\[0.2ex]
+%| \< Ptol & & Ptolemy & I Soter >|\\[0.2ex]
+%| \< Mao & & Mao & Tse-tung >|\\[0.2ex]
+%|\end{nameauth}|
+%\end{quote}
+% \ForgetName{Ptolemy}[I Soter]\ForgetName{Henry}[VIII]\ForgetName{Mao}[Tse-tung]|\Henry, \LHenry, \Henry, and \SHenry| give \Henry, \LHenry, \Henry, and \SHenry. |\Ptol,| |\LPtol,| |\Ptol,| |and \SPtol| make \Ptol, \LPtol, \Ptol, and \SPtol. |\Mao, \LMao, \Mao, and \SMao| produce \Mao, \LMao, \Mao, and \SMao.
+%
+% Avoid mixing syntax. If you take |\Name{Antiochus, IV}|\IndexName{Antiochus, IV} and add a sobriquet like |\Name{Antiochus, IV}[Epiphanes]| you will get two different names in the index. \cmd{\AKA} may look like it blends old and new syntax, but it really does not.
+%
+% Workarounds include |\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. Use |\Name{Antiochus~IV, Epiphanes}| to keep the numeral with the name (best done with the simplified interface). Maybe the best way is to use something like |\TagName{Antiochus,| |IV}{| |Epiphanes,| |king}| with |\Name{Antiochus,| |IV}| and include ``Epiphanes'' manually as needed.
+%
+% Remember also that you can ``stack'' modifiers like \cmd{\CapThis}, \cmd{\CapName}, \cmd{\RevName}, \cmd{\KeepAffix}, and so on in front of the control sequences of the simplified interface. |\CapName\LMao| generates \CapName\LMao.
% \clearpage
%
% \subsubsection{Particles}
% \label{sec:Particles}
-% The following illustrate the American style of particulate names.\\[2ex]
-% \begin{tabular}{p{0.4\textwidth}p{0.5\textwidth}}
-% First: \ForgetName[Walter]{de la Mare}\Name[Walter]{de la Mare} & |\Name*[Walter]{de la Mare}|\newline |\Name[Walter]{de la Mare}|\newline |\FName[Walter]{de la Mare}|\\[0.5ex]
-% Next reference: \Name[Walter]{de la Mare} & |\Name[Walter]{de la Mare}|\\[0.5ex]
-% At start of sentence: \CapThis\Name[Walter]{de la Mare} & |\CapThis\Name[Walter]{de la Mare}|\\[0.5ex]
-% Forename: \FName[Walter]{de la Mare} & |\FName[Walter]{de la Mare}|\\[0.5ex]
+% The following illustrate the American style of particulate names.\\[1ex]
+% \begin{tabular}{p{0.45\textwidth}@{}p{0.55\textwidth}}\hline{\large\strut}
+% First: \ForgetName[Walter]{de la Mare}\Name[Walter]{de la Mare} & |\Name*[Walter]{de la Mare}|\newline |\Name[Walter]{de la Mare}|\newline |\FName[Walter]{de la Mare}|\\{\large\strut}
+% Next reference: \Name[Walter]{de la Mare} & |\Name[Walter]{de la Mare}|\\{\large\strut}
+% At start of sentence: \CapThis\Name[Walter]{de la Mare} & |\CapThis\Name[Walter]{de la Mare}|\\{\large\strut}
+% Forename: \FName[Walter]{de la Mare} & |\FName[Walter]{de la Mare}|\\\hline
% \end{tabular}\\[2ex]
-% The Continental style differs slightly. These first three forms below put the particles in the index. Long macros are split for readability.\\[2ex]
-% \begin{tabular}{p{0.4\textwidth}p{0.5\textwidth}}
-% The (admittedly long) first use:\newline\small\Name[Johann Wolfgang von]{Goethe} & |\Name*[Johann Wolfgang von]{Goethe}|\newline |\Name[Johann Wolfgang von]{Goethe}|\newline |\FName[Johann Wolfgang von]{Goethe}|\\[0.5ex]
-% Subsequent: \Name[Johann Wolfgang von]{Goethe} & |\Name[Johann Wolfgang von]{Goethe}|\\[0.5ex]
-% Forenames: \FName[Johann Wolfgang von]{Goethe}[Johann Wolfgang] & |\FName[Johann Wolfgang von]{Goethe}%|\newline|[Johann Wolfgang]|\\[0.5ex]
+%
+% \noindent The Continental style differs slightly. These first three forms below put the particles in the index. Long macros are split for readability.\\[1ex]
+% \begin{tabular}{p{0.45\textwidth}@{}p{0.55\textwidth}}\hline{\large\strut}
+% The (admittedly long) first use:\newline\small\Name[Johann Wolfgang von]{Goethe} & |\Name*[Johann Wolfgang von]{Goethe}|\newline |\Name[Johann Wolfgang von]{Goethe}|\newline |\FName[Johann Wolfgang von]{Goethe}|\\{\large\strut}
+% Subsequent: \Name[Johann Wolfgang von]{Goethe} & |\Name[Johann Wolfgang von]{Goethe}|\\{\large\strut}
+% Forenames: \FName[Johann Wolfgang von]{Goethe}[Johann Wolfgang] & |\FName[Johann Wolfgang von]{Goethe}%|\newline|[Johann Wolfgang]|\\\hline
% \end{tabular}\\[2ex]
-% \indent These latter examples of the Continental style use the nickname feature to omit the particles from the index. Long macros are split for readability.\\[2ex]
-% \begin{tabular}{p{0.4\textwidth}p{0.5\textwidth}}
-% First: \Name[Adolf]{Harnack}[Adolf von] & |\Name*[Adolf]{Harnack}[Adolf von]|\newline |\Name[Adolf]{Harnack}[Adolf von]|\newline |\FName[Adolf]{Harnack}[Adolf von]|\\[0.5ex]
-% Next full name:\newline\hbox to 1em{\hfil}\Name*[Adolf]{Harnack}[Adolf von] & |\Name*[Adolf]{Harnack}[Adolf von]|\newline\\[0.5ex]
-% Subsequent surname: \Name[Adolf]{Harnack}[Adolf von] & |\Name[Adolf]{Harnack}[Adolf von]|\newline |\Name[Adolf]{Harnack}|\\[0.5ex]
-% Subsequent forename: \FName[Adolf]{Harnack} & |\FName[Adolf]{Harnack}|\\[0.5ex]
+%
+% \noindent These latter examples of the Continental style use the nickname feature to omit the particles from the index. Long macros are split for readability.\\[1ex]
+% \begin{tabular}{p{0.45\textwidth}@{}p{0.55\textwidth}}\hline{\large\strut}
+% First: \Name[Adolf]{Harnack}[Adolf von] & |\Name*[Adolf]{Harnack}[Adolf von]|\newline |\Name[Adolf]{Harnack}[Adolf von]|\newline |\FName[Adolf]{Harnack}[Adolf von]|\\{\large\strut}
+% Next full name:\newline\hbox to 1em{\hfil}\Name*[Adolf]{Harnack}[Adolf von] & |\Name*[Adolf]{Harnack}[Adolf von]|\newline\\{\large\strut}
+% Subsequent surname: \Name[Adolf]{Harnack}[Adolf von] & |\Name[Adolf]{Harnack}[Adolf von]|\newline |\Name[Adolf]{Harnack}|\\{\large\strut}
+% Subsequent forename: \FName[Adolf]{Harnack} & |\FName[Adolf]{Harnack}|\\\hline
% \end{tabular}
+% \begin{quote}
+%|\begin{nameauth}% In the preamble!|\\[0.2ex]
+%| \< DLM & Walter & de la Mare & >|\\[0.2ex]
+%| \< JWG & Johann Wolfgang von & Goethe & >|\\[0.2ex]
+%| \< Harnack & Adolf & Harnack & >|\\[0.2ex]
+%|\end{nameauth}|
+%\end{quote}
+%\ForgetName[Walter]{de la Mare}\ForgetName[Johann Wolfgang von]{Goethe}\ForgetName[Adolf]{Harnack}|\DLM\| |and| |\CapThis\DLM| produce \DLM\ and \CapThis\DLM. |\JWG\| |and| |\JWG| give \JWG\ and \JWG. Using the alternate forenames option, |\Harnack[Adolf von]\| |and| |\Harnack| yield \Harnack[Adolf von]\ and \Harnack, but you will not see \Harnack's ``von'' in the index.
+% \index{Rambam|seealso{Maimonides}}
% \clearpage
%
% \StopEventually{\PrintChanges\clearpage\PrintIndex}
@@ -1101,29 +1363,32 @@
% \fi
% \subsection{Package Options and Required Packages}
%
+% Used internally to control printed name forms. |@nameauth@FullName| is only used to decide long or short forms in subsequent occurrences of names. The next Boolean, |@nameauth@FirstName|, switches surnames and forenames in the short form. |@nameauth@AltAKA| determines the cross-references that \cmd{\AKA} will print.
% \begin{macrocode}
\newif\if@nameauth@FullName
\newif\if@nameauth@FirstName
\newif\if@nameauth@AltAKA
% \end{macrocode}
-% Used internally to control printed name forms. |@nameauth@FullName| is only used to decide long or short forms in subsequent occurrences of names. The next Boolean, |@nameauth@FirstName|, switches surnames and forenames in the short form. |@nameauth@AltAKA| determines the cross-references that \cmd{\AKA} will print.\\
-%
+% The next Boolean values control formatting. The first is toggled with \cmd{\NamesActive} and \cmd{\NamesInctive}; the second with \cmd{\IndexActive} and \cmd{\IndexInctive}. The first four are set with package options. The last two are set with \cmd{\ShowComma} and \cmd{\KeepAffix}, cleared by each instance of \cmd{\Name} and \cmd{\AKA}.
% \begin{macrocode}
\newif\if@nameauth@DoFormat
\newif\if@nameauth@DoIndex
\newif\if@nameauth@AlwaysFormat
+\newif\if@nameauth@AlwaysComma
\newif\if@nameauth@ShowComma
+\newif\if@nameauth@NBSP
% \end{macrocode}
-% These Boolean values control formatting. The first two can be toggled with \cmd{\NamesActive} and \cmd{\NamesInctive}, as well as \cmd{\IndexActive} and \cmd{\IndexInctive}. The first three are set with package options. The last is set with \cmd{\ShowComma} and cleared by \cmd{\Name} and friends.\\
-%
+% These Boolean values are used for detection of affixes and final periods.
% \begin{macrocode}
\newif\if@nameauth@Comma
\newif\if@nameauth@Punct
% \end{macrocode}
-% These Boolean values are used internally for detection of suffixes and final periods.\\
-%
+% This Boolean value is triggered by \cmd{\CapThis}.
% \begin{macrocode}
\newif\if@nameauth@DoCaps
+% \end{macrocode}
+% The next Boolean values govern full name capitalization, name reversing, and name reversing with commas.
+% \begin{macrocode}
\newif\if@nameauth@AllCaps
\newif\if@nameauth@AllThis
\newif\if@nameauth@RevAll
@@ -1131,8 +1396,7 @@
\newif\if@nameauth@RevAllComma
\newif\if@nameauth@RevThisComma
% \end{macrocode}
-% This Boolean triggers capitalization in \cmd{\Name} of particles like \emph{de la} that may occur at the start of a sentence. It is triggered with \cmd{\CapThis}.\\
-%
+% The following package options interact with many of the prior Boolean values. Suppressing and showing commas is set at load time and should not be changed in the document or else significant errors will result. Most options can be changed with user interface macros. Avoid changing the internal Boolean values directly.
% \changes{v1.7}{2013/04/02}{Change options processing to prevent errors}
% \begin{macrocode}
\newcommand{\NamesFormat}{}
@@ -1148,22 +1412,25 @@
\DeclareOption{allreversed}{\@nameauth@RevAlltrue\@nameauth@RevAllCommafalse}
\DeclareOption{allrevcomma}{\@nameauth@RevAlltrue\@nameauth@RevAllCommatrue}
\DeclareOption{notreversed}{\@nameauth@RevAllfalse\@nameauth@RevAllCommafalse}
-\DeclareOption{comma}{\protected@edef\Interspace{,\space}}
-\DeclareOption{nocomma}{\protected@edef\Interspace{\space}}
+\DeclareOption{comma}{\@nameauth@AlwaysCommatrue}
+\DeclareOption{nocomma}{\@nameauth@AlwaysCommafalse}
\DeclareOption{index}{\@nameauth@DoIndextrue}
\DeclareOption{noindex}{\@nameauth@DoIndexfalse}
\ExecuteOptions{nocomma,mainmatter,index,normalcaps,notreversed,smallcaps}
\ProcessOptions\relax
+% \end{macrocode}
+% Now we load the required packages. They facilitate the first/subsequent name uses, the parsing of arguments, and the implementation of starred forms.
+% \begin{macrocode}
\RequirePackage{etoolbox}
\RequirePackage{trimspaces}
\RequirePackage{suffix}
\RequirePackage{xargs}
% \end{macrocode}
-% The options above interact with the prior Boolean values. Suppressing and showing commas is set at load time and should not be changed in the document or else significant errors will result. Most options can be changed with user interface macros. Avoid changing the internal Boolean values directly.\\
%
% \subsection{Internal Macros}
% \begin{macro}{\@nameauth@CleanName}
% \changes{v0.8}{2012/01/29}{Renamed macro to help compatibility}
+% 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.
% \begin{macrocode}
\newcommand*{\@nameauth@CleanName}[1]%
{%
@@ -1171,14 +1438,12 @@
}
% \end{macrocode}
% \end{macro}
-% Thanks to \Name*[Heiko]{Oberdiek}, this macro produces a ``sanitized'' string based on the forename/surname parameters of \cmd{\Name} and friends. With this we can construct a control sequence name. Testing for the presence of that control sequence determines the existence of pseudonyms and the first occurrence of a name.\\
-%
-% The following macros parse a ``base'' name into a radix and a suffix. They are designed so that their function occurs at the time of macro expansion, not execution. This expandability is key to the proper indexing function of this package. They form the kernel of the suffix removal and comma suppression features.
%
% \begin{macro}{\@nameauth@Root}
% \changes{v0.85}{2012/02/05}{Revise suffix handling}
% \changes{v0.9}{2012/02/10}{renamed macro; suffix handling expandable}
% \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.
% \begin{macrocode}
\newcommand*{\@nameauth@Root}[1]%
{%
@@ -1186,92 +1451,66 @@
}
% \end{macrocode}
% \end{macro}
-% Anything starting with a comma and ending with the end of the name is stripped off. That includes ``Sr.,'' ``Jr.,'' ``III,'' and so on.
%
% \begin{macro}{\@nameauth@TrimRoot}
% \changes{v0.85}{2012/02/05}{Divide suffix handling into functional parts}
% \changes{v0.9}{2012/02/10}{Renamed macro; suffix handling expandable}
+% Throw out the comma and suffix, return the radix.
% \begin{macrocode}
\def\@nameauth@TrimRoot#1,#2\relax{#1}
% \end{macrocode}
% \end{macro}
-% This delimited-parameter macro strips off the second parameter as it returns the first.
%
+% \clearpage
% \begin{macro}{\@nameauth@CapRoot}
% \changes{v0.95}{2012/02/17}{Added macro}
+% The next two macros implement the particulate name capitalization mechanism by returning a radix where the first letter is capitalized.
% \begin{macrocode}
\newcommand*{\@nameauth@CapRoot}[1]%
-{%
- \@nameauth@CR#1\relax%
-}
+ {\@nameauth@CR#1\relax}
% \end{macrocode}
% \end{macro}
-% This macro implements the particulate name capitalization mechanism.
%
% \begin{macro}{\@nameauth@CR}
% \changes{v0.95}{2012/02/17}{Added macro}
+% Grab the first letter as one parameter, and everything before \cmd{\relax} as the second. Capitalize the first and return it with the second.
% \begin{macrocode}
\def\@nameauth@CR#1#2\relax{\uppercase{#1}\@nameauth@Root{#2}}
% \end{macrocode}
% \end{macro}
-% This delimited-parameter macro caps the first parameter and strips suffixes off the second.
%
% \begin{macro}{\@nameauth@AllCapRoot}
% \changes{v1.5}{2013/02/22}{Added macro}
+% This macro returns a fully-capitalized radix. It is used for generating capitalized Eastern family names in the body text.
% \begin{macrocode}
\newcommand*{\@nameauth@AllCapRoot}[1]%
-{%
- \uppercase{\@nameauth@Root{#1}}%
-}
+ {\uppercase{\@nameauth@Root{#1}}}
% \end{macrocode}
% \end{macro}
-% This macro caps the root name(s) in a potential \meta{root}|,|\meta{suffix} pair.
%
% \begin{macro}{\@nameauth@Suffix}
% \changes{v0.9}{2012/02/10}{added macro}
% \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 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.
% \begin{macrocode}
\newcommand*{\@nameauth@Suffix}[1]%
-{%
- \@nameauth@TrimSuffix#1\relax%
-}
+ {\@nameauth@TrimSuffix#1\relax}
% \end{macrocode}
% \end{macro}
-% Anything before a comma is stripped off by |\@nameauth@Suffix|, but it should be called only in a conditional where one knows that a comma will be present.
%
% \begin{macro}{\@nameauth@TrimSuffix}
% \changes{v0.9}{2012/02/10}{added macro}
% \changes{v1.4}{2012/07/24}{Made more robust}
% \changes{v1.5}{2013/02/22}{Added space removal}
+% Throw out the radix, comma, and \cmd{\relax}; return the suffix with no leading spaces.
% \begin{macrocode}
\def\@nameauth@TrimSuffix#1,#2\relax{\trim@spaces{#2}}
% \end{macrocode}
% \end{macro}
-% This delimited-parameter macro strips the first parameter and returns the second. By stripping off spaces it allows consistent formatting.
-%
-%The next macros check whether the next token is a period. They are only called if the terminal character produced within \cmd{\Name} and \cmd{\FName} is itself a period.
-%
-% \begin{macro}{\@nameauth@CheckDot}
-% \changes{v0.8}{2012/01/29}{Renamed macro to help compatibility}
-% \begin{macrocode}
-\def\@nameauth@CheckDot{\futurelet\@token\@nameauth@EvalDot}
-% \end{macrocode}
-% \end{macro}
-% This macro assigns the lookahead token \cmd{\@token} to be evaluated by\break \cmd{\@nameauth@EvalDot} while keeping \cmd{\@token} non-destructively on the list of input tokens. This does not gobble spaces like \cmd{\@nextchar}.
-%
-% \begin{macro}{\@nameauth@EvalDot}
-% \changes{v0.8}{2012/01/29}{Renamed macro to help compatibility}
-% \begin{macrocode}
-\def\@nameauth@EvalDot%
-{%
- \let\@period=.\ifx\@token\@period\expandafter\@gobble \fi%
-}
-% \end{macrocode}
-% \end{macro}
-% \cmd{\@nameauth@EvalDot} checks if \cmd{\@token} is a period. If so it gobbles it by using \cmd{\expandafter} to get past the grouping. Another \cmd{\expandafter} occurs immediately before the invocation of \cmd{\@nameauth@CheckDot} in \cmd{\Name}, \cmd{\FName}, and \cmd{\AKA}.
%
% \begin{macro}{\@nameauth@TestDot}
% \changes{v0.8}{2012/01/29}{Renamed macro to help compatibility}
+% This macro, based on a snippet by \Name*[Uwe]{Lueck}, checks for a period at the end of its parameter, ignoring medial periods. It determines whether we need to call \cmd{\@nameauth@CheckDot} below.
% \begin{macrocode}
\newcommand*{\@nameauth@TestDot}[1]%
{%
@@ -1283,9 +1522,23 @@
}
% \end{macrocode}
% \end{macro}
-% While \cmd{\@nameauth@CheckDot} looks \emph{ahead} for a period, \cmd{\@nameauth@TestDot}\,---\,based on a snippet by \Name*[Uwe]{Lueck}\,---\,checks for a terminal period in the name passed to it, ignoring medial periods. It always resets the Boolean value before making its test, making it unnecessary to reset elsewhere.\\
%
-% The following macros format the output for \cmd{\Name} and friends. The intent is to separate formatting in modular fashion from name parsing.
+% \begin{macro}{\@nameauth@CheckDot}
+% \changes{v0.8}{2012/01/29}{Renamed macro to help compatibility}
+% We assume that \cmd{\expandafter} precedes the invocation of \cmd{\@nameauth@CheckDot}, which only is called if the terminal character of the input is a period. We evaluate the lookahead \cmd{\@token} while keeping it on the list of input tokens.
+% \begin{macrocode}
+\def\@nameauth@CheckDot{\futurelet\@token\@nameauth@EvalDot}
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\@nameauth@EvalDot}
+% \changes{v0.8}{2012/01/29}{Renamed macro to help compatibility}
+% If \cmd{\@token} is a full stop, we gobble the token.
+% \begin{macrocode}
+\def\@nameauth@EvalDot%
+ {\let\@period=.\ifx\@token\@period\expandafter\@gobble \fi}
+% \end{macrocode}
+% \end{macro}
%
% \begin{macro}{\@nameauth@FmtName}
% \changes{v0.8}{2012/01/29}{Renamed macro to help compatibility}
@@ -1293,6 +1546,7 @@
% \changes{v0.9}{2012/02/10}{Redesigned macro}
% \changes{v0.94}{2012/02/15}{Added particle caps}
% \changes{v0.95}{2012/02/17}{Fixed incompatibility with \textsf{microtype}}
+% The following macros format the output of \cmd{\Name}, etc. \cmd{\@nameauth@FmtName} is where the first occurrences of a name are formatted. Notice how \cmd{\NamesFormat} sits between a \cmd{\bgroup} and an \cmd{\egroup} to localize the font change. The \cmd{\NamesFormat} hook has been discussed previously.
% \begin{macrocode}
\newcommand{\@nameauth@FmtName}[1]%
{%
@@ -1303,6 +1557,12 @@
#1%
\fi%
}
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\@nameauth@FmtName*}
+% \cmd{\@nameauth@FmtName} is where subsequent occurrences of a name are formatted. |\if@nameauth@AlwaysFormat| causes formatting to occur always (when possible).
+% \begin{macrocode}
\WithSuffix\newcommand\@nameauth@FmtName*[1]%
{%
\@nameauth@TestDot{#1}%
@@ -1318,10 +1578,11 @@
}
% \end{macrocode}
% \end{macro}
-% \cmd{\@nameauth@FmtName} is where the first occurrences of a name are formatted. Notice how \cmd{\NamesFormat} sits between a \cmd{\bgroup} and an \cmd{\egroup} to localize the font change. The \cmd{\NamesFormat} hook has been discussed above. The conditional |\if@nameauth@AlwaysFormat| causes formatting to occur always (when possible).
%
% \begin{macro}{\@nameauth@Index}
% \changes{v0.94}{2012/02/15}{Added macro}
+% \changes{v1.9}{2015/07/09}{babel workaround}
+% If the indexing flag is true, create an index entry, otherwise do nothing.
% \begin{macrocode}
\newcommandx\@nameauth@Index[2][2=\@empty]%
{%
@@ -1337,66 +1598,51 @@
}
% \end{macrocode}
% \end{macro}
-% If the indexing flag is true, create an index entry, otherwise do nothing.
-%
% \subsection{User Interface Macros}
-%
+% The following macros have been documented previously. Either they call the internal macros or set Boolean values.
% \begin{macro}{\CapThis}
% \changes{v0.94}{2012/02/15}{Added macro}
% \begin{macrocode}
-\newcommand{\CapThis}%
-{%
- \@nameauth@DoCapstrue%
-}
+\newcommand{\CapThis}{\@nameauth@DoCapstrue}
% \end{macrocode}
% \end{macro}
-% Force the capitalizing of particles. This affects the next occurrence of \cmd{\Name}, which then turns off the forced caps.
-%
+%
% \begin{macro}{\CapName}
% \changes{v1.5}{2013/02/22}{Added macro}
+% Capitalize entire name.
% \begin{macrocode}
-\newcommand{\CapName}%
-{%
- \@nameauth@AllThistrue%
-}
+\newcommand{\CapName}{\@nameauth@AllThistrue}
% \end{macrocode}
% \end{macro}
-% Force the capitalizing of particles. This affects the next occurrence of \cmd{\Name}, which then turns off the forced caps.
-%
% \begin{macro}{\RevName}
% \changes{v1.5}{2013/02/22}{Added macro}
+% Reverse name order.
% \begin{macrocode}
-\newcommand{\RevName}%
-{%
- \@nameauth@RevThistrue%
-}
+\newcommand{\RevName}{\@nameauth@RevThistrue}
% \end{macrocode}
% \end{macro}
-% Force the capitalizing of particles. This affects the next occurrence of \cmd{\Name}, which then turns off the forced caps.
-%
% \begin{macro}{\RevComma}
% \changes{v1.5}{2013/02/22}{Added macro}
+% Last name, comma, first name.
% \begin{macrocode}
\newcommand{\RevComma}%
-{%
- \@nameauth@RevThistrue%
- \@nameauth@RevThisCommatrue%
-}
+ {\@nameauth@RevThistrue\@nameauth@RevThisCommatrue}
% \end{macrocode}
% \end{macro}
-% Force the capitalizing of particles. This affects the next occurrence of \cmd{\Name}, which then turns off the forced caps.
-%
% \begin{macro}{\ShowComma}
% \changes{v1.4}{2012/07/24}{Added macro}
+% Put comma between name and suffix one time.
% \begin{macrocode}
-\newcommand{\ShowComma}%
-{%
- \@nameauth@ShowCommatrue%
-}
+\newcommand{\ShowComma}{\@nameauth@ShowCommatrue}
+% \end{macrocode}
+% \end{macro}
+% \begin{macro}{\KeepAffix}
+% \changes{v1.9}{2015/07/09}{Added macro}
+% Trigger a name-suffix pair to be separated by a non-breaking space.
+% \begin{macrocode}
+\newcommand{\KeepAffix}{\@nameauth@NBSPtrue}
% \end{macrocode}
% \end{macro}
-% Force a comma between a name and a suffix on a per-issue basis.
-%
% \begin{macro}{\Name}
% \changes{v0.75}{2012/01/19}{Added ``sobriquet'' feature}
% \changes{v0.8}{2012/01/29}{Merged all major functionality here}
@@ -1409,6 +1655,7 @@
% \changes{v1.26}{2012/04/24}{Fixed sorting of name suffixes in index}
% \changes{v1.4}{2012/07/24}{Made more robust}
% \changes{v1.5}{2013/02/22}{Added reversing and caps mechanisms}
+% 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]%
{%
@@ -1416,13 +1663,21 @@
\protected@edef\testi{#1}%
\protected@edef\testii{#2}%
\protected@edef\testiii{#3}%
- \if@nameauth@AllCaps\CapName\fi%
- \if@nameauth@RevAll\RevName\fi%
- \if@nameauth@RevAllComma\RevComma\fi%
+ \if@nameauth@AllCaps\@nameauth@AllThistrue\fi%
+ \if@nameauth@RevAll\@nameauth@RevThistrue\fi%
+ \if@nameauth@RevAllComma\@nameauth@RevThisCommatrue\fi%
+ \protected@edef\ISpace{\space}%
+ \protected@edef\Space{\space}%
+ \if@nameauth@NBSP\protected@edef\Space{\nobreakspace}\fi%
+ \if@nameauth@AlwaysComma%
+ \protected@edef\ISpace{,\space}%
+ \protected@edef\Space{,\space}%
+ \if@nameauth@NBSP\protected@edef\Space{,\nobreakspace}\fi%
+ \fi%
\if@nameauth@ShowComma%
+ \protected@edef\ISpace{,\space}%
\protected@edef\Space{,\space}%
- \else%
- \let\Space\Interspace%
+ \if@nameauth@NBSP\protected@edef\Space{,\nobreakspace}\fi%
\fi%
\protected@edef\RawShort{\@nameauth@Root{#2}}%
\protected@edef\CapShort{\@nameauth@CapRoot{#2}}%
@@ -1446,7 +1701,7 @@
\fi%
\else%
\protected@edef\Suffix{\@nameauth@Suffix{#2}}%
- \protected@edef\IndexSurnames{\RawShort\Space\Suffix}%
+ \protected@edef\IndexSurnames{\RawShort\ISpace\Suffix}%
\protected@edef\Reversed{\Suffix\Space\RawShort}%
\protected@edef\Surnames{\RawShort\Space\Suffix}%
\if@nameauth@RevThis%
@@ -1473,16 +1728,13 @@
\fi%
\fi%
\fi%
- \@nameauth@DoCapsfalse%
- \@nameauth@AllThisfalse%
- \@nameauth@ShowCommafalse%
\ifx\testi\@empty%
\ifx\testiii\@empty%
\ifcsname\@nameauth@CleanName{#2!PN!}\endcsname%
\PackageWarning{nameauth}%
{macro \Name: Xref: #2 cannot be a page reference.}%
\else%
- \@nameauth@Index{\IndexSurnames}[\@nameauth@CleanName{#2}]%
+ \@nameauth@Index{\IndexSurnames}[\@nameauth@CleanName{#2}!TAG!]%
\fi%
\if@nameauth@DoFormat%
\ifcsname\@nameauth@CleanName{#2!MN!}\endcsname%
@@ -1542,7 +1794,7 @@
\PackageWarning{nameauth}%
{macro \Name: Xref: #2 #3 cannot be a page reference.}%
\else%
- \@nameauth@Index{\IndexSurnames\space#3}[\@nameauth@CleanName{#2#3}]%
+ \@nameauth@Index{\IndexSurnames\ISpace#3}[\@nameauth@CleanName{#2#3}!TAG!]%
\fi%
\if@nameauth@DoFormat%
\ifcsname\@nameauth@CleanName{#2#3!MN!}\endcsname%
@@ -1609,16 +1861,16 @@
\expandafter\testiii\expandafter\space\Surnames}%
\else%
\expandafter\@nameauth@FmtName\expandafter*\expandafter{%
- \expandafter\Surnames\expandafter\space#3}%
+ \expandafter\Surnames\expandafter\space\testiii}%
\fi%
\fi%
\fi%
\fi%
\else%
\if@nameauth@RevThisComma%
+ \protected@edef\ISpace{,\space}%
\protected@edef\Space{,\space}%
- \else%
- \let\Space\Interspace%
+ \if@nameauth@NBSP\protected@edef\Space{,\nobreakspace}\fi%
\fi%
\ifx\testiii\@empty%
\protected@edef\Forenames{#1}%
@@ -1630,9 +1882,9 @@
{macro \Name: Xref: #1 #2 cannot be a page reference.}%
\else%
\ifx\Suffix\@empty%
- \@nameauth@Index{\IndexShort, #1}[\@nameauth@CleanName{#1#2}]%
+ \@nameauth@Index{\IndexShort, #1}[\@nameauth@CleanName{#1#2}!TAG!]%
\else%
- \@nameauth@Index{\IndexShort, #1, \Suffix}[\@nameauth@CleanName{#1#2}]%
+ \@nameauth@Index{\IndexShort, #1, \Suffix}[\@nameauth@CleanName{#1#2}!TAG!]%
\fi%
\fi%
\if@nameauth@DoFormat%
@@ -1699,6 +1951,10 @@
\fi%
\fi%
\fi%
+ \@nameauth@NBSPfalse%
+ \@nameauth@DoCapsfalse%
+ \@nameauth@AllThisfalse%
+ \@nameauth@ShowCommafalse%
\@nameauth@RevThisfalse%
\@nameauth@RevThisCommafalse%
\if@nameauth@Punct\expandafter\@nameauth@CheckDot\fi%
@@ -1708,19 +1964,12 @@
%
% \begin{macro}{\Name*}
% \changes{v1.4}{2012/07/24}{Refactored}
+% \cmd{\Name*} sets a Boolean value and calls \cmd{\Name}.
% \begin{macrocode}
\WithSuffix\newcommandx\Name*[3][1=\@empty, 3=\@empty]%
-{%
- \@nameauth@FullNametrue%
- \Name[#1]{#2}[#3]%
-}
+ {\@nameauth@FullNametrue\Name[#1]{#2}[#3]}
% \end{macrocode}
% \end{macro}
-% \cmd{\Name} is the heart of this package. \Name*[Marc van]{Dongen} provided the basic structure. The present version has been refactored to isolate indexing and parsing. Macros have been redesigned to be smaller, more efficient, and more robust.
-%
-% The present version of \cmd{\Name} incorporates \cmd{\FName} as well.
-%
-% The use of \cmd{\expandafter} before \cmd{\@nameauth@CheckDot} works with the other use of \cmd{\expandafter} mentioned with \cmd{\@nameauth@EvalDot} above to move past the closing brace and fetch the period as lookahead. That is only done when the check for a terminal period in the name succeeds.
%
% \begin{macro}{\FName}
% \changes{v0.9}{2012/02/10}{Added macro}
@@ -1729,27 +1978,23 @@
% \changes{v1.0}{2012/02/20}{Fixed compatibility issues.}
% \changes{v1.26}{2012/04/24}{Fixed sorting of name suffixes in index}
% \changes{v1.4}{2012/07/24}{Refactored}
+% \cmd{\FName} sets a Boolean value and calls \cmd{\Name}.
% \begin{macrocode}
\newcommandx\FName[3][1=\@empty, 3=\@empty]%
-{%
- \@nameauth@FirstNametrue%
- \Name[#1]{#2}[#3]%
-}
+ {\@nameauth@FirstNametrue\Name[#1]{#2}[#3]}
% \end{macrocode}
% \end{macro}
%
-% \begin{macro}{\FName}
+% \begin{macro}{\FName*}
% \changes{v1.4}{2012/07/24}{Refactored}
+% \cmd{\FName} and \cmd{\FName*} are identical.
% \begin{macrocode}
\WithSuffix\newcommandx\FName*[3][1=\@empty, 3=\@empty]%
-{%
- \@nameauth@FirstNametrue%
- \Name[#1]{#2}[#3]%
-}
+ {\@nameauth@FirstNametrue\Name[#1]{#2}[#3]}
% \end{macrocode}
% \end{macro}
-% \cmd{\FName} and \cmd{\FName*} are identical and derived from \cmd{\Name} using it to print forename(s) in a subsequent use.
%
+% \clearpage
% \begin{macro}{\AKA}
% \changes{v0.85}{2012/02/05}{Add comma suppression, ltxdoc compatibility}
% \changes{v0.86}{2012/02/06}{Fixed some regressions}
@@ -1760,6 +2005,7 @@
% \changes{v1.26}{2012/04/24}{Fixed sorting of name suffixes in index}
% \changes{v1.4}{2012/07/24}{Made more robust}
% \changes{v1.5}{2013/02/22}{Added reversing and caps mechanisms}
+% \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]%
{%
@@ -1769,34 +2015,60 @@
\protected@edef\testiii{#3}%
\protected@edef\testiv{#4}%
\protected@edef\testv{#5}%
- \if@nameauth@AllCaps\CapName\fi%
- \if@nameauth@RevAll\RevName\fi%
- \if@nameauth@RevAll\RevComma\fi%
+ \if@nameauth@AllCaps\@nameauth@AllThistrue\fi%
+ \if@nameauth@RevAll\@nameauth@RevThistrue\fi%
+ \if@nameauth@RevAllComma\@nameauth@RevThisCommatrue\fi%
+ \protected@edef\ISpace{\space}%
+ \protected@edef\Space{\space}%
+ \if@nameauth@NBSP\protected@edef\Space{\nobreakspace}\fi%
+ \if@nameauth@AlwaysComma%
+ \protected@edef\ISpace{,\space}%
+ \protected@edef\Space{,\space}%
+ \if@nameauth@NBSP\protected@edef\Space{,\nobreakspace}\fi%
+ \fi%
\if@nameauth@ShowComma%
+ \protected@edef\ISpace{,\space}%
\protected@edef\Space{,\space}%
- \else%
- \let\Space\Interspace%
+ \if@nameauth@NBSP\protected@edef\Space{,\nobreakspace}\fi%
\fi%
\protected@edef\Shortii{\@nameauth@Root{#2}}%
\protected@edef\Shortiv{\@nameauth@Root{#4}}%
+ \protected@edef\CapShort{\@nameauth@CapRoot{#4}}%
+ \protected@edef\AllCapShort{\@nameauth@AllCapRoot{#4}}%
\ifx\testii\Shortii%
\let\Surnamesii\Shortii%
\protected@edef\Suffixii{\@empty}%
\else%
\protected@edef\Suffixii{\@nameauth@Suffix{#2}}%
- \protected@edef\Surnamesii{\Shortii\Space\Suffixii}%
+ \protected@edef\Surnamesii{\Shortii\ISpace\Suffixii}%
\fi%
\ifx\testiv\Shortiv%
\protected@edef\Suffixiv{\@empty}%
+ \let\ISurnamesiv\Shortiv%
+ \let\Reversed\Shortiv%
\let\Surnamesiv\Shortiv%
- \let\Reverseiv\Shortiv%
+ \if@nameauth@DoCaps%
+ \let\Surnamesiv\CapShort%
+ \let\Reversed\CapShort%
+ \fi%
+ \if@nameauth@AllThis%
+ \let\Surnamesiv\AllCapShort%
+ \let\Reversed\AllCapShort%
+ \fi%
\else%
\protected@edef\Suffixiv{\@nameauth@Suffix{#4}}%
+ \protected@edef\ISurnamesiv{\Shortiv\ISpace\Suffixiv}%
+ \protected@edef\Reversed{\Suffixiv\Space\Shortiv}%
\protected@edef\Surnamesiv{\Shortiv\Space\Suffixiv}%
- \protected@edef\Reverseiv{\Suffixiv\Space\Shortiv}%
+ \if@nameauth@DoCaps%
+ \protected@edef\Reversed{\Suffixiv\Space\CapShort}%
+ \protected@edef\Surnamesiv{\CapShort\Space\Suffixiv}%
+ \fi%
+ \if@nameauth@AllThis%
+ \protected@edef\Reversed{\Suffixiv\Space\AllCapShort}%
+ \protected@edef\Surnamesiv{\AllCapShort\Space\Suffixiv}%
+ \fi%
\fi%
- \@nameauth@ShowCommafalse%
- \@nameauth@AllThisfalse%
\ifx\testiii\@empty%
\ifx\testv\@empty%
\ifcsname\@nameauth@CleanName{#4!PN!}\endcsname%
@@ -1813,22 +2085,21 @@
\else%
\csgdef{\@nameauth@CleanName{#4!PN!}}{}%
\ifx\testi\@empty%
- \@nameauth@Index{\Surnamesiv|see{\Surnamesii}}%
+ \@nameauth@Index{\ISurnamesiv|see{\Surnamesii}}%
\else%
- \ifx\Suffixii\@empty \@nameauth@Index{\Surnamesiv|see{\Surnamesii, #1}}%
- \else \@nameauth@Index{\Surnamesiv|see{\Shortii, #1, \Suffixii}}\fi%
+ \ifx\Suffixii\@empty \@nameauth@Index{\ISurnamesiv|see{\Surnamesii, #1}}%
+ \else \@nameauth@Index{\ISurnamesiv|see{\Shortii, #1, \Suffixii}}\fi%
\fi%
\fi%
\fi%
\fi%
- \@nameauth@AltAKAfalse%
\if@nameauth@RevThisComma%
+ \protected@edef\ISpace{,\space}%
\protected@edef\Space{,\space}%
- \else%
- \let\Space\Interspace%
+ \if@nameauth@NBSP\protected@edef\Space{,\nobreakspace}\fi%
\fi%
\if@nameauth@RevThis%
- \expandafter\@nameauth@FmtName\expandafter*\expandafter{\Reverseiv}%
+ \expandafter\@nameauth@FmtName\expandafter*\expandafter{\Reversed}%
\else%
\expandafter\@nameauth@FmtName\expandafter*\expandafter{\Surnamesiv}%
\fi%
@@ -1847,27 +2118,25 @@
\else%
\csgdef{\@nameauth@CleanName{#4#5!PN!}}{}%
\ifx\testi\@empty%
- \@nameauth@Index{\Surnamesiv\space#5|see{\Surnamesii}}%
+ \@nameauth@Index{\ISurnamesiv\ISpace#5|see{\Surnamesii}}%
\else%
- \ifx\Suffixii\@empty \@nameauth@Index{\Surnamesiv\space#5|see{\Surnamesii, #1}}%
- \else \@nameauth@Index{\Surnamesiv\space#5|see{\Shortii, #1, \Suffixii}}\fi%
+ \ifx\Suffixii\@empty \@nameauth@Index{\ISurnamesiv\ISpace#5|see{\Surnamesii, #1}}%
+ \else \@nameauth@Index{\ISurnamesiv\ISpace#5|see{\Shortii, #1, \Suffixii}}\fi%
\fi%
\fi%
\fi%
\fi%
\if@nameauth@RevThisComma%
+ \protected@edef\ISpace{,\space}%
\protected@edef\Space{,\space}%
- \else%
- \let\Space\Interspace%
+ \if@nameauth@NBSP\protected@edef\Space{,\nobreakspace}\fi%
\fi%
\if@nameauth@AltAKA%
- \@nameauth@AltAKAfalse%
\if@nameauth@RevThis%
\else%
\expandafter\@nameauth@FmtName\expandafter*\expandafter{\testv}%
\fi%
\else%
- \@nameauth@AltAKAfalse%
\if@nameauth@RevThis%
\expandafter\@nameauth@FmtName\expandafter*\expandafter{\expandafter\testv\expandafter\Space\Surnamesiv}%
\else%
@@ -1890,18 +2159,18 @@
\else%
\csgdef{\@nameauth@CleanName{#3#4!PN!}}{}%
\ifx\testi\@empty%
- \ifx\Suffixiv\@empty \@nameauth@Index{\Surnamesiv, #3|see{\Surnamesii}}%
+ \ifx\Suffixiv\@empty \@nameauth@Index{\ISurnamesiv, #3|see{\Surnamesii}}%
\else \@nameauth@Index{\Shortiv, #3, \Suffixiv|see{\Surnamesii}}\fi%
\else%
\ifx\Suffixii\@empty%
\ifx\Suffixiv\@empty%
- \@nameauth@Index{\Surnamesiv, #3|see{\Surnamesii, #1}}%
+ \@nameauth@Index{\ISurnamesiv, #3|see{\Surnamesii, #1}}%
\else%
\@nameauth@Index{\Shortiv, #3, \Suffixiv|see{\Surnamesii, #1}}%
\fi%
\else%
\ifx\Suffixiv\@empty%
- \@nameauth@Index{\Surnamesiv, #3|see{\Shortii, #1, \Suffixii}}%
+ \@nameauth@Index{\ISurnamesiv, #3|see{\Shortii, #1, \Suffixii}}%
\else%
\@nameauth@Index{\Shortiv, #3, \Suffixiv|see{\Shortii, #1, \Suffixii}}%
\fi%
@@ -1910,11 +2179,10 @@
\fi%
\fi%
\fi%
- \@nameauth@AltAKAfalse%
\if@nameauth@RevThisComma%
+ \protected@edef\ISpace{,\space}%
\protected@edef\Space{,\space}%
- \else%
- \let\Space\Interspace%
+ \if@nameauth@NBSP\protected@edef\Space{,\nobreakspace}\fi%
\fi%
\ifx\testv\@empty%
\protected@edef\Forenames{#3}%
@@ -1929,10 +2197,22 @@
\expandafter\Forenames\expandafter\space\Surnamesiv}%
\fi%
\fi%
+ \@nameauth@NBSPfalse%
+ \@nameauth@AltAKAfalse%
+ \@nameauth@DoCapsfalse%
+ \@nameauth@AllThisfalse%
+ \@nameauth@ShowCommafalse%
\@nameauth@RevThisfalse%
\@nameauth@RevThisCommafalse%
\if@nameauth@Punct\expandafter\@nameauth@CheckDot\fi%
}
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\AKA*}
+% \changes{v0.9}{2012/02/10}{Added macro}
+% This starred form sets a Boolean to print only the alternate name parameter, if that exists, and calls \cmd{\AKA}.
+% \begin{macrocode}
\WithSuffix\newcommandx\AKA*[5][1=\@empty,3=\@empty,5=\@empty]%
{%
\@nameauth@AltAKAtrue%
@@ -1940,25 +2220,33 @@
}
% \end{macrocode}
% \end{macro}
-% \cmd{\AKA} prints a pseudonym and creates index cross-references. Its starred form prints only the alternate name parameter, if that exists. It prevents multiple generation of cross-references and suppresses double periods.
%
% \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}.
% \begin{macrocode}
\newcommandx\PName[5][1=\@empty,3=\@empty,5=\@empty]%
{%
\Name[#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}.
+% \begin{macrocode}
\WithSuffix\newcommandx\PName*[5][1=\@empty,3=\@empty,5=\@empty]%
{%
\Name*[#1]{#2}\space(\AKA[#1]{#2}[#3]{#4}[#5])%
}
% \end{macrocode}
% \end{macro}
-% \cmd{\PName} is a convenience macro whose starred and unstarred forms call the respective versions of \cmd{\Name}, followed only by \cmd{\AKA}.
%
% \begin{macro}{\TagName}
% \changes{v1.2}{2012/02/25}{Added macro.}
+% \changes{v1.9}{2015/07/09}{fix collisions}
+% This creates an index entry tag that is applied to a name that is not already used as a cross reference via \cmd{\AKA}.
% \begin{macrocode}
\newcommandx\TagName[4][1=\@empty, 3=\@empty]%
{%
@@ -1970,14 +2258,14 @@
\PackageWarning{nameauth}%
{macro \textbackslash TagName Cannot tag xref: #2.}%
\else%
- \csgdef{\@nameauth@CleanName{#2}}{#4}%
+ \csgdef{\@nameauth@CleanName{#2}!TAG!}{#4}%
\fi%
\else%
\ifcsname\@nameauth@CleanName{#2#3!PN!}\endcsname%
\PackageWarning{nameauth}%
{macro \textbackslash TagName Cannot tag xref: #2 #3.}%
\else%
- \csgdef{\@nameauth@CleanName{#2#3}}{#4}%
+ \csgdef{\@nameauth@CleanName{#2#3}!TAG!}{#4}%
\fi%
\fi%
\else%
@@ -1985,16 +2273,17 @@
\PackageWarning{nameauth}%
{macro \textbackslash TagName Cannot tag xref: #1 #2.}%
\else%
- \csgdef{\@nameauth@CleanName{#1#2}}{#4}%
+ \csgdef{\@nameauth@CleanName{#1#2}!TAG!}{#4}%
\fi%
\fi%
}
% \end{macrocode}
% \end{macro}
-% \cmd{\TagName} creates an index entry tag after a name that is not already a pseudonym.
%
% \begin{macro}{\UntagName}
% \changes{v1.2}{2012/02/25}{Added macro.}
+% \changes{v1.9}{2015/07/09}{Ensure global undef, fix collisions}
+% This deletes an index entry tag.
% \begin{macrocode}
\newcommandx\UntagName[3][1=\@empty, 3=\@empty]%
{%
@@ -2002,17 +2291,16 @@
\protected@edef\testiii{#3}%
\ifx\testi\@empty%
\ifx\testiii\@empty%
- \csundef{\@nameauth@CleanName{#2}}%
+ \global\csundef{\@nameauth@CleanName{#2}!TAG!}%
\else%
- \csundef{\@nameauth@CleanName{#2#3}}%
+ \global\csundef{\@nameauth@CleanName{#2#3}!TAG!}%
\fi%
\else%
- \csundef{\@nameauth@CleanName{#1#2}}%
+ \global\csundef{\@nameauth@CleanName{#1#2}!TAG!}%
\fi%
}
% \end{macrocode}
% \end{macro}
-% \cmd{\TagName} creates an index entry tag after a name that is not already a pseudonym.
%
% \begin{macro}{\IndexName}
% \changes{v0.75}{2012/01/19}{Optional parameter added; mandatory parameter deleted}
@@ -2023,16 +2311,19 @@
% \changes{v1.2}{2012/02/25}{Added warnings.}
% \changes{v1.26}{2012/04/24}{Fixed sorting of name suffixes in index}
% \changes{v1.4}{2012/07/24}{Made more robust}
+% This creates an index entry that is not already a pseudonym. It prints nothing. It does ensure consistent formatting.
% \begin{macrocode}
\newcommandx\IndexName[3][1=\@empty, 3=\@empty]%
{%
\protected@edef\testi{#1}%
\protected@edef\testii{#2}%
\protected@edef\testiii{#3}%
+ \protected@edef\Space{\space}%
+ \if@nameauth@AlwaysComma%
+ \protected@edef\Space{,\space}%
+ \fi%
\if@nameauth@ShowComma%
\protected@edef\Space{,\space}%
- \else%
- \let\Space\Interspace%
\fi%
\protected@edef\Short{\@nameauth@Root{#2}}%
\ifx\testii\Short%
@@ -2042,21 +2333,20 @@
\protected@edef\Suffix{\@nameauth@Suffix{#2}}%
\protected@edef\Surnames{\Short\Space\Suffix}%
\fi%
- \@nameauth@ShowCommafalse%
\ifx\testi\@empty%
\ifx\testiii\@empty%
\ifcsname\@nameauth@CleanName{#2!PN!}\endcsname%
\PackageWarning{nameauth}%
{macro \IndexName: XRef: #2 exists.}%
\else%
- \@nameauth@Index{\Surnames}[\@nameauth@CleanName{#2}]%
+ \@nameauth@Index{\Surnames}[\@nameauth@CleanName{#2}!TAG!]%
\fi%
\else%
\ifcsname\@nameauth@CleanName{#2#3!PN!}\endcsname%
\PackageWarning{nameauth}%
{macro \IndexName: XRef: #2 #3 exists.}%
\else%
- \@nameauth@Index{\Surnames\space#3}[\@nameauth@CleanName{#2#3}]%
+ \@nameauth@Index{\Surnames\Space#3}[\@nameauth@CleanName{#2#3}!TAG!]%
\fi%
\fi%
\else%
@@ -2064,17 +2354,18 @@
\PackageWarning{nameauth}%
{macro \IndexName: XRef: #1 #2 exists.}%
\else%
- \ifx\Suffix\@empty \@nameauth@Index{\Short, #1}[\@nameauth@CleanName{#1#2}]%
- \else \@nameauth@Index{\Short, #1, \Suffix}[\@nameauth@CleanName{#1#2}]\fi%
+ \ifx\Suffix\@empty \@nameauth@Index{\Short, #1}[\@nameauth@CleanName{#1#2}!TAG!]%
+ \else \@nameauth@Index{\Short, #1, \Suffix}[\@nameauth@CleanName{#1#2}!TAG!]\fi%
\fi%
\fi%
+ \@nameauth@ShowCommafalse%
}
% \end{macrocode}
% \end{macro}
-% \cmd{\IndexName} creates an index entry that is not already a pseudonym. It prints nothing. It does ensure consistent formatting.
%
% \begin{macro}{\ExcludeName}
% \changes{v0.94}{2012/02/15}{Added macro}
+% 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]%
{%
@@ -2133,10 +2424,11 @@
}
% \end{macrocode}
% \end{macro}
-% This macro prevents a name from being formatted or indexed by using the exclusion mechanism of \cmd{\AKA}. The result is that \cmd{\Name} and friends will print their arguments, emit a warning, and continue.
%
% \begin{macro}{\ForgetName}
% \changes{v0.75}{2012/01/19}{New parameter added}
+% \changes{v1.9}{2015/07/09}{Ensure global undef}
+% This undefines a control sequence to force the ``first use'' option of \cmd{\Name}.
% \begin{macrocode}
\newcommandx\ForgetName[3][1=\@empty, 3=\@empty]%
{%
@@ -2144,23 +2436,23 @@
\protected@edef\testiii{#3}%
\ifx\testi\@empty%
\ifx\testiii\@empty%
- \csundef{\@nameauth@CleanName{#2!MN!}}%
- \csundef{\@nameauth@CleanName{#2!NF!}}%
+ \global\csundef{\@nameauth@CleanName{#2!MN!}}%
+ \global\csundef{\@nameauth@CleanName{#2!NF!}}%
\else%
- \csundef{\@nameauth@CleanName{#2#3!MN!}}%
- \csundef{\@nameauth@CleanName{#2#3!NF!}}%
+ \global\csundef{\@nameauth@CleanName{#2#3!MN!}}%
+ \global\csundef{\@nameauth@CleanName{#2#3!NF!}}%
\fi%
\else%
- \csundef{\@nameauth@CleanName{#1#2!MN!}}%
- \csundef{\@nameauth@CleanName{#1#2!NF!}}%
+ \global\csundef{\@nameauth@CleanName{#1#2!MN!}}%
+ \global\csundef{\@nameauth@CleanName{#1#2!NF!}}%
\fi%
}
% \end{macrocode}
% \end{macro}
-% \cmd{\ForgetName} undefines control sequences to force the ``first use'' option of \cmd{\Name}.
%
% \begin{macro}{\SubvertName}
% \changes{v0.9}{2012/02/10}{Added macro}
+% This defines a control sequence to suppress the ``first use'' of \cmd{\Name}.
% \begin{macrocode}
\newcommandx\SubvertName[3][1=\@empty, 3=\@empty]%
{%
@@ -2181,66 +2473,122 @@
}
% \end{macrocode}
% \end{macro}
-% \cmd{\SubvertName} defines control sequences to suppress the ``first use'' of \cmd{\Name}.\\
%
-% \noindent The following macros toggle formatting and indexing.
+% \begin{environment}{nameauth}
+% \changes{v1.6}{2013/03/10}{Added |nameauth| environment}
+% The |nameauth| environment provides a means to implement shorthand references to names in a document.
+% \begin{macrocode}
+\newenvironment{nameauth}{%
+ \begingroup%
+ \csdef{<}##1&##2&##3&##4>{%
+ \protected@edef\arga{\trim@spaces{##1}}%
+ \protected@edef\argb{\trim@spaces{##2}}%
+ \protected@edef\argc{\trim@spaces{##3}}%
+ \protected@edef\argd{\trim@spaces{##4}}%
+ \ifx\arga\@empty
+ \PackageError{nameauth}%
+ {environment nameauth: Control sequence missing.}%
+ \else
+ \ifx\argc\@empty
+ \PackageError{nameauth}%
+ {environment nameauth: Essential name missing.}%
+ \else
+ \ifx\argd\@empty
+ \ifx\argb\@empty
+ \csxdef{\arga}{\Name{\argc}}%
+ \csxdef{L\arga}{\Name*{\argc}}%
+ \csxdef{S\arga}{\FName{\argc}}%
+ \else
+ \csxdef{\arga}{\Name[\argb]{\argc}}%
+ \csxdef{L\arga}{\Name*[\argb]{\argc}}%
+ \csxdef{S\arga}{\FName[\argb]{\argc}}%
+ \fi
+ \else
+ \ifx\argb\@empty
+ \csxdef{\arga}{\Name{\argc}[\argd]}%
+ \csxdef{L\arga}{\Name*{\argc}[\argd]}%
+ \csxdef{S\arga}{\FName{\argc}[\argd]}%
+ \else
+ \csxdef{\arga}{\Name[\argb]{\argc}[\argd]}%
+ \csxdef{L\arga}{\Name*[\argb]{\argc}[\argd]}%
+ \csxdef{S\arga}{\FName[\argb]{\argc}[\argd]}%
+ \fi
+ \fi
+ \fi
+ \fi
+ \ignorespaces%
+ }%
+}{\endgroup}
+% \end{macrocode}
+% \end{environment}
%
% \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}
%
-% \changes{v1.5}{2013/02/22}{Added macro}
% \begin{macro}{\AllCapsInactive}
+% Turn off global surname capitalization.
+% \changes{v1.5}{2013/02/22}{Added macro}
% \begin{macrocode}
\newcommand{\AllCapsInactive}{\@nameauth@AllCapsfalse}
% \end{macrocode}
% \end{macro}
-%
-% \changes{v1.5}{2013/02/22}{Added macro}
+%
% \begin{macro}{\AllCapsActive}
+% Turn on global surname capitalization.
+% \changes{v1.5}{2013/02/22}{Added macro}
% \begin{macrocode}
\newcommand{\AllCapsActive}{\@nameauth@AllCapstrue}
% \end{macrocode}
% \end{macro}
%
-% \changes{v1.5}{2013/02/22}{Added macro}
% \begin{macro}{\ReverseInactive}
+% Turn off global name reversing.
+% \changes{v1.5}{2013/02/22}{Added macro}
% \begin{macrocode}
\newcommand{\ReverseInactive}{\@nameauth@RevAllfalse}
% \end{macrocode}
% \end{macro}
-%
-% \changes{v1.5}{2013/02/22}{Added macro}
+%
% \begin{macro}{\ReverseActive}
+% Turn on global name reversing.
+% \changes{v1.5}{2013/02/22}{Added macro}
% \begin{macrocode}
\newcommand{\ReverseActive}{\@nameauth@RevAlltrue}
% \end{macrocode}
% \end{macro}
%
-% \changes{v1.5}{2013/02/22}{Added macro}
% \begin{macro}{\ReverseCommaInactive}
+% Turn off global ``last-name-comma-first.''
+% \changes{v1.5}{2013/02/22}{Added macro}
% \begin{macrocode}
-\newcommand{\ReverseCommaInactive}{\@nameauth@RevAllfalse\@nameauth@RevAllCommafalse}
+\newcommand{\ReverseCommaInactive}%
+ {\@nameauth@RevAllfalse\@nameauth@RevAllCommafalse}
% \end{macrocode}
% \end{macro}
-%
-% \changes{v1.5}{2013/02/22}{Added macro}
+%
% \begin{macro}{\ReverseCommaActive}
+% Turn on global ``last-name-comma-first.''
+% \changes{v1.5}{2013/02/22}{Added macro}
% \begin{macrocode}
-\newcommand{\ReverseCommaActive}{\@nameauth@RevAlltrue\@nameauth@RevAllCommatrue}
+\newcommand{\ReverseCommaActive}%
+ {\@nameauth@RevAlltrue\@nameauth@RevAllCommatrue}
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{\IndexInactive}
% \changes{v0.94}{2012/02/15}{Added macro}
+% turn off global indexing of names.
% \begin{macrocode}
\newcommand{\IndexInactive}{\@nameauth@DoIndexfalse}
% \end{macrocode}
@@ -2248,58 +2596,11 @@
%
% \begin{macro}{\IndexActive}
% \changes{v0.94}{2012/02/15}{Added macro}
+% turn on global indexing of names.
% \begin{macrocode}
\newcommand{\IndexActive}{\@nameauth@DoIndextrue}
% \end{macrocode}
% \end{macro}
-%
-% \begin{environment}{nameauth}
-% \changes{v1.6}{2013/03/10}{Added |nameauth| environment}
-% The |nameauth| environment provides a means to implement shorthand references to names in a document.
-% \begin{macrocode}
-\newenvironment{nameauth}{%
- \begingroup%
- \csdef{<}##1&##2&##3&##4>{%
- \protected@edef\arga{\trim@spaces{##1}}%
- \protected@edef\argb{\trim@spaces{##2}}%
- \protected@edef\argc{\trim@spaces{##3}}%
- \protected@edef\argd{\trim@spaces{##4}}%
- \ifx\arga\@empty
- \PackageError{nameauth}%
- {environment nameauth: Control sequence missing.}%
- \else
- \ifx\argc\@empty
- \PackageError{nameauth}%
- {environment nameauth: Essential name missing.}%
- \else
- \ifx\argd\@empty
- \ifx\argb\@empty
- \csxdef{\arga}{\Name{\argc}}%
- \csxdef{L\arga}{\Name*{\argc}}%
- \csxdef{S\arga}{\FName{\argc}}%
- \else
- \csxdef{\arga}{\Name[\argb]{\argc}}%
- \csxdef{L\arga}{\Name*[\argb]{\argc}}%
- \csxdef{S\arga}{\FName[\argb]{\argc}}%
- \fi
- \else
- \ifx\argb\@empty
- \csxdef{\arga}{\Name{\argc}[\argd]}%
- \csxdef{L\arga}{\Name*{\argc}[\argd]}%
- \csxdef{S\arga}{\FName{\argc}[\argd]}%
- \else
- \csxdef{\arga}{\Name[\argb]{\argc}[\argd]}%
- \csxdef{L\arga}{\Name*[\argb]{\argc}[\argd]}%
- \csxdef{S\arga}{\FName[\argb]{\argc}[\argd]}%
- \fi
- \fi
- \fi
- \fi
- \ignorespaces%
- }%
-}{\endgroup}
-% \end{macrocode}
-% \end{environment}
% \clearpage
% \Finale
\endinput