summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/bibtex/bibhtml/bibhtml.html
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/bibtex/bibhtml/bibhtml.html')
-rw-r--r--Master/texmf-dist/doc/bibtex/bibhtml/bibhtml.html95
1 files changed, 54 insertions, 41 deletions
diff --git a/Master/texmf-dist/doc/bibtex/bibhtml/bibhtml.html b/Master/texmf-dist/doc/bibtex/bibhtml/bibhtml.html
index ae24e497a0c..d68dfd94d81 100644
--- a/Master/texmf-dist/doc/bibtex/bibhtml/bibhtml.html
+++ b/Master/texmf-dist/doc/bibtex/bibhtml/bibhtml.html
@@ -4,7 +4,7 @@
<title>Bibhtml documentation</title>
<meta name="keywords" content="bibhtml, bibtex, HTML" />
<link href="http://nxg.me.uk" rev="author" />
- <link type="text/css" rel="stylesheet" href="http://nxg.me.uk/style/base.css" />
+ <link type="text/css" rel="stylesheet" href="style.css" />
</head>
<body>
@@ -20,10 +20,10 @@ modelled closely on the standard BibTeX style files.</p>
which illustrate how you might integrate these generated
bibliographies into an XML/HTML workflow.</p>
-<p>The long-term URL for this page is <code>http://purl.org/nxg/dist/bibhtml</code></p>
+<p>The long-term URL for this package is <code>http://purl.org/nxg/dist/bibhtml</code></p>
<p>This documentation describes
-bibhtml version 2.0, released 2009 August 9.</p>
+bibhtml version 2.0.1, released 2009 November 2.</p>
</div>
<h3>Contents</h3>
@@ -40,21 +40,22 @@ bibhtml version 2.0, released 2009 August 9.</p>
<p><em>Bibhtml</em> consists of a set of BibTeX style files, which
allow you to use BibTeX to produce bibliographies in HTML. These are
-modelled closely on the standard BibTeX style files.</p>
+modelled closely on the standard BibTeX style files. For sample output,
+see <a href="#refs">the reference section below</a>.</p>
<p>To accompany them, this package includes a pair of XSLT scripts
which illustrate how you might integrate these generated
bibliographies into an XML/HTML workflow.</p>
<p>The output of these style files is usable as-is, but it benefits
-from some post-processing, to remove TeX-isms. There's a <em>sed</em>
+from some post-processing, to remove TeX-isms. There’s a <em>sed</em>
script in the distribution which does exactly that, called
<code>detex.sed</code>. If you want to make a version of that im some
other regexp-supporting language, let me know and I can include it in
the distribution.</p>
<p>As well,
-it includes a Perl script which orchestrates the various steps
+the package includes a Perl script which orchestrates the various steps
required to manage such a bibliography for one or more HTML files.
The references in the text are linked directly to the corresponding
bibliography entry, and if a URL is defined in the entry within the
@@ -78,7 +79,7 @@ XSLT-based workflow. For further details, see the discussion of the
style files <a href="#bst-files">below</a>.</p>
<p>There is also a Perl script, <em>bibhtml</em>, which can orchestrate generating and using
-this <code>.aux</code> file. This script isn't really maintained any
+this <code>.aux</code> file. This script isn’t really maintained any
more, but it is still distributed, and documented <a href="#usage">below</a>.</p>
<p><em>Bibhtml</em> works with a standard BibTeX database -- it is
@@ -93,9 +94,14 @@ archive, this will be of no interest to you.</p>
<h2><a name="bst-files" id="bst-files">BibTeX style files</a></h2>
<p>The package includes several BibTeX style files. As well as the
-ones directly derived from the standard styles, there are also <code>plainhtmldate.bst</code> and
-<code>plainhtmldater.bst</code>, which are derived from the standard
-<code>plain.bst</code> which sort the
+ones directly derived from the standard styles, there are also
+<code>plainhtmldate.bst</code>,
+<code>plainhtmldater.bst</code>,
+<code>alphahtmldate.bst</code> and
+<code>alphahtmldater.bst</code> styles,
+which are derived from the standard
+<code>plain.bst</code> and <code>alpha.bst</code> styles,
+which sort the
output by date and reverse date, rather than by author.</p>
<p>In version 2 of the <em>bibhtml</em> package, the
@@ -191,7 +197,7 @@ reasonably usable without any post-processing. However it is not
ideal, since there are occasionaly TeX-isms such as backslash-escaped
characters and the like, depending on what is in the source
<code>.bib</code> file. Also, without post-processing any DOIs in
-the source file aren't formed into links.</p>
+the source file aren’t formed into links.</p>
<p>The distribution includes a <code>sed</code> file,
<code>detex.sed</code>, which can do appropriate post-processing.
@@ -203,28 +209,31 @@ Thus the normal workflow is:</p>
</pre>
<p>Since it uses <code>sed</code>, this is fairly obviously
unix-specific, but if anyone would like to contribute a script with
-similar functionality (it's just a few moderately tortuous regular
-expressions), I'd be delighted to include it in the distribution.</p>
+similar functionality (it’s just a few moderately tortuous regular
+expressions), I’d be delighted to include it in the distribution.</p>
<h2><a name="install" id="install">Installation</a></h2>
<p>The <code>.bst</code> files have to be installed
-<a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=inst-wlcf">&#x2018;somewhere where LaTeX can find them&#x2019;</a>. If you give the command
+<a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=inst-wlcf">‘somewhere where LaTeX can find them’</a>. If you give the command
<code>kpsepath bst</code> you can see the list of directories that
-BibTeX searches for <code>.bst</code> files &#x2013; on my system, I'd put
+BibTeX searches for <code>.bst</code> files – on my system, I’d put
them into <code>/usr/local/texlive/texmf-local/bibtex/bst</code>,
which is a directory for system-wide local additions.</p>
<p>If you wish, you may change the distributed BibTeX style files (see
<a href="#bst-files">above</a>) to the extent of changing the
-`eprint' mirror site from the master <code>xxx.arxiv.org</code> to a
-more local mirror. If you don't use the LANL preprint archive, this
+‘eprint’ mirror site from the master <code>xxx.arxiv.org</code> to a
+more local mirror. If you don’t use the LANL preprint archive, this
will be of no interest to you.</p>
<h2><a name="usage" id="usage">The <em>bibhtml</em> script</a></h2>
-<p>As noted above, this script should still work and is distributed on
-that basis, but it's no longer maintained, and won't be further developed.</p>
+<p>As noted above, <strong>this script should still work and is distributed on
+that basis, but it’s no longer maintained, and won’t be further developed.</strong>
+The XSLT-based mechanism described above is probably more robust;
+also, the interface described in this section is not the same as the interface
+of the <a href="#xslt">XSLT scripts</a> section above.</p>
<h3>The BibTeX database</h3>
@@ -241,7 +250,7 @@ with these in future versions. </p>
composed of the BibTeX citation key. Thus, you might cite [grendel89]
with</p>
<pre>&lt;a href="bibliography.html#grendel89"&gt;(Grendel, 1989)&lt;/a&gt;</pre>
-<p>(of course, the link text can be anything you like). That's all there is to
+<p>(of course, the link text can be anything you like). That’s all there is to
it. When you run <em>bibhtml</em>, it generates an
<code>.aux</code> file which makes BibTeX produce references for exactly those
keys which appear in this way. </p>
@@ -258,7 +267,7 @@ and
<code>&lt;?bibhtml end ?&gt;</code>
(which should be on lines by themselves) with the formatted
bibliography. It leaves those instructions in place, naturally, so once
-this file is set up, you shouldn't have to touch it again. Older
+this file is set up, you shouldn’t have to touch it again. Older
versions of bibhtml used the magic comments <code>&lt;-- bibhtml start
--&gt;</code> and <code>&lt;-- bibhtml end --&gt;</code>: these are
still supported, but are deprecated and may disappear in a future version.</p>
@@ -275,12 +284,12 @@ example), which will not therefore have to be rescanned in future.</p>
the command line (see <a href="#options">below</a>) or using the
<code>&lt;?bibhtml bibdata </code><em>bibfile</em><code>?&gt;</code>
and <code>&lt;?bibhtml bibstyle</code><em>stylefile</em><code>?&gt;</code> instructions. The
-value of `bibdata' is cumulative, and appends to any value specified
-on the command line. A value of `bibstyle' specified on the command
+value of ‘bibdata’ is cumulative, and appends to any value specified
+on the command line. A value of ‘bibstyle’ specified on the command
line, in contrast, overrides any value in the file.</p>
<p>As a special case, <em>bibhtml</em> also replaces the line <em>after</em> a
-comment <code>&lt;?bibhtml today ?&gt;</code> with today's date.</p>
+comment <code>&lt;?bibhtml today ?&gt;</code> with today’s date.</p>
<p>Summary of processing instructions:</p>
@@ -307,7 +316,7 @@ of <code>\bibliographystyle{</code><em>stylefile</em><code>}</code>
command in a LaTex file; see also the <code>-s</code> command-line option.</dd>
<dt><code>&lt;?bibhtml today?&gt;</code></dt>
-<dd>Replace the <em>following</em> line by today's date.</dd>
+<dd>Replace the <em>following</em> line by today’s date.</dd>
</dl>
<h3><a name="options" id="options">Supported options</a></h3>
@@ -332,17 +341,17 @@ whatever has been specified as the bibliography file name. </p>
<dd>Set this to +3 if you want <code>~</code> translated to
<code>&amp;nbsp;</code>, and <code>--</code> to
<code>&amp;enspace;</code>. Or set it to -3 (the default) if you
-don't.</dd>
+don’t.</dd>
<dt>-a</dt>
-<dd>If this option is set, <em>bibhtml</em> won't bother scanning any
+<dd>If this option is set, <em>bibhtml</em> won’t bother scanning any
files at all, and will generate references for all the entries in your
database. This is equivalent to <code>\nocite{*}</code> in LaTeX.</dd>
<dt>-b bibdata</dt>
<dd>The name of your BibTeX database file, as it would be specified in a
<code>\bibliography{}</code> command in LaTeX. Unless <em>you</em> happen to
-keep all your references in a file called <code>bib.bib</code>, you'll
+keep all your references in a file called <code>bib.bib</code>, you’ll
probably want to change this. Or you can use the <code>&lt;?bibhtml
bibdata xxx?&gt;</code> <a href="#pis">processing instruction</a>.</dd>
@@ -353,7 +362,7 @@ options, which are inserted in the command line at that point.</dd>
<dt><a name="merge" id="merge">--merge</a></dt>
<dd>In this special case, <em>bibhtml</em> takes two arguments, a
<code>.bbl</code> file and an <code>.html</code> file,
-merges the first into the second, and nothing else. It's
+merges the first into the second, and nothing else. It’s
intended to be used when you have generated a
<code>.bbl</code> file by a separate run of BibTeX, and simply
wish to merge the results into your bibliography file. As
@@ -361,15 +370,15 @@ such, it will most likely be useful as part of a script, or
other post-processing system.</dd>
<dt>-r rootname</dt>
-<dd>Specify this and you'll create <code>rootname.html</code>,
+<dd>Specify this and you’ll create <code>rootname.html</code>,
<code>rootname.aux</code> and so on. Why not just stick with the default
-`bibliography'...? </dd>
+‘bibliography’...? </dd>
<dt><a name="opt-s" id="opt-s">-s bibstyle</a></dt>
<dd>The name of the BibTeX bibliography style you want to use, as it
would be specified for the <code>\bibstyle</code> command in
LaTeX. If you want to have a different layout for your HTML
-bibliographies, please don't change the file plainhtml.bst
+bibliographies, please don’t change the file plainhtml.bst
distributed with bibhtml. Instead, make a <em>copy</em> of
plainhtml.bst under a different name, edit it as much as you
like, and use this option of bibhtml to use the modified
@@ -392,8 +401,8 @@ verbose.</dd>
</dl>
<p>The defaults for the various parameters are unlikely to be helpful,
-so you're likely to want to set one or more of them every time you run
-the program. It is for this reason, and because you're likely to want
+so you’re likely to want to set one or more of them every time you run
+the program. It is for this reason, and because you’re likely to want
the same set of options every time you create the bibliography for a
set of files in a directory, that you can put a collection of options
in a configuration file. This can be specified on the command line
@@ -426,9 +435,10 @@ platforms. If so, please get in touch, with suggestions. </p>
<h2><a name="example" id="example">Example</a></h2>
<p>There are multiple sources of advice for how to cite electronic
-documents. The most formal are an ISO standard <a href="#url:iso690"><span class="cite">url:iso690</span></a>, and the American Psychological
-Association's guidance in Sect. 6.31 of <a href="#apastyle"><span class="cite">apastyle</span></a>. As well, there are older, but still
-useful discussions in <a href="#walker06"><span class="cite">walker06</span></a> and <a href="#emory95"><span class="cite">emory95</span></a>.</p>
+documents. The most formal are an ISO standard <h:a xmlns:h="http://www.w3.org/1999/xhtml" href="#url:iso690"><span class="cite">url:iso690</span></h:a>, and the American Psychological
+Association’s guidance in Sect. 6.31 of <h:a xmlns:h="http://www.w3.org/1999/xhtml" href="#apastyle"><span class="cite">apastyle</span></h:a>. As well, there are older but still
+useful discussions in <h:a xmlns:h="http://www.w3.org/1999/xhtml" href="#walker06"><span class="cite">walker06</span></h:a> and
+<h:a xmlns:h="http://www.w3.org/1999/xhtml" href="#emory95"><span class="cite">emory95</span></h:a>.</p>
<h2><a name="refs" id="refs">References</a></h2>
@@ -474,11 +484,11 @@ and at
<a href="http://purl.org/nxg/dist/bibhtml"><code>http://purl.org/nxg/dist/bibhtml</code></a>.</p>
<p>Download the distribution:
-<a href="bibhtml-2.0.tar.gz">bibhtml-2.0.tar.gz</a> or
-<a href="bibhtml-2.0.zip">bibhtml-2.0.zip</a>.</p>
+<a href="bibhtml-2.0.1.tar.gz">bibhtml-2.0.1.tar.gz</a> or
+<a href="bibhtml-2.0.1.zip">bibhtml-2.0.1.zip</a>.</p>
<p>Do <a href="mailto:norman@astro.gla.ac.uk">let me know</a> if
-you use this stuff. I'd be grateful for any bug reports,
+you use this stuff. I’d be grateful for any bug reports,
and bug fixes, and also for any comments on the clarity or
otherwise of this documentation.</p>
@@ -501,6 +511,9 @@ online copy of the GPL at <code><a href="http://www.gnu.org/copyleft/gpl.html">h
<dl>
+<dt>2.0.1, 2009 November 2</dt>
+<dd>The *date.bst and *dater.bst styles now work again.</dd>
+
<dt>2.0, 2009 August 9</dt>
<dd>First real release of v2.0, after mild use elsewhere.</dd>
@@ -555,7 +568,7 @@ inserts the bibliography in-place.</li>
<div class="signature">
<a href="http://nxg.me.uk">Norman</a><br />
-2009 August 9
+2009 November 2
</div>
</body>