diff options
Diffstat (limited to 'Master/texmf-dist/source/latex/amsrefs/amsrdoc.tex')
-rw-r--r-- | Master/texmf-dist/source/latex/amsrefs/amsrdoc.tex | 144 |
1 files changed, 138 insertions, 6 deletions
diff --git a/Master/texmf-dist/source/latex/amsrefs/amsrdoc.tex b/Master/texmf-dist/source/latex/amsrefs/amsrdoc.tex index 9c29af18082..ea3357a1907 100644 --- a/Master/texmf-dist/source/latex/amsrefs/amsrdoc.tex +++ b/Master/texmf-dist/source/latex/amsrefs/amsrdoc.tex @@ -1,6 +1,6 @@ %% filename: amsrdoc.tex -%% version: 1.03 -%% date: 2008/10/27 +%% version: 1.04 +%% date: 2013/01/16 %% %% American Mathematical Society %% Technical Support @@ -13,7 +13,7 @@ %% fax: (401) 331-3842 %% email: tech-support@ams.org %% -%% Copyright 2004, 2006-2008, 2010 American Mathematical Society. +%% Copyright 2004, 2006-2008, 2010, 2013 American Mathematical Society. %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License, either version 1.3c @@ -35,6 +35,7 @@ \hyphenation{herme-neutics} \usepackage{amsrefs} +\usepackage{amsthm} \renewcommand*\descriptionlabel[1]{\hspace\labelsep \normalfont\bfseries #1:} @@ -43,6 +44,11 @@ \makeatletter +\newtheoremstyle{note}{3pt}{3pt}{}{}{\bfseries}{:}{.5em}{} + +\theoremstyle{note} +\newtheorem*{note}{Note} + \def\nitem[#1]{\item[#1\@gobble]} \DeclareRobustCommand{\fld}{\category@index{field}} @@ -71,7 +77,7 @@ \title{User's Guide to the \pkg{amsrefs} Package} \author{David M. Jones\\American Mathematical Society} -\date{October 27, 2008} +\date{January 16, 2013} \begin{document} @@ -439,6 +445,56 @@ write \begin{biblist}[\setcounter{bib}{-1}] \end{verbatim} +The \env{biblist} environment also takes a second optional argument +that can be used to modify the current bibliography. This argument +consists of an asterisk followed by a set of key-value pairs +surrounded by braces: +\begin{verbatim} + \begin{biblist}*{key={val},...} +\end{verbatim} +Two keys are supported at present: +\begin{description} + +\item[labels] + +Set this to ``numeric,'' ``alphabetic,'' or ``shortalphabetic'' to +override the default label style for the current bibliography. + +\item[prefix] + +The value of this key will be prepended to each of the labels in the +current bibliography. + +\end{description} +\begin{note} +Neither of these can be used with the \opt{author-year} option. +\end{note} +For example, if you are using numeric labels, then +\begin{verbatim} + \begin{biblist}*{prefix={A}} +\end{verbatim} +will cause the items to be labeled ``A1,'' ``A2,'' etc. Similarly, +\begin{verbatim} + \begin{biblist}*{labels={alphabetic}} +\end{verbatim} +will cause the current list to be labeled alphabetically instead of +numerically. + +\begin{note} +Depending on your specific use of \cn{cite}s, use of non-numeric +prefixes or of mixed numeric and non-numeric label styles can +interfere with citation sorting and compression +(section~\ref{sec:sorting}). You may need to pass the +\opt{non-sorted-cites} and \opt{non-compressed-cites} options to +amsrefs to get the correct behavior. +\end{note} + +If you want to use both types of optional arguments, the key-value +pairs come second: +\begin{verbatim} + \begin{biblist}[\normalsize]*{...} +\end{verbatim} + Each \env{biblist} environment resets the \cnt{bib} counter so that its items are numbered starting from~1. If you want the numbering to start where the last \env{biblist} left off, use the \env{biblist*} @@ -688,6 +744,17 @@ Like \emph{report} but produced by the author for an educational institution to satisfy the requirements for a degree. Not (normally) produced by a commercial publisher for sale. +\item[webpage] + +An online resource. It is limited to the following fields: +\fld{accessdate}, +\fld{author}, +\fld{date}, +\fld{note}, +\fld{subtitle}, +\fld{title}, +\fld{url}. + \end{description} \subsection{Field names for the \cn{bib} command} @@ -737,6 +804,12 @@ The meaning of many of these should be self-evident, so comments will be kept to a minimum. \begin{description} +\item[accessdate] + +Used to specify the date on which a \btype{webpage} was viewed, as +opposed to the date on which the resource was last modified, which +would be put in the \fld{date} field. + \item[address] Usually the address of the publisher or other issuing organization, @@ -1194,7 +1267,59 @@ digits of the year are used in the label. The \opt{y2k} instructs \end{description} -\subsection{Citation sorting and compression} +\begin{note} +Since \pkg{amsrefs} leaves the order of the bibliography items up to +the user, a common mistake when using non-numeric labels (especially +\opt{shortalphabetic} labels) is to put the items in an order that is +incompatible with the natural order of the labels. This can result in +a sequence such as this: +\begin{biblist}*{labels={shortalphabetic}} + +\bib{A}{article}{ + title={\dots}, + author={Doe, John}, +} + +\bib{C}{article}{ + title={\dots}, + author={Doe, John}, + author={Smith, Jane}, +} + +\bib{B}{article}{ + title={\dots}, + author={Dunn, John}, +} +\end{biblist} +where \pkg{amsrefs} does not automatically replace the first and third +labels by ``D1'' and ``D2'' as it would if they were consecutive. +This is because the real error lies in attempting to force the labels +into an unordered sequence. Readers are entitled to find reference +``D2'' between references ``D1'' and~``DS'' in the bibliography just +as they are entitled to find reference~[2] between references [1] +and~[3]. + +If \pkg{amsrefs} encounters a situation like this, it will issue a +warning. There are three ways to resolve the problem: +\begin{enumerate} + +\item +Rearrange the items in an order that is compatible with the label +style you have chosen. + +\item +Choose a different label style that is compatible with the order you +have chosen for the items. + +\item +Use the \fld{label} field to override the automatically-generated +label and leave your readers to their own devices. + +\end{enumerate} + +\end{note} + +\subsection{Citation sorting and compression}\label{sec:sorting} When numeric citation labels are being used and \pkg{amsrefs} encounters a list of multiple citations (for example, @@ -1483,7 +1608,9 @@ would thus be coded as follows: \end{verbatim} For symmetry, a \cn{citeauthor} command, which produces the list of authors without the year, is also provided, and plural forms -\cn{ycites} and \cn{ocites} are provided to mirror \cn{cites}. +\cn{ycites} and \cn{ocites} are provided to mirror \cn{cites}. There +is also a \cn{citeyear} command that is identical to \cn{ycite} except +that it suppresses the surrounding parentheses. Finally, in some author-year styles, if there are three or more authors, \cn{cite} and \cn{ocite} will produce abbreviated author @@ -1732,4 +1859,9 @@ the comma in front of the line break, as desired: Text\dots \end{quote} +\subsection{Defining custom entry types or styles} + +See the documentation of \cn{BibSpec} and related commands in ``The +\pkg{amsrefs} package'' (\fn{amsrefs.pdf}). + \end{document} |