| 1 | <?xml version='1.0'?>
|
|---|
| 2 | <xsl:stylesheet
|
|---|
| 3 | xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
|
|---|
| 4 | xmlns:doc="http://nwalsh.com/xsl/documentation/1.0"
|
|---|
| 5 | xmlns:fo="http://www.w3.org/1999/XSL/Format"
|
|---|
| 6 | xmlns:xlink="http://www.w3.org/1999/xlink"
|
|---|
| 7 | exclude-result-prefixes="doc"
|
|---|
| 8 | version='1.0'>
|
|---|
| 9 |
|
|---|
| 10 | <!-- ********************************************************************
|
|---|
| 11 | $Id$
|
|---|
| 12 | ********************************************************************
|
|---|
| 13 |
|
|---|
| 14 | This file is part of the XSL DocBook Stylesheet distribution.
|
|---|
| 15 | See ../README or http://docbook.sf.net/release/xsl/current/ for
|
|---|
| 16 | copyright and other information.
|
|---|
| 17 |
|
|---|
| 18 | ******************************************************************** -->
|
|---|
| 19 |
|
|---|
| 20 | <doc:reference xmlns=""><info><title>FO Processing Instruction Reference</title>
|
|---|
| 21 | <releaseinfo role="meta">
|
|---|
| 22 | $Id$
|
|---|
| 23 | </releaseinfo>
|
|---|
| 24 | </info>
|
|---|
| 25 |
|
|---|
| 26 | <partintro id="partintro">
|
|---|
| 27 | <title>Introduction</title>
|
|---|
| 28 |
|
|---|
| 29 | <para>This is generated reference documentation for all
|
|---|
| 30 | user-specifiable processing instructions (PIs) in the DocBook
|
|---|
| 31 | XSL stylesheets for FO output.
|
|---|
| 32 | <note>
|
|---|
| 33 | <para>You add these PIs at particular points in a document to
|
|---|
| 34 | cause specific “exceptions” to formatting/output behavior. To
|
|---|
| 35 | make global changes in formatting/output behavior across an
|
|---|
| 36 | entire document, it’s better to do it by setting an
|
|---|
| 37 | appropriate stylesheet parameter (if there is one).</para>
|
|---|
| 38 | </note>
|
|---|
| 39 | </para>
|
|---|
| 40 | </partintro>
|
|---|
| 41 | </doc:reference>
|
|---|
| 42 |
|
|---|
| 43 | <!-- ==================================================================== -->
|
|---|
| 44 |
|
|---|
| 45 | <doc:pi name="dbfo_background-color" xmlns="">
|
|---|
| 46 | <refpurpose>Sets background color for an image</refpurpose>
|
|---|
| 47 | <refdescription>
|
|---|
| 48 | <para>Use the <tag class="xmlpi">dbfo background-color</tag> PI before or
|
|---|
| 49 | after an image (<tag>graphic</tag>, <tag>inlinegraphic</tag>,
|
|---|
| 50 | <tag>imagedata</tag>, or <tag>videodata</tag> element) as a
|
|---|
| 51 | sibling to the element, to set a background color for the
|
|---|
| 52 | image.</para>
|
|---|
| 53 | </refdescription>
|
|---|
| 54 | <refsynopsisdiv>
|
|---|
| 55 | <synopsis><tag class="xmlpi">dbfo background-color="<replaceable>color</replaceable>"</tag></synopsis>
|
|---|
| 56 | </refsynopsisdiv>
|
|---|
| 57 | <refparameter>
|
|---|
| 58 | <variablelist>
|
|---|
| 59 | <varlistentry><term>background-color="<replaceable>color</replaceable>"</term>
|
|---|
| 60 | <listitem>
|
|---|
| 61 | <para>An HTML color value</para>
|
|---|
| 62 | </listitem>
|
|---|
| 63 | </varlistentry>
|
|---|
| 64 | </variablelist>
|
|---|
| 65 | </refparameter>
|
|---|
| 66 | <refsee role="tcg">
|
|---|
| 67 | <para><link role="tcg"
|
|---|
| 68 | xlink:href="BGcolor.html"
|
|---|
| 69 | >Background color</link></para>
|
|---|
| 70 | </refsee>
|
|---|
| 71 | </doc:pi>
|
|---|
| 72 | <xsl:template name="pi.dbfo_background-color">
|
|---|
| 73 | <xsl:param name="node" select="."/>
|
|---|
| 74 | <xsl:call-template name="dbfo-attribute">
|
|---|
| 75 | <xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
|
|---|
| 76 | <xsl:with-param name="attribute" select="'background-color'"/>
|
|---|
| 77 | </xsl:call-template>
|
|---|
| 78 | </xsl:template>
|
|---|
| 79 |
|
|---|
| 80 | <doc:pi name="dbfo_bgcolor" xmlns="">
|
|---|
| 81 | <refpurpose>Sets background color on a table row or table cell</refpurpose>
|
|---|
| 82 | <refdescription>
|
|---|
| 83 | <para>Use the <tag class="xmlpi">dbfo bgcolor</tag> PI as child of a table row
|
|---|
| 84 | or cell to set a background color for that table row or cell.</para>
|
|---|
| 85 | </refdescription>
|
|---|
| 86 | <refsynopsisdiv>
|
|---|
| 87 | <synopsis><tag class="xmlpi">dbfo bgcolor="<replaceable>color</replaceable>"</tag></synopsis>
|
|---|
| 88 | </refsynopsisdiv>
|
|---|
| 89 | <refparameter>
|
|---|
| 90 | <variablelist>
|
|---|
| 91 | <varlistentry><term>bgcolor="<replaceable>color</replaceable>"</term>
|
|---|
| 92 | <listitem>
|
|---|
| 93 | <para>An HTML color value</para>
|
|---|
| 94 | </listitem>
|
|---|
| 95 | </varlistentry>
|
|---|
| 96 | </variablelist>
|
|---|
| 97 | </refparameter>
|
|---|
| 98 | <refsee role="tcg">
|
|---|
| 99 | <para><link role="tcg"
|
|---|
| 100 | xlink:href="BGtableColor.html#CellBGColor"
|
|---|
| 101 | >Cell background color</link></para>
|
|---|
| 102 | </refsee>
|
|---|
| 103 | </doc:pi>
|
|---|
| 104 | <xsl:template name="pi.dbfo_bgcolor">
|
|---|
| 105 | <xsl:param name="node" select="."/>
|
|---|
| 106 | <xsl:call-template name="dbfo-attribute">
|
|---|
| 107 | <xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
|
|---|
| 108 | <xsl:with-param name="attribute" select="'bgcolor'"/>
|
|---|
| 109 | </xsl:call-template>
|
|---|
| 110 | </xsl:template>
|
|---|
| 111 |
|
|---|
| 112 | <doc:pi name="dbfo_float-type" xmlns="">
|
|---|
| 113 | <refpurpose>Specifies float behavior for a sidebar</refpurpose>
|
|---|
| 114 | <refdescription>
|
|---|
| 115 | <para>Use the <tag class="xmlpi">dbfo float-type</tag> PI to specify the float
|
|---|
| 116 | behavior for a <tag>sidebar</tag> (to cause the sidebar to be
|
|---|
| 117 | displayed as a marginal note).</para>
|
|---|
| 118 | </refdescription>
|
|---|
| 119 | <refsynopsisdiv>
|
|---|
| 120 | <synopsis><tag class="xmlpi">dbfo float-type="margin.note"</tag></synopsis>
|
|---|
| 121 | </refsynopsisdiv>
|
|---|
| 122 | <refparameter>
|
|---|
| 123 | <variablelist>
|
|---|
| 124 | <varlistentry><term>float-type="margin.note"</term>
|
|---|
| 125 | <listitem>
|
|---|
| 126 | <para>Specifies that the <tag>sidebar</tag> should be
|
|---|
| 127 | displayed as a marginal note.</para>
|
|---|
| 128 | </listitem>
|
|---|
| 129 | </varlistentry>
|
|---|
| 130 | </variablelist>
|
|---|
| 131 | </refparameter>
|
|---|
| 132 | <refsee role="params">
|
|---|
| 133 | <para><parameter>sidebar.float.type parameter</parameter>,
|
|---|
| 134 | <parameter>sidebar.float.width parameter</parameter>,
|
|---|
| 135 | <parameter>sidebar.properties attribute-set</parameter>,
|
|---|
| 136 | <parameter>sidebar.title.properties</parameter>
|
|---|
| 137 | </para>
|
|---|
| 138 | </refsee>
|
|---|
| 139 | <refsee role="tcg">
|
|---|
| 140 | <para><link xlink:href="SideFloats.html#SidebarFloats" >A sidebar as
|
|---|
| 141 | side float</link></para>
|
|---|
| 142 | </refsee>
|
|---|
| 143 | </doc:pi>
|
|---|
| 144 | <xsl:template name="pi.dbfo_float-type">
|
|---|
| 145 | <xsl:param name="node" select="."/>
|
|---|
| 146 | <xsl:call-template name="dbfo-attribute">
|
|---|
| 147 | <xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
|
|---|
| 148 | <xsl:with-param name="attribute" select="'float-type'"/>
|
|---|
| 149 | </xsl:call-template>
|
|---|
| 150 | </xsl:template>
|
|---|
| 151 |
|
|---|
| 152 | <doc:pi name="dbfo_glossary-presentation" xmlns="">
|
|---|
| 153 | <refpurpose>Specifies presentation style for a glossary</refpurpose>
|
|---|
| 154 | <refdescription>
|
|---|
| 155 | <para>Use the <tag class="xmlpi">dbfo glossary-presentation</tag> PI as a child of
|
|---|
| 156 | a <tag>glossary</tag> to control its presentation style.</para>
|
|---|
| 157 | </refdescription>
|
|---|
| 158 | <refsynopsisdiv>
|
|---|
| 159 | <synopsis><tag class="xmlpi">dbfo glossary-presentation="list"|"blocks"</tag></synopsis>
|
|---|
| 160 | </refsynopsisdiv>
|
|---|
| 161 | <refparameter>
|
|---|
| 162 | <variablelist>
|
|---|
| 163 | <varlistentry><term>glossary-presentation="list"</term>
|
|---|
| 164 | <listitem>
|
|---|
| 165 | <para>Displays the glossary as a list</para>
|
|---|
| 166 | </listitem>
|
|---|
| 167 | </varlistentry>
|
|---|
| 168 | <varlistentry><term>glossary-presentation="blocks"</term>
|
|---|
| 169 | <listitem>
|
|---|
| 170 | <para>Displays the glossary as blocks</para>
|
|---|
| 171 | </listitem>
|
|---|
| 172 | </varlistentry>
|
|---|
| 173 | </variablelist>
|
|---|
| 174 | </refparameter>
|
|---|
| 175 | <refsee role="params">
|
|---|
| 176 | <para><parameter>glossary.as.blocks</parameter></para>
|
|---|
| 177 | </refsee>
|
|---|
| 178 | <refsee role="tcg">
|
|---|
| 179 | <para><link xlink:href="Glossaries.html#GlossaryFormatPrint" >Glossary
|
|---|
| 180 | formatting in print</link></para>
|
|---|
| 181 | </refsee>
|
|---|
| 182 | </doc:pi>
|
|---|
| 183 | <xsl:template name="pi.dbfo_glossary-presentation">
|
|---|
| 184 | <xsl:param name="node" select="."/>
|
|---|
| 185 | <xsl:call-template name="dbfo-attribute">
|
|---|
| 186 | <xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
|
|---|
| 187 | <xsl:with-param name="attribute" select="'glossary-presentation'"/>
|
|---|
| 188 | </xsl:call-template>
|
|---|
| 189 | </xsl:template>
|
|---|
| 190 |
|
|---|
| 191 | <doc:pi name="dbfo_glosslist-presentation" xmlns="">
|
|---|
| 192 | <refpurpose>Specifies presentation style for a glosslist</refpurpose>
|
|---|
| 193 | <refdescription>
|
|---|
| 194 | <para>Use the <tag class="xmlpi">dbfo glosslist-presentation</tag> PI as a child of
|
|---|
| 195 | a <tag>glosslist</tag> to control its presentation style.</para>
|
|---|
| 196 | </refdescription>
|
|---|
| 197 | <refsynopsisdiv>
|
|---|
| 198 | <synopsis><tag class="xmlpi">dbfo glosslist-presentation="list"|"blocks"</tag></synopsis>
|
|---|
| 199 | </refsynopsisdiv>
|
|---|
| 200 | <refparameter>
|
|---|
| 201 | <variablelist>
|
|---|
| 202 | <varlistentry><term>glosslist-presentation="list"</term>
|
|---|
| 203 | <listitem>
|
|---|
| 204 | <para>Displays the glosslist as a list</para>
|
|---|
| 205 | </listitem>
|
|---|
| 206 | </varlistentry>
|
|---|
| 207 | <varlistentry><term>glosslist-presentation="blocks"</term>
|
|---|
| 208 | <listitem>
|
|---|
| 209 | <para>Displays the glosslist as blocks</para>
|
|---|
| 210 | </listitem>
|
|---|
| 211 | </varlistentry>
|
|---|
| 212 | </variablelist>
|
|---|
| 213 | </refparameter>
|
|---|
| 214 | <refsee role="params">
|
|---|
| 215 | <para><parameter>glosslist.as.blocks</parameter> </para>
|
|---|
| 216 | </refsee>
|
|---|
| 217 | <refsee role="tcg">
|
|---|
| 218 | <para><link xlink:href="Glossaries.html#GlossaryFormatPrint" >Glossary
|
|---|
| 219 | formatting in print</link></para>
|
|---|
| 220 | </refsee>
|
|---|
| 221 | </doc:pi>
|
|---|
| 222 | <xsl:template name="pi.dbfo_glosslist-presentation">
|
|---|
| 223 | <xsl:param name="node" select="."/>
|
|---|
| 224 | <xsl:call-template name="dbfo-attribute">
|
|---|
| 225 | <xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
|
|---|
| 226 | <xsl:with-param name="attribute" select="'glosslist-presentation'"/>
|
|---|
| 227 | </xsl:call-template>
|
|---|
| 228 | </xsl:template>
|
|---|
| 229 |
|
|---|
| 230 | <doc:pi name="dbfo_glossterm-width" xmlns="">
|
|---|
| 231 | <refpurpose>Specifies the glossterm width for a glossary or
|
|---|
| 232 | glosslist</refpurpose>
|
|---|
| 233 | <refdescription>
|
|---|
| 234 | <para>Use the <tag class="xmlpi">dbfo glossterm-width</tag> PI as a child of a
|
|---|
| 235 | <tag>glossary</tag> or <tag>glosslist</tag> to specify the
|
|---|
| 236 | width for output of <tag>glossterm</tag> instances in the
|
|---|
| 237 | output.</para>
|
|---|
| 238 | </refdescription>
|
|---|
| 239 | <refsynopsisdiv>
|
|---|
| 240 | <synopsis><tag class="xmlpi">dbfo glossterm-width="<replaceable>width</replaceable>"</tag></synopsis>
|
|---|
| 241 | </refsynopsisdiv>
|
|---|
| 242 | <refparameter>
|
|---|
| 243 | <variablelist>
|
|---|
| 244 | <varlistentry><term>glossterm-width="<replaceable>width</replaceable>"</term>
|
|---|
| 245 | <listitem>
|
|---|
| 246 | <para>Specifies the glossterm width (including units)</para>
|
|---|
| 247 | </listitem>
|
|---|
| 248 | </varlistentry>
|
|---|
| 249 | </variablelist>
|
|---|
| 250 | </refparameter>
|
|---|
| 251 | <refsee role="params">
|
|---|
| 252 | <para><parameter>glossterm.width</parameter>,
|
|---|
| 253 | <parameter>glossterm.separation</parameter>
|
|---|
| 254 | </para>
|
|---|
| 255 | </refsee>
|
|---|
| 256 | <refsee role="tcg">
|
|---|
| 257 | <para><link xlink:href="Glossaries.html#GlossaryFormatPrint" >Glossary
|
|---|
| 258 | formatting in print</link></para>
|
|---|
| 259 | </refsee>
|
|---|
| 260 | </doc:pi>
|
|---|
| 261 | <xsl:template name="pi.dbfo_glossterm-width">
|
|---|
| 262 | <xsl:param name="node" select="."/>
|
|---|
| 263 | <xsl:call-template name="dbfo-attribute">
|
|---|
| 264 | <xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
|
|---|
| 265 | <xsl:with-param name="attribute" select="'glossterm-width'"/>
|
|---|
| 266 | </xsl:call-template>
|
|---|
| 267 | </xsl:template>
|
|---|
| 268 |
|
|---|
| 269 | <doc:pi name="dbfo_keep-together" xmlns="">
|
|---|
| 270 | <refpurpose>Specifies “keep” behavior for a table, example,
|
|---|
| 271 | figure, or equation</refpurpose>
|
|---|
| 272 | <refdescription>
|
|---|
| 273 | <para>Use the <tag class="xmlpi">dbfo keep-together</tag> PI as a child of a
|
|---|
| 274 | formal object (<tag>table</tag>, <tag>example</tag>,
|
|---|
| 275 | <tag>figure</tag>, or <tag>equation</tag>) or their informal
|
|---|
| 276 | equivalents) to specify “keep” behavior for the object (to
|
|---|
| 277 | allow the object to “break” across a page).</para>
|
|---|
| 278 | </refdescription>
|
|---|
| 279 | <refsynopsisdiv>
|
|---|
| 280 | <synopsis><tag class="xmlpi">dbfo keep-together="auto"|"always"</tag></synopsis>
|
|---|
| 281 | </refsynopsisdiv>
|
|---|
| 282 | <refparameter>
|
|---|
| 283 | <variablelist>
|
|---|
| 284 | <varlistentry><term>keep-together="auto"</term>
|
|---|
| 285 | <listitem>
|
|---|
| 286 | <para>Enables the object to break across a page</para>
|
|---|
| 287 | </listitem>
|
|---|
| 288 | </varlistentry>
|
|---|
| 289 | <varlistentry><term>keep-together="always"</term>
|
|---|
| 290 | <listitem>
|
|---|
| 291 | <para>Prevents the object from breaking across a page (the
|
|---|
| 292 | default stylesheet behavior)</para>
|
|---|
| 293 | </listitem>
|
|---|
| 294 | </varlistentry>
|
|---|
| 295 | </variablelist>
|
|---|
| 296 | </refparameter>
|
|---|
| 297 | <refsee role="params">
|
|---|
| 298 | <para>formal.object.properties</para>
|
|---|
| 299 | </refsee>
|
|---|
| 300 | <refsee role="tcg">
|
|---|
| 301 | <para><link xlink:href="PageBreaking.html#KeepTogetherPI"
|
|---|
| 302 | >Keep-together processing instruction</link></para>
|
|---|
| 303 | </refsee>
|
|---|
| 304 | </doc:pi>
|
|---|
| 305 | <xsl:template name="pi.dbfo_keep-together">
|
|---|
| 306 | <xsl:param name="node" select="."/>
|
|---|
| 307 | <xsl:call-template name="dbfo-attribute">
|
|---|
| 308 | <xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
|
|---|
| 309 | <xsl:with-param name="attribute" select="'keep-together'"/>
|
|---|
| 310 | </xsl:call-template>
|
|---|
| 311 | </xsl:template>
|
|---|
| 312 |
|
|---|
| 313 | <doc:pi name="dbfo_label-width" xmlns="">
|
|---|
| 314 | <refpurpose>Specifies the label width for a qandaset</refpurpose>
|
|---|
| 315 | <refdescription>
|
|---|
| 316 | <para>Use the <tag class="xmlpi">dbfo label-width</tag> PI as a child of a
|
|---|
| 317 | <tag>qandaset</tag> to specify the width of labels.</para>
|
|---|
| 318 | </refdescription>
|
|---|
| 319 | <refsynopsisdiv>
|
|---|
| 320 | <synopsis><tag class="xmlpi">dbfo label-width="<replaceable>width</replaceable>"</tag></synopsis>
|
|---|
| 321 | </refsynopsisdiv>
|
|---|
| 322 | <refparameter>
|
|---|
| 323 | <variablelist>
|
|---|
| 324 | <varlistentry><term>label-width="<replaceable>width</replaceable>"</term>
|
|---|
| 325 | <listitem>
|
|---|
| 326 | <para>Specifies the label width (including units)</para>
|
|---|
| 327 | </listitem>
|
|---|
| 328 | </varlistentry>
|
|---|
| 329 | </variablelist>
|
|---|
| 330 | </refparameter>
|
|---|
| 331 | <refsee role="tcg">
|
|---|
| 332 | <para><link role="tcg"
|
|---|
| 333 | xlink:href="QandAformat.html"
|
|---|
| 334 | >Q and A formatting</link></para>
|
|---|
| 335 | </refsee>
|
|---|
| 336 | </doc:pi>
|
|---|
| 337 | <xsl:template name="pi.dbfo_label-width">
|
|---|
| 338 | <xsl:param name="node" select="."/>
|
|---|
| 339 | <xsl:call-template name="dbfo-attribute">
|
|---|
| 340 | <xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
|
|---|
| 341 | <xsl:with-param name="attribute" select="'label-width'"/>
|
|---|
| 342 | </xsl:call-template>
|
|---|
| 343 | </xsl:template>
|
|---|
| 344 |
|
|---|
| 345 | <doc:pi name="dbfo_linenumbering.everyNth" xmlns="">
|
|---|
| 346 | <refpurpose>Specifies interval for lines numbers in verbatims</refpurpose>
|
|---|
| 347 | <refdescription>
|
|---|
| 348 | <para>Use the <tag class="xmlpi">dbfo linenumbering.everyNth</tag> PI as a child
|
|---|
| 349 | of a “verbatim” element – <tag>programlisting</tag>,
|
|---|
| 350 | <tag>screen</tag>, <tag>synopsis</tag> — to specify
|
|---|
| 351 | the interval at which lines are numbered.</para>
|
|---|
| 352 | </refdescription>
|
|---|
| 353 | <refsynopsisdiv>
|
|---|
| 354 | <synopsis><tag class="xmlpi">dbfo linenumbering.everyNth="<replaceable>N</replaceable>"</tag></synopsis>
|
|---|
| 355 | </refsynopsisdiv>
|
|---|
| 356 | <refparameter>
|
|---|
| 357 | <variablelist>
|
|---|
| 358 | <varlistentry><term>linenumbering.everyNth="<replaceable>N</replaceable>"</term>
|
|---|
| 359 | <listitem>
|
|---|
| 360 | <para>Specifies numbering interval; a number is output
|
|---|
| 361 | before every <replaceable>N</replaceable>th line</para>
|
|---|
| 362 | </listitem>
|
|---|
| 363 | </varlistentry>
|
|---|
| 364 | </variablelist>
|
|---|
| 365 | </refparameter>
|
|---|
| 366 | <refsee role="params">
|
|---|
| 367 | <para><parameter>linenumbering.everyNth</parameter></para>
|
|---|
| 368 | </refsee>
|
|---|
| 369 | <refsee role="tcg">
|
|---|
| 370 | <para><link role="tcg"
|
|---|
| 371 | xlink:href="AnnotateListing.html#LineNumbering"
|
|---|
| 372 | >Line numbering</link></para>
|
|---|
| 373 | </refsee>
|
|---|
| 374 | </doc:pi>
|
|---|
| 375 | <xsl:template name="pi.dbfo_linenumbering.everyNth">
|
|---|
| 376 | <xsl:param name="node" select="."/>
|
|---|
| 377 | <xsl:call-template name="dbfo-attribute">
|
|---|
| 378 | <xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
|
|---|
| 379 | <xsl:with-param name="attribute" select="'linenumbering.everyNth'"/>
|
|---|
| 380 | </xsl:call-template>
|
|---|
| 381 | </xsl:template>
|
|---|
| 382 |
|
|---|
| 383 | <doc:pi name="dbfo_linenumbering.separator" xmlns="">
|
|---|
| 384 | <refpurpose>Specifies separator text for line numbers in verbatims</refpurpose>
|
|---|
| 385 | <refdescription>
|
|---|
| 386 | <para>Use the <tag class="xmlpi">dbfo linenumbering.separator</tag> PI as a child
|
|---|
| 387 | of a “verbatim” element – <tag>programlisting</tag>,
|
|---|
| 388 | <tag>screen</tag>, <tag>synopsis</tag> — to specify
|
|---|
| 389 | the separator text output between the line numbers and content.</para>
|
|---|
| 390 | </refdescription>
|
|---|
| 391 | <refsynopsisdiv>
|
|---|
| 392 | <synopsis><tag class="xmlpi">dbfo linenumbering.separator="<replaceable>text</replaceable>"</tag></synopsis>
|
|---|
| 393 | </refsynopsisdiv>
|
|---|
| 394 | <refparameter>
|
|---|
| 395 | <variablelist>
|
|---|
| 396 | <varlistentry><term>linenumbering.separator="<replaceable>text</replaceable>"</term>
|
|---|
| 397 | <listitem>
|
|---|
| 398 | <para>Specifies the text (zero or more characters)</para>
|
|---|
| 399 | </listitem>
|
|---|
| 400 | </varlistentry>
|
|---|
| 401 | </variablelist>
|
|---|
| 402 | </refparameter>
|
|---|
| 403 | <refsee role="params">
|
|---|
| 404 | <para><parameter>linenumbering.separator</parameter></para>
|
|---|
| 405 | </refsee>
|
|---|
| 406 | <refsee role="tcg">
|
|---|
| 407 | <para><link role="tcg"
|
|---|
| 408 | xlink:href="AnnotateListing.html#LineNumbering"
|
|---|
| 409 | >Line numbering</link></para>
|
|---|
| 410 | </refsee>
|
|---|
| 411 | </doc:pi>
|
|---|
| 412 | <xsl:template name="pi.dbfo_linenumbering.separator">
|
|---|
| 413 | <xsl:param name="node" select="."/>
|
|---|
| 414 | <xsl:call-template name="dbfo-attribute">
|
|---|
| 415 | <xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
|
|---|
| 416 | <xsl:with-param name="attribute" select="'linenumbering.separator'"/>
|
|---|
| 417 | </xsl:call-template>
|
|---|
| 418 | </xsl:template>
|
|---|
| 419 |
|
|---|
| 420 | <doc:pi name="dbfo_linenumbering.width" xmlns="">
|
|---|
| 421 | <refpurpose>Specifies width for line numbers in verbatims</refpurpose>
|
|---|
| 422 | <refdescription>
|
|---|
| 423 | <para>Use the <tag class="xmlpi">dbfo linenumbering.width</tag> PI as a child
|
|---|
| 424 | of a “verbatim” element – <tag>programlisting</tag>,
|
|---|
| 425 | <tag>screen</tag>, <tag>synopsis</tag> — to specify
|
|---|
| 426 | the width set aside for line numbers.</para>
|
|---|
| 427 | </refdescription>
|
|---|
| 428 | <refsynopsisdiv>
|
|---|
| 429 | <synopsis><tag class="xmlpi">dbfo linenumbering.width="<replaceable>width</replaceable>"</tag></synopsis>
|
|---|
| 430 | </refsynopsisdiv>
|
|---|
| 431 | <refparameter>
|
|---|
| 432 | <variablelist>
|
|---|
| 433 | <varlistentry><term>linenumbering.width="<replaceable>width</replaceable>"</term>
|
|---|
| 434 | <listitem>
|
|---|
| 435 | <para>Specifies the width (inluding units)</para>
|
|---|
| 436 | </listitem>
|
|---|
| 437 | </varlistentry>
|
|---|
| 438 | </variablelist>
|
|---|
| 439 | </refparameter>
|
|---|
| 440 | <refsee role="params">
|
|---|
| 441 | <para><parameter>linenumbering.width</parameter></para>
|
|---|
| 442 | </refsee>
|
|---|
| 443 | <refsee role="tcg">
|
|---|
| 444 | <para><link role="tcg"
|
|---|
| 445 | xlink:href="AnnotateListing.html#LineNumbering"
|
|---|
| 446 | >Line numbering</link></para>
|
|---|
| 447 | </refsee>
|
|---|
| 448 | </doc:pi>
|
|---|
| 449 | <xsl:template name="pi.dbfo_linenumbering.width">
|
|---|
| 450 | <xsl:param name="node" select="."/>
|
|---|
| 451 | <xsl:call-template name="dbfo-attribute">
|
|---|
| 452 | <xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
|
|---|
| 453 | <xsl:with-param name="attribute" select="'linenumbering.width'"/>
|
|---|
| 454 | </xsl:call-template>
|
|---|
| 455 | </xsl:template>
|
|---|
| 456 |
|
|---|
| 457 | <doc:pi name="dbfo_list-presentation" xmlns="">
|
|---|
| 458 | <refpurpose>Specifies presentation style for a variablelist or
|
|---|
| 459 | segmentedlist</refpurpose>
|
|---|
| 460 | <refdescription>
|
|---|
| 461 | <para>Use the <tag class="xmlpi">dbfo list-presentation</tag> PI as a child of
|
|---|
| 462 | a <tag>variablelist</tag> or <tag>segmentedlist</tag> to
|
|---|
| 463 | control the presentation style for the list (to cause it, for
|
|---|
| 464 | example, to be displayed as a table).</para>
|
|---|
| 465 | </refdescription>
|
|---|
| 466 | <refsynopsisdiv>
|
|---|
| 467 | <synopsis><tag class="xmlpi">dbfo list-presentation="list"|"blocks"|"table"</tag></synopsis>
|
|---|
| 468 | </refsynopsisdiv>
|
|---|
| 469 | <refparameter>
|
|---|
| 470 | <variablelist>
|
|---|
| 471 | <varlistentry><term>list-presentation="list"</term>
|
|---|
| 472 | <listitem>
|
|---|
| 473 | <para>Displays the list as a list</para>
|
|---|
| 474 | </listitem>
|
|---|
| 475 | </varlistentry>
|
|---|
| 476 | <varlistentry><term>list-presentation="blocks"</term>
|
|---|
| 477 | <listitem>
|
|---|
| 478 | <para>(<tag>variablelist</tag> only) Displays the list as blocks</para>
|
|---|
| 479 | </listitem>
|
|---|
| 480 | </varlistentry>
|
|---|
| 481 | <varlistentry><term>list-presentation="table"</term>
|
|---|
| 482 | <listitem>
|
|---|
| 483 | <para>(<tag>segmentedlist</tag> only) Displays the list as a table</para>
|
|---|
| 484 | </listitem>
|
|---|
| 485 | </varlistentry>
|
|---|
| 486 | </variablelist>
|
|---|
| 487 | </refparameter>
|
|---|
| 488 | <refsee role="params">
|
|---|
| 489 | <itemizedlist>
|
|---|
| 490 | <listitem>
|
|---|
| 491 | <para><parameter>variablelist.as.blocks</parameter></para>
|
|---|
| 492 | </listitem>
|
|---|
| 493 | <listitem>
|
|---|
| 494 | <para><parameter>variablelist.as.table</parameter></para>
|
|---|
| 495 | </listitem>
|
|---|
| 496 | </itemizedlist>
|
|---|
| 497 | </refsee>
|
|---|
| 498 | <refsee role="tcg">
|
|---|
| 499 | <para><link role="tcg"
|
|---|
| 500 | xlink:href="Variablelists.html#ListIndents"
|
|---|
| 501 | >Variable list formatting in print</link></para>
|
|---|
| 502 | </refsee>
|
|---|
| 503 | </doc:pi>
|
|---|
| 504 | <xsl:template name="pi.dbfo_list-presentation">
|
|---|
| 505 | <xsl:param name="node" select="."/>
|
|---|
| 506 | <xsl:call-template name="dbfo-attribute">
|
|---|
| 507 | <xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
|
|---|
| 508 | <xsl:with-param name="attribute" select="'list-presentation'"/>
|
|---|
| 509 | </xsl:call-template>
|
|---|
| 510 | </xsl:template>
|
|---|
| 511 |
|
|---|
| 512 | <doc:pi name="dbfo_list-width" xmlns="">
|
|---|
| 513 | <refpurpose>Specifies the width of a horizontal simplelist</refpurpose>
|
|---|
| 514 | <refdescription>
|
|---|
| 515 | <para>Use the <tag class="xmlpi">dbfo list-width</tag> PI as a child of a
|
|---|
| 516 | <tag>simplelist</tag> whose <tag class="attribute">class</tag>
|
|---|
| 517 | value is <literal>horizontal</literal>, to specify the width
|
|---|
| 518 | of the <tag>simplelist</tag>.</para>
|
|---|
| 519 | </refdescription>
|
|---|
| 520 | <refsynopsisdiv>
|
|---|
| 521 | <synopsis><tag class="xmlpi">dbfo list-width="<replaceable>width</replaceable>"</tag></synopsis>
|
|---|
| 522 | </refsynopsisdiv>
|
|---|
| 523 | <refparameter>
|
|---|
| 524 | <variablelist>
|
|---|
| 525 | <varlistentry><term>list-width="<replaceable>width</replaceable>"</term>
|
|---|
| 526 | <listitem>
|
|---|
| 527 | <para>Specifies the <tag>simplelist</tag> width (including units)</para>
|
|---|
| 528 | </listitem>
|
|---|
| 529 | </varlistentry>
|
|---|
| 530 | </variablelist>
|
|---|
| 531 | </refparameter>
|
|---|
| 532 | </doc:pi>
|
|---|
| 533 | <xsl:template name="pi.dbfo_list-width">
|
|---|
| 534 | <xsl:param name="node" select="."/>
|
|---|
| 535 | <xsl:call-template name="dbfo-attribute">
|
|---|
| 536 | <xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
|
|---|
| 537 | <xsl:with-param name="attribute" select="'list-width'"/>
|
|---|
| 538 | </xsl:call-template>
|
|---|
| 539 | </xsl:template>
|
|---|
| 540 |
|
|---|
| 541 | <doc:pi name="dbfo_orientation" xmlns="">
|
|---|
| 542 | <refpurpose>Specifies the orientation for table row or cell</refpurpose>
|
|---|
| 543 | <refdescription>
|
|---|
| 544 | <para>Use the <tag class="xmlpi">dbfo orientation</tag> PI as a child of an
|
|---|
| 545 | <tag>table</tag> row or cell to specify the orientation
|
|---|
| 546 | (rotation) for the row or cell.</para>
|
|---|
| 547 | </refdescription>
|
|---|
| 548 | <refsynopsisdiv>
|
|---|
| 549 | <synopsis><tag class="xmlpi">dbfo orientation="0"|"90"|"180"|"270"|"-90"|"-180"|"-270"</tag></synopsis>
|
|---|
| 550 | </refsynopsisdiv>
|
|---|
| 551 | <refparameter>
|
|---|
| 552 | <variablelist>
|
|---|
| 553 | <varlistentry><term>orientation="0"|"90"|"180"|"270"|"-90"|"-180"|"-270"</term>
|
|---|
| 554 | <listitem>
|
|---|
| 555 | <para>Specifies the number of degrees by which the cell or
|
|---|
| 556 | row is rotated</para>
|
|---|
| 557 | </listitem>
|
|---|
| 558 | </varlistentry>
|
|---|
| 559 | </variablelist>
|
|---|
| 560 | </refparameter>
|
|---|
| 561 | </doc:pi>
|
|---|
| 562 | <xsl:template name="pi.dbfo_orientation">
|
|---|
| 563 | <xsl:param name="node" select="."/>
|
|---|
| 564 | <xsl:call-template name="dbfo-attribute">
|
|---|
| 565 | <xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
|
|---|
| 566 | <xsl:with-param name="attribute" select="'orientation'"/>
|
|---|
| 567 | </xsl:call-template>
|
|---|
| 568 | </xsl:template>
|
|---|
| 569 |
|
|---|
| 570 | <doc:pi name="dbfo_pgwide" xmlns="">
|
|---|
| 571 | <refpurpose>Specifies if an <tag>equation</tag> or <tag>example</tag> goes across full page width</refpurpose>
|
|---|
| 572 | <refdescription>
|
|---|
| 573 | <para>Use the <tag class="xmlpi">dbfo pgwide</tag> PI as a child of an
|
|---|
| 574 | <tag>equation</tag> or <tag>example</tag> to specify that the
|
|---|
| 575 | content should rendered across the full width of the page.</para>
|
|---|
| 576 | </refdescription>
|
|---|
| 577 | <refsynopsisdiv>
|
|---|
| 578 | <synopsis><tag class="xmlpi">dbfo pgwide="0"|"1"</tag></synopsis>
|
|---|
| 579 | </refsynopsisdiv>
|
|---|
| 580 | <refparameter>
|
|---|
| 581 | <variablelist>
|
|---|
| 582 | <varlistentry><term>pgwide="0"</term>
|
|---|
| 583 | <listitem>
|
|---|
| 584 | <para>If zero, the content is rendered across the current
|
|---|
| 585 | text flow</para>
|
|---|
| 586 | </listitem>
|
|---|
| 587 | </varlistentry>
|
|---|
| 588 | <varlistentry><term>pgwide="1"</term>
|
|---|
| 589 | <listitem>
|
|---|
| 590 | <para>If <code>1</code> (or any non-zero value), the
|
|---|
| 591 | content is rendered across the full width of the page</para>
|
|---|
| 592 | </listitem>
|
|---|
| 593 | </varlistentry>
|
|---|
| 594 | </variablelist>
|
|---|
| 595 | </refparameter>
|
|---|
| 596 | <refsee role="params">
|
|---|
| 597 | <para><parameter>pgwide.properties</parameter></para>
|
|---|
| 598 | </refsee>
|
|---|
| 599 | </doc:pi>
|
|---|
| 600 | <xsl:template name="pi.dbfo_pgwide">
|
|---|
| 601 | <xsl:param name="node" select="."/>
|
|---|
| 602 | <xsl:call-template name="dbfo-attribute">
|
|---|
| 603 | <xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
|
|---|
| 604 | <xsl:with-param name="attribute" select="'pgwide'"/>
|
|---|
| 605 | </xsl:call-template>
|
|---|
| 606 | </xsl:template>
|
|---|
| 607 |
|
|---|
| 608 | <doc:pi name="dbfo_rotated-width" xmlns="">
|
|---|
| 609 | <refpurpose>Specifies the width for a table <tag>entry</tag> or
|
|---|
| 610 | <tag>row</tag></refpurpose>
|
|---|
| 611 | <refdescription>
|
|---|
| 612 | <para>Use the <tag class="xmlpi">dbfo rotated-width</tag> PI as a child of an
|
|---|
| 613 | <tag>entry</tag> or <tag>row</tag> instance to specify the
|
|---|
| 614 | width of that the <tag>entry</tag> or <tag>row</tag>; or
|
|---|
| 615 | use it higher up in table to cause the width to be inherited
|
|---|
| 616 | recursively down.</para>
|
|---|
| 617 | </refdescription>
|
|---|
| 618 | <refsynopsisdiv>
|
|---|
| 619 | <synopsis><tag class="xmlpi">dbfo rotated-width="<replaceable>width</replaceable>"</tag></synopsis>
|
|---|
| 620 | </refsynopsisdiv>
|
|---|
| 621 | <refparameter>
|
|---|
| 622 | <variablelist>
|
|---|
| 623 | <varlistentry><term>rotated-width="<replaceable>width</replaceable>"</term>
|
|---|
| 624 | <listitem>
|
|---|
| 625 | <para>Specifies the width of a row or cell (including units)</para>
|
|---|
| 626 | </listitem>
|
|---|
| 627 | </varlistentry>
|
|---|
| 628 | </variablelist>
|
|---|
| 629 | </refparameter>
|
|---|
| 630 | </doc:pi>
|
|---|
| 631 | <xsl:template name="pi.dbfo_rotated-width">
|
|---|
| 632 | <xsl:param name="node" select="."/>
|
|---|
| 633 | <xsl:call-template name="dbfo-attribute">
|
|---|
| 634 | <xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
|
|---|
| 635 | <xsl:with-param name="attribute" select="'rotated-width'"/>
|
|---|
| 636 | </xsl:call-template>
|
|---|
| 637 | </xsl:template>
|
|---|
| 638 |
|
|---|
| 639 | <doc:pi name="dbfo_sidebar-width" xmlns="">
|
|---|
| 640 | <refpurpose>Specifies the width of a sidebar</refpurpose>
|
|---|
| 641 | <refdescription>
|
|---|
| 642 | <para>Use the <tag class="xmlpi">dbfo sidebar-width</tag> PI as a child of a
|
|---|
| 643 | <tag>sidebar</tag> to specify the width of the sidebar.</para>
|
|---|
| 644 | </refdescription>
|
|---|
| 645 | <refsynopsisdiv>
|
|---|
| 646 | <synopsis><tag class="xmlpi">dbfo sidebar-width="<replaceable>width</replaceable>"</tag></synopsis>
|
|---|
| 647 | </refsynopsisdiv>
|
|---|
| 648 | <refparameter>
|
|---|
| 649 | <variablelist>
|
|---|
| 650 | <varlistentry><term>sidebar-width="<replaceable>width</replaceable>"</term>
|
|---|
| 651 | <listitem>
|
|---|
| 652 | <para>Specifies the <tag>sidebar</tag> width (including units)</para>
|
|---|
| 653 | </listitem>
|
|---|
| 654 | </varlistentry>
|
|---|
| 655 | </variablelist>
|
|---|
| 656 | </refparameter>
|
|---|
| 657 | <refsee role="params">
|
|---|
| 658 | <para><parameter>sidebar.float.type parameter</parameter>,
|
|---|
| 659 | <parameter>sidebar.float.width parameter</parameter>,
|
|---|
| 660 | <parameter>sidebar.properties attribute-set</parameter>,
|
|---|
| 661 | <parameter>sidebar.title.properties</parameter>
|
|---|
| 662 | </para>
|
|---|
| 663 | </refsee>
|
|---|
| 664 | <refsee role="tcg">
|
|---|
| 665 | <para><link xlink:href="SideFloats.html#SidebarFloats" >A sidebar as
|
|---|
| 666 | side float</link></para>
|
|---|
| 667 | </refsee>
|
|---|
| 668 | </doc:pi>
|
|---|
| 669 | <xsl:template name="pi.dbfo_sidebar-width">
|
|---|
| 670 | <xsl:param name="node" select="."/>
|
|---|
| 671 | <xsl:call-template name="dbfo-attribute">
|
|---|
| 672 | <xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
|
|---|
| 673 | <xsl:with-param name="attribute" select="'sidebar-width'"/>
|
|---|
| 674 | </xsl:call-template>
|
|---|
| 675 | </xsl:template>
|
|---|
| 676 |
|
|---|
| 677 | <doc:pi name="dbfo_start" xmlns="">
|
|---|
| 678 | <refpurpose>(obsolete) Sets the starting number on an ordered list</refpurpose>
|
|---|
| 679 | <refdescription>
|
|---|
| 680 | <para><emphasis>This PI is obsolete</emphasis>. The intent of
|
|---|
| 681 | it was to provide a means for setting a specific starting
|
|---|
| 682 | number for an ordered list. Instead of this PI, set a value
|
|---|
| 683 | for the <literal>override</literal> attribute on the first
|
|---|
| 684 | <tag>listitem</tag> in the list; that will have the same
|
|---|
| 685 | effect as what this PI was intended for.</para>
|
|---|
| 686 | </refdescription>
|
|---|
| 687 | <refsynopsisdiv>
|
|---|
| 688 | <synopsis><tag class="xmlpi">dbfo start="<replaceable>character</replaceable>"</tag></synopsis>
|
|---|
| 689 | </refsynopsisdiv>
|
|---|
| 690 | <refparameter>
|
|---|
| 691 | <variablelist>
|
|---|
| 692 | <varlistentry><term>start="<replaceable>character</replaceable>"</term>
|
|---|
| 693 | <listitem>
|
|---|
| 694 | <para>Specifies the character to use as the starting
|
|---|
| 695 | number; use 0-9, a-z, A-Z, or lowercase or uppercase
|
|---|
| 696 | Roman numerals</para>
|
|---|
| 697 | </listitem>
|
|---|
| 698 | </varlistentry>
|
|---|
| 699 | </variablelist>
|
|---|
| 700 | </refparameter>
|
|---|
| 701 | <refsee role="tcg">
|
|---|
| 702 | <para><link role="tcg"
|
|---|
| 703 | xlink:href="Orderedlists.html#ListStartNum"
|
|---|
| 704 | >List starting number</link></para>
|
|---|
| 705 | </refsee>
|
|---|
| 706 | </doc:pi>
|
|---|
| 707 | <xsl:template name="pi.dbfo_start">
|
|---|
| 708 | <xsl:param name="node" select="."/>
|
|---|
| 709 | <xsl:call-template name="pi-attribute">
|
|---|
| 710 | <xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
|
|---|
| 711 | <xsl:with-param name="attribute" select="'start'"/>
|
|---|
| 712 | </xsl:call-template>
|
|---|
| 713 | </xsl:template>
|
|---|
| 714 |
|
|---|
| 715 | <doc:pi name="dbfo_table-width" xmlns="">
|
|---|
| 716 | <refpurpose>Specifies the width for a table or for revhistory
|
|---|
| 717 | output</refpurpose>
|
|---|
| 718 | <refdescription>
|
|---|
| 719 | <para>Use the <tag class="xmlpi">dbfo table-width</tag> PI as a child or
|
|---|
| 720 | sibling of a <tag>table</tag>, or as a child of an
|
|---|
| 721 | <tag>informaltable</tag>, <tag>entrybl</tag>, or
|
|---|
| 722 | <tag>revhistory</tag> instance (which is rendered as a table
|
|---|
| 723 | in output) to specify the width of the table in output.</para>
|
|---|
| 724 | </refdescription>
|
|---|
| 725 | <refsynopsisdiv>
|
|---|
| 726 | <synopsis><tag class="xmlpi">dbfo table-width="<replaceable>width</replaceable>"</tag></synopsis>
|
|---|
| 727 | </refsynopsisdiv>
|
|---|
| 728 | <refparameter>
|
|---|
| 729 | <variablelist>
|
|---|
| 730 | <varlistentry><term>table-width="<replaceable>width</replaceable>"</term>
|
|---|
| 731 | <listitem>
|
|---|
| 732 | <para>Specifies the table width (including units or as a percentage)</para>
|
|---|
| 733 | </listitem>
|
|---|
| 734 | </varlistentry>
|
|---|
| 735 | </variablelist>
|
|---|
| 736 | </refparameter>
|
|---|
| 737 | <refsee role="tcg">
|
|---|
| 738 | <para><link role="tcg"
|
|---|
| 739 | xlink:href="Tables.html#TableWidth"
|
|---|
| 740 | >Table width</link></para>
|
|---|
| 741 | </refsee>
|
|---|
| 742 | </doc:pi>
|
|---|
| 743 | <xsl:template name="pi.dbfo_table-width">
|
|---|
| 744 | <xsl:param name="node" select="."/>
|
|---|
| 745 | <xsl:call-template name="dbfo-attribute">
|
|---|
| 746 | <xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
|
|---|
| 747 | <xsl:with-param name="attribute" select="'table-width'"/>
|
|---|
| 748 | </xsl:call-template>
|
|---|
| 749 | </xsl:template>
|
|---|
| 750 |
|
|---|
| 751 | <doc:pi name="dbfo_term-width" xmlns="">
|
|---|
| 752 | <refpurpose>Specifies the term width for a variablelist</refpurpose>
|
|---|
| 753 | <refdescription>
|
|---|
| 754 | <para>Use the <tag class="xmlpi">dbfo term-width</tag> PI as a child of a
|
|---|
| 755 | <tag>variablelist</tag> to specify the width for
|
|---|
| 756 | <tag>term</tag> output.</para>
|
|---|
| 757 | </refdescription>
|
|---|
| 758 | <refsynopsisdiv>
|
|---|
| 759 | <synopsis><tag class="xmlpi">dbfo term-width="<replaceable>width</replaceable>"</tag></synopsis>
|
|---|
| 760 | </refsynopsisdiv>
|
|---|
| 761 | <refparameter>
|
|---|
| 762 | <variablelist>
|
|---|
| 763 | <varlistentry><term>term-width="<replaceable>width</replaceable>"</term>
|
|---|
| 764 | <listitem>
|
|---|
| 765 | <para>Specifies the term width (including units)</para>
|
|---|
| 766 | </listitem>
|
|---|
| 767 | </varlistentry>
|
|---|
| 768 | </variablelist>
|
|---|
| 769 | </refparameter>
|
|---|
| 770 | <refsee role="tcg">
|
|---|
| 771 | <para><link role="tcg"
|
|---|
| 772 | xlink:href="Variablelists.html#ListIndents"
|
|---|
| 773 | >Variable list formatting in print</link></para>
|
|---|
| 774 | </refsee>
|
|---|
| 775 | </doc:pi>
|
|---|
| 776 | <xsl:template name="pi.dbfo_term-width">
|
|---|
| 777 | <xsl:param name="node" select="."/>
|
|---|
| 778 | <xsl:call-template name="dbfo-attribute">
|
|---|
| 779 | <xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
|
|---|
| 780 | <xsl:with-param name="attribute" select="'term-width'"/>
|
|---|
| 781 | </xsl:call-template>
|
|---|
| 782 | </xsl:template>
|
|---|
| 783 |
|
|---|
| 784 | <doc:pi name="dbfo_toc" xmlns="">
|
|---|
| 785 | <refpurpose>Specifies whether a TOC should be generated for a qandaset</refpurpose>
|
|---|
| 786 | <refdescription>
|
|---|
| 787 | <para>Use the <tag class="xmlpi">dbfo toc</tag> PI as a child of a
|
|---|
| 788 | <tag>qandaset</tag> to specify whether a table of contents
|
|---|
| 789 | (TOC) is generated for the <tag>qandaset</tag>.</para>
|
|---|
| 790 | </refdescription>
|
|---|
| 791 | <refsynopsisdiv>
|
|---|
| 792 | <synopsis><tag class="xmlpi">dbfo toc="0"|"1"</tag></synopsis>
|
|---|
| 793 | </refsynopsisdiv>
|
|---|
| 794 | <refparameter>
|
|---|
| 795 | <variablelist>
|
|---|
| 796 | <varlistentry><term>toc="0"</term>
|
|---|
| 797 | <listitem>
|
|---|
| 798 | <para>If zero, no TOC is generated</para>
|
|---|
| 799 | </listitem>
|
|---|
| 800 | </varlistentry>
|
|---|
| 801 | <varlistentry><term>toc="1"</term>
|
|---|
| 802 | <listitem>
|
|---|
| 803 | <para>If <code>1</code> (or any non-zero value),
|
|---|
| 804 | a TOC is generated</para>
|
|---|
| 805 | </listitem>
|
|---|
| 806 | </varlistentry>
|
|---|
| 807 | </variablelist>
|
|---|
| 808 | </refparameter>
|
|---|
| 809 | <refsee role="tcg">
|
|---|
| 810 | <para><link role="tcg"
|
|---|
| 811 | xlink:href="QandAtoc.html"
|
|---|
| 812 | >Q and A list of questions</link>,
|
|---|
| 813 | <link role="tcg"
|
|---|
| 814 | xlink:href="QandAformat.html"
|
|---|
| 815 | >Q and A formatting</link></para>
|
|---|
| 816 | </refsee>
|
|---|
| 817 | </doc:pi>
|
|---|
| 818 | <xsl:template name="pi.dbfo_toc">
|
|---|
| 819 | <xsl:param name="node" select="."/>
|
|---|
| 820 | <xsl:call-template name="dbfo-attribute">
|
|---|
| 821 | <xsl:with-param name="pis" select="$node/processing-instruction('dbfo')"/>
|
|---|
| 822 | <xsl:with-param name="attribute" select="'toc'"/>
|
|---|
| 823 | </xsl:call-template>
|
|---|
| 824 | </xsl:template>
|
|---|
| 825 |
|
|---|
| 826 | <doc:pi name="dbfo-need" xmlns="">
|
|---|
| 827 | <refpurpose>Specify a need for space (a kind of soft page break)</refpurpose>
|
|---|
| 828 | <refdescription>
|
|---|
| 829 | <para>A “need” is a request for space on a page. If the
|
|---|
| 830 | requested space is not available, the page breaks and the
|
|---|
| 831 | content that follows the need request appears on the next
|
|---|
| 832 | page. If the requested space is available, then no page break
|
|---|
| 833 | is inserted.</para>
|
|---|
| 834 | </refdescription>
|
|---|
| 835 | <refsynopsisdiv>
|
|---|
| 836 | <synopsis><tag class="xmlpi">dbfo-need height="<replaceable>n</replaceable>" [space-before="<replaceable>n</replaceable>"]</tag></synopsis>
|
|---|
| 837 | </refsynopsisdiv>
|
|---|
| 838 | <refparameter>
|
|---|
| 839 | <variablelist>
|
|---|
| 840 | <varlistentry><term>height="<replaceable>n</replaceable>"</term>
|
|---|
| 841 | <listitem>
|
|---|
| 842 | <para>The amount of height needed (including units)</para>
|
|---|
| 843 | </listitem>
|
|---|
| 844 | </varlistentry>
|
|---|
| 845 | <varlistentry><term>space-before="<replaceable>n</replaceable>"</term>
|
|---|
| 846 | <listitem>
|
|---|
| 847 | <para>The amount of extra vertical space to add (including units)</para>
|
|---|
| 848 | </listitem>
|
|---|
| 849 | </varlistentry>
|
|---|
| 850 | </variablelist>
|
|---|
| 851 | </refparameter>
|
|---|
| 852 | <refsee role="tcg">
|
|---|
| 853 | <para><link role="tcg"
|
|---|
| 854 | xlink:href="PageBreaking.html#SoftPageBreaks"
|
|---|
| 855 | >Soft page breaks</link></para>
|
|---|
| 856 | </refsee>
|
|---|
| 857 | </doc:pi>
|
|---|
| 858 | <xsl:template name="pi.dbfo-need">
|
|---|
| 859 | <xsl:variable name="pi-height">
|
|---|
| 860 | <xsl:call-template name="dbfo-attribute">
|
|---|
| 861 | <xsl:with-param name="pis" select="."/>
|
|---|
| 862 | <xsl:with-param name="attribute" select="'height'"/>
|
|---|
| 863 | </xsl:call-template>
|
|---|
| 864 | </xsl:variable>
|
|---|
| 865 |
|
|---|
| 866 | <xsl:variable name="height">
|
|---|
| 867 | <xsl:choose>
|
|---|
| 868 | <xsl:when test="$pi-height != ''">
|
|---|
| 869 | <xsl:value-of select="$pi-height"/>
|
|---|
| 870 | </xsl:when>
|
|---|
| 871 | <xsl:otherwise>0pt</xsl:otherwise>
|
|---|
| 872 | </xsl:choose>
|
|---|
| 873 | </xsl:variable>
|
|---|
| 874 |
|
|---|
| 875 | <xsl:variable name="pi-before">
|
|---|
| 876 | <xsl:call-template name="dbfo-attribute">
|
|---|
| 877 | <xsl:with-param name="pis" select="."/>
|
|---|
| 878 | <xsl:with-param name="attribute" select="'space-before'"/>
|
|---|
| 879 | </xsl:call-template>
|
|---|
| 880 | </xsl:variable>
|
|---|
| 881 |
|
|---|
| 882 | <xsl:variable name="spacer">
|
|---|
| 883 | <fo:block-container width="100%" height="{$height}">
|
|---|
| 884 | <fo:block><fo:leader leader-length="0pt"/></fo:block>
|
|---|
| 885 | </fo:block-container>
|
|---|
| 886 | </xsl:variable>
|
|---|
| 887 |
|
|---|
| 888 | <xsl:choose>
|
|---|
| 889 | <xsl:when test="$fop.extensions != 0">
|
|---|
| 890 | <!-- Doesn't work in fop -->
|
|---|
| 891 | </xsl:when>
|
|---|
| 892 | <xsl:when test="$pi-before != '' and
|
|---|
| 893 | not(following-sibling::listitem) and
|
|---|
| 894 | not(following-sibling::step)">
|
|---|
| 895 | <fo:block space-after="0pt" space-before="{$pi-before}">
|
|---|
| 896 | <xsl:copy-of select="$spacer"/>
|
|---|
| 897 | </fo:block>
|
|---|
| 898 | </xsl:when>
|
|---|
| 899 | <xsl:when test="following-sibling::para">
|
|---|
| 900 | <fo:block space-after="0pt"
|
|---|
| 901 | xsl:use-attribute-sets="normal.para.spacing">
|
|---|
| 902 | <xsl:copy-of select="$spacer"/>
|
|---|
| 903 | </fo:block>
|
|---|
| 904 | </xsl:when>
|
|---|
| 905 | <xsl:when test="following-sibling::table or
|
|---|
| 906 | following-sibling::figure or
|
|---|
| 907 | following-sibling::example or
|
|---|
| 908 | following-sibling::equation">
|
|---|
| 909 | <fo:block space-after="0pt"
|
|---|
| 910 | xsl:use-attribute-sets="formal.object.properties">
|
|---|
| 911 | <xsl:copy-of select="$spacer"/>
|
|---|
| 912 | </fo:block>
|
|---|
| 913 | </xsl:when>
|
|---|
| 914 | <xsl:when test="following-sibling::informaltable or
|
|---|
| 915 | following-sibling::informalfigure or
|
|---|
| 916 | following-sibling::informalexample or
|
|---|
| 917 | following-sibling::informalequation">
|
|---|
| 918 | <fo:block space-after="0pt"
|
|---|
| 919 | xsl:use-attribute-sets="informal.object.properties">
|
|---|
| 920 | <xsl:copy-of select="$spacer"/>
|
|---|
| 921 | </fo:block>
|
|---|
| 922 | </xsl:when>
|
|---|
| 923 | <xsl:when test="following-sibling::itemizedlist or
|
|---|
| 924 | following-sibling::orderedlist or
|
|---|
| 925 | following-sibling::variablelist or
|
|---|
| 926 | following-sibling::simplelist">
|
|---|
| 927 | <fo:block space-after="0pt"
|
|---|
| 928 | xsl:use-attribute-sets="informal.object.properties">
|
|---|
| 929 | <xsl:copy-of select="$spacer"/>
|
|---|
| 930 | </fo:block>
|
|---|
| 931 | </xsl:when>
|
|---|
| 932 | <xsl:when test="following-sibling::listitem or
|
|---|
| 933 | following-sibling::step">
|
|---|
| 934 | <fo:list-item space-after="0pt"
|
|---|
| 935 | xsl:use-attribute-sets="informal.object.properties">
|
|---|
| 936 | <fo:list-item-label/>
|
|---|
| 937 | <fo:list-item-body start-indent="0pt" end-indent="0pt">
|
|---|
| 938 | <xsl:copy-of select="$spacer"/>
|
|---|
| 939 | </fo:list-item-body>
|
|---|
| 940 | </fo:list-item>
|
|---|
| 941 | </xsl:when>
|
|---|
| 942 | <xsl:when test="following-sibling::sect1 or
|
|---|
| 943 | following-sibling::sect2 or
|
|---|
| 944 | following-sibling::sect3 or
|
|---|
| 945 | following-sibling::sect4 or
|
|---|
| 946 | following-sibling::sect5 or
|
|---|
| 947 | following-sibling::section">
|
|---|
| 948 | <fo:block space-after="0pt"
|
|---|
| 949 | xsl:use-attribute-sets="section.title.properties">
|
|---|
| 950 | <xsl:copy-of select="$spacer"/>
|
|---|
| 951 | </fo:block>
|
|---|
| 952 | </xsl:when>
|
|---|
| 953 | <xsl:otherwise>
|
|---|
| 954 | <fo:block space-after="0pt" space-before="0em">
|
|---|
| 955 | <xsl:copy-of select="$spacer"/>
|
|---|
| 956 | </fo:block>
|
|---|
| 957 | </xsl:otherwise>
|
|---|
| 958 | </xsl:choose>
|
|---|
| 959 |
|
|---|
| 960 | <xsl:choose>
|
|---|
| 961 | <xsl:when test="$fop.extensions != 0">
|
|---|
| 962 | <!-- Doesn't work in fop -->
|
|---|
| 963 | </xsl:when>
|
|---|
| 964 | <xsl:when test="following-sibling::listitem or
|
|---|
| 965 | following-sibling::step">
|
|---|
| 966 | <fo:list-item space-before.precedence="force"
|
|---|
| 967 | space-before="-{$height}"
|
|---|
| 968 | space-after="0pt"
|
|---|
| 969 | space-after.precedence="force">
|
|---|
| 970 | <fo:list-item-label/>
|
|---|
| 971 | <fo:list-item-body start-indent="0pt" end-indent="0pt"/>
|
|---|
| 972 | </fo:list-item>
|
|---|
| 973 | </xsl:when>
|
|---|
| 974 | <xsl:otherwise>
|
|---|
| 975 | <fo:block space-before.precedence="force"
|
|---|
| 976 | space-before="-{$height}"
|
|---|
| 977 | space-after="0pt"
|
|---|
| 978 | space-after.precedence="force">
|
|---|
| 979 | </fo:block>
|
|---|
| 980 | </xsl:otherwise>
|
|---|
| 981 | </xsl:choose>
|
|---|
| 982 | </xsl:template>
|
|---|
| 983 |
|
|---|
| 984 | <!-- ==================================================================== -->
|
|---|
| 985 |
|
|---|
| 986 | <xsl:template name="dbfo-attribute">
|
|---|
| 987 | <!-- * dbfo-attribute is an interal utility template for retrieving -->
|
|---|
| 988 | <!-- * pseudo-attributes/parameters from PIs -->
|
|---|
| 989 | <xsl:param name="pis" select="processing-instruction('dbfo')"/>
|
|---|
| 990 | <xsl:param name="attribute">filename</xsl:param>
|
|---|
| 991 | <xsl:call-template name="pi-attribute">
|
|---|
| 992 | <xsl:with-param name="pis" select="$pis"/>
|
|---|
| 993 | <xsl:with-param name="attribute" select="$attribute"/>
|
|---|
| 994 | </xsl:call-template>
|
|---|
| 995 | </xsl:template>
|
|---|
| 996 |
|
|---|
| 997 | <!-- ==================================================================== -->
|
|---|
| 998 |
|
|---|
| 999 | <xsl:template match="processing-instruction()">
|
|---|
| 1000 | </xsl:template>
|
|---|
| 1001 |
|
|---|
| 1002 | <!-- ==================================================================== -->
|
|---|
| 1003 |
|
|---|
| 1004 | <xsl:template match="processing-instruction('dbfo-need')">
|
|---|
| 1005 | <xsl:call-template name="pi.dbfo-need"/>
|
|---|
| 1006 | </xsl:template>
|
|---|
| 1007 |
|
|---|
| 1008 | </xsl:stylesheet>
|
|---|
