This file is indexed.

/usr/share/doc/refdb/refdb-manual/ch22s04.html is in refdb-doc 1.0.2-3.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

1
2
<?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>Processing expectations for the RefDB DocBook bibliography output</title><link rel="stylesheet" type="text/css" href="manual.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /><link rel="home" href="index.html" title="RefDB handbook" /><link rel="up" href="ch22.html" title="Chapter 22. The RefDB SGML/XML input and output formats" /><link rel="prev" href="ch22s03.html" title="The XML input format for extended notes" /><link rel="next" href="ch23.html" title="Chapter 23. The RefDB client/server communication protocol" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Processing expectations for the RefDB DocBook bibliography output</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch22s03.html">Prev</a> </td><th width="60%" align="center">Chapter 22. The RefDB SGML/XML input and output formats</th><td width="20%" align="right"> <a accesskey="n" href="ch23.html">Next</a></td></tr></table><hr /></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="idp69995712"></a>Processing expectations for the RefDB DocBook bibliography output</h2></div></div></div><p>The accepted standard DSSSL and XSL stylesheets for DocBook by Norman Walsh as well as the XSL stylesheets for TEI by Sebastian Rahtz are not designed to handle the complexity of the bibliography formatting requirements of various journals and publishers. RefDB strains the limits of SGML and the document types to supply the required structural information, but it takes customized stylesheets to turn this into proper formatting. The RefDB package contains sets of DSSSL and XSL stylesheets that were designed for this purpose. They are implemented as driver files for the standard stylesheets. If those stylesheets do not do exactly what you need, you will have to modify them or write new ones from scratch. This chapter briefly explains the design of the output that RefDB generates and how this should be processed in your stylesheets.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This section discusses the DocBook output. It is straightforward to transfer this to TEI output. See <a class="link" href="ch10s03.html#sect3-create-citations" title="Create citations">here</a> for a description of the equivalent TEI elements and attributes.</p></div><p>The general principle of the RefDB bibliography is straightforward: Each citation that you want to be treated as a RefDB citation needs to have a <code class="sgmltag-attribute">role</code> attribute with the value <span class="quote"><span class="quote">REFDB</span></span>. Each citation defines at least one <code class="sgmltag-element">xref</code> element. The value of the <code class="sgmltag-attribute">linkend</code> attribute encodes the ID of the required reference in the database (if you need references in several databases, this attribute can additionally specify the database). RefDB uses this information to generate a DocBook <code class="sgmltag-element">bibliography</code> element. This contains an entry for each requested reference. These entries are labelled with <code class="sgmltag-attribute">ID</code> attributes that match the <code class="sgmltag-element">xref</code> <code class="sgmltag-attribute">linkend</code> attributes in the text. Each RefDB-generated reference entry defines a <code class="sgmltag-attribute">xreflabel</code> attribute which holds the text that is to be displayed at the position of the corresponding <code class="sgmltag-element">xref</code> elements.</p><p>This is all it takes for single and unique citations, i.e. with one <code class="sgmltag-element">xref</code> element per <code class="sgmltag-element">citation</code> element and only one occurrence throughout the text. Both multiple occurrences of the same citation in the text and multiple citations (more than one <code class="sgmltag-element">xref</code> elements per <code class="sgmltag-element">citation</code> element) make things a bit more difficult.</p><p>Some output formats require a different formatting for the first citation of a publication in the text and all subsequent citations of the same publication. The first citation is identical with the above mentioned default case. All following citations of the same publication need an additional <code class="sgmltag-element">xref</code> <code class="sgmltag-attribute">endterm</code> attribute which points to an additional <code class="sgmltag-element">bibliomset</code> element which in turn contains the text to be displayed for subsequent citations. The <code class="sgmltag-attribute">endterm</code> attribute has the same value as the <code class="sgmltag-attribute">linkend</code> attribute except that the letter <span class="quote"><span class="quote">S</span></span> (as in subsequent) is appended to the attribute.</p><p>The real trouble starts with multiple citations. The output format may require the sequence of the citations to be sorted, and in the case of a numerical citation style it may require sequences of consecutive citations to be displayed as ranges (e.g. <span class="quote"><span class="quote">[5-7]</span></span> instead of <span class="quote"><span class="quote">[5,6,7]</span></span>). This may break the links between the individual citations and the reference in the bibliography in the output document. RefDB will create an additional <code class="sgmltag-element">bibliomset</code> element for each multiple citation. This provides the sorted and formatted text that is to be displayed for the multiple citation. For this to work you have to define an additional <code class="sgmltag-element">xref</code> element whose <code class="sgmltag-attribute">linkend</code> attribute points to one of the references and whose <code class="sgmltag-attribute">endterm</code> points to the additional <code class="sgmltag-element">bibliomset</code> element. This arrangement allows the multiple citation to be displayed differently depending on the desired output format. If the output is generated for printout, only the additional <code class="sgmltag-element">xref</code> element should be formatted. This ensures the correct formatting of the citation in the printout. In output formats that allow hyperlinks it may be preferable to format the <code class="sgmltag-element">xref</code> elements that link to the references individually. This may be incorrect in terms of the citation style, but the functional links to the references in the bibliography may outweigh this disadvantage.</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch22s03.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch22.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch23.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">The XML input format for extended notes </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 23. The RefDB client/server communication protocol</td></tr></table></div></body></html>