docsrc/reference.xml

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