stylesheets/styleguide/docbook-xsl-1.75.2/params/bibliography.collection.xml

   1 <refentry xmlns="http://docbook.org/ns/docbook"\r
   2           xmlns:xlink="http://www.w3.org/1999/xlink"\r
   3           xmlns:xi="http://www.w3.org/2001/XInclude"\r
   4           xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"\r
   5           xmlns:xsl="http://www.w3.org/1999/XSL/Transform"\r
   6           version="5.0" xml:id="bibliography.collection">\r
   7 <refmeta>\r
   8 <refentrytitle>bibliography.collection</refentrytitle>\r
   9 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>\r
  10 </refmeta>\r
  11 <refnamediv>\r
  12 <refname>bibliography.collection</refname>\r
  13 <refpurpose>Name of the bibliography collection file</refpurpose>\r
  14 </refnamediv>\r
  15 \r
  16 <refsynopsisdiv>\r
  17 <src:fragment xml:id="bibliography.collection.frag">\r
  18 <xsl:param name="bibliography.collection">http://docbook.sourceforge.net/release/bibliography/bibliography.xml</xsl:param>\r
  19 \r
  20 </src:fragment>\r
  21 </refsynopsisdiv>\r
  22 \r
  23 <refsection><info><title>Description</title></info>\r
  24 \r
  25 <para>Maintaining bibliography entries across a set of documents is tedious, time\r
  26 consuming, and error prone. It makes much more sense, usually, to store all of\r
  27 the bibliography entries in a single place and simply <quote>extract</quote>\r
  28 the ones you need in each document.</para>\r
  29 \r
  30 <para>That's the purpose of the\r
  31 <parameter>bibliography.collection</parameter> parameter. To setup a global\r
  32 bibliography <quote>database</quote>, follow these steps:</para>\r
  33 \r
  34 <para>First, create a stand-alone bibliography document that contains all of\r
  35 the documents that you wish to reference. Make sure that each bibliography\r
  36 entry (whether you use <tag>biblioentry</tag> or <tag>bibliomixed</tag>)\r
  37 has an ID.</para>\r
  38 \r
  39 <para>My global bibliography, <filename>~/bibliography.xml</filename> begins\r
  40 like this:</para>\r
  41 \r
  42 <informalexample>\r
  43 <programlisting>&lt;!DOCTYPE bibliography\r
  44   PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"\r
  45   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"&gt;\r
  46 &lt;bibliography&gt;&lt;title&gt;References&lt;/title&gt;\r
  47 \r
  48 &lt;bibliomixed id="xml-rec"&gt;&lt;abbrev&gt;XML 1.0&lt;/abbrev&gt;Tim Bray,\r
  49 Jean Paoli, C. M. Sperberg-McQueen, and Eve Maler, editors.\r
  50 &lt;citetitle&gt;&lt;ulink url="http://www.w3.org/TR/REC-xml"&gt;Extensible Markup\r
  51 Language (XML) 1.0 Second Edition&lt;/ulink&gt;&lt;/citetitle&gt;.\r
  52 World Wide Web Consortium, 2000.\r
  53 &lt;/bibliomixed&gt;\r
  54 \r
  55 &lt;bibliomixed id="xml-names"&gt;&lt;abbrev&gt;Namespaces&lt;/abbrev&gt;Tim Bray,\r
  56 Dave Hollander,\r
  57 and Andrew Layman, editors.\r
  58 &lt;citetitle&gt;&lt;ulink url="http://www.w3.org/TR/REC-xml-names/"&gt;Namespaces in\r
  59 XML&lt;/ulink&gt;&lt;/citetitle&gt;.\r
  60 World Wide Web Consortium, 1999.\r
  61 &lt;/bibliomixed&gt;\r
  62 \r
  63 &lt;!-- ... --&gt;\r
  64 &lt;/bibliography&gt;\r
  65 </programlisting>\r
  66 </informalexample>\r
  67 \r
  68 <para>When you create a bibliography in your document, simply\r
  69 provide <emphasis>empty</emphasis> <tag>bibliomixed</tag>\r
  70 entries for each document that you wish to cite. Make sure that these\r
  71 elements have the same ID as the corresponding <quote>real</quote>\r
  72 entry in your global bibliography.</para>\r
  73 \r
  74 <para>For example:</para>\r
  75 \r
  76 <informalexample>\r
  77 <programlisting>&lt;bibliography&gt;&lt;title&gt;Bibliography&lt;/title&gt;\r
  78 \r
  79 &lt;bibliomixed id="xml-rec"/&gt;\r
  80 &lt;bibliomixed id="xml-names"/&gt;\r
  81 &lt;bibliomixed id="DKnuth86"&gt;Donald E. Knuth. &lt;citetitle&gt;Computers and\r
  82 Typesetting: Volume B, TeX: The Program&lt;/citetitle&gt;. Addison-Wesley,\r
  83 1986.  ISBN 0-201-13437-3.\r
  84 &lt;/bibliomixed&gt;\r
  85 &lt;bibliomixed id="relaxng"/&gt;\r
  86 \r
  87 &lt;/bibliography&gt;</programlisting>\r
  88 </informalexample>\r
  89 \r
  90 <para>Note that it's perfectly acceptable to mix entries from your\r
  91 global bibliography with <quote>normal</quote> entries. You can use\r
  92 <tag>xref</tag> or other elements to cross-reference your\r
  93 bibliography entries in exactly the same way you do now.</para>\r
  94 \r
  95 <para>Finally, when you are ready to format your document, simply set the\r
  96 <parameter>bibliography.collection</parameter> parameter (in either a\r
  97 customization layer or directly through your processor's interface) to\r
  98 point to your global bibliography.</para>\r
  99 \r
 100 <para>The stylesheets will format the bibliography in your document as if\r
 101 all of the entries referenced appeared there literally.</para>\r
 102 \r
 103 </refsection>\r
 104 </refentry>\r