summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/bibtex/urlbst/urlbst.html
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/bibtex/urlbst/urlbst.html')
-rw-r--r--Master/texmf-dist/doc/bibtex/urlbst/urlbst.html148
1 files changed, 90 insertions, 58 deletions
diff --git a/Master/texmf-dist/doc/bibtex/urlbst/urlbst.html b/Master/texmf-dist/doc/bibtex/urlbst/urlbst.html
index 1edeadcf3a0..6ee21377103 100644
--- a/Master/texmf-dist/doc/bibtex/urlbst/urlbst.html
+++ b/Master/texmf-dist/doc/bibtex/urlbst/urlbst.html
@@ -3,7 +3,7 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Urlbst</title>
-<link href="http://nxg.me.uk/" rev="author"/>
+<link href="https://nxg.me.uk/" rev="author"/>
<link type="text/css" rel="stylesheet" href="/style/base.css"/>
</head>
@@ -17,11 +17,14 @@ basic support for <code>eprint</code>, <code>doi</code> and <code>pubmed</code>
hypertex/hyperref support.</p>
<p>The Persistent URL for this page is
-<code>http://purl.org/nxg/dist/urlbst</code>.
-The code (and bugparade) is on
-<a href='https://bitbucket.org/nxg/urlbst/'>bitbucket.org</a>.</p>
-
-<p>Version 0.8, 2019 July 1.</p>
+<code>https://purl.org/nxg/dist/urlbst</code>
+– <strong>please quote this rather than the URL it redirects to</strong>.
+It is on CTAN at
+<a href='https://ctan.org/pkg/urlbst'><code>https://ctan.org/pkg/urlbst</code></a>.
+The code (and bugparade) is
+<a href='https://heptapod.host/nxg/urlbst'>online</a>.</p>
+
+<p>Version 0.9, 2022 December 1.</p>
</div>
<p>Contents</p>
@@ -54,18 +57,23 @@ eprint fields. Fuller details are in the <a href="urlbst.pdf"
<h2><a name='usage'>Usage</a></h2>
<pre>
-urlbst [--[no]eprint] [--[no]doi] [--[no]pubmed]
- [--inlinelinks] [--nohyperlinks] [--hypertex] [--hyperref]
- [--literal key=value]
+urlbst [--literal key=value] [--setting key=value]
[input-file [output-file]]
</pre>
<p>If either the input-file or the output-file is omitted, they
default to stdin and stdout respectively. If the input file already
has a URL entry type, then the script objects.
By default (in the current version), the output
-includes support for eprint, doi and pubmed, but these can be disabled
-by <code>--noeprint</code>, <code>--nodoi</code> and
-<code>--nopubmed</code>, respectively.</p>
+includes support for eprint, doi and pubmed.</p>
+
+<p>The support in the generated <code>.bst</code> file can be adjusted
+with the options <code>--setting</code> and <code>--literal</code>;
+see <code>--setting help</code> and <code>--literal help</code> for
+the available switches. The options <code>--[no]eprint</code>,
+<code>--[no]doi</code>, <code>--[no]pubmed</code>,
+<code>--inlinelinks</code>, <code>--nohyperlinks</code>,
+<code>--hypertex</code> and <code>--hyperref</code> are shortcuts for
+some of these settings.
<p>The added fields are:</p>
<ul>
@@ -78,27 +86,26 @@ by <code>--noeprint</code>, <code>--nodoi</code> and
<a href='http://pubmed.gov'>PubMed</a> identifier (PMID).</li>
</ul>
-<p>If either of the <code>--hypertex</code> or <code>--hyperref</code>
-options is present, then the generated <code>.bst</code> file includes
+<p>If setting <code>hrefform</code> is 1 or 2, then the generated
+<code>.bst</code> file includes
support for hyperlinks in the generated eprint entries in the
bibliography, with the format being either HyperTeX (see <a
href="http://arxiv.org/hypertex/#implementation" >arXiv, again</a>),
supported by xdvi, dvips and others, or using the support available
-from the hyperref package. These options have no effect unless one of
-the <code>--eprint</code> or <code>--doi</code> options is given: when
+from the hyperref package. When
URLs are included in the bibliography, they are written out using the
<code>\url{...}</code> command, and hyperref automatically processes
that in the correct way to include a hyperlink.</p>
-<p>The <code>--inlinelinks</code> option tells urlbst not to write out
-the URL as text within the bibliography entry. Instead, urlbst will
-produce a more conventional-looking and compact bibliography entry,
-but the entry's title will now be a hyperlink to that URL. This
-hyperlink may be useful to anyone who reads your document online
-(this option can only be used with <code>--hyperref</code> or
-<code>--hypertex</code>). Any DOI or eprint text which would be
-produced as a result of the appropriate option will still appear in
-this mode.</p>
+<p>The setting <code>inlinelinks</code> (option
+<code>--inlinelinks</code>) tells urlbst not to write out the URL as
+text within the bibliography entry. Instead, urlbst will produce a
+more conventional-looking and compact bibliography entry, but the
+entry's title will now be a hyperlink to that URL. This hyperlink may
+be useful to anyone who reads your document online (this option can
+only be used with <code>hrefform</code> 1 or 2. Any DOI or eprint
+text which would be produced as a result of the appropriate option
+will still appear in this mode.</p>
<p>You may adjust various literal strings, either for the purposes of
internationalisation, or simply because you prefer different text. To
@@ -108,16 +115,28 @@ th'intert00bs"</code>, to replace the default <code>URL:</code> text.
The possible values, and their defaults, are below (say
<code>--literal help</code> to get this list printed out):</p>
<table>
-<tr><th>keyword</th><th>default</th><th>meaning</th></tr>
-<tr><td>cited</td><td>cited</td><td>indicator of citation, or "last checked", date</td></tr>
-<tr><td>doiprefix</td><td>doi:</td><td>text printed before DOI</td></tr>
-<tr><td>eprintprefix</td><td>arXiv:</td><td>text printed before eprint
-ref</td></tr>
-<tr><td>linktext</td><td>[link]</td><td>fallback link text</td></tr>
-<tr><td>pubmedprefix</td><td>PMID:</td><td>text printed before PUBMED reference</td></tr>
-<tr><td>online</td><td>online</td><td>indication that resource is online</td></tr>
-<tr><td>urlintro</td><td>URL:</td><td>location of online resource (an
-alternative is "Available from:")</td></tr>
+<tr><th>literal</th><th>description</th><th>default</th></tr>
+<tr><td>urlintro</td><td>prefix before URL; typically "Available from:" or "URL:"</td><td>URL: </td></tr>
+<tr><td>pubmedprefix</td><td>text prefix printed before PUBMED ref</td><td>PMID:</td></tr>
+<tr><td>pubmedurl</td><td>prefix to make URL from PUBMED</td><td>http://www.ncbi.nlm.nih.gov/pubmed/</td></tr>
+<tr><td>eprintprefix</td><td>text prefix printed before eprint ref</td><td>arXiv:</td></tr>
+<tr><td>linktextstring</td><td>anonymous link text</td><td>[link]</td></tr>
+<tr><td>citedstring</td><td>label that something is cited by something else</td><td>cited </td></tr>
+<tr><td>eprinturl</td><td>prefix to make URL from eprint ref</td><td>http://arxiv.org/abs/</td></tr>
+<tr><td>doiurl</td><td>prefix to make URL from DOI</td><td>https://doi.org/</td></tr>
+<tr><td>doiprefix</td><td>printed text to introduce DOI</td><td>doi:</td></tr>
+<tr><td>onlinestring</td><td>label that a resource is online</td><td>online</td></tr>
+</table>
+
+<p>The list of settings (<code>--setting help</code>) is:</p>
+<table>
+<tr><th>setting</th><th>description</th><th>default</th></tr>
+<tr><td>inlinelinks</td><td>0=URLs explicit; 1=URLs attached to titles</td><td>0</td></tr>
+<tr><td>addpubmed</td><td>0=no PUBMED resolver; 1=include it</td><td>1</td></tr>
+<tr><td>addeprints</td><td>0=no eprints; 1=include eprints</td><td>1</td></tr>
+<tr><td>hrefform</td><td>0=no crossrefs; 1=hypertex xrefs; 2=hyperref refs</td><td>0</td></tr>
+<tr><td>adddoi</td><td>0=no DOI resolver; 1=include it</td><td>1</td></tr>
+<tr><td>doiform</td><td>0=with href; 1=with \doi{}</td><td>0</td></tr>
</table>
<p>The distribution includes preconverted versions of the four
@@ -182,17 +201,16 @@ which have been pre-converted.</p>
<p>There is more general discussion of including URLs in
bibliographies in the <a
-href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=citeURL" >UK TeX
-FAQ</a>.</p>
+href="https://texfaq.org/FAQ-citeURL" >TeX FAQ</a>.</p>
<h2><a name='download'>Download and installation</a></h2>
<p>Download the file as a
-<a href="urlbst-0.8.tar.gz" >tarball</a>
+<a href="urlbst-0.9.tar.gz" >tarball</a>
or
-<a href="urlbst-0.8.zip" >zip file</a>
-and unpack it. Or you can clone the source repository at
-<a href='http://bitbucket.org/nxg/urlbst/'>bitbucket.org</a>.</p>
+<a href="urlbst-0.9.zip" >zip file</a>
+and unpack it. Or you can clone the source repository
+<a href='https://heptapod.host/nxg/urlbst'>online</a>.</p>
<p>To install, you should simply copy the distributed
<code>urlbst</code> script to someplace on the path (such as
@@ -209,9 +227,9 @@ and you will probably need to use <code>texhash</code>,
<code>mktexlsr</code> or its equivalent, to update LaTeX's filename
cache. For further hints here, see
the TeX FAQ entries on <a
-href='http://www.tex.ac.uk/cgi-bin/texfaq2html?label=instpackages'
+href='https://texfaq.org/#installing'
>installing a package</a> and <a
-href='http://www.tex.ac.uk/cgi-bin/texfaq2html?label=wherefiles'
+href='https://texfaq.org/FAQ-inst-wlcf'
>where LaTeX puts files</a>.</p>
<p>That should be all you have to do.</p>
@@ -297,7 +315,7 @@ is distributed as a PDF file, but if you want to regenerate it, use</p>
<p>The copyright and licence position for the modified <code>.bst</code> files seems
slightly muddy to me. On the grounds that any licence is better than
no licence, I therefore assert that the <em>modifications</em> which the
-<code>urlbst</code> program makes to these files are copyright 2002-03, 2005-12, 2014, 2019,
+<code>urlbst</code> program makes to these files are copyright 2002-03, 2005-12, 2014, 2019, 2022,
Norman Gray, and that these modifications are available for
distribution under the terms of the LaTeX Project Public Licence.</p>
@@ -318,18 +336,17 @@ distribution, for the relevant licence text.</p>
<h2><a name='information'>Further Information and acknowledgements</a></h2>
-<p><code>urlbst</code> is archived <a
-href='https://ctan.org/pkg/urlbst'
->on CTAN</a>, and discussed in the
-<a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=citeURL" >TeX
-FAQ</a>.</p>
+<p><code>urlbst</code> is archived <a href='https://ctan.org/pkg/urlbst' >on CTAN</a>,
+and discussed in the
+<a href="https://texfaq.org/FAQ-citeURL" >TeX FAQ</a>.</p>
-<p>The source code for the package is maintained at
-<a href='http://bitbucket.org/nxg/urlbst/'>bitbucket.org</a>,
+<p>The source code for the package is maintained
+<a href='https://heptapod.host/nxg/urlbst'>online</a>.
+<!--
which also includes an issue tracker, where you can report bugs (or
-just mail me).</p>
+just mail me).--></p>
-<p>The <a href="http://purl.org/nxg/dist/urlbst"
+<p>The <a href="https://purl.org/nxg/dist/urlbst"
>home page of urlbst</a> might possibly have more recent versions than the
one you're looking at now.</p>
@@ -348,6 +365,20 @@ to Katrin Leinweber for the pull request which fixed the format of DOI
references.</p>
<dl>
+<dt><strong>0.9, 2022 December 1</strong></dt>
+<dd><ul>
+ <li>Changed repository location to <a href='https://heptapod.host/nxg/urlbst'>heptapod</a>
+ (when Bitbucket dropped support for Mercurial).
+ The issue links below, pointing to Bitbucket, will therefore no
+ longer work.</li>
+ <li>Refactoring of the mechanism for configuring the generated
+ <code>.bst</code> file, specifically adding the
+ <code>--setting</code> option.</li>
+ <li>Added the <code>doiform</code> setting to generate DOIs wrapped
+ in <code>\doi{...}</code>.</li>
+</ul>
+</dd>
+
<dt><strong>0.8, 2019 July 1</strong></dt>
<dd><ul>
<li>The presence of a preexisting <code>format.doi</code>,
@@ -365,8 +396,9 @@ thanks to
</dd>
<dt>0.7, 2011 July 20</dt>
-<dd>Add <code>--nodoi</code>, <code>--noeprints</code> and <code>--nopubmed</code> options (which defaulted
-on, and couldn't otherwise be turned off)</dd>
+<dd>Add <code>--nodoi</code>, <code>--noeprints</code> and
+<code>--nopubmed</code> options (which defaulted on, and couldn't
+otherwise be turned off)</dd>
<dt>0.7b1, 2011 March 17</dt>
<dd>Allow parameterisation of literal strings, with option <code>--literal</code>.</dd>
@@ -449,13 +481,13 @@ documentation added.</dd>
</dl>
</div>
-<p>Copyright 2002-03, 2005-12, 2014, 2019, Norman Gray. Released under the terms of the GNU
+<p>Copyright 2002-03, 2005-12, 2014, 2019, 2022, Norman Gray. Released under the terms of the GNU
General Public Licence.</p>
<div class="signature">
-<a href="http://nxg.me.uk"
+<a href="https://nxg.me.uk"
>Norman Gray</a><br/>
-2019 July 1
+2022 December 1
</div>
</body>