diff options
author | Karl Berry <karl@freefriends.org> | 2012-01-01 23:05:20 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2012-01-01 23:05:20 +0000 |
commit | 053930a0ae346b5d7e31ad8e9e576cac0ea1bb70 (patch) | |
tree | 16679d9bda02d9b5d94337e3feced52bd79ff4c7 /Master/texmf-dist/source/latex/nameauth | |
parent | 1ebe946b5d71b79e2110bbdb86c76987bfca0b90 (diff) |
nameauth 0.7 (31dec11)
git-svn-id: svn://tug.org/texlive/trunk@24993 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/source/latex/nameauth')
-rw-r--r-- | Master/texmf-dist/source/latex/nameauth/nameauth.dtx | 689 | ||||
-rw-r--r-- | Master/texmf-dist/source/latex/nameauth/nameauth.ins | 55 |
2 files changed, 744 insertions, 0 deletions
diff --git a/Master/texmf-dist/source/latex/nameauth/nameauth.dtx b/Master/texmf-dist/source/latex/nameauth/nameauth.dtx new file mode 100644 index 00000000000..404cee3b1ad --- /dev/null +++ b/Master/texmf-dist/source/latex/nameauth/nameauth.dtx @@ -0,0 +1,689 @@ +% \iffalse meta-comment +% +% Copyright (C) 2011 by Charles P. Schaum <charles dot schaum at att dot net> +% --------------------------------------------------------------------------- +% 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} +%</driver> +%<package>\NeedsTeXFormat{LaTeX2e}[2005/12/01] +%<package>\ProvidesPackage{nameauth} +%<*package> + [2011/12/26 v0.7 name authority macros to aid consistent display and indexing of names] +%</package> +% +%<*driver> +\documentclass{ltxdoc} +\usepackage[utf8]{inputenc} +\usepackage[TS1,T1]{fontenc} +\usepackage{hologo} +\usepackage{lmodern} +\usepackage{makeidx} +\usepackage{newunicodechar} +\usepackage{nameauth}[2011/12/26] +\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} +%</driver> +% \fi +% +% \CheckSum{336} +% +% \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} +% +% \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} +% +% \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} +% 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{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 forenames}\\ +% \texttt{\bsc Name*}\oarg{forename(s)}\marg{surname(s)}\oarg{alternate forenames} +% \end{quote} +% +% From now one we will abbreviate \emph{forename(s)} with \emph{FNN} and \emph{surname(s)} with \emph{SNN} in the syntax descriptions. The unstarred form prints the ``full name'' at the first occurrence, then only the surname(s) thereafter. A ``full name'' in the body texts consists of either the regular or the alternate forename(s), followed by the surname(s). Only the ``regular'' forenames are used in the index. The starred form always prints the full name. Forenames are optional. Surnames are mandatory. Both macros usually apply a different ``font attribute'' to the name when it first appears in the running text. For example: +% +% \begin{quote} +% \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} +% +% \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} +% +% Observe that \texttt{\bsc Name} and \texttt{\bsc Name*} appear to have the same effect with \Name{Boethius}. That is not exactly true. When \texttt{\bsc Name} is used with a name containing a comma and a suffix, it removes the suffix after the first use, while \texttt{\bsc Name*} does not do this. That results in the following behavior: +% +% \begin{quote} +% \texttt{\bsc Name[Martin Luther]\{King, Jr.\}}\\ +% Print \Name[Martin Luther]{King, Jr.} when it appears and \Name[Martin Luther]{King, Jr.} thereafter. Use the starred form to get \Name*[Martin Luther]{King, Jr.}. +% \end{quote} +% +% 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.}\\ +% \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} +% +% \subsection{Advanced Features} +% +% \subsubsection{Alternate forenames in the Text} +% +% In some cultures people receive three or more forenames. It is often inadvisable to use so many names in the index. Yet you might wish to introduce a person with all of his or her names. If nothing else, this is a grandiose flourish that can add a bit of \textit{gravitas} to a historical figure's role in the text. The ``alternate forenames'' optional argument comes to the rescue. The following examples show how one might use alternate forenames: +% +% \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} +% +% Observe that the alternate forenames override the regular forenames in the text. They do not get printed, however, in subsequent occurrences of \texttt{\bsc Name}. The surname argument is 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 allows one to print any text in the body---such as a nickname---yet it will create a standard index entry for the person so named. Its syntax is: +% \begin{quote} +% \texttt{\bsc IndexName}\oarg{FNN}\marg{SNN}\oarg{text} +% \end{quote} +% +% \texttt{\bsc IndexName} will not interfere with the \textit{nom de plume} mechanism described below. It allows considerable flexibility while retaining the helpful indexing features. For example, a historian might wish to refer to a person with a familiar name when the history text describes close familial relationships: +% +% \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 +% \bsc IndexName[C.F.W.]\{Walther\}\{Ferdinand\}. +% \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 \IndexName[C.F.W.]{Walther}{Ferdinand}. +% \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} +% +% \DescribeMacro{\PName} +% People may use pseudonyms or \emph{noms de plume}. Sometimes they become known by epithets or monikers. There are two macros to handle this. The first of these macros, \texttt{\bsc PName}, introduces the name of the person under which he or she will be indexed, followed by the pseudonym in parentheses. Like \texttt{\bsc Name} it has starred and unstarred forms, although the star only operates on the main name that is indexed, not the pseudonym. It is likely that one is known more by the pen name, so an abbreviation mechanism for lesser-known information seems counterintuitive for clarity. The syntax is: +% +% \begin{quote} +% \texttt{\bsc PName}\oarg{FNN}\marg{SNN}\oarg{alternate FNN}\marg{alternate 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} +% +% Observe carefully that \texttt{\bsc PName} does not allow the ``optional forenames'' parameter used in \texttt{\bsc Name}. This is done intentionally to reduce the possible confusion of a double alias. +% +% \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 from the normal indexing feature for more flexibility. Its syntax is similar to \texttt{\bsc PName}: +% +% \begin{quote} +% \texttt{\bsc AKA}\oarg{FNN}\marg{SNN}\oarg{alternate FNN}\marg{alternate SNN} +% \end{quote} +% +% \texttt{\bsc AKA} only prints the pseudonym, not the indexed name. The macro also will prevent the double-printing of a period after an abbreviation. Here are a few examples of how to use it: +% +% \begin{quote} +% \texttt{\bsc AKA[George]\{Eliot\}[Mary Anne]\{Evans\}}\dots\\ +% \texttt{\bsc Name[George]\{Eliot\}}\\[1ex] +% Today we consider \AKA[George]{Eliot}[Mary Anne]{Evans} and her literary contributions as \Name[George]{Eliot}. +% +% \index{Doctor Angelicus=\textit{Doctor Angelicus}|see {Thomas Aquinas}}% +% \texttt{\bsc PName\{Thomas Aquinas\}\{Thomas of Aquino\}}\dots\\[1ex] +% Perhaps the greatest medieval theologian was \PName{Thomas Aquinas}{Thomas of Aquino}, known as \textit{Doctor Angelicus}. His name ``Aquinas'' is not a surname, so many modern scholars refer to him as Thomas. +% \end{quote} +% +% To index \textit{Doctor Angelicus} as a pseudonym one must use the following method in order to format the index entry correctly. Note that the ``actual'' character @ may be redefined.\\ +% +% {\small \verb!\index{Doctor Angelicus@\textit{Doctor Angelicus}|see {Thomas Aquinas}}!}\\ +% +% \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. As a general rule, the more one has to account for exceptions, the shakier the rules get. My own use of these macros involves people with English, French, German, Italian, Latin, and Central European names. If all you ever index are John Smith and Jerry Jones, you may never need any macros beyond \texttt{\bsc Name}. +% +% Pseudonyms cannot be indexed with page numbers. They only work as ``see'' references that point to name entries in the index that do have page references. \texttt{\bsc Name} will print a pseudonym if it is used and emit a warning. 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. +% +% \texttt{\bsc AKA} will only create one \textit{see} reference per pseudonym. This has the side effect of excluding the special case where a pseudonym applies to multiple people: \PName*[Willebrord]{Snel van Royen}{Snellius} and his son \PName*[Rudolph]{Snel van Royen}{Snellius} have the same Latin moniker. +% \index{Snellius|see {Snel van Royen, Rudolph}}% +% +% You will see in the index that Snellius points to two entries. I had to add a manual index entry to work around it: +% \begin{quote} +% \verb!\index{Snellius|see {Snel van Royen, Rudolph}}! +% \end{quote} +% Otherwise the moniker Snellius would point in the index only to the first occurrence, which is \PName*[Willebrord]{Snel van Royen}{Snellius}. This is one case when \emph{not} to use \texttt{\bsc IndexName}---it would involve more typing and still would not create the desired index reference. +% +% Be careful with name collisions, especially with more than one person having the same last name: +% \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 for those cases. +% +% \subsection{Name Formatting} +% +% \subsubsection{Font Attributes} +% \label{sec:FontAttributes} +% +% \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 textsc\{\#1\}\%}\\ +% \texttt{\bsc ifinner\bsc else\bsc marginpar\{\#1\}\bsc fi\}} +% \end{quote} +% +% \subsection{Formatting Certain Sections} +% \label{sec:SectionFormat} +% +% \DescribeMacro{\NamesActive} +% \DescribeMacro{\NamesInctive} +% Using the \texttt{frontmatter} option will deactivate formatting until \texttt{\bsc NamesActive} activates it. Another macro, \texttt{\bsc NamesInactive}, will deactivate formatting. These two macros toggle formatting on and off. They 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} +% +% See how the mechanism works in a complementary, yet independent manner. The index entries all will have the same format. +% +% \subsection{Tweaks:\texttt{\bsc ForgetName}} +% \label{sec:Tweaks} +% +% \DescribeMacro{\ForgetName} +% The macro \texttt{\bsc ForgetName} is a ``dirty trick'' of sorts that takes the optional and mandatory parameters used by \texttt{\bsc Name} to create an index entry. Thus it does not take the final optional parameter. It causes the macros 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}{\@CleanName} +% \begin{macrocode} +\newcommand*{\@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}{\@Zapsuffix} +% \begin{macrocode} +\newcommand{\@Zapsuffix}[1]{% + \def\@@Zapsuff##1,##2*{##1}% + {\@@Zapsuff#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}{\@CheckDot} +% \begin{macrocode} +\def\@CheckDot{\futurelet\@token\@EvalDot} +% \end{macrocode} +% \end{macro} +% This macro assigns the lookahead token \texttt{\bsc @token} to be evaluated by \texttt{\bsc @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}{\@EvalDot} +% \begin{macrocode} +\def\@EvalDot{\let\@period=.\ifx\@token\@period\expandafter\@gobble \fi} +% \end{macrocode} +% \end{macro} +% \texttt{\bsc @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 @CheckDot} in \texttt{\bsc Name} and \texttt{\bsc AKA}. +% +% \begin{macro}{\@TestDot} +% \begin{macrocode} +\newcommand*{\@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 @CheckDot} looks \emph{ahead} for a period, \texttt{\bsc @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}{\@FmtName} +% \begin{macrocode} +\DeclareDocumentCommand\@FmtName{s m}% +{% + \@TestDot{#2}% + \IfBooleanTF{#1}{#2}{\bgroup\NamesFormat{#2}\egroup}% +} +% \end{macrocode} +% \end{macro} +% \texttt{\bsc @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. +% +% \begin{macro}{\@FName} +% \begin{macrocode} +\DeclareDocumentCommand\@FName{o m o}% +{% + \IfValueTF{#1}% + {\IfValueTF{#3}{\def\@ForeNames{#3}}{\def\@ForeNames{#1}}% + \ifcsname\@CleanName{#1#2!PN!}\endcsname% + \@FmtName*{#1 #2}% + \PackageWarning{nameauth}% + {You cannot create a page reference from the pen name: #1 #2.}% + \else% + \if@nameauth@DoFormat% + \ifcsname\@CleanName{#1#2!MN!}\endcsname% + \@FmtName*{\@ForeNames{\space}#2}\index{#2,{\space}#1}% + \else% + \csgdef{\@CleanName{#1#2!MN!}}{}% + \@FmtName{\@ForeNames{\space}#2}\index{#2,{\space}#1}% + \fi% + \else% + \ifcsname\@CleanName{#1#2!NF!}\endcsname% + \@FmtName*{\@ForeNames{\space}#2}\index{#2,{\space}#1}% + \else% + \csgdef{\@CleanName{#1#2!NF!}}{}% + \@FmtName*{\@ForeNames{\space}#2}\index{#2,{\space}#1}% + \fi% + \fi% + \fi}% + {\ifcsname\@CleanName{#2!PN!}\endcsname% + \@FmtName*{#1 #2}% + \PackageWarning{nameauth}% + {You cannot create a page reference from the pen name: #1 #2.}% + \else% + \if@nameauth@DoFormat% + \ifcsname\@CleanName{#2!MN!}\endcsname% + \@FmtName*{#2}\index{#2}% + \else% + \csgdef{\@CleanName{#2!MN!}}{}% + \@FmtName{#2}\index{#2}% + \fi% + \else% + \ifcsname\@CleanName{#2!NF!}\endcsname% + \@FmtName*{#2}\index{#2}% + \else% + \csgdef{\@CleanName{#2!NF!}}{}% + \@FmtName*{#2}\index{#2}% + \fi% + \fi% + \fi}% +} +% \end{macrocode} +% \end{macro} +% \texttt{\bsc @FName} (full name) first checks for the optional forenames argument. Two outcomes are possible. Either the forenames and surnames will be printed, or the surnames only will be printed. One cannot have ``alternate'' forenames with a surname-only entry. In that case, one must use either \texttt{\bsc AKA} or \texttt{\bsc IndexName}. +% +% Next \texttt{\bsc @FName} checks if the ``alternate'' forenames exist. If so, they are used as forenames for the body text and the ``regular'' forenames are used in the index. Otherwise the ``regular'' forenames are used for both. +% +% Third, a check occurs for a control sequence name based on the names given and the suffix \texttt{!PN!} (for pen name) wrapped in a pair of bangs. This format is used by \texttt{\bsc AKA} to create the index \emph{see} cross-references. If such a control sequence exists, then \texttt{\bsc @FName} prints the name given, emits a warning, and creates no index entry. Nor will ``alternate forenames'' be examined in this case. 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 fourth 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 @FmtName}, which applies the formatting hook. Otherwise use the starred dorm that applies no formatting. +% +% The state of \texttt{@nameauth@DoFormat} also controls the suffix used: \texttt{!MN!} for main name or \texttt{!NF!} for no format. Suffixes are enclosed in pairs of bangs. +% \clearpage +% +% \begin{macro}{\@LName} +% \begin{macrocode} +\DeclareDocumentCommand\@LName{o m o}% +{% + \IfValueTF{#1}% + {\IfValueTF{#3}{\def\@ForeNames{#3}}{\def\@ForeNames{#1}}% + \ifcsname\@CleanName{#1#2!PN!}\endcsname% + \@FmtName*{#1 #2}% + \PackageWarning{nameauth}% + {You cannot create a page reference from the pen name: #1 #2.}% + \else% + \if@nameauth@DoFormat% + \ifcsname\@CleanName{#1#2!MN!}\endcsname% + \@FmtName*{\@Zapsuffix{#2}}\index{#2,{\space}#1}% + \else% + \csgdef{\@CleanName{#1#2!MN!}}{}% + \@FmtName{\@ForeNames{\space}#2}\index{#2,{\space}#1}% + \fi% + \else% + \ifcsname\@CleanName{#1#2!NF!}\endcsname% + \@FmtName*{\@Zapsuffix{#2}}\index{#2,{\space}#1}% + \else% + \csgdef{\@CleanName{#1#2!NF!}}{}% + \@FmtName*{\@ForeNames{\space}#2}\index{#2,{\space}#1}% + \fi% + \fi% + \fi}% + {\ifcsname\@CleanName{#2!PN!}\endcsname% + \@FmtName*{#1 #2}% + \PackageWarning{nameauth}% + {You cannot create a page reference from the pen name: #1 #2.} + \else% + \if@nameauth@DoFormat% + \ifcsname\@CleanName{#2!MN!}\endcsname% + \@FmtName*{\@Zapsuffix{#2}}\index{#2}% + \else% + \csgdef{\@CleanName{#2!MN!}}{}% + \@FmtName{#2}\index{#2}% + \fi% + \else% + \ifcsname\@CleanName{#2!NF!}\endcsname% + \@FmtName*{\@Zapsuffix{#2}}\index{#2}% + \else% + \csgdef{\@CleanName{#2!NF!}}{}% + \@FmtName*{#2}\index{#2}% + \fi% + \fi% + \fi}% +} +% \end{macrocode} +% \end{macro} +% \texttt{\bsc @LName} (last name only) differs little from \texttt{\bsc @FName} apart from its use of \texttt{\bsc @ZapSuffix} and the last name only \emph{except} in the case of the first occurrence of a name. One could make a good case that \texttt{\bsc @FName} and \texttt{\bsc @LName} should be combined. When I tried that, the result introduced bugs that proved difficult to track down. This version simply worked, so I stuck with it. +% +% \Name*[Marc van]{Dongen} provided the basic structure for these two macros. +% +% \subsection{User Interface Macros} +% \begin{macro}{\Name} +% \begin{macrocode} +\DeclareDocumentCommand\Name{s o m o}% +{% + \@nameauth@Punctfalse% + \IfBooleanTF{#1}{\@FName[#2]{#3}[#4]}{\@LName[#2]{#3}[#4]}% + \if@nameauth@Punct\expandafter\@CheckDot\fi% +} +% \end{macrocode} +% \end{macro} +% \texttt{\bsc Name} and \texttt{\bsc Name*} call \texttt{\bsc @LName} and \texttt{\bsc @FName}, respectively. The use of \texttt{\bsc expandafter} before \texttt{\bsc @CheckDot} works with the other use of \texttt{\bsc expandafter} mentioned with \texttt{\bsc @EvalDot} above to move past the closing brace and fetch the period as lookahead. Yet that is only done when the check for a terminal period in the name succeeds. +% +% \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}. +% +% \begin{macro}{\AKA} +% \begin{macrocode} +\DeclareDocumentCommand\AKA{o m o m}% +{% + \@nameauth@Punctfalse% + \IfValueTF{#3}% + {\@FmtName*{#3 #4}\ifcsname\@CleanName{#3#4!PN!}\endcsname\relax\else% + \csgdef{\@CleanName{#3#4!PN!}}{}% + \IfValueTF{#1}% + {\index{#4,{\space}#3|see{#2,{\space}#1}}}% + {\index{#4,{\space}#3|see{#2}}}% + \fi}% + {\@FmtName*{#4}\ifcsname\@CleanName{#4!PN!}\endcsname\relax\else% + \csgdef{\@CleanName{#4!PN!}}{}% + \IfValueTF{#1}% + {\index{#4|see{#2,{\space}#1}}}% + {\index{#4|see{#2}}}% + \fi}% + \if@nameauth@Punct\expandafter\@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 \emph{pseudonym}. +% +% \begin{macro}{\IndexName} +% \begin{macrocode} +\DeclareDocumentCommand\IndexName{o m m}% +{% + \IfValueTF{#1}% + {\ifcsname\@CleanName{#1#2!PN!}\endcsname\else\index{#2,{\space}#1}\fi}% + {\ifcsname\@CleanName{#2!PN!}\endcsname\else\index{#2}\fi}% + {#3}% +} +% \end{macrocode} +% \end{macro} +% +% \texttt{\bsc IndexName} creates an index entry that is not already a pseudonym. It also prints text, but not necessarily the name that is indexed. +% +% \begin{macro}{\ForgetName} +% \begin{macrocode} +\DeclareDocumentCommand\ForgetName{o m}% +{% + \IfValueTF{#1}% + {\csundef{\@CleanName{#1#2!MN!}}\csundef{\@CleanName{#1#2!NF!}}}% + {\csundef{\@CleanName{#2!MN!}}\csundef{\@CleanName{#2!NF!}}}% +} +% \end{macrocode} +% \end{macro} +% +% \texttt{\bsc ForgetName} uses the \eTeX facilities to undefine control sequences that \texttt{\bsc @FName} and \texttt{\bsc @LName} use to define them. 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} +% +% \begin{macrocode} +\endinput +% \end{macrocode} +% +% \iffalse +%</package> +% \fi +% +% \Finale +% \clearpage
\ No newline at end of file diff --git a/Master/texmf-dist/source/latex/nameauth/nameauth.ins b/Master/texmf-dist/source/latex/nameauth/nameauth.ins new file mode 100644 index 00000000000..56daaacf3c3 --- /dev/null +++ b/Master/texmf-dist/source/latex/nameauth/nameauth.ins @@ -0,0 +1,55 @@ +%% +%% Copyright (C) 2011 by Charles P. Schaum <charles dot schaum at att dot net> +%% +%% This file may be distributed and/or modified under the conditions of +%% the LaTeX Project Public License, either version 1.2 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.2 or later is part of all distributions of LaTeX version +%% 1999/12/01 or later. +%% + +\input docstrip.tex +\keepsilent + +\usedir{tex/latex/nameauth} + +\preamble + +This is a generated file. + +Copyright (C) 2011 by Charles P. Schaum <charles dot schaum at att dot net> + +This file may be distributed and/or modified under the conditions of +the LaTeX Project Public License, either version 1.2 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.2 or later is part of all distributions of LaTeX version +1999/12/01 or later. + +\endpreamble + +\generate{\file{nameauth.sty}{\from{nameauth.dtx}{package}}} + +\obeyspaces +\Msg{*************************************************************} +\Msg{* *} +\Msg{* To finish the installation you have to move the following *} +\Msg{* file into a directory searched by TeX: *} +\Msg{* *} +\Msg{* nameauth.sty *} +\Msg{* *} +\Msg{* To produce the documentation run the file nameauth.dtx *} +\Msg{* through LaTeX. *} +\Msg{* *} +\Msg{* Happy TeXing! *} +\Msg{* *} +\Msg{*************************************************************} + +\endbatchfile |