diff options
author | Karl Berry <karl@freefriends.org> | 2007-01-10 22:52:26 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2007-01-10 22:52:26 +0000 |
commit | c1e1e595bebb609afcffda926804d80da3a79a9b (patch) | |
tree | d8141aa4c8eed16ed6193f76a8806540af8de89c /Master/texmf-dist/doc/latex/authorindex/authorindex.tex | |
parent | 35d6860f8d0a3dc99e81eb2646f8e55c45aab0f2 (diff) |
authorindex (doc) update (28nov06)
git-svn-id: svn://tug.org/texlive/trunk@3317 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/authorindex/authorindex.tex')
-rw-r--r-- | Master/texmf-dist/doc/latex/authorindex/authorindex.tex | 102 |
1 files changed, 82 insertions, 20 deletions
diff --git a/Master/texmf-dist/doc/latex/authorindex/authorindex.tex b/Master/texmf-dist/doc/latex/authorindex/authorindex.tex index 5044fbd25e9..7b4d2b229f2 100644 --- a/Master/texmf-dist/doc/latex/authorindex/authorindex.tex +++ b/Master/texmf-dist/doc/latex/authorindex/authorindex.tex @@ -22,8 +22,8 @@ \renewcommand\descriptionlabel[1]{\hspace\labelsep\normalfont\texttt{#1}} \title{The \authorindex\ Package} -\author{Andreas Wettstein\\\texttt{wettstae@ise.ch}} -\date{September 2002} +\author{Andreas Wettstein\\\texttt{wettstae@synopsys.com}} +\date{March 2005} \begin{document} @@ -168,13 +168,18 @@ By default, \authorindex\ generates exactly one entry for each author in the index. All pages with citations of the author's work go into this entry, no matter what the co-authors for the work that you cite are. -You can change this behavior with the \ltxinp{\aisee} command. You call -\ltxinp{\aisee} in the preamble of your document with a string argument. For -authors that are not the first in the author list of a work cited, -\authorindex\ generates an entry with this authors name, followed by the string -you have given to \ltxinp{\aisee}, followed by the name of the first author of -the cited work. Entries for authors that are first (or even only) authors of a -work are listed in the author index as usual. +Optionally, you can generate a reference to first authors in the author list of +all of the author's works. To this end, you call \ltxinp{\aialso} in the +preamble of your document. The command takes two string arguments. The first +argument is put before first author name, the second is used as a separator. + +Alternatively, you can change this behavior with the \ltxinp{\aisee} command. +You call \ltxinp{\aisee} in the preamble of your document with a string +argument. For authors that are not the first in the author list of a work +cited, \authorindex\ generates an entry with this authors name, followed by the +string you have given to \ltxinp{\aisee}, followed by the name of the first +author of the cited work. Entries for authors that are first (or even only) +authors of a work are listed in the author index as usual. For example, if you write in German, you'd put \begin{verbatim} @@ -306,6 +311,36 @@ This approach would also work for name prefixes like ``van'' or ``de la''. Note that the command \ltxinp{\indexspace}, which separates entries that start with a different letters, is placed according to the format used for sorting. + +\subsection{Dealing with name variations} + +In different publications, the name of the same author may appear in different +forms. Causes of variation are differing style conventions of various +journals, inconsistencies caused by the author, or plain errors. + +Bibliographies should give the author names as close to what appears on the +publication as the bibliography style allows. This in the interest of your +readers, as is simplifies finding what you cite. But it also implies that +inconsistencies carry over to the \ltxinp{author} fields of the \BibTeX\ data +base. + +In contrast, for author indices, names should be used consistently. Readers +consult the author index to find out about the works of a particular person, +and should find all of them in a single entry, rather than scattered over +multiple entries that correspond to different forms of the same name. + +To meet the conflicting needs for bibliographies and author indices, +\authorindex\ supports two new fields for \BibTeX\ data base entries: +\begin{description} +\item[authauthor] Gives the author name list, using the authoritative form of + the authors names. The format is like for the \ltxinp{author} field. +\item[autheditor] Likewise, for editors. +\end{description} +If a new field is present in a \BibTeX\ entry, \authorindex\ uses it instead of +the \ltxinp{author} or \ltxinp{editor} field. Of course, the latter fields are +still required for \BibTeX. + + \subsection{Fonts for the names} \ltxinp{\ainame} is a command with one argument. It determines how the @@ -524,7 +559,17 @@ these functions to write page information along with the citation key to the additional output for a few specific packages. Please note that these ``fixes'' may no longer work if newer versions of these packages appear. +If you use a non-compatible package that is not listed below, it is worthwile +to have a look into it's source code. I the simplest case, the package might +simply include one of the listed packages (using \ltxinp{\usepackage}), and +hence one of the examples below applies. Others might require more effort, but +the basic strategy for a fix will be always similar to the examples below. If +you encounter non-compatible packages, please notify me about them (ideally, +with instructions for a fix) so that I can include them in this manual. + + \subsubsection{\package{chicago}} +\label{sec:chicago} The standard version of the \package{chicago} package does not work with \authorindex. For this package, there is a patch that apparently makes it work @@ -570,22 +615,30 @@ without the \authorindex\ package. \subsubsection{\package{natbib}} Like \package{chicago}, the package \package{natbib} also conflicts with -\authorindex. Michael Friendly and Patrick W.\ Daly devised a fix for Nelson -Beebe's \package{authidx} package \cite{Beebe98}, which the former posted to -\texttt{comp.text.tex}. With a few changes, it seems to work for \authorindex\ -too. You insert in your \file{natbib.cfg} the following lines: +\authorindex. The following fix is based on a similar fix by Michael Friendly +and Patrick W.\ Daly for Nelson Beebe's \package{authidx} package +\cite{Beebe98}, plus additional support for \package{natbib}'s numerical mode +as proposed by Pieter Eendebak. You insert in your \file{natbib.cfg} the +following lines: \begin{verbatim} % natbib.cfg -% Asoundingly Egregious Hack to make natbib work with authorindex -% package: -% - This tacks on to \NAT@citex, which is just for author-year -% style citations. There's probably a better way \AtBeginDocument{% \@ifpackageloaded{authorindex}{% - \let\org@@citex\NAT@citex + \ifNAT@numbers + \let\org@@citex\NAT@citexnum + \else + \let\org@@citex\NAT@citex + \fi \def\@citex[#1][#2]#3{% - \typeout {indexing: [#1][#2]{#3}} - \org@@citex[#1][#2]{#3}\@aicitey{#3}}}{}} + \typeout{indexing: [#1][#2]{#3}}% + \org@@citex[#1][#2]{#3}% + \@aicitey{#3}}% + \renewcommand\NAT@wrout[5]{% + \if@filesw{% + \let\protect\noexpand\let~\relax + \immediate\write\@auxout{\string\aibibcite{#5}{#1}}% + \immediate\write\@auxout{\string\bibcite{#5}{{#1}{#2}{{#3}}{{#4}}}}}% + \fi}}{}} \endinput \end{verbatim} Please note that I tested this work-around superficially. It does not repair a @@ -593,6 +646,14 @@ conflict that occurs when the \authorindex\ package option \ltxinp{withbib} is used. +\subsubsection{Other packages} + +\begin{description} +\item[\package{monog3}] A class from Oxford University Press that used + \package{chicago}. See section \ref{sec:chicago}. +\end{description} + + \section{Problems and restrictions} Currently, I am aware of the following problems and restrictions: @@ -623,6 +684,7 @@ Currently, I am aware of the following problems and restrictions: I want to thank Mark A. Gordon for his substantial improvements to the language and presentation in this manual. + \begin{thebibliography}{3} \bibitem{Patashnik88a} |