diff options
Diffstat (limited to 'Master/texmf-dist/source/latex/nameauth')
| -rw-r--r-- | Master/texmf-dist/source/latex/nameauth/nameauth.dtx | 4044 | ||||
| -rw-r--r-- | Master/texmf-dist/source/latex/nameauth/nameauth.ins | 8 |
2 files changed, 2273 insertions, 1779 deletions
diff --git a/Master/texmf-dist/source/latex/nameauth/nameauth.dtx b/Master/texmf-dist/source/latex/nameauth/nameauth.dtx index 883bf941c05..3747d190ac1 100644 --- a/Master/texmf-dist/source/latex/nameauth/nameauth.dtx +++ b/Master/texmf-dist/source/latex/nameauth/nameauth.dtx @@ -9,7 +9,7 @@ nameauth:| Name authority management for consistency in text and index Author:| Charles P. Schaum E-mail:| charles dot schaum at comcast dot net - License:| Released under the LaTeX Project Public License v1.3c or later + License:| Released under the LaTeX Project Public License 1.3c or later See:| http://www.latex-project.org/lppl.txt @@ -106,7 +106,7 @@ This material is subject to the LaTeX Project Public License: http://www.ctan.org/tex-archive/help/Catalogue/licenses.lppl.html Happy TeXing! -%</readme> +%</readme>F %<*internal> \fi \def\nameofplainTeX{plain} @@ -124,13 +124,13 @@ Happy TeXing! nameauth:| Name authority management for consistency in text and index Author:| Charles P. Schaum E-mail:| charles dot schaum at comcast dot net - License:| Released under the LaTeX Project Public License v1.3c or later + License:| Released under the LaTeX Project Public License 1.3c or later See:| http://www.latex-project.org/lppl.txt \endpreamble \postamble -Copyright (C) 2016 by Charles P. Schaum <charles dot schaum at comcast dot net> +Copyright (C) 2017 by Charles P. Schaum <charles dot schaum at comcast dot net> This work may be distributed and/or modified under the conditions of the LaTeX Project Public License (LPPL), either @@ -180,7 +180,7 @@ Running "make install" installs the files in the local TeX tree. %<package>\NeedsTeXFormat{LaTeX2e}[1999/12/01] %<package>\ProvidesPackage{nameauth} %<*package> - [2016/11/01 v3.03 Name authority management for consistency in text and index] + [2017/01/13 3.1 Name authority management for consistency in text and index] %</package> %<*driver> \documentclass[11pt]{ltxdoc} @@ -190,8 +190,6 @@ Running "make install" installs the files in the local TeX tree. \ifxetex \usepackage{fontspec} \defaultfontfeatures{Mapping=tex-text} - \usepackage{xunicode} - \usepackage{xltxtra} \else \ifluatex \usepackage{fontspec} @@ -208,12 +206,24 @@ Running "make install" installs the files in the local TeX tree. \fi \usepackage{\jobname} \usepackage{manfnt} -\usepackage[textwidth=135mm,textheight=237mm,right=25mm,nohead]{geometry} +\usepackage[textwidth=135mm,textheight=237mm,right=25mm,marginparwidth=40mm,nohead]{geometry} \usepackage[toc]{multitoc} \usepackage{makeidx} \usepackage{setspace} \usepackage{enumitem} \usepackage{booktabs} +\usepackage{xcolor} +\colorlet{naviolet}{violet!80!black} +\colorlet{nagreen}{green!40!black} +\colorlet{naolive}{olive!90!black} +\colorlet{naorange}{orange!50!black} +\colorlet{nared}{red!60!black} +\makeatletter +\newcommand\NO{\@ifstar% +{\textcolor{nared}{\large\strut {\hbox to 2.5em{\hfil\S\textsf{No}\hfil}}}}{\textcolor{nared}{\large\strut {\hbox to 2.5em{\hfil\textsf{No}\hfil}}}}} +\newcommand\YES{\@ifstar% +{\textcolor{nagreen}{\large\strut\bfseries \fbox{\hbox to 2.1em{\hfil*\textsf{Yes}\hfil}}}}{\textcolor{nagreen}{\large\strut\bfseries \fbox{\hbox to 2.1em{\hfil\textsf{Yes}\hfil}}}}} +\makeatother \ifxetex \usepackage{tikz}% \else @@ -236,74 +246,102 @@ Running "make install" installs the files in the local TeX tree. \CodelineIndex \RecordChanges \begin{nameauth} - \< Aeths & & \noexpand\DoFormat{Æþelstan} & > + \< Cath & Catherine \noexpand\AltCaps{d}e' + & \noexpand\textSC{Medici} & > + \< Aeth & & Æthelred, II & > + \< Unraed & & Æthelred, II & Unrædig > + \< Anth & Susan B. & Anthony & > \< Aris & & Aristotle & > \< Attil & & Attila, the Hun & > - \< Cao & & \noexpand\DoFormat{Cao}, Cao & > - \< CBald & & Charles, the Bald & > - \< Chas & & \noexpand\DoFormat{Charles}, I & > \< Cicero & M.T. & Cicero & > \< Confucius & & Confucius & > + \< Mencius & & \noexpand\textSC{Mencius} & > \< Dagb & & Dagobert & I > \< Dem & & Demetrius, I & > - \< deSmet & Pierre-Jean & \noexpand\DoFormat{\noexpand\CP{d}e Smet} & > - \< DLM & Walter & de la Mare & > + \< deSmet & Pierre-Jean & + \noexpand\Fbox{\noexpand\AltCaps{d}e Smet} & > \< Einstein & Albert & Einstein & > \< Eliz & & Elizabeth, I & > - \< Francis & & Francis, I & > - \< Fukuyama & & \uppercase{Fukuyama}, Takeshi & > + \< Fukuyama & & \textUC{Fukuyama}, Takeshi & > \< Harnack & Adolf & Harnack & > \< Henry & & Henry & VIII > - \< Howell & Thurston & \textsc{Howell},\textsc{III} &> \< JayR & John David & Rockefeller, IV & Jay > - \< JQA & John Quincy & \noexpand\DoFormat{Adams} & > - \< JRII & John David & Rockefeller, II & > - \< JRIII & John David & \noexpand\DoFormat{Rockefeller}, III & > + \< Adams & John & \noexpand\textSC{Adams} & > + \< JRIII & John David & \textSC{Rockefeller},\textSC{III} & > \< JRIV & John David & Rockefeller, IV & > \< JWG & J.W. von & Goethe & > \< KempMed & & Thomas, à~Kempis & > + \< KempAlt & & Thomas & à~Kempis > \< KempW & Thomas & à~Kempis & > \< Konoe & Fumimaro & Konoe & > - \< Lewis & Clive Staples & Lewis & C.S. > - \< LewisFull & Clive Staples & Lewis & > - \< Mao & & Mao & Tse-tung > - \< Miyazaki & & Miyazaki, Hayao & > - \< OFukuyama & & \uppercase{Fukuyama} & Takeshi > - \< Patton & George S. & Patton, Jr. & > - \< Plato & & Plato & > - \< Ptol & & Ptolemy & I > - \< SDJR & Sammy & \noexpand\DoFormat{Davis}, \noexpand\DoFormat{Jr}. & > + \< CSL & Clive Staples & Lewis & C.S. > + \< Lewis & Clive Staples & Lewis & > + \< Luth & Martin & \noexpand\textSC{Luther} & > + \< Miyaz & & Miyazaki, Hayao & > + \< MSens & & Miyazaki, Hayao & Sensei > + \< OFukuyama & & \textUC{Fukuyama} & Takeshi > + \< Pat & George S. & Patton, Jr. & > + \< HAR & & Harun, \noexpand\textSC% + {\noexpand\AltCaps{a}l-Rashid} & > + \< SDJR & Sammy & \noexpand\textSC{Davis}, + \noexpand\textSC{Jr}. & > \< Soto & Hernando & de Soto & > + \< VBuren & Martin & Van Buren & > \< Sun & & Sun, Yat-sen & > \< Wash & George & Washington & > + \< Washs & George & Washington's & > \< White & E.\,B. & White & > \< Yamt & & Yamamoto, Isoroku & > \< Yosh & & Yoshida & Shigeru > \end{nameauth} -\PretagName[Catherine]{\textsc{de'~Medici}}{de Medici, Catherine} +\ExcludeName[George]{Washington's} +\PretagName{Demetrius, I}{Demetrius 1} +\PretagName{Elizabeth, I}{Elizabeth 1} +\PretagName{Friedrich, I}{Friedrich 1} +\PretagName[Catherine \noexpand\AltCaps{d}e'] + {\noexpand\textSC{Medici}}{Medici, Catherine de} \PretagName[E.\,B.]{White}{White, E. B.} -\PretagName[Greta]{\textsc{Garbo}}{Garbo, Greta} -\PretagName[Heinrich Wilhelm]{\textsc{Rühmann}}{Ruehmann, Heinrich Wilhelm} -\PretagName[Heinz]{\textsc{Rühmann}}{Ruehmann, Heinz} +\PretagName[Martin]{\noexpand\textSC{Luther}}{Luther, Martin} +\PretagName[Greta]{\textSC{Garbo}}{Garbo, Greta} +\PretagName[Heinrich Wilhelm]{\textSC{Rühmann}}{Ruehmann, Heinrich Wilhelm} +\PretagName[Heinz]{\textSC{Rühmann}}{Ruehmann, Heinz} \PretagName[Jan]{Łukasiewicz}{Lukasiewicz, Jan} -\PretagName[John David]{\noexpand\DoFormat{Rockefeller}, III}{Rockefeller, John David, III} -\PretagName[John Quincy]{\noexpand\DoFormat{Adams}}{Adams, John Quincy} -\PretagName[Pierre-Jean]{\noexpand\DoFormat{\noexpand\CP{d}e Smet}}{de Smet, Pierre-Jean} -\PretagName[Sammy]{\noexpand\DoFormat{Davis}, \noexpand\DoFormat{Jr}.}{Davis, Sammy, Jr.} -\PretagName[Thurston]{\textsc{Howell},\textsc{III}}{Howell, Thurston 3} -\PretagName{\noexpand\DoFormat{Æþelstan}}{Aethelstan} -\PretagName{\noexpand\DoFormat{Cao}, Cao}{Cao Cao} -\PretagName{\noexpand\DoFormat{Charles}, I}{Charles 1} -\PretagName{\noexpand\DoFormat{Mengde}}{Mengde} -\PretagName{\uppercase{Fukuyama}, Takeshi}{Fukuyama, T} +\PretagName[John David]{\textSC{Rockefeller},\textSC{III}} + {Rockefeller, John David 3} +\PretagName[John David]{Rockefeller, IV}{Rockefeller, John David 4} +\PretagName[John]{\noexpand\textSC{Adams}}{Adams, John} +\PretagName[Pierre-Jean]% + {\noexpand\Fbox{\noexpand\AltCaps{d}e Smet}}% + {de Smet, Pierre-Jean} +\PretagName[Sammy] + {\noexpand\textSC{Davis}, \noexpand\textSC{Jr}.} + {Davis, Sammy, Jr.} +\PretagName{\textUC{Tokugawa}, Ieyasu}{Tokugawa Ieyasu} +\PretagName{Bo\"ethius}{Boethius} +\PretagName[Ada]{\textIT{Lovelace}}{Lovelace, Ada} +\PretagName[Charles]{\textBF{Babbage}}{Babbage, Charles} +\PretagName{\noexpand\textSC{Meng}, Ke}{Meng Ke} +\PretagName{\noexpand\textSC{Mencius}}{Mencius} +\PretagName{\textUC{Fukuyama}, Takeshi}{Fukuyama, T} +\PretagName{Harun, \noexpand\textSC% + {\noexpand\AltCaps{a}l-Rashid}}{Harun al-Rashid} \PretagName{Æthelred, II}{Aethelred 2} \PretagName{Atatürk}{Ataturk} \PretagName{Thomas, à~Kempis}{Thomas a Kempis} \PretagName{Vlad, Ţepeş}{Vlad Tepes} +\PretagName[Frenec]{Molnár}{Molnar, Frenec} +\TagName[Martin]{Van Buren}{, pres.|hyperpage} +\TagName[Frenec]{Molnár}{\dag|hyperpage} +\TagName[Martin]{\noexpand\textSC{Luther}}{|hyperpage} +\TagName{\textUC{Tokugawa}, Ieyasu}{|hyperpage} +\TagName[Ada]{\textIT{Lovelace}}{|hyperpage} +\TagName[Charles]{\textBF{Babbage}}{|hyperpage} +\TagName{Bo\"ethius}{|hyperpage} +\TagName[Susan B.]{Anthony}{|hyperpage} \TagName[Adolf]{Harnack}{|hyperpage} \TagName[Albert]{Einstein}{|hyperpage} \TagName[Bob]{Hope}{|hyperpage} -\TagName[Catherine]{\textsc{de'~Medici}}{|hyperpage} +\TagName[Catherine \noexpand\AltCaps{d}e']{\noexpand\textSC{Medici}}{|hyperpage} \TagName[Charles]{du Fresne}{|hyperpage} \TagName[Charlie]{Chaplin}{|hyperpage} \TagName[Chesley B.]{Sullenberger, III}{|hyperpage} @@ -311,25 +349,23 @@ Running "make install" installs the files in the local TeX tree. \TagName[Dan]{Luecking}{|hyperpage} \TagName[E.\,B.]{White}{|hyperpage} \TagName[Enrico]{Gregorio}{|hyperpage} +\TagName{Friedrich, I}{ Barbarossa, emperor|hyperpage} \TagName[Fumimaro]{Konoe}{\dag, PM|hyperpage} \TagName[George S.]{Patton, Jr.}{|hyperpage} \TagName[George]{Eliot}{|hyperpage} \TagName[George]{Washington}{, pres.|hyperpage} -\TagName[Greta]{\textsc{Garbo}}{|hyperpage} +\TagName[Greta]{\textSC{Garbo}}{|hyperpage} \TagName[Heiko]{Oberdiek}{|hyperpage} -\TagName[Heinz]{\textsc{Rühmann}}{|hyperpage} +\TagName[Heinz]{\textSC{Rühmann}}{|hyperpage} \TagName[Hernando]{de Soto}{|hyperpage} \TagName[J.E.]{Carter, Jr.}{, pres.|hyperpage} -\TagName[J.S.]{Mill}{|hyperpage} \TagName[J.W. von]{Goethe}{|hyperpage} \TagName[Jan]{Łukasiewicz}{|hyperpage} \TagName[Jesse]{Ventura}{|hyperpage} -\TagName[Johann]{Andreä}{|hyperpage} -\TagName[John David]{\noexpand\DoFormat{Rockefeller}, III}{|hyperpage} -\TagName[John David]{Rockefeller, II}{|hyperpage} +\TagName[John David]{\textSC{Rockefeller},\textSC{III}}{|hyperpage} \TagName[John David]{Rockefeller, IV}{|hyperpage} \TagName[John Maynard]{Keynes}{|hyperpage} -\TagName[John Quincy]{\noexpand\DoFormat{Adams}}{, pres.|hyperpage} +\TagName[John]{\noexpand\textSC{Adams}}{, pres.|hyperpage} \TagName[John]{Smith}{*|hyperpage} \TagName[John]{Strietelmeier}{|hyperpage} \TagName[Lafcadio]{Hearn}{|hyperpage} @@ -342,53 +378,42 @@ Running "make install" installs the files in the local TeX tree. \TagName[Mustafa]{Kemal}{|hyperpage} \TagName[Nicolas]{Malebranche}{|hyperpage} \TagName[Oskar]{Hammerstein, II}{|hyperpage} -\TagName[Patrick]{Cousot}{|hyperpage} -\TagName[Patrick]{Cousot}{|hyperpage} \TagName[Philipp]{Stephani}{|hyperpage} -\TagName[Pierre-Jean]{\noexpand\DoFormat{\noexpand\CP{d}e Smet}}{|hyperpage} +\TagName[Pierre-Jean]{\noexpand\Fbox{\noexpand\AltCaps{d}e Smet}}{|hyperpage} \TagName[Robert]{Schlicht}{|hyperpage} \TagName[Rudolph]{Carnap}{|hyperpage} \TagName[R.]{Snel van Royen}{|hyperpage} -\TagName[Sammy]{\noexpand\DoFormat{Davis}, \noexpand\DoFormat{Jr}.}{|hyperpage} +\TagName[Sammy]{\noexpand\textSC{Davis}, \noexpand\textSC{Jr}.}{|hyperpage} \TagName[Schuyler]{Colfax}{, v.p.|hyperpage} \TagName[The Amazing]{Kreskin}{|hyperpage} -\TagName[Thurston]{\textsc{Howell},\textsc{III}}{*|hyperpage} \TagName[Ulysses S.]{Grant}{, pres.|hyperpage} \TagName[Uwe]{Lueck}{|hyperpage} \TagName[W.E.B.]{Du Bois}{|hyperpage} -\TagName[Walter]{de la Mare}{|hyperpage} \TagName[W.]{Snel van Royen}{|hyperpage} \TagName[Yoko]{Kanno}{\dag|hyperpage} -\TagName{\noexpand\DoFormat{Æþelstan}}{, king|hyperpage} -\TagName{\noexpand\DoFormat{Cao}, Cao}{|hyperpage} -\TagName{\noexpand\DoFormat{Charles}, I}{, king|hyperpage} -\TagName{\uppercase{Fukuyama}, Takeshi}{|hyperpage} +\TagName{\noexpand\textSC{Mencius}}{|hyperpage} +\TagName{\textUC{Fukuyama}, Takeshi}{|hyperpage} \TagName{Æthelred, II}{, king|hyperpage} \TagName{Arai, Akino}{|hyperpage} \TagName{Aristotle}{|hyperpage} \TagName{Attila, the Hun}{|hyperpage} \TagName{Bernard, of Clairvaux}{|hyperpage} \TagName{Boris, the Animal}{*|hyperpage} -\TagName{Charles, the Bald}{, emperor|hyperpage} \TagName{Chiang}[Kai-shek]{\ddag, pres.|hyperpage} \TagName{Confucius}{|hyperpage} \TagName{Dagobert}[I]{\ddag, king|hyperpage} \TagName{Demetrius, I}{ Soter, king|hyperpage} \TagName{Elizabeth, I}{, queen|hyperpage} -\TagName{Francis, I}{, king|hyperpage} \TagName{Gregory, I}{, pope|hyperpage} +\TagName{Harun, \noexpand\textSC{\noexpand\AltCaps{a}l-Rashid}}{|hyperpage} \TagName{Henry}[VIII]{\ddag, king|hyperpage} \TagName{Ishida}[Yoko]{\ddag|hyperpage} -\TagName{Jean, sans Peur}{, duke|hyperpage} \TagName{John, Eriugena}{|hyperpage} \TagName{Lao-tzu}{|hyperpage} \TagName{Leo, I}{, pope|hyperpage} \TagName{Louis, XIV}{, king|hyperpage} \TagName{Maimonides}{|hyperpage} -\TagName{Mao}[Tse-tung]{\ddag, chairman|hyperpage} \TagName{Miyazaki, Hayao}{|hyperpage} -\TagName{Plato}{|hyperpage} -\TagName{Ptolemy}[I]{ Soter\ddag, king|hyperpage} \TagName{Rambam}{|hyperpage} \TagName{Sun, Yat-sen}{, pres.|hyperpage} \TagName{Thomas, à~Kempis}{|hyperpage} @@ -400,6 +425,7 @@ Running "make install" installs the files in the local TeX tree. \TagName{Yamamoto, Isoroku}{|hyperpage} \TagName{Yohko}{|hyperpage} \TagName{Yoshida}[Shigeru]{\ddag, PM|hyperpage} +\NameAddInfo{Friedrich, I}{Barbarossa} \IndexActual{=} \begin{document} \DocInput{\jobname.dtx} @@ -407,7 +433,7 @@ Running "make install" installs the files in the local TeX tree. %</driver> % \fi % -% \CheckSum{3094} +% \CheckSum{3356} % % \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 @@ -425,23 +451,26 @@ Running "make install" installs the files in the local TeX tree. % Grave accent \` Left brace \{ Vertical bar \| % Right brace \} Tilde \~} % -% \changes{v0.7}{2011/12/26}{Initial release} -% \changes{v2.0}{2015/11/11}{Use dtxgen template} -% \changes{v2.5}{2016/04/06}{No default formatting} +% \changes{0.7}{2011/12/26}{Initial release} +% \changes{2.0}{2015/11/11}{Use dtxgen template; prevent malformed input in most macros} +% \changes{2.5}{2016/04/06}{No default formatting} +% \changes{2.6}{2016/09/19}{Fix older syntax in most macros} +% \changes{3.1}{2017/01/13}{Simplified logic and argument tests in most macros} % \GetFileInfo{\jobname.dtx} % \DoNotIndex{\@empty, \@gobble, \@period, \@token, \trim@spaces, \zap@space} % \DoNotIndex{\begingroup, \bfseries, \bgroup, \csdef, \csgdef, \csname, \csundef, \DeclareOption, \def, \detokenize, \edef, \egroup, \else, \endcsname, \endgroup, \endinput, \ExecuteOptions, \expandafter, \fi, \futurelet, \global, \hbox, \if, \ifcsname, \ifx, \ignorespaces, \index, \itshape, \leavevmode, \let, \newcommand, \newcommandx, \newenvironment, \newif, \nobreakspace, \PackageError, \PackageWarning, \ProcessOptions, \relax, \renewcommand, \RequirePackage, \scshape, \space, \textbackslash, \uppercase} % -% \newif\ifSC -% \newif\ifItal % \newif\ifDoTikZ -% \newif\ifFirstCap -% \newif\ifInHook -% \SCtrue -% \Italtrue +% \newif\ifNoTag +% % \ifxetex\DoTikZtrue\else % \ifluatex\ifpdf\DoTikZtrue\fi % \else\ifpdf\DoTikZtrue\fi\fi\fi +% \let\ex\expandafter +% \renewcommand*\FrontNamesFormat[1]{\color{nagreen}\sffamily #1} +% \renewcommand*\FrontNameHook[1]{\color{naolive}\sffamily #1} +% \renewcommand*\NamesFormat[1]{\color{naviolet}\sffamily #1} +% \renewcommand*\MainNameHook[1]{\color{naorange}\sffamily #1} % % \title{\textsf{nameauth} --- Name authority management\\ for consistency in text and % index\thanks{This file describes version \fileversion, last revised \filedate.}} @@ -457,91 +486,57 @@ Running "make install" installs the files in the local TeX tree. % {\small\tableofcontents} % \setlength{\parskip}{0.1\baselineskip plus .05\baselineskip minus .05\baselineskip} % -% \section{Introduction} -% -% \subsection{Preliminary Information} -% +% \section{Quick Start} +% \subsection{Introduction} % \begin{center}\large\bfseries Disclaimer\end{center} -% \noindent This manual uses names of living and dead historical figures because users refer to real people. At no time do I intend any disrespect or statement of bias for or against any particular person, culture, or tradition. All names herein are used only for teaching purposes. +% \noindent This manual uses names of living and dead historical figures because users refer to real people. At no time do I intend any disrespect or statement of bias for or against any particular person, culture, or tradition. All names herein (as I know them) are used only for teaching purposes, and I strive to respect those names. % % \begin{center}\large\bfseries Denotative Signs\end{center} -% \noindent In the index, fictional names have an asterisk (*). In this manual, ``non-native'' Eastern names are shown with a dagger (\dag). Names that use the older syntax are shown with a double dagger (\ddag). These marks are not added by the package macros and will not appear in users' works. +% \noindent In the index, fictional names have an asterisk (*). In this manual, ``non-native'' Eastern names are shown with a dagger (\dag). Names that use the older non-Western syntax are shown with a double dagger (\ddag). These signs are not added by the package macros and will not appear in users' works unless they add them. % % \begin{center}\large\bfseries Design\end{center} -% \noindent When publications use hundreds of names, it takes time and money to check them. This package automates much of that work: +% \noindent When publications use hundreds of names, it takes time and money to manage and check them. This package handles much of that work in order to save time and money. One can implement a name authority, a master list of related names and variants. % \begin{itemize}\small -% \item \textbf{Automation} of name forms to aid professional writing. Move blocks of text and see the names reformat themselves. +% \item \textbf{Automate} name forms to aid professional writing. % \begin{itemize} +% \item Move blocks of text and see the names reformat themselves. % \item Default to long name references first, then shorter ones. -% \item Use alternate names only in the body text, not the index. -% \item Perform name caps and reversing only in the body text. +% \item Use name variants only in the body text, not the index. % \end{itemize} -% \item Name variants in the text still produce \textbf{consistent index entries}. -% \item One can design \textbf{complex name formatting}. Default is English typography, but other standards, such as ``Continental'' use of small caps, can be applied (Sections~\ref{sec:accents}, \ref{sec:nonenglish}, \ref{sec:IndexSort}, and~\ref{sec:Hooksc}). -% \item One can \textbf{automate information retrieval} about names. -% \item One can implement and automate a \textbf{name authority}, a master list of names that permits known name variants. -% \item Some \textbf{cross-cultural naming conventions} are possible. +% \item Permit \textbf{complex name formatting}. Default is English typography. +% \item More\marginpar{\large\raggedleft\textsf{\bfseries 3.1}\strut} \textbf{cross-cultural naming conventions} are possible. A basic form of ``Continental'' formatting has been integrated into the package instead of being a user add-on (Sections~\ref{sec:accents}, \ref{sec:altformat}, \ref{sec:IndexSort}, and~\ref{sec:Hooksc}). % \item \textbf{Automatic sort keys and tags} aid indexing. -% \item Provide \textbf{automatic name presentation} that could work in a \LaTeX\ backend for a document transform, database report, etc. +% \item One can \textbf{automate information retrieval} about names. +% \item Indexing generally conforms to the standard in Nancy C. Mulvany, \emph{Indexing Books} (Chicago: University of Chicago Press, 1994). All references [\hypertarget{Mulvany}{Mulvany}] refer to this edition. This was thought suitable for most disciplines. +% \item Notable\marginpar{\large\raggedleft\textsf{\bfseries 3.0}\strut} changes correspond to package version numbers in the margin. +% \item The\marginpar{\small\raggedleft\dbend} ``dangerous bend'' is used throughout this manual to show where caution is needed to sort out some technical points. +% \item Please see Section~\ref{sec:notes} for technical notes regarding general questions about package design, this manual, and the package building and release process. % \end{itemize} % -% Indexing generally conforms to the standard in Nancy C. Mulvany, \emph{Indexing Books} (Chicago: University of Chicago Press, 1994). -% % \begin{center}\large\bfseries Thanks\end{center} -% \noindent {\def\NamesFormat{\bfseries} 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 in the early versions of this package. Thanks also to the users and their feedback.} +% \noindent 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 in the early versions of this package. Thanks also to users for valuable feedback. % \clearpage % -% \subsection{Technical Notes} -% About the package itself: -% \begin{itemize}\small -% \item Most current changes are compatible with older versions. -% \item The package works with \texttt{xindy} and \texttt{makeindex}. We recommend \texttt{xindy} for languages whose collating sequences do not map to English.\footnote{\cmd{\PretagName} may not be useful in that case. German \emph{does} map to English: ä, ö, ü, and ß are ae, oe, ue, and ss. Norwegian \emph{does not} map to English: æ, ø, and å come after z.} -% \item Notable\marginpar{\large\raggedleft\textsf{\bfseries 3.0}\strut} changes, features, and fixes that correspond to version numbers are indicated in the margin. -% \item We\marginpar{\large\raggedleft\textsf{\bfseries 3.0}\strut} support Eastern alternate names when using ``native'' format. We simplify indexing, custom formatting, and other tasks. -% \item Name\marginpar{\large\raggedleft\textsf{\bfseries 3.0}\strut} output, index page entries, and index cross-references are independent due to modular design. -% \item Warnings\marginpar{\large\raggedleft\textsf{\bfseries 3.0}\strut} for the indexing macros are suppressed unless one uses the \texttt{verbose} option. The \texttt{nameauth} environment will produce warnings. -% \item The\marginpar{\large\raggedleft\textsf{\bfseries 2.6}\strut} \texttt{comma} option and the old syntax are no longer restrictive, save with \cmd{\AKA} and its derivatives. See Sections~\ref{sec:obsolete}, \ref{sec:Affix}, and~\ref{sec:AKA}. -% \item No\marginpar{\large\raggedleft\textsf{\bfseries 2.5\strut}} formatting is selected by default. To implement formatting, see Sections~\ref{sec:nonenglish}, \ref{sec:formatting}, and~\ref{sec:Hooksa}f. -% \end{itemize} -% \noindent About the manual: -% \begin{itemize}\small -% \item With\marginpar{\small\raggedleft\dbend} the ``dangerous bend'' we show incompatibilities, complex topics, and points where caution is needed. -% \item This manual is designed to be compatible with both A4 and US letter stock size formats. -% \item Macro references are minimized for a ``clean'' index, showing how \textsf{nameauth} ``normally'' handles indexing. -% \item Some examples use package macros and internals in special ways to demonstrate a particular point. Usually we mention that with the example. -% \end{itemize} -% About package building: -% \begin{itemize}\small -% \item The \textsf{nameauth} package requires \textsf{etoolbox}, \textsf{suffix}, \textsf{trimspaces}, and \textsf{xargs}. The \texttt{dtx} file encoding is UTF-8; we cannot guarantee building and using this package on systems that are not Unicode-compliant. -% \item With each release, we test \textsf{nameauth} with dvi-mode \texttt{latex} and with pdf-mode engines \texttt{pdflatex}, \texttt{lualatex}, and \texttt{xelatex} using \texttt{makeindex}. We run the GNU Makefile with the ENGINE=\meta{engine} option.\footnote{The manual is used as the test suite. In dvi mode the manual omits all references to \emph{TikZ} because some dvi display programs (\emph{e.g.} \texttt{dviout}, but not \texttt{xdvi}) will emit errors about bad specials even if one just includes the \textsf{tikz} package. The \emph{TikZ} diagrams herein will appear as blank space in that case. This does not affect \textsf{nameauth} proper.} -% \item This build used \ifxetex\texttt{xelatex}\else -% \ifluatex\ifpdf\texttt{lualatex} in \texttt{pdf} mode\else -% \texttt{lualatex} in \texttt{dvi} mode\fi -% \else\ifpdf\texttt{pdflatex}\else -% \texttt{latex}\fi\fi\fi. This item changes per \LaTeX\ engine. -% \item This package is tested on Ubuntu Linux and Windows 7 (both vanilla \TeX\ Live). Cygwin provides \texttt{make} on Windows. The \texttt{pdflatex} version of this package is released from the Ubuntu platform to CTAN. -% \end{itemize} -% \clearpage +% \subsection{Basic Concepts} +% \label{sec:start} % -% \subsection{What's In A Name?} -% \label{sec:NameTypes} +% Name forms are ambiguous apart from historical and cultural contexts. This package uses that ambiguity to encode names in order to avoid changing the order in which one enters names in one's native culture. In this manual we refer to three general classes of names, shown below. It is helpful to become familiarized with this terminology. Other naming systems can be adapted to these general categories with some caveats, \emph{e.g.}, Icelandic, Hungarian, etc. % -% Name forms are ambiguous apart from historical and cultural contexts. In this manual we refer to three general classes of names, shown below. Section~\ref{sec:start} shows how these classes are implemented. +% For teaching purposes, we highlight names using sans-serif and use color to show first and subsequent uses of names (see also Sections~\ref{sec:formatting} and~\ref{sec:tweaks}). % -% Professional writing often calls for the full form of a person's name to be used when it first occurs, with shorter forms used thereafter. That is why, in each class, there is a required name and optional name elements.\footnote{Compare Mulvany, \emph{Indexing Books}, pages 152--82, and the \emph{Chicago Manual of Style}. That approach is adapted to \LaTeX\ and its way of handling optional arguments.} -% Other naming systems can be adapted to these categories, \emph{e.g.}, Icelandic, Hungarian, etc. +% Professional writing calls for the full form of a person's name when first used, with shorter forms used thereafter. The name parts that define each class are shown in black, with optional elements in red.\footnote{Compare [\hyperlink{Mulvany}{Mulvany}, 152--82] and the \emph{Chicago Manual of Style}. That approach is adapted to \LaTeX\ and its way of handling optional arguments.} % -% \begin{enumerate}[noitemsep] -% \item Western name:\\[1ex] +% \begin{enumerate}[noitemsep]\large +% \item Western name: \Wash\\[1ex] % \ifDoTikZ\begin{tikzpicture}[line/.style={draw,thick}]\normalsize % \node [matrix] (macro) at (0,1) % { % \node(space){\qquad\qquad\qquad}; & % \node(arg1){\strut\textbf{Forename(s)}}; & % \node(arg2){\strut\textbf{Surname(s)}}; & -% \node(arg3){\strut\textbf{Sobriquet, etc.}};\\ +% \node(arg3){\strut\color{nared}\textbf{Sobriquet, etc.}};\\ % }; -% \node [matrix,column sep=1em] (tipsii) at (1,-2) +% \node [matrix,column sep=1em] (descriptors) at (1,-2) % { % \node[align=left](a1) % { @@ -580,7 +575,7 @@ Running "make install" installs the files in the local TeX tree. % \path (arg3) -- (a3); % \end{scope} % \end{tikzpicture}\else\vfill\fi -% \item Eastern name:\\[1ex] +% \item Eastern name: \Sun\\[1ex] % \ifDoTikZ\begin{tikzpicture}[line/.style={draw,thick}]\normalsize % \node [matrix] (macro) at (0,1) % { @@ -589,7 +584,7 @@ Running "make install" installs the files in the local TeX tree. % \node(spaceii){\qquad}; & % \node(arg2){\strut\textbf{Given name}};\\ % }; -% \node [matrix,column sep=1cm] (tipsii) at (2,-1) +% \node [matrix,column sep=1cm] (descriptors) at (2,-0.5) % { % \node[align=left](a1) % { @@ -605,16 +600,16 @@ Running "make install" installs the files in the local TeX tree. % \path (arg2) -- (a2); % \end{scope} % \end{tikzpicture}\else\vfill\fi -% \item Ancient name:\\[1ex] +% \item Ancient name: \Eliz\\[1ex] % \ifDoTikZ\begin{tikzpicture}[line/.style={draw,thick}]\normalsize % \node [matrix] (macro) at (0,1) % { % \node(spacei){\qquad\qquad\qquad}; & -% \node(arg1){\strut\textbf{Given name}}; & +% \node(arg1){\strut\color{black}\textbf{Given name}}; & % \node(spaceii){\qquad}; & -% \node(arg2){\strut\textbf{Sobriquet, etc.}};\\ +% \node(arg2){\strut\color{nared}\textbf{Sobriquet, etc.}};\\ % }; -% \node [matrix,column sep=2.2cm] (tipsii) at (1.5,-1.5) +% \node [matrix,column sep=2.2cm] (descriptors) at (1.5,-1.7) % { % \node[align=left](a1) % { @@ -627,7 +622,8 @@ Running "make install" installs the files in the local TeX tree. % \small\textit{notable feature}\\ % \small\textit{notable attribute}\\ % \small\textit{place of origin}\\ -% \small\textit{territory} +% \small\textit{territory}\\ +% \small\textit{patronym} % }; \\ % }; % \begin{scope}[every path/.style=line] @@ -636,55 +632,51 @@ Running "make install" installs the files in the local TeX tree. % \end{scope} % \end{tikzpicture}\else\vfill\fi % \end{enumerate} -% -% Since we use these classes of names throughout the manual, it is helpful to become familiarized with this terminology and how one can apply it to one's own culture and context. +% \ForgetName[George]{Washington}\ForgetName{Sun, Yat-sen}\ForgetName{Elizabeth, I} % \clearpage % -% \section{Usage} -% \subsection{Quick Start Guide} -% \label{sec:start} -% -% Here we offer templates for the most common macros and features. The details will come later. This section also formats the first uses of names in \textbf{boldface} to illustrate how first uses are long, but long uses need not be first. -% \let\OldFormat\NamesFormat\renewcommand\NamesFormat{\bfseries} -% -% \subsubsection{Main Interface} -% We see how \textsf{nameauth} implements the classes of names, using \cmd{\Name} as an example (see also Section~\ref{sec:Naming}). The macros of this package halt with an error when: +% Based on the classes of names, the \textsf{nameauth} macros halt with an error in the following cases: % \begin{itemize}\small -% \item The \meta{SNN} argument expands to the empty string or an \meta{SNN, Affix} pair expands to \meta{empty}, \meta{Affix}. +% \item The required name argument \meta{SNN} expands to the empty string. +% \item The required argument \meta{SNN, Affix} expands to \meta{empty}, \meta{Affix}. % \item No shorthand is present for a name in the simplified interface (Section~\ref{sec:simplestart}). % \end{itemize} % +% \subsection{Traditional Interface} +% +% For all categories, the fields that define each category are shown in black, with optional elements in red.\medskip +% % \noindent{\bfseries Western Names} % \ifDoTikZ % \begin{center} % \begin{tikzpicture}[line/.style={draw,thick}] -% \node [matrix,column sep=2.5cm] (tipsi) at (1.5,2.5) +% \node [matrix,column sep=2.5cm] (advice) at (0.5,1.5) % { -% \node(opt){\small Add to force full name.}; & +% \node[align=center](opt){\small Add to force full name.}; & % \node[text width=3.5cm,align=left](grp){\small Add only if text in brackets |[|\,|]| follows.}; \\ % }; -% \node [matrix] (macro) at (1.1,1) +% \node [matrix] (macro) at (0.2,0) % { % \node(cmd){\bfseries\cmd{\Name}}; & % \node(star){\bfseries\texttt{*}}; & % \node(arg1){\bfseries\bfseries\oarg{FNN}}; & -% \node(arg2){\bfseries\bfseries\marg{SNN}}; & -% \node(arg3){\bfseries\oarg{Alternate names}}; & +% \node(arg2){\bfseries\bfseries\marg{SNN\color{nared}, Affix}}; & +% \node(arg3){\bfseries\oarg{\color{nared}Alternate names}}; & % \node(braces){\bfseries|{}|}; \\ % }; -% \node [matrix,column sep=1em] (tipsii) at (1,-1) +% \node [matrix,column sep=1em] (descriptors) at (0,-1.5) % { % \node[align=center](a1) % { -% \small Forename(s)\\\small used in index +% \small Forename(s) % }; & & & % \node[align=center](a2) % { -% \small Surname(s)\\\small Surname(s)|,| affix\\ \small``required name'' -% }; & & +% \small Surname(s) +% }; & & & & & % \node[align=center](a3) % { -% \meta{empty}\\\small Nickname(s)\\\small Full forenames, etc. +% \small Used only in text % }; \\ % }; % \begin{scope}[every path/.style=line] @@ -697,50 +689,67 @@ Running "make install" installs the files in the local TeX tree. % \end{tikzpicture} % \end{center}\vspace{-2ex} % \else\vfill\fi -% \textbf{Examples:}\\[1ex] -% {\setstretch{1.1}One always must include all fields for consistent index entries.\\[1ex] -% |\Name[George]{Washington}|\dotfill\Name[George]{Washington}\\ -% |\Name[George]{Washington}|\dotfill\Name[George]{Washington}\\ -% |\Name[John David]{Rockefeller, II}|\dotfill\Name[John David]{Rockefeller, II}\\ -% |\Name[John David]{Rockefeller, II}|\dotfill\Name[John David]{Rockefeller, II}\\[1ex] -% When using \meta{Alternate names}, the \meta{FNN} argument must have a name in it. The \meta{Alternate names} are swapped with the \meta{FNN}, but only in the body text:\\[1ex] -% |\Name [Clive Staples]{Lewis}|\dotfill\Name[Clive Staples]{Lewis}\\ +% \textbf{Examples:}\medskip +% +% \noindent One always must include all fields for consistent index entries.\medskip +% +% {\setstretch{1.1}\noindent|\Name [George]{Washington}|\dotfill\Name[George]{Washington}\\ +% |\Name*[George]{Washington}|\dotfill\Name*[George]{Washington}\\ +% |\Name [George]{Washington}|\dotfill\Name[George]{Washington}\\ +% |\FName[George]{Washington}|\dotfill\FName[George]{Washington}\\ +% |\Name [George S.]{Patton, Jr.}|\dotfill\Name[George S.]{Patton, Jr.}\\ +% |\Name*[George S.]{Patton, Jr.}|\dotfill\Name*[George S.]{Patton, Jr.}\\ +% |\Name [George S.]{Patton, Jr.}|\dotfill\Name[George S.]{Patton, Jr.}\\ +% |\FName[George S.]{Patton, Jr.}|\dotfill\FName[George S.]{Patton, Jr.}}\medskip +% +% \noindent\meta{Alternate names} with Western forms require the \meta{FNN} argument to have a name in it. \meta{Alternate names} print in the text. \meta{FNN} prints in the index. For alternate surnames see Section~\ref{sec:DuBois}.\medskip +% +% {\setstretch{1.1}\noindent|\Name [Clive Staples]{Lewis}|\dotfill\Name[Clive Staples]{Lewis}\\ % |\Name*[Clive Staples]{Lewis}[C.S.]|\dotfill\Name*[Clive Staples]{Lewis}[C.S.]\\ +% |\Name [Clive Staples]{Lewis}|\dotfill\Name[Clive Staples]{Lewis}\\ % |\Name [Clive Staples]{Lewis}[C.S.]|\dotfill\Name[Clive Staples]{Lewis}[C.S.]\\ % |\Name*[Clive Staples]{Lewis}[Jack]|\dotfill\Name*[Clive Staples]{Lewis}[Jack]\\ -% |\Name [John David]{Rockefeller, IV}|\dotfill\Name[John David]{Rockefeller, IV}\\ +% |\FName[Clive Staples]{Lewis}[Jack]|\dotfill\FName[Clive Staples]{Lewis}[Jack]}\medskip +% +% \noindent Both affixes and alternate names can vary in the text. Western names require a comma to delimit affixes; see Sections~\ref{sec:obsolete} and~\ref{sec:Affix}. Using alternate names does not trigger an explicit first use. That is intentional.\medskip +% +% {\setstretch{1.1}\noindent|\Name [John David]{Rockefeller, IV}|\dotfill\Name[John David]{Rockefeller, IV}\\ +% |\Name [John David]{Rockefeller, IV}[Jay]|\dotfill\Name[John David]{Rockefeller, IV}[Jay]\\ % |\Name*[John David]{Rockefeller, IV}[Jay]|\dotfill\Name*[John David]{Rockefeller, IV}[Jay]\\ -% |\DropAffix\Name*[John David]{Rockefeller, IV}[Jay]|\dotfill\DropAffix\Name*[John David]{Rockefeller, IV}[Jay]\\ -% |\Name [John David]{Rockefeller, IV}[Jay]|\dotfill\Name[John David]{Rockefeller, IV}[Jay]\\[1ex] -% Western names cannot use the older syntax for affixes; see Sections~\ref{sec:obsolete} and~\ref{sec:Affix}. Notice how using nicknames or alternate names does not trigger an explicit first use. That is intentional. Compare Section~\ref{sec:tweaks} to ``bend the rules.''} +% |\DropAffix\Name*[John David]{Rockefeller, IV}[Jay]|\dotfill\DropAffix\Name*[John David]{Rockefeller, IV}[Jay]} % \clearpage % -% \noindent{\bfseries Eastern Names in the Text, Western Index Entry} +% \noindent{\bfseries ``Non-Native'' Eastern Names in the Text, Western Index Entry} % \ifDoTikZ % \begin{center} % \begin{tikzpicture}[line/.style={draw,thick}] -% \node [matrix,column sep=1.5cm] (tipsi) at (0.5,2) +% \node [matrix,column sep=1.5cm] (advice) at (0.5,1.5) % { -% \node(opt){\small Add to force full name.}; & +% \node[align=center](opt){\small Add to force full name.}; & % \node[text width=3.5cm,align=left](grp){\small Add only if text in brackets |[|\,|]| follows.}; \\ % }; -% \node [matrix] (macro) at (0,1) +% \node [matrix] (macro) at (0,0) % { % \node(cmd){\bfseries\cmd{\RevName} \cmd{\Name}}; & % \node(star){\bfseries\texttt{*}}; & % \node(arg1){\bfseries\oarg{FNN}}; & % \node(arg2){\bfseries\marg{SNN}}; & +% \node(arg3){\bfseries\oarg{\color{nared}Alternate names}}; & % \node(braces){\bfseries|{}|}; \\ % }; -% \node [matrix] (tipsii) at (0.5,0) +% \node [matrix,column sep=1em] (descriptors) at (0.7,-1.5) % { -% \node(a1) +% \node[align=center](a1) % { -% \strut\quad\small Given name -% }; & -% \node(a2) +% \small Given name +% }; & & & +% \node[align=center](a2) +% { +% \small Family name +% }; & & & +% \node[align=center](a3) % { -% \strut\quad\small Family name +% \small Used only in text % }; \\ % }; % \begin{scope}[every path/.style=line] @@ -748,41 +757,52 @@ Running "make install" installs the files in the local TeX tree. % \path (grp) -- (braces); % \path (arg1) -- (a1); % \path (arg2) -- (a2); +% \path (arg3) -- (a3); % \end{scope} % \end{tikzpicture} % \end{center}\vspace{-2ex} % \else\vfill\fi -% {These are Western name forms without affixes that the reversing macros (Section~\ref{sec:Eastern}) cause to display in Eastern order in the body text only. We indicate them with a dagger.\\[1ex] -% |\Name[Fumimaro]{Konoe}|\dotfill\Name[Fumimaro]{Konoe}\dag\\ -% |\Name[Fumimaro]{Konoe}|\dotfill\Name[Fumimaro]{Konoe}\dag\\ -% |\RevName\Name*[Fumimaro]{Konoe}|\dotfill\RevName\Name*[Fumimaro]{Konoe}\dag\\[1ex] -% The index entries are Western in fashion: \meta{SNN}, \meta{FNN}. This ``non-native'' form of Eastern names conflicts with both comma-delimited forms and the old syntax.}\bigskip +% \textbf{Examples:}\medskip +% +% \noindent These are encoded using Western name forms without affixes. The reversing macros (Section~\ref{sec:Eastern}) cause them to display in Eastern order in the body text. [\hyperlink{Mulvany}{Mulvany}, 166] shows Hungarian names compatible with this category. Index entries are formatted as: \meta{SNN}, \meta{FNN}. We show these names with a dagger (\dag).\medskip % -% \noindent{\bfseries Eastern Names in the Text, Eastern Index Entry} +% {\noindent\setstretch{1.1}|\Name[Fumimaro]{Konoe}|\dotfill\Name[Fumimaro]{Konoe}\dag\\ +% |\Name*[Fumimaro]{Konoe}[Prime Minister]|\dotfill\Name*[Fumimaro]{Konoe}[Prime Minister]\dag\\ +% |\RevName\Name*[Fumimaro]{Konoe}|\dotfill\RevName\Name*[Fumimaro]{Konoe}\dag\\ +% |\RevName\Name[Frenec]{Molnár}|\dotfill\RevName\Name[Frenec]{Molnár}\dag}\medskip +% +% \noindent This ``non-native'' form of Eastern names excludes both comma-delimited suffixes and the older non-Western syntax (Sections~\ref{sec:obsolete}). This form \emph{will not share} control sequences and index entries with the non-Western forms described below.\bigskip +% +% \noindent{\bfseries ``Native'' Eastern Names in the Text, Eastern Index Entry} % \ifDoTikZ % \begin{center} % \begin{tikzpicture}[line/.style={draw,thick}] -% \node [matrix,column sep=1cm] (tipsi) at (0.5,2) +% \node [matrix,column sep=1cm] (advice) at (0.5,1.3) % { % \node(opt){\small Add to force full name.}; & % \node[text width=3.5cm,align=left](grp){\small Add only if text in brackets |[|\,|]| follows.}; \\ % }; -% \node [matrix] (macro) at (0,1) +% \node [matrix] (macro) at (0,0) % { % \node(cmd){\bfseries\cmd{\Name}}; & % \node(star){\bfseries\texttt{*}}; & % \node(arg1){\bfseries\marg{SNN, FNN}}; & +% \node(arg2){\bfseries\oarg{\color{nared}Alternate names}}; & % \node(braces){\bfseries|{}|}; \\ % }; -% \node [matrix,column sep=1em] (tipsii) at (0.5,0) +% \node [matrix,column sep=1em] (descriptors) at (0.3,-1.3) % { -% \node(a1) +% \node[align=center](a1) % { -% \quad Family name +% \small Family name % }; & -% \node(a2) +% \node[align=center](a2) +% { +% \small Given name +% }; & & +% \node[align=center](a3) % { -% \quad Given name +% \small Used only in text % }; \\ % }; % \begin{scope}[every path/.style=line] @@ -790,32 +810,40 @@ Running "make install" installs the files in the local TeX tree. % \path (grp) -- (braces); % \path (arg1) -- (a1); % \path (arg1) -- (a2); +% \path (arg2) -- (a3); % \end{scope} % \end{tikzpicture} % \end{center}\vspace{-2ex} % \else\vfill\fi -% \textbf{Examples:}\\[1ex] -% {The main feature of Eastern, ancient, and medieval name forms is the comma-delimited suffix. These forms have the same syntax, but different meanings.\\[1ex] -% |\Name{Yamamoto, Isoroku}|\dotfill\Name{Yamamoto, Isoroku}\\ +% \textbf{Examples:}\medskip +% +% \noindent The main feature of non-Western forms in \textsf{nameauth} is the comma-delimited suffix. Eastern names have the family name in \meta{SNN} where ancient names have the personal name, but that remains the required argument. +% +%These names always take the form \meta{SNN FNN} in the index. See Section~\ref{sec:Eastern}. Here we call this the ``native'' Eastern form.\medskip +% +% {\noindent\setstretch{1.1}|\Name{Yamamoto, Isoroku}|\dotfill\Name{Yamamoto, Isoroku}\\ % |\Name{Yamamoto, Isoroku}|\dotfill\Name{Yamamoto, Isoroku}\\ -% |\RevName\Name*{Yamamoto, Isoroku}|\dotfill\RevName\Name*{Yamamoto, Isoroku}\\[1ex] -% These names truly are Eastern names. They always take the form \meta{SNN FNN} in the index. See Section~\ref{sec:Eastern}. We call this the ``native'' Eastern form. For the old syntax, see Section~\ref{sec:obsolete}.}\bigskip +% |\RevName\Name*{Yamamoto, Isoroku}|\dotfill\RevName\Name*{Yamamoto, Isoroku}\\ +% |\RevName\Name*{Yamamoto, Isoroku}[Admiral]|\dotfill\RevName\Name*{Yamamoto, Isoroku}[Admiral]}\medskip +% +% \noindent Non-Western\marginpar{\large\raggedleft\textsf{\bfseries 3.0}\strut\break\small\dbend} forms also can have alternate names, except for mononyms (for which it makes no sense). These alternate names do not work with the older syntax for non-Western names (see Section~\ref{sec:obsolete}). +% \clearpage % % \noindent{\bfseries Ancient Names} % \ifDoTikZ % \begin{center} % \begin{tikzpicture}[line/.style={draw,thick}] -% \node [matrix,column sep=0.9em] (tipsi) at (2,2) +% \node [matrix,column sep=0.9em] (advice) at (0.6,1.4) % { -% \node(opt){\quad\small Add to force full name.}; & -% \node[text width=2.6cm,align=left](a1){\small Name(s)\hfil\break Name(s), affix}; & +% \node[align=center](opt){\small Add to force full name.}; & +% \node[align=center](a1){\small Name(s)}; & % \node[text width=3.3cm,align=left](grp){\small Add only if text in brackets |[|\,|]| follows.}; \\ % }; -% \node [matrix] (macro) at (1,1) +% \node [matrix] (macro) at (0,0) % { % \node(cmd){\bfseries\cmd{\Name}}; & % \node(star){\bfseries\texttt{*}}; & -% \node(arg1){\bfseries\marg{SNN}}; & +% \node(arg1){\bfseries\marg{SNN\color{nared}, Affix}}; & % \node(braces){\bfseries|{}|}; \\ % }; % \begin{scope}[every path/.style=line] @@ -825,173 +853,142 @@ Running "make install" installs the files in the local TeX tree. % \end{scope} % \end{tikzpicture} % \end{center}\vspace{-2ex} -% \else\vfill\fi -% \textbf{Examples:}\\[1ex] -% {These forms are for royalty and ancient figures. They have one or more personal names that may or may not have suffixes. For the older syntax see Section~\ref{sec:obsolete}.\\[1ex] -% |\Name{Aristotle}|\dotfill\Name{Aristotle}\\ +% \else\vspace{20ex}\fi +% \textbf{Examples:}\medskip +% +% \noindent These forms are for royalty and ancient figures. They have one or more personal names that may or may not have suffixes.\medskip +% +% {\noindent\setstretch{1.1}|\Name{Aristotle}|\dotfill\Name{Aristotle}\\ % |\Name{Aristotle}|\dotfill\Name{Aristotle}\\ % |\Name{Elizabeth, I}|\dotfill\Name{Elizabeth, I}\\ % |\Name{Elizabeth, I}|\dotfill\Name{Elizabeth, I}} -% \clearpage -% -% \begin{center}\large\bfseries Macro Patterns:\end{center} % -% \noindent Here we see a large subset of the \textsf{nameauth} macros in order to get a feel for their patterns. This may help one get used to them. -% \begin{center}\small\setstretch{1.1} -% \begin{tabular}{l@{\,}r@{}c@{\,}c@{ }l}\toprule -% \meta{prefix macros} & \cmd{\Name} & & \meta{arguments} \\ -% \meta{prefix macros} & \cmd{\Name} & |*| & \meta{arguments} \\ -% \meta{prefix macros} & \cmd{\FName} & & \meta{arguments} \\\midrule -% & \cmd{\IndexName} & & \meta{arguments} \\ -% & \cmd{\IndexRef} & & \meta{arguments} & \meta{target} \\ -% & \cmd{\ExcludeName} & & \meta{arguments} \\ -% & \cmd{\IncludeName} & & \meta{arguments} \\ -% & \cmd{\IncludeName} & |*| & \meta{arguments} \\ -% & \cmd{\PretagName} & & \meta{arguments} & \meta{sort key} \\ -% & \cmd{\TagName} & & \meta{arguments} & \meta{tag} \\ -% & \cmd{\UntagName} & & \meta{arguments} \\ -% & \cmd{\NameAddInfo} & & \meta{arguments} & \meta{tag} \\ -% & \cmd{\NameQueryInfo} & & \meta{arguments} \\ -% & \cmd{\NameClearInfo} & & \meta{arguments} & \\ -% & \cmd{\IfMainName} & & \meta{arguments} & \marg{y}\marg{n}\\ -% & \cmd{\IfFrontName} & & \meta{arguments} & \marg{y}\marg{n}\\ -% & \cmd{\IfAKA} & & \meta{arguments} & \marg{y}\marg{n}\\ -% & \cmd{\ForgetName} & & \meta{arguments} \\ -% & \cmd{\SubvertName} & & \meta{arguments} \\\bottomrule -% \end{tabular} -% \end{center} -% -% \begin{center}\large\bfseries Prefix Macros:\end{center} -% -% \begin{center}\small\setstretch{1.1} -% \begin{tabular}{rp{0.65\textwidth}}\toprule -% \cmd{\CapThis} & Capitalize first letter of \meta{SNN} in body text.\footnotemark\\ -% \cmd{\CapName} & Cap entire \meta{SNN} in body text. Overrides \cmd{\CapThis}.\\\midrule -% \cmd{\RevName} & Reverse name order in body text (for Eastern names).\\\midrule -% \cmd{\RevComma} & Reverse Western names to \meta{SNN}, \meta{FNN}. Has no effect on native Eastern names.\\ -% \cmd{\ShowComma} & Add comma between \meta{SNN} and \meta{Affix}.\\ -% \cmd{\NoComma} & Suppress comma between \meta{SNN} and \meta{Affix}. Overrides \cmd{\ShowComma}.\\\midrule -% \cmd{\ForceFN} & Force Eastern forename/ancient affix. Only affects non-Western forms.\\ -% \cmd{\DropAffix} & Drop name affix of Western name (in long name reference). Only affects Western names.\\ -% \cmd{\KeepAffix} & Insert non-breaking space between \meta{SNN} and \meta{Affix}. Can prevent a native Eastern name from breaking.\\\midrule -% \cmd{\SeeAlso} & Toggle cross-reference type from \emph{see} to \emph{see also} (with \cmd{\IndexRef}, \cmd{\AKA}, and \cmd{\PName}).\\\bottomrule -% \end{tabular} -% \end{center} -% \footnotetext{\cmd{\AccentCapThis} is a fall-back for when the \textsf{nameauth} package is used where system architecture or file encoding might cause errors with the automatic Unicode detection under NFSS.} -% -% Most \meta{prefix macros} are ``stackable'' in front of the naming macros; for example, \cmd{\CapName}\cmd{\RevName}\cmd{\Name}\dots. -% \clearpage -% -% \subsubsection{Simplefied Interface} +% \subsection{Simplified Interface} % \label{sec:simplestart}% % % \DescribeEnv{nameauth} -% The |nameauth| environment can replace \cmd{\Name}, \cmd{\Name*}, and \cmd{\FName} with name shorthands that inter-operate with the other package macros. -% -% Although not required, |nameauth| is best used in the document preamble to avoid undefined control sequences.\footnote{The |nameauth| environment uses \cmd{\ignorespaces} to mitigate the need for trailing \texttt{\%}.} -% The italicized comments below are not part of the example proper. Macro fields have uniform widths only to help compare argument types. +% The |nameauth| environment replaces \cmd{\Name}, \cmd{\Name*}, and \cmd{\FName} with shorthands. Using |nameauth| in the preamble is not required, but it helps prevent undefined control sequences. We set some names up below. Comments are added for explanation; they are not part of the environment itself. % \begin{quote}\small\setstretch{1.1} -% |\begin{nameauth}|\\ -% | \<| \meta{$cseq_1$} |&| \meta{FNN} |&| \meta{SNN}\hphantom{\textit{affix, }} \,|& >|\hfill|% |\emph{West./Non-native East.}\\ -% | \<| \meta{$cseq_2$} |&| \meta{FNN} |&| \meta{SNN, affix} \,|& >|\hfill|% |\emph{Western}\\ -% | \<| \meta{$cseq_3$} |&| \hphantom{\meta{FNN}} |&| \meta{SNN}\hphantom{\textit{affix, }} \,|& >|\hfill|% |\emph{ancient/mono}\\ -% | \<| \meta{$cseq_4$} |&| \hphantom{\meta{FNN}} |&| \meta{SNN, affix} \,|& >|\hfill|% |\emph{royal/ancient}\\ -% | \<| \meta{$cseq_5$} |&| \hphantom{\meta{FNN}} |&| \meta{SNN, FNN}\,|& >|\hfill|% |\emph{Native Eastern}\\ -% | \<| \meta{$cseq_6$} |&| \hphantom{\meta{FNN}} |&| \meta{SNN}\hphantom{\textit{affix, }} \,|&| \meta{FNN or affix} |>|\hfill|% |\emph{old syntax}\footnote{See Section~\ref{sec:obsolete}.}\\ +% |% Field 1 Field 2 Field 3 Field 4|\\ +% |\begin{nameauth}|\\[0.2ex] +% | \< Wash & George & Washington & > %|\hfill\emph{Western}\\ +% | \< Soto & Hernando & de Soto & > %|\hfill\emph{Western}\\ +% | \< Pat & George S. & Patton, Jr. & > %|\hfill\emph{W+affix}\\ +% | \< JRIV & John David & Rockefeller, IV & > %|\hfill\emph{W+affix}\\ +% | \< Lewis & Clive Staples & Lewis & > %|\hfill\emph{Western}\\ +% | \< Aris & & Aristotle & > %|\hfill\emph{Ancient}\\ +% | \< Aeth & & Æthelred, II & > %|\hfill\emph{Ancient}\\ +% | \< Eliz & & Elizabeth, I & > %|\hfill\emph{Ancient}\\ +% | \< Attil & & Attila, the Hun & > %|\hfill\emph{Ancient}\\ +% | \< Konoe & Fumimaro & Konoe & > %|\hfill\emph{W\,as\,East.}\\ +% | \< Miyaz & & Miyazaki, Hayao & > %|\hfill\emph{Eastern}\\ +% | \< Yamt & & Yamamoto, Isoroku & > %|\hfill\emph{Eastern}\\ % |\end{nameauth}| % \end{quote} % -% Each \meta{cseq} creates three macros. In the document text, |\|\meta{cseq} itself works like \cmd{\Name}. |\L|\meta{cseq} (think ``Long'') works like \cmd{\Name*}. |\S|\meta{cseq} (think ``Short'') works like \cmd{\FName}. Please bear in mind the following guidelines: -% % \begin{itemize}\small +% \item Field 1 contains text that will be turned into three control sequences. For example, \texttt{Wash} generates \cmd{\Wash} (like \cmd{\Name}): \ForgetThis\Wash, \cmd{\LWash} (L for Long; like \cmd{\Name*}): \LWash, and \cmd{\SWash} (S for Short; like \cmd{\FName}): \SWash. +% \item Fields~2 and~3 hold the name arguments. +% \item Field 4 usually remains empty. It handles the older non-Western syntax (Section~\ref{sec:obsolete}) and permanent alternate names (next page). % \item In this context, ``|\<|'' is an escape character and a control sequence. If you forget it or just use |<| without the backslash, you will get errors. -% \item There \emph{must} be four argument fields (three ampersands) per line. Leaving out an ampersand will cause an error. Think ``holy hand grenade of Antioch'' from \emph{Monty Python and the Holy Grail}. -% \item Extra spaces in each |&|-delimited field are stripped, as is also the case in the main interface (Section~\ref{sec:tolerance}). -% \item Include trailing braces |{|\,|}| or the like if you must prevent subsequent text in brackets |[|\,|]| from being seen as an optional argument. -% \item The old syntax (Section~\ref{sec:obsolete}), triggered by an empty \meta{FNN} field, causes the \meta{Alt. names} field to be interpreted as either \meta{Eastern FNN} or \meta{affix}. +% \item There \emph{must} be four argument fields (three ampersands) per line. Leaving out an ampersand will cause an error. +% \item Extra spaces in each |&|-delimited field are stripped, as is also the case in the traditional interface (Section~\ref{sec:tolerance}). +% \item Put trailing braces |{|\,|}| or something else after the shorthands to prevent subsequent text in brackets |[|\,|]| from becoming an optional argument. % \end{itemize} % -%Current\marginpar{\large\raggedleft\textsf{\bfseries 3.0}\strut} versions permit alternate names for Eastern names and Western names, but not mononyms. \textbf{To switch between \meta{FNN} and \meta{Alt. names}, simply use the forms above with an optional argument after the shorthand.} The forms below only print \meta{Alt. names}, never \meta{FNN}, in the body text. See also Section \ref{sec:Fname} and the example on the next page. +% Normally you would use something like |\LLewis[C.S.]| to get \LLewis[C.S.] instead of \LLewis. You can make that permanent, where \SCSL\ always prints in the text, yet the index always shows ``Lewis, Clive Staples. Some permanent alternate names are shown below: +% % \begin{quote}\small\setstretch{1.1} -% |\begin{nameauth}|\\ -% | \<| \meta{$cseq_7$} | &| \meta{FNN} |&| \meta{SNN}\hphantom{\textit{affix, }} \,|&| \meta{Alt. names} |>|\hfill|%|\,\emph{Western alt.}\footnote{Instead of this form you could use \cmd{\IndexRef} or \cmd{\AKA} to create a cross-reference, for example, from \AKA[John David]{Rockefeller, IV}[Jay]{Rockefeller} to \LJRIV. See Sections~\ref{sec:IndexXref} and~\ref{sec:AKA}.}\\ -% | \<| \meta{$cseq_8$} | &| \meta{FNN} |&| \meta{SNN, affix} \,|&| \meta{Alt. names} |>|\hfill|% |\emph{Western alt.}\\ -% | \<| \meta{$cseq_9$} | &| \hphantom{\meta{FNN}} |&| \meta{SNN, affix} \,|&| \meta{Alt. names} |>|\hfill|% |\emph{Ancient alt.}\\ -% | \<| \meta{$cseq_{10}$} |&| \hphantom{\meta{FNN}} |&| \meta{SNN, FNN}\,|&| \meta{Alt. names} |>|\hfill|% |\emph{Eastern alt.}\\ +% |\begin{nameauth}|\\[0.2ex] +% | \< JayR & John David & Rockefeller, IV & Jay > %|\hfill\emph{Western}\\ +% | \< CSL & Clive Staples & Lewis & C.S. > %|\hfill\emph{Western}\\ +% | \< Unraed & & Æthelred, II & Unrædig > %|\hfill\emph{Ancient}\\ +% | \< MSens & & Miyazaki, Hayao & Sensei > %|\hfill\emph{Eastern}\\ % |\end{nameauth}| % \end{quote} -% \clearpage % -% This example of the \texttt{nameauth} environment uses a fairly complete set of names and illustrates how extra spaces are ignored. We also see the shorthands used in the body text (and the index).\ForgetName[George]{Washington}\ForgetName[John David]{Rockefeller, II}\ForgetName[John David]{Rockefeller, IV}\ForgetName[Clive Staples]{Lewis}\ForgetName{Aristotle}\ForgetName{Elizabeth, I}\ForgetName[Fumimaro]{Konoe}\ForgetName{Yamamoto, Isoroku} +% So you get \ForgetThis\JayR, \ForgetThis\CSL, \ForgetThis\Unraed, and \ForgetThis\MSens\ instead of \LJRIV, \LLewis, \LAeth, and \LMiyaz, but they all have the same respective index entries.\footnote{One could use \cmd{\AKA} to create a cross-reference \AKA[John David]{Rockefeller, IV}[Jay]{Rockefeller}. See Sections~\ref{sec:IndexXref} and~\ref{sec:AKA}.} +% The caveat is that |\LLewis[Jack]| prints \LLewis[Jack] while |\LCSL[Jack]| prints \LCSL[Jack]. Section~\ref{sec:Fname} explains why. +% % \begin{quote}\small\setstretch{1.1} % |\begin{nameauth}|\\[0.2ex] -% | \< Wash & George & Washington & >|\hfill|% |\emph{Western}\\ -% | \< Soto & Hernando & de Soto & >|\hfill|% |\emph{particle}\\ -% | \< JRII & John David & Rockefeller, II & >|\hfill|% |\emph{affix}\\ -% | \< JRIV & John David & Rockefeller, IV & >|\hfill|% |\emph{affix}\\ -% | \< JayR & John David & Rockefeller, IV & Jay >|\hfill|% |\emph{nickname}\\ -% | \< LewisFull & Clive Staples & Lewis & >|\hfill|% |\emph{Western}\\ -% | \< Lewis & Clive Staples & Lewis & C.S. >|\hfill|% |\emph{nickname}\\ -% | \< Aris & & Aristotle & >|\hfill|% |\emph{ancient}\\ -% | \< Eliz & & Elizabeth, I & >|\hfill|% |\emph{royal}\\ -% | \< Attil & & Attila, the Hun & >|\hfill|% |\emph{ancient}\\ -% | \< Konoe & Fumimaro & Konoe & >|\hfill|% |\emph{``non-native'' Eastern}\\ -% | \< Yamt & & Yamamoto, Isoroku & >|\hfill|% |\emph{``native'' Eastern}\\ +% | \< JWG & J.W. von & Goethe & > %|\hfill\emph{Western; German}\\ +% | \< VBuren & Martin & Van Buren & > %|\hfill\emph{Western; English}\\ % |\end{nameauth}| % \end{quote} % -% Below, ``non-native'' Eastern name forms are shown with a dagger (\dag). Please see Section~\ref{sec:Eastern} to avoid pitfalls with Eastern names and reversing macros. +% English keeps the prefix with the surname in the text and the index: \VBuren\ is ``Van Buren, Martin'' in the index. German separates particles: \cmd{\JWG} prints \JWG\ and \JWG, with ``Goethe, J.W. von'' in the index. You get \LJWG[von] with |\LJWG[von]|. See Section~\ref{sec:standards} on multicultural standards and Section~\ref{sec:DuBois} on indexing alternate names. Additionally, [\hyperlink{Mulvany}{Mulvany}, 152--82] and the \emph{Chicago Manual of Style} offer helpful guidance.\ForgetName[J.W. von]{Goethe}\medskip +% +% \noindent\textbf{So, why use it?}\medskip +% +% The simplified interface can save work. Instead of the traditional interface macros on the left, one uses the simplified macros on the right:\\[1ex] +% {\small\setstretch{1.1} +% |\Name [George]{Washington}|\dotfill\cmd{\Wash}: \ForgetThis\Wash\\ +% |\Name*[George]{Washington}|\dotfill\cmd{\LWash}: \LWash\\ +% |\Name [George]{Washington}|\dotfill\cmd{\Wash}: \Wash\hphantom{ \SWash}\\ +% |\FName[George]{Washington}|\dotfill\cmd{\SWash}: \SWash\hphantom{ \Wash}\\[1ex] +% |\IndexName[George]{Washington}|\dotfill\cmd{\JustIndex}\cmd{\Wash} \JustIndex\Wash\hphantom{:\LWash}\\[1ex] +% |\ForgetName[George]{Washington}%|\\ +% |\Name[George]{Washington}|\dotfill\cmd{\ForgetThis}\cmd{\Wash}: \ForgetThis\Wash\\[1ex] +% |\SubvertName[George]{Washington}%|\\ +% |\Name[George]{Washington}|\dotfill\cmd{\SubvertThis}\cmd{\Wash}: \SubvertThis\Wash\hphantom{ \SWash}} +% \clearpage +% +% \noindent\textbf{Examples:}\medskip +% +% Below, ``non-native'' Eastern name forms are shown with a dagger (\dag). Please see Section~\ref{sec:Eastern} to avoid pitfalls with Eastern names and reversing macros. We reset some ``first uses'' of names from before (Section~\ref{sec:tweaks}). +% % \begin{center}\footnotesize\setstretch{1.1} -% \begin{tabular}{ll} +% \begin{tabular}{@{}ll@{}} % \textsc{Western:} & \textsc{Ancient\,/\,Mononym} \\ -% |\Wash | \dotfill \Wash & |\Aris| \dotfill \Aris \\ +% |\Wash | \dotfill \ForgetThis\Wash & |\Aris| \dotfill \ForgetThis\Aris \\ % |\LWash| \dotfill \LWash & |\Aris| \dotfill \Aris \\ % |\Wash | \dotfill \Wash & \\ % |\SWash| \dotfill \SWash & \textsc{Medieval/Royal:} \\ -% |\RevComma\LWash| & |\Eliz | \dotfill \Eliz \\ -% \dotfill \RevComma\LWash & |\Eliz | \dotfill \Eliz \\ -% & |\Attil| \dotfill \Attil \\ -% \textsc{Particles:} \hfill (Section~\ref{sec:standards}) & |\Attil| \dotfill \Attil \\ -% |\Soto| \dotfill \Soto & \\ -% |\Soto| \dotfill \Soto & \textsc{``Non-native'' Eastern:} \\ -% |\CapThis\Soto| \dotfill \CapThis\Soto & |\Konoe | \dotfill \Konoe\dag \\ -% & |\LKonoe| \dotfill \LKonoe\dag \\ -% \textsc{Affixes:} \hfill (Section~\ref{sec:Affix}) & |\Konoe | \dotfill \Konoe\dag \\ -% |\JRII | \dotfill \JRII & |\SKonoe| \dotfill \SKonoe\dag \\ -% |\LJRII| \dotfill \LJRII & |\CapName\RevName\LKonoe| \\ -% |\DropAffix\LJRII| & \dotfill \CapName\RevName\LKonoe\dag \\ -% \dotfill \DropAffix\LJRII & |\CapName\Konoe| \dotfill \CapName\Konoe\dag \\ -% |\JRII | \dotfill \JRII & \\ -% |\SJRII| \dotfill \SJRII & \textsc{``Native'' Eastern:} \\ -% & |\CapName\Yamt| \\ -% \textsc{Nicknames:} \hfill (Section~\ref{sec:Fname}) & \dotfill \CapName\Yamt \\ -% |\JRIV | \dotfill \JRIV & |\CapName\LYamt| \\ -% |\LJRIV[Jay]| \dotfill \LJRIV[Jay] & \dotfill \CapName\LYamt \\ -% |\SJRIV[Jay]| \dotfill \SJRIV[Jay] & |\CapName\Yamt| \\ -% |\DropAffix\LJayR | \dotfill\DropAffix \LJayR & \dotfill \CapName\Yamt \\ -% |\SJayR | \dotfill \SJayR & |\RevName\LYamt| \\ -% |\LewisFull| \dotfill \LewisFull & \dotfill \RevName\LYamt \\ -% |\LLewis| \dotfill \LLewis & |\SYamt| \dotfill \SYamt \\ -% |\Lewis | \dotfill \Lewis & |\ForceFN\SYamt| \\ -% |\SLewis| \dotfill \SLewis & \dotfill \ForceFN\SYamt \\ +% |\RevComma\LWash| \dotfill \RevComma\LWash & |\Eliz | \dotfill \ForgetThis\Eliz \\ +% & |\Eliz | \dotfill \Eliz \\ +% \textsc{Particles:} \hfill (Section~\ref{sec:standards}) & |\LEliz[the First]| \dotfill \LEliz[the First] \\ +% |\Soto| \dotfill \ForgetThis\Soto & |\Attil| \dotfill \ForgetThis\Attil \\ +% |\Soto| \dotfill \Soto & |\Attil| \dotfill \Attil\\ +% |\CapThis\Soto| \dotfill \CapThis\Soto & \\ +% & \textsc{``Non-native'' Eastern:} \\ +% \textsc{Affixes:} \hfill (Section~\ref{sec:Affix}) & |\Konoe | \dotfill \ForgetThis\Konoe\dag \\ +% |\Pat | \dotfill \ForgetThis\Pat & |\LKonoe| \dotfill \LKonoe\dag \\ +% |\LPat| \dotfill \LPat & |\LKonoe[Minister]| \dotfill \LKonoe[Minister]\dag \\ +% |\DropAffix\LPat| \dotfill \DropAffix\LPat & |\Konoe | \dotfill \Konoe\dag \\ +% |\Pat | \dotfill \Pat & |\SKonoe| \dotfill \SKonoe\dag \\ +% |\SPat| \dotfill \SPat & |\CapName\RevName\LKonoe| \dotfill \CapName\RevName\LKonoe\dag \\ +% & |\CapName\Konoe| \dotfill \CapName\Konoe\dag \\ +% \textsc{Nicknames:} \hfill (Section~\ref{sec:Fname}) & \\ +% |\JRIV | \dotfill \ForgetThis\JRIV & \textsc{``Native'' Eastern:} \\ +% |\DropAffix\LJRIV[Jay]| \dotfill \DropAffix\LJRIV[Jay] & |\CapName\Yamt| \dotfill \ForgetThis\CapName\Yamt \\ +% |\SJRIV[Jay]| \dotfill \SJRIV[Jay] & |\CapName\LYamt| \dotfill \CapName\LYamt \\ +% |\Lewis| \dotfill \ForgetThis\Lewis & |\CapName\Yamt| \dotfill \CapName\Yamt \\ +% |\LLewis[Jack]| \dotfill \LLewis[Jack] & |\RevName\LYamt| \dotfill \RevName\LYamt \\ +% |\SLewis[Jack]| \dotfill \SLewis[Jack] & |\RevName\LYamt[Admiral] | \dotfill \RevName\LYamt[Admiral] \\ +% |\LCSL| \dotfill \LCSL & |\SYamt| \dotfill \SYamt \\ +% |\SCSL | \dotfill \SCSL & |\ForceFN\SYamt| \dotfill \ForceFN\SYamt \\ % \end{tabular} % \end{center} % \ExcludeName{Attila, the Hun} -% \clearpage % -% Sections~\ref{sec:standards},\marginpar{\small\raggedleft\dbend} \ref{sec:accents}, and~\ref{sec:IndexSort} deal with the pitfalls of accents and capitalization, as well as why you should use \cmd{\PretagName} for any name with control sequences or active Unicode under NFSS. This becomes very important when authors and publishers use medieval names as Western names. +% Sections~\ref{sec:standards},\marginpar{\small\raggedleft\dbend} \ref{sec:accents}, and~\ref{sec:IndexSort} deal with the pitfalls of accents and capitalization, as well as why you should use \cmd{\PretagName} when dealing with names that contain control sequences or active Unicode characters. +% +% The simplified\marginpar{\small\raggedleft\dbend} interface can tempt one into completely equating a name with its shortcut. Here we show that to be false. |\ForgetThis\CSL| prints \ForgetThis\CSL. Then |\Lewis| prints \Lewis. Likewise, |\ForgetThis\Lewis| prints \ForgetThis\Lewis. Then |\CSL| prints \CSL. The name itself is the pattern that governs everything. Internally, that detokenized pattern is |CliveStaples!Lewis|. Non-western names have patterns like |Elizabeth,I| and |Yamamoto,Isoroku|. Mononyms are their own pattern: |Aristotle|. % -% When index tagging or pre-tagging names, the \meta{Alternate names} field has no effect on index tags because it appears only in the text. \cmd{\JRIV} and \cmd{\JayR} need only one tag, as do \cmd{\LewisFull} and \cmd{\Lewis}: +% For the same reasons,\marginpar{\small\raggedleft\dbend} when index tagging or pre-tagging names, the \meta{Alternate names} field has no effect on index tags. \cmd{\JRIV} and \cmd{\JayR} need only one tag, as do \cmd{\Lewis} and \cmd{\CSL}: % \begin{quote}\small\setstretch{1.1} % |\TagName[John David]{Rockefeller, IV}{|\meta{something}|}|\\ % |\TagName[Clive Staples]{Lewis}{|\meta{something}|}| % \end{quote} +% \clearpage % -% \subsubsection{Older Syntax} +% \subsection{Older Syntax} % \label{sec:obsolete} % -% An older syntax remains for backward compatibility with early versions of \textsf{nameauth}. The\marginpar{\large\raggedleft\textsf{\bfseries 3.0}\strut} old syntax generally inter-operates with the new, but it limits the use of \cmd{\AKA} and its derivatives. It does not permit using any name forms with comma-delimited suffixes. See also Section~\ref{sec:error}. +% An older syntax for non-Western names remains for backward compatibility with early versions of \textsf{nameauth}. The older syntax prevents the use of alternate names, limits the use of \cmd{\AKA} (Section~\ref{sec:AKA}) and excludes comma-delimited suffixes. Otherwise it works seamlessly with the new syntax. % +% The big change is, instead of using a comma-delimited affix, this form uses the final optional argument for personal names and affixes. When \textsf{nameauth} was young, this seemed the intuitive approach to take. Now it only remains so that older documents still work today. % \begin{quote}\small\setstretch{1.1} % |\Name{Henry}[VIII]|\hfill|% |\emph{royal name}\\ % |\Name{Chiang}[Kai-shek]|\hfill|% |\emph{Eastern name}\\ @@ -1000,7 +997,7 @@ Running "make install" installs the files in the local TeX tree. % | \< Yosh & & Yoshida & Shigeru >|\hfill|% |\emph{Eastern name}\\ % |\end{nameauth}| % \end{quote} -% Since the \meta{FNN} fields are empty, the final field becomes either \meta{affix} or \meta{FNN} and will appear in the index. With this example, we have: +% Since the \meta{FNN} fields are empty, the final field becomes either \meta{affix} or \meta{FNN} and will appear in the index. We show these names with a double dagger (\ddag): % % \begin{center}\small\setstretch{1.1} % \begin{tabular}{ll}\toprule @@ -1015,18 +1012,164 @@ Running "make install" installs the files in the local TeX tree. % \end{tabular} % \end{center} % -% \noindent|\Name{Henry}[VIII]|\marginpar{\large\raggedleft\textsf{\bfseries 2.6}\strut\break\small\raggedleft\dbend} (old syntax) will share name occurrences, tags, and index entries with |\Name{Henry, VIII}| (new syntax), as we see below. To avoid confusion, we do not recommend mixing these forms. +% \noindent|\Name{Henry}[VIII]|\marginpar{\large\raggedleft\textsf{\bfseries 2.6}\strut\break\small\raggedleft\dbend} (older syntax) will share name occurrences, tags, and index entries with |\Name{Henry, VIII}| (new syntax), as we see below. We recommend using the newer syntax unless otherwise needed. % \begin{quote}\small\setstretch{1.1} -% \NameAddInfo{Henry}[VIII]{ (\emph{Defensor Fidei})}|\NameAddInfo{Henry}[VIII]{ (\emph{Defensor Fidei})}|\\ -% \texttt{\dots}\\ -% |\Name*{Henry, VIII}\NameQueryInfo{Henry, VIII}|\\ +% \NameAddInfo{Henry}[VIII]{ (\emph{Defensor Fidei})}|\NameAddInfo{Henry}[VIII]{ (\emph{Defensor Fidei})}% older|\\ +% \texttt{\dots} |\Name*{Henry, VIII}\NameQueryInfo{Henry, VIII} | |% new|\\[0.5ex] % \Name*{Henry, VIII}\NameQueryInfo{Henry, VIII} % \end{quote} % -% Presently\marginpar{\large\raggedleft\textsf{\bfseries 3.0}\strut\break\small\raggedleft\dbend} |\Name*{Henry, VIII}[Tudor]| prints ``\Name*{Henry, VIII}[Tudor]'' in the body text and ``Henry VIII'' in the index. In former versions of this package it would have produced ``Henry VIII Tudor'' in the text and in the index. \textbf{Since the older behavior was discouraged, it no longer will be supported and no backward compatibility will exist.} See also Sections~\ref{sec:indextag} and~\ref{sec:tagtext}. -% \let\NamesFormat\OldFormat +% Presently\marginpar{\large\raggedleft\textsf{\bfseries 3.0}\strut\break\small\raggedleft\dbend} |\Name*{Henry, VIII}[Tudor]| prints ``\Name*{Henry, VIII}[Tudor]'' in the body text and ``Henry VIII'' in the index. Before version 3.0 it would have produced ``Henry VIII Tudor'' in the text and in the index. \textbf{The older behavior was discouraged. It is obsolete and not supported.} See also Sections~\ref{sec:indextag} and~\ref{sec:tagtext}. +% \clearpage +% +% \subsection{Reference Tables} +% \label{sec:RefTables} +% +% \begin{center}\large\bfseries Getting Things Done\end{center} +% Here we link from general tasks to relevant sections. The end of each section listed in the table has a return link to this section. +% \begin{center} +% \begin{tabular}{p{0.5\textwidth}l@{ }r} +% \bfseries I want to\dots & \bfseries Topic & \bfseries Section \\\toprule +% implement standard scholarly names & \cmd{\Name} & \ref{sec:Naming}\\\midrule +% refer to forenames and affixes & \cmd{\FName} & \ref{sec:Fname}\\ +% & forcing references & \ref{sec:tweaks}\\\midrule +% use surnames with inflected or alternate & indexing control & \ref{sec:indexctrl}\\ +% forms without creating unwanted index & forcing references & \ref{sec:tweaks}\\ +% entries & alternate spellings & \ref{sec:DuBois}\\\midrule +% use affixes in names & comma delimiter & \ref{sec:Affix}\\\midrule +% use ``native'' Eastern name forms & comma delimiter & \ref{sec:Affix}\\ +% & Eastern names & \ref{sec:Eastern}\\\midrule +% use reversing and all caps for all Eastern name forms in body text only & Eastern names & \ref{sec:Eastern}\\\midrule +% use discretionary caps in body text only & particles & \ref{sec:standards}\\\midrule +% use discretionary caps in text and index & advanced hooks & \ref{sec:Hooksc}\\\midrule +% handle non-English names and & particles & \ref{sec:standards}\\ +% Continental formatting & accents & \ref{sec:accents}\\ +% & non-English format & \ref{sec:altformat}\\ +% & indexing control & \ref{sec:indexctrl}\\ +% & index sorting & \ref{sec:IndexSort}\\ +% & advanced hooks & \ref{sec:Hooksc}\\\midrule +% not have affixes be present by default & index tags & \ref{sec:indextag}\\ +% in long name forms & text tags & \ref{sec:tagtext}\\\midrule +% manage index cross-references & cross-references & \ref{sec:IndexXref}\\ +% & alternate names & \ref{sec:AKA}\\\midrule +% format variant name forms & formatting & \ref{sec:formatting}\\ +% & indexing control & \ref{sec:indexctrl}\\ +% & forcing references & \ref{sec:tweaks}\\ +% & alternate spellings & \ref{sec:DuBois}\\\midrule +% use \textsf{nameauth} with beamer overlays & formatting & \ref{sec:formatting}\\ +% or design a game book & index tags & \ref{sec:indextag}\\ +% or design a history book & text tags & \ref{sec:tagtext}\\ +% or use many dynamic name elements & name tests & \ref{sec:tests}\\ +% or force name elements to be constant & forcing references & \ref{sec:tweaks}\\ +% & life dates & \ref{sec:Hooksb}\\ +% & advanced hooks & \ref{sec:Hooksc}\\\bottomrule +% \end{tabular} +% \end{center} +% \clearpage +% +% \begin{center}\large\bfseries Form and Format Overview\end{center} +% Below we see how the naming macros generate output. First uses of a name are full references and call first-use formatting hooks. Subsequent uses can be longer or shorter, calling their own hooks unless \cmd{\ForceName} changes that (Section~\ref{sec:formatting}). Section~\ref{sec:tweaks} also has more information on how to change things. For changes to \cmd{\AKA} and friends, the \texttt{alwaysformat} option may be needed (Section~\ref{sec:AKA}).\bigskip +% +% \noindent{\large\strut\cmd{\Name} or Unmodified Shorthand}\\ +% {\small% +%\begin{tabular}{lcccc}\toprule[1pt] +% \bfseries First Reference & \bfseries Full & \bfseries Short & \parbox{3.1cm}{\footnotesize\ttfamily\textbackslash NamesFormat\\ \textbackslash FrontNamesFormat\smallskip} & \parbox{2.5cm}{\footnotesize\ttfamily\textbackslash MainNameHook\\ \textbackslash FrontNameHook\smallskip}\\ +% & \YES & \NO & \YES & \NO\\\midrule +% \bfseries Subsequent Ref. & & & \S Cf. \cmd{\ForceName}\\ +% {}*Western Surname & \NO & \YES* & \NO* & \YES\\\midrule +% {}*Eastern Surname & \NO & \YES* & \NO* & \YES\\\midrule +% {}*Ancient Name & \NO & \YES* & \NO* & \YES\\\bottomrule[1pt] +% \end{tabular}}\\\bigskip +% +% \noindent{\large\strut\cmd{\Name*} or L-modifier + Shorthand}\\ +% {\small% +% \begin{tabular}{lcccc}\toprule[1pt] +% \hphantom{*Western Forename} & \bfseries Full & \bfseries Short & \parbox{3.1cm}{\footnotesize\ttfamily\textbackslash NamesFormat \textbackslash FrontNamesFormat\smallskip} & \parbox{2.5cm}{\footnotesize\ttfamily\textbackslash MainNameHook \textbackslash FrontNameHook\smallskip}\\ +% \bfseries First Reference & \YES & \NO & \YES & \NO\\\midrule +% & & & \S Cf. \cmd{\ForceName}\\ +% \bfseries Subsequent Ref.& \YES & \NO & \NO* & \YES\\\bottomrule[1pt] +% \end{tabular}}\\\bigskip +% +% \noindent{\large\strut\cmd{\FName} or S-modifier + Shorthand}\\ +% {\small% +%\begin{tabular}{lcccc}\toprule[1pt] +% \bfseries First Reference & \bfseries Full & \bfseries Short & \parbox{3.1cm}{\footnotesize\ttfamily\textbackslash NamesFormat \textbackslash FrontNamesFormat\smallskip} & \parbox{2.5cm}{\footnotesize\ttfamily\textbackslash MainNameHook \textbackslash FrontNameHook\smallskip}\\ +% & \YES & \NO & \YES & \NO\\\midrule +% \bfseries Subsequent Ref. & & & \S Cf. \cmd{\ForceName}\\ +% {}*Western Forename & \NO & \YES* & \NO* & \YES\\\midrule +% {}*Eastern Surname & \NO & \YES* & \NO* & \YES\\\midrule +% {}*Ancient Name & \NO & \YES* & \NO* & \YES\\\bottomrule[1pt] +% \end{tabular}}\\\bigskip +% +% \noindent{\large\strut\cmd{\ForceFN}\cmd{\FName} or \cmd{\ForceFN} S-modifier + Shorthand}\\ +% {\small% +%\begin{tabular}{lcccc}\toprule[1pt] +% \bfseries First Reference & \bfseries Full & \bfseries Short & \parbox{3.1cm}{\footnotesize\ttfamily\textbackslash NamesFormat \textbackslash FrontNamesFormat\smallskip} & \parbox{2.5cm}{\footnotesize\ttfamily\textbackslash MainNameHook \textbackslash FrontNameHook\smallskip}\\ +% & \YES & \NO & \YES & \NO\\\midrule +% \bfseries Subsequent Ref. & & & \S Cf. \cmd{\ForceName}\\ +% {}*Western Forename & \NO & \YES* & \NO* & \YES\\\midrule +% {}*Eastern Forename & \NO & \YES* & \NO* & \YES\\\midrule +% {}*Ancient Affix & \NO & \YES* & \NO* & \YES\\\bottomrule[1pt] +% \end{tabular}}\\\bigskip % \clearpage % +% \begin{center}\bfseries Selected Macro Patterns:\end{center} +% +% \begin{center}\small\setstretch{1.05} +% \begin{tabular}{lrccl}\toprule +% \meta{prefix macros} & \cmd{\Name} & \meta{optional *} & \meta{arguments} \\ +% \meta{prefix macros} & \cmd{\FName} & \meta{optional *} & \meta{arguments} \\ +% \meta{prefix macros} & \cmd{\AKA} & \meta{optional *} & \meta{target args} & \meta{xref args}\\ +% \cmd{\SeeAlso} & \cmd{\IndexName} & & \meta{arguments} \\ +% \cmd{\SeeAlso} & \cmd{\IndexRef} & & \meta{arguments} & \meta{target}\\\midrule +% & \cmd{\ExcludeName} & & \meta{arguments} \\ +% & \cmd{\IncludeName} & \meta{optional *} & \meta{arguments} \\ +% & \cmd{\PretagName} & & \meta{arguments} & \meta{sort key} \\ +% & \cmd{\TagName} & & \meta{arguments} & \meta{tag} \\ +% & \cmd{\UntagName} & & \meta{arguments} \\ +% & \cmd{\NameAddInfo} & & \meta{arguments} & \meta{tag} \\ +% & \cmd{\NameQueryInfo} & & \meta{arguments} \\ +% & \cmd{\NameClearInfo} & & \meta{arguments} & \\ +% & \cmd{\IfMainName} & & \meta{arguments} & \marg{y}\marg{n}\\ +% & \cmd{\IfFrontName} & & \meta{arguments} & \marg{y}\marg{n}\\ +% & \cmd{\IfAKA} & & \meta{arguments} & \marg{y}\marg{n}\\ +% & \cmd{\ForgetName} & & \meta{arguments} \\ +% & \cmd{\SubvertName} & & \meta{arguments} \\\bottomrule +% \end{tabular} +% \end{center} +% +% \begin{center}\bfseries Prefix Macros (One-Time Effect):\end{center} +% \hfil They stack: \cmd{\CapThis}\cmd{\SubvertThis}\cmd{\SkipIndex}\cmd{\Name[foo]\{bar\}}: \CapThis\SubvertThis\SkipIndex\Name[foo]{bar} +% \begin{center}\small\setstretch{1.05} +% \begin{tabular}{rp{0.72\textwidth}}\toprule +% \cmd{\CapThis} & Capitalize first letter of \meta{SNN} or \meta{Affix} in body text. Overrides both \cmd{\CapName} and \cmd{\AllCapsActive}.\footnotemark[3]\\ +% \cmd{\CapName} & Cap entire \meta{SNN} in body text.\\\midrule +% \cmd{\RevName} & Reverse name order in body text (e.g., for Eastern names).\\\midrule +% \cmd{\RevComma} & Reverse Western names to \meta{SNN}, \meta{FNN}.\footnotemark[4]\\ +% \cmd{\ShowComma} & Add comma between \meta{SNN} and \meta{Affix}.\\ +% \cmd{\NoComma} & No comma between \meta{SNN} and \meta{Affix}. Excludes \cmd{\ShowComma}.\\\midrule +% \cmd{\ForceFN} & \texttt{Force} Eastern \texttt{F}ore\texttt{N}ame or ancient \texttt{F}i\texttt{N}al affix.\footnotemark[5]\\ +% \cmd{\DropAffix} & Drop name affix of Western name (in long name reference).\footnotemark[6]\\ +% \cmd{\KeepAffix} & Insert non-breaking space between \meta{SNN} and \meta{Affix}.\footnotemark[7]\\ +% \cmd{\KeepName} & Insert non-breaking space between all syntactic name elements.\\\midrule +% \cmd{\ForceName} & Have a subsequent name use call first-use formatting hooks.\\\midrule +% \cmd{\ForgetThis} & Next naming macro prints a first use. Excludes \cmd{\SubvertThis}.\\ +% \cmd{\SubvertThis} & The next naming macro prints a subsequent use.\\\midrule +% \cmd{\SeeAlso} & The next cross-reference macro creates a \emph{see also} reference.\footnotemark[8]\\ +% \cmd{\SkipIndex} & The next naming macro does not create index entries.\\ +% \cmd{\JustIndex} & The next \cmd{\Name} or \cmd{\FName} acts just like a call to \cmd{\IndexName}. Ignored and reset by \cmd{\AKA} and \cmd{\PName}.\\\bottomrule +% \end{tabular} +% \end{center} +% \footnotetext[3]{\cmd{\AccentCapThis} is a fall-back for when the \textsf{nameauth} package is used where system architecture or file encoding might cause errors with the automatic Unicode detection under NFSS.} +% \footnotetext[4]{Has no effect on non-Western name forms.} +% \footnotetext[5]{Only affects non-Western name forms.} +% \footnotetext[6]{Only affects Western name forms.} +% \footnotetext[7]{Used best with Western and ancient name forms.} +% \footnotetext[8]{Works only with \cmd{\IndexRef}, \cmd{\AKA}, \cmd{\PName} and their respective starred variants.} +% \addtocounter{footnote}{6} +% \clearpage +% +% \section{Detailed Usage} % \subsection{Package Options} % \label{sec:options} % @@ -1034,10 +1177,9 @@ Running "make install" installs the files in the local TeX tree. % \begin{quote}\small % |\usepackage[|\meta{$option_1$}|,|\meta{$option_2$}|,|\dots|]{nameauth}| % \end{quote} -% The options have no required order. Still, we discuss them from the general to the specific, as the headings below indicate. +% The options have no required order. Still, we discuss them from the general to the specific, as the headings below indicate. In the listings below, when there are defaults, \textbf{default options are shown in boldface.} % -% \begin{center}\bfseries Default options are shown in boldface.\\[2ex] -% \large Choosing Features\end{center} +% \begin{center}\large\bfseries Choosing Features\end{center} % % \noindent{\bfseries Enable Package Warnings}\\[1ex] % {\setstretch{1.1}\begin{tabular}{p{0.22\textwidth}p{0.6\textwidth}} @@ -1047,32 +1189,34 @@ Running "make install" installs the files in the local TeX tree. % % \noindent{\bfseries Choose Formatting}\\[1ex] % {\setstretch{1.1}\begin{tabular}{p{0.22\textwidth}p{0.6\textwidth}} -% \quad\bfseries\texttt{mainmatter} & \bfseries Start with ``main-matter names'' and formatting hooks (page~\pageref{page:PostProcess}).\\ +% \quad\bfseries\texttt{mainmatter} & \bfseries Start with ``main-matter names'' and formatting hooks (see also page~\pageref{page:PostProcess}).\\ % \quad\texttt{frontmatter} & Start with ``front-matter names'' and hooks.\\ % \quad\texttt{alwaysformat} & Use only respective ``first use'' formatting hooks.\\ -% \quad\texttt{formatAKA} & Format names declared by \cmd{\AKA} like other main- and front-matter names.\\ +% \quad\texttt{formatAKA} & Format the first use of a name with \cmd{\AKA} like the first use of a name with \cmd{\Name}.\\ % \quad\texttt{oldAKA} & Force \cmd{\AKA*} to act like it did before v.3.0.\\ % \end{tabular}}\\[1ex] -% The default \texttt{mainmatter} option and the \texttt{frontmatter} option enable two different systems of name use and formatting. They are mutually exclusive. \cmd{\NamesActive} starts the main matter system when \texttt{frontmatter} is used. See Section~\ref{sec:formatting}. +% The \texttt{mainmatter} option and the \texttt{frontmatter} option enable two different systems of name use and formatting. They are mutually exclusive. \cmd{\NamesActive} starts the main matter system when \texttt{frontmatter} is used. See Section~\ref{sec:formatting}. % -% The \texttt{alwaysformat} option forces ``first use'' hooks globally. The \texttt{formatAKA} option affects ``first-use'' formatting and \cmd{\AKA} (Section~\ref{sec:AKA}). Both \texttt{alwaysformat} and \texttt{formatAKA} can be used with either \texttt{mainmatter} or \texttt{frontmatter}. +% The \texttt{alwaysformat} option forces ``first use'' hooks globally in both naming systems. Its use is limited in current versions of \textsf{nameauth}. % -% \textbf{Using\marginpar{\large\raggedleft\textsf{\bfseries 3.0}\strut} \texttt{oldAKA} option forces \cmd{\AKA*} always to print a ``forename'' field in the text, as it did in versions 2.6 and older.} Otherwise the current behavior of \cmd{\AKA*} prints in the same fashion as \cmd{\FName} (see Sections~\ref{sec:Fname} and~\ref{sec:AKA}).\bigskip +% The\marginpar{\large\raggedleft\textsf{\bfseries 3.1}\strut} \texttt{formatAKA} option permits \cmd{\AKA} to use the ``first use'' formatting hooks. This enables \cmd{\ForceName} to trigger those hooks at will (Section~\ref{sec:AKA}). Otherwise \cmd{\AKA} uses ``subsequent use'' hooks. +% +% Using the\marginpar{\large\raggedleft\textsf{\bfseries 3.0}\strut} \texttt{oldAKA} option forces \cmd{\AKA*} always to print a ``forename'' field in the text, as it did in versions 2.6 and older. Otherwise the current behavior of \cmd{\AKA*} prints in the same fashion as \cmd{\FName} (see Sections~\ref{sec:Fname} and~\ref{sec:AKA}).\bigskip % % \noindent{\bfseries Enable/Disable Indexing}\\[1ex] % {\setstretch{1.1}\begin{tabular}{p{0.22\textwidth}p{0.6\textwidth}} % \quad\bfseries\texttt{index} & \bfseries Create index entries in place with names.\\ % \quad\texttt{noindex} & Suppress indexing of names.\\ % \end{tabular}}\\[1ex] -% These apply only to the \textsf{nameauth} package macros. The default \texttt{index} option enables name indexing right away. The \texttt{noindex} option disables the indexing of names until \cmd{\IndexActive} enables it. {\bfseries Both \texttt{noindex} and \cmd{\IndexInactive} suppress index tags.} See Section~\ref{sec:SectionIndex}.\bigskip +% These apply only to the \textsf{nameauth} package macros. The default \texttt{index} option enables name indexing right away. The \texttt{noindex} option disables the indexing of names until \cmd{\IndexActive} enables it. \textbf{Caution:}\marginpar{\small\raggedleft\dbend} using \texttt{noindex} and \cmd{\IndexInactive} prevents index tags until you call \cmd{\IndexInactive}, as explained also in Section~\ref{sec:indexctrl}. +% \clearpage % % \noindent{\bfseries Enable/Disable Index Sorting}\\[1ex] % {\setstretch{1.1}\begin{tabular}{p{0.22\textwidth}p{0.6\textwidth}} % \quad\bfseries\texttt{pretag} & \bfseries Create sort keys used with \texttt{makeindex}.\\ % \quad\texttt{nopretag} & Do not create sort keys. \\ % \end{tabular}}\\[1ex] -% The default allows \cmd{\PretagName} to create sort keys used with NFSS or \texttt{makeindex} and its analogues. This option exists to switch sorting off if needed for \texttt{xindy}. See Section~\ref{sec:IndexSort}. -% \clearpage +% The default allows \cmd{\PretagName} to create sort keys used with NFSS or \texttt{makeindex} and its analogues. The \texttt{nopretag} option disables the sorting mechanism, e.g., if a different sorting method is used with \texttt{xindy}. See Section~\ref{sec:IndexSort}. % % \begin{center}\large\bfseries Affect the Syntax of Names\end{center} % {\bfseries Show/Hide Affix Commas}\\[2ex] @@ -1080,9 +1224,9 @@ Running "make install" installs the files in the local TeX tree. % \quad\bfseries\texttt{nocomma} & \bfseries Suppress commas between surnames and affixes, following the \emph{Chicago Manual of Style} and other conventions.\\ % \quad\texttt{comma} & Retain commas between surnames and affixes.\\ % \end{tabular}}\\[1ex] -% This option is set at load time. If you use \emph{modern standards}, choose the default \texttt{nocomma} option to get, \emph{e.g.}, ``\Name[J.E.]{Carter, Jr.}[James Earl].'' If you need to adopt \emph{older standards} that use commas between surnames and affixes, you have two choices: +% This option is set at load time. If you use \emph{modern standards}, choose the default \texttt{nocomma} option to get, \emph{e.g.}, \Name[J.E.]{Carter, Jr.}[James Earl]. If you need to adopt \emph{older standards} that use commas between surnames and affixes, you have two choices: % \begin{enumerate} -% \item The \texttt{comma} option globally produces, \emph{e.g.}, ``\ShowComma\Name*[J.E.]{Carter, Jr.}[James Earl].'' +% \item The \texttt{comma} option globally produces, \emph{e.g.}, \ShowComma\Name*[J.E.]{Carter, Jr.}[James Earl]. % \item Section~\ref{sec:Affix} shows how one can use \cmd{\ShowComma} with the \texttt{nocomma} option and \cmd{\NoComma} with the \texttt{comma} option to get per-name results. % \end{enumerate}\medskip % @@ -1093,7 +1237,7 @@ Running "make install" installs the files in the local TeX tree. % \end{tabular}}\\[1ex] % This only capitalizes names printed in the body text. English standards usually do not propagate typographic changes into the index. % -% Still,\marginpar{\small\raggedleft\dbend} you can use this package with non-English conventions. You can add, \emph{e.g.}, uppercase or small caps in surnames, formatting them also in the index. See also Sections~\ref{sec:nonenglish} and~\ref{sec:Hooksc} The simplified interface aids the embedding of control sequences in names. Section~\ref{sec:Eastern} deals with capitalization on a section-level and per-name basis.\bigskip +% Still,\marginpar{\small\raggedleft\dbend} you can use this package with non-English conventions. You can add, \emph{e.g.}, uppercase or small caps in surnames, formatting them also in the index. See also Sections~\ref{sec:altformat} and~\ref{sec:Hooksc} The simplified interface aids the embedding of control sequences in names. Section~\ref{sec:Eastern} deals with capitalization on a section-level and per-name basis.\bigskip % % \noindent{\bfseries Reverse Name Order}\\[2ex] % {\setstretch{1.1}\begin{tabular}{p{0.22\textwidth}p{0.6\textwidth}} @@ -1101,64 +1245,67 @@ Running "make install" installs the files in the local TeX tree. % \quad\texttt{allreversed} & Print all name forms in ``smart'' reverse order.\\ % \quad\texttt{allrevcomma} & Print all names in ``Surname, Forenames'' order, meant for Western names.\\ % \end{tabular}}\\[1ex] -% These options should not be used indiscriminately. Reversing can have unwanted results with ancient/medieval names. Section~\ref{sec:Eastern} can help guide you on whether to consider global or per-name reversing for Eastern names. +% These options are mutually exclusive. Section~\ref{sec:Eastern} speaks more about reversing. The \texttt{allreversed} option, \cmd{\ReverseActive}, and \cmd{\RevName} work with all names and override \texttt{allrevcomma} and its macros. % -% So-called ``last-comma-first'' lists of names via \texttt{allrevcomma} and the macros \cmd{\ReverseCommaActive} and \cmd{\RevComma} (Section~\ref{sec:LastFirst}) are \emph{not} the same as the \texttt{comma} option. They are designed for Western names. +% So-called ``last-comma-first'' lists of names via \texttt{allrevcomma} and the reversing macros \cmd{\ReverseCommaActive} and \cmd{\RevComma} (Section~\ref{sec:LastFirst}) are \emph{not} the same as the \texttt{comma} option. They only affect Western names. % \clearpage % % \phantomsection\label{page:PostProcess} % \begin{center}\large\bfseries Typographic Post-Processing\end{center} -% \noindent Sections~\ref{sec:nonenglish},\marginpar{\small\raggedleft\dbend} \ref{sec:formatting}, and~\ref{sec:Hooksa}f. explain this topic in greater detail, but are more advanced regarding technical details. Post-processing does not affect the index and comes after ``syntactic formatting'' (control sequences always present in the \textsf{nameauth} macro arguments).\footnote{This package was designed with type hierarchies in mind, although it has become more flexible. See Robert Bringhurst, \emph{The Elements of Typographic Style}, version 3.2 (Point Roberts, Washington: Hartley \& Marks, 2008), 53--60.} +% \noindent{\bfseries Formatting Attributes}\\[2ex] +% {\setstretch{1.1}\begin{tabular}{p{0.22\textwidth}p{0.6\textwidth}} +% \quad\texttt{smallcaps} & First use of a main-matter name in small caps.\\ +% \quad\texttt{italic} & First use of a main-matter name in italic.\\ +% \quad\texttt{boldface} & First use of a main-matter name in boldface.\\ +% \quad\bfseries\texttt{noformat} & \bfseries Do not define a default format.\\ +% \end{tabular}}\\ % -% What\marginpar{\large\raggedleft\textsf{\bfseries 2.4}\strut} was ``typographic formatting'' has become a generalized concept of ``post-processing'' via these hook macros: +% Current\marginpar{\large\raggedleft\textsf{\bfseries 2.5}\strut} versions assign no default formatting to names. Most users have preferred the \texttt{noformat} option as the default and then design their own hooks as needed.\footnote{For those that want the old default option from the early days of this package, one can recover that behavior with the \texttt{smallcaps} option.} +% The options above are ``quick'' solutions based on English typography. +% +% What\marginpar{\large\raggedleft\textsf{\bfseries 2.4}\strut} was ``typographic formatting'' has become a generalized concept of ``post-processing'' via hook macros.\footnote{This package was designed with type hierarchies in mind, although it has become more flexible. See Robert Bringhurst, \emph{The Elements of Typographic Style}, version 3.2 (Point Roberts, Washington: Hartley \& Marks, 2008), 53--60. I drew some inspiration from the typography in Bernhard Lohse, \emph{Luthers Theologie} (G\"ottingen: Vandenhoeck \& Ruprecht, 1995) and the five-volume series by Jaroslav J. Pelikan Jr., The Christian Tradition: A History of the Development of Doctrine (Chicago: Chicago UP, 1971--89). Each volume in the series has its own title.} +% Post-processing does not affect the index. Sections \ref{sec:formatting}, \ref{sec:Hooksa}, \ref{sec:Hooksb}, and~\ref{sec:Hooksc} explain these hooks in greater detail: % \begin{itemize} % \item \cmd{\NamesFormat} formats first uses of main-matter names. % \item \cmd{\MainNameHook} formats subsequent uses of main-matter names. % \item \cmd{\FrontNamesFormat} formats first uses of front-matter names. % \item \cmd{\FrontNameHook} formats subsequent uses of front-matter names. -% \end{itemize}\smallskip -% -% Sections~\ref{sec:formatting} and~\ref{sec:Hooksa}f. offer substantially more complex possibilities for such hooks.\footnote{I drew some inspiration from the typography in Bernhard Lohse, \emph{Luthers Theologie} (G\"ottingen: Vandenhoeck \& Ruprecht, 1995) and the five-volume series by Jaroslav J. Pelikan Jr., The Christian Tradition: A History of the Development of Doctrine (Chicago: Chicago UP, 1971--89). Each volume in the series has its own title.} -% By default, they do nothing.\marginpar{\small\raggedleft\cmd{\global}} Changes to the formatting hooks apply within the scope where they are made. To change that, use \cmd{\global} explicitly. +% \end{itemize} % -% English typography has been the default design choice for this package. Still, one can use German, French, and similar standards, which I group as ``Continental.'' Sections~\ref{sec:nonenglish} and~\ref{sec:Hooksc} have more on the topic, as well as the use of sort tags in Section~\ref{sec:IndexSort}. Continental standards format surnames only, both in the text and in the index. This conflicts with some deliberately ambiguous name forms in \textsf{nameauth}.\footnote{Ancient, Eastern, and suffixed name forms have the same pattern.} -% To get formatting in the index one must add it in the macro arguments. The simplified interface aids this process. Continental users may have to implement their own capitalization features; see Sections~\ref{sec:standards} and~\ref{sec:Hooksc}.\medskip +% Changes\marginpar{\small\raggedleft\cmd{\global}} to the formatting hooks apply within the scope where they are made. Use \cmd{\global} explicitly to alter that. \cmd{\NamesFormat} originally was the only hook, so any oddity in the naming of these hooks results from the need for backward compatibility with old versions. % -% \noindent{\bfseries Formatting Attributes}\\[2ex] -% {\setstretch{1.1}\begin{tabular}{ll} -% \quad\texttt{smallcaps} & Set the first use of an entire name in small caps.\footnotemark\\ -% \quad\texttt{italic} & Set the first use of an entire name in italic.\\ -% \quad\texttt{boldface} & Set the first use of an entire name in boldface.\\ -% \quad\bfseries\texttt{noformat} & \bfseries Do not define a default format.\\ +% \begin{center}\large\bfseries Alternate or Continental Formatting\end{center} +% \noindent{\bfseries Alternate Syntactic Formatting}\\[2ex] +% {\setstretch{1.1}\begin{tabular}{p{0.22\textwidth}p{0.6\textwidth}} +% \quad\texttt{altformat} & Make available the alternate formatting framework from the start of the document. Activate formatting by default.\\ % \end{tabular}}\\ -% \footnotetext{Many users will not be affected by these changes. Many prefer the \texttt{noformat} option. If you did use the default option in the past, you can recover that behavior with the \texttt{smallcaps} option.} -% -% The options that assign a font change are intended for ``quick'' solutions based on English typography. They change only \cmd{\NamesFormat}, the macro that formats first instances of names in the main matter.\bigskip % -% \textbf{Current\marginpar{\large\raggedleft\textsf{\bfseries 2.5}\strut} versions assign no default formatting to names.} +% A built-in\marginpar{\large\raggedleft\textsf{\bfseries 3.1}\strut\break\small\dbend} framework provides an alternate formatting mechanism that can be used for ``Continental'' formatting that one sees in German, French, and so on. Continental standards format surnames only, both in the text and in the index. Section~\ref{sec:altformat} introduces the topic, while Section~\ref{sec:Hooksc} goes into greater detail. The previous methods the produced Continental formatting still ought to work. The error protection that prevents \cmd{\CapThis} from breaking alternately formatted names is available by using this option or other macros in Section~\ref{sec:altformat}. % \clearpage % % \subsection{Naming Macros} -% \label{sec:Naming} +% +% Although the formatting hooks do nothing by default, we use them here for teaching purposes. We also force first and subsequent uses as needed. See also Sections~\ref{sec:formatting} and~\ref{sec:tweaks}. Section~\ref{sec:tweaks} show how the name reference systems are independent of other data sets in \textsf{nameauth}. % % \subsubsection{\texttt{\textbackslash Name} and \texttt{\textbackslash Name*}} +% \label{sec:Naming} % % \DescribeMacro{\Name} % \DescribeMacro{\Name*} -% \cmd{\Name} displays and indexes names. Also see the quick start (Section~\ref{sec:simplestart}) and reference (Section~\ref{sec:PatRef}). It always prints the required ``surname'' field. \cmd{\Name} prints the full name at the first occurrence, then a partial form thereafter. \cmd{\Name*} always prints the full name. These macros generate index entries before and after a name in the body text in case of a page break. The general syntax is: +% \cmd{\Name} displays and indexes names. It always prints the required ``surname'' field. \cmd{\Name} prints the full name at the first occurrence, then a partial form thereafter. \cmd{\Name*} always prints the full name. These macros generate index entries before and after a name in the body text in case of a page break. The general syntax is: % \begin{quote}\small\setstretch{1.1} % \cmd{\Name}| |\oarg{FNN}\marg{SNN|,| opt. FNN/Affix}\oarg{Alternate names}\\ % \cmd{\Name}|*|\oarg{FNN}\marg{SNN|,| opt. FNN/Affix}\oarg{Alternate names} % \end{quote} -% In\marginpar{\large\raggedleft\textsf{\bfseries 3.0}\strut} the body text, not the index, the \meta{Alternate names} field replaces the \meta{FNN} field or the \meta{opt. FNN/Affix} field if they exist. If neither of the latter exist, then the old syntax is used (Section~\ref{sec:obsolete}). We see this below: +% In\marginpar{\large\raggedleft\textsf{\bfseries 3.0}\strut} the body text, not the index, the \meta{Alternate names} field replaces the \meta{FNN} field or the \meta{opt. FNN/Affix} field if they exist. If neither of the latter exist, then the older non-Western syntax is used (Section~\ref{sec:obsolete}). % % \begin{quote}\small\setstretch{1.1} % |\begin{nameauth}|\\ % | \< Einstein & Albert & Einstein & >|\\ % | \< Cicero & M.T. & Cicero & >|\\ % | \< Confucius & & Confucius & >|\\ -% | \< Miyazaki & & Miyazaki, Hayao & >|\\ -% | \< CBald & & Charles, the Bald & >|\\ +% | \< Miyaz & & Miyazaki, Hayao & >|\\ +% | \< Eliz & & Elizabeth, I & >|\\ % |\end{nameauth}| % \end{quote} % @@ -1171,18 +1318,20 @@ Running "make install" installs the files in the local TeX tree. % |\Name*[M.T.]{Cicero}[Marcus Tullius]| & \Name*[M.T.]{Cicero}[Marcus Tullius]\\ % |\Name [M.T.]{Cicero}| or |\Cicero| & \Cicero\\\midrule % |\Name {Confucius}| or |\Confucius| & \Confucius\\\midrule -% |\Name {Miyazaki, Hayao}| or |\Miyazaki| & \Name {Miyazaki, Hayao}\\ +% |\Name {Miyazaki, Hayao}| or |\Miyaz| & \ForgetThis\Name {Miyazaki, Hayao}\\ % |\Name*{Miyazaki, Hayao}[Sensei]| & \Name*{Miyazaki, Hayao}[Sensei]\\ -% |\Name {Miyazaki, Hayao}| or |\Miyazaki| & \Name {Miyazaki, Hayao}\\\midrule -% |\Name {Charles, the Bald}| or |\CBald| & \CBald\\ -% |\Name*{Charles, the Bald}| or |\LCBald| & \Name*{Charles, the Bald}\\ -% |\Name {Charles, the Bald}| or |\CBald| & \Name {Charles, the Bald}\\\bottomrule +% |\Name {Miyazaki, Hayao}| or |\Miyaz| & \Name {Miyazaki, Hayao}\\\midrule +% |\Name {Elizabeth, I}| or |\Eliz| & \ForgetThis\Eliz\\ +% |\Name*{Elizabeth, I}| or |\LEliz| & \Name*{Elizabeth, I}\\ +% |\Name {Elizabeth, I}| or |\Eliz| & \Name {Elizabeth, I}\\\bottomrule % \end{tabular} % \end{center} % -% When using the simplified interface, the preferred way to get alternate names is |\LCicero[Marcus Tullius]| and |\LMiyazaki[Sensei]|: \LCicero[Marcus Tullius] and \LMiyazaki[Sensei]. The next section explains why that is so. +% When using the simplified interface, the preferred way to get alternate names is |\LCicero[Marcus Tullius]| and |\LMiyaz[Sensei]|: \LCicero[Marcus Tullius] and \LMiyaz[Sensei]. The next section explains why that is so. % -% Note also that the alternate forename goes away in subsequent name references. |\Name [M.T.]{Cicero}[Marcus Tullius]| shows up as just \Name [M.T.]{Cicero}[Marcus Tullius] in that case. By default, subsequent name references are surnames only. +% Note also that the alternate forename goes away in subsequent short name references. |\Name[M.T.]{Cicero}[Marcus Tullius]| shows up as just \Name [M.T.]{Cicero}[Marcus Tullius] in that case. By default, subsequent name references are surnames only. +% +% {\medskip\noindent\hbox{}\hfill\large Back to Section~\ref{sec:RefTables} \hfill\hbox{}} % \clearpage % % \subsubsection{Forenames: \texttt{\textbackslash FName}} @@ -1190,13 +1339,14 @@ Running "make install" installs the files in the local TeX tree. % % \DescribeMacro{\FName} % \DescribeMacro{\FName*} -% \cmd{\FName} and its synonym \cmd{\FName*} print just personal names, but only in subsequent name uses. The two macros are the same in case you edit \cmd{\Name*} by adding an \texttt{F} to get a first reference. They print a full name, not a short name, when a name is used for the first time. The syntax is: +% \cmd{\FName} and its synonym \cmd{\FName*} print personal names only in subsequent name uses. They print full names for first uses. The two macros are the same in case you edit \cmd{\Name*} by adding an \texttt{F} to get a first reference. They print a full name, not a short name, when a name is used for the first time. The syntax is: % \begin{quote}\small % \cmd{\FName}\oarg{FNN}\marg{SNN|,| opt. FNN/Affix}\oarg{Alternate names} % \end{quote} -% These\marginpar{\large\raggedleft\textsf{\bfseries 3.0}\strut} % \DescribeMacro{\ForceFN} -% macros work with both Eastern and Western names, but to get an Eastern personal name, one must precede these macros with \cmd{\ForceFN}. Otherwise you would get poor results with some royal and ancient names. See also Sections~\ref{sec:tweaks} and~\ref{sec:PatRef}. Examples of general use include: % +% These\marginpar{\large\raggedleft\textsf{\bfseries 3.0}\strut} +% macros work with both Eastern and Western names, but to get an Eastern personal name, one must precede these macros with \cmd{\ForceFN}.\footnote{Otherwise you would get poor results with some royal and ancient names.} +% See also Section~\ref{sec:tweaks} on how to vary some of the forms below. The standard results for subsequent name uses below are: % % \begin{center}\small\setstretch{1.1} % \begin{tabular}{ll}\toprule @@ -1204,107 +1354,96 @@ Running "make install" installs the files in the local TeX tree. % |\FName[M.T.]{Cicero}[Marcus Tullius]| \\ % or |\SCicero[Marcus Tullius]| & \SCicero[Marcus Tullius]\\\midrule % |\FName{Confucius}| or |\SConfucius |& \FName{Confucius}\\\midrule -% |\FName{Miyazaki, Hayao}| or |\SMiyazaki| & \FName{Miyazaki, Hayao}\\ +% |\FName{Miyazaki, Hayao}| or |\SMiyaz| & \FName{Miyazaki, Hayao}\\\midrule % |\ForceFN\FName{Miyazaki, Hayao}|\\ -% or |\ForceFN\SMiyazaki| & \ForceFN\FName{Miyazaki, Hayao}\\ +% or |\ForceFN\SMiyaz| & \ForceFN\FName{Miyazaki, Hayao}\\\midrule % |\ForceFN\FName{Miyazaki, Hayao}[Sensei]|\\ -% or |\ForceFN\SMiyazaki[Sensei]| & \ForceFN\FName{Miyazaki, Hayao}[Sensei]\\\midrule -% |\FName{Charles, the Bald}| or |\SCBald| & \SCBald\\ -% |\ForceFN\FName{Charles, the Bald}|\\ -% or |\ForceFN\SCBald| & \ForceFN\SCBald\\\bottomrule +% or |\ForceFN\SMiyaz[Sensei]| & \ForceFN\FName{Miyazaki, Hayao}[Sensei]\\\midrule +% |\FName{Elizabeth, I}| or |\SEliz| & \SEliz\\\midrule +% |\ForceFN\FName{Elizabeth, I}[the First]|\\ +% or |\ForceFN\SEliz[the First]| & \ForceFN\SEliz[the First]\\\bottomrule % \end{tabular} % \end{center} % -% If we use |\FName[Chesley B.]{Sullenberger, III}[Sully]| we get ``\FName[Chesley B.]{Sullenberger, III}[Sully]'' and ``\FName[Chesley B.]{Sullenberger, III}[Sully]'' because the \meta{Alternate names} always replace the forenames. Please use caution! +% The \meta{Alternate names} argument always replaces the forenames in the text. Sometimes this is a good thing, and sometimes it is not: % \begin{nameauth}% % \< Ches & Chesley B. & Sullenberger, III & > % \< Sully & Chesley B. & Sullenberger, III & Sully > % \end{nameauth}% % \begin{quote}\small\setstretch{1.1} % |\begin{nameauth}|\\ -% | \< LewisFull & Clive Staples & Lewis & >|\\ -% | \< Lewis & Clive Staples & Lewis & C.S. >|\\ +% | \< Lewis & Clive Staples & Lewis & >|\\ +% | \< CSL & Clive Staples & Lewis & C.S. >|\\ % | \< Ches & Chesley B. & Sullenberger, III & >|\\ % | \< Sully & Chesley B. & Sullenberger, III & Sully >|\\ % |\end{nameauth}| % \end{quote} -% \ForgetName[Clive Staples]{Lewis}% -% Some names might call for this name-swapping. For example, if a book section refers always to \Lewis, but another section introduces him as \Name*[Clive Staples]{Lewis} and the editor wants to index him as such, then the two shorthands for \Lewis\ above might be appropriate. Section~\ref{sec:simplestart} illustrates several examples. % -% \ForgetName[Chesley B.]{Sullenberger, III} -% Using ``default nicknames'' in the simplified interface has some caveats. The\marginpar{\small\raggedleft\dbend} first use \cmd{\Ches} prints ``\Ches.'' Later, \cmd{\SChes} and \cmd{\SSully} print ``\SChes'' and ``\SSully.'' While |\SChes[Sully]| always gives ``\SChes[Sully],'' |\SSully[Chesley B.]| prints ``\SSully[Chesley B.].'' With \cmd{\Sully}, the \meta{Alternate names} field is already occupied, making |[Chesley B.]| normal text. +% For example, if a book section refers always to \LCSL, but another section introduces him as \LLewis, one can use both \cmd{\CSL} and \cmd{\Lewis}. \cmd{\Lewis} and \cmd{\CSL} share common first and subsequent uses because they both point to the same \meta{FNN} (Clive Staples) and \meta{SNN} (Lewis). +% +% The drawback lies in remembering that \cmd{\Ches} gives us \Ches, while \cmd{\LSully} produces \LSully. Likewise, \cmd{\SCSL[Jack]} produces \SCSL[Jack]. This happens because the final field in the \texttt{nameauth} environment populates the \meta{Alternate Names} argument. When that occurs, the following text in square brackets becomes just normal text. +% +% {\medskip\noindent\hbox{}\hfill\large Back to Section~\ref{sec:RefTables} \hfill\hbox{}} % \clearpage % % \subsection{Language Issues} +% Here we engage topics that relate to specific aspects of grammar and cultural standards. The \textsf{nameauth} package is designed with a keen awareness of cross-cultural use and tries to implement such aspects in a smooth fashion. % % \subsubsection{Affixes Need Commas} % \label{sec:Affix} % -% Comma-delimited affixes handle several different name types. \emph{Always include a comma as an affix delimiter}, even when commas are not printed. Extra spaces between the comma and affix are ignored. +% Comma-delimited affixes are shown below. For Western names, they separate a surname and an affix. For non-Western names, they separate either a surname and a forename or a name and an affix. \emph{Always use a comma as an affix delimiter}, even when commas are not printed. Spaces between the comma and affix are ignored. See also Section~\ref{sec:tolerance}. % % \begin{center}\small\ForgetName{Sun, Yat-sen}\setstretch{1.1} % \begin{tabular}{ll}\toprule -% |\Name[Oskar]{Hammerstein, II}| & \Name[Oskar]{Hammerstein, II}\\ +% |\Name[Oskar]{Hammerstein, II}| & \KeepAffix\Name[Oskar]{Hammerstein, II}\\ % |\Name[Oskar]{Hammerstein, II}| & \Name[Oskar]{Hammerstein, II}\\\midrule -% |\Name{Louis, XIV}| & \Name{Louis, XIV}\\ +% |\Name{Louis, XIV}| & \KeepAffix\Name{Louis, XIV}\\ % |\Name{Louis, XIV}| & \Name{Louis, XIV}\\\midrule -% |\Name{Sun, Yat-sen}| & \Name{Sun, Yat-sen}\\ +% |\Name{Sun, Yat-sen}| & \KeepAffix\Name{Sun, Yat-sen}\\ % |\Name{Sun, Yat-sen}| & \Name{Sun, Yat-sen}\\\bottomrule % \end{tabular} % \end{center} % -% One\marginpar{\small\raggedleft\dbend} cannot use the old syntax with the \Name[Oskar]{Hammerstein, II} example. If you tried to use {\IndexInactive|\Name[Oskar]{Hammerstein}[II]| you would get ``\Name[Oskar]{Hammerstein}[II].''} Western names with suffixes must use the comma-delimited syntax. Also, one must use comma-delimited suffixes to cross-reference all name forms with \cmd{\AKA}. For a full description see Section~\ref{sec:AKA}.\medskip +% Western\marginpar{\small\raggedleft\dbend} names with suffixes must use the comma-delimited syntax. Using the older non-Western syntax |\Name[Oskar]{Hammerstein}[II]| produces \SkipIndex\Name[Oskar]{Hammerstein}[II] (index entry skipped). Also, one must use comma-delimited suffixes to with the cross-reference target of \cmd{\AKA} (Section~\ref{sec:AKA}).\medskip % % \DescribeMacro{\KeepAffix} -% Put \cmd{\KeepAffix} before \cmd{\Name} or \cmd{\AKA} if a \meta{SNN, affix} pair is split: ``\Name*{Louis, XIV}.'' |\KeepAffix\Name*{Louis, XIV}| prevents that break by inserting a non-breaking space between \meta{SNN} and \meta{affix} (or \meta{SNN} and \meta{Eastern FNN}) in the body text, but not in the index. Spaces between multiple names in each name field are not affected. This works with all name types handled by \textsf{nameauth}.\medskip +% \DescribeMacro{\KeepName} +% In the text only,\marginpar{\large\raggedleft\textsf{\bfseries 3.1}\strut} \cmd{\KeepAffix} puts a non-breaking space between a Western surname and affix, an ancient name and affix, and a native Eastern family name and personal name. +% In the text only, \cmd{\KeepName} turns all spaces between syntactic name components (\meta{FNN}, \meta{SNN}, \meta{Affix}, \meta{Alternate name(s)}) into non-breaking spaces. You get no bad breaks when using |\KeepName\LJWG[von]| \KeepName\LJWG[von]. +% Any spaces between multiple names in each syntactic name component are not affected. \cmd{\KeepAffix} and \cmd{\KeepName} affect all \textsf{nameauth} macros that print a name in the text.\medskip % % \DescribeMacro{\DropAffix} % Preceding\marginpar{\large\raggedleft\textsf{\bfseries 3.0}\strut} the naming macros with \cmd{\DropAffix} will suppress an affix in a Western name. |\DropAffix\Name*[Oskar]{Hammerstein, II}| produces ``\DropAffix\Name*[Oskar]{Hammerstein, II}.'' This does not affect non-Western names.\medskip % -% One can switch between the macros below without affecting entries in the index. Do, however, strive for consistency.\medskip -% % \DescribeMacro{\ShowComma} -% If you do not want to use the \texttt{comma} option, \cmd{\ShowComma} gets the same results on a per-name basis for Western names while using the default \texttt{nocomma}: -% \begin{center}\small\setstretch{1.1} -% \begin{tabular}{ll}\toprule -% |\Name*[Louis]{Gossett, Jr.}| & \Name*[Louis]{Gossett, Jr.}\\ -% |\ShowComma\Name*[Louis]{Gossett, Jr.}| & \ShowComma\Name*[Louis]{Gossett, Jr.}\\\bottomrule -% \end{tabular} -% \end{center}\medskip -% % \DescribeMacro{\NoComma} -% If you\marginpar{\large\raggedleft\textsf{\bfseries 2.6}\strut} do wish to use the \texttt{comma} option, \cmd{\NoComma} can suppress a comma between the surname and affix on a per-name basis. For example, we alter package internals to simulate the \texttt{comma} option for the two tables below: -% \makeatletter\@nameauth@AlwaysCommatrue\makeatother +% \cmd{\ShowComma} forces a comma between a Western name and its affix. It works like the \texttt{comma} option on a per-name basis, and only in the body text. \cmd{\NoComma}\marginpar{\large\raggedleft\textsf{\bfseries 2.6}\strut} works like the \texttt{nocomma} option on a per-name basis. % \begin{center}\small\setstretch{1.1} -% \begin{tabular}{ll}\toprule -% |\Name*[Louis]{Gossett, Jr.}| & \Name*[Louis]{Gossett, Jr.}\\ -% |\NoComma\Name*[Louis]{Gossett, Jr.}| & \NoComma\Name*[Louis]{Gossett, Jr.}\\\bottomrule -% \end{tabular} -% \end{center} -% -% This might be useful when making a comma-reversed form (Section~\ref{sec:LastFirst}) under the \texttt{comma} option, where you do not want the form \meta{SNN}|,| \meta{affix}|,| \meta{FNN}: -% \begin{center}\footnotesize\setstretch{1.1} -% \begin{tabular}{ll}\toprule -% |\RevComma\Name*[Louis]{Gossett, Jr.}| & \RevComma\Name*[Louis]{Gossett, Jr.}\\ +% \begin{tabular}{@{}ll@{}}\toprule +% |\ShowComma\Name*[Louis]{Gossett, Jr.}| & \ShowComma\Name*[Louis]{Gossett, Jr.}\\ +% |\NoComma\Name*[Louis]{Gossett, Jr.}| & \NoComma\Name*[Louis]{Gossett, Jr.}\\ +% |\RevComma\ShowComma\Name*[Louis]{Gossett, Jr.}| & \RevComma\ShowComma\Name*[Louis]{Gossett, Jr.}\\ % |\RevComma\NoComma\Name*[Louis]{Gossett, Jr.}| & \RevComma\NoComma\Name*[Louis]{Gossett, Jr.}\\\bottomrule % \end{tabular} % \end{center} -% \makeatletter\@nameauth@AlwaysCommafalse\makeatother +% +% {\medskip\noindent\hbox{}\hfill\large Back to Section~\ref{sec:RefTables} \hfill\hbox{}} +% \clearpage % % \subsubsection{Eastern Names} % \label{sec:Eastern} % -% The\marginpar{\small\raggedleft non-native} \textsf{nameauth} package offers ``non-native'' and ``native'' ways to handle romanized Eastern names. The ``non-native'' form really is a Western name (and it is indexed as such) that is made to look Eastern in the body text: +% The\marginpar{\small\raggedleft non-native} \textsf{nameauth} package offers ``non-native'' and ``native'' ways to handle romanized Eastern names. The ``non-native'' form is entered as a Western name and it is indexed as such. \cmd{\RevName} reverses its order in the body text: % \begin{quote}\small -% \cmd{\RevName}\cmd{\Name*}\oarg{Eastern FNN}\marg{Eastern SNN}\oarg{Alternate names} +% \cmd{\RevName}\cmd{\Name*}\oarg{FNN}\marg{SNN}\oarg{Alternate names} % \end{quote} -% The index entry of this name form looks like \meta{SNN}, \meta{FNN} (including the comma). This type of entry is a Western form. Pick non-native Eastern names when you need to have Western name forms in the index entries.\medskip +% The index entry of this name form looks like \meta{SNN}, \meta{FNN} (including the comma). This type of entry is a Western form. Pick this form especially when using Hungarian names, although apologies are due from this author for needing to enter these names in reverse.\medskip % -% In\marginpar{\small\raggedleft native} contrast, there are two general forms of syntax for ``native'' Eastern name forms, which are indexed as such and appear in Eastern name order in the body text. The new syntax permits alternate names; the old does not: +% In\marginpar{\small\raggedleft native} contrast, there are two general forms of syntax for ``native'' Eastern name forms, which are indexed as such and appear in Eastern name order in the body text. Apologies are due for using the \meta{SNN} and \meta{FNN} nomenclature for Eastern family and personal names, but human speech has its limitations. The new syntax permits alternate names; the old does not: % \begin{quote}\small\setstretch{1.1} -% \cmd{\Name}\marg{Eastern SNN, Eastern FNN}\\ -% \cmd{\Name}\marg{Eastern SNN, Eastern FNN}\oarg{Alternate names}\\ -% \cmd{\Name}\marg{Eastern SNN}\oarg{Eastern FNN} (old syntax) +% \cmd{\Name}\marg{SNN, FNN}\oarg{Alternate names}\hfill (new syntax)\\ +% \cmd{\Name}\marg{SNN}\oarg{FNN}\hfill (older syntax) % \end{quote} % The index entry of this name form looks like \meta{SNN} \meta{FNN} (no comma). This type of entry bears similarity with ancient and medieval forms. Pick native Eastern names when you want to use Eastern forms in the index.\medskip % @@ -1316,7 +1455,7 @@ Running "make install" installs the files in the local TeX tree. % \begin{tabular}{rll}\toprule % & \emph{unchanged} & |\RevName|\\\midrule % |\LKonoe| & \LKonoe\dag & \RevName\LKonoe\dag\\ -% |\LKonoe[Minister]| & \LKonoe[Minister]\dag & \meta{not appropriate}\\ +% |\LKonoe[Prime Minister]| & \LKonoe[Prime Minister]\dag & \meta{not appropriate}\\ % |\Konoe| & \Konoe\dag & \RevName\Konoe\dag\\ % |\SKonoe| & \SKonoe\dag & \RevName\SKonoe\dag\\\midrule % |\LYamt| & \LYamt & \RevName\LYamt\\ @@ -1327,7 +1466,7 @@ Running "make install" installs the files in the local TeX tree. % \end{tabular} % \end{center} % -% Creating\marginpar{\large\raggedleft\textsf{\bfseries 3.0}\strut} ``last-comma-first'' listings by surname (Section~\ref{sec:LastFirst}) only makes sense with Western names and maybe non-native Eastern names, but not with native Eastern names or ancient forms. That is why native Eastern forms and ancient forms are unaffected by the commatized form of reversing. +% Creating\marginpar{\large\raggedleft\textsf{\bfseries 3.0}\strut} ``last-comma-first'' listings by surname (Section~\ref{sec:LastFirst}) only makes sense with Western names and maybe non-native Eastern names, but not with native Eastern names or ancient forms. That is why native Eastern forms and ancient forms are unaffected by the comma form of reversing. % % Please\marginpar{\small\raggedleft\cmd{\global}} note that \cmd{\ReverseActive} and \cmd{\ReverseInactive} can be used explicitly as a pair. They also can be used singly within an explicit scope, where the effects cease after leaving that scope. Use \cmd{\global} to force a global effect. % \clearpage @@ -1340,40 +1479,41 @@ Running "make install" installs the files in the local TeX tree. % % Both\marginpar{\small\raggedleft\cmd{\global}} \cmd{\AllCapsActive} and \cmd{\AllCapsInactive} have the same local restrictions as the other state-changing macros. Use \cmd{\global} to force a global effect. % -% In the example below, names in Western order, then non-native Eastern order are marked with a dagger ({\dag}). All other names are in native Eastern, then Western order. Old-syntax forms have a double dagger(\ddag): +% In the example below, names in Western order, then non-native Eastern order are marked with a dagger ({\dag}). All other names are in native Eastern, then Western order. Older-syntax forms have a double dagger(\ddag): % -% \begin{center}\small\setstretch{1.1} +% \begin{center}\small\setstretch{1.1}\AllCapsActive % \begin{tabular}{lll}\toprule -% & \emph{unchanged} & |\CapName\RevName|\\\midrule +% & |\CapName| only & |\CapName\RevName|\\\midrule % |\Name*[Yoko]{Kanno}| & \CapName\Name*[Yoko]{Kanno}\dag & \CapName\RevName\Name*[Yoko]{Kanno}\dag\\ -% |\Name*{Arai, Akino}| & \CapName\Name*{Arai, Akino} & \CapName\RevName\Name*{Arai, Akino}\\ +% |\Name*{Arai, Akino}| & \Name*{Arai, Akino} & \RevName\Name*{Arai, Akino}\\ % |\Name*{Ishida}[Yoko]| & \CapName\Name*{Ishida}[Yoko]\ddag & \CapName\RevName\Name*{Ishida}[Yoko]\ddag\\ -% |\Name*{Yohko}| & \CapName\Name*{Yohko} & \CapName\RevName\Name*{Yohko}\\\bottomrule -% \end{tabular} +% |\Name*{Yohko}| & \Name*{Yohko} & \RevName\Name*{Yohko}\\\bottomrule +% \end{tabular}\AllCapsInactive % \end{center}\smallskip % -% Capitalization and reversing precede post-processing. The reversing and capitalization macros also work with \cmd{\AKA}. They affect only the text, not the index. For caps in the text and index see Sections~\ref{sec:nonenglish} and~\ref{sec:Hooksc}. +% Capitalization and reversing precede post-processing. The reversing and capitalization macros also work with \cmd{\AKA}. They affect only the text, not the index. For caps in the text and index see Sections~\ref{sec:altformat} and~\ref{sec:Hooksc}. +% +% {\medskip\noindent\hbox{}\hfill\large Back to Section~\ref{sec:RefTables} \hfill\hbox{}} % % \subsubsection{Initials} % % Omit spaces between initials if possible; see also Bringhurst's \emph{Elements of Typographic Style}. If your publisher wants spaces between initials, try putting thin spaces |\,| between them. Use \cmd{\PretagName} to get the correct index sorting:\bigskip % -% \leavevmode\begin{minipage}[c]{0.4\textwidth}\footnotesize\setstretch{1.1} -% |\PretagName[E.\,B.]{White}%|\\ -% | {White, E. B.}|\\ +% \leavevmode\begin{minipage}[c]{0.55\textwidth}\footnotesize\setstretch{1.1} +% |\PretagName[E.\,B.]{White}{White, E. B.}|\\ % |\begin{nameauth}|\\ % | \< White & E.\,B. & White & >|\\ % |\end{nameauth}| % \end{minipage} -% \begin{minipage}[c]{0.42\textwidth}\footnotesize +% \begin{minipage}[c]{0.35\textwidth}\footnotesize % \def\sep{\vrule width0.5pt\kern-0.5pt}% -% \begin{tabular}{ll}\hline -% & \hphantom{E.}\sep\,\sep\hphantom{B.}\sep\hphantom{\ }\sep\hphantom{White}\\ -% \cmd{\White} and \cmd{\LWhite} & \White\\ -% & \hphantom{E.}\sep\,\sep\hphantom{B.}\sep\hphantom{\ }\sep\hphantom{White}\\\hline -% & \hphantom{E.}\sep\ \sep\hphantom{B.}\sep\ \sep\hphantom{White}\\ -% Normal text:\hfill & {E. B. White}\\ -% & \hphantom{E.}\sep\ \sep\hphantom{B.}\sep\ \sep\hphantom{White}\\\hline +% \normalsize\begin{tabular}{@{}ll@{}}\hline +% & \hspace{0.48pt}\hphantom{E.}\sep\,\sep\hphantom{B.}\sep\hphantom{\ }\sep\hphantom{White}\\ +% \cmd{\White} & \hspace{0.48pt}\White\\ +% & \hspace{0.48pt}\hphantom{E.}\sep\,\sep\hphantom{B.}\sep\hphantom{\ }\sep\hphantom{White}\\\hline +% & \sffamily\hphantom{E.}\sep\ \sep\hphantom{B.}\sep\ \sep\hphantom{White}\\ +% Normal text:\hfill & \sffamily E. B. White\\ +% & \sffamily\hphantom{E.}\sep\ \sep\hphantom{B.}\sep\ \sep\hphantom{White}\\\hline % \end{tabular} % \end{minipage} % @@ -1387,7 +1527,7 @@ Running "make install" installs the files in the local TeX tree. % |\end{nameauth}| % \end{quote} % -% One also can fix bad breaks with the \textsf{babel} or \textsf{polyglossia} packages. This moves the solution from ``quick and dirty'' to elegant. We force a bad break: \Name[John]{Strietelmeier}. We can stop that using \textsf{babel}: +% One also can fix bad breaks with the \textsf{babel} or \textsf{polyglossia} packages. This can make the solution more elegant at times. We avoid bad breaks by using \textsf{babel}:\IndexName[John]{Strietelmeier} % \begin{quote}\small\setstretch{1.1} % \newcommand\de[1]{\foreignlanguage{ngerman}{#1}}% % |\newcommand\de[1]{\foreignlanguage{ngerman}{#1}}|\\ @@ -1400,23 +1540,23 @@ Running "make install" installs the files in the local TeX tree. % \DescribeMacro{\ReverseCommaActive} % \DescribeMacro{\ReverseCommaInactive} % \DescribeMacro{\RevComma} -% The reversing macros \cmd{\ReverseCommaActive}, \cmd{\ReverseCommaInactive}, and \cmd{\RevComma}\ let us reorder long Western names (via \cmd{\Name*} and the like). The first two are broad toggles, while the third works on a per-name basis. +% The macros \cmd{\ReverseCommaActive}, \cmd{\ReverseCommaInactive}, and \cmd{\RevComma}\ let us reorder long Western names (via \cmd{\Name*} and the like). The first two are broad toggles, while the third works on a per-name basis. % -% These macros\marginpar{\large\raggedleft\textsf{\bfseries 3.0}\strut} work independently of the reversing macros used with Eastern names. This change allows reversing and commas to work harmoniously with ``native'' Eastern and ancient names: +% These macros\marginpar{\large\raggedleft\textsf{\bfseries 3.0}\strut} do not affect ``native'' Eastern and ancient name forms. Also, see below how long uses are not always first uses: % \begin{center}\small\setstretch{1.1} % \begin{tabular}{lll}\toprule -% \Name*[J.S.]{Mill}[John Stuart] & \RevComma\Name*[J.S.]{Mill}[John Stuart] & OK\\ -% \Name*[Oskar]{Hammerstein, II} & \RevComma\Name*[Oskar]{Hammerstein, II} & OK\\ -% \Name*{John, Eriugena} & \RevComma\Name*{John, Eriugena} & no change\\ -% \Name*{Mao}[Tse-tung] & \RevComma\Name*{Mao}[Tse-tung] & no change\\ -% \Name*{Confucius} & \RevComma\Name*{Confucius} & no change\\\bottomrule +% \ForgetThis\VBuren & \RevComma\LVBuren & OK\\ +% \ForgetThis\Name[Oskar]{Hammerstein, II} & \RevComma\Name*[Oskar]{Hammerstein, II} & OK\\ +% \ForgetThis\Aeth & \RevComma\LAeth & no change\\ +% \ForgetThis\Name{Chiang}[Kai-shek] & \RevComma\Name*{Chiang}[Kai-shek] & no change\\ +% \ForceName\Name{Confucius} & \RevComma\Name{Confucius} & no change\\\bottomrule % \end{tabular} % \end{center} % % Since\marginpar{\large\raggedleft\textsf{\bfseries 3.0}} reversing with commas is independent of ``native'' Eastern and ancient names, we see its effects on ``non-native'' Eastern names: % \begin{center}\small\setstretch{1.1} % \begin{tabular}{rl}\toprule -% |\LKonoe| & \LKonoe\dag\\ +% |\ForgetThis\Konoe| & \ForgetThis\Konoe\dag\\ % |\RevName\LKonoe| & \RevName\LKonoe\dag\\ % |\RevComma\LKonoe| & \RevComma\LKonoe\dag\\\bottomrule % \end{tabular} @@ -1427,30 +1567,20 @@ Running "make install" installs the files in the local TeX tree. % \subsubsection{Particles} % \label{sec:standards} % -% 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}. This subsection deals mainly with accented names in English contexts. +% According to [\hyperlink{Mulvany}{Mulvany}, 165f.] and 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}. To Anglicize \JWG[Johann Wolfgang von] in the text as \LJWG[von], but indexed under ``Goethe, J.W. von,'' we use |\LJWG[von]|. |\Name[Catherine de']{Medici}| should be indexed as ``Medici, Catherine de'\,'' instead of modern ``De~Medici.'' See also Sections~\ref{sec:indexctrl} and especially~\ref{sec:DuBois} for name variants. % -% We\marginpar{\small\raggedleft non-breaking\break spaces} recommend inserting |~| or \cmd{\nobreakspace} between particles and names if the particles are less than three letters. This will keep them from becoming lost because of a bad break. -% \cmd{\CapThis} (below)\marginpar{\large\raggedleft\textsf{\bfseries 3.0}\strut} no longer consumes the space between a single-letter particle and a name. -% -% Some particles look very similar. For example, \emph{L'} and \emph{d'} are two separate glyphs each, while \emph{Ľ} and \emph{ď} are one Unicode glyph each.\medskip +% We\marginpar{\small\raggedleft non-breaking\break spaces} recommend inserting |~| or \cmd{\nobreakspace} between particles and names if the particles are less than three letters. This will keep them from becoming lost because of a bad line break or page break.\footnote{With v.3.0, \cmd{\CapThis} does not eat the space between a single-letter particle and a name.} +% Please remember that some particles look very similar. For example, \emph{L'} and \emph{d'} are two separate glyphs each, while \emph{Ľ} and \emph{ď} are one Unicode glyph each.\medskip % % \DescribeMacro{\CapThis} -% In English, these particles go in the \meta{SNN} field of \cmd{\Name}, \emph{e.g.}, \ForgetName[Walter]{de la Mare}\Name[Walter]{de la Mare}. When the last name with the particle appears at the beginning of a sentence, one must capitalize the particle: -% \begin{quote}\small -% |\CapThis\Name[Walter]{de la Mare} will think it fair.%|\\ -% |\CapThis\Soto\ would agree.|\\[1ex] -% \CapThis\Name[Walter]{de la Mare} will think it fair. \CapThis\Soto\ would agree. +% In English and modern Romance languages, \emph{e.g.}, \ForgetThis\Soto\ shows that these particles go in the \meta{SNN} field of \cmd{\Name}: \Soto. When the particle appears at the beginning of a sentence, one must capitalize it: +% \begin{quote}\small\setstretch{1.1} +% |\CapThis\Soto\ was a famous Spanish explorer in North America.|\\[1ex] +% \CapThis\Soto\ was a famous Spanish explorer in North America. % \end{quote} -% \clearpage % -% The\marginpar{\small\raggedleft\dbend} Continental style for surnames (Sections~\ref{sec:nonenglish} and~\ref{sec:Hooksc}) does not work with \cmd{\CapThis}. Consider the example below or modify the examples from Section~\ref{sec:Hooksc} to implement an alternate method of capitalization. -% \begin{center}\footnotesize\setstretch{1.1} -% \begin{tabular}{rl}\toprule -% |\Name[Catherine]{\textsc{de'~Medici}}| & \Name[Catherine]{\textsc{de'~Medici}}\\\midrule -% |\textsc{De'~Medici}%|\\ -% |\IndexName[Catherine]{\textsc{de'~Medici}}| & \textsc{De'~Medici}\IndexName[Catherine]{\textsc{de'~Medici}}\\\bottomrule -% \end{tabular} -% \end{center} +% \cmd{\CapThis}\marginpar{\large\raggedleft\textsf{\bfseries 3.1}\strut} will not cause errors if one uses the \texttt{altformat} option and the provided macros for Continental surname formats. Otherwise it could cause errors in some cases where control sequences in the macro arguments conflict with the capitalization process. See Section~\ref{sec:altformat}. +% \clearpage % % \DescribeMacro{\AccentCapThis} % If the source files\marginpar{\large\raggedleft\textsf{\bfseries 3.0}\strut} for the \textsf{nameauth} package have Unicode encoding and run on a Unicode-compliant system, \cmd{\AccentCapThis} is not necessary. See also page~\pageref{page:CapRoot}. If the text encoding of the source files is changed or there are system encoding issues, \cmd{\AccentCapThis} might be needed with NFSS when the first name character is an active Unicode character. See also Section \ref{sec:Unicode}.\medskip @@ -1460,19 +1590,39 @@ Running "make install" installs the files in the local TeX tree. % |\PretagName{Thomas, à~Kempis}{Thomas a Kempis}|\hfill\emph{medieval}\\ % |\PretagName[Thomas]{à~Kempis}{Thomas a Kempis}|\hfill\emph{Western}\\ % |\begin{nameauth}|\\[0.2ex] -% | \< KempMed & & Thomas, à~Kempis & >|\hfill\emph{medieval}\\ -% | \< KempW & Thomas & à~Kempis & >|\hfill\emph{Western}\\ +% | \< KempMed & & Thomas, à~Kempis & >|\hfill\emph{medieval, new syntax}\\ +% | \< KempAlt & & Thomas & à~Kempis >|\hfill\emph{medieval, older syntax}\\ +% | \< KempW & Thomas & à~Kempis & >|\hfill\emph{Western}\\ % |\end{nameauth}| % \end{quote} -% The medieval forms \KempMed\ and \KempMed\ use the particle as the first part of an affix. Please do not confuse the medieval forms with the Western forms. Otherwise you will get similar names with different index entries.\footnote{Properly speaking, ``à~Kempis'' and ``Aquinas'' are not surnames but suffixed place names. They create different index entries from Western names and look different in the text.} +% The medieval forms\marginpar{\large\raggedleft\textsf{\bfseries 3.1}\strut} are \KempMed\ and \KempMed, indexed as ``Thomas à~Kempis.'' The suffixed place name ``à~Kempis'' (Latin for \emph{von Kempen}) is used by some as a surname: \ForceFN\SKempMed. We use |\ForceFN\SKempMed| to get that form. \CapThis\ForceFN\SKempMed\ can start a sentence via |\CapThis\ForceFN\SKempMed|. The old syntax works just as well: \CapThis\ForceFN\SKempAlt\ occurs via |\CapThis\ForceFN\SKempAlt|. % -% {\IndexInactive Many people still use medieval affixes as Western surnames: |\CapThis\KempW| displays \SubvertName[Thomas]{à~Kempis}``\CapThis\KempW.''\footnote{Ethnocentric treatment of names still occurs in academic literature. This is due to simplicity in work flow or conformity to name authorities. The \textsf{nameauth} package accommodates that, even if the package author finds such practices to be culturally insensitive.}} -% The publisher's way of handling names may differ from the standard way. This package allows for such variations. Yet some publishers have problems with some name forms.\footnote{An example of a true error is the index entry ``Yat-sen, Sun'' (as if Sun were a forename) in Immanuel Geiss, \emph{Personen: Die biographische Dimension der Weltgeschichte}, Geschichte Griffbereit vol. 2 (Munich: Wissen Media Verlag, 2002), 720. Still, the six-volume set is good.} -% Developing a good rapport with the publisher will help you apply this package to the company's style.\medskip +% Western forms\marginpar{\small\raggedleft\dbend} like |\KempW|: \SkipIndex\KempW\ are different from medieval forms and create different index entries. |\CapThis\KempW| gives ``\SkipIndex\CapThis\KempW'' in the text and ``à~Kempis, Thomas'' in the index, which we suppress here.\footnote{Name variants result from work flow constraints, name authorities, and publisher styles. This package works with that, over against this author's plea for cultural sensitivity.} +% The publisher's way of handling names may differ from the standard way. This package allows for such variations.\footnote{Yet some publishers have problems with some name forms. An example of a true error is the index entry ``Yat-sen, Sun'' (as if Sun were a forename) in Immanuel Geiss, \emph{Personen: Die biographische Dimension der Weltgeschichte}, Geschichte Griffbereit vol. 2 (Munich: Wissen Media Verlag, 2002), 720. Still, the six-volume set is a helpful reference work.} +% Developing a good rapport with the publisher and the editor will help you apply this package to the company's style.\medskip % -% If\marginpar{\small\raggedleft Alternates} the \textsf{nameauth} package is not used with UTF-8 encoding under NFSS or with \texttt{xelatex}/\texttt{lualatex}, the package still will work. Instead use control sequences, like |\Name[Thomas]{\`a~Kempis}|. +% Using \cmd{\CapThis}\marginpar{\small\raggedleft Alternates} with a form like |\SubvertThis\ForceFN\FName{Thomas,| |\`a~Kempis}| only works in NFSS: \CapThis\SkipIndex\SubvertThis\ForceFN\FName{Thomas, \`a~Kempis}. It fails with \texttt{xelatex} and \texttt{lualatex} because \textsf{inputenc} is not compatible with \textsf{fontspec}. +% +% \begingroup +% \makeatletter\renewcommand*\NamesFormat[1]{\begingroup\ignorespaces% +% \protected@edef\temp{\endgroup{\color{naviolet}\sffamily #1 %\ignorespaces +% \noexpand\NameQueryInfo[\unexpanded\expandafter{\the\@nameauth@toksa}] +% {\unexpanded\expandafter{\the\@nameauth@toksb}} +% [\unexpanded\expandafter{\the\@nameauth@toksc}]}}\temp}\makeatother% +% Non-English\marginpar{\small\raggedleft\dbend} contexts do not necessarily bind particles to surnames. One can use the alternate names fields or ``text tags'' and ``index tags.'' See also Sections~\ref{sec:indextag}, \ref{sec:tagtext}, and~\ref{sec:Hooksb}. The macros below allow us to show \Name{Friedrich, I}, \Name*{Friedrich, I}, and \Name{Friedrich, I} via |\Name{Friedrich, I}|: +% \begin{quote}\footnotesize\setstretch{1.1} +% |\NameAddInfo{Friedrich, I}{Barbarossa}|\\ +% |\PretagName{Friedrich, I}{Friedrich 1}|\\ +% |\TagName{Friedrich, I}{ Barbarossa, emperor|\texttt{\textbar}|hyperpage}|\\[1ex] +% |\makeatletter\renewcommand*\NamesFormat[1]{\begingroup%|\\ +% |\protected@edef\temp{\endgroup{\color{naviolet}\sffamily #1 %|\\ +% |\noexpand\NameQueryInfo[\unexpanded\expandafter{\the\@nameauth@toksa}]|\\ +% |{\unexpanded\expandafter{\the\@nameauth@toksb}}|\\ +% |[\unexpanded\expandafter{\the\@nameauth@toksc}]}}\temp}\makeatother| +% \end{quote} +% \endgroup % -% Non-English contexts do not necessarily bind particles to surnames. Using \cmd{\Name} and \cmd{\FName} with alternate forenames helps address this and may skirt the particle capitalization issue. See also Section~\ref{sec:PatRef}. +% {\noindent\hbox{}\hfill\large Back to Section~\ref{sec:RefTables} \hfill\hbox{}} % \clearpage % % \subsubsection{Accented Names} @@ -1480,129 +1630,85 @@ Running "make install" installs the files in the local TeX tree. % % For names that contain accented characters, using \texttt{xelatex} or \texttt{lualatex} with \texttt{xindy} (\texttt{texindy}) is recommended. See also Section~\ref{sec:engines}. % -% In NFSS,\marginpar{\small\raggedleft\dbend} accented characters are active. Especially when using \texttt{makeindex}, use \cmd{\PretagName} for all names with active Unicode characters (Sections~\ref{sec:IndexSort} and~\ref{sec:Unicode}). These active characters differ from the control sequences you type: -% \begin{quote}\small\setstretch{1.1} -% \ForgetName{Æthelred, II}% -% |\Name[Johann]{Andre\"a}|\hfill {\IndexInactive\Name[Johann]{Andre\"a}}\\ -% |\Name[Johann]{Andreä}|\hfill \Name[Johann]{Andreä} instead of \Name[Johann]{Andreä}\\ -% |\Name{\AE thelred, II}|\hfill {\IndexInactive\Name{\AE thelred, II}}\\ -% |\Name{Æthelred, II}|\hfill \Name{Æthelred, II} instead of \Name{Æthelred, II} -% \end{quote} -% -% See Section~\ref{sec:Unicode} on how to add additional Unicode glyphs to the default set under NFSS, \textsf{inputenc}, and \textsf{fontenc}. One may use expandable control sequences in names (thanks \Name*[Robert]{Schlicht}). Also, you can use \cmd{\edef} and \cmd{\noexpand} in names (Section~\ref{sec:Hooksc}, thanks \Name[Patrick]{Cousot}). -% -% \subsubsection{Non-English Format} -% \label{sec:nonenglish} -% -% See\marginpar{\small\raggedleft Continental\\ small caps} Sections~\ref{sec:formatting} and~\ref{sec:Hooksc} in addition to this section. We place this section here because it has a language-based element. -% -% By default, name post-processing only affects the text. Also by default, you cannot post-process Continental formatting because it occurs in both the text and the index via control sequences in the \textsf{nameauth} macro arguments. That usually requires \cmd{\PretagName} for index sorting (Section~\ref{sec:IndexSort}). Section ~\ref{sec:Hooksc} explains how to implement post-processing via \cmd{\noexpand} and other steps. +% In NFSS,\marginpar{\small\raggedleft\dbend} many Unicode characters are active. Especially with \texttt{makeindex}, use \cmd{\PretagName} to sort all names with active characters (Sections~\ref{sec:IndexSort} and~\ref{sec:Unicode}). +% \ForgetName{Æthelred, II} +% These active characters differ from explicit control sequences that one might type. We suppress unwanted index entries below among the names that truly are different, yet look the same. +% \begin{itemize}\small +% \item |\Name{Æthelred, II}| creates \Name{Æthelred, II} and \Name{Æthelred, II}. Now we have a different name: |\Name{\AE thelred, II}| \SkipIndex\Name{\AE thelred, II} (a ``first reference''). +% \item |\Name{Bo\"ethius}| \Name{Bo\"ethius} is not the same as |\Name{Boëthius}| \SkipIndex\Name{Boëthius}. Both differ from |\Name{\textsf{Boëthius}}| \SkipIndex\Name{\textsf{Boëthius}}. +% \end{itemize} % -% Here we have a very basic attempt at Continental formatting of the surname in both the body text and the index. One cannot alter this formatting: -% \begin{quote}\small\setstretch{1.1} -% \indent|\PretagName[Greta]{\textsc{Garbo}}{Garbo, Greta}|\\ -% \indent|\Name[Greta]{\textsc{Garbo}}| -% \end{quote} -% You get \Name[Greta]{\textsc{Garbo}}, then \Name[Greta]{\textsc{Garbo}}\,---\,even in the front matter. In order to get an unformatted reference to the name ``Garbo,''\IndexName[Greta]{\textsc{Garbo}} one must type something like |``Garbo''\IndexName[Greta]{\textsc{Garbo}}.| +% See Section~\ref{sec:Unicode} on how to add additional Unicode glyphs to the default set under NFSS, \textsf{inputenc}, and \textsf{fontenc}. % -% As with accented names, different control sequences produce different names. |\Name[\normalfont{Greta}]{\textsc{Garbo}}| looks exactly like name above, but it has a different index entry and different first/subsequent uses. +% {\medskip\noindent\hbox{}\hfill\large Back to Section~\ref{sec:RefTables} \hfill\hbox{}} % -% A comma delimiter will split the macro argument into a root and an affix. To avoid an error regarding unbalanced braces, format the name and suffix separately. A suffixed Western name with Continental formatting looks like: -% \begin{quote}\small\setstretch{1.1} -% |\PretagName[Thurston]{\textsc{Howell},\textsc{III}}%|\\ -% | {Howell, Thurston 3}|\\ -% |\begin{nameauth}|\\ -% | \< Howell & Thurston & \textsc{Howell},\textsc{III} & >|\\ -% |\end{nameauth}| -% \end{quote} -% \cmd{\Howell} generates \Howell, then \Howell. The old syntax cannot be used with \LHowell. -% \clearpage -% -% For Eastern names we have a related example that uses both the new syntax and the old syntax: -% \begin{quote}\small\setstretch{1.1} -% |\PretagName{\uppercase{Fukuyama}}[Takeshi]{Fukuyama Takeshi}|\\ -% |\begin{nameauth}|\\ -% | \< Fukuyama & & \uppercase{Fukuyama}, Takeshi & >|\\ -% | \< OFukuyama & & \uppercase{Fukuyama} & Takeshi >|\\ -% |\end{nameauth}| -% \end{quote} -% \begin{center}\small\setstretch{1.1} -% \begin{tabular}{rl}\toprule -% |\Fukuyama| & \Fukuyama\\ -% |\OFukuyama| & \OFukuyama\\ -% |\LOFukuyama| & \LOFukuyama\\ -% |\Fukuyama| & \Fukuyama\\\bottomrule -% \end{tabular} -% \end{center} -% The old syntax and new syntax inter-operate. The built-in capitalization macros will not work here. For an alternate solution, see Section~\ref{sec:Hooksc}. +% \subsection{Formatting} % -% \subsection{Spaces and Punctuation} +% \subsubsection{Spaces \& Full Stops} % \label{sec:tolerance} % -% The \textsf{nameauth} package protects against some typing errors. Adding extra spaces \emph{normally} does not produce unique names. The simplified interface also is fault-tolerant with spaces. The variations below illustrate this point: +% The \textsf{nameauth} package is forgiving with spaces; extra spaces usually do not create unique names, as we see below: % % \begin{center}\small\setstretch{1.1}\ForgetName[Martin Luther]{King, Jr.} % \begin{tabular}{ll}\toprule % \textit{Macro Example} & \textit{Resulting Text}\\\midrule -% |\Name*[Martin Luther]{King, Jr.}| & \Name*[Martin Luther]{King, Jr.}\\ -% \cmd{\Name*}\texttt{[\textvisiblespace\textvisiblespace Martin Luther]\{\textvisiblespace\textvisiblespace King, Jr.\}} & \Name*[ Martin Luther]{ King, Jr.}\\ -% \cmd{\Name*}\texttt{[Martin Luther\textvisiblespace\textvisiblespace]\{King, Jr.\textvisiblespace\textvisiblespace\}} & \Name*[Martin Luther ]{King, Jr. }\\ -% \cmd{\Name*}\texttt{[\textvisiblespace Martin Luther\textvisiblespace]\{\textvisiblespace King, Jr.\textvisiblespace\}} & \Name*[ Martin Luther ]{ King, Jr. }\\ -% \cmd{\Name*}\texttt{[Martin\textvisiblespace\textvisiblespace\textvisiblespace Luther]\{King\textvisiblespace,\textvisiblespace\textvisiblespace Jr.\}} & \Name*[Martin Luther]{King , Jr.}\\\bottomrule +% |\Name*[Martin Luther]{King,Jr.}| & \Name*[Martin Luther]{King,Jr.}\\ +% \cmd{\Name*}\texttt{[\textvisiblespace\textvisiblespace Martin\textvisiblespace\textvisiblespace Luther\textvisiblespace\textvisiblespace]\{\textvisiblespace\textvisiblespace King,\textvisiblespace\textvisiblespace Jr.\textvisiblespace\textvisiblespace\}} & \Name*[ Martin Luther ]{ King, Jr. }\\\bottomrule % \end{tabular} % \end{center} % -% In Western names, affixes like ``Jr.'' (junior), ``Sr.'' (senior), ``d.\,J.'' (\textit{der J\"ungere}), and ``d.\,\"A.'' (\textit{der \"Altere}) can collide with the full stop in a sentence. \cmd{\Name}, \cmd{\FName}, and \cmd{\AKA} detect this in the printed form of a name and gobble the subsequent full stop as needed: +% In Western names, affixes like ``Jr.'' (junior), ``Sr.'' (senior), ``d.\,J.'' (\textit{der J\"ungere}), and ``d.\,\"A.'' (\textit{der \"Altere}) can collide with the full stop in a sentence and produce two of them. \cmd{\Name}, \cmd{\FName}, and \cmd{\AKA} detect this in the printed form of a name and gobble the subsequent full stop as needed: % % \begin{center}\footnotesize\setstretch{1.1}\ForgetName[Martin Luther]{King, Jr.} -% \begin{tabular}{r@{\hbox to 1em{\hfil}}c@{\hbox to 1em{\hfil}}l}\toprule -% \textit{Macro Example\hfill} & \textit{periods} & \textit{Resulting Text}\\\midrule -% |\Name[Martin Luther]{King, Jr.}.| & $2\rightarrow1$ & \Name[Martin Luther]{King, Jr.}.\\ -% |\Name[Martin Luther]{King, Jr.}.| & $2\rightarrow1$ & \Name[Martin Luther]{King, Jr.}.\\ -% |\Name[Martin Luther]{King, Jr.}|\texttt{\textvisiblespace} & $1\rightarrow0$ & \Name[Martin Luther]{King, Jr.}\\ -% |\Name*[Martin Luther]{King, Jr.}.| & $2\rightarrow1$ & \Name*[Martin Luther]{King, Jr.}.\\ -% |\Name*[Martin Luther]{King, Jr.}|\texttt{\textvisiblespace} & $1\rightarrow1$ & \Name*[Martin Luther]{King, Jr.}\\\bottomrule +% \begin{tabular}{rcl}\toprule +% \textit{Macro Example\hfill} & \textit{Result} & \textit{Resulting Text}\\\midrule +% |\Name [Martin Luther]{King, Jr.}.| & gobbled & \Name [Martin Luther]{King, Jr.}.\\ +% |\Name [Martin Luther]{King, Jr.}.| & stayed & \Name [Martin Luther]{King, Jr.}.\\ +% |\Name*[Martin Luther]{King, Jr.}.| & gobbled & \Name*[Martin Luther]{King, Jr.}.\\ +% |\DropAffix\Name*[Martin Luther]{King, Jr.}.| & stayed & \DropAffix\Name*[Martin Luther]{King, Jr.}.\\ +% |\FName[Martin Luther]{King, Jr.}[M.L.]|. & gobbled & \FName[Martin Luther]{King, Jr.}[M.L.]\\\bottomrule % \end{tabular} % \end{center} -% Grouping tokens can frustrate this: |{\Name*[Martin Luther]{King, Jr.}}.| produces ``{\Name*[Martin Luther]{King, Jr.}}.'' (two periods). Enclosing |{Jr.}| within braces or a macro will do the same. If you must format the affix, leave the period outside: |\Name[Martin Luther]{\textsc{King}, \textsc{Jr}.}| Cf. Section~\ref{sec:nonenglish}. -% \clearpage +% Grouping tokens can prevent this: |{\Name*[Martin Luther]{King, Jr.}}.| produces ``{\Name*[Martin Luther]{King, Jr.}}.'' We see two periods. Enclosing |{Jr.}| within braces or making the whole suffix a macro argument will do the same. Leave the final period outside the macro or group: +%\begin{quote} +%\indent{\small|\Name[Martin Luther]{\textSC{King}, \textSC{Jr}.}|} +% \end{quote} +% Compare Sections~\ref{sec:altformat} and~\ref{sec:Hooksc}. % -% \subsection{Formatting in the Text} +% \subsubsection{Formatting in the Text} % \label{sec:formatting} % -% There are two kinds of formatting at work: +% There are two kinds of formatting at work that interact with each other: % \begin{enumerate}\small -% \item \textbf{Syntactic Formatting:} The default includes reversing and capitalizing macros. Otherwise one must embed control sequences in name arguments. -% \item \textbf{Name Post-Processing:} The hook macros apply formatting to the final form that a name takes in the text. +% \item \textbf{Syntactic Formatting:} Displayed name elements, reversing, and caps normally occur only in the body text, not the index. +% \item \textbf{Name Post-Processing:} Hook macros apply formatting to the printed form of a name, which normally does not affect the name form. % \end{enumerate} % % \DescribeMacro{\NamesFormat} % \DescribeMacro{\FrontNamesFormat} % \DescribeMacro{\MainNameHook} % \DescribeMacro{\FrontNameHook} -% The\marginpar{\large\raggedleft\textsf{\bfseries 2.5}\strut} -% ``main-matter'' and ``front-matter'' systems are independent systems of formatting and first/subsequent name use. The main-matter system uses \cmd{\NamesFormat} to post-process first occurrences of names and \cmd{\MainNameHook} for subsequent uses. The front-matter system uses \cmd{\FrontNamesFormat} for first occurrences of names and \cmd{\FrontNameHook} for subsequent uses. The \texttt{alwaysformat} option causes every name to be formatted with the ``first-use'' hooks. +% Independent\marginpar{\large\raggedleft\textsf{\bfseries 2.5}\strut} +% ``main-matter'' and ``front-matter'' systems format first and subsequent name uses. The main-matter system uses \cmd{\NamesFormat} to post-process first occurrences of names and \cmd{\MainNameHook} for subsequent uses. The front-matter system uses \cmd{\FrontNamesFormat} for first occurrences and \cmd{\FrontNameHook} for subsequent uses. The \texttt{alwaysformat} option causes only \cmd{\NamesFormat} and \cmd{\FrontNamesFormat} to be used. Section~\ref{sec:tweaks} show how the name reference systems are independent of other data sets in \textsf{nameauth}.\medskip % % \DescribeMacro{\NamesActive} % \DescribeMacro{\NamesInactive} -% Using the \texttt{frontmatter} option or \cmd{\NamesInactive} causes the naming macros to use the front matter formatting hook until \cmd{\NamesActive} switches the macros to the independent main matter formatting hooks. Additionally, two independent systems of names are created: front-matter names and main-matter names. +% \cmd{\NamesInactive} and the \texttt{frontmatter} option make names use the front matter system. \cmd{\NamesActive} switches names to the main matter system. % -% Please\marginpar{\small\raggedleft\cmd{\global}} note that these two macros can be used explicitly as a pair. They also can be used singly within an explicit scope, where the effects cease after leaving that scope. Use \cmd{\global} to force a global effect. +% Please\marginpar{\small\raggedleft\cmd{\global}} note that these two macros can be used explicitly as a pair. They also can be used singly within an explicit scope, where the effects cease after leaving that scope. Use \cmd{\global} to force a global effect.\medskip % -% By default, these two systems of names differ only between recognition of first and subsequent uses. We change the first-use formatting hooks in this section to show a greater distinction: +% These two systems differ only with respect to first and subsequent name uses. We show this here by using different colors. At the start of this manual, we set up the following after defining our custom colors: % \begin{quote}\small\setstretch{1.1} -% |\let\OldFormat\NamesFormat|\\ -% |\let\OldFrontFormat\FrontNamesFormat|\\ -% |\renewcommand*\NamesFormat{\scshape}|\\ -% |\renewcommand*\FrontNamesFormat{\bfseries}| +% |\renewcommand*\FrontNamesFormat[1]{\color{nagreen}\sffamily #1}|\\ +% |\renewcommand*\FrontNameHook[1]{\color{naolive}\sffamily #1}|\\ +% |\renewcommand*\NamesFormat[1]{\color{naviolet}\sffamily #1}|\\ +% |\renewcommand*\MainNameHook[1]{\color{naorange}\sffamily #1}| % \end{quote} -% \let\OldFormat\NamesFormat\ignorespaces% -% \let\OldFrontFormat\FrontNamesFormat\ignorespaces% -% \renewcommand*\NamesFormat{\scshape}\ignorespaces% -% \renewcommand*\FrontNamesFormat{\bfseries}\ignorespaces% -% Now we switch to the ``front matter'' mode: +% The two systems are meant to be used in distinct parts of the document, such as front matter and main matter or text and footnotes. The look awkward when used in the same block of text.\medskip +% +% \noindent We switch to the ``front matter'' system: % \begin{quote}\small\setstretch{1.1} -% \NamesInactive\cmd{\NamesInactive}\NamesInactive\\[0.4ex] +% \cmd{\NamesInactive}\NamesInactive\\[0.4ex] % \begin{tabular}{@{}ll} % |\Name[Rudolph]{Carnap}| & \Name[Rudolph]{Carnap}\\ % |\Name[Rudolph]{Carnap}| & \Name[Rudolph]{Carnap}\\ @@ -1610,7 +1716,7 @@ Running "make install" installs the files in the local TeX tree. % |\Name[Nicolas]{Malebranche}| & \Name[Nicolas]{Malebranche}\\ % \end{tabular} % \end{quote} -% Then we switch back to ``main matter'' mode: +% Then we switch back to ``main matter'' system: % \begin{quote}\small\setstretch{1.1} % \cmd{\NamesActive}\NamesActive\\[0.4ex] % \begin{tabular}{@{}ll} @@ -1621,48 +1727,45 @@ Running "make install" installs the files in the local TeX tree. % \end{tabular} % \end{quote} % \clearpage +% \DescribeMacro{\ForceName} +% Use this prefix macro\marginpar{\large\raggedleft\textsf{\bfseries 3.1}\strut} to force ``first use'' formatting for the next \cmd{\Name}, etc. This will not force a full name reference. One must use the \texttt{formatAKA} option when using this with \cmd{\AKA}, etc. We show this macro in Sections~\ref{sec:tweaks}, \ref{sec:AKA}, and~\ref{sec:Hooksb}.\medskip % -% Below\marginpar{\small\raggedleft\dbend} we simulate the \texttt{alwaysformat} option by manipulating the package internals. After the examples, we reset the formatting hooks. +% Below\marginpar{\small\raggedleft \texttt{alwaysformat}} we simulate the \texttt{alwaysformat} option by manipulating the package internals. After the examples, we reset the formatting hooks. % \makeatletter\@nameauth@AlwaysFormattrue\makeatother% -% \ForgetName[Albert]{Einstein}\ForgetName{Confucius}% -% \ForgetName[M.T.]{Cicero}\ForgetName{Charles, the Bald}% +% \ForgetName[M.T.]{Cicero}\ForgetName{Elizabeth, I}% % \begin{itemize} % \item\NamesInactive Using \texttt{alwaysformat} in the front matter will produce: \Name[Albert]{Einstein}, then \Name[Albert]{Einstein}; \Name{Confucius}, then \Name{Confucius}. -% \item \global\NamesActive Using \texttt{alwaysformat} in the main matter will produce: \Name[M.T.]{Cicero}[Marcus Tullius], then \Name[M.T.]{Cicero}[Marcus Tullius]; \Name{Charles, the Bald}, then \Name{Charles, the Bald}. +% \item \global\NamesActive Using \texttt{alwaysformat} in the main matter will produce: \Name[M.T.]{Cicero}[Marcus Tullius], then \Name[M.T.]{Cicero}[Marcus Tullius]; \Name{Elizabeth, I}, then \Name{Elizabeth, I}. % \end{itemize} % \makeatletter\@nameauth@AlwaysFormatfalse\makeatother % -% Basic\marginpar{\small\raggedleft\dbend} formatting changes can take either the font switch forms or the font command forms. The following also work: +% Basic formatting changes can take either the font switch forms or the font command forms. The following are equivalent: % \begin{quote}\small\setstretch{1.1} -% |\renewcommand*\NamesFormat{\textsc}|\\ +% |\renewcommand*\NamesFormat{\bfseries}|\\ % |\renewcommand*\FrontNamesFormat{\textbf}| % \end{quote} -% That is because the formatting hooks are called in such a manner that lets them either have one argument or not and keeps their changes local via: -% \begin{quote}\small\setstretch{1.1} -% \cmd{\bgroup}\meta{Hook}|{#1}|\cmd{\egroup} -% \end{quote} +% The hooks are called in a way that lets them either have one argument or none and keeps changes local via: \cmd{\bgroup}\meta{Hook}|{#1}|\cmd{\egroup}\medskip % -% The\marginpar{\small\raggedleft\dbend} previous examples illustrate the independent systems or ``species'' of names. This is most useful when you want to format names one way in the regular body text but another way somewhere else. In footnotes, for example, we could locally redefine \cmd{\NamesFormat} to create custom formatting: +% The\marginpar{\small\raggedleft applied to\break footnotes\break\dbend} previous examples illustrate the independent systems or ``species'' of names. This is most useful when you want to format names one way in the regular body text but another way somewhere else. In footnotes, for example, we could locally redefine \cmd{\NamesFormat} to create custom formatting: % \begin{quote}\small\setstretch{1.1} % |\makeatletter|\\ -% |\let\@oldfntext\@makefntext|\\ +% |\let\@oldfntext\@makefntext|\hfill|% restore this later|\\ % |\long\def\@makefntext#1{%|\\ -% | \renewcommand*\NamesFormat{\itshape}\@oldfntext{#1}}|\\ -% |\let\@makefntext\@oldfntext% just in case|\\ +% | \renewcommand*\NamesFormat{\color{naviolet}\scshape}%|\\ +% | \@oldfntext{#1}}|\\ % |\makeatother| % \end{quote} % \makeatletter\ignorespaces% % \let\@oldfntext\@makefntext% -% \long\def\@makefntext#1{\renewcommand*\NamesFormat{\itshape}\@oldfntext{#1}}% +% \long\def\@makefntext#1{\renewcommand*\NamesFormat{\color{naviolet}\scshape}\@oldfntext{#1}}% % \makeatother% % -% The problem above is that \Name[John Maynard]{Keynes} in the text affects formatting in the footnotes.\footnote{You get the name \cmd{\Name}\texttt{[John Maynard]\{Keynes\}} \Name[John Maynard]{Keynes} instead of \cmd{\ForgetName}\texttt{[John Maynard]\{Keynes\}}\cmd{\Name}\texttt{[John Maynard]\{Keynes\}} \ForgetName[John Maynard]{Keynes}\Name[John Maynard]{Keynes}.} -% Using \cmd{\ForgetName} to address this can be tedious. +% The problem above is that \Name[John Maynard]{Keynes} in the text affects formatting in the footnotes.\footnote{You get \Name[John Maynard]{Keynes} from \cmd{\Name}\texttt{[John Maynard]\{Keynes\}} instead of \ForgetThis\Name[John Maynard]{Keynes}.} +% In this case, the subsequent-use hook \cmd{\MainNameHook} is called because the name already occurred in the text. % -% A different, simpler solution uses the front-matter system: +% Using the front-matter system to manage names in the footnotes independently of those in the body text may be the easiest and most robust solution: % \begin{quote}\small\setstretch{1.1} % |\makeatletter|\\ -% |\let\@oldfntext\@makefntext|\\ % |\long\def\@makefntext#1{%|\\ % | \NamesInactive\@oldfntext{#1}\NamesActive%|\\ % |}\makeatother| @@ -1670,104 +1773,278 @@ Running "make install" installs the files in the local TeX tree. % \makeatletter\ignorespaces% % \long\def\@makefntext#1{\NamesInactive\@oldfntext{#1}\NamesActive}% % \makeatother% -% Your footnotes do not affect the main body text now.\footnote{We have \Name[John Maynard]{Keynes}, then \Name[John Maynard]{Keynes}.} -% We change footnotes back to normal and restore the formatting hooks with the following: +% Your footnotes do not affect the main body text now.\footnote{We have the expected \Name[John Maynard]{Keynes}, then \Name[John Maynard]{Keynes}.} +% Nevertheless, you can synchronize the two naming systems if needed or manipulate them independently; see Section~\ref{sec:tweaks}. Now we change footnotes back to normal, either with \cmd{\let} or with scoping and groups: % \begin{quote}\small\setstretch{1.1} -% |\makeatletter%|\\ -% |\let\@makefntext\@oldfntext%|\\ -% |\makeatother|\\[1ex] -% |\let\NamesFormat\OldFormat|\\ -% |\let\FrontNamesFormat\OldFrontFormat| +% |\makeatletter|\\ +% |\let\@makefntext\@oldfntext|\\ +% |\makeatother| +% \end{quote} +% \makeatletter\let\@makefntext\@oldfntext\makeatother% +% +% {\noindent\hbox{}\hfill\large Back to Section~\ref{sec:RefTables} \hfill\hbox{}} +% +% \subsubsection{Alternate Format} +% \label{sec:altformat} +% \begingroup\AltFormatActive +% +% \begin{center}\bfseries Basic Features\end{center} +% Name post-processing in the formatting hooks (Section~\ref{sec:formatting}) only affects the text. Continental formatting occurs in both the text and in the index. Therefore you need to use control sequences in the naming macro arguments. +% +%Section~\ref{sec:accents} showed us that changing a control sequence will change a name, even if one cannot see the difference. Those changes must be consistent in the index to avoid spurious entries. Here is how we address that. +% +% We use \cmd{\AltFormatActive}\marginpar{\large\raggedleft\textsf{\bfseries 3.1}\strut} at the start of this section to enable alternate formatting and switch it ``on.'' We begin with basic examples that do not change. We then move to advanced features that allow change in the text. +% +% If made the \meta{SNN} argument of a name macro,\marginpar{\small\raggedleft how to break stuff\break\dbend} |\textsc{a Name, Problem}| will cause an error due to using commas as suffix delimiters. We fix that by using: |\textsc{a Name}, \textsc{Problem}|. +% +% \cmd{\CapThis} still can break |\textsc{a Name}, \textsc{Problem}| under the normal formatting regime. Alternate formatting prevents this by suppressing the normal effects of \cmd{\CapThis}. +% +% Previous methods to get Continental formatting still should work. Simply use the \texttt{altformat} option or \cmd{\AltFormatActive} to add protection against \cmd{\CapThis}.\medskip +% +% \DescribeMacro{\AltFormatActive} +% Both the \texttt{altformat} option and \cmd{\AltFormatActive} globally enable alternate formatting and switch the formatting macros ``on.'' This causes \cmd{\CapThis} only to work via \cmd{\AltCaps}.\medskip +% +% \DescribeMacro{\AltFormatActive*} +% When one wants to enable alternate formatting but keep the formatting macros in the ``off'' state, use the starred form \cmd{\AltFormatActive*}. It can change the effects of both the \texttt{altformat} option and \cmd{\AltFormatActive}. It causes \cmd{\CapThis} only to work via \cmd{\AltCaps}.\medskip +% +% \DescribeMacro{\AltFormatInactive} +% When one needs to switch alternate formatting ``off'' and deactivate its mechanism, use \cmd{\AltFormatInactive} to revert globally to standard formatting and the normal function of \cmd{\CapThis}. +% \begin{center}\small +% \begin{tabular}{lcc}\toprule +% & Enabled & Switched ``On''\\\midrule +% \cmd{\AltFormatActive} & \YES & \YES\\ +% \cmd{\AltFormatActive*} & \YES & \NO\\ +% \cmd{\AltFormatInactive} & \NO & \NO\\\bottomrule +% \end{tabular} +% \end{center} +% +% \DescribeMacro{\textSC} +% \DescribeMacro{\textIT} +% \DescribeMacro{\textBF} +% \DescribeMacro{\textUC} +% Continental formatting can be as simple as using the short macro \cmd{\textSC}. Three other macros also implement alternate formatting. These macros make changes only when alternate formatting is active. We sort the index entry and demonstrate the formatting activated by \cmd{\AltFormatActive}. +% \begin{quote}\small\setstretch{1.1} +% |\PretagName[Greta]{\textSC{Garbo}}{Garbo, Greta}|\\ +% |\PretagName[Ada]{\textIT{Lovelace}}{Lovelace, Ada}|\\ +% |\PretagName[Charles]{\textBF{Babbage}}{Babbage, Charles}|\\ +% |\PretagName{\textUC{Tokugawa}, Ieyasu}{Tokugawa Ieyasu}| % \end{quote} -% \makeatletter\ignorespaces% -% \let\@makefntext\@oldfntext% -% \makeatother% -% \let\NamesFormat\OldFormat% -% \let\FrontNamesFormat\OldFrontFormat% +% \clearpage +% \begin{quote}\small\setstretch{1.1} +% |\Name[Greta]{\textSC{Garbo}}|\dotfill \Name[Greta]{\textSC{Garbo}}; \Name[Greta]{\textSC{Garbo}}\\ +% |\Name[Ada]{\textIT{Lovelace}}|\dotfill \Name[Ada]{\textIT{Lovelace}}; \Name[Ada]{\textIT{Lovelace}}\\ +% |\Name[Charles]{\textBF{Babbage}}|\dotfill \Name[Charles]{\textBF{Babbage}}; \Name[Charles]{\textBF{Babbage}}\\ +% |\Name{\textUC{Tokugawa}, Ieyasu}|\dotfill \Name{\textUC{Tokugawa}, Ieyasu}; \Name{\textUC{Tokugawa}, Ieyasu} +% \end{quote} +% +% Formatting\marginpar{\small\raggedleft\dbend} also occurs in the index using this method. Any time that a naming macro writes to the index, the flags that control these formatting macros must be in the same state, or else you will get spurious index entries. +% +% A comma\marginpar{\small\raggedleft comma karma} delimiter splits the mandatory macro argument into a root and an affix. To avoid errors, format the name and suffix separately. The example below gives us \JRIII, then \JRIII. +% \begin{quote}\footnotesize\setstretch{1.1} +% |\PretagName[John David]{\textSC{Rockefeller},\textSC{III}}%|\\ +% | {Rockefeller, John David 3}|\\ +% |\begin{nameauth}|\\ +% | \< JRIII & John David & \textSC{Rockefeller},\textSC{III} & >|\\ +% |\end{nameauth}| +% \end{quote} +% +% For non-Western names, the new syntax and the older syntax produce the same control sequence that identifies names. Again we are careful to avoid putting the comma delimiter within a container macro. +% \begin{quote}\small\setstretch{1.1} +% |\PretagName{\textUC{Fukuyama}}[Takeshi]{Fukuyama Takeshi}|\\ +% |\begin{nameauth}|\\ +% | \< Fukuyama & & \textUC{Fukuyama}, Takeshi & >|\\ +% | \< OFukuyama & & \textUC{Fukuyama} & Takeshi >|\\ +% |\end{nameauth}| +% \end{quote} +% \begin{center}\small\setstretch{1.1} +% \begin{tabular}{rl}\toprule +% |\Fukuyama| & \Fukuyama\\ +% |\OFukuyama| & \OFukuyama\\ +% |\LOFukuyama| & \LOFukuyama\\ +% |\Fukuyama| & \Fukuyama\\\bottomrule +% \end{tabular} +% \end{center} +% +% Only the new syntax allows alternate names to be used in the text. Thus, |\LFukuyama[Sensei]| \LFukuyama[Sensei] wrote \emph{Nihon Fukuin R\=uteru Ky\=okai Shi} in 1954, after studying in the US in the 1930s. The old syntax |\LOFukuyama[Sensei]| yields \LOFukuyama[Sensei]. +% +% \begin{center}\bfseries Advanced Features\end{center} +% A more complex version of alternate formatting allows us to make format changes in the text while keeping format consistent in the index. We use \cmd{\textSC}, \cmd{\textIT}, \cmd{\textBF}, and \cmd{\textUC} with \cmd{\noexpand} and special triggering macros. Using \cmd{\noexpand} is crucial because we do not want to have the macros expand at the wrong time, giving us the wrong results. Thus: +% \begin{quote}\small\setstretch{1.1} +% |\Name[Martin]{\textSC{Luther}}|\hfill \emph{basic}\\ +% |\Name[Martin]{\noexpand\textSC{Luther}}|\hfill \emph{advanced} +% \end{quote} +% +% \renewcommand*\MainNameHook{\color{naorange}\sffamily\AltOff} +% Remember |\textsc{a Name}, \textsc{Problem}|? With a little work adding the alternate formatting macros and \cmd{\noexpand} we get: +% \begin{quote}\footnotesize\setstretch{1.1} +% |\noexpand\textSC{\noexpand\AltCaps{a}| |Name},| |\noexpand\textSC{Problem}}| +% \end{quote} +% With an additional change to the formatting hooks, whenever alternate formatting is active, the naming macros will avoid \SkipIndex\Name{\noexpand\textSC{\noexpand\AltCaps{a} Name}, \noexpand\textSC{Problem}}. \SkipIndex\CapThis\Name*{\noexpand\textSC{\noexpand\AltCaps{a} Name}, \noexpand\textSC{Problem}} will not occur even with \cmd{\CapThis} and \SkipIndex\Name{\noexpand\textSC{\noexpand\AltCaps{a} Name}, \noexpand\textSC{Problem}} will work just fine. We suppressed the index entries that would have been created here. +% +%The macros below work together for advanced alternate formatting. +% \begin{enumerate}\small +% \item The macro\DescribeMacro{\AltOff}\ \cmd{\AltOff} does nothing except when called in a formatting hook, where it ``switches off'' alternate formatting. When that happens, \cmd{\textSC}, \cmd{\textBF}, \cmd{\textIT}, and \cmd{\textUC} do nothing. This macro works with the \texttt{altformat} option and when \cmd{\AltFormatActive} has been called. +% +% \item The macro\DescribeMacro{\AltOn}\ \cmd{\AltOon} does nothing except when called in a formatting hook, where it ``switches on'' alternate formatting. When that happens, \cmd{\textSC}, \cmd{\textBF}, \cmd{\textIT}, and \cmd{\textUC} perform their changes. This macro works when \cmd{\AltFormatActive*} has been called. +% +% \item Using \cmd{\noexpand} is the golden key (\emph{clavis aurea}) that lets us expand formatting changes only when desired. It enables this kind of formatting hook, which we must implement: +% \begin{quote}\small +% |\renewcommand*\MainNameHook{\AltOff}| +% \end{quote} +% \item Since\DescribeMacro{\AltCaps}\ the normal effects of \cmd{\CapThis} are disabled \cmd{\AltCaps} provides an alternate means to this end. It capitalizes its argument in braces |{| |}| when it is used in a macro hook and triggered by \cmd{\CapThis}. +% \end{enumerate} +% +% Since we used \cmd{\AltFormatActive} in this section it has triggered formatting by default. We only need to change \cmd{\MainNameHook} and \cmd{\FrontNameHook} because we want to have formatting in first uses but suppress it in subsequent uses. Below we match the style of this manual with the redesign of the formatting hooks and we include a sample text: +% \begin{quote}\small\setstretch{1.1} +% |\renewcommand*\MainNameHook[1]%|\\ +% | {\color{naorange}\sffamily\AltOff}|\medskip +% +% With the 500th anniversary of the Reformation in 2017, studies should focus both on the life of \Luth\ and on the social, religious, and political factors of the time that influenced \Luth. +% \end{quote} +% +% We show alternate formatting and capitalization in the text, here being mindful of how medieval Italian differs from modern Italian: +% \begin{quote}\small\setstretch{1.1} +% |\begin{nameauth}|\\ +% | \< Cath & Catherine \noexpand\AltCaps{d}e'|\\ +% | & \noexpand\textSC{Medici} & >|\\ +% |\end{nameauth}|\medskip +% +%This gives us \Cath\ and \Cath. To get either \ForceName\CapThis\LCath[\noexpand\AltCaps{d}e'] or \CapThis\LCath[\noexpand\AltCaps{d}e'], use |\CapThis\LCath[\noexpand\AltCaps{d}e']|. +% \end{quote} +% +% Sections~\ref{sec:formatting} and~\ref{sec:Hooksc} have more on these topics, especially the use of \cmd{\NameParser}. We return to normal formatting with \cmd{\AltFormatInactive} and ensure that no names in the alternate regime are used elsewhere. +% \AltFormatInactive\endgroup +% +% {\medskip\noindent\hbox{}\hfill\large Back to Section~\ref{sec:RefTables} \hfill\hbox{}} % \clearpage % % \subsection{Indexing Macros} % -% Current\marginpar{\large\raggedleft\textsf{\bfseries 3.0}\strut} versions of \textsf{nameauth} offer greater flexibility with indexing but still implement some error protection. We cover the indexing macros here because the later macros in this manual build on many of their concepts. +% Current\marginpar{\large\raggedleft\textsf{\bfseries 3.0}\strut} versions of \textsf{nameauth} offer greater flexibility with indexing but still implement some error protection. We cover the indexing macros here because the later macros in this manual build on many of their concepts. Some aspects of indexing go beyond the scope of this package.\footnote{The maintainer of the \textsf{babel} package is working to address issues with Roman page numbers. For \textsf{memoir}, search for ``memoir babel index'' at \url{http://tex.stackexchange.com}.} % % \subsubsection{Indexing Control} -% \label{sec:SectionIndex} +% \label{sec:indexctrl} % % \DescribeMacro{\IndexActive} % \DescribeMacro{\IndexInactive} -% Using the \texttt{noindex} option deactivates the indexing function of this package until \cmd{\IndexActive} occurs. Another macro, \cmd{\IndexInactive}, will deactivate indexing again. These can be used throughout the document. They work differently than \cmd{\ExcludeName} and \cmd{\IncludeName}, which leverage the cross-referencing system. -% \textbf{\cmd{\IndexInactive} also suppresses index sorting and tagging macros.} +% Using the \texttt{noindex} option deactivates the indexing function of this package until \cmd{\IndexActive} occurs. Another macro, \cmd{\IndexInactive}, will deactivate indexing again. These can be used throughout the document. \cmd{\ExcludeName} and \cmd{\IncludeName} do not deactivate indexing, but they leverage the cross-referencing system to prevent page entries. % % Please\marginpar{\small\raggedleft\cmd{\global}} note that these two macros can be used explicitly as a pair. They also can be used singly within an explicit scope, where the effects cease after leaving that scope. Use \cmd{\global} to force a global effect. % -% \subsubsection{Indexing and \textsf{babel}} -% \label{sec:babel} -% Using\marginpar{\small\raggedleft \textsf{texindy}} \textsf{babel} with Roman page numbers will put \cmd{\textlatin} in the index entries if one includes a language that does not use the Latin alphabet\,---\,even if the main language does. The \texttt{texindy} program will ignore such references. This issue can affect \textsf{nameauth}. +% \begin{center}\bfseries \cmd{\IndexInactive} suppresses index sorting and tagging macros.\end{center} +% +% \DescribeMacro{\SkipIndex} +% The prefix\marginpar{\large\raggedleft\textsf{\bfseries 3.1}\strut} macro \cmd{\SkipIndex} will suppress indexing for just one instance of a naming or cross-referencing macro. It will not alter name forms or formatting. For example, |\SkipIndex\Name[Monty]{Python}| produces \SkipIndex\Name[Monty]{Python} in the text with no index entry. The same thing again yields \SkipIndex\Name[Monty]{Python}. Both \cmd{\IndexName} and \cmd{\IndexRef} ignore \cmd{\SkipIndex} and allow its effect, with other prefix macros, to ``pass through'' to the next naming macro.\medskip +% +% \DescribeMacro{\JustIndex} +% This prefix macro makes \cmd{\Name} and \cmd{\Fname} act just like a call to \cmd{\IndexName} one time only. That means, like \cmd{\IndexName}, the effects of all the other prefix macros will ``pass through'' to the next naming macro. Both \cmd{\AKA} and \cmd{\PName} ignore and reset the flag controlled by this macro. +% +% All the changes made by the prefix macros pass through |\JustIndex\|\meta{$name_1$} to the next instance of \cmd{\Name}, etc., |\|\meta{$name_2$}. This is exactly as if you called \cmd{\IndexName}. This makes |\JustIndex\|\meta{$name_1$}|\SkipIndex\|\meta{$name_2$} equivalent to |\SkipIndex\JustIndex\|\meta{$name_1$}|\|\meta{$name_2$}.\medskip % -% One fairly effective workaround for \texttt{texindy} redefines \cmd{\textlatin} to produce the page number itself within a certain scope like: +% Now we use tricks from Sections~\ref{sec:IndexName}, \ref{sec:IndexXref} and~\ref{sec:tweaks} to modify name forms, formatting, and indexing. Instead of using \cmd{\SkipIndex}, \cmd{\IndexInactive}, and \cmd{\IndexActive}, here we let the name exclusion mechanism protect a name: % \begin{quote}\small\setstretch{1.1} -% |\newcommand\fixindex[1]{\def\textlatin##1{##1}#1}|\\\dots\\ -% |\fixindex{| \meta{paragraphs of running text} |}| +% |\begin{nameauth}|\\ +% | \< Washs & George & Washington's & >|\\ +% |\end{nameauth}|\\ +% |\ExcludeName[George]{Washington's}| % \end{quote} -% Of course, one can opt to check if \cmd{\textlatin} is defined, save its value, redefine it, then restore it, perhaps even in an environment. +% |\Washs| and |\Washs| produce \Washs\ and \Washs, but no index entries. Use |\JustIndex\Wash|\JustIndex\Wash\ as needed. +% +% {\medskip\noindent\hbox{}\hfill\large Back to Section~\ref{sec:RefTables} \hfill\hbox{}} +% \clearpage % % \subsubsection{Index Entries} % \label{sec:IndexName} % % \DescribeMacro{\IndexName} -% The naming macros (\cmd{\Name}, etc.) use this macro to create index entries. Direct use of \cmd{\IndexName} is available also to users. It prints nothing in the body text. The syntax is: +% The naming macros (\cmd{\Name}, etc.) use this macro to create index entries. You can use it too. It prints nothing in the body text. The syntax is: % \begin{quote}\small % \cmd{\IndexName}\oarg{FNN}\marg{SNN}\oarg{Alternate names} % \end{quote} % -% \cmd{\IndexName} complies with the new syntax, where a suffixed pair in \meta{SNN} is a name/affix pair that can be ancient or Eastern. If \meta{FNN} are present, it ignores \meta{Alternate names} for Western and native Eastern name forms. Otherwise, if \meta{FNN} are absent, \cmd{\IndexName} sees \meta{Alternate names} as an affix or Eastern forename using the old syntax. +% \cmd{\IndexName} complies with the new syntax, where a suffixed pair in \meta{SNN} is a name/affix pair that can be ancient or Eastern. If \meta{FNN} are present, it ignores \meta{Alternate names} for Western and native Eastern name forms. If \meta{FNN} are absent, \cmd{\IndexName} sees \meta{Alternate names} as an affix or Eastern forename using the older syntax. % % If used after \cmd{\IndexInactive} this macro does nothing until \cmd{\IndexActive} appears. It will not create index entries for names used as cross-references by \cmd{\IndexRef} and \cmd{\AKA}. This provides a basic level of error protection. % -% 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. +% The indexing mechanism in the \textsf{nameauth} package follows [\hyperlink{Mulvany}{Mulvany}, 152--82] and the \emph{Chicago Manual of Style} regarding Western name affixes. Thus \LChes\ becomes ``Sullenberger, Chesley B., III'' in the index. +% +% To show what gets into the index entries, consider the following example, much of which gets set up only once in the document. +% \begin{quote}\small\setstretch{1.1} +% |\begin{nameauth}|\\ +% | \< Dem & & Demetrius, I & >|\\ +% | \< Harnack & Adolf & Harnack & >|\\ +% | \< JWG & J.W. von & Goethe & >|\\ +% | \< Miyaz & & Miyazaki, Hayao & >|\\ +% |\end{nameauth}| +% \end{quote} +% \begingroup\NameAddInfo{Demetrius, I}{Soter} +% \makeatletter\renewcommand*\NamesFormat[1]{\begingroup\ignorespaces% +% \protected@edef\temp{\endgroup{\color{naviolet}\sffamily #1 %\ignorespaces +% \noexpand\NameQueryInfo[\unexpanded\expandafter{\the\@nameauth@toksa}] +% {\unexpanded\expandafter{\the\@nameauth@toksb}} +% [\unexpanded\expandafter{\the\@nameauth@toksc}]}}\temp}\makeatother% +% We add a text tag as a sobriquet and use the hook from Section~\ref{sec:standards}: +% \begin{quote}\footnotesize\setstretch{1.1} +% |\NameAddInfo{Demetrius, I}{Soter}|\\[1ex] +% |\makeatletter\renewcommand*\NamesFormat[1]{\begingroup%|\\ +% |\protected@edef\temp{\endgroup{\color{naviolet}\sffamily #1 %|\\ +% |\noexpand\NameQueryInfo[\unexpanded\expandafter{\the\@nameauth@toksa}]|\\ +% |{\unexpanded\expandafter{\the\@nameauth@toksb}}|\\ +% |[\unexpanded\expandafter{\the\@nameauth@toksc}]}}\temp}\makeatother| +% \end{quote} +% We also add an index tag: |\TagName{Demetrius, I}{ Soter, king}| and a sort tag: |\PretagName{Demetrius, I}{Demetrius 1}|. +% \begin{center}\footnotesize\setstretch{1.1} +% \begin{tabular}{lll}\toprule +% Text & Source & Index\\\midrule +% \LDem & \cmd{\LDem} & Demetrius I Soter, king\\ +% \LDem & \cmd{\LDem} & Demetrius I Soter, king\\ +% \LHarnack[Adolf von] & \cmd{\LHarnack[Adolf von]} & Harnack, Adolf\\ +% \LHarnack & \cmd{\LHarnack} & Harnack, Adolf\\ +% \LJWG[Joh. Wolfg. v.] & \cmd{\LJWG[Joh. Wolfg. v.]} & Goethe, J.W. von\\ +% \LJWG & \cmd{\LJWG} & Goethe, J.W. von\\ +% \LMiyaz & \cmd{\LMiyaz} & Miyazaki Hayao\\ +% \LMiyaz[Sensei] & \cmd{\LMiyaz[Sensei]} & Miyazaki Hayao\\ +% \end{tabular} +% \end{center} +% Everything in the \meta{FNN} and \meta{SNN} arguments, including the \meta{Affix}, gets in the index. When the final optional argument is interpreted as an alternate name, it does not become part of the index entry. Text tags never get in the index, but index tags always get in the index. +% \endgroup +% \clearpage % % \subsubsection{Index Cross-References} % \label{sec:IndexXref} % % \DescribeMacro{\IndexRef} -% The\marginpar{\large\raggedleft\textsf{\bfseries 3.0}\strut} cross-referencing macros (\cmd{\AKA}, etc.) use this macro. Also available to users, \cmd{\IndexRef} creates a \emph{see} reference by default from the name defined by its first three arguments to whatever one puts in the final argument. The syntax is: +% The\marginpar{\large\raggedleft\textsf{\bfseries 3.0}\strut} cross-referencing macros (\cmd{\AKA}, etc.) use this macro. Also available to users, \cmd{\IndexRef} creates a \emph{see} reference by default from the name defined by its first three arguments to whatever one puts in the final argument. Section~\ref{sec:tweaks} show how cross-references are independent of other data sets. The syntax is: % \begin{quote}\small % \cmd{\IndexRef}\oarg{FNN}\marg{SNN}\oarg{Alternate names}\marg{reference target} % \end{quote} % -% The name used for the cross-reference is parsed in the same way as by \cmd{\IndexName}. The final argument is neither parsed nor checked to see if a corresponding main entry exists. For example, to cross-reference ``Sun King'' with \Name*{Louis, XIV} use: \cmd{\IndexRef}\texttt{\{Sun King\}\{Louis XIV\}}\IndexRef{Sun King}{Louis XIV}. +% The name used for the cross-reference is parsed in the same way as by \cmd{\IndexName}. The final argument is neither parsed nor checked to see if a corresponding main entry exists. For example, to cross-reference ``Sun King'' with \Name*{Louis, XIV} use: \cmd{\IndexRef}\texttt{\{Sun King\}\{Louis XIV\}}\IndexRef{Sun King}{Louis XIV}. To format that reference in the text, use \cmd{\AKA} (Section~\ref{sec:AKA}). % -% {\bfseries You are encouraged to see page~\pageref{page:manualxref} for handling cases of complex cross-references with either \cmd{\AKA} or \cmd{\IndexRef}.}\medskip +% \begin{center}\bfseries Please see page~\pageref{page:manualxref} regarding complex cross-references.\end{center} % % \DescribeMacro{\SeeAlso} % One\marginpar{\large\raggedleft\textsf{\bfseries 3.0}\strut} can precede \cmd{\IndexRef}, \cmd{\AKA}, or \cmd{\PName} with \cmd{\SeeAlso} to produce a \emph{see also} reference for a name that has appeared already in the index.\footnote{When the \texttt{verbose} option is selected, \cmd{\IndexRef} warns that a name once used as a page number entry is now being used as a cross-reference. It also warns when one attempts to redefine or alter an established cross-reference.} % However, this should be used with caution, as the following points indicate: % \begin{itemize}\small -% \item Once a cross-reference is created, that name cannot be used for page number entries. ``Bar\dots 10, \emph{see also} Foo'' means that one cannot have an entry for ``Bar'' after page 10. -% \item The target of a reference, however, remains available. ``Bar\dots 10, \emph{see also} Foo'' means that an entry for ``Foo\dots 12, 13'' is okay. -% \item A \emph{see} reference has no page references before it. ``Bar\dots 10, \emph{see} Foo'' is an invalid index entry. -% \item A \emph{see also} reference appears after extant page references. ``Bar\dots 10, \emph{see also} Foo'' is just fine, but ``Bar\dots 10, \emph{see also} Foo, 11, 14'' is invalid. -% \item Having \emph{see} and \emph{see also} references on different index entry lines is suppressed. One can use \cmd{\IndexRef} to group reference targets in one entry. ``Bar\dots 10, \emph{see also} Foo; Baz'' is better than ``Bar\dots 10, \emph{see also} Foo; \emph{see also} Baz.''\footnote{Professional indexers often use programs like \texttt{cindex} that enforce a rigorous, standard methodology and syntax. The \textsf{nameauth} package likewise tries to follow suit.} +% \item If on page 10 there is |\SeeAlso\IndexRef{Bar}{Foo}|, one \emph{cannot} have index page entries for ``Bar'' thereafter. A \emph{see also} reference comes after page references. +% \item If on page 10 there is |\SeeAlso\IndexRef{Bar}{Foo}|, one \emph{can} have index page entries for ``Foo'' thereafter because it is the target of ``Bar.'' +% \item If on page 10 there is |\Name{Bar}| and on page 12 |\IndexRef{Bar}{Foo}|, that will not work because \emph{see} references cannot contain page references. +% \item Suggestion: Group references together: |\IndexRef{Bar}{Baz; Foo}|.\\ Avoid |\IndexRef{Bar}{Baz} \IndexRef{Bar}{Foo}|.\footnote{Professional indexers often use programs like \texttt{Cindex} that enforce a rigorous, standard methodology and syntax. The \textsf{nameauth} package likewise tries to follow suit.} % \end{itemize} % -% \cmd{\IndexRef} causes an index tag with the format \meta{some text}\verb+|+\meta{some function} to be reduced to \meta{some text} in the cross-reference. This allows cross-references to work with any index function text used by \cmd{\TagName} (Section~\ref{sec:indextag}).\medskip +% \cmd{\IndexRef} causes an index tag with the format \meta{some text}\verb+|+\meta{some macro} to be reduced to \meta{some text} in the cross-reference. This allows cross-references to work with any index macro, e.g. \texttt{\textbar hyperpage}, used by \cmd{\TagName} (Section~\ref{sec:indextag}).\medskip % % \DescribeMacro{\ExcludeName} -% This\marginpar{\large\raggedleft\textsf{\bfseries 3.0}\strut} macro prevents a name from being used as either an index entry or as an index cross-reference. It can be used at any point in the document. It ignores extant cross-references. The syntax is: +% This\marginpar{\large\raggedleft\textsf{\bfseries 3.0}\strut} macro prevents a name from being used as either an index entry or as an index cross-reference. It ignores extant cross-references. The syntax is: % \begin{quote}\small % \cmd{\ExcludeName}\oarg{FNN}\marg{SNN}\oarg{Alternate names} % \end{quote} % -% For example, you will not see any index references for the following names. We show formatting with \textbf{boldface}: -% \begin{quote}\small\setstretch{1.1}\def\NamesFormat{\bfseries}\ExcludeName[Kris]{Kringle}\ExcludeName[Santa]{Claus} -% |\ExcludeName[Kris]{Kringle}|\\ -% |\Name[Kris]{Kringle}| and |\Name[Kris]{Kringle}|:\\ -% \Name[Kris]{Kringle} and \Name[Kris]{Kringle}. \cmd{\ForgetName} will give us a first-use name again: \ForgetName[Kris]{Kringle}\Name[Kris]{Kringle}, then \Name[Kris]{Kringle}.\\[1ex] -% |\ExcludeName[Santa]{Claus}|\\ -% |\AKA[Kris]{Kringle}[Santa]{Claus}|\\ \AKA[Kris]{Kringle}[Santa]{Claus} (not formatted by \cmd{\AKA}). -% \end{quote} +% After |\ExcludeName[Kris]{Kringle}|\ExcludeName[Kris]{Kringle}, you can use |\Name[Kris]{Kringle}| to get \Name[Kris]{Kringle} and \Name[Kris]{Kringle}. After |\ExcludeName[Santa]{Claus}|\ExcludeName[Santa]{Claus} you can use |\AKA[Kris]{Kringle}[Santa]{Claus}| \AKA[Kris]{Kringle}[Santa]{Claus}. No index entries are created. % % This can be used to prevent references in the index after you are done with a name. Unlike \cmd{\IndexInactive} and \cmd{\IndexActive} this macro does not suspend the indexing system, but only works on a per-name basis. +% \clearpage % % \DescribeMacro{\IncludeName} % \DescribeMacro{\IncludeName*} @@ -1776,24 +2053,25 @@ Running "make install" installs the files in the local TeX tree. % \cmd{\IncludeName\ }\oarg{FNN}\marg{SNN}\oarg{Alternate names}\\ % \cmd{\IncludeName*}\oarg{FNN}\marg{SNN}\oarg{Alternate names} % \end{quote} -% The unstarred form of \cmd{\IncludeName} only removes the exclusion placed on a page-number entry by \cmd{\ExcludeName}. The starred form of \cmd{\IncludeName} makes the \textsf{nameauth} macros forget about both an exclusion and a cross-reference. +% The unstarred form of \cmd{\IncludeName} only removes an exclusion created by \cmd{\ExcludeName}. The starred form of \cmd{\IncludeName} completely unprotects a cross-reference and allows it to have a page entry like a name. % -% For example, we used |\ExcludeName{Attila, the Hun}| after his appearance in Section~\ref{sec:simplestart}. Using \cmd{\IfAKA} from Section~\ref{sec:tests} tells us that, ``\IfAKA{Attila, the Hun}{Attila is a cross-reference}{Attila is a name}{Attila is excluded}.'' -% Now if we |\IncludeName{Attila, the Hun}|\IncludeName{Attila, the Hun}, a reference to \Name{Attila, the Hun} will create an index entry on this page. \cmd{\IfAKA} now tells us that, ``\IfAKA{Attila, the Hun}{Attila is a cross-reference}{Attila is a name}{Attila is excluded}.'' +% For example, we used |\ExcludeName{Attila, the Hun}| after his appearance in Section~\ref{sec:simplestart}. Using \cmd{\IfAKA\{Attila, the Hun\}} (Section~\ref{sec:tests}) tells us that, ``\IfAKA{Attila, the Hun}{Attila is a cross-reference}{Attila is a name}{Attila is excluded}.'' +% Now if we |\IncludeName{Attila, the Hun}|\IncludeName{Attila, the Hun}, a reference to |\LAttil| will create a name and an index entry on this page: \LAttil. \cmd{\IfAKA} now tells us that ``\IfAKA{Attila, the Hun}{Attila is a cross-reference}{Attila is a name}{Attila is excluded}.'' % -% In similar fashion, using \cmd{\IfAKA} on the cross-reference ``Jay Rockefeller'' that we created in Section~\ref{sec:simplestart} tells us that ``\IfAKA[Jay]{Rockefeller}{Jay is a cross-reference}{Jay is a name}{Jay is excluded}.'' If we use the unstarred form |\IncludeName[Jay]{Rockefeller}|\IncludeName[Jay]{Rockefeller}, we still get ``\IfAKA[Jay]{Rockefeller}{Jay is a cross-reference}{Jay is a name}{Jay is excluded}.'' Nothing happened because cross-references are given extra protection. Yet |\IncludeName*[Jay]{Rockefeller}|\IncludeName*[Jay]{Rockefeller} produces ``\IfAKA[Jay]{Rockefeller}{Jay is a cross-reference}{Jay is a name}{Jay is excluded}.'' -% Now all protection of ``Jay Rockefeller'' is removed and we can do anything to it. +% Cross-references get more protection. \cmd{\IfAKA[Jay]\{Rockefeller\}} (a reference in a footnote from Section~\ref{sec:simplestart}) tells us that ``\IfAKA[Jay]{Rockefeller}{Jay is a cross-reference}{Jay is a name}{Jay is excluded}.'' Using |\IncludeName[Jay]{Rockefeller}|\IncludeName[Jay]{Rockefeller} changes nothing: we still get ``\IfAKA[Jay]{Rockefeller}{Jay is a cross-reference}{Jay is a name}{Jay is excluded}.'' |\IncludeName*[Jay]{Rockefeller}|\IncludeName*[Jay]{Rockefeller} results in ``\IfAKA[Jay]{Rockefeller}{Jay is a cross-reference}{Jay is a name}{Jay is excluded},'' removing all protection of that cross-reference. +% +% {\medskip\noindent\hbox{}\hfill\large Back to Section~\ref{sec:RefTables} \hfill\hbox{}} % % \subsubsection{Index Sorting} % \label{sec:IndexSort} % % The general practice for sorting with \texttt{makeindex -s} involves creating your own |.ist| file (pages 659--65 in \emph{The Latex Companion}). Otherwise the following form works with both \texttt{makeindex} and \texttt{texindy}: |\index{|\meta{sort key}|@|\meta{actual}|}| % -% \begin{center}\bfseries Basic Sorting (Makeindex)\end{center} +% \begin{center}\bfseries Basic Sorting (for Makeindex and More)\end{center} % % \DescribeMacro{\PretagName} % \noindent The \marginpar{\large\raggedleft\textsf{\bfseries 2.0}\strut} -% \textsf{nameauth} package integrates this sort of index sorting automatically by using a ``pretag.'' The syntax is: +% \textsf{nameauth} package integrates this sort of index sorting automatically by using a ``pretag.'' Section~\ref{sec:tweaks} show how sorting tags are independent of other data sets in \textsf{nameauth}. The syntax is: % \begin{quote}\small % \cmd{\PretagName}\oarg{FNN}\marg{SNN}\oarg{Alternate names}\marg{tag} % \end{quote} @@ -1804,10 +2082,18 @@ Running "make install" installs the files in the local TeX tree. % |\PretagName[Jan]{Łukasiewicz}{Lukasiewicz, Jan}|\\ % |\PretagName{Æthelred, II}{Aethelred 2}| % \end{quote} -% One need only ``pretag'' names once in the preamble. Every time that one refers to \Name*[Jan]{Łukasiewicz} or \Name*{Æthelred, II}, the proper index entry will be created. If you create a cross-reference with \cmd{\AKA} and you want to ``pretag'' it, see Section~\ref{sec:AKA}. +% +% One need only ``pretag'' names once in the preamble. Every time that one refers to \Name*[Jan]{Łukasiewicz} or \Name*{Æthelred, II}, the proper index entry will be tagged and sorted automatically. +% +% Additionally, one can include sub-entry delimiters when sorting, so \meta{Some Name} can be sorted as a sub-entry of ``MyCategory'' by the following: +% \begin{quote}\small +% |\PretagName[Some]{Name}{MyCategory!Name, Some}| +% \end{quote} +% +% One also can ``pretag'' a cross-reference created with \cmd{\IndexRef}, \cmd{\AKA}, and so on. See also Sections~\ref{sec:IndexXref} and~\ref{sec:AKA}. % \clearpage % -% Although the \cmd{\PretagName} macro might look similar to the the other tagging macros, its use and scope is quite a bit different: +% Although the \cmd{\PretagName} macro might look similar to the the other tagging macros, its use is quite different: % \begin{itemize}\small % \item You can ``pretag'' any name and any cross-reference. % \item You can ``tag'' and ``untag'' only names, not cross-references. @@ -1819,22 +2105,22 @@ Running "make install" installs the files in the local TeX tree. % % \begin{center}\bfseries Extra Spaces and Sorting\end{center} % -% \noindent Under\marginpar{\small\raggedleft\dbend} NFSS, active Unicode characters expand to add one or two spaces after control sequences. See \cmd{\indexentry} and \cmd{\item} entries in your \texttt{idx} and \texttt{ind} files. For example, \texttt{ä} becomes \texttt{\cmd{\IeC\textvisiblespace}\{\cmd{\"a}\}} (one space added) and \texttt{Æ} becomes \texttt{\cmd{\IeC\textvisiblespace}\{\cmd{\AE\textvisiblespace}\}} (two spaces added). +% \noindent Under\marginpar{\small\raggedleft\dbend} NFSS, active Unicode characters expand to add one or two spaces after control sequences. See \cmd{\indexentry} and \cmd{\item} entries in your \texttt{idx} and \texttt{ind} files. For example, \texttt{ä} becomes \texttt{\cmd{\IeC\textvisiblespace}\{\cmd{\"a}\}} (one added space) and \texttt{Æ} becomes \texttt{\cmd{\IeC\textvisiblespace}\{\cmd{\AE\textvisiblespace}\}} (two added spaces). % % Section~\ref{sec:Unicode} shows how this is related to the number of times the active character must be expanded. The character \texttt{Æ} must expand twice, through both \cmd{\IeC} and \cmd{\T1}, while \texttt{ä} expands only once through \cmd{\IeC} to a letter. The character \texttt{ß} (\emph{scharfes Ess, Esszett}) below expands twice. % -% Both \texttt{xelatex} and \texttt{lualatex} (using \textsf{fontspec}) avoid these issues by handling the characters natively. That produces the following: -% \begin{quote}\small\setstretch{1.1} -% NFSS: |\index{Fußball}| $\rightarrow$ \cmd{\indexentry}\ignorespaces% +% Both \texttt{xelatex} and \texttt{lualatex} (using \textsf{fontspec}) avoid these issues by handling the characters natively. Thus we have the following: +% \begin{center}\small +% \begin{tabular}{l@{\,}l@{\,}c@{\,}l} +% NFSS: & |\index{Fußball}| & $\rightarrow$ & \cmd{\indexentry}\ignorespaces% % \texttt{\{Fu\cmd{\IeC\textvisiblespace}\{\cmd{\ss\textvisiblespace}\}ball\}\{}\ignorespaces% -% \meta{page}\texttt{\}} -% -% fontspec: |\index{Fußball}| $\rightarrow$ \cmd{\indexentry}\texttt{\{Fußball\}\{}\meta{page}\texttt{\}} -% -% cseq: |\index{Fu\ss ball}| $\rightarrow$ \cmd{\indexentry}\texttt{\{Fu\cmd{\ss\textvisiblespace}ball\}\{}\meta{page}\texttt{\}} -% \end{quote} +% \meta{page}\texttt{\}}\\ +% fontspec: & |\index{Fußball}| & $\rightarrow$ & \cmd{\indexentry}\texttt{\{Fußball\}\{}\meta{page}\texttt{\}}\\ +% cseq: & |\index{Fu\ss ball}| & $\rightarrow$ & \cmd{\indexentry}\texttt{\{Fu\cmd{\ss\textvisiblespace}ball\}\{}\meta{page}\texttt{\}}\\ +% \end{tabular} +% \end{center} % -% A macro with the general form below, similar to \cmd{\IndexName}, will add two spaces after \emph{other} control sequences that are expanded multiple times. Those spaces only affect index sorting, not appearance. Remember this when using manual index entries with \textsf{nameauth}: +% A macro with the general form below, similar to \cmd{\IndexName}, will add two spaces after \emph{other} control sequences that are expanded multiple times. Those spaces only affect index sorting, not appearance. Remember this when using and modifying manual index entries with \textsf{nameauth}: % \begin{quote}\small\setstretch{1.1} % |\newcommand\IndexExample[1]{%|\\ % \hbox{}\qquad|\protected@edef\argument{#1}\index{\argument}}%| @@ -1858,7 +2144,7 @@ Running "make install" installs the files in the local TeX tree. % | \verbatiminput{\jobname.ind}|\\ % |\fi| % \end{quote} -% \clearpage +% {\noindent\hbox{}\hfill\large Back to Section~\ref{sec:RefTables} \hfill\hbox{}} % % \subsubsection{Index Tags} % \label{sec:indextag} @@ -1869,7 +2155,7 @@ Running "make install" installs the files in the local TeX tree. % \cmd{\TagName}\oarg{FNN}\marg{SNN}\oarg{Alternate names}\marg{tag} % \end{quote} % -% Tags are not ``pretags.'' To help sort that out, we look at what gets affected by these commands: +% Index tags are not ``pretags.'' Section~\ref{sec:tweaks} show how index tags are independent of other data sets in \textsf{nameauth}. To help sort that out, we look at what parts of the argument of \cmd{\index} get affected by these commands: % % \begin{center}\small\setstretch{1.1} % \begin{tabular}{r@{\,\vrule width0.5pt\,}c@{\,\vrule width0.5pt\,}c@{\,\vrule width0.5pt\,}l} @@ -1879,34 +2165,25 @@ Running "make install" installs the files in the local TeX tree. % \end{tabular} % \end{center} % -% All the tagging commands use the name arguments as a reference point. \cmd{\PretagName} generates the leading sort key while \cmd{\TagName} and \cmd{\UntagName} affect the trailing content of the index entry. +% All the tagging commands are keyed to the name arguments. \cmd{\PretagName} generates the leading sort key while \cmd{\TagName} and \cmd{\UntagName} affect the trailing content of the index entry. % -% Tags created by \cmd{\TagName} can be helpful in the indexes of history texts, as can other package features. Below, \cmd{\TagName} causes the \textsf{nameauth} indexing macros to append ``\texttt{,\textvisiblespace pope}'' to the index entries for \Name*{Gregory, I} and \Name*{Leo, I}: -% \begin{center}\small\setstretch{1.1} -% \begin{tabular}{ll} -% |\TagName{Leo, I}{, pope}| & (in the preamble)\\ -% |\TagName{Gregory, I}{, pope}| \\ -% \dots\\ -% |\Name*{Leo, I} was known as| & \Name*{Leo, I} was known as\\ -% |\AKA{Leo, I}{Leo}[the Great].| & \AKA{Leo, I}{Leo}[the Great].\\ -% \dots\\ -% |\Name{Gregory,| |I}| |``\ForceFN%| & \Name{Gregory, I} ``\ForceFN\AKA*{Gregory, I}{Gregory}[the Great],''\\ -% |\AKA*{Gregory,| |I}{Gregory}%| & another pope.\\ -% |[the Great],''| |another| |pope.|\\ -% \end{tabular} -% \end{center} +% Tags created by \cmd{\TagName} can be helpful in the indexes of history texts, as can other package features. \cmd{\TagName} causes the \textsf{nameauth} indexing macros to append ``\texttt{,\textvisiblespace pope}'' to the index entries for the popes below: +% \begin{quote}\small\setstretch{1.1} +% |\TagName{Leo, I}{, pope}|\\ +% |\TagName{Gregory, I}{, pope}| \\[1ex] +% |\Name{Leo, I} was known as \AKA{Leo, I}{Leo, the Great}.|\\ +% |\Name{Gregory, I} was known as \Name{Gregory, I}|\\ +% |``\ForceFN\AKA*{Gregory, I}{Gregory}[the Great].''|\\[1ex] +% \Name{Leo, I} was known as \AKA{Leo, I}{Leo, the Great}.\\ +% \Name{Gregory, I} was known as \Name{Gregory, I} +% ``\ForceFN\AKA*{Gregory, I}{Gregory}[the Great].'' +% \end{quote} % -% Tags are literal text that can be daggers, asterisks, and even specials. For example, all fictional names in the index of this manual are tagged with an asterisk. One must add any desired spacing to the start of the tag. Tagging aids scholarly indexing and can include life/regnal dates and other information. +% We see both the old syntax and the new syntax used above. \cmd{\TagName} works with all name types, but not with cross-references from \cmd{\IndexRef}, etc. Tags are literal text that can be daggers, asterisks, and so on. For example, all fictional names in the index of this manual are tagged with an asterisk. One must add any desired spacing to the start of the tag. Tagging aids scholarly indexing and can include life/regnal dates and other information. % -% \cmd{\TagName} works with all name types, not just medieval names. Back in Section~\ref{sec:start} we had the example of \AKA[J.E.]{Carter, Jr.}[Jimmy]{Carter} (cross-reference in the index). \cmd{\TagName} adds ``\texttt{,\textvisiblespace president}'' to his index entry\IndexName[J.E.]{Carter, Jr.}. +% You\marginpar{\small\raggedleft\dbend} can use the \marg{tag} field of \cmd{\TagName} to add specials to index entries for names. Every name in this manual is tagged with at least \texttt{\textbar hyperpage} to allow hyperlinks in the index with \textsf{ltxdoc} and \textsf{hypdoc}. You may have to use \cmd{\string}\texttt{\textbar hyperpage} where a vertical bar is active, as in \textsf{ltxdoc}. % -% You\marginpar{\small\raggedleft\dbend} can use the \marg{tag} field of \cmd{\TagName} to add ``specials'' to index entries for names. Every name in this manual is tagged with at least \verb!|hyperpage! to allow hyperlinks in the index using the \textsf{ltxdoc} class and \textsf{hypdoc} package. You may have to use \cmd{\string} before \verb!|hyperpage! where a vertical bar is active. For example, the following will produce a special index entry with no page number: -% \begin{quote}\small\setstretch{1.1} -% |\newcommand\orphan[2]{#1}|\\ -% \verb+\TagName{Sine Nomine}{\string|orphan{(Sine Pagina)}}+ -% \end{quote} -% \newcommand\orphan[2]{#1}\TagName{Sine Nomine}{\string|orphan{(Sine Pagina)}}% -% Using |\Name{Sine Nomine}| \Name{Sine Nomine} here will generate this entry in the \texttt{ind} file: |\item Sine Nomine\pfill \orphan{(Sine Pagina)}{29}|. One can use this method to create special index entries via \cmd{\IndexName}, then ``protect'' the names used with \cmd{\ExcludeName} after the entries have been created. +% For example, |\newcommand\orphan[2]{#1}| allows one to use \texttt{\textbar orphan\{}\meta{text}|}| in an index tag to replace the page number with \meta{text}. The \texttt{idx} file will contain |\indexentry{|\meta{name}\texttt{\textbar}|orphan{|\meta{text}|}}{|\meta{page}|}|. The \texttt{ind} file will have something like |\item |\meta{name}|, \orphan{|\meta{text}|}{|\meta{page}|}|, depending on the index style. % \clearpage % % \DescribeMacro{\UntagName} @@ -1918,27 +2195,31 @@ Running "make install" installs the files in the local TeX tree. % By using \cmd{\TagName} and \cmd{\UntagName}, one can disambiguate different people with the same name. For example, using macros from Section~\ref{sec:tweaks}: % % \begin{quote}\small\setstretch{1.1} -% \ttfamily This refers to |\Name[John]{Smith}|.\\ -% Now another |\ForgetName[John]{Smith}%|\\ -% |\TagName[John]{Smith}{ (second)}\Name[John]{Smith}|.\\ -% Then a third |\ForgetName[John]{Smith}%|\\ -% |\TagName[John]{Smith}{ (third)}\Name[John]{Smith}|.\\ -% Then the first |\UntagName[John]{Smith}\Name*[John]{Smith}|. -% -% \normalfont This refers to \Name[John]{Smith}.\\ -% Now another \ForgetName[John]{Smith}\TagName[John]{Smith}{* (second)\string|hyperpage}\Name[John]{Smith}.\\ -% Then a third \ForgetName[John]{Smith}\TagName[John]{Smith}{* (third)\string|hyperpage}\Name[John]{Smith}.\\ -% Then the first \TagName[John]{Smith}{*\string|hyperpage}\Name*[John]{Smith}. +% {\footnotesize\ttfamily This refers to |\Name[John]{Smith}.\\|\\ +% Now we have a new |\TagName[John]{Smith}{ (second)}%|\\ +% | \ForgetThis\Name[John]{Smith}.\\|\\ +% Now we have a third |\TagName[John]{Smith}{ (third)}%|\\ +% | \ForgetThis\Name[John]{Smith}.\\|\\ +% Then back to the first |\UntagName[John]{Smith}\Name*[John]{Smith}|.} +% +% This refers to \Name[John]{Smith}.\\ +% Now we have a new \TagName[John]{Smith}{* (second)\ignorespaces% +% \string|hyperpage}\ForgetThis\Name[John]{Smith}.\\ +% Now we have a third \TagName[John]{Smith}{* (third)\ignorespaces% +% \string|hyperpage}\ForgetThis\Name[John]{Smith}.\\ +% Then back to the first \TagName[John]{Smith}{*\string|hyperpage}\Name*[John]{Smith}. % \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.\footnote{Since this document, unlike the example above, puts an asterisk by all fictional names in the index, it puts an asterisk at the beginning of the tags above and does not \cmd{\UntagName} \Name*[John]{Smith}, but retags him with an asterisk again.} +% The tweaking macros (Section~\ref{sec:tweaks}) make it seem like you are dealing with three people who have the same name. The index tags will group together those entries that have the same tag.\footnote{Since this document, unlike the example above, puts an asterisk by all fictional names in the index, it puts an asterisk at the beginning of the tags above and does not \cmd{\UntagName} \Name*[John]{Smith}, but re-tags him with an asterisk again. We also used \cmd{\string}\texttt{\textbar hyperpage} in all the index tags. The information is not shown above for the sake of simplicity and pedagogy.} +% +% {\medskip\noindent\hbox{}\hfill\large Back to Section~\ref{sec:RefTables} \hfill\hbox{}} % % \subsection{``Text Tags''} % \label{sec:tagtext} % -% Section~\ref{sec:indextag} deals with similar tagging features in the index. ``Text tags'' differ from index tags because they are not printed automatically with every name managed by \textsf{nameauth}. +% Section~\ref{sec:indextag} deals with similar tagging features in the index. ``Text tags'' are not printed automatically with every name managed by \textsf{nameauth}. Section~\ref{sec:tweaks} show how text tags are independent of other data sets. Section~\ref{sec:Hooksb} offers additional examples on using these macros. % -% These ``text tags'' are a name information database. The macros in this section are named accordingly. Section~\ref{sec:Hooksb} offers additional examples.\medskip +% Several major uses include optional sobriquets, life dates, regnal dates, footnotes, biographical vignettes, margin paragraphs, and so on.\medskip % % \DescribeMacro{\NameAddInfo} % Text tags are independent of any other name conditionals, similar to index tags. This \cmd{\long} macro's syntax is: @@ -1946,19 +2227,18 @@ Running "make install" installs the files in the local TeX tree. % \cmd{\NameAddInfo}\oarg{FNN}\marg{SNN}\oarg{Alternate names}\marg{tag} % \end{quote} % -% For example, |\NameAddInfo[George]{Washington}{(1732--99)}|\NameAddInfo[George]{Washington}{(1732--99)} will associate the text ``\NameQueryInfo[George]{Washington}'' with the name ``\LWash.'' Note, however, that the tag does not print automatically with the name.\medskip +% For example, |\NameAddInfo[George]{Washington}{(1732--99)}|\NameAddInfo[George]{Washington}{(1732--99)} will associate the text ``\NameQueryInfo[George]{Washington}'' with the name ``\LWash.'' Note, however, that the tag does not print automatically with the name. +% \clearpage % % \DescribeMacro{\NameQueryInfo} -% To retrieve the information in a text tag, one uses the name as a key to the corresponding information: +% To retrieve the information in a text tag, one uses the name as a key to the corresponding information in the data set: % \begin{quote}\small % \cmd{\NameQueryInfo}\oarg{FNN}\marg{SNN}\oarg{Alternate names} % \end{quote} % \NameAddInfo[Ulysses S.]{Grant}{(president 1869--77)}% % \NameAddInfo[Schuyler]{Colfax}{\footnote{Seventeenth vice-president of the US during the first term (1869--73) of \Name[Ulysses S.]{Grant}~\NameQueryInfo[Ulysses S.]{Grant}.}}% -% Thus, |``\NameQueryInfo[George]{Washington}.''| expands to ``\NameQueryInfo[George]{Washington}.'' As with index tags, one can put a space at the start of a tag\,---\,or not, depending on the use. Sections~\ref{sec:indextag} and~\ref{sec:Hooksa}f. illustrate how this can permit tags like asterisks, daggers, and footnotes, such as one for \Name[Schuyler]{Colfax}.\NameQueryInfo[Schuyler]{Colfax} -% \clearpage +% Thus, |``\NameQueryInfo[George]{Washington}''| expands to ``\NameQueryInfo[George]{Washington}''. As with index tags, one can put a space at the start of a tag\,---\,or not. In text tags one might use asterisks, daggers, and even footnotes, such as one for \Name[Schuyler]{Colfax}.\NameQueryInfo[Schuyler]{Colfax} We can include a ``text tag'' within another one, thus building complex relations. Keeping this in mind, we look at the source for the footnote: % -% The source for the previous example looks like: % \begin{quote}\small\setstretch{1.1} % |\NameAddInfo[Ulysses S.]{Grant}{(president 1869--77)}%|\\ % |\NameAddInfo[Schuyler]{Colfax}%|\\ @@ -1969,45 +2249,21 @@ Running "make install" installs the files in the local TeX tree. % |\Name[Schuyler]{Colfax}.\NameQueryInfo[Schuyler]{Colfax}| % \end{quote} % -% By using these text tag macros with the conditional macros, one can display information associated with a name based on whether or the name has occurred. For the example below, we turn indexing off: -% \begin{quote}\small\IndexInactive -% {\setstretch{1.1}\begin{verbatim} -%\NameAddInfo{Sam} -%{% -% \IfMainName{Freddy}% -% {\Name{Freddy}'s sidekick}% -% {a young gardener with a Midlands accent}% -%} -%There is \Name{Sam}. He is \NameQueryInfo{Sam}. -%Then \Name{Sam} met \Name{Freddy}, who lives% -%with his posh uncle \Name{Bill}. -%Now he is \NameQueryInfo{Sam} on a quest to save the realm. -% \end{verbatim}}\vspace{-2ex} -% \NameAddInfo{Sam}{\IfMainName{Freddy}{\Name{Freddy}'s sidekick}{a young gardener with a Midlands accent}} -% There is \Name{Sam}. He is \NameQueryInfo{Sam}.\\ -% Then \Name{Sam} met \Name{Freddy}, who lives with his posh uncle \Name{Bill}.\\ -% Now he is \NameQueryInfo{Sam} on a quest to save the realm. -% \end{quote} -% % \DescribeMacro{\NameClearInfo} % \cmd{\NameAddInfo} will replace one text tag with another text tag, but it does not delete a text tag. That is the role of \cmd{\NameClearInfo}. The syntax is: % \begin{quote}\small % \cmd{\NameClearInfo}\oarg{FNN}\marg{SNN}\oarg{Alternate names} % \end{quote} % -% For example, |\NameClearInfo[George]{Washington}|\NameClearInfo[George]{Washington} will cause the macro |``\NameQueryInfo[George]{Washington}''| to produce nothing. +% |\NameClearInfo[George]{Washington}|\NameClearInfo[George]{Washington} will cause the next attempt at making a query, |\NameQueryInfo[George]{Washington}|, to produce nothing\NameQueryInfo[George]{Washington}. +% +% {\medskip\noindent\hbox{}\hfill\large Back to Section~\ref{sec:RefTables} \hfill\hbox{}} % % \subsection{Name Decisions} % \subsubsection{Testing Decisions} % \label{sec:tests} % -% The macros in this section permit conditional text that depends on the presence or absence of a name. These macros use \cmd{\If}\textbf{\dots} because they differ from regular |\if| expressions. The following macros affect conditional branching: \cmd{\Name}, \cmd{\Name*}, \cmd{\FName}, \cmd{\PName}, \cmd{\AKA}, \cmd{\AKA*}, \cmd{\ForgetName}, \cmd{\SubvertName}, \cmd{\ExcludeName}, \cmd{\IncludeName}, and \cmd{\IncludeName*}. Uses might include: -% \begin{itemize}\small -% \item a book where one ties information to the first mention of a name, like a ``text tag,'' margin paragraph, mini-bio, footnote, etc. -% \item a game book where you have to pick a game path -% \item a presentation that can change if certain names are present -% \item conditional comments using the \textsf{comment}, \textsf{pdfcomment}, and similar packages -% \end{itemize} +% The macros in this section permit conditional text that depends on the presence or absence of a name. These macros use \cmd{\If}\textbf{\dots} because they differ from regular |\if| expressions. The following macros affect conditional branching: \cmd{\Name}, \cmd{\Name*}, \cmd{\FName}, \cmd{\PName}, \cmd{\AKA}, \cmd{\AKA*}, \cmd{\ForgetName}, \cmd{\SubvertName}, \cmd{\ExcludeName}, \cmd{\IncludeName}, and \cmd{\IncludeName*}. % % If one uses these macros inside other macros or passes control sequences to them, the expansion of control sequences can create false results (see \emph{The \TeX book}, 212--15). To get around those problems, consider using the following: % \begin{itemize}\small @@ -2017,6 +2273,7 @@ Running "make install" installs the files in the local TeX tree. % \end{itemize} % % See Sections~\ref{sec:Hooksb} and~\ref{sec:Hooksc} for related ideas about tokens and expansion. Using \cmd{\tracingmacros}, \cmd{\show}, or \cmd{\meaning} can help you. +% \clearpage % % \DescribeMacro{\IfMainName} % If you want to produce output or perform a task based on whether a ``main body'' name exists, use \cmd{\IfMainName}, whose syntax is: @@ -2025,13 +2282,14 @@ Running "make install" installs the files in the local TeX tree. % \end{quote} % This is a long macro via \cmd{\newcommandx}, so you can have paragraph breaks in the \meta{yes} and \meta{no} paths. A ``main body'' name is capable of being formatted by this package, \emph{i.e.}, one created by the naming macros when the \texttt{mainmatter} option is used or after \cmd{\NamesActive}. It is distinguished from those names that occur in the front matter and those that have been used as cross-references. % -% For example, we get \IndexName[Bob]{Hope}``\IfMainName[Bob]{Hope}{I met Bob}{I have not met Bob}'' from the following example because we have yet to invoke |\Name[Bob]{Hope}|: +% For example, we get ``\IfMainName[Bob]{Hope}{I met Bob}{I have not met Bob}'' because we have yet to invoke the name |\Name[Bob]{Hope}|. We will create a manual index entry here.\IndexName[Bob]{Hope} % \begin{quote}\small % |\IfMainName[Bob]{Hope}{I met Bob}{I have not met Bob}| % \end{quote}% -% Please note that this test is not affected by the use of \cmd{\IndexName}. Since we have encountered \Name*[Johann]{Andreä}, we get ``\IfMainName[Johann]{Andreä}{I met Johann}{I have not met Johann}'' with a similar example: +% Please note that this test is not affected by the use of \cmd{\IndexName}. Since we have encountered \ForgetThis\Name*{Elizabeth, I}, we get ``\IfMainName{Elizabeth, I}{I met Bess}{I have not met Bess}'' with a similar example: % \begin{quote}\small\setstretch{1.1} -% |\IfMainName[Johann]{Andreä}{I met Johann}%|\\| {I have not met Johann}| +% |\IfMainName{Elizabeth, I}{I met Bess}%|\\ +% | {I have not met Bess}| % \end{quote} % % \DescribeMacro{\IfFrontName} @@ -2058,7 +2316,9 @@ Running "make install" installs the files in the local TeX tree. % | {\Name[Rudolph]{Carnap} is only formatted}%|\\ % | {\Name[Rudolph]{Carnap} is not mentioned}}| % \end{quote}% -% Please refer to Sections~\ref{sec:tweaks} and~\ref{sec:LocalNames} to understand the scope and operation of main- and front-matter names.\medskip +% Please refer to Sections~\ref{sec:tweaks} and~\ref{sec:LocalNames} to understand the scope and operation of main- and front-matter names. +% \vfil +% \begin{center}\large This space intentionally left blank.\end{center} % \clearpage % % \DescribeMacro{\IfAKA} @@ -2109,198 +2369,220 @@ Running "make install" installs the files in the local TeX tree. % | {\Name{Grinch} is not an alias}%|\\ % | {\Name{Grinch} is excluded}| % \end{quote} -% \clearpage +% +% By using the text tag macros with the conditional macros, one can display information associated with a name based on whether or the name has occurred. Below we disable indexing with \cmd{\IndexInactive}: +% \begin{quote}\small\IndexInactive +% \begin{verbatim} +%\NameAddInfo{Sam} +%{\IfMainName{Freddy}% +% {\SkipIndex\Name{Freddy's} sidekick}% +% {a young gardener helping his granddad}} +% +%There is \Name{Sam}. He is \NameQueryInfo{Sam}. +%Then \Name{Sam} met \Name{Freddy}, who lives with his uncle. +%Now he is \NameQueryInfo{Sam} on a quest to save the realm. +% \end{verbatim}\vspace{-1ex} +% \NameAddInfo{Sam}{\IfMainName{Freddy}{\SkipIndex\Name{Freddy's} sidekick}{a young gardener helping his granddad}} +% There is \Name{Sam}. He is \NameQueryInfo{Sam}.\\ +% Then \Name{Sam} met \Name{Freddy}, who lives with his uncle.\\ +% Now he is \NameQueryInfo{Sam} on a quest to save the realm. +% \end{quote} +% We use \cmd{\SkipIndex} to prevent the name ``\SkipIndex\Name{Freddy's}'' from making an index entry of its own. See Section~\ref{sec:indexctrl}. Take care to avoid a stack overflow by conditionally nesting tags ``down the rabbit hole.'' +% +% {\medskip\noindent\hbox{}\hfill\large Back to Section~\ref{sec:RefTables} \hfill\hbox{}} % % \subsubsection{Changing Decisions} % \label{sec:tweaks} % -% This section describes macros that change the status of whether a name has occurred. That also helps to avoid clashes between formatted and non-formatted names. They are meant for editing at or near the final draft stage. Cross-reference names created by \cmd{\IndexRef} or \cmd{\AKA} are not affected by these macros.\medskip +% The following summary of macros that can change (not just read) different data sets will help us put this section into better perspective: +% +% \begin{center}\small +% \begin{tabular}{@{}lc@{}c@{}c@{}c@{}c@{}}\toprule[1pt] +% Macro & \footnotesize Names & \footnotesize Xrefs & \footnotesize Sort & \footnotesize Index & \footnotesize Text\\ +% & & & Tag & Tag & Tag\\\midrule +% \cmd{\Name} \cmd{\Name*} \cmd{\FName} & \YES & \NO & \NO & \NO & \NO\\\midrule +% \cmd{\ForgetName} \cmd{\SubvertName} & \YES & \NO & \NO & \NO & \NO\\\midrule +% \cmd{\PName} \cmd{\PName*} & \YES & \YES & \NO & \NO & \NO\\\midrule +% \cmd{\AKA} \cmd{\AKA*} \cmd{\IndexRef} & \NO & \YES & \NO & \NO & \NO\\\midrule +% \cmd{\ExcludeName} & \NO & \YES & \NO & \NO & \NO\\\midrule +% \cmd{\IncludeName} \cmd{\IncludeName*} & \NO & \YES & \NO & \NO & \NO\\\midrule +% \cmd{\PretagName} & \NO & \NO & \YES & \NO & \NO\\\midrule +% \cmd{\TagName} \cmd{\UntagName} & \NO & \NO & \NO & \YES & \NO\\\midrule +% \cmd{\NameAddInfo} \cmd{\NameClearInfo} & \NO & \NO & \NO & \NO & \YES\\\midrule +% \end{tabular} +% \end{center} +% +% The macros in this section force either a first or subsequent use, helpful especially with overlays in the \textsf{beamer} class. They do not affect \cmd{\AKA} and \cmd{\PName}. They always are global with respect to \LaTeX\ scoping rules. +% +% ``Forgetting'' a name not only changes its format, but also its displayed form and its status with decision macros. Sometimes you want all the changes (\textsf{beamer} overlays) and sometimes not (use \cmd{\Name*}, \cmd{\ForceName}, etc.). +% \begin{center}\small +% \begin{tabular}{lccc}\toprule +% \bfseries & \bfseries Name Length & \bfseries Format Hooks & \bfseries Decision\footnotemark[22]\\\midrule +% \bfseries First Use & Always long & First & False\\ +% \bfseries Subsequent Use & Long or short & Subsequent & True\\\bottomrule +% \end{tabular} +% \end{center} +% \footnotetext[22]{Decision outcome prior to the name being used.} +% \addtocounter{footnote}{1} % % \DescribeMacro{\ForgetName} -% This macro is a ``dirty trick'' of sorts that takes the same optional and mandatory arguments used by \cmd{\Name}. It handles its arguments in the same way, except that it ignores the final argument if \meta{FNN} are present. The syntax is: +% This macro takes the same arguments as \cmd{\Name}. It ignores alternate names if \meta{FNN} are present. It ``forgets'' a name, forcing a ``first use'' The syntax is: % \begin{quote}\small % \cmd{\ForgetName}\oarg{FNN}\marg{SNN}\oarg{Alternate names} % \end{quote} -% This macro causes \cmd{\Name} and friends globally to ``forget'' prior uses of a name. The next use of that name will print as if it were a ``first use,'' even if it is not. Index entries and cross-references are \emph{never} forgotten.\medskip +% +% \DescribeMacro{\ForgetThis} +% This mode switch\marginpar{\large\raggedleft\textsf{\bfseries 3.1}} causes the next instance of a naming macro or shorthand to call \cmd{\ForgetName} internally. After knowing |\Einstein| ``\Einstein'' we forget him and again have a first reference: |\ForgetThis\Einstein| ``\ForgetThis\Einstein.''\medskip % % \DescribeMacro{\SubvertName} -% This macro is the opposite of the one above. It takes the same arguments. It handles its arguments in the same manner. The syntax is: +% This macro is the opposing analogue of the macros that we saw above. It ``subverts'' a name, forcing a ``subsequent use.'' The syntax is: % \begin{quote}\small % \cmd{\SubvertName}\oarg{FNN}\marg{SNN}\oarg{Alternate names} % \end{quote} -% This macro causes \cmd{\Name} and friends globally to think that a prior use of a name already has occurred. The next use of that name will print as if it were a ``subsequent use,'' even if it is not. % -% One use for this macro is to get around the first-use safeguards of \cmd{\FName}. To ensure formatting consistency: +% \DescribeMacro{\SubvertThis} +% This mode switch\marginpar{\large\raggedleft\textsf{\bfseries 3.1}} causes the next instance of a naming macro or shorthand to call \cmd{\SubvertName} internally. \cmd{\ForgetThis} takes precedence over \cmd{\SubvertThis}. % \begin{quote}\small\setstretch{1.1} -% \cmd{\SubvertName}\oarg{FNN}\marg{SNN}|%|\\ -% |\makeatletter \@nameauth@FirstFormattrue \makeatother%|\\ -% \cmd{\FName}\oarg{FNN}\marg{SNN}\oarg{Alternate names} +% \begin{tabular}{@{}lll} +% |\SubvertThis\LAnth| & \SubvertThis\LAnth & \emph{forced subsequent use, forced long}\\ +% |\ForceName\SAnth| & \ForceName\SAnth & \emph{subsequent use, forced first format}\\ +% |\ForgetThis\SAnth| & \ForgetThis\SAnth & \emph{forced first use and format}\\ +% |\SAnth| & \SAnth & \emph{subsequent use, short}\\ +% \end{tabular} % \end{quote} +% We met \cmd{\ForceName} back in Section~\ref{sec:formatting}. Here we use it with a subsequent name use to format it as a first use. We will meet \cmd{\ForceName} again in Section~\ref{sec:AKA}.\medskip % -% The default \marginpar{\small\raggedleft Scope} behavior of these two macros changes whether a name is ``forgotten'' or ``subverted'' simultaneously for front matter and main matter names, Remember the example on page~\pageref{page:Carnap} above that gave us the answer, ``\IfFrontName[Rudolph]{Carnap}{\IfMainName[Rudolph]{Carnap}{\Name[Rudolph]{Carnap} is both}{\Name[Rudolph]{Carnap} is only non-formatted}}{\IfMainName[Rudolph]{Carnap}{\Name[Rudolph]{Carnap} is only formatted}{\Name[Rudolph]{Carnap} is not mentioned}}''? Now watch closely: After we use \ForgetName[Rudolph]{Carnap}|\ForgetName[Rudolph]{Carnap}| we get the result: -% ``\IfFrontName[Rudolph]{Carnap}{\IfMainName[Rudolph]{Carnap}{\Name[Rudolph]{Carnap} is both}{\Name[Rudolph]{Carnap} is only non-formatted}}{\IfMainName[Rudolph]{Carnap}{\Name[Rudolph]{Carnap} is only formatted}{\Name[Rudolph]{Carnap} is not mentioned}}.'' Both the main matter name and the front matter name were forgotten! +% By default,\marginpar{\small\raggedleft Naming system\break scope} these macros affect a name form in both front matter and main matter naming systems. The example on page~\pageref{page:Carnap} above gave us the answer, ``\IfFrontName[Rudolph]{Carnap}{\IfMainName[Rudolph]{Carnap}{\Name[Rudolph]{Carnap} is both}{\Name[Rudolph]{Carnap} is only non-formatted}}{\IfMainName[Rudolph]{Carnap}{\Name[Rudolph]{Carnap} is only formatted}{\Name[Rudolph]{Carnap} is not mentioned}}''. After we use \ForgetName[Rudolph]{Carnap}|\ForgetName[Rudolph]{Carnap}| we get the result: +% ``\IfFrontName[Rudolph]{Carnap}{\IfMainName[Rudolph]{Carnap}{\Name[Rudolph]{Carnap} is both}{\Name[Rudolph]{Carnap} is only non-formatted}}{\IfMainName[Rudolph]{Carnap}{\Name[Rudolph]{Carnap} is only formatted}{\Name[Rudolph]{Carnap} is not mentioned}}.'' Both front- and main-matter names were forgotten and now we have a first-use situation. % -% This default behavior helps synchronize formatted and unformatted types of names. For example, if you wanted to use unformatted names in the footnotes and formatted names in the text (Section~\ref{sec:formatting}), you could use, \emph{e.g.} \cmd{\SubvertName} right after the first use of a name in the body text, ensuring that all references in the text and notes would be short unless otherwise modified.\footnote{This manual takes advantage of that behavior at times in order to synchronize first and subsequent uses of names between formatted and unformatted sections of the body text.}\medskip +% This default behavior helps synchronize formatted and unformatted types of names. For example, if you wanted to use unformatted names in the footnotes and formatted names in the text (Section~\ref{sec:formatting}), you could use, \emph{e.g.} \cmd{\SubvertName} right after the first use of a name in the body text, ensuring that all references in the text and notes would be short unless otherwise modified. This manual uses that behavior to synchronize uses of names between formatting systems.\medskip % % \DescribeMacro{\LocalNames} % \DescribeMacro{\GlobalNames} -% If, however, this ``global'' behavior of \cmd{\ForgetName} and \cmd{\SubvertName} is not desired, you can use \cmd{\LocalNames} to change that behavior and \cmd{\GlobalNames} to restore the default behavior. Both of these macros work globally. +% If this default behavior is not desired, \cmd{\LocalNames} restricts the macros above to the current naming system. After \cmd{\LocalNames}, if you are in a ``front matter'' section (the \texttt{frontmatter} option or \cmd{\NamesInactive}) the macros above will affect only names in that section. The same is true if you are in a ``main matter'' section via the \texttt{mainmatter} option or \cmd{\NamesActive}. \cmd{\GlobalNames} restores the default behavior. Remember that this is respective to formatting systems, not document scope! Section~\ref{sec:LocalNames} goes into greater detail on system-level scoping. % -% After \cmd{\LocalNames}, if you are in a ``front matter'' section (the \texttt{frontmatter} option or \cmd{\NamesInactive}) \cmd{\ForgetName} and \cmd{\SubvertName} will only affect unformatted names. If you are in a ``main matter'' section via the \texttt{mainmatter} option or \cmd{\NamesActive}, then \cmd{\ForgetName} and \cmd{\SubvertName} will only affect formatted names. Section~\ref{sec:LocalNames} offers a long example. +% {\medskip\noindent\hbox{}\hfill\large Back to Section~\ref{sec:RefTables} \hfill\hbox{}} % \clearpage % % \subsection{Name Variant Macros} % \label{sec:AKA} % -% The\marginpar{\large\raggedleft\textsf{\bfseries 3.0}} macros in this section are specialized and have a somewhat different syntax than others in this manual. Macros like \cmd{\IndexRef} permit one to avoid them altogether. Yet here they are, if needed.\medskip +% The\marginpar{\large\raggedleft\textsf{\bfseries 3.0}} macros in this section are specialized and have a somewhat different syntax than others in this manual. Macros like \cmd{\IndexRef} permit one to avoid the macros here completely. Yet here they are, if needed.\medskip % % \DescribeMacro{\AKA} % \DescribeMacro{\AKA*} -% \cmd{\AKA} (meaning \textit{also known as}) handles the occasional full-name mention of pseudonyms, stage names, \emph{noms de plume}, and so on. The syntax for \cmd{\AKA} is: +% \cmd{\AKA} (meaning \textit{also known as}) handles the full-name mention of pseudonyms, stage names, \emph{noms de plume}, and so on. The syntax for \cmd{\AKA} is: % \begin{quote}\small\setstretch{1.1} % \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} % Both macros create a cross-reference in the index from the \meta{Alt. FNN}, \meta{Alt. SNN}, and \meta{Alt. names} fields to a target defined by \meta{FNN} and \meta{SNN}, regardless of whether that name exists. -% \textbf{The name order for \cmd{\AKA} is opposite that of \cmd{\IndexRef}.} That is due to the following problem: -% \begin{center}\small\setstretch{1.1} -% \begin{tabular}{r@{\,\vrule width0.5pt\,}c@{\,\vrule width0.5pt\,}l} -% \oarg{$FNN_1$}\marg{$SNN_1$} & \oarg{$Alt_1$}\oarg{$FNN_2$} & \marg{$SNN_2$}\oarg{$Alt_2$}\\ -% & Which to pick? \\ -% \end{tabular} -% \end{center} -% By only allowing \meta{FNN1} and \meta{SNN1} for the target name, we can let the other fields permit an unrestricted cross-reference. See also Section~\ref{sec:indextag}. +% \textbf{The name order for \cmd{\AKA} is opposite that of \cmd{\IndexRef}.}\footnote{That ordering is due to the collision between \textbf{\meta{Alt\textsubscript{1}}} and \textbf{\meta{FNN\textsubscript{2}}} in a hypothetical \cmd{\AKA}\oarg{FNN\textsubscript{1}}\marg{SNN\textsubscript{1}}\ignorespaces% +% \textbf{\oarg{Alt\textsubscript{1}}\oarg{FNN\textsubscript{2}}}\ignorespaces% +% \marg{SNN\textsubscript{2}}\oarg{Alt\textsubscript{2}} By only allowing \meta{FNN\textsubscript{1}} and \meta{SNN\textsubscript{1}} for the target name, we can let the other fields permit an unrestricted cross-reference.} +%See also Section~\ref{sec:indextag}. % -% \cmd{\AKA} only prints long names in the text. It designed for the occasional mentioning of full alternate names. See page~\pageref{page:manualxref} for alternate solutions. \cmd{\SeeAlso} works with \cmd{\AKA}, \cmd{\AKA*}, and \cmd{\PName}. +% \cmd{\AKA} only prints whatever form of name in the text that you manually specify. It is designed for the occasional mention of alternate names. See page~\pageref{page:manualxref} for alternate solutions. \cmd{\SeeAlso} works with \cmd{\AKA}, \cmd{\AKA*}, and \cmd{\PName}. % % \cmd{\AKA} prints the \meta{Alt. FNN} and \meta{Alt. SNN} fields in the body text. If the \meta{Alt. names} field is present, \cmd{\AKA} swaps it with the \meta{Alt. FNN} field in the text. The caps and reversing macros work with \cmd{\AKA}. % % \cmd{\AKA*}\marginpar{\large\raggedleft\textsf{\bfseries 3.0}} prints short name references like \cmd{\FName}, meaning that \cmd{\ForceFN} works with it in the same manner. For the older behavior of \cmd{\AKA*} use the \texttt{oldAKA} option or always precede \cmd{\AKA*} with \cmd{\ForceFN}. % -% \begin{center}\bfseries Basic Operation\end{center} -% \begin{quote}\small\setstretch{1.1} -% These are the possible main-name forms before the alternate name:\\[1ex] -% {\footnotesize\begin{tabular}{llll@{}} -% \cmd{\AKA} & \oarg{FNN}\marg{SNN} & \dots \hphantom{\oarg{FNN}\quad\marg{SNN} \quad} & \emph{Western}\\ -% \cmd{\AKA} & \oarg{FNN}\marg{SNN, Affix} & \dots\\ -% \cmd{\AKA} & \hphantom{\oarg{FNN}}\marg{SNN} & \dots & \emph{Ancient}\\ -% \cmd{\AKA} & \hphantom{\oarg{FNN}}\marg{SNN, Affix} & \dots\\ -% \cmd{\AKA} & \hphantom{\oarg{FNN}}\marg{SNN, FNN} & \dots & \emph{Eastern}\\ -% \end{tabular}}\\[1ex] -% These are the more common alternate-name forms after the main name:\\[1ex] -% {\footnotesize\begin{tabular}{lll@{}l@{}} -% \cmd{\AKA} & \dots\hphantom{ \quad} & \oarg{Alt. FNN}\marg{Alt. SNN} & \emph{Western}\\ -% \cmd{\AKA} & \dots & \oarg{Alt. FNN}\marg{Alt. SNN}\oarg{Alt. names}\\ -% \cmd{\AKA} & \dots & \oarg{Alt. FNN}\marg{Alt. SNN, Affix}\\ -% \cmd{\AKA} & \dots & \oarg{Alt. FNN}\marg{Alt. SNN, Affix}\oarg{Alt. names}\\ -% \cmd{\AKA} & \dots & \hphantom{\oarg{Alt. FNN}}\marg{Alt. SNN} & \emph{Ancient}\\ -% \cmd{\AKA} & \dots & \hphantom{\oarg{Alt. FNN}}\marg{Alt. SNN, Affix}\\ -% \cmd{\AKA} & \dots & \hphantom{\oarg{Alt. FNN}}\marg{Alt. SNN, Alt. FNN} & \emph{Eastern}\\ -% \end{tabular}}\\[1ex] -% These alternate-name forms use non-Western alternate names:\\[1ex] -% {\footnotesize\begin{tabular}{llll@{}} -% \cmd{\AKA} & \dots \hphantom{\oarg{N}} & \marg{Alt. SNN, Alt. FNN}\oarg{Alt. names}\hphantom{ \quad} & \emph{Eastern}\\ -% \cmd{\AKA} & \dots & \marg{Alt. SNN, Alt. Affix}\oarg{Alt. names} & \emph{Ancient}\\ -% \end{tabular}}\\[1ex] -% These alternate-name forms use the old syntax:\\[1ex] -% {\footnotesize\begin{tabular}{llll@{}} -% \cmd{\AKA} & \dots \hphantom{\oarg{NNN}\marg{SNN}} & \marg{Alt. SNN}\oarg{Alt. FNN}\hphantom{ \quad} & \emph{Eastern}\\ -% \cmd{\AKA} & \dots & \marg{Alt. SNN}\oarg{Alt. Affix} & \emph{Ancient}\\ -% \end{tabular}} -% \end{quote} +% \begin{center}\bfseries General Tips\end{center} +% \begin{itemize}\small +% \item \oarg{FNN}\marg{SNN} is the target. \oarg{Alt. FNN}\marg{Alt. SNN}\oarg{Alt. names} is the cross-reference to the target. Neither create page references. +% \item The older non-Western syntax cannot be used with \oarg{FNN}\marg{SNN}. It can be used with \marg{Alt. SNN}\oarg{Alt. names}, but we discourage that. +% \item Only the \meta{SNN} and \meta{Alt. SNN} fields use comma-delimited suffixes. +% \item One cannot create an index tag for a cross-reference, but one can sort that reference with \cmd{\PretagName}. +% \item \oarg{Alt. FNN}\marg{Alt. SNN}\oarg{Alt. names} in \cmd{\AKA} correspond to the name fields in \cmd{\PretagName}. +% \item \DropAffix\Name*[J.E.]{Carter, Jr.}[Jimmy] is not a cross-reference when it takes a form like:\\\hbox{}\qquad |\DropAffix\Name*[J.E.]{Carter, Jr.}[Jimmy]|. +% \item \AKA[J.E.]{Carter, Jr.}[Jimmy]{Carter} is a cross-reference when it takes a form like:\\\hbox{}\qquad |\AKA[J.E.]{Carter, Jr.}[Jimmy]{Carter}|. +% \item To index stage names:\\\hbox{}\qquad |\Name[The Amazing]{Kreskin}|\dotfill \Name[The Amazing]{Kreskin}\\\hbox{}\qquad|\AKA[The| |Amazing]{Kreskin}| |[Joseph]{Kresge}|\dotfill \AKA[The Amazing]{Kreskin}[Joseph]{Kresge} +% \item To keep stage names out of the index (index entries suppressed):{\IndexInactive\\\hbox{}\qquad |\Name[J.]{Kreskin}[The| |Amazing]|\dotfill \Name[J.]{Kreskin}[The Amazing]\\\hbox{}\qquad |\AKA[J.]{Kreskin}[Joseph]{Kresge}|\dotfill \AKA[J.]{Kreskin}[Joseph]{Kresge}} +% \end{itemize} % -% The next example makes ``alternate name'' cross-references to the target \Name[Bob]{Hope}, illustrating Western names: +% \begin{center}\bfseries Examples\end{center} +% We make cross-references to \Name[Bob]{Hope}, where sll of the forms below create the cross-reference ``Hope, Leslie Townes \emph{see} Hope, Bob'': % \begin{center}\small\setstretch{1.1} -% \begin{tabular}{ll}\toprule -% |\AKA[Bob]{Hope}[Leslie Townes]{Hope}| & \AKA[Bob]{Hope}[Leslie Townes]{Hope}\\ -% |\AKA*[Bob]{Hope}[Leslie Townes]{Hope}| & \AKA*[Bob]{Hope}[Leslie Townes]{Hope}\\ -% |\AKA[Bob]{Hope}%|\\| [Leslie Townes]{Hope}[Leslie]| & \AKA[Bob]{Hope}[Leslie Townes]{Hope}[Leslie]\\ -% |\AKA*[Bob]{Hope}%|\\| [Leslie Townes]{Hope}[Leslie]| & \AKA*[Bob]{Hope}[Leslie Townes]{Hope}[Leslie]\\\bottomrule +% \begin{tabular}{p{0.6\textwidth}l}\toprule +% \footnotesize|\AKA[Bob]{Hope}[Leslie Townes]{Hope}| & \AKA[Bob]{Hope}[Leslie Townes]{Hope}\\ +% \footnotesize|\RevComma\AKA[Bob]{Hope}[Leslie Townes]{Hope}| & \RevComma\AKA[Bob]{Hope}[Leslie Townes]{Hope}\\ +% \footnotesize|\AKA[Bob]{Hope}[Leslie Townes]{Hope}%| | [\ignorespaces]| & \AKA[Bob]{Hope}[Leslie Townes]{Hope}[\ignorespaces]\\ +% \footnotesize|\AKA[Bob]{Hope}[Leslie Townes]{Hope}[Lester T.]| & \AKA[Bob]{Hope}[Leslie Townes]{Hope}[Lester T.]\\ +% \footnotesize|\AKA*[Bob]{Hope}[Leslie Townes]{Hope}| & \AKA*[Bob]{Hope}[Leslie Townes]{Hope}\\ +% \footnotesize|\AKA*[Bob]{Hope}[Leslie Townes]{Hope}[Lester]| & \AKA*[Bob]{Hope}[Leslie Townes]{Hope}[Lester]\\\bottomrule % \end{tabular} % \end{center} % -% As with nicknames and \cmd{\Name}, the alternate forms in the text do not appear in the index. Remember that one cannot apply an index tag to a cross-reference; only a ``pretag'' will work. -% -% With \KeepAffix\Name*{Louis, XIV} and \Name{Lao-tzu} below, notice that there is no change in printed form between \cmd{\AKA} and \cmd{\AKA*}: +% Next we see what happens with references to \KeepAffix\Name*{Louis, XIV}, \Name{Lao-tzu}, and \KeepAffix\Name*{Gregory, I}, as well as \Name[Lafcadio]{Hearn} and \Name[Charles]{du Fresne}: % \begin{center}\small\setstretch{1.1} -% \begin{tabular}{ll}\toprule +% \begin{tabular}{p{0.6\textwidth}l}\toprule % |\AKA{Louis, XIV}{Sun King}| & \AKA{Louis, XIV}{Sun King}\\ % |\AKA*{Louis, XIV}{Sun King}| & \AKA{Louis, XIV}{Sun King}\\\midrule % |\AKA{Lao-tzu}{Li, Er}| & \AKA{Lao-tzu}{Li, Er}\\ -% |\AKA*{Lao-tzu}{Li, Er}| & \AKA{Lao-tzu}{Li, Er}\\\bottomrule -% \end{tabular} -% \end{center} -% -% This final example illustrates how \cmd{\AKA*} can be useful with medieval affixes as we consider \KeepAffix\Name{Gregory, I} ``\ForceFN\AKA*{Gregory, I}{Gregory}[the Great]'': -% \begin{center}\small\setstretch{1.1} -% \begin{tabular}{ll}\toprule -% |\AKA{Gregory, I}{Gregory}[the Great]| & \AKA{Gregory, I}{Gregory}[the Great]\\ -% |\AKA*{Gregory, I}{Gregory}[the Great]| & \AKA*{Gregory, I}{Gregory}[the Great]\\ -% |\ForceFN\AKA*{Gregory, I}%|\\ -% | {Gregory}[the Great]| & \ForceFN\AKA*{Gregory, I}{Gregory}[the Great]\\\bottomrule +% |\AKA*{Lao-tzu}{Li, Er}| & \AKA*{Lao-tzu}{Li, Er}\\\midrule +% |\AKA[Charles]{du Fresne}{du Cange}| & \AKA[Charles]{du Fresne}{du Cange}\\ +% |\CapThis\AKA[Charles]{du Fresne}{du Cange}| & \CapThis\AKA[Charles]{du Fresne}{du Cange}\\\midrule +% \footnotesize|\CapName\AKA[Lafcadio]{Hearn}{Koizumi, Yakumo}| & \CapName\AKA[Lafcadio]{Hearn}{Koizumi, Yakumo}\\ +% \footnotesize|\RevName\AKA[Lafcadio]{Hearn}{Koizumi, Yakumo}| & \RevName\AKA[Lafcadio]{Hearn}{Koizumi, Yakumo}\\\midrule +% \footnotesize|\AKA{Gregory, I}{Gregory}[the Great]| & \AKA{Gregory, I}{Gregory}[the Great]\\ +% \footnotesize|\AKA*{Gregory, I}{Gregory}[the Great]| & \AKA*{Gregory, I}{Gregory}[the Great]\\ +% \footnotesize|\ForceFN\AKA*{Gregory, I}{Gregory}[the Great]| & \ForceFN\AKA*{Gregory, I}{Gregory}[the Great]\\\bottomrule % \end{tabular} % \end{center} % % \begin{center}\bfseries Formatting Alternate Names: General\end{center} -% In this simple example we redefine the the default system of formatting to illustrate what can happen under default formatting conditions: -% \begin{quote}\small\setstretch{1.1} -% \renewcommand*\NamesFormat{\scshape}|\renewcommand*\NamesFormat{\scshape}|\\ -% |\Name{Jean, sans Peur}| |(\AKA{Jean,| |sans| |Peur}{Jean| |the| |Fearless})|\\ {\ttfamily was Duke of Burgundy 1404|--|1419.} +% \cmd{\AKA}\marginpar{\small\raggedleft\texttt{formatAKA}\break\dbend} and its derivatives use the subsequent-use formatting hooks \cmd{\MainNamesHook} and \cmd{\FrontNamesHook}. This was designed originally to keep cross-references from looking like main names by accident when they were intriduced in the body text. In order to be freed of those constraints, use the \texttt{formatAKA} package option. Note the caveats that come therewith. % -% \Name{Jean, sans Peur} (\AKA{Jean, sans Peur}{Jean the Fearless}) was Duke of Burgundy 1404--1419. +% We show \texttt{formatAKA} used with |\AKA{Elizabeth, I}[Good Queen]{Bess}|. The colors indicate which formatting hooks are being used.\ignorespaces% +% \begin{quote}\small\setstretch{1.1} +% \makeatletter\@nameauth@AKAFormattrue\makeatother +% \NamesInactive \textbf{Front Matter:} \ForgetThis\LEliz\ was known as ``\AKA{Elizabeth, I}[Good Queen]{Bess}.''\\ +% Again we mention Queen \Eliz, ``\AKA{Elizabeth, I}[Good Queen]{Bess}.''\\ +% \cmd{\ForceName}: \ForceName\AKA{Elizabeth, I}[Good Queen]{Bess}.\\[1ex] +% \NamesActive \textbf{Main Matter:} \ForgetThis\LEliz\ was known as ``\AKA{Elizabeth, I}[Good Queen]{Bess}.''\\ +% Again we mention Queen \Eliz, ``\AKA{Elizabeth, I}[Good Queen]{Bess}.''\\ +% \cmd{\ForceName}: \ForceName\AKA{Elizabeth, I}[Good Queen]{Bess}. % \end{quote} +% Section~\ref{sec:tweaks} also shows how cross-references are independent of other data sets in \textsf{nameauth}. Cross-references do not respect the two namng systems. The first time that the cross-reference appears, we see that \texttt{formatAKA} lets it use the first-use hooks. Thereafter, it uses the subsequent-use hooks. When we switched to the main matter, the cross-reference \AKA{Elizabeth, I}[Good Queen]{Bess} did not switch to a first use until we used \cmd{\ForceName}. Now we compare the \texttt{alwaysformat} option: % -% ``\AKA{Jean, sans Peur}{Jean the Fearless}''\marginpar{\small\raggedleft\texttt{formatAKA}\break\dbend} usually receives no formatting because it is post-processed by \cmd{\MainNamesHook} in the main matter text and \cmd{\FrontNamesHook} in the front matter. The \texttt{formatAKA} option causes \cmd{\AKA} to use \cmd{\NamesFormat} and \cmd{\FrontNamesFormat}, but \textbf{only once in the whole document}. Using the \texttt{alwaysformat} option formats all names as first uses. -% One can tweak the \texttt{formatAKA} option with the following and place it before \cmd{\AKA} or \cmd{\AKA*}: % \begin{quote}\small\setstretch{1.1} -% \cmd{\makeatletter}\\ -% |\newcommand*\Format{\@nameauth@FirstFormattrue}|\\ -% \cmd{\makeatother} +% \makeatletter\@nameauth@AlwaysFormattrue\makeatother +% \NamesInactive \textbf{Front Matter:} \ForgetThis\LEliz\ was known as ``\AKA{Elizabeth, I}[Good Queen]{Bess}.''\\ +% Again we mention Queen \Eliz, ``\AKA{Elizabeth, I}[Good Queen]{Bess}.''\\ +% \cmd{\ForceName}: \ForceName\AKA{Elizabeth, I}[Good Queen]{Bess}.\\[1ex] +% \NamesActive \textbf{Main Matter:} \ForgetThis\LEliz\ was known as ``\AKA{Elizabeth, I}[Good Queen]{Bess}.''\\ +% Again we mention Queen \Eliz, ``\AKA{Elizabeth, I}[Good Queen]{Bess}.''\\ +% \cmd{\ForceName}: \ForceName\AKA{Elizabeth, I}[Good Queen]{Bess}. % \end{quote} -% \clearpage % -% Below we show the effects of \texttt{formatAKA} and \texttt{alwaysformat} on the example macro |\AKA{Elizabeth, I}[Good Queen]{Bess}|. We use special formatting for main-matter and front-matter names.\ignorespaces% -% \begin{quote}\leavevmode{}\small\setstretch{1.1}\ignorespaces% -% \renewcommand*\FrontNamesFormat{\itshape}\ignorespaces% -% \renewcommand*\NamesFormat{\scshape}\ignorespaces% -% \makeatletter\newcommand*\Format{\@nameauth@FirstFormattrue}\makeatother\ignorespaces% -% \ForgetName{Elizabeth, I}\ignorespaces% -% \makeatletter\@nameauth@AKAFormattrue\makeatother\hbox{}\hfil\texttt{formatAKA}\\ -% {\NamesInactive \textbf{Front Matter:} \LEliz\ was known as ``\AKA{Elizabeth, I}[Good Queen]{Bess}.'' Again we mention Queen \Eliz, ``\AKA{Elizabeth, I}[Good Queen]{Bess}.''\\ |\Format\AKA{Elizabeth, I}[Good Queen]{Bess}| \Format\AKA{Elizabeth, I}[Good Queen]{Bess}.\\ -% \NamesActive \textbf{Main Matter:} \LEliz\ was known as ``\AKA{Elizabeth, I}[Good Queen]{Bess}.'' Again we mention Queen \Eliz, ``\AKA{Elizabeth, I}[Good Queen]{Bess}.''\\ |\Format\AKA{Elizabeth, I}[Good Queen]{Bess}| \Format\AKA{Elizabeth, I}[Good Queen]{Bess}.}\\[1ex] -% \ForgetName{Elizabeth, I}\ignorespaces% -% {\makeatletter\@nameauth@AlwaysFormattrue\makeatother\hbox{}\hfil\texttt{alwaysformat}\\ -% \NamesInactive \textbf{Front Matter:} \LEliz\ was known as ``\AKA{Elizabeth, I}[Good Queen]{Bess}.'' Again we mention Queen \Eliz, ``\AKA{Elizabeth, I}[Good Queen]{Bess}.''\\ -% \NamesActive \textbf{Main Matter:} \LEliz\ was known as ``\AKA{Elizabeth, I}[Good Queen]{Bess}.'' Again we mention Queen \Eliz, ``\AKA{Elizabeth, I}[Good Queen]{Bess}.''} -% \end{quote} -% \ForgetName{Elizabeth, I}% +% With \texttt{alwaysformat}, all the names in the document use only the first-use hooks, never the subsequent-use hooks. This option tends to get little use in the newer versions of \textsf{nameauth}. It was more useful in early versions when \cmd{\NamesFormat} was the only formatting hook. % % \begin{center}\bfseries Formatting Alternate Names: Continental\end{center} -% \noindent The following annotated example shows a simple Continental style where the surname is always in small caps, both in the text and in the index: +% \noindent The following annotated example shows the simple Continental form that we introduced in Section~\ref{sec:altformat}. We initiate the alternate formatting framework with \cmd{\AltFormatActive} and take care not to use the names below outside of it.\AltFormatActive % \begin{enumerate} % \item Tag the names for proper sorting.\\[4pt] -% |\PretagName[Heinz]{\textsc{Rühmann}}{Ruehmann, Heinz}%|\\ -% |\PretagName[Heinrich Wilhelm]{\textsc{Rühmann}}%|\\ +% |\PretagName[Heinz]{\textSC{Rühmann}}{Ruehmann, Heinz}%|\\ +% |\PretagName[Heinrich Wilhelm]{\textSC{Rühmann}}%|\\ % | {Ruehmann, Heinrich Wilhelm}%| -% \item ``\Name*[Heinz]{\textsc{Rühmann}}'' is the main name. \cmd{\AKA*} uses ``\textsc{Rühmann}, Heinrich Wilhelm'' as the index cross-reference and prints only ``Heinrich Wilhelm'' in the body text.\\[4pt] -% |\AKA*[Heinz]{\textsc{Rühmann}}%|\\ -% | [Heinrich Wilhelm]{\textsc{Rühmann}} %| -% \item \cmd{\SubvertName} causes \cmd{\FName} to print the short version via the ``subsequent-use'' macro \cmd{\MainNameHook}.\\[4pt] -% |\SubvertName[Heinz]{\textsc{Rühmann}} %| -% \item \cmd{\FName} prints ``\FName[Heinz]{\textsc{Rühmann}}.''\\[4pt] -% |``\FName[Heinz]{\textsc{Rühmann}}'' %| -% \item \cmd{\Name} prints ``\Name[Heinz]{\textsc{Rühmann}}.'' The small caps are syntactic, not typographic, because they are part of the argument to \cmd{\Name} itself.\\[4pt] -% |\Name[Heinz]{\textsc{Rühmann}}| |(7| |March| |1902\,--\,3%|\\ +% \item ``\Name*[Heinz]{\textSC{Rühmann}}'' is the main name, but we do not start with that. We begin with \cmd{\AKA*} in order to use his legal name as an alias for his more popular stage name. \cmd{\AKA*} prints ``\AKA*[Heinz]{\textSC{Rühmann}}[Heinrich Wilhelm]{\textSC{Rühmann}}'' in the body text and sets up the index cross-reference ``\textsc{Rühmann}, Heinrich Wilhelm \emph{see} \textsc{Rühmann}, Heinz.''\\[4pt] +% |\AKA*[Heinz]{\textSC{Rühmann}}%|\\ +% | [Heinrich Wilhelm]{\textSC{Rühmann}} %| +% \item \cmd{\SubvertThis} makes \cmd{\FName} print \SubvertThis``\FName[Heinz]{\textSC{Rühmann}}.''\\[4pt] +% |\SubvertThis``\FName[Heinz]{\textSC{Rühmann}}'' %| +% \item \cmd{\Name} prints ``\Name[Heinz]{\textSC{Rühmann}}.'' The small caps are syntactic, not typographic, because they are part of the argument to \cmd{\Name} itself.\\[4pt] +% |\Name[Heinz]{\textSC{Rühmann}}| |(7| |March| |1902\,--\,3%|\\ % |October 1994)| |was| |a| |German| |actor| |in| |over| |100| |films.| % \end{enumerate} % The resulting text is: % \begin{quote}\small -% \AKA*[Heinz]{\textsc{Rühmann}}[Heinrich Wilhelm]{\textsc{Rühmann}} \ignorespaces% -% \SubvertName[Heinz]{\textsc{Rühmann}}\ignorespaces% -% ``\FName[Heinz]{\textsc{Rühmann}}'' \ignorespaces% -% \Name[Heinz]{\textsc{Rühmann}} (7 March 1902\,--\,3 October \ignorespaces% +% \AKA*[Heinz]{\textSC{Rühmann}}[Heinrich Wilhelm]{\textSC{Rühmann}} \ignorespaces% +% \SubvertThis``\FName[Heinz]{\textSC{Rühmann}}'' \ignorespaces% +% \Name[Heinz]{\textSC{Rühmann}} (7 March 1902\,--\,3 October \ignorespaces% % 1994) was a German actor in over 100 films. % \end{quote} +% Of course, this example is but one among a number of solutions. The point is to find a solution that best fits one's needs. We now resume normal formatting with \cmd{\AltFormatInactive}. +% \AltFormatInactive % \clearpage % % \phantomsection\label{page:manualxref} @@ -2311,19 +2593,18 @@ Running "make install" installs the files in the local TeX tree. % \IndexRef{Snellius}{Snel van Royen, R.; Snel van Royen, W.} % \end{quote} % -% Cross-references generated by \cmd{\AKA} and \cmd{\AKA*} are meant only to be cross-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: +% \cmd{\AKA} and \cmd{\AKA*} never create never page entries. When the alternate name needs to be indexed with page numbers and \emph{see also} references, do the following: % \begin{itemize}\small % \item Refer to the person intended, \emph{e.g.}:\\ \hbox{}\qquad\Name{Maimonides} (\AKA{Maimonides}{Moses ben-Maimon}):\\ \hbox{}\qquad|\Name{Maimonides}| |(\AKA{Maimonides}{Moses| |ben-Maimon})| -% \item We now have a target entry and a \emph{see} reference. -% \item We also should refer to the main name. The fact that we had a target reference does not establish the index entry for the main name. Thus:\\ \hbox{}\qquad\Name{Maimonides}\\ \hbox{}\qquad|\Name{Maimonides}| -% \item Before creating a cross-reference, one must refer to the alternate name, \emph{e.g.}:\\ \hbox{}\qquad\Name{Rambam}\\ \hbox{}\qquad|\Name{Rambam}| -% \item For\marginpar{\large\raggedleft\textsf{\bfseries 3.0}\strut} whatever name you use for the \emph{see also} reference, put the cross-reference after all of the page references. For example, you could put both of these macros at the end of the document:\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}.}\\\hbox{}\qquad|\SeeAlso\IndexRef{Maimonides}{Rambam}|\\\hbox{}\qquad|\SeeAlso\IndexRef{Rambam}{Maimonides}| +% \item We now have a main name with a page entry, as well as a ``\emph{see} reference'' name. If we fail to refer to the main name, we would have a cross-reference to an entry that does not exist. +% \item Before creating a \emph{see also} cross-reference, one must refer to the alternate name so that all the page entries precede the cross-reference, \emph{e.g.}:\\ \hbox{}\qquad\Name{Rambam}\qquad|\Name{Rambam}| +% \item For\marginpar{\large\raggedleft\textsf{\bfseries 3.0}\strut} whatever name you use for the \emph{see also} reference, put the cross-reference after all of the page references. For example, you could put both of these macros at the end of the document:\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 \url{http://tex.stackexchange.com}.}\\\hbox{}\qquad|\SeeAlso\IndexRef{Maimonides}{Rambam}|\\\hbox{}\qquad|\SeeAlso\IndexRef{Rambam}{Maimonides}| % \item You could let the last reference to either name be handled by \cmd{\SeeAlso}\cmd{\AKA}, but that could be more confusing and prone to error. % \end{itemize} % \SeeAlso\IndexRef{Maimonides}{Rambam}% % \SeeAlso\IndexRef{Rambam}{Maimonides}% % -% Using \cmd{\PretagName} (Section~\ref{sec:IndexSort}) helps to avoid the need for manual index entries. Instead of doing a lot of extra work with \texttt{makeindex} for some names, consider the following example: +% Using \cmd{\PretagName} (Section~\ref{sec:IndexSort}) helps to avoid the need for manual index entries, as the following example shows: % % \begin{quote}\small\setstretch{1.1} % {\ttfamily% @@ -2339,105 +2620,95 @@ Running "make install" installs the files in the local TeX tree. % (\AKA{Thomas, Aquinas}{Thomas of Aquino}), also known as % % \AKA{Thomas, Aquinas}{\textit{Doctor angelicus}}. % \end{quote} -% We use the medieval form: |\Name{Thomas, Aquinas}| because ``Aquinas'' is not a surname, even though many people, including scholars, falsely use it as such. Section~\ref{sec:standards} talks about those unfortunate situations where one must use the Western form |\Name[Thomas]{Aquinas}.| -% \clearpage -% -% \begin{center}\bfseries General Tips for \cmd{\AKA}\end{center} -% \begin{itemize}\small -% \item \oarg{FNN}\marg{SNN} is the target name. \oarg{Alt. FNN}\marg{Alt. SNN}\oarg{Alt. names} is the cross-reference to the target. Neither create an index entry with page references for the target. -% \item The old syntax causes \cmd{\AKA} and \cmd{\AKA*} to fail:|\AKA{Louis}[XIV]{Sun| |King}| and |\AKA{Gregory}[I]{Gregory}[the| |Great]|. -% \item The \meta{Alt. SNN} field uses comma-delimited suffixes. -% \item The \meta{Alt. names} field does not use comma-delimited suffixes. -% \item Eastern names work as pseudonyms, with all that entails. One can refer to \Name[Lafcadio]{Hearn} as \CapName\AKA[Lafcadio]{Hearn}{Koizumi, Yakumo}:\\\hbox{}\qquad|\CapName\AKA[Lafcadio]{Hearn}{Koizumi, Yakumo}|. -% \item Particles work: \CapThis\AKA[Charles]{du Fresne}{du Cange} is the alternate name for \Name[Charles]{du Fresne}, which is capitalized via \cmd{\CapThis}\cmd{\AKA}. See also Section~\ref{sec:PatRef}. -% \item Reversing works, \emph{e.g.},\\\hbox{}\qquad \cmd{\RevComma}\cmd{\AKA\dots}: \RevComma\AKA[Bob]{Hope}[Leslie Townes]{Hope}\\\hbox{}\qquad \cmd{\RevName}\cmd{\AKA\dots\ }: \RevName\CapName\AKA[Lafcadio]{Hearn}{Koizumi, Yakumo} -% \item The\marginpar{\small\raggedleft\dbend} name fields of \cmd{\PretagName} correspond with the \oarg{Alt. FNN}\marg{Alt. SNN}\oarg{Alt. names} fields of \cmd{\AKA}:\\[1ex]\hbox{}\qquad |\AKA{Vlad| |III,| |Dracula}{Vlad,| |Ţepeş}| matches\\\hbox{}\qquad |\PretagName{Vlad,| |Ţepeş}{Vlad| |Tepes}| -% \item With\marginpar{\small\raggedleft\dbend} stage names like \Name[The Amazing]{Kreskin}, if you want them in the index, use |\Name[The| |Amazing]{Kreskin}| to get ``Kreskin, The Amazing.'' {\IndexInactive Otherwise use something like |\Name[J.]{Kreskin}[The| |Amazing]| to get \Name[J.]{Kreskin}[The Amazing] in the text and ``Kreskin, J.'' in the index.\\[1ex] Using \cmd{\AKA} with such names looks like: |\AKA[The| |Amazing]{Kreskin}| |[Joseph]{Kresge}| and |\AKA[J.]{Kreskin}[Joseph]{Kresge}|.} The results are \Name*[The Amazing]{Kreskin}, a.k.a. \AKA[The Amazing]{Kreskin}[Joseph]{Kresge}. -% \item Special\marginpar{\small\raggedleft\dbend} cases like ``Iron Mike'' Tyson as the nickname for \Name[Mike]{Tyson} may be handled in a number of ways. -% \begin{itemize}\small -% \item Follow |``Iron Mike''| with |\IndexName[Mike]{Tyson}| and do whatever you want in the text. This may be the easiest solution. -% \item Use |``\AKA[Mike]{Tyson}{Iron Mike}''| to create ``\AKA[Mike]{Tyson}{Iron Mike}'' in the text and a cross-reference to ``Tyson, Mike'' in the index. Be sure to have an occurrence of |\Name[Mike]{Tyson}| in the text. See also Section~\ref{sec:AKA}. This is the best solution in terms of how \textsf{nameauth} is designed. -% \item Always get ``Iron Mike Tyson'' with something like:\\[1ex] -% |\newcommand*\Iron{\SubvertName[Mike]{Tyson}%|\\ -% |\FName[Mike]{Tyson}[Iron Mike] \Name[Mike]{Tyson}}|\\[1ex] -% \newcommand*\Iron{\SubvertName[Mike]{Tyson}\FName[Mike]{Tyson}[Iron Mike] \Name[Mike]{Tyson}} -% |``\Iron''| gives you ``\Iron.'' You are responsible for typesetting the first use and creating a cross-reference. This solution runs somewhat contrary to the design principles of \textsf{nameauth}, but it may be helpful if you want the invariant name ``\Iron'' to recur and you want to save typing. -% \end{itemize} -% \end{itemize} +% We use the medieval form: |\Name{Thomas, Aquinas}| because ``Aquinas'' is not a surname, even though many people, including scholars, use it as such. Section~\ref{sec:standards} talks about how one can use |\ForceFN\FName{Thomas, Aquinas}| to refer to \ForceFN\FName{Thomas, Aquinas}. Using |\ForceFN\Name{Thomas, Aquinas}| will produce \ForceFN\Name{Thomas, Aquinas}. That helps prevent unwanted side effects with Eastern names. % \clearpage % -% \begin{center}\bfseries And the Silliest Macro Comes Last\end{center} % \DescribeMacro{\PName} % \DescribeMacro{\PName*} -% \cmd{\PName} is a ``convenience macro'' meant for Western names. It generates a main name followed by a cross-reference in parentheses with the following syntax: +% These macros were meant for Western names and developed in the early versions of \textsf{nameauth}. They no longer fit well with the package. They print a main name followed by a cross-reference in parentheses, the syntax being: % \begin{quote}\small % \cmd{\PName}\oarg{FNN}\marg{SNN}\oarg{other FNN}\marg{other SNN}\oarg{other alt.} % \end{quote} % -% Although \cmd{\PName} creates an easy shortcut, its drawbacks are many. It only can use the \meta{FNN}\meta{SNN} form of \cmd{\AKA}. Neither \cmd{\AKA*}, nor \cmd{\CapName}, \cmd{\CapThis}, \cmd{\RevComma}, \cmd{\RevName}, and the related package options work with \cmd{\PName}. Below we see the forms that \cmd{\Pname} can handle: -% \begin{quote}\small\setstretch{1.1} -% |\PName[Mark]{Twain}[Samuel L.]{Clemens}|\\ -% \hbox{}\dotfill \PName[Mark]{Twain}[Samuel L.]{Clemens}\\ -% \hbox{}\dotfill \PName[Mark]{Twain}[Samuel L.]{Clemens}\\[1ex] -% |\PName*[Mark]{Twain}[Samuel L.]{Clemens}[Sam]|\\ -% \hbox{}\dotfill \PName*[Mark]{Twain}[Samuel L.]{Clemens}[Sam]\\[1ex] -% |\PName{Voltaire}[François-Marie]{Arouet}|\\ -% \hbox{}\dotfill \PName{Voltaire}[François-Marie]{Arouet}\\ -% \hbox{}\dotfill \PName{Voltaire}[François-Marie]{Arouet}\\[1ex] +% Apart from \cmd{\SkipIndex}, prefix macros only work on the name given by \meta{FNN} and \meta{SNN}, not on the latter cross-reference. \cmd{\SkipIndex} keeps both names out of the index. Below we see the only name types that this macro can handle: +% \begin{quote}\footnotesize\setstretch{1.1} +% |\PName[Mark]{Twain}[Samuel L.]{Clemens}|\hfill \PName[Mark]{Twain}[Samuel L.]{Clemens}\\ +% \hbox{}\hfill \PName[Mark]{Twain}[Samuel L.]{Clemens}\\ +% |\PName*[Mark]{Twain}[Samuel L.]{Clemens}[Sam]|\hfill \PName*[Mark]{Twain}[Samuel L.]{Clemens}[Sam]\\[1ex] +% |\PName{Voltaire}[François-Marie]{Arouet}|\hfill \PName{Voltaire}[François-Marie]{Arouet}\\ +% \hbox{}\hfill \PName{Voltaire}[François-Marie]{Arouet}\\[1ex] % |\PretagName{\textit{Doctor mellifluus}}{Doctor mellifluus}|\\ % |\PName{Bernard, of Clairvaux}{\textit{Doctor mellifluus}}|\\ % \PretagName{\textit{Doctor mellifluus}}{Doctor mellifluus} -% \hbox{}\dotfill \PName{Bernard, of Clairvaux}{\textit{Doctor mellifluus}}\\ -% \hbox{}\dotfill \PName{Bernard, of Clairvaux}{\textit{Doctor mellifluus}} +% \hbox{}\hfill \PName{Bernard, of Clairvaux}{\textit{Doctor mellifluus}}\\ +% \hbox{}\hfill \PName{Bernard, of Clairvaux}{\textit{Doctor mellifluus}} % \end{quote} % -% Like \cmd{\AKA}, \cmd{\PName} cannot use the old syntax \marg{SNN}\oarg{FNN} for the main name, but it can do so for the alternate name. +% Like \cmd{\AKA}, \cmd{\PName} cannot use the older syntax \marg{SNN}\oarg{FNN} for the main name, but it can do so for the alternate name. % -% |\PName{William,| |I}{William,| |the Conqueror}| gives \PName{William, I}{William, the Conqueror}. To limit possible confusion, avoid the old syntax in the alternate name: |\PName{William, I}{William}[the Conqueror].| Nevertheless, that \emph{does} work and will produce \PName{William, I}{William}[the Conqueror]. If you use \cmd{\PName*} you get \PName*{William, I}{William}[the Conqueror]. +% |\PName{William,| |I}{William,| |the Conqueror}| gives \PName{William, I}{William, the Conqueror} and \PName{William, I}{William, the Conqueror}.\footnote{The form \texttt{\textbackslash PName\{William, I\}\{William\}[the Conqueror]} works, but we discourage it. Also choose forms like \texttt{\textbackslash PName\{Lao-tzu\}\{Li, Er\}} instead of \texttt{\textbackslash PName\{Lao-tzu\}\{Li\}[Er]}. Avoiding the older syntax with \cmd{\AKA} and \cmd{\PName} avoids error.} +% If you use \cmd{\PName*}, again you will get the long reference \PName*{William, I}{William}[the Conqueror]. % -% Also choose forms like |\PName{Lao-tzu}{Li, Er}| ``\PName{Lao-tzu}{Li, Er}'' instead of |\PName{Lao-tzu}{Li}[Er]| ``\PName{Lao-tzu}{Li}[Er].'' Both forms will work, but the latter form looks confusing and could lead to error. +% |\PName*{William, I}[William]{the Conqueror}| puts \SkipIndex``\PName*{William, I}[William]{the Conqueror}'' in the body text, but its index entry will be ``the Conqueror, William \emph{see} William I.'' This is a result of mixing medieval and Western forms. We suppressed the index entry with \cmd{\SkipIndex}. % -% The\marginpar{\small\raggedleft\dbend} form |\PName{William, I}[William]{the Conqueror}| will produce {\IndexInactive``\PName{William, I}[William]{the Conqueror}''} in the body text, but its index entry will be ``the Conqueror, William \emph{see} William I.'' This is a result of mixing medieval and Western forms. -% \clearpage +% {\medskip\noindent\hbox{}\hfill\large Back to Section~\ref{sec:RefTables} \hfill\hbox{}} % % \subsection{Longer Examples} % -% \subsubsection{Variant Spellings} +% \subsubsection{Variant Names} % \label{sec:DuBois} -% {\IndexRef[W.E.B.]{Du\-Bois}{Du Bois, W.E.B.}\def\NamesFormat{\bfseries}Some\marginpar{\small\raggedleft\dbend} issues can be a bit tricky to address. Here we show first uses of names in \textbf{boldface} to illustrate more clearly what is going on. For example, the problem of using \Name[W.E.B.]{Du Bois} and the alternate form \Name[W.E.B.]{Du\-Bois} illustrates a name collision for \textsf{nameauth} because the names differ only in terms of spaces. +% This section\marginpar{\large\raggedleft\textsf{\bfseries 3.1}\strut} demonstrates how \textsf{nameauth} helps one manage a name authority. Handling name variants has become easier than before. We start with some simple cases and move on to complex ones: % -% Normally, that sort of collision helps the fault-tolerant aspects of this package and is a good thing. Here it is not useful. We need to disambiguate the name forms. We do that by inserting an optional hyphen into the alternate form: +% \newcommand*\Iron{\SubvertThis\Name*[Mike]{Tyson}[Iron Mike]} +% \begin{itemize}\small +% \item Where |Iron Mike| occurs in the text, include |\IndexName[Mike]{Tyson}|. +% \item |\SubvertThis\FName[Mike]{Tyson}[Iron Mike]| always prints \SubvertThis\FName[Mike]{Tyson}[Iron Mike] indexed as ``Tyson, Mike''. That form uses the subsequent-use formatting hooks. |\ForceName\SubvertThis\FName[Mike]{Tyson}[Iron Mike]| prints \ForceName\SubvertThis\FName[Mike]{Tyson}[Iron Mike] with the first-use hooks. +% \item The form \cmd{\Iron} \SubvertThis\Name*[Mike]{Tyson}[Iron Mike] can be set up with:\\[1ex] +% |\newcommand*\Iron{\SubvertThis\Name*[Mike]{Tyson}[Iron Mike]}|\\[1ex] +% In \textsf{nameauth} it makes little sense to ``force'' the subsequent use because it is the common use. First uses are rare. That is why we set up the subsequent use with \cmd{\SubvertThis} and create a first use when needed with \cmd{\ForceName}. |\ForceName\Iron| prints \ForceName\Iron, again indexed as ``Tyson, Mike''. +% \item Use |\IndexRef{Iron Mike}{Tyson, Mike}| to create a \emph{see} cross-reference from ``Iron Mike'' to ``Tyson, Mike'' in the index. Be sure to have an occurrence of |\Name[Mike]{Tyson}| in the text. +% \item Use |``\AKA[Mike]{Tyson}{Iron Mike}''| to create ``\AKA[Mike]{Tyson}{Iron Mike}'' in the text and a cross-reference to ``Tyson, Mike'' in the index. Be sure to have an occurrence of |\Name[Mike]{Tyson}| in the text. +% \end{itemize} +% +% When you want alternate names that can change form and format independently, do the following: % \begin{nameauth} -% \< DuBois & W.E.B. & Du Bois & > -% \< AltDuBois & W.E.B. & Du\-Bois & > +% \< DuBois & W.E.B. & Du Bois & > +% \< AltDuBois & W.E.B. & Du\empty Bois & > % \end{nameauth} -% \begin{quote}\small\setstretch{1.1} +% \begin{enumerate}\small +% \item We start by deciding that the canonical name form we wish to use is ``W.E.B. Du Bois.'' We want to manage the alternate form ``W.E.B. DuBois'' as if it were an occurrence of the canonical name. We set up the name authority:\\ % |\begin{nameauth}|\\ -% | \< DuBois & W.E.B. & Du Bois & >|\\ -% | \< AltDuBois & W.E.B. & Du\-Bois & >|\\ +% | \< DuBois & W.E.B. & Du Bois & >|\\ +% | \< AltDuBois & W.E.B. & Du\empty Bois & >|\\ % |\end{nameauth}| -% \end{quote} -% We still can prevent either name from breaking by putting either \cmd{\DuBois} or \cmd{\AltDuBois} into an \cmd{\hbox}, and so on. % -% Indexing\marginpar{\large\raggedleft\textsf{\bfseries 3.0}\strut} both name forms would be trivial. One can use both at need to generate page references in the index. After all of the page references are done, one can create cross-references with \cmd{\SeeAlso}\cmd{\IndexRef}. +% \item This name gives us an extra level of difficulty because the two variants differ only in terms of spaces. They share the same internal representation in the \textsf{nameauth} macros: |W.E.B.!DuBois|. We fix this ambiguity by inserting a non-printing control sequence in the alternate form, such as |{Du\empty Bois}|. That prevents ``{Du\empty Bois}'' from breaking at the end of a line or page. A discretionary hyphen would allow the name to break.\footnote{Ignoring spaces in names is good because it aids fault tolerance, thereby decreasing spurious index entries. Here we have a special case where this behavior is not useful.} % -% Indexing with only the canonical name form \DuBois\ gets more complex. Before the first reference |\Name[W.E.B.]{Du\-Bois}| or |\AltDuBois| ``\AltDuBois'' occurs, we prevent the creation of any index entries for it by creating a \emph{see} reference, as we did at the start of this section: -% \begin{quote}\small\setstretch{1.1} -% |\IndexRef[W.E.B.]{Du\-Bois}{Du Bois, W.E.B.}| -% \end{quote} -% You can see that first and subsequent name forms, as well as formatting, still work. |\ForgetName[W.E.B.]{Du\-Bois}|\ForgetName[W.E.B.]{Du\-Bois} produces \AltDuBois. We simply will not see index references generated for \AltDuBois. +% \item Instead of using \cmd{\SkipIndex}\cmd{\AltDuBois} every time we wanted to avoid making an index entry, we create a cross-reference in the index from the alternate name to the canonical name:\\ +% | \IndexRef[W.E.B.]{Du\empty Bois}%| |{Du Bois, W.E.B.}| % -% In order to index under |\AltDuBois| as if it were |\DuBois|, we need a macro that will work with the punctuation detection in case we generate the short name W.E.B. We choose the following solution: -% \begin{quote}\small\setstretch{1.1} -% |\global\newcommand*\OtherDuBois|\\ -% | {\IndexName[W.E.B.]{Du Bois}%|\\ -% | \AltDuBois\IndexName[W.E.B.]{Du Bois}}|\\[1ex] -% |\global\newcommand*\SOtherDuBois|\\ -% | {\IndexName[W.E.B.]{Du Bois}\SAltDuBois}| -% \end{quote} -% \global\newcommand*\OtherDuBois{\IndexName[W.E.B.]{Du Bois}\AltDuBois\IndexName[W.E.B.]{Du Bois}}\global\newcommand*\SOtherDuBois{\IndexName[W.E.B.]{Du Bois}\SAltDuBois} -% If we want to ``forget'' \AltDuBois\ again via |\ForgetName[W.E.B.]{Du\-Bois}|\ForgetName[W.E.B.]{Du\-Bois} we get \cmd{\OtherDuBois}: \OtherDuBois\ and \OtherDuBois. With \cmd{\SOtherDuBois} we can mention \SOtherDuBois. The extra full stop at the end of the sentence was gobbled. We used \cmd{\global} to ensure that, regardless of scope, our macros would work wherever we want them to work.} -% \clearpage +% \IndexRef[W.E.B.]{Du\empty Bois}{Du Bois, W.E.B.}From this point onward, no page entry for \AltDuBois\ will occur in the index unless manipulated by \cmd{\IncludeName*}. The canonical \DuBois\ functions as a different name and is not affected. +% \end{enumerate} +% +% Indexing\marginpar{\large\raggedleft\textsf{\bfseries 3.0}\strut} both name forms would be trivial. One can use both forms at need to generate page references in the index. After all of the page references are done, one can create cross-references with \cmd{\SeeAlso}\cmd{\IndexRef}. +% +% Indexing\marginpar{\large\raggedleft\textsf{\bfseries 3.1}\strut} with the canonical name form \DuBois\ whenever we see \AltDuBois\ is slightly more complicated: +% +% \begin{itemize}\small +% \item We no longer wrap each name automatically with two index entries, so we would need to keep track of page breaks and this alternate name. +% \item We could use |\JustIndex\DuBois\AltDuBois| to get \JustIndex\DuBois\AltDuBois. +% \item We could create macros based on that:\\ +% |\global\newcommand*\OtherDuBois{\JustIndex\DuBois\AltDuBois}|\\ +% |\global\newcommand*\LOtherDuBois{\JustIndex\DuBois\LAltDuBois}|\\ +% |\global\newcommand*\SOtherDuBois{\JustIndex\DuBois\SAltDuBois}| +% \end{itemize} +% \global\newcommand*\OtherDuBois{\JustIndex\DuBois\AltDuBois\JustIndex\DuBois} +% \global\newcommand*\LOtherDuBois{\JustIndex\DuBois\LAltDuBois\JustIndex\DuBois} +% \global\newcommand*\SOtherDuBois{\JustIndex\DuBois\SAltDuBois} +% +% With |\ForgetThis\OtherDuBois| we get \ForgetThis\OtherDuBois\ and \OtherDuBois\ thereafter. |\LOtherDuBois| gives us \LOtherDuBois, while with |\SOtherDuBois| we get \SOtherDuBois. The extra full stop at the end of the sentence was gobbled. We used \cmd{\global} to ensure that, regardless of scope, our macros work. +% +% {\medskip\noindent\hbox{}\hfill\large Back to Section~\ref{sec:RefTables} \hfill\hbox{}} % % \subsubsection{\texttt{\textbackslash LocalNames}} % \label{sec:LocalNames} @@ -2458,7 +2729,7 @@ Running "make install" installs the files in the local TeX tree. % |\Name*[Charlie]{Chaplin}|\hfill\Name*[Charlie]{Chaplin}\\ % |\CheckChuck|\hfill\CheckChuck % \end{quote} -% Now we switch to ``front-matter'' text and create a name. We use \cmd{\global} with \cmd{\NamesInactive} in order to ignore any local scoping environments: +% Now we switch to ``front-matter'' text and create a name. To ignore any local scoping we use \cmd{\global}\cmd{\NamesInactive}: % \begin{quote}\small\setstretch{1.1} % |\global\NamesInactive|\global\NamesInactive\\ % |\Name*[Charlie]{Chaplin}|\hfill\Name*[Charlie]{Chaplin}\\ @@ -2494,22 +2765,15 @@ Running "make install" installs the files in the local TeX tree. % % The following subset of active Unicode characters are available ``out of the box'' using NFSS, \textsf{inputenc}, and \textsf{fontenc}: % -% \begin{center}\small\setstretch{1.1} -% \begin{tabular}{llll}\toprule -% \scshape À Á Â Ã Ä Å Æ & \scshape Ç È É Ê Ë & \scshape Ì Í Î Ï Ð Ñ & \scshape small caps \\ -% À Á Â Ã Ä Å Æ & Ç È É Ê Ë & Ì Í Î Ï Ð Ñ & normal \\[1ex] -% \scshape Ò Ó Ô Õ Ö Ø & \scshape Ù Ú Û Ü Ý & \scshape Þ ß & \scshape small caps \\ -% Ò Ó Ô Õ Ö Ø & Ù Ú Û Ü Ý & Þ ß & normal \\[1ex] -% \scshape à á â ã ä å æ & \scshape ç è é ê ë & \scshape ì í î ï ð ñ & \scshape small caps \\ -% à á â ã ä å æ & ç è é ê ë & ì í î ï ð ñ & normal \\[1ex] -% \scshape ò ó ô õ ö ø & \scshape ù ú û ü ý & \scshape þ ÿ & \scshape small caps \\ -% ò ó ô õ ö ø & ù ú û ü ý & þ ÿ & normal \\[1ex] -% \scshape Ă ă Ą ą Ć ć Č č & \scshape Ď ď Đ đ Ę ę Ě ě & \scshape Ğ ğ İ ı & \scshape small caps \\ -% Ă ă Ą ą Ć ć Č č & Ď ď Đ đ Ę ę Ě ě & Ğ ğ İ ı & normal \\[1ex] -% \scshape IJ ij Ľ ľ Ł ł & \scshape Ń ń Ň ň Œ œ & \scshape Ŕ ŕ Ř ř & \scshape small caps \\ -% IJ ij Ľ ľ Ł ł & Ń ń Ň ň Œ œ & Ŕ ŕ Ř ř & normal \\[1ex] -% \scshape Ś Ş ş Š š Ţ ţ Ť ť & \scshape Ů ů Ű ű & \scshape Ź ź Ż ż Ž ž & \scshape small caps \\ -% Ś Ş ş Š š Ţ ţ Ť ť & Ů ů Ű ű & Ź ź Ż ż Ž ž & normal \\\bottomrule +% \begin{center}\setstretch{1.1} +% \begin{tabular}{lll}\toprule +% À Á Â Ã Ä Å Æ & Ç È É Ê Ë & Ì Í Î Ï Ð Ñ \\ +% Ò Ó Ô Õ Ö Ø & Ù Ú Û Ü Ý & Þ ß \\ +% à á â ã ä å æ & ç è é ê ë & ì í î ï ð ñ \\ +% ò ó ô õ ö ø & ù ú û ü ý & þ ÿ \\ +% Ă ă Ą ą Ć ć Č č & Ď ď Đ đ Ę ę Ě ě & Ğ ğ İ ı \\ +% IJ ij Ľ ľ Ł ł & Ń ń Ň ň Œ œ & Ŕ ŕ Ř ř \\ +% Ś Ş ş Š š Ţ ţ Ť ť & Ů ů Ű ű & Ź ź Ż ż Ž ž \\\bottomrule % \end{tabular} % \end{center} % @@ -2521,7 +2785,7 @@ Running "make install" installs the files in the local TeX tree. % |\newunicodechar{ſ}{\textlongs}| % \end{quote} % -% Although\marginpar{\small\raggedleft\dbend} |\newunicodechar{ā}{\=a}| allows |\Name{Ghazāli}| to generate {\IndexInactive\Name{Ghaz\=ali}}, one must be careful with control sequences like |\=a|. They fail when using \texttt{makeindex} and \texttt{gind.ist}. For example, the \textsf{ltxdoc} class, with \texttt{gind.ist}, turns the default ``actual'' character |@| into |=|. Using |\index{Gh{\=a}zali}| halts execution. Using |\index{Gh\=azali}| gives an ``azali'' entry sorted under ``Gh'' (thanks \Name[Dan]{Luecking}). This issue is not specific to \textsf{nameauth}. +% Although\marginpar{\small\raggedleft\dbend} |\newunicodechar{ā}{\=a}| allows |\Name{Ghazāli}| to show \SkipIndex\Name{Ghaz\=ali}, one must be careful with control sequences like |\=a|. They fail when using \texttt{makeindex} and \texttt{gind.ist}. For example, the \textsf{ltxdoc} class, with \texttt{gind.ist}, turns the default ``actual'' character |@| into |=|. Using |\index{Gh{\=a}zali}| halts execution. Understandably, using |\index{Gh\=azali}| gives an ``azali'' entry sorted under ``Gh'' (thanks \Name[Dan]{Luecking}). This issue is not specific to \textsf{nameauth}. % % Such\marginpar{\small\raggedleft\dbend} issues with \texttt{gind.ist} are not the only concerns one must have about NFSS, \textsf{inputenc}, and \textsf{fontenc} when using Unicode. Although the manner in which glyphs are handled is quite powerful, it also is fragile. Any \TeX\ macro that partitions its argument without using delimiters can break Unicode under NFSS. Consider the following examples with |\def\foo#1#2#3\relax{<#1#2><#3>}|: % \begin{center}\setstretch{1.1} @@ -2530,7 +2794,7 @@ Running "make install" installs the files in the local TeX tree. % Argument & Macro & Result\\\midrule % |abc| & |\foo abc\relax| & \foo abc\relax\\ % |{æ}bc| & |\foo {æ}bc\relax| & \foo {æ}bc\relax\\ -% \cmd{\ae bc} & |\foo \ae bc\relax| & \foo \ae bc\relax\\\bottomrule +% |\ae bc| & |\foo \ae bc\relax| & \foo \ae bc\relax\\\bottomrule % \end{tabular} % \end{center} % @@ -2553,7 +2817,8 @@ Running "make install" installs the files in the local TeX tree. % \cmd{\@car}\meta{$test_1$}\cmd{\@nil}, where \meta{$test_1$} expands to \cmd{\IeC} \marg{$test_1$}\\ % \cmd{\@car}\meta{$test_2$}\cmd{\@nil}, where \meta{$test_2$} expands to \cmd{\IeC} \marg{$test_2$} % \end{quote} -% If \meta{$test_2$} expands to the letter \meta{$test_2$}, then it will fail the equality. ``Active'' characters expand to ``two-argument wide'' values under NFSS: +% +% If \meta{$test_2$} expands to the letter \meta{$test_2$}, then it will fail the test for equality. ``Active'' characters expand to ``two-argument wide'' values under NFSS, as the table below shows via defining a macro to be a character, then printing its \cmd{\meaning} in the cell: % \begin{center}\footnotesize\setstretch{1.1}\makeatletter % \begin{tabular}{lll}\toprule % |\def\a|\marg{L} & |\protected@edef\a|\marg{L} & |\protected\edef\a|\marg{L}\\ @@ -2564,6 +2829,8 @@ Running "make install" installs the files in the local TeX tree. % \end{center} % The number of spaces inserted in the index file depends on the number of expansions that occur for a given active character. % +% This\marginpar{\small\raggedleft\dbend} method of testing for active characters and resolving the related issues can interfere with some situations of expansion, generating errors. Be mindful of names within an \cmd{\edef}, for example, unless you control expansion explicitly. +% % \LaTeX\marginpar{\small\raggedleft\dbend} also removes spaces between undelimited macro arguments, but not from the trailing undelimited argument. This is no longer an issue for name arguments in \textsf{nameauth}, but we include the information anyway: % \begin{center}\setstretch{1.1} % \def\foo#1#2#3\relax{<#1#2><#3>} @@ -2585,24 +2852,25 @@ Running "make install" installs the files in the local TeX tree. % |a\space bc| & |\foo a\space bc\relax| & \foo a\space bc\relax\\\bottomrule % \end{tabular} % \end{center} -% See also Sections~\ref{sec:standards} and~\ref{sec:accents}. +% See also Sections~\ref{sec:standards} and~\ref{sec:accents}, as well as Section~\ref{sec:IndexSort}. % \clearpage % % \subsubsection{\LaTeX\ Engines} % \label{sec:engines} % -% The\marginpar{\small\raggedleft\dbend} \textsf{nameauth} package tries to work with multiple languages and typesetting engines. The following preamble snippet from this manual illustrates how that can be done:\footnote{A similar version of this example is in \texttt{examples.tex}, collocated with this manual.} +% The\marginpar{\small\raggedleft\dbend} \textsf{nameauth} package tries to work with multiple languages and typesetting engines. The following preamble snippet illustrates how that can be done:\footnote{A similar version of this example is in \texttt{examples.tex}, collocated with this manual.} +% Please note that there have been changes to the \textsf{fontspec} package in 2016, so one should consult the relevant package documentation regarding the new encodings and what packages to include or not to include as a result. % \begin{quote}\small\setstretch{1.1} % |\usepackage{ifxetex}|\\ % |\usepackage{ifluatex}|\\ % |\ifxetex%|\hfill |uses fontspec|\\ -% \hbox{\quad}|\usepackage{fontspec}|\\ +% \hbox{\quad}|\usepackage{fontspec}%|\hfill | check package docs|\\ % \hbox{\quad}|\defaultfontfeatures{Mapping=tex-text}|\\ -% \hbox{\quad}|\usepackage{xunicode}|\\ -% \hbox{\quad}|\usepackage{xltxtra}|\\ +% \hbox{\quad}|\usepackage{xunicode}%|\hfill | check if outmoded|\\ +% \hbox{\quad}|\usepackage{xltxtra}%|\hfill | check if outmoded|\\ % |\else|\\ % \hbox{\quad}|\ifluatex%|\hfill | also uses fontspec|\\ -% \hbox{\quad}\hbox{\quad}|\usepackage{fontspec}|\\ +% \hbox{\quad}\hbox{\quad}|\usepackage{fontspec}%|\hfill | check package docs|\\ % \hbox{\quad}\hbox{\quad}|\defaultfontfeatures{Ligatures=TeX}|\\ % \hbox{\quad}|\else%|\hfill | traditional NFSS|\\ % \hbox{\qquad}|\usepackage[utf8]{inputenc}|\\ @@ -2611,7 +2879,7 @@ Running "make install" installs the files in the local TeX tree. % |\fi| % \end{quote} % -% This arrangement worked best for this manual, which is tested with all of the \LaTeX\ engines above. This example is not meant to be the only possible way to check which engine you are using and how to set things up. +% This general arrangement works for this manual, which is tested with all of the \LaTeX\ engines above. This example is not meant to be the only possible way to check which engine you are using and how to set things up. % % The following can be used in the text itself to allow for conditional processing that helps one to document work under multiple engines: % @@ -2634,19 +2902,25 @@ Running "make install" installs the files in the local TeX tree. % \subsubsection{Hooks: Intro} % \label{sec:Hooksa} % +% Starting with this section we reset all formatting hooks to do nothing. This helps us focus on the modifications made hereafter. +% \renewcommand*\NamesFormat{} +% \renewcommand*\FrontNamesFormat{} +% \renewcommand*\MainNameHook{} +% \renewcommand*\FrontNameHook{} +% % Before\marginpar{\small\raggedleft Margin\break Paragraphs} we get to the use of text tags and name conditionals in name formatting, we begin with an intermediate example to illustrate that something more complex can occur in \cmd{\NamesFormat}.\marginpar{\small\raggedleft\dbend} Here we put the first mention of a name in boldface, along with a marginal notation if possible:\footnote{A similar version of this example is in \texttt{examples.tex}, collocated with this manual.} % \begin{quote}\small\setstretch{1.1} % |\let\OldFormat\NamesFormat%|\\ % |\renewcommand*\NamesFormat[1]|\\ -% | {\textbf{#1}\ifinner\else|\\ +% | {\textbf{#1}\unless\ifinner|\\ % | \marginpar{\raggedleft\scriptsize #1}\fi}|\\ % \dots\\ % |\let\NamesFormat\OldFormat%| % \end{quote} -% Changes to \cmd{\NamesFormat} should not rely merely on scoping rules to keep them ``local'' but should be changed and reset explicitly, or else odd side effects can result, especially with more exotic changes to \cmd{\NamesFormat}. We now use the example above in a sample text: +% Changes to \cmd{\NamesFormat} are not relying just on scoping rules to keep them ``local.'' We use \cmd{\let} to make explicit changes in order to avoid some possible side effects. We now use the example above in a sample text: % \begin{quote}\small\setstretch{1.1} % \let\OldFormat\NamesFormat\ignorespaces% -% \renewcommand*\NamesFormat[1]{\textbf{#1}\ifinner\else +% \renewcommand*\NamesFormat[1]{\textbf{#1}\unless\ifinner % \marginpar{\raggedleft\scriptsize #1}\fi}% % |\PretagName{Vlad, Ţepeş}{Vlad Tepes}% for accented names|\\[2ex] % {\small |\Name{Vlad| |III,| |Dracula},| |known| |as| |\AKA{Vlad| |III,| |Dracula}{Vlad,| |Ţepeş}| |(the| |Impaler)| |after| |his| |death,| |was| |the| |son| |of| |\Name{Vlad| |II,| |Dracul},| |a| |member| |of| |the| |Order| |of| |the| |Dragon.| |Later| |references| |to| |``\Name{Vlad| |III,| |Dracula}''| |appear| |thus.|}\\[2ex] @@ -2654,10 +2928,10 @@ Running "make install" installs the files in the local TeX tree. % \let\NamesFormat\OldFormat% % \end{quote} % -% Now again we have reverted to the original form of \cmd{\NamesFormat} and we get \ForgetName{Vlad III, Dracula}\Name{Vlad III, Dracula} and \Name{Vlad III, Dracula}. For references to ``Vlad'' consider using |\Name{Vlad, III}| and use \cmd{\NameAddInfo} and \cmd{\NameQueryInfo} to handle ``\texttt{Dracula}.'' The simplified interface greatly helps one to avoid confusion and settle on specific name forms. +% Now again we have reverted to the default \cmd{\NamesFormat} and we get \ForgetName{Vlad III, Dracula}\Name{Vlad III, Dracula} and \Name{Vlad III, Dracula}. For references to ``Vlad'' consider using |\Name{Vlad, III}| and use \cmd{\NameAddInfo} and \cmd{\NameQueryInfo} to handle ``\texttt{Dracula}.'' The simplified interface greatly helps one to avoid confusion and settle on specific name forms. % % \let\OldMainHook\MainNameHook% -% You\marginpar{\small\raggedleft\dbend} cannot re-enter \cmd{\Name} or \cmd{\AKA} by calling them within \cmd{\Namesformat}, \cmd{\FrontNameHook}, or \cmd{\MainNameHook}, as the next example shows: +% You\marginpar{\small\raggedleft\dbend} cannot re-enter \cmd{\Name} or \cmd{\AKA} by calling them within any of the formatting hooks, as the next example shows: % \begin{quote}\small\setstretch{1.1} % |\renewcommand*\MainNameHook[1]|\\ % |{%|\\ @@ -2685,100 +2959,94 @@ Running "make install" installs the files in the local TeX tree. % \DescribeMacro{\@nameauth@toksc} % This package makes three token registers available to facilitate using the name conditional macros as we do below. Using these registers allows accented names to be recognized properly. In \cmd{\AKA} the token registers are copies of the \emph{last} three arguments, corresponding to the pseudonym.\marginpar{\small\raggedleft\dbend} Nevertheless, they have the same names as the registers in \cmd{\@nameauth@Name} because they work the same way and may be easier to use this way. % -% We assume that we will not be using the \texttt{alwaysformat} option, meaning that we only call this hook once for a first use:\footnote{A similar version of this example is in \texttt{examples.tex}, collocated with this manual.} +% We assume that we will not be using the \texttt{alwaysformat} option, meaning that we only call this hook once for a first use of \cmd{\AKA}. We also use a different formatting for the naming macros on the one hand and \cmd{\AKA} on the other:\footnote{A similar version of this example is in \texttt{examples.tex}, collocated with this manual.} % \begin{quote}\small\setstretch{1.1} -% |\newif\ifNoTextTag%|\hfill|allows us to work around \ForgetName|\\ +% |\newif\ifNoTag%|\hfill|allows us to work around \ForgetName|\\ % |\let\OldFormat\NamesFormat%|\hfill|save the format|\\ +% |\let\OldFrontFormat\FrontNamesFormat|\\ % |\makeatletter%|\hfill|access internals|\\ -% |\renewcommand*\NamesFormat[1]|\\ -% |{%|\\ -% | \let\ex\expandafter%|\hfill|reduce typing|\\ -% | \textbf{#1}%|\\ -% | \if@nameauth@InName%|\hfill|do only in \@nameauth@Name|\\ -% | \ifNoTextTag%|\hfill|true branch disables tags|\\ -% | \else%|\hfill|take false branch|\\ -% | \ex\ex\ex\ex\ex\ex\ex\NameQueryInfo%|\\ -% | \ex\ex\ex\ex\ex\ex\ex[%|\\ -% | \ex\ex\ex\the\ex\ex\ex\@nameauth@toksa\ex\ex\ex]%|\\ -% | \ex\ex\ex{\ex\the\ex\@nameauth@toksb\ex}%|\\ -% | \ex[\the\@nameauth@toksc]%|\\ -% | \fi|\\ -% | \fi|\\ -% | \if@nameauth@InAKA%|\hfill|do only in \AKA|\\ -% | \ifNoTextTag\else|\\ -% | \ex\ex\ex\ex\ex\ex\ex\NameQueryInfo%|\\ -% | \ex\ex\ex\ex\ex\ex\ex[%|\\ -% | \ex\ex\ex\the\ex\ex\ex\@nameauth@toksa\ex\ex\ex]%|\\ -% | \ex\ex\ex{\ex\the\ex\@nameauth@toksb\ex}%|\\ -% | \ex[\the\@nameauth@toksc]%|\\ -% | \fi|\\ -% | \fi|\\ -% | \global\NoTextTagfalse%|\hfill|reset tag suppression|\\ +% |\renewcommand*\NamesFormat[1]{\begingroup%|\\ +% | \protected@edef\temp{\endgroup\textbf{#1}%|\\ +% | \unless\ifNoTag|\\ +% | \if@nameauth@InName|\\ +% | {\bfseries\noexpand\NameQueryInfo|\\ +% | [\unexpanded\expandafter{\the\@nameauth@toksa}]|\\ +% | {\unexpanded\expandafter{\the\@nameauth@toksb}}|\\ +% | [\unexpanded\expandafter{\the\@nameauth@toksc}]}\fi|\\ +% | \if@nameauth@InAKA\noexpand\NameQueryInfo|\\ +% | [\unexpanded\expandafter{\the\@nameauth@toksa}]|\\ +% | {\unexpanded\expandafter{\the\@nameauth@toksb}}|\\ +% | [\unexpanded\expandafter{\the\@nameauth@toksc}]\fi|\\ +% | \fi}\temp\global\NoTagfalse%|\\ % |}|\\ -% |\makeatother%| +% |\makeatother|\\ +% |\let\FrontNamesFormat\NamesFormat| % \end{quote} +% \let\OldFormat\NamesFormat\ignorespaces% +% \let\OldFrontFormat\FrontNamesFormat\ignorespaces% +% \makeatletter\ignorespaces% +% \renewcommand*\NamesFormat[1]{\begingroup\ignorespaces% +% \protected@edef\temp{\endgroup\textbf{#1}\ignorespaces% +% \unless\ifNoTag +% \if@nameauth@InName +% {\bfseries\noexpand\NameQueryInfo +% [\unexpanded\expandafter{\the\@nameauth@toksa}] +% {\unexpanded\expandafter{\the\@nameauth@toksb}} +% [\unexpanded\expandafter{\the\@nameauth@toksc}]}\fi +% \if@nameauth@InAKA\noexpand\NameQueryInfo +% [\unexpanded\expandafter{\the\@nameauth@toksa}] +% {\unexpanded\expandafter{\the\@nameauth@toksb}} +% [\unexpanded\expandafter{\the\@nameauth@toksc}]\fi +% \fi}\temp\global\NoTagfalse}\ignorespaces% +% \makeatother% +% This change prints tags in the first use hooks unless \cmd{\NoTag} is set true. Please note that the conditional path here is placed within the \cmd{\edef}. Putting it outside the \cmd{\edef}, such as |\unless\ifNoTag\temp\fi|, will cause errors. % -% The example above prints tags by default in the false path of \cmd{\NoTextTag}, while suppressing them in the true path. -% \clearpage +% This method uses the $\epsilon$-\TeX{} primitives \cmd{\noexpand} and \cmd{\unexpanded} to avoid the extensive repetition of \cmd{\expandafter}. Since the \textsf{nameauth} package depends on \textsf{etoolbox}, we assume that we are using $\epsilon$-\TeX. % -% Before\marginpar{\small\raggedleft\dbend} we can refer to any text tags, we must create them. For teaching purposes I will ``lie'' (sorry) about the tag used for ``Atatürk'' until later. +% Before we can refer to any text tags, we must create them. Using the approach above, we must include a leading space in the text tags: % \begin{quote}\small\setstretch{1.1} % |\NameAddInfo[George]{Washington}{ (1732--99)}%|\\ % |\NameAddInfo[Mustafa]{Kemal}{ (1881--1938)}%|\\ % |\NameAddInfo{Atatürk}{ (in 1934, a special surname)}%| -% \end{quote} % \NameAddInfo[George]{Washington}{ (1732--99)}% % \NameAddInfo[Mustafa]{Kemal}{ (1881--1938)}% % \NameAddInfo{Atatürk}{ (in 1934, a special surname)}% -% \NameAddInfo{Ata\-türk}{ (in 1934, a special surname)}% -% We begin using the modified \cmd{\NamesFormat} under normal conditions: -% \newif\ifNoTextTag% -% \let\OldFormat\NamesFormat% -% \let\OldFrontFormat\FrontNamesFormat% -% \makeatletter\renewcommand*\NamesFormat[1]{\let\ex\expandafter\ignorespaces% -% \textbf{#1}\ignorespaces% -% \if@nameauth@InName\ifNoTextTag\else -% \ex\ex\ex\ex\ex\ex\ex\NameQueryInfo\ex\ex\ex\ex\ex\ex\ex[\ex\ex\ex\the\ex\ex\ex\@nameauth@toksa\ex\ex\ex]\ex\ex\ex{\ex\the\ex\@nameauth@toksb\ex}\ex[\the\@nameauth@toksc]\ignorespaces% -% \fi\fi -% \if@nameauth@InAKA\ifNoTextTag\else -% \ex\ex\ex\ex\ex\ex\ex\NameQueryInfo\ex\ex\ex\ex\ex\ex\ex[\ex\ex\ex\the\ex\ex\ex\@nameauth@toksa\ex\ex\ex]\ex\ex\ex{\ex\the\ex\@nameauth@toksb\ex}\ex[\the\@nameauth@toksc]\ignorespaces% -% \fi\fi\global\NoTextTagfalse}\makeatother -% \ForgetName[George]{Washington}% -% \begin{quote}\small\setstretch{1.1} -% |\Wash| |held| |office| |1789--97.| |No| |tags| |appear| |with| |\Wash. %|\\ -% |First| |use,| |dates| |suppressed:%|\\ -% |\NoTextTagtrue\ForgetName[George]{Washington}\Wash.| -% -% |\Name[Mustafa]{Kemal}| |was| |granted| |the| |name%|\\ -% |\AKA[Mustafa]{Kemal}{Atatürk}. We mention%|\\ -% |\AKA[Mustafa]{Kemal}{Atatürk} again.| +% \end{quote} % -% \Wash\ held office 1789--97. No tags appear with \Wash. First use, dates suppressed: \NoTextTagtrue\ForgetName[George]{Washington}\Wash. +% The leading space is needed only when a text tag appears. Another way to add that space is to put it in the conditional path of the formatting hook and leave it out of the text tags entirely: +% \begin{quote}\small +% \dots|\unless\ifNoTag|\dots|{ }\noexpand\NameQueryInfo|\dots|\fi}\temp| +% \end{quote} % -% \Name[Mustafa]{Kemal} was granted the name {\IndexInactive\AKA[Mustafa]{Kemal}{Atatürk}. We mention \AKA[Mustafa]{Kemal}{Atatürk} again.} +% Now we begin with the first example, where both the name and the dates are in boldface because we use a naming macro: +% \begin{quote}\small\setstretch{1.1} +% |\ForgetThis\Wash held office 1789--97. No tags here: \Wash.|\\ +% |First use, dates suppressed: \NoTagtrue\ForgetThis\Wash.|\\[1ex] +% \ForgetThis\Wash\ held office 1789--97. No tags here: \Wash. +% First use, dates suppressed: \NoTagtrue\ForgetThis\Wash. % \end{quote} % -% Notice\marginpar{\small\raggedleft\dbend} that the text tag for \AKA[Mustafa]{Kemal}{Atatürk} did not print. That is because \cmd{\AKA} usually only calls the ``subsequent use'' hooks. Therefore we simulate the \texttt{formatAKA} option and \cmd{\ForgetName} \Wash\ and \Name[Mustafa]{Kemal}: +% Since \cmd{\AKA} usually calls the ``subsequent use'' formatting hooks, we can create a scope to ``fool'' it into calling the first-use hook via \cmd{\let}: % \begin{quote}\small\setstretch{1.1} -% \makeatletter\@nameauth@AKAFormattrue\makeatother -% \ForgetName[George]{Washington}% -% \ForgetName[Mustafa]{Kemal}% -% \Wash\ held office 1789--97. No tags appear with \Wash. First use, dates suppressed: \NoTextTagtrue\ForgetName[George]{Washington}\Wash. +% |\Name[Mustafa]{Kemal} was granted the name%|\\ +% |\begingroup\let\MainNameHook\NamesFormat%|\\ +% |\AKA[Mustafa]{Kemal}{Atatürk}\endgroup. We mention%|\\ +% |\AKA[Mustafa]{Kemal}{Atatürk} again.| % -% \Name[Mustafa]{Kemal} was granted the name {\IndexInactive\AKA[Mustafa]{Kemal}{Ata\-türk}. We mention \AKA[Mustafa]{Kemal}{Ata\-türk} again.} +% \Name[Mustafa]{Kemal} was granted the name \begingroup\let\MainNameHook\NamesFormat \AKA[Mustafa]{Kemal}{Atatürk}\endgroup. We mention \AKA[Mustafa]{Kemal}{Atatürk} again. % \end{quote} -% Here we see that the tag is printed because \texttt{formatAKA} allows \cmd{\NamesFormat} to be called for the first use of {\IndexInactive\AKA[Mustafa]{Kemal}{Ata\-türk}}. % -% If we |\let\FrontNamesFormat\NamesFormat| we can get similar results in the front matter and its name system. -% -% I have not been quite honest above. Since I wanted to simulate multiple first uses of \cmd{\AKA}, which can print a tag only once unless you use the \texttt{alwaysformat} option, I inserted non-visible control sequences into some instances of |\AKA[Mustafa]{Kemal}{Atatürk}| in the example paragraphs above: -% \begin{quote}\footnotesize\setstretch{1.1} -% |\NameAddInfo{Atatürk}{| |(a| |special| |surname| |granted| |1934)}|\\ -% |\NameAddInfo{Ata\-türk}{| |(a| |special| |surname| |granted| |1934)}| +% Another\marginpar{\small\raggedleft\dbend} solution uses the \texttt{formatAKA} package option. In the example below, we simulate a first occurrence of \Name[Mustafa]{Kemal}. Then we simulate \texttt{formatAKA}. Finally, we use \cmd{\ForceName} with \cmd{\AKA}: +% \begin{quote}\small\setstretch{1.1} +% |\ForgetName[Mustafa]{Kemal}%|\hfill|first use|\\ +% |\makeatletter\@nameauth@AKAFormattrue\makeatother%|\hfill|formatAKA|\\ +% |\Name[Mustafa]{Kemal} was granted the name%|\\ +% |\AKA[Mustafa]{Kemal}{Atatürk}. We mention%|\\ +% |\AKA[Mustafa]{Kemal}{Atatürk} again.|\\[1ex] +% \ForgetName[Mustafa]{Kemal}\makeatletter\@nameauth@AKAFormattrue\makeatother\Name[Mustafa]{Kemal} was granted the name \ForceName\AKA[Mustafa]{Kemal}{Atatürk}. We mention \AKA[Mustafa]{Kemal}{Atatürk} again. % \end{quote} -% In order to prevent multiple index entries, I prevented the form |{Ata\-türk}| from appearing in the index via \cmd{\IndexInactive} within a scope.\medskip % -% Please remember to reset the formatting, if needed: +% There are other solutions for getting this result, such as using \cmd{\IncludeName*} or non-printing control sequences. One must decide the best approach for oneself. Please remember to reset the formatting, if needed: % \begin{quote}\small\setstretch{1.1} % |\let\NamesFormat\OldFormat|\\ % |\let\FrontNamesFormat\OldFrontFormat| @@ -2787,223 +3055,310 @@ Running "make install" installs the files in the local TeX tree. % \let\FrontNamesFormat\OldFrontFormat % % See Section~\ref{sec:internal} and page~\pageref{page:parser} for the decision paths and the logic used by the package. Presently, writing hook macros is much simpler. +% +% {\medskip\noindent\hbox{}\hfill\large Back to Section~\ref{sec:RefTables} \hfill\hbox{}} % \clearpage % % \subsubsection{Hooks: Advanced} % \label{sec:Hooksc} +% \AltFormatActive\begingroup % -% \begin{center}\bfseries The Name Parser for Hooks\end{center} -% \noindent The\marginpar{\large\raggedleft\textsf{\bfseries 3.0}} current modular design of \textsf{nameauth} (Section~\ref{sec:internal} and page~\pageref{page:parser}) permits one to predict the state of the macros and Boolean flags in the locked path. This means we can use that available information to ``start from scratch'' and completely ignore the parsed and formatted argument of the formatting hooks. We do that by having the hook take an argument: -% \begin{quote}\small\setstretch{1.1} -% |\renewcommand*|\meta{Hook}|[1]{|\texttt{\dots}|}| -% \end{quote} +% \begin{center}\bfseries Alternate Formatting\end{center} +% The\marginpar{\large\raggedleft\textsf{\bfseries 3.1}} alternate formatting framework now makes designing hooks much easier by providing some built-in features that add not only error protection but also ease of use. We enabled that framework at the beginning of this section with \cmd{\AltFormatActive} and take care not to use the names in this section elsewhere. % -% \DescribeMacro{\NameParser} -% There is a pared-down parser available to the package user called \cmd{\NameParser} that only can be used in a formatting hook, else it does nothing. Its sole purpose is to print a name how the regular \textsf{nameauth} parser does it, minus the capitalization extras. Reversing and commas are still usable. The way to use the parser is simple: -% \begin{quote}\small\setstretch{1.1} -% |\renewcommand*|\meta{Hook}|[1]|\\| {|\meta{$cseq_1$\dots $cseq_m$}| \NameParser |\meta{$cseq_n$\dots}|}| -% \end{quote} -% The notation \meta{$cseq_1$\dots $cseq_m$} and \meta{$cseq_n$\dots} means a number of control sequences that can change the way a name is parsed. The subsequent examples take advantage of this. +% Both \cmd{\AltFormatActive} and \cmd{\AltFormatActive*} set the internal Boolean flag \cmd{\@nameauth@AltFormattrue}, which enables alternate formatting. Additionally, \cmd{\AltFormatActive} sets \cmd{\@nameauth@DoAlttrue}, which ``switches on'' alternate formatting. \cmd{\AltFormatInactive} sets both flags false. % -% Also\marginpar{\small\raggedleft\dbend} be aware that if you designed your own hooks for versions of \textsf{nameauth} before 3.0, it remains highly likely that they still work, but without the newer features. Updating your custom hooks is strongly advised. +% The main feature\marginpar{\small\raggedleft\cmd{\CapThis}\break protection} of this framework is protecting against errors created when \cmd{\@nameauth@Cap} gets a misleading result from \cmd{\@nameauthUTFtest} and splits a token list in a way that causes an error. The alternate capping macro \cmd{\AltCaps} and \cmd{\CapThis} work mutually in \cmd{\@nameauth@Parse} to ensure that they do not interfere with each other, as we saw demonstrated in Section~\ref{sec:altformat}. % % \begin{center}\bfseries Continental Format\end{center} -% \noindent This implementation of Continental formatting prints surnames in small caps the first time they are used, then no small caps thereafter. Yet small caps are used consistently in the index. -% -% The font change from small caps to normal is generated only in the body text output. The way to handle that is by using \cmd{\noexpand}, since the name arguments in \textsf{nameauth} have to use \cmd{\protected@edef} to work right. -% -% In the document preamble, before defining any names, create the following boolean flag and macro: +% Here we look in greater detail at the more complex version of Continental formatting from Section~\ref{sec:altformat}. % +% Font changes \marginpar{\small\raggedleft changes\break in text} in the text occur with the short macros \cmd{\textSC}, \cmd{\textIT}, \cmd{\textBF}, and \cmd{\textUC}. They all look similar to \cmd{\textSC}. We therefore show just this one macro as an example from the package source. % \begin{quote}\small\setstretch{1.1} -% |\newif\ifSC|\\ -% |\SCtrue%|\hfill |We want small caps in the index|\\[1ex] -% |\def\DoFormat#1%|\\ -% |{%|\\ -% | \ifSC \textsc{#1}%|\hfill |Format small caps if true|\\ -% | \else #1%|\hfill |Do nothing if false|\\ -% | \fi|\\ +% |\newcommand*\textSC[1]{%|\\ +% | \if@nameauth@DoAlt\textsc{#1}\else#1\fi|\\ % |}| % \end{quote} -% \def\DoFormat#1{\ifSC\textsc{#1}\else#1\fi}% % -% \cmd{\DoFormat} is the key to this approach. We want a control sequence that will expand differently, depending on the state of this Boolean flag. -% Using \cmd{\noexpand} is another vital piece of the solution. -% \clearpage +% Using this method, formatting occurs in both the text and in the index if the \texttt{altformat} option or \cmd{\AltFormatActive} was used. If you use a name that uses these macros both within and outside of the alternate formatting regime, you will get spurious index entries.\footnote{Using \cmd{\AltFormatActive*} is interesting because it looks like the normal \textsf{nameauth} regime but prevents \cmd{\CapThis} from having its normal effect unless you use \cmd{\AltCaps}. With \cmd{\AltFormatActive*} if you use a name that has alternate formatting both within and outside of the alternate formatting regime, you may not get spurious index entries as long as control sequences are consistent.} % -% Since Continental formatting alters the surname, see how the formatting macro always appears in the \meta{SNN} field below as we start to define names: +% We plan to have small caps on by default, then off in subsequent uses. We thus use \cmd{\AltFormatActive} for the ``always on'' general condition, then redefine \cmd{\MainNameHook} because it is the subsequent use. We use \cmd{\AltOff} to suppress formatting. It works only in the formatting hooks. \cmd{\AltOff} toggles an internal flag that deactivates any changes. From the source, it looks like: % \begin{quote}\small\setstretch{1.1} -% {\noindent\footnotesize|\begin{nameauth}|\\ -% | \< JQA & John Quincy & \noexpand\DoFormat{Adams} & >|\\ -% | \< Aeths & & \noexpand\DoFormat{Æþelstan} & >|\\ -% | \< Chas & & \noexpand\DoFormat{Charles}, I & >|\\ -% | \< Cao & & \noexpand\DoFormat{Cao}, Cao & >|\\ -% | \< JRIII & John David & \noexpand\DoFormat{Rockefeller}, III & >|\\ -% | \< SDJR|\,|&|\,|Sammy|\,|&|\,|\noexpand\DoFormat{Davis},\noexpand\DoFormat{Jr}.|\,|& >|\\ -% |\end{nameauth}|} +% |\newcommand*\AltOff{%|\\ +% | \if@nameauth@InHook\@nameauth@DoAltfalse\fi|\\ +% |}| % \end{quote} % -% Now we must ensure that these names are sorted properly in the index. See again how the formatting must be present: +% Since the normal effects of \cmd{\CapThis} are disabled, \cmd{\AltCaps} does the job by capitalizing its argument in braces |{| |}| when it is used in a macro hook and triggered by \cmd{\CapThis}. The source looks like: % \begin{quote}\small\setstretch{1.1} -% {\noindent\footnotesize|\PretagName[John Quincy]%|\\ -% | {\noexpand\DoFormat{Adams}}{Adams, John Quincy}|\\ -% |\PretagName{\noexpand\DoFormat{Æþelstan}}{Aethelstan}|\\ -% |\PretagName{\noexpand\DoFormat{Charles}, I}{Charles 1}|\\ -% |\PretagName{\noexpand\DoFormat{Cao}, Cao}{Cao Cao}|\\ -% |\PretagName[John David]{\noexpand\DoFormat{Rockefeller}, III}%|\\ -% | {Rockefeller, John David, III}|\\ -% |\PretagName[Sammy]%|\\ -% | {\noexpand\DoFormat{Davis}, \noexpand\DoFormat{Jr}.}%|\\ -% | {Davis, Sammy, Jr.}|} +% |\newcommand*\AltCaps[1]{%|\\ +% | \if@nameauth@InHook|\\ +% | \if@nameauth@DoCaps\uppercase{#1}\else#1\fi|\\ +% | \else#1\fi|\\ +% |}| % \end{quote} % -% We save the hook macros if we want to recall them. +% It is important that these macros not expand too soon. We therefore must put \cmd{\noexpand} once before \cmd{\textSC}, etc., and once before \cmd{\AltCaps}. This is because the name arguments in \textsf{nameauth} have to use \cmd{\protected@edef} to work right. We will get to that when we set up the names and any applicable tags. +% +% Before we alter the formatting hooks, we can save the hook macros if we want to recall them (below) or we can use \cmd{\begingroup} and \cmd{\endgroup} to create a new scope and let that handle any changes. We use scoping in this section. +% +% The final step \emph{does not come} from the \textsf{nameauth} source. We must redefine the formatting hooks ourselves. One of the simplest ways to do this when using the \texttt{altformat} option or \cmd{\AltFormatActive} is: % \begin{quote}\small\setstretch{1.1} -% |\let\OldNamesFormat\NamesFormat|\\ -% |\let\OldFrontNamesFormat\FrontNamesFormat|\\ -% |\let\OldFrontHook\FrontNameHook|\\ -% |\let\OldMainHook\MainNameHook| +% |\renewcommand*\MainNameHook{\AltOff}| % \end{quote} -% -% \let\OldNamesFormat\NamesFormat% -% \let\OldFrontNamesFormat\FrontNamesFormat% -% \let\OldFrontHook\FrontNameHook% -% \let\OldMainHook\MainNameHook% -% We\marginpar{\large\raggedleft\textsf{\bfseries 3.0}} do not need to redefine either \cmd{\NamesFormat} or \cmd{\FrontNamesFormat} because we already set the default to be small caps. We redefine \cmd{\MainNameHook} and \cmd{\FrontNameHook} in order to \emph{suppress} formatting in subsequent uses of names. Currently, this is fairly easy.\footnote{A similar version of this example is in \texttt{examples.tex}, collocated with this manual.} +% Simple, \emph{oder}? If needed, we can \cmd{\let}\cmd{\FrontNameHook}\cmd{\MainNameHook}. +% \renewcommand*\MainNameHook{\AltOff}\let\FrontNameHook\MainNameHook +% If you want to suppress formatting altogether in the front matter, make the following change: |\let\FrontNamesFormat\MainNameHook|. +% +% Continental formatting usually alters at least one element in the required name field, as we see below: % \begin{quote}\small\setstretch{1.1} -% |\renewcommand*\MainNameHook[1]{\SCfalse\NameParser}|\\ -% |\let\FrontNameHook\MainNameHook| +% |\begin{nameauth}|\\ +% | \< Adams & John & \noexpand\textSC{Adams} & >|\\ +% | \< SDJR & Sammy & \noexpand\textSC{Davis},|\\ +% | \noexpand\textSC{Jr}. & >|\\ +% | \< HAR & & Harun, \noexpand\textSC%|\\ +% | {\noexpand\AltCaps{a}l-Rashid} & >|\\ +% | \< Mencius & & \noexpand\textSC{Mencius} & >|\\ +% |\end{nameauth}| % \end{quote} -% \renewcommand*\MainNameHook[1]{\SCfalse\NameParser}% -% \let\FrontNameHook\MainNameHook% % -% Here we see the results for both main- and front-matter names. Not only did we get the formatting that we wanted, but we also retained many other features.\bigskip +% Now we must ensure that these names are sorted properly in the index. See again how the formatting must be present: +% \begin{quote}\small\setstretch{1.1} +% |\PretagName[John]{\noexpand\textSC{Adams}}{Adams, John}|\\ +% |\PretagName[Sammy]%|\\ +% | {\noexpand\textSC{Davis}, \noexpand\textSC{Jr}.}%|\\ +% | {Davis, Sammy, Jr.}|\\ +% |\PretagName{Harun, \noexpand\textSC%|\\ +% | {\noexpand\AltCaps{a}l-Rashid}}{Harun al-Rashid}|\\ +% |\PretagName{\noexpand\textSC{Mencius}}{Mencius}| +% \end{quote} % -% {\footnotesize\noindent\begin{tabular}{llll}\toprule +% The use in the body text is not much different than normal, but only if we use the simplified interface. +% \begin{center} +% \small\noindent\begin{tabular}{llll}\toprule % First & Next & Long & Short \\\midrule -% \JQA & \JQA & \LJQA & \SJQA\\ -% \JRIII & \JRIII & \LJRIII & \SJRIII\\ -% \Aeths & \Aeths & \LAeths & \SAeths\\ -% \Chas & \Chas & \LChas & \SChas\\ -% \Cao & \Cao & \LCao & \SCao\\\bottomrule -% \end{tabular}} -% \clearpage +% \Adams & \Adams & \LAdams & \SAdams\\ +% \SDJR & \SDJR & \LSDJR & \SSDJR\\ +% \HAR & \HAR & \LHAR & \SHAR\\ +% \Mencius & \Mencius & \LMencius & \SMencius\\\bottomrule +% \end{tabular} +% \end{center} % % \begin{itemize}\small -% \item Punctuation detection still works: \SDJR. Then we have \SDJR. -% \item \cmd{\RevComma}\cmd{\LJQA} yields \RevComma\LJQA. All the reversing macros work. -% \item \cmd{\DropAffix}\cmd{\LJRIII} gives: \DropAffix\LJRIII. -% \item \cmd{\ForceFN}\cmd{\SChas} produces: ``\ForceFN\SChas'' instead of \cmd{\SChas} ``\SChas.'' This is, in fact, the correct result. -% \item Using the main interface requires some extra typing. For example,\\ -% |\ForgetName[John Quincy]{\noexpand\DoFormat{Adams}}\JQA|\\ -% results in \ForgetName[John Quincy]{\noexpand\DoFormat{Adams}}\JQA. +% \item Punctuation detection works: \LSDJR. Then we have \SDJR. +% \item \cmd{\DropAffix}\cmd{\LSDJR} gives \DropAffix\LSDJR. +% \item \cmd{\RevComma}\cmd{\LAdams} yields \RevComma\LAdams. All the reversing macros work. +% \item \cmd{\ForceName}\cmd{\ForceFN}\cmd{\SHAR} produces \ForceName\ForceFN\SHAR. If we add \cmd{\CapThis} we get \CapThis\ForceName\ForceFN\SHAR. The way that Continental resources treat certain affixes relates to similar issues in [\hyperlink{Mulvany}{Mulvany}, 168--73].\footnote{Handling non-Western names in Western sources can be a gray area. One ought take care to be culturally sensitive in these matters.} +% \item One must include the extra control sequences in all the macro arguments that use these names. % \end{itemize} % % \makeatletter\@nameauth@AKAFormattrue\makeatother -% Normally \cmd{\AKA} will not format alternate names. However, if we use the \texttt{formatAKA} option we can refer to \LCao\ as \AKA{\noexpand\DoFormat{Cao}, Cao}{\noexpand\DoFormat{Mengde}}, and again \AKA{\noexpand\DoFormat{Cao}, Cao}{\noexpand\DoFormat{Mengde}}. We get that with: +% If we use the \texttt{formatAKA} option we can refer to \Mencius\ as \AKA{\noexpand\textSC{Mencius}}{\noexpand\textSC{Meng}, Ke}, and again \AKA{\noexpand\textSC{Mencius}}{\noexpand\textSC{Meng}, Ke}. We get that with: % \begin{quote}\small\setstretch{1.1} -% |\PretagName{\noexpand\DoFormat{Mengde}}{Mengde}|\\ -% |\AKA{\noexpand\DoFormat{Cao}, Cao}{\noexpand\DoFormat{Mengde}}| +% |\PretagName{\noexpand\textSC{Meng}, Ke}{Meng Ke}|\\ +% |\AKA{\noexpand\textSC{Mencius}}{\noexpand\textSC{Meng}, Ke}| % \end{quote} % \makeatletter\@nameauth@AKAFormatfalse\makeatother % -% If you want to suppress formatting altogether in the front matter, make the following change: |\let\FrontNamesFormat\MainNameHook.| +% \begin{center}\bfseries Rolling Your Own: New Style\end{center} +% \noindent ``New style'' means that we are sticking closely with various package features that have been implemented already and look similar to the solutions in Section~\ref{sec:altformat}. Here we set out on the path to custom formatting. % -% When needed, we can use \cmd{\let} to restore the hooks to their old values. Please note, however, that the index entries will contain small caps, regardless of how we change the hook macros for the document text. -% \let\NamesFormat\OldNamesFormat% -% \let\FrontNamesFormat\OldFrontNamesFormat% -% \let\FrontNameHook\OldFrontHook% -% \let\MainNameHook\OldMainHook% +% When\marginpar{\small\raggedleft\dbend} redesigning formatting hooks, you should use \cmd{\AltFormatActive} or the \texttt{altformat} option to enable alternate formatting and prevent \cmd{\CapThis} from breaking your formatting macros. % -% \begin{center}\bfseries Caps within Formatting\end{center} -% \noindent This\marginpar{\small\raggedleft\dbend} method of redesigning the hooks must be used if you want to capitalize a name that is otherwise formatted in the index. All we need to do is modify the example above. We begin in similar fashion, but add a few extra bits. First come three Boolean flags that control the format changes. \texttt{\textbackslash ifItal} controls italics. \texttt{\textbackslash ifFirstCap} controls capitalization, and \texttt{\textbackslash ifInHook} is set true in a hook macro so that we do not capitalize outside of it.\footnote{One could use the internal flag \texttt{\textbackslash if@nameauth@InHook} to the same effect. A similar version of this example is in \texttt{examples.tex}, collocated with this manual.} +% We recommend using the internal package flag \cmd{\@nameauth@DoAlt}, which activates alternate formatting, \cmd{\@nameauth@DoCaps}, which handles capitalization, and \cmd{\@nameauth@InHook}, which is true when the formatting hooks are called. See page~\pageref{page:hooks} and following for examples of how the ready-made formatting macros are designed. If you create your own macros, they will look similar:\footnote{A similar version of this example is in \texttt{examples.tex}, collocated with this manual.} % \begin{quote}\small\setstretch{1.1} -% |\newif\ifItal%|\hfill |Flag to trigger italics|\\ -% |\newif\ifFirstCap%|\hfill |Flag to trigger caps|\\ -% |\newif\ifInHook%|\hfill |But only with a name in the body text|\\ -% |\Italtrue%|\hfill |We want italics in the index| +% |\makeatletter%|\\ +% |\newcommand*\Fbox[1]{%|\\ +% | \if@nameauth@DoAlt\fbox{#1}\else#1\fi|\\ +% |}|\\ +% |\makeatother| % \end{quote} +% \makeatletter\newcommand*\Fbox[1]{\if@nameauth@DoAlt\fbox{#1}\else#1\fi}\makeatother % -% This \cmd{\DoFormat} below is quite similar to the previous example. In fact, if you take the names from the previous example and use them here, this will change the appearance not only in the body text but also in the index, creating a separate set of entries (at least with \texttt{makeindex}). +% Since \cmd{\AltCaps} is part of \textsf{nameauth}, you need not reinvent that particular wheel. As was the case previously, the final step is redefining the formatting hooks. One of the simplest ways to do this is: % \begin{quote}\small\setstretch{1.1} -% |\def\DoFormat#1%|\\ -% |{%|\\ -% | \ifItal \textit{#1}%|\\ -% | \else #1%|\\ -% | \fi|\\ -% |}| +% |\renewcommand*\MainNameHook{\AltOff}|\\ +% |\let\FrontNameHook\MainNameHook| % \end{quote} -% \def\DoFormat#1{\ifItal\textit{#1}\else#1\fi}% -% \clearpage % -% Here is the macro that achieves capitalization in the name. Please put its argument within braces to avoid breaking active Unicode characters in NFSS. We have to restrict the operation of this macro to a formatting hook via \texttt{\textbackslash ifInHook}. +% When defining names, be sure to use \cmd{\noexpand} before the control sequences in the macro arguments so they expand at the proper time: % \begin{quote}\small\setstretch{1.1} -% |\def\CP#1%|\\ -% |{%|\\ -% | \ifInHook|\\ -% | \ifFirstCap \uppercase{#1}%|\\ -% | \else #1%|\\ -% | \fi|\\ -% | \else #1%|\\ -% | \fi|\\ -% |}|\\ -% |\newcommand*\CapMe{\FirstCaptrue}| -% \end{quote} -% \def\CP#1{\ifInHook\ifFirstCap\uppercase{#1}\else#1\fi\else#1\fi}% -% \newcommand*\CapMe{\FirstCaptrue} +% |\PretagName[Pierre-Jean]%|\\ +% | {\noexpand\Fbox{\noexpand\AltCaps{d}e Smet}}%|\\ +% | {de Smet, Pierre-Jean}|\medskip % -% Like the previous example, you put the formatting in the naming macro arguments. Remember to ensure that \cmd{\CP} does not break active characters by putting its argument in braces. -% \begin{quote}\footnotesize\setstretch{1.1} -% |\PretagName[Pierre-Jean]{\noexpand\DoFormat{\noexpand\CP{d}e Smet}}%|\\ -% | {de Smet, Pierre-Jean}|\\ % |\begin{nameauth}|\\ -% | \<| |deSmet| |&| |Pierre-Jean| |&| |\noexpand\DoFormat{\noexpand\CP{d}e| |Smet}}| |&| |>|\\ +% | \< deSmet & Pierre-Jean &|\\ +% | \noexpand\Fbox{\noexpand\AltCaps{d}e Smet}} & >|\\ % |\end{nameauth}| % \end{quote} % -% You need to have \cmd{\global} before \cmd{\FirstCapfalse} to ensure that the change persists beyond the scope of the hook. +% Now we show how the formatting hooks work in the body text. One can check the index to see that it is formatted properly and consistently. +% \begin{center}\footnotesize +% \begin{tabular}{llll}\toprule +% First & Next & Long & Short \\\midrule +% |\deSmet| & |\deSmet| & |\LdeSmet| & |\SdeSmet|\\ +% \deSmet & \deSmet & \LdeSmet & \SdeSmet\\\bottomrule +% \end{tabular} +% \end{center} +% +% The capitalized version |\CapThis\deSmet| is \CapThis\deSmet. This also works for a formatted use via \cmd{\ForceName}: \ForceName\CapThis\deSmet. The index entries will be consistent for all the variations in the text. +% +% Also, remember to restore the macro hooks if they should not persist for the entire document, or else you will get unwanted results. +% +% \begin{center}\bfseries Rolling Your Own: Old Style\end{center} +% The idea of ``old style'' conveys the meaning that these approaches have something of an independent design that goes beyond what the package offers. Since older \textsf{nameauth} versions had less integration of Continental formatting, we use this parlance. Here we start to use more of our own solutions for dealing with name formatting. We begin that journey by looking at \cmd{\NameParser}. +% +% \DescribeMacro{\NameParser} +% This user-accessible parser\marginpar{\large\raggedleft\textsf{\bfseries 3.1}} (page~\pageref{page:parser}) builds a name from the internal macros \cmd{\FNN}, \cmd{\SNN}, \cmd{\rootb} and \cmd{\suffb}. Reversing and commas are still usable; capitalization depends on the context. The general form is: +% \begin{quote}\small\setstretch{1.1} +% |\renewcommand*|\meta{Hook}|[1]{|\texttt{\dots}\cmd{\NameParser}\texttt{\dots}|}| +% \end{quote} +% In order to use this hook-level parser, we want the option of ignoring the text that is sent to the formatting hooks from \cmd{\@nameauth@Parse}. We do that by redefining the hooks to take an argument. +% +% If we use the \texttt{altformat} option or \cmd{\AltFormatActive}, then alternate formatting is both enabled and ``switched on''; whatever formatting macros that we are using should be in the ``on'' state. If we want subsequent uses of names to be in the ``off'' state, we can design a hook like: +% \begin{quote}\small\setstretch{1.1} +% |\renewcommand*|\meta{Hook}|[1]{|\texttt{\dots}\cmd{\AltOff}\cmd{\NameParser}\texttt{\dots}|}| +% \end{quote} % -% If you want to use italics all the time, just \cmd{\let} all the hooks be \cmd{\NamesFormat}. If you want to follow the style of the previous example above, you do: +% If we used \cmd{\AltFormatActive*}, where the formatting macros are ``switched off'' but enabled nonetheless, then we might want a hook that turns the macros ``on'' instead: % \begin{quote}\small\setstretch{1.1} +% |\renewcommand*|\meta{Hook}|[1]{|\texttt{\dots}\cmd{\AltOn}\cmd{\NameParser}\texttt{\dots}|}| +% \end{quote} +% +% We have shown\marginpar{\small\raggedleft\dbend} already that you do not really need \cmd{\NameParser} to use these switching macros in the hooks. Yet the user-level parser does have some handy uses, especially as we go further toward designing custom macros. For example, we demonstrate an extreme case based on Section~\ref{sec:Hooksa} where we modify some internal flags to have \cmd{\NameParser} to produce different syntactic forms than the normal output (index entries suppressed):\footnote{A similar version of this example is in \texttt{examples.tex}, collocated with this manual.} +% \begin{quote}\IndexInactive\small\setstretch{1.1}\makeatletter +% \renewcommand*\NamesFormat[1]{#1\unless\ifinner\marginpar{\small\raggedleft\@nameauth@FullNametrue\@nameauth@FirstNamefalse\@nameauth@EastFNfalse\NameParser}\fi} +% \renewcommand*\MainNameHook[1]{\AltOff#1\unless\ifinner\marginpar{\small\raggedleft\@nameauth@FullNamefalse\@nameauth@FirstNamefalse\@nameauth@EastFNfalse\NameParser}\fi} +% |\makeatletter|\\ +% |\renewcommand*\NamesFormat[1]{#1\unless\ifinner|\\ +% | \marginpar{\small\raggedleft%|\\ +% | \@nameauth@FullNametrue\@nameauth@FirstNamefalse%|\\ +% | \@nameauth@EastFNfalse\NameParser}\fi}|\\ +% |\renewcommand*\MainNameHook[1]{\AltOff#1\unless\ifinner|\\ +% | \marginpar{\small\raggedleft%|\\ +% | \@nameauth@FullNamefalse\@nameauth@FirstNamefalse%|\\ +% | \@nameauth@EastFNfalse\NameParser}\fi}|\\ +% |\makeatother|\makeatother +% +% \Name[Wm.]{\noexpand\textSC{Shakespeare}}\hfill |\Name[Wm.]{\noexpand\textSC{Shakespeare}}| +% +% \Name[Wm.]{\noexpand\textSC{Shakespeare}}\hfill |\Name[Wm.]{\noexpand\textSC{Shakespeare}}| +% +% \Name*[Wm.]{\noexpand\textSC{Shakespeare}}\hfill |\Name*[Wm.]{\noexpand\textSC{Shakespeare}}| +% +% \FName[Wm.]{\noexpand\textSC{Shakespeare}}[William]\hfill |\FName[Wm.]{\noexpand\textSC{Shakespeare}}[William]| +% +% \ForceName\Name[Wm.]{\noexpand\textSC{Shakespeare}}\\\hbox{}\hfill |\ForceName\Name[Wm.]{\noexpand\textSC{Shakespeare}}| +% \end{quote} +% +% In a first-use hook, the person's full name always is displayed in the margin. In a subsequent-use formatting hook, only a surname, ancient personal name, or mononym can be displayed in the margin. +% +% We use the \cmd{\NameParser} macro to re-create the name, but using different rules via the internal Boolean flags. The macros that toggle these flags are discussed elsewhere. These include: +% \begin{quote}\small\setstretch{1.1} +% |\if@nameauth@FullName|\hfill Print a full name if true.\\ +% |\if@nameauth@FirstName|\hfill Print a first name if true.\\ +% Only one or the other of these can be true to avoid undocumented behavior.\\[1ex] +% |\if@nameauth@RevThis|\hfill Reverse name order if true.\\ +% |\if@nameauth@EastFN|\hfill toggled by \cmd{\ForceFN}.\\ +% |\if@nameauth@RevThisComma|\hfill Reverse Western name, add comma.\\ +% Reversing without commas overrides reversing with commas. +% \end{quote} +% +% Please\marginpar{\small\raggedleft\dbend} be aware that if you designed your own hooks for versions of \textsf{nameauth} before 3.0, it remains likely that they still work, but without the newer features. Updating your custom hooks is advised. +% +% The older version of ``rolling your own'' is reminiscent of the newer way, but it has significant differences: +% \begin{itemize}\small +% \item We do not use the internal package macros. +% \item We best use \cmd{\NameParser} to generate the name in the hooks. It may be possible not to do so, but as we get more customized the user-level parser is a handy way to get reasonably predictable results. +% \item We still recommend using \cmd{\AltFormatActive} if you want to disable the normal effects of \cmd{\CapThis}. Otherwise redefine \cmd{\CapThis} (which is what we do below).\footnote{A similar version of this example is in \texttt{examples.tex}, collocated with this manual.} +% \end{itemize} +% +%\newif\ifFbox +%\newif\ifFirstCap +%\newif\ifInHook +%\Fboxtrue +% We define three Boolean flags and set one of them true by default. The \texttt{\textbackslash ifFbox} flag takes over the internal function of \texttt{\textbackslash @nameauth@DoAlt}, which is enabled by \cmd{\AltFormatActive}. The \texttt{\textbackslash ifFirstCap} flag takes over the internal function of \texttt{\textbackslash @nameauth@DoCaps}, which is enabled by \cmd{\CapThis}. The \texttt{\textbackslash ifInHook} flag replaces the internal function of \texttt{\textbackslash @nameauth@InHook}, which is enabled by the internal format hook dispatcher. +%\begin{quote}\small\setstretch{1.1} +% |\newif\ifFbox|\\ +% |\newif\ifFirstCap|\\ +% |\newif\ifInHook|\\ +% |\Fboxtrue| +%\end{quote} +% +%\renewcommand*\Fbox[1]{\ifFbox\fbox{#1}\else#1\fi} +% The formatting macro is like the new style, except it refers to \texttt{\textbackslash ifFbox}: +%\begin{quote}\small\setstretch{1.1} +% |\renewcommand*\Fbox[1]{%|\\ +% | \ifFbox\fbox{#1}\else#1\fi|\\ +% |}| +%\end{quote} +% +%\renewcommand*\AltCaps[1]{\ifInHook +% \ifFirstCap\uppercase{#1}\else#1\fi +% \else +% #1\fi} +% Our new \cmd{\AltCaps} works like the built-in version, except it does not use the internal macros and flags: +%\begin{quote}\small\setstretch{1.1} +% |\renewcommand*\AltCaps[1]{%|\\ +% | \ifInHook|\\ +% | \ifFirstCap\uppercase{#1}\else#1\fi|\\ +% | \else|\\ +% | #1%|\\ +% | \fi|\\ +% |}| +%\end{quote} +% +%\renewcommand*\CapThis{\FirstCaptrue} +%\renewcommand*\NamesFormat[1] +%{\InHooktrue\NameParser\InHookfalse\global\FirstCapfalse} +%\renewcommand*\MainNameHook[1] +%{\Fboxfalse\InHooktrue\NameParser\InHookfalse\global\FirstCapfalse\Fboxtrue} +%\let\FrontNamesFormat\Namesformat +%\let\FrontNameHook\MainNameHook +% Here we redefine \cmd{\CapThis} to use our flag instead of the internal flag: +%\begin{quote}\small\setstretch{1.1} +% |\renewcommand*\CapThis{\FirstCaptrue}| +%\end{quote} +% +% We have to do in our own hooks what the naming macros do internally in order to get the same exit conditions. In the new style, we do not have to define \cmd{\NamesFormat}. Here we have to define everything: +%\begin{quote}\small\setstretch{1.1} % |\renewcommand*\NamesFormat[1]|\\ % |{%|\\ % | \InHooktrue\NameParser\InHookfalse%|\\ % | \global\FirstCapfalse%|\\ -% |}|\\[1ex] +% |}| +%\end{quote} +% +% Instead of using just \cmd{\AltOff} before \cmd{\NameParser} below, we have to add a few extras in order to mimic the functions of the internal flags: +%\begin{quote}\small\setstretch{1.1} % |\renewcommand*\MainNameHook[1]|\\ % |{%|\\ -% | \Italfalse\InHooktrue\NameParser\InHookfalse%|\\ -% | \global\FirstCapfalse\Italtrue%|\\ -% |}|\\[1ex] -% |\let\FrontNamesFormat\NamesFormat|\\ +% | \Fboxfalse\InHooktrue\NameParser\InHookfalse%|\\ +% | \global\FirstCapfalse\Fboxtrue%|\\ +% |}| +%\end{quote} +% +% We let the front-matter hooks be like the main-matter hooks to avoid spurious index entries. +%\begin{quote}\small\setstretch{1.1} +% |\let\FrontNamesFormat\Namesformat|\\ % |\let\FrontNameHook\MainNameHook| -% \end{quote} -% \renewcommand*\NamesFormat[1]{\InHooktrue\NameParser\InHookfalse\global\FirstCapfalse}% -% \renewcommand*\MainNameHook[1]{\Italfalse\InHooktrue\NameParser\InHookfalse\global\FirstCapfalse\Italtrue}% -% \let\FrontNamesFormat\NamesFormat% -% \let\FrontNameHook\MainNameHook% -% Now we show how the formatting hooks work in the body text. One can check the index to see that it is formatted with italics and is consistent.\medskip +%\end{quote} % +% Because we uses \cmd{\noexpand}, our ``old-style'' macros will index the name below under the same entry as the ``new-style'' macros. % \begin{center}\footnotesize % \begin{tabular}{llll}\toprule % First & Next & Long & Short \\\midrule % |\deSmet| & |\deSmet| & |\LdeSmet| & |\SdeSmet|\\ -% \deSmet & \deSmet & \LdeSmet & \SdeSmet\\\bottomrule +% \ForgetThis\deSmet & \deSmet & \LdeSmet & \SdeSmet\\\bottomrule % \end{tabular} % \end{center} % -% The capitalized version |\CapMe\deSmet| is \CapMe\deSmet. This also works for a formatted use: \let\MainNameHook\NamesFormat\CapMe\deSmet. The index entries will be consistent for all the variations in the text. +% The capitalized version |\CapThis\deSmet| is \CapThis\deSmet. This also works for a formatted use via \cmd{\ForceName}: \ForceName\CapThis\deSmet. % -% Also, remember to restore the macro hooks if they should not persist for the entire document, or else you will get unwanted results: -% \begin{quote}\small\setstretch{1.1} -% |\let\NamesFormat\OldNamesFormat%|\\ -% |\let\FrontNamesFormat\OldFrontNamesFormat%|\\ -% |\let\FrontNameHook\OldFrontHook%|\\ -% |\let\MainNameHook\OldMainHook%| -% \end{quote} -% \let\NamesFormat\OldNamesFormat% -% \let\FrontNamesFormat\OldFrontNamesFormat% -% \let\FrontNameHook\OldFrontHook% -% \let\MainNameHook\OldMainHook% +% Be sure not to use names with alternate formatting outside of those sections, or else you will get spurious index entries. We now resume normal formatting with \cmd{\AltFormatInactive}.% \AltFormatInactive\endgroup +% +% {\medskip\noindent\hbox{}\hfill\large Back to Section~\ref{sec:RefTables} \hfill\hbox{}} % % \subsubsection{Full Redesign} % \label{sec:NewEngine} @@ -3051,155 +3406,37 @@ Running "make install" installs the files in the local TeX tree. % Here we show that \cmd{\NameauthName}, \cmd{\NameauthLName}, and \cmd{\NameauthFName} have reverted back to their original forms. Now |\Name[No Particular]{Name}| and \cmd{\Silly} produce {\IndexInactive\Name[No Particular]{Name} and \Silly.} % \clearpage % -% \subsection{Naming Pattern Reference} -% \label{sec:PatRef} -% -% \noindent{\bfseries Western Names}\\[2ex] -% We set up a \texttt{nameauth} environment for each section below.\footnote{For those who observe that \cmd{\Lewis} as defined here is different than earlier in this manual, five stars to the boarding school house of your choice. The \texttt{nameauth} environment permists one to make successive global redefinitions. Yet this is done at your own risk.} -% \begin{quote}\small\setstretch{1.1} -% |\begin{nameauth}|\\ -% | \< Einstein & Albert & Einstein & >|\\ -% | \< Lewis & Clive Staples & Lewis & >|\\ -% |\end{nameauth}| -% \end{quote} -% \begin{nameauth} -% \< Lewis & Clive Staples & Lewis & > -% \end{nameauth} -% {\footnotesize\setstretch{1.1}\ForgetName[Albert]{Einstein}\ForgetName[Clive Staples]{Lewis} -% \begin{tabular}{p{0.33\textwidth}@{}p{0.19\textwidth}@{}p{0.42\textwidth}}\toprule -% \textit{First reference in the text}:\newline\hbox to 1em{\hfil} \Name [Albert]{Einstein} & \cmd{\Einstein} \cmd{\LEinstein} \cmd{\SEinstein}& |\Name [Albert]{Einstein}| |\Name*[Albert]{Einstein}| |\FName[Albert]{Einstein}|\\[1ex] -% \textit{Subseq. full}: \Name*[Albert]{Einstein} & \cmd{\LEinstein} & |\Name*[Albert]{Einstein}|\\[1ex] -% \textit{Subsequent surname}: \Name [Albert]{Einstein} & \cmd{\Einstein} & |\Name [Albert]{Einstein}|\\[1ex] -% \textit{Subsequent forename}: \FName[Albert]{Einstein} & \cmd{\SEinstein} & |\FName[Albert]{Einstein}|\\\midrule -% \textit{Long first reference}: \newline\hbox to 1em{\hfil}\Lewis & \cmd{\Lewis}\newline \cmd{\LLewis}\newline \cmd{\SLewis} & |\Name [Clive Staples]{Lewis}| |\Name*[Clive Staples]{Lewis}| |\FName[Clive Staples]{Lewis}|\\[1ex] -% \textit{Subsequent full}: \LLewis[C.S.] & \cmd{\LLewis[C.S.]} & |\Name*[Clive Staples]{Lewis}[C.S.]|\\[1ex] -% \textit{Subsequent surname}: \Lewis [C.S.] & \cmd{\Lewis\ [C.S.]} \cmd{\Lewis} & |\Name [Clive Staples]{Lewis}[C.S.]|\newline |\Name [Clive Staples]{Lewis}|\\[1ex] -% \textit{Alternate}: \SLewis[Jack] & \cmd{\SLewis[Jack]} & |\FName[Clive Staples]{Lewis}[Jack]|\\\bottomrule -% \end{tabular}}\bigskip -% -% \noindent{\bfseries Western Plus Affixes}\\[2ex] -% Always use a comma to delimit name/affix pairs. -% \begin{quote}\small\setstretch{1.1} -% |\begin{nameauth}|\\ -% | \< Patton & George S. & Patton, Jr. & >|\\ -% |\end{nameauth}| -% \end{quote} -% {\footnotesize\setstretch{1.1}\ForgetName[George S.]{Patton, Jr.} -% \begin{tabular}{p{0.35\textwidth}@{}p{0.18\textwidth}@{}p{0.41\textwidth}}\toprule -% \textit{First reference}:\newline\hbox to 1em{\hfil}\Name [George S.]{Patton, Jr.} & \cmd{\Patton} \cmd{\LPatton} \cmd{\SPatton} & |\Name [George S.]{Patton, Jr.}|\newline |\Name*[George S.]{Patton, Jr.}|\newline |\FName[George S.]{Patton, Jr.}|\\[1ex] -% \textit{Subsequent full}:\newline\hbox to 1em{\hfil}\Name*[George S.]{Patton, Jr.} & \cmd{\LPatton} & |\Name*[George S.]{Patton, Jr.}|\newline\\[1ex] -% \textit{Subsequent surname}: \Name [George S.]{Patton, Jr.} & \cmd{\Patton} & |\Name [George S.]{Patton, Jr.}|\\[1ex] -% \textit{Subsequent forename}: \FName[George S.]{Patton, Jr.} & \cmd{\SPatton} & |\FName[George S.]{Patton, Jr.}|\\\midrule -% \end{tabular}\\ -% \begin{tabular}{p{0.35\textwidth}@{}p{0.59\textwidth}} -% \textit{Alternate forename}: \FName[George S.]{Patton, Jr.}[George] & \cmd{\SPatton[George]} \\ -% & |\FName[George S.]{Patton, Jr.}[George]|\\\bottomrule -% \end{tabular}} -% \clearpage -% -% \noindent{\bfseries New Syntax: Non-Western} -% \begin{quote}\small\setstretch{1.1} -% |\begin{nameauth}|\\ -% | \< Francis & & Francis, I & >|\\ -% | \< Dem & & Demetrius, I & >|\\ -% | \< Sun & & Sun, Yat-sen & >|\\ -% | \< Attil & & Attila, the Hun & >|\\ -% | \< Plato & & Plato & >|\\ -% |\end{nameauth}| -% \end{quote} -% For sobriquets, one could use |\Name{Demetrius, I Soter}| to keep the number with the affix or |\Name{Demetrius I, Soter}| to keep the number with the name. We recommend, however, that you use text tags and index tags for ``Soter'' (Sections~\ref{sec:indextag} and~\ref{sec:tagtext}). That is what we do below: -% \begin{quote}\small\setstretch{1.1} -% |\NameAddInfo{Demetrius, I}{Soter}|\\ -% |\def\Soter{\NameQueryInfo{Demetrius, I}}|\\ -% |\TagName{Demetrius, I}{ Soter}| -% \end{quote} -% \NameAddInfo{Demetrius, I}{Soter}\def\Soter{\NameQueryInfo{Demetrius, I}}\ignorespaces% -% {\footnotesize\setstretch{1.1}\ForgetName{Francis, I}\ForgetName{Demetrius, I Soter}\ForgetName{Sun, Yat-sen}\ForgetName{Attila, the Hun}\ForgetName{Plato}\ignorespaces% -% \begin{tabular}{p{0.34\textwidth}@{}p{0.21\textwidth}@{}p{0.39\textwidth}}\toprule -% \textit{First reference}: \Name{Francis, I} & \cmd{\Francis}\newline \cmd{\LFrancis}\newline \cmd{\SFrancis} & |\Name {Francis, I}|\newline |\Name*{Francis, I}|\newline |\FName{Francis, I}|\\[1ex] -% \textit{Subsequent full}: \Name*{Francis, I} & \cmd{\LFrancis} & |\Name*{Francis, I}|\\[1ex] -% \textit{Subsequent name}: \Name{Francis, I} & \cmd{\Francis}\newline \cmd{\SFrancis} & |\Name {Francis, I}|\newline |\FName{Francis, I}|\\\midrule -% \textit{First reference}: \newline\hbox to 1em{\hfil}\Name{Demetrius, I}\ \Soter & |\Dem\ \Soter|\newline|\LDem\ \Soter|\newline|\SDem\ \Soter| & |\Name {Demetrius, I}\ \Soter|\newline |\Name*{Demetrius, I}\ \Soter|\newline |\FName{Demetrius, I}\ \Soter|\\[1ex] -% \textit{Subsequent full}: \Name*{Demetrius, I} & |\LDem| & |\Name*{Demetrius, I}|\\[1ex] -% \textit{Subsequent name}: \Name{Demetrius, I}\ & |\Dem|\newline|\SDem| & |\Name {Demetrius, I}|\newline |\FName{Demetrius, I}|\\\midrule -% \textit{First reference}:\newline\hbox to 1em{\hfil}\Name{Sun, Yat-sen} & \cmd{\Sun}\newline\cmd{\LSun}\newline\cmd{\SSun} & |\Name {Sun, Yat-sen}|\newline |\Name*{Sun, Yat-sen}|\newline |\FName{Sun, Yat-sen}|\\[1ex] -% \textit{Subsequent full}: \Name*{Sun, Yat-sen} & \cmd{\LSun} & |\Name*{Sun, Yat-sen}|\\[1ex] -% \textit{Subsequent name}: \Name{Sun, Yat-sen} & \cmd{\Sun}\newline\cmd{\SSun} & |\Name {Sun, Yat-sen}|\newline |\FName{Sun, Yat-sen}|\\[1ex] -% \textit{Personal name}: \ForceFN\SSun & \cmd{\ForceFN}\cmd{\SSun} & |\ForceFN\FName{Sun, Yat-sen}|\\\midrule -% \textit{All references}: \Name{Plato} & \cmd{\Plato}\newline\cmd{\LPlato}\newline\cmd{\SPlato} & |\Name {Plato}|\newline |\Name*{Plato}|\newline |\FName{Plato}|\\\bottomrule -% \end{tabular}}\bigskip -% -% You also can ``stack'' \cmd{\CapThis}, \cmd{\CapName}, \cmd{\RevName}, \cmd{\KeepAffix}, and so on in front of these control sequences. |\CapName\LSun| generates \CapName\LSun. For a fuller listing, see Section~\ref{sec:start}. -% \clearpage -% -% \noindent{\bfseries Old Syntax: Royal and Eastern} -% \begin{quote}\small\setstretch{1.1} -% |\begin{nameauth}|\\ -% | \< Henry & & Henry & VIII >|\\ -% | \< Ptol & & Ptolemy & I >|\\ -% | \< Mao & & Mao & Tse-tung >|\\ -% |\end{nameauth}| -% \end{quote} -% For sobriquets, one could use |\Name{Ptolemy, I Soter}| to keep the number with the affix or |\Name{Ptolemy I, Soter}| to keep the number with the name. We recommend, however, that you use text tags and index tags for ``Soter'' (Sections~\ref{sec:indextag} and~\ref{sec:tagtext}). That is what we do below: -% \begin{quote}\small\setstretch{1.1} -% |\NameAddInfo{Ptolemy}[I]{Soter}|\\ -% |\def\Soter{\NameQueryInfo{Ptolemy}[I]}|\\ -% |\TagName{Ptolemy}[I]{ Soter}| -% \end{quote} -% \NameAddInfo{Ptolemy}[I]{Soter}\def\Soter{\NameQueryInfo{Ptolemy}[I]}\ignorespaces% -% {\footnotesize\setstretch{1.1}\ForgetName{Henry}[VIII]\ForgetName{Ptolemy}[I Soter]\ForgetName{Mao}[Tse-tung] -% \begin{tabular}{p{0.37\textwidth}@{}p{0.20\textwidth}@{}p{0.37\textwidth}}\toprule -% \textit{First reference}: \Name{Henry}[VIII]\ddag & \cmd{\Henry}\newline \cmd{\LHenry}\newline \cmd{\SHenry} & |\Name {Henry}[VIII]|\newline |\Name*{Henry}[VIII]|\newline |\FName{Henry}[VIII]|\\[1ex] -% \textit{Subsequent full}: \Name*{Henry}[VIII]\ddag & \cmd{\LHenry} & |\Name*{Henry}[VIII]|\\[1ex] -% \textit{Subsequent name}: \Name{Henry}[VIII]\ddag & \cmd{\Henry}\newline \cmd{\SHenry} & |\Name {Henry}[VIII]|\newline |\FName{Henry}[VIII]|\\\midrule -% \textit{First reference}: \Name{Ptolemy}[I]\ \Soter\ddag & |\Ptol\ \Soter|\newline|\LPtol\ \Soter|\newline|\SPtol\ \Soter| & |\Name {Ptolemy}[I]\ \Soter|\newline |\Name*{Ptolemy}[I]\ \Soter|\newline |\FName{Ptolemy}[I]\ \Soter|\\[1ex] -% \textit{Subsequent full}: \Name*{Ptolemy}[I]\ddag & |\LPtol| & |\Name*{Ptolemy}[I]|\\[1ex] -% \textit{Subsequent name}: \Name{Ptolemy}[I]\ddag & |\Ptol|\newline|\SPtol| & |\Name {Ptolemy}[I]|\newline |\FName{Ptolemy}[I]|\\\midrule -% \textit{First reference}:\newline \hbox to 1em{\hfil}\Name{Mao}[Tse-tung]\ddag & \cmd{\Mao}\newline \cmd{\LMao}\newline \cmd{\SMao} & |\Name {Mao}[Tse-tung]|\newline |\Name*{Mao}[Tse-tung]|\newline |\FName{Mao}[Tse-tung]|\\[1ex] -% \textit{Subsequent full}: \Name*{Mao}[Tse-tung]\ddag & \cmd{\LMao} & |\Name*{Mao}[Tse-tung]|\\[1ex] -% \textit{Subsequent name}: \Name{Mao}[Tse-tung]\ddag & \cmd{\Mao}\newline \cmd{\SMao} & |\Name {Mao}[Tse-tung]|\newline |\FName{Mao}[Tse-tung]|\\[1ex] -% \textit{Personal name}: \ForceFN\SMao & \cmd{\ForceFN}\cmd{\SMao} & |\ForceFN\FName{Mao}[Tse-tung]|\\\bottomrule -% \end{tabular}}\bigskip -% -% There used to be\marginpar{\large\raggedleft\textsf{\bfseries 3.0}\break\small\raggedleft\dbend} more ambiguity between the new syntax and the old syntax. That has been cleared up in present versions. Now it is clear that the new syntax takes precedence. |\Name*{Æthelred, II}[the Unready]| prints ``\Name*{Æthelred, II}[the Unready]'' in the body text and ``Æthelred, II'' in the index. In former versions of this package it would have produced ``Æthelred, II the Unready'' in the text and in the index. \textbf{Since the older behavior was discouraged, it no longer will be supported and no backward compatibility will exist.} -% -% Sections~\ref{sec:tagtext} and~\ref{sec:indextag}, as well as this section, show how one might use tags to handle ``the Unready'' in a more complex and more consistent manner. -% \clearpage -% -% \noindent\textbf{Particles, American Style} -% \begin{quote}\small\setstretch{1.1} -% |\begin{nameauth}|\\ -% | \< DLM & Walter & de la Mare & >|\\ -% | \< JWG & J.W. von & Goethe & >|\\ -% | \< Harnack & Adolf & Harnack & >|\\ -% |\end{nameauth}| -% \end{quote} -% {\footnotesize\setstretch{1.1}\ForgetName[Walter]{de la Mare} -% \begin{tabular}{p{0.35\textwidth}@{}p{0.18\textwidth}@{}p{0.41\textwidth}}\toprule -% \textit{First}: \Name[Walter]{de la Mare} & \cmd{\DLM}\newline \cmd{\LDLM}\newline \cmd{\SDLM} & |\Name [Walter]{de la Mare}|\newline |\Name*[Walter]{de la Mare}|\newline |\FName[Walter]{de la Mare}|\\[1ex] -% \textit{Subsequent}: \Name[Walter]{de la Mare} & \cmd{\DLM} & |\Name [Walter]{de la Mare}|\\[1ex] -% \textit{Start of sentence}: \CapThis\Name[Walter]{de la Mare} & \cmd{\CapThis}\cmd{\DLM} & |\CapThis\Name[Walter]{de la Mare}|\\[1ex] -% \textit{Forename}: \FName[Walter]{de la Mare} & \cmd{\SDLM} & |\FName[Walter]{de la Mare}|\\\bottomrule -% \end{tabular}}\\[2ex] -% -% \noindent\textbf{Particles, European Style, in the Index}\\[2ex] -% {\footnotesize\setstretch{1.1} -% \begin{tabular}{p{0.27\textwidth}@{ }p{0.33\textwidth}@{}p{0.34\textwidth}}\toprule -% \textit{First use}:\newline \hbox to 1em{\hfil}\Name[J.W. von]{Goethe}[Johann Wolfgang von] & |\JWG [Johann Wolfgang von]|\newline |\LJWG[Johann Wolfgang von]|\newline |\SJWG[Johann Wolfgang von]| & |\Name [J.W. von]{Goethe}%|\newline| [Johann Wolfgang von]|\newline |\Name*[J.W. von]{Goethe}%|\newline| [Johann Wolfgang von]|\newline |\FName[J.W. von]{Goethe}%|\newline| [Johann Wolfgang von]|\\[1ex] -% \textit{Subsequent}: \Name[J.W. von]{Goethe} & \cmd{\JWG} & |\Name [J.W. von]{Goethe}|\\[1ex] -% \textit{Forenames}: \FName[J.W. von]{Goethe}[Johann Wolfgang] & |\SJWG[Johann Wolfgang]| & |\FName[J.W. von]{Goethe}%|\newline|[Johann Wolfgang]|\\\bottomrule -% \end{tabular}}\\[2ex] -% -% \noindent\textbf{Particles, European Style, Not in the Index}\\[2ex] -% {\footnotesize\setstretch{1.1} -% \begin{tabular}{p{0.26\textwidth}@{}p{0.27\textwidth}@{}p{0.41\textwidth}}\toprule -% \textit{First}:\newline \hbox to 1em{\hfil}\Name[Adolf]{Harnack}[Adolf von] & |\Harnack [Adolf von]|\newline |\LHarnack[Adolf von]|\newline |\SHarnack[Adolf von]| & |\Name [Adolf]{Harnack}[Adolf von]|\newline |\Name-[Adolf]{Harnack}[Adolf von]|\newline |\FName[Adolf]{Harnack}[Adolf von]|\\[1ex] -% \textit{Subsequent full}:\newline \hbox to 1em{\hfil}\Name*[Adolf]{Harnack}[Adolf von] & |\LHarnack[Adolf von]| & |\Name*[Adolf]{Harnack}[Adolf von]|\\ -% \textit{Subseq. last}: \Name[Adolf]{Harnack} & |\Harnack| & |\Name [Adolf]{Harnack}|\\[1ex] -% \textit{Subseq. first}: \FName[Adolf]{Harnack} & |\SHarnack| & |\FName[Adolf]{Harnack}|\\\bottomrule -% \end{tabular}}\bigskip -% -% You will not see \Harnack's ``von'' in the index because it was used only in the alternate forenames field. +% \subsection{Technical Notes} +% \label{sec:notes} +% About the package itself: +% \begin{itemize}\small +% \item We put great weight on being backward-compatible with older versions. +% \item Recent changes aim for simpler work flow, not more features. +% \item The package works with both \texttt{xindy} and \texttt{makeindex}. We recommend \texttt{xindy} for languages whose collating sequences do not map to English.\footnote{\cmd{\PretagName} may not be useful in that case. German \emph{does} map to English: ä, ö, ü, and ß are ae, oe, ue, and ss. Norwegian \emph{does not} map to English: æ, ø, and å come after z.} +% \item We\marginpar{\large\raggedleft\textsf{\bfseries 3.0}\strut} support alternate names in both Western and ``native'' Eastern forms. Mononyms and the older syntax for non-Western names do not support alternate names. +% \item Name\marginpar{\large\raggedleft\textsf{\bfseries 3.0}\strut} output, index entries, and index cross-references are independent modules. +% \item Warnings\marginpar{\large\raggedleft\textsf{\bfseries 3.0}\strut} for the indexing macros are suppressed unless one uses the \texttt{verbose} option. The \texttt{nameauth} environment will continue to emit warnings as needed. +% \item The\marginpar{\large\raggedleft\textsf{\bfseries 2.6}\strut} \texttt{comma} option and the older syntax are no longer restrictive, save with \cmd{\AKA} and its derivatives. See Sections~\ref{sec:obsolete}, \ref{sec:Affix}, and~\ref{sec:AKA}. +% \item No\marginpar{\large\raggedleft\textsf{\bfseries 2.5\strut}} formatting is selected by default. Cf. Sections~\ref{sec:formatting}, \ref{sec:Hooksa}, \ref{sec:Hooksb}, and~\ref{sec:Hooksc}. +% \end{itemize} +% \noindent About the manual: +% \begin{itemize}\small +% \item This manual is compatible with both A4 and US letter formats. +% \item For an index that focuses on using the names, we minimize macro references. +% \item We mention when this manual changes package internals for an example. +% \item The name pattern reference was removed for redundancy and obsolescence. +% \end{itemize} +% About package building: +% \begin{itemize}\small +% \item The \textsf{nameauth} package requires \textsf{etoolbox}, \textsf{suffix}, \textsf{trimspaces}, and \textsf{xargs}. The \texttt{dtx} file encoding is UTF-8; we cannot guarantee building and using this package on systems that are not Unicode-compliant. +% \item With each release, we test \textsf{nameauth} with dvi-mode \texttt{latex} and with pdf-mode engines \texttt{pdflatex}, \texttt{lualatex}, and \texttt{xelatex} using \texttt{makeindex}. We run the GNU Makefile with the ENGINE=\meta{engine} option.\footnote{The manual is used as the test suite. In dvi mode the manual omits all references to \emph{TikZ} because some dvi display programs (\emph{e.g.} \texttt{dviout}, but not \texttt{xdvi}) will emit errors about bad specials even if one just includes the \textsf{tikz} package. The \emph{TikZ} diagrams herein will appear as blank space in that case. This does not affect \textsf{nameauth} proper.} +% \item This package was built with \ifxetex\texttt{xelatex}\else +% \ifluatex\ifpdf\texttt{lualatex} in \texttt{pdf} mode\else +% \texttt{lualatex} in \texttt{dvi} mode\fi +% \else\ifpdf\texttt{pdflatex}\else +% \texttt{latex}\fi\fi\fi. This item changes per \LaTeX\ engine. +% \item This package is tested on Ubuntu Linux and Windows 7 (both vanilla \TeX\ Live). Cygwin provides \texttt{make} on Windows. The \texttt{pdflatex} version of this package is released from the Ubuntu platform to CTAN. +% \end{itemize} % \clearpage % % \subsection{Errors and Warnings} @@ -3232,7 +3469,7 @@ Running "make install" installs the files in the local TeX tree. % \item Use the \texttt{verbose} option for warnings from the indexing macros. % \item Using an index cross-reference name as a page entry. Nothing will happen. % \item Creating the same cross-reference multiple times. Nothing will happen. -% \item Creating a page reference after a cross-reference has been created or after you have used \cmd{\ExcludeName}. Nothing will happen until you use a variant of \cmd{\Includename}. +% \item Creating a page reference after a cross-reference has been created or after you have used \cmd{\ExcludeName}. Nothing happens until you use a variant of \cmd{\Includename}. % \item Using \cmd{\TagName} and \cmd{\UntagName} on cross-references. Nothing will happen. % \item Using \cmd{\PretagName} with cross-references will create sorting tags for them, but also will generate ``informational warnings'' only if the \texttt{verbose} option is selected. % \item Using \cmd{\ExcludeName} with cross-references. Nothing will happen. @@ -3256,7 +3493,7 @@ Running "make install" installs the files in the local TeX tree. % The flags below are grouped according to general function. We begin with flow control\medskip % % \noindent{\large\bfseries Who Called Me?}\\[0.5ex] -% These values are used by the format hook dispatcher \cmd{\@nameauth@Hook} and the hook macros to determine if they have been called by either \cmd{\@nameauth@Name} or \cmd{\AKA}, respectively. Those macros set these flags. On their use, see Sections~\ref{sec:Hooksb} and ~\ref{sec:Hooksc}. +% These values are used by the format hook dispatcher \cmd{\@nameauth@Hook} and the hook macros to determine if they have been called by either \cmd{\@nameauth@Name}, \cmd{\AKA}, or \cmd{\IndexRef}, respectively. Those macros set these flags. On their use, see also Sections~\ref{sec:Hooksb} and ~\ref{sec:Hooksc}. % \begin{macrocode} \newif\if@nameauth@InAKA \newif\if@nameauth@InName @@ -3272,9 +3509,11 @@ Running "make install" installs the files in the local TeX tree. % \end{macrocode}\smallskip % % \noindent{\large\bfseries Indexing}\\[0.5ex] -% As the naming macros have locks, so do the indexing macros. These locks permit or prevent both indexing and tags. \cmd{\IndexActive} and \cmd{\IndexInctive} or the \texttt{index} and \texttt{noindex} options toggle this flag: +% As the naming macros have locks, so do the indexing macros. These locks permit or prevent both indexing and tags. \cmd{\IndexActive} and \cmd{\IndexInctive} or the \texttt{index} and \texttt{noindex} options toggle the first flag; \cmd{\SkipIndex} toggles the second. \cmd{\JustIndex} toggles the third, which makes the core naming engine act like a call to \cmd{\IndexName}: % \begin{macrocode} \newif\if@nameauth@DoIndex +\newif\if@nameauth@SkipIndex +\newif\if@nameauth@JustIndex % \end{macrocode} % The \texttt{pretag} and \texttt{nopretag} options toggle the value below, which allows or prevents the insertion of sort keys. % \begin{macrocode} @@ -3291,10 +3530,15 @@ Running "make install" installs the files in the local TeX tree. \newif\if@nameauth@MainFormat \newif\if@nameauth@AKAFormat % \end{macrocode} -% The next value works with \cmd{\LocalNames} and \cmd{\GlobalNames}. +% The next flag works with \cmd{\LocalNames} and \cmd{\GlobalNames}. % \begin{macrocode} \newif\if@nameauth@LocalNames % \end{macrocode}\medskip +% These two flags trigger \cmd{\ForgetName} and \cmd{\SubvertName} within \cmd{\@nameauth@Name}. +% \begin{macrocode} +\newif\if@nameauth@Forget +\newif\if@nameauth@Subvert +% \end{macrocode}\medskip % \texttt{\textbackslash if@nameauth@FirstFormat} triggers the first-use hooks to be called; otherwise the second-use hooks are called. Additionally, \texttt{\textbackslash if@nameauth@AlwaysFormat} forces this true, except when \texttt{\textbackslash if@nameauth@AKAFormat} is false. % \begin{macrocode} \newif\if@nameauth@FirstFormat @@ -3312,9 +3556,10 @@ Running "make install" installs the files in the local TeX tree. % \end{macrocode}\medskip % % \noindent{\large\bfseries Name Breaking}\\[0.5ex] -% \cmd{\KeepAffix} toggles the flag below, which causes an \meta{SNN}-\meta{Affix} pair to have a non-breaking space between them. For ``native'' Eastern names this prevents the family name and personal name from breaking. +% \cmd{\KeepAffix} toggles the first flag below, while \cmd{\KeepName} toggles the second. Both affect the use of non-breaking spaces in the text. % \begin{macrocode} \newif\if@nameauth@NBSP +\newif\if@nameauth@NBSPX % \end{macrocode}\medskip % % \noindent{\large\bfseries Detect Punctuation}\\[0.5ex] @@ -3324,7 +3569,11 @@ Running "make install" installs the files in the local TeX tree. % \end{macrocode}\medskip % % \noindent{\large\bfseries Long and Short Names}\\[0.5ex] -% \texttt{\textbackslash if@nameauth@FullName} is true in any case where a long name reference is desired. \texttt{\textbackslash if@nameauth@FirstName} disables full-name references and causes only Western forenames to be displayed. \texttt{\textbackslash if@nameauth@AltAKA} is toggled respectively by \cmd{\AKA} and \cmd{\AKA*} to print a longer or shorter name. \texttt{\textbackslash if@nameauth@OldAKA} forces the pre-3.0 behavior of \cmd{\AKA*}. \texttt{\textbackslash if@nameauth@ShortSNN} is used with \cmd{\DropAffix} to suppress the affix of a Western name. \texttt{\textbackslash if@nameauth@EastFN} toggles the forced printing of Eastern forenames. +% \texttt{\textbackslash if@nameauth@FullName} is true for a long name reference. \texttt{\textbackslash if@nameauth@FirstName} disables full-name references and causes only Western forenames to be displayed. +% +% \texttt{\textbackslash if@nameauth@AltAKA} is toggled respectively by \cmd{\AKA} and \cmd{\AKA*} to print a longer or shorter name. \texttt{\textbackslash if@nameauth@OldAKA} forces the pre-3.0 behavior of \cmd{\AKA*}. +% +% \texttt{\textbackslash if@nameauth@ShortSNN} is used with \cmd{\DropAffix} to suppress the affix of a Western name. \texttt{\textbackslash if@nameauth@EastFN} toggles the forced printing of Eastern forenames. % \begin{macrocode} \newif\if@nameauth@FullName \newif\if@nameauth@FirstName @@ -3351,11 +3600,13 @@ Running "make install" installs the files in the local TeX tree. % \end{macrocode}\medskip % % \noindent{\large\bfseries Capitalize First Letter}\\[0.5ex] -% The next three flags deal with first-letter capitalization. The first Boolean value is triggered by \cmd{\CapThis} and reset by \cmd{\Name} and \cmd{\AKA}. The second is triggered by \cmd{\@nameauth@UTFtest} when it encounters a Unicode character under NFSS. The third is an ``override switch'' triggered by \cmd{\AccentCapThis} as a fall-back in case there is a problem with the detection. +% The next flags deal with first-letter capitalization. The first Boolean value is triggered by \cmd{\CapThis} and reset by \cmd{\Name} and \cmd{\AKA}. The second is triggered by \cmd{\@nameauth@UTFtest} when it encounters a Unicode character under NFSS. The third is an ``override switch'' triggered by \cmd{\AccentCapThis} as a fall-back. The fourth prevents the first-letter capping mechanism from interacting with Continental formatting and the fifth toggles it. % \begin{macrocode} \newif\if@nameauth@DoCaps \newif\if@nameauth@UTF \newif\if@nameauth@Accent +\newif\if@nameauth@AltFormat +\newif\if@nameauth@DoAlt % \end{macrocode}\medskip % % \noindent{\large\bfseries Warning Levels}\\[0.5ex] @@ -3386,42 +3637,42 @@ Running "make install" installs the files in the local TeX tree. % \end{macrocode} % \end{macro} % \begin{macro}{\MainNameHook} -% \changes{v2.4}{2016/03/15}{Added} +% \changes{2.4}{2016/03/15}{Added} % Post-process subsequent instance of final complete name form in main-matter text. See Sections~\ref{sec:formatting} and~\ref{sec:Hooksa}f. Called when |\@nameauth@MainFormat| is true and the Boolean flag |\@nameauth@FirstFormat| is false. % \begin{macrocode} \newcommand*\MainNameHook{} % \end{macrocode} % \end{macro} % \begin{macro}{\FrontNamesFormat} -% \changes{v2.5}{2016/04/06}{Added} +% \changes{2.5}{2016/04/06}{Added} % Post-process ``first'' instance of final complete name form in front-matter text. Called when |\@nameauth@MainFormat| is false and |\@nameauth@FirstFormat| is true. % \begin{macrocode} \newcommand*\FrontNamesFormat{} % \end{macrocode} % \end{macro} % \begin{macro}{\FrontNameHook} -% \changes{v2.4}{2016/03/15}{Added} +% \changes{2.4}{2016/03/15}{Added} % Post-process subsequent instance of final complete name form in front-matter text. Called when |\@nameauth@MainFormat| is false and |\@nameauth@FirstFormat| is false. % \begin{macrocode} \newcommand*\FrontNameHook{} % \end{macrocode} % \end{macro} % \begin{macro}{\NameauthName} -% \changes{v2.2}{2015/12/01}{Added} +% \changes{2.2}{2015/12/01}{Added} % Hook to create custom naming macros. Usually the three macros below have the same control sequence, but they need not do so if you want something different. See Section~\ref{sec:NewEngine}. Use at your own risk! Changing these macros basically rewrites this package. % \begin{macrocode} \newcommand*\NameauthName{\@nameauth@Name} % \end{macrocode} % \end{macro} % \begin{macro}{\NameauthLName} -% \changes{v2.3}{2016/01/05}{Added} +% \changes{2.3}{2016/01/05}{Added} % Customization hook called after \cmd{\@nameauth@FullName} is set true. See Section~\ref{sec:NewEngine}. % \begin{macrocode} \newcommand*\NameauthLName{\@nameauth@Name} % \end{macrocode} % \end{macro} % \begin{macro}{\NameauthFName} -% \changes{v2.2}{2015/12/01}{Added} +% \changes{2.2}{2015/12/01}{Added} % Customization hook called after \cmd{\@nameauth@FirstName} is set true. See Section~\ref{sec:NewEngine}. % \begin{macrocode} \newcommand*\NameauthFName{\@nameauth@Name} @@ -3436,7 +3687,7 @@ Running "make install" installs the files in the local TeX tree. \DeclareOption{mainmatter}{\@nameauth@MainFormattrue} \DeclareOption{frontmatter}{\@nameauth@MainFormatfalse} \DeclareOption{formatAKA}{\@nameauth@AKAFormattrue} -\DeclareOption{oldAKA}{\@nameauth@oldAKAtrue} +\DeclareOption{oldAKA}{\@nameauth@OldAKAtrue} \DeclareOption{index}{\@nameauth@DoIndextrue} \DeclareOption{noindex}{\@nameauth@DoIndexfalse} \DeclareOption{pretag}{\@nameauth@Pretagtrue} @@ -3446,7 +3697,7 @@ Running "make install" installs the files in the local TeX tree. \DeclareOption{allreversed}% {\@nameauth@RevAlltrue\@nameauth@RevAllCommafalse} \DeclareOption{allrevcomma}% - {\@nameauth@RevAlltrue\@nameauth@RevAllCommatrue} + {\@nameauth@RevAllfalse\@nameauth@RevAllCommatrue} \DeclareOption{notreversed}% {\@nameauth@RevAllfalse\@nameauth@RevAllCommafalse} \DeclareOption{alwaysformat}{\@nameauth@AlwaysFormattrue} @@ -3455,14 +3706,10 @@ Running "make install" installs the files in the local TeX tree. \DeclareOption{boldface}{\renewcommand*\NamesFormat{\bfseries}} \DeclareOption{noformat}{\renewcommand*\NamesFormat{}} \DeclareOption{verbose}{\@nameauth@Verbosetrue} +\DeclareOption{altformat}{\@nameauth@AltFormattrue\@nameauth@DoAlttrue} \ExecuteOptions% - {nocomma,% - mainmatter,% - index,% - pretag,% - normalcaps,% - notreversed,% - noformat} + {nocomma,mainmatter,index,pretag,% + normalcaps,notreversed,noformat} \ProcessOptions\relax % \end{macrocode} % @@ -3490,7 +3737,7 @@ Running "make install" installs the files in the local TeX tree. % % \noindent{\large\bfseries Parsing: Root and Suffix} % \begin{macro}{\@nameauth@Root} -% \changes{v1.4}{2012/07/24}{More robust} +% \changes{1.4}{2012/07/24}{More robust} % The following two macros return everything before a comma in \meta{SNN}. % \begin{macrocode} \newcommand*\@nameauth@Root[1]{\@nameauth@TrimRoot#1,\\} @@ -3498,9 +3745,9 @@ Running "make install" installs the files in the local TeX tree. % \end{macro} % % \begin{macro}{\@nameauth@TrimRoot} -% \changes{v0.9}{2012/02/10}{Expandable} -% \changes{v2.0}{2015/11/11}{Trim spaces} -% \changes{v3.0}{2016/10/26}{Redesigned} +% \changes{0.9}{2012/02/10}{Expandable} +% \changes{2.0}{2015/11/11}{Trim spaces} +% \changes{3.0}{2016/10/26}{Redesigned} % Throw out the comma and suffix, return the radix. % \begin{macrocode} \def\@nameauth@TrimRoot#1,#2\\{\trim@spaces{#1}} @@ -3508,7 +3755,7 @@ Running "make install" installs the files in the local TeX tree. % \end{macro} % % \begin{macro}{\@nameauth@TagRoot} -% \changes{v3.0}{2016/10/26}{Added} +% \changes{3.0}{2016/10/26}{Added} % The following two macros return everything before a vertical bar (\verb+|+) in an index tag. % \begin{macrocode} \newcommand*\@nameauth@TagRoot[1]{\@nameauth@TrimTag#1|\\} @@ -3516,7 +3763,7 @@ Running "make install" installs the files in the local TeX tree. % \end{macro} % % \begin{macro}{\@nameauth@TrimTag} -% \changes{v3.0}{2016/10/26}{Added} +% \changes{3.0}{2016/10/26}{Added} % Throw out the bar and suffix, return the radix. % \begin{macrocode} \def\@nameauth@TrimTag#1|#2\\{#1} @@ -3524,7 +3771,7 @@ Running "make install" installs the files in the local TeX tree. % \end{macro} % % \begin{macro}{\@nameauth@Suffix} -% \changes{v0.9}{2012/02/10}{Added} +% \changes{0.9}{2012/02/10}{Added} % The following two macros parse \meta{SNN} into a radix and a comma-delimited suffix, returning only the suffix after a comma in the argument, or nothing. % \begin{macrocode} \newcommand*\@nameauth@Suffix[1]{\@nameauth@TrimSuffix#1,,\\} @@ -3532,30 +3779,22 @@ Running "make install" installs the files in the local TeX tree. % \end{macro} % % \begin{macro}{\@nameauth@TrimSuffix} -% \changes{v0.9}{2012/02/10}{Added} -% \changes{v1.5}{2013/02/22}{Trim spaces} -% \changes{v3.0}{2016/10/26}{New test} +% \changes{0.9}{2012/02/10}{Added} +% \changes{1.5}{2013/02/22}{Trim spaces} +% \changes{3.0}{2016/10/26}{New test} % Throw out the radix; return the suffix with no leading spaces. % \begin{macrocode} -\def\@nameauth@TrimSuffix#1,#2,#3\\{% - \ifx\\#2\\\@empty\else\trim@spaces{#2}\fi} +\def\@nameauth@TrimSuffix#1,#2,#3\\% + {\ifx\\#2\\\@empty\else\trim@spaces{#2}\fi} % \end{macrocode} % \end{macro} % % \noindent{\large\bfseries Parsing: Capitalization} -% \begin{macro}{\@nameauth@AllCapRoot} -% \changes{v1.5}{2013/02/22}{Added} -% This macro returns a fully-capitalized radix. It is used for generating capitalized Eastern family names in the body text. It is also the trivial case. -% \begin{macrocode} -\newcommand*\@nameauth@AllCapRoot[1] - {\uppercase{\@nameauth@Root{#1}}} -% \end{macrocode} -% \end{macro} -% % \begin{macro}{\@nameauth@UTFtest} % \phantomsection\label{page:CapRoot} -% \changes{v3.0}{2016/10/26}{Added} -% Before we attempt at capitalizing anything, we need to determine if we are running under \texttt{xelatex} or \texttt{lualatex} by testing for \cmd{\Umathchar}. Then we see if we are un the UTF-8 regime of NFSS. Then we can test if the leading token of our text is the same as the leading token of an active Unicode character. We run this test when we enter \cmd{\@nameauth@Name} and \cmd{\AKA}. +% \changes{3.0}{2016/10/26}{Added} +% \changes{3.1}{2017/01/13}{The override bypasses the test} +% Before we attempt at capitalizing anything, we need to determine if we are running under \texttt{xelatex} or \texttt{lualatex} by testing for \cmd{\Umathchar}. Then we see if we are in the UTF-8 regime of NFSS. Then we can test if the leading token of our text is the same as the leading token of an active Unicode character. We run this test when we enter \cmd{\@nameauth@Name} and \cmd{\AKA}. % \begin{macrocode} \newcommand*\@nameauth@UTFtest[1] {% @@ -3563,53 +3802,51 @@ Running "make install" installs the files in the local TeX tree. \@nameauth@UTFfalse% \else \ifdefined\UTFviii@two@octets - \toks@\expandafter{\@car#1\@nil}% - \edef\one{\the\toks@}% - \toks@\expandafter{\@carß\@nil}% - \edef\two{\the\toks@}% - \ifx\one\two\@nameauth@UTFtrue\else\@nameauth@UTFfalse\fi \if@nameauth@Accent - \@nameauth@UTFtrue% - \@nameauth@Accentfalse% + \@nameauth@UTFtrue\@nameauth@Accentfalse% + \else + \toks@\expandafter{\@car#1\@nil}% + \edef\one{\the\toks@}% + \toks@\expandafter{\@carß\@nil}% + \edef\two{\the\toks@}% + \ifx\one\two\@nameauth@UTFtrue\else\@nameauth@UTFfalse\fi \fi - \else\@nameauth@UTFfalse\fi + \else + \@nameauth@UTFfalse% + \fi \fi } % \end{macrocode} % \end{macro} -% \clearpage % -% \begin{macro}{\@nameauth@CapRoot} -% \changes{v0.95}{2012/02/17}{Added} -% \changes{v2.1}{2015/11/24}{Fix Unicode/NFSS} -% \changes{v3.0}{2016/10/26}{New UTF test} +% \begin{macro}{\@nameauth@Cap} +% \changes{3.1}{2017/01/13}{Added; old caps obsolete} % Use the NFSS Unicode version if the test is true, else use the regular version. % \begin{macrocode} -\newcommand*\@nameauth@CapRoot[1] +\newcommand*\@nameauth@Cap[1] {% - \if@nameauth@UTF \@nameauth@CRiii#1\\% - \else \@nameauth@CRii#1\\% + \if@nameauth@UTF \@nameauth@Ciii#1\\% + \else \@nameauth@Cii#1\\% \fi } % \end{macrocode} % \end{macro} % -% \begin{macro}{\@nameauth@CRii} -% \changes{v0.95}{2012/02/17}{Added} -% \changes{v1.26}{2012/04/24}{Fixed} -% \changes{v3.0}{2016/10/26}{Redesigned} -% Cap the first letter and return the rest as a radix stripped of its suffix. +% \begin{macro}{\@nameauth@Cii} +% \changes{3.1}{2017/01/13}{Added} +% Cap the first letter of the argument. % \begin{macrocode} -\def\@nameauth@CRii#1#2\\{\@nameauth@Root{\uppercase{#1}#2}} +\def\@nameauth@Cii#1#2\\% + {\expandafter\trim@spaces\expandafter{\uppercase{#1}#2}} % \end{macrocode} % \end{macro} % -% \begin{macro}{\@nameauth@CRiii} -% \changes{v2.1}{2015/11/24}{Added} -% \changes{v3.0}{2016/10/26}{Redesigned} -% Cap the first letter and return the rest as a radix stripped of its suffix. This is called in \texttt{pdflatex} under \textsf{inputenc}/Unicode. +% \begin{macro}{\@nameauth@Ciii} +% \changes{3.1}{2017/01/13}{Added} +% Cap the first letter of the argument. This is called in \texttt{pdflatex} under \textsf{inputenc}/Unicode. % \begin{macrocode} -\def\@nameauth@CRiii#1#2#3\\{\@nameauth@Root{\uppercase{#1#2}#3}} +\def\@nameauth@Ciii#1#2#3\\% + {\expandafter\trim@spaces\expandafter{\uppercase{#1#2}#3}} % \end{macrocode} % \end{macro} % @@ -3653,9 +3890,9 @@ Running "make install" installs the files in the local TeX tree. % % \noindent{\large\bfseries Error Detection} % \begin{macro}{\@nameauth@Error} -% \changes{v3.0}{2016/10/26}{Added} -% \changes{v3.01}{2016/10/27}{Fixed} -% One can cause \textsf{nameauth} to halt with an error by leaving a required name argument empty, providing an argument that expands to empty, or creating a name root that is empty within a root/suffix pair. +% \changes{3.0}{2016/10/26}{Added} +% \changes{3.01}{2016/10/27}{Fixed} +% One can cause \textsf{nameauth} to halt with an error by leaving a required name argument empty, providing an argument that expands to empty, or creating an empty root within a root/suffix pair. % \begin{macrocode} \newcommand*\@nameauth@Error[2] {% @@ -3672,20 +3909,22 @@ Running "make install" installs the files in the local TeX tree. } % \end{macrocode} % \end{macro} +% \clearpage % % \noindent{\large\bfseries Core Name Engine} % % \begin{macro}{\@nameauth@Name} -% \changes{v0.85}{2012/02/05}{Comma suppression} -% \changes{v1.5}{2013/02/22}{Reversing/caps} -% \changes{v2.0}{2015/11/11}{Isolate malformed input; trim spaces; redesign tagging} -% \changes{v2.1}{2015/11/24}{Isolate Unicode issues} -% \changes{v2.3}{2016/01/05}{Now internal} -% \changes{v2.4}{2016/03/15}{Add token regs for hooks} -% \changes{v2.41}{2016/03/17}{No local \cmd{\newtoks}} -% \changes{v2.5}{2016/04/06}{Hooks query internal values} -% \changes{v2.6}{2016/09/19}{Improve indexing; fix old syntax} -% \changes{v3.0}{2016/10/26}{Redesigned} +% \changes{0.85}{2012/02/05}{Comma suppression} +% \changes{1.5}{2013/02/22}{Reversing/caps} +% \changes{2.0}{2015/11/11}{Trim spaces; redesign tagging} +% \changes{2.1}{2015/11/24}{Isolate Unicode issues} +% \changes{2.3}{2016/01/05}{Now internal} +% \changes{2.4}{2016/03/15}{Add token regs for hooks} +% \changes{2.41}{2016/03/17}{No local \cmd{\newtoks}} +% \changes{2.5}{2016/04/06}{Hooks query internal values} +% \changes{2.6}{2016/09/19}{Improve indexing} +% \changes{3.0}{2016/10/26}{Redesigned} +% \changes{3.1}{2017/01/13}{Enhanced workflow control} % Here is the heart of the package. \Name*[Marc van]{Dongen} provided the original basic structure. Parsing, indexing, and formatting are more discrete than in earlier versions. % \begin{macrocode} \newcommandx*\@nameauth@Name[3][1=\@empty, 3=\@empty] @@ -3693,39 +3932,60 @@ Running "make install" installs the files in the local TeX tree. % \end{macrocode} % Both \cmd{\@nameauth@Name} and \cmd{\AKA} engage the lock below, preventing a stack overflow. % \begin{macrocode} - \if@nameauth@Lock\else - \@nameauth@Locktrue% + \unless\if@nameauth@Lock + \@nameauth@Locktrue% % \end{macrocode} % Tell the formatting mechanism that it is being called from \cmd{\@nameauth@Name}. Then test for malformed input. % \begin{macrocode} - \@nameauth@InNametrue% - \@nameauth@Error{#2}{macro \string\@nameauth@name}% + \@nameauth@InNametrue% + \@nameauth@Error{#2}{macro \string\@nameauth@name}% % \end{macrocode} -% Ensure that names are printed in horizontal mode. Create an index entry. +% If we use \cmd{\JustIndex} then skip everything else.. % \begin{macrocode} - \leavevmode\hbox{}% - \IndexName[#1]{#2}[#3]% - \if@nameauth@MainFormat - \@nameauth@Parse[#1]{#2}[#3]{!MN}% - \else - \@nameauth@Parse[#1]{#2}[#3]{!NF}% - \fi - \IndexName[#1]{#2}[#3]% + \if@nameauth@JustIndex + \IndexName[#1]{#2}[#3]% + \@nameauth@InNamefalse% + \@nameauth@Lockfalse% + \@nameauth@JustIndexfalse% + \else +% \end{macrocode} +% Delete/create name cseq if directed. If the delete flag is set, the create flag is ignored. Ensure that names are printed in horizontal mode. Print the name between two index entries, if allowed. +% \begin{macrocode} + \if@nameauth@Forget + \ForgetName[#1]{#2}[#3]% + \else + \if@nameauth@Subvert + \SubvertName[#1]{#2}[#3]% + \fi + \fi + \leavevmode\hbox{}% + \unless\if@nameauth@SkipIndex\IndexName[#1]{#2}[#3]\fi + \if@nameauth@MainFormat + \@nameauth@Parse[#1]{#2}[#3]{!MN}% + \else + \@nameauth@Parse[#1]{#2}[#3]{!NF}% + \fi + \unless\if@nameauth@SkipIndex\IndexName[#1]{#2}[#3]\fi % \end{macrocode} % Reset all the ``per name'' Boolean values. % \begin{macrocode} - \@nameauth@Lockfalse% - \@nameauth@InNamefalse% - \@nameauth@NBSPfalse% - \@nameauth@DoCapsfalse% - \@nameauth@Accentfalse% - \@nameauth@AllThisfalse% - \@nameauth@ShowCommafalse% - \@nameauth@NoCommafalse% - \@nameauth@RevThisfalse% - \@nameauth@RevThisCommafalse% - \@nameauth@ShortSNNfalse% - \@nameauth@EastFNfalse% + \@nameauth@SkipIndexfalse% + \@nameauth@Forgetfalse% + \@nameauth@Subvertfalse% + \@nameauth@Lockfalse% + \@nameauth@InNamefalse% + \@nameauth@NBSPfalse% + \@nameauth@NBSPXfalse% + \@nameauth@DoCapsfalse% + \@nameauth@Accentfalse% + \@nameauth@AllThisfalse% + \@nameauth@ShowCommafalse% + \@nameauth@NoCommafalse% + \@nameauth@RevThisfalse% + \@nameauth@RevThisCommafalse% + \@nameauth@ShortSNNfalse% + \@nameauth@EastFNfalse% + \fi % \end{macrocode} % Close the ``locked'' branch. % \begin{macrocode} @@ -3737,21 +3997,23 @@ Running "make install" installs the files in the local TeX tree. } % \end{macrocode} % \end{macro} -% \clearpage % % \begin{macro}{\@nameauth@Parse} -% \changes{v3.0}{2016/10/26}{Added} -% Parse and print a name in the text. The final required argument is a ``mode designator'' that can be ``!MN'' (main name); ``!NF'' (was ``non-formatted,'' now ``name in front matter''); and ``!PN'' (pseudonym/cross-reference). Both \cmd{\@nameauth@Name} and \cmd{\AKA} call this parser to print their names in the text. +% \changes{3.0}{2016/10/26}{Added} +% \changes{3.1}{2017/01/13}{Enhanced, integrated caps} +% Parse and print a name in the text. The final required argument is a ``mode designator'' that can be ``!MN'' (main name); ``!NF'' (was ``non-formatted,'' now ``name in front matter''); and ``!PN'' (pseudonym/cross-reference). Both \cmd{\@nameauth@Name} and \cmd{\AKA} call this parser. % \begin{macrocode} \newcommandx*\@nameauth@Parse[4][1=\@empty, 3=\@empty] {% \if@nameauth@Lock + \let\ex\expandafter% % \end{macrocode} % We want these arguments to expand to \cmd{\@empty} (or not) when we test them. % \begin{macrocode} \protected@edef\arga{\trim@spaces{#1}}% - \protected@edef\argc{\trim@spaces{#3}}% + \protected@edef\rootb{\@nameauth@Root{#2}}% \protected@edef\suffb{\@nameauth@Suffix{#2}}% + \protected@edef\argc{\trim@spaces{#3}}% % \end{macrocode} % If global caps. reversing, and commas are true, set the local flags true. % \begin{macrocode} @@ -3759,19 +4021,6 @@ Running "make install" installs the files in the local TeX tree. \if@nameauth@RevAll\@nameauth@RevThistrue\fi \if@nameauth@RevAllComma\@nameauth@RevThisCommatrue\fi % \end{macrocode} -% Get the root name as a normal or capitalized form, according to the flags. -% \begin{macrocode} - \if@nameauth@DoCaps - \@nameauth@UTFtest{#2}% - \protected@edef\rootb{\@nameauth@CapRoot{#2}}% - \else - \if@nameauth@AllThis - \protected@edef\rootb{\@nameauth@AllCapRoot{#2}}% - \else - \protected@edef\rootb{\@nameauth@Root{#2}}% - \fi - \fi -% \end{macrocode} % Make (usually) unique control sequence values from the name arguments. % \begin{macrocode} \def\csb{\@nameauth@Clean{#2}}% @@ -3784,11 +4033,49 @@ Running "make install" installs the files in the local TeX tree. \@nameauth@toksb\expandafter{#2}% \@nameauth@toksc\expandafter{#3}% % \end{macrocode} -% The code below handles non-breaking and regular spaces (\cmd{\KeepAffix}). It also handles the use of commas before affixes in Western names. +% Implement capitalization on demand in the body text if not in Continental mode. +% \begin{macrocode} + \if@nameauth@DoCaps + \let\csuffb\suffb% + \let\cargc\argc% + \unless\if@nameauth@AltFormat +% \end{macrocode} +% We test the root surname for active Unicode characters. Then we capitalize the first letter. +% \begin{macrocode} + \ex\@nameauth@UTFtest\ex{\rootb}% + \edef\crootb{\noexpand\@nameauth@Cap{\rootb}}% +% \end{macrocode} +% We test the suffix for active Unicode characters. Then we capitalize the first letter. +% \begin{macrocode} + \unless\ifx\suffb\@empty + \ex\@nameauth@UTFtest\ex{\suffb}% + \edef\csuffb{\noexpand\@nameauth@Cap{\suffb}}% + \fi +% \end{macrocode} +% We test the final optarg for active Unicode characters. Then we capitalize the first letter. +% \begin{macrocode} + \unless\ifx\argc\@empty + \ex\@nameauth@UTFtest\ex{\argc}% + \edef\cargc{\noexpand\@nameauth@Cap{\argc}}% + \fi + \let\rootb\crootb% + \fi + \else +% \end{macrocode} +% We capitalize the entire surname when desired; different from above. +% \begin{macrocode} + \if@nameauth@AllThis + \protected@edef\rootb{\uppercase{\@nameauth@Root{#2}}}% + \fi + \fi +% \end{macrocode} +% Use non-breaking spaces and commas as desired. % \begin{macrocode} \edef\Space{\space}% + \edef\SpaceX{\space}% \if@nameauth@NBSP\edef\Space{\nobreakspace}\fi - \ifx\arga\@empty\else + \if@nameauth@NBSPX\edef\SpaceX{\nobreakspace}\fi + \unless\ifx\arga\@empty \if@nameauth@AlwaysComma \edef\Space{,\space}% \if@nameauth@NBSP\edef\Space{,\nobreakspace}\fi @@ -3803,7 +4090,7 @@ Running "make install" installs the files in the local TeX tree. \fi \fi % \end{macrocode} -% The section below parses names. It ``attaches meaning'' to the macro arguments via \cmd{\FNN} and \cmd{\SNN}, wich is all the name printing macros know. Call the name printing macros, based on the optional arguments. Then create a second index entry. +% We parses names by attaching ``meaning'' to patterns of macro arguments primarily via \cmd{\FNN} and \cmd{\SNN}. Then we call the name printing macros, based on the optional arguments. % \begin{macrocode} \let\SNN\rootb% \ifx\arga\@empty @@ -3812,18 +4099,21 @@ Running "make install" installs the files in the local TeX tree. % When \cmd{\arga}, \cmd{\argc}, and \cmd{\suffb} are empty, we have a mononym. When \cmd{\suffb} is not empty, we have a native Eastern name or non-Western name. % \begin{macrocode} \let\FNN\suffb% + \unless\ifx\suffb\@empty + \if@nameauth@DoCaps\let\FNN\csuffb\fi + \fi \let\SNN\rootb% \@nameauth@NonWest{\csb#4}% \else % \end{macrocode} -% When \cmd{\arga} and \cmd{\suffb} are empty, but \cmd{\argc} is not, we have the old syntax. When \cmd{\arga} is empty, but \cmd{\argc} and \cmd{\suffb} are not, we have alternate names for non-Western names. +% When \cmd{\arga} and \cmd{\suffb} are empty, but \cmd{\argc} is not, we have the older syntax. When \cmd{\arga} is empty, but \cmd{\argc} and \cmd{\suffb} are not, we have alternate names for non-Western names. % \begin{macrocode} \ifx\suffb\@empty - \let\FNN\argc% + \if@nameauth@DoCaps\let\FNN\cargc\else\let\FNN\argc\fi \let\SNN\rootb% \@nameauth@NonWest{\csbc#4}% \else - \let\FNN\argc% + \if@nameauth@DoCaps\let\FNN\cargc\else\let\FNN\argc\fi \let\SNN\rootb% \@nameauth@NonWest{\csb#4}% \fi @@ -3837,8 +4127,7 @@ Running "make install" installs the files in the local TeX tree. \else \let\FNN\argc% \fi - \ifx\suffb\@empty - \else + \unless\ifx\suffb\@empty \protected@edef\SNN{\rootb\Space\suffb}% \if@nameauth@ShortSNN\let\SNN\rootb\fi \fi @@ -3848,17 +4137,16 @@ Running "make install" installs the files in the local TeX tree. } % \end{macrocode} % \end{macro} -% \clearpage % % \begin{macro}{\@nameauth@NonWest} -% \changes{v3.0}{2016/10/26}{Added} -% \changes{v3.02}{2016/11/01}{First name only with ``short'' macros} +% \changes{3.0}{2016/10/26}{Added} +% \changes{3.02}{2016/11/01}{Restrict \cmd{\ForceFN}} % Print non-Western names from \cmd{\@nameauth@name} and \cmd{\AKA}. We inherit internal control sequences from the naming macros and do nothing if called outside them. % \begin{macrocode} \newcommand*\@nameauth@NonWest[1] {% \if@nameauth@Lock - \ifcsname#1\endcsname\else + \unless\ifcsname#1\endcsname \@nameauth@FirstFormattrue% \fi \if@nameauth@InAKA @@ -3871,7 +4159,7 @@ Running "make install" installs the files in the local TeX tree. \@nameauth@FirstNamefalse% \fi \else - \ifcsname#1\endcsname\else + \unless\ifcsname#1\endcsname \@nameauth@FullNametrue% \@nameauth@FirstNamefalse% \fi @@ -3900,8 +4188,8 @@ Running "make install" installs the files in the local TeX tree. \fi \fi \fi - \ifcsname#1\endcsname\else - \if@nameauth@InAKA\else\csgdef{#1}{}\fi% + \unless\ifcsname#1\endcsname + \unless\if@nameauth@InAKA\csgdef{#1}{}\fi \fi \@nameauth@FullNamefalse% \@nameauth@FirstNamefalse% @@ -3909,16 +4197,15 @@ Running "make install" installs the files in the local TeX tree. } % \end{macrocode} % \end{macro} -% \clearpage % % \begin{macro}{\@nameauth@West} -% \changes{v3.0}{2016/10/26}{Added} +% \changes{3.0}{2016/10/26}{Added} % Print Western names and ``non-native'' Eastern names from \cmd{\@nameauth@name} and \cmd{\AKA}. We inherit internal control sequences from the naming macros and do nothing if called outside them. % \begin{macrocode} \newcommand*\@nameauth@West[1] {% \if@nameauth@Lock - \ifcsname#1\endcsname\else + \unless\ifcsname#1\endcsname \@nameauth@FirstFormattrue% \fi \if@nameauth@InAKA @@ -3930,7 +4217,7 @@ Running "make install" installs the files in the local TeX tree. \@nameauth@FirstNamefalse% \fi \else - \ifcsname#1\endcsname\else + \unless\ifcsname#1\endcsname \@nameauth@FullNametrue% \@nameauth@FirstNamefalse% \fi @@ -3940,13 +4227,13 @@ Running "make install" installs the files in the local TeX tree. \fi \if@nameauth@FullName \if@nameauth@RevThis - \@nameauth@Hook{\SNN\space\FNN}% + \@nameauth@Hook{\SNN\SpaceX\FNN}% \else \if@nameauth@RevThisComma - \edef\RevSpace{,\space}% + \edef\RevSpace{,\SpaceX}% \@nameauth@Hook{\SNN\RevSpace\FNN}% \else - \@nameauth@Hook{\FNN\space\SNN}% + \@nameauth@Hook{\FNN\SpaceX\SNN}% \fi \fi \else @@ -3956,8 +4243,8 @@ Running "make install" installs the files in the local TeX tree. \@nameauth@Hook{\rootb}% \fi \fi - \ifcsname#1\endcsname\else - \if@nameauth@InAKA\else\csgdef{#1}{}\fi% + \unless\ifcsname#1\endcsname + \unless\if@nameauth@InAKA\csgdef{#1}{}\fi \fi \@nameauth@FullNamefalse% \@nameauth@FirstNamefalse% @@ -3965,16 +4252,15 @@ Running "make install" installs the files in the local TeX tree. } % \end{macrocode} % \end{macro} -% \clearpage % % \noindent{\large\bfseries Format Hook Dispatcher} % \begin{macro}{\@nameauth@Hook} -% \changes{v0.94}{2012/02/15}{Particle caps} -% \changes{v0.95}{2012/02/17}{Works with \textsf{microtype}} -% \changes{v2.4}{2016/03/15}{Add hooks} -% \changes{v2.5}{2016/04/06}{Improve hooks} -% \changes{v3.0}{2016/10/26}{Better punctuation detection} -% Flags help the dispatcher invoke the correct formatting hooks. The flags control which hook is called (first/subsequent use, name type). The first set of tests handles formatting within \cmd{\AKA}. The second set of tests handles regular name formatting. The hooks have a local scope (and are defined as empty) by default. +% \changes{0.94}{2012/02/15}{Particle caps} +% \changes{0.95}{2012/02/17}{Works with \textsf{microtype}} +% \changes{2.4}{2016/03/15}{Add hooks} +% \changes{2.5}{2016/04/06}{Improve hooks} +% \changes{3.0}{2016/10/26}{Better punctuation detection} +% Flags help the dispatcher invoke the correct formatting hooks. The flags control which hook is called (first/subsequent use, name type). The first set of tests handles formatting within \cmd{\AKA}. The second set of tests handles regular name formatting. % \begin{macrocode} \newcommand*\@nameauth@Hook[1] {% @@ -3986,7 +4272,7 @@ Running "make install" installs the files in the local TeX tree. \if@nameauth@AlwaysFormat \@nameauth@FirstFormattrue% \else - \if@nameauth@AKAFormat\else + \unless\if@nameauth@AKAFormat \@nameauth@FirstFormatfalse\fi \fi \if@nameauth@MainFormat @@ -4026,12 +4312,11 @@ Running "make install" installs the files in the local TeX tree. } % \end{macrocode} % \end{macro} -% \clearpage % % \noindent{\large\bfseries Indexing Internals} % \begin{macro}{\@nameauth@Index} -% \changes{v0.94}{2012/02/15}{Added} -% \changes{v2.0}{2015/11/11}{New tagging} +% \changes{0.94}{2012/02/15}{Added} +% \changes{2.0}{2015/11/11}{New tagging} % If the indexing flag is true, create an index entry, otherwise do nothing. Add tags automatically if they exist. % \begin{macrocode} \newcommand*\@nameauth@Index[2] @@ -4072,7 +4357,7 @@ Running "make install" installs the files in the local TeX tree. % \end{macro} % % \begin{macro}{\@nameauth@Actual} -% \changes{v2.0}{2015/11/11}{Added} +% \changes{2.0}{2015/11/11}{Added} % This sets the ``actual'' character used by \textsf{nameauth} for index sorting. % \begin{macrocode} \newcommand*\@nameauth@Actual{@} @@ -4082,15 +4367,15 @@ Running "make install" installs the files in the local TeX tree. % \subsection{User Interface Macros} % \noindent{\large\bfseries Syntactic Formatting\,---\,Capitalization} % \begin{macro}{\CapThis} -% \changes{v0.94}{2012/02/15}{Added} -% Tells the root capping macro to cap the first character. +% \changes{0.94}{2012/02/15}{Added} +% Tells the root capping macro to cap the first character. This excludes \cmd{\CapName}. % \begin{macrocode} \newcommand*\CapThis{\@nameauth@DoCapstrue} % \end{macrocode} % \end{macro} % % \begin{macro}{\AccentCapThis} -% \changes{v2.1}{2015/11/24}{Added} +% \changes{2.1}{2015/11/24}{Added} % Overrides the automatic test for active Unicode characters. This is a fall-back in case the automatic test for active Unicode characters fails. % \begin{macrocode} \newcommand*\AccentCapThis% @@ -4099,24 +4384,24 @@ Running "make install" installs the files in the local TeX tree. % \end{macro} % % \begin{macro}{\CapName} -% \changes{v1.5}{2013/02/22}{Added} -% Capitalize entire required name. +% \changes{1.5}{2013/02/22}{Added} +% Capitalize entire required name. \cmd{\CapThis} overrides this. % \begin{macrocode} \newcommand*\CapName{\@nameauth@AllThistrue} % \end{macrocode} % \end{macro} % % \begin{macro}{\AllCapsInactive} -% Turn off global surname capitalization. -% \changes{v1.5}{2013/02/22}{Added} +% Turn off global surname capitalization. \cmd{\CapThis} overrides this. +% \changes{1.5}{2013/02/22}{Added} % \begin{macrocode} \newcommand*\AllCapsInactive{\@nameauth@AllCapsfalse} % \end{macrocode} % \end{macro} % % \begin{macro}{\AllCapsActive} -% \changes{v1.5}{2013/02/22}{Added} -% Turn on global surname capitalization. +% \changes{1.5}{2013/02/22}{Added} +% Turn on global surname capitalization. \cmd{\CapThis} overrides this. % \begin{macrocode} \newcommand*\AllCapsActive{\@nameauth@AllCapstrue} % \end{macrocode} @@ -4124,7 +4409,7 @@ Running "make install" installs the files in the local TeX tree. % % \noindent{\large\bfseries Syntactic Formatting\,---\,Reversing} % \begin{macro}{\RevName} -% \changes{v1.5}{2013/02/22}{Added} +% \changes{1.5}{2013/02/22}{Added} % Reverse name order. % \begin{macrocode} \newcommand*\RevName{\@nameauth@RevThistrue} @@ -4133,7 +4418,7 @@ Running "make install" installs the files in the local TeX tree. % % \begin{macro}{\ReverseInactive} % Turn off global name reversing. -% \changes{v1.5}{2013/02/22}{Added} +% \changes{1.5}{2013/02/22}{Added} % \begin{macrocode} \newcommand*\ReverseInactive{\@nameauth@RevAllfalse} % \end{macrocode} @@ -4141,15 +4426,15 @@ Running "make install" installs the files in the local TeX tree. % % \begin{macro}{\ReverseActive} % Turn on global name reversing. -% \changes{v1.5}{2013/02/22}{Added} +% \changes{1.5}{2013/02/22}{Added} % \begin{macrocode} \newcommand*\ReverseActive{\@nameauth@RevAlltrue} % \end{macrocode} % \end{macro} % % \begin{macro}{\ForceFN} -% Force the printing of an Eastern forename in the text, but only when using the ``short name'' macros. -% \changes{v3.0}{2016/10/26}{Added} +% Force the printing of an Eastern forename in the text, but only when using the ``short name'' macro \cmd{\FName} and the S-modifier. +% \changes{3.0}{2016/10/26}{Added} % \begin{macrocode} \newcommand*\ForceFN{\@nameauth@EastFNtrue} % \end{macrocode} @@ -4157,7 +4442,7 @@ Running "make install" installs the files in the local TeX tree. % % \noindent{\large\bfseries Syntactic Formatting\,---\,Reversing with Commas} % \begin{macro}{\RevComma} -% \changes{v1.5}{2013/02/22}{Added} +% \changes{1.5}{2013/02/22}{Added} % Last name, comma, first name. % \begin{macrocode} \newcommand*\RevComma% @@ -4167,7 +4452,7 @@ Running "make install" installs the files in the local TeX tree. % % \begin{macro}{\ReverseCommaInactive} % Turn off global ``last-name-comma-first.'' -% \changes{v1.5}{2013/02/22}{Added} +% \changes{1.5}{2013/02/22}{Added} % \begin{macrocode} \newcommand*\ReverseCommaInactive% {\@nameauth@RevAllCommafalse} @@ -4176,16 +4461,125 @@ Running "make install" installs the files in the local TeX tree. % % \begin{macro}{\ReverseCommaActive} % Turn on global ``last-name-comma-first.'' -% \changes{v1.5}{2013/02/22}{Added} +% \changes{1.5}{2013/02/22}{Added} % \begin{macrocode} \newcommand*\ReverseCommaActive% {\@nameauth@RevAllCommatrue} % \end{macrocode} % \end{macro} +% \clearpage +% +% \noindent{\large\bfseries Alternate Syntactic Formatting} +% \phantomsection\label{page:hooks} +% \begin{macro}{\AltFormatActive} +% \changes{3.1}{2017/01/13}{Added} +% Turn on alternate formatting. +% \begin{macrocode} +\newcommand*\AltFormatActive{% + \global\@nameauth@AltFormattrue% + \global\@nameauth@DoAlttrue% +} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\AltFormatActive*} +% \changes{3.1}{2017/01/13}{Added} +% Turn on alternate formatting. +% \begin{macrocode} +\WithSuffix{\newcommand*}\AltFormatActive*{% + \global\@nameauth@AltFormattrue% + \global\@nameauth@DoAltfalse% +} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\AltFormatInactive} +% Turn off alternate formatting. +% \changes{3.1}{2017/01/13}{Added} +% \begin{macrocode} +\newcommand*\AltFormatInactive{% + \global\@nameauth@AltFormatfalse% + \global\@nameauth@DoAltfalse% +} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\AltOn} +% Locally turn on alternate formatting. +% \changes{3.1}{2017/01/13}{Added} +% \begin{macrocode} +\newcommand*\AltOn{% + \if@nameauth@InHook + \if@nameauth@AltFormat\@nameauth@DoAlttrue\fi + \fi +} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\AltOff} +% Locally turn off alternate formatting. +% \changes{3.1}{2017/01/13}{Added} +% \begin{macrocode} +\newcommand*\AltOff{% + \if@nameauth@InHook + \if@nameauth@AltFormat\@nameauth@DoAltfalse\fi + \fi +} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\AltCaps} +% \changes{3.1}{2017/01/13}{Added} +% Alternate discretionary capping macro triggered by \cmd{\CapThis}. +% \begin{macrocode} +\newcommand*\AltCaps[1]{% + \if@nameauth@InHook + \if@nameauth@DoCaps\uppercase{#1}\else#1\fi + \else#1% + \fi +} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\textSC} +% \changes{3.1}{2017/01/13}{Added} +% Alternate formatting macro: small caps when active. +% \begin{macrocode} +\newcommand*\textSC[1]{% + \if@nameauth@DoAlt\textsc{#1}\else#1\fi} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\textUC} +% \changes{3.1}{2017/01/13}{Added} +% Alternate formatting macro: uppercase when active. +% \begin{macrocode} +\newcommand*\textUC[1]{% + \if@nameauth@DoAlt\uppercase{#1}\else#1\fi} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\textIT} +% \changes{3.1}{2017/01/13}{Added} +% Alternate formatting macro: italic when active. +% \begin{macrocode} +\newcommand*\textIT[1]{% + \if@nameauth@DoAlt\textit{#1}\else#1\fi} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\textBF} +% \changes{3.1}{2017/01/13}{Added} +% Alternate formatting macro: boldface when active. +% \begin{macrocode} +\newcommand*\textBF[1]{% + \if@nameauth@DoAlt\textbf{#1}\else#1\fi} +% \end{macrocode} +% \end{macro} % % \noindent{\large\bfseries Syntactic Formatting\,---\,Affixes} % \begin{macro}{\ShowComma} -% \changes{v1.4}{2012/07/24}{Added} +% \changes{1.4}{2012/07/24}{Added} % Put comma between name and suffix one time. % \begin{macrocode} \newcommand*\ShowComma{\@nameauth@ShowCommatrue} @@ -4193,7 +4587,7 @@ Running "make install" installs the files in the local TeX tree. % \end{macro} % % \begin{macro}{\NoComma} -% \changes{v2.6}{2016/09/19}{Added} +% \changes{2.6}{2016/09/19}{Added} % Remove comma between name and suffix one time (with \texttt{comma} option). % \begin{macrocode} \newcommand*\NoComma{\@nameauth@NoCommatrue} @@ -4201,22 +4595,29 @@ Running "make install" installs the files in the local TeX tree. % \end{macro} % % \begin{macro}{\DropAffix} -% \changes{v3.0}{2016/10/26}{Added} +% \changes{3.0}{2016/10/26}{Added} % Suppress the affix in a long Western name. % \begin{macrocode} \newcommand*\DropAffix{\@nameauth@ShortSNNtrue} % \end{macrocode} % \end{macro} % -% \noindent{\large\bfseries Typographic Formatting\,---\,Affixes} % \begin{macro}{\KeepAffix} -% \changes{v1.9}{2015/07/09}{Added} +% \changes{1.9}{2015/07/09}{Added} % Trigger a name-suffix pair to be separated by a non-breaking space. % \begin{macrocode} \newcommand*\KeepAffix{\@nameauth@NBSPtrue} % \end{macrocode} % \end{macro} % +% \begin{macro}{\KeepName} +% \changes{3.1}{2017/01/13}{Added} +% Use non-breaking spaces between name syntactic forms. +% \begin{macrocode} +\newcommand*\KeepName{\@nameauth@NBSPtrue\@nameauth@NBSPXtrue} +% \end{macrocode} +% \end{macro} +% % \noindent{\large\bfseries Typographic Formatting\,---\,Main Versus Front Matter} % \begin{macro}{\NamesInactive} % Switch to the ``non-formatted'' species of names. @@ -4232,20 +4633,45 @@ Running "make install" installs the files in the local TeX tree. % \end{macrocode} % \end{macro} % +% \noindent{\large\bfseries Typographic Formatting\,---\,First / Subsequent Reference} +% \begin{macro}{\ForgetThis} +% \changes{3.1}{2017/01/13}{Added} +% Have the naming engine \cmd{\@nameauth@Name} call \cmd{\ForgetName} internally. +% \begin{macrocode} +\newcommand*\ForgetThis{\@nameauth@Forgettrue} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\SubvertThis} +% \changes{3.1}{2017/01/13}{Added} +% Have the naming engine \cmd{\@nameauth@Name} call \cmd{\SubvertName} internally. +% \begin{macrocode} +\newcommand*\SubvertThis{\@nameauth@Subverttrue} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\ForceName} +% \changes{3.1}{2017/01/13}{Added} +% Set \cmd{\@nameauth@FirstFormat} to be true even for subsequent name uses. Works for one name only. +% \begin{macrocode} +\newcommand*\ForceName{\@nameauth@FirstFormattrue} +% \end{macrocode} +% \end{macro} +% % \noindent{\large\bfseries Name Occurrence Tweaks} % \begin{macro}{\LocalNames} -% \changes{v2.3}{2016/01/05}{Added} -% \changes{v2.4}{2016/03/15}{Ensured to be global} -% \cmd{\LocalNames} sets |@nameauth@LocalNames| true so \cmd{\ForgetName} and \cmd{\SubvertName} do not affect both formatted and unformatted names. +% \changes{2.3}{2016/01/05}{Added} +% \changes{2.4}{2016/03/15}{Ensured to be global} +% \cmd{\LocalNames} sets |@nameauth@LocalNames| true so \cmd{\ForgetName} and \cmd{\SubvertName} do not affect both formatted and unformatted naming systems. % \begin{macrocode} \newcommand*\LocalNames{\global\@nameauth@LocalNamestrue} % \end{macrocode} % \end{macro} % % \begin{macro}{\GlobalNames} -% \changes{v2.3}{2016/01/05}{Added} -% \changes{v2.4}{2016/03/15}{Ensured to be global} -% \cmd{\GlobalNames} sets |@nameauth@LocalNames| false, restoring the default behavior of \cmd{\ForgetName} and \cmd{\SubvertName}. +% \changes{2.3}{2016/01/05}{Added} +% \changes{2.4}{2016/03/15}{Ensured to be global} +% \cmd{\GlobalNames} sets |@nameauth@LocalNames| false, restoring \cmd{\ForgetName} and \cmd{\SubvertName} to the default behavior. % \begin{macrocode} \newcommand*\GlobalNames{\global\@nameauth@LocalNamesfalse} % \end{macrocode} @@ -4253,23 +4679,39 @@ Running "make install" installs the files in the local TeX tree. % % \noindent{\large\bfseries Index Operations} % \begin{macro}{\IndexInactive} -% \changes{v0.94}{2012/02/15}{Added} -% turn off global indexing of names. +% \changes{0.94}{2012/02/15}{Added} +% Turn off global indexing of names. % \begin{macrocode} \newcommand*\IndexInactive{\@nameauth@DoIndexfalse} % \end{macrocode} % \end{macro} % +% \begin{macro}{\SkipIndex} +% \changes{3.1}{2017/01/13}{Added} +% Turn off the next instance of indexing in \cmd{\Name}, \cmd{\FName}, and starred forms. +% \begin{macrocode} +\newcommand*\SkipIndex{\@nameauth@SkipIndextrue} +% \end{macrocode} +% \end{macro} +% +% \begin{macro}{\JustIndex} +% \changes{3.1}{2017/01/13}{Added} +% Makes the next call to \cmd{\Name}, \cmd{\FName}, and starred forms act like \cmd{\IndexName}. Overrides \cmd{\SkipIndex}. +% \begin{macrocode} +\newcommand*\JustIndex{\@nameauth@JustIndextrue} +% \end{macrocode} +% \end{macro} +% % \begin{macro}{\IndexActive} -% \changes{v0.94}{2012/02/15}{Added} -% turn on global indexing of names. +% \changes{0.94}{2012/02/15}{Added} +% Turn on global indexing of names. % \begin{macrocode} \newcommand*\IndexActive{\@nameauth@DoIndextrue} % \end{macrocode} % \end{macro} % % \begin{macro}{\IndexActual} -% \changes{v2.0}{2015/11/11}{Added} +% \changes{2.0}{2015/11/11}{Added} % Change the ``actual'' character from the default. % \begin{macrocode} \newcommand*\IndexActual[1] @@ -4278,8 +4720,8 @@ Running "make install" installs the files in the local TeX tree. % \end{macro} % % \begin{macro}{\SeeAlso} -% \changes{v3.0}{2016/10/26}{Added} -% Change the type of cross-reference from a \emph{see} reference to a \emph{see also} reference. Works once per name. +% \changes{3.0}{2016/10/26}{Added} +% Change the type of cross-reference from a \emph{see} reference to a \emph{see also} reference. Works once per xref, unless one uses \cmd{\Include*}, in which case, take care! % \begin{macrocode} \newcommand*\SeeAlso{\@nameauth@SeeAlsotrue} % \end{macrocode} @@ -4288,8 +4730,9 @@ Running "make install" installs the files in the local TeX tree. % \noindent{\large\bfseries Hook Macro Name Parser} % \phantomsection\label{page:parser} % \begin{macro}{\NameParser} -% \changes{v3.0}{2016/10/26}{Added} -% \changes{v3.03}{2016/11/01}{First name only with ``short'' macros} +% \changes{3.0}{2016/10/26}{Added} +% \changes{3.03}{2016/11/01}{First name only with ``short'' macros} +% \changes{3.1}{2017/01/13}{Older syntax fixed; NBSP added} % Generate a name form based on the current state of the \textsf{nameauth} macros in the locked path. Available for use only in the hook macros. % \begin{macrocode} \newcommand*\NameParser @@ -4297,14 +4740,46 @@ Running "make install" installs the files in the local TeX tree. \if@nameauth@InHook \let\SNN\rootb% \ifx\arga\@empty +% \end{macrocode} +% If the first optarg is empty, it is a non-Western name. The forename will be either the suffix or the final optarg. +% \begin{macrocode} \ifx\argc\@empty \let\FNN\suffb% \else \let\FNN\argc% \fi \ifx\suffb\@empty - \SNN% +% \end{macrocode} +% mononym +% \begin{macrocode} + \ifx\FNN\@empty + \SNN% + \else +% \end{macrocode} +% Eastern or ancient name, using the older syntax, with name reversing and forcing +% \begin{macrocode} + \if@nameauth@FullName% + \if@nameauth@RevThis + \FNN\Space\SNN% + \else + \SNN\Space\FNN% + \fi + \else + \if@nameauth@FirstName + \if@nameauth@EastFN + \FNN% + \else + \SNN% + \fi + \else + \SNN% + \fi + \fi + \fi \else +% \end{macrocode} +% Eastern or ancient name, using the new syntax, with name reversing and forcing +% \begin{macrocode} \if@nameauth@FullName \if@nameauth@RevThis \FNN\Space\SNN% @@ -4324,24 +4799,26 @@ Running "make install" installs the files in the local TeX tree. \fi \fi \else +% \end{macrocode} +% Western name with name reversing and suffixes +% \begin{macrocode} \ifx\argc\@empty \let\FNN\arga% \else \let\FNN\argc% \fi - \ifx\suffb\@empty - \else + \unless\ifx\suffb\@empty \protected@edef\SNN{\rootb\Space\suffb}% \if@nameauth@ShortSNN\let\SNN\rootb\fi% \fi \if@nameauth@FullName \if@nameauth@RevThis - \SNN\space\FNN% + \SNN\SpaceX\FNN% \else \if@nameauth@RevThisComma \SNN\RevSpace\FNN% \else - \FNN\space\SNN% + \FNN\SpaceX\SNN% \fi \fi \else @@ -4358,9 +4835,9 @@ Running "make install" installs the files in the local TeX tree. % \end{macrocode} % \end{macro} % -% \noindent{\large\bfseries Main Naming Interface} +% \noindent{\large\bfseries Traditional Naming Interface} % \begin{macro}{\Name} -% \changes{v2.3}{2016/01/05}{Interface macro} +% \changes{2.3}{2016/01/05}{Interface macro} % \cmd{\Name} calls \cmd{\NameauthName}, the interface hook. % \begin{macrocode} \newcommand\Name{\NameauthName} @@ -4368,7 +4845,7 @@ Running "make install" installs the files in the local TeX tree. % \end{macro} % % \begin{macro}{\Name*} -% \changes{v2.3}{2016/01/05}{Interface macro} +% \changes{2.3}{2016/01/05}{Interface macro} % \cmd{\Name*} sets up a long name reference and calls \cmd{\NameauthLName}, the interface hook. % \begin{macrocode} \WithSuffix{\newcommand*}\Name*% @@ -4377,8 +4854,8 @@ Running "make install" installs the files in the local TeX tree. % \end{macro} % % \begin{macro}{\FName} -% \changes{v0.9}{2012/02/10}{Added} -% \changes{v2.3}{2016/01/05}{Interface macro} +% \changes{0.9}{2012/02/10}{Added} +% \changes{2.3}{2016/01/05}{Interface macro} % \cmd{\FName} sets up a short name reference and calls \cmd{\NameauthFName}, the interface hook. % \begin{macrocode} \newcommand\FName{\@nameauth@FirstNametrue\NameauthFName} @@ -4386,33 +4863,30 @@ Running "make install" installs the files in the local TeX tree. % \end{macro} % % \begin{macro}{\FName*} -% \changes{v2.3}{2016/01/05}{Interface macro} -% \cmd{\FName} and \cmd{\FName*} are identical. +% \changes{2.3}{2016/01/05}{Interface macro} +% \cmd{\FName} and \cmd{\FName*} are identical in function. % \begin{macrocode} \WithSuffix{\newcommand*}\FName*% {\@nameauth@FirstNametrue\NameauthFName} % \end{macrocode} % \end{macro} -% \clearpage % % \noindent{\large\bfseries Index Operations} % \begin{macro}{\IndexName} -% \changes{v0.75}{2012/01/19}{Current arguments} -% \changes{v0.85}{2012/02/05}{Comma suppression} -% \changes{v1.26}{2012/04/24}{Fix name suffix sorting} -% \changes{v2.0}{2015/11/11}{Isolate malformed input; trim spaces; redesign tagging} -% \changes{v2.6}{2016/09/19}{Fix commas, old syntax} -% \changes{v3.0}{2016/10/26}{Redesigned} -% This creates a ``main'' index entry with page references. It issues warnings if the \texttt{verbose} option is selected and if a cross-reference or exclusion exists. It prints nothing. First we make copies of the arguments to test them and make parsing decisions. +% \changes{0.75}{2012/01/19}{Current arguments} +% \changes{0.85}{2012/02/05}{Comma suppression} +% \changes{1.26}{2012/04/24}{Fix name suffix sorting} +% \changes{2.0}{2015/11/11}{Trim spaces; redesign tagging} +% \changes{2.6}{2016/09/19}{Fix commas} +% \changes{3.0}{2016/10/26}{Redesigned} +% \changes{3.1}{2017/01/13}{Better tests} +% This creates an index entry with page references. It issues warnings if the \texttt{verbose} option is selected. It prints nothing. First we make copies of the arguments. % \begin{macrocode} \newcommandx*\IndexName[3][1=\@empty, 3=\@empty] {% - \protected@edef\testa{#1}% \protected@edef\arga{\trim@spaces{#1}}% - \protected@edef\testb{\trim@spaces{#2}}% \protected@edef\rootb{\@nameauth@Root{#2}}% \protected@edef\suffb{\@nameauth@Suffix{#2}}% - \protected@edef\testc{#3}% \protected@edef\argc{\trim@spaces{#3}}% \def\csb{\@nameauth@Clean{#2}}% \def\csbc{\@nameauth@Clean{#2,#3}}% @@ -4422,27 +4896,24 @@ Running "make install" installs the files in the local TeX tree. % \begin{macrocode} \@nameauth@Error{#2}{macro \string\IndexName}% % \end{macrocode} -% Now we deal with suffixes, and whether to handle them for Western or Eastern names. -% \begin{macrocode} - \let\Short\rootb% - \ifx\suffb\@empty - \let\SNN\rootb% - \else - \protected@edef\SNN{\rootb\space\suffb}% - \fi -% \end{macrocode} -% -% We create the appropriate index entries, calling \cmd{\@nameauth@Index} to handle sorting and tagging. We do not create an index entry for a cross-reference (code !PN for pseudonym), used by \cmd{\IndexRef}, \cmd{\Excludename}, \cmd{\Includename}, \cmd{\AKA}, and \cmd{\PName}. +% We create the appropriate index entries, calling \cmd{\@nameauth@Index} to handle sorting and tagging. We do not create an index entry for a cross-reference (code !PN for pseudonym), used by \cmd{\IndexRef}, \cmd{\Excludename}, \cmd{\Includename}, \cmd{\AKA}, and \cmd{\PName}. If the first optarg is empty, it is a non-Western name. % \begin{macrocode} - \ifx\testa\@empty - \ifx\testc\@empty + \ifx\arga\@empty + \ifx\argc\@empty \ifcsname\csb!PN\endcsname \if@nameauth@Verbose \PackageWarning{nameauth}% {macro \IndexName: XRef: #2 exists}% \fi \else - \@nameauth@Index{\csb}{\SNN}% + \ifx\suffb\@empty +% \end{macrocode} +% mononym or Eastern / ancient name, new syntax +% \begin{macrocode} + \@nameauth@Index{\csb}{\rootb}% + \else + \@nameauth@Index{\csb}{\rootb\space\suffb}% + \fi \fi \else \ifx\suffb\@empty @@ -4452,11 +4923,11 @@ Running "make install" installs the files in the local TeX tree. {macro \IndexName: XRef: #2 #3 exists}% \fi \else - \@nameauth@Index{\csbc}{\SNN\space\argc}% - \fi % \end{macrocode} -% \clearpage\noindent +% Eastern or ancient name, older syntax % \begin{macrocode} + \@nameauth@Index{\csbc}{\rootb\space\argc}% + \fi \else \ifcsname\csb!PN\endcsname \if@nameauth@Verbose @@ -4464,7 +4935,10 @@ Running "make install" installs the files in the local TeX tree. {macro \IndexName: XRef: #2 exists}% \fi \else - \@nameauth@Index{\csb}{\SNN}% +% \end{macrocode} +% Eastern or ancient name, new syntax, alternate name ignored +% \begin{macrocode} + \@nameauth@Index{\csb}{\rootb\space\suffb}% \fi \fi \fi @@ -4475,12 +4949,15 @@ Running "make install" installs the files in the local TeX tree. {macro \IndexName: XRef: #1 #2 exists}% \fi \else +% \end{macrocode} +% Western name, without and with affix +% \begin{macrocode} \ifx\suffb\@empty \@nameauth@Index{\csab}% - {\Short,\space\arga}% + {\rootb,\space\arga}% \else \@nameauth@Index{\csab}% - {\Short,\space\arga,\space\suffb}% + {\rootb,\space\arga,\space\suffb}% \fi \fi \fi @@ -4489,16 +4966,15 @@ Running "make install" installs the files in the local TeX tree. % \end{macro} % % \begin{macro}{\IndexRef} -% \changes{v3.0}{2016/10/26}{Added} +% \changes{3.0}{2016/10/26}{Added} +% \changes{3.1}{2017/01/13}{Better tests} % This creates an index cross-reference that is not already a pseudonym. It prints nothing. First we make copies of the arguments to test them and make parsing decisions. % \begin{macrocode} \newcommandx*\IndexRef[4][1=\@empty, 3=\@empty] {% - \protected@edef\testa{#1}% \protected@edef\arga{\trim@spaces{#1}}% \protected@edef\rootb{\@nameauth@Root{#2}}% \protected@edef\suffb{\@nameauth@Suffix{#2}}% - \protected@edef\testc{#3}% \protected@edef\argc{\trim@spaces{#3}}% \protected@edef\target{#4}% \def\csb{\@nameauth@Clean{#2}}% @@ -4511,29 +4987,31 @@ Running "make install" installs the files in the local TeX tree. \@nameauth@Error{#2}{macro \string\IndexRef}% \@nameauth@Xreftrue% % \end{macrocode} -% Now we deal with suffixes, and whether to handle them for Western or Eastern names. -% \begin{macrocode} - \let\Short\rootb% - \ifx\suffb\@empty - \let\SNN\rootb% - \else - \protected@edef\SNN{\rootb\space\suffb}% - \fi -% \end{macrocode} % We create either \emph{see also} entries or \emph{see} entries. The former are unrestricted. The latter are only created if they do not already exist as main entries. % \begin{macrocode} - \ifx\testa\@empty - \ifx\testc\@empty + \ifx\arga\@empty + \ifx\argc\@empty \ifcsname\csb!PN\endcsname \if@nameauth@Verbose \PackageWarning{nameauth}% {macro \IndexRef: XRef: #2 exists}% \fi \else - \if@nameauth@SeeAlso - \@nameauth@Index{\csb}{\SNN|seealso{\target}}% + \ifx\suffb\@empty +% \end{macrocode} +% mononym or Eastern / ancient name, new syntax +% \begin{macrocode} + \if@nameauth@SeeAlso + \@nameauth@Index{\csb}{\rootb|seealso{\target}}% + \else + \@nameauth@Index{\csb}{\rootb|see{\target}}% + \fi \else - \@nameauth@Index{\csb}{\SNN|see{\target}}% + \if@nameauth@SeeAlso + \@nameauth@Index{\csb}{\rootb\space\suffb|seealso{\target}}% + \else + \@nameauth@Index{\csb}{\rootb\space\suffb|see{\target}}% + \fi \fi \csgdef{\csb!PN}{}% \fi @@ -4545,12 +5023,15 @@ Running "make install" installs the files in the local TeX tree. {macro \IndexRef: XRef: #2 #3 exists}% \fi \else +% \end{macrocode} +% Eastern or ancient name, older syntax +% \begin{macrocode} \if@nameauth@SeeAlso \@nameauth@Index{\csbc}% - {\SNN\space\argc|seealso{\target}}% + {\rootb\space\argc|seealso{\target}}% \else \@nameauth@Index{\csbc}% - {\SNN\space\argc|see{\target}}% + {\rootb\space\argc|see{\target}}% \fi \csgdef{\csbc!PN}{}% \fi @@ -4561,20 +5042,20 @@ Running "make install" installs the files in the local TeX tree. {macro \IndexRef: XRef: #2 exists}% \fi \else +% \end{macrocode} +% Eastern or ancient name, new syntax, alternate name ignored +% \begin{macrocode} \if@nameauth@SeeAlso \@nameauth@Index{\csb}% - {\SNN|seealso{\target}}% + {\rootb\space\suffb|seealso{\target}}% \else \@nameauth@Index{\csb}% - {\SNN|see{\target}}% + {\rootb\space\suffb|see{\target}}% \fi \csgdef{\csb!PN}{}% \fi \fi \fi -% \end{macrocode} -% \clearpage\noindent -% \begin{macrocode} \else \ifcsname\csab!PN\endcsname \if@nameauth@Verbose @@ -4582,21 +5063,24 @@ Running "make install" installs the files in the local TeX tree. {macro \IndexRef: XRef: #1 #2 exists}% \fi \else +% \end{macrocode} +% Western name, without and with affix +% \begin{macrocode} \ifx\suffb\@empty \if@nameauth@SeeAlso \@nameauth@Index{\csab}% - {\Short,\space\arga|seealso{\target}}% + {\rootb,\space\arga|seealso{\target}}% \else \@nameauth@Index{\csab}% - {\Short,\space\arga|see{\target}}% + {\rootb,\space\arga|see{\target}}% \fi \else \if@nameauth@SeeAlso \@nameauth@Index{\csab}% - {\Short,\space\arga,\space\suffb|seealso{\target}}% + {\rootb,\space\arga,\space\suffb|seealso{\target}}% \else \@nameauth@Index{\csab}% - {\Short,\space\arga,\space\suffb|see{\target}}% + {\rootb,\space\arga,\space\suffb|see{\target}}% \fi \fi \csgdef{\csab!PN}{}% @@ -4609,17 +5093,15 @@ Running "make install" installs the files in the local TeX tree. % \end{macro} % % \begin{macro}{\ExcludeName} -% \changes{v0.94}{2012/02/15}{Added} -% \changes{v2.0}{2015/11/11}{Isolate malformed input} -% \changes{v2.3}{2016/01/05}{Make special xref type} -% \changes{v2.6}{2016/09/19}{Fix old syntax} -% \changes{v3.0}{2016/10/26}{Redesigned} +% \changes{0.94}{2012/02/15}{Added} +% \changes{2.3}{2016/01/05}{Make special xref type} +% \changes{3.0}{2016/10/26}{Redesigned} % This macro prevents a name from being indexed. % \begin{macrocode} \newcommandx*\ExcludeName[3][1=\@empty, 3=\@empty] {% - \protected@edef\testa{#1}% - \protected@edef\testc{#3}% + \protected@edef\arga{\trim@spaces{#1}}% + \protected@edef\argc{\trim@spaces{#3}}% \protected@edef\suffb{\@nameauth@Suffix{#2}}% \def\csb{\@nameauth@Clean{#2}}% \def\csbc{\@nameauth@Clean{#2,#3}}% @@ -4628,8 +5110,8 @@ Running "make install" installs the files in the local TeX tree. % Below we parse the name arguments and create a non-empty pseudonym macro. % \begin{macrocode} \@nameauth@Error{#2}{macro \string\ExcludeName}% - \ifx\testa\@empty - \ifx\testc\@empty + \ifx\arga\@empty + \ifx\argc\@empty \if@nameauth@Verbose \ifcsname\csb!MN\endcsname \PackageWarning{nameauth}% @@ -4640,9 +5122,6 @@ Running "make install" installs the files in the local TeX tree. {macro \ExcludeName: Reference: #2 exists}% \fi \fi -% \end{macrocode} -% \clearpage\noindent -% \begin{macrocode} \ifcsname\csb!PN\endcsname \if@nameauth@Verbose \PackageWarning{nameauth}% @@ -4718,70 +5197,69 @@ Running "make install" installs the files in the local TeX tree. % \end{macro} % % \begin{macro}{\IncludeName} -% \changes{v3.0}{2016/10/26}{Added} -% This macro allows a name to be indexed. +% \changes{3.0}{2016/10/26}{Added} +% This macro allows a name to be indexed if it is not a cross-reference. % \begin{macrocode} \newcommandx*\IncludeName[3][1=\@empty, 3=\@empty] {% - \protected@edef\testa{#1}% - \protected@edef\testc{#3}% + \protected@edef\arga{\trim@spaces{#1}}% + \protected@edef\argc{\trim@spaces{#3}}% \protected@edef\suffb{\@nameauth@Suffix{#2}}% \def\csb{\@nameauth@Clean{#2}}% \def\csbc{\@nameauth@Clean{#2,#3}}% \def\csab{\@nameauth@Clean{#1!#2}}% % \end{macrocode} -% Below we parse the name arguments undefine a pseudonym control sequence if it is not excluded (non-empty). +% Below we parse the name arguments and undefine an ``excluded'' name. % \begin{macrocode} \@nameauth@Error{#2}{macro \string\IncludeName}% - \ifx\testa\@empty - \ifx\testc\@empty + \ifx\arga\@empty + \ifx\argc\@empty \ifcsname\csb!PN\endcsname \edef\testex{\csname\csb!PN\endcsname}% - \ifx\testex\@empty\else\global\csundef{\csb!PN}\fi + \unless\ifx\testex\@empty\global\csundef{\csb!PN}\fi \fi \else \ifx\suffb\@empty \ifcsname\csbc!PN\endcsname \edef\testex{\csname\csbc!PN\endcsname}% - \ifx\testex\@empty\else\global\csundef{\csbc!PN}\fi + \unless\ifx\testex\@empty\global\csundef{\csbc!PN}\fi \fi \else \ifcsname\csb!PN\endcsname \edef\testex{\csname\csb!PN\endcsname}% - \ifx\testex\@empty\else\global\csundef{\csb!PN}\fi + \unless\ifx\testex\@empty\global\csundef{\csb!PN}\fi \fi \fi \fi \else \ifcsname\csab!PN\endcsname \edef\testex{\csname\csab!PN\endcsname}% - \ifx\testex\@empty\else\global\csundef{\csab!PN}\fi + \unless\ifx\testex\@empty\global\csundef{\csab!PN}\fi \fi \fi } % \end{macrocode} % \end{macro} -% \clearpage % % \begin{macro}{\IncludeName*} -% \changes{v3.0}{2016/10/26}{Added} -% This macro allows a name to be indexed. +% \changes{3.0}{2016/10/26}{Added} +% \changes{3.1}{2017/01/13}{Fixed} +% This macro allows any name to be indexed, undefining cross-references. % \begin{macrocode} \WithSuffix{\newcommandx*}\IncludeName*[3][1=\@empty, 3=\@empty] {% - \protected@edef\testa{#1}% - \protected@edef\testc{#3}% + \protected@edef\arga{\trim@spaces{#1}}% + \protected@edef\argc{\trim@spaces{#3}}% \protected@edef\suffb{\@nameauth@Suffix{#2}}% \def\csb{\@nameauth@Clean{#2}}% \def\csbc{\@nameauth@Clean{#2,#3}}% \def\csab{\@nameauth@Clean{#1!#2}}% - \edef\testa{!}% % \end{macrocode} -% Below we parse the name arguments and undefine a pseudonym control sequence. +% Below we parse the name arguments and undefine an xref control sequence. % \begin{macrocode} \@nameauth@Error{#2}{macro \string\IncludeName*}% - \ifx\testa\@empty - \ifx\testc\@empty + \ifx\arga\@empty + \ifx\argc\@empty \global\csundef{\csb!PN}% \else \ifx\suffb\@empty @@ -4796,17 +5274,15 @@ Running "make install" installs the files in the local TeX tree. } % \end{macrocode} % \end{macro} -% \clearpage\noindent % % \begin{macro}{\PretagName} -% \changes{v2.0}{2015/11/11}{Added} -% \changes{v2.6}{2016/09/19}{Fix old syntax} +% \changes{2.0}{2015/11/11}{Added} % This creates an index entry tag that is applied before a name. % \begin{macrocode} \newcommandx*\PretagName[4][1=\@empty, 3=\@empty] {% - \protected@edef\testa{#1}% - \protected@edef\testc{#3}% + \protected@edef\arga{\trim@spaces{#1}}% + \protected@edef\argc{\trim@spaces{#3}}% \protected@edef\suffb{\@nameauth@Suffix{#2}}% \def\csb{\@nameauth@Clean{#2}}% \def\csbc{\@nameauth@Clean{#2,#3}}% @@ -4815,8 +5291,8 @@ Running "make install" installs the files in the local TeX tree. % We parse the arguments, defining the sort tag control sequences used by\newline \cmd{\@nameauth@Index}. % \begin{macrocode} \@nameauth@Error{#2}{macro \string\PretagName}% - \ifx\testa\@empty - \ifx\testc\@empty + \ifx\arga\@empty + \ifx\argc\@empty \ifcsname\csb!PN\endcsname \if@nameauth@Verbose \PackageWarning{nameauth}% @@ -4855,19 +5331,17 @@ Running "make install" installs the files in the local TeX tree. } % \end{macrocode} % \end{macro} -% \clearpage\noindent % % \begin{macro}{\TagName} -% \changes{v1.2}{2012/02/25}{Added} -% \changes{v1.9}{2015/07/09}{Fix cs collisions} -% \changes{v2.0}{2015/11/11}{Isolate malformed input; redesign tagging} -% \changes{v2.6}{2016/09/19}{Fix old syntax} -% This creates an index entry tag that is applied to a name that is not already used as a \emph{see} reference. +% \changes{1.2}{2012/02/25}{Added} +% \changes{1.9}{2015/07/09}{Fix cs collisions} +% \changes{2.0}{2015/11/11}{Redesign tagging} +% This creates an index entry tag for a name that is not used as a cross-reference. % \begin{macrocode} \newcommandx*\TagName[4][1=\@empty, 3=\@empty] {% - \protected@edef\testa{#1}% - \protected@edef\testc{#3}% + \protected@edef\arga{\trim@spaces{#1}}% + \protected@edef\argc{\trim@spaces{#3}}% \protected@edef\suffb{\@nameauth@Suffix{#2}}% \def\csb{\@nameauth@Clean{#2}}% \def\csbc{\@nameauth@Clean{#2,#3}}% @@ -4876,8 +5350,8 @@ Running "make install" installs the files in the local TeX tree. % We parse the arguments, defining the index tag control sequences used by\newline \cmd{\@nameauth@Index}. % \begin{macrocode} \@nameauth@Error{#2}{macro \string\TagName}% - \ifx\testa\@empty - \ifx\testc\@empty + \ifx\arga\@empty + \ifx\argc\@empty \ifcsname\csb!PN\endcsname \if@nameauth@Verbose \PackageWarning{nameauth}% @@ -4922,16 +5396,15 @@ Running "make install" installs the files in the local TeX tree. % \end{macro} % % \begin{macro}{\UntagName} -% \changes{v1.2}{2012/02/25}{Added} -% \changes{v1.9}{2015/07/09}{Ensure global undef, fix cs collisions} -% \changes{v2.0}{2015/11/11}{Isolate malformed input; redesign tagging} -% \changes{v2.6}{2016/09/19}{Fix old syntax} +% \changes{1.2}{2012/02/25}{Added} +% \changes{1.9}{2015/07/09}{Ensure global undef, fix cs collisions} +% \changes{2.0}{2015/11/11}{Redesign tagging} % This deletes an index tag. % \begin{macrocode} \newcommandx*\UntagName[3][1=\@empty, 3=\@empty] {% - \protected@edef\testa{#1}% - \protected@edef\testc{#3}% + \protected@edef\arga{\trim@spaces{#1}}% + \protected@edef\argc{\trim@spaces{#3}}% \protected@edef\suffb{\@nameauth@Suffix{#2}}% \def\csb{\@nameauth@Clean{#2}}% \def\csbc{\@nameauth@Clean{#2,#3}}% @@ -4940,8 +5413,8 @@ Running "make install" installs the files in the local TeX tree. % We parse the arguments, undefining the index tag control sequences. % \begin{macrocode} \@nameauth@Error{#2}{macro \string\UntagName}% - \ifx\testa\@empty - \ifx\testc\@empty + \ifx\arga\@empty + \ifx\argc\@empty \global\csundef{\csb!TAG}% \else \ifx\suffb\@empty @@ -4957,16 +5430,15 @@ Running "make install" installs the files in the local TeX tree. % \end{macrocode} % \end{macro} % -% \noindent{\large\bfseries Name Info Database: ``Text Tags''} +% \noindent{\large\bfseries Name Info Data Set: ``Text Tags''} % \begin{macro}{\NameAddInfo} -% \changes{v2.4}{2016/03/15}{Added} -% \changes{v2.6}{2016/09/19}{Fix old syntax} +% \changes{2.4}{2016/03/15}{Added} % This creates a control sequence and information associated with a given name, similar to an index tag, but usable in the body text. % \begin{macrocode} \newcommandx\NameAddInfo[4][1=\@empty, 3=\@empty] {% - \protected@edef\testa{#1}% - \protected@edef\testc{#3}% + \protected@edef\arga{\trim@spaces{#1}}% + \protected@edef\argc{\trim@spaces{#3}}% \protected@edef\Suff{\@nameauth@Suffix{#2}}% \def\csb{\@nameauth@Clean{#2}}% \def\csbc{\@nameauth@Clean{#2,#3}}% @@ -4975,8 +5447,8 @@ Running "make install" installs the files in the local TeX tree. % We parse the arguments, defining the text tag control sequences. % \begin{macrocode} \@nameauth@Error{#2}{macro \string\NameAddInfo}% - \ifx\testa\@empty - \ifx\testc\@empty + \ifx\arga\@empty + \ifx\argc\@empty \csgdef{\csb!DB}{#4}% \else \ifx\Suff\@empty @@ -4993,14 +5465,14 @@ Running "make install" installs the files in the local TeX tree. % \end{macro} % % \begin{macro}{\NameQueryInfo} -% \changes{v2.4}{2016/03/15}{Added} -% \changes{v2.6}{2016/09/19}{Fix old syntax} +% \changes{2.4}{2016/03/15}{Added} +% \changes{3.1}{2017/01/13}{Short macro} % This prints the information created by \cmd{\NameAddInfo} if it exists. % \begin{macrocode} -\newcommandx\NameQueryInfo[3][1=\@empty, 3=\@empty] +\newcommandx*\NameQueryInfo[3][1=\@empty, 3=\@empty] {% - \protected@edef\testa{#1}% - \protected@edef\testc{#3}% + \protected@edef\arga{\trim@spaces{#1}}% + \protected@edef\argc{\trim@spaces{#3}}% \protected@edef\Suff{\@nameauth@Suffix{#2}}% \def\csb{\@nameauth@Clean{#2}}% \def\csbc{\@nameauth@Clean{#2,#3}}% @@ -5009,8 +5481,8 @@ Running "make install" installs the files in the local TeX tree. % We parse the arguments, invoking the tag control sequences to expand to their contents. % \begin{macrocode} \@nameauth@Error{#2}{macro \string\NameQueryInfo}% - \ifx\testa\@empty - \ifx\testc\@empty + \ifx\arga\@empty + \ifx\argc\@empty \ifcsname\csb!DB\endcsname\csname\csb!DB\endcsname\fi \else \ifx\Suff\@empty @@ -5027,14 +5499,13 @@ Running "make install" installs the files in the local TeX tree. % \end{macro} % % \begin{macro}{\NameClearInfo} -% \changes{v2.4}{2016/03/15}{Added} -% \changes{v2.6}{2016/09/19}{Fix old syntax} +% \changes{2.4}{2016/03/15}{Added} % This deletes a text tag. It has the same structure as \cmd{\UntagName}. % \begin{macrocode} \newcommandx*\NameClearInfo[3][1=\@empty, 3=\@empty] {% - \protected@edef\testa{#1}% - \protected@edef\testc{#3}% + \protected@edef\arga{\trim@spaces{#1}}% + \protected@edef\argc{\trim@spaces{#3}}% \protected@edef\Suff{\@nameauth@Suffix{#2}}% \def\csb{\@nameauth@Clean{#2}}% \def\csbc{\@nameauth@Clean{#2,#3}}% @@ -5043,8 +5514,8 @@ Running "make install" installs the files in the local TeX tree. % We parse the arguments, undefining the text tag control sequences. % \begin{macrocode} \@nameauth@Error{#2}{macro \string\NameClearInfo}% - \ifx\testa\@empty - \ifx\testc\@empty + \ifx\arga\@empty + \ifx\argc\@empty \global\csundef{\csb!DB}% \else \ifx\Suff\@empty @@ -5059,18 +5530,16 @@ Running "make install" installs the files in the local TeX tree. } % \end{macrocode} % \end{macro} -% \clearpage % % \noindent{\large\bfseries Name Decisions} % \begin{macro}{\IfMainName} -% \changes{v2.3}{2016/01/05}{Added} -% \changes{v2.6}{2016/09/19}{Fix old syntax} -% This macro expands one path if a main matter name exists, or else the other if it does not exist. +% \changes{2.3}{2016/01/05}{Added} +% This macro expands one path if a main matter name exists, or else the other. % \begin{macrocode} \newcommandx\IfMainName[5][1=\@empty, 3=\@empty] {% - \protected@edef\testa{#1}% - \protected@edef\testc{#3}% + \protected@edef\arga{\trim@spaces{#1}}% + \protected@edef\argc{\trim@spaces{#3}}% \protected@edef\suffb{\@nameauth@Suffix{#2}}% \def\csb{\@nameauth@Clean{#2}}% \def\csbc{\@nameauth@Clean{#2,#3}}% @@ -5079,8 +5548,8 @@ Running "make install" installs the files in the local TeX tree. % Below we parse the name arguments and choose the path. % \begin{macrocode} \@nameauth@Error{#2}{macro \string\IfMainName}% - \ifx\testa\@empty - \ifx\testc\@empty + \ifx\arga\@empty + \ifx\argc\@empty \ifcsname\csb!MN\endcsname{#4}\else{#5}\fi \else \ifx\suffb\@empty @@ -5097,14 +5566,13 @@ Running "make install" installs the files in the local TeX tree. % \end{macro} % % \begin{macro}{\IfFrontName} -% \changes{v2.3}{2016/01/05}{Added} -% \changes{v2.6}{2016/09/19}{Fix old syntax} -% This macro expands one path if a front matter name exists, the other if it does not exist. +% \changes{2.3}{2016/01/05}{Added} +% This macro expands one path if a front matter name exists, or else the other. % \begin{macrocode} \newcommandx\IfFrontName[5][1=\@empty, 3=\@empty] {% - \protected@edef\testa{#1}% - \protected@edef\testc{#3}% + \protected@edef\arga{\trim@spaces{#1}}% + \protected@edef\argc{\trim@spaces{#3}}% \protected@edef\suffb{\@nameauth@Suffix{#2}}% \def\csb{\@nameauth@Clean{#2}}% \def\csbc{\@nameauth@Clean{#2,#3}}% @@ -5113,8 +5581,8 @@ Running "make install" installs the files in the local TeX tree. % Below we parse the name arguments and choose the path. % \begin{macrocode} \@nameauth@Error{#2}{macro \string\IfFrontName}% - \ifx\testa\@empty - \ifx\testc\@empty + \ifx\arga\@empty + \ifx\argc\@empty \ifcsname\csb!NF\endcsname{#4}\else{#5}\fi \else \ifx\suffb\@empty @@ -5131,26 +5599,25 @@ Running "make install" installs the files in the local TeX tree. % \end{macro} % % \begin{macro}{\IfAKA} -% \changes{v2.3}{2016/01/05}{Added} -% \changes{v2.4}{2016/03/15}{New exclusion test} -% \changes{v2.6}{2016/09/19}{Fix old syntax} -% \changes{v3.0}{2016/10/26}{Redesigned} -% This macro expands one path if a see-reference name exists, another if it does not exist, and a third if it is excluded. +% \changes{2.3}{2016/01/05}{Added} +% \changes{2.4}{2016/03/15}{New exclusion test} +% \changes{3.0}{2016/10/26}{Redesigned} +% This macro expands one path if a cross-reference exists, another if it does not exist, and a third if it is excluded. % \begin{macrocode} \newcommandx\IfAKA[6][1=\@empty, 3=\@empty] {% - \protected@edef\testa{#1}% - \protected@edef\testc{#3}% + \protected@edef\arga{\trim@spaces{#1}}% + \protected@edef\argc{\trim@spaces{#3}}% \protected@edef\suffb{\@nameauth@Suffix{#2}}% \def\csb{\@nameauth@Clean{#2}}% \def\csbc{\@nameauth@Clean{#2,#3}}% \def\csab{\@nameauth@Clean{#1!#2}}% % \end{macrocode} -% Fore each class of name we test first if a cross-reference exists, then if it is excluded. +% For each class of name we test first if a cross-reference exists, then if it is excluded. % \begin{macrocode} \@nameauth@Error{#2}{macro \string\IfAKA}% - \ifx\testa\@empty - \ifx\testc\@empty + \ifx\arga\@empty + \ifx\argc\@empty \ifcsname\csb!PN\endcsname \edef\testex{\csname\csb!PN\endcsname}% \ifx\testex\@empty{#4}\else{#6}\fi @@ -5180,17 +5647,15 @@ Running "make install" installs the files in the local TeX tree. % % \noindent{\large\bfseries Changing Name Decisions} % \begin{macro}{\ForgetName} -% \changes{v0.75}{2012/01/19}{New argument added} -% \changes{v1.9}{2015/07/09}{Ensure global undef} -% \changes{v2.0}{2015/11/11}{Isolate malformed input} -% \changes{v2.3}{2016/01/05}{Global or local} -% \changes{v2.6}{2016/09/19}{Fix old syntax} -% This undefines a control sequence to force the ``first use'' option of \cmd{\Name}. +% \changes{0.75}{2012/01/19}{New argument added} +% \changes{1.9}{2015/07/09}{Ensure global undef} +% \changes{2.3}{2016/01/05}{Global or local} +% This undefines a control sequence to force a ``first use.'' % \begin{macrocode} \newcommandx*\ForgetName[3][1=\@empty, 3=\@empty] {% - \protected@edef\testa{#1}% - \protected@edef\testc{#3}% + \protected@edef\arga{\trim@spaces{#1}}% + \protected@edef\argc{\trim@spaces{#3}}% \protected@edef\suffb{\@nameauth@Suffix{#2}}% \def\csb{\@nameauth@Clean{#2}}% \def\csbc{\@nameauth@Clean{#2,#3}}% @@ -5199,8 +5664,8 @@ Running "make install" installs the files in the local TeX tree. % \end{macrocode} % Now we parse the arguments, undefining the control sequences either by current name type (via |@nameauth@MainFormat|) or completely (toggled by |@nameauth@LocalNames|). % \begin{macrocode} - \ifx\testa\@empty - \ifx\testc\@empty + \ifx\arga\@empty + \ifx\argc\@empty \if@nameauth@LocalNames \if@nameauth@MainFormat \global\csundef{\csb!MN}% @@ -5253,16 +5718,15 @@ Running "make install" installs the files in the local TeX tree. % \end{macro} % % \begin{macro}{\SubvertName} -% \changes{v0.9}{2012/02/10}{Added} -% \changes{v2.0}{2015/11/11}{Isolate malformed input} -% \changes{v2.3}{2016/01/05}{Global or local} -% \changes{v2.6}{2016/09/19}{Fix old syntax} -% This defines a control sequence to suppress the ``first use'' of \cmd{\Name}. +% \changes{0.9}{2012/02/10}{Added} +% \changes{2.3}{2016/01/05}{Global or local} +% \changes{3.1}{2017/01/13}{Fix old syntax} +% This defines a control sequence to force a ``subsequent use.'' % \begin{macrocode} \newcommandx*\SubvertName[3][1=\@empty, 3=\@empty] {% - \protected@edef\testa{#1}% - \protected@edef\testc{#3}% + \protected@edef\arga{\trim@spaces{#1}}% + \protected@edef\argc{\trim@spaces{#3}}% \protected@edef\suffb{\@nameauth@Suffix{#2}}% \def\csb{\@nameauth@Clean{#2}}% \def\csbc{\@nameauth@Clean{#2,#3}}% @@ -5272,10 +5736,10 @@ Running "make install" installs the files in the local TeX tree. % \begin{macrocode} \@nameauth@Error{#2}{macro \string\SubvertName}% % \end{macrocode} -% Now we parse the arguments, defining the control sequences either locally by section type or globally. |@nameauth@LocalNames| toggles the local or global behavior, while |@nameauth@MainFormat| selects the type of name. +% Now we parse the arguments, defining the control sequences either locally by section type or globally. |@nameauth@LocalNames| toggles the local or global behavior, while we select the type of name with |@nameauth@MainFormat|. % \begin{macrocode} - \ifx\testa\@empty - \ifx\testc\@empty + \ifx\arga\@empty + \ifx\argc\@empty \if@nameauth@LocalNames \if@nameauth@MainFormat \csgdef{\csb!MN}{}% @@ -5298,17 +5762,17 @@ Running "make install" installs the files in the local TeX tree. \csgdef{\csbc!MN}{}% \csgdef{\csbc!NF}{}% \fi - \fi - \else - \if@nameauth@LocalNames - \if@nameauth@MainFormat - \csgdef{\csb!MN}{}% + \else + \if@nameauth@LocalNames + \if@nameauth@MainFormat + \csgdef{\csb!MN}{}% + \else + \csgdef{\csb!NF}{}% + \fi \else + \csgdef{\csb!MN}{}% \csgdef{\csb!NF}{}% \fi - \else - \csgdef{\csb!MN}{}% - \csgdef{\csb!NF}{}% \fi \fi \else @@ -5329,25 +5793,27 @@ Running "make install" installs the files in the local TeX tree. % % \noindent{\large\bfseries Alternate Names} % \begin{macro}{\AKA} -% \changes{v0.85}{2012/02/05}{Comma suppression} -% \changes{v1.26}{2012/04/24}{Fix name suffixes} -% \changes{v1.5}{2013/02/22}{Reversing and caps} -% \changes{v2.0}{2015/11/11}{Fix malformed input; trim spaces; fix tagging} -% \changes{v2.1}{2015/11/24}{Fix Unicode issues} -% \changes{v2.3}{2016/01/05}{Expand starred mode} -% \changes{v2.4}{2016/03/15}{Fix formatting; add token regs} -% \changes{v2.41}{2016/03/17}{No local \cmd{\newtoks}} -% \changes{v2.6}{2016/09/19}{Fix index commas, old syntax} -% \changes{v3.0}{2016/10/26}{Redesigned} +% \changes{0.85}{2012/02/05}{Comma suppression} +% \changes{1.26}{2012/04/24}{Fix name suffixes} +% \changes{1.5}{2013/02/22}{Reversing and caps} +% \changes{2.0}{2015/11/11}{Trim spaces; fix tagging} +% \changes{2.1}{2015/11/24}{Fix Unicode issues} +% \changes{2.3}{2016/01/05}{Expand starred mode} +% \changes{2.4}{2016/03/15}{Fix formatting; add token regs} +% \changes{2.41}{2016/03/17}{No local \cmd{\newtoks}} +% \changes{2.6}{2016/09/19}{Fix index commas} +% \changes{3.0}{2016/10/26}{Redesigned} +% \changes{3.1}{2017/01/13}{Can skip index} % \cmd{\AKA} prints an alternate name and creates index cross-references. It prevents multiple generation of cross-references and suppresses double periods. % \begin{macrocode} \newcommandx*\AKA[5][1=\@empty, 3=\@empty, 5=\@empty] {% % \end{macrocode} -% Prevent entering \cmd{\AKA} via itself or \cmd{\@nameauth@Name}. +% Prevent entering \cmd{\AKA} via itself or \cmd{\@nameauth@Name}. Prevent the index-only flag. % \begin{macrocode} - \if@nameauth@Lock\else + \unless\if@nameauth@Lock \@nameauth@Locktrue% + \@nameauth@JustIndexfalse% % \end{macrocode} % Tell the formatting system that \cmd{\AKA} is running. Test for malformed input. % \begin{macrocode} @@ -5358,7 +5824,6 @@ Running "make install" installs the files in the local TeX tree. % Names occur in horizontal mode; we ensure that. Next we make copies of the target name arguments and we parse and print the cross-reference name. % \begin{macrocode} \leavevmode\hbox{}% - \protected@edef\testi{#1}% \protected@edef\argi{\trim@spaces{#1}}% \protected@edef\rooti{\@nameauth@Root{#2}}% \protected@edef\suffi{\@nameauth@Suffix{#2}}% @@ -5366,26 +5831,30 @@ Running "make install" installs the files in the local TeX tree. % \end{macrocode} % Create an index cross-reference based on the arguments. % \begin{macrocode} - \ifx\testi\@empty - \ifx\suffi\@empty - \IndexRef[#3]{#4}[#5]{\rooti}% - \else - \IndexRef[#3]{#4}[#5]{\rooti\space\suffi}% - \fi - \else - \ifx\suffi\@empty - \IndexRef[#3]{#4}[#5]{\rooti,\space\argi}% + \unless\if@nameauth@SkipIndex + \ifx\argi\@empty + \ifx\suffi\@empty + \IndexRef[#3]{#4}[#5]{\rooti}% + \else + \IndexRef[#3]{#4}[#5]{\rooti\space\suffi}% + \fi \else - \IndexRef[#3]{#4}[#5]{\rooti,\space\argi,\space\suffi}% + \ifx\suffi\@empty + \IndexRef[#3]{#4}[#5]{\rooti,\space\argi}% + \else + \IndexRef[#3]{#4}[#5]{\rooti,\space\argi,\space\suffi}% + \fi \fi \fi % \end{macrocode} % Reset all the ``per name'' Boolean values. % \begin{macrocode} + \@nameauth@SkipIndexfalse% \@nameauth@Lockfalse% \@nameauth@InAKAfalse% \@nameauth@AltAKAfalse% \@nameauth@NBSPfalse% + \@nameauth@NBSPXfalse% \@nameauth@DoCapsfalse% \@nameauth@Accentfalse% \@nameauth@AllThisfalse% @@ -5408,7 +5877,7 @@ Running "make install" installs the files in the local TeX tree. % \end{macro} % % \begin{macro}{\AKA*} -% \changes{v0.9}{2012/02/10}{Added} +% \changes{0.9}{2012/02/10}{Added} % This starred form sets a Boolean to print only the alternate name argument, if that exists, and calls \cmd{\AKA}. % \begin{macrocode} \WithSuffix{\newcommand*}\AKA*{\@nameauth@AltAKAtrue\AKA} @@ -5416,11 +5885,19 @@ Running "make install" installs the files in the local TeX tree. % \end{macro} % % \begin{macro}{\PName} -% \changes{v2.3}{2016/01/05}{Work directly with hooks} -% \cmd{\PName} is a convenience macro that calls \cmd{\NameauthName}, then \cmd{\AKA}. +% \changes{2.3}{2016/01/05}{Work directly with hooks} +% \changes{3.1}{2017/01/13}{Can skip index} +% \cmd{\PName} is a convenience macro that calls \cmd{\NameauthName}, then \cmd{\AKA}. It prevents the index-only feature from triggering. % \begin{macrocode} \newcommandx*\PName[5][1=\@empty,3=\@empty,5=\@empty] -{\NameauthName[#1]{#2}\space(\AKA[#1]{#2}[#3]{#4}[#5])} +{% + \@nameauth@JustIndexfalse% + \if@nameauth@SkipIndex + \NameauthName[#1]{#2}\space(\SkipIndex\AKA[#1]{#2}[#3]{#4}[#5])% + \else + \NameauthName[#1]{#2}\space(\AKA[#1]{#2}[#3]{#4}[#5])% + \fi +} % \end{macrocode} % \end{macro} % @@ -5433,12 +5910,12 @@ Running "make install" installs the files in the local TeX tree. % % \noindent{\large\bfseries Simplified Interface} % \begin{environment}{nameauth} -% \changes{v1.6}{2013/03/10}{Environment added} -% \changes{v1.9}{2015/07/09}{Bugfix} -% \changes{v2.0}{2015/11/11}{Redesigned argument handling} -% \changes{v2.11}{2015/11/29}{Bugfix} -% \changes{v2.41}{2016/03/17}{No local \cmd{\newtoks}} -% The \texttt{nameauth} environment creares macro shorthands. +% \changes{1.6}{2013/03/10}{Environment added} +% \changes{1.9}{2015/07/09}{Bugfix} +% \changes{2.0}{2015/11/11}{Redesigned argument handling} +% \changes{2.11}{2015/11/29}{Bugfix} +% \changes{2.41}{2016/03/17}{No local \cmd{\newtoks}} +% The \texttt{nameauth} environment creares macro shorthands. First we define a control sequence \cmd{\<} that takes four parameters, delimited by three ampersands and \texttt{>}. % \begin{macrocode} \newenvironment{nameauth}{% \begingroup% @@ -5450,6 +5927,9 @@ Running "make install" installs the files in the local TeX tree. \@nameauth@etoksb\expandafter{##2}% \@nameauth@etoksc\expandafter{##3}% \@nameauth@etoksd\expandafter{##4}% +% \end{macrocode} +% The first argument must have some text to create a set of control sequences with it. The third argument is the required name field. Redefining a shorthand creates a warning. +% \begin{macrocode} \ifx\@arga\@empty \PackageError{nameauth}% {environment nameauth: Control sequence missing}% @@ -5459,6 +5939,11 @@ Running "make install" installs the files in the local TeX tree. \PackageWarning{nameauth}% {environment nameauth: Shorthand macro already exists}% \fi +% \end{macrocode} +% Set up shorthands according to name form. We have to use \cmd{\expandafter}, not the $\epsilon$-\TeX{} way, due to \cmd{\protected@edef} in the naming macros. +% +% We begin with mononyms and non-Western names that use the new syntax. We use one \cmd{\expandafter} per token because we only have one argument to expand first. +% \begin{macrocode} \ifx\@testd\@empty \ifx\@testb\@empty \ex\csgdef\ex{\ex\@arga\ex}\ex{\ex\NameauthName\ex{% @@ -5470,6 +5955,9 @@ Running "make install" installs the files in the local TeX tree. \ex\@nameauth@FirstNametrue% \ex\NameauthFName\ex{\the\@nameauth@etoksc}}% \else +% \end{macrocode} +% Next we have Western names with no alternate names. Here we have two arguments to expand in reverse order, so we need three, then one uses of \cmd{\expandafter} per token. +% \begin{macrocode} \ex\ex\ex\csgdef\ex\ex\ex{\ex\ex\ex\@arga\ex\ex\ex}% \ex\ex\ex{\ex\ex\ex\NameauthName\ex\ex\ex[% \ex\the\ex\@nameauth@etoksb\ex]\ex{\the\@nameauth@etoksc}}% @@ -5483,6 +5971,9 @@ Running "make install" installs the files in the local TeX tree. \ex\the\ex\@nameauth@etoksb\ex]\ex{\the\@nameauth@etoksc}}% \fi \else +% \end{macrocode} +% Below are native Eastern names with alternates and the older syntax. Again, we have three or one use of \cmd{\expandafter} per step before the respective arguments. +% \begin{macrocode} \ifx\@testb\@empty \ex\ex\ex\csgdef\ex\ex\ex{\ex\ex\ex\@arga\ex\ex\ex}% \ex\ex\ex{\ex\ex\ex\NameauthName\ex\ex\ex{% @@ -5496,6 +5987,9 @@ Running "make install" installs the files in the local TeX tree. \ex\ex\ex\NameauthFName\ex\ex\ex{% \ex\the\ex\@nameauth@etoksc\ex}\ex[\the\@nameauth@etoksd]}% \else +% \end{macrocode} +% Here are Western names with alternates. We have three arguments to expand, so we have seven, three, and one respective use of \cmd{\expandafter}. +% \begin{macrocode} \ex\ex\ex\ex\ex\ex\ex\csgdef\ex\ex\ex\ex\ex\ex\ex{% \ex\ex\ex\ex\ex\ex\ex\@arga\ex\ex\ex\ex\ex\ex\ex}% \ex\ex\ex\ex\ex\ex\ex{\ex\ex\ex\ex\ex\ex\ex\NameauthName% diff --git a/Master/texmf-dist/source/latex/nameauth/nameauth.ins b/Master/texmf-dist/source/latex/nameauth/nameauth.ins index e6f0d9e00b7..98f2106819e 100644 --- a/Master/texmf-dist/source/latex/nameauth/nameauth.ins +++ b/Master/texmf-dist/source/latex/nameauth/nameauth.ins @@ -10,7 +10,7 @@ %% nameauth:| Name authority management for consistency in text and index %% Author:| Charles P. Schaum %% E-mail:| charles dot schaum at comcast dot net -%% License:| Released under the LaTeX Project Public License v1.3c or later +%% License:| Released under the LaTeX Project Public License 1.3c or later %% See:| http://www.latex-project.org/lppl.txt %% \input docstrip.tex @@ -22,13 +22,13 @@ nameauth:| Name authority management for consistency in text and index Author:| Charles P. Schaum E-mail:| charles dot schaum at comcast dot net - License:| Released under the LaTeX Project Public License v1.3c or later + License:| Released under the LaTeX Project Public License 1.3c or later See:| http://www.latex-project.org/lppl.txt \endpreamble \postamble -Copyright (C) 2016 by Charles P. Schaum <charles dot schaum at comcast dot net> +Copyright (C) 2017 by Charles P. Schaum <charles dot schaum at comcast dot net> This work may be distributed and/or modified under the conditions of the LaTeX Project Public License (LPPL), either @@ -53,7 +53,7 @@ Running "make install" installs the files in the local TeX tree. } \endbatchfile %% -%% Copyright (C) 2016 by Charles P. Schaum <charles dot schaum at comcast dot net> +%% Copyright (C) 2017 by Charles P. Schaum <charles dot schaum at comcast dot net> %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License (LPPL), either |