[latexrefman-commits] [SCM] latexrefman updated: r632 - trunk
jimhefferon at gnu.org.ua
jimhefferon at gnu.org.ua
Tue May 29 18:38:49 CEST 2018
Author: jimhefferon
Date: 2018-05-29 19:38:49 +0300 (Tue, 29 May 2018)
New Revision: 632
Modified:
trunk/ChangeLog
trunk/latex2e.html
trunk/latex2e.info
trunk/latex2e.pdf
trunk/latex2e.texi
Log:
still finishing TODO on Environments; did thebibliography
Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog 2018-05-28 20:44:46 UTC (rev 631)
+++ trunk/ChangeLog 2018-05-29 16:38:49 UTC (rev 632)
@@ -1,3 +1,7 @@
+2018-05-29 Jim Hefferon <jhefferon at smcvt.edu>
+
+ * latex2e.texi (thebibliography) Add examples. Adjust wording.
+
2018-05-28 Jim Hefferon <jhefferon at smcvt.edu>
* latex2e.texi (picture) Add examples. Adjust wording.
Modified: trunk/latex2e.html
===================================================================
--- trunk/latex2e.html 2018-05-28 20:44:46 UTC (rev 631)
+++ trunk/latex2e.html 2018-05-29 16:38:49 UTC (rev 632)
@@ -3652,7 +3652,7 @@
<p>Thus, <code>\label{fig:Euler}</code> is a label for a figure with a portrait
of the great man.
</p>
-<p>Inside the auxillary file the reference information is kept in the
+<p>Inside the auxiliary file the reference information is kept in the
format
<code>\newlabel{<var>label</var>}{{<var>currentlabel</var>}{<var>pagenumber</var>}}</code>.
Here <var>currentlabel</var> is the current value of the macro
@@ -6873,7 +6873,7 @@
</p>
<p>The label is optional; it is used for cross references (see <a href="#Cross-references">Cross references</a>).
<a name="index-_005ccaption-1"></a>
-The <code>\caption</code> command is alo optional. It specifies caption text
+The <code>\caption</code> command is also optional. It specifies caption text
for the table. By default it is numbered. If its optional
<var>lottitle</var> is present then that text is used in the list of tables
instead of <var>title</var> (see <a href="#Tables-of-contents">Tables of contents</a>).
@@ -7360,43 +7360,61 @@
</p>
<div class="example">
<pre class="example">\begin{thebibliography}{<var>widest-label</var>}
-\bibitem[<var>label</var>]{<var>cite_key}</var>
-...
+ \bibitem[<var>label</var>]{<var>cite_key}</var>
+ ...
\end{thebibliography}
</pre></div>
-<p>Produce a bibliography or reference list.
+<p>Produce a bibliography or reference list. There are two ways to produce
+bibliographic lists. This environment is suitable when you have only a
+few references and can maintain the list by hand. See <a href="#Using-BibTeX">Using BibTeX</a>
+for a more sophisticated approach.
</p>
-<p>In the <code>article</code> class, this list is labelled ‘<samp>References</samp>’ and
-the label is stored in macro <code>\refname</code>; in the <code>report</code>
-class, it is labelled ‘<samp>Bibliography</samp>’ and the label is stored in
-macro <code>\bibname</code>.
+<p>This shows the environment with two entries.
</p>
-<p>Change the label by redefining the command <code>\refname</code> or
-<code>\bibname</code>, whichever is applicable depending on the class:
+<div class="example">
+<pre class="example">This work is based on \cite{latexdps}.
+Together they are \cite{latexdps, texbook}.
+ ...
+\begin{thebibliography}{9}
+\bibitem{latexdps}
+ Leslie Lamport.
+ \textit{\LaTeX{}: a document preparation system}.
+ Addison-Wesley, Reading, Massachusetts, 1993.
+\bibitem{texbook}
+ Donald Ervin Knuth.
+ \textit{The \TeX book}.
+ Addison-Wesley, Reading, Massachusetts, 1983.
+\end{thebibliography}
+</pre></div>
+
+<p>This styles the first reference as ‘<samp>[1] Leslie ...</samp>’, and so that
+<code>\cite{latexdps}</code> produces the matching ‘<samp>... based on [1]</samp>’.
+The second <code>\cite</code> produces ‘<samp>[1, 2]</samp>’. You must compile the
+document twice to resolve these references.
</p>
-<ul>
-<li> <a name="index-_005cbibname"></a>
-For standard classes whose top level sectioning is <code>\chapter</code>
-(such as <samp>book</samp> and <samp>report</samp>), the label is in the macro
-<code>\bibname</code>;
-
-</li><li> <a name="index-_005crefname"></a>
-For standard classes whose the top level sectioning is <code>\section</code>
-(such as <samp>article</samp>), the label is in macro <code>\refname</code>.
-</li></ul>
-
+<p>The mandatory argument <var>widest-label</var> is text that, when typeset, is
+as wide as the widest item label produced by the <code>\bibitem</code>
+commands. The tradition is to use <code>9</code> for bibliographies with less
+than 10 references, <code>99</code> for ones with less than 100, etc.
+</p>
+<p>The bibliographic list is headed by a title such as ‘<samp>Bibliography</samp>’.
+To change it there are two cases. In the <samp>book</samp> and <samp>report</samp>
+classes, where the top level sectioning is <code>\chapter</code> and the
+default title is ‘<samp>Bibliography</samp>’, that title is in the macro
+<code>\bibname</code>. For <samp>article</samp>, where the class’s top level
+sectioning is <code>\section</code> and the default is ‘<samp>References</samp>’, the
+title is in macro <code>\refname</code>. Change it by redefining the command,
+as with <code>\renewcommand{\refname}{Cited references}</code> after
+<code>\begin{document}</code>.
+</p>
<a name="index-package_002c-babel"></a>
<a name="index-babel-package"></a>
-<p>Language support packages such as <samp>babel</samp> will redefine
-<code>\refname</code> or <code>\bibname</code>.
+<p>Language support packages such as <samp>babel</samp> will automatically
+redefine <code>\refname</code> or <code>\bibname</code> to fit the selected
+language.
</p>
-<p>The mandatory <var>widest-label</var> argument is text that, when typeset,
-is as wide as the widest item label produced by the <code>\bibitem</code>
-commands. It is typically given as <code>9</code> for bibliographies with
-less than 10 references, <code>99</code> for ones with less than 100, etc.
-</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">• <a href="#g_t_005cbibitem" accesskey="1">\bibitem</a>:</td><td> </td><td align="left" valign="top">Specify a bibliography item.
</td></tr>
@@ -7432,21 +7450,60 @@
<pre class="example">\bibitem[<var>label</var>]{<var>cite_key</var>}
</pre></div>
-<p>Generate an entry labelled by <var>label</var>. If the optional <var>label</var>
-argument is missing then LaTeX automatically generates a number using
-the <code>enumi</code> counter. The <var>cite_key</var> is a
+<p>Generate an entry labeled by <var>label</var>. The default is for LaTeX to
+generates a number using the <code>enumi</code> counter. The <em>citation key</em>
<a name="index-citation-key"></a>
-<em>citation key</em> consisting in any sequence of
-letters, numbers, and punctuation symbols not containing a comma.
+<var>cite_key</var> is a string of
+letters, numbers, and punctuation symbols (but not comma).
</p>
-<p>This command writes an entry to the <samp>.aux</samp> file containing the
-item’s <var>cite_key</var> and <var>label</var>. When the <samp>.aux</samp> file is
-read by the <code>\begin{document}</code> command, the item’s <var>label</var> is
-associated with <code>cite_key</code>, causing references to <var>cite_key</var>
-with a <code>\cite</code> command (see <a href="#g_t_005ccite">\cite</a>) to produce the associated
-<var>label</var>.
+<p>See <a href="#thebibliography">thebibliography</a> for an example.
</p>
+<p>The optional <var>label</var> changes the default label from an integer to the
+given string. With this
+</p>
+<div class="example">
+<pre class="example">\begin{thebibliography}
+\bibitem[Lamport 1993]{latexdps}
+ Leslie Lamport.
+ \textit{\LaTeX{}: a document preparation system}.
+ Addison-Wesley, Reading, Massachusetts, 1993.
+\bibitem{texbook}
+ Donald Ervin Knuth.
+ \textit{The \TeX book}.
+ Addison-Wesley, Reading, Massachusetts, 1983.
+\end{thebibliography}
+</pre></div>
+<p>the first entry will be styled as ‘<samp>[Lamport 1993] Leslie ...</samp>’ (The
+amount of horizontal space that LaTeX leaves for the label depends on
+the <var>widest-label</var> argument of the <code>thebibliography</code>
+environment; see <a href="#thebibliography">thebibliography</a>.) Similarly, <code>... based on
+\cite{latexdps}</code> will produce ‘<samp>... based on [Lamport 1994]</samp>’.
+</p>
+<p>If you mix <code>\bibitem</code> entries having a <var>label</var> with those that
+do not then LaTeX will number the unlabelled ones sequentially. In
+the example above the <code>texbook</code> entry will appear as ‘<samp>[1]
+Donald ...</samp>’, despite that it is the second entry.
+</p>
+<p>If you use the same <var>cite_key</var> twice then you get ‘<samp>LaTeX
+Warning: There were multiply-defined labels</samp>’.
+</p>
+<p>Under the hood, LaTeX remembers the <var>cite_key</var> and <var>label</var>
+information because <code>\bibitem</code> writes it to the auxiliary file
+<samp><var>filename</var>.aux</samp>. For instance, the above example causes
+<code>\bibcite{latexdps}{Lamport, 1993}</code> and
+<code>\bibcite{texbook}{1}</code> to appear in that file. The <samp>.aux</samp>
+file is read by the <code>\begin{document}</code> command and then the
+information is available for <code>\cite</code> commands. This explains why
+you need to run LaTeX twice to resolve references: once to write it
+out and once to read it in.
+</p>
+<p>Because of this two-pass algorithm, when you add a <code>\bibitem</code> or
+change its <var>cite_key</var> you may get ‘<samp>LaTeX Warning: Label(s) may
+have changed. Rerun to get cross-references right</samp>’. Fix it by
+recompiling.
+</p>
+
<hr>
<a name="g_t_005ccite"></a>
<div class="header">
@@ -7470,16 +7527,46 @@
<pre class="example">\cite[<var>subcite</var>]{<var>keys</var>}
</pre></div>
-<p>Generate an in-text citation to the references associated with
-<var>keys</var>, using entries in the <samp>.aux</samp> file. The <var>keys</var>
-argument is a list of one or more citation keys (see <a href="#g_t_005cbibitem">\bibitem</a>),
-separated by commas.
+<p>Generate as output a citation to the references associated with
+<var>keys</var>. The mandatory <var>keys</var> is a citation key, or a
+comma-separated list of citation keys (see <a href="#g_t_005cbibitem">\bibitem</a>).
</p>
-<p>The text of the optional <var>subcite</var> argument appears after the
-citation. For example, <code>\cite[p.~314]{knuth}</code> might produce
-‘<samp>[Knuth, p. 314]</samp>’.
+<p>This
</p>
+<div class="example">
+<pre class="example">The ultimate source is \cite{texbook}.
+ ...
+\begin{thebibliography}
+\bibitem{texbook}
+ Donald Ervin Knuth.
+ \textit{The \TeX book}.
+ Addison-Wesley, Reading, Massachusetts, 1983.
+\end{thebibliography}
+</pre></div>
+<p>produces the output ‘<samp>... source is [1]</samp>’.
+</p>
+<p>The optional argument <var>subcite</var> is appended to the citation. For
+example, <code>See 14.3 in \cite[p.~314]{texbook}</code> might produce
+‘<samp>See 14.3 in [1, p. 314]</samp>’.
+</p>
+<p>If <var>keys</var> is not in your bibliography information then you get
+‘<samp>LaTeX Warning: There were undefined references</samp>’, and in the output
+the citation shows as a boldface question mark between square brackets.
+There are two possible causes. If you have mistyped something, as in
+<code>\cite{texbok}</code> then you need to correct the spelling. On the
+other hand, if you have just added or modified the bibliographic
+information and so changed the <samp>.aux</samp> file (see <a href="#g_t_005cbibitem">\bibitem</a>) then
+the fix may be to just run LaTeX again.
+</p>
+<p>In addition to what appears in the output, <code>\cite</code> writes
+information to the auxiliary file <samp><var>filename</var>.aux</samp>. For
+instance, <code>\cite{latexdps}</code> writes ‘<samp>\citation{latexdps}</samp>’
+to that file. This information is used by BibTeX to include in your
+reference list only those works that you have actually cited; see
+<a href="#g_t_005cnocite">\nocite</a> also.
+</p>
+
<hr>
<a name="g_t_005cnocite"></a>
<div class="header">
@@ -7497,9 +7584,14 @@
<pre class="example"><code>\nocite{<var>keys</var>}</code>
</pre></div>
-<p>Produces no text, but writes <var>keys</var>, which is a list of one or more
-citation keys, to the <samp>.aux</samp> file.
+<p>Produces no output but writes <var>keys</var> to the auxiliary file
+<samp><var>filename</var>.aux</samp>.
</p>
+<p>The mandatory argument <var>keys</var> is a comma-separated list of one or
+more citation keys (see <a href="#g_t_005cbibitem">\bibitem</a>). This information is used by
+BibTeX to include these works in your reference list even though you
+have not actually cited them (see <a href="#g_t_005ccite">\cite</a>).
+</p>
<hr>
<a name="Using-BibTeX"></a>
@@ -7516,30 +7608,31 @@
<a name="index-_005cbibliographystyle"></a>
<a name="index-_005cbibliography"></a>
-<p>If you use the BibTeX program by Oren Patashnik (highly
-recommended if you need a bibliography of more than a couple of
-titles) to maintain your bibliography, you don’t use the
-<code>thebibliography</code> environment (see <a href="#thebibliography">thebibliography</a>). Instead,
-you include the lines
+<p>As described in <code>thebibliography</code> (see <a href="#thebibliography">thebibliography</a>), a
+sophisticated approach to managing bibliographies is provided by the
+BibTeX program. This is only an introduction; see the full
+documentation on CTAN.
</p>
+<p>With BibTeX, you don’t use <code>thebibliography</code>
+(see <a href="#thebibliography">thebibliography</a>). Instead, include these lines.
+</p>
<div class="example">
<pre class="example">\bibliographystyle{<var>bibstyle</var>}
-\bibliography{<var>bibfile1</var>,<var>bibfile2</var>}
+\bibliography{<var>bibfile1</var>, <var>bibfile2</var>, ...}
</pre></div>
-<p>The <code>\bibliographystyle</code> command does not produce any output of
-its own. Rather, it defines the style in which the bibliography will
-be produced: <var>bibstyle</var> refers to a file
-<var>bibstyle</var><samp>.bst</samp>, which defines how your citations will look.
-The standard <var>bibstyle</var> names distributed with BibTeX are:
+<p>The <var>bibstyle</var> refers to a file <samp><var>bibstyle</var>.bst</samp>, which
+defines how your citations will look. The standard <var>bibstyle</var>’s
+distributed with BibTeX are:
</p>
<dl compact="compact">
<dt><code>alpha</code></dt>
-<dd><p>Sorted alphabetically. Labels are formed from name of author and year of
-publication.
+<dd><p>Labels are formed from name of author and year of publication.
+The bibliographic items are sorted alphabetically.
</p></dd>
<dt><code>plain</code></dt>
-<dd><p>Sorted alphabetically. Labels are numeric.
+<dd><p>Labels are integers.
+Sort the bibliographic items alphabetically.
</p></dd>
<dt><code>unsrt</code></dt>
<dd><p>Like <code>plain</code>, but entries are in order of citation.
@@ -7549,18 +7642,33 @@
</p></dd>
</dl>
-<p>In addition, numerous other BibTeX style files exist tailored to
-the demands of various publications. See
+<p>Many, many other BibTeX style files exist,
+tailored to the demands of various publications. See CTAN’s listing
<a href="http://mirror.ctan.org/biblio/bibtex/contrib">http://mirror.ctan.org/biblio/bibtex/contrib</a>.
</p>
<p>The <code>\bibliography</code> command is what actually produces the
-bibliography. The argument to <code>\bibliography</code> refers to files
-named <samp><var>bibfile1</var>.bib</samp>, <samp><var>bibfile2</var>.bib</samp>, …,
-which should contain your database in
-BibTeX format. Only the entries referred to via <code>\cite</code> and
-<code>\nocite</code> will be listed in the bibliography.
+bibliography. Its argument is a comma-separated list, referring to
+files named <samp><var>bibfile1</var>.bib</samp>, <samp><var>bibfile2</var>.bib</samp>,
+… These contain your database in BibTeX format. This shows a
+typical entry in that format.
</p>
+<div class="example">
+<pre class="example">@book{latexdps,
+ author = "W.H. Masters and V.E. Johnson",
+ title = "Human Sexual Response",
+ year = "1966",
+ publisher = "Bantam Books",
+ address = "Toronto; New York"
+}
+</pre></div>
+<p>Only the bibliographic entries referred to via <code>\cite</code> and
+<code>\nocite</code> will be listed in the document’s bibliography. Thus you
+can keep all your sources together in one file, or a small number of
+files, and rely on BibTeX to include in this document only those that
+you used.
+</p>
+
<hr>
<a name="theorem"></a>
<div class="header">
@@ -7729,14 +7837,14 @@
files, or parts of those files. Such packages include <code>listings</code>,
and <code>minted</code>.
</p>
-<a name="index-package_002c-fancyverb"></a>
-<a name="index-fancyverb-package"></a>
+<a name="index-package_002c-fancyvrb-1"></a>
+<a name="index-fancyvrb-package-1"></a>
<a name="index-package_002c-verbatimbox"></a>
<a name="index-verbatimbox-package"></a>
<p>A package that provides many more options for verbatim environments is
-<code>fancyverb</code>. Another is <code>verbatimbox</code>.
+<code>fancyvrb</code>. Another is <code>verbatimbox</code>.
</p>
<p>For a list of all the relevant packages, see CTAN.
</p>
@@ -7792,7 +7900,7 @@
<a name="index-package_002c-url"></a>
<a name="index-url-package"></a>
-<p>For typesetting Internet addresses, URL’s, the package <code>url</code>
+<p>For typesetting Internet addresses, urls, the package <code>url</code>
provides an option that is better than the <code>\verb</code> command, since
it allows line breaks.
</p>
@@ -16351,7 +16459,7 @@
and run LaTeX again then the resulting document shows only the
material from <samp>articles.tex</samp>, not the material from
<samp>preamble.tex</samp> or <samp>amendments.tex</samp>. Nonetheless, all of the
-auxillary information from the omitted files is still there, including
+auxiliary information from the omitted files is still there, including
the starting page number of the chapter.
</p>
<p>If the document preamble does not have <code>\includeonly</code> then
@@ -16359,7 +16467,7 @@
commands.
</p>
<p>The <code>\include</code> command makes a new page. To avoid that, see
-<a href="#g_t_005cinput">\input</a> (which, however, does not retain the auxillary
+<a href="#g_t_005cinput">\input</a> (which, however, does not retain the auxiliary
information).
</p>
<p>File names can involve paths.
@@ -17779,8 +17887,8 @@
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_letter-F">F</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-families_002c-of-fonts">families, of fonts</a>:</td><td> </td><td valign="top"><a href="#Low_002dlevel-font-commands">Low-level font commands</a></td></tr>
-<tr><td></td><td valign="top"><a href="#index-fancyverb-package"><code>fancyverb</code> <span class="roman">package</span></a>:</td><td> </td><td valign="top"><a href="#verbatim">verbatim</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-fancyvrb-package"><code>fancyvrb</code> <span class="roman">package</span></a>:</td><td> </td><td valign="top"><a href="#tabbing">tabbing</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-fancyvrb-package-1"><code>fancyvrb</code> <span class="roman">package</span></a>:</td><td> </td><td valign="top"><a href="#verbatim">verbatim</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-feminine-ordinal-symbol">feminine ordinal symbol</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-figure-number_002c-cross-referencing">figure number, cross referencing</a>:</td><td> </td><td valign="top"><a href="#g_t_005cref">\ref</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-figures_002c-footnotes-in">figures, footnotes in</a>:</td><td> </td><td valign="top"><a href="#minipage">minipage</a></td></tr>
@@ -18052,8 +18160,8 @@
<tr><td></td><td valign="top"><a href="#index-package_002c-datetime"><span class="roman">package</span>, <code>datetime</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005ctoday">\today</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-package_002c-enumitem"><span class="roman">package</span>, <code>enumitem</code></a>:</td><td> </td><td valign="top"><a href="#list">list</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-package_002c-etoolbox"><span class="roman">package</span>, <code>etoolbox</code></a>:</td><td> </td><td valign="top"><a href="#Class-and-package-commands">Class and package commands</a></td></tr>
-<tr><td></td><td valign="top"><a href="#index-package_002c-fancyverb"><span class="roman">package</span>, <code>fancyverb</code></a>:</td><td> </td><td valign="top"><a href="#verbatim">verbatim</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-package_002c-fancyvrb"><span class="roman">package</span>, <code>fancyvrb</code></a>:</td><td> </td><td valign="top"><a href="#tabbing">tabbing</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-package_002c-fancyvrb-1"><span class="roman">package</span>, <code>fancyvrb</code></a>:</td><td> </td><td valign="top"><a href="#verbatim">verbatim</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-package_002c-flafter"><span class="roman">package</span>, <code>flafter</code></a>:</td><td> </td><td valign="top"><a href="#Floats">Floats</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-package_002c-float"><span class="roman">package</span>, <code>float</code></a>:</td><td> </td><td valign="top"><a href="#Floats">Floats</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-package_002c-footmisc"><span class="roman">package</span>, <code>footmisc</code></a>:</td><td> </td><td valign="top"><a href="#Footnotes-in-section-headings">Footnotes in section headings</a></td></tr>
@@ -18567,7 +18675,6 @@
<tr><td></td><td valign="top"><a href="#index-_005cbibitem"><code>\bibitem</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cbibitem">\bibitem</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_005cbibliography"><code>\bibliography</code></a>:</td><td> </td><td valign="top"><a href="#Using-BibTeX">Using BibTeX</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_005cbibliographystyle"><code>\bibliographystyle</code></a>:</td><td> </td><td valign="top"><a href="#Using-BibTeX">Using BibTeX</a></td></tr>
-<tr><td></td><td valign="top"><a href="#index-_005cbibname"><code>\bibname</code></a>:</td><td> </td><td valign="top"><a href="#thebibliography">thebibliography</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_005cbigcap"><code>\bigcap</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_005cbigcirc"><code>\bigcirc</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_005cbigcup"><code>\bigcup</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr>
@@ -19093,7 +19200,6 @@
<tr><td></td><td valign="top"><a href="#index-_005cRe"><code>\Re</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_005cref"><code>\ref</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cref">\ref</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_005creflectbox"><code>\reflectbox</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cscalebox">\scalebox</a></td></tr>
-<tr><td></td><td valign="top"><a href="#index-_005crefname"><code>\refname</code></a>:</td><td> </td><td valign="top"><a href="#thebibliography">thebibliography</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_005crefstepcounter"><code>\refstepcounter</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005crefstepcounter">\refstepcounter</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_005crenewenvironment"><code>\renewenvironment</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cnewenvironment-_0026-_005crenewenvironment">\newenvironment & \renewenvironment</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_005cRequirePackage"><code>\RequirePackage</code></a>:</td><td> </td><td valign="top"><a href="#Class-and-package-commands">Class and package commands</a></td></tr>
Modified: trunk/latex2e.info
===================================================================
--- trunk/latex2e.info 2018-05-28 20:44:46 UTC (rev 631)
+++ trunk/latex2e.info 2018-05-29 16:38:49 UTC (rev 632)
@@ -2222,7 +2222,7 @@
Thus, '\label{fig:Euler}' is a label for a figure with a portrait of
the great man.
- Inside the auxillary file the reference information is kept in the
+ Inside the auxiliary file the reference information is kept in the
format '\newlabel{LABEL}{{CURRENTLABEL}{PAGENUMBER}}'. Here
CURRENTLABEL is the current value of the macro '\@currentlabel' that is
usually updated whenever you call '\refstepcounter{COUNTER}'.
@@ -4522,7 +4522,7 @@
can contain text, commands, graphics, etc.
The label is optional; it is used for cross references (*note Cross
-references::). The '\caption' command is alo optional. It specifies
+references::). The '\caption' command is also optional. It specifies
caption text for the table. By default it is numbered. If its optional
LOTTITLE is present then that text is used in the list of tables instead
of TITLE (*note Tables of contents::).
@@ -4894,32 +4894,52 @@
Synopsis:
\begin{thebibliography}{WIDEST-LABEL}
- \bibitem[LABEL]{CITE_KEY}
- ...
+ \bibitem[LABEL]{CITE_KEY}
+ ...
\end{thebibliography}
- Produce a bibliography or reference list.
+ Produce a bibliography or reference list. There are two ways to
+produce bibliographic lists. This environment is suitable when you have
+only a few references and can maintain the list by hand. *Note Using
+BibTeX:: for a more sophisticated approach.
- In the 'article' class, this list is labelled 'References' and the
-label is stored in macro '\refname'; in the 'report' class, it is
-labelled 'Bibliography' and the label is stored in macro '\bibname'.
+ This shows the environment with two entries.
- Change the label by redefining the command '\refname' or '\bibname',
-whichever is applicable depending on the class:
+ This work is based on \cite{latexdps}.
+ Together they are \cite{latexdps, texbook}.
+ ...
+ \begin{thebibliography}{9}
+ \bibitem{latexdps}
+ Leslie Lamport.
+ \textit{\LaTeX{}: a document preparation system}.
+ Addison-Wesley, Reading, Massachusetts, 1993.
+ \bibitem{texbook}
+ Donald Ervin Knuth.
+ \textit{The \TeX book}.
+ Addison-Wesley, Reading, Massachusetts, 1983.
+ \end{thebibliography}
- * For standard classes whose top level sectioning is '\chapter' (such
- as 'book' and 'report'), the label is in the macro '\bibname';
+ This styles the first reference as '[1] Leslie ...', and so that
+'\cite{latexdps}' produces the matching '... based on [1]'. The second
+'\cite' produces '[1, 2]'. You must compile the document twice to
+resolve these references.
- * For standard classes whose the top level sectioning is '\section'
- (such as 'article'), the label is in macro '\refname'.
+ The mandatory argument WIDEST-LABEL is text that, when typeset, is as
+wide as the widest item label produced by the '\bibitem' commands. The
+tradition is to use '9' for bibliographies with less than 10 references,
+'99' for ones with less than 100, etc.
- Language support packages such as 'babel' will redefine '\refname' or
-'\bibname'.
+ The bibliographic list is headed by a title such as 'Bibliography'.
+To change it there are two cases. In the 'book' and 'report' classes,
+where the top level sectioning is '\chapter' and the default title is
+'Bibliography', that title is in the macro '\bibname'. For 'article',
+where the class's top level sectioning is '\section' and the default is
+'References', the title is in macro '\refname'. Change it by redefining
+the command, as with '\renewcommand{\refname}{Cited references}' after
+'\begin{document}'.
- The mandatory WIDEST-LABEL argument is text that, when typeset, is as
-wide as the widest item label produced by the '\bibitem' commands. It
-is typically given as '9' for bibliographies with less than 10
-references, '99' for ones with less than 100, etc.
+ Language support packages such as 'babel' will automatically redefine
+'\refname' or '\bibname' to fit the selected language.
* Menu:
@@ -4942,17 +4962,54 @@
\bibitem[LABEL]{CITE_KEY}
- Generate an entry labelled by LABEL. If the optional LABEL argument
-is missing then LaTeX automatically generates a number using the 'enumi'
-counter. The CITE_KEY is a "citation key" consisting in any sequence of
-letters, numbers, and punctuation symbols not containing a comma.
+ Generate an entry labeled by LABEL. The default is for LaTeX to
+generates a number using the 'enumi' counter. The "citation key"
+CITE_KEY is a string of letters, numbers, and punctuation symbols (but
+not comma).
- This command writes an entry to the '.aux' file containing the item's
-CITE_KEY and LABEL. When the '.aux' file is read by the
-'\begin{document}' command, the item's LABEL is associated with
-'cite_key', causing references to CITE_KEY with a '\cite' command (*note
-\cite::) to produce the associated LABEL.
+ *Note thebibliography:: for an example.
+ The optional LABEL changes the default label from an integer to the
+given string. With this
+
+ \begin{thebibliography}
+ \bibitem[Lamport 1993]{latexdps}
+ Leslie Lamport.
+ \textit{\LaTeX{}: a document preparation system}.
+ Addison-Wesley, Reading, Massachusetts, 1993.
+ \bibitem{texbook}
+ Donald Ervin Knuth.
+ \textit{The \TeX book}.
+ Addison-Wesley, Reading, Massachusetts, 1983.
+ \end{thebibliography}
+
+ the first entry will be styled as '[Lamport 1993] Leslie ...' (The
+amount of horizontal space that LaTeX leaves for the label depends on
+the WIDEST-LABEL argument of the 'thebibliography' environment; see
+*note thebibliography::.) Similarly, '... based on \cite{latexdps}'
+will produce '... based on [Lamport 1994]'.
+
+ If you mix '\bibitem' entries having a LABEL with those that do not
+then LaTeX will number the unlabelled ones sequentially. In the example
+above the 'texbook' entry will appear as '[1] Donald ...', despite that
+it is the second entry.
+
+ If you use the same CITE_KEY twice then you get 'LaTeX Warning: There
+were multiply-defined labels'.
+
+ Under the hood, LaTeX remembers the CITE_KEY and LABEL information
+because '\bibitem' writes it to the auxiliary file 'FILENAME.aux'. For
+instance, the above example causes '\bibcite{latexdps}{Lamport, 1993}'
+and '\bibcite{texbook}{1}' to appear in that file. The '.aux' file is
+read by the '\begin{document}' command and then the information is
+available for '\cite' commands. This explains why you need to run LaTeX
+twice to resolve references: once to write it out and once to read it
+in.
+
+ Because of this two-pass algorithm, when you add a '\bibitem' or
+change its CITE_KEY you may get 'LaTeX Warning: Label(s) may have
+changed. Rerun to get cross-references right'. Fix it by recompiling.
+
File: latex2e.info, Node: \cite, Next: \nocite, Prev: \bibitem, Up: thebibliography
@@ -4967,13 +5024,42 @@
\cite[SUBCITE]{KEYS}
- Generate an in-text citation to the references associated with KEYS,
-using entries in the '.aux' file. The KEYS argument is a list of one or
-more citation keys (*note \bibitem::), separated by commas.
+ Generate as output a citation to the references associated with KEYS.
+The mandatory KEYS is a citation key, or a comma-separated list of
+citation keys (*note \bibitem::).
- The text of the optional SUBCITE argument appears after the citation.
-For example, '\cite[p.~314]{knuth}' might produce '[Knuth, p. 314]'.
+ This
+ The ultimate source is \cite{texbook}.
+ ...
+ \begin{thebibliography}
+ \bibitem{texbook}
+ Donald Ervin Knuth.
+ \textit{The \TeX book}.
+ Addison-Wesley, Reading, Massachusetts, 1983.
+ \end{thebibliography}
+
+ produces the output '... source is [1]'.
+
+ The optional argument SUBCITE is appended to the citation. For
+example, 'See 14.3 in \cite[p.~314]{texbook}' might produce 'See 14.3 in
+[1, p. 314]'.
+
+ If KEYS is not in your bibliography information then you get 'LaTeX
+Warning: There were undefined references', and in the output the
+citation shows as a boldface question mark between square brackets.
+There are two possible causes. If you have mistyped something, as in
+'\cite{texbok}' then you need to correct the spelling. On the other
+hand, if you have just added or modified the bibliographic information
+and so changed the '.aux' file (*note \bibitem::) then the fix may be to
+just run LaTeX again.
+
+ In addition to what appears in the output, '\cite' writes information
+to the auxiliary file 'FILENAME.aux'. For instance, '\cite{latexdps}'
+writes '\citation{latexdps}' to that file. This information is used by
+BibTeX to include in your reference list only those works that you have
+actually cited; see *note \nocite:: also.
+
File: latex2e.info, Node: \nocite, Next: Using BibTeX, Prev: \cite, Up: thebibliography
@@ -4984,49 +5070,67 @@
\nocite{KEYS}
- Produces no text, but writes KEYS, which is a list of one or more
-citation keys, to the '.aux' file.
+ Produces no output but writes KEYS to the auxiliary file
+'FILENAME.aux'.
+ The mandatory argument KEYS is a comma-separated list of one or more
+citation keys (*note \bibitem::). This information is used by BibTeX to
+include these works in your reference list even though you have not
+actually cited them (*note \cite::).
+
File: latex2e.info, Node: Using BibTeX, Prev: \nocite, Up: thebibliography
8.24.4 Using BibTeX
-------------------
-If you use the BibTeX program by Oren Patashnik (highly recommended if
-you need a bibliography of more than a couple of titles) to maintain
-your bibliography, you don't use the 'thebibliography' environment
-(*note thebibliography::). Instead, you include the lines
+As described in 'thebibliography' (*note thebibliography::), a
+sophisticated approach to managing bibliographies is provided by the
+BibTeX program. This is only an introduction; see the full
+documentation on CTAN.
+ With BibTeX, you don't use 'thebibliography' (*note
+thebibliography::). Instead, include these lines.
+
\bibliographystyle{BIBSTYLE}
- \bibliography{BIBFILE1,BIBFILE2}
+ \bibliography{BIBFILE1, BIBFILE2, ...}
- The '\bibliographystyle' command does not produce any output of its
-own. Rather, it defines the style in which the bibliography will be
-produced: BIBSTYLE refers to a file BIBSTYLE'.bst', which defines how
-your citations will look. The standard BIBSTYLE names distributed with
-BibTeX are:
+ The BIBSTYLE refers to a file 'BIBSTYLE.bst', which defines how your
+citations will look. The standard BIBSTYLE's distributed with BibTeX
+are:
'alpha'
- Sorted alphabetically. Labels are formed from name of author and
- year of publication.
+ Labels are formed from name of author and year of publication. The
+ bibliographic items are sorted alphabetically.
'plain'
- Sorted alphabetically. Labels are numeric.
+ Labels are integers. Sort the bibliographic items alphabetically.
'unsrt'
Like 'plain', but entries are in order of citation.
'abbrv'
Like 'plain', but more compact labels.
- In addition, numerous other BibTeX style files exist tailored to the
-demands of various publications. See
+Many, many other BibTeX style files exist, tailored to the demands of
+various publications. See CTAN's listing
<http://mirror.ctan.org/biblio/bibtex/contrib>.
The '\bibliography' command is what actually produces the
-bibliography. The argument to '\bibliography' refers to files named
-'BIBFILE1.bib', 'BIBFILE2.bib', ..., which should contain your database
-in BibTeX format. Only the entries referred to via '\cite' and
-'\nocite' will be listed in the bibliography.
+bibliography. Its argument is a comma-separated list, referring to
+files named 'BIBFILE1.bib', 'BIBFILE2.bib', ... These contain your
+database in BibTeX format. This shows a typical entry in that format.
+ @book{latexdps,
+ author = "W.H. Masters and V.E. Johnson",
+ title = "Human Sexual Response",
+ year = "1966",
+ publisher = "Bantam Books",
+ address = "Toronto; New York"
+ }
+
+ Only the bibliographic entries referred to via '\cite' and '\nocite'
+will be listed in the document's bibliography. Thus you can keep all
+your sources together in one file, or a small number of files, and rely
+on BibTeX to include in this document only those that you used.
+
File: latex2e.info, Node: theorem, Next: titlepage, Prev: thebibliography, Up: Environments
@@ -5139,7 +5243,7 @@
'minted'.
A package that provides many more options for verbatim environments
-is 'fancyverb'. Another is 'verbatimbox'.
+is 'fancyvrb'. Another is 'verbatimbox'.
For a list of all the relevant packages, see CTAN.
@@ -5177,7 +5281,7 @@
point, '!'. The second instead uses plus, '+', because the exclamation
point is part of 'literal-text'.
- For typesetting Internet addresses, URL's, the package 'url' provides
+ For typesetting Internet addresses, urls, the package 'url' provides
an option that is better than the '\verb' command, since it allows line
breaks.
@@ -10636,14 +10740,14 @@
'preamble' and 'amendments' and run LaTeX again then the resulting
document shows only the material from 'articles.tex', not the material
from 'preamble.tex' or 'amendments.tex'. Nonetheless, all of the
-auxillary information from the omitted files is still there, including
+auxiliary information from the omitted files is still there, including
the starting page number of the chapter.
If the document preamble does not have '\includeonly' then LaTeX will
include all the files you call for with '\include' commands.
The '\include' command makes a new page. To avoid that, see *note
-\input:: (which, however, does not retain the auxillary information).
+\input:: (which, however, does not retain the auxiliary information).
File names can involve paths.
@@ -11462,7 +11566,7 @@
* at clause, in font definitions: \newfont. (line 19)
* author, for titlepage: \maketitle. (line 12)
* auxiliary file: Output files. (line 33)
-* babel package: thebibliography. (line 28)
+* babel package: thebibliography. (line 53)
* babel package <1>: Accents. (line 6)
* background, colored: Colored pages. (line 6)
* backslash, in text: Text symbols. (line 73)
@@ -11532,7 +11636,7 @@
* circumflex accent: Accents. (line 33)
* circumflex accent, math: Math accents. (line 32)
* circumflex, ASCII, in text: Text symbols. (line 64)
-* citation key: \bibitem. (line 16)
+* citation key: \bibitem. (line 15)
* class and package commands: Class and package commands.
(line 6)
* class and package difference: Class and package construction.
@@ -11708,8 +11812,8 @@
* external files, writing: filecontents. (line 6)
* families, of fonts: Low-level font commands.
(line 21)
-* fancyverb package: verbatim. (line 37)
* fancyvrb package: tabbing. (line 145)
+* fancyvrb package <1>: verbatim. (line 37)
* feminine ordinal symbol: Text symbols. (line 135)
* figure number, cross referencing: \ref. (line 6)
* figures, footnotes in: minipage. (line 112)
@@ -12009,7 +12113,7 @@
* package, amsmath <1>: displaymath. (line 22)
* package, amsmath <2>: theorem. (line 28)
* package, amsthm: theorem. (line 28)
-* package, babel: thebibliography. (line 28)
+* package, babel: thebibliography. (line 53)
* package, babel <1>: Accents. (line 6)
* package, cleveref: Cross references. (line 38)
* package, cprotect: verbatim. (line 26)
@@ -12018,8 +12122,8 @@
* package, enumitem: list. (line 247)
* package, etoolbox: Class and package commands.
(line 110)
-* package, fancyverb: verbatim. (line 37)
* package, fancyvrb: tabbing. (line 145)
+* package, fancyvrb <1>: verbatim. (line 37)
* package, flafter: Floats. (line 82)
* package, float: Floats. (line 52)
* package, footmisc: Footnotes in section headings.
@@ -12447,7 +12551,6 @@
* \bibitem: \bibitem. (line 6)
* \bibliography: Using BibTeX. (line 6)
* \bibliographystyle: Using BibTeX. (line 6)
-* \bibname: thebibliography. (line 22)
* \bigcap: Math symbols. (line 58)
* \bigcirc: Math symbols. (line 62)
* \bigcup: Math symbols. (line 66)
@@ -13079,7 +13182,6 @@
* \Re: Math symbols. (line 571)
* \ref: \ref. (line 6)
* \reflectbox: \scalebox. (line 6)
-* \refname: thebibliography. (line 25)
* \refstepcounter: \refstepcounter. (line 6)
* \renewenvironment: \newenvironment & \renewenvironment.
(line 6)
@@ -13636,179 +13738,179 @@
Node: quotation & quote165747
Node: tabbing166646
Node: table172651
-Node: tabular174675
-Node: \multicolumn181925
-Node: \vline185810
-Node: \cline187155
-Node: \hline187839
-Node: thebibliography188521
-Node: \bibitem190021
-Node: \cite190804
-Node: \nocite191339
-Node: Using BibTeX191605
-Node: theorem193114
-Node: titlepage194036
-Node: verbatim195309
-Node: \verb196820
-Node: verse198290
-Node: Line breaking199018
-Node: \\200115
-Node: \obeycr & \restorecr201153
-Node: \newline201555
-Node: \- (hyphenation)202389
-Node: \discretionary203004
-Node: \fussy203296
-Node: \sloppy203686
-Node: \hyphenation204013
-Node: \linebreak & \nolinebreak204638
-Node: Page breaking205290
-Node: \cleardoublepage205898
-Node: \clearpage206327
-Node: \newpage206624
-Node: \enlargethispage206855
-Node: \pagebreak & \nopagebreak207382
-Node: Footnotes208076
-Node: \footnote209330
-Node: \footnotemark211141
-Node: \footnotetext212385
-Node: Footnotes in a table212875
-Node: Footnotes in section headings214732
-Node: Footnotes of footnotes215588
-Node: Multiple reference to footnotes216355
-Node: Footnote parameters217213
-Node: Definitions217963
-Node: \newcommand & \renewcommand218840
-Node: \providecommand223086
-Node: \newcounter223747
-Node: \newlength224898
-Node: \newsavebox225544
-Node: \newenvironment & \renewenvironment226154
-Node: \newtheorem230885
-Node: \newfont234358
-Node: \protect235653
-Node: \ignorespaces & \ignorespacesafterend238039
-Node: Counters240788
-Node: \alph \Alph \arabic \roman \Roman \fnsymbol242461
-Node: \usecounter245290
-Node: \value246153
-Node: \setcounter247082
-Node: \addtocounter247684
-Node: \refstepcounter248149
-Node: \stepcounter248807
-Node: \day \month \year249149
-Node: Lengths249694
-Node: Units of length251484
-Node: \setlength252978
-Node: \addtolength253382
-Node: \settodepth253700
-Node: \settoheight253991
-Node: \settowidth254288
-Node: Predefined lengths254596
-Node: Making paragraphs255111
-Node: \indent255683
-Node: \noindent256145
-Node: \parskip256654
-Node: Marginal notes256912
-Node: Math formulas258724
-Node: Subscripts & superscripts260508
-Node: Math symbols261846
-Node: Math functions287175
-Node: Math accents288118
-Node: Spacing in math mode289090
-Node: Math miscellany290557
-Node: Modes293107
-Node: \ensuremath294947
-Node: Page styles295863
-Node: \maketitle296357
-Node: \pagenumbering297427
-Node: \pagestyle297923
-Node: \thispagestyle299064
-Node: Spaces299370
-Node: \hspace300240
-Node: \hfill301195
-Node: \spacefactor301587
-Node: \(SPACE) and \@304299
-Ref: \AT304442
-Node: \frenchspacing305919
-Node: \normalsfcodes306535
-Node: \(SPACE) after control sequence306724
-Node: \thinspace307635
-Node: \/307955
-Node: \hrulefill \dotfill309137
-Node: \addvspace310130
-Node: \bigskip \medskip \smallskip311176
-Node: \vfill312068
-Node: \vspace312937
-Node: Boxes313930
-Node: \mbox314642
-Node: \fbox and \framebox314929
-Node: lrbox315733
-Node: \makebox316091
-Node: \parbox316811
-Node: \raisebox318922
-Node: \savebox319535
-Node: \sbox319950
-Node: \usebox320399
-Node: Color320660
-Node: Color package options321504
-Node: Color models323150
-Node: Commands for color325459
-Node: Define colors325874
-Node: Colored text326589
-Node: Colored boxes328964
-Node: Colored pages330403
-Node: Graphics331096
-Node: Graphics package options333223
-Node: Graphics package configuration335979
-Node: \graphicspath336781
-Node: \DeclareGraphicsExtensions339704
-Node: \DeclareGraphicsRule341501
-Node: Commands for graphics344690
-Node: \includegraphics345195
-Node: \rotatebox358164
-Node: \scalebox360959
-Node: \resizebox362011
-Node: Special insertions363203
-Node: Reserved characters364007
-Node: Upper and lower case365208
-Node: Symbols by font position367123
-Node: Text symbols367743
-Node: Accents371191
-Node: Additional Latin letters373733
-Ref: Non-English characters373904
-Node: \rule374921
-Node: \today375350
-Node: Splitting the input376104
-Node: \endinput377481
-Node: \include & \includeonly378748
-Node: \input382765
-Node: Front/back matter383473
-Node: Tables of contents383678
-Node: \addcontentsline384739
-Node: \addtocontents385757
-Node: Glossaries386290
-Node: Indexes386809
-Node: Letters388442
-Node: \address392120
-Node: \cc392990
-Node: \closing393408
-Node: \encl393719
-Node: \location394134
-Node: \makelabels394403
-Node: \name395404
-Node: \opening395634
-Node: \ps395974
-Node: \signature396263
-Node: \telephone397355
-Node: Terminal input/output397720
-Node: \typein397985
-Node: \typeout398570
-Node: Command line399193
-Node: Document templates400145
-Node: beamer template400552
-Node: book template401203
-Node: tugboat template401571
-Node: Concept Index403935
-Node: Command Index468222
+Node: tabular174676
+Node: \multicolumn181926
+Node: \vline185811
+Node: \cline187156
+Node: \hline187840
+Node: thebibliography188522
+Node: \bibitem190935
+Node: \cite193217
+Node: \nocite194874
+Node: Using BibTeX195363
+Node: theorem197310
+Node: titlepage198232
+Node: verbatim199505
+Node: \verb201015
+Node: verse202484
+Node: Line breaking203212
+Node: \\204309
+Node: \obeycr & \restorecr205347
+Node: \newline205749
+Node: \- (hyphenation)206583
+Node: \discretionary207198
+Node: \fussy207490
+Node: \sloppy207880
+Node: \hyphenation208207
+Node: \linebreak & \nolinebreak208832
+Node: Page breaking209484
+Node: \cleardoublepage210092
+Node: \clearpage210521
+Node: \newpage210818
+Node: \enlargethispage211049
+Node: \pagebreak & \nopagebreak211576
+Node: Footnotes212270
+Node: \footnote213524
+Node: \footnotemark215335
+Node: \footnotetext216579
+Node: Footnotes in a table217069
+Node: Footnotes in section headings218926
+Node: Footnotes of footnotes219782
+Node: Multiple reference to footnotes220549
+Node: Footnote parameters221407
+Node: Definitions222157
+Node: \newcommand & \renewcommand223034
+Node: \providecommand227280
+Node: \newcounter227941
+Node: \newlength229092
+Node: \newsavebox229738
+Node: \newenvironment & \renewenvironment230348
+Node: \newtheorem235079
+Node: \newfont238552
+Node: \protect239847
+Node: \ignorespaces & \ignorespacesafterend242233
+Node: Counters244982
+Node: \alph \Alph \arabic \roman \Roman \fnsymbol246655
+Node: \usecounter249484
+Node: \value250347
+Node: \setcounter251276
+Node: \addtocounter251878
+Node: \refstepcounter252343
+Node: \stepcounter253001
+Node: \day \month \year253343
+Node: Lengths253888
+Node: Units of length255678
+Node: \setlength257172
+Node: \addtolength257576
+Node: \settodepth257894
+Node: \settoheight258185
+Node: \settowidth258482
+Node: Predefined lengths258790
+Node: Making paragraphs259305
+Node: \indent259877
+Node: \noindent260339
+Node: \parskip260848
+Node: Marginal notes261106
+Node: Math formulas262918
+Node: Subscripts & superscripts264702
+Node: Math symbols266040
+Node: Math functions291369
+Node: Math accents292312
+Node: Spacing in math mode293284
+Node: Math miscellany294751
+Node: Modes297301
+Node: \ensuremath299141
+Node: Page styles300057
+Node: \maketitle300551
+Node: \pagenumbering301621
+Node: \pagestyle302117
+Node: \thispagestyle303258
+Node: Spaces303564
+Node: \hspace304434
+Node: \hfill305389
+Node: \spacefactor305781
+Node: \(SPACE) and \@308493
+Ref: \AT308636
+Node: \frenchspacing310113
+Node: \normalsfcodes310729
+Node: \(SPACE) after control sequence310918
+Node: \thinspace311829
+Node: \/312149
+Node: \hrulefill \dotfill313331
+Node: \addvspace314324
+Node: \bigskip \medskip \smallskip315370
+Node: \vfill316262
+Node: \vspace317131
+Node: Boxes318124
+Node: \mbox318836
+Node: \fbox and \framebox319123
+Node: lrbox319927
+Node: \makebox320285
+Node: \parbox321005
+Node: \raisebox323116
+Node: \savebox323729
+Node: \sbox324144
+Node: \usebox324593
+Node: Color324854
+Node: Color package options325698
+Node: Color models327344
+Node: Commands for color329653
+Node: Define colors330068
+Node: Colored text330783
+Node: Colored boxes333158
+Node: Colored pages334597
+Node: Graphics335290
+Node: Graphics package options337417
+Node: Graphics package configuration340173
+Node: \graphicspath340975
+Node: \DeclareGraphicsExtensions343898
+Node: \DeclareGraphicsRule345695
+Node: Commands for graphics348884
+Node: \includegraphics349389
+Node: \rotatebox362358
+Node: \scalebox365153
+Node: \resizebox366205
+Node: Special insertions367397
+Node: Reserved characters368201
+Node: Upper and lower case369402
+Node: Symbols by font position371317
+Node: Text symbols371937
+Node: Accents375385
+Node: Additional Latin letters377927
+Ref: Non-English characters378098
+Node: \rule379115
+Node: \today379544
+Node: Splitting the input380298
+Node: \endinput381675
+Node: \include & \includeonly382942
+Node: \input386959
+Node: Front/back matter387667
+Node: Tables of contents387872
+Node: \addcontentsline388933
+Node: \addtocontents389951
+Node: Glossaries390484
+Node: Indexes391003
+Node: Letters392636
+Node: \address396314
+Node: \cc397184
+Node: \closing397602
+Node: \encl397913
+Node: \location398328
+Node: \makelabels398597
+Node: \name399598
+Node: \opening399828
+Node: \ps400168
+Node: \signature400457
+Node: \telephone401549
+Node: Terminal input/output401914
+Node: \typein402179
+Node: \typeout402764
+Node: Command line403387
+Node: Document templates404339
+Node: beamer template404746
+Node: book template405397
+Node: tugboat template405765
+Node: Concept Index408129
+Node: Command Index472416
End Tag Table
Modified: trunk/latex2e.pdf
===================================================================
(Binary files differ)
Modified: trunk/latex2e.texi
===================================================================
--- trunk/latex2e.texi 2018-05-28 20:44:46 UTC (rev 631)
+++ trunk/latex2e.texi 2018-05-29 16:38:49 UTC (rev 632)
@@ -6068,43 +6068,59 @@
@example
\begin@{thebibliography@}@{@var{widest-label}@}
-\bibitem[@var{label}]@{@var{cite_key@}}
-...
+ \bibitem[@var{label}]@{@var{cite_key@}}
+ ...
\end@{thebibliography@}
@end example
-Produce a bibliography or reference list.
+Produce a bibliography or reference list. There are two ways to produce
+bibliographic lists. This environment is suitable when you have only a
+few references and can maintain the list by hand. @xref{Using BibTeX}
+for a more sophisticated approach.
-In the @code{article} class, this list is labelled @samp{References} and
-the label is stored in macro @code{\refname}; in the @code{report}
-class, it is labelled @samp{Bibliography} and the label is stored in
-macro @code{\bibname}.
+This shows the environment with two entries.
-Change the label by redefining the command @code{\refname} or
- at code{\bibname}, whichever is applicable depending on the class:
+ at example
+This work is based on \cite@{latexdps@}.
+Together they are \cite@{latexdps, texbook@}.
+ ...
+\begin@{thebibliography@}@{9@}
+\bibitem@{latexdps@}
+ Leslie Lamport.
+ \textit@{\LaTeX@{@}: a document preparation system@}.
+ Addison-Wesley, Reading, Massachusetts, 1993.
+\bibitem@{texbook@}
+ Donald Ervin Knuth.
+ \textit@{The \TeX book@}.
+ Addison-Wesley, Reading, Massachusetts, 1983.
+\end@{thebibliography@}
+ at end example
- at itemize
- at item
- at findex \bibname
-For standard classes whose top level sectioning is @code{\chapter}
-(such as @file{book} and @file{report}), the label is in the macro
- at code{\bibname};
+This styles the first reference as @samp{[1] Leslie ...}, and so that
+ at code{\cite@{latexdps@}} produces the matching @samp{... based on [1]}.
+The second @code{\cite} produces @samp{[1, 2]}. You must compile the
+document twice to resolve these references.
- at item
- at findex \refname
-For standard classes whose the top level sectioning is @code{\section}
-(such as @file{article}), the label is in macro @code{\refname}.
- at end itemize
+The mandatory argument @var{widest-label} is text that, when typeset, is
+as wide as the widest item label produced by the @code{\bibitem}
+commands. The tradition is to use @code{9} for bibliographies with less
+than 10 references, @code{99} for ones with less than 100, etc.
+The bibliographic list is headed by a title such as @samp{Bibliography}.
+To change it there are two cases. In the @file{book} and @file{report}
+classes, where the top level sectioning is @code{\chapter} and the
+default title is @samp{Bibliography}, that title is in the macro
+ at code{\bibname}. For @file{article}, where the class's top level
+sectioning is @code{\section} and the default is @samp{References}, the
+title is in macro @code{\refname}. Change it by redefining the command,
+as with @code{\renewcommand@{\refname@}@{Cited references@}} after
+ at code{\begin@{document@}}.
+
@PkgIndex{babel}
-Language support packages such as @file{babel} will redefine
- at code{\refname} or @code{\bibname}.
+Language support packages such as @file{babel} will automatically
+redefine @code{\refname} or @code{\bibname} to fit the selected
+language.
-The mandatory @var{widest-label} argument is text that, when typeset,
-is as wide as the widest item label produced by the @code{\bibitem}
-commands. It is typically given as @code{9} for bibliographies with
-less than 10 references, @code{99} for ones with less than 100, etc.
-
@menu
* \bibitem:: Specify a bibliography item.
* \cite:: Refer to a bibliography item.
@@ -6130,21 +6146,60 @@
\bibitem[@var{label}]@{@var{cite_key}@}
@end example
-Generate an entry labelled by @var{label}. If the optional @var{label}
-argument is missing then @LaTeX{} automatically generates a number using
-the @code{enumi} counter. The @var{cite_key} is a
+Generate an entry labeled by @var{label}. The default is for @LaTeX{} to
+generates a number using the @code{enumi} counter. The @dfn{citation key}
@cindex citation key
- at dfn{citation key} consisting in any sequence of
-letters, numbers, and punctuation symbols not containing a comma.
+ at var{cite_key} is a string of
+letters, numbers, and punctuation symbols (but not comma).
-This command writes an entry to the @file{.aux} file containing the
-item's @var{cite_key} and @var{label}. When the @file{.aux} file is
-read by the @code{\begin@{document@}} command, the item's @var{label} is
-associated with @code{cite_key}, causing references to @var{cite_key}
-with a @code{\cite} command (@pxref{\cite}) to produce the associated
- at var{label}.
+ at xref{thebibliography} for an example.
+The optional @var{label} changes the default label from an integer to the
+given string. With this
+ at example
+\begin@{thebibliography@}
+\bibitem[Lamport 1993]@{latexdps@}
+ Leslie Lamport.
+ \textit@{\LaTeX@{@}: a document preparation system@}.
+ Addison-Wesley, Reading, Massachusetts, 1993.
+\bibitem@{texbook@}
+ Donald Ervin Knuth.
+ \textit@{The \TeX book@}.
+ Addison-Wesley, Reading, Massachusetts, 1983.
+\end@{thebibliography@}
+ at end example
+
+the first entry will be styled as @samp{[Lamport 1993] Leslie ...} (The
+amount of horizontal space that @LaTeX{} leaves for the label depends on
+the @var{widest-label} argument of the @code{thebibliography}
+environment; see @ref{thebibliography}.) Similarly, @code{... based on
+\cite@{latexdps@}} will produce @samp{... based on [Lamport 1994]}.
+
+If you mix @code{\bibitem} entries having a @var{label} with those that
+do not then @LaTeX{} will number the unlabelled ones sequentially. In
+the example above the @code{texbook} entry will appear as @samp{[1]
+Donald ...}, despite that it is the second entry.
+
+If you use the same @var{cite_key} twice then you get @samp{LaTeX
+Warning: There were multiply-defined labels}.
+
+Under the hood, @LaTeX{} remembers the @var{cite_key} and @var{label}
+information because @code{\bibitem} writes it to the auxiliary file
+ at file{@var{filename}.aux}. For instance, the above example causes
+ at code{\bibcite@{latexdps@}@{Lamport, 1993@}} and
+ at code{\bibcite@{texbook@}@{1@}} to appear in that file. The @file{.aux}
+file is read by the @code{\begin@{document@}} command and then the
+information is available for @code{\cite} commands. This explains why
+you need to run @LaTeX{} twice to resolve references: once to write it
+out and once to read it in.
+
+Because of this two-pass algorithm, when you add a @code{\bibitem} or
+change its @var{cite_key} you may get @samp{LaTeX Warning: Label(s) may
+have changed. Rerun to get cross-references right}. Fix it by
+recompiling.
+
+
@node \cite
@subsection @code{\cite}
@@ -6162,16 +6217,46 @@
\cite[@var{subcite}]@{@var{keys}@}
@end example
-Generate an in-text citation to the references associated with
- at var{keys}, using entries in the @file{.aux} file. The @var{keys}
-argument is a list of one or more citation keys (@pxref{\bibitem}),
-separated by commas.
+Generate as output a citation to the references associated with
+ at var{keys}. The mandatory @var{keys} is a citation key, or a
+comma-separated list of citation keys (@pxref{\bibitem}).
-The text of the optional @var{subcite} argument appears after the
-citation. For example, @code{\cite[p.~314]@{knuth@}} might produce
- at samp{[Knuth, p. at tie{}314]}.
+This
+ at example
+The ultimate source is \cite@{texbook@}.
+ ...
+\begin@{thebibliography@}
+\bibitem@{texbook@}
+ Donald Ervin Knuth.
+ \textit@{The \TeX book@}.
+ Addison-Wesley, Reading, Massachusetts, 1983.
+\end@{thebibliography@}
+ at end example
+produces the output @samp{... source is [1]}.
+
+The optional argument @var{subcite} is appended to the citation. For
+example, @code{See 14.3 in \cite[p.~314]@{texbook@}} might produce
+ at samp{See 14.3 in [1, p. at tie{}314]}.
+
+If @var{keys} is not in your bibliography information then you get
+ at samp{LaTeX Warning: There were undefined references}, and in the output
+the citation shows as a boldface question mark between square brackets.
+There are two possible causes. If you have mistyped something, as in
+ at code{\cite@{texbok@}} then you need to correct the spelling. On the
+other hand, if you have just added or modified the bibliographic
+information and so changed the @file{.aux} file (@pxref{\bibitem}) then
+the fix may be to just run @LaTeX{} again.
+
+In addition to what appears in the output, @code{\cite} writes
+information to the auxiliary file @file{@var{filename}.aux}. For
+instance, @code{\cite@{latexdps@}} writes @samp{\citation@{latexdps@}}
+to that file. This information is used by Bib at TeX{} to include in your
+reference list only those works that you have actually cited; see
+ at ref{\nocite} also.
+
+
@node \nocite
@subsection @code{\nocite}
@@ -6183,10 +6268,15 @@
@code{\nocite@{@var{keys}@}}
@end example
-Produces no text, but writes @var{keys}, which is a list of one or more
-citation keys, to the @file{.aux} file.
+Produces no output but writes @var{keys} to the auxiliary file
+ at file{@var{filename}.aux}.
+The mandatory argument @var{keys} is a comma-separated list of one or
+more citation keys (@pxref{\bibitem}). This information is used by
+Bib at TeX{} to include these works in your reference list even though you
+have not actually cited them (@pxref{\cite}).
+
@node Using BibTeX
@subsection Using Bib at TeX{}
@@ -6196,47 +6286,63 @@
@findex \bibliographystyle
@findex \bibliography
-If you use the Bib at TeX{} program by Oren Patashnik (highly
-recommended if you need a bibliography of more than a couple of
-titles) to maintain your bibliography, you don't use the
- at code{thebibliography} environment (@pxref{thebibliography}). Instead,
-you include the lines
+As described in @code{thebibliography} (@pxref{thebibliography}), a
+sophisticated approach to managing bibliographies is provided by the
+Bib at TeX{} program. This is only an introduction; see the full
+documentation on CTAN.
+With Bib at TeX{}, you don't use @code{thebibliography}
+(@pxref{thebibliography}). Instead, include these lines.
+
@example
\bibliographystyle@{@var{bibstyle}@}
-\bibliography@{@var{bibfile1}, at var{bibfile2}@}
+\bibliography@{@var{bibfile1}, @var{bibfile2}, ...@}
@end example
-The @code{\bibliographystyle} command does not produce any output of
-its own. Rather, it defines the style in which the bibliography will
-be produced: @var{bibstyle} refers to a file
- at var{bibstyle}@file{.bst}, which defines how your citations will look.
-The standard @var{bibstyle} names distributed with Bib at TeX{} are:
+The @var{bibstyle} refers to a file @file{@var{bibstyle}.bst}, which
+defines how your citations will look. The standard @var{bibstyle}'s
+distributed with Bib at TeX{} are:
@table @code
@item alpha
-Sorted alphabetically. Labels are formed from name of author and year of
-publication.
+Labels are formed from name of author and year of publication.
+The bibliographic items are sorted alphabetically.
@item plain
-Sorted alphabetically. Labels are numeric.
+Labels are integers.
+Sort the bibliographic items alphabetically.
@item unsrt
Like @code{plain}, but entries are in order of citation.
@item abbrv
Like @code{plain}, but more compact labels.
@end table
-In addition, numerous other Bib at TeX{} style files exist tailored to
-the demands of various publications. See
+ at noindent Many, many other Bib at TeX{} style files exist,
+tailored to the demands of various publications. See CTAN's listing
@url{http://mirror.ctan.org/biblio/bibtex/contrib}.
The @code{\bibliography} command is what actually produces the
-bibliography. The argument to @code{\bibliography} refers to files
-named @file{@var{bibfile1}.bib}, @file{@var{bibfile2}.bib}, @dots{},
-which should contain your database in
-Bib at TeX{} format. Only the entries referred to via @code{\cite} and
- at code{\nocite} will be listed in the bibliography.
+bibliography. Its argument is a comma-separated list, referring to
+files named @file{@var{bibfile1}.bib}, @file{@var{bibfile2}.bib},
+ at dots{} These contain your database in Bib at TeX{} format. This shows a
+typical entry in that format.
+ at example
+@@book@{latexdps,
+ author = "W.H. Masters and V.E. Johnson",
+ title = "Human Sexual Response",
+ year = "1966",
+ publisher = "Bantam Books",
+ address = "Toronto; New York"
+@}
+ at end example
+Only the bibliographic entries referred to via @code{\cite} and
+ at code{\nocite} will be listed in the document's bibliography. Thus you
+can keep all your sources together in one file, or a small number of
+files, and rely on Bib at TeX{} to include in this document only those that
+you used.
+
+
@node theorem
@section @code{theorem}
More information about the latexrefman-commits
mailing list