/usr/share/doc/refdb/refdb-manual/re13.html is in refdb-doc 1.0.2-3ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 | <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>db2ris</title><link rel="stylesheet" type="text/css" href="manual.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="RefDB handbook" /><link rel="up" href="ch14.html#idp66539984" title="Tools" /><link rel="prev" href="re12.html" title="bib2ris" /><link rel="next" href="re14.html" title="en2ris" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">db2ris</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="re12.html">Prev</a> </td><th width="60%" align="center">Tools</th><td width="20%" align="right"> <a accesskey="n" href="re14.html">Next</a></td></tr></table><hr /></div><div class="refentry"><a id="refentry-db2ris"></a><div class="titlepage"></div><div class="refnamediv"><a id="db2ris-name"></a><h2>Name</h2><p>db2ris — converts DocBook bibliographic data to the RIS format</p></div><div class="refsynopsisdiv"><a id="db2ris-synopsis"></a><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">db2ris</code> [-a ] [-e <em class="replaceable"><code>log-destination</code></em>] [-h ] [-L <em class="replaceable"><code>log-file</code></em>] [-o <em class="replaceable"><code>file</code></em>] [-O <em class="replaceable"><code>file</code></em>] [-r <em class="replaceable"><code>reftype</code></em>] <em class="replaceable"><code>file</code></em> </p></div></div><div class="refsect1"><a id="db2ris-description"></a><h2>Description</h2><p>db2ris converts DocBook bibliographic data into RIS files. The design and purpose of the DocBook bibliography information is too different from the RIS format to warrant a simple and straightforward conversion, let alone a bi-directional one. The DocBook bibliography definition allows for a lot of freedom how to encode your information. To accommodate as wide a range of uses and abuses of the bibliographic elements as possible, this import filter is implemented as a DSSSL stylesheet rather than as a C application. This allows you to quickly change or extend the stylesheet to adapt it to your needs. db2ris is a wrapper script which invokes OpenJade to do the actual transformation.</p></div><div class="refsect1"><a id="db2ris-options"></a><h2>Options</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="option">-a</code></span></dt><dd><p>Use full first- and othernames if they are present in the DocBook source. By default, all first- and othernames will be abbreviated.</p></dd><dt><span class="term"><code class="option">-e</code> <em class="replaceable"><code>log-destination</code></em></span></dt><dd><p>log-destination can have the values 0, 1, or 2, or the equivalent strings <span class="emphasis"><em>stderr</em></span>, <span class="emphasis"><em>syslog</em></span>, or <span class="emphasis"><em>file</em></span>, respectively. This value specifies where the log information goes to. <code class="literal">0</code> (zero) means the messages are sent to stderr. They are immediately available on the screen but they may interfere with command output. <code class="literal">1</code> will send the output to the syslog facility. Keep in mind that syslog must be configured to accept log messages from user programs, see the syslog(8) man page for further information. Unix-like systems usually save these messages in <code class="filename">/var/log/user.log</code>. <code class="literal">2</code> will send the messages to a custom log file which can be specified with the <code class="option">-L</code> option.</p></dd><dt><span class="term"><code class="option">-h</code></span></dt><dd><p>Displays help and usage screen, then exits.</p></dd><dt><span class="term"><code class="option">-L</code> <em class="replaceable"><code>log-file</code></em></span></dt><dd><p>Specify the full path to a log file that will receive the log messages. Typically this would be <code class="filename">/var/log/refdba</code>.</p></dd><dt><span class="term"><code class="option">-o</code> <em class="replaceable"><code>file</code></em></span></dt><dd><p>Send output to <span class="emphasis"><em>file</em></span> instead of to stdout. If <span class="emphasis"><em>file</em></span> exists, its contents will be overwritten.</p></dd><dt><span class="term"><code class="option">-O</code> <em class="replaceable"><code>file</code></em></span></dt><dd><p>Send output to <span class="emphasis"><em>file</em></span> instead of to stdout. If <span class="emphasis"><em>file</em></span> exists, the output will be appended.</p></dd><dt><span class="term"><code class="option">-r</code> <em class="replaceable"><code>reftype</code></em></span></dt><dd><p>Set the default RIS reference type. This type will be used if db2ris cannot infer the reference type from the <span class="emphasis"><em>BiblioEntry</em></span> element.</p></dd><dt><span class="term"><span class="emphasis"><em>file</em></span></span></dt><dd><p>The names of one or more DocBook files.</p></dd></dl></div></div><div class="refsect1"><a id="db2ris-configuration"></a><h2>Configuration</h2><p><span class="command"><strong>db2ris</strong></span> evaluates the file <code class="filename">db2risrc</code> to initialize itself.</p><div class="table"><a id="idp71551360"></a><p class="title"><strong>Table 14.3. db2risrc</strong></p><div class="table-contents"><table class="table" summary="db2risrc" border="1"><colgroup><col /><col /><col /></colgroup><thead><tr><th>Variable</th><th>Default</th><th>Comment</th></tr></thead><tbody><tr><td>logfile</td><td>/var/log/db2ris.log</td><td>The full path of a custom log file. This is used only if logdest is set appropriately.</td></tr><tr><td>logdest</td><td>0</td><td>The destination of the log information. 0 = print to stderr; 2 = use a custom logfile. The latter needs a proper setting of logfile.</td></tr><tr><td>authorlong</td><td>f</td><td>Set this to t if full first- and othernames should be used if possible.</td></tr><tr><td>defaultreftype</td><td>GEN</td><td>The default RIS reference type will be used if a <code class="sgmltag-element">BiblioEntry</code> element does not specify the type.</td></tr></tbody></table></div></div><br class="table-break" /></div><div class="refsect1"><a id="db2ris-data-processing"></a><h2>Data Processing</h2><p>We have to make a bunch of assumptions to arrive at a suitable output:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>db2ris will handle only <span class="quote">“<span class="quote">raw</span>”</span> (as opposed to <span class="quote">“<span class="quote">cooked</span>”</span>) bibliographic data. This basically means that you must encode all bibliographic data in <code class="sgmltag-element">BiblioEntry</code> elements, not in <code class="sgmltag-element">BiblioMixed</code> elements.</p></li><li class="listitem"><p>db2ris discards all publication date information from the <code class="sgmltag-element">PubDate</code> except the first 4 characters of #PCDATA so these should better be a 4-digit year.</p></li><li class="listitem"><p>By default, the publication type is neither explicitly encoded in a <code class="sgmltag-element">BiblioEntry</code> element nor can it be easily inferred. Therefore db2ris assumes that the <code class="sgmltag-element">BiblioEntry</code> carry a <code class="varname">role</code> attribute with the RIS publication type as the value. If the attribute is missing, a default type is used instead. This means that you should add these attributes before the conversion in order to get useful RIS datasets (or fix the TY entries in the RIS file afterwards).</p></li><li class="listitem"><p>DocBook does not have a special element to encode the name of a journal or magazine that published an article. Instead the same <code class="sgmltag-element">Title</code> element is used as for the article title, a book title, or a series title. To distinguish between a journal or magazine name and <span class="quote">“<span class="quote">real</span>”</span> titles, the <code class="sgmltag-element">Title</code> element encoding the journal name is assumed to be nested in a <code class="sgmltag-element">BiblioSet</code> whose <code class="varname">relation</code> attribute is set to <span class="quote">“<span class="quote">journal</span>”</span>, <span class="quote">“<span class="quote">pub</span>”</span>, <span class="quote">“<span class="quote">abbrev</span>”</span>, or <span class="quote">“<span class="quote">full</span>”</span> (this more or less arbitrary list can of course be extended or changed, see below). The values <span class="quote">“<span class="quote">abbrev</span>”</span> and <span class="quote">“<span class="quote">full</span>”</span> furthermore decide whether the RIS tag <span class="quote">“<span class="quote">JO</span>”</span> or <span class="quote">“<span class="quote">JF</span>”</span> will be used.</p></li></ul></div></div><div class="refsect1"><a id="db2ris-modifying"></a><h2>Modifying db2ris</h2><p>As previously stated, db2ris is implemented as a DSSSL stylesheet that can be easily and quickly adapted to your needs. It may be prudent to create copies of the script and modify these in order to adapt them for particular <span class="quote">“<span class="quote">abuses</span>”</span> of the DocBook bibliographic elements in various documents or data sources. This section briefly lists the functions which you would most likely want to change.</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">reftype-heuristic</span></dt><dd><p>This function attempts to infer the correct RIS publication type.</p></dd><dt><span class="term">titletype-heuristic</span></dt><dd><p>This function gives a hint whether a <code class="sgmltag-element">Title</code> element is used as a journal/magazine name or as an article title or book title.</p></dd><dt><span class="term">process-date</span></dt><dd><p>This function creates a valid string for the RIS PY tag from the <code class="sgmltag-element">PubDate</code> element.</p></dd></dl></div></div><div class="refsect1"><a id="db2ris-files"></a><h2>Files</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="filename">PREFIX/etc/refdb/db2risrc</code></span></dt><dd><p>The global configuration file of db2ris.</p></dd><dt><span class="term"><code class="filename">$HOME/.db2risrc</code></span></dt><dd><p>The user configuration file of db2ris.</p></dd></dl></div></div><div class="refsect1"><a id="db2ris-see_also"></a><h2>See also</h2><p><span class="emphasis"><em>RefDB</em></span> (7),
<span class="emphasis"><em><a class="link" href="re12.html" title="bib2ris">bib2ris</a></em></span> (1),
<span class="emphasis"><em><a class="link" href="re14.html" title="en2ris">en2ris</a></em></span> (1),
<span class="emphasis"><em><a class="link" href="re15.html" title="marc2ris">marc2ris</a></em></span> (1),
<span class="emphasis"><em><a class="link" href="re16.html" title="med2ris">med2ris</a></em></span> (1).</p><p><span class="emphasis"><em>RefDB manual (local copy) </em></span> PREFIX/share/doc/refdb-<version>/refdb-manual/index.html</p><p><span class="emphasis"><em>RefDB manual (web) </em></span> <<a class="ulink" href="http://refdb.sourceforge.net/manual/index.html" target="_top">http://refdb.sourceforge.net/manual/index.html</a>></p><p><span class="emphasis"><em>RefDB on the web </em></span> <<a class="ulink" href="http://refdb.sourceforge.net/" target="_top">http://refdb.sourceforge.net/</a>></p></div><div class="refsect1"><a id="db2ris-author"></a><h2>Author</h2><p>db2ris was written by Markus Hoenicka <markus@mhoenicka.de>.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="re12.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch14.html#idp66539984">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="re14.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">bib2ris </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> en2ris</td></tr></table></div></body></html>
|