stylesheets/evergreen_docbook_files/docbook-xsl-1.75.2/docsrc/reference.xml

   1 <set xmlns="http://docbook.org/ns/docbook" version="5.0"\r
   2   xmlns:xi="http://www.w3.org/2001/XInclude"\r
   3   xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"\r
   4   xmlns:xsl="http://www.w3.org/1999/XSL/Transform"\r
   5   xmlns:xlink="http://www.w3.org/1999/xlink"\r
   6   xml:base="../docsrc/"\r
   7   >\r
   8   <!-- * WARNING WARNING WARNING -->\r
   9   <!-- * WARNING WARNING WARNING -->\r
  10   <!-- * -->\r
  11   <!-- * This document has duplicate IDs in it and is intended for -->\r
  12   <!-- * processing using the chunk.xsl stylesheet to generate chunked -->\r
  13   <!-- * output from it (not for generating a single HTML output file) -->\r
  14   <!-- * -->\r
  15   <!-- * WARNING WARNING WARNING -->\r
  16   <!-- * WARNING WARNING WARNING -->\r
  17   <title>DocBook XSL Stylesheets: Reference Documentation</title>\r
  18   <info><releaseinfo role="meta">$Id: reference.xml 8321 2009-03-12 18:20:36Z mzjn $ </releaseinfo>\r
  19     <xi:include href="./authors.xml"/>\r
  20     <xi:include href="./copyright.xml" xpointer="xpointer(//*[local-name() = 'copyright'])"/>\r
  21     <xi:include href="./license.xml"/>\r
  22     <xi:include href="./warranty.xml"/>\r
  23     <abstract xml:id="about">\r
  24       <title>About this document</title>\r
  25       <para>This is generated reference documentation for the DocBook\r
  26         XSL stylesheets. It is available in the following formats:\r
  27         <itemizedlist>\r
  28           <listitem>\r
  29             <para><link\r
  30                 xlink:href="http://docbook.sourceforge.net/release/xsl/current/doc/reference.html"\r
  31                 >HTML</link>,\r
  32               <link\r
  33                 xlink:href="http://docbook.sourceforge.net/release/xsl/current/doc/reference.pdf"\r
  34                 >PDF</link>,\r
  35               <link\r
  36                 xlink:href="http://docbook.sourceforge.net/release/xsl/current/doc/reference.txt"\r
  37                 >plain text</link></para>\r
  38           </listitem>\r
  39         </itemizedlist>\r
  40         This is primarily documentation on the parameters and processing instructions you can use\r
  41         to control the behavior of the stylesheets.\r
  42         <note>\r
  43           <para>This is purely reference documentation&#xa0;– not how-to\r
  44             documentation. For a thorough step-by-step how-to guide to\r
  45             publishing content using the DocBook XSL stylesheets, see\r
  46             Bob Stayton’s <link \r
  47               xlink:href="http://www.sagehill.net/book-description.html"\r
  48               >DocBook XSL: The Complete Guide</link>, available online\r
  49             at <link\r
  50               xlink:href="http://www.sagehill.net/docbookxsl/index.html"\r
  51               >http://www.sagehill.net/docbookxsl/index.html</link>\r
  52           </para>\r
  53         </note>\r
  54         This document is divided into three sets of references:\r
  55         the first two sets provides user documentation; the third,\r
  56         developer documentation.</para>\r
  57     </abstract>\r
  58   </info>\r
  59   <book xml:id="param"><title>DocBook XSL Stylesheets User Reference: Parameters</title>\r
  60     <info>\r
  61       <abstract>\r
  62         <para>This is generated reference documentation for all\r
  63           user-configurable parameters in the DocBook XSL\r
  64           stylesheets.\r
  65           <note>\r
  66             <para>This is purely reference documentation&#xa0;– not how-to\r
  67               documentation. For a thorough step-by-step how-to guide to\r
  68               publishing content using the DocBook XSL stylesheets, see\r
  69               Bob Stayton’s <link \r
  70                 xlink:href="http://www.sagehill.net/book-description.html"\r
  71                 >DocBook XSL: The Complete Guide</link>, available online\r
  72               at <link\r
  73                 xlink:href="http://www.sagehill.net/docbookxsl/index.html"\r
  74                 >http://www.sagehill.net/docbookxsl/index.html</link>\r
  75             </para>\r
  76           </note>\r
  77         </para>\r
  78       </abstract>\r
  79     </info>\r
  80     <part xml:id="html">\r
  81       <?dbhtml dir="html"?>\r
  82       <?dbhtml filename="index.html"?>\r
  83       <xi:include href="../html/param.xml" xpointer="xpointer(/book/info/title)" />\r
  84       <partintro xml:id="htmlintro">\r
  85         <xi:include href="../html/param.xml" xpointer="xpointer(/book/info/abstract/node())" />\r
  86       </partintro>\r
  87       <xi:include href="../html/param.xml" xpointer="xpointer(/book/reference)" />\r
  88     </part>\r
  89     <part xml:id="fo">\r
  90       <?dbhtml dir="fo"?>\r
  91       <?dbhtml filename="index.html"?>\r
  92       <xi:include href="../fo/param.xml" xpointer="xpointer(/book/info/title)" />\r
  93       <partintro xml:id="fointro">\r
  94         <xi:include href="../fo/param.xml" xpointer="xpointer(/book/info/abstract/node())" />\r
  95       </partintro>\r
  96       <xi:include href="../fo/param.xml" xpointer="xpointer(/book/reference)" />\r
  97     </part>\r
  98     <part xml:id="manpages">\r
  99       <?dbhtml dir="manpages"?>\r
 100       <?dbhtml filename="index.html"?>\r
 101       <xi:include href="../manpages/param.xml" xpointer="xpointer(/book/info/title)" />\r
 102       <partintro xml:id="manintro">\r
 103         <xi:include href="../manpages/param.xml" xpointer="xpointer(/book/info/abstract/node())" />\r
 104       </partintro>\r
 105       <xi:include href="../manpages/param.xml" xpointer="xpointer(/book/reference)" />\r
 106     </part>\r
 107     <part xml:id="roundtrip">\r
 108       <?dbhtml dir="roundtrip"?>\r
 109       <?dbhtml filename="index.html"?>\r
 110       <xi:include href="../roundtrip/param.xml" xpointer="xpointer(/book/info/title)" />\r
 111       <partintro xml:id="roundtripintro">\r
 112         <xi:include href="../roundtrip/param.xml" xpointer="xpointer(/book/info/abstract/node())" />\r
 113       </partintro>\r
 114       <xi:include href="../roundtrip/param.xml" xpointer="xpointer(/book/reference/node()[not(self::title)])" />\r
 115     </part>\r
 116     <part xml:id="slides"><title>Slides Parameter Reference</title>\r
 117       <?dbhtml dir="slides"?>\r
 118       <?dbhtml filename="index.html"?>\r
 119       <partintro xml:id="slidesintro">\r
 120         <para>This is reference documentation for all\r
 121           user-configurable parameters in the DocBook XSL Slides\r
 122           stylesheets (for generating HTML and PDF slide\r
 123           presentations).</para>\r
 124         <note>\r
 125           <para>The Slides stylesheet for HTML output is a\r
 126             customization layer of the DocBook XSL HTML\r
 127             stylesheet; the Slides stylesheet for FO output is a\r
 128             customization layer of the DocBook XSL FO stylesheet.\r
 129             Therefore, in addition to the slides-specific\r
 130             parameters listed in this section, you can also use a\r
 131             number of <link xlink:href="../html">HTML stylesheet\r
 132               parameters</link> and <link xlink:href="../fo">FO\r
 133               stylesheet parameters</link> to control Slides\r
 134             output.</para>\r
 135         </note>\r
 136       </partintro>\r
 137       <xi:include href="../slides/html/param.xml" xpointer="xpointer(/book/reference)" />\r
 138       <xi:include href="../slides/fo/param.xml" xpointer="xpointer(/book/reference)" />\r
 139     </part>\r
 140     <part xml:id="website">\r
 141       <?dbhtml dir="website"?>\r
 142       <?dbhtml filename="index.html"?>\r
 143       <xi:include href="../website/param.xml" xpointer="xpointer(/book/info/title)" />\r
 144       <partintro xml:id="websiteintro">\r
 145         <xi:include href="../website/param.xml" xpointer="xpointer(/book/info/abstract/node())" />\r
 146       </partintro>\r
 147       <xi:include href="../website/param.xml" xpointer="xpointer(/book/reference)" />\r
 148     </part>\r
 149   </book>\r
 150   <book xml:id="pi"><title>DocBook XSL Stylesheets User Reference: PIs</title>\r
 151     <?dbhtml dir="pi"?>\r
 152     <?dbhtml filename="index.html"?>\r
 153     <info>\r
 154       <abstract>\r
 155         <para>This is generated reference documentation for all\r
 156           user-specifiable processing instructions in the DocBook\r
 157           XSL stylesheets.\r
 158           <note>\r
 159             <para>You add these PIs at particular points in a document to\r
 160               cause specific “exceptions” to formatting/output behavior. To\r
 161               make global changes in formatting/output behavior across an\r
 162               entire document, it’s better to do it by setting an\r
 163               appropriate stylesheet parameter (if there is one).</para>\r
 164           </note>\r
 165         </para>\r
 166       </abstract>\r
 167     </info>\r
 168     <part xml:id="pi-html">\r
 169       <xi:include href="../html/pi.xml" xpointer="xpointer(/reference/node())" />\r
 170     </part>\r
 171     <part xml:id="pi-fo">\r
 172       <xi:include href="../fo/pi.xml" xpointer="xpointer(/reference/node())" />\r
 173     </part>\r
 174     <part xml:id="pi-man">\r
 175       <xi:include href="../manpages/pi.xml" xpointer="xpointer(/reference/node())" />\r
 176     </part>\r
 177     <part xml:id="pi-common">\r
 178       <xi:include href="../common/pi.xml" xpointer="xpointer(/reference/node())" />\r
 179     </part>\r
 180   </book>\r
 181   <book xml:id="developer"><title>DocBook XSL Stylesheets Developer Reference</title>\r
 182     <info>\r
 183       <abstract>\r
 184         <para>This is technical reference documentation for\r
 185           developers using the DocBook XSL Stylesheets. It is not\r
 186           intended to be user documentation, but is instead\r
 187           provided for developers writing customization layers for\r
 188           the stylesheets.</para>\r
 189       </abstract>\r
 190     </info>\r
 191     <part xml:id="lib">\r
 192       <?dbhtml dir="lib"?>\r
 193       <?dbhtml filename="index.html"?>\r
 194       <xi:include href="../lib/lib.xml" xpointer="xpointer(/book/info/title)" />\r
 195       <partintro xml:id="libintro">\r
 196         <xi:include href="../lib/lib.xml" xpointer="xpointer(/book/info/abstract/node())" />\r
 197       </partintro>\r
 198       <xi:include href="../lib/lib.xml" xpointer="xpointer(/book/reference)" />\r
 199     </part>\r
 200     <part xml:id="common-part"><title>Common Template Reference</title>\r
 201       <?dbhtml dir="common"?>\r
 202       <?dbhtml filename="index.html"?>\r
 203       <info>\r
 204         <abstract>\r
 205           <para>This is technical reference documentation for the\r
 206             “base”, “refentry”, and “utility” sets of common\r
 207             templates in the DocBook XSL Stylesheets. These\r
 208             templates are “common” in that they are shared across\r
 209             output formats (that is, they’re not\r
 210             output-format-dependent)</para>\r
 211           <para>This documentation is not intended to be user\r
 212             documentation. It is provided for developers writing\r
 213             customization layers for the stylesheets.</para>\r
 214         </abstract>\r
 215       </info>\r
 216         <xi:include href="../common/common.xml"/>\r
 217         <xi:include href="../common/refentry.xml"/>\r
 218         <xi:include href="../common/utility.xml"/>\r
 219         <xi:include href="../common/charmap.xml"/>\r
 220     </part>\r
 221     <part xml:id="table-templates">\r
 222       <xi:include href="../fo/table.xml" xpointer="xpointer(/reference/node())"/>\r
 223     </part>\r
 224     <part xml:id="template"> \r
 225       <xi:include href="../template/titlepage.xml" xpointer="xpointer(/reference/node())"/>\r
 226     </part>\r
 227   </book>\r
 228 </set>\r
 229 <!-- * vim: set ft=docbk foldlevel=2: -->\r