summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/amsrefs/00readme.txt
blob: 2d89ab2e25e60fbf544bab2aa982168569926aef (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
00readme.txt for amsrefs 2.10 [2012/05/08]

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.

This work may be distributed and/or modified under the
conditions of the LaTeX Project Public License, either version 1.3c
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.3c 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 the American Mathematical
Society.

American Mathematical Society
Technical Support
Publications Technical Group
201 Charles Street
Providence, RI 02904
USA
tel: (401) 455-4080
     (800) 321-4267 (USA and Canada only)
fax: (401) 331-3842
email: tech-support@ams.org

========================================================================

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 command for bibliography items is different -- \bib instead of
\bibitem -- for reasons that will be evident upon further reading in
the documentation.

A set of BibTeX style files are provided to allow people to extract
data from .bib files and produce .bbl files in amsrefs format instead
of conventional \bibitem format.

User documentation is in amsrdoc.pdf and amsrefs.faq.

Technical documentation (including documentation for package writers)
is in amsrefs.pdf.

========================================================================
I. 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).

-- Deferred formatting.

This means that 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.

-- Less ambiguous format for author names.

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.

-- Author-year citations.

There is integrated support for citations in author-year form.

-- Back-reference support.

Works in conjunction with the hyperref package.

-- Setup requires only LaTeX knowledge.

All bibliography setup can be done in LaTeX; learning another
programming language (such as, the one used in BibTeX bst files) is
unnecessary.

-- Self-printable database files.

A LaTeX document that contains only a bibliography in amsrefs forms can
be used as a database for exporting entries to other documents. And
because it is a LaTeX document, the database can be printed directly at
any time simply by running it through LaTeX in the usual way.

-- Self-contained.

In many cases it seems possible to do without BibTeX entirely. For
example, if the entries are extracted from a single database file that
is maintained in sorted order, the bibliography can be printed directly
by LaTeX on the first pass and the citations resolved on the second
pass.

========================================================================
II. GETTING STARTED

1. Install the package, referring to install.txt as needed.

2. There are four example files provided:

   cite-xa : Demonstrates an author-year citation scheme. The
             bibliography is embedded in the .tex file instead of
             residing in a separate .bbl file.
 
   cite-xb : Demonstrates usage with more-or-less standard BibTeX
             methods.
 
   cite-xs : Shows how the bbl file can be created by LaTeX itself from a
             suitably presorted ltb file.
 
   cite-xh : A working hyperref/backrefs example.

3. Run LaTeX on cite-xa.tex. Take a look at the messages that have to
   do with citations and the bibliography section. Run LaTeX again to
   resolve the citations and check the output.

4. Run LaTeX on cite-xb.tex. Run BibTeX. Look at the bbl file.
   Interesting, huh? Run LaTeX twice more to resolve the citations.

5. Run LaTeX on cite-xs.tex and look at the output.

6. Run pdflatex on cite-xh.tex (it is set up to use BibTeX also, like
   cite-xb).

========================================================================
III. REMARKS ON THIS RELEASE

This release fixes a few bugs and restates the license under which the
package is distributed.

See section IV (CHANGE LOG) for a complete list of user-visible
changes.

========================================================================
IV. CHANGE LOG

2004-06-30 amsrefs.dtx 2.0 

    * Major rewrite of internals.  See changes.pdf for information on
      the user-visible changes.

2006-10-25 amsrefs.dtx 2.02

    -- Updated copyright and license fields.
    -- Numerous bug fixes.

    * 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.

    * amsxport.dtx 2.01:
      -- Fixed bug in sort order of references.

2007-10-22 amsrefs.dtx 2.03

    -- .sty files now unpack into tex/latex/amsrefs instead of
       tex/latex/amscls.

    * amsrefs.dtx 2.03:
      -- Added the msc-links option.
      -- \nocite no longer produces a back reference with the backrefs
         option.
      -- The backrefs option no longer automatically loads hyperref.
      -- Fixed support for showkeys (not showlabels, as incorrectly
         stated in the release notes for 2.02) and the showkeys
         notcite option.
      -- Modified the bibdiv, bibchapter and bibsection environments
         to set the page headings correctly for non-AMS document
         classes.
      -- For journals with issue numbers but no volumes, the issue
         number is now treated as a volume number, per AMS house
         style.
      -- \cite and related commands can now be used within the fields
         of a \bib item, for example, note={See also \cite{SokalB1998}}

    * 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.

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.

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

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