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