% \iffalse meta-comment % % Copyright (C) 2011 by Charles P. Schaum % --------------------------------------------------------------------------- % This work may be distributed and/or modified under the % conditions of the LaTeX Project Public License, either version 1.3 % of this license or (at your option) any later version. % The latest version of this license is in % http://www.latex-project.org/lppl.txt % and version 1.3 or later is part of all distributions of LaTeX % version 2005/12/01 or later. % % This work has the LPPL maintenance status `maintained'. % % The Current Maintainer of this work is Charles P. Schaum. % % This work consists of the files nameauth.dtx and nameauth.ins % and the derived filebase nameauth.sty. % % \fi % % \iffalse %<*driver> \ProvidesFile{nameauth.dtx} % %\NeedsTeXFormat{LaTeX2e}[2005/12/01] %\ProvidesPackage{nameauth} %<*package> [2012/01/29 v0.8 name authority macros to aid consistent display and indexing of names] % % %<*driver> \documentclass{ltxdoc} \usepackage[utf8]{inputenc} \usepackage[TS1,T1]{fontenc} \usepackage{hologo} \usepackage{lmodern} \usepackage{makeidx} \usepackage{newunicodechar} \usepackage{nameauth}[2012/01/29] \begingroup\lccode`!=`\\\lowercase{\endgroup\def\bsc{!}} \makeindex \frenchspacing \DeclareTextSymbolDefault{\textlongs}{TS1} \DeclareTextSymbol{\textlongs}{TS1}{115} \newunicodechar{ſ}{\textlongs} \newunicodechar{ā}{\=a} \newunicodechar{ṃ}{\d{m}} \EnableCrossrefs \CodelineIndex \RecordChanges \begin{document} \DocInput{nameauth.dtx} \PrintChanges \PrintIndex \end{document} % % \fi % % \CheckSum{318} % % \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 % Lower-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 % Digits \0\1\2\3\4\5\6\7\8\9 % Exclamation \! Double quote \" Hash (number) \# % Dollar \$ Percent \% Ampersand \& % Acute accent \' Left paren \( Right paren \) % Asterisk \* Plus \+ Comma \, % Minus \- Point \. Solidus \/ % Colon \: Semicolon \; Less than \< % Equals \= Greater than \> Question mark \? % Commercial at \@ Left bracket \[ Backslash \\ % Right bracket \] Circumflex \^ Underscore \_ % Grave accent \` Left brace \{ Vertical bar \| % Right brace \} Tilde \~} % % % \changes{v0.7}{2011/12/26}{Initial version} % \changes{v0.75}{2012/01/19}{New features described; documentation clarified} % \changes{v0.8}{2012/01/29}{Refactoring to improve functionality and compatibility; documentation expanded} % % \DoNotIndex{\newcommand, \newenvironment, \@empty, \@gobble, \bfseries, \bgroup, \def, \egroup, \else, \endcsname, \endinput, \ExecuteOptions, \fi, \if, \ifx, \IfBooleanTF, \IfValueTF, \itshape, \let, \newif, \relax, \renewcommand, \RequirePackage, \scshape, \space, \DeclareDocumentCommand, \DeclareOption, \ProcessOptions} % % \providecommand*{\url}{\texttt} % \GetFileInfo{nameauth.dtx} % \title{The \textsf{nameauth} package} % \author{Charles P. Schaum \\ \texttt{charles dot schaum at att dot net}} % \date{\fileversion~from \filedate} % % \maketitle % % \begin{abstract} % \noindent These macros help an author to encode the (optional) forenames and (mandatory) surnames of people in order to normalize occurrences in the text and entries in the index. This package is intended for Western-style naming conventions. % \end{abstract} % % \section{Introduction} % % Suppose you were working on a collection of essays. Depending on the permissions governing the essays, you might need to allow variance in the spelling of people's names. You would use either a house reference, a research library, or an encyclopedic source to decide on authoritative name forms. Your index might use abbreviated versions of those forms. Either a substantive or copy editor would keep track of the main name form, the variants, and their relationship to the index. For optimal quality, that would require a proofreading pass with queries to the editor. That adds time and cost to the job. If the author or editor can handle these details in advance, the result trims overhead cost. That could make a prospective author or freelance editor more likely to be selected for publication. % % \subsection{Design Decisions} % % This package assumes that an author or editor wants to minimize keystrokes. The default behavior sets the first occurrence of a person's name in small caps and prints out that full name. Subsequent occurrences set the last name only in the running text font. Considerable variation from the defaults is possible. % % \subsection{Thanks} % % Thanks to \Name[Marc van]{Dongen}, \Name[Enrico]{Gregorio}, \Name[Philipp]{Stephani}, \Name[Heiko]{Oberdiek}, and \Name[Uwe]{Lueck} for their invaluable assistance. Marc showed me the basic structure using the \textsf{xparse} package. Enrico and Philipp helped with generating control sequences and sanitizing. Heiko gave a space-removing solution that could be passed as an argument in a macro. Code adapted from Uwe's work on the texhax list enabled the routines to function with the \textsf{microtype} package. % % \section{Usage} % % \subsection{Package Options} % If the default behavior is not desired, the following options easily alter it. They are, as follows: % % \begin{quote} % \begin{tabular}{lp{3in}} % \texttt{mainmatter} & The default behavior triggers special typesetting of the first occurrence of a name, starting at the beginning of a document.\\[1ex] % \texttt{frontmatter} & This option suppresses the special typesetting of the first occurrence of a name before the invocation of \texttt{\bsc NamesActive}. This option fits well with front matter from a contributor who may not intend the same formatting and emphasis found in the main matter. The indexing and aliasing features of the package remain operative. \emph{Note}: One can switch at will between formatted and non-formatted sections; see Section \ref{sec:SectionFormat}.\\[2ex] % \texttt{smallcaps} & The default behavior when a name is first encountered is to print it in small caps.\\[1ex] % \texttt{italic} & This option causes the first occurrence of the name to be italicized.\\[1ex] % \texttt{boldface} & This option causes the first occurrence of the name to be set in boldface.\\[1ex] % \texttt{noformat} & This option suppresses document formatting after the invocation of \texttt{\bsc NamesActive}. If an author wants the indexing and aliasing functions without any special typesetting, this option accomplishes that easily. \emph{Note}: One can override the name typesetting options manually; see Section \ref{sec:FontAttributes}. This option is \emph{not} equivalent to \texttt{frontmatter}. The latter functions independently and never produces any formatting. This approach allows one to toggle formatting on and off without retyping the document. It anticipates variation among publishers' house styles. % \end{tabular} % \end{quote} % \clearpage % % \subsection{Quick Start Guide} % \changes{v0.8}{2012/01/29}{Added quick start guide for the impatient} % % This page and the next comprise a ``cheat sheet'' for the impatient. None of the examples in this subsection generate index entries. These examples simply help you get used to the package: % % \begin{enumerate}\setlength\itemsep{0pt}\small % \item The indexed forms of the names always remain the same. % \item Always use the same form of reference for, e.g., \texttt{\bsc Name[John]\{Smith\}} or\newline \texttt{\bsc Name\{Louis\}[XIV]}, otherwise point 1 will become false. % \item Typing longer name references allows you to rearrange text and let \LaTeX{} figure out first references and name forms. This package trades some work for consistency. % \item Checking against the index will help you debug your \texttt{\bsc Name} references, \emph{inter alia}. % \item Start using the macros you \emph{need}, then work from there. % \end{enumerate} % % \bgroup\small % \begin{tabular}{p{1.8in}p{2.3in}} % \normalsize\strut\textbf{I want to\dots} & \normalsize\textbf{I need to use} (for example)\dots \\\hline % Print a full Western name (first reference) & \texttt{\bsc Name*[John]\{Smith\}} or\newline \texttt{\bsc Name[John]\{Smith\}}\\\hline % Print a full Western name (subsequent reference) & \texttt{\bsc Name*[John]\{Smith\}}\\\hline % Print a short Western name (subsequent reference) & \texttt{\bsc Name[John]\{Smith\}}\\\hline % Print a Western name that has a longer form in the text than in the index (first reference) & \texttt{\bsc Name*[J.Q.]\{Public\}[Jane Q.]} or\newline \texttt{\bsc Name[J.Q.]\{Public\}[Jane Q.]}\\\hline % Now the full name without the longer form & \texttt{\bsc Name*[J.Q.]\{Public\}}\\\hline % Same person, last name only (subsequent reference) & \dag\texttt{\bsc Name[J.Q.]\{Public\}} or\newline \texttt{\bsc Name[J.Q.]\{Public\}[Jane Q.]}\\\hline % Print an ancient name & \texttt{\bsc Name\{Plato\}} or \texttt{\bsc Name*\{Plato\}}\\\hline % Print a full Eastern name (first reference) & \texttt{\bsc Name*\{Mao\}[Tse-tung]} or\newline \texttt{\bsc Name\{Mao\}[Tse-tung]}\\\hline % Print a full Eastern name (subsequent reference) & \texttt{\bsc Name*\{Mao\}[Tse-tung]}\\\hline % Print a short Eastern name (subsequent reference) & \texttt{\bsc Name\{Mao\}[Tse-tung]}\\\hline % Print a full enumerated name (first reference) & \texttt{\bsc Name*\{Louis\}[XIV]} or\newline \texttt{\bsc Name\{Louis\}[XIV]}\\\hline % Shorter subsequent reference & \texttt{\bsc Name\{Louis\}[XIV]}\\\hline % Print an ancient name and sobriquet & \texttt{\bsc Name*\{Antiochus V\}[Eupator]} or\newline \texttt{\bsc Name\{Antiochus V\}[Eupator]}\\\hline % Shorter subsequent reference to ``Antiochus V''; for name only, \emph{consistently} use ``V Eupator'' & \texttt{\bsc Name\{Antiochus V\}[Eupator]}\\\hline % \end{tabular} % % \smallskip\dag{} Using this form can cause unwanted results if you rearrange text. % \egroup % \clearpage % % \bgroup\small % \begin{tabular}{p{1.6in}p{2.5in}} % \normalsize\strut\textbf{I want to\dots} & \normalsize\textbf{I need to use} (for example)\dots \\\hline % Index, but do not print a reference to ``Public, J.Q.'' & \texttt{\bsc IndexName[J.Q.]\{Public\}} or\newline \ddag\texttt{\bsc IndexName[J.Q.]\{Public\}[Jane Q.]}\\\hline % Index, but do not print a reference to ``Plato'' & \texttt{\bsc IndexName\{Plato\}}\\\hline % Index, but do not print a reference to ``Mao Tse-tung'' & \P\texttt{\bsc IndexName\{Mao\}[Tse-tung]}\\\hline % Index, but do not print a reference to ``Louis XIV'' & \P\texttt{\bsc IndexName\{Louis\}[XIV]}\\\hline % Index, but do not print a reference to ``Antiochus V Eupator'' & \P\texttt{\bsc IndexName\{Antiochus V\}[Eupator]}\\\hline % \end{tabular} % % \smallskip\ddag{} The alternate names are ignored in this case.\\ % \indent\P{} ``Unofficial'' variants are neither shown nor encouraged. % \egroup % %\bigskip % \bgroup\small % \begin{tabular}{p{1.5in}p{2.6in}} % \normalsize\strut\textbf{I want to\dots} & \normalsize\textbf{I need to use} (for example)\dots \\\hline % Print a full Western name followed by a lesser-known name in parentheses (first reference) & \texttt{\bsc PName*[Bob]\{Hope\}[Leslie Townes]\{Hope\}} or\newline \texttt{\bsc PName[Bob]\{Hope\}[Leslie Townes]\{Hope\}}\\\hline % Print a full Western name followed by a lesser-known name in parentheses (subsequent reference) & \texttt{\bsc PName*[Bob]\{Hope\}[Leslie Townes]\{Hope\}}\\\hline % Print a surname only, followed by a full lesser-known name in parentheses (subsequent reference) & \texttt{\bsc PName[Bob]\{Hope\}[Leslie Townes]\{Hope\}}\\\hline % Print a mononym followed by a lesser-known name in parentheses & \texttt{\bsc PName*\{Prince\}[Prince Rogers]\{Nelson\}} or\newline \texttt{\bsc PName\{Prince\}[Prince Rogers]\{Nelson\}}\\\hline % Print a name, then another name that only cross-references it in the index & a tribute to \texttt{\bsc Name\{Ari Up\}, born \newline \bsc AKA\{Ari Up\}[Arianne]\{Forster\}\dots}\\\hline % \end{tabular} % \egroup % % \bigskip % These (and possibly other combinations) will likely fail: % \begin{enumerate}\setlength\itemsep{0pt}\small % \item \texttt{\bsc Name[First]\{Ancient\}[Sobriquet]} and \texttt{\bsc Name[King]\{Number\}[Sobriquet]} % \item \texttt{\bsc Name\{Ancient\}[Sobriquet] \bsc AKA\{Ancient Sobriquet\}[OtherFirst]\{OtherLast\}} % \item \texttt{\bsc Name\{Queen\}[Number] \bsc AKA\{Queen Number\}[OtherFirst]\{OtherLast\}} % \item \texttt{\bsc Name\{EastFamily\}[EastFirst] \bsc AKA\{EastFamily EastFirst\}[OtherFirst]\{OtherLast\}} % \item E.g. \texttt{\bsc Name[]\{Kreskin\}[The Amazing] (\bsc AKA\{Kreskin\}[Joseph]\{Kresge\})} % \item Using \texttt{\bsc PName} in the same way as \texttt{\bsc AKA} above. % \item Using \texttt{\bsc Name} with a lot of people having the same surname or mononym and different numbers without disambiguation in the text. % \item Getting the pairing of \texttt{\{} and \texttt{\}} or \texttt{[} and \texttt{]} messed up. % \end{enumerate} % % \subsection{Basic Macros} % % \subsubsection{\texttt{\bsc Name} and \texttt{\bsc Name*}} % % \DescribeMacro{\Name} % \DescribeMacro{\Name*} % This macro generates two forms of the name: a printed form in the text and a form of the name that occurs in the index.\index{name forms|usage} % The general syntax is: % \begin{quote} % \texttt{\bsc Name}\oarg{forename(s)}\marg{surname(s)}\oarg{alternate names}\\ % \texttt{\bsc Name*}\oarg{forename(s)}\marg{surname(s)}\oarg{alternate names} % \end{quote} % % From now on we will abbreviate \emph{forename(s)} with \emph{FNN} and \emph{surname(s)} with \emph{SNN} at various points. The syntax descriptions above do not capture exactly how the \texttt{\bsc Name} macro behaves. The following table should help: % % \begin{quote}\small % \begin{tabular}{llll}\hline % {\large\strut}\emph{FNN} & \emph{SNN} & Alternate Names & Result\\\hline % \texttt{Albert} & \texttt {Einstein} & (none) & \Name[Albert]{Einstein}\\ % (none) & \texttt{Confucius} & (none) & \Name{Confucius}\\ % \texttt{M.T.} & \texttt{Cicero} & \texttt{Marcus Tullius} & \Name[M.T.]{Cicero}[Marcus Tullius]\\ % (none) & \texttt{Charles} & \texttt{the Bald} & \Name{Charles}[the Bald]\\\hline % \end{tabular} % \end{quote} % % Basically,\texttt{\bsc Name} connects the \emph{FNN} to the \emph{SNN} to create both a printed form and an indexed form, respectively, \textbf{\emph{FNN}\,\emph{SNN}} and \textbf{\emph{SNN},\,\emph{FNN}}. This takes care of most modern Western names. For those with one name, such as ancient figures or those with stage names, one can drop the \emph{FNN} so that \texttt{\bsc Name} produces the result \textbf{\emph{SNN}} for both text and index. % % A newer feature added to \texttt{\bsc Name} avoids a complicated workaround. Sometimes you might want to have the option of using either an alternate set of forenames or a sobriquet that functions as a surname for ancient figures. These two alternatives are handled by the final, optional field of \texttt{\bsc Name}. If ``regular'' \emph{FNN} are present, then the alternate names conditionally will replace the \emph{FNN} in the printed form, but not in the indexed form. If no regular \emph{FNN} are present, then the alternate names will be appended to the \emph{SNN} in the printed form \emph{and} in the indexed form. You must use the sobriquet form of a name consistently or risk confusion. % % I mentioned conditional use. The unstarred form prints the ``full name'' at the first occurrence, then only the partial form thereafter. The starred form always prints the full name. Both macros usually apply a different ``font attribute'' to the name when it first appears in the running text. % % Here are some more examples of use: % % \begin{quote}\small % \texttt{\bsc Name*[Johann Wolfgang von]\{Goethe\}}\\ % Print \Name*[Johann Wolfgang von]{Goethe} the first time it appears.\\ % Later, print the full name \Name*[Johann Wolfgang von]{Goethe}.\\[1ex] % \texttt{\bsc Name[Johann Wolfgang von]\{Goethe\}}\\ % \ForgetName[Johann Wolfgang von]{Goethe}% % Print \Name[Johann Wolfgang von]{Goethe} the first time it appears.\\ % Later, print only the last name \Name[Johann Wolfgang von]{Goethe}.\\[1ex] % \texttt{\bsc Name\{Boethius\}} and \texttt{\bsc Name*\{Boethius\}} % Print \Name{Boethius} the first time it appears. Later, print \Name{Boethius}. % \end{quote} % % \begin{quote}\small % \texttt{\bsc Name*\{Antiochus IV\}[Epiphanes]}\\ % Print \Name*{Antiochus IV}[Epiphanes] the first time it appears. Later, print the name and sobriquet \Name*{Antiochus IV}[Epiphanes].\\[1ex] % \ForgetName{Antiochus IV}[Epiphanes]% % \texttt{\bsc Name\{Antiochus IV\}[Epiphanes]}\\ % Print \Name{Antiochus IV}[Epiphanes] the first time it appears. Later, print just the name \Name{Antiochus IV}[Epiphanes]. % \end{quote} % % \emph{Note}: Here I am playing a ``dirty trick'' by making each line begin as if the name had not yet occurred. See Section \ref{sec:Tweaks} for more. % % \subsubsection{Suffix Removal} % % \texttt{\bsc Name} and \texttt{\bsc Name*} have an additional difference. \texttt{\bsc Name} will truncate the comma and suffizes from subsquent occurrences of last names. For example, it prints the name \Name[Oskar]{Hammerstein, II} the first time and \Name[Oskar]{Hammerstein, II} thereafter. % % These macros keep track of whether the name ends with the period of an abbreviation like ``Jr.'' and ``Sr.'' That should also work with abbreviations like ``d.~\"{A}.'' (\textit{der \"{A}ltere}). Two periods are not printed when the full name is printed at the end of a sentence. The following example shows the possible combinations: % % \ForgetName[Martin Luther]{King, Jr.}% % \begin{quote}\small % \begin{tabular}{ll} % \texttt{\bsc Name[Martin Luther]\{King, Jr.\}.} & \Name[Martin Luther]{King, Jr.}.\\ % \texttt{\bsc Name[Martin Luther]\{King, Jr.\}.} & \Name[Martin Luther]{King, Jr.}.\\ % \texttt{\bsc Name[Martin Luther]\{King, Jr.\}} & \Name[Martin Luther]{King, Jr.} (e.g., in a sentence)\\ % \texttt{\bsc Name*[Martin Luther]\{King, Jr.\}.} & \Name*[Martin Luther]{King, Jr.}.\\ % \texttt{\bsc Name*[Martin Luther]\{King, Jr.\}} & \Name*[Martin Luther]{King, Jr.} % \end{tabular} % \end{quote} % % \subsubsection{Tabular Summary of \texttt{\bsc Name}} % % We begin by recapitulating the original uses: Usual Western forenames and surnames, persons with a mononym, an abbreviated name in the index and a fuller name in the text, and a mononym plus sobriquet option: % % \begin{quote}\small % \begin{tabular}{llll}\hline % {\large\strut}\emph{FNN} & \emph{SNN} & Alternate Names & Result\\\hline % \texttt{Harry S.} & \texttt {Truman} & (none) & \Name[Harry S.]{Truman}\\ % (none) & \texttt{Mencius} & (none) & \Name{Mencius}\\ % \texttt{John Q.} & \texttt{Adams} & \texttt{John Quincy} & \Name[John Q.]{Adams}[John Quincy]\\ % (none) & \texttt{Ptolemy I} & \texttt{Soter} & \Name{Ptolemy I}[Soter]\\\hline % \end{tabular} % \end{quote} % % Different results can be achieved when the options are applied creatively. In some cases, the sobriquet option can serve for lists of royalty and references to them. In others, this use will fail: % % \begin{quote}\small % \begin{tabular}{llp{1.2cm}ll}\hline % \emph{FNN} & \emph{SNN} & Alternate Names & Result & Function\\\hline % (none) & \texttt{Henry} & \texttt{VIII} & \Name{Henry}[VIII] & \texttt{\bsc Name\{Henry\}[VIII]}\\ % (none) & \texttt{Henry} & \texttt{VIII} & \Name*{Henry}[VIII] & \texttt{\bsc Name*\{Henry\}[VIII]}\\ % (none) & \texttt{Henry} & \texttt{VIII} & \Name{Henry}[VIII] & \texttt{\bsc Name\{Henry\}[VIII]}\\ % \texttt{Henry} & \texttt{Tudor} & \texttt{VIII} & \textsc{VIII Tudor} & \texttt{\bsc Name[Henry]\{Tudor\}[VIII]}\\\hline % \end{tabular} % \end{quote} % % Very rudimentary references to Eastern names (I plead ignorance on this point) can be achieved via the sobriquet feature: % % \begin{quote}\small % \begin{tabular}{llp{1.2cm}ll}\hline % \emph{FNN} & \emph{SNN} & Alternate Names & Result & Function\\\hline % (none) & \texttt{Chiang} & \texttt{Kai-shek} & \Name{Chiang}[Kai-shek] & \texttt{\bsc Name\{Chiang\}[Kai-shek]}\\ % (none) & \texttt{Chiang} & \texttt{Kai-shek} & \Name{Chiang}[Kai-shek] & \texttt{\bsc Name\{Chiang\}[Kai-shek]}\\ % (none) & \texttt{Sun} & \texttt{Yat-sen} & \Name{Sun}[Yat-sen] & \texttt{\bsc Name\{Sun\}[Yat-sen]}\\ % (none) & \texttt{Sun} & \texttt{Yat-sen} & \Name{Sun}[Yat-sen] & \texttt{\bsc Name\{Sun\}[Yat-sen]}\\\hline % \end{tabular} % \end{quote} % % Here is a general table of options. Sobriquets and suffixes do mix, but not well. Therefore their use together is not shown. % % \begin{quote}\small % \begin{tabular}{llp{1.4cm}p{4cm}}\hline % \emph{FNN} & \emph{SNN} & Alternate Names & Result\\\hline % \texttt{Forename} & \texttt{SurnameA, Suffix} & \texttt{Othername} & \Name[Forename]{SurnameA, Suffix}[Othername] (\texttt{\bsc Name})\\ % \texttt{Forename} & \texttt{SurnameA, Suffix} & \texttt{Othername} & \Name*[Forename]{SurnameA, Suffix}[Othername] (\texttt{\bsc Name*})\\ % \texttt{Forename} & \texttt{SurnameA, Suffix} & \texttt{Othername} & \Name[Forename]{SurnameA, Suffix}[Othername] (\texttt{\bsc Name})\\\hline % \texttt{Forename} & \texttt{SurnameB, Suffix} & (none) & \Name[Forename]{SurnameB, Suffix} (\texttt{\bsc Name})\\ % \texttt{Forename} & \texttt{SurnameB, Suffix} & (none) & \Name*[Forename]{SurnameB, Suffix} (\texttt{\bsc Name*})\\ % \texttt{Forename} & \texttt{SurnameB, Suffix} & (none) & \Name[Forename]{SurnameB, Suffix} (\texttt{\bsc Name})\\\hline % \end{tabular} % \end{quote} % % \subsection{Advanced Features} % % \subsubsection{Alternate forenames in the Text} % % I showed above the cases of \Name[M.T.]{Cicero}[Marcus Tullius] and \Name*[John Q.]{Adams}[John Quincy] where one can have a longer name in the text than in the index. Here are fuller examples: % % \begin{quote}\small % \texttt{\bsc Name[Wilhelm M.L.]\{De Wette\}[Wilhelm Martin Leberecht]}\\ % \Name[Wilhelm M.L.]{De Wette}[Wilhelm Martin Leberecht] (text, first occurrence)\\ % \Name[Wilhelm M.L.]{De Wette}[Wilhelm Martin Leberecht] (text, second occurrence)\\ % The abbreviated name ``De Wette, Wilhelm M.L.'' is in the index.\\[1ex] % \ForgetName[Wilhelm M.L.]{De Wette}% % \texttt{\bsc Name*[Wilhelm M.L.]\{De Wette\}}\\ % \Name*[Wilhelm M.L.]{De Wette} (text, first occurrence)\\ % \Name*[Wilhelm M.L.]{De Wette} (text, second occurrence)\\ % The abbreviated name ``De Wette, Wilhelm M.L.'' is in the index.\\[1ex] % \ForgetName[Wilhelm M.L.]{De Wette}% % \texttt{\bsc Name*[Wilhelm M.L.]\{De Wette\}[W.M.L.]}\\ % \Name*[Wilhelm M.L.]{De Wette}[W.M.L.] (text, first occurrence)\\ % \Name*[Wilhelm M.L.]{De Wette}[W.M.L.] (text, second occurrence)\\ % The abbreviated name “De Wette, Wilhelm M.L.” is in the index. % \end{quote} % % The alternate forenames \emph{override} the \emph{FNN} in the text. This is \emph{not} true with sobriquets, which are \emph{appended} to \emph{SNN}. The difference in the two is whether the \emph{FNN} argument exists. Alternate forenames do not get printed in subsequent occurrences of \texttt{\bsc Name}. They \emph{do} get printed in subsequent occurrences of \texttt{\bsc Name*}. The surname argument is \emph{always} printed. There is, however, the possibility that you might refer to a person with a nickname only. The next macro facilitates this. % % \subsubsection{\texttt{\bsc IndexName}} % % \DescribeMacro{\IndexName} % This macro prints no text in the body. It only creates an index entry that conforms with the rest of the package. Its syntax is: % \begin{quote} % \texttt{\bsc IndexName}\oarg{FNN}\marg{SNN}\oarg{alternate names} % \end{quote} % % The \texttt{\bsc IndexName} \emph{does not work} with the pen name mechanism described below. This example shows \texttt{\bsc Name} and \texttt{\bsc IndexName} working together. % % \begin{quote} % \bgroup\ttfamily % \bsc Name[C.F.W.]\{Walther\}[Carl Ferdinand Wilhelm] was a major\break figure in nineteenth-century American Lutheran history.\break \bsc Name[C.F.W.]\{Walther\} used his full name when signing\break official documents. To his family, friends, and close\break colleagues, however, he was simply\break Ferdinand\bsc IndexName[C.F.W.]\{Walther\}. % \egroup % % \Name[C.F.W.]{Walther}[Carl Ferdinand Wilhelm] was a major figure in nineteenth-century American Lutheran history. \Name[C.F.W.]{Walther} used his full name when signing official documents. To his family, friends, and close colleagues, however, he was simply Ferdinand\IndexName[C.F.W.]{Walther}. % \end{quote} % % One can use this macro for special cases, like referring to works by joint or multiple authors or simply indexing names consistently with this package: % % \begin{quote} % \bgroup\ttfamily % \bsc newcommand\{\bsc SJB\}\%\break % \{\bsc IndexName[Stan]\{Berenstain\}\bsc IndexName[Jan]\{Berenstain\}\}\break % \bsc textit\{The Berenstain Bears\} is a popular series of\break children's books with over 300 titles. One can index the\break Berenstains\bsc SJB\{\} in this manner. % \egroup % % \newcommand{\SJB}% % {\IndexName[Stan]{Berenstain}\IndexName[Jan]{Berenstain}} % \textit{The Berenstain Bears} is a popular series of children's books with over 300 titles. One can index the Berenstains\SJB{} in this manner. % \end{quote} % % \ForgetName{Antiochus IV}[Epiphanes]% % \begin{quote} % \bgroup\ttfamily % First Maccabees recounts the suppression of Jewish customs\break under the Seleucid king \bsc Name\{Antiochus IV\}[Epiphanes]. His behavior was so egregious that he became an early model for the later profile of Antichrist.\break \bsc IndexName\{Antiochus IV\}[Epiphanes] % \egroup % % First Maccabees recounts the suppression of Jewish customs under the Seleucid king \Name{Antiochus IV}[Epiphanes]. His behavior was so egregious that he became an early model for the later profile of Antichrist.\IndexName{Antiochus IV}[Epiphanes] % \end{quote} % % \texttt{\bsc IndexName} may be helpful in a pinch, but it lacks certain safeguards for handling pseudonyms that the following macros introduce. % % \subsubsection{\texttt{\bsc PName} and \texttt{\bsc AKA}: Pen Names} % % This section deals with pen names that function differently than the sobriquet feature and apart from it. I have designed these macros to preclude the alternate name and sobriquet features of \texttt{\bsc Name} for the following reasons: % % \begin{enumerate} % \item It only makes sense for \texttt{\bsc PName} and \texttt{\bsc AKA} to have the better-known name come first, then the lesser-known name. % \item Having the names in that order produces an ambiguous argument list when implementing sobriquets. Making the list unambiguous by using a mandatory argument often would require the author to type an empty set of braces. % \item The more names and details that get packed into any given macro, the more confusing it is to use. That level of inefficiency defeats the purpose of this package, which is to save typing, yet have standardized names. % \item A number of ancient pseudonyms require special typesetting that must be handled manually. % \end{enumerate} % % The workaround for a name using a sobriquet is simply: % \begin{quote} % \bgroup\ttfamily % \verb!\index{Jean the Fearless|see {Jean sans Peur}}%!\\ % \bsc Name\{Jean\}[sans Peur] (Jean the Fearless) was Duke of Burgundy from 1404 to 1419. % \egroup % % \index{Jean the Fearless|see {Jean sans Peur}}% % \Name{Jean}[sans Peur] (Jean the Fearless) was Duke of Burgundy from 1404 to 1419. % \end{quote} % % A more complicated example is: % \begin{quote} % \bgroup\ttfamily\small % \verb!\index{Doctor Angelicus@\textit{Doctor Angelicus}|see {Thomas Aquinas}}%!\\ % \verb!\index{Thomas of Aquino|see {Thomas Aquinas}}%!\\ % Perhaps the greatest medieval theologian was \bsc Name\{Thomas\}[Aquinas] (Thomas of Aquino), also known as \bsc textit\{Doctor Angelicus\}. His name ``Aquinas'' is not a surname, so many modern scholars refer to him as \bsc Name\{Thomas\}[Aquinas]. % \egroup % % \index{Doctor Angelicus=\textit{Doctor Angelicus}|see {Thomas Aquinas}}% % \index{Thomas of Aquino|see {Thomas Aquinas}}% % Perhaps the greatest medieval theologian was \Name{Thomas}[Aquinas] (Thomas of Aquino), also known as \textit{Doctor Angelicus}. His name ``Aquinas'' is not a surname, so many modern scholars refer to him as \Name{Thomas}[Aquinas]. % \end{quote} % % This also means, unfortunately, that pen names used with Eastern names will have to be indexed manually. % % \DescribeMacro{\PName} % Pseudonyms, \emph{noms de plume}, epithets, and monikers can be handled with two macros: \texttt{\bsc PName} and \texttt{\bsc AKA}. The macro \texttt{\bsc PName} takes a well-known name, followed by as lesser-known name. Like \texttt{\bsc Name}, \texttt{\bsc PName} has starred and unstarred forms, but those forms only operate on the main name that is indexed, not on the second, lesser-known name. The syntax is: % \begin{quote} % \texttt{\bsc PName}\oarg{FNN}\marg{SNN}\oarg{lesser-known FNN}\marg{lesser-known SNN} % \end{quote} % % The following examples should make clear its use: % % \begin{quote} % \texttt{\bsc PName*[Mark]\{Twain\}[Samuel L.]\{Clemens\}}\\ % Print \PName*[Mark]{Twain}[Samuel L.]{Clemens} the first time it appears. Later, print \PName*[Mark]{Twain}[Samuel L.]{Clemens}.\\[1ex] % \ForgetName[Mark]{Twain}% % \texttt{\bsc PName[Mark]\{Twain\}[Samuel L.]\{Clemens\}}\\ % Print \PName[Mark]{Twain}[Samuel L.]{Clemens} the first time it appears. Later, print \PName[Mark]{Twain}[Samuel L.]{Clemens}.\\[1ex] % \texttt{\bsc PName*[Willebrord]\{Snel van Royen\}\{Snellius\}}\\ % Print \PName*[Willebrord]{Snel van Royen}{Snellius} the first time it appears. Later, print \PName*[Willebrord]{Snel van Royen}{Snellius}.\\[1ex] % \ForgetName[Willebrord]{Snel van Royen}% % \texttt{\bsc PName[Willebrord]\{Snel van Royen\}\{Snellius\}}\\ % Print \PName[Willebrord]{Snel van Royen}{Snellius} the first time it appears. Later, print \PName[Willebrord]{Snel van Royen}{Snellius}.\\[1ex] % \texttt{\bsc PName\{Voltaire\}[François-Marie]\{Arouet\}}\\ % Print \PName{Voltaire}[François-Marie]{Arouet} the first time it appears. Later, print \PName{Voltaire}[François-Marie]{Arouet}. The starred version also produces \PName*{Voltaire}[François-Marie]{Arouet} % \end{quote} % % \DescribeMacro{\AKA} % The second macro that handles aliases is \texttt{\bsc AKA}. It is the same alias mechanism used in \texttt{\bsc PName}, but separated for more flexibility. Its syntax is similar to \texttt{\bsc PName}: % \begin{quote} % \texttt{\bsc AKA}\oarg{FNN}\marg{SNN}\oarg{lesser-known FNN}\marg{lesser-known SNN} % \end{quote} % % \texttt{\bsc AKA} only prints the pseudonym, \emph{not} the indexed name. The macro also will prevent the double-printing of a period after an abbreviation. Here is an example: % % \begin{quote} % \bgroup\ttfamily % Today we consider \bsc AKA[George]\{Eliot\}[Mary Anne]\{Evans\} and her literary contributions as \bsc Name[George]\{Eliot\}. % \egroup % % Today we consider \AKA[George]{Eliot}[Mary Anne]{Evans} and her literary contributions as \Name[George]{Eliot}. % \end{quote} % % \texttt{\bsc AKA} creates an index entry that cross-references to the ``main'' name given. It is assumed that a \texttt{\bsc Name} macro occurs somewhere in reference to the indexed name. No error checking otherwise occurs for this. % % Pseudonyms cannot be indexed with page numbers. They only work as ``see'' cross-references. \texttt{\bsc Name} will print its arguments and emit a warning if you give a pen name. If you want to index a pseudonym with page numbers, use \texttt{\bsc Name} for both the main name and the pseudonym, then manually cross-reference them, e.g.:\medskip % % \bgroup\small\index{Rambam|seealso{Maimonides}} % \begin{tabular}{p{0.7in}ll}\hline % Authoritative Name & Alternate Name & Example of Use\\\hline % \Name{Maimonides} & \AKA{Maimonides}{Moses ben-Maimon} & \texttt{\bsc AKA\{Maimonides\}\{Moses ben-Maimon\}}\\ % \Name{Maimonides} & \Name{Rambam} & \verb!\Name{Rambam}!\\& & \verb!\index{Rambam|seealso{Maimonides}!\\\hline % \end{tabular} % \egroup % % \texttt{\bsc AKA} will not create multiple instances of a cross-reference. This prevents bogus multiple cross-references in the index, but it also excludes the special case where one moniker applies to multiple people, e.g.: \PName*[Willebrord]{Snel van Royen}{Snellius} and his son \PName*[Rudolph]{Snel van Royen}{Snellius}. % \index{Snellius|see {Snel van Royen, Rudolph}}% % Do not use \texttt{\bsc IndexName} in this case. One must add a manual index entry as a workaround: % \begin{quote} % \verb!\index{Snellius|see {Snel van Royen, Rudolph}}! % \end{quote} % % Be careful with name collisions, especially with more than one person having the same last name. The following examples illustrate this: % \begin{quote} % \texttt{\bsc PName[Willebrord]\{Snel van Royen\}\{Snellius\}}\\ % \PName[Willebrord]{Snel van Royen}{Snellius}\\[1ex] % \texttt{\bsc PName[Rudolph]\{Snel van Royen\}\{Snellius\}}\\ % \PName[Rudolph]{Snel van Royen}{Snellius}\\[1ex] % \texttt{\bsc Name[Willebrord]\{Snel van Royen\}}\\ % \Name[Willebrord]{Snel van Royen}\\[1ex] % \texttt{\bsc Name[Rudolph]\{Snel van Royen\}}\\ % \Name[Rudolph]{Snel van Royen} % \end{quote} % % \subsection{Accented Names} % \label{sec:Accents} % % The following Unicode accents will work in names using UTF8 and \textsf{inputenc}: % % \begin{quote} % \begin{tabular}{llll} % \scshape À Á Â Ã Ä Å Æ & \scshape Ç È É Ê Ë & \scshape Ì Í Î Ï Ð Ñ & \scshape first use \\ % À Á Â Ã Ä Å Æ & Ç È É Ê Ë & Ì Í Î Ï Ð Ñ & second use \\[1ex] % \scshape Ò Ó Ô Õ Ö Ø & \scshape Ù Ú Û Ü Ý & \scshape Þ ß & \scshape first use \\ % Ò Ó Ô Õ Ö Ø & Ù Ú Û Ü Ý & Þ ß & second use \\[1ex] % \scshape à á â ã ä å æ & \scshape ç è é ê ë & \scshape ì í î ï ð ñ & \scshape first use \\ % à á â ã ä å æ & ç è é ê ë & ì í î ï ð ñ & second use \\[1ex] % \scshape ò ó ô õ ö ø & \scshape ù ú û ü ý & \scshape þ ÿ & \scshape first use \\ % ò ó ô õ ö ø & ù ú û ü ý & þ ÿ & second use \\[1ex] % \scshape Ă ă Ą ą Ć ć Č č & \scshape Ď ď Đ đ Ę ę Ě ě & \scshape Ğ ğ İ ı & \scshape first use \\ % Ă ă Ą ą Ć ć Č č & Ď ď Đ đ Ę ę Ě ě & Ğ ğ İ ı & second use \\[1ex] % \scshape IJ ij Ľ ľ Ł ł & \scshape Ń ń Ň ň Œ œ & \scshape Ŕ ŕ Ř ř & \scshape first use \\ % IJ ij Ľ ľ Ł ł & Ń ń Ň ň Œ œ & Ŕ ŕ Ř ř & second use \\[1ex] % \scshape Ś Ş ş Š š Ţ ţ Ť ť & \scshape Ů ů Ű ű & \scshape Ź ź Ż ż Ž ž & \scshape first use \\ % Ś Ş ş Š š Ţ ţ Ť ť & Ů ů Ű ű & Ź ź Ż ż Ž ž & second use \\ % \end{tabular} % \end{quote} % % Other accents will not work unless you use \TeX\ control sequences or \hologo{XeLaTeX}. You can also include the TS1 encoding and do something like the following with the \textsf{inputenc} package, the \textsf{newunicodechar} package, and and UTF8: % % \begin{quote} % \texttt{\bsc DeclareTextSymbolDefault\{\bsc textlongs\}\{TS1\}}\\ % \texttt{\bsc DeclareTextSymbol\{\bsc textlongs\}\{TS1\}\{115\}}\\ % \texttt{\bsc newunicodechar\{ſ\}\{\bsc textlongs\}}\\ % \texttt{\bsc newunicodechar\{ā\}\{\bsc=a\}}\\ % \texttt{\bsc newunicodechar\{ṃ\}\{\bsc d\{m\}\}} % \end{quote} % % Please remember that the appropriate font packages, such as \textsf{lmodern} or the \TeX\ Gyre fonts, are needed to obtain some TS1 glyphs. Also there may be points where \textsf{pdflatex} will accept the input (e.g., Gh{\=a}zali), but \textsf{makeindex} will have problems with that. In ``normal'' operation (I have used \textsf{article} and \textsf{memoir}) these control sequences appear to work. Yet in generating this style file, that was not the case. You may need to use manual index entries in those cases. % % \subsection{Name Formatting} % % \subsubsection{Font Attributes} % \label{sec:FontAttributes} % \changes{v0.8}{2012/01/29}{Expanded description of functionality} % % \DescribeMacro{\NamesFormat} % The first time a name is printed, it is formatted with the font attribute stored in \texttt{\bsc NamesFormat}. This is set with the class options or manually. \texttt{\bsc NamesFormat} can use either the command form or the declaration form of selecting font attributes, e.g., \texttt{\bsc textsc} or \texttt{\bsc scshape}. By redefining this macro, one can ``hook'' into the special typesetting of the first occurrence of a name. Consider the following: % % \begin{quote} % \texttt{\bsc renewcommand\{\bsc NamesFormat\}[1]\{\bsc textbf\{\#1\}\%}\\ % \texttt{\bsc ifinner\bsc else\bsc marginpar\{\bsc scriptsize \#1\}\bsc fi\}} % \end{quote} % % If we \texttt{\bsc let} the value of \texttt{\bsc NamesFormat} to save the current value and implement a temporary change like the above, we get: % % \let\oldformat\NamesFormat % \renewcommand{\NamesFormat}[1]{\textbf{#1}\ifinner\else\marginpar{\scriptsize #1}\fi} % %\begin{quote} % \texttt{\bsc Name\{Vlad III\}[Dracula] became known as Vlad Ţepeş, ``The Impaler,'' after his death. He was the son of \bsc Name\{Vlad II\}[Dracul]. Later references to \bsc Name\{Vlad III\}[Dracula] appear thus.}\bigskip % % \Name{Vlad III}[Dracula] became known as Vlad Ţepeş, ``The Impaler,'' after his death. He was the son of \Name{Vlad II}[Dracul]. Later references to \Name{Vlad III}[Dracula] appear thus. % \end{quote} % % \let\NamesFormat\oldformat % % After using \texttt{\bsc let} to revert \texttt{\bsc NamesFormat}, a first occurrence again takes the form: \ForgetName{Vlad III}[Dracula]\Name{Vlad III}[Dracula].\\ % % Let me again stress that with names like \Name*{Vlad II}[Dracul] and \Name*{Vlad III}[Dracula], you cannot use either \texttt{\bsc PName} or \texttt{\bsc AKA}. Attempting to do so will fail. You must use as a guide the examples given above for \Name*{Jean}[sans Peur] and \Name*{Thomas}[Aquinas]. % % \subsection{Formatting Certain Sections} % \label{sec:SectionFormat} % % \DescribeMacro{\NamesActive} % \DescribeMacro{\NamesInctive} % Using the \texttt{frontmatter} option deactivates formatting until \texttt{\bsc NamesActive} occurs. Another macro, \texttt{\bsc NamesInactive}, will deactivate formatting again. These two macros toggle formatting on and off. The mechanism works in a complementary, yet independent manner. It can be used throughout the document. % % Here we switch to the ``front matter'' mode with \texttt{\bsc NamesInactive}: % \NamesInactive % \begin{quote} % \begin{tabular}{ll} % \texttt{\bsc Name[Rudolph]\{Carnap\}} & \Name[Rudolph]{Carnap}\\ % \texttt{\bsc Name[Rudolph]\{Carnap\}} & \Name[Rudolph]{Carnap}\\ % \texttt{\bsc Name[Nicolas]\{Malebranche\}} & \Name[Nicolas]{Malebranche}\\ %\texttt{\bsc Name[Nicolas]\{Malebranche\}} & \Name[Nicolas]{Malebranche}\\ % \end{tabular} % \end{quote} % % Then we switch back to ``main matter'' mode with \texttt{\bsc NamesActive}: % \NamesActive % \begin{quote} % \begin{tabular}{ll} % \texttt{\bsc Name[Rudolph]\{Carnap\}} & \Name[Rudolph]{Carnap}\\ % \texttt{\bsc Name[Rudolph]\{Carnap\}} & \Name[Rudolph]{Carnap}\\ % \texttt{\bsc Name[Nicolas]\{Malebranche\}} & \Name[Nicolas]{Malebranche}\\ %\texttt{\bsc Name[Nicolas]\{Malebranche\}} & \Name[Nicolas]{Malebranche}\\ % \end{tabular} % \end{quote} % % \subsection{Tweaks:\texttt{\bsc ForgetName}} % \label{sec:Tweaks} % % \DescribeMacro{\ForgetName} % This macro is a ``dirty trick'' of sorts that takes the same optional and mandatory parameters used by \texttt{\bsc Name}. It handles its arguments in the same manner as \texttt{\bsc Name}, except that it ignores the final parameter if \emph{FNN} are present. The syntax is: % \begin{quote} % \texttt{\bsc ForgetName}\oarg{FNN}\marg{SNN}\oarg{alternate names} % \end{quote} % % This macro causes \texttt{\bsc Name} and friends to “forget” prior uses of a name with respect to typesetting. The next use will print as if it were a ``first use.'' Index entries and pseudonyms (see above) are \emph{never} forgotten. % % \StopEventually{\PrintChanges\clearpage\PrintIndex} % % \section{Implementation} % % \iffalse %<*package> % \fi % \subsection{Class Options and Required Packages} % \begin{macrocode} \newif\if@nameauth@DoFormat \newif\if@nameauth@Punct % \end{macrocode} % These boolean values control whether or not formatting of first entries occurs and whether or not a name ends with a period.\\ % % \begin{macrocode} \DeclareOption{mainmatter}{\@nameauth@DoFormattrue} \DeclareOption{frontmatter}{\@nameauth@DoFormatfalse} \DeclareOption{smallcaps}{\newcommand{\NamesFormat}{\scshape}} \DeclareOption{italic}{\renewcommand{\NamesFormat}{\itshape}} \DeclareOption{boldface}{\renewcommand{\NamesFormat}{\bfseries}} \DeclareOption{noformat}{\renewcommand{\NamesFormat}{}} \ExecuteOptions{smallcaps,mainmatter} \ProcessOptions\relax \RequirePackage{etoolbox} \RequirePackage{xparse} % \end{macrocode} % % \subsection{Internal Macros} % \begin{macro}{\@nameauth@CleanName} % \changes{v0.8}{2012/01/29}{Renamed macro to help compatibility} % \begin{macrocode} \newcommand*{\@nameauth@CleanName}[1]{\expandafter\zap@space\detokenize{#1} \@empty} % \end{macrocode} % \end{macro} % Thanks to \Name*[Heiko]{Oberdiek}, this macro produces a ``sanitized'' string based on the forename/surname parameters of \texttt{\bsc Name} and friends. With this we can construct a control sequence name (\texttt{\bsc csname}). Testing for the presence of that control sequence determines the existence of pseudonyms and the first occurrence of a name. % % \begin{macro}{\@nameauth@Zapsuffix} % \begin{macrocode} \newcommand{\@nameauth@Zapsuffix}[1]{% \def\@@Zapsuffix##1,##2*{##1}% {\@@Zapsuffix#1,*}% } % \end{macrocode} % \end{macro} % This macro does what it says. Anything starting with a comma and ending with the end of the name is stripped off. That includes ``Sr.,'' ``Jr.,'' ``III,'' and so on. % % \begin{macro}{\@nameauth@CheckDot} % \changes{v0.8}{2012/01/29}{Renamed macro to help compatibility} % \begin{macrocode} \def\@nameauth@CheckDot{\futurelet\@token\@nameauth@EvalDot} % \end{macrocode} % \end{macro} % This macro assigns the lookahead token \texttt{\bsc @token} to be evaluated by \texttt{\bsc @nameauth@EvalDot} while keeping \texttt{\bsc @token} non-destructively on the list of input tokens. I use this method instead of \texttt{\bsc @nextchar} because I do not want to gobble spaces. % % \begin{macro}{\@nameauth@EvalDot} % \changes{v0.8}{2012/01/29}{Renamed macro to help compatibility} % \begin{macrocode} \def\@nameauth@EvalDot{\let\@period=.\ifx\@token\@period\expandafter\@gobble \fi} % \end{macrocode} % \end{macro} % \texttt{\bsc @nameauth@EvalDot} checks of \texttt{\bsc @token} is a period. If so it gobbles it by using \texttt{\bsc expandafter} to get past the grouping. Another \texttt{\bsc expandafter} occurs immediately before the invocation of \texttt{\bsc @nameauth@CheckDot} in \texttt{\bsc Name} and \texttt{\bsc AKA}. % % \begin{macro}{\@nameauth@TestDot} % \changes{v0.8}{2012/01/29}{Renamed macro to help compatibility} % \begin{macrocode} \newcommand*{\@nameauth@TestDot}[1]{% \def\TestDot##1.\TestEnd##2\TestStop{\TestPunct{##2}}% \def\TestPunct##1{\ifx\TestPunct##1\TestPunct\else\@nameauth@Puncttrue\fi}% \@nameauth@Punctfalse% \TestDot#1\TestEnd.\TestEnd\TestStop% } % \end{macrocode} % \end{macro} % While \texttt{\bsc @nameauth@CheckDot} looks \emph{ahead} for a period, \texttt{\bsc @nameauth@TestDot}---based on a snippet by \Name*[Uwe]{Lueck}---checks for a terminal period in the name passed to it, ignoring medial periods. This string test is compatible with the \textsf{microtype} package. % % \begin{macro}{\@nameauth@FmtName} % \changes{v0.8}{2012/01/29}{Renamed macro to help compatibility} % \begin{macrocode} \DeclareDocumentCommand\@nameauth@FmtName{s m}% {% \@nameauth@TestDot{#2}% \IfBooleanTF{#1}{#2}{\bgroup\NamesFormat{#2}\egroup}% } % \end{macrocode} % \end{macro} % \texttt{\bsc @nameauth@FmtName} is where the first occurrences of a name are formatted. Notice how \texttt{\bsc NamesFormat} sits between a \texttt{\bsc bgroup} and an \texttt{\bsc egroup} to localize the font change. It is adjacent to the brackets that enclose the second parameter, allowing one to hook into the name formatting procedure. % % \subsection{User Interface Macros} % \begin{macro}{\Name} % \changes{v0.75}{2012/01/19}{Added ``sobriquet'' feature} % \changes{v0.8}{2012/01/29}{Merged all major functionality here} % \begin{macrocode} \DeclareDocumentCommand\Name{s o m o}% {% \@nameauth@Punctfalse% \IfValueTF{#2}% {\IfValueTF{#4}{\def\@ForeNames{#4}}{\def\@ForeNames{#2}}% \ifcsname\@nameauth@CleanName{#2#3!PN!}\endcsname% \@nameauth@FmtName*{#2 #3}% \PackageWarning{nameauth}% {You cannot create a page reference from the pen name: #2 #3.}% \else% \if@nameauth@DoFormat% \ifcsname\@nameauth@CleanName{#2#3!MN!}\endcsname% \IfBooleanTF{#1}% {\@nameauth@FmtName*{\@ForeNames{\space}#3}\index{#3,{\space}#2}}% {\@nameauth@FmtName*{\@nameauth@Zapsuffix{#3}}\index{#3,{\space}#2}}% \else% \csgdef{\@nameauth@CleanName{#2#3!MN!}}{}% \@nameauth@FmtName{\@ForeNames{\space}#3}\index{#3,{\space}#2}% \fi% \else% \ifcsname\@nameauth@CleanName{#2#3!NF!}\endcsname% \IfBooleanTF{#1}% {\@nameauth@FmtName*{\@ForeNames{\space}#3}\index{#3,{\space}#2}}% {\@nameauth@FmtName*{\@nameauth@Zapsuffix{#3}}\index{#3,{\space}#2}}% \else% \csgdef{\@nameauth@CleanName{#2#3!NF!}}{}% \@nameauth@FmtName*{\@ForeNames{\space}#3}\index{#3,{\space}#2}% \fi% \fi% \fi}% {\IfValueTF{#4} {\ifcsname\@nameauth@CleanName{#3#4!PN!}\endcsname% \@nameauth@FmtName*{#3 #4}% \PackageWarning{nameauth}% {You cannot create a page reference from the pen name: #3 #4.}% \else% \if@nameauth@DoFormat% \ifcsname\@nameauth@CleanName{#3#4!MN!}\endcsname% \IfBooleanTF{#1}% {\@nameauth@FmtName*{#3 #4}\index{#3 #4}}% {\@nameauth@FmtName*{\@nameauth@Zapsuffix{#3}}\index{#3 #4}}% \else% \csgdef{\@nameauth@CleanName{#3#4!MN!}}{}% \@nameauth@FmtName{#3 #4}\index{#3 #4}% \fi% \else% \ifcsname\@nameauth@CleanName{#3#4!NF!}\endcsname% \IfBooleanTF{#1}% {\@nameauth@FmtName*{#3 #4}\index{#3 #4}}% {\@nameauth@FmtName*{\@nameauth@Zapsuffix{#3}}\index{#3 #4}}% \else% \csgdef{\@nameauth@CleanName{#3#4!NF!}}{}% \@nameauth@FmtName*{#3 #4}\index{#3 #4}% \fi% \fi% \fi}% {\ifcsname\@nameauth@CleanName{#3!PN!}\endcsname% \@nameauth@FmtName*{#3}% \PackageWarning{nameauth}% {You cannot create a page reference from the pen name: #3.}% \else% \if@nameauth@DoFormat% \ifcsname\@nameauth@CleanName{#3!MN!}\endcsname% \IfBooleanTF{#1}% {\@nameauth@FmtName*{#3}\index{#3}}% {\@nameauth@FmtName*{\@nameauth@Zapsuffix{#3}}\index{#3}}% \else% \csgdef{\@nameauth@CleanName{#3!MN!}}{}% \@nameauth@FmtName{#3}\index{#3}% \fi% \else% \ifcsname\@nameauth@CleanName{#3!NF!}\endcsname% \IfBooleanTF{#1}% {\@nameauth@FmtName*{#3}\index{#3}}% {\@nameauth@FmtName*{\@nameauth@Zapsuffix{#3}}\index{#3}}% \else% \csgdef{\@nameauth@CleanName{#3!NF!}}{}% \@nameauth@FmtName*{#3}\index{#3}% \fi% \fi% \fi}% }% \if@nameauth@Punct\expandafter\@nameauth@CheckDot\fi% } % \end{macrocode} % \end{macro} % % \texttt{\bsc Name} first checks for the forenames argument. Two outcomes are possible. % \begin{enumerate} % \item Forenames are present. In this case, the alternate names argument creates two choices. % \begin{enumerate} % \item The alternate names replace the forenames in the printed form, not the indexed form. % \item The absence of alternate names will result in the forenames being used for both forms. % \end{enumerate} % \item Forenames are absent. In that case, the alternate names argument creates two different choices. % \begin{enumerate} % \item The alternate names are appended to the surnames in both printed and indexed forms. % \item Only the surnames are used. % \end{enumerate} % \end{enumerate} % % A check occurs for a control sequence based on the names given and the suffix \texttt{!PN!} (for pen name). This is how \texttt{\bsc AKA} protects cross-references. If the control sequence exists, then \texttt{\bsc Name} only prints the name given and emits a warning. One cannot use \texttt{\bsc ForgetName} to expunge a pen name. This is a deliberate decision to avoid corruption of the index cross-references. % % The next branch involves the boolean value \texttt{@nameauth@DoFormat}, which is controlled by \texttt{\bsc NamesActive} and \texttt{\bsc NamesInactive}. If formatting is active, choose the unstarred form of \texttt{\bsc @nameauth@FmtName}, which applies the formatting hook. Otherwise use the starred form that applies no formatting. % % The state of \texttt{@nameauth@DoFormat} also controls the suffix used in the control sequences: \texttt{!MN!} for main name or \texttt{!NF!} for no format. This is the heart of the \texttt{frontmatter} / \texttt{mainmatter} mechanism. % % Where longer and shorter versions of names are printed, there the star parameter controls those outcomes. % % The use of \texttt{\bsc expandafter} before \texttt{\bsc @nameauth@CheckDot} works with the other use of \texttt{\bsc expandafter} mentioned with \texttt{\bsc @nameauth@EvalDot} above to move past the closing brace and fetch the period as lookahead. That is only done when the check for a terminal period in the name succeeds. % % \Name*[Marc van]{Dongen} provided the basic structure for this macro. % % \begin{macro}{\PName} % \begin{macrocode} \DeclareDocumentCommand\PName{s o m o m}% {% \IfBooleanTF{#1}{\Name*[#2]{#3}}{\Name[#2]{#3}}% {\space}(\AKA[#2]{#3}[#4]{#5})% } % \end{macrocode} % \end{macro} % % \texttt{\bsc PName} is a convenience macro whose starred and unstarred forms call the respective versions of \texttt{\bsc Name}, then \texttt{\bsc AKA}. It prevents both the ``sobriquet'' feature and the alternate forenames feature. % % \begin{macro}{\AKA} % \begin{macrocode} \DeclareDocumentCommand\AKA{o m o m}% {% \@nameauth@Punctfalse% \IfValueTF{#3}% {\@nameauth@FmtName*{#3 #4}% \ifcsname\@nameauth@CleanName{#3#4!PN!}\endcsname\relax\else% \csgdef{\@nameauth@CleanName{#3#4!PN!}}{}% \IfValueTF{#1}% {\index{#4,{\space}#3|see{#2,{\space}#1}}}% {\index{#4,{\space}#3|see{#2}}}% \fi}% {\@nameauth@FmtName*{#4}% \ifcsname\@nameauth@CleanName{#4!PN!}\endcsname\relax\else% \csgdef{\@nameauth@CleanName{#4!PN!}}{}% \IfValueTF{#1}% {\index{#4|see{#2,{\space}#1}}}% {\index{#4|see{#2}}}% \fi}% \if@nameauth@Punct\expandafter\@nameauth@CheckDot\fi% } % \end{macrocode} % \end{macro} % % \texttt{\bsc AKA} prints a pseudonym and creates index cross-references. It also checks to see of cross-references already have been generated, and if so, it does not do it again. Like \texttt{\bsc Name} it checks for a terminal period, but only for the alternate name. % % \begin{macro}{\IndexName} % \changes{v0.75}{2012/01/19}{Optional parameter added; mandatory parameter deleted} % \begin{macrocode} \DeclareDocumentCommand\IndexName{o m o}% {% \IfValueTF{#1}% {\ifcsname\@nameauth@CleanName{#1#2!PN!}\endcsname% \else\index{#2,{\space}#1}\fi}% {\IfValueTF{#3} {\ifcsname\@nameauth@CleanName{#2#3!PN!}\endcsname% \else\index{#2 #3}\fi} {\ifcsname\@nameauth@CleanName{#2!PN!}\endcsname% \else\index{#2}\fi}% }% } % \end{macrocode} % \end{macro} % % \texttt{\bsc IndexName} creates an index entry that is not already a pseudonym. It prints nothing. % % \begin{macro}{\ForgetName} % \changes{v0.75}{2012/01/19}{New parameter added} % \begin{macrocode} \DeclareDocumentCommand\ForgetName{o m o}% {% \IfValueTF{#1}% {\csundef{\@nameauth@CleanName{#1#2!MN!}}% \csundef{\@nameauth@CleanName{#1#2!NF!}}}% {\IfValueTF{#3}% {\csundef{\@nameauth@CleanName{#2#3!MN!}}% \csundef{\@nameauth@CleanName{#2#3!NF!}}}% {\csundef{\@nameauth@CleanName{#2!MN!}}% \csundef{\@nameauth@CleanName{#2!NF!}}}% }% } % \end{macrocode} % \end{macro} % % \texttt{\bsc ForgetName} uses the \eTeX facilities to undefine control sequences created by \texttt{\bsc Name}. Using \texttt{\bsc @ifdefined} does not create a control sequence equivalent to \texttt{\bsc relax}, thus using less resources. % % \begin{macro}{\NamesInactive} % \begin{macrocode} \newcommand{\NamesInactive}{\@nameauth@DoFormatfalse} % \end{macrocode} % \end{macro} % % This macro deactivates formatting, even as its counterpart below activates it. % % \begin{macro}{\NamesActive} % \begin{macrocode} \newcommand{\NamesActive}{\@nameauth@DoFormattrue} % \end{macrocode} % \end{macro} % \clearpage \endinput % % \iffalse % % \fi % % \Finale % \clearpage