summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2006-12-26 22:53:22 +0000
committerKarl Berry <karl@freefriends.org>2006-12-26 22:53:22 +0000
commit88b0c2e69866fb0ba56d9fd5d081107ca00af9fc (patch)
tree2a40a0b5c3e3f4bc7009646b12358bdbb121a159 /Master/texmf-dist/doc
parentc0c470acc33af982c6e6eb3b48dfa957010e8239 (diff)
bibhtml update
git-svn-id: svn://tug.org/texlive/trunk@2942 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc')
-rwxr-xr-xMaster/texmf-dist/doc/latex/bibhtml/bibhtml4
-rw-r--r--Master/texmf-dist/doc/latex/bibhtml/bibhtml.html183
-rw-r--r--Master/texmf-dist/doc/latex/bibhtml/bibhtml.xslt55
3 files changed, 170 insertions, 72 deletions
diff --git a/Master/texmf-dist/doc/latex/bibhtml/bibhtml b/Master/texmf-dist/doc/latex/bibhtml/bibhtml
index 4a1c9104be8..4d645bba496 100755
--- a/Master/texmf-dist/doc/latex/bibhtml/bibhtml
+++ b/Master/texmf-dist/doc/latex/bibhtml/bibhtml
@@ -32,7 +32,7 @@
use strict;
-my $version = 'Bibhtml, version 1.2, Norman Gray <norman@astro.gla.ac.uk>, 2005 September 19';
+my $version = 'Bibhtml, version 1.3, Norman Gray <norman@astro.gla.ac.uk>, 2006 October 31';
# configuration...
@@ -439,7 +439,7 @@ sub readconfig {
sub printhelp {
print STDOUT <<\_EOD;
-This is bibhtml version 1.2, 2005 September 19.
+This is bibhtml version 1.3, 2006 October 31.
Usage:
% bibhtml [options...] filename...
diff --git a/Master/texmf-dist/doc/latex/bibhtml/bibhtml.html b/Master/texmf-dist/doc/latex/bibhtml/bibhtml.html
index 5d3286e4a58..0c76961e2b1 100644
--- a/Master/texmf-dist/doc/latex/bibhtml/bibhtml.html
+++ b/Master/texmf-dist/doc/latex/bibhtml/bibhtml.html
@@ -1,17 +1,15 @@
-<?xml version="1.0"?> <!-- -*- xml -*- -->
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
- "xhtml1/xhtml1-strict.dtd"
- >
+<?xml version="1.0"?> <!-- -*- nxml -*- -->
-<!-- $Id: bibhtml.html.in,v 1.7 2005/09/19 16:08:41 norman Exp $ -->
+<!-- $Id: bibhtml.html.in,v 1.10 2006/10/31 15:39:36 norman Exp $ -->
-<html>
+<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Bibhtml documentation</title>
<meta name="keywords" content="bibhtml, bibtex, HTML"/>
- <link href="http://www.astro.gla.ac.uk/users/norman/" rev="author"/>
- <link type="text/css" rel="stylesheet"
- href="http://www.astro.gla.ac.uk/users/norman/style.css"/>
+ <link href="http://nxg.me.uk" rev="author"/>
+ <link type="text/css"
+ rel="stylesheet"
+ href="http://nxg.me.uk/style/base.css"/>
</head>
<body>
@@ -19,30 +17,32 @@
<h1>Bibhtml</h1>
<div class='abstract'>
-<p><em>Bibhtml</em> consists of a Perl script and a BibTeX style
-file, which together allow you to compile a bibliography for a
-collection of 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 BibTeX database file, then the
-generated bibliography entry is linked to this.</p>
+<p><em>Bibhtml</em> consists of a set of BibTeX style files, which
+allow you to use BibTeX to produce bibliographies in HTML. As well,
+it 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
+BibTeX database file, then the generated bibliography entry is linked
+to this.</p>
<p>This page is <code>http://purl.org/nxg/dist/bibhtml</code></p>
<p>This documentation describes
-<em>bibhtml, version 1.2, 2005 September 19</em>.</p>
+<em>bibhtml, version 1.3, 2006 October 31</em>.</p>
</div>
<h3>Contents</h3>
<ul>
-<li><a href='#usage'>Usage</a>
+<li><a href='#usage'>Running <em>bibhtml</em></a>
<ul>
<li>The BibTeX database</li>
<li>Preparing the text</li>
<li><a href='#pis' >Preparing the bibliography file -- processing
instructions supported</a></li>
-<li><a href='#bst-files'>BibTeX style files</a></li>
+<li><a href='#options'>Supported options</a></li>
</ul></li>
-<li><a href='#running'>Running <em>bibhtml</em> -- options</a></li>
+<li><a href='#bst-files'>BibTeX style files</a></li>
<li><a href='#install'>Installation</a></li>
<li><a href='#two-pass'>Two-pass bibhtml</a></li>
<li><a href='#example'>Example</a></li>
@@ -56,28 +56,33 @@ instructions supported</a></li>
</li>
</ul>
-
-
-<p><em>Bibhtml</em> consists of a Perl script and a number of BibTeX style
-files, which together allow you to compile a bibliography for a
-collection of 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 BibTeX database file, then the
-generated bibliography entry is linked to this.</p>
+<p><em>Bibhtml</em> consists of a set of BibTeX style files, which
+allow you to use BibTeX to produce bibliographies in HTML. As well,
+it 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
+BibTeX database file, then the generated bibliography entry is linked
+to this.</p>
<p>The BibTeX style files are <code>plainhtml.bst</code> and
<code>alphahtml.bst</code>, which are derived from the standard files
<code>plain.bst</code> and <code>alpha.bst</code>. As well, there are
-<code>.bst</code> files which produce their output in date order (see
-<a href="#bst-files" >below</a>). You can specify these to
-<em>bibhtml</em> using either the <a href="#opt-s"><code>-s</code>
-option</a> or the processing instructions described <a href="#pis"
->below</a>.</p>
-
-<p>The BibTeX style files distributed as part of this package are also
-of considerable use in isolation.</p>
-
-<h2><a name='usage'>Usage</a></h2>
+<code>.bst</code> files which produce their output in date order. To
+use them, you should generate an <code>.aux</code> file by some
+appropriate means, and include the line
+<code>\bibstyle{plainhtml}</code>. Run BibTeX, and the result is a
+<code>.bbl</code> file, in broadly the `plain' style, but formatted
+using HTML rather than LaTeX. This might form a useful component of a
+XSLT-based workflow. For further details, see the discussion of the
+style files <a href="#bst-files" >below</a>.</p>
+
+<p>The <em>bibhtml</em> script can orchestrate generating and using
+this <code>.aux</code> file, and you can specify the style file to use
+either with the <a href="#opt-s"><code>-s</code> option</a>, or with
+the processing instructions described <a href="#pis" >below</a>.</p>
+
+<h2><a name='usage'>Running <em>bibhtml</em></a></h2>
<h3>The BibTeX database</h3>
@@ -134,7 +139,7 @@ generated file (perhaps the output of a separate XML tool-chain, for
example), which will not therefore have to be rescanned in future.</p>
<p>You can specify the bibliography database and style file either on
-the command line (see <a href="#running" >below</a>) or using the
+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
@@ -172,32 +177,7 @@ command in a LaTex file; see also the <code>-s</code> command-line option.</dd>
<dd>Replace the <em>following</em> line by today's date.</dd>
</dl>
-<h3><a name='bst-files'>BibTeX style files</a></h3>
-
-<p><em>bibhtml</em> depends on several BibTeX style files.
-<code>plainhtml.bst</code>, <code>plainhtmldate.bst</code> and
-<code>plainhtmldater.bst</code> are derived from the standard
-<code>plain.bst</code>. All produce HTML, but the latter two sort the
-output by date and reverse date, rather than by author.
-<code>alphahtml.bst</code> and friends were derived from the standard
-<code>alpha.bst</code>, and contributed to the package, by Franz
-G. Fischer, <code>Franz.Fischer@lpr.e-technik.tu-muenchen.de</code>,
-to whom thanks are due.</p>
-
-<p>These style files support an additional entry type,
-<code>@webpage</code>, and two additional fields on all entry types,
-<code>url</code> and <code>lastchecked</code>, which give the URL
-associated with the reference, and the date at which the URL was last
-verified to be still present. See also the <a
-href="http://purl.org/nxg/dist/urlbst" ><code>urlbst</code>
-package</a>, which performs a different role, but implements the same
-BibTeX extensions.</p>
-
-<p>Although these style files are distributed as part of
-<em>bibhtml</em> they are also useful in isolation, as part of a
-larger system which generates HTML.</p>
-
-<h2><a name='running'>Running <em>bibhtml</em> -- options</a></h2>
+<h3><a name='options'>Supported options</a></h3>
<p><em>Usage</em></p>
<pre>
@@ -293,6 +273,62 @@ file might contain:</p>
-b mybib +3 -r refs
</pre>
+<h2><a name='bst-files'>BibTeX style files</a></h2>
+
+<p><em>bibhtml</em> depends on several BibTeX style files.
+<code>plainhtml.bst</code>, <code>plainhtmldate.bst</code> and
+<code>plainhtmldater.bst</code> are derived from the standard
+<code>plain.bst</code>. All produce HTML, but the latter two sort the
+output by date and reverse date, rather than by author.
+<code>alphahtml.bst</code> and friends were derived from the standard
+<code>alpha.bst</code>, and contributed to the package, by Franz
+G. Fischer, <code>Franz.Fischer@lpr.e-technik.tu-muenchen.de</code>,
+to whom thanks are due.</p>
+
+<p>These style files support an additional entry type,
+<code>@webpage</code>, and two additional fields on all entry types,
+<code>url</code> and <code>lastchecked</code>, which give the URL
+associated with the reference, and the date at which the URL was last
+verified to be still present. See also the <a
+href="http://purl.org/nxg/dist/urlbst" ><code>urlbst</code>
+package</a>, which performs a different role, but implements the same
+BibTeX extensions.</p>
+
+<p>Although these style files are distributed as part of
+<em>bibhtml</em> they are also useful in isolation, as part of a
+larger system which generates HTML.</p>
+
+<p>The distribution includes a sample XSLT script,
+<code>bibhtml.xslt</code> which shows how you might use XSLT to
+extract citations from a source file into an <code>.aux</code>
+file.</p>
+
+<p>The distributed <code>.bst</code> files have two configurable
+parameters, which you might want to adjust for your installation:</p>
+
+<p>The variable <code>'xxxmirror</code> gives the host name of the arXiv mirror which will be used
+when generating links to eprints. The default setting in the
+<code>.bst</code> files is:</p>
+<pre>
+"xxx.arxiv.org" 'xxxmirror :=
+</pre>
+
+<p>By default, the style files generate link targets in the
+bibliography with the same name as the citation key. Thus a BibTeX
+entry with key <code>surname99</code>, say, would appear in the
+generated HTML <code>.bbl</code> file wrapped in <code>&lt;a
+name="surname99"&gt;...&lt;/a&gt;</code>. If this is inconvenient,
+perhaps because it conflicts with other links within the file,
+then you can adjust the <code>'hrefprefix</code> variable within the
+style file, to specify a prefix which should appear in the link key.
+Thus setting</p>
+<pre>
+"ref:" 'hrefprefix :=
+</pre>
+<p>in the <code>.bst</code> file would produce links like <code>&lt;a
+name="ref:surname99"&gt;...&lt;/a&gt;</code> in the <code>.bbl</code>
+file.</p>
+
<h2><a name='install'>Installation</a></h2>
<p>Nothing to it.... On Unix, for example, put <em>bibhtml</em>
@@ -306,7 +342,7 @@ link with <code>ln -s bibhtml bibhtml2</code>.</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.lanl.gov</code> to a
+`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>
@@ -333,7 +369,7 @@ platforms. If so, please get in touch, with suggestions. </p>
<p>There are multiple sources of advice for how to cite electronic
documents. The most formal are an ISO standard <a
href="bibhtml.html#iso690">[ISO 690-2]</a>, and the American
-Psychological Association's guidance (<a href="bibhtml.html#apa03"
+Psychological Association's guidance <a href="bibhtml.html#apa03"
>[APA 2003]</a>. As well, there are older, but still useful
discussions in
<a href="bibhtml.html#walker95">Walker</a> and
@@ -408,6 +444,14 @@ sources.</p>
<dl>
+<dt>1.3, 2006 October 31</dt>
+<dd><ul>
+<li>Add <code>hrefprefix</code> parameterisation to style files.</li>
+<li><code>xxx.arxiv.org</code> is now the default e-prints host.</li>
+<li>Some improvements to documentation.</li>
+</ul>
+</dd>
+
<dt>1.2, 2005 September 19</dt>
<dd><ul>
<li>Changes to <code>.bst</code> style files, adding
@@ -449,11 +493,10 @@ inserts the bibliography in-place.</li>
<a href="http://www.ctan.org/tex-archive/biblio/bibtex/contrib/bibhtml/"
><code>biblio/bibtex/contrib/bibhtml/</code></a>,
and at
-<code><a href="http://purl.org/nxg/dist/bibhtml"
- >purl.org/nxg/dist/bibhtml</a></code>.</p>
+<a href="http://purl.org/nxg/dist/bibhtml" ><code>@HOMEPAGE</code></a>.</p>
<p>Download the distribution:
-<a href="bibhtml-1.2.tar.gz">bibhtml-1.2.tar.gz</a>.</p>
+<a href="bibhtml-1.3.tar.gz">bibhtml-1.3.tar.gz</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,
@@ -472,7 +515,7 @@ href="http://www.gnu.org/copyleft/gpl.html"
<div class="signature">
<a href="http://purl.org/nxg">Norman</a><br/>
-2005 September 19
+2006 October 31
</div>
</body>
diff --git a/Master/texmf-dist/doc/latex/bibhtml/bibhtml.xslt b/Master/texmf-dist/doc/latex/bibhtml/bibhtml.xslt
new file mode 100644
index 00000000000..0980890f171
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/bibhtml/bibhtml.xslt
@@ -0,0 +1,55 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ ! bibhtml.xslt
+ !
+ ! Part of bibhtml, version 1.3, released 2006 October 31
+ ! See <http://purl.org/nxg/dist/bibhtml>
+ !
+ ! This sample script processes an XML file which contains elements like
+ ! <span class='cite'>citation</span>, extracting each of the `citation'
+ ! strings and emitting a .aux file which, once a \bibdata line has been
+ ! appended, is suitable for processing with BibTeX. Adapt or extend as
+ ! appropriate.
+ !
+ ! $Revision: 1.1 $
+ !-->
+<x:stylesheet xmlns:x="http://www.w3.org/1999/XSL/Transform"
+ version="1.0"
+ exclude-result-prefixes="h"
+ xmlns:h="http://www.w3.org/1999/xhtml">
+
+ <x:output method="xml"
+ version="1.0"
+ doctype-public="-//W3C//DTD XHTML 1.0 Strict//EN"
+ doctype-system="http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"
+ omit-xml-declaration="yes"/>
+
+ <x:template match="/">
+ <x:apply-templates select="//h:span[@class='cite']"/>
+ <x:call-template name="make-tex-command">
+ <x:with-param name="command">bibstyle</x:with-param>
+ <x:with-param name="content">plainhtml</x:with-param>
+ </x:call-template>
+ </x:template>
+
+ <x:template match="h:span[@class='cite']">
+ <x:call-template name="make-tex-command">
+ <x:with-param name="command">citation</x:with-param>
+ <x:with-param name="content">
+ <x:copy-of select="."/>
+ </x:with-param>
+ </x:call-template>
+ </x:template>
+
+ <x:template name="make-tex-command">
+ <x:param name="command"/>
+ <x:param name="content"/>
+ <x:text>\</x:text>
+ <x:value-of select="$command"/>
+ <x:text>{</x:text>
+ <x:value-of select="$content"/>
+ <x:text>}
+</x:text>
+ </x:template>
+
+</x:stylesheet>