summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/amsrefs/README
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/source/latex/amsrefs/README')
-rw-r--r--Master/texmf-dist/source/latex/amsrefs/README254
1 files changed, 179 insertions, 75 deletions
diff --git a/Master/texmf-dist/source/latex/amsrefs/README b/Master/texmf-dist/source/latex/amsrefs/README
index 2d89ab2e25e..0571c4c4dbe 100644
--- a/Master/texmf-dist/source/latex/amsrefs/README
+++ b/Master/texmf-dist/source/latex/amsrefs/README
@@ -1,12 +1,6 @@
-00readme.txt for amsrefs 2.10 [2012/05/08]
+README for amsrefs 2.12 [2013/01/15]
-See section III (REMARKS ON THIS RELEASE) for notes on the
-compatibility of this release with previous releases.
-
-See also install.txt. There is a history of changes at the end of this
-file.
-
-Copyright 2001-2004, 2007, 2008, 2010, 2011, 2012 American Mathematical Society.
+Copyright 2001-2004, 2007, 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
@@ -33,12 +27,21 @@ fax: (401) 331-3842
email: tech-support@ams.org
========================================================================
+ CONTENTS
+I. OVERVIEW
+II. FEATURES
+III. INSTALLATION AND GETTING STARTED
+IV. REMARKS ON THIS RELEASE
+V. CHANGE LOG
+
+========================================================================
+I. OVERVIEW
-The amsrefs package deals with bibliographies and citations in LaTeX
-documents. The basic citation command remains more or less the same as
-in standard LaTeX (\cite), but a number of additional variations address
-certain known pitfalls or gaps in the standard LaTeX set of citation
-features.
+The amsrefs package supports bibliographies and citations in LaTeX
+documents. The basic citation command remains more or less the same
+as in standard LaTeX (\cite), but a number of additional variations
+address certain known pitfalls or gaps in the standard LaTeX set of
+citation features.
The command for bibliography items is different -- \bib instead of
\bibitem -- for reasons that will be evident upon further reading in
@@ -54,25 +57,29 @@ Technical documentation (including documentation for package writers)
is in amsrefs.pdf.
========================================================================
-I. FEATURES
+II. FEATURES
-- Preservation of structure.
-The internal structural information of the bibliography entries is not
-lost when they are imported from the database file into the LaTeX
-document. This takes on its greatest significance when archiving
-documents in LaTeX form or transmitting them to another user (such as a
-publisher).
+With BibTeX alone, the structure of a bibitem in a .bib file is lost
+when items are imported into a .bbl file for direct processing by
+LaTeX. With amsrefs, there is no such conversion; LaTeX typesets the
+bibliography directly from the structured data. The greatest
+potential advantage of this is seen when archiving documents in LaTeX
+form or transmitting them to another user (such as a publisher).
-- Deferred formatting.
-This means that the style of the bibliography can be changed on demand
-without re-importing everything from the original database(s).
+Since bibliography entries are stored in structured format in the
+LaTeX file and the formatting is under the control of a LaTeX package
+instead of a separate program, the style of the bibliography can be
+changed on demand without re-importing everything from the original
+database(s).
-- More natural data format for titles.
-Proper nouns do not need to have braces added to prevent capitalization
-problems.
+Proper nouns do not need to have braces added to prevent
+capitalization problems.
-- Less ambiguous format for author names.
@@ -80,9 +87,9 @@ When author names are given in inverted order (last name first) it is
possible for LaTeX to unambiguously identify the last name without any
further markup, even in cases like Saunders Mac Lane (Mac Lane,
Saunders) versus Stephen H. Lane (Lane, Stephen H.), or Cam Van Tran
-(Tran, Cam Van) versus Bert Van Keulen (Van Keulen, Bert). In
-BibTeX some of these would need to have extra braces added to ensure
-that the surname is accurately distinguished.
+(Tran, Cam Van) versus Bert Van Keulen (Van Keulen, Bert). In BibTeX
+some of these would need to have extra braces added to ensure that the
+surname is accurately distinguished.
-- Author-year citations.
@@ -114,7 +121,7 @@ by LaTeX on the first pass and the citations resolved on the second
pass.
========================================================================
-II. GETTING STARTED
+III. INSTALLATION AND GETTING STARTED
1. Install the package, referring to install.txt as needed.
@@ -145,41 +152,142 @@ II. GETTING STARTED
cite-xb).
========================================================================
-III. REMARKS ON THIS RELEASE
+IV. REMARKS ON THIS RELEASE
+
+Version 2.12 of amsrefs implements two new features for the biblist
+environment, one new entry type, one new warning, and one bug fix.
+
+New features: The biblist environment now takes an optional argument
+ consisting of an asterisk followed by a brace-delimited set of
+ key-value pairs. The currently supported keys are "labels," which
+ changes the label style of the current biblist, and "prefix,"
+ which adds a prefix to each label. For example, if you are using
+ numeric labels, then
+
+ \begin{biblist}*{prefix={A}}
+
+ will result in items labeled A1, A2, etc., instead of 1, 2, etc.
+
+ Similarly,
+
+ \begin{biblist}*{labels={alphabetic}}
+
+ will switch to alphabetic labels for the current bibliography.
+ Other allowable values are "numeric" and "shortalphabetic."
+
+ The biblist environment already takes a []-delimited optional
+ argument, so if you want to use both, the *-argument comes last:
+
+ \begin{biblist}[\normalsize]*{...}
+
+ NOTE: Use of non-numeric prefixes or of mixed numeric and
+ non-numeric label styles can interfere with the citation sorting
+ and compression features, depending on exactly how you arrange
+ your \cite's. You may need to pass the non-sorted-cites and
+ non-compressed-cites options to amsrefs to get the correct
+ behavior.
-This release fixes a few bugs and restates the license under which the
-package is distributed.
+New entry type: There is now a webpage entry designed for references
+ to online resources. It takes the following fields: accessdate,
+ author, date, note, subtitle, title, url.
-See section IV (CHANGE LOG) for a complete list of user-visible
-changes.
+New warning: A common mistake when using non-numeric labels is to
+ place the bibliography items in an order that is incompatible with
+ the labels assigned by amsrefs. This can result in a sequence
+ such as this
+
+ [D] John Doe. ...
+ [DS] John Doe and Jane Smith. ...
+ [D] John Dunn. ...
+
+ where 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 expect
+ that reference "D2" lies between references "D1" and "DS" in the
+ bibliography just as they are entitled to expect that reference
+ [2] lies between references [1] and [3].
+
+ If amsrefs encounters a situation like this, it will now issue a
+ warning. There are three ways to resolve the problem:
+
+ 1. Rearrange the items in an order that is compatible with the
+ label style you have chosen.
+
+ 2. Choose a different label style that is compatible with the
+ order you have chosen for the items.
+
+ 3. Use the label field to override the automatically-generated
+ label and leave your readers to their own devices.
+
+Bug fix: Spaces are now ignored inside the first argument (the
+ citekey) to \bib. Previously, something like
+
+ \bib{Doe 1998}{...}{...}
+
+ along with
+
+ \cite{Doe 1998}
+
+ would result in a warning that the citation 'Doe1998' was
+ undefined since the space was stripped from the argument to \cite,
+ but not from the first argument to \bib.
========================================================================
-IV. CHANGE LOG
+V. CHANGE LOG (REVERSE CHRONOLOGICAL ORDER)
-2004-06-30 amsrefs.dtx 2.0
+2012-01-15 amsrefs.dtx v2.12
+ -- Added *-optional argument to biblist to allow setting of new
+ per-biblist prefix and labels options.
+ -- Added new webpage entry type.
+ -- Patched \bib to ignore spaces inside the citekey for
+ compatibility with \cite.
+ -- Add a warning if an out-of-order duplicate biblabel stem is
+ detected.
- * Major rewrite of internals. See changes.pdf for information on
- the user-visible changes.
+2012-07-26 amsrefs.dtx v2.11
+ -- Minimal support for mixing \bibitem with \bib. This is *not*
+ recommended practice and will not be mentioned in the user
+ documentation, but it is necessary for certain internal AMS
+ applications.
-2006-10-25 amsrefs.dtx 2.02
+ -- Eliminated the "(to appear in print)" note that \PrintDOI used
+ to add if there was was no volume field.
- -- Updated copyright and license fields.
- -- Numerous bug fixes.
+ -- Added \citeyear to aid in emulating natbib.
- * amsrefs.dtx 2.02:
- -- Fixed bug in copying cross-referenced entries from .ltb files
- to the .bbl file.
- -- Fixed disappearing table of contents when used with AMS
- document classes.
- -- Enabled xrefs in more fields.
- -- Fixed spacing problems with \MR. Also be more forgiving if
- the argument to \MR begins with "MR" or "MR ".
- -- Added support for showlabels.sty.
- -- Fixed some bugs in the interaction with hyperref.
- -- Removed support for the obsolete beta and jpa package options.
+ * textcmds.dtx 2.00:
+ -- Replaced most \newcommand's by \providecommand to minimize
+ chances of conflicts with other packages or user definitions.
- * amsxport.dtx 2.01:
- -- Fixed bug in sort order of references.
+2012-05-08 amsrefs.dtx 2.10
+ -- patched amsbst.sty to remove unwanted close paren from \PrintEditorsA
+ -- patched \@endbiblist to reset \previous@primary between biblists
+
+2010-08-17 amsrefs.dtx 2.09
+
+ -- Restored support for \citeform that was inadvertently lost
+ somewhere along the way.
+ -- .bst files now unpack into bibtex/bst/amsrefs instead of
+ bibtex/bst/ams
+ -- .bib files now unpack into bibtex/bib/amsrefs instead of
+ bibtex/bib/ams
+
+2010-08-13 amsrefs.dtx 2.08
+
+ -- Updated license to LPPL.
+ -- Patched author-year \BibLabel to support hyperref.
+ -- Added \biblistfont to support easier customization of
+ bibliography font.
+
+2008-07-25 amsrefs.dtx 2.07: AMS-internal modifications.
+
+2008-07-25 amsrefs.dtx 2.06
+
+ -- Modified \BibLabel to typeset numeric labels flush-right
+ instead of flush-left, per AMS house style.
+
+amrefs.dtx 2.03, 2.04, 2.05: AMS-internal modifications only.
2007-10-22 amsrefs.dtx 2.03
@@ -206,31 +314,27 @@ IV. CHANGE LOG
* textcmds.dtx 1.06:
-- Added \q for symmetry with \qq.
-amrefs.dtx 2.03, 2.04, 2.05: AMS-internal modifications only.
-
-2008-07-25 amsrefs.dtx 2.06
-
- -- Modified \BibLabel to typeset numeric labels flush-right
- instead of flush-left, per AMS house style.
-
-2008-07-25 amsrefs.dtx 2.07: AMS-internal modifications.
+2006-10-25 amsrefs.dtx 2.02
-2010-08-13 amsrefs.dtx 2.08
+ -- Updated copyright and license fields.
+ -- Numerous bug fixes.
- -- Updated license to LPPL.
- -- Patched author-year \BibLabel to support hyperref.
- -- Added \biblistfont to support easier customization of
- bibliography font.
+ * amsrefs.dtx 2.02:
+ -- Fixed bug in copying cross-referenced entries from .ltb files
+ to the .bbl file.
+ -- Fixed disappearing table of contents when used with AMS
+ document classes.
+ -- Enabled xrefs in more fields.
+ -- Fixed spacing problems with \MR. Also be more forgiving if
+ the argument to \MR begins with "MR" or "MR ".
+ -- Added support for showlabels.sty.
+ -- Fixed some bugs in the interaction with hyperref.
+ -- Removed support for the obsolete beta and jpa package options.
-2010-08-17 amsrefs.dtx 2.09
+ * amsxport.dtx 2.01:
+ -- Fixed bug in sort order of references.
- -- Restored support for \citeform that was inadvertently lost
- somewhere along the way.
- -- .bst files now unpack into bibtex/bst/amsrefs instead of
- bibtex/bst/ams
- -- .bib files now unpack into bibtex/bib/amsrefs instead of
- bibtex/bib/ams
+2004-06-30 amsrefs.dtx 2.0
-2012-05-08 amsrefs.dtx 2.10
- -- patched amsbst.sty to remove unwanted close paren from \PrintEditorsA
- -- patched \@endbiblist to reset \previous@primary between biblists
+ * Major rewrite of internals. See changes.pdf for information on
+ the user-visible changes.