| OLD | NEW |
|---|
| (Empty) |
| 1 <?xml version="1.0" encoding="ASCII"?> | |
| 2 <book version="5.0"> | |
| 3 <info> | |
| 4 <title>HTML Parameter Reference</title> | |
| 5 <releaseinfo role="meta"> | |
| 6 $Id: param.xweb 9658 2012-10-29 22:28:34Z bobstayton $ | |
| 7 </releaseinfo> | |
| 8 <author> | |
| 9 <personname> | |
| 10 <surname>Walsh</surname> | |
| 11 <firstname>Norman</firstname> | |
| 12 </personname> | |
| 13 </author> | |
| 14 <copyright> | |
| 15 <year>1999</year> | |
| 16 <year>2000</year> | |
| 17 <year>2001</year> | |
| 18 <year>2002</year> | |
| 19 <year>2003</year> | |
| 20 <year>2004</year> | |
| 21 <year>2005</year> | |
| 22 <year>2006</year> | |
| 23 <year>2007</year> | |
| 24 <year>2008</year> | |
| 25 <year>2009</year> | |
| 26 <year>2010</year> | |
| 27 <year>2011</year> | |
| 28 <holder>Norman Walsh</holder> | |
| 29 </copyright> | |
| 30 <abstract> | |
| 31 <para>This is reference documentation for all user-configurable | |
| 32 parameters in the DocBook XSL HTML stylesheets (for generating | |
| 33 HTML output).</para> | |
| 34 </abstract> | |
| 35 </info> | |
| 36 <reference xml:id="admons"><title>Admonitions</title> | |
| 37 <refentry version="5.0" xml:id="admon.graphics.extension"> | |
| 38 <refmeta> | |
| 39 <refentrytitle>admon.graphics.extension</refentrytitle> | |
| 40 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 41 </refmeta> | |
| 42 <refnamediv> | |
| 43 <refname>admon.graphics.extension</refname> | |
| 44 <refpurpose>Filename extension for admonition graphics</refpurpose> | |
| 45 </refnamediv> | |
| 46 | |
| 47 <refsynopsisdiv> | |
| 48 <programlisting xml:id="admon.graphics.extension.frag"> | |
| 49 <xsl:param name="admon.graphics.extension">.png</xsl:param> | |
| 50 </programlisting> | |
| 51 </refsynopsisdiv> | |
| 52 | |
| 53 <refsection><info><title>Description</title></info> | |
| 54 | |
| 55 <para>Sets the filename extension to use on admonition graphics.</para> | |
| 56 | |
| 57 <itemizedlist> | |
| 58 <para>The DocBook XSL distribution provides admonition graphics in the followi
ng formats:</para> | |
| 59 <listitem><para>GIF (extension: <filename class="extension">.gif</filename>)</
para></listitem> | |
| 60 <listitem><para>PNG (extension: <filename class="extension">.png</filename>)</
para></listitem> | |
| 61 <listitem><para>SVG (extension: <filename class="extension">.svg</filename>)</
para></listitem> | |
| 62 <listitem><para>TIFF (extension: <filename class="extension">.tif</filename>)<
/para></listitem> | |
| 63 </itemizedlist> | |
| 64 | |
| 65 </refsection> | |
| 66 </refentry> | |
| 67 | |
| 68 <refentry version="5.0" xml:id="admon.graphics.path"> | |
| 69 <refmeta> | |
| 70 <refentrytitle>admon.graphics.path</refentrytitle> | |
| 71 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 72 </refmeta> | |
| 73 <refnamediv> | |
| 74 <refname>admon.graphics.path</refname> | |
| 75 <refpurpose>Path to admonition graphics</refpurpose> | |
| 76 </refnamediv> | |
| 77 | |
| 78 <refsynopsisdiv> | |
| 79 <programlisting xml:id="admon.graphics.path.frag"><xsl:param name="admon.grap
hics.path">images/</xsl:param></programlisting> | |
| 80 </refsynopsisdiv> | |
| 81 | |
| 82 <refsection><info><title>Description</title></info> | |
| 83 | |
| 84 <para>Sets the path to the directory containing the admonition graphics | |
| 85 (caution.png, important.png etc). This location is normally relative | |
| 86 to the output html directory. See <parameter>base.dir</parameter></para> | |
| 87 | |
| 88 </refsection> | |
| 89 </refentry> | |
| 90 | |
| 91 <refentry version="5.0" xml:id="admon.graphics"> | |
| 92 <refmeta> | |
| 93 <refentrytitle>admon.graphics</refentrytitle> | |
| 94 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 95 </refmeta> | |
| 96 <refnamediv> | |
| 97 <refname>admon.graphics</refname> | |
| 98 <refpurpose>Use graphics in admonitions?</refpurpose> | |
| 99 </refnamediv> | |
| 100 | |
| 101 <refsynopsisdiv> | |
| 102 <programlisting xml:id="admon.graphics.frag"> | |
| 103 <xsl:param name="admon.graphics" select="0"></xsl:param> | |
| 104 </programlisting> | |
| 105 </refsynopsisdiv> | |
| 106 | |
| 107 <refsection><info><title>Description</title></info> | |
| 108 | |
| 109 <para>If true (non-zero), admonitions are presented in an alternate style that u
ses | |
| 110 a graphic. Default graphics are provided in the distribution. | |
| 111 </para> | |
| 112 | |
| 113 </refsection> | |
| 114 </refentry> | |
| 115 | |
| 116 <refentry version="5.0" xml:id="admon.textlabel"> | |
| 117 <refmeta> | |
| 118 <refentrytitle>admon.textlabel</refentrytitle> | |
| 119 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 120 </refmeta> | |
| 121 <refnamediv> | |
| 122 <refname>admon.textlabel</refname> | |
| 123 <refpurpose>Use text label in admonitions?</refpurpose> | |
| 124 </refnamediv> | |
| 125 | |
| 126 <refsynopsisdiv> | |
| 127 <programlisting xml:id="admon.textlabel.frag"> | |
| 128 <xsl:param name="admon.textlabel" select="1"></xsl:param> | |
| 129 </programlisting> | |
| 130 </refsynopsisdiv> | |
| 131 | |
| 132 <refsection><info><title>Description</title></info> | |
| 133 | |
| 134 <para>If true (non-zero), admonitions are presented with a generated | |
| 135 text label such as Note or Warning in the appropriate language. | |
| 136 If zero, such labels are turned off, but any title child | |
| 137 of the admonition element are still output. | |
| 138 The default value is 1. | |
| 139 </para> | |
| 140 | |
| 141 </refsection> | |
| 142 </refentry> | |
| 143 | |
| 144 <refentry version="5.0" xml:id="admon.style"> | |
| 145 <refmeta> | |
| 146 <refentrytitle>admon.style</refentrytitle> | |
| 147 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 148 </refmeta> | |
| 149 <refnamediv> | |
| 150 <refname>admon.style</refname> | |
| 151 <refpurpose>Specifies the CSS style attribute that should be added to | |
| 152 admonitions.</refpurpose> | |
| 153 </refnamediv> | |
| 154 | |
| 155 <refsynopsisdiv> | |
| 156 <programlisting xml:id="admon.style.frag"><xsl:param name="admon.style"> | |
| 157 <xsl:value-of select="concat('margin-', $direction.align.start,
': 0.5in; margin-', $direction.align.end, ': 0.5in;')"></xsl:value-of> | |
| 158 </xsl:param></programlisting> | |
| 159 </refsynopsisdiv> | |
| 160 | |
| 161 <refsection><info><title>Description</title></info> | |
| 162 | |
| 163 <para>Specifies the value of the CSS <tag class="attribute">style</tag> | |
| 164 attribute that should be added to admonitions. | |
| 165 </para> | |
| 166 | |
| 167 </refsection> | |
| 168 </refentry> | |
| 169 | |
| 170 </reference> | |
| 171 <reference xml:id="callouts"><title>Callouts</title> | |
| 172 <refentry version="5.0" xml:id="callout.defaultcolumn"> | |
| 173 <refmeta> | |
| 174 <refentrytitle>callout.defaultcolumn</refentrytitle> | |
| 175 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> | |
| 176 </refmeta> | |
| 177 <refnamediv> | |
| 178 <refname>callout.defaultcolumn</refname> | |
| 179 <refpurpose>Indicates what column callouts appear in by default</refpurpose> | |
| 180 </refnamediv> | |
| 181 | |
| 182 <refsynopsisdiv> | |
| 183 <programlisting xml:id="callout.defaultcolumn.frag"> | |
| 184 <xsl:param name="callout.defaultcolumn">60</xsl:param> | |
| 185 </programlisting> | |
| 186 </refsynopsisdiv> | |
| 187 | |
| 188 <refsection><info><title>Description</title></info> | |
| 189 | |
| 190 <para>If a callout does not identify a column (for example, if it uses | |
| 191 the <literal>linerange</literal> <tag class="attribute">unit</tag>), | |
| 192 it will appear in the default column. | |
| 193 </para> | |
| 194 | |
| 195 </refsection> | |
| 196 </refentry> | |
| 197 | |
| 198 <refentry version="5.0" xml:id="callout.graphics.extension"> | |
| 199 <refmeta> | |
| 200 <refentrytitle>callout.graphics.extension</refentrytitle> | |
| 201 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 202 </refmeta> | |
| 203 <refnamediv> | |
| 204 <refname>callout.graphics.extension</refname> | |
| 205 <refpurpose>Filename extension for callout graphics</refpurpose> | |
| 206 </refnamediv> | |
| 207 | |
| 208 <refsynopsisdiv> | |
| 209 <programlisting xml:id="callout.graphics.extension.frag"> | |
| 210 <xsl:param name="callout.graphics.extension">.png</xsl:param> | |
| 211 | |
| 212 </programlisting> | |
| 213 </refsynopsisdiv> | |
| 214 | |
| 215 <refsection><info><title>Description</title></info> | |
| 216 <para>Sets the filename extension to use on callout graphics. </para> | |
| 217 | |
| 218 <itemizedlist> | |
| 219 <para>The Docbook XSL distribution provides callout graphics in the following fo
rmats:</para> | |
| 220 <listitem><para>SVG (extension: <filename class="extension">.svg</filename>)</pa
ra></listitem> | |
| 221 <listitem><para>PNG (extension: <filename class="extension">.png</filename>)</pa
ra></listitem> | |
| 222 <listitem><para>GIF (extension: <filename class="extension">.gif</filename>)</pa
ra></listitem> | |
| 223 </itemizedlist> | |
| 224 </refsection> | |
| 225 </refentry> | |
| 226 | |
| 227 <refentry version="5.0" xml:id="callout.graphics.number.limit"> | |
| 228 <refmeta> | |
| 229 <refentrytitle>callout.graphics.number.limit</refentrytitle> | |
| 230 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> | |
| 231 </refmeta> | |
| 232 <refnamediv> | |
| 233 <refname>callout.graphics.number.limit</refname> | |
| 234 <refpurpose>Number of the largest callout graphic</refpurpose> | |
| 235 </refnamediv> | |
| 236 | |
| 237 <refsynopsisdiv> | |
| 238 <programlisting xml:id="callout.graphics.number.limit.frag"> | |
| 239 <xsl:param name="callout.graphics.number.limit">15</xsl:param> | |
| 240 | |
| 241 </programlisting> | |
| 242 </refsynopsisdiv> | |
| 243 | |
| 244 <refsection><info><title>Description</title></info> | |
| 245 | |
| 246 <para>If <parameter>callout.graphics</parameter> is non-zero, graphics | |
| 247 are used to represent callout numbers instead of plain text. The value | |
| 248 of <parameter>callout.graphics.number.limit</parameter> is the largest | |
| 249 number for which a graphic exists. If the callout number exceeds this | |
| 250 limit, the default presentation "(plain text instead of a graphic)" | |
| 251 will be used. | |
| 252 </para> | |
| 253 | |
| 254 </refsection> | |
| 255 </refentry> | |
| 256 | |
| 257 <refentry version="5.0" xml:id="callout.graphics.path"> | |
| 258 <refmeta> | |
| 259 <refentrytitle>callout.graphics.path</refentrytitle> | |
| 260 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 261 </refmeta> | |
| 262 <refnamediv> | |
| 263 <refname>callout.graphics.path</refname> | |
| 264 <refpurpose>Path to callout graphics</refpurpose> | |
| 265 </refnamediv> | |
| 266 | |
| 267 <refsynopsisdiv> | |
| 268 <programlisting xml:id="callout.graphics.path.frag"> | |
| 269 <xsl:param name="callout.graphics.path">images/callouts/</xsl:param> | |
| 270 </programlisting> | |
| 271 </refsynopsisdiv> | |
| 272 | |
| 273 <refsection><info><title>Description</title></info> | |
| 274 | |
| 275 <para>Sets the path to the directory holding the callout graphics. his | |
| 276 location is normally relative to the output html directory. see | |
| 277 base.dir. Always terminate the directory with / since the graphic file | |
| 278 is appended to this string, hence needs the separator. | |
| 279 </para> | |
| 280 | |
| 281 </refsection> | |
| 282 </refentry> | |
| 283 | |
| 284 <refentry version="5.0" xml:id="callout.graphics"> | |
| 285 <refmeta> | |
| 286 <refentrytitle>callout.graphics</refentrytitle> | |
| 287 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 288 </refmeta> | |
| 289 <refnamediv> | |
| 290 <refname>callout.graphics</refname> | |
| 291 <refpurpose>Use graphics for callouts?</refpurpose> | |
| 292 </refnamediv> | |
| 293 | |
| 294 <refsynopsisdiv> | |
| 295 <programlisting xml:id="callout.graphics.frag"> | |
| 296 <xsl:param name="callout.graphics" select="1"></xsl:param> | |
| 297 </programlisting> | |
| 298 </refsynopsisdiv> | |
| 299 | |
| 300 <refsection><info><title>Description</title></info> | |
| 301 | |
| 302 <para>If non-zero, callouts are presented with graphics (e.g., reverse-video | |
| 303 circled numbers instead of "(1)", "(2)", etc.). | |
| 304 Default graphics are provided in the distribution. | |
| 305 </para> | |
| 306 | |
| 307 </refsection> | |
| 308 </refentry> | |
| 309 | |
| 310 <refentry version="5.0" xml:id="callout.list.table"> | |
| 311 <refmeta> | |
| 312 <refentrytitle>callout.list.table</refentrytitle> | |
| 313 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 314 </refmeta> | |
| 315 <refnamediv> | |
| 316 <refname>callout.list.table</refname> | |
| 317 <refpurpose>Present callout lists using a table?</refpurpose> | |
| 318 </refnamediv> | |
| 319 | |
| 320 <refsynopsisdiv> | |
| 321 <programlisting xml:id="callout.list.table.frag"> | |
| 322 <xsl:param name="callout.list.table" select="1"></xsl:param> | |
| 323 </programlisting> | |
| 324 </refsynopsisdiv> | |
| 325 | |
| 326 <refsection><info><title>Description</title></info> | |
| 327 | |
| 328 <para>The default presentation of <tag>calloutlist</tag>s uses | |
| 329 an HTML <tag>DL</tag> element. Some browsers don't align DLs very well | |
| 330 if <parameter>callout.graphics</parameter> is used. With this option | |
| 331 turned on, <tag>calloutlist</tag>s are presented in an HTML | |
| 332 <tag>TABLE</tag>, which usually results in better alignment | |
| 333 of the callout number with the callout description.</para> | |
| 334 | |
| 335 </refsection> | |
| 336 </refentry> | |
| 337 | |
| 338 <refentry version="5.0" xml:id="callout.unicode.number.limit"> | |
| 339 <refmeta> | |
| 340 <refentrytitle>callout.unicode.number.limit</refentrytitle> | |
| 341 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> | |
| 342 </refmeta> | |
| 343 <refnamediv> | |
| 344 <refname>callout.unicode.number.limit</refname> | |
| 345 <refpurpose>Number of the largest unicode callout character</refpurpose> | |
| 346 </refnamediv> | |
| 347 | |
| 348 <refsynopsisdiv> | |
| 349 <programlisting xml:id="callout.unicode.number.limit.frag"> | |
| 350 <xsl:param name="callout.unicode.number.limit">10</xsl:param> | |
| 351 </programlisting> | |
| 352 </refsynopsisdiv> | |
| 353 | |
| 354 <refsection><info><title>Description</title></info> | |
| 355 | |
| 356 <para>If <parameter>callout.unicode</parameter> | |
| 357 is non-zero, unicode characters are used to represent | |
| 358 callout numbers. The value of | |
| 359 <parameter>callout.unicode.number.limit</parameter> | |
| 360 is | |
| 361 the largest number for which a unicode character exists. If the callout number | |
| 362 exceeds this limit, the default presentation "(nnn)" will always | |
| 363 be used. | |
| 364 </para> | |
| 365 | |
| 366 </refsection> | |
| 367 </refentry> | |
| 368 | |
| 369 <refentry version="5.0" xml:id="callout.unicode.start.character"> | |
| 370 <refmeta> | |
| 371 <refentrytitle>callout.unicode.start.character</refentrytitle> | |
| 372 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> | |
| 373 </refmeta> | |
| 374 <refnamediv> | |
| 375 <refname>callout.unicode.start.character</refname> | |
| 376 <refpurpose>First Unicode character to use, decimal value.</refpurpose> | |
| 377 </refnamediv> | |
| 378 | |
| 379 <refsynopsisdiv> | |
| 380 <programlisting xml:id="callout.unicode.start.character.frag"> | |
| 381 <xsl:param name="callout.unicode.start.character">10102</xsl:param> | |
| 382 </programlisting> | |
| 383 </refsynopsisdiv> | |
| 384 | |
| 385 <refsection><info><title>Description</title></info> | |
| 386 | |
| 387 <para>If <parameter>callout.graphics</parameter> is zero and <parameter>callout.
unicode</parameter> | |
| 388 is non-zero, unicode characters are used to represent | |
| 389 callout numbers. The value of | |
| 390 <parameter>callout.unicode.start.character</parameter> | |
| 391 is the decimal unicode value used for callout number one. Currently, | |
| 392 only values 9312 and 10102 are supported in the stylesheets for this parameter. | |
| 393 </para> | |
| 394 | |
| 395 </refsection> | |
| 396 </refentry> | |
| 397 | |
| 398 <refentry version="5.0" xml:id="callout.unicode"> | |
| 399 <refmeta> | |
| 400 <refentrytitle>callout.unicode</refentrytitle> | |
| 401 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 402 </refmeta> | |
| 403 <refnamediv> | |
| 404 <refname>callout.unicode</refname> | |
| 405 <refpurpose>Use Unicode characters rather than images for callouts.</refpurpose> | |
| 406 </refnamediv> | |
| 407 | |
| 408 <refsynopsisdiv> | |
| 409 <programlisting xml:id="callout.unicode.frag"><xsl:param name="callout.unicod
e" select="0"></xsl:param></programlisting> | |
| 410 </refsynopsisdiv> | |
| 411 | |
| 412 <refsection><info><title>Description</title></info> | |
| 413 | |
| 414 <para>The stylesheets can use either an image of the numbers one to ten, or the
single Unicode character which represents the numeral, in white on a black backg
round. Use this to select the Unicode character option. | |
| 415 </para> | |
| 416 | |
| 417 </refsection> | |
| 418 </refentry> | |
| 419 | |
| 420 <refentry version="5.0" xml:id="callouts.extension"> | |
| 421 <refmeta> | |
| 422 <refentrytitle>callouts.extension</refentrytitle> | |
| 423 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 424 </refmeta> | |
| 425 <refnamediv> | |
| 426 <refname>callouts.extension</refname> | |
| 427 <refpurpose>Enable the callout extension</refpurpose> | |
| 428 </refnamediv> | |
| 429 | |
| 430 <refsynopsisdiv> | |
| 431 <programlisting xml:id="callouts.extension.frag"> | |
| 432 <xsl:param name="callouts.extension" select="1"></xsl:param> | |
| 433 </programlisting> | |
| 434 </refsynopsisdiv> | |
| 435 | |
| 436 <refsection><info><title>Description</title></info> | |
| 437 | |
| 438 <para>The callouts extension processes <tag>areaset</tag> | |
| 439 elements in <tag>programlistingco</tag> and other text-based | |
| 440 callout elements. | |
| 441 </para> | |
| 442 | |
| 443 </refsection> | |
| 444 </refentry> | |
| 445 | |
| 446 </reference> | |
| 447 <reference xml:id="ebnf"><title>EBNF</title> | |
| 448 <refentry version="5.0" xml:id="ebnf.table.bgcolor"> | |
| 449 <refmeta> | |
| 450 <refentrytitle>ebnf.table.bgcolor</refentrytitle> | |
| 451 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo> | |
| 452 </refmeta> | |
| 453 <refnamediv> | |
| 454 <refname>ebnf.table.bgcolor</refname> | |
| 455 <refpurpose>Background color for EBNF tables</refpurpose> | |
| 456 </refnamediv> | |
| 457 | |
| 458 <refsynopsisdiv> | |
| 459 <programlisting xml:id="ebnf.table.bgcolor.frag"> | |
| 460 <xsl:param name="ebnf.table.bgcolor">#F5DCB3</xsl:param> | |
| 461 </programlisting> | |
| 462 </refsynopsisdiv> | |
| 463 | |
| 464 <refsection><info><title>Description</title></info> | |
| 465 | |
| 466 <para>Sets the background color for EBNF tables (a pale brown). No | |
| 467 <tag>bgcolor</tag> attribute is output if | |
| 468 <parameter>ebnf.table.bgcolor</parameter> is set to the null string. </para> | |
| 469 | |
| 470 | |
| 471 </refsection> | |
| 472 </refentry> | |
| 473 | |
| 474 <refentry version="5.0" xml:id="ebnf.table.border"> | |
| 475 <refmeta> | |
| 476 <refentrytitle>ebnf.table.border</refentrytitle> | |
| 477 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 478 </refmeta> | |
| 479 <refnamediv> | |
| 480 <refname>ebnf.table.border</refname> | |
| 481 <refpurpose>Selects border on EBNF tables</refpurpose> | |
| 482 </refnamediv> | |
| 483 | |
| 484 <refsynopsisdiv> | |
| 485 <programlisting xml:id="ebnf.table.border.frag"><xsl:param name="ebnf.table.b
order" select="1"></xsl:param></programlisting> | |
| 486 </refsynopsisdiv> | |
| 487 | |
| 488 <refsection><info><title>Description</title></info> | |
| 489 | |
| 490 <para>Selects the border on EBNF tables. If non-zero, the tables have | |
| 491 borders, otherwise they don't.</para> | |
| 492 | |
| 493 </refsection> | |
| 494 </refentry> | |
| 495 | |
| 496 <refentry version="5.0" xml:id="ebnf.assignment"> | |
| 497 <refmeta> | |
| 498 <refentrytitle>ebnf.assignment</refentrytitle> | |
| 499 <refmiscinfo class="other" otherclass="datatype">rtf</refmiscinfo> | |
| 500 </refmeta> | |
| 501 <refnamediv> | |
| 502 <refname>ebnf.assignment</refname> | |
| 503 <refpurpose>The EBNF production assignment operator</refpurpose> | |
| 504 </refnamediv> | |
| 505 | |
| 506 <refsynopsisdiv> | |
| 507 <programlisting xml:id="ebnf.assignment.frag"> | |
| 508 <xsl:param name="ebnf.assignment"> | |
| 509 <code>::=</code> | |
| 510 </xsl:param> | |
| 511 | |
| 512 </programlisting> | |
| 513 </refsynopsisdiv> | |
| 514 | |
| 515 <refsection><info><title>Description</title></info> | |
| 516 | |
| 517 <para>The <parameter>ebnf.assignment</parameter> parameter determines what | |
| 518 text is used to show <quote>assignment</quote> in <tag>production</tag>s | |
| 519 in <tag>productionset</tag>s.</para> | |
| 520 | |
| 521 <para>While <quote><literal>::=</literal></quote> is common, so are several | |
| 522 other operators.</para> | |
| 523 | |
| 524 </refsection> | |
| 525 </refentry> | |
| 526 | |
| 527 <refentry version="5.0" xml:id="ebnf.statement.terminator"> | |
| 528 <refmeta> | |
| 529 <refentrytitle>ebnf.statement.terminator</refentrytitle> | |
| 530 <refmiscinfo class="other" otherclass="datatype">rtf</refmiscinfo> | |
| 531 </refmeta> | |
| 532 <refnamediv> | |
| 533 <refname>ebnf.statement.terminator</refname> | |
| 534 <refpurpose>Punctuation that ends an EBNF statement.</refpurpose> | |
| 535 </refnamediv> | |
| 536 | |
| 537 <refsynopsisdiv> | |
| 538 <programlisting xml:id="ebnf.statement.terminator.frag"> | |
| 539 <xsl:param name="ebnf.statement.terminator"></xsl:param> | |
| 540 | |
| 541 </programlisting> | |
| 542 </refsynopsisdiv> | |
| 543 | |
| 544 <refsection><info><title>Description</title></info> | |
| 545 | |
| 546 <para>The <parameter>ebnf.statement.terminator</parameter> parameter determines
what | |
| 547 text is used to terminate each <tag>production</tag> | |
| 548 in <tag>productionset</tag>.</para> | |
| 549 | |
| 550 <para>Some notations end each statement with a period.</para> | |
| 551 | |
| 552 </refsection> | |
| 553 </refentry> | |
| 554 | |
| 555 </reference> | |
| 556 <reference xml:id="toc_index"><title>ToC/LoT/Index Generation</title> | |
| 557 <refentry version="5.0" xml:id="annotate.toc"> | |
| 558 <refmeta> | |
| 559 <refentrytitle>annotate.toc</refentrytitle> | |
| 560 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 561 </refmeta> | |
| 562 <refnamediv> | |
| 563 <refname>annotate.toc</refname> | |
| 564 <refpurpose>Annotate the Table of Contents?</refpurpose> | |
| 565 </refnamediv> | |
| 566 | |
| 567 <refsynopsisdiv> | |
| 568 <programlisting xml:id="annotate.toc.frag"><xsl:param name="annotate.toc" sel
ect="1"></xsl:param></programlisting> | |
| 569 </refsynopsisdiv> | |
| 570 | |
| 571 <refsection><info><title>Description</title></info> | |
| 572 | |
| 573 <para>If true, TOCs will be annotated. At present, this just means | |
| 574 that the <tag>refpurpose</tag> of <tag>refentry</tag> | |
| 575 TOC entries will be displayed. | |
| 576 </para> | |
| 577 | |
| 578 </refsection> | |
| 579 </refentry> | |
| 580 | |
| 581 <refentry version="5.0" xml:id="autotoc.label.separator"> | |
| 582 <refmeta> | |
| 583 <refentrytitle>autotoc.label.separator</refentrytitle> | |
| 584 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 585 </refmeta> | |
| 586 <refnamediv> | |
| 587 <refname>autotoc.label.separator</refname> | |
| 588 <refpurpose>Separator between labels and titles in the ToC</refpurpose> | |
| 589 </refnamediv> | |
| 590 | |
| 591 <refsynopsisdiv> | |
| 592 <programlisting xml:id="autotoc.label.separator.frag"> | |
| 593 <xsl:param name="autotoc.label.separator">. </xsl:param> | |
| 594 </programlisting> | |
| 595 </refsynopsisdiv> | |
| 596 | |
| 597 <refsection><info><title>Description</title></info> | |
| 598 | |
| 599 <para>String used to separate labels and titles in a table of contents.</para> | |
| 600 | |
| 601 </refsection> | |
| 602 </refentry> | |
| 603 | |
| 604 <refentry version="5.0" xml:id="autotoc.label.in.hyperlink"> | |
| 605 <refmeta> | |
| 606 <refentrytitle>autotoc.label.in.hyperlink</refentrytitle> | |
| 607 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 608 </refmeta> | |
| 609 <refnamediv> | |
| 610 <refname>autotoc.label.in.hyperlink</refname> | |
| 611 <refpurpose>Include label in hyperlinked titles in TOC?</refpurpose> | |
| 612 </refnamediv> | |
| 613 | |
| 614 <refsynopsisdiv> | |
| 615 <programlisting xml:id="autotoc.label.in.hyperlink.frag"><xsl:param name="aut
otoc.label.in.hyperlink" select="1"></xsl:param></programlisting> | |
| 616 </refsynopsisdiv> | |
| 617 | |
| 618 <refsection><info><title>Description</title></info> | |
| 619 | |
| 620 <para>If the value of | |
| 621 <parameter>autotoc.label.in.hyperlink</parameter> is non-zero, labels | |
| 622 are included in hyperlinked titles in the TOC. If it is instead zero, | |
| 623 labels are still displayed prior to the hyperlinked titles, but | |
| 624 are not hyperlinked along with the titles.</para> | |
| 625 | |
| 626 </refsection> | |
| 627 </refentry> | |
| 628 | |
| 629 <refentry version="5.0" xml:id="process.source.toc"> | |
| 630 <refmeta> | |
| 631 <refentrytitle>process.source.toc</refentrytitle> | |
| 632 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 633 </refmeta> | |
| 634 <refnamediv> | |
| 635 <refname>process.source.toc</refname> | |
| 636 <refpurpose>Process a non-empty <tag>toc</tag> element if it occurs in a source
document?</refpurpose> | |
| 637 </refnamediv> | |
| 638 | |
| 639 <refsynopsisdiv> | |
| 640 <programlisting xml:id="process.source.toc.frag"><xsl:param name="process.sou
rce.toc" select="0"></xsl:param></programlisting> | |
| 641 </refsynopsisdiv> | |
| 642 | |
| 643 <refsection><info><title>Description</title></info> | |
| 644 | |
| 645 <para>Specifies that the contents of a non-empty "hard-coded" | |
| 646 <tag>toc</tag> element in a source document are processed to | |
| 647 generate a TOC in output. | |
| 648 <note> | |
| 649 <para>This parameter has no effect on automated generation of | |
| 650 TOCs. An automated TOC may still be generated along with the | |
| 651 "hard-coded" TOC. To suppress automated TOC generation, adjust the | |
| 652 value of the <parameter>generate.toc</parameter> paramameter.</para> | |
| 653 | |
| 654 <para>The <tag>process.source.toc</tag> parameter also has | |
| 655 no effect if the <tag>toc</tag> element is empty; handling | |
| 656 for empty <tag>toc</tag> is controlled by the | |
| 657 <parameter>process.empty.source.toc</parameter> parameter.</para> | |
| 658 </note> | |
| 659 </para> | |
| 660 | |
| 661 </refsection> | |
| 662 </refentry> | |
| 663 | |
| 664 <refentry version="5.0" xml:id="process.empty.source.toc"> | |
| 665 <refmeta> | |
| 666 <refentrytitle>process.empty.source.toc</refentrytitle> | |
| 667 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 668 </refmeta> | |
| 669 <refnamediv> | |
| 670 <refname>process.empty.source.toc</refname> | |
| 671 <refpurpose>Generate automated TOC if <tag>toc</tag> element occurs in a source
document?</refpurpose> | |
| 672 </refnamediv> | |
| 673 | |
| 674 <refsynopsisdiv> | |
| 675 <programlisting xml:id="process.empty.source.toc.frag"><xsl:param name="proce
ss.empty.source.toc" select="0"></xsl:param></programlisting> | |
| 676 </refsynopsisdiv> | |
| 677 | |
| 678 <refsection><info><title>Description</title></info> | |
| 679 | |
| 680 <para>Specifies that if an empty <tag>toc</tag> element is found in a | |
| 681 source document, an automated TOC is generated at this point in the | |
| 682 document. | |
| 683 <note> | |
| 684 <para>Depending on what the value of the | |
| 685 <parameter>generate.toc</parameter> parameter is, setting this | |
| 686 parameter to <literal>1</literal> could result in generation of | |
| 687 duplicate automated TOCs. So the | |
| 688 <parameter>process.empty.source.toc</parameter> is primarily useful | |
| 689 as an "override": by placing an empty <tag>toc</tag> in your | |
| 690 document and setting this parameter to <literal>1</literal>, you can | |
| 691 force a TOC to be generated even if <tag>generate.toc</tag> | |
| 692 says not to.</para> | |
| 693 </note> | |
| 694 </para> | |
| 695 | |
| 696 </refsection> | |
| 697 </refentry> | |
| 698 | |
| 699 <refentry version="5.0" xml:id="bridgehead.in.toc"> | |
| 700 <refmeta> | |
| 701 <refentrytitle>bridgehead.in.toc</refentrytitle> | |
| 702 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 703 </refmeta> | |
| 704 <refnamediv> | |
| 705 <refname>bridgehead.in.toc</refname> | |
| 706 <refpurpose>Should bridgehead elements appear in the TOC?</refpurpose> | |
| 707 </refnamediv> | |
| 708 | |
| 709 <refsynopsisdiv> | |
| 710 <programlisting xml:id="bridgehead.in.toc.frag"><xsl:param name="bridgehead.i
n.toc" select="0"></xsl:param></programlisting> | |
| 711 </refsynopsisdiv> | |
| 712 | |
| 713 <refsection><info><title>Description</title></info> | |
| 714 | |
| 715 <para>If non-zero, <tag>bridgehead</tag>s appear in the TOC. Note that | |
| 716 this option is not fully supported and may be removed in a future | |
| 717 version of the stylesheets. | |
| 718 </para> | |
| 719 | |
| 720 </refsection> | |
| 721 </refentry> | |
| 722 | |
| 723 <refentry version="5.0" xml:id="simplesect.in.toc"> | |
| 724 <refmeta> | |
| 725 <refentrytitle>simplesect.in.toc</refentrytitle> | |
| 726 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 727 </refmeta> | |
| 728 <refnamediv> | |
| 729 <refname>simplesect.in.toc</refname> | |
| 730 <refpurpose>Should <tag>simplesect</tag> elements appear in the TOC?</refpurpose
> | |
| 731 </refnamediv> | |
| 732 | |
| 733 <refsynopsisdiv> | |
| 734 <programlisting xml:id="simplesect.in.toc.frag"><xsl:param name="simplesect.i
n.toc" select="0"></xsl:param></programlisting> | |
| 735 </refsynopsisdiv> | |
| 736 | |
| 737 <refsection><info><title>Description</title></info> | |
| 738 | |
| 739 <para>If non-zero, <tag>simplesect</tag>s will be included in the TOC. | |
| 740 </para> | |
| 741 | |
| 742 </refsection> | |
| 743 </refentry> | |
| 744 | |
| 745 <refentry version="5.0" xml:id="manual.toc"> | |
| 746 <refmeta> | |
| 747 <refentrytitle>manual.toc</refentrytitle> | |
| 748 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 749 </refmeta> | |
| 750 <refnamediv> | |
| 751 <refname>manual.toc</refname> | |
| 752 <refpurpose>An explicit TOC to be used for the TOC</refpurpose> | |
| 753 </refnamediv> | |
| 754 | |
| 755 <refsynopsisdiv> | |
| 756 <programlisting xml:id="manual.toc.frag"> | |
| 757 <xsl:param name="manual.toc"></xsl:param> | |
| 758 </programlisting> | |
| 759 </refsynopsisdiv> | |
| 760 | |
| 761 <refsection><info><title>Description</title></info> | |
| 762 | |
| 763 <para>The <parameter>manual.toc</parameter> identifies an explicit TOC that | |
| 764 will be used for building the printed TOC. | |
| 765 </para> | |
| 766 | |
| 767 </refsection> | |
| 768 </refentry> | |
| 769 | |
| 770 <refentry version="5.0" xml:id="toc.list.type"> | |
| 771 <refmeta> | |
| 772 <refentrytitle>toc.list.type</refentrytitle> | |
| 773 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> | |
| 774 <refmiscinfo class="other" otherclass="value">dl</refmiscinfo> | |
| 775 <refmiscinfo class="other" otherclass="value">ul</refmiscinfo> | |
| 776 <refmiscinfo class="other" otherclass="value">ol</refmiscinfo> | |
| 777 </refmeta> | |
| 778 <refnamediv> | |
| 779 <refname>toc.list.type</refname> | |
| 780 <refpurpose>Type of HTML list element to use for Tables of Contents</refpurpose> | |
| 781 </refnamediv> | |
| 782 | |
| 783 <refsynopsisdiv> | |
| 784 <programlisting xml:id="toc.list.type.frag"><xsl:param name="toc.list.type"&g
t;dl</xsl:param></programlisting> | |
| 785 </refsynopsisdiv> | |
| 786 | |
| 787 <refsection><info><title>Description</title></info> | |
| 788 | |
| 789 <para>When an automatically generated Table of Contents (or List of Titles) | |
| 790 is produced, this HTML element will be used to make the list. | |
| 791 </para> | |
| 792 | |
| 793 </refsection> | |
| 794 </refentry> | |
| 795 | |
| 796 <refentry version="5.0" xml:id="toc.section.depth"> | |
| 797 <refmeta> | |
| 798 <refentrytitle>toc.section.depth</refentrytitle> | |
| 799 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> | |
| 800 </refmeta> | |
| 801 <refnamediv> | |
| 802 <refname>toc.section.depth</refname> | |
| 803 <refpurpose>How deep should recursive <tag>section</tag>s appear | |
| 804 in the TOC?</refpurpose> | |
| 805 </refnamediv> | |
| 806 | |
| 807 <refsynopsisdiv> | |
| 808 <programlisting xml:id="toc.section.depth.frag"><xsl:param name="toc.section.
depth">2</xsl:param></programlisting> | |
| 809 </refsynopsisdiv> | |
| 810 | |
| 811 <refsection><info><title>Description</title></info> | |
| 812 | |
| 813 <para>Specifies the depth to which recursive sections should appear in the | |
| 814 TOC. | |
| 815 </para> | |
| 816 | |
| 817 </refsection> | |
| 818 </refentry> | |
| 819 | |
| 820 <refentry version="5.0" xml:id="toc.max.depth"> | |
| 821 <refmeta> | |
| 822 <refentrytitle>toc.max.depth</refentrytitle> | |
| 823 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> | |
| 824 </refmeta> | |
| 825 <refnamediv> | |
| 826 <refname>toc.max.depth</refname> | |
| 827 <refpurpose>How many levels should be created for each TOC?</refpurpose> | |
| 828 </refnamediv> | |
| 829 | |
| 830 <refsynopsisdiv> | |
| 831 <programlisting xml:id="toc.max.depth.frag"><xsl:param name="toc.max.depth"&g
t;8</xsl:param></programlisting> | |
| 832 </refsynopsisdiv> | |
| 833 | |
| 834 <refsection><info><title>Description</title></info> | |
| 835 | |
| 836 <para>Specifies the maximal depth of TOC on all levels.</para> | |
| 837 | |
| 838 </refsection> | |
| 839 </refentry> | |
| 840 | |
| 841 <refentry version="5.0" xml:id="generate.toc"> | |
| 842 <refmeta> | |
| 843 <refentrytitle>generate.toc</refentrytitle> | |
| 844 <refmiscinfo class="other" otherclass="datatype">table</refmiscinfo> | |
| 845 </refmeta> | |
| 846 <refnamediv> | |
| 847 <refname>generate.toc</refname> | |
| 848 <refpurpose>Control generation of ToCs and LoTs</refpurpose> | |
| 849 </refnamediv> | |
| 850 | |
| 851 <refsynopsisdiv> | |
| 852 <programlisting xml:id="generate.toc.frag"> | |
| 853 <xsl:param name="generate.toc"> | |
| 854 appendix toc,title | |
| 855 article/appendix nop | |
| 856 article toc,title | |
| 857 book toc,title,figure,table,example,equation | |
| 858 chapter toc,title | |
| 859 part toc,title | |
| 860 preface toc,title | |
| 861 qandadiv toc | |
| 862 qandaset toc | |
| 863 reference toc,title | |
| 864 sect1 toc | |
| 865 sect2 toc | |
| 866 sect3 toc | |
| 867 sect4 toc | |
| 868 sect5 toc | |
| 869 section toc | |
| 870 set toc,title | |
| 871 </xsl:param> | |
| 872 | |
| 873 </programlisting> | |
| 874 </refsynopsisdiv> | |
| 875 | |
| 876 <refsection><info><title>Description</title></info> | |
| 877 | |
| 878 <para>This parameter has a structured value. It is a table of space-delimited | |
| 879 path/value pairs. Each path identifies some element in the source document | |
| 880 using a restricted subset of XPath (only the implicit child axis, no wildcards, | |
| 881 no predicates). Paths can be either relative or absolute.</para> | |
| 882 | |
| 883 <para>When processing a particular element, the stylesheets consult this table t
o | |
| 884 determine if a ToC (or LoT(s)) should be generated.</para> | |
| 885 | |
| 886 <para>For example, consider the entry:</para> | |
| 887 | |
| 888 <screen>book toc,figure</screen> | |
| 889 | |
| 890 <para>This indicates that whenever a <tag>book</tag> is formatted, a | |
| 891 Table Of Contents and a List of Figures should be generated. Similarly,</para> | |
| 892 | |
| 893 <screen>/chapter toc</screen> | |
| 894 | |
| 895 <para>indicates that whenever a document <emphasis>that has a root | |
| 896 of</emphasis> <tag>chapter</tag> is formatted, a Table of | |
| 897 Contents should be generated. The entry <literal>chapter</literal> would match | |
| 898 all chapters, but <literal>/chapter</literal> matches only <tag>chapter</tag> | |
| 899 document elements.</para> | |
| 900 | |
| 901 <para>Generally, the longest match wins. So, for example, if you want to disting
uish | |
| 902 articles in books from articles in parts, you could use these two entries:</para
> | |
| 903 | |
| 904 <screen>book/article toc,figure | |
| 905 part/article toc</screen> | |
| 906 | |
| 907 <para>Note that an article in a part can never match a <literal>book/article</li
teral>, | |
| 908 so if you want nothing to be generated for articles in parts, you can simply lea
ve | |
| 909 that rule out.</para> | |
| 910 | |
| 911 <para>If you want to leave the rule in, to make it explicit that you're turning | |
| 912 something off, use the value <quote>nop</quote>. For example, the following | |
| 913 entry disables ToCs and LoTs for articles:</para> | |
| 914 | |
| 915 <screen>article nop</screen> | |
| 916 | |
| 917 <para>Do not simply leave the word <quote>article</quote> in the file | |
| 918 without a matching value. That'd be just begging the silly little | |
| 919 path/value parser to get confused.</para> | |
| 920 | |
| 921 <para>Section ToCs are further controlled by the | |
| 922 <parameter>generate.section.toc.level</parameter> parameter. | |
| 923 For a given section level to have a ToC, it must have both an entry in | |
| 924 <parameter>generate.toc</parameter> and be within the range enabled by | |
| 925 <parameter>generate.section.toc.level</parameter>.</para> | |
| 926 </refsection> | |
| 927 </refentry> | |
| 928 | |
| 929 <refentry version="5.0" xml:id="generate.section.toc.level"> | |
| 930 <refmeta> | |
| 931 <refentrytitle>generate.section.toc.level</refentrytitle> | |
| 932 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> | |
| 933 </refmeta> | |
| 934 <refnamediv> | |
| 935 <refname>generate.section.toc.level</refname> | |
| 936 <refpurpose>Control depth of TOC generation in sections</refpurpose> | |
| 937 </refnamediv> | |
| 938 | |
| 939 <refsynopsisdiv> | |
| 940 <programlisting xml:id="generate.section.toc.level.frag"> | |
| 941 <xsl:param name="generate.section.toc.level" select="0"></xsl:param> | |
| 942 </programlisting> | |
| 943 </refsynopsisdiv> | |
| 944 | |
| 945 <refsection><info><title>Description</title></info> | |
| 946 | |
| 947 <para>The <parameter>generate.section.toc.level</parameter> parameter | |
| 948 controls the depth of <tag>section</tag> in which TOCs will be generated. Note | |
| 949 that this is related to, but not the same as | |
| 950 <parameter>toc.section.depth</parameter>, which controls the depth to | |
| 951 which TOC entries will be generated in a given TOC.</para> | |
| 952 <para>If, for example, <parameter>generate.section.toc.level</parameter> | |
| 953 is <literal>3</literal>, TOCs will be generated in first, second, and third | |
| 954 level sections, but not in fourth level sections. | |
| 955 </para> | |
| 956 | |
| 957 </refsection> | |
| 958 </refentry> | |
| 959 | |
| 960 <refentry version="5.0" xml:id="generate.index"> | |
| 961 <refmeta> | |
| 962 <refentrytitle>generate.index</refentrytitle> | |
| 963 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 964 </refmeta> | |
| 965 <refnamediv> | |
| 966 <refname>generate.index</refname> | |
| 967 <refpurpose>Do you want an index?</refpurpose> | |
| 968 </refnamediv> | |
| 969 | |
| 970 <refsynopsisdiv> | |
| 971 <programlisting xml:id="generate.index.frag"><xsl:param name="generate.index"
select="1"></xsl:param></programlisting> | |
| 972 </refsynopsisdiv> | |
| 973 | |
| 974 <refsection><info><title>Description</title></info> | |
| 975 | |
| 976 <para>Specify if an index should be generated. </para> | |
| 977 | |
| 978 </refsection> | |
| 979 </refentry> | |
| 980 | |
| 981 <refentry version="5.0" xml:id="index.method"> | |
| 982 <refmeta> | |
| 983 <refentrytitle>index.method</refentrytitle> | |
| 984 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> | |
| 985 <refmiscinfo class="other" otherclass="value">basic</refmiscinfo> | |
| 986 <refmiscinfo class="other" otherclass="value">kosek</refmiscinfo> | |
| 987 <refmiscinfo class="other" otherclass="value">kimber</refmiscinfo> | |
| 988 </refmeta> | |
| 989 <refnamediv> | |
| 990 <refname>index.method</refname> | |
| 991 <refpurpose>Select method used to group index entries in an index</refpurpose> | |
| 992 </refnamediv> | |
| 993 | |
| 994 <refsynopsisdiv> | |
| 995 <programlisting xml:id="index.method.frag"> | |
| 996 <xsl:param name="index.method">basic</xsl:param> | |
| 997 </programlisting> | |
| 998 </refsynopsisdiv> | |
| 999 | |
| 1000 <refsection><info><title>Description</title></info> | |
| 1001 | |
| 1002 <para>This parameter lets you select which method to use for sorting and groupin
g | |
| 1003 index entries in an index. | |
| 1004 Indexes in Latin-based languages that have accented characters typically | |
| 1005 sort together accented words and unaccented words. | |
| 1006 Thus <quote>Á</quote> (U+00C1 LATIN CAPITAL LETTER A WITH ACUTE) would sort
together | |
| 1007 with <quote>A</quote> (U+0041 LATIN CAPITAL LETTER A), so both would appear in t
he <quote>A</quote> | |
| 1008 section of the index. | |
| 1009 Languages using other alphabets (such as Russian, which is written in the Cyril
lic alphabet) | |
| 1010 and languages using ideographic chararacters (such as Japanese) | |
| 1011 require grouping specific to the languages and alphabets. | |
| 1012 </para> | |
| 1013 | |
| 1014 <para>The default indexing method is limited. | |
| 1015 It can group accented characters in Latin-based languages only. | |
| 1016 It cannot handle non-Latin alphabets or ideographic languages. | |
| 1017 The other indexing methods require extensions of one type or | |
| 1018 another, and do not work with | |
| 1019 all XSLT processors, which is why they are not used by default.</para> | |
| 1020 | |
| 1021 <para>The three choices for indexing method are:</para> | |
| 1022 <variablelist> | |
| 1023 <varlistentry> | |
| 1024 <term><literal>basic</literal></term> | |
| 1025 <listitem> | |
| 1026 <para> | |
| 1027 (default) Sort and groups words based only on the Latin alphabet. | |
| 1028 Words with accented Latin letters will group and sort with | |
| 1029 their respective primary letter, but | |
| 1030 words in non-Latin alphabets will be | |
| 1031 put in the <quote>Symbols</quote> section of the index. | |
| 1032 </para> | |
| 1033 </listitem> | |
| 1034 </varlistentry> | |
| 1035 <varlistentry> | |
| 1036 <term><literal>kosek</literal></term> | |
| 1037 <listitem> | |
| 1038 <para> | |
| 1039 This method sorts and groups words based on letter groups configured in | |
| 1040 the DocBook locale file for the given language. | |
| 1041 See, for example, the French locale file <filename>common/fr.xml</filename>. | |
| 1042 This method requires that the XSLT processor | |
| 1043 supports the EXSLT extensions (most do). | |
| 1044 It also requires support for using | |
| 1045 user-defined functions in xsl:key (xsltproc does not). | |
| 1046 </para> | |
| 1047 <para>This method is suitable for any language for which you can | |
| 1048 list all the individual characters that should appear | |
| 1049 in each letter group in an index. | |
| 1050 It is probably not practical to use it for ideographic languages | |
| 1051 such as Chinese that have hundreds or thousands of characters. | |
| 1052 </para> | |
| 1053 | |
| 1054 <para>To use the kosek method, you must:</para> | |
| 1055 | |
| 1056 <orderedlist> | |
| 1057 <listitem> | |
| 1058 <para>Use a processor that supports its extensions, such as | |
| 1059 Saxon 6 or Xalan (xsltproc and Saxon 8 do not). | |
| 1060 </para> | |
| 1061 </listitem> | |
| 1062 <listitem> | |
| 1063 <para>Set the index.method parameter's value to <quote>kosek</quote>. | |
| 1064 </para> | |
| 1065 </listitem> | |
| 1066 <listitem> | |
| 1067 <para>Import the appropriate index extensions stylesheet module | |
| 1068 <filename>fo/autoidx-kosek.xsl</filename> or | |
| 1069 <filename>html/autoidx-kosek.xsl</filename> into your | |
| 1070 customization. | |
| 1071 </para> | |
| 1072 </listitem> | |
| 1073 </orderedlist> | |
| 1074 | |
| 1075 </listitem> | |
| 1076 </varlistentry> | |
| 1077 <varlistentry> | |
| 1078 <term><literal>kimber</literal></term> | |
| 1079 <listitem> | |
| 1080 <para> | |
| 1081 This method uses extensions to the Saxon processor to implement | |
| 1082 sophisticated indexing processes. It uses its own | |
| 1083 configuration file, which can include information for any number of | |
| 1084 languages. Each language's configuration can group | |
| 1085 words using one of two processes. In the | |
| 1086 enumerated process similar to that used in the kosek method, | |
| 1087 you indicate the groupings character-by-character. | |
| 1088 In the between-key process, you specify the | |
| 1089 break-points in the sort order that should start a new group. | |
| 1090 The latter configuration is useful for ideographic languages | |
| 1091 such as Chinese, Japanese, and Korean. | |
| 1092 You can also define your own collation algorithms and how you | |
| 1093 want mixed Latin-alphabet words sorted.</para> | |
| 1094 <itemizedlist> | |
| 1095 <listitem> | |
| 1096 <para>For a whitepaper describing the extensions, see: | |
| 1097 <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.innodata
-isogen.com/knowledge_center/white_papers/back_of_book_for_xsl_fo.pdf">http://ww
w.innodata-isogen.com/knowledge_center/white_papers/back_of_book_for_xsl_fo.pdf<
/link>. | |
| 1098 </para> | |
| 1099 </listitem> | |
| 1100 <listitem> | |
| 1101 <para>To download the extension library, see | |
| 1102 <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.innodata
-isogen.com/knowledge_center/tools_downloads/i18nsupport">http://www.innodata-is
ogen.com/knowledge_center/tools_downloads/i18nsupport</link>. | |
| 1103 </para> | |
| 1104 </listitem> | |
| 1105 </itemizedlist> | |
| 1106 | |
| 1107 <para>To use the kimber method, you must:</para> | |
| 1108 | |
| 1109 <orderedlist> | |
| 1110 <listitem> | |
| 1111 <para>Use Saxon (version 6 or 8) as your XSLT processor. | |
| 1112 </para> | |
| 1113 </listitem> | |
| 1114 <listitem> | |
| 1115 <para>Install and configure the Innodata Isogen library, using | |
| 1116 the documentation that comes with it. | |
| 1117 </para> | |
| 1118 </listitem> | |
| 1119 <listitem> | |
| 1120 <para>Set the index.method parameter's value to <quote>kimber</quote>. | |
| 1121 </para> | |
| 1122 </listitem> | |
| 1123 <listitem> | |
| 1124 <para>Import the appropriate index extensions stylesheet module | |
| 1125 <filename>fo/autoidx-kimber.xsl</filename> or | |
| 1126 <filename>html/autoidx-kimber.xsl</filename> into your | |
| 1127 customization. | |
| 1128 </para> | |
| 1129 </listitem> | |
| 1130 </orderedlist> | |
| 1131 | |
| 1132 </listitem> | |
| 1133 </varlistentry> | |
| 1134 </variablelist> | |
| 1135 | |
| 1136 </refsection> | |
| 1137 </refentry> | |
| 1138 | |
| 1139 <refentry version="5.0" xml:id="index.on.type"> | |
| 1140 <refmeta> | |
| 1141 <refentrytitle>index.on.type</refentrytitle> | |
| 1142 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 1143 </refmeta> | |
| 1144 <refnamediv> | |
| 1145 <refname>index.on.type</refname> | |
| 1146 <refpurpose>Select indexterms based on <tag class="attribute">type</tag> | |
| 1147 attribute value</refpurpose> | |
| 1148 </refnamediv> | |
| 1149 | |
| 1150 <refsynopsisdiv> | |
| 1151 <programlisting xml:id="index.on.type.frag"> | |
| 1152 <xsl:param name="index.on.type" select="0"></xsl:param> | |
| 1153 </programlisting> | |
| 1154 </refsynopsisdiv> | |
| 1155 | |
| 1156 <refsection><info><title>Description</title></info> | |
| 1157 | |
| 1158 <para> | |
| 1159 If non-zero, | |
| 1160 then an <tag>index</tag> element that has a | |
| 1161 <tag class="attribute">type</tag> attribute | |
| 1162 value will contain only those <tag>indexterm</tag> | |
| 1163 elements with a matching <tag class="attribute">type</tag> attribute value. | |
| 1164 If an <tag>index</tag> has no <tag class="attribute">type</tag> | |
| 1165 attribute or it is blank, then the index will contain | |
| 1166 all <tag>indexterm</tag>s in the current scope. | |
| 1167 </para> | |
| 1168 | |
| 1169 <para> | |
| 1170 If <literal>index.on.type</literal> is zero, then the | |
| 1171 <tag class="attribute">type</tag> attribute has no effect | |
| 1172 on selecting indexterms for an index. | |
| 1173 </para> | |
| 1174 | |
| 1175 <para>For those using DocBook version 4.2 or earlier, | |
| 1176 the <tag class="attribute">type</tag> attribute is not available | |
| 1177 for index terms. However, you can achieve the same | |
| 1178 effect by using the <tag class="attribute">role</tag> attribute | |
| 1179 in the same manner on <tag>indexterm</tag> | |
| 1180 and <tag>index</tag>, and setting the stylesheet parameter | |
| 1181 <parameter>index.on.role</parameter> to a nonzero value. | |
| 1182 </para> | |
| 1183 | |
| 1184 </refsection> | |
| 1185 </refentry> | |
| 1186 | |
| 1187 <refentry version="5.0" xml:id="index.on.role"> | |
| 1188 <refmeta> | |
| 1189 <refentrytitle>index.on.role</refentrytitle> | |
| 1190 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 1191 </refmeta> | |
| 1192 <refnamediv> | |
| 1193 <refname>index.on.role</refname> | |
| 1194 <refpurpose>Select indexterms based on <tag class="attribute">role</tag> value</
refpurpose> | |
| 1195 </refnamediv> | |
| 1196 | |
| 1197 <refsynopsisdiv> | |
| 1198 <programlisting xml:id="index.on.role.frag"> | |
| 1199 <xsl:param name="index.on.role" select="0"></xsl:param> | |
| 1200 </programlisting> | |
| 1201 </refsynopsisdiv> | |
| 1202 | |
| 1203 <refsection><info><title>Description</title></info> | |
| 1204 | |
| 1205 <para> | |
| 1206 If non-zero, | |
| 1207 then an <tag>index</tag> element that has a | |
| 1208 <tag class="attribute">role</tag> attribute | |
| 1209 value will contain only those <tag>indexterm</tag> | |
| 1210 elements with a matching role value. | |
| 1211 If an <tag>index</tag> has no <tag class="attribute">role</tag> | |
| 1212 attribute or it is blank, then the index will contain | |
| 1213 all <tag>indexterm</tag>s in the current scope. | |
| 1214 </para> | |
| 1215 <para> | |
| 1216 If <literal>index.on.role</literal> is zero, then the | |
| 1217 <tag class="attribute">role</tag> attribute has no effect | |
| 1218 on selecting indexterms for an index. | |
| 1219 </para> | |
| 1220 | |
| 1221 <para>If you are using DocBook version 4.3 or later, you should | |
| 1222 use the <tag class="attribute">type</tag> attribute instead of <tag class="attri
bute">role</tag> | |
| 1223 on <tag>indexterm</tag> and <tag>index</tag>, | |
| 1224 and set the <parameter>index.on.type</parameter> to a nonzero | |
| 1225 value. | |
| 1226 </para> | |
| 1227 | |
| 1228 </refsection> | |
| 1229 </refentry> | |
| 1230 | |
| 1231 <refentry version="5.0" xml:id="index.links.to.section"> | |
| 1232 <refmeta> | |
| 1233 <refentrytitle>index.links.to.section</refentrytitle> | |
| 1234 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 1235 </refmeta> | |
| 1236 <refnamediv> | |
| 1237 <refname>index.links.to.section</refname> | |
| 1238 <refpurpose>HTML index entries link to container section title</refpurpose> | |
| 1239 </refnamediv> | |
| 1240 | |
| 1241 <refsynopsisdiv> | |
| 1242 <programlisting xml:id="index.links.to.section.frag"> | |
| 1243 <xsl:param name="index.links.to.section" select="1"></xsl:param> | |
| 1244 </programlisting> | |
| 1245 </refsynopsisdiv> | |
| 1246 | |
| 1247 <refsection><info><title>Description</title></info> | |
| 1248 | |
| 1249 <para>If zero, then an index entry in an index links | |
| 1250 directly to the location of the | |
| 1251 generated <tag>anchor</tag> that is output | |
| 1252 for the indexterm. If two identical indexterm elements | |
| 1253 exist in the same section, then both entries appear | |
| 1254 in the index with the same title but link to different | |
| 1255 locations.</para> | |
| 1256 | |
| 1257 <para>If non-zero, then an index entry in an index links to the | |
| 1258 section title containing the <tag>indexterm</tag>, rather than | |
| 1259 directly to the <tag>anchor</tag> output for the indexterm. | |
| 1260 Duplicate indexterm entries in the same section are dropped. | |
| 1261 </para> | |
| 1262 | |
| 1263 <para>The default value is 1, so index entries link to | |
| 1264 section titles by default.</para> | |
| 1265 | |
| 1266 <para>In both cases, the link text in an index entry is the | |
| 1267 title of the section containing the indexterm. | |
| 1268 That is because HTML does not have numbered pages. | |
| 1269 It also provides the reader with context information | |
| 1270 for each link.</para> | |
| 1271 | |
| 1272 <para>This parameter lets you choose which style of | |
| 1273 index linking you want. </para> | |
| 1274 | |
| 1275 <itemizedlist> | |
| 1276 <listitem> | |
| 1277 <para>When set to 0, an index entry takes you | |
| 1278 to the precise location of its corresponding indexterm. | |
| 1279 However, if you have a lot of duplicate | |
| 1280 entries in sections, then you have a lot of duplicate | |
| 1281 titles in the index, which makes it more cluttered. | |
| 1282 The reader may not recognize why duplicate titles | |
| 1283 appear until they follow the links. Also, the links | |
| 1284 may land the reader in the middle of a section where the | |
| 1285 section title is not visible, which may also be | |
| 1286 confusing to the reader.</para> | |
| 1287 </listitem> | |
| 1288 <listitem> | |
| 1289 <para>When set to 1, an index entry link is | |
| 1290 less precise, but duplicate titles in the | |
| 1291 index entries are eliminated. | |
| 1292 Landing on the section title location may confirm the reader's | |
| 1293 expectation that a link that | |
| 1294 shows a section title will take them to that section title, | |
| 1295 not a location within the section. | |
| 1296 </para> | |
| 1297 </listitem> | |
| 1298 </itemizedlist> | |
| 1299 | |
| 1300 </refsection> | |
| 1301 </refentry> | |
| 1302 | |
| 1303 <refentry version="5.0" xml:id="index.prefer.titleabbrev"> | |
| 1304 <refmeta> | |
| 1305 <refentrytitle>index.prefer.titleabbrev</refentrytitle> | |
| 1306 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 1307 </refmeta> | |
| 1308 <refnamediv> | |
| 1309 <refname>index.prefer.titleabbrev</refname> | |
| 1310 <refpurpose>Should abbreviated titles be used as back references?</refpurpose> | |
| 1311 </refnamediv> | |
| 1312 | |
| 1313 <refsynopsisdiv> | |
| 1314 <programlisting xml:id="index.prefer.titleabbrev.frag"> | |
| 1315 <xsl:param name="index.prefer.titleabbrev" select="0"></xsl:param> | |
| 1316 </programlisting> | |
| 1317 </refsynopsisdiv> | |
| 1318 | |
| 1319 <refsection><info><title>Description</title></info> | |
| 1320 | |
| 1321 <para>If non-zero, and if a <tag>titleabbrev</tag> is defined, the abbreviated t
itle | |
| 1322 is used as the link text of a back reference in the index. | |
| 1323 </para> | |
| 1324 | |
| 1325 </refsection> | |
| 1326 </refentry> | |
| 1327 | |
| 1328 <refentry version="5.0" xml:id="index.term.separator"> | |
| 1329 <refmeta> | |
| 1330 <refentrytitle>index.term.separator</refentrytitle> | |
| 1331 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 1332 </refmeta> | |
| 1333 <refnamediv> | |
| 1334 <refname>index.term.separator</refname> | |
| 1335 <refpurpose>Override for punctuation separating an index term | |
| 1336 from its list of page references in an index</refpurpose> | |
| 1337 </refnamediv> | |
| 1338 | |
| 1339 <refsynopsisdiv> | |
| 1340 <programlisting xml:id="index.term.separator.frag"> | |
| 1341 <xsl:param name="index.term.separator"></xsl:param> | |
| 1342 </programlisting> | |
| 1343 </refsynopsisdiv> | |
| 1344 | |
| 1345 <refsection><info><title>Description</title></info> | |
| 1346 | |
| 1347 <para>This parameter permits you to override | |
| 1348 the text to insert between | |
| 1349 the end of an index term and its list of page references. | |
| 1350 Typically that might be a comma and a space. | |
| 1351 </para> | |
| 1352 | |
| 1353 <para>Because this text may be locale dependent, | |
| 1354 this parameter's value is normally taken from a gentext | |
| 1355 template named 'term-separator' in the | |
| 1356 context 'index' in the stylesheet | |
| 1357 locale file for the language | |
| 1358 of the current document. | |
| 1359 This parameter can be used to override the gentext string, | |
| 1360 and would typically be used on the command line. | |
| 1361 This parameter would apply to all languages. | |
| 1362 </para> | |
| 1363 | |
| 1364 <para>So this text string can be customized in two ways. | |
| 1365 You can reset the default gentext string using | |
| 1366 the <parameter>local.l10n.xml</parameter> parameter, or you can | |
| 1367 fill in the content for this normally empty | |
| 1368 override parameter. | |
| 1369 The content can be a simple string, or it can be | |
| 1370 something more complex such as a call-template. | |
| 1371 For fo output, it could be an <tag>fo:leader</tag> | |
| 1372 element to provide space of a specific length, or a dot leader. | |
| 1373 </para> | |
| 1374 | |
| 1375 </refsection> | |
| 1376 </refentry> | |
| 1377 | |
| 1378 <refentry version="5.0" xml:id="index.number.separator"> | |
| 1379 <refmeta> | |
| 1380 <refentrytitle>index.number.separator</refentrytitle> | |
| 1381 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 1382 </refmeta> | |
| 1383 <refnamediv> | |
| 1384 <refname>index.number.separator</refname> | |
| 1385 <refpurpose>Override for punctuation separating page numbers in index</refpurpos
e> | |
| 1386 </refnamediv> | |
| 1387 | |
| 1388 <refsynopsisdiv> | |
| 1389 <programlisting xml:id="index.number.separator.frag"> | |
| 1390 <xsl:param name="index.number.separator"></xsl:param> | |
| 1391 </programlisting> | |
| 1392 </refsynopsisdiv> | |
| 1393 | |
| 1394 <refsection><info><title>Description</title></info> | |
| 1395 | |
| 1396 <para>This parameter permits you to override the text to insert between | |
| 1397 page references in a formatted index entry. Typically | |
| 1398 that would be a comma and a space. | |
| 1399 </para> | |
| 1400 | |
| 1401 <para>Because this text may be locale dependent, | |
| 1402 this parameter's value is normally taken from a gentext | |
| 1403 template named 'number-separator' in the | |
| 1404 context 'index' in the stylesheet | |
| 1405 locale file for the language | |
| 1406 of the current document. | |
| 1407 This parameter can be used to override the gentext string, | |
| 1408 and would typically be used on the command line. | |
| 1409 This parameter would apply to all languages. | |
| 1410 </para> | |
| 1411 | |
| 1412 <para>So this text string can be customized in two ways. | |
| 1413 You can reset the default gentext string using | |
| 1414 the <parameter>local.l10n.xml</parameter> parameter, or you can | |
| 1415 override the gentext with the content of this parameter. | |
| 1416 The content can be a simple string, or it can be | |
| 1417 something more complex such as a call-template. | |
| 1418 </para> | |
| 1419 | |
| 1420 <para>In HTML index output, section title references are used instead of | |
| 1421 page number references. This punctuation appears between | |
| 1422 such section titles in an HTML index. | |
| 1423 </para> | |
| 1424 | |
| 1425 </refsection> | |
| 1426 </refentry> | |
| 1427 | |
| 1428 <refentry version="5.0" xml:id="index.range.separator"> | |
| 1429 <refmeta> | |
| 1430 <refentrytitle>index.range.separator</refentrytitle> | |
| 1431 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 1432 </refmeta> | |
| 1433 <refnamediv> | |
| 1434 <refname>index.range.separator</refname> | |
| 1435 <refpurpose>Override for punctuation separating the two numbers | |
| 1436 in a page range in index</refpurpose> | |
| 1437 </refnamediv> | |
| 1438 | |
| 1439 <refsynopsisdiv> | |
| 1440 <programlisting xml:id="index.range.separator.frag"> | |
| 1441 <xsl:param name="index.range.separator"></xsl:param> | |
| 1442 </programlisting> | |
| 1443 </refsynopsisdiv> | |
| 1444 | |
| 1445 <refsection><info><title>Description</title></info> | |
| 1446 | |
| 1447 <para>This parameter permits you | |
| 1448 to override the text to insert between | |
| 1449 the two numbers of a page range in an index. | |
| 1450 This parameter is only used by those XSL-FO processors | |
| 1451 that support an extension for generating such page ranges | |
| 1452 (such as XEP).</para> | |
| 1453 | |
| 1454 <para>Because this text may be locale dependent, | |
| 1455 this parameter's value is normally taken from a gentext | |
| 1456 template named 'range-separator' in the | |
| 1457 context 'index' in the stylesheet | |
| 1458 locale file for the language | |
| 1459 of the current document. | |
| 1460 This parameter can be used to override the gentext string, | |
| 1461 and would typically be used on the command line. | |
| 1462 This parameter would apply to all languages. | |
| 1463 </para> | |
| 1464 | |
| 1465 <para>So this text string can be customized in two ways. | |
| 1466 You can reset the default gentext string using | |
| 1467 the <parameter>local.l10n.xml</parameter> parameter, or you can | |
| 1468 override the gentext with the content of this parameter. | |
| 1469 The content can be a simple string, or it can be | |
| 1470 something more complex such as a call-template. | |
| 1471 </para> | |
| 1472 | |
| 1473 <para>In HTML index output, section title references are used instead of | |
| 1474 page number references. So there are no page ranges | |
| 1475 and this parameter has no effect. | |
| 1476 </para> | |
| 1477 | |
| 1478 </refsection> | |
| 1479 </refentry> | |
| 1480 | |
| 1481 </reference> | |
| 1482 <reference xml:id="dbk_ext"><title>Stylesheet Extensions</title> | |
| 1483 <refentry version="5.0" xml:id="linenumbering.everyNth"> | |
| 1484 <refmeta> | |
| 1485 <refentrytitle>linenumbering.everyNth</refentrytitle> | |
| 1486 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> | |
| 1487 </refmeta> | |
| 1488 <refnamediv> | |
| 1489 <refname>linenumbering.everyNth</refname> | |
| 1490 <refpurpose>Indicate which lines should be numbered</refpurpose> | |
| 1491 </refnamediv> | |
| 1492 | |
| 1493 <refsynopsisdiv> | |
| 1494 <programlisting xml:id="linenumbering.everyNth.frag"> | |
| 1495 <xsl:param name="linenumbering.everyNth">5</xsl:param> | |
| 1496 </programlisting> | |
| 1497 </refsynopsisdiv> | |
| 1498 | |
| 1499 <refsection><info><title>Description</title></info> | |
| 1500 | |
| 1501 <para>If line numbering is enabled, everyNth line will be | |
| 1502 numbered. Note that numbering is one based, not zero based. | |
| 1503 </para> | |
| 1504 <para>See also <parameter>linenumbering.extension</parameter>, | |
| 1505 <parameter>linenumbering.separator</parameter>, | |
| 1506 <parameter>linenumbering.width</parameter> and | |
| 1507 <parameter>use.extensions</parameter></para> | |
| 1508 | |
| 1509 </refsection> | |
| 1510 </refentry> | |
| 1511 | |
| 1512 <refentry version="5.0" xml:id="linenumbering.extension"> | |
| 1513 <refmeta> | |
| 1514 <refentrytitle>linenumbering.extension</refentrytitle> | |
| 1515 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 1516 </refmeta> | |
| 1517 <refnamediv> | |
| 1518 <refname>linenumbering.extension</refname> | |
| 1519 <refpurpose>Enable the line numbering extension</refpurpose> | |
| 1520 </refnamediv> | |
| 1521 | |
| 1522 <refsynopsisdiv> | |
| 1523 <programlisting xml:id="linenumbering.extension.frag"> | |
| 1524 <xsl:param name="linenumbering.extension" select="1"></xsl:param> | |
| 1525 </programlisting> | |
| 1526 </refsynopsisdiv> | |
| 1527 | |
| 1528 <refsection><info><title>Description</title></info> | |
| 1529 | |
| 1530 <para>If non-zero, verbatim environments (<tag>address</tag>, <tag>literallayout
</tag>, | |
| 1531 <tag>programlisting</tag>, <tag>screen</tag>, <tag>synopsis</tag>) that specify
line numbering will | |
| 1532 have line numbers. | |
| 1533 </para> | |
| 1534 | |
| 1535 </refsection> | |
| 1536 </refentry> | |
| 1537 | |
| 1538 <refentry version="5.0" xml:id="linenumbering.separator"> | |
| 1539 <refmeta> | |
| 1540 <refentrytitle>linenumbering.separator</refentrytitle> | |
| 1541 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 1542 </refmeta> | |
| 1543 <refnamediv> | |
| 1544 <refname>linenumbering.separator</refname> | |
| 1545 <refpurpose>Specify a separator between line numbers and lines</refpurpose> | |
| 1546 </refnamediv> | |
| 1547 | |
| 1548 <refsynopsisdiv> | |
| 1549 <programlisting xml:id="linenumbering.separator.frag"> | |
| 1550 <xsl:param name="linenumbering.separator"><xsl:text> </xsl:text&g
t;</xsl:param> | |
| 1551 </programlisting> | |
| 1552 </refsynopsisdiv> | |
| 1553 | |
| 1554 <refsection><info><title>Description</title></info> | |
| 1555 | |
| 1556 <para>The separator is inserted between line numbers and lines in the | |
| 1557 verbatim environment. The default value is a single white space. | |
| 1558 Note the interaction with <parameter>linenumbering.width</parameter> | |
| 1559 </para> | |
| 1560 | |
| 1561 </refsection> | |
| 1562 </refentry> | |
| 1563 | |
| 1564 <refentry version="5.0" xml:id="linenumbering.width"> | |
| 1565 <refmeta> | |
| 1566 <refentrytitle>linenumbering.width</refentrytitle> | |
| 1567 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> | |
| 1568 </refmeta> | |
| 1569 <refnamediv> | |
| 1570 <refname>linenumbering.width</refname> | |
| 1571 <refpurpose>Indicates the width of line numbers</refpurpose> | |
| 1572 </refnamediv> | |
| 1573 | |
| 1574 <refsynopsisdiv> | |
| 1575 <programlisting xml:id="linenumbering.width.frag"> | |
| 1576 <xsl:param name="linenumbering.width">3</xsl:param> | |
| 1577 </programlisting> | |
| 1578 </refsynopsisdiv> | |
| 1579 | |
| 1580 <refsection><info><title>Description</title></info> | |
| 1581 | |
| 1582 <para>If line numbering is enabled, line numbers will appear right | |
| 1583 justified in a field "width" characters wide. | |
| 1584 </para> | |
| 1585 | |
| 1586 </refsection> | |
| 1587 </refentry> | |
| 1588 | |
| 1589 <refentry version="5.0" xml:id="tablecolumns.extension"> | |
| 1590 <refmeta> | |
| 1591 <refentrytitle>tablecolumns.extension</refentrytitle> | |
| 1592 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 1593 </refmeta> | |
| 1594 <refnamediv> | |
| 1595 <refname>tablecolumns.extension</refname> | |
| 1596 <refpurpose>Enable the table columns extension function</refpurpose> | |
| 1597 </refnamediv> | |
| 1598 | |
| 1599 <refsynopsisdiv> | |
| 1600 <programlisting xml:id="tablecolumns.extension.frag"> | |
| 1601 <xsl:param name="tablecolumns.extension" select="1"></xsl:param> | |
| 1602 </programlisting> | |
| 1603 </refsynopsisdiv> | |
| 1604 | |
| 1605 <refsection><info><title>Description</title></info> | |
| 1606 | |
| 1607 <para>The table columns extension function adjusts the widths of table | |
| 1608 columns in the HTML result to more accurately reflect the specifications | |
| 1609 in the CALS table. | |
| 1610 </para> | |
| 1611 | |
| 1612 </refsection> | |
| 1613 </refentry> | |
| 1614 | |
| 1615 <refentry version="5.0" xml:id="textinsert.extension"> | |
| 1616 <refmeta> | |
| 1617 <refentrytitle>textinsert.extension</refentrytitle> | |
| 1618 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 1619 </refmeta> | |
| 1620 <refnamediv> | |
| 1621 <refname>textinsert.extension</refname> | |
| 1622 <refpurpose>Enables the textinsert extension element</refpurpose> | |
| 1623 </refnamediv> | |
| 1624 <refsynopsisdiv> | |
| 1625 <programlisting xml:id="textinsert.extension.frag"> | |
| 1626 <xsl:param name="textinsert.extension" select="1"></xsl:param> | |
| 1627 </programlisting> | |
| 1628 </refsynopsisdiv> | |
| 1629 <refsection><info><title>Description</title></info> | |
| 1630 <para>The textinsert extension element inserts the contents of | |
| 1631 a file into the result tree (as text).</para> | |
| 1632 <note> | |
| 1633 <para>To use the textinsert extension element, you must use | |
| 1634 either Saxon or Xalan as your XSLT processor (it doesn’t | |
| 1635 work with xsltproc), along with either the DocBook Saxon | |
| 1636 extensions or DocBook Xalan extensions (for more | |
| 1637 information about those extensions, see <link xmlns:xlink="http://www.w3
.org/1999/xlink" role="tcg" xlink:href="InstallingAProcessor.html#SaxonExtension
s">DocBook Saxon Extensions</link> and <link xmlns:xlink="http://www.w3.org/1999
/xlink" role="tcg" xlink:href="InstallingAProcessor.html#XalanExtensions">DocBoo
k Xalan Extensions</link>), and you must set both | |
| 1638 the <parameter>use.extensions</parameter> and | |
| 1639 <parameter>textinsert.extension</parameter> parameters to | |
| 1640 <literal>1</literal>.</para> | |
| 1641 <para>As an alternative to using the textinsert element, | |
| 1642 consider using an Xinclude element with the | |
| 1643 <literal>parse="text"</literal> attribute and value | |
| 1644 specified, as detailed in <link xmlns:xlink="http://www.w3.org/1999/xlin
k" role="tcg" xlink:href="ExternalCode.html#XIncludeCode">Using XInclude for tex
t inclusions</link>.</para> | |
| 1645 </note> | |
| 1646 </refsection> | |
| 1647 <refsection><info><title>See Also</title></info> | |
| 1648 <para>You can also use the <tag class="xmlpi">dbhtml-include href</tag>
processing | |
| 1649 instruction to insert external files — both files containing | |
| 1650 plain text and files with markup content (including HTML | |
| 1651 content).</para> | |
| 1652 </refsection> | |
| 1653 <refsection><info><title>More information</title></info> | |
| 1654 <para>For how-to documentation on inserting contents of | |
| 1655 external code files and other text files into output, see | |
| 1656 <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="Ex
ternalCode.html">External code files</link>.</para> | |
| 1657 <para>For guidelines on inserting contents of | |
| 1658 HTML files into output, see <link xmlns:xlink="http://www.w3.org/1999/xlin
k" role="tcg" xlink:href="InsertExtHtml.html">Inserting external HTML code</link
>.</para> | |
| 1659 </refsection> | |
| 1660 </refentry> | |
| 1661 | |
| 1662 <refentry version="5.0" xml:id="textdata.default.encoding"> | |
| 1663 <refmeta> | |
| 1664 <refentrytitle>textdata.default.encoding</refentrytitle> | |
| 1665 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 1666 </refmeta> | |
| 1667 <refnamediv> | |
| 1668 <refname>textdata.default.encoding</refname> | |
| 1669 <refpurpose>Default encoding of external text files which are included | |
| 1670 using textdata element</refpurpose> | |
| 1671 </refnamediv> | |
| 1672 | |
| 1673 <refsynopsisdiv> | |
| 1674 <programlisting xml:id="textdata.default.encoding.frag"> | |
| 1675 <xsl:param name="textdata.default.encoding"></xsl:param> | |
| 1676 </programlisting> | |
| 1677 </refsynopsisdiv> | |
| 1678 | |
| 1679 <refsection><info><title>Description</title></info> | |
| 1680 | |
| 1681 <para>Specifies the encoding of any external text files included using | |
| 1682 <tag>textdata</tag> element. This value is used only when you do | |
| 1683 not specify encoding by the appropriate attribute | |
| 1684 directly on textdata. An empty string is interpreted as the system | |
| 1685 default encoding.</para> | |
| 1686 | |
| 1687 </refsection> | |
| 1688 </refentry> | |
| 1689 | |
| 1690 <refentry version="5.0" xml:id="graphicsize.extension"> | |
| 1691 <refmeta> | |
| 1692 <refentrytitle>graphicsize.extension</refentrytitle> | |
| 1693 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 1694 </refmeta> | |
| 1695 <refnamediv> | |
| 1696 <refname>graphicsize.extension</refname> | |
| 1697 <refpurpose>Enable the getWidth()/getDepth() extension functions</refpurpose> | |
| 1698 </refnamediv> | |
| 1699 | |
| 1700 <refsynopsisdiv> | |
| 1701 <programlisting xml:id="graphicsize.extension.frag"> | |
| 1702 <xsl:param name="graphicsize.extension" select="1"></xsl:param> | |
| 1703 </programlisting> | |
| 1704 </refsynopsisdiv> | |
| 1705 | |
| 1706 <refsection><info><title>Description</title></info> | |
| 1707 | |
| 1708 <para>If non-zero (and if <parameter>use.extensions</parameter> is non-zero | |
| 1709 and if you're using a processor that supports extension functions), the | |
| 1710 <function>getWidth</function> and <function>getDepth</function> functions | |
| 1711 will be used to extract image sizes from graphics.</para> | |
| 1712 | |
| 1713 <para>The main supported image formats are GIF, JPEG, and PNG. Somewhat cruder | |
| 1714 support for EPS and PDF images is also available.</para> | |
| 1715 </refsection> | |
| 1716 </refentry> | |
| 1717 | |
| 1718 <refentry version="5.0" xml:id="graphicsize.use.img.src.path"> | |
| 1719 <refmeta> | |
| 1720 <refentrytitle>graphicsize.use.img.src.path</refentrytitle> | |
| 1721 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 1722 </refmeta> | |
| 1723 <refnamediv> | |
| 1724 <refname>graphicsize.use.img.src.path</refname> | |
| 1725 <refpurpose>Prepend <parameter>img.src.path</parameter> before | |
| 1726 filenames passed to extension functions</refpurpose> | |
| 1727 </refnamediv> | |
| 1728 | |
| 1729 <refsynopsisdiv> | |
| 1730 <programlisting xml:id="graphicsize.use.img.src.path.frag"> | |
| 1731 <xsl:param name="graphicsize.use.img.src.path" select="0"></xsl:param&g
t; | |
| 1732 </programlisting> | |
| 1733 </refsynopsisdiv> | |
| 1734 | |
| 1735 <refsection><info><title>Description</title></info> | |
| 1736 | |
| 1737 <para>If non-zero <parameter>img.src.path</parameter> parameter will | |
| 1738 be appended before filenames passed to extension functions for | |
| 1739 measuring image dimensions.</para> | |
| 1740 | |
| 1741 </refsection> | |
| 1742 </refentry> | |
| 1743 | |
| 1744 <refentry version="5.0" xml:id="use.extensions"> | |
| 1745 <refmeta> | |
| 1746 <refentrytitle>use.extensions</refentrytitle> | |
| 1747 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 1748 </refmeta> | |
| 1749 <refnamediv> | |
| 1750 <refname>use.extensions</refname> | |
| 1751 <refpurpose>Enable extensions</refpurpose> | |
| 1752 </refnamediv> | |
| 1753 | |
| 1754 <refsynopsisdiv> | |
| 1755 <programlisting xml:id="use.extensions.frag"> | |
| 1756 <xsl:param name="use.extensions" select="0"></xsl:param> | |
| 1757 </programlisting> | |
| 1758 </refsynopsisdiv> | |
| 1759 | |
| 1760 <refsection><info><title>Description</title></info> | |
| 1761 | |
| 1762 <para>If non-zero, extensions may be used. Each extension is | |
| 1763 further controlled by its own parameter. But if | |
| 1764 <parameter>use.extensions</parameter> is zero, no extensions will | |
| 1765 be used. | |
| 1766 </para> | |
| 1767 | |
| 1768 </refsection> | |
| 1769 </refentry> | |
| 1770 | |
| 1771 </reference> | |
| 1772 <reference xml:id="labels"><title>Automatic labelling</title> | |
| 1773 <refentry version="5.0" xml:id="chapter.autolabel"> | |
| 1774 <refmeta> | |
| 1775 <refentrytitle>chapter.autolabel</refentrytitle> | |
| 1776 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> | |
| 1777 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo> | |
| 1778 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo> | |
| 1779 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo> | |
| 1780 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo> | |
| 1781 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscin
fo> | |
| 1782 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscin
fo> | |
| 1783 </refmeta> | |
| 1784 <refnamediv> | |
| 1785 <refname>chapter.autolabel</refname> | |
| 1786 <refpurpose>Specifies the labeling format for Chapter titles</refpurpose> | |
| 1787 </refnamediv> | |
| 1788 | |
| 1789 <refsynopsisdiv> | |
| 1790 <programlisting xml:id="chapter.autolabel.frag"> | |
| 1791 <xsl:param name="chapter.autolabel" select="1"></xsl:param></program
listing> | |
| 1792 </refsynopsisdiv> | |
| 1793 | |
| 1794 <refsection><info><title>Description</title></info> | |
| 1795 | |
| 1796 <para>If non-zero, then chapters will be numbered using the parameter | |
| 1797 value as the number format if the value matches one of the following: | |
| 1798 </para> | |
| 1799 | |
| 1800 <variablelist> | |
| 1801 <varlistentry> | |
| 1802 <term>1 or arabic</term> | |
| 1803 <listitem> | |
| 1804 <para>Arabic numeration (1, 2, 3 ...).</para> | |
| 1805 </listitem> | |
| 1806 </varlistentry> | |
| 1807 <varlistentry> | |
| 1808 <term>A or upperalpha</term> | |
| 1809 <listitem> | |
| 1810 <para>Uppercase letter numeration (A, B, C ...).</para> | |
| 1811 </listitem> | |
| 1812 </varlistentry> | |
| 1813 <varlistentry> | |
| 1814 <term>a or loweralpha</term> | |
| 1815 <listitem> | |
| 1816 <para>Lowercase letter numeration (a, b, c ...).</para> | |
| 1817 </listitem> | |
| 1818 </varlistentry> | |
| 1819 <varlistentry> | |
| 1820 <term>I or upperroman</term> | |
| 1821 <listitem> | |
| 1822 <para>Uppercase roman numeration (I, II, III ...).</para> | |
| 1823 </listitem> | |
| 1824 </varlistentry> | |
| 1825 <varlistentry> | |
| 1826 <term>i or lowerroman</term> | |
| 1827 <listitem> | |
| 1828 <para>Lowercase roman letter numeration (i, ii, iii ...).</para> | |
| 1829 </listitem> | |
| 1830 </varlistentry> | |
| 1831 </variablelist> | |
| 1832 | |
| 1833 <para>Any nonzero value other than the above will generate | |
| 1834 the default number format (arabic). | |
| 1835 </para> | |
| 1836 | |
| 1837 </refsection> | |
| 1838 </refentry> | |
| 1839 | |
| 1840 <refentry version="5.0" xml:id="appendix.autolabel"> | |
| 1841 <refmeta> | |
| 1842 <refentrytitle>appendix.autolabel</refentrytitle> | |
| 1843 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> | |
| 1844 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo> | |
| 1845 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo> | |
| 1846 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo> | |
| 1847 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo> | |
| 1848 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscin
fo> | |
| 1849 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscin
fo> | |
| 1850 </refmeta> | |
| 1851 <refnamediv> | |
| 1852 <refname>appendix.autolabel</refname> | |
| 1853 <refpurpose>Specifies the labeling format for Appendix titles</refpurpose> | |
| 1854 </refnamediv> | |
| 1855 | |
| 1856 <refsynopsisdiv> | |
| 1857 <programlisting xml:id="appendix.autolabel.frag"> | |
| 1858 <xsl:param name="appendix.autolabel">A</xsl:param> | |
| 1859 </programlisting> | |
| 1860 </refsynopsisdiv> | |
| 1861 | |
| 1862 <refsection><info><title>Description</title></info> | |
| 1863 | |
| 1864 <para>If non-zero, then appendices will be numbered using the | |
| 1865 parameter value as the number format if the value matches one of the | |
| 1866 following: | |
| 1867 </para> | |
| 1868 | |
| 1869 <variablelist> | |
| 1870 <varlistentry> | |
| 1871 <term>1 or arabic</term> | |
| 1872 <listitem> | |
| 1873 <para>Arabic numeration (1, 2, 3 ...).</para> | |
| 1874 </listitem> | |
| 1875 </varlistentry> | |
| 1876 <varlistentry> | |
| 1877 <term>A or upperalpha</term> | |
| 1878 <listitem> | |
| 1879 <para>Uppercase letter numeration (A, B, C ...).</para> | |
| 1880 </listitem> | |
| 1881 </varlistentry> | |
| 1882 <varlistentry> | |
| 1883 <term>a or loweralpha</term> | |
| 1884 <listitem> | |
| 1885 <para>Lowercase letter numeration (a, b, c ...).</para> | |
| 1886 </listitem> | |
| 1887 </varlistentry> | |
| 1888 <varlistentry> | |
| 1889 <term>I or upperroman</term> | |
| 1890 <listitem> | |
| 1891 <para>Uppercase roman numeration (I, II, III ...).</para> | |
| 1892 </listitem> | |
| 1893 </varlistentry> | |
| 1894 <varlistentry> | |
| 1895 <term>i or lowerroman</term> | |
| 1896 <listitem> | |
| 1897 <para>Lowercase roman letter numeration (i, ii, iii ...).</para> | |
| 1898 </listitem> | |
| 1899 </varlistentry> | |
| 1900 </variablelist> | |
| 1901 | |
| 1902 <para>Any nonzero value other than the above will generate | |
| 1903 the default number format (upperalpha). | |
| 1904 </para> | |
| 1905 | |
| 1906 </refsection> | |
| 1907 </refentry> | |
| 1908 | |
| 1909 <refentry version="5.0" xml:id="part.autolabel"> | |
| 1910 <refmeta> | |
| 1911 <refentrytitle>part.autolabel</refentrytitle> | |
| 1912 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> | |
| 1913 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo> | |
| 1914 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo> | |
| 1915 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo> | |
| 1916 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo> | |
| 1917 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscin
fo> | |
| 1918 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscin
fo> | |
| 1919 </refmeta> | |
| 1920 <refnamediv> | |
| 1921 <refname>part.autolabel</refname> | |
| 1922 <refpurpose>Specifies the labeling format for Part titles</refpurpose> | |
| 1923 </refnamediv> | |
| 1924 | |
| 1925 <refsynopsisdiv> | |
| 1926 <programlisting xml:id="part.autolabel.frag"> | |
| 1927 <xsl:param name="part.autolabel">I</xsl:param> | |
| 1928 </programlisting> | |
| 1929 </refsynopsisdiv> | |
| 1930 | |
| 1931 <refsection><info><title>Description</title></info> | |
| 1932 | |
| 1933 <para>If non-zero, then parts will be numbered using the parameter | |
| 1934 value as the number format if the value matches one of the following: | |
| 1935 </para> | |
| 1936 | |
| 1937 <variablelist> | |
| 1938 <varlistentry> | |
| 1939 <term>1 or arabic</term> | |
| 1940 <listitem> | |
| 1941 <para>Arabic numeration (1, 2, 3 ...).</para> | |
| 1942 </listitem> | |
| 1943 </varlistentry> | |
| 1944 <varlistentry> | |
| 1945 <term>A or upperalpha</term> | |
| 1946 <listitem> | |
| 1947 <para>Uppercase letter numeration (A, B, C ...).</para> | |
| 1948 </listitem> | |
| 1949 </varlistentry> | |
| 1950 <varlistentry> | |
| 1951 <term>a or loweralpha</term> | |
| 1952 <listitem> | |
| 1953 <para>Lowercase letter numeration (a, b, c ...).</para> | |
| 1954 </listitem> | |
| 1955 </varlistentry> | |
| 1956 <varlistentry> | |
| 1957 <term>I or upperroman</term> | |
| 1958 <listitem> | |
| 1959 <para>Uppercase roman numeration (I, II, III ...).</para> | |
| 1960 </listitem> | |
| 1961 </varlistentry> | |
| 1962 <varlistentry> | |
| 1963 <term>i or lowerroman</term> | |
| 1964 <listitem> | |
| 1965 <para>Lowercase roman letter numeration (i, ii, iii ...).</para> | |
| 1966 </listitem> | |
| 1967 </varlistentry> | |
| 1968 </variablelist> | |
| 1969 | |
| 1970 <para>Any nonzero value other than the above will generate | |
| 1971 the default number format (upperroman). | |
| 1972 </para> | |
| 1973 | |
| 1974 | |
| 1975 </refsection> | |
| 1976 </refentry> | |
| 1977 | |
| 1978 <refentry version="5.0" xml:id="reference.autolabel"> | |
| 1979 <refmeta> | |
| 1980 <refentrytitle>reference.autolabel</refentrytitle> | |
| 1981 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> | |
| 1982 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo> | |
| 1983 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo> | |
| 1984 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo> | |
| 1985 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo> | |
| 1986 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscin
fo> | |
| 1987 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscin
fo> | |
| 1988 </refmeta> | |
| 1989 <refnamediv> | |
| 1990 <refname>reference.autolabel</refname> | |
| 1991 <refpurpose>Specifies the labeling format for Reference titles</refpurpose> | |
| 1992 </refnamediv> | |
| 1993 <refsynopsisdiv> | |
| 1994 <programlisting xml:id="reference.autolabel.frag"> | |
| 1995 <xsl:param name="reference.autolabel">I</xsl:param> | |
| 1996 </programlisting> | |
| 1997 </refsynopsisdiv> | |
| 1998 <refsection><info><title>Description</title></info> | |
| 1999 <para>If non-zero, references will be numbered using the parameter | |
| 2000 value as the number format if the value matches one of the | |
| 2001 following: | |
| 2002 </para> | |
| 2003 <variablelist> | |
| 2004 <varlistentry> | |
| 2005 <term>1 or arabic</term> | |
| 2006 <listitem> | |
| 2007 <para>Arabic numeration (1, 2, 3 ...).</para> | |
| 2008 </listitem> | |
| 2009 </varlistentry> | |
| 2010 <varlistentry> | |
| 2011 <term>A or upperalpha</term> | |
| 2012 <listitem> | |
| 2013 <para>Uppercase letter numeration (A, B, C ...).</para> | |
| 2014 </listitem> | |
| 2015 </varlistentry> | |
| 2016 <varlistentry> | |
| 2017 <term>a or loweralpha</term> | |
| 2018 <listitem> | |
| 2019 <para>Lowercase letter numeration (a, b, c ...).</para> | |
| 2020 </listitem> | |
| 2021 </varlistentry> | |
| 2022 <varlistentry> | |
| 2023 <term>I or upperroman</term> | |
| 2024 <listitem> | |
| 2025 <para>Uppercase roman numeration (I, II, III ...).</para> | |
| 2026 </listitem> | |
| 2027 </varlistentry> | |
| 2028 <varlistentry> | |
| 2029 <term>i or lowerroman</term> | |
| 2030 <listitem> | |
| 2031 <para>Lowercase roman letter numeration (i, ii, iii ...).</para> | |
| 2032 </listitem> | |
| 2033 </varlistentry> | |
| 2034 </variablelist> | |
| 2035 <para>Any non-zero value other than the above will generate | |
| 2036 the default number format (upperroman). | |
| 2037 </para> | |
| 2038 </refsection> | |
| 2039 </refentry> | |
| 2040 | |
| 2041 <refentry version="5.0" xml:id="preface.autolabel"> | |
| 2042 <refmeta> | |
| 2043 <refentrytitle>preface.autolabel</refentrytitle> | |
| 2044 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> | |
| 2045 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo> | |
| 2046 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo> | |
| 2047 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo> | |
| 2048 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo> | |
| 2049 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscin
fo> | |
| 2050 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscin
fo> | |
| 2051 </refmeta> | |
| 2052 <refnamediv> | |
| 2053 <refname>preface.autolabel</refname> | |
| 2054 <refpurpose>Specifices the labeling format for Preface titles</refpurpose> | |
| 2055 </refnamediv> | |
| 2056 | |
| 2057 <refsynopsisdiv> | |
| 2058 <programlisting xml:id="preface.autolabel.frag"><xsl:param name="preface.auto
label" select="0"></xsl:param></programlisting> | |
| 2059 </refsynopsisdiv> | |
| 2060 | |
| 2061 <refsection><info><title>Description</title></info> | |
| 2062 | |
| 2063 <para>If non-zero then prefaces will be numbered using the parameter | |
| 2064 value as the number format if the value matches one of the following: | |
| 2065 </para> | |
| 2066 | |
| 2067 <variablelist> | |
| 2068 <varlistentry> | |
| 2069 <term>1 or arabic</term> | |
| 2070 <listitem> | |
| 2071 <para>Arabic numeration (1, 2, 3 ...).</para> | |
| 2072 </listitem> | |
| 2073 </varlistentry> | |
| 2074 <varlistentry> | |
| 2075 <term>A or upperalpha</term> | |
| 2076 <listitem> | |
| 2077 <para>Uppercase letter numeration (A, B, C ...).</para> | |
| 2078 </listitem> | |
| 2079 </varlistentry> | |
| 2080 <varlistentry> | |
| 2081 <term>a or loweralpha</term> | |
| 2082 <listitem> | |
| 2083 <para>Lowercase letter numeration (a, b, c ...).</para> | |
| 2084 </listitem> | |
| 2085 </varlistentry> | |
| 2086 <varlistentry> | |
| 2087 <term>I or upperroman</term> | |
| 2088 <listitem> | |
| 2089 <para>Uppercase roman numeration (I, II, III ...).</para> | |
| 2090 </listitem> | |
| 2091 </varlistentry> | |
| 2092 <varlistentry> | |
| 2093 <term>i or lowerroman</term> | |
| 2094 <listitem> | |
| 2095 <para>Lowercase roman letter numeration (i, ii, iii ...).</para> | |
| 2096 </listitem> | |
| 2097 </varlistentry> | |
| 2098 </variablelist> | |
| 2099 | |
| 2100 <para>Any nonzero value other than the above will generate | |
| 2101 the default number format (arabic). | |
| 2102 </para> | |
| 2103 | |
| 2104 | |
| 2105 </refsection> | |
| 2106 </refentry> | |
| 2107 | |
| 2108 <refentry version="5.0" xml:id="qandadiv.autolabel"> | |
| 2109 <refmeta> | |
| 2110 <refentrytitle>qandadiv.autolabel</refentrytitle> | |
| 2111 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 2112 </refmeta> | |
| 2113 <refnamediv> | |
| 2114 <refname>qandadiv.autolabel</refname> | |
| 2115 <refpurpose>Are divisions in QAndASets enumerated?</refpurpose> | |
| 2116 </refnamediv> | |
| 2117 | |
| 2118 <refsynopsisdiv> | |
| 2119 <programlisting xml:id="qandadiv.autolabel.frag"><xsl:param name="qandadiv.au
tolabel" select="1"></xsl:param></programlisting> | |
| 2120 </refsynopsisdiv> | |
| 2121 | |
| 2122 <refsection><info><title>Description</title></info> | |
| 2123 | |
| 2124 <para>If non-zero, unlabeled qandadivs will be enumerated. | |
| 2125 </para> | |
| 2126 | |
| 2127 </refsection> | |
| 2128 </refentry> | |
| 2129 | |
| 2130 <refentry version="5.0" xml:id="section.autolabel"> | |
| 2131 <refmeta> | |
| 2132 <refentrytitle>section.autolabel</refentrytitle> | |
| 2133 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 2134 </refmeta> | |
| 2135 <refnamediv> | |
| 2136 <refname>section.autolabel</refname> | |
| 2137 <refpurpose>Are sections enumerated?</refpurpose> | |
| 2138 </refnamediv> | |
| 2139 | |
| 2140 <refsynopsisdiv> | |
| 2141 <programlisting xml:id="section.autolabel.frag"><xsl:param name="section.auto
label" select="0"></xsl:param></programlisting> | |
| 2142 </refsynopsisdiv> | |
| 2143 | |
| 2144 <refsection><info><title>Description</title></info> | |
| 2145 | |
| 2146 <para>If true (non-zero), unlabeled sections will be enumerated. | |
| 2147 </para> | |
| 2148 | |
| 2149 </refsection> | |
| 2150 </refentry> | |
| 2151 | |
| 2152 <refentry version="5.0" xml:id="section.autolabel.max.depth"> | |
| 2153 <refmeta> | |
| 2154 <refentrytitle>section.autolabel.max.depth</refentrytitle> | |
| 2155 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> | |
| 2156 </refmeta> | |
| 2157 <refnamediv> | |
| 2158 <refname>section.autolabel.max.depth</refname> | |
| 2159 <refpurpose>The deepest level of sections that are numbered.</refpurpose> | |
| 2160 </refnamediv> | |
| 2161 | |
| 2162 <refsynopsisdiv> | |
| 2163 <programlisting xml:id="section.autolabel.max.depth.frag"> | |
| 2164 <xsl:param name="section.autolabel.max.depth">8</xsl:param> | |
| 2165 </programlisting> | |
| 2166 </refsynopsisdiv> | |
| 2167 | |
| 2168 <refsection><info><title>Description</title></info> | |
| 2169 | |
| 2170 <para>When section numbering is turned on by the | |
| 2171 <parameter>section.autolabel</parameter> parameter, then this | |
| 2172 parameter controls the depth of <tag>section</tag> nesting that is | |
| 2173 numbered. Sections nested to a level deeper than this value will not | |
| 2174 be numbered. | |
| 2175 </para> | |
| 2176 | |
| 2177 </refsection> | |
| 2178 </refentry> | |
| 2179 | |
| 2180 <refentry version="5.0" xml:id="section.label.includes.component.label"> | |
| 2181 <refmeta> | |
| 2182 <refentrytitle>section.label.includes.component.label</refentrytitle> | |
| 2183 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 2184 </refmeta> | |
| 2185 <refnamediv> | |
| 2186 <refname>section.label.includes.component.label</refname> | |
| 2187 <refpurpose>Do section labels include the component label?</refpurpose> | |
| 2188 </refnamediv> | |
| 2189 | |
| 2190 <refsynopsisdiv> | |
| 2191 <programlisting xml:id="section.label.includes.component.label.frag"><xsl:par
am name="section.label.includes.component.label" select="0"></xsl:param>
;</programlisting> | |
| 2192 </refsynopsisdiv> | |
| 2193 | |
| 2194 <refsection><info><title>Description</title></info> | |
| 2195 | |
| 2196 <para>If non-zero, section labels are prefixed with the label of the | |
| 2197 component that contains them. | |
| 2198 </para> | |
| 2199 | |
| 2200 </refsection> | |
| 2201 </refentry> | |
| 2202 | |
| 2203 <refentry version="5.0" xml:id="label.from.part"> | |
| 2204 <refmeta> | |
| 2205 <refentrytitle>label.from.part</refentrytitle> | |
| 2206 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 2207 </refmeta> | |
| 2208 <refnamediv> | |
| 2209 <refname>label.from.part</refname> | |
| 2210 <refpurpose>Renumber components in each part?</refpurpose> | |
| 2211 </refnamediv> | |
| 2212 | |
| 2213 <refsynopsisdiv> | |
| 2214 <programlisting xml:id="label.from.part.frag"> | |
| 2215 <xsl:param name="label.from.part" select="0"></xsl:param> | |
| 2216 </programlisting> | |
| 2217 </refsynopsisdiv> | |
| 2218 | |
| 2219 <refsection><info><title>Description</title></info> | |
| 2220 | |
| 2221 <para>If <parameter>label.from.part</parameter> is non-zero, then | |
| 2222 numbering of components — <tag>preface</tag>, | |
| 2223 <tag>chapter</tag>, <tag>appendix</tag>, and | |
| 2224 <tag>reference</tag> (when <tag>reference</tag> occurs at the | |
| 2225 component level) — is re-started within each | |
| 2226 <tag>part</tag>.</para> | |
| 2227 <para>If <parameter>label.from.part</parameter> is zero (the | |
| 2228 default), numbering of components is <emphasis>not</emphasis> | |
| 2229 re-started within each <tag>part</tag>; instead, components are | |
| 2230 numbered sequentially throughout each <tag>book</tag>, | |
| 2231 regardless of whether or not they occur within <tag>part</tag> | |
| 2232 instances.</para> | |
| 2233 | |
| 2234 </refsection> | |
| 2235 </refentry> | |
| 2236 | |
| 2237 <refentry version="5.0" xml:id="component.label.includes.part.label"> | |
| 2238 <refmeta> | |
| 2239 <refentrytitle>component.label.includes.part.label</refentrytitle> | |
| 2240 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 2241 </refmeta> | |
| 2242 <refnamediv> | |
| 2243 <refname>component.label.includes.part.label</refname> | |
| 2244 <refpurpose>Do component labels include the part label?</refpurpose> | |
| 2245 </refnamediv> | |
| 2246 | |
| 2247 <refsynopsisdiv> | |
| 2248 <programlisting xml:id="component.label.includes.part.label.frag"><xsl:param
name="component.label.includes.part.label" select="0"></xsl:param></pro
gramlisting> | |
| 2249 </refsynopsisdiv> | |
| 2250 | |
| 2251 <refsection><info><title>Description</title></info> | |
| 2252 | |
| 2253 <para>If non-zero, number labels for <tag>chapter</tag>, | |
| 2254 <tag>appendix</tag>, and other component elements are prefixed with | |
| 2255 the label of the part element that contains them. So you might see | |
| 2256 Chapter II.3 instead of Chapter 3. Also, the labels for formal | |
| 2257 elements such as <tag>table</tag> and <tag>figure</tag> will include | |
| 2258 the part label. If there is no part element container, then no prefix | |
| 2259 is generated. | |
| 2260 </para> | |
| 2261 <para> | |
| 2262 This feature is most useful when the | |
| 2263 <parameter>label.from.part</parameter> parameter is turned on. | |
| 2264 In that case, there would be more than one <tag>chapter</tag> | |
| 2265 <quote>1</quote>, and the extra part label prefix will identify | |
| 2266 each chapter unambiguously. | |
| 2267 </para> | |
| 2268 | |
| 2269 </refsection> | |
| 2270 </refentry> | |
| 2271 | |
| 2272 </reference> | |
| 2273 | |
| 2274 <reference xml:id="html"><title>HTML</title> | |
| 2275 <refentry version="5.0" xml:id="html.base"> | |
| 2276 <refmeta> | |
| 2277 <refentrytitle>html.base</refentrytitle> | |
| 2278 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> | |
| 2279 </refmeta> | |
| 2280 <refnamediv> | |
| 2281 <refname>html.base</refname> | |
| 2282 <refpurpose>An HTML base URI</refpurpose> | |
| 2283 </refnamediv> | |
| 2284 | |
| 2285 <refsynopsisdiv> | |
| 2286 <programlisting xml:id="html.base.frag"> | |
| 2287 <xsl:param name="html.base"></xsl:param></programlisting> | |
| 2288 </refsynopsisdiv> | |
| 2289 | |
| 2290 <refsection><info><title>Description</title></info> | |
| 2291 | |
| 2292 <para>If html.base is set, it is used for the <tag>base</tag> element | |
| 2293 in the <tag>head</tag> of the html documents. The parameter specifies | |
| 2294 the base URL for all relative URLs in the document. This is useful | |
| 2295 for dynamically served html where the base URI needs to be | |
| 2296 shifted.</para> | |
| 2297 | |
| 2298 </refsection> | |
| 2299 </refentry> | |
| 2300 | |
| 2301 <refentry version="5.0" xml:id="html.stylesheet"> | |
| 2302 <refmeta> | |
| 2303 <refentrytitle>html.stylesheet</refentrytitle> | |
| 2304 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 2305 </refmeta> | |
| 2306 <refnamediv> | |
| 2307 <refname>html.stylesheet</refname> | |
| 2308 <refpurpose>Name of the stylesheet(s) to use in the generated HTML</refpurpose> | |
| 2309 </refnamediv> | |
| 2310 | |
| 2311 <refsynopsisdiv> | |
| 2312 <programlisting xml:id="html.stylesheet.frag"> | |
| 2313 <xsl:param name="html.stylesheet"></xsl:param> | |
| 2314 </programlisting> | |
| 2315 </refsynopsisdiv> | |
| 2316 | |
| 2317 <refsection><info><title>Description</title></info> | |
| 2318 | |
| 2319 <para>The <parameter>html.stylesheet</parameter> parameter is either | |
| 2320 empty, indicating that no stylesheet <tag>link</tag> tag should be | |
| 2321 generated in the html output, or it is a list of one or more | |
| 2322 stylesheet files.</para> | |
| 2323 | |
| 2324 <para>Multiple stylesheets are space-delimited. If you need to | |
| 2325 reference a stylesheet URI that includes a space, encode it with | |
| 2326 <literal>%20</literal>. A separate html <literal>link</literal> element will | |
| 2327 be generated for each stylesheet in the order they are listed in the | |
| 2328 parameter.</para> | |
| 2329 | |
| 2330 </refsection> | |
| 2331 </refentry> | |
| 2332 | |
| 2333 <refentry version="5.0" xml:id="html.stylesheet.type"> | |
| 2334 <refmeta> | |
| 2335 <refentrytitle>html.stylesheet.type</refentrytitle> | |
| 2336 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 2337 </refmeta> | |
| 2338 <refnamediv> | |
| 2339 <refname>html.stylesheet.type</refname> | |
| 2340 <refpurpose>The type of the stylesheet used in the generated HTML</refpurpose> | |
| 2341 </refnamediv> | |
| 2342 | |
| 2343 <refsynopsisdiv> | |
| 2344 <programlisting xml:id="html.stylesheet.type.frag"><xsl:param name="html.styl
esheet.type">text/css</xsl:param></programlisting> | |
| 2345 </refsynopsisdiv> | |
| 2346 | |
| 2347 <refsection><info><title>Description</title></info> | |
| 2348 | |
| 2349 <para>The type of the stylesheet to place in the HTML <tag>link</tag> tag. | |
| 2350 </para> | |
| 2351 | |
| 2352 </refsection> | |
| 2353 </refentry> | |
| 2354 | |
| 2355 <refentry version="5.0" xml:id="css.decoration"> | |
| 2356 <refmeta> | |
| 2357 <refentrytitle>css.decoration</refentrytitle> | |
| 2358 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 2359 </refmeta> | |
| 2360 <refnamediv> | |
| 2361 <refname>css.decoration</refname> | |
| 2362 <refpurpose>Enable CSS decoration of elements</refpurpose> | |
| 2363 </refnamediv> | |
| 2364 | |
| 2365 <refsynopsisdiv> | |
| 2366 <programlisting xml:id="css.decoration.frag"> | |
| 2367 <xsl:param name="css.decoration" select="1"></xsl:param> | |
| 2368 </programlisting> | |
| 2369 </refsynopsisdiv> | |
| 2370 | |
| 2371 <refsection><info><title>Description</title></info> | |
| 2372 | |
| 2373 <para> | |
| 2374 If non-zero, then html elements produced by the stylesheet may be | |
| 2375 decorated with <literal>style</literal> attributes. For example, the | |
| 2376 <literal>li</literal> tags produced for list items may include a | |
| 2377 fragment of CSS in the <literal>style</literal> attribute which sets | |
| 2378 the CSS property "list-style-type". | |
| 2379 </para> | |
| 2380 | |
| 2381 </refsection> | |
| 2382 </refentry> | |
| 2383 | |
| 2384 <refentry version="5.0" xml:id="html.script"> | |
| 2385 <refmeta> | |
| 2386 <refentrytitle>html.script</refentrytitle> | |
| 2387 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 2388 </refmeta> | |
| 2389 <refnamediv> | |
| 2390 <refname>html.script</refname> | |
| 2391 <refpurpose>Name of the script(s) to use in the generated HTML</refpurpose> | |
| 2392 </refnamediv> | |
| 2393 | |
| 2394 <refsynopsisdiv> | |
| 2395 <programlisting xml:id="html.script.frag"> | |
| 2396 <xsl:param name="html.script"></xsl:param> | |
| 2397 </programlisting> | |
| 2398 </refsynopsisdiv> | |
| 2399 | |
| 2400 <refsection><info><title>Description</title></info> | |
| 2401 | |
| 2402 <para>The <parameter>html.script</parameter> parameter is either | |
| 2403 empty (default), indicating that no <tag>script</tag> element should be | |
| 2404 generated in the html output, or it is a list of one or more | |
| 2405 script locations.</para> | |
| 2406 | |
| 2407 <para>Multiple script locations are space-delimited. If you need to | |
| 2408 reference a script URI that includes a space, encode it with | |
| 2409 <literal>%20</literal>. A separate html <literal>script</literal> element will | |
| 2410 be generated for each script in the order they are listed in the | |
| 2411 parameter.</para> | |
| 2412 | |
| 2413 </refsection> | |
| 2414 </refentry> | |
| 2415 | |
| 2416 <refentry version="5.0" xml:id="html.script.type"> | |
| 2417 <refmeta> | |
| 2418 <refentrytitle>html.script.type</refentrytitle> | |
| 2419 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 2420 </refmeta> | |
| 2421 <refnamediv> | |
| 2422 <refname>html.script.type</refname> | |
| 2423 <refpurpose>The type of script used in the generated HTML</refpurpose> | |
| 2424 </refnamediv> | |
| 2425 | |
| 2426 <refsynopsisdiv> | |
| 2427 <programlisting xml:id="html.script.type.frag"><xsl:param name="html.script.t
ype">text/javascript</xsl:param></programlisting> | |
| 2428 </refsynopsisdiv> | |
| 2429 | |
| 2430 <refsection><info><title>Description</title></info> | |
| 2431 | |
| 2432 <para>The type of script to place in the HTML <tag>script</tag> element. | |
| 2433 Specifically, the value of the <tag>script</tag> element's <tag>type</tag> | |
| 2434 attribute. | |
| 2435 The default value is <literal>text/javascript</literal>. | |
| 2436 This param is used only when the stylesheet parameter | |
| 2437 <tag>html.script</tag> is non-blank and specifies the location of a script.</par
a> | |
| 2438 | |
| 2439 | |
| 2440 </refsection> | |
| 2441 </refentry> | |
| 2442 | |
| 2443 <refentry version="5.0" xml:id="spacing.paras"> | |
| 2444 <refmeta> | |
| 2445 <refentrytitle>spacing.paras</refentrytitle> | |
| 2446 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 2447 </refmeta> | |
| 2448 <refnamediv> | |
| 2449 <refname>spacing.paras</refname> | |
| 2450 <refpurpose>Insert additional <p> elements for spacing?</refpurpose> | |
| 2451 </refnamediv> | |
| 2452 | |
| 2453 <refsynopsisdiv> | |
| 2454 <programlisting xml:id="spacing.paras.frag"> | |
| 2455 <xsl:param name="spacing.paras" select="0"></xsl:param> | |
| 2456 </programlisting> | |
| 2457 </refsynopsisdiv> | |
| 2458 | |
| 2459 <refsection><info><title>Description</title></info> | |
| 2460 | |
| 2461 <para>When non-zero, additional, empty paragraphs are inserted in | |
| 2462 several contexts (for example, around informal figures), to create a | |
| 2463 more pleasing visual appearance in many browsers. | |
| 2464 </para> | |
| 2465 | |
| 2466 </refsection> | |
| 2467 </refentry> | |
| 2468 | |
| 2469 <refentry version="5.0" xml:id="emphasis.propagates.style"> | |
| 2470 <refmeta> | |
| 2471 <refentrytitle>emphasis.propagates.style</refentrytitle> | |
| 2472 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 2473 </refmeta> | |
| 2474 <refnamediv> | |
| 2475 <refname>emphasis.propagates.style</refname> | |
| 2476 <refpurpose>Pass emphasis role attribute through to HTML?</refpurpose> | |
| 2477 </refnamediv> | |
| 2478 <refsynopsisdiv> | |
| 2479 <programlisting xml:id="emphasis.propagates.style.frag"> | |
| 2480 <xsl:param name="emphasis.propagates.style" select="1"></xsl:param> | |
| 2481 </programlisting> | |
| 2482 </refsynopsisdiv> | |
| 2483 <refsection><info><title>Description</title></info> | |
| 2484 <para>If non-zero, the <literal>role</literal> attribute of | |
| 2485 <tag>emphasis</tag> elements will be passed through to the HTML as a | |
| 2486 class attribute on a <literal>span</literal> that surrounds the | |
| 2487 emphasis.</para> | |
| 2488 </refsection> | |
| 2489 </refentry> | |
| 2490 | |
| 2491 <refentry version="5.0" xml:id="para.propagates.style"> | |
| 2492 <refmeta> | |
| 2493 <refentrytitle>para.propagates.style</refentrytitle> | |
| 2494 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 2495 </refmeta> | |
| 2496 <refnamediv> | |
| 2497 <refname>para.propagates.style</refname> | |
| 2498 <refpurpose>Pass para role attribute through to HTML?</refpurpose> | |
| 2499 </refnamediv> | |
| 2500 | |
| 2501 <refsynopsisdiv> | |
| 2502 <programlisting xml:id="para.propagates.style.frag"> | |
| 2503 <xsl:param name="para.propagates.style" select="1"></xsl:param> | |
| 2504 </programlisting> | |
| 2505 </refsynopsisdiv> | |
| 2506 | |
| 2507 <refsection><info><title>Description</title></info> | |
| 2508 | |
| 2509 <para>If true, the role attribute of <tag>para</tag> elements | |
| 2510 will be passed through to the HTML as a class attribute on the | |
| 2511 <tag>p</tag> generated for the paragraph.</para> | |
| 2512 | |
| 2513 </refsection> | |
| 2514 </refentry> | |
| 2515 | |
| 2516 <refentry version="5.0" xml:id="phrase.propagates.style"> | |
| 2517 <refmeta> | |
| 2518 <refentrytitle>phrase.propagates.style</refentrytitle> | |
| 2519 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 2520 </refmeta> | |
| 2521 <refnamediv> | |
| 2522 <refname>phrase.propagates.style</refname> | |
| 2523 <refpurpose>Pass phrase role attribute through to HTML?</refpurpose> | |
| 2524 </refnamediv> | |
| 2525 | |
| 2526 <refsynopsisdiv> | |
| 2527 <programlisting xml:id="phrase.propagates.style.frag"> | |
| 2528 <xsl:param name="phrase.propagates.style" select="1"></xsl:param></p
rogramlisting> | |
| 2529 </refsynopsisdiv> | |
| 2530 | |
| 2531 <refsection><info><title>Description</title></info> | |
| 2532 | |
| 2533 <para>If non-zero, the role attribute of <tag>phrase</tag> elements | |
| 2534 will be passed through to the HTML as a <literal>class</literal> | |
| 2535 attribute on a <literal>span</literal> that surrounds the | |
| 2536 phrase.</para> | |
| 2537 | |
| 2538 </refsection> | |
| 2539 </refentry> | |
| 2540 | |
| 2541 <refentry version="5.0" xml:id="entry.propagates.style"> | |
| 2542 <refmeta> | |
| 2543 <refentrytitle>entry.propagates.style</refentrytitle> | |
| 2544 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 2545 </refmeta> | |
| 2546 <refnamediv> | |
| 2547 <refname>entry.propagates.style</refname> | |
| 2548 <refpurpose>Pass entry role attribute through to HTML?</refpurpose> | |
| 2549 </refnamediv> | |
| 2550 | |
| 2551 <refsynopsisdiv> | |
| 2552 <programlisting xml:id="entry.propagates.style.frag"> | |
| 2553 <xsl:param name="entry.propagates.style" select="1"></xsl:param> | |
| 2554 </programlisting> | |
| 2555 </refsynopsisdiv> | |
| 2556 | |
| 2557 <refsection><info><title>Description</title></info> | |
| 2558 | |
| 2559 <para>If true, the role attribute of <tag>entry</tag> elements | |
| 2560 will be passed through to the HTML as a class attribute on the | |
| 2561 <tag>td</tag> or <tag>th</tag> generated for the table | |
| 2562 cell.</para> | |
| 2563 | |
| 2564 </refsection> | |
| 2565 </refentry> | |
| 2566 | |
| 2567 <refentry version="5.0" xml:id="html.longdesc"> | |
| 2568 <refmeta> | |
| 2569 <refentrytitle>html.longdesc</refentrytitle> | |
| 2570 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 2571 </refmeta> | |
| 2572 <refnamediv> | |
| 2573 <refname>html.longdesc</refname> | |
| 2574 <refpurpose>Should longdesc URIs be created?</refpurpose> | |
| 2575 </refnamediv> | |
| 2576 <refsynopsisdiv> | |
| 2577 <programlisting xml:id="html.longdesc.frag"> | |
| 2578 <xsl:param name="html.longdesc" select="1"></xsl:param> | |
| 2579 </programlisting> | |
| 2580 </refsynopsisdiv> | |
| 2581 <refsection><info><title>Description</title></info> | |
| 2582 <para>If non-zero, HTML files will be created for the | |
| 2583 <literal>longdesc</literal> attribute. These files | |
| 2584 are created from the <tag>textobject</tag>s in | |
| 2585 <tag>mediaobject</tag>s and | |
| 2586 <tag>inlinemediaobject</tag>. | |
| 2587 </para> | |
| 2588 </refsection> | |
| 2589 </refentry> | |
| 2590 | |
| 2591 <refentry version="5.0" xml:id="html.longdesc.link"> | |
| 2592 <refmeta> | |
| 2593 <refentrytitle>html.longdesc.link</refentrytitle> | |
| 2594 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 2595 </refmeta> | |
| 2596 <refnamediv> | |
| 2597 <refname>html.longdesc.link</refname> | |
| 2598 <refpurpose>Should a link to the longdesc be included in the HTML?</refpurpose> | |
| 2599 </refnamediv> | |
| 2600 | |
| 2601 <refsynopsisdiv> | |
| 2602 <programlisting xml:id="html.longdesc.link.frag"> | |
| 2603 <xsl:param name="html.longdesc.link" select="$html.longdesc"></xsl:para
m> | |
| 2604 </programlisting> | |
| 2605 </refsynopsisdiv> | |
| 2606 | |
| 2607 <refsection><info><title>Description</title></info> | |
| 2608 | |
| 2609 <para>If non-zero, links will be created to the | |
| 2610 HTML files created for the | |
| 2611 <literal>longdesc</literal> attribute. It makes no | |
| 2612 sense to enable this option without also enabling the | |
| 2613 <parameter>html.longdesc</parameter> parameter.</para> | |
| 2614 | |
| 2615 | |
| 2616 | |
| 2617 </refsection> | |
| 2618 </refentry> | |
| 2619 | |
| 2620 <refentry version="5.0" xml:id="make.valid.html"> | |
| 2621 <refmeta> | |
| 2622 <refentrytitle>make.valid.html</refentrytitle> | |
| 2623 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 2624 </refmeta> | |
| 2625 <refnamediv> | |
| 2626 <refname>make.valid.html</refname> | |
| 2627 <refpurpose>Attempt to make sure the HTML output is valid HTML</refpurpose> | |
| 2628 </refnamediv> | |
| 2629 | |
| 2630 <refsynopsisdiv> | |
| 2631 <programlisting xml:id="make.valid.html.frag"> | |
| 2632 <xsl:param name="make.valid.html" select="0"></xsl:param> | |
| 2633 </programlisting> | |
| 2634 </refsynopsisdiv> | |
| 2635 | |
| 2636 <refsection><info><title>Description</title></info> | |
| 2637 | |
| 2638 <para>If <parameter>make.valid.html</parameter> is true, the stylesheets take | |
| 2639 extra effort to ensure that the resulting HTML is valid. This may mean that some | |
| 2640 <tag>para</tag> tags are translated into HTML <tag>div</tag>s or | |
| 2641 that other substitutions occur.</para> | |
| 2642 | |
| 2643 <para>This parameter is different from <parameter>html.cleanup</parameter> | |
| 2644 because it changes the resulting markup; it does not use extension functions | |
| 2645 to manipulate result-tree-fragments and is therefore applicable to any | |
| 2646 XSLT processor.</para> | |
| 2647 | |
| 2648 </refsection> | |
| 2649 </refentry> | |
| 2650 | |
| 2651 <refentry version="5.0" xml:id="html.cleanup"> | |
| 2652 <refmeta> | |
| 2653 <refentrytitle>html.cleanup</refentrytitle> | |
| 2654 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 2655 </refmeta> | |
| 2656 <refnamediv> | |
| 2657 <refname>html.cleanup</refname> | |
| 2658 <refpurpose>Attempt to clean up the resulting HTML?</refpurpose> | |
| 2659 </refnamediv> | |
| 2660 | |
| 2661 <refsynopsisdiv> | |
| 2662 <programlisting xml:id="html.cleanup.frag"> | |
| 2663 <xsl:param name="html.cleanup" select="1"></xsl:param> | |
| 2664 </programlisting> | |
| 2665 </refsynopsisdiv> | |
| 2666 | |
| 2667 <refsection><info><title>Description</title></info> | |
| 2668 | |
| 2669 <para>If non-zero, and if the <link xmlns:xlink="http://www.w3.org/1999/xlink" x
link:href="http://www.exslt.org/">EXSLT</link> | |
| 2670 extensions are supported by your processor, the resulting HTML will be | |
| 2671 <quote>cleaned up</quote>. This improves the chances that the | |
| 2672 resulting HTML will be valid. It may also improve the formatting of | |
| 2673 some elements.</para> | |
| 2674 | |
| 2675 <para>This parameter is different from <parameter>make.valid.html</parameter> | |
| 2676 because it uses extension functions to manipulate result-tree-fragments.</para> | |
| 2677 | |
| 2678 </refsection> | |
| 2679 </refentry> | |
| 2680 | |
| 2681 <refentry version="5.0" xml:id="html.append"> | |
| 2682 <refmeta> | |
| 2683 <refentrytitle>html.append</refentrytitle> | |
| 2684 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 2685 </refmeta> | |
| 2686 <refnamediv> | |
| 2687 <refname>html.append</refname> | |
| 2688 <refpurpose>Specifies content to append to HTML output</refpurpose> | |
| 2689 </refnamediv> | |
| 2690 | |
| 2691 <refsynopsisdiv> | |
| 2692 <programlisting xml:id="html.append.frag"><xsl:param name="html.append">&l
t;/xsl:param></programlisting> | |
| 2693 </refsynopsisdiv> | |
| 2694 | |
| 2695 <refsection><info><title>Description</title></info> | |
| 2696 | |
| 2697 <para>Specifies content to append to the end of HTML files output by | |
| 2698 the <filename>html/docbook.xsl</filename> stylesheet, after the | |
| 2699 closing <code><html></code> tag. You probably don’t want to set any | |
| 2700 value for this parameter; but if you do, the only value it should ever | |
| 2701 be set to is a newline character: <code>&#x0a;</code> or | |
| 2702 <code>&#10;</code></para> | |
| 2703 | |
| 2704 </refsection> | |
| 2705 </refentry> | |
| 2706 | |
| 2707 <refentry version="5.0" xml:id="draft.mode"> | |
| 2708 <refmeta> | |
| 2709 <refentrytitle>draft.mode</refentrytitle> | |
| 2710 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> | |
| 2711 <refmiscinfo class="other" otherclass="value">no</refmiscinfo> | |
| 2712 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo> | |
| 2713 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo> | |
| 2714 </refmeta> | |
| 2715 <refnamediv> | |
| 2716 <refname>draft.mode</refname> | |
| 2717 <refpurpose>Select draft mode</refpurpose> | |
| 2718 </refnamediv> | |
| 2719 | |
| 2720 <refsynopsisdiv> | |
| 2721 <programlisting xml:id="draft.mode.frag"> | |
| 2722 <xsl:param name="draft.mode">no</xsl:param> | |
| 2723 </programlisting> | |
| 2724 </refsynopsisdiv> | |
| 2725 | |
| 2726 <refsection><info><title>Description</title></info> | |
| 2727 | |
| 2728 <para>Selects draft mode. If <parameter>draft.mode</parameter> is | |
| 2729 <quote><literal>yes</literal></quote>, the entire document will be treated | |
| 2730 as a draft. If it is <quote><literal>no</literal></quote>, the entire document | |
| 2731 will be treated as a final copy. If it is <quote><literal>maybe</literal></quote
>, | |
| 2732 individual sections will be treated as draft or final independently, depending | |
| 2733 on how their <literal>status</literal> attribute is set. | |
| 2734 </para> | |
| 2735 | |
| 2736 </refsection> | |
| 2737 </refentry> | |
| 2738 | |
| 2739 <refentry version="5.0" xml:id="draft.watermark.image"> | |
| 2740 <refmeta> | |
| 2741 <refentrytitle>draft.watermark.image</refentrytitle> | |
| 2742 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> | |
| 2743 </refmeta> | |
| 2744 <refnamediv> | |
| 2745 <refname>draft.watermark.image</refname> | |
| 2746 <refpurpose>The URI of the image to be used for draft watermarks</refpurpose> | |
| 2747 </refnamediv> | |
| 2748 | |
| 2749 <refsynopsisdiv> | |
| 2750 <programlisting xml:id="draft.watermark.image.frag"> | |
| 2751 <xsl:param name="draft.watermark.image">images/draft.png</xsl:param> | |
| 2752 </programlisting> | |
| 2753 </refsynopsisdiv> | |
| 2754 | |
| 2755 <refsection><info><title>Description</title></info> | |
| 2756 | |
| 2757 <para>The image to be used for draft watermarks.</para> | |
| 2758 | |
| 2759 </refsection> | |
| 2760 </refentry> | |
| 2761 | |
| 2762 <refentry version="5.0" xml:id="generate.id.attributes"> | |
| 2763 <refmeta> | |
| 2764 <refentrytitle>generate.id.attributes</refentrytitle> | |
| 2765 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 2766 </refmeta> | |
| 2767 <refnamediv> | |
| 2768 <refname>generate.id.attributes</refname> | |
| 2769 <refpurpose>Generate ID attributes on container elements?</refpurpose> | |
| 2770 </refnamediv> | |
| 2771 | |
| 2772 <refsynopsisdiv> | |
| 2773 <programlisting xml:id="generate.id.attributes.frag"> | |
| 2774 <xsl:param name="generate.id.attributes" select="0"></xsl:param> | |
| 2775 </programlisting> | |
| 2776 </refsynopsisdiv> | |
| 2777 | |
| 2778 <refsection><info><title>Description</title></info> | |
| 2779 | |
| 2780 <para>If non-zero, the HTML stylesheet will generate ID attributes on | |
| 2781 containers. For example, the markup:</para> | |
| 2782 | |
| 2783 <screen><section id="foo"><title>Some Title</title> | |
| 2784 <para>Some para.</para> | |
| 2785 </section></screen> | |
| 2786 | |
| 2787 <para>might produce:</para> | |
| 2788 | |
| 2789 <screen><div class="section" id="foo"> | |
| 2790 <h2>Some Title</h2> | |
| 2791 <p>Some para.</p> | |
| 2792 </div></screen> | |
| 2793 | |
| 2794 <para>The alternative is to generate anchors:</para> | |
| 2795 | |
| 2796 <screen><div class="section"> | |
| 2797 <h2><a name="foo"></a>Some Title</h2> | |
| 2798 <p>Some para.</p> | |
| 2799 </div></screen> | |
| 2800 | |
| 2801 <para>Because the <tag class="attribute">name</tag> attribute of | |
| 2802 the <tag>a</tag> element and the <tag class="attribute">id</tag> | |
| 2803 attribute of other tags are both of type <quote>ID</quote>, producing both | |
| 2804 generates invalid documents.</para> | |
| 2805 | |
| 2806 <para>As of version 1.50, you can use this switch to control which type of | |
| 2807 identifier is generated. For backwards-compatibility, generating | |
| 2808 <tag>a</tag> anchors is preferred.</para> | |
| 2809 | |
| 2810 <para>Note: at present, this switch is incompletely implemented. | |
| 2811 Disabling ID attributes will suppress them, but enabling ID attributes | |
| 2812 will not suppress the anchors.</para> | |
| 2813 | |
| 2814 </refsection> | |
| 2815 </refentry> | |
| 2816 | |
| 2817 <refentry version="5.0" xml:id="generate.consistent.ids"> | |
| 2818 <refmeta> | |
| 2819 <refentrytitle>generate.consistent.ids</refentrytitle> | |
| 2820 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 2821 </refmeta> | |
| 2822 <refnamediv> | |
| 2823 <refname>generate.consistent.ids</refname> | |
| 2824 <refpurpose>Generate consistent id values if document is unchanged</refpurpose> | |
| 2825 </refnamediv> | |
| 2826 | |
| 2827 <refsynopsisdiv> | |
| 2828 <programlisting xml:id="generate.consistent.ids.frag"> | |
| 2829 <xsl:param name="generate.consistent.ids" select="0"></xsl:param> | |
| 2830 </programlisting> | |
| 2831 </refsynopsisdiv> | |
| 2832 | |
| 2833 <refsection><info><title>Description</title></info> | |
| 2834 | |
| 2835 <para>When the stylesheet assigns an id value to an output element, | |
| 2836 the generate-id() function may be used. That function may not | |
| 2837 produce consistent values between runs. Version control | |
| 2838 systems may misidentify the changing id values as changes | |
| 2839 to the document.</para> | |
| 2840 | |
| 2841 <para>If you set this parameter's value to 1, then the | |
| 2842 template named <literal>object.id</literal> will replace | |
| 2843 the use of the function generate-id() with | |
| 2844 <literal><xsl:number level="multiple" count="*"/></literal>. | |
| 2845 This counts preceding elements to generate a unique number for | |
| 2846 the id value.</para> | |
| 2847 | |
| 2848 <caution> | |
| 2849 <para>This param does not associate permanent unique id values | |
| 2850 with particular elements. | |
| 2851 The id values are consistent only as long as the document | |
| 2852 structure does not change. | |
| 2853 If the document structure changes, then the counting | |
| 2854 of elements changes, and all id values after | |
| 2855 the first such change may be different, even when there is | |
| 2856 no change to the element itself or its output. | |
| 2857 </para> | |
| 2858 </caution> | |
| 2859 | |
| 2860 <para>The default value of this parameter is zero, so generate-id() is used | |
| 2861 by default.</para> | |
| 2862 | |
| 2863 </refsection> | |
| 2864 </refentry> | |
| 2865 | |
| 2866 <refentry version="5.0" xml:id="generate.meta.abstract"> | |
| 2867 <refmeta> | |
| 2868 <refentrytitle>generate.meta.abstract</refentrytitle> | |
| 2869 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 2870 </refmeta> | |
| 2871 <refnamediv> | |
| 2872 <refname>generate.meta.abstract</refname> | |
| 2873 <refpurpose>Generate HTML <tag>META</tag> element from <tag>abstract</tag>?</ref
purpose> | |
| 2874 </refnamediv> | |
| 2875 | |
| 2876 <refsynopsisdiv> | |
| 2877 <programlisting xml:id="generate.meta.abstract.frag"> | |
| 2878 <xsl:param name="generate.meta.abstract" select="1"></xsl:param> | |
| 2879 </programlisting> | |
| 2880 </refsynopsisdiv> | |
| 2881 | |
| 2882 <refsection><info><title>Description</title></info> | |
| 2883 | |
| 2884 <para>If non-zero, document abstracts will be reproduced in the HTML | |
| 2885 <literal>head</literal>, with <literal>>meta name="description" content="..."
</literal></para> | |
| 2886 | |
| 2887 | |
| 2888 </refsection> | |
| 2889 </refentry> | |
| 2890 | |
| 2891 <refentry version="5.0" xml:id="make.clean.html"> | |
| 2892 <refmeta> | |
| 2893 <refentrytitle>make.clean.html</refentrytitle> | |
| 2894 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 2895 </refmeta> | |
| 2896 <refnamediv> | |
| 2897 <refname>make.clean.html</refname> | |
| 2898 <refpurpose>Make HTML conform to modern coding standards</refpurpose> | |
| 2899 </refnamediv> | |
| 2900 | |
| 2901 <refsynopsisdiv> | |
| 2902 <programlisting xml:id="make.clean.html.frag"> | |
| 2903 <xsl:param name="make.clean.html" select="0"></xsl:param> | |
| 2904 </programlisting> | |
| 2905 </refsynopsisdiv> | |
| 2906 | |
| 2907 <refsection><info><title>Description</title></info> | |
| 2908 | |
| 2909 <para>If <parameter>make.clean.html</parameter> is true, the stylesheets take | |
| 2910 extra effort to ensure that the resulting HTML is conforms to | |
| 2911 modern HTML coding standards. In addition to eliminating | |
| 2912 excessive and noncompliant coding, it moves presentation | |
| 2913 HTML coding to a CSS stylesheet.</para> | |
| 2914 | |
| 2915 <para>The resulting HTML is dependent on | |
| 2916 CSS for formatting, and so the stylesheet is capable of | |
| 2917 generating a supporting CSS file. The <parameter>docbook.css.source</parameter> | |
| 2918 and <parameter>custom.css.source</parameter> parameters control | |
| 2919 how a CSS file is generated.</para> | |
| 2920 | |
| 2921 <para>If you require your CSS to reside in the HTML | |
| 2922 <tag>head</tag> element, then the <parameter>generate.css.header</parameter> | |
| 2923 can be used to do that.</para> | |
| 2924 | |
| 2925 <para>The <parameter>make.clean.html</parameter> parameter is | |
| 2926 different from <parameter>html.cleanup</parameter> | |
| 2927 because the former changes the resulting markup; it does not use extension funct
ions | |
| 2928 like the latter to manipulate result-tree-fragments, | |
| 2929 and is therefore applicable to any XSLT processor.</para> | |
| 2930 | |
| 2931 <para>If <parameter>make.clean.html</parameter> is set to zero (the default), | |
| 2932 then the stylesheet retains its original | |
| 2933 <quote>old style</quote> | |
| 2934 HTML formatting features.</para> | |
| 2935 </refsection> | |
| 2936 </refentry> | |
| 2937 | |
| 2938 <refentry version="5.0" xml:id="docbook.css.source"> | |
| 2939 <refmeta> | |
| 2940 <refentrytitle>docbook.css.source</refentrytitle> | |
| 2941 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 2942 </refmeta> | |
| 2943 <refnamediv> | |
| 2944 <refname>docbook.css.source</refname> | |
| 2945 <refpurpose>Name of the default CSS input file</refpurpose> | |
| 2946 </refnamediv> | |
| 2947 | |
| 2948 <refsynopsisdiv> | |
| 2949 <programlisting xml:id="docbook.css.source.frag"><xsl:param name="docbook
.css.source">docbook.css.xml</xsl:param></programlisting> | |
| 2950 </refsynopsisdiv> | |
| 2951 | |
| 2952 <refsection><info><title>Description</title></info> | |
| 2953 | |
| 2954 <para>The <parameter>docbook.css.source</parameter> parameter | |
| 2955 specifies the name of the file containing the default DocBook | |
| 2956 CSS styles. Those styles are necessary when the | |
| 2957 <parameter>make.clean.html</parameter> parameter is nonzero.</para> | |
| 2958 | |
| 2959 <para>The file is a well-formed XML file that | |
| 2960 must consist of a single <tag>style</tag> root | |
| 2961 element that contains CSS styles as its text content. | |
| 2962 The default value of the parameter (and filename) | |
| 2963 is <literal>docbook.css.xml</literal>. | |
| 2964 The stylesheets ship with the default file. You can substitute | |
| 2965 your own and specify its path in this parameter.</para> | |
| 2966 | |
| 2967 <para>If <parameter>docbook.css.source</parameter> is not blank, | |
| 2968 and <parameter>make.clean.html</parameter> is nonzero, then | |
| 2969 the stylesheet takes the following actions:</para> | |
| 2970 | |
| 2971 <orderedlist> | |
| 2972 <listitem> | |
| 2973 <para>The stylesheet uses the XSLT <literal>document()</literal> | |
| 2974 function to open the file specified by the parameter and | |
| 2975 load it into a variable.</para> | |
| 2976 </listitem> | |
| 2977 <listitem> | |
| 2978 <para>The stylesheet forms an output pathname consisting of the | |
| 2979 value of the <parameter>base.dir</parameter> parameter (if it is set) | |
| 2980 and the value of <parameter>docbook.css.source</parameter>, | |
| 2981 with the <literal>.xml</literal> suffix stripped off. | |
| 2982 </para> | |
| 2983 </listitem> | |
| 2984 <listitem> | |
| 2985 <para>The stylesheet removes the <tag>style</tag> | |
| 2986 wrapper element and writes just the CSS text content to the output file.</pa
ra> | |
| 2987 </listitem> | |
| 2988 <listitem> | |
| 2989 <para>The stylesheet adds a <tag>link</tag> element to the | |
| 2990 HTML <tag>HEAD</tag> element to reference the external CSS stylesheet. | |
| 2991 For example:</para> | |
| 2992 <programlisting><link rel="stylesheet" href="docbook.css" type="text/css"
> | |
| 2993 </programlisting> | |
| 2994 <para>However, if the <parameter>docbook.css.link</parameter> | |
| 2995 parameter is set to zero, then no <tag>link</tag> is written | |
| 2996 for the default CSS file. That is useful if a custom | |
| 2997 CSS file will import the default CSS stylesheet to ensure | |
| 2998 proper cascading of styles.</para> | |
| 2999 </listitem> | |
| 3000 </orderedlist> | |
| 3001 | |
| 3002 <para>If the <parameter>docbook.css.source</parameter> parameter | |
| 3003 is changed from its default <literal>docbook.css.xml</literal> to blank, | |
| 3004 then no default CSS is generated. Likewise if the | |
| 3005 <parameter>make.clean.html</parameter> parameter is set to zero, | |
| 3006 then no default CSS is generated. The | |
| 3007 <parameter>custom.css.source</parameter> parameter can be used | |
| 3008 instead to generate a complete custom CSS file.</para> | |
| 3009 | |
| 3010 <para>You can use the <parameter>generate.css.header</parameter> | |
| 3011 parameter to instead write the CSS to each HTML <tag>HEAD</tag> | |
| 3012 element in a <tag>style</tag> tag instead of an external CSS file.</para> | |
| 3013 | |
| 3014 </refsection> | |
| 3015 </refentry> | |
| 3016 | |
| 3017 <refentry version="5.0" xml:id="docbook.css.link"> | |
| 3018 <refmeta> | |
| 3019 <refentrytitle>docbook.css.link</refentrytitle> | |
| 3020 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 3021 </refmeta> | |
| 3022 <refnamediv> | |
| 3023 <refname>docbook.css.link</refname> | |
| 3024 <refpurpose>Insert a link referencing the default CSS stylesheet</refpurpose> | |
| 3025 </refnamediv> | |
| 3026 | |
| 3027 <refsynopsisdiv> | |
| 3028 <programlisting xml:id="docbook.css.link.frag"> | |
| 3029 <xsl:param name="docbook.css.link" select="1"></xsl:param> | |
| 3030 </programlisting> | |
| 3031 </refsynopsisdiv> | |
| 3032 | |
| 3033 <refsection><info><title>Description</title></info> | |
| 3034 | |
| 3035 <para>The stylesheets are capable of generating a default | |
| 3036 CSS stylesheet file. The parameters | |
| 3037 <parameter>make.clean.html</parameter> and | |
| 3038 <parameter>docbook.css.source</parameter> control that feature.</para> | |
| 3039 | |
| 3040 <para>Normally if a default CSS file is generated, then | |
| 3041 the stylesheet inserts a <tag>link</tag> tag in the HTML | |
| 3042 <tag>HEAD</tag> element to reference it. | |
| 3043 However, you can omit that <tag>link</tag> reference if | |
| 3044 you set the <parameter>docbook.css.link</parameter> to zero | |
| 3045 (1 is the default).</para> | |
| 3046 | |
| 3047 <para>This parameter is useful when you want to import the | |
| 3048 default CSS into a custom CSS file generated using the | |
| 3049 <parameter>custom.css.source</parameter> parameter. | |
| 3050 </para> | |
| 3051 | |
| 3052 </refsection> | |
| 3053 </refentry> | |
| 3054 | |
| 3055 <refentry version="5.0" xml:id="custom.css.source"> | |
| 3056 <refmeta> | |
| 3057 <refentrytitle>custom.css.source</refentrytitle> | |
| 3058 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 3059 </refmeta> | |
| 3060 <refnamediv> | |
| 3061 <refname>custom.css.source</refname> | |
| 3062 <refpurpose>Name of a custom CSS input file</refpurpose> | |
| 3063 </refnamediv> | |
| 3064 | |
| 3065 <refsynopsisdiv> | |
| 3066 <programlisting xml:id="custom.css.source.frag"><xsl:param name="custom.c
ss.source"></xsl:param></programlisting> | |
| 3067 </refsynopsisdiv> | |
| 3068 | |
| 3069 <refsection><info><title>Description</title></info> | |
| 3070 | |
| 3071 <para>The <parameter>custom.css.source</parameter> | |
| 3072 parameter enables you to add CSS styles to DocBook's | |
| 3073 HTML output.</para> | |
| 3074 | |
| 3075 <para>The parameter | |
| 3076 specifies the name of a file containing custom | |
| 3077 CSS styles. The file must be a well-formed XML file that | |
| 3078 consists of a single <tag>style</tag> root | |
| 3079 element that contains CSS styles as its text content. | |
| 3080 For example:</para> | |
| 3081 <programlisting><?xml version="1.0"?> | |
| 3082 <style> | |
| 3083 h2 { | |
| 3084 font-weight: bold; | |
| 3085 color: blue; | |
| 3086 } | |
| 3087 ... | |
| 3088 </style> | |
| 3089 </programlisting> | |
| 3090 | |
| 3091 <para>The filename specified by the parameter | |
| 3092 should have a <literal>.xml</literal> | |
| 3093 filename suffix, although that is not required. | |
| 3094 The default value of this parameter is blank.</para> | |
| 3095 | |
| 3096 <para>If <parameter>custom.css.source</parameter> is not blank, then | |
| 3097 the stylesheet takes the following actions. | |
| 3098 These actions take place regardless of the value of | |
| 3099 the <parameter>make.clean.html</parameter> parameter.</para> | |
| 3100 | |
| 3101 <orderedlist> | |
| 3102 <listitem> | |
| 3103 <para>The stylesheet uses the XSLT <literal>document()</literal> | |
| 3104 function to open the file specified by the parameter and | |
| 3105 load it into a variable.</para> | |
| 3106 </listitem> | |
| 3107 <listitem> | |
| 3108 <para>The stylesheet forms an output pathname consisting of the | |
| 3109 value of the <parameter>base.dir</parameter> parameter (if it is set) | |
| 3110 and the value of <parameter>custom.css.source</parameter>, | |
| 3111 with the <literal>.xml</literal> suffix stripped off. | |
| 3112 </para> | |
| 3113 </listitem> | |
| 3114 <listitem> | |
| 3115 <para>The stylesheet removes the <tag>style</tag> | |
| 3116 wrapper element and writes just the CSS text content to the output file.</pa
ra> | |
| 3117 </listitem> | |
| 3118 <listitem> | |
| 3119 <para>The stylesheet adds a <tag>link</tag> element to the | |
| 3120 HTML <tag>HEAD</tag> element to reference this external CSS stylesheet. | |
| 3121 For example: | |
| 3122 <programlisting><link rel="stylesheet" href="custom.css" type="text/css"&
gt; | |
| 3123 </programlisting> | |
| 3124 </para> | |
| 3125 </listitem> | |
| 3126 </orderedlist> | |
| 3127 | |
| 3128 | |
| 3129 | |
| 3130 <para>If the <parameter>make.clean.html</parameter> parameter is nonzero | |
| 3131 (the default is zero), | |
| 3132 and if the <parameter>docbook.css.source</parameter> parameter | |
| 3133 is not blank (the default is not blank), | |
| 3134 then the stylesheet will also generate a default CSS file | |
| 3135 and add a <tag>link</tag> tag to reference it. | |
| 3136 The <tag>link</tag> to the custom CSS comes after the | |
| 3137 <tag>link</tag> to the default, so it should cascade properly | |
| 3138 in most browsers. | |
| 3139 If you do not want two <tag>link</tag> tags, and | |
| 3140 instead want your custom CSS to import the default generated | |
| 3141 CSS file, then do the following: | |
| 3142 </para> | |
| 3143 | |
| 3144 <orderedlist> | |
| 3145 <listitem> | |
| 3146 <para>Add a line like the following to your custom CSS source file:</para> | |
| 3147 <programlisting>@import url("docbook.css") | |
| 3148 </programlisting> | |
| 3149 </listitem> | |
| 3150 <listitem> | |
| 3151 <para>Set the <parameter>docbook.css.link</parameter> parameter | |
| 3152 to zero. This will omit the <tag>link</tag> tag | |
| 3153 that references the default CSS file.</para> | |
| 3154 </listitem> | |
| 3155 </orderedlist> | |
| 3156 | |
| 3157 <para>If you set <parameter>make.clean.html</parameter> to nonzero but | |
| 3158 you do not want the default CSS generated, then also set | |
| 3159 the <parameter>docbook.css.source</parameter> parameter to blank. | |
| 3160 Then no default CSS will be generated, and so | |
| 3161 all CSS styles must come from your custom CSS file.</para> | |
| 3162 | |
| 3163 <para>You can use the <parameter>generate.css.header</parameter> | |
| 3164 parameter to instead write the CSS to each HTML <tag>HEAD</tag> | |
| 3165 element in a <tag>style</tag> tag instead of an external CSS file.</para> | |
| 3166 | |
| 3167 </refsection> | |
| 3168 </refentry> | |
| 3169 | |
| 3170 <refentry version="5.0" xml:id="generate.css.header"> | |
| 3171 <refmeta> | |
| 3172 <refentrytitle>generate.css.header</refentrytitle> | |
| 3173 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 3174 </refmeta> | |
| 3175 <refnamediv> | |
| 3176 <refname>generate.css.header</refname> | |
| 3177 <refpurpose>Insert generated CSS styles in HEAD element</refpurpose> | |
| 3178 </refnamediv> | |
| 3179 | |
| 3180 <refsynopsisdiv> | |
| 3181 <programlisting xml:id="generate.css.header.frag"> | |
| 3182 <xsl:param name="generate.css.header" select="0"></xsl:param> | |
| 3183 </programlisting> | |
| 3184 </refsynopsisdiv> | |
| 3185 | |
| 3186 <refsection><info><title>Description</title></info> | |
| 3187 | |
| 3188 <para>The stylesheets are capable of generating both default | |
| 3189 and custom CSS stylesheet files. The parameters | |
| 3190 <parameter>make.clean.html</parameter>, | |
| 3191 <parameter>docbook.css.source</parameter>, and | |
| 3192 <parameter>custom.css.source</parameter> control that feature.</para> | |
| 3193 | |
| 3194 <para>If you require that CSS styles reside in the HTML | |
| 3195 <tag>HEAD</tag> element instead of external CSS files, | |
| 3196 then set the <parameter>generate.css.header</parameter> | |
| 3197 parameter to nonzero (it is zero by default). | |
| 3198 Then instead of generating the CSS in external files, | |
| 3199 they are wrapped in <tag>style</tag> elements in | |
| 3200 the <tag>HEAD</tag> element of each HTML output file. | |
| 3201 </para> | |
| 3202 | |
| 3203 </refsection> | |
| 3204 </refentry> | |
| 3205 | |
| 3206 </reference> | |
| 3207 <reference xml:id="xslt"><title>XSLT Processing</title> | |
| 3208 <refentry version="5.0" xml:id="rootid"> | |
| 3209 <refmeta> | |
| 3210 <refentrytitle>rootid</refentrytitle> | |
| 3211 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 3212 </refmeta> | |
| 3213 <refnamediv> | |
| 3214 <refname>rootid</refname> | |
| 3215 <refpurpose>Specify the root element to format</refpurpose> | |
| 3216 </refnamediv> | |
| 3217 | |
| 3218 <refsynopsisdiv> | |
| 3219 <programlisting xml:id="rootid.frag"> | |
| 3220 <xsl:param name="rootid"></xsl:param></programlisting> | |
| 3221 </refsynopsisdiv> | |
| 3222 | |
| 3223 <refsection><info><title>Description</title></info> | |
| 3224 | |
| 3225 <para>If <parameter>rootid</parameter> is not empty, it must be the | |
| 3226 value of an ID that occurs in the document being formatted. The entire | |
| 3227 document will be loaded and parsed, but formatting will begin at the | |
| 3228 element identified, rather than at the root. For example, this allows | |
| 3229 you to process only <tag>chapter</tag> 4 of a <tag>book</tag>.</para> | |
| 3230 <para>Because the entire document is available to the processor, automatic | |
| 3231 numbering, cross references, and other dependencies are correctly | |
| 3232 resolved.</para> | |
| 3233 | |
| 3234 </refsection> | |
| 3235 </refentry> | |
| 3236 | |
| 3237 <refentry version="5.0" xml:id="suppress.navigation"> | |
| 3238 <refmeta> | |
| 3239 <refentrytitle>suppress.navigation</refentrytitle> | |
| 3240 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 3241 </refmeta> | |
| 3242 <refnamediv> | |
| 3243 <refname>suppress.navigation</refname> | |
| 3244 <refpurpose>Disable header and footer navigation</refpurpose> | |
| 3245 </refnamediv> | |
| 3246 | |
| 3247 <refsynopsisdiv> | |
| 3248 <programlisting xml:id="suppress.navigation.frag"> | |
| 3249 <xsl:param name="suppress.navigation" select="0"></xsl:param> | |
| 3250 </programlisting> | |
| 3251 </refsynopsisdiv> | |
| 3252 | |
| 3253 <refsection><info><title>Description</title></info> | |
| 3254 | |
| 3255 <para> | |
| 3256 If non-zero, header and footer navigation will be suppressed.</para> | |
| 3257 | |
| 3258 </refsection> | |
| 3259 </refentry> | |
| 3260 | |
| 3261 <refentry version="5.0" xml:id="suppress.header.navigation"> | |
| 3262 <refmeta> | |
| 3263 <refentrytitle>suppress.header.navigation</refentrytitle> | |
| 3264 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 3265 </refmeta> | |
| 3266 <refnamediv> | |
| 3267 <refname>suppress.header.navigation</refname> | |
| 3268 <refpurpose>Disable header navigation</refpurpose> | |
| 3269 </refnamediv> | |
| 3270 | |
| 3271 <refsynopsisdiv> | |
| 3272 <programlisting xml:id="suppress.header.navigation.frag"> | |
| 3273 <xsl:param name="suppress.header.navigation" select="0"></xsl:param> | |
| 3274 </programlisting> | |
| 3275 </refsynopsisdiv> | |
| 3276 | |
| 3277 <refsection><info><title>Description</title></info> | |
| 3278 | |
| 3279 <para>If non-zero, header navigation will be suppressed.</para> | |
| 3280 | |
| 3281 </refsection> | |
| 3282 </refentry> | |
| 3283 | |
| 3284 <refentry version="5.0" xml:id="suppress.footer.navigation"> | |
| 3285 <refmeta> | |
| 3286 <refentrytitle>suppress.footer.navigation</refentrytitle> | |
| 3287 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 3288 </refmeta> | |
| 3289 <refnamediv> | |
| 3290 <refname>suppress.footer.navigation</refname> | |
| 3291 <refpurpose>Disable footer navigation</refpurpose> | |
| 3292 </refnamediv> | |
| 3293 | |
| 3294 <refsynopsisdiv> | |
| 3295 <programlisting xml:id="suppress.footer.navigation.frag"><xsl:param name="sup
press.footer.navigation">0</xsl:param></programlisting> | |
| 3296 </refsynopsisdiv> | |
| 3297 | |
| 3298 <refsection><info><title>Description</title></info> | |
| 3299 | |
| 3300 <para> | |
| 3301 If non-zero, footer navigation will be suppressed.</para> | |
| 3302 | |
| 3303 </refsection> | |
| 3304 </refentry> | |
| 3305 | |
| 3306 <refentry version="5.0" xml:id="header.rule"> | |
| 3307 <refmeta> | |
| 3308 <refentrytitle>header.rule</refentrytitle> | |
| 3309 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 3310 </refmeta> | |
| 3311 <refnamediv> | |
| 3312 <refname>header.rule</refname> | |
| 3313 <refpurpose>Rule under headers?</refpurpose> | |
| 3314 </refnamediv> | |
| 3315 | |
| 3316 <refsynopsisdiv> | |
| 3317 <programlisting xml:id="header.rule.frag"> | |
| 3318 <xsl:param name="header.rule" select="1"></xsl:param> | |
| 3319 </programlisting> | |
| 3320 </refsynopsisdiv> | |
| 3321 | |
| 3322 <refsection><info><title>Description</title></info> | |
| 3323 | |
| 3324 <para>If non-zero, a rule will be drawn below the page headers.</para> | |
| 3325 | |
| 3326 </refsection> | |
| 3327 </refentry> | |
| 3328 | |
| 3329 <refentry version="5.0" xml:id="footer.rule"> | |
| 3330 <refmeta> | |
| 3331 <refentrytitle>footer.rule</refentrytitle> | |
| 3332 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 3333 </refmeta> | |
| 3334 <refnamediv> | |
| 3335 <refname>footer.rule</refname> | |
| 3336 <refpurpose>Rule over footers?</refpurpose> | |
| 3337 </refnamediv> | |
| 3338 | |
| 3339 <refsynopsisdiv> | |
| 3340 <programlisting xml:id="footer.rule.frag"> | |
| 3341 <xsl:param name="footer.rule" select="1"></xsl:param> | |
| 3342 </programlisting> | |
| 3343 </refsynopsisdiv> | |
| 3344 | |
| 3345 <refsection><info><title>Description</title></info> | |
| 3346 | |
| 3347 <para>If non-zero, a rule will be drawn above the page footers.</para> | |
| 3348 | |
| 3349 </refsection> | |
| 3350 </refentry> | |
| 3351 | |
| 3352 <refentry version="5.0" xml:id="id.warnings"> | |
| 3353 <refmeta> | |
| 3354 <refentrytitle>id.warnings</refentrytitle> | |
| 3355 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 3356 </refmeta> | |
| 3357 <refnamediv> | |
| 3358 <refname>id.warnings</refname> | |
| 3359 <refpurpose>Should warnings be generated for titled elements without IDs?</refpu
rpose> | |
| 3360 </refnamediv> | |
| 3361 <refsynopsisdiv> | |
| 3362 <programlisting xml:id="id.warnings.frag"> | |
| 3363 <xsl:param name="id.warnings" select="0"></xsl:param> | |
| 3364 </programlisting> | |
| 3365 </refsynopsisdiv> | |
| 3366 <refsection><info><title>Description</title></info> | |
| 3367 <para>If non-zero, the stylesheet will issue a warning for any element | |
| 3368 (other than the root element) which has a <tag>title</tag> but does not have an | |
| 3369 ID.</para> | |
| 3370 </refsection> | |
| 3371 </refentry> | |
| 3372 | |
| 3373 </reference> | |
| 3374 <reference xml:id="meta"><title>Meta/*Info and Titlepages</title> | |
| 3375 <refentry version="5.0" xml:id="inherit.keywords"> | |
| 3376 <refmeta> | |
| 3377 <refentrytitle>inherit.keywords</refentrytitle> | |
| 3378 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 3379 </refmeta> | |
| 3380 <refnamediv> | |
| 3381 <refname>inherit.keywords</refname> | |
| 3382 <refpurpose>Inherit keywords from ancestor elements?</refpurpose> | |
| 3383 </refnamediv> | |
| 3384 | |
| 3385 <refsynopsisdiv> | |
| 3386 <programlisting xml:id="inherit.keywords.frag"> | |
| 3387 <xsl:param name="inherit.keywords" select="1"></xsl:param></programl
isting> | |
| 3388 </refsynopsisdiv> | |
| 3389 | |
| 3390 <refsection><info><title>Description</title></info> | |
| 3391 | |
| 3392 <para>If <parameter>inherit.keywords</parameter> | |
| 3393 is non-zero, the keyword <literal>meta</literal> for each HTML | |
| 3394 <literal>head</literal> element will include all of the keywords from | |
| 3395 ancestor elements. Otherwise, only the keywords from the current section | |
| 3396 will be used. | |
| 3397 </para> | |
| 3398 | |
| 3399 </refsection> | |
| 3400 </refentry> | |
| 3401 | |
| 3402 <refentry version="5.0" xml:id="make.single.year.ranges"> | |
| 3403 <refmeta> | |
| 3404 <refentrytitle>make.single.year.ranges</refentrytitle> | |
| 3405 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 3406 </refmeta> | |
| 3407 <refnamediv> | |
| 3408 <refname>make.single.year.ranges</refname> | |
| 3409 <refpurpose>Print single-year ranges (e.g., 1998-1999)</refpurpose> | |
| 3410 </refnamediv> | |
| 3411 | |
| 3412 <refsynopsisdiv> | |
| 3413 <programlisting xml:id="make.single.year.ranges.frag"> | |
| 3414 <xsl:param name="make.single.year.ranges" select="0"></xsl:param></p
rogramlisting> | |
| 3415 </refsynopsisdiv> | |
| 3416 | |
| 3417 <refsection><info><title>Description</title></info> | |
| 3418 | |
| 3419 <para>If non-zero, year ranges that span a single year will be printed | |
| 3420 in range notation (1998-1999) instead of discrete notation | |
| 3421 (1998, 1999).</para> | |
| 3422 | |
| 3423 </refsection> | |
| 3424 </refentry> | |
| 3425 | |
| 3426 <refentry version="5.0" xml:id="make.year.ranges"> | |
| 3427 <refmeta> | |
| 3428 <refentrytitle>make.year.ranges</refentrytitle> | |
| 3429 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 3430 </refmeta> | |
| 3431 <refnamediv> | |
| 3432 <refname>make.year.ranges</refname> | |
| 3433 <refpurpose>Collate copyright years into ranges?</refpurpose> | |
| 3434 </refnamediv> | |
| 3435 | |
| 3436 <refsynopsisdiv> | |
| 3437 <programlisting xml:id="make.year.ranges.frag"><xsl:param name="make.year.ran
ges" select="0"></xsl:param></programlisting> | |
| 3438 </refsynopsisdiv> | |
| 3439 | |
| 3440 <refsection><info><title>Description</title></info> | |
| 3441 | |
| 3442 <para>If non-zero, multiple copyright <tag>year</tag> elements will be | |
| 3443 collated into ranges. | |
| 3444 This works only if each year number is put into a separate | |
| 3445 year element. The copyright element permits multiple | |
| 3446 year elements. If a year element contains a dash or | |
| 3447 a comma, then that year element will not be merged into | |
| 3448 any range. | |
| 3449 </para> | |
| 3450 | |
| 3451 </refsection> | |
| 3452 </refentry> | |
| 3453 | |
| 3454 <refentry version="5.0" xml:id="author.othername.in.middle"> | |
| 3455 <refmeta> | |
| 3456 <refentrytitle>author.othername.in.middle</refentrytitle> | |
| 3457 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 3458 </refmeta> | |
| 3459 <refnamediv> | |
| 3460 <refname>author.othername.in.middle</refname> | |
| 3461 <refpurpose>Is <tag>othername</tag> in <tag>author</tag> a | |
| 3462 middle name?</refpurpose> | |
| 3463 </refnamediv> | |
| 3464 | |
| 3465 <refsynopsisdiv> | |
| 3466 <programlisting xml:id="author.othername.in.middle.frag"> | |
| 3467 <xsl:param name="author.othername.in.middle" select="1"></xsl:param>
</programlisting> | |
| 3468 </refsynopsisdiv> | |
| 3469 | |
| 3470 <refsection><info><title>Description</title></info> | |
| 3471 | |
| 3472 <para>If non-zero, the <tag>othername</tag> of an <tag>author</tag> | |
| 3473 appears between the <tag>firstname</tag> and | |
| 3474 <tag>surname</tag>. Otherwise, <tag>othername</tag> | |
| 3475 is suppressed. | |
| 3476 </para> | |
| 3477 | |
| 3478 </refsection> | |
| 3479 </refentry> | |
| 3480 | |
| 3481 <refentry version="5.0" xml:id="blurb.on.titlepage.enabled"> | |
| 3482 <refmeta> | |
| 3483 <refentrytitle>blurb.on.titlepage.enabled</refentrytitle> | |
| 3484 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 3485 </refmeta> | |
| 3486 <refnamediv> | |
| 3487 <refname>blurb.on.titlepage.enabled</refname> | |
| 3488 <refpurpose>Display personblurb and authorblurb on title pages?</refpurpose> | |
| 3489 </refnamediv> | |
| 3490 | |
| 3491 <refsynopsisdiv> | |
| 3492 <programlisting xml:id="blurb.on.titlepage.enabled.frag"> | |
| 3493 <xsl:param name="blurb.on.titlepage.enabled" select="0"></xsl:param> | |
| 3494 </programlisting> | |
| 3495 </refsynopsisdiv> | |
| 3496 | |
| 3497 <refsection><info><title>Description</title></info> | |
| 3498 | |
| 3499 <para>If non-zero, output from <tag>authorblurb</tag> and | |
| 3500 <tag>personblurb</tag> elements is displayed on title pages. If zero | |
| 3501 (the default), output from those elements is suppressed on title pages | |
| 3502 (unless you are using a <literal>titlepage</literal> customization | |
| 3503 that causes them to be included).</para> | |
| 3504 | |
| 3505 </refsection> | |
| 3506 </refentry> | |
| 3507 | |
| 3508 <refentry version="5.0" xml:id="contrib.inline.enabled"> | |
| 3509 <refmeta> | |
| 3510 <refentrytitle>contrib.inline.enabled</refentrytitle> | |
| 3511 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 3512 </refmeta> | |
| 3513 <refnamediv> | |
| 3514 <refname>contrib.inline.enabled</refname> | |
| 3515 <refpurpose>Display contrib output inline?</refpurpose> | |
| 3516 </refnamediv> | |
| 3517 | |
| 3518 <refsynopsisdiv> | |
| 3519 <programlisting xml:id="contrib.inline.enabled.frag"><xsl:param name="contrib
.inline.enabled">1</xsl:param></programlisting> | |
| 3520 </refsynopsisdiv> | |
| 3521 | |
| 3522 <refsection><info><title>Description</title></info> | |
| 3523 | |
| 3524 <para>If non-zero (the default), output of the <tag>contrib</tag> element is | |
| 3525 displayed as inline content rather than as block content.</para> | |
| 3526 | |
| 3527 </refsection> | |
| 3528 </refentry> | |
| 3529 | |
| 3530 <refentry version="5.0" xml:id="editedby.enabled"> | |
| 3531 <refmeta> | |
| 3532 <refentrytitle>editedby.enabled</refentrytitle> | |
| 3533 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 3534 </refmeta> | |
| 3535 <refnamediv> | |
| 3536 <refname>editedby.enabled</refname> | |
| 3537 <refpurpose>Display “Edited by” heading above editor name?</refpurpo
se> | |
| 3538 </refnamediv> | |
| 3539 | |
| 3540 <refsynopsisdiv> | |
| 3541 <programlisting xml:id="editedby.enabled.frag"><xsl:param name="editedby.enab
led">1</xsl:param></programlisting> | |
| 3542 </refsynopsisdiv> | |
| 3543 | |
| 3544 <refsection><info><title>Description</title></info> | |
| 3545 | |
| 3546 <para>If non-zero, a localized <emphasis role="bold">Edited | |
| 3547 by</emphasis> heading is displayed above editor names in output of the | |
| 3548 <tag>editor</tag> element.</para> | |
| 3549 | |
| 3550 </refsection> | |
| 3551 </refentry> | |
| 3552 | |
| 3553 <refentry version="5.0" xml:id="abstract.notitle.enabled"> | |
| 3554 <refmeta> | |
| 3555 <refentrytitle>abstract.notitle.enabled</refentrytitle> | |
| 3556 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 3557 </refmeta> | |
| 3558 <refnamediv> | |
| 3559 <refname>abstract.notitle.enabled</refname> | |
| 3560 <refpurpose>Suppress display of abstract titles?</refpurpose> | |
| 3561 </refnamediv> | |
| 3562 <refsynopsisdiv> | |
| 3563 <programlisting xml:id="abstract.notitle.enabled.frag"><xsl:param name="abs
tract.notitle.enabled" select="0"></xsl:param></programlisting> | |
| 3564 </refsynopsisdiv> | |
| 3565 <refsection><info><title>Description</title></info> | |
| 3566 <para>If non-zero, in output of the <tag>abstract</tag> element on titlepages, | |
| 3567 display of the abstract title is suppressed.</para> | |
| 3568 </refsection> | |
| 3569 </refentry> | |
| 3570 | |
| 3571 <refentry version="5.0" xml:id="othercredit.like.author.enabled"> | |
| 3572 <refmeta> | |
| 3573 <refentrytitle>othercredit.like.author.enabled</refentrytitle> | |
| 3574 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 3575 </refmeta> | |
| 3576 <refnamediv> | |
| 3577 <refname>othercredit.like.author.enabled</refname> | |
| 3578 <refpurpose>Display othercredit in same style as author?</refpurpose> | |
| 3579 </refnamediv> | |
| 3580 | |
| 3581 <refsynopsisdiv> | |
| 3582 <programlisting xml:id="othercredit.like.author.enabled.frag"><xsl:param name
="othercredit.like.author.enabled">0</xsl:param></programlisting> | |
| 3583 </refsynopsisdiv> | |
| 3584 | |
| 3585 <refsection><info><title>Description</title></info> | |
| 3586 | |
| 3587 <para>If non-zero, output of the | |
| 3588 <tag>othercredit</tag> element on titlepages is displayed in | |
| 3589 the same style as <tag>author</tag> and | |
| 3590 <tag>editor</tag> output. If zero then | |
| 3591 <tag>othercredit</tag> output is displayed using a style | |
| 3592 different than that of <tag>author</tag> and | |
| 3593 <tag>editor</tag>.</para> | |
| 3594 | |
| 3595 </refsection> | |
| 3596 </refentry> | |
| 3597 | |
| 3598 <refentry version="5.0" xml:id="generate.legalnotice.link"> | |
| 3599 <refmeta> | |
| 3600 <refentrytitle>generate.legalnotice.link</refentrytitle> | |
| 3601 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 3602 </refmeta> | |
| 3603 <refnamediv> | |
| 3604 <refname>generate.legalnotice.link</refname> | |
| 3605 <refpurpose>Write legalnotice to separate chunk and generate link?</refpurpose> | |
| 3606 </refnamediv> | |
| 3607 | |
| 3608 <refsynopsisdiv> | |
| 3609 <programlisting xml:id="generate.legalnotice.link.frag"><xsl:param name="gene
rate.legalnotice.link" select="0"></xsl:param></programlisting> | |
| 3610 </refsynopsisdiv> | |
| 3611 | |
| 3612 <refsection><info><title>Description</title></info> | |
| 3613 | |
| 3614 <para>If the value of <parameter>generate.legalnotice.link</parameter> | |
| 3615 is non-zero, the stylesheet: | |
| 3616 | |
| 3617 <itemizedlist> | |
| 3618 <listitem> | |
| 3619 <para>writes the contents of <tag>legalnotice</tag> to a separate | |
| 3620 HTML file</para> | |
| 3621 </listitem> | |
| 3622 <listitem> | |
| 3623 <para>inserts a hyperlink to the <tag>legalnotice</tag> file</para> | |
| 3624 </listitem> | |
| 3625 <listitem> | |
| 3626 <para>adds (in the HTML <literal>head</literal>) either a single | |
| 3627 <literal>link</literal> or element or multiple | |
| 3628 <literal>link</literal> elements (depending on the value of the | |
| 3629 <parameter>html.head.legalnotice.link.multiple</parameter> | |
| 3630 parameter), with the value or values derived from the | |
| 3631 <parameter>html.head.legalnotice.link.types</parameter> | |
| 3632 parameter</para> | |
| 3633 </listitem> | |
| 3634 </itemizedlist> | |
| 3635 | |
| 3636 Otherwise, if <parameter>generate.legalnotice.link</parameter> is | |
| 3637 zero, <tag>legalnotice</tag> contents are rendered on the title | |
| 3638 page.</para> | |
| 3639 | |
| 3640 <para>The name of the separate HTML file is computed as follows: | |
| 3641 | |
| 3642 <orderedlist> | |
| 3643 <listitem> | |
| 3644 <para>If a filename is given by the <tag class="xmlpi">dbhtml filename</tag> | |
| 3645 processing instruction, that filename is used.</para> | |
| 3646 </listitem> | |
| 3647 <listitem> | |
| 3648 <para>If the legalnotice has an <tag class="attribute">id</tag>/<tag class="at
tribute">xml:id</tag> | |
| 3649 attribute, and if <parameter>use.id.as.filename</parameter> != 0, the filename | |
| 3650 is the concatenation of the id value and the value of the <parameter>html.ext</p
arameter> | |
| 3651 parameter.</para> | |
| 3652 </listitem> | |
| 3653 <listitem> | |
| 3654 <para>If the legalnotice does not have an <tag class="attribute">id</tag>/<tag
class="attribute">xml:id</tag> | |
| 3655 attribute, or if <parameter>use.id.as.filename</parameter> = 0, the filename is
the concatenation of "ln-", | |
| 3656 auto-generated id value, and <parameter>html.ext</parameter> value. | |
| 3657 </para> | |
| 3658 </listitem> | |
| 3659 </orderedlist> | |
| 3660 | |
| 3661 </para> | |
| 3662 | |
| 3663 </refsection> | |
| 3664 </refentry> | |
| 3665 | |
| 3666 <refentry version="5.0" xml:id="generate.revhistory.link"> | |
| 3667 <refmeta> | |
| 3668 <refentrytitle>generate.revhistory.link</refentrytitle> | |
| 3669 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 3670 </refmeta> | |
| 3671 <refnamediv> | |
| 3672 <refname>generate.revhistory.link</refname> | |
| 3673 <refpurpose>Write revhistory to separate chunk and generate link?</refpurpose> | |
| 3674 </refnamediv> | |
| 3675 | |
| 3676 <refsynopsisdiv> | |
| 3677 <programlisting xml:id="generate.revhistory.link.frag"><xsl:param name="gener
ate.revhistory.link" select="0"></xsl:param></programlisting> | |
| 3678 </refsynopsisdiv> | |
| 3679 | |
| 3680 <refsection><info><title>Description</title></info> | |
| 3681 | |
| 3682 <para>If non-zero, the contents of <tag>revhistory</tag> are written | |
| 3683 to a separate HTML file and a link to the file is | |
| 3684 generated. Otherwise, <tag>revhistory</tag> contents are rendered on | |
| 3685 the title page.</para> | |
| 3686 | |
| 3687 <para>The name of the separate HTML file is computed as follows: | |
| 3688 | |
| 3689 <orderedlist> | |
| 3690 <listitem> | |
| 3691 <para>If a filename is given by the <tag class="xmlpi">dbhtml filename</tag> p
rocessing instruction, | |
| 3692 that filename is used.</para> | |
| 3693 </listitem> | |
| 3694 <listitem> | |
| 3695 <para>If the revhistory has an <tag class="attribute">id</tag>/<tag class="att
ribute">xml:id</tag> | |
| 3696 attribute, and if <parameter>use.id.as.filename</parameter> != 0, the filename i
s the concatenation of | |
| 3697 the id value and the value of the <parameter>html.ext</parameter> parameter.</pa
ra> | |
| 3698 </listitem> | |
| 3699 <listitem> | |
| 3700 <para>If the revhistory does not have an <tag class="attribute">id</tag>/<tag
class="attribute">xml:id</tag> | |
| 3701 attribute, or if <parameter>use.id.as.filename</parameter> = 0, the filename is
the concatenation of "rh-", | |
| 3702 auto-generated id value, and <parameter>html.ext</parameter> value. | |
| 3703 </para> | |
| 3704 </listitem> | |
| 3705 </orderedlist> | |
| 3706 | |
| 3707 </para> | |
| 3708 | |
| 3709 </refsection> | |
| 3710 </refentry> | |
| 3711 | |
| 3712 <refentry version="5.0" xml:id="html.head.legalnotice.link.types"> | |
| 3713 <refmeta> | |
| 3714 <refentrytitle>html.head.legalnotice.link.types</refentrytitle> | |
| 3715 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 3716 </refmeta> | |
| 3717 <refnamediv> | |
| 3718 <refname>html.head.legalnotice.link.types</refname> | |
| 3719 <refpurpose>Specifies link types for legalnotice link in html head</refpurpose> | |
| 3720 </refnamediv> | |
| 3721 | |
| 3722 <refsynopsisdiv> | |
| 3723 <programlisting xml:id="html.head.legalnotice.link.types.frag"> | |
| 3724 <xsl:param name="html.head.legalnotice.link.types">copyright</xsl:param
> | |
| 3725 </programlisting> | |
| 3726 </refsynopsisdiv> | |
| 3727 | |
| 3728 <refsection><info><title>Description</title></info> | |
| 3729 | |
| 3730 <para>The value of | |
| 3731 <parameter>html.head.legalnotice.link.types</parameter> is a | |
| 3732 space-separated list of link types, as described in <link xmlns:xlink="http://ww
w.w3.org/1999/xlink" xlink:href="http://www.w3.org/TR/html401/types.html#type-li
nks">Section 6.12 | |
| 3733 of the HTML 4.01 specification</link>. If the value of the | |
| 3734 <parameter>generate.legalnotice.link</parameter> parameter is | |
| 3735 non-zero, then the stylesheet generates (in the | |
| 3736 <literal>head</literal> section of the HTML source) either a single | |
| 3737 HTML <literal>link</literal> element or, if the value of the | |
| 3738 <parameter>html.head.legalnotice.link.multiple</parameter> is | |
| 3739 non-zero, one <literal>link</literal> element for each link type | |
| 3740 specified. Each <literal>link</literal> has the following attributes: | |
| 3741 | |
| 3742 <itemizedlist> | |
| 3743 <listitem> | |
| 3744 <para>a <tag class="attribute">rel</tag> attribute whose | |
| 3745 value is derived from the value of | |
| 3746 <parameter>html.head.legalnotice.link.types</parameter></para> | |
| 3747 </listitem> | |
| 3748 <listitem> | |
| 3749 <para>an <tag class="attribute">href</tag> attribute whose | |
| 3750 value is set to the URL of the file containing the | |
| 3751 <tag>legalnotice</tag></para> | |
| 3752 </listitem> | |
| 3753 <listitem> | |
| 3754 <para>a <tag class="attribute">title</tag> attribute whose | |
| 3755 value is set to the title of the corresponding | |
| 3756 <tag>legalnotice</tag> (or a title programatically | |
| 3757 determined by the stylesheet)</para> | |
| 3758 </listitem> | |
| 3759 </itemizedlist> | |
| 3760 | |
| 3761 For example: | |
| 3762 | |
| 3763 <screen> <link rel="license" href="ln-id2524073.html" title="Legal Notice"&g
t;</screen> | |
| 3764 </para> | |
| 3765 | |
| 3766 <refsection><info><title>About the default value</title></info> | |
| 3767 | |
| 3768 <para>In an ideal world, the default value of | |
| 3769 <parameter>html.head.legalnotice.link.types</parameter> would | |
| 3770 probably be “<literal>license</literal>”, since the content of the | |
| 3771 DocBook <tag>legalnotice</tag> is typically license | |
| 3772 information, not copyright information. However, the default value | |
| 3773 is “<literal>copyright</literal>” for pragmatic reasons: because | |
| 3774 that’s among the set of “recognized link types” listed in <l
ink xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.w3.org/TR/
html401/types.html#type-links">Section | |
| 3775 6.12 of the HTML 4.01 specification</link>, and because certain | |
| 3776 browsers and browser extensions are preconfigured to recognize that | |
| 3777 value.</para> | |
| 3778 </refsection> | |
| 3779 | |
| 3780 </refsection> | |
| 3781 </refentry> | |
| 3782 | |
| 3783 <refentry version="5.0" xml:id="html.head.legalnotice.link.multiple"> | |
| 3784 <refmeta> | |
| 3785 <refentrytitle>html.head.legalnotice.link.multiple</refentrytitle> | |
| 3786 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 3787 </refmeta> | |
| 3788 <refnamediv> | |
| 3789 <refname>html.head.legalnotice.link.multiple</refname> | |
| 3790 <refpurpose>Generate multiple link instances in html head for legalnotice?</refp
urpose> | |
| 3791 </refnamediv> | |
| 3792 | |
| 3793 <refsynopsisdiv> | |
| 3794 <programlisting xml:id="html.head.legalnotice.link.multiple.frag"> | |
| 3795 <xsl:param name="html.head.legalnotice.link.multiple" select="1"></xsl:
param> | |
| 3796 </programlisting> | |
| 3797 </refsynopsisdiv> | |
| 3798 | |
| 3799 <refsection><info><title>Description</title></info> | |
| 3800 | |
| 3801 <para>If <parameter>html.head.legalnotice.link.multiple</parameter> is | |
| 3802 non-zero and the value of | |
| 3803 <parameter>html.head.legalnotice.link.types</parameter> contains | |
| 3804 multiple link types, then the stylesheet generates (in the | |
| 3805 <literal>head</literal> section of the HTML source) one | |
| 3806 <literal>link</literal> element for each link type specified. For | |
| 3807 example, if the value of | |
| 3808 <parameter>html.head.legalnotice.link.types</parameter> is | |
| 3809 “<literal>copyright license</literal>”: | |
| 3810 | |
| 3811 <screen> <link rel="copyright" href="ln-id2524073.html" title="Legal Notice"
> | |
| 3812 <link rel="license" href="ln-id2524073.html" title="Legal Notice"></scre
en> | |
| 3813 | |
| 3814 Otherwise, the stylesheet generates generates a single | |
| 3815 <literal>link</literal> instance; for example: | |
| 3816 | |
| 3817 <screen> <link rel="copyright license" href="ln-id2524073.html" title="Legal
Notice"></screen> | |
| 3818 | |
| 3819 </para> | |
| 3820 </refsection> | |
| 3821 </refentry> | |
| 3822 | |
| 3823 </reference> | |
| 3824 <reference xml:id="refentry"><title>Reference Pages</title> | |
| 3825 <refentry version="5.0" xml:id="funcsynopsis.decoration"> | |
| 3826 <refmeta> | |
| 3827 <refentrytitle>funcsynopsis.decoration</refentrytitle> | |
| 3828 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 3829 </refmeta> | |
| 3830 <refnamediv> | |
| 3831 <refname>funcsynopsis.decoration</refname> | |
| 3832 <refpurpose>Decorate elements of a <tag>funcsynopsis</tag>?</refpurpose> | |
| 3833 </refnamediv> | |
| 3834 | |
| 3835 <refsynopsisdiv> | |
| 3836 <programlisting xml:id="funcsynopsis.decoration.frag"> | |
| 3837 <xsl:param name="funcsynopsis.decoration" select="1"></xsl:param> | |
| 3838 </programlisting> | |
| 3839 </refsynopsisdiv> | |
| 3840 | |
| 3841 <refsection><info><title>Description</title></info> | |
| 3842 | |
| 3843 <para>If non-zero, elements of the <tag>funcsynopsis</tag> will be | |
| 3844 decorated (e.g. rendered as bold or italic text). The decoration is controlled b
y | |
| 3845 templates that can be redefined in a customization layer. | |
| 3846 </para> | |
| 3847 | |
| 3848 </refsection> | |
| 3849 </refentry> | |
| 3850 | |
| 3851 <refentry version="5.0" xml:id="funcsynopsis.style"> | |
| 3852 <refmeta> | |
| 3853 <refentrytitle>funcsynopsis.style</refentrytitle> | |
| 3854 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> | |
| 3855 <refmiscinfo class="other" otherclass="value">ansi</refmiscinfo> | |
| 3856 <refmiscinfo class="other" otherclass="value">kr</refmiscinfo> | |
| 3857 </refmeta> | |
| 3858 <refnamediv> | |
| 3859 <refname>funcsynopsis.style</refname> | |
| 3860 <refpurpose>What style of <tag>funcsynopsis</tag> should be generated?</refpurpo
se> | |
| 3861 </refnamediv> | |
| 3862 | |
| 3863 <refsynopsisdiv> | |
| 3864 <programlisting xml:id="funcsynopsis.style.frag"><xsl:param name="funcsynopsi
s.style">kr</xsl:param></programlisting> | |
| 3865 </refsynopsisdiv> | |
| 3866 | |
| 3867 <refsection><info><title>Description</title></info> | |
| 3868 | |
| 3869 <para>If <parameter>funcsynopsis.style</parameter> is <literal>ansi</literal>, | |
| 3870 ANSI-style function synopses are generated for a | |
| 3871 <tag>funcsynopsis</tag>, otherwise K&R-style | |
| 3872 function synopses are generated. | |
| 3873 </para> | |
| 3874 | |
| 3875 </refsection> | |
| 3876 </refentry> | |
| 3877 | |
| 3878 <refentry version="5.0" xml:id="function.parens"> | |
| 3879 <refmeta> | |
| 3880 <refentrytitle>function.parens</refentrytitle> | |
| 3881 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 3882 </refmeta> | |
| 3883 <refnamediv> | |
| 3884 <refname>function.parens</refname> | |
| 3885 <refpurpose>Generate parens after a function?</refpurpose> | |
| 3886 </refnamediv> | |
| 3887 | |
| 3888 <refsynopsisdiv> | |
| 3889 <programlisting xml:id="function.parens.frag"> | |
| 3890 <xsl:param name="function.parens" select="0"></xsl:param> | |
| 3891 </programlisting> | |
| 3892 </refsynopsisdiv> | |
| 3893 | |
| 3894 <refsection><info><title>Description</title></info> | |
| 3895 | |
| 3896 <para>If non-zero, the formatting of a <tag>function</tag> element | |
| 3897 will include generated parentheses. | |
| 3898 </para> | |
| 3899 | |
| 3900 </refsection> | |
| 3901 </refentry> | |
| 3902 | |
| 3903 <refentry version="5.0" xml:id="refentry.generate.name"> | |
| 3904 <refmeta> | |
| 3905 <refentrytitle>refentry.generate.name</refentrytitle> | |
| 3906 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 3907 </refmeta> | |
| 3908 <refnamediv> | |
| 3909 <refname>refentry.generate.name</refname> | |
| 3910 <refpurpose>Output NAME header before <tag>refname</tag>s?</refpurpose> | |
| 3911 </refnamediv> | |
| 3912 | |
| 3913 <refsynopsisdiv> | |
| 3914 <programlisting xml:id="refentry.generate.name.frag"> | |
| 3915 <xsl:param name="refentry.generate.name" select="1"></xsl:param> | |
| 3916 </programlisting> | |
| 3917 </refsynopsisdiv> | |
| 3918 | |
| 3919 <refsection><info><title>Description</title></info> | |
| 3920 | |
| 3921 <para>If non-zero, a "NAME" section title is output before the list | |
| 3922 of <tag>refname</tag>s. This parameter and | |
| 3923 <parameter>refentry.generate.title</parameter> are mutually | |
| 3924 exclusive. This means that if you change this parameter to zero, you | |
| 3925 should set <parameter>refentry.generate.title</parameter> to non-zero unless | |
| 3926 you want get quite strange output. | |
| 3927 </para> | |
| 3928 | |
| 3929 </refsection> | |
| 3930 </refentry> | |
| 3931 | |
| 3932 <refentry version="5.0" xml:id="refentry.generate.title"> | |
| 3933 <refmeta> | |
| 3934 <refentrytitle>refentry.generate.title</refentrytitle> | |
| 3935 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 3936 </refmeta> | |
| 3937 <refnamediv> | |
| 3938 <refname>refentry.generate.title</refname> | |
| 3939 <refpurpose>Output title before <tag>refname</tag>s?</refpurpose> | |
| 3940 </refnamediv> | |
| 3941 | |
| 3942 <refsynopsisdiv> | |
| 3943 <programlisting xml:id="refentry.generate.title.frag"> | |
| 3944 <xsl:param name="refentry.generate.title" select="0"></xsl:param> | |
| 3945 </programlisting> | |
| 3946 </refsynopsisdiv> | |
| 3947 | |
| 3948 <refsection><info><title>Description</title></info> | |
| 3949 | |
| 3950 <para>If non-zero, the reference page title or first name is | |
| 3951 output before the list of <tag>refname</tag>s. This parameter and | |
| 3952 <parameter>refentry.generate.name</parameter> are mutually exclusive. | |
| 3953 This means that if you change this parameter to non-zero, you | |
| 3954 should set <parameter>refentry.generate.name</parameter> to zero unless | |
| 3955 you want get quite strange output.</para> | |
| 3956 | |
| 3957 | |
| 3958 </refsection> | |
| 3959 </refentry> | |
| 3960 | |
| 3961 <refentry version="5.0" xml:id="refentry.xref.manvolnum"> | |
| 3962 <refmeta> | |
| 3963 <refentrytitle>refentry.xref.manvolnum</refentrytitle> | |
| 3964 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 3965 </refmeta> | |
| 3966 <refnamediv> | |
| 3967 <refname>refentry.xref.manvolnum</refname> | |
| 3968 <refpurpose>Output <tag>manvolnum</tag> as part of | |
| 3969 <tag>refentry</tag> cross-reference?</refpurpose> | |
| 3970 </refnamediv> | |
| 3971 | |
| 3972 <refsynopsisdiv> | |
| 3973 <programlisting xml:id="refentry.xref.manvolnum.frag"> | |
| 3974 <xsl:param name="refentry.xref.manvolnum" select="1"></xsl:param> | |
| 3975 </programlisting> | |
| 3976 </refsynopsisdiv> | |
| 3977 | |
| 3978 <refsection><info><title>Description</title></info> | |
| 3979 | |
| 3980 <para>if non-zero, the <tag>manvolnum</tag> is used when cross-referencing | |
| 3981 <tag>refentry</tag>s, either with <tag>xref</tag> | |
| 3982 or <tag>citerefentry</tag>. | |
| 3983 </para> | |
| 3984 | |
| 3985 </refsection> | |
| 3986 </refentry> | |
| 3987 | |
| 3988 <refentry version="5.0" xml:id="citerefentry.link"> | |
| 3989 <refmeta> | |
| 3990 <refentrytitle>citerefentry.link</refentrytitle> | |
| 3991 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 3992 </refmeta> | |
| 3993 <refnamediv> | |
| 3994 <refname>citerefentry.link</refname> | |
| 3995 <refpurpose>Generate URL links when cross-referencing RefEntrys?</refpurpose> | |
| 3996 </refnamediv> | |
| 3997 | |
| 3998 <refsynopsisdiv> | |
| 3999 <programlisting xml:id="citerefentry.link.frag"> | |
| 4000 <xsl:param name="citerefentry.link" select="0"></xsl:param></program
listing> | |
| 4001 </refsynopsisdiv> | |
| 4002 | |
| 4003 <refsection><info><title>Description</title></info> | |
| 4004 | |
| 4005 <para>If non-zero, a web link will be generated, presumably | |
| 4006 to an online man->HTML gateway. The text of the link is | |
| 4007 generated by the <literal>generate.citerefentry.link</literal> template. | |
| 4008 </para> | |
| 4009 | |
| 4010 </refsection> | |
| 4011 </refentry> | |
| 4012 | |
| 4013 <refentry version="5.0" xml:id="refentry.separator"> | |
| 4014 <refmeta> | |
| 4015 <refentrytitle>refentry.separator</refentrytitle> | |
| 4016 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 4017 </refmeta> | |
| 4018 <refnamediv> | |
| 4019 <refname>refentry.separator</refname> | |
| 4020 <refpurpose>Generate a separator between consecutive RefEntry elements?</refpurp
ose> | |
| 4021 </refnamediv> | |
| 4022 | |
| 4023 <refsynopsisdiv> | |
| 4024 <programlisting xml:id="refentry.separator.frag"> | |
| 4025 <xsl:param name="refentry.separator" select="1"></xsl:param> | |
| 4026 </programlisting> | |
| 4027 </refsynopsisdiv> | |
| 4028 | |
| 4029 <refsection><info><title>Description</title></info> | |
| 4030 | |
| 4031 <para>If true, a separator will be generated between consecutive | |
| 4032 reference pages. | |
| 4033 </para> | |
| 4034 | |
| 4035 </refsection> | |
| 4036 </refentry> | |
| 4037 | |
| 4038 <refentry version="5.0" xml:id="refclass.suppress"> | |
| 4039 <refmeta> | |
| 4040 <refentrytitle>refclass.suppress</refentrytitle> | |
| 4041 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 4042 </refmeta> | |
| 4043 <refnamediv> | |
| 4044 <refname>refclass.suppress</refname> | |
| 4045 <refpurpose>Suppress display of refclass contents?</refpurpose> | |
| 4046 </refnamediv> | |
| 4047 | |
| 4048 <refsynopsisdiv> | |
| 4049 <programlisting xml:id="refclass.suppress.frag"> | |
| 4050 <xsl:param name="refclass.suppress" select="0"></xsl:param></program
listing> | |
| 4051 </refsynopsisdiv> | |
| 4052 | |
| 4053 <refsection><info><title>Description</title></info> | |
| 4054 | |
| 4055 <para>If the value of <parameter>refclass.suppress</parameter> is | |
| 4056 non-zero, then display of <tag>refclass</tag> contents is | |
| 4057 suppressed in output.</para> | |
| 4058 | |
| 4059 </refsection> | |
| 4060 </refentry> | |
| 4061 | |
| 4062 </reference> | |
| 4063 <reference xml:id="tables"><title>Tables</title> | |
| 4064 <refentry version="5.0" xml:id="default.table.width"> | |
| 4065 <refmeta> | |
| 4066 <refentrytitle>default.table.width</refentrytitle> | |
| 4067 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> | |
| 4068 </refmeta> | |
| 4069 <refnamediv> | |
| 4070 <refname>default.table.width</refname> | |
| 4071 <refpurpose>The default width of tables</refpurpose> | |
| 4072 </refnamediv> | |
| 4073 <refsynopsisdiv> | |
| 4074 <programlisting xml:id="default.table.width.frag"> | |
| 4075 <xsl:param name="default.table.width"></xsl:param> | |
| 4076 </programlisting> | |
| 4077 </refsynopsisdiv> | |
| 4078 <refsection><info><title>Description</title></info> | |
| 4079 <para>If non-zero, this value will be used for the | |
| 4080 <literal>width</literal> attribute on <tag>table</tag>s that do not specify an | |
| 4081 alternate width (with the <tag class="xmlpi">dbhtml table-width</tag> or | |
| 4082 <tag class="xmlpi">dbfo table-width</tag> processing instruction).</para> | |
| 4083 </refsection> | |
| 4084 </refentry> | |
| 4085 | |
| 4086 <refentry version="5.0" xml:id="nominal.table.width"> | |
| 4087 <refmeta> | |
| 4088 <refentrytitle>nominal.table.width</refentrytitle> | |
| 4089 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> | |
| 4090 </refmeta> | |
| 4091 <refnamediv> | |
| 4092 <refname>nominal.table.width</refname> | |
| 4093 <refpurpose>The (absolute) nominal width of tables</refpurpose> | |
| 4094 </refnamediv> | |
| 4095 | |
| 4096 <refsynopsisdiv> | |
| 4097 <programlisting xml:id="nominal.table.width.frag"> | |
| 4098 <xsl:param name="nominal.table.width">6in</xsl:param> | |
| 4099 </programlisting> | |
| 4100 </refsynopsisdiv> | |
| 4101 | |
| 4102 <refsection><info><title>Description</title></info> | |
| 4103 | |
| 4104 <para>In order to convert CALS column widths into HTML column widths, it | |
| 4105 is sometimes necessary to have an absolute table width to use for conversion | |
| 4106 of mixed absolute and relative widths. This value must be an absolute | |
| 4107 length (not a percentage).</para> | |
| 4108 | |
| 4109 </refsection> | |
| 4110 </refentry> | |
| 4111 | |
| 4112 <refentry version="5.0" xml:id="table.borders.with.css"> | |
| 4113 <refmeta> | |
| 4114 <refentrytitle>table.borders.with.css</refentrytitle> | |
| 4115 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 4116 </refmeta> | |
| 4117 <refnamediv> | |
| 4118 <refname>table.borders.with.css</refname> | |
| 4119 <refpurpose>Use CSS to specify table, row, and cell borders?</refpurpose> | |
| 4120 </refnamediv> | |
| 4121 | |
| 4122 <refsynopsisdiv> | |
| 4123 <programlisting xml:id="table.borders.with.css.frag"> | |
| 4124 <xsl:param name="table.borders.with.css" select="0"></xsl:param> | |
| 4125 </programlisting> | |
| 4126 </refsynopsisdiv> | |
| 4127 | |
| 4128 <refsection><info><title>Description</title></info> | |
| 4129 | |
| 4130 <para>If non-zero, CSS will be used to draw table borders. | |
| 4131 </para> | |
| 4132 | |
| 4133 </refsection> | |
| 4134 </refentry> | |
| 4135 | |
| 4136 <refentry version="5.0" xml:id="table.cell.border.style"> | |
| 4137 <refmeta> | |
| 4138 <refentrytitle>table.cell.border.style</refentrytitle> | |
| 4139 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> | |
| 4140 <refmiscinfo class="other" otherclass="value">none</refmiscinfo> | |
| 4141 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo> | |
| 4142 <refmiscinfo class="other" otherclass="value">dotted</refmiscinfo> | |
| 4143 <refmiscinfo class="other" otherclass="value">dashed</refmiscinfo> | |
| 4144 <refmiscinfo class="other" otherclass="value">double</refmiscinfo> | |
| 4145 <refmiscinfo class="other" otherclass="value">groove</refmiscinfo>
| |
| 4146 <refmiscinfo class="other" otherclass="value">ridge</refmiscinfo> | |
| 4147 <refmiscinfo class="other" otherclass="value">inset</refmiscinfo> | |
| 4148 <refmiscinfo class="other" otherclass="value">outset</refmiscinfo> | |
| 4149 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo> | |
| 4150 </refmeta> | |
| 4151 <refnamediv> | |
| 4152 <refname>table.cell.border.style</refname> | |
| 4153 <refpurpose>Specifies the border style of table cells</refpurpose> | |
| 4154 </refnamediv> | |
| 4155 | |
| 4156 <refsynopsisdiv> | |
| 4157 <programlisting xml:id="table.cell.border.style.frag"> | |
| 4158 <xsl:param name="table.cell.border.style">solid</xsl:param> | |
| 4159 </programlisting> | |
| 4160 </refsynopsisdiv> | |
| 4161 | |
| 4162 <refsection><info><title>Description</title></info> | |
| 4163 | |
| 4164 <para>Specifies the border style of table cells.</para> | |
| 4165 | |
| 4166 <note> | |
| 4167 <para>To control properties of cell borders in HTML output, you must also turn
on the | |
| 4168 <parameter>table.borders.with.css</parameter> parameter.</para> | |
| 4169 </note> | |
| 4170 | |
| 4171 </refsection> | |
| 4172 </refentry> | |
| 4173 | |
| 4174 <refentry version="5.0" xml:id="table.cell.border.thickness"> | |
| 4175 <refmeta> | |
| 4176 <refentrytitle>table.cell.border.thickness</refentrytitle> | |
| 4177 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> | |
| 4178 </refmeta> | |
| 4179 <refnamediv> | |
| 4180 <refname>table.cell.border.thickness</refname> | |
| 4181 <refpurpose>Specifies the thickness of table cell borders</refpurpose> | |
| 4182 </refnamediv> | |
| 4183 | |
| 4184 <refsynopsisdiv> | |
| 4185 <programlisting xml:id="table.cell.border.thickness.frag"> | |
| 4186 <xsl:param name="table.cell.border.thickness">0.5pt</xsl:param> | |
| 4187 </programlisting> | |
| 4188 </refsynopsisdiv> | |
| 4189 | |
| 4190 <refsection><info><title>Description</title></info> | |
| 4191 | |
| 4192 <para>If non-zero, specifies the thickness of borders on table | |
| 4193 cells. The units are points. See <link xmlns:xlink="http://www.w3.org/1999/xlink
" xlink:href="http://www.w3.org/TR/CSS21/box.html#border-width-properties"> | |
| 4194 CSS</link></para> | |
| 4195 | |
| 4196 <note> | |
| 4197 <para>To control properties of cell borders in HTML output, you must also turn
on the | |
| 4198 <parameter>table.borders.with.css</parameter> parameter.</para> | |
| 4199 </note> | |
| 4200 | |
| 4201 </refsection> | |
| 4202 </refentry> | |
| 4203 | |
| 4204 <refentry version="5.0" xml:id="table.cell.border.color"> | |
| 4205 <refmeta> | |
| 4206 <refentrytitle>table.cell.border.color</refentrytitle> | |
| 4207 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo> | |
| 4208 </refmeta> | |
| 4209 <refnamediv> | |
| 4210 <refname>table.cell.border.color</refname> | |
| 4211 <refpurpose>Specifies the border color of table cells</refpurpose> | |
| 4212 </refnamediv> | |
| 4213 | |
| 4214 <refsynopsisdiv> | |
| 4215 <programlisting xml:id="table.cell.border.color.frag"> | |
| 4216 <xsl:param name="table.cell.border.color"></xsl:param> | |
| 4217 | |
| 4218 </programlisting> | |
| 4219 </refsynopsisdiv> | |
| 4220 | |
| 4221 <refsection><info><title>Description</title></info> | |
| 4222 | |
| 4223 <para>Set the color of table cell borders. If non-zero, the value is used | |
| 4224 for the border coloration. See <link xmlns:xlink="http://www.w3.org/1999/xlink"
xlink:href="http://www.w3.org/TR/CSS21/syndata.html#value-def-color">CSS</link>.
A | |
| 4225 <literal>color</literal> is either a keyword or a numerical RGB specification. | |
| 4226 Keywords are aqua, black, blue, fuchsia, gray, green, lime, maroon, | |
| 4227 navy, olive, orange, purple, red, silver, teal, white, and | |
| 4228 yellow.</para> | |
| 4229 | |
| 4230 <note> | |
| 4231 <para>To control properties of cell borders in HTML output, you must also turn
on the | |
| 4232 <parameter>table.borders.with.css</parameter> parameter.</para> | |
| 4233 </note> | |
| 4234 | |
| 4235 </refsection> | |
| 4236 </refentry> | |
| 4237 | |
| 4238 <refentry version="5.0" xml:id="table.frame.border.style"> | |
| 4239 <refmeta> | |
| 4240 <refentrytitle>table.frame.border.style</refentrytitle> | |
| 4241 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> | |
| 4242 <refmiscinfo class="other" otherclass="value">none</refmiscinfo> | |
| 4243 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo> | |
| 4244 <refmiscinfo class="other" otherclass="value">dotted</refmiscinfo> | |
| 4245 <refmiscinfo class="other" otherclass="value">dashed</refmiscinfo> | |
| 4246 <refmiscinfo class="other" otherclass="value">double</refmiscinfo> | |
| 4247 <refmiscinfo class="other" otherclass="value">groove</refmiscinfo>
| |
| 4248 <refmiscinfo class="other" otherclass="value">ridge</refmiscinfo> | |
| 4249 <refmiscinfo class="other" otherclass="value">inset</refmiscinfo> | |
| 4250 <refmiscinfo class="other" otherclass="value">outset</refmiscinfo> | |
| 4251 <refmiscinfo class="other" otherclass="value">solid</refmiscinfo> | |
| 4252 </refmeta> | |
| 4253 <refnamediv> | |
| 4254 <refname>table.frame.border.style</refname> | |
| 4255 <refpurpose>Specifies the border style of table frames</refpurpose> | |
| 4256 </refnamediv> | |
| 4257 | |
| 4258 <refsynopsisdiv> | |
| 4259 <programlisting xml:id="table.frame.border.style.frag"> | |
| 4260 <xsl:param name="table.frame.border.style">solid</xsl:param> | |
| 4261 </programlisting> | |
| 4262 </refsynopsisdiv> | |
| 4263 | |
| 4264 <refsection><info><title>Description</title></info> | |
| 4265 | |
| 4266 <para>Specifies the border style of table frames.</para> | |
| 4267 | |
| 4268 </refsection> | |
| 4269 </refentry> | |
| 4270 | |
| 4271 <refentry version="5.0" xml:id="table.frame.border.thickness"> | |
| 4272 <refmeta> | |
| 4273 <refentrytitle>table.frame.border.thickness</refentrytitle> | |
| 4274 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> | |
| 4275 </refmeta> | |
| 4276 <refnamediv> | |
| 4277 <refname>table.frame.border.thickness</refname> | |
| 4278 <refpurpose>Specifies the thickness of the frame border</refpurpose> | |
| 4279 </refnamediv> | |
| 4280 | |
| 4281 <refsynopsisdiv> | |
| 4282 <programlisting xml:id="table.frame.border.thickness.frag"> | |
| 4283 <xsl:param name="table.frame.border.thickness">0.5pt</xsl:param> | |
| 4284 </programlisting> | |
| 4285 </refsynopsisdiv> | |
| 4286 | |
| 4287 <refsection><info><title>Description</title></info> | |
| 4288 | |
| 4289 <para>Specifies the thickness of the border on the table's frame.</para> | |
| 4290 | |
| 4291 </refsection> | |
| 4292 </refentry> | |
| 4293 | |
| 4294 <refentry version="5.0" xml:id="table.frame.border.color"> | |
| 4295 <refmeta> | |
| 4296 <refentrytitle>table.frame.border.color</refentrytitle> | |
| 4297 <refmiscinfo class="other" otherclass="datatype">color</refmiscinfo> | |
| 4298 </refmeta> | |
| 4299 <refnamediv> | |
| 4300 <refname>table.frame.border.color</refname> | |
| 4301 <refpurpose>Specifies the border color of table frames</refpurpose> | |
| 4302 </refnamediv> | |
| 4303 | |
| 4304 <refsynopsisdiv> | |
| 4305 <programlisting xml:id="table.frame.border.color.frag"> | |
| 4306 <xsl:param name="table.frame.border.color"></xsl:param> | |
| 4307 | |
| 4308 </programlisting> | |
| 4309 </refsynopsisdiv> | |
| 4310 | |
| 4311 <refsection><info><title>Description</title></info> | |
| 4312 | |
| 4313 <para>Specifies the border color of table frames.</para> | |
| 4314 | |
| 4315 </refsection> | |
| 4316 </refentry> | |
| 4317 | |
| 4318 <refentry version="5.0" xml:id="default.table.frame"> | |
| 4319 <refmeta> | |
| 4320 <refentrytitle>default.table.frame</refentrytitle> | |
| 4321 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 4322 </refmeta> | |
| 4323 <refnamediv> | |
| 4324 <refname>default.table.frame</refname> | |
| 4325 <refpurpose>The default framing of tables</refpurpose> | |
| 4326 </refnamediv> | |
| 4327 | |
| 4328 <refsynopsisdiv> | |
| 4329 <programlisting xml:id="default.table.frame.frag"> | |
| 4330 <xsl:param name="default.table.frame">all</xsl:param> | |
| 4331 </programlisting> | |
| 4332 </refsynopsisdiv> | |
| 4333 | |
| 4334 <refsection><info><title>Description</title></info> | |
| 4335 | |
| 4336 <para>This value will be used when there is no frame attribute on the | |
| 4337 table. </para> | |
| 4338 | |
| 4339 </refsection> | |
| 4340 </refentry> | |
| 4341 | |
| 4342 <refentry version="5.0" xml:id="html.cellspacing"> | |
| 4343 <refmeta> | |
| 4344 <refentrytitle>html.cellspacing</refentrytitle> | |
| 4345 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> | |
| 4346 </refmeta> | |
| 4347 <refnamediv> | |
| 4348 <refname>html.cellspacing</refname> | |
| 4349 <refpurpose>Default value for cellspacing in HTML tables</refpurpose> | |
| 4350 </refnamediv> | |
| 4351 | |
| 4352 <refsynopsisdiv> | |
| 4353 <programlisting xml:id="html.cellspacing.frag"> | |
| 4354 <xsl:param name="html.cellspacing"></xsl:param> | |
| 4355 </programlisting> | |
| 4356 </refsynopsisdiv> | |
| 4357 | |
| 4358 <refsection><info><title>Description</title></info> | |
| 4359 | |
| 4360 <para>If non-zero, this value will be used as the default cellspacing | |
| 4361 value in HTML tables. nn for pixels or nn% for percentage | |
| 4362 length. E.g. 5 or 5%</para> | |
| 4363 | |
| 4364 </refsection> | |
| 4365 </refentry> | |
| 4366 | |
| 4367 <refentry version="5.0" xml:id="html.cellpadding"> | |
| 4368 <refmeta> | |
| 4369 <refentrytitle>html.cellpadding</refentrytitle> | |
| 4370 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> | |
| 4371 </refmeta> | |
| 4372 <refnamediv> | |
| 4373 <refname>html.cellpadding</refname> | |
| 4374 <refpurpose>Default value for cellpadding in HTML tables</refpurpose> | |
| 4375 </refnamediv> | |
| 4376 | |
| 4377 <refsynopsisdiv> | |
| 4378 <programlisting xml:id="html.cellpadding.frag"> | |
| 4379 <xsl:param name="html.cellpadding"></xsl:param> | |
| 4380 </programlisting> | |
| 4381 </refsynopsisdiv> | |
| 4382 | |
| 4383 <refsection><info><title>Description</title></info> | |
| 4384 | |
| 4385 <para>If non-zero, this value will be used as the default cellpadding value | |
| 4386 in HTML tables. nn for pixels or nn% for percentage length. E.g. 5 or | |
| 4387 5%</para> | |
| 4388 | |
| 4389 </refsection> | |
| 4390 </refentry> | |
| 4391 | |
| 4392 </reference> | |
| 4393 <reference xml:id="qa"><title>QAndASet</title> | |
| 4394 <refentry version="5.0" xml:id="qanda.defaultlabel"> | |
| 4395 <refmeta> | |
| 4396 <refentrytitle>qanda.defaultlabel</refentrytitle> | |
| 4397 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> | |
| 4398 <refmiscinfo class="other" otherclass="value">number</refmiscinfo> | |
| 4399 <refmiscinfo class="other" otherclass="value">qanda</refmiscinfo> | |
| 4400 <refmiscinfo class="other" otherclass="value">none</refmiscinfo> | |
| 4401 </refmeta> | |
| 4402 <refnamediv> | |
| 4403 <refname>qanda.defaultlabel</refname> | |
| 4404 <refpurpose>Sets the default for defaultlabel on QandASet.</refpurpose> | |
| 4405 </refnamediv> | |
| 4406 | |
| 4407 <refsynopsisdiv> | |
| 4408 <programlisting xml:id="qanda.defaultlabel.frag"> | |
| 4409 <xsl:param name="qanda.defaultlabel">number</xsl:param> | |
| 4410 </programlisting> | |
| 4411 </refsynopsisdiv> | |
| 4412 | |
| 4413 <refsection><info><title>Description</title></info> | |
| 4414 | |
| 4415 <para>If no <literal>defaultlabel</literal> attribute is specified on | |
| 4416 a <tag>qandaset</tag>, this value is used. It is generally one of the legal | |
| 4417 values for the defaultlabel attribute (<literal>none</literal>, | |
| 4418 <literal>number</literal> or | |
| 4419 <literal>qanda</literal>), or one of the additional stylesheet-specific values | |
| 4420 (<literal>qnumber</literal> or <literal>qnumberanda</literal>). | |
| 4421 The default value is 'number'. | |
| 4422 </para> | |
| 4423 <para>The values are rendered as follows:</para> | |
| 4424 <variablelist> | |
| 4425 <varlistentry><term><literal>qanda</literal></term> | |
| 4426 <listitem> | |
| 4427 <para><tag>question</tag>s are labeled "Q:" and | |
| 4428 <tag>answer</tag>s are labeled "A:". </para> | |
| 4429 </listitem> | |
| 4430 </varlistentry> | |
| 4431 | |
| 4432 <varlistentry><term><literal>number</literal></term> | |
| 4433 <listitem> | |
| 4434 <para>The questions are enumerated and the answers | |
| 4435 are not labeled. </para> | |
| 4436 </listitem> | |
| 4437 </varlistentry> | |
| 4438 | |
| 4439 <varlistentry><term><literal>qnumber</literal></term> | |
| 4440 <listitem> | |
| 4441 <para>The questions are labeled "Q:" followed by a number, and answers are not | |
| 4442 labeled. | |
| 4443 When sections are numbered, adding a label | |
| 4444 to the number distinguishes the question numbers | |
| 4445 from the section numbers. | |
| 4446 This value is not allowed in the | |
| 4447 <tag class="attribute">defaultlabel</tag> attribute | |
| 4448 of a <tag>qandaset</tag> element.</para> | |
| 4449 </listitem> | |
| 4450 </varlistentry> | |
| 4451 | |
| 4452 <varlistentry><term><literal>qnumberanda</literal></term> | |
| 4453 <listitem> | |
| 4454 <para>The questions are labeled "Q:" followed by a number, and | |
| 4455 the answers are labeled "A:". | |
| 4456 When sections are numbered, adding a label | |
| 4457 to the number distinguishes the question numbers | |
| 4458 from the section numbers. | |
| 4459 This value is not allowed in the | |
| 4460 <tag class="attribute">defaultlabel</tag> attribute | |
| 4461 of a <tag>qandaset</tag> element.</para> | |
| 4462 </listitem> | |
| 4463 </varlistentry> | |
| 4464 | |
| 4465 <varlistentry><term><literal>none</literal></term> | |
| 4466 <listitem> | |
| 4467 <para>No distinguishing label precedes Questions or Answers. | |
| 4468 </para> | |
| 4469 </listitem> | |
| 4470 </varlistentry> | |
| 4471 </variablelist> | |
| 4472 | |
| 4473 </refsection> | |
| 4474 </refentry> | |
| 4475 | |
| 4476 <refentry version="5.0" xml:id="qanda.inherit.numeration"> | |
| 4477 <refmeta> | |
| 4478 <refentrytitle>qanda.inherit.numeration</refentrytitle> | |
| 4479 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 4480 </refmeta> | |
| 4481 <refnamediv> | |
| 4482 <refname>qanda.inherit.numeration</refname> | |
| 4483 <refpurpose>Does enumeration of QandASet components inherit the numeration of pa
rent elements?</refpurpose> | |
| 4484 </refnamediv> | |
| 4485 | |
| 4486 <refsynopsisdiv> | |
| 4487 <programlisting xml:id="qanda.inherit.numeration.frag"> | |
| 4488 <xsl:param name="qanda.inherit.numeration" select="1"></xsl:param> | |
| 4489 </programlisting> | |
| 4490 </refsynopsisdiv> | |
| 4491 | |
| 4492 <refsection><info><title>Description</title></info> | |
| 4493 | |
| 4494 <para>If non-zero, numbered <tag>qandadiv</tag> elements and | |
| 4495 <tag>question</tag> and <tag>answer</tag> inherit the enumeration of | |
| 4496 the ancestors of the <tag>qandaset</tag>. | |
| 4497 </para> | |
| 4498 | |
| 4499 </refsection> | |
| 4500 </refentry> | |
| 4501 | |
| 4502 <refentry version="5.0" xml:id="qanda.in.toc"> | |
| 4503 <refmeta> | |
| 4504 <refentrytitle>qanda.in.toc</refentrytitle> | |
| 4505 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 4506 </refmeta> | |
| 4507 <refnamediv> | |
| 4508 <refname>qanda.in.toc</refname> | |
| 4509 <refpurpose>Should qandaentry questions appear in | |
| 4510 the document table of contents?</refpurpose> | |
| 4511 </refnamediv> | |
| 4512 | |
| 4513 <refsynopsisdiv> | |
| 4514 <programlisting xml:id="qanda.in.toc.frag"><xsl:param name="qanda.in.toc" sel
ect="0"></xsl:param></programlisting> | |
| 4515 </refsynopsisdiv> | |
| 4516 | |
| 4517 <refsection><info><title>Description</title></info> | |
| 4518 | |
| 4519 <para>If true (non-zero), then the generated table of contents | |
| 4520 for a document will include <tag>qandaset</tag> titles, | |
| 4521 <tag>qandadiv</tag> titles, | |
| 4522 and <tag>question</tag> elements. The default value (zero) excludes | |
| 4523 them from the TOC. | |
| 4524 </para> | |
| 4525 <para>This parameter does not affect any tables of contents | |
| 4526 that may be generated inside a qandaset or qandadiv. | |
| 4527 </para> | |
| 4528 | |
| 4529 </refsection> | |
| 4530 </refentry> | |
| 4531 | |
| 4532 <refentry version="5.0" xml:id="qanda.nested.in.toc"> | |
| 4533 <refmeta> | |
| 4534 <refentrytitle>qanda.nested.in.toc</refentrytitle> | |
| 4535 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 4536 </refmeta> | |
| 4537 <refnamediv> | |
| 4538 <refname>qanda.nested.in.toc</refname> | |
| 4539 <refpurpose>Should nested answer/qandaentry instances appear in TOC?</refpurpose
> | |
| 4540 </refnamediv> | |
| 4541 | |
| 4542 <refsynopsisdiv> | |
| 4543 <programlisting xml:id="qanda.nested.in.toc.frag"> | |
| 4544 <xsl:param name="qanda.nested.in.toc" select="0"></xsl:param> | |
| 4545 </programlisting> | |
| 4546 </refsynopsisdiv> | |
| 4547 | |
| 4548 <refsection><info><title>Description</title></info> | |
| 4549 | |
| 4550 <para>If non-zero, instances of <tag>qandaentry</tag> | |
| 4551 that are children of <tag>answer</tag> elements are shown in | |
| 4552 the TOC.</para> | |
| 4553 | |
| 4554 </refsection> | |
| 4555 </refentry> | |
| 4556 | |
| 4557 </reference> | |
| 4558 <reference xml:id="links"><title>Linking</title> | |
| 4559 <refentry version="5.0" xml:id="target.database.document"> | |
| 4560 <refmeta> | |
| 4561 <refentrytitle>target.database.document</refentrytitle> | |
| 4562 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> | |
| 4563 </refmeta> | |
| 4564 <refnamediv> | |
| 4565 <refname>target.database.document</refname> | |
| 4566 <refpurpose>Name of master database file for resolving | |
| 4567 olinks</refpurpose> | |
| 4568 </refnamediv> | |
| 4569 <refsynopsisdiv> | |
| 4570 <programlisting xml:id="target.database.document.frag"> | |
| 4571 <xsl:param name="target.database.document">olinkdb.xml</xsl:param> | |
| 4572 </programlisting> | |
| 4573 </refsynopsisdiv> | |
| 4574 <refsection><info><title>Description</title></info> | |
| 4575 | |
| 4576 <para> | |
| 4577 To resolve olinks between documents, the stylesheets use a master | |
| 4578 database document that identifies the target datafiles for all the | |
| 4579 documents within the scope of the olinks. This parameter value is the | |
| 4580 URI of the master document to be read during processing to resolve | |
| 4581 olinks. The default value is <filename>olinkdb.xml</filename>.</para> | |
| 4582 | |
| 4583 <para>The data structure of the file is defined in the | |
| 4584 <filename>targetdatabase.dtd</filename> DTD. The database file | |
| 4585 provides the high level elements to record the identifiers, locations, | |
| 4586 and relationships of documents. The cross reference data for | |
| 4587 individual documents is generally pulled into the database using | |
| 4588 system entity references or XIncludes. See also | |
| 4589 <parameter>targets.filename</parameter>. </para> </refsection> | |
| 4590 </refentry> | |
| 4591 | |
| 4592 <refentry version="5.0" xml:id="targets.filename"> | |
| 4593 <refmeta> | |
| 4594 <refentrytitle>targets.filename</refentrytitle> | |
| 4595 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 4596 </refmeta> | |
| 4597 <refnamediv> | |
| 4598 <refname>targets.filename</refname> | |
| 4599 <refpurpose>Name of cross reference targets data file</refpurpose> | |
| 4600 </refnamediv> | |
| 4601 <refsynopsisdiv> <programlisting xml:id="targets.filename.frag"> | |
| 4602 <xsl:param name="targets.filename">target.db</xsl:param> | |
| 4603 </programlisting> | |
| 4604 </refsynopsisdiv> | |
| 4605 <refsection><info><title>Description</title></info> | |
| 4606 | |
| 4607 <para> | |
| 4608 In order to resolve olinks efficiently, the stylesheets can | |
| 4609 generate an external data file containing information about | |
| 4610 all potential cross reference endpoints in a document. | |
| 4611 This parameter lets you change the name of the generated | |
| 4612 file from the default name <filename>target.db</filename>. | |
| 4613 The name must agree with that used in the target database | |
| 4614 used to resolve olinks during processing. | |
| 4615 See also <parameter>target.database.document</parameter>. | |
| 4616 </para> | |
| 4617 </refsection> | |
| 4618 </refentry> | |
| 4619 | |
| 4620 <refentry version="5.0" xml:id="olink.base.uri"> | |
| 4621 <refmeta> | |
| 4622 <refentrytitle>olink.base.uri</refentrytitle> | |
| 4623 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> | |
| 4624 </refmeta> | |
| 4625 <refnamediv> | |
| 4626 <refname>olink.base.uri</refname> | |
| 4627 <refpurpose>Base URI used in olink hrefs</refpurpose> | |
| 4628 </refnamediv> | |
| 4629 <refsynopsisdiv> <programlisting xml:id="olink.base.uri.frag"> | |
| 4630 <xsl:param name="olink.base.uri"></xsl:param> | |
| 4631 </programlisting> | |
| 4632 </refsynopsisdiv> | |
| 4633 <refsection><info><title>Description</title></info> | |
| 4634 | |
| 4635 <para>When cross reference data is collected for resolving olinks, it | |
| 4636 may be necessary to prepend a base URI to each target's href. This | |
| 4637 parameter lets you set that base URI when cross reference data is | |
| 4638 collected. This feature is needed when you want to link to a document | |
| 4639 that is processed without chunking. The output filename for such a | |
| 4640 document is not known to the XSL stylesheet; the only target | |
| 4641 information consists of fragment identifiers such as | |
| 4642 <literal>#idref</literal>. To enable the resolution of olinks between | |
| 4643 documents, you should pass the name of the HTML output file as the | |
| 4644 value of this parameter. Then the hrefs recorded in the cross | |
| 4645 reference data collection look like | |
| 4646 <literal>outfile.html#idref</literal>, which can be reached as links | |
| 4647 from other documents.</para> | |
| 4648 </refsection> | |
| 4649 </refentry> | |
| 4650 | |
| 4651 <refentry version="5.0" xml:id="use.local.olink.style"> | |
| 4652 <refmeta> | |
| 4653 <refentrytitle>use.local.olink.style</refentrytitle> | |
| 4654 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 4655 </refmeta> | |
| 4656 <refnamediv> | |
| 4657 <refname>use.local.olink.style</refname> | |
| 4658 <refpurpose>Process olinks using xref style of current | |
| 4659 document</refpurpose> | |
| 4660 </refnamediv> | |
| 4661 <refsynopsisdiv> <programlisting xml:id="use.local.olink.style.frag"> | |
| 4662 <xsl:param name="use.local.olink.style" select="0"></xsl:param> </pr
ogramlisting> | |
| 4663 </refsynopsisdiv> | |
| 4664 <refsection><info><title>Description</title></info> | |
| 4665 | |
| 4666 <para>When cross reference data is collected for use by olinks, the data for eac
h potential target includes one field containing a completely assembled cross re
ference string, as if it were an xref generated in that document. Other fields r
ecord the separate title, number, and element name of each target. When an olink
is formed to a target from another document, the olink resolves to that preasse
mbled string by default. If the <parameter>use.local.olink.style</parameter> par
ameter is set to non-zero, then instead the cross | |
| 4667 reference string is formed again from the target title, number, and | |
| 4668 element name, using the stylesheet processing the targeting document. | |
| 4669 Then olinks will match the xref style in the targeting document | |
| 4670 rather than in the target document. If both documents are processed | |
| 4671 with the same stylesheet, then the results will be the same.</para> | |
| 4672 </refsection> | |
| 4673 </refentry> | |
| 4674 | |
| 4675 <refentry version="5.0" xml:id="current.docid"> | |
| 4676 <refmeta> | |
| 4677 <refentrytitle>current.docid</refentrytitle> | |
| 4678 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 4679 </refmeta> | |
| 4680 <refnamediv> | |
| 4681 <refname>current.docid</refname> | |
| 4682 <refpurpose>targetdoc identifier for the document being | |
| 4683 processed</refpurpose> | |
| 4684 </refnamediv> | |
| 4685 <refsynopsisdiv> <programlisting xml:id="current.docid.frag"> | |
| 4686 <xsl:param name="current.docid"></xsl:param> | |
| 4687 </programlisting> | |
| 4688 </refsynopsisdiv> | |
| 4689 <refsection><info><title>Description</title></info> | |
| 4690 | |
| 4691 <para>When olinks between documents are resolved for HTML output, the stylesheet
can compute the relative path between the current document and the target docum
ent. The stylesheet needs to know the <literal>targetdoc</literal> identifiers f
or both documents, as they appear in the <parameter>target.database.document</pa
rameter> database file. This parameter passes to the stylesheet | |
| 4692 the targetdoc identifier of the current document, since that | |
| 4693 identifier does not appear in the document itself. </para> | |
| 4694 <para>This parameter can also be used for print output. If an olink's <literal>
targetdoc</literal> id differs from the <literal>current.docid</literal>, then
the stylesheet can append the target document's title to the generated olink tex
t. That identifies to the reader that the link is to a different document, not t
he current document. See also <parameter>olink.doctitle</parameter> to enable th
at feature.</para> | |
| 4695 </refsection> | |
| 4696 </refentry> | |
| 4697 | |
| 4698 <refentry version="5.0" xml:id="olink.doctitle"> | |
| 4699 <refmeta> | |
| 4700 <refentrytitle>olink.doctitle</refentrytitle> | |
| 4701 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> | |
| 4702 <refmiscinfo class="other" otherclass="value">no</refmiscinfo> | |
| 4703 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo> | |
| 4704 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo> | |
| 4705 </refmeta> | |
| 4706 <refnamediv> | |
| 4707 <refname>olink.doctitle</refname> | |
| 4708 <refpurpose>show the document title for external olinks?</refpurpose> | |
| 4709 | |
| 4710 </refnamediv> | |
| 4711 <refsynopsisdiv> <programlisting xml:id="olink.doctitle.frag"> | |
| 4712 <xsl:param name="olink.doctitle">no</xsl:param> | |
| 4713 </programlisting> | |
| 4714 </refsynopsisdiv> | |
| 4715 <refsection><info><title>Description</title></info> | |
| 4716 | |
| 4717 <para>When olinks between documents are resolved, the generated text | |
| 4718 may not make it clear that the reference is to another document. | |
| 4719 It is possible for the stylesheets to append the other document's | |
| 4720 title to external olinks. For this to happen, two parameters must | |
| 4721 be set.</para> | |
| 4722 <itemizedlist> | |
| 4723 <listitem> | |
| 4724 <para>This <parameter>olink.doctitle</parameter> parameter | |
| 4725 should be set to either <literal>yes</literal> or <literal>maybe</literal> | |
| 4726 to enable this feature. | |
| 4727 </para> | |
| 4728 </listitem> | |
| 4729 <listitem> | |
| 4730 <para>And you should also set the <parameter>current.docid</parameter> | |
| 4731 parameter to the document id for the document currently | |
| 4732 being processed for output. | |
| 4733 </para> | |
| 4734 </listitem> | |
| 4735 </itemizedlist> | |
| 4736 | |
| 4737 <para> | |
| 4738 Then if an olink's <literal>targetdoc</literal> id differs from | |
| 4739 the <literal>current.docid</literal> value, the stylesheet knows | |
| 4740 that it is a reference to another document and can | |
| 4741 append the target document's | |
| 4742 title to the generated olink text. </para> | |
| 4743 | |
| 4744 <para>The text for the target document's title is copied from the | |
| 4745 olink database from the <tag>ttl</tag> element | |
| 4746 of the top-level <tag>div</tag> for that document. | |
| 4747 If that <tag>ttl</tag> element is missing or empty, | |
| 4748 no title is output. | |
| 4749 </para> | |
| 4750 | |
| 4751 <para>The supported values for <parameter>olink.doctitle</parameter> are: | |
| 4752 </para> | |
| 4753 <variablelist> | |
| 4754 <varlistentry> | |
| 4755 <term><literal>yes</literal></term> | |
| 4756 <listitem> | |
| 4757 <para> | |
| 4758 Always insert the title to the target document if it is not | |
| 4759 the current document. | |
| 4760 </para> | |
| 4761 </listitem> | |
| 4762 </varlistentry> | |
| 4763 <varlistentry> | |
| 4764 <term><literal>no</literal></term> | |
| 4765 <listitem> | |
| 4766 <para> | |
| 4767 Never insert the title to the target document, even if requested | |
| 4768 in an <tag class="attribute">xrefstyle</tag> attribute. | |
| 4769 </para> | |
| 4770 </listitem> | |
| 4771 </varlistentry> | |
| 4772 <varlistentry> | |
| 4773 <term><literal>maybe</literal></term> | |
| 4774 <listitem> | |
| 4775 <para> | |
| 4776 Only insert the title to the target document, if requested | |
| 4777 in an <tag class="attribute">xrefstyle</tag> attribute. | |
| 4778 </para> | |
| 4779 </listitem> | |
| 4780 </varlistentry> | |
| 4781 </variablelist> | |
| 4782 <para>An <tag class="attribute">xrefstyle</tag> attribute | |
| 4783 may override the global setting for individual olinks. | |
| 4784 The following values are supported in an | |
| 4785 <tag class="attribute">xrefstyle</tag> | |
| 4786 attribute using the <literal>select:</literal> syntax: | |
| 4787 </para> | |
| 4788 | |
| 4789 <variablelist> | |
| 4790 <varlistentry> | |
| 4791 <term><literal>docname</literal></term> | |
| 4792 <listitem> | |
| 4793 <para> | |
| 4794 Insert the target document name for this olink using the | |
| 4795 <literal>docname</literal> gentext template, but only | |
| 4796 if the value of <parameter>olink.doctitle</parameter> | |
| 4797 is not <literal>no</literal>. | |
| 4798 </para> | |
| 4799 </listitem> | |
| 4800 </varlistentry> | |
| 4801 <varlistentry> | |
| 4802 <term><literal>docnamelong</literal></term> | |
| 4803 <listitem> | |
| 4804 <para> | |
| 4805 Insert the target document name for this olink using the | |
| 4806 <literal>docnamelong</literal> gentext template, but only | |
| 4807 if the value of <parameter>olink.doctitle</parameter> | |
| 4808 is not <literal>no</literal>. | |
| 4809 </para> | |
| 4810 </listitem> | |
| 4811 </varlistentry> | |
| 4812 <varlistentry> | |
| 4813 <term><literal>nodocname</literal></term> | |
| 4814 <listitem> | |
| 4815 <para> | |
| 4816 Omit the target document name even if | |
| 4817 the value of <parameter>olink.doctitle</parameter> | |
| 4818 is <literal>yes</literal>. | |
| 4819 </para> | |
| 4820 </listitem> | |
| 4821 </varlistentry> | |
| 4822 </variablelist> | |
| 4823 <para>Another way of inserting the target document name | |
| 4824 for a single olink is to employ an | |
| 4825 <tag class="attribute">xrefstyle</tag> | |
| 4826 attribute using the <literal>template:</literal> syntax. | |
| 4827 The <literal>%o</literal> placeholder (the letter o, not zero) | |
| 4828 in such a template | |
| 4829 will be filled in with the target document's title when it is processed. | |
| 4830 This will occur regardless of | |
| 4831 the value of <parameter>olink.doctitle</parameter>. | |
| 4832 </para> | |
| 4833 <para>Note that prior to version 1.66 of the XSL stylesheets, | |
| 4834 the allowed values for this parameter were 0 and 1. Those | |
| 4835 values are still supported and mapped to 'no' and 'yes', respectively. | |
| 4836 </para> | |
| 4837 </refsection> | |
| 4838 </refentry> | |
| 4839 | |
| 4840 <refentry version="5.0" xml:id="activate.external.olinks"> | |
| 4841 <refmeta> | |
| 4842 <refentrytitle>activate.external.olinks</refentrytitle> | |
| 4843 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 4844 </refmeta> | |
| 4845 <refnamediv> | |
| 4846 <refname>activate.external.olinks</refname> | |
| 4847 <refpurpose>Make external olinks into active links</refpurpose> | |
| 4848 </refnamediv> | |
| 4849 | |
| 4850 <refsynopsisdiv> | |
| 4851 <programlisting xml:id="activate.external.olinks.frag"> | |
| 4852 <xsl:param name="activate.external.olinks" select="1"></xsl:param> | |
| 4853 </programlisting> | |
| 4854 </refsynopsisdiv> | |
| 4855 | |
| 4856 <refsection><info><title>Description</title></info> | |
| 4857 | |
| 4858 <para>If <parameter>activate.external.olinks</parameter> is nonzero | |
| 4859 (the default), then any olinks that reference another document | |
| 4860 become active links that can be clicked on to follow the link. | |
| 4861 If the parameter is set to zero, then external olinks | |
| 4862 will have the appropriate link text generated, but the link is | |
| 4863 not made active. Olinks to destinations in | |
| 4864 the current document remain active.</para> | |
| 4865 | |
| 4866 <para>To make an external olink active for HTML | |
| 4867 outputs, the link text is wrapped in an <tag>a</tag> | |
| 4868 element with an <tag>href</tag> attribute. To | |
| 4869 make an external olink active for FO outputs, the link text is | |
| 4870 wrapped in an <tag>fo:basic-link</tag> element with an | |
| 4871 <tag>external-destination</tag> attribute.</para> | |
| 4872 | |
| 4873 <para>This parameter is useful when you need external olinks | |
| 4874 to resolve but not be clickable. For example, if documents | |
| 4875 in a collection are available independently of each other, | |
| 4876 then having active links between them could lead to | |
| 4877 unresolved links when a given target document is missing.</para> | |
| 4878 | |
| 4879 <para>The epub stylesheets set this parameter to zero by default | |
| 4880 because there is no standard linking mechanism between Epub documents.</para> | |
| 4881 | |
| 4882 <para>If external links are made inactive, you should | |
| 4883 consider setting the | |
| 4884 stylesheet parameter <parameter>olink.doctitle</parameter> | |
| 4885 to <literal>yes</literal>. That will append the external document's | |
| 4886 title to the link text, making it easier for the user to | |
| 4887 locate the other document.</para> | |
| 4888 | |
| 4889 <para>An olink is considered external when the | |
| 4890 <parameter>current.docid</parameter> stylesheet parameter | |
| 4891 is set to some value, and the olink's <tag>targetdoc</tag> | |
| 4892 attribute has a different value. If the two values | |
| 4893 match, then the link is considered internal. If the | |
| 4894 <parameter>current.docid</parameter> parameter is blank, or | |
| 4895 the <tag>olink</tag> element does not have a <tag>targetdoc</tag> attribute, | |
| 4896 then the link is considered to be internal and will become | |
| 4897 an active link.</para> | |
| 4898 | |
| 4899 <para>See also <parameter>olink.doctitle</parameter>, | |
| 4900 <parameter>prefer.internal.olink</parameter>.</para> | |
| 4901 | |
| 4902 </refsection> | |
| 4903 </refentry> | |
| 4904 | |
| 4905 <refentry version="5.0" xml:id="olink.debug"> | |
| 4906 <refmeta> | |
| 4907 <refentrytitle>olink.debug</refentrytitle> | |
| 4908 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 4909 </refmeta> | |
| 4910 <refnamediv> | |
| 4911 <refname>olink.debug</refname> | |
| 4912 <refpurpose>Turn on debugging messages for olinks</refpurpose> | |
| 4913 </refnamediv> | |
| 4914 | |
| 4915 <refsynopsisdiv> | |
| 4916 <programlisting xml:id="olink.debug.frag"> | |
| 4917 <xsl:param name="olink.debug" select="0"></xsl:param> | |
| 4918 </programlisting> | |
| 4919 </refsynopsisdiv> | |
| 4920 | |
| 4921 <refsection><info><title>Description</title></info> | |
| 4922 | |
| 4923 <para>If non-zero, then each olink will generate several | |
| 4924 messages about how it is being resolved during processing. | |
| 4925 This is useful when an olink does not resolve properly | |
| 4926 and the standard error messages are not sufficient to | |
| 4927 find the problem. | |
| 4928 </para> | |
| 4929 | |
| 4930 <para>You may need to read through the olink XSL templates | |
| 4931 to understand the context for some of the debug messages. | |
| 4932 </para> | |
| 4933 | |
| 4934 </refsection> | |
| 4935 </refentry> | |
| 4936 | |
| 4937 <refentry version="5.0" xml:id="olink.properties"> | |
| 4938 <refmeta> | |
| 4939 <refentrytitle>olink.properties</refentrytitle> | |
| 4940 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> | |
| 4941 </refmeta> | |
| 4942 <refnamediv> | |
| 4943 <refname>olink.properties</refname> | |
| 4944 <refpurpose>Properties associated with the cross-reference | |
| 4945 text of an olink.</refpurpose> | |
| 4946 </refnamediv> | |
| 4947 | |
| 4948 <refsynopsisdiv> | |
| 4949 <programlisting xml:id="olink.properties.frag"> | |
| 4950 <xsl:attribute-set name="olink.properties"> | |
| 4951 <xsl:attribute name="show-destination">replace</xsl:attribute> | |
| 4952 </xsl:attribute-set> | |
| 4953 </programlisting> | |
| 4954 </refsynopsisdiv> | |
| 4955 | |
| 4956 <refsection><info><title>Description</title></info> | |
| 4957 | |
| 4958 <para>This <literal>attribute set</literal> is applied to the | |
| 4959 <literal>fo:basic-link</literal> element of an olink. It is not applied to the | |
| 4960 optional page number or optional title of the external | |
| 4961 document.</para> | |
| 4962 | |
| 4963 </refsection> | |
| 4964 </refentry> | |
| 4965 | |
| 4966 <refentry version="5.0" xml:id="olink.lang.fallback.sequence"> | |
| 4967 <refmeta> | |
| 4968 <refentrytitle>olink.lang.fallback.sequence</refentrytitle> | |
| 4969 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 4970 </refmeta> | |
| 4971 <refnamediv> | |
| 4972 <refname>olink.lang.fallback.sequence</refname> | |
| 4973 <refpurpose>look up translated documents if olink not found?</refpurpose> | |
| 4974 | |
| 4975 </refnamediv> | |
| 4976 <refsynopsisdiv> <programlisting xml:id="olink.lang.fallback.sequence.frag"> | |
| 4977 <xsl:param name="olink.lang.fallback.sequence"></xsl:param> | |
| 4978 </programlisting> | |
| 4979 </refsynopsisdiv> | |
| 4980 <refsection><info><title>Description</title></info> | |
| 4981 | |
| 4982 | |
| 4983 <para>This parameter defines a list of lang values | |
| 4984 to search among to resolve olinks. | |
| 4985 </para> | |
| 4986 | |
| 4987 <para>Normally an olink tries to resolve to a document in the same | |
| 4988 language as the olink itself. The language of an olink | |
| 4989 is determined by its nearest ancestor element with a | |
| 4990 <tag class="attribute">lang</tag> attribute, otherwise the | |
| 4991 value of the <parameter>l10n.gentext.default.lang</parameter> | |
| 4992 parameter. | |
| 4993 </para> | |
| 4994 | |
| 4995 <para>An olink database can contain target data for the same | |
| 4996 document in multiple languages. Each set of data has the | |
| 4997 same value for the <tag>targetdoc</tag> attribute in | |
| 4998 the <tag>document</tag> element in the database, but with a | |
| 4999 different <tag>lang</tag> attribute value. | |
| 5000 </para> | |
| 5001 | |
| 5002 <para>When an olink is being resolved, the target is first | |
| 5003 sought in the document with the same language as the olink. | |
| 5004 If no match is found there, then this parameter is consulted | |
| 5005 for additional languages to try.</para> | |
| 5006 | |
| 5007 <para>The <parameter>olink.lang.fallback.sequence</parameter> | |
| 5008 must be a whitespace separated list of lang values to | |
| 5009 try. The first one with a match in the olink database is used. | |
| 5010 The default value is empty.</para> | |
| 5011 | |
| 5012 <para>For example, a document might be written in German | |
| 5013 and contain an olink with | |
| 5014 <literal>targetdoc="adminguide"</literal>. | |
| 5015 When the document is processed, the processor | |
| 5016 first looks for a target dataset in the | |
| 5017 olink database starting with:</para> | |
| 5018 | |
| 5019 <literallayout><literal><document targetdoc="adminguide" lang="de"></liter
al>. | |
| 5020 </literallayout> | |
| 5021 | |
| 5022 <para>If there is no such element, then the | |
| 5023 <parameter>olink.lang.fallback.sequence</parameter> | |
| 5024 parameter is consulted. | |
| 5025 If its value is, for example, <quote>fr en</quote>, then the processor next | |
| 5026 looks for <literal>targetdoc="adminguide" lang="fr"</literal>, and | |
| 5027 then for <literal>targetdoc="adminguide" lang="en"</literal>. | |
| 5028 If there is still no match, it looks for | |
| 5029 <literal>targetdoc="adminguide"</literal> with no | |
| 5030 lang attribute. | |
| 5031 </para> | |
| 5032 | |
| 5033 <para>This parameter is useful when a set of documents is only | |
| 5034 partially translated, or is in the process of being translated. | |
| 5035 If a target of an olink has not yet been translated, then this | |
| 5036 parameter permits the processor to look for the document in | |
| 5037 other languages. This assumes the reader would rather have | |
| 5038 a link to a document in a different language than to have | |
| 5039 a broken link. | |
| 5040 </para> | |
| 5041 | |
| 5042 </refsection> | |
| 5043 </refentry> | |
| 5044 | |
| 5045 <refentry version="5.0" xml:id="insert.olink.page.number"> | |
| 5046 <refmeta> | |
| 5047 <refentrytitle>insert.olink.page.number</refentrytitle> | |
| 5048 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> | |
| 5049 <refmiscinfo class="other" otherclass="value">no</refmiscinfo> | |
| 5050 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo> | |
| 5051 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo> | |
| 5052 </refmeta> | |
| 5053 <refnamediv> | |
| 5054 <refname>insert.olink.page.number</refname> | |
| 5055 <refpurpose>Turns page numbers in olinks on and off</refpurpose> | |
| 5056 </refnamediv> | |
| 5057 | |
| 5058 <refsynopsisdiv> | |
| 5059 <programlisting xml:id="insert.olink.page.number.frag"> | |
| 5060 <xsl:param name="insert.olink.page.number">no</xsl:param> | |
| 5061 </programlisting> | |
| 5062 </refsynopsisdiv> | |
| 5063 | |
| 5064 <refsection><info><title>Description</title></info> | |
| 5065 | |
| 5066 <para>The value of this parameter determines if | |
| 5067 cross references made between documents with | |
| 5068 <tag>olink</tag> will | |
| 5069 include page number citations. | |
| 5070 In most cases this is only applicable to references in printed output. | |
| 5071 </para> | |
| 5072 <para>The parameter has three possible values. | |
| 5073 </para> | |
| 5074 <variablelist> | |
| 5075 <varlistentry> | |
| 5076 <term>no</term> | |
| 5077 <listitem><para>No page number references will be generated for olinks. | |
| 5078 </para></listitem> | |
| 5079 </varlistentry> | |
| 5080 <varlistentry> | |
| 5081 <term>yes</term> | |
| 5082 <listitem><para>Page number references will be generated | |
| 5083 for all <tag>olink</tag> references. | |
| 5084 The style of page reference may be changed | |
| 5085 if an <tag class="attribute">xrefstyle</tag> | |
| 5086 attribute is used. | |
| 5087 </para></listitem> | |
| 5088 </varlistentry> | |
| 5089 <varlistentry> | |
| 5090 <term>maybe</term> | |
| 5091 <listitem><para>Page number references will not be generated | |
| 5092 for an <tag>olink</tag> element unless | |
| 5093 it has an | |
| 5094 <tag class="attribute">xrefstyle</tag> | |
| 5095 attribute whose value specifies a page reference. | |
| 5096 </para></listitem> | |
| 5097 </varlistentry> | |
| 5098 </variablelist> | |
| 5099 <para>Olinks that point to targets within the same document | |
| 5100 are treated as <tag>xref</tag>s, and controlled by | |
| 5101 the <parameter>insert.xref.page.number</parameter> parameter. | |
| 5102 </para> | |
| 5103 | |
| 5104 <para>Page number references for olinks to | |
| 5105 external documents can only be inserted if the | |
| 5106 information exists in the olink database. | |
| 5107 This means each olink target element | |
| 5108 (<tag>div</tag> or <tag>obj</tag>) | |
| 5109 must have a <tag class="attribute">page</tag> attribute | |
| 5110 whose value is its page number in the target document. | |
| 5111 The XSL stylesheets are not able to extract that information | |
| 5112 during processing because pages have not yet been created in | |
| 5113 XSLT transformation. Only the XSL-FO processor knows what | |
| 5114 page each element is placed on. | |
| 5115 Therefore some postprocessing must take place to populate | |
| 5116 page numbers in the olink database. | |
| 5117 </para> | |
| 5118 | |
| 5119 | |
| 5120 | |
| 5121 </refsection> | |
| 5122 </refentry> | |
| 5123 | |
| 5124 <refentry version="5.0" xml:id="insert.olink.pdf.frag"> | |
| 5125 <refmeta> | |
| 5126 <refentrytitle>insert.olink.pdf.frag</refentrytitle> | |
| 5127 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 5128 </refmeta> | |
| 5129 <refnamediv> | |
| 5130 <refname>insert.olink.pdf.frag</refname> | |
| 5131 <refpurpose>Add fragment identifiers for links into PDF files</refpurpose> | |
| 5132 </refnamediv> | |
| 5133 | |
| 5134 <refsynopsisdiv> | |
| 5135 <programlisting xml:id="insert.olink.pdf.frag.frag"> | |
| 5136 <xsl:param name="insert.olink.pdf.frag" select="0"></xsl:param> | |
| 5137 </programlisting> | |
| 5138 </refsynopsisdiv> | |
| 5139 | |
| 5140 <refsection><info><title>Description</title></info> | |
| 5141 | |
| 5142 <para>The value of this parameter determines whether | |
| 5143 the cross reference URIs to PDF documents made with | |
| 5144 <tag>olink</tag> will | |
| 5145 include fragment identifiers. | |
| 5146 </para> | |
| 5147 | |
| 5148 <para>When forming a URI to link to a PDF document, | |
| 5149 a fragment identifier (typically a '#' followed by an | |
| 5150 id value) appended to the PDF filename can be used by | |
| 5151 the PDF viewer to open | |
| 5152 the PDF file to a location within the document instead of | |
| 5153 the first page. | |
| 5154 However, not all PDF files have id | |
| 5155 values embedded in them, and not all PDF viewers can | |
| 5156 handle fragment identifiers. | |
| 5157 </para> | |
| 5158 | |
| 5159 <para>If <parameter>insert.olink.pdf.frag</parameter> is set | |
| 5160 to a non-zero value, then any olink targeting a | |
| 5161 PDF file will have the fragment identifier appended to the URI. | |
| 5162 The URI is formed by concatenating the value of the | |
| 5163 <parameter>olink.base.uri</parameter> parameter, the | |
| 5164 value of the <tag class="attribute">baseuri</tag> | |
| 5165 attribute from the <tag class="element">document</tag> | |
| 5166 element in the olink database with the matching | |
| 5167 <tag class="attribute">targetdoc</tag> value, | |
| 5168 and the value of the <tag class="attribute">href</tag> | |
| 5169 attribute for the targeted element in the olink database. | |
| 5170 The <tag class="attribute">href</tag> attribute | |
| 5171 contains the fragment identifier. | |
| 5172 </para> | |
| 5173 | |
| 5174 <para>If <parameter>insert.olink.pdf.frag</parameter> is set | |
| 5175 to zero (the default value), then | |
| 5176 the <tag class="attribute">href</tag> attribute | |
| 5177 from the olink database | |
| 5178 is not appended to PDF olinks, so the fragment identifier is left off. | |
| 5179 A PDF olink is any olink for which the | |
| 5180 <tag class="attribute">baseuri</tag> attribute | |
| 5181 from the matching <tag class="element">document</tag> | |
| 5182 element in the olink database ends with '.pdf'. | |
| 5183 Any other olinks will still have the fragment identifier added. | |
| 5184 </para> | |
| 5185 </refsection> | |
| 5186 </refentry> | |
| 5187 | |
| 5188 <refentry version="5.0" xml:id="prefer.internal.olink"> | |
| 5189 <refmeta> | |
| 5190 <refentrytitle>prefer.internal.olink</refentrytitle> | |
| 5191 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 5192 </refmeta> | |
| 5193 <refnamediv> | |
| 5194 <refname>prefer.internal.olink</refname> | |
| 5195 <refpurpose>Prefer a local olink reference to an external reference</refpurpose> | |
| 5196 </refnamediv> | |
| 5197 | |
| 5198 <refsynopsisdiv> | |
| 5199 <programlisting xml:id="prefer.internal.olink.frag"> | |
| 5200 <xsl:param name="prefer.internal.olink" select="0"></xsl:param> | |
| 5201 </programlisting> | |
| 5202 </refsynopsisdiv> | |
| 5203 | |
| 5204 <refsection><info><title>Description</title></info> | |
| 5205 | |
| 5206 <para>If you are re-using XML content modules in multiple documents, | |
| 5207 you may want to redirect some of your olinks. This parameter | |
| 5208 permits you to redirect an olink to the current document. | |
| 5209 </para> | |
| 5210 | |
| 5211 <para>For example: you are writing documentation for a product, | |
| 5212 which includes 3 manuals: a little installation | |
| 5213 booklet (booklet.xml), a user | |
| 5214 guide (user.xml), and a reference manual (reference.xml). | |
| 5215 All 3 documents begin with the same introduction section (intro.xml) that | |
| 5216 contains a reference to the customization section (custom.xml) which is | |
| 5217 included in both user.xml and reference.xml documents. | |
| 5218 </para> | |
| 5219 | |
| 5220 <para>How do you write the link to custom.xml in intro.xml | |
| 5221 so that it is interpreted correctly in all 3 documents?</para> | |
| 5222 <itemizedlist> | |
| 5223 <listitem><para>If you use xref, it will fail in user.xml.</para> | |
| 5224 </listitem> | |
| 5225 <listitem><para>If you use olink (pointing to reference.xml), | |
| 5226 the reference in user.xml | |
| 5227 will point to the customization section of the reference manual, while it is | |
| 5228 actually available in user.xml.</para> | |
| 5229 </listitem> | |
| 5230 </itemizedlist> | |
| 5231 | |
| 5232 <para>If you set the <parameter>prefer.internal.olink</parameter> | |
| 5233 parameter to a non-zero value, then the processor will | |
| 5234 first look in the olink database | |
| 5235 for the olink's <tag>targetptr</tag> attribute value | |
| 5236 in document matching the <parameter>current.docid</parameter> | |
| 5237 parameter value. If it isn't found there, then | |
| 5238 it tries the document in the database | |
| 5239 with the <tag>targetdoc</tag> | |
| 5240 value that matches the olink's <tag>targetdoc</tag> | |
| 5241 attribute. | |
| 5242 </para> | |
| 5243 | |
| 5244 <para>This feature permits an olink reference to resolve to | |
| 5245 the current document if there is an element | |
| 5246 with an id matching the olink's <tag>targetptr</tag> | |
| 5247 value. The current document's olink data must be | |
| 5248 included in the target database for this to work.</para> | |
| 5249 | |
| 5250 <caution> | |
| 5251 <para>There is a potential for incorrect links if | |
| 5252 the same <tag>id</tag> attribute value is used for different | |
| 5253 content in different documents. | |
| 5254 Some of your olinks may be redirected to the current document | |
| 5255 when they shouldn't be. It is not possible to control | |
| 5256 individual olink instances.</para> | |
| 5257 </caution> | |
| 5258 | |
| 5259 </refsection> | |
| 5260 </refentry> | |
| 5261 | |
| 5262 <refentry version="5.0" xml:id="link.mailto.url"> | |
| 5263 <refmeta> | |
| 5264 <refentrytitle>link.mailto.url</refentrytitle> | |
| 5265 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 5266 </refmeta> | |
| 5267 <refnamediv> | |
| 5268 <refname>link.mailto.url</refname> | |
| 5269 <refpurpose>Mailto URL for the LINK REL=made HTML HEAD element</refpurpose> | |
| 5270 </refnamediv> | |
| 5271 | |
| 5272 <refsynopsisdiv> | |
| 5273 <programlisting xml:id="link.mailto.url.frag"> | |
| 5274 <xsl:param name="link.mailto.url"></xsl:param> | |
| 5275 </programlisting> | |
| 5276 </refsynopsisdiv> | |
| 5277 | |
| 5278 <refsection><info><title>Description</title></info> | |
| 5279 | |
| 5280 <para>If not the empty string, this address will be used for the | |
| 5281 rel=made <literal>link</literal> element in the html <literal>head</literal> | |
| 5282 </para> | |
| 5283 | |
| 5284 </refsection> | |
| 5285 </refentry> | |
| 5286 | |
| 5287 <refentry version="5.0" xml:id="ulink.target"> | |
| 5288 <refmeta> | |
| 5289 <refentrytitle>ulink.target</refentrytitle> | |
| 5290 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 5291 </refmeta> | |
| 5292 <refnamediv> | |
| 5293 <refname>ulink.target</refname> | |
| 5294 <refpurpose>The HTML anchor target for ULinks</refpurpose> | |
| 5295 </refnamediv> | |
| 5296 | |
| 5297 <refsynopsisdiv> | |
| 5298 <programlisting xml:id="ulink.target.frag"> | |
| 5299 <xsl:param name="ulink.target">_top</xsl:param> | |
| 5300 </programlisting> | |
| 5301 </refsynopsisdiv> | |
| 5302 | |
| 5303 <refsection><info><title>Description</title></info> | |
| 5304 | |
| 5305 <para>If <parameter>ulink.target</parameter> is non-zero, its value will | |
| 5306 be used for the <literal>target</literal> attribute | |
| 5307 on anchors generated for <tag>ulink</tag>s.</para> | |
| 5308 | |
| 5309 </refsection> | |
| 5310 </refentry> | |
| 5311 | |
| 5312 </reference> | |
| 5313 <reference xml:id="xrefs"><title>Cross References</title> | |
| 5314 <refentry version="5.0" xml:id="collect.xref.targets"> | |
| 5315 <refmeta> | |
| 5316 <refentrytitle>collect.xref.targets</refentrytitle> | |
| 5317 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> | |
| 5318 <refmiscinfo class="other" otherclass="value">no</refmiscinfo> | |
| 5319 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo> | |
| 5320 <refmiscinfo class="other" otherclass="value">only</refmiscinfo> | |
| 5321 </refmeta> | |
| 5322 <refnamediv> | |
| 5323 <refname>collect.xref.targets</refname> | |
| 5324 <refpurpose>Controls whether cross reference data is | |
| 5325 collected</refpurpose> | |
| 5326 </refnamediv> | |
| 5327 <refsynopsisdiv> <programlisting xml:id="collect.xref.targets.frag"> | |
| 5328 <xsl:param name="collect.xref.targets">no</xsl:param> | |
| 5329 </programlisting> | |
| 5330 </refsynopsisdiv> | |
| 5331 <refsection><info><title>Description</title></info> | |
| 5332 | |
| 5333 <para> | |
| 5334 In order to resolve olinks efficiently, the stylesheets can | |
| 5335 generate an external data file containing information about | |
| 5336 all potential cross reference endpoints in a document. | |
| 5337 This parameter determines whether the collection process is run when the documen
t is processed by the stylesheet. The default value is <literal>no</literal>, w
hich means the data file is not generated during processing. The other choices a
re <literal>yes</literal>, which means the data file is created and the document
is processed for output, and <literal>only</literal>, which means the data file
is created but the document is not processed for output. | |
| 5338 See also <parameter>targets.filename</parameter>. | |
| 5339 </para> | |
| 5340 </refsection> | |
| 5341 </refentry> | |
| 5342 | |
| 5343 <refentry version="5.0" xml:id="insert.xref.page.number"> | |
| 5344 <refmeta> | |
| 5345 <refentrytitle>insert.xref.page.number</refentrytitle> | |
| 5346 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> | |
| 5347 <refmiscinfo class="other" otherclass="value">no</refmiscinfo> | |
| 5348 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo> | |
| 5349 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo> | |
| 5350 </refmeta> | |
| 5351 <refnamediv> | |
| 5352 <refname>insert.xref.page.number</refname> | |
| 5353 <refpurpose>Turns page numbers in xrefs on and off</refpurpose> | |
| 5354 </refnamediv> | |
| 5355 | |
| 5356 <refsynopsisdiv> | |
| 5357 <programlisting xml:id="insert.xref.page.number.frag"> | |
| 5358 <xsl:param name="insert.xref.page.number">no</xsl:param> | |
| 5359 </programlisting> | |
| 5360 </refsynopsisdiv> | |
| 5361 | |
| 5362 <refsection><info><title>Description</title></info> | |
| 5363 | |
| 5364 <para>The value of this parameter determines if | |
| 5365 cross references (<tag>xref</tag>s) in | |
| 5366 printed output will | |
| 5367 include page number citations. | |
| 5368 It has three possible values. | |
| 5369 </para> | |
| 5370 <variablelist> | |
| 5371 <varlistentry> | |
| 5372 <term>no</term> | |
| 5373 <listitem><para>No page number references will be generated. | |
| 5374 </para></listitem> | |
| 5375 </varlistentry> | |
| 5376 <varlistentry> | |
| 5377 <term>yes</term> | |
| 5378 <listitem><para>Page number references will be generated | |
| 5379 for all <tag>xref</tag> elements. | |
| 5380 The style of page reference may be changed | |
| 5381 if an <tag class="attribute">xrefstyle</tag> | |
| 5382 attribute is used. | |
| 5383 </para></listitem> | |
| 5384 </varlistentry> | |
| 5385 <varlistentry> | |
| 5386 <term>maybe</term> | |
| 5387 <listitem><para>Page number references will not be generated | |
| 5388 for an <tag>xref</tag> element unless | |
| 5389 it has an | |
| 5390 <tag class="attribute">xrefstyle</tag> | |
| 5391 attribute whose value specifies a page reference. | |
| 5392 </para></listitem> | |
| 5393 </varlistentry> | |
| 5394 </variablelist> | |
| 5395 | |
| 5396 </refsection> | |
| 5397 </refentry> | |
| 5398 | |
| 5399 <refentry version="5.0" xml:id="use.role.as.xrefstyle"> | |
| 5400 <refmeta> | |
| 5401 <refentrytitle>use.role.as.xrefstyle</refentrytitle> | |
| 5402 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 5403 </refmeta> | |
| 5404 <refnamediv> | |
| 5405 <refname>use.role.as.xrefstyle</refname> | |
| 5406 <refpurpose>Use <tag class="attribute">role</tag> attribute for | |
| 5407 <tag class="attribute">xrefstyle</tag> on <tag>xref</tag>?</refpurpose> | |
| 5408 </refnamediv> | |
| 5409 | |
| 5410 <refsynopsisdiv> | |
| 5411 <programlisting xml:id="use.role.as.xrefstyle.frag"> | |
| 5412 <xsl:param name="use.role.as.xrefstyle" select="1"></xsl:param> | |
| 5413 </programlisting> | |
| 5414 </refsynopsisdiv> | |
| 5415 | |
| 5416 <refsection><info><title>Description</title></info> | |
| 5417 | |
| 5418 <para>In DocBook documents that conform to a schema older than V4.3, this parame
ter allows | |
| 5419 <tag class="attribute">role</tag> to serve the purpose of specifying the cross r
eference style.</para> | |
| 5420 | |
| 5421 <para>If non-zero, the <tag class="attribute">role</tag> attribute on | |
| 5422 <tag>xref</tag> will be used to select the cross reference style. | |
| 5423 In DocBook V4.3, the <tag class="attribute">xrefstyle</tag> attribute was added
for this purpose. | |
| 5424 If the <tag class="attribute">xrefstyle</tag> attribute is present, | |
| 5425 <tag class="attribute">role</tag> will be ignored, regardless of the setting | |
| 5426 of this parameter.</para> | |
| 5427 | |
| 5428 </refsection> | |
| 5429 | |
| 5430 <refsection><info><title>Example</title></info> | |
| 5431 | |
| 5432 <para>The following small stylesheet shows how to configure the | |
| 5433 stylesheets to make use of the cross reference style:</para> | |
| 5434 | |
| 5435 <programlisting><?xml version="1.0"?> | |
| 5436 <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" | |
| 5437 version="1.0"> | |
| 5438 | |
| 5439 <xsl:import href="../xsl/html/docbook.xsl"/> | |
| 5440 | |
| 5441 <xsl:output method="html"/> | |
| 5442 | |
| 5443 <xsl:param name="local.l10n.xml" select="document('')"/> | |
| 5444 <l:i18n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0"> | |
| 5445 <l:l10n xmlns:l="http://docbook.sourceforge.net/xmlns/l10n/1.0" language="e
n"> | |
| 5446 <l:context name="xref"> | |
| 5447 <l:template name="chapter" style="title" text="Chapter %n, %t"/> | |
| 5448 <l:template name="chapter" text="Chapter %n"/> | |
| 5449 </l:context> | |
| 5450 </l:l10n> | |
| 5451 </l:i18n> | |
| 5452 | |
| 5453 </xsl:stylesheet></programlisting> | |
| 5454 | |
| 5455 <para>With this stylesheet, the cross references in the following document:</par
a> | |
| 5456 | |
| 5457 <programlisting><?xml version="1.0" encoding="utf-8"?> | |
| 5458 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | |
| 5459 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | |
| 5460 <book id="book"><title>Book</title> | |
| 5461 | |
| 5462 <preface> | |
| 5463 <title>Preface</title> | |
| 5464 | |
| 5465 <para>Normal: <xref linkend="ch1"/>.</para> | |
| 5466 <para>Title: <xref xrefstyle="title" linkend="ch1"/>.</para> | |
| 5467 | |
| 5468 </preface> | |
| 5469 | |
| 5470 <chapter id="ch1"> | |
| 5471 <title>First Chapter</title> | |
| 5472 | |
| 5473 <para>Irrelevant.</para> | |
| 5474 | |
| 5475 </chapter> | |
| 5476 </book></programlisting> | |
| 5477 | |
| 5478 <para>will appear as:</para> | |
| 5479 | |
| 5480 <informalexample> | |
| 5481 <para>Normal: Chapter 1.</para> | |
| 5482 <para>Title: Chapter 1, <emphasis>First Chapter</emphasis>.</para> | |
| 5483 </informalexample> | |
| 5484 </refsection> | |
| 5485 | |
| 5486 </refentry> | |
| 5487 | |
| 5488 <refentry version="5.0" xml:id="xref.with.number.and.title"> | |
| 5489 <refmeta> | |
| 5490 <refentrytitle>xref.with.number.and.title</refentrytitle> | |
| 5491 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 5492 </refmeta> | |
| 5493 <refnamediv> | |
| 5494 <refname>xref.with.number.and.title</refname> | |
| 5495 <refpurpose>Use number and title in cross references</refpurpose> | |
| 5496 </refnamediv> | |
| 5497 | |
| 5498 <refsynopsisdiv> | |
| 5499 <programlisting xml:id="xref.with.number.and.title.frag"> | |
| 5500 <xsl:param name="xref.with.number.and.title" select="1"></xsl:param> | |
| 5501 </programlisting> | |
| 5502 </refsynopsisdiv> | |
| 5503 | |
| 5504 <refsection><info><title>Description</title></info> | |
| 5505 | |
| 5506 <para>A cross reference may include the number (for example, the number of | |
| 5507 an example or figure) and the <tag>title</tag> which is a required child of some | |
| 5508 targets. This parameter inserts both the relevant number as well as | |
| 5509 the title into the link. </para> | |
| 5510 | |
| 5511 </refsection> | |
| 5512 </refentry> | |
| 5513 | |
| 5514 <refentry version="5.0" xml:id="xref.label-page.separator"> | |
| 5515 <refmeta> | |
| 5516 <refentrytitle>xref.label-page.separator</refentrytitle> | |
| 5517 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 5518 </refmeta> | |
| 5519 <refnamediv> | |
| 5520 <refname>xref.label-page.separator</refname> | |
| 5521 <refpurpose>Punctuation or space separating label from page number in xref</refp
urpose> | |
| 5522 </refnamediv> | |
| 5523 | |
| 5524 <refsynopsisdiv> | |
| 5525 <programlisting xml:id="xref.label-page.separator.frag"><xsl:param name="xref
.label-page.separator"><xsl:text> </xsl:text></xsl:param></
programlisting> | |
| 5526 </refsynopsisdiv> | |
| 5527 | |
| 5528 <refsection><info><title>Description</title></info> | |
| 5529 | |
| 5530 <para> | |
| 5531 This parameter allows you to control the punctuation of certain | |
| 5532 types of generated cross reference text. | |
| 5533 When cross reference text is generated for an | |
| 5534 <tag class="element">xref</tag> or | |
| 5535 <tag class="element">olink</tag> element | |
| 5536 using an <tag class="attribute">xrefstyle</tag> attribute | |
| 5537 that makes use of the <literal>select:</literal> feature, | |
| 5538 and the selected components include both label and page | |
| 5539 but no title, | |
| 5540 then the value of this parameter is inserted between | |
| 5541 label and page number in the output. | |
| 5542 If a title is included, then other separators are used. | |
| 5543 </para> | |
| 5544 | |
| 5545 </refsection> | |
| 5546 </refentry> | |
| 5547 | |
| 5548 <refentry version="5.0" xml:id="xref.label-title.separator"> | |
| 5549 <refmeta> | |
| 5550 <refentrytitle>xref.label-title.separator</refentrytitle> | |
| 5551 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 5552 </refmeta> | |
| 5553 <refnamediv> | |
| 5554 <refname>xref.label-title.separator</refname> | |
| 5555 <refpurpose>Punctuation or space separating label from title in xref</refpurpose
> | |
| 5556 </refnamediv> | |
| 5557 | |
| 5558 <refsynopsisdiv> | |
| 5559 <programlisting xml:id="xref.label-title.separator.frag"><xsl:param name="xre
f.label-title.separator">: </xsl:param></programlisting> | |
| 5560 </refsynopsisdiv> | |
| 5561 | |
| 5562 <refsection><info><title>Description</title></info> | |
| 5563 | |
| 5564 <para> | |
| 5565 This parameter allows you to control the punctuation of certain | |
| 5566 types of generated cross reference text. | |
| 5567 When cross reference text is generated for an | |
| 5568 <tag class="element">xref</tag> or | |
| 5569 <tag class="element">olink</tag> element | |
| 5570 using an <tag class="attribute">xrefstyle</tag> attribute | |
| 5571 that makes use of the <literal>select:</literal> feature, | |
| 5572 and the selected components include both label and title, | |
| 5573 then the value of this parameter is inserted between | |
| 5574 label and title in the output. | |
| 5575 </para> | |
| 5576 | |
| 5577 </refsection> | |
| 5578 </refentry> | |
| 5579 | |
| 5580 <refentry version="5.0" xml:id="xref.title-page.separator"> | |
| 5581 <refmeta> | |
| 5582 <refentrytitle>xref.title-page.separator</refentrytitle> | |
| 5583 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 5584 </refmeta> | |
| 5585 <refnamediv> | |
| 5586 <refname>xref.title-page.separator</refname> | |
| 5587 <refpurpose>Punctuation or space separating title from page number in xref</refp
urpose> | |
| 5588 </refnamediv> | |
| 5589 | |
| 5590 <refsynopsisdiv> | |
| 5591 <programlisting xml:id="xref.title-page.separator.frag"><xsl:param name="xref
.title-page.separator"><xsl:text> </xsl:text></xsl:param></
programlisting> | |
| 5592 </refsynopsisdiv> | |
| 5593 | |
| 5594 <refsection><info><title>Description</title></info> | |
| 5595 | |
| 5596 <para> | |
| 5597 This parameter allows you to control the punctuation of certain | |
| 5598 types of generated cross reference text. | |
| 5599 When cross reference text is generated for an | |
| 5600 <tag class="element">xref</tag> or | |
| 5601 <tag class="element">olink</tag> element | |
| 5602 using an <tag class="attribute">xrefstyle</tag> attribute | |
| 5603 that makes use of the <literal>select:</literal> feature, | |
| 5604 and the selected components include both title and page number, | |
| 5605 then the value of this parameter is inserted between | |
| 5606 title and page number in the output. | |
| 5607 </para> | |
| 5608 | |
| 5609 </refsection> | |
| 5610 </refentry> | |
| 5611 | |
| 5612 </reference> | |
| 5613 <reference xml:id="lists"><title>Lists</title> | |
| 5614 <refentry version="5.0" xml:id="segmentedlist.as.table"> | |
| 5615 <refmeta> | |
| 5616 <refentrytitle>segmentedlist.as.table</refentrytitle> | |
| 5617 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 5618 </refmeta> | |
| 5619 <refnamediv> | |
| 5620 <refname>segmentedlist.as.table</refname> | |
| 5621 <refpurpose>Format segmented lists as tables?</refpurpose> | |
| 5622 </refnamediv> | |
| 5623 | |
| 5624 <refsynopsisdiv> | |
| 5625 <programlisting xml:id="segmentedlist.as.table.frag"> | |
| 5626 <xsl:param name="segmentedlist.as.table" select="0"></xsl:param> | |
| 5627 </programlisting> | |
| 5628 </refsynopsisdiv> | |
| 5629 | |
| 5630 <refsection><info><title>Description</title></info> | |
| 5631 | |
| 5632 <para>If non-zero, <tag>segmentedlist</tag>s will be formatted as | |
| 5633 tables.</para> | |
| 5634 | |
| 5635 </refsection> | |
| 5636 </refentry> | |
| 5637 | |
| 5638 <refentry version="5.0" xml:id="variablelist.as.table"> | |
| 5639 <refmeta> | |
| 5640 <refentrytitle>variablelist.as.table</refentrytitle> | |
| 5641 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 5642 </refmeta> | |
| 5643 <refnamediv> | |
| 5644 <refname>variablelist.as.table</refname> | |
| 5645 <refpurpose>Format <tag>variablelist</tag>s as tables?</refpurpose> | |
| 5646 </refnamediv> | |
| 5647 | |
| 5648 <refsynopsisdiv> | |
| 5649 <programlisting xml:id="variablelist.as.table.frag"> | |
| 5650 <xsl:param name="variablelist.as.table" select="0"></xsl:param> | |
| 5651 </programlisting> | |
| 5652 </refsynopsisdiv> | |
| 5653 | |
| 5654 <refsection><info><title>Description</title></info> | |
| 5655 | |
| 5656 <para>If non-zero, <tag>variablelist</tag>s will be formatted as | |
| 5657 tables. A processing instruction exists to specify a particular width for the | |
| 5658 column containing the <tag>term</tag>s: | |
| 5659 <tag class="xmlpi">dbhtml term-width=".25in"</tag></para> | |
| 5660 | |
| 5661 <para>You can override this setting with a processing instruction as the | |
| 5662 child of <tag>variablelist</tag>: <tag class="xmlpi">dbhtml | |
| 5663 list-presentation="table"</tag> or <tag class="xmlpi">dbhtml | |
| 5664 list-presentation="list"</tag>.</para> | |
| 5665 | |
| 5666 <para>This parameter only applies to the HTML transformations. In the | |
| 5667 FO case, proper list markup is robust enough to handle the formatting. | |
| 5668 But see also <parameter>variablelist.as.blocks</parameter>.</para> | |
| 5669 | |
| 5670 <programlisting> <variablelist> | |
| 5671 <?dbhtml list-presentation="table"?> | |
| 5672 <?dbhtml term-width="1.5in"?> | |
| 5673 <?dbfo list-presentation="list"?> | |
| 5674 <?dbfo term-width="1in"?> | |
| 5675 <varlistentry> | |
| 5676 <term>list</term> | |
| 5677 <listitem> | |
| 5678 <para> | |
| 5679 Formatted as a table even if variablelist.as.table is set to 0
. | |
| 5680 </para> | |
| 5681 </listitem> | |
| 5682 </varlistentry> | |
| 5683 </variablelist></programlisting> | |
| 5684 | |
| 5685 </refsection> | |
| 5686 </refentry> | |
| 5687 | |
| 5688 <refentry version="5.0" xml:id="variablelist.term.separator"> | |
| 5689 <refmeta> | |
| 5690 <refentrytitle>variablelist.term.separator</refentrytitle> | |
| 5691 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 5692 </refmeta> | |
| 5693 <refnamediv> | |
| 5694 <refname>variablelist.term.separator</refname> | |
| 5695 <refpurpose>Text to separate <tag>term</tag>s within a multi-term | |
| 5696 <tag>varlistentry</tag></refpurpose> | |
| 5697 </refnamediv> | |
| 5698 | |
| 5699 <refsynopsisdiv> | |
| 5700 <programlisting xml:id="variablelist.term.separator.frag"> | |
| 5701 <xsl:param name="variablelist.term.separator">, </xsl:param></progra
mlisting> | |
| 5702 </refsynopsisdiv> | |
| 5703 | |
| 5704 <refsection><info><title>Description</title></info> | |
| 5705 | |
| 5706 <para>When a <tag>varlistentry</tag> contains multiple <tag>term</tag> | |
| 5707 elements, the string specified in the value of the | |
| 5708 <parameter>variablelist.term.separator</parameter> parameter is placed | |
| 5709 after each <tag>term</tag> except the last.</para> | |
| 5710 | |
| 5711 <note> | |
| 5712 <para>To generate a line break between multiple <tag>term</tag>s in | |
| 5713 a <tag>varlistentry</tag>, set a non-zero value for the | |
| 5714 <parameter>variablelist.term.break.after</parameter> parameter. If | |
| 5715 you do so, you may also want to set the value of the | |
| 5716 <parameter>variablelist.term.separator</parameter> parameter to an | |
| 5717 empty string (to suppress rendering of the default comma and space | |
| 5718 after each <tag>term</tag>).</para> | |
| 5719 </note> | |
| 5720 | |
| 5721 </refsection> | |
| 5722 </refentry> | |
| 5723 | |
| 5724 <refentry version="5.0" xml:id="variablelist.term.break.after"> | |
| 5725 <refmeta> | |
| 5726 <refentrytitle>variablelist.term.break.after</refentrytitle> | |
| 5727 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 5728 </refmeta> | |
| 5729 <refnamediv> | |
| 5730 <refname>variablelist.term.break.after</refname> | |
| 5731 <refpurpose>Generate line break after each <tag>term</tag> within a | |
| 5732 multi-term <tag>varlistentry</tag>?</refpurpose> | |
| 5733 </refnamediv> | |
| 5734 | |
| 5735 <refsynopsisdiv> | |
| 5736 <programlisting xml:id="variablelist.term.break.after.frag"> | |
| 5737 <xsl:param name="variablelist.term.break.after">0</xsl:param></progr
amlisting> | |
| 5738 </refsynopsisdiv> | |
| 5739 | |
| 5740 <refsection><info><title>Description</title></info> | |
| 5741 | |
| 5742 <para>Set a non-zero value for the | |
| 5743 <parameter>variablelist.term.break.after</parameter> parameter to | |
| 5744 generate a line break between <tag>term</tag>s in a | |
| 5745 multi-term <tag>varlistentry</tag>.</para> | |
| 5746 | |
| 5747 <note> | |
| 5748 <para>If you set a non-zero value for | |
| 5749 <parameter>variablelist.term.break.after</parameter>, you may also | |
| 5750 want to set the value of the | |
| 5751 <parameter>variablelist.term.separator</parameter> parameter to an | |
| 5752 empty string (to suppress rendering of the default comma and space | |
| 5753 after each <tag>term</tag>).</para> | |
| 5754 </note> | |
| 5755 | |
| 5756 </refsection> | |
| 5757 </refentry> | |
| 5758 | |
| 5759 </reference> | |
| 5760 <reference xml:id="biblio"><title>Bibliography</title> | |
| 5761 <refentry version="5.0" xml:id="bibliography.style"> | |
| 5762 <refmeta> | |
| 5763 <refentrytitle>bibliography.style</refentrytitle> | |
| 5764 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> | |
| 5765 <refmiscinfo class="other" otherclass="value">normal</refmiscinfo> | |
| 5766 <refmiscinfo class="other" otherclass="value">iso690</refmiscinfo> | |
| 5767 </refmeta> | |
| 5768 <refnamediv> | |
| 5769 <refname>bibliography.style</refname> | |
| 5770 <refpurpose>Style used for formatting of biblioentries.</refpurpose> | |
| 5771 </refnamediv> | |
| 5772 | |
| 5773 <refsynopsisdiv> | |
| 5774 <programlisting xml:id="bibliography.style.frag"> | |
| 5775 <xsl:param name="bibliography.style">normal</xsl:param> | |
| 5776 </programlisting> | |
| 5777 </refsynopsisdiv> | |
| 5778 | |
| 5779 <refsection><info><title>Description</title></info> | |
| 5780 | |
| 5781 <para>Currently only <literal>normal</literal> and | |
| 5782 <literal>iso690</literal> styles are supported.</para> | |
| 5783 | |
| 5784 <para>In order to use ISO690 style to the full extent you might need | |
| 5785 to use additional markup described on <link xmlns:xlink="http://www.w3.org/1999/
xlink" xlink:href="http://wiki.docbook.org/topic/ISO690Bibliography">the | |
| 5786 following WiKi page</link>.</para> | |
| 5787 | |
| 5788 </refsection> | |
| 5789 </refentry> | |
| 5790 | |
| 5791 <refentry version="5.0" xml:id="biblioentry.item.separator"> | |
| 5792 <refmeta> | |
| 5793 <refentrytitle>biblioentry.item.separator</refentrytitle> | |
| 5794 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 5795 </refmeta> | |
| 5796 <refnamediv> | |
| 5797 <refname>biblioentry.item.separator</refname> | |
| 5798 <refpurpose>Text to separate bibliography entries</refpurpose> | |
| 5799 </refnamediv> | |
| 5800 | |
| 5801 <refsynopsisdiv> | |
| 5802 <programlisting xml:id="biblioentry.item.separator.frag"><xsl:param name="bib
lioentry.item.separator">. </xsl:param></programlisting> | |
| 5803 </refsynopsisdiv> | |
| 5804 | |
| 5805 <refsection><info><title>Description</title></info> | |
| 5806 | |
| 5807 <para>Text to separate bibliography entries | |
| 5808 </para> | |
| 5809 | |
| 5810 </refsection> | |
| 5811 </refentry> | |
| 5812 | |
| 5813 <refentry version="5.0" xml:id="bibliography.collection"> | |
| 5814 <refmeta> | |
| 5815 <refentrytitle>bibliography.collection</refentrytitle> | |
| 5816 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 5817 </refmeta> | |
| 5818 <refnamediv> | |
| 5819 <refname>bibliography.collection</refname> | |
| 5820 <refpurpose>Name of the bibliography collection file</refpurpose> | |
| 5821 </refnamediv> | |
| 5822 | |
| 5823 <refsynopsisdiv> | |
| 5824 <programlisting xml:id="bibliography.collection.frag"> | |
| 5825 <xsl:param name="bibliography.collection">http://docbook.sourceforge.net/r
elease/bibliography/bibliography.xml</xsl:param> | |
| 5826 | |
| 5827 </programlisting> | |
| 5828 </refsynopsisdiv> | |
| 5829 | |
| 5830 <refsection><info><title>Description</title></info> | |
| 5831 | |
| 5832 <para>Maintaining bibliography entries across a set of documents is tedious, tim
e | |
| 5833 consuming, and error prone. It makes much more sense, usually, to store all of | |
| 5834 the bibliography entries in a single place and simply <quote>extract</quote> | |
| 5835 the ones you need in each document.</para> | |
| 5836 | |
| 5837 <para>That's the purpose of the | |
| 5838 <parameter>bibliography.collection</parameter> parameter. To setup a global | |
| 5839 bibliography <quote>database</quote>, follow these steps:</para> | |
| 5840 | |
| 5841 <para>First, create a stand-alone bibliography document that contains all of | |
| 5842 the documents that you wish to reference. Make sure that each bibliography | |
| 5843 entry (whether you use <tag>biblioentry</tag> or <tag>bibliomixed</tag>) | |
| 5844 has an ID.</para> | |
| 5845 | |
| 5846 <para>My global bibliography, <filename>~/bibliography.xml</filename> begins | |
| 5847 like this:</para> | |
| 5848 | |
| 5849 <informalexample> | |
| 5850 <programlisting><!DOCTYPE bibliography | |
| 5851 PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" | |
| 5852 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> | |
| 5853 <bibliography><title>References</title> | |
| 5854 | |
| 5855 <bibliomixed id="xml-rec"><abbrev>XML 1.0</abbrev>Tim Bray, | |
| 5856 Jean Paoli, C. M. Sperberg-McQueen, and Eve Maler, editors. | |
| 5857 <citetitle><ulink url="http://www.w3.org/TR/REC-xml">Extensible Mark
up | |
| 5858 Language (XML) 1.0 Second Edition</ulink></citetitle>. | |
| 5859 World Wide Web Consortium, 2000. | |
| 5860 </bibliomixed> | |
| 5861 | |
| 5862 <bibliomixed id="xml-names"><abbrev>Namespaces</abbrev>Tim Bra
y, | |
| 5863 Dave Hollander, | |
| 5864 and Andrew Layman, editors. | |
| 5865 <citetitle><ulink url="http://www.w3.org/TR/REC-xml-names/">Namespac
es in | |
| 5866 XML</ulink></citetitle>. | |
| 5867 World Wide Web Consortium, 1999. | |
| 5868 </bibliomixed> | |
| 5869 | |
| 5870 <!-- ... --> | |
| 5871 </bibliography> | |
| 5872 </programlisting> | |
| 5873 </informalexample> | |
| 5874 | |
| 5875 <para>When you create a bibliography in your document, simply | |
| 5876 provide <emphasis>empty</emphasis> <tag>bibliomixed</tag> | |
| 5877 entries for each document that you wish to cite. Make sure that these | |
| 5878 elements have the same ID as the corresponding <quote>real</quote> | |
| 5879 entry in your global bibliography.</para> | |
| 5880 | |
| 5881 <para>For example:</para> | |
| 5882 | |
| 5883 <informalexample> | |
| 5884 <programlisting><bibliography><title>Bibliography</title> | |
| 5885 | |
| 5886 <bibliomixed id="xml-rec"/> | |
| 5887 <bibliomixed id="xml-names"/> | |
| 5888 <bibliomixed id="DKnuth86">Donald E. Knuth. <citetitle>Computers and | |
| 5889 Typesetting: Volume B, TeX: The Program</citetitle>. Addison-Wesley, | |
| 5890 1986. ISBN 0-201-13437-3. | |
| 5891 </bibliomixed> | |
| 5892 <bibliomixed id="relaxng"/> | |
| 5893 | |
| 5894 </bibliography></programlisting> | |
| 5895 </informalexample> | |
| 5896 | |
| 5897 <para>Note that it's perfectly acceptable to mix entries from your | |
| 5898 global bibliography with <quote>normal</quote> entries. You can use | |
| 5899 <tag>xref</tag> or other elements to cross-reference your | |
| 5900 bibliography entries in exactly the same way you do now.</para> | |
| 5901 | |
| 5902 <para>Finally, when you are ready to format your document, simply set the | |
| 5903 <parameter>bibliography.collection</parameter> parameter (in either a | |
| 5904 customization layer or directly through your processor's interface) to | |
| 5905 point to your global bibliography.</para> | |
| 5906 | |
| 5907 <para>A relative path in the parameter is interpreted in one | |
| 5908 of two ways:</para> | |
| 5909 <orderedlist numeration="loweralpha"> | |
| 5910 <listitem> | |
| 5911 <para>If your document contains no links to empty bibliographic elements, | |
| 5912 then the path is relative to the file containing | |
| 5913 the first <tag>bibliomixed</tag> element in the document.</para> | |
| 5914 </listitem> | |
| 5915 <listitem> | |
| 5916 <para>If your document does contain links to empty bibliographic elements, | |
| 5917 then the path is relative to the file containing | |
| 5918 the first such link element in the document.</para> | |
| 5919 </listitem> | |
| 5920 </orderedlist> | |
| 5921 <para>Once the collection file is opened by the first instance described | |
| 5922 above, it stays open for the current document | |
| 5923 and the relative path is not reinterpreted again.</para> | |
| 5924 | |
| 5925 <para>The stylesheets will format the bibliography in your document as if | |
| 5926 all of the entries referenced appeared there literally.</para> | |
| 5927 | |
| 5928 </refsection> | |
| 5929 </refentry> | |
| 5930 | |
| 5931 <refentry version="5.0" xml:id="bibliography.numbered"> | |
| 5932 <refmeta> | |
| 5933 <refentrytitle>bibliography.numbered</refentrytitle> | |
| 5934 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 5935 </refmeta> | |
| 5936 <refnamediv> | |
| 5937 <refname>bibliography.numbered</refname> | |
| 5938 <refpurpose>Should bibliography entries be numbered?</refpurpose> | |
| 5939 </refnamediv> | |
| 5940 | |
| 5941 <refsynopsisdiv> | |
| 5942 <programlisting xml:id="bibliography.numbered.frag"> | |
| 5943 <xsl:param name="bibliography.numbered" select="0"></xsl:param> | |
| 5944 </programlisting> | |
| 5945 </refsynopsisdiv> | |
| 5946 | |
| 5947 <refsection><info><title>Description</title></info> | |
| 5948 | |
| 5949 <para>If non-zero bibliography entries will be numbered</para> | |
| 5950 | |
| 5951 </refsection> | |
| 5952 </refentry> | |
| 5953 | |
| 5954 </reference> | |
| 5955 <reference xml:id="glossary"><title>Glossary</title> | |
| 5956 <refentry version="5.0" xml:id="glossterm.auto.link"> | |
| 5957 <refmeta> | |
| 5958 <refentrytitle>glossterm.auto.link</refentrytitle> | |
| 5959 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 5960 </refmeta> | |
| 5961 <refnamediv> | |
| 5962 <refname>glossterm.auto.link</refname> | |
| 5963 <refpurpose>Generate links from glossterm to glossentry automatically?</refpurpo
se> | |
| 5964 </refnamediv> | |
| 5965 | |
| 5966 <refsynopsisdiv> | |
| 5967 <programlisting xml:id="glossterm.auto.link.frag"> | |
| 5968 <xsl:param name="glossterm.auto.link" select="0"></xsl:param> | |
| 5969 </programlisting> | |
| 5970 </refsynopsisdiv> | |
| 5971 | |
| 5972 <refsection><info><title>Description</title></info> | |
| 5973 | |
| 5974 <para>If non-zero, links from inline <tag>glossterm</tag>s to the corresponding | |
| 5975 <tag>glossentry</tag> elements in a <tag>glossary</tag> or <tag>glosslist</tag> | |
| 5976 will be automatically generated. This is useful when your glossterms are consist
ent | |
| 5977 and you don't want to add links manually.</para> | |
| 5978 | |
| 5979 <para>The automatic link generation feature is not used on <tag>glossterm</tag>
elements | |
| 5980 that have a <tag class="attribute">linkend</tag> attribute.</para> | |
| 5981 | |
| 5982 </refsection> | |
| 5983 </refentry> | |
| 5984 | |
| 5985 <refentry version="5.0" xml:id="firstterm.only.link"> | |
| 5986 <refmeta> | |
| 5987 <refentrytitle>firstterm.only.link</refentrytitle> | |
| 5988 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 5989 </refmeta> | |
| 5990 <refnamediv> | |
| 5991 <refname>firstterm.only.link</refname> | |
| 5992 <refpurpose>Does automatic glossterm linking only apply to firstterms?</refpurpo
se> | |
| 5993 </refnamediv> | |
| 5994 | |
| 5995 <refsynopsisdiv> | |
| 5996 <programlisting xml:id="firstterm.only.link.frag"> | |
| 5997 <xsl:param name="firstterm.only.link" select="0"></xsl:param> | |
| 5998 </programlisting> | |
| 5999 </refsynopsisdiv> | |
| 6000 | |
| 6001 <refsection><info><title>Description</title></info> | |
| 6002 | |
| 6003 <para>If non-zero, only <tag>firstterm</tag>s will be automatically linked | |
| 6004 to the glossary. If glossary linking is not enabled, this parameter | |
| 6005 has no effect.</para> | |
| 6006 | |
| 6007 </refsection> | |
| 6008 </refentry> | |
| 6009 | |
| 6010 <refentry version="5.0" xml:id="glossary.collection"> | |
| 6011 <refmeta> | |
| 6012 <refentrytitle>glossary.collection</refentrytitle> | |
| 6013 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 6014 </refmeta> | |
| 6015 <refnamediv> | |
| 6016 <refname>glossary.collection</refname> | |
| 6017 <refpurpose>Name of the glossary collection file</refpurpose> | |
| 6018 </refnamediv> | |
| 6019 | |
| 6020 <refsynopsisdiv> | |
| 6021 <programlisting xml:id="glossary.collection.frag"> | |
| 6022 <xsl:param name="glossary.collection"></xsl:param> | |
| 6023 </programlisting> | |
| 6024 </refsynopsisdiv> | |
| 6025 | |
| 6026 <refsection><info><title>Description</title></info> | |
| 6027 | |
| 6028 <para>Glossaries maintained independently across a set of documents | |
| 6029 are likely to become inconsistent unless considerable effort is | |
| 6030 expended to keep them in sync. It makes much more sense, usually, to | |
| 6031 store all of the glossary entries in a single place and simply | |
| 6032 <quote>extract</quote> the ones you need in each document.</para> | |
| 6033 | |
| 6034 <para>That's the purpose of the | |
| 6035 <parameter>glossary.collection</parameter> parameter. To setup a global | |
| 6036 glossary <quote>database</quote>, follow these steps:</para> | |
| 6037 | |
| 6038 <refsection><info><title>Setting Up the Glossary Database</title></info> | |
| 6039 | |
| 6040 <para>First, create a stand-alone glossary document that contains all of | |
| 6041 the entries that you wish to reference. Make sure that each glossary | |
| 6042 entry has an ID.</para> | |
| 6043 | |
| 6044 <para>Here's an example glossary:</para> | |
| 6045 | |
| 6046 <informalexample> | |
| 6047 <programlisting> | |
| 6048 <?xml version="1.0" encoding="utf-8"?> | |
| 6049 <!DOCTYPE glossary | |
| 6050 PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" | |
| 6051 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> | |
| 6052 <glossary> | |
| 6053 <glossaryinfo> | |
| 6054 <editor><firstname>Eric</firstname><surname>Raymond</
surname></editor> | |
| 6055 <title>Jargon File 4.2.3 (abridged)</title> | |
| 6056 <releaseinfo>Just some test data</releaseinfo> | |
| 6057 </glossaryinfo> | |
| 6058 | |
| 6059 <glossdiv><title>0</title> | |
| 6060 | |
| 6061 <glossentry> | |
| 6062 <glossterm>0</glossterm> | |
| 6063 <glossdef> | |
| 6064 <para>Numeric zero, as opposed to the letter `O' (the 15th letter of | |
| 6065 the English alphabet). In their unmodified forms they look a lot | |
| 6066 alike, and various kluges invented to make them visually distinct have | |
| 6067 compounded the confusion. If your zero is center-dotted and letter-O | |
| 6068 is not, or if letter-O looks almost rectangular but zero looks more | |
| 6069 like an American football stood on end (or the reverse), you're | |
| 6070 probably looking at a modern character display (though the dotted zero | |
| 6071 seems to have originated as an option on IBM 3270 controllers). If | |
| 6072 your zero is slashed but letter-O is not, you're probably looking at | |
| 6073 an old-style ASCII graphic set descended from the default typewheel on | |
| 6074 the venerable ASR-33 Teletype (Scandinavians, for whom /O is a letter, | |
| 6075 curse this arrangement). (Interestingly, the slashed zero long | |
| 6076 predates computers; Florian Cajori's monumental "A History of | |
| 6077 Mathematical Notations" notes that it was used in the twelfth and | |
| 6078 thirteenth centuries.) If letter-O has a slash across it and the zero | |
| 6079 does not, your display is tuned for a very old convention used at IBM | |
| 6080 and a few other early mainframe makers (Scandinavians curse <emphasis>this
</emphasis> | |
| 6081 arrangement even more, because it means two of their letters collide). | |
| 6082 Some Burroughs/Unisys equipment displays a zero with a <emphasis>reversed&
lt;/emphasis> | |
| 6083 slash. Old CDC computers rendered letter O as an unbroken oval and 0 | |
| 6084 as an oval broken at upper right and lower left. And yet another | |
| 6085 convention common on early line printers left zero unornamented but | |
| 6086 added a tail or hook to the letter-O so that it resembled an inverted | |
| 6087 Q or cursive capital letter-O (this was endorsed by a draft ANSI | |
| 6088 standard for how to draw ASCII characters, but the final standard | |
| 6089 changed the distinguisher to a tick-mark in the upper-left corner). | |
| 6090 Are we sufficiently confused yet?</para> | |
| 6091 </glossdef> | |
| 6092 </glossentry> | |
| 6093 | |
| 6094 <glossentry> | |
| 6095 <glossterm>1TBS</glossterm> | |
| 6096 <glossdef> | |
| 6097 <para role="accidence"> | |
| 6098 <phrase role="pronounce"></phrase> | |
| 6099 <phrase role="partsofspeach">n</phrase> | |
| 6100 </para> | |
| 6101 <para>The "One True Brace Style"</para> | |
| 6102 <glossseealso>indent style</glossseealso> | |
| 6103 </glossdef> | |
| 6104 </glossentry> | |
| 6105 | |
| 6106 <!-- ... --> | |
| 6107 | |
| 6108 </glossdiv> | |
| 6109 | |
| 6110 <!-- ... --> | |
| 6111 | |
| 6112 </glossary></programlisting> | |
| 6113 </informalexample> | |
| 6114 | |
| 6115 </refsection> | |
| 6116 | |
| 6117 <refsection><info><title>Marking Up Glossary Terms</title></info> | |
| 6118 | |
| 6119 <para>That takes care of the glossary database, now you have to get the entries | |
| 6120 into your document. Unlike bibliography entries, which can be empty, creating | |
| 6121 <quote>placeholder</quote> glossary entries would be very tedious. So instead, | |
| 6122 support for <parameter>glossary.collection</parameter> relies on implicit linkin
g.</para> | |
| 6123 | |
| 6124 <para>In your source document, simply use <tag>firstterm</tag> and | |
| 6125 <tag>glossterm</tag> to identify the terms you wish to have included | |
| 6126 in the glossary. The stylesheets assume that you will either set the | |
| 6127 <tag class="attribute">baseform</tag> attribute correctly, or that the | |
| 6128 content of the element exactly matches a term in your glossary.</para> | |
| 6129 | |
| 6130 <para>If you're using a <parameter>glossary.collection</parameter>, don't | |
| 6131 make explicit links on the terms in your document.</para> | |
| 6132 | |
| 6133 <para>So, in your document, you might write things like this:</para> | |
| 6134 | |
| 6135 <informalexample> | |
| 6136 <programlisting><para>This is dummy text, without any real meaning. | |
| 6137 The point is simply to reference glossary terms like <glossterm>0</glos
sterm> | |
| 6138 and the <firstterm baseform="1TBS">One True Brace Style (1TBS)</firstte
rm>. | |
| 6139 The <glossterm>1TBS</glossterm>, as you can probably imagine, is a n
early | |
| 6140 religious issue.</para></programlisting> | |
| 6141 </informalexample> | |
| 6142 | |
| 6143 <para>If you set the <parameter>firstterm.only.link</parameter> parameter, | |
| 6144 only the terms marked with <tag>firstterm</tag> will be links. | |
| 6145 Otherwise, all the terms will be linked.</para> | |
| 6146 | |
| 6147 </refsection> | |
| 6148 | |
| 6149 <refsection><info><title>Marking Up the Glossary</title></info> | |
| 6150 | |
| 6151 <para>The glossary itself has to be identified for the stylesheets. For lack | |
| 6152 of a better choice, the <tag class="attribute">role</tag> is used. | |
| 6153 To identify the glossary as the target for automatic processing, set | |
| 6154 the role to <quote><literal>auto</literal></quote>. The title of this | |
| 6155 glossary (and any other information from the <tag>glossaryinfo</tag> | |
| 6156 that's rendered by your stylesheet) will be displayed, but the entries will | |
| 6157 come from the database. | |
| 6158 </para> | |
| 6159 | |
| 6160 <para>Unfortunately, the glossary can't be empty, so you must put in | |
| 6161 at least one <tag>glossentry</tag>. The content of this entry | |
| 6162 is irrelevant, it will not be rendered:</para> | |
| 6163 | |
| 6164 <informalexample> | |
| 6165 <programlisting><glossary role="auto"> | |
| 6166 <glossentry> | |
| 6167 <glossterm>Irrelevant</glossterm> | |
| 6168 <glossdef> | |
| 6169 <para>If you can see this, the document was processed incorrectly. Use | |
| 6170 the <parameter>glossary.collection</parameter> parameter.</para&g
t; | |
| 6171 </glossdef> | |
| 6172 </glossentry> | |
| 6173 </glossary></programlisting> | |
| 6174 </informalexample> | |
| 6175 | |
| 6176 <para>What about glossary divisions? If your glossary database has glossary | |
| 6177 divisions <emphasis>and</emphasis> your automatic glossary contains at least | |
| 6178 one <tag>glossdiv</tag>, the automic glossary will have divisions. | |
| 6179 If the <tag>glossdiv</tag> is missing from either location, no divisions | |
| 6180 will be rendered.</para> | |
| 6181 | |
| 6182 <para>Glossary entries (and divisions, if appropriate) in the glossary will | |
| 6183 occur in precisely the order they occur in your database.</para> | |
| 6184 | |
| 6185 </refsection> | |
| 6186 | |
| 6187 <refsection><info><title>Formatting the Document</title></info> | |
| 6188 | |
| 6189 <para>Finally, when you are ready to format your document, simply set the | |
| 6190 <parameter>glossary.collection</parameter> parameter (in either a | |
| 6191 customization layer or directly through your processor's interface) to | |
| 6192 point to your global glossary.</para> | |
| 6193 | |
| 6194 <para>A relative path in the parameter is interpreted in one | |
| 6195 of two ways:</para> | |
| 6196 <orderedlist numeration="loweralpha"> | |
| 6197 <listitem> | |
| 6198 <para>If the parameter <literal>glossterm.auto.link</literal> | |
| 6199 is set to zero, then the path is relative to the file containing | |
| 6200 the empty <tag>glossary</tag> element in the document.</para> | |
| 6201 </listitem> | |
| 6202 <listitem> | |
| 6203 <para>If the parameter <literal>glossterm.auto.link</literal> | |
| 6204 is set to non-zero, then the path is relative to the file containing | |
| 6205 the first inline <tag>glossterm</tag> or | |
| 6206 <tag>firstterm</tag> in the document to be linked.</para> | |
| 6207 </listitem> | |
| 6208 </orderedlist> | |
| 6209 <para>Once the collection file is opened by the first instance described | |
| 6210 above, it stays open for the current document | |
| 6211 and the relative path is not reinterpreted again.</para> | |
| 6212 | |
| 6213 <para>The stylesheets will format the glossary in your document as if | |
| 6214 all of the entries implicilty referenced appeared there literally.</para> | |
| 6215 </refsection> | |
| 6216 | |
| 6217 <refsection><info><title>Limitations</title></info> | |
| 6218 | |
| 6219 <para>Glossary cross-references <emphasis>within the glossary</emphasis> are | |
| 6220 not supported. For example, this <emphasis>will not</emphasis> work:</para> | |
| 6221 | |
| 6222 <informalexample> | |
| 6223 <programlisting><glossentry> | |
| 6224 <glossterm>gloss-1</glossterm> | |
| 6225 <glossdef><para>A description that references <glossterm>gloss
-2</glossterm>.</para> | |
| 6226 <glossseealso>gloss-2</glossseealso> | |
| 6227 </glossdef> | |
| 6228 </glossentry></programlisting> | |
| 6229 </informalexample> | |
| 6230 | |
| 6231 <para>If you put glossary cross-references in your glossary that way, | |
| 6232 you'll get the cryptic error: <computeroutput>Warning: | |
| 6233 glossary.collection specified, but there are 0 automatic | |
| 6234 glossaries</computeroutput>.</para> | |
| 6235 | |
| 6236 <para>Instead, you must do two things:</para> | |
| 6237 | |
| 6238 <orderedlist> | |
| 6239 <listitem> | |
| 6240 <para>Markup your glossary using <tag>glossseealso</tag>:</para> | |
| 6241 | |
| 6242 <informalexample> | |
| 6243 <programlisting><glossentry> | |
| 6244 <glossterm>gloss-1</glossterm> | |
| 6245 <glossdef><para>A description that references <glossterm>gloss
-2</glossterm>.</para> | |
| 6246 <glossseealso>gloss-2</glossseealso> | |
| 6247 </glossdef> | |
| 6248 </glossentry></programlisting> | |
| 6249 </informalexample> | |
| 6250 </listitem> | |
| 6251 | |
| 6252 <listitem> | |
| 6253 <para>Make sure there is at least one <tag>glossterm</tag> reference to | |
| 6254 <glossterm>gloss-2</glossterm> <emphasis>in your document</emphasis>. The | |
| 6255 easiest way to do that is probably within a <tag>remark</tag> in your | |
| 6256 automatic glossary:</para> | |
| 6257 | |
| 6258 <informalexample> | |
| 6259 <programlisting><glossary role="auto"> | |
| 6260 <remark>Make sure there's a reference to <glossterm>gloss-2</glos
sterm>.</remark> | |
| 6261 <glossentry> | |
| 6262 <glossterm>Irrelevant</glossterm> | |
| 6263 <glossdef> | |
| 6264 <para>If you can see this, the document was processed incorrectly. Use | |
| 6265 the <parameter>glossary.collection</parameter> parameter.</para&g
t; | |
| 6266 </glossdef> | |
| 6267 </glossentry> | |
| 6268 </glossary></programlisting> | |
| 6269 </informalexample> | |
| 6270 </listitem> | |
| 6271 </orderedlist> | |
| 6272 </refsection> | |
| 6273 | |
| 6274 </refsection> | |
| 6275 </refentry> | |
| 6276 | |
| 6277 <refentry version="5.0" xml:id="glossary.sort"> | |
| 6278 <refmeta> | |
| 6279 <refentrytitle>glossary.sort</refentrytitle> | |
| 6280 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 6281 </refmeta> | |
| 6282 <refnamediv> | |
| 6283 <refname>glossary.sort</refname> | |
| 6284 <refpurpose>Sort glossentry elements?</refpurpose> | |
| 6285 </refnamediv> | |
| 6286 | |
| 6287 <refsynopsisdiv> | |
| 6288 <programlisting xml:id="glossary.sort.frag"> | |
| 6289 <xsl:param name="glossary.sort" select="0"></xsl:param> | |
| 6290 </programlisting> | |
| 6291 </refsynopsisdiv> | |
| 6292 | |
| 6293 <refsection><info><title>Description</title></info> | |
| 6294 | |
| 6295 <para>If non-zero, then the glossentry elements within a | |
| 6296 glossary, glossdiv, or glosslist are sorted on the glossterm, using | |
| 6297 the current lang setting. If zero (the default), then | |
| 6298 glossentry elements are not sorted and are presented | |
| 6299 in document order. | |
| 6300 </para> | |
| 6301 | |
| 6302 </refsection> | |
| 6303 </refentry> | |
| 6304 | |
| 6305 <refentry version="5.0" xml:id="glossentry.show.acronym"> | |
| 6306 <refmeta> | |
| 6307 <refentrytitle>glossentry.show.acronym</refentrytitle> | |
| 6308 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> | |
| 6309 <refmiscinfo class="other" otherclass="value">no</refmiscinfo> | |
| 6310 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo> | |
| 6311 <refmiscinfo class="other" otherclass="value">primary</refmiscinfo> | |
| 6312 </refmeta> | |
| 6313 <refnamediv> | |
| 6314 <refname>glossentry.show.acronym</refname> | |
| 6315 <refpurpose>Display <tag>glossentry</tag> acronyms?</refpurpose> | |
| 6316 </refnamediv> | |
| 6317 | |
| 6318 <refsynopsisdiv> | |
| 6319 <programlisting xml:id="glossentry.show.acronym.frag"> | |
| 6320 <xsl:param name="glossentry.show.acronym">no</xsl:param> | |
| 6321 </programlisting> | |
| 6322 </refsynopsisdiv> | |
| 6323 | |
| 6324 <refsection><info><title>Description</title></info> | |
| 6325 | |
| 6326 <para>A setting of <quote>yes</quote> means they should be displayed; | |
| 6327 <quote>no</quote> means they shouldn't. If <quote>primary</quote> is used, | |
| 6328 then they are shown as the primary text for the entry.</para> | |
| 6329 | |
| 6330 <note> | |
| 6331 <para>This setting controls both <tag>acronym</tag> and | |
| 6332 <tag>abbrev</tag> elements in the <tag>glossentry</tag>.</para> | |
| 6333 </note> | |
| 6334 | |
| 6335 </refsection> | |
| 6336 </refentry> | |
| 6337 | |
| 6338 </reference> | |
| 6339 <reference xml:id="misc"><title>Miscellaneous</title> | |
| 6340 <refentry version="5.0" xml:id="formal.procedures"> | |
| 6341 <refmeta> | |
| 6342 <refentrytitle>formal.procedures</refentrytitle> | |
| 6343 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 6344 </refmeta> | |
| 6345 <refnamediv> | |
| 6346 <refname>formal.procedures</refname> | |
| 6347 <refpurpose>Selects formal or informal procedures</refpurpose> | |
| 6348 </refnamediv> | |
| 6349 | |
| 6350 <refsynopsisdiv> | |
| 6351 <programlisting xml:id="formal.procedures.frag"> | |
| 6352 <xsl:param name="formal.procedures" select="1"></xsl:param> | |
| 6353 </programlisting> | |
| 6354 </refsynopsisdiv> | |
| 6355 | |
| 6356 <refsection><info><title>Description</title></info> | |
| 6357 | |
| 6358 <para>Formal procedures are numbered and always have a title. | |
| 6359 </para> | |
| 6360 | |
| 6361 </refsection> | |
| 6362 </refentry> | |
| 6363 | |
| 6364 <refentry version="5.0" xml:id="formal.title.placement"> | |
| 6365 <refmeta> | |
| 6366 <refentrytitle>formal.title.placement</refentrytitle> | |
| 6367 <refmiscinfo class="other" otherclass="datatype">table</refmiscinfo> | |
| 6368 </refmeta> | |
| 6369 <refnamediv> | |
| 6370 <refname>formal.title.placement</refname> | |
| 6371 <refpurpose>Specifies where formal object titles should occur</refpurpose> | |
| 6372 </refnamediv> | |
| 6373 | |
| 6374 <refsynopsisdiv> | |
| 6375 <programlisting xml:id="formal.title.placement.frag"> | |
| 6376 <xsl:param name="formal.title.placement"> | |
| 6377 figure before | |
| 6378 example before | |
| 6379 equation before | |
| 6380 table before | |
| 6381 procedure before | |
| 6382 task before | |
| 6383 </xsl:param> | |
| 6384 </programlisting> | |
| 6385 </refsynopsisdiv> | |
| 6386 | |
| 6387 <refsection><info><title>Description</title></info> | |
| 6388 | |
| 6389 <para>Specifies where formal object titles should occur. For each formal object | |
| 6390 type (<tag>figure</tag>, | |
| 6391 <tag>example</tag>, | |
| 6392 <tag>equation</tag>, | |
| 6393 <tag>table</tag>, and <tag>procedure</tag>) | |
| 6394 you can specify either the keyword | |
| 6395 <quote><literal>before</literal></quote> or | |
| 6396 <quote><literal>after</literal></quote>.</para> | |
| 6397 | |
| 6398 </refsection> | |
| 6399 </refentry> | |
| 6400 | |
| 6401 <refentry version="5.0" xml:id="runinhead.default.title.end.punct"> | |
| 6402 <refmeta> | |
| 6403 <refentrytitle>runinhead.default.title.end.punct</refentrytitle> | |
| 6404 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 6405 </refmeta> | |
| 6406 <refnamediv> | |
| 6407 <refname>runinhead.default.title.end.punct</refname> | |
| 6408 <refpurpose>Default punctuation character on a run-in-head</refpurpose> | |
| 6409 </refnamediv> | |
| 6410 | |
| 6411 <refsynopsisdiv> | |
| 6412 <programlisting xml:id="runinhead.default.title.end.punct.frag"><xsl:param na
me="runinhead.default.title.end.punct">.</xsl:param> | |
| 6413 </programlisting> | |
| 6414 </refsynopsisdiv> | |
| 6415 | |
| 6416 <refsection><info><title>Description</title></info> | |
| 6417 | |
| 6418 <para>If non-zero, For a <tag>formalpara</tag>, use the specified | |
| 6419 string as the separator between the title and following text. The period is the
default value.</para> | |
| 6420 | |
| 6421 </refsection> | |
| 6422 </refentry> | |
| 6423 | |
| 6424 <refentry version="5.0" xml:id="runinhead.title.end.punct"> | |
| 6425 <refmeta> | |
| 6426 <refentrytitle>runinhead.title.end.punct</refentrytitle> | |
| 6427 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 6428 </refmeta> | |
| 6429 <refnamediv> | |
| 6430 <refname>runinhead.title.end.punct</refname> | |
| 6431 <refpurpose>Characters that count as punctuation on a run-in-head</refpurpose> | |
| 6432 </refnamediv> | |
| 6433 | |
| 6434 <refsynopsisdiv> | |
| 6435 <programlisting xml:id="runinhead.title.end.punct.frag"> | |
| 6436 <xsl:param name="runinhead.title.end.punct">.!?:</xsl:param> | |
| 6437 </programlisting> | |
| 6438 </refsynopsisdiv> | |
| 6439 | |
| 6440 <refsection><info><title>Description</title></info> | |
| 6441 | |
| 6442 <para>Specify which characters are to be counted as punctuation. These | |
| 6443 characters are checked for a match with the last character of the | |
| 6444 title. If no match is found, the | |
| 6445 <parameter>runinhead.default.title.end.punct</parameter> contents are | |
| 6446 inserted. This is to avoid duplicated punctuation in the output. | |
| 6447 </para> | |
| 6448 | |
| 6449 </refsection> | |
| 6450 </refentry> | |
| 6451 | |
| 6452 <refentry version="5.0" xml:id="show.comments"> | |
| 6453 <refmeta> | |
| 6454 <refentrytitle>show.comments</refentrytitle> | |
| 6455 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 6456 </refmeta> | |
| 6457 <refnamediv> | |
| 6458 <refname>show.comments</refname> | |
| 6459 <refpurpose>Display <tag>remark</tag> elements?</refpurpose> | |
| 6460 </refnamediv> | |
| 6461 | |
| 6462 <refsynopsisdiv> | |
| 6463 <programlisting xml:id="show.comments.frag"> | |
| 6464 <xsl:param name="show.comments" select="1"></xsl:param> | |
| 6465 </programlisting> | |
| 6466 </refsynopsisdiv> | |
| 6467 | |
| 6468 <refsection><info><title>Description</title></info> | |
| 6469 | |
| 6470 <para>If non-zero, comments will be displayed, otherwise they | |
| 6471 are suppressed. Comments here refers to the <tag>remark</tag> element | |
| 6472 (which was called <literal>comment</literal> prior to DocBook | |
| 6473 4.0), not XML comments (<-- like this -->) which are | |
| 6474 unavailable. | |
| 6475 </para> | |
| 6476 | |
| 6477 </refsection> | |
| 6478 </refentry> | |
| 6479 | |
| 6480 <refentry version="5.0" xml:id="show.revisionflag"> | |
| 6481 <refmeta> | |
| 6482 <refentrytitle>show.revisionflag</refentrytitle> | |
| 6483 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 6484 </refmeta> | |
| 6485 <refnamediv> | |
| 6486 <refname>show.revisionflag</refname> | |
| 6487 <refpurpose>Enable decoration of elements that have a revisionflag</refpurpose> | |
| 6488 </refnamediv> | |
| 6489 | |
| 6490 <refsynopsisdiv> | |
| 6491 <programlisting xml:id="show.revisionflag.frag"> | |
| 6492 <xsl:param name="show.revisionflag" select="0"></xsl:param> | |
| 6493 </programlisting> | |
| 6494 </refsynopsisdiv> | |
| 6495 | |
| 6496 <refsection><info><title>Description</title></info> | |
| 6497 | |
| 6498 <para> | |
| 6499 If <parameter>show.revisionflag</parameter> is turned on, then the stylesheets | |
| 6500 may produce additional markup designed to allow a CSS stylesheet to | |
| 6501 highlight elements that have specific revisionflag settings.</para> | |
| 6502 | |
| 6503 <para>The markup inserted will be usually be either a <span> or | |
| 6504 <div> with an appropriate <literal>class</literal> | |
| 6505 attribute. (The value of the class attribute will be the same as the | |
| 6506 value of the revisionflag attribute). In some contexts, for example | |
| 6507 tables, where extra markup would be structurally illegal, the class | |
| 6508 attribute will be added to the appropriate container element.</para> | |
| 6509 | |
| 6510 <para>In general, the stylesheets only test for revisionflag in contexts | |
| 6511 where an importing stylesheet would have to redefine whole templates. | |
| 6512 Most of the revisionflag processing is expected to be done by another | |
| 6513 stylesheet, for example <filename>changebars.xsl</filename>.</para> | |
| 6514 | |
| 6515 </refsection> | |
| 6516 </refentry> | |
| 6517 | |
| 6518 <refentry version="5.0" xml:id="shade.verbatim"> | |
| 6519 <refmeta> | |
| 6520 <refentrytitle>shade.verbatim</refentrytitle> | |
| 6521 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 6522 </refmeta> | |
| 6523 <refnamediv> | |
| 6524 <refname>shade.verbatim</refname> | |
| 6525 <refpurpose>Should verbatim environments be shaded?</refpurpose> | |
| 6526 </refnamediv> | |
| 6527 | |
| 6528 <refsynopsisdiv> | |
| 6529 <programlisting xml:id="shade.verbatim.frag"><xsl:param name="shade.verbatim"
select="0"></xsl:param></programlisting> | |
| 6530 </refsynopsisdiv> | |
| 6531 | |
| 6532 <refsection><info><title>Description</title></info> | |
| 6533 | |
| 6534 <para>In the FO stylesheet, if this parameter is non-zero then the | |
| 6535 <property>shade.verbatim.style</property> properties will be applied | |
| 6536 to verbatim environments.</para> | |
| 6537 | |
| 6538 <para>In the HTML stylesheet, this parameter is now deprecated. Use | |
| 6539 CSS instead.</para> | |
| 6540 | |
| 6541 </refsection> | |
| 6542 </refentry> | |
| 6543 | |
| 6544 <refentry version="5.0" xml:id="shade.verbatim.style"> | |
| 6545 <refmeta> | |
| 6546 <refentrytitle>shade.verbatim.style</refentrytitle> | |
| 6547 <refmiscinfo class="other" otherclass="datatype">attribute set</refmiscinfo> | |
| 6548 </refmeta> | |
| 6549 <refnamediv> | |
| 6550 <refname>shade.verbatim.style</refname> | |
| 6551 <refpurpose>Properties that specify the style of shaded verbatim listings</refpu
rpose> | |
| 6552 </refnamediv> | |
| 6553 | |
| 6554 <refsynopsisdiv> | |
| 6555 <programlisting xml:id="shade.verbatim.style.frag"> | |
| 6556 <xsl:attribute-set name="shade.verbatim.style"> | |
| 6557 <xsl:attribute name="border">0</xsl:attribute> | |
| 6558 <xsl:attribute name="bgcolor">#E0E0E0</xsl:attribute> | |
| 6559 </xsl:attribute-set> | |
| 6560 | |
| 6561 </programlisting> | |
| 6562 </refsynopsisdiv> | |
| 6563 | |
| 6564 <refsection><info><title>Description</title></info> | |
| 6565 | |
| 6566 <para>Properties that specify the style of shaded verbatim listings. The | |
| 6567 parameters specified (the border and background color) are added to | |
| 6568 the styling of the xsl-fo output. A border might be specified as "thin | |
| 6569 black solid" for example. See <link xmlns:xlink="http://www.w3.org/1999/xlink" x
link:href="http://www.w3.org/TR/2004/WD-xsl11-20041216/#border">xsl-fo</link></p
ara> | |
| 6570 | |
| 6571 </refsection> | |
| 6572 </refentry> | |
| 6573 | |
| 6574 <refentry version="5.0" xml:id="punct.honorific"> | |
| 6575 <refmeta> | |
| 6576 <refentrytitle>punct.honorific</refentrytitle> | |
| 6577 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 6578 </refmeta> | |
| 6579 <refnamediv> | |
| 6580 <refname>punct.honorific</refname> | |
| 6581 <refpurpose>Punctuation after an honorific in a personal name.</refpurpose> | |
| 6582 </refnamediv> | |
| 6583 | |
| 6584 <refsynopsisdiv> | |
| 6585 <programlisting xml:id="punct.honorific.frag"> | |
| 6586 <xsl:param name="punct.honorific">.</xsl:param> | |
| 6587 </programlisting> | |
| 6588 </refsynopsisdiv> | |
| 6589 | |
| 6590 <refsection><info><title>Description</title></info> | |
| 6591 | |
| 6592 <para>This parameter specifies the punctuation that should be added after an | |
| 6593 honorific in a personal name.</para> | |
| 6594 | |
| 6595 </refsection> | |
| 6596 </refentry> | |
| 6597 | |
| 6598 <refentry version="5.0" xml:id="tex.math.in.alt"> | |
| 6599 <refmeta> | |
| 6600 <refentrytitle>tex.math.in.alt</refentrytitle> | |
| 6601 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> | |
| 6602 <refmiscinfo class="other" otherclass="value">plain</refmiscinfo> | |
| 6603 <refmiscinfo class="other" otherclass="value">latex</refmiscinfo> | |
| 6604 </refmeta> | |
| 6605 <refnamediv> | |
| 6606 <refname>tex.math.in.alt</refname> | |
| 6607 <refpurpose>TeX notation used for equations</refpurpose> | |
| 6608 </refnamediv> | |
| 6609 | |
| 6610 <refsynopsisdiv> | |
| 6611 <programlisting xml:id="tex.math.in.alt.frag"> | |
| 6612 <xsl:param name="tex.math.in.alt"></xsl:param> | |
| 6613 </programlisting> | |
| 6614 </refsynopsisdiv> | |
| 6615 | |
| 6616 <refsection><info><title>Description</title></info> | |
| 6617 | |
| 6618 <para>If you want type math directly in TeX notation in equations, | |
| 6619 this parameter specifies notation used. Currently are supported two | |
| 6620 values -- <literal>plain</literal> and <literal>latex</literal>. Empty | |
| 6621 value means that you are not using TeX math at all.</para> | |
| 6622 | |
| 6623 <para>Preferred way for including TeX alternative of math is inside of | |
| 6624 <tag>textobject</tag> element. Eg.:</para> | |
| 6625 | |
| 6626 <programlisting><inlineequation> | |
| 6627 <inlinemediaobject> | |
| 6628 <imageobject> | |
| 6629 <imagedata fileref="eq1.gif"/> | |
| 6630 </imageobject> | |
| 6631 <textobject><phrase>E=mc squared</phrase></textobject> | |
| 6632 <textobject role="tex"><phrase>E=mc^2</phrase></textobject&
gt; | |
| 6633 </inlinemediaobject> | |
| 6634 </inlineequation></programlisting> | |
| 6635 | |
| 6636 <para>If you are using <tag>graphic</tag> element, you can | |
| 6637 store TeX inside <tag>alt</tag> element:</para> | |
| 6638 | |
| 6639 <programlisting><inlineequation> | |
| 6640 <alt role="tex">a^2+b^2=c^2</alt> | |
| 6641 <graphic fileref="a2b2c2.gif"/> | |
| 6642 </inlineequation></programlisting> | |
| 6643 | |
| 6644 <para>If you want use this feature, you should process your FO with | |
| 6645 PassiveTeX, which only supports TeX math notation. When calling | |
| 6646 stylsheet, don't forget to specify also | |
| 6647 passivetex.extensions=1.</para> | |
| 6648 | |
| 6649 <para>If you want equations in HTML, just process generated file | |
| 6650 <filename>tex-math-equations.tex</filename> by TeX or LaTeX. Then run | |
| 6651 dvi2bitmap program on result DVI file. You will get images for | |
| 6652 equations in your document.</para> | |
| 6653 | |
| 6654 <warning> | |
| 6655 <para>This feature is useful for print/PDF output only if you | |
| 6656 use the obsolete and now unsupported PassiveTeX XSL-FO | |
| 6657 engine.</para> | |
| 6658 </warning> | |
| 6659 | |
| 6660 </refsection> | |
| 6661 | |
| 6662 <refsection><info><title>Related Parameters</title></info> | |
| 6663 <para><parameter>tex.math.delims</parameter>, | |
| 6664 <parameter>passivetex.extensions</parameter>, | |
| 6665 <parameter>tex.math.file</parameter></para> | |
| 6666 </refsection> | |
| 6667 | |
| 6668 </refentry> | |
| 6669 | |
| 6670 <refentry version="5.0" xml:id="tex.math.file"> | |
| 6671 <refmeta> | |
| 6672 <refentrytitle>tex.math.file</refentrytitle> | |
| 6673 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 6674 </refmeta> | |
| 6675 <refnamediv> | |
| 6676 <refname>tex.math.file</refname> | |
| 6677 <refpurpose>Name of temporary file for generating images from equations</refpurp
ose> | |
| 6678 </refnamediv> | |
| 6679 | |
| 6680 <refsynopsisdiv> | |
| 6681 <programlisting xml:id="tex.math.file.frag"> | |
| 6682 <xsl:param name="tex.math.file">tex-math-equations.tex</xsl:param> | |
| 6683 </programlisting> | |
| 6684 </refsynopsisdiv> | |
| 6685 | |
| 6686 <refsection><info><title>Description</title></info> | |
| 6687 | |
| 6688 <para>Name of auxiliary file for TeX equations. This file can be | |
| 6689 processed by dvi2bitmap to get bitmap versions of equations for HTML | |
| 6690 output.</para> | |
| 6691 | |
| 6692 </refsection> | |
| 6693 <refsection><info><title>Related Parameters</title></info> | |
| 6694 <para><parameter>tex.math.in.alt</parameter>, | |
| 6695 <parameter>tex.math.delims</parameter>, | |
| 6696 </para> | |
| 6697 </refsection> | |
| 6698 <refsection><info><title>More information</title></info> | |
| 6699 <para>For how-to documentation on embedding TeX equations and | |
| 6700 generating output from them, see | |
| 6701 <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="TexM
ath.html">DBTeXMath</link>.</para> | |
| 6702 </refsection> | |
| 6703 </refentry> | |
| 6704 | |
| 6705 <refentry version="5.0" xml:id="tex.math.delims"> | |
| 6706 <refmeta> | |
| 6707 <refentrytitle>tex.math.delims</refentrytitle> | |
| 6708 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 6709 </refmeta> | |
| 6710 <refnamediv> | |
| 6711 <refname>tex.math.delims</refname> | |
| 6712 <refpurpose>Should equations output for processing by TeX be | |
| 6713 surrounded by math mode delimiters?</refpurpose> | |
| 6714 </refnamediv> | |
| 6715 | |
| 6716 <refsynopsisdiv> | |
| 6717 <programlisting xml:id="tex.math.delims.frag"> | |
| 6718 <xsl:param name="tex.math.delims" select="1"></xsl:param> | |
| 6719 </programlisting> | |
| 6720 </refsynopsisdiv> | |
| 6721 | |
| 6722 <refsection><info><title>Description</title></info> | |
| 6723 | |
| 6724 <para>For compatibility with DSSSL based DBTeXMath from Allin Cottrell | |
| 6725 you should set this parameter to 0.</para> | |
| 6726 | |
| 6727 <warning> | |
| 6728 <para>This feature is useful for print/PDF output only if you | |
| 6729 use the obsolete and now unsupported PassiveTeX XSL-FO | |
| 6730 engine.</para> | |
| 6731 </warning> | |
| 6732 | |
| 6733 </refsection> | |
| 6734 <refsection><info><title>Related Parameters</title></info> | |
| 6735 <para><parameter>tex.math.in.alt</parameter>, | |
| 6736 <parameter>passivetex.extensions</parameter></para> | |
| 6737 </refsection> | |
| 6738 | |
| 6739 <refsection><info><title>See Also</title></info> | |
| 6740 <para>You can also use the <tag class="xmlpi">dbtex delims</tag> processing | |
| 6741 instruction to control whether delimiters are output.</para> | |
| 6742 </refsection> | |
| 6743 | |
| 6744 | |
| 6745 </refentry> | |
| 6746 | |
| 6747 <refentry version="5.0" xml:id="pixels.per.inch"> | |
| 6748 <refmeta> | |
| 6749 <refentrytitle>pixels.per.inch</refentrytitle> | |
| 6750 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> | |
| 6751 </refmeta> | |
| 6752 <refnamediv> | |
| 6753 <refname>pixels.per.inch</refname> | |
| 6754 <refpurpose>How many pixels are there per inch?</refpurpose> | |
| 6755 </refnamediv> | |
| 6756 | |
| 6757 <refsynopsisdiv> | |
| 6758 <programlisting xml:id="pixels.per.inch.frag"> | |
| 6759 <xsl:param name="pixels.per.inch">90</xsl:param> | |
| 6760 </programlisting> | |
| 6761 </refsynopsisdiv> | |
| 6762 | |
| 6763 <refsection><info><title>Description</title></info> | |
| 6764 | |
| 6765 <para>When lengths are converted to pixels, this value is used to | |
| 6766 determine the size of a pixel. The default value is taken from the | |
| 6767 <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.w3.org/T
R/2004/WD-xsl11-20041216/">XSL | |
| 6768 Recommendation</link>. | |
| 6769 </para> | |
| 6770 | |
| 6771 </refsection> | |
| 6772 </refentry> | |
| 6773 | |
| 6774 <refentry version="5.0" xml:id="points.per.em"> | |
| 6775 <refmeta> | |
| 6776 <refentrytitle>points.per.em</refentrytitle> | |
| 6777 <refmiscinfo class="other" otherclass="datatype">number</refmiscinfo> | |
| 6778 </refmeta> | |
| 6779 <refnamediv> | |
| 6780 <refname>points.per.em</refname> | |
| 6781 <refpurpose>Specify the nominal size of an em-space in points</refpurpose> | |
| 6782 </refnamediv> | |
| 6783 | |
| 6784 <refsynopsisdiv> | |
| 6785 <programlisting xml:id="points.per.em.frag"> | |
| 6786 <xsl:param name="points.per.em">10</xsl:param> | |
| 6787 </programlisting> | |
| 6788 </refsynopsisdiv> | |
| 6789 | |
| 6790 <refsection><info><title>Description</title></info> | |
| 6791 | |
| 6792 <para>The fixed value used for calculations based upon the size of a | |
| 6793 character. The assumption made is that ten point font is in use. This | |
| 6794 assumption may not be valid.</para> | |
| 6795 | |
| 6796 </refsection> | |
| 6797 </refentry> | |
| 6798 | |
| 6799 <refentry version="5.0" xml:id="use.svg"> | |
| 6800 <refmeta> | |
| 6801 <refentrytitle>use.svg</refentrytitle> | |
| 6802 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 6803 </refmeta> | |
| 6804 <refnamediv> | |
| 6805 <refname>use.svg</refname> | |
| 6806 <refpurpose>Allow SVG in the result tree?</refpurpose> | |
| 6807 </refnamediv> | |
| 6808 | |
| 6809 <refsynopsisdiv> | |
| 6810 <programlisting xml:id="use.svg.frag"> | |
| 6811 <xsl:param name="use.svg" select="1"></xsl:param> | |
| 6812 </programlisting> | |
| 6813 </refsynopsisdiv> | |
| 6814 | |
| 6815 <refsection><info><title>Description</title></info> | |
| 6816 | |
| 6817 <para>If non-zero, SVG will be considered an acceptable image format. SVG | |
| 6818 is passed through to the result tree, so correct rendering of the resulting | |
| 6819 diagram depends on the formatter (FO processor or web browser) that is used | |
| 6820 to process the output from the stylesheet.</para> | |
| 6821 | |
| 6822 </refsection> | |
| 6823 </refentry> | |
| 6824 | |
| 6825 <refentry version="5.0" xml:id="menuchoice.separator"> | |
| 6826 <refmeta> | |
| 6827 <refentrytitle>menuchoice.separator</refentrytitle> | |
| 6828 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 6829 </refmeta> | |
| 6830 <refnamediv> | |
| 6831 <refname>menuchoice.separator</refname> | |
| 6832 <refpurpose>Separator between items of a <tag>menuchoice</tag> | |
| 6833 other than <tag>guimenuitem</tag> and | |
| 6834 <tag>guisubmenu</tag></refpurpose> | |
| 6835 </refnamediv> | |
| 6836 | |
| 6837 <refsynopsisdiv> | |
| 6838 <programlisting xml:id="menuchoice.separator.frag"> | |
| 6839 <xsl:param name="menuchoice.separator">+</xsl:param> | |
| 6840 </programlisting> | |
| 6841 </refsynopsisdiv> | |
| 6842 | |
| 6843 <refsection><info><title>Description</title></info> | |
| 6844 | |
| 6845 <para>Separator used to connect items of a <tag>menuchoice</tag> other | |
| 6846 than <tag>guimenuitem</tag> and <tag>guisubmenu</tag>. The latter | |
| 6847 elements are linked with <parameter>menuchoice.menu.separator</parameter>. | |
| 6848 </para> | |
| 6849 | |
| 6850 </refsection> | |
| 6851 </refentry> | |
| 6852 | |
| 6853 <refentry version="5.0" xml:id="menuchoice.menu.separator"> | |
| 6854 <refmeta> | |
| 6855 <refentrytitle>menuchoice.menu.separator</refentrytitle> | |
| 6856 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 6857 </refmeta> | |
| 6858 <refnamediv> | |
| 6859 <refname>menuchoice.menu.separator</refname> | |
| 6860 <refpurpose>Separator between items of a <tag>menuchoice</tag> | |
| 6861 with <tag>guimenuitem</tag> or | |
| 6862 <tag>guisubmenu</tag></refpurpose> | |
| 6863 </refnamediv> | |
| 6864 | |
| 6865 <refsynopsisdiv> | |
| 6866 <programlisting xml:id="menuchoice.menu.separator.frag"> | |
| 6867 <xsl:param name="menuchoice.menu.separator"> → </xsl:param> | |
| 6868 </programlisting> | |
| 6869 </refsynopsisdiv> | |
| 6870 | |
| 6871 <refsection><info><title>Description</title></info> | |
| 6872 | |
| 6873 <para>Separator used to connect items of a <tag>menuchoice</tag> with | |
| 6874 <tag>guimenuitem</tag> or <tag>guisubmenu</tag>. Other elements | |
| 6875 are linked with <parameter>menuchoice.separator</parameter>. | |
| 6876 </para> | |
| 6877 <para>The default value is &#x2192;, which is the | |
| 6878 &rarr; (right arrow) character entity. | |
| 6879 The current FOP (0.20.5) requires setting the font-family | |
| 6880 explicitly. | |
| 6881 </para> | |
| 6882 <para>The default value also includes spaces around the arrow, | |
| 6883 which will allow a line to break. Replace the spaces with | |
| 6884 &#xA0; (nonbreaking space) if you don't want those | |
| 6885 spaces to break. | |
| 6886 </para> | |
| 6887 | |
| 6888 </refsection> | |
| 6889 </refentry> | |
| 6890 | |
| 6891 <refentry version="5.0" xml:id="default.float.class"> | |
| 6892 <refmeta> | |
| 6893 <refentrytitle>default.float.class</refentrytitle> | |
| 6894 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 6895 </refmeta> | |
| 6896 <refnamediv> | |
| 6897 <refname>default.float.class</refname> | |
| 6898 <refpurpose>Specifies the default float class</refpurpose> | |
| 6899 </refnamediv> | |
| 6900 | |
| 6901 <refsynopsisdiv> | |
| 6902 <programlisting xml:id="default.float.class.frag"> | |
| 6903 <xsl:param name="default.float.class"> | |
| 6904 <xsl:choose> | |
| 6905 <xsl:when test="contains($stylesheet.result.type,'html')">left</xsl
:when> | |
| 6906 <xsl:otherwise>before</xsl:otherwise> | |
| 6907 </xsl:choose> | |
| 6908 </xsl:param> | |
| 6909 </programlisting> | |
| 6910 </refsynopsisdiv> | |
| 6911 | |
| 6912 <refsection><info><title>Description</title></info> | |
| 6913 | |
| 6914 <para>Selects the direction in which a float should be placed. for | |
| 6915 xsl-fo this is before, for html it is left. For Western texts, the | |
| 6916 before direction is the top of the page.</para> | |
| 6917 | |
| 6918 </refsection> | |
| 6919 </refentry> | |
| 6920 | |
| 6921 <refentry version="5.0" xml:id="footnote.number.format"> | |
| 6922 <refmeta> | |
| 6923 <refentrytitle>footnote.number.format</refentrytitle> | |
| 6924 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> | |
| 6925 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo> | |
| 6926 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo> | |
| 6927 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo> | |
| 6928 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscin
fo> | |
| 6929 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscin
fo> | |
| 6930 </refmeta> | |
| 6931 <refnamediv> | |
| 6932 <refname>footnote.number.format</refname> | |
| 6933 <refpurpose>Identifies the format used for footnote numbers</refpurpose> | |
| 6934 </refnamediv> | |
| 6935 | |
| 6936 <refsynopsisdiv> | |
| 6937 <programlisting xml:id="footnote.number.format.frag"> | |
| 6938 <xsl:param name="footnote.number.format">1</xsl:param> | |
| 6939 </programlisting> | |
| 6940 </refsynopsisdiv> | |
| 6941 | |
| 6942 <refsection><info><title>Description</title></info> | |
| 6943 | |
| 6944 <para>The <parameter>footnote.number.format</parameter> specifies the format | |
| 6945 to use for footnote numeration (1, i, I, a, or A).</para> | |
| 6946 | |
| 6947 </refsection> | |
| 6948 </refentry> | |
| 6949 | |
| 6950 <refentry version="5.0" xml:id="table.footnote.number.format"> | |
| 6951 <refmeta> | |
| 6952 <refentrytitle>table.footnote.number.format</refentrytitle> | |
| 6953 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> | |
| 6954 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo> | |
| 6955 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo> | |
| 6956 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo> | |
| 6957 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscin
fo> | |
| 6958 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscin
fo> | |
| 6959 </refmeta> | |
| 6960 <refnamediv> | |
| 6961 <refname>table.footnote.number.format</refname> | |
| 6962 <refpurpose>Identifies the format used for footnote numbers in tables</refpurpos
e> | |
| 6963 </refnamediv> | |
| 6964 | |
| 6965 <refsynopsisdiv> | |
| 6966 <programlisting xml:id="table.footnote.number.format.frag"> | |
| 6967 <xsl:param name="table.footnote.number.format">a</xsl:param> | |
| 6968 </programlisting> | |
| 6969 </refsynopsisdiv> | |
| 6970 | |
| 6971 <refsection><info><title>Description</title></info> | |
| 6972 | |
| 6973 <para>The <parameter>table.footnote.number.format</parameter> specifies the form
at | |
| 6974 to use for footnote numeration (1, i, I, a, or A) in tables.</para> | |
| 6975 | |
| 6976 </refsection> | |
| 6977 </refentry> | |
| 6978 | |
| 6979 <refentry version="5.0" xml:id="footnote.number.symbols"> | |
| 6980 <refmeta> | |
| 6981 <refentrytitle>footnote.number.symbols</refentrytitle> | |
| 6982 <refmiscinfo class="other" otherclass="datatype"/> | |
| 6983 </refmeta> | |
| 6984 <refnamediv> | |
| 6985 <refname>footnote.number.symbols</refname> | |
| 6986 <refpurpose>Special characters to use as footnote markers</refpurpose> | |
| 6987 </refnamediv> | |
| 6988 | |
| 6989 <refsynopsisdiv> | |
| 6990 <programlisting xml:id="footnote.number.symbols.frag"> | |
| 6991 <xsl:param name="footnote.number.symbols"></xsl:param> | |
| 6992 </programlisting> | |
| 6993 </refsynopsisdiv> | |
| 6994 | |
| 6995 <refsection><info><title>Description</title></info> | |
| 6996 | |
| 6997 <para>If <parameter>footnote.number.symbols</parameter> is not the empty string, | |
| 6998 footnotes will use the characters it contains as footnote symbols. For example, | |
| 6999 <quote>*&#x2020;&#x2021;&#x25CA;&#x2720;</quote> will identify | |
| 7000 footnotes with <quote>*</quote>, <quote>†</quote>, <quote>‡</quote>, | |
| 7001 <quote>◊</quote>, and <quote>✠</quote>. If there are more footnotes | |
| 7002 than symbols, the stylesheets will fall back to numbered footnotes using | |
| 7003 <parameter>footnote.number.format</parameter>.</para> | |
| 7004 | |
| 7005 <para>The use of symbols for footnotes depends on the ability of your | |
| 7006 processor (or browser) to render the symbols you select. Not all systems are | |
| 7007 capable of displaying the full range of Unicode characters. If the quoted charac
ters | |
| 7008 in the preceding paragraph are not displayed properly, that's a good indicator | |
| 7009 that you may have trouble using those symbols for footnotes.</para> | |
| 7010 | |
| 7011 </refsection> | |
| 7012 </refentry> | |
| 7013 | |
| 7014 <refentry version="5.0" xml:id="table.footnote.number.symbols"> | |
| 7015 <refmeta> | |
| 7016 <refentrytitle>table.footnote.number.symbols</refentrytitle> | |
| 7017 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 7018 </refmeta> | |
| 7019 <refnamediv> | |
| 7020 <refname>table.footnote.number.symbols</refname> | |
| 7021 <refpurpose>Special characters to use a footnote markers in tables</refpurpose> | |
| 7022 </refnamediv> | |
| 7023 | |
| 7024 <refsynopsisdiv> | |
| 7025 <programlisting xml:id="table.footnote.number.symbols.frag"> | |
| 7026 <xsl:param name="table.footnote.number.symbols"></xsl:param> | |
| 7027 </programlisting> | |
| 7028 </refsynopsisdiv> | |
| 7029 | |
| 7030 <refsection><info><title>Description</title></info> | |
| 7031 | |
| 7032 <para>If <parameter>table.footnote.number.symbols</parameter> is not the empty s
tring, | |
| 7033 table footnotes will use the characters it contains as footnote symbols. For exa
mple, | |
| 7034 <quote>*&#x2020;&#x2021;&#x25CA;&#x2720;</quote> will identify | |
| 7035 footnotes with <quote>*</quote>, <quote>†</quote>, <quote>‡</quote>, | |
| 7036 <quote>◊</quote>, and <quote>✠</quote>. If there are more footnotes | |
| 7037 than symbols, the stylesheets will fall back to numbered footnotes using | |
| 7038 <parameter>table.footnote.number.format</parameter>.</para> | |
| 7039 | |
| 7040 <para>The use of symbols for footnotes depends on the ability of your | |
| 7041 processor (or browser) to render the symbols you select. Not all systems are | |
| 7042 capable of displaying the full range of Unicode characters. If the quoted charac
ters | |
| 7043 in the preceding paragraph are not displayed properly, that's a good indicator | |
| 7044 that you may have trouble using those symbols for footnotes.</para> | |
| 7045 | |
| 7046 </refsection> | |
| 7047 </refentry> | |
| 7048 | |
| 7049 <refentry version="5.0" xml:id="highlight.source"> | |
| 7050 <refmeta> | |
| 7051 <refentrytitle>highlight.source</refentrytitle> | |
| 7052 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 7053 </refmeta> | |
| 7054 <refnamediv> | |
| 7055 <refname>highlight.source</refname> | |
| 7056 <refpurpose>Should the content of <tag>programlisting</tag> | |
| 7057 be syntactically highlighted?</refpurpose> | |
| 7058 </refnamediv> | |
| 7059 | |
| 7060 <refsynopsisdiv> | |
| 7061 <programlisting xml:id="highlight.source.frag"> | |
| 7062 <xsl:param name="highlight.source" select="0"></xsl:param> | |
| 7063 </programlisting> | |
| 7064 </refsynopsisdiv> | |
| 7065 | |
| 7066 <refsection><info><title>Description</title></info> | |
| 7067 | |
| 7068 <para>When this parameter is non-zero, the stylesheets will try to do syntax hig
hlighting of the | |
| 7069 content of <tag>programlisting</tag> elements. You specify the language for each
programlisting | |
| 7070 by using the <tag class="attribute">language</tag> attribute. The <parameter>hig
hlight.default.language</parameter> | |
| 7071 parameter can be used to specify the language for programlistings without a <tag
class="attribute">language</tag> | |
| 7072 attribute. Syntax highlighting also works for <tag>screen</tag> and <tag>synopsi
s</tag> elements.</para> | |
| 7073 | |
| 7074 <para>The actual highlighting work is done by the XSLTHL extension module. This
is an external Java library that has to be | |
| 7075 downloaded separately (see below).</para> | |
| 7076 | |
| 7077 <itemizedlist> | |
| 7078 <para>In order to use this extension, you must</para> | |
| 7079 | |
| 7080 <listitem><para>add <filename>xslthl-2.x.x.jar</filename> to your Java classpath
. The latest version is available | |
| 7081 from <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://sourcef
orge.net/projects/xslthl">the XSLT syntax highlighting project</link> | |
| 7082 at SourceForge.</para> | |
| 7083 </listitem> | |
| 7084 <listitem> | |
| 7085 <para>use a customization layer in which you import one of the following stylesh
eet modules: | |
| 7086 <itemizedlist> | |
| 7087 <listitem> | |
| 7088 <para><filename>html/highlight.xsl</filename> | |
| 7089 </para> | |
| 7090 </listitem> | |
| 7091 <listitem> | |
| 7092 <para><filename>xhtml/highlight.xsl</filename> | |
| 7093 </para> | |
| 7094 </listitem> | |
| 7095 <listitem> | |
| 7096 <para><filename>xhtml-1_1/highlight.xsl</filename> | |
| 7097 </para> | |
| 7098 </listitem> | |
| 7099 <listitem> | |
| 7100 <para><filename>fo/highlight.xsl</filename> | |
| 7101 </para> | |
| 7102 </listitem> | |
| 7103 </itemizedlist> | |
| 7104 </para> | |
| 7105 </listitem> | |
| 7106 <listitem><para>let either the <literal>xslthl.config</literal> Java system prop
erty or the | |
| 7107 <parameter>highlight.xslthl.config</parameter> parameter point to the configurat
ion file for syntax | |
| 7108 highlighting (using URL syntax). DocBook XSL comes with a ready-to-use configura
tion file, | |
| 7109 <filename>highlighting/xslthl-config.xml</filename>.</para> | |
| 7110 </listitem> | |
| 7111 </itemizedlist> | |
| 7112 | |
| 7113 <para>The extension works with Saxon 6.5.x and Xalan-J. (Saxon 8.5 or later is a
lso supported, but since it is | |
| 7114 an XSLT 2.0 processor it is not guaranteed to work with DocBook XSL in all circu
mstances.)</para> | |
| 7115 | |
| 7116 <para>The following is an example of a Saxon 6 command adapted for syntax highli
ghting, to be used on Windows:</para> | |
| 7117 | |
| 7118 <informalexample> | |
| 7119 <para><command>java -cp c:/Java/saxon.jar;c:/Java/xslthl-2.0.1.jar | |
| 7120 -Dxslthl.config=file:///c:/docbook-xsl/highlighting/xslthl-config.xml com.icl.sa
xon.StyleSheet | |
| 7121 -o test.html test.xml myhtml.xsl</command></para> | |
| 7122 </informalexample> | |
| 7123 | |
| 7124 </refsection> | |
| 7125 </refentry> | |
| 7126 | |
| 7127 <refentry version="5.0" xml:id="highlight.xslthl.config"> | |
| 7128 <refmeta> | |
| 7129 <refentrytitle>highlight.xslthl.config</refentrytitle> | |
| 7130 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> | |
| 7131 </refmeta> | |
| 7132 <refnamediv> | |
| 7133 <refname>highlight.xslthl.config</refname> | |
| 7134 <refpurpose>Location of XSLTHL configuration file</refpurpose> | |
| 7135 </refnamediv> | |
| 7136 | |
| 7137 <refsynopsisdiv> | |
| 7138 <programlisting xml:id="highlight.xslthl.config.frag"> | |
| 7139 <xsl:param name="highlight.xslthl.config"></xsl:param> | |
| 7140 </programlisting> | |
| 7141 </refsynopsisdiv> | |
| 7142 | |
| 7143 <refsection><info><title>Description</title></info> | |
| 7144 | |
| 7145 <para>This location has precedence over the corresponding Java property.</para> | |
| 7146 | |
| 7147 <para>Please note that usually you have to specify location as URL not | |
| 7148 just as a simple path on the local | |
| 7149 filesystem. E.g. <filename>file:///home/user/xslthl/my-xslthl-config.xml</filena
me>.</para> | |
| 7150 | |
| 7151 | |
| 7152 | |
| 7153 </refsection> | |
| 7154 </refentry> | |
| 7155 | |
| 7156 <refentry version="5.0" xml:id="highlight.default.language"> | |
| 7157 <refmeta> | |
| 7158 <refentrytitle>highlight.default.language</refentrytitle> | |
| 7159 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 7160 </refmeta> | |
| 7161 <refnamediv> | |
| 7162 <refname>highlight.default.language</refname> | |
| 7163 <refpurpose>Default language of programlisting</refpurpose> | |
| 7164 </refnamediv> | |
| 7165 | |
| 7166 <refsynopsisdiv> | |
| 7167 <programlisting xml:id="highlight.default.language.frag"> | |
| 7168 <xsl:param name="highlight.default.language"></xsl:param> | |
| 7169 </programlisting> | |
| 7170 </refsynopsisdiv> | |
| 7171 | |
| 7172 <refsection><info><title>Description</title></info> | |
| 7173 | |
| 7174 <para>This language is used when there is no language attribute on programlistin
g.</para> | |
| 7175 | |
| 7176 </refsection> | |
| 7177 </refentry> | |
| 7178 | |
| 7179 <refentry version="5.0" xml:id="email.delimiters.enabled"> | |
| 7180 <refmeta> | |
| 7181 <refentrytitle>email.delimiters.enabled</refentrytitle> | |
| 7182 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 7183 </refmeta> | |
| 7184 <refnamediv> | |
| 7185 <refname>email.delimiters.enabled</refname> | |
| 7186 <refpurpose>Generate delimiters around email addresses?</refpurpose> | |
| 7187 </refnamediv> | |
| 7188 | |
| 7189 <refsynopsisdiv> | |
| 7190 <programlisting xml:id="email.delimiters.enabled.frag"> | |
| 7191 <xsl:param name="email.delimiters.enabled" select="1"></xsl:param> | |
| 7192 </programlisting> | |
| 7193 </refsynopsisdiv> | |
| 7194 | |
| 7195 <refsection><info><title>Description</title></info> | |
| 7196 | |
| 7197 <para>If non-zero, delimiters | |
| 7198 | |
| 7199 <footnote><para>For delimiters, the | |
| 7200 stylesheets are currently hard-coded to output angle | |
| 7201 brackets.</para></footnote> | |
| 7202 | |
| 7203 are generated around e-mail addresses | |
| 7204 (the output of the <tag>email</tag> element).</para> | |
| 7205 | |
| 7206 </refsection> | |
| 7207 </refentry> | |
| 7208 | |
| 7209 <refentry version="5.0" xml:id="exsl.node.set.available"> | |
| 7210 <refmeta> | |
| 7211 <refentrytitle>exsl.node.set.available</refentrytitle> | |
| 7212 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 7213 </refmeta> | |
| 7214 <refnamediv> | |
| 7215 <refname>exsl.node.set.available</refname> | |
| 7216 <refpurpose>Is the test function-available('exsl:node-set') true?</refpurpose> | |
| 7217 </refnamediv> | |
| 7218 | |
| 7219 <refsynopsisdiv> | |
| 7220 <programlisting xml:id="exsl.node.set.available.frag"><xsl:param name="exsl.n
ode.set.available"> | |
| 7221 <xsl:choose> | |
| 7222 <xsl:when exsl:foo="" test="function-available('exsl:node-set') or
contains(system-property('xsl:vendor'),
'Apache Software Foundation')">1</xsl:when> | |
| 7223 <xsl:otherwise>0</xsl:otherwise> | |
| 7224 </xsl:choose> | |
| 7225 </xsl:param> | |
| 7226 </programlisting> | |
| 7227 </refsynopsisdiv> | |
| 7228 | |
| 7229 <refsection><info><title>Description</title></info> | |
| 7230 | |
| 7231 <para>If non-zero, | |
| 7232 then the exsl:node-set() function is available to be used in | |
| 7233 the stylesheet. | |
| 7234 If zero, then the function is not available. | |
| 7235 This param automatically detects the presence of | |
| 7236 the function and does not normally need to be set manually.</para> | |
| 7237 | |
| 7238 <para>This param was created to handle a long-standing | |
| 7239 bug in the Xalan processor that fails to detect the | |
| 7240 function even though it is available.</para> | |
| 7241 | |
| 7242 </refsection> | |
| 7243 </refentry> | |
| 7244 | |
| 7245 </reference> | |
| 7246 <reference xml:id="annos"><title>Annotations</title> | |
| 7247 <refentry version="5.0" xml:id="annotation.support"> | |
| 7248 <refmeta> | |
| 7249 <refentrytitle>annotation.support</refentrytitle> | |
| 7250 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 7251 </refmeta> | |
| 7252 <refnamediv> | |
| 7253 <refname>annotation.support</refname> | |
| 7254 <refpurpose>Enable annotations?</refpurpose> | |
| 7255 </refnamediv> | |
| 7256 | |
| 7257 <refsynopsisdiv> | |
| 7258 <programlisting xml:id="annotation.support.frag"> | |
| 7259 <xsl:param name="annotation.support" select="0"></xsl:param> | |
| 7260 </programlisting> | |
| 7261 </refsynopsisdiv> | |
| 7262 | |
| 7263 <refsection><info><title>Description</title></info> | |
| 7264 | |
| 7265 <para>If non-zero, the stylesheets will attempt to support annotation | |
| 7266 elements in HTML by including some JavaScript (see | |
| 7267 <parameter>annotation.js</parameter>).</para> | |
| 7268 | |
| 7269 </refsection> | |
| 7270 </refentry> | |
| 7271 | |
| 7272 <refentry version="5.0" xml:id="annotation.js"> | |
| 7273 <refmeta> | |
| 7274 <refentrytitle>annotation.js</refentrytitle> | |
| 7275 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 7276 </refmeta> | |
| 7277 <refnamediv> | |
| 7278 <refname>annotation.js</refname> | |
| 7279 <refpurpose>URIs identifying JavaScript files with support for annotation popups
</refpurpose> | |
| 7280 </refnamediv> | |
| 7281 | |
| 7282 <refsynopsisdiv> | |
| 7283 <programlisting xml:id="annotation.js.frag"> | |
| 7284 | |
| 7285 <xsl:param name="annotation.js"> | |
| 7286 <xsl:text>http://docbook.sourceforge.net/release/script/AnchorPosition.js
http://docbook.sourceforge.net/release/script/PopupWindow.js</xsl:text><
;/xsl:param> | |
| 7287 | |
| 7288 </programlisting> | |
| 7289 </refsynopsisdiv> | |
| 7290 | |
| 7291 <refsection><info><title>Description</title></info> | |
| 7292 | |
| 7293 <para>If <property>annotation.support</property> is enabled and the | |
| 7294 document contains <tag>annotation</tag>s, then the URIs listed | |
| 7295 in this parameter will be included. These JavaScript files are required | |
| 7296 for popup annotation support.</para> | |
| 7297 | |
| 7298 </refsection> | |
| 7299 </refentry> | |
| 7300 | |
| 7301 <refentry version="5.0" xml:id="annotation.css"> | |
| 7302 <refmeta> | |
| 7303 <refentrytitle>annotation.css</refentrytitle> | |
| 7304 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 7305 </refmeta> | |
| 7306 <refnamediv> | |
| 7307 <refname>annotation.css</refname> | |
| 7308 <refpurpose>CSS rules for annotations</refpurpose> | |
| 7309 </refnamediv> | |
| 7310 | |
| 7311 <refsynopsisdiv> | |
| 7312 <programlisting xml:id="annotation.css.frag"> | |
| 7313 <xsl:param name="annotation.css"> | |
| 7314 /* ====================================================================== | |
| 7315 Annotations | |
| 7316 */ | |
| 7317 | |
| 7318 div.annotation-list { visibility: hidden; | |
| 7319 } | |
| 7320 | |
| 7321 div.annotation-nocss { position: absolute; | |
| 7322 visibility: hidden; | |
| 7323 } | |
| 7324 | |
| 7325 div.annotation-popup { position: absolute; | |
| 7326 z-index: 4; | |
| 7327 visibility: hidden; | |
| 7328 padding: 0px; | |
| 7329 margin: 2px; | |
| 7330 border-style: solid; | |
| 7331 border-width: 1px; | |
| 7332 width: 200px; | |
| 7333 background-color: white; | |
| 7334 } | |
| 7335 | |
| 7336 div.annotation-title { padding: 1px; | |
| 7337 font-weight: bold; | |
| 7338 border-bottom-style: solid; | |
| 7339 border-bottom-width: 1px; | |
| 7340 color: white; | |
| 7341 background-color: black; | |
| 7342 } | |
| 7343 | |
| 7344 div.annotation-body { padding: 2px; | |
| 7345 } | |
| 7346 | |
| 7347 div.annotation-body p { margin-top: 0px; | |
| 7348 padding-top: 0px; | |
| 7349 } | |
| 7350 | |
| 7351 div.annotation-close { position: absolute; | |
| 7352 top: 2px; | |
| 7353 right: 2px; | |
| 7354 } | |
| 7355 </xsl:param> | |
| 7356 </programlisting> | |
| 7357 </refsynopsisdiv> | |
| 7358 | |
| 7359 <refsection><info><title>Description</title></info> | |
| 7360 | |
| 7361 <para>If <parameter>annotation.support</parameter> is enabled and the | |
| 7362 document contains <tag>annotation</tag>s, then the CSS in this | |
| 7363 parameter will be included in the document.</para> | |
| 7364 | |
| 7365 </refsection> | |
| 7366 </refentry> | |
| 7367 | |
| 7368 <refentry version="5.0" xml:id="annotation.graphic.open"> | |
| 7369 <refmeta> | |
| 7370 <refentrytitle>annotation.graphic.open</refentrytitle> | |
| 7371 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> | |
| 7372 </refmeta> | |
| 7373 <refnamediv> | |
| 7374 <refname>annotation.graphic.open</refname> | |
| 7375 <refpurpose>Image for identifying a link that opens an annotation popup</refpurp
ose> | |
| 7376 </refnamediv> | |
| 7377 | |
| 7378 <refsynopsisdiv> | |
| 7379 <programlisting xml:id="annotation.graphic.open.frag"> | |
| 7380 <xsl:param name="annotation.graphic.open">http://docbook.sourceforge.net/r
elease/images/annot-open.png</xsl:param> | |
| 7381 </programlisting> | |
| 7382 </refsynopsisdiv> | |
| 7383 | |
| 7384 <refsection><info><title>Description</title></info> | |
| 7385 | |
| 7386 <para>This image is used inline to identify the location of | |
| 7387 annotations. It may be replaced by a user provided graphic. The size should be a
pproximately 10x10 pixels.</para> | |
| 7388 | |
| 7389 </refsection> | |
| 7390 </refentry> | |
| 7391 | |
| 7392 <refentry version="5.0" xml:id="annotation.graphic.close"> | |
| 7393 <refmeta> | |
| 7394 <refentrytitle>annotation.graphic.close</refentrytitle> | |
| 7395 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> | |
| 7396 </refmeta> | |
| 7397 <refnamediv> | |
| 7398 <refname>annotation.graphic.close</refname> | |
| 7399 <refpurpose>Image for identifying a link that closes an annotation popup</refpur
pose> | |
| 7400 </refnamediv> | |
| 7401 | |
| 7402 <refsynopsisdiv> | |
| 7403 <programlisting xml:id="annotation.graphic.close.frag"> | |
| 7404 <xsl:param name="annotation.graphic.close"> | |
| 7405 http://docbook.sourceforge.net/release/images/annot-close.png</xsl:param> | |
| 7406 </programlisting> | |
| 7407 </refsynopsisdiv> | |
| 7408 | |
| 7409 <refsection><info><title>Description</title></info> | |
| 7410 | |
| 7411 <para>This image is used on popup annotations as the “x” that the | |
| 7412 user can click to dismiss the popup.</para> | |
| 7413 <para>This image is used on popup annotations as the “x” that the us
er can | |
| 7414 click to dismiss the popup. It may be replaced by a user provided graphic. The s
ize should be approximately 10x10 pixels.</para> | |
| 7415 | |
| 7416 </refsection> | |
| 7417 </refentry> | |
| 7418 | |
| 7419 </reference> | |
| 7420 <reference xml:id="graphics"><title>Graphics</title> | |
| 7421 <refentry version="5.0" xml:id="img.src.path"> | |
| 7422 <refmeta> | |
| 7423 <refentrytitle>img.src.path</refentrytitle> | |
| 7424 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 7425 </refmeta> | |
| 7426 <refnamediv> | |
| 7427 <refname>img.src.path</refname> | |
| 7428 <refpurpose>Path to HTML/FO image files</refpurpose> | |
| 7429 </refnamediv> | |
| 7430 | |
| 7431 <refsynopsisdiv> | |
| 7432 <programlisting xml:id="img.src.path.frag"><xsl:param name="img.src.path">
</xsl:param></programlisting> | |
| 7433 </refsynopsisdiv> | |
| 7434 | |
| 7435 <refsection><info><title>Description</title></info> | |
| 7436 | |
| 7437 <para>Add a path prefix to the value of the <tag class="attribute">fileref</tag>
| |
| 7438 attribute of <tag>graphic</tag>, <tag>inlinegraphic</tag>, and <tag>imagedata</t
ag> elements. The resulting | |
| 7439 compound path is used in the output as the value of the <tag class="attribute">s
rc</tag> | |
| 7440 attribute of <tag class="element">img</tag> (HTML) or <tag class="element">exter
nal-graphic</tag> (FO). | |
| 7441 </para> | |
| 7442 | |
| 7443 <para> | |
| 7444 The path given by <literal>img.src.path</literal> could be relative to the direc
tory where the HTML/FO | |
| 7445 files are created, or it could be an absolute URI. | |
| 7446 The default value is empty. | |
| 7447 Be sure to include a trailing slash if needed. | |
| 7448 </para> | |
| 7449 | |
| 7450 <para>This prefix is not applied to any filerefs that start | |
| 7451 with "/" or contain "//:". | |
| 7452 </para> | |
| 7453 | |
| 7454 </refsection> | |
| 7455 </refentry> | |
| 7456 | |
| 7457 <refentry version="5.0" xml:id="keep.relative.image.uris"> | |
| 7458 <refmeta> | |
| 7459 <refentrytitle>keep.relative.image.uris</refentrytitle> | |
| 7460 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 7461 </refmeta> | |
| 7462 <refnamediv> | |
| 7463 <refname>keep.relative.image.uris</refname> | |
| 7464 <refpurpose>Should image URIs be resolved against xml:base?</refpurpose> | |
| 7465 </refnamediv> | |
| 7466 | |
| 7467 <refsynopsisdiv> | |
| 7468 <programlisting xml:id="keep.relative.image.uris.frag"> | |
| 7469 <xsl:param name="keep.relative.image.uris" select="1"></xsl:param> | |
| 7470 | |
| 7471 </programlisting> | |
| 7472 </refsynopsisdiv> | |
| 7473 | |
| 7474 <refsection><info><title>Description</title></info> | |
| 7475 | |
| 7476 <para>If non-zero, relative URIs (in, for example | |
| 7477 <literal>fileref</literal> attributes) will be used in the generated | |
| 7478 output. Otherwise, the URIs will be made absolute with respect to the | |
| 7479 base URI.</para> | |
| 7480 | |
| 7481 <para>Note that the stylesheets calculate (and use) the absolute form | |
| 7482 for some purposes, this only applies to the resulting output.</para> | |
| 7483 | |
| 7484 </refsection> | |
| 7485 </refentry> | |
| 7486 | |
| 7487 <refentry version="5.0" xml:id="graphic.default.extension"> | |
| 7488 <refmeta> | |
| 7489 <refentrytitle>graphic.default.extension</refentrytitle> | |
| 7490 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 7491 </refmeta> | |
| 7492 <refnamediv> | |
| 7493 <refname>graphic.default.extension</refname> | |
| 7494 <refpurpose>Default extension for graphic filenames</refpurpose> | |
| 7495 </refnamediv> | |
| 7496 | |
| 7497 <refsynopsisdiv> | |
| 7498 <programlisting xml:id="graphic.default.extension.frag"><xsl:param name="grap
hic.default.extension"></xsl:param></programlisting> | |
| 7499 </refsynopsisdiv> | |
| 7500 | |
| 7501 <refsection><info><title>Description</title></info> | |
| 7502 | |
| 7503 <para>If a <tag>graphic</tag> or <tag>mediaobject</tag> | |
| 7504 includes a reference to a filename that does not include an extension, | |
| 7505 and the <tag class="attribute">format</tag> attribute is | |
| 7506 <emphasis>unspecified</emphasis>, the default extension will be used. | |
| 7507 </para> | |
| 7508 | |
| 7509 </refsection> | |
| 7510 </refentry> | |
| 7511 | |
| 7512 <refentry version="5.0" xml:id="default.image.width"> | |
| 7513 <refmeta> | |
| 7514 <refentrytitle>default.image.width</refentrytitle> | |
| 7515 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> | |
| 7516 </refmeta> | |
| 7517 <refnamediv> | |
| 7518 <refname>default.image.width</refname> | |
| 7519 <refpurpose>The default width of images</refpurpose> | |
| 7520 </refnamediv> | |
| 7521 | |
| 7522 <refsynopsisdiv> | |
| 7523 <programlisting xml:id="default.image.width.frag"> | |
| 7524 <xsl:param name="default.image.width"></xsl:param> | |
| 7525 </programlisting> | |
| 7526 </refsynopsisdiv> | |
| 7527 | |
| 7528 <refsection><info><title>Description</title></info> | |
| 7529 | |
| 7530 <para>If specified, this value will be used for the | |
| 7531 <tag class="attribute">width</tag> attribute on images that do not specify any | |
| 7532 <emphasis xmlns:xlink="http://www.w3.org/1999/xlink" xlink:title="DocBook 5: The
Definitive Guide" xlink:href="http://docbook.org/tdg5/en/html/imagedata.html#vi
ewport.area">viewport dimensions</emphasis>.</para> | |
| 7533 | |
| 7534 </refsection> | |
| 7535 </refentry> | |
| 7536 | |
| 7537 <refentry version="5.0" xml:id="nominal.image.width"> | |
| 7538 <refmeta> | |
| 7539 <refentrytitle>nominal.image.width</refentrytitle> | |
| 7540 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> | |
| 7541 </refmeta> | |
| 7542 <refnamediv> | |
| 7543 <refname>nominal.image.width</refname> | |
| 7544 <refpurpose>The nominal image width</refpurpose> | |
| 7545 </refnamediv> | |
| 7546 | |
| 7547 <refsynopsisdiv> | |
| 7548 <programlisting xml:id="nominal.image.width.frag"> | |
| 7549 <xsl:param name="nominal.image.width" select="6 * $pixels.per.inch"></x
sl:param> | |
| 7550 </programlisting> | |
| 7551 </refsynopsisdiv> | |
| 7552 | |
| 7553 <refsection><info><title>Description</title></info> | |
| 7554 | |
| 7555 <para>Graphic widths expressed as a percentage are problematic. In the | |
| 7556 following discussion, we speak of width and contentwidth, but | |
| 7557 the same issues apply to depth and contentdepth.</para> | |
| 7558 | |
| 7559 <para>A width of 50% means "half of the available space for the image." | |
| 7560 That's fine. But note that in HTML, this is a dynamic property and | |
| 7561 the image size will vary if the browser window is resized.</para> | |
| 7562 | |
| 7563 <para>A contentwidth of 50% means "half of the actual image width". | |
| 7564 But what does that mean if the stylesheets cannot assess the image's | |
| 7565 actual size? Treating this as a width of 50% is one possibility, but | |
| 7566 it produces behavior (dynamic scaling) that seems entirely out of | |
| 7567 character with the meaning.</para> | |
| 7568 | |
| 7569 <para>Instead, the stylesheets define a | |
| 7570 <parameter>nominal.image.width</parameter> and convert percentages to | |
| 7571 actual values based on that nominal size.</para> | |
| 7572 | |
| 7573 </refsection> | |
| 7574 </refentry> | |
| 7575 | |
| 7576 <refentry version="5.0" xml:id="nominal.image.depth"> | |
| 7577 <refmeta> | |
| 7578 <refentrytitle>nominal.image.depth</refentrytitle> | |
| 7579 <refmiscinfo class="other" otherclass="datatype">length</refmiscinfo> | |
| 7580 </refmeta> | |
| 7581 <refnamediv> | |
| 7582 <refname>nominal.image.depth</refname> | |
| 7583 <refpurpose>Nominal image depth</refpurpose> | |
| 7584 </refnamediv> | |
| 7585 | |
| 7586 <refsynopsisdiv> | |
| 7587 <programlisting xml:id="nominal.image.depth.frag"> | |
| 7588 <xsl:param name="nominal.image.depth" select="4 * $pixels.per.inch"></x
sl:param> | |
| 7589 </programlisting> | |
| 7590 </refsynopsisdiv> | |
| 7591 | |
| 7592 <refsection><info><title>Description</title></info> | |
| 7593 | |
| 7594 <para>See <parameter>nominal.image.width</parameter>.</para> | |
| 7595 | |
| 7596 </refsection> | |
| 7597 </refentry> | |
| 7598 | |
| 7599 <refentry version="5.0" xml:id="use.embed.for.svg"> | |
| 7600 <refmeta> | |
| 7601 <refentrytitle>use.embed.for.svg</refentrytitle> | |
| 7602 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 7603 </refmeta> | |
| 7604 <refnamediv> | |
| 7605 <refname>use.embed.for.svg</refname> | |
| 7606 <refpurpose>Use HTML <tag>embed</tag> for SVG?</refpurpose> | |
| 7607 </refnamediv> | |
| 7608 | |
| 7609 <refsynopsisdiv> | |
| 7610 <programlisting xml:id="use.embed.for.svg.frag"> | |
| 7611 <xsl:param name="use.embed.for.svg" select="0"></xsl:param> | |
| 7612 </programlisting> | |
| 7613 </refsynopsisdiv> | |
| 7614 | |
| 7615 <refsection><info><title>Description</title></info> | |
| 7616 | |
| 7617 <para>If non-zero, an <tag>embed</tag> element will be created for | |
| 7618 SVG figures. An <tag>object</tag> is <emphasis>always</emphasis> created, | |
| 7619 this parameter merely controls whether or not an additional <tag>embed</tag> | |
| 7620 is generated inside the <tag>object</tag>.</para> | |
| 7621 | |
| 7622 <para>On the plus side, this may be more portable among browsers and plug-ins. | |
| 7623 On the minus side, it isn't valid HTML.</para> | |
| 7624 | |
| 7625 </refsection> | |
| 7626 </refentry> | |
| 7627 | |
| 7628 <refentry version="5.0" xml:id="make.graphic.viewport"> | |
| 7629 <refmeta> | |
| 7630 <refentrytitle>make.graphic.viewport</refentrytitle> | |
| 7631 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 7632 </refmeta> | |
| 7633 <refnamediv> | |
| 7634 <refname>make.graphic.viewport</refname> | |
| 7635 <refpurpose>Use tables in HTML to make viewports for graphics</refpurpose> | |
| 7636 </refnamediv> | |
| 7637 | |
| 7638 <refsynopsisdiv> | |
| 7639 <programlisting xml:id="make.graphic.viewport.frag"> | |
| 7640 <xsl:param name="make.graphic.viewport" select="1"></xsl:param> | |
| 7641 </programlisting> | |
| 7642 </refsynopsisdiv> | |
| 7643 | |
| 7644 <refsection><info><title>Description</title></info> | |
| 7645 | |
| 7646 <para>The HTML <tag>img</tag> element only supports the notion | |
| 7647 of content-area scaling; it doesn't support the distinction between a | |
| 7648 content-area and a viewport-area, so we have to make some compromises.</para> | |
| 7649 | |
| 7650 <para>If <parameter>make.graphic.viewport</parameter> is non-zero, a table | |
| 7651 will be used to frame the image. This creates an effective viewport-area. | |
| 7652 </para> | |
| 7653 | |
| 7654 <para>Tables and alignment don't work together, so this parameter is ignored | |
| 7655 if alignment is specified on an image.</para> | |
| 7656 </refsection> | |
| 7657 </refentry> | |
| 7658 | |
| 7659 <refentry version="5.0" xml:id="preferred.mediaobject.role"> | |
| 7660 <refmeta> | |
| 7661 <refentrytitle>preferred.mediaobject.role</refentrytitle> | |
| 7662 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 7663 </refmeta> | |
| 7664 <refnamediv> | |
| 7665 <refname>preferred.mediaobject.role</refname> | |
| 7666 <refpurpose>Select which mediaobject to use based on | |
| 7667 this value of an object's <tag class="attribute">role</tag> attribute. | |
| 7668 </refpurpose> | |
| 7669 </refnamediv> | |
| 7670 | |
| 7671 <refsynopsisdiv> | |
| 7672 <programlisting xml:id="preferred.mediaobject.role.frag"> | |
| 7673 <xsl:param name="preferred.mediaobject.role"></xsl:param> | |
| 7674 </programlisting> | |
| 7675 </refsynopsisdiv> | |
| 7676 | |
| 7677 <refsection><info><title>Description</title></info> | |
| 7678 | |
| 7679 <para>A mediaobject may contain several objects such as imageobjects. | |
| 7680 If the parameter <parameter>use.role.for.mediaobject</parameter> is | |
| 7681 non-zero, then the <literal>role</literal> attribute on | |
| 7682 <tag>imageobject</tag>s and other objects within a | |
| 7683 <tag>mediaobject</tag> container will be used to select which object | |
| 7684 will be used. If one of the objects has a role value that matches the | |
| 7685 <parameter>preferred.mediaobject.role</parameter> parameter, then it | |
| 7686 has first priority for selection. If more than one has such a role | |
| 7687 value, the first one is used. | |
| 7688 </para> | |
| 7689 <para> | |
| 7690 See the <parameter>use.role.for.mediaobject</parameter> parameter | |
| 7691 for the sequence of selection.</para> | |
| 7692 </refsection> | |
| 7693 </refentry> | |
| 7694 | |
| 7695 <refentry version="5.0" xml:id="use.role.for.mediaobject"> | |
| 7696 <refmeta> | |
| 7697 <refentrytitle>use.role.for.mediaobject</refentrytitle> | |
| 7698 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 7699 </refmeta> | |
| 7700 <refnamediv> | |
| 7701 <refname>use.role.for.mediaobject</refname> | |
| 7702 <refpurpose>Use <tag class="attribute">role</tag> attribute | |
| 7703 value for selecting which of several objects within a mediaobject to use. | |
| 7704 </refpurpose> | |
| 7705 </refnamediv> | |
| 7706 | |
| 7707 <refsynopsisdiv> | |
| 7708 <programlisting xml:id="use.role.for.mediaobject.frag"> | |
| 7709 <xsl:param name="use.role.for.mediaobject" select="1"></xsl:param> | |
| 7710 </programlisting> | |
| 7711 </refsynopsisdiv> | |
| 7712 | |
| 7713 <refsection><info><title>Description</title></info> | |
| 7714 | |
| 7715 <para>If non-zero, the <tag class="attribute">role</tag> attribute on | |
| 7716 <tag>imageobject</tag>s or other objects within a <tag>mediaobject</tag> contain
er will be used to select which object will be | |
| 7717 used. | |
| 7718 </para> | |
| 7719 <para> | |
| 7720 The order of selection when then parameter is non-zero is: | |
| 7721 </para> | |
| 7722 <orderedlist> | |
| 7723 <listitem> | |
| 7724 <para>If the stylesheet parameter <parameter>preferred.mediaobject.role</par
ameter> has a value, then the object whose role equals that value is selected.</
para> | |
| 7725 </listitem> | |
| 7726 <listitem> | |
| 7727 <para>Else if an object's role attribute has a value of | |
| 7728 <literal>html</literal> for HTML processing or | |
| 7729 <literal>fo</literal> for FO output, then the first | |
| 7730 of such objects is selected. | |
| 7731 </para> | |
| 7732 </listitem> | |
| 7733 <listitem> | |
| 7734 <para>Else the first suitable object is selected.</para> | |
| 7735 </listitem> | |
| 7736 </orderedlist> | |
| 7737 <para> | |
| 7738 If the value of | |
| 7739 <parameter>use.role.for.mediaobject</parameter> | |
| 7740 is zero, then role attributes are not considered | |
| 7741 and the first suitable object | |
| 7742 with or without a role value is used. | |
| 7743 </para> | |
| 7744 </refsection> | |
| 7745 </refentry> | |
| 7746 | |
| 7747 <refentry version="5.0" xml:id="ignore.image.scaling"> | |
| 7748 <refmeta> | |
| 7749 <refentrytitle>ignore.image.scaling</refentrytitle> | |
| 7750 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 7751 </refmeta> | |
| 7752 <refnamediv> | |
| 7753 <refname>ignore.image.scaling</refname> | |
| 7754 <refpurpose>Tell the stylesheets to ignore the author's image scaling attributes
</refpurpose> | |
| 7755 </refnamediv> | |
| 7756 | |
| 7757 <refsynopsisdiv> | |
| 7758 <programlisting xml:id="ignore.image.scaling.frag"> | |
| 7759 <xsl:param name="ignore.image.scaling" select="0"></xsl:param> | |
| 7760 </programlisting> | |
| 7761 </refsynopsisdiv> | |
| 7762 | |
| 7763 <refsection><info><title>Description</title></info> | |
| 7764 | |
| 7765 <para>If non-zero, the scaling attributes on graphics and media objects are | |
| 7766 ignored.</para> | |
| 7767 | |
| 7768 </refsection> | |
| 7769 </refentry> | |
| 7770 | |
| 7771 </reference> | |
| 7772 <reference xml:id="chunking"><title>Chunking</title> | |
| 7773 <refentry version="5.0" xml:id="chunker.output.cdata-section-elements"> | |
| 7774 <refmeta> | |
| 7775 <refentrytitle>chunker.output.cdata-section-elements</refentrytitle> | |
| 7776 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 7777 </refmeta> | |
| 7778 <refnamediv> | |
| 7779 <refname>chunker.output.cdata-section-elements</refname> | |
| 7780 <refpurpose>List of elements to escape with CDATA sections</refpurpose> | |
| 7781 </refnamediv> | |
| 7782 <refsynopsisdiv> | |
| 7783 <programlisting xml:id="chunker.output.cdata-section-elements.frag"> | |
| 7784 <xsl:param name="chunker.output.cdata-section-elements"></xsl:param> | |
| 7785 </programlisting> | |
| 7786 </refsynopsisdiv> | |
| 7787 <refsection><info><title>Description</title></info> | |
| 7788 <para>This parameter specifies the list of elements that should be escaped | |
| 7789 as CDATA sections by the chunking stylesheet. Not all processors support | |
| 7790 specification of this parameter. | |
| 7791 </para> | |
| 7792 <note> | |
| 7793 <para>This parameter is documented here, but the declaration is actually | |
| 7794 in the <filename>chunker.xsl</filename> stylesheet module.</para> | |
| 7795 </note> | |
| 7796 </refsection> | |
| 7797 </refentry> | |
| 7798 | |
| 7799 <refentry version="5.0" xml:id="chunker.output.doctype-public"> | |
| 7800 <refmeta> | |
| 7801 <refentrytitle>chunker.output.doctype-public</refentrytitle> | |
| 7802 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 7803 </refmeta> | |
| 7804 <refnamediv> | |
| 7805 <refname>chunker.output.doctype-public</refname> | |
| 7806 <refpurpose>Public identifer to use in the document type of generated pages</ref
purpose> | |
| 7807 </refnamediv> | |
| 7808 <refsynopsisdiv> | |
| 7809 <programlisting xml:id="chunker.output.doctype-public.frag"> | |
| 7810 <xsl:param name="chunker.output.doctype-public"></xsl:param> | |
| 7811 </programlisting> | |
| 7812 </refsynopsisdiv> | |
| 7813 <refsection><info><title>Description</title></info> | |
| 7814 <para>This parameter specifies the public identifier that should be used by | |
| 7815 the chunking stylesheet in the document type declaration of chunked pages. | |
| 7816 Not all processors support specification of | |
| 7817 this parameter. | |
| 7818 </para> | |
| 7819 <note> | |
| 7820 <para>This parameter is documented here, but the declaration is actually | |
| 7821 in the <filename>chunker.xsl</filename> stylesheet module.</para> | |
| 7822 </note> | |
| 7823 </refsection> | |
| 7824 </refentry> | |
| 7825 | |
| 7826 <refentry version="5.0" xml:id="chunker.output.doctype-system"> | |
| 7827 <refmeta> | |
| 7828 <refentrytitle>chunker.output.doctype-system</refentrytitle> | |
| 7829 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> | |
| 7830 </refmeta> | |
| 7831 <refnamediv> | |
| 7832 <refname>chunker.output.doctype-system</refname> | |
| 7833 <refpurpose>System identifier to use for the document type in generated pages</r
efpurpose> | |
| 7834 </refnamediv> | |
| 7835 <refsynopsisdiv> | |
| 7836 <programlisting xml:id="chunker.output.doctype-system.frag"> | |
| 7837 <xsl:param name="chunker.output.doctype-system"></xsl:param> | |
| 7838 </programlisting> | |
| 7839 </refsynopsisdiv> | |
| 7840 <refsection><info><title>Description</title></info> | |
| 7841 <para>This parameter specifies the system identifier that should be used by | |
| 7842 the chunking stylesheet in the document type declaration of chunked pages. | |
| 7843 Not all processors support specification of | |
| 7844 this parameter. | |
| 7845 </para> | |
| 7846 <note> | |
| 7847 <para>This parameter is documented here, but the declaration is actually | |
| 7848 in the <filename>chunker.xsl</filename> stylesheet module.</para> | |
| 7849 </note> | |
| 7850 </refsection> | |
| 7851 </refentry> | |
| 7852 | |
| 7853 <refentry version="5.0" xml:id="chunker.output.encoding"> | |
| 7854 <refmeta> | |
| 7855 <refentrytitle>chunker.output.encoding</refentrytitle> | |
| 7856 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 7857 </refmeta> | |
| 7858 <refnamediv> | |
| 7859 <refname>chunker.output.encoding</refname> | |
| 7860 <refpurpose>Encoding used in generated pages</refpurpose> | |
| 7861 </refnamediv> | |
| 7862 <refsynopsisdiv> | |
| 7863 <programlisting xml:id="chunker.output.encoding.frag"> | |
| 7864 <xsl:param name="chunker.output.encoding">ISO-8859-1</xsl:param> | |
| 7865 </programlisting> | |
| 7866 </refsynopsisdiv> | |
| 7867 <refsection><info><title>Description</title></info> | |
| 7868 <para>This parameter specifies the encoding to be used in files | |
| 7869 generated by the chunking stylesheet. Not all processors support | |
| 7870 specification of this parameter. | |
| 7871 </para> | |
| 7872 <para>This parameter used to be named <literal>default.encoding</literal>.</para
> | |
| 7873 <note> | |
| 7874 <para>This parameter is documented here, but the declaration is actually | |
| 7875 in the <filename>chunker.xsl</filename> stylesheet module.</para> | |
| 7876 </note> | |
| 7877 </refsection> | |
| 7878 </refentry> | |
| 7879 | |
| 7880 <refentry version="5.0" xml:id="chunker.output.indent"> | |
| 7881 <refmeta> | |
| 7882 <refentrytitle>chunker.output.indent</refentrytitle> | |
| 7883 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 7884 </refmeta> | |
| 7885 <refnamediv> | |
| 7886 <refname>chunker.output.indent</refname> | |
| 7887 <refpurpose>Specification of indentation on generated pages</refpurpose> | |
| 7888 </refnamediv> | |
| 7889 <refsynopsisdiv> | |
| 7890 <programlisting xml:id="chunker.output.indent.frag"> | |
| 7891 <xsl:param name="chunker.output.indent">no</xsl:param> | |
| 7892 </programlisting> | |
| 7893 </refsynopsisdiv> | |
| 7894 <refsection><info><title>Description</title></info> | |
| 7895 <para>This parameter specifies the value of the indent | |
| 7896 specification for generated pages. Not all processors support | |
| 7897 specification of this parameter. | |
| 7898 </para> | |
| 7899 <note> | |
| 7900 <para>This parameter is documented here, but the declaration is actually | |
| 7901 in the <filename>chunker.xsl</filename> stylesheet module.</para> | |
| 7902 </note> | |
| 7903 </refsection> | |
| 7904 </refentry> | |
| 7905 | |
| 7906 <refentry version="5.0" xml:id="chunker.output.media-type"> | |
| 7907 <refmeta> | |
| 7908 <refentrytitle>chunker.output.media-type</refentrytitle> | |
| 7909 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 7910 </refmeta> | |
| 7911 <refnamediv> | |
| 7912 <refname>chunker.output.media-type</refname> | |
| 7913 <refpurpose>Media type to use in generated pages</refpurpose> | |
| 7914 </refnamediv> | |
| 7915 <refsynopsisdiv> | |
| 7916 <programlisting xml:id="chunker.output.media-type.frag"> | |
| 7917 <xsl:param name="chunker.output.media-type"></xsl:param> | |
| 7918 </programlisting> | |
| 7919 </refsynopsisdiv> | |
| 7920 <refsection><info><title>Description</title></info> | |
| 7921 <para>This parameter specifies the media type that should be used by | |
| 7922 the chunking stylesheet. Not all processors support specification of | |
| 7923 this parameter. | |
| 7924 </para> | |
| 7925 <para>This parameter specifies the media type that should be used by the | |
| 7926 chunking stylesheet. This should be one from those defined in | |
| 7927 <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.ietf.org
/rfc/rfc2045.txt">[RFC2045]</link> and | |
| 7928 <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.ietf.or
g/rfc/rfc2046.txt">[RFC2046]</link> </para> | |
| 7929 <note> | |
| 7930 <para>This parameter is documented here, but the declaration is actually | |
| 7931 in the <filename>chunker.xsl</filename> stylesheet module.</para> | |
| 7932 <para>It must be one from html, xml or text</para> | |
| 7933 </note> | |
| 7934 </refsection> | |
| 7935 </refentry> | |
| 7936 | |
| 7937 <refentry version="5.0" xml:id="chunker.output.method"> | |
| 7938 <refmeta> | |
| 7939 <refentrytitle>chunker.output.method</refentrytitle> | |
| 7940 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> | |
| 7941 <refmiscinfo class="other" otherclass="value">html</refmiscinfo> | |
| 7942 <refmiscinfo class="other" otherclass="value">xml</refmiscinfo> | |
| 7943 </refmeta> | |
| 7944 <refnamediv> | |
| 7945 <refname>chunker.output.method</refname> | |
| 7946 <refpurpose>Method used in generated pages</refpurpose> | |
| 7947 </refnamediv> | |
| 7948 <refsynopsisdiv> | |
| 7949 <programlisting xml:id="chunker.output.method.frag"> | |
| 7950 <xsl:param name="chunker.output.method">html</xsl:param> | |
| 7951 </programlisting> | |
| 7952 </refsynopsisdiv> | |
| 7953 <refsection><info><title>Description</title></info> | |
| 7954 <para>This parameter specifies the output method to be used in files | |
| 7955 generated by the chunking stylesheet. | |
| 7956 </para> | |
| 7957 <para>This parameter used to be named <literal>output.method</literal>.</para> | |
| 7958 <note> | |
| 7959 <para>This parameter is documented here, but the declaration is actually | |
| 7960 in the <filename>chunker.xsl</filename> stylesheet module.</para> | |
| 7961 </note> | |
| 7962 </refsection> | |
| 7963 </refentry> | |
| 7964 | |
| 7965 <refentry version="5.0" xml:id="chunker.output.omit-xml-declaration"> | |
| 7966 <refmeta> | |
| 7967 <refentrytitle>chunker.output.omit-xml-declaration</refentrytitle> | |
| 7968 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 7969 </refmeta> | |
| 7970 <refnamediv> | |
| 7971 <refname>chunker.output.omit-xml-declaration</refname> | |
| 7972 <refpurpose>Omit-xml-declaration for generated pages</refpurpose> | |
| 7973 </refnamediv> | |
| 7974 <refsynopsisdiv> | |
| 7975 <programlisting xml:id="chunker.output.omit-xml-declaration.frag"> | |
| 7976 <xsl:param name="chunker.output.omit-xml-declaration">no</xsl:param> | |
| 7977 </programlisting> | |
| 7978 </refsynopsisdiv> | |
| 7979 <refsection><info><title>Description</title></info> | |
| 7980 <para>This parameter specifies the value of the omit-xml-declaration | |
| 7981 specification for generated pages. Not all processors support | |
| 7982 specification of this parameter. | |
| 7983 </para> | |
| 7984 <note> | |
| 7985 <para>This parameter is documented here, but the declaration is actually | |
| 7986 in the <filename>chunker.xsl</filename> stylesheet module.</para> | |
| 7987 </note> | |
| 7988 </refsection> | |
| 7989 </refentry> | |
| 7990 | |
| 7991 <refentry version="5.0" xml:id="chunker.output.standalone"> | |
| 7992 <refmeta> | |
| 7993 <refentrytitle>chunker.output.standalone</refentrytitle> | |
| 7994 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 7995 </refmeta> | |
| 7996 <refnamediv> | |
| 7997 <refname>chunker.output.standalone</refname> | |
| 7998 <refpurpose>Standalone declaration for generated pages</refpurpose> | |
| 7999 </refnamediv> | |
| 8000 <refsynopsisdiv> | |
| 8001 <programlisting xml:id="chunker.output.standalone.frag"> | |
| 8002 <xsl:param name="chunker.output.standalone">no</xsl:param> | |
| 8003 </programlisting> | |
| 8004 </refsynopsisdiv> | |
| 8005 <refsection><info><title>Description</title></info> | |
| 8006 <para>This parameter specifies the value of the standalone | |
| 8007 specification for generated pages. It must be either | |
| 8008 <literal>yes</literal> or <literal>no</literal>. Not all | |
| 8009 processors support specification of this parameter. | |
| 8010 </para> | |
| 8011 <note> | |
| 8012 <para>This parameter is documented here, but the declaration is actually | |
| 8013 in the <filename>chunker.xsl</filename> stylesheet module.</para> | |
| 8014 </note> | |
| 8015 </refsection> | |
| 8016 </refentry> | |
| 8017 | |
| 8018 <refentry version="5.0" xml:id="saxon.character.representation"> | |
| 8019 <refmeta> | |
| 8020 <refentrytitle>saxon.character.representation</refentrytitle> | |
| 8021 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 8022 </refmeta> | |
| 8023 <refnamediv> | |
| 8024 <refname>saxon.character.representation</refname> | |
| 8025 <refpurpose>Saxon character representation used in generated HTML pages</refpurp
ose> | |
| 8026 </refnamediv> | |
| 8027 | |
| 8028 <refsynopsisdiv> | |
| 8029 <programlisting xml:id="saxon.character.representation.frag"><xsl:param nam
e="saxon.character.representation" select="'entity;decimal'"></xsl:param&g
t;</programlisting> | |
| 8030 </refsynopsisdiv> | |
| 8031 | |
| 8032 <refsection><info><title>Description</title></info> | |
| 8033 | |
| 8034 <para>This parameter has effect only when Saxon 6 is used (version 6.4.2 or late
r). | |
| 8035 It sets the character representation in files generated by the chunking styleshe
ets. | |
| 8036 If you want to suppress entity references for characters with direct representat
ions in | |
| 8037 <parameter>chunker.output.encoding</parameter>, set the parameter value to <lite
ral>native</literal>. | |
| 8038 </para> | |
| 8039 | |
| 8040 <para> For more information, see <link xmlns:xlink="http://www.w3.org/1999/xlink
" role="tcg" xlink:href="OutputEncoding.html#SaxonCharacter">Saxon output charac
ter representation</link>.</para> | |
| 8041 | |
| 8042 <note> | |
| 8043 <para>This parameter is documented here, but the declaration is actually | |
| 8044 in the <filename>chunker.xsl</filename> stylesheet module.</para> | |
| 8045 </note> | |
| 8046 | |
| 8047 </refsection> | |
| 8048 | |
| 8049 </refentry> | |
| 8050 | |
| 8051 <refentry version="5.0" xml:id="html.ext"> | |
| 8052 <refmeta> | |
| 8053 <refentrytitle>html.ext</refentrytitle> | |
| 8054 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 8055 </refmeta> | |
| 8056 <refnamediv> | |
| 8057 <refname>html.ext</refname> | |
| 8058 <refpurpose>Identifies the extension of generated HTML files</refpurpose> | |
| 8059 </refnamediv> | |
| 8060 | |
| 8061 <refsynopsisdiv> | |
| 8062 <programlisting xml:id="html.ext.frag"> | |
| 8063 <xsl:param name="html.ext">.html</xsl:param> | |
| 8064 </programlisting> | |
| 8065 </refsynopsisdiv> | |
| 8066 | |
| 8067 <refsection><info><title>Description</title></info> | |
| 8068 | |
| 8069 <para>The extension identified by <parameter>html.ext</parameter> will | |
| 8070 be used as the filename extension for chunks created by this | |
| 8071 stylesheet. </para> | |
| 8072 | |
| 8073 </refsection> | |
| 8074 </refentry> | |
| 8075 | |
| 8076 <refentry version="5.0" xml:id="use.id.as.filename"> | |
| 8077 <refmeta> | |
| 8078 <refentrytitle>use.id.as.filename</refentrytitle> | |
| 8079 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 8080 </refmeta> | |
| 8081 <refnamediv> | |
| 8082 <refname>use.id.as.filename</refname> | |
| 8083 <refpurpose>Use ID value of chunk elements as the filename?</refpurpose> | |
| 8084 </refnamediv> | |
| 8085 | |
| 8086 <refsynopsisdiv> | |
| 8087 <programlisting xml:id="use.id.as.filename.frag"> | |
| 8088 <xsl:param name="use.id.as.filename" select="0"></xsl:param> | |
| 8089 </programlisting> | |
| 8090 </refsynopsisdiv> | |
| 8091 | |
| 8092 <refsection><info><title>Description</title></info> | |
| 8093 | |
| 8094 <para>If <parameter>use.id.as.filename</parameter> | |
| 8095 is non-zero, the filename of chunk elements that have IDs will be | |
| 8096 derived from the ID value. | |
| 8097 </para> | |
| 8098 | |
| 8099 </refsection> | |
| 8100 </refentry> | |
| 8101 | |
| 8102 <refentry version="5.0" xml:id="html.extra.head.links"> | |
| 8103 <refmeta> | |
| 8104 <refentrytitle>html.extra.head.links</refentrytitle> | |
| 8105 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 8106 </refmeta> | |
| 8107 <refnamediv> | |
| 8108 <refname>html.extra.head.links</refname> | |
| 8109 <refpurpose>Toggle extra HTML head link information</refpurpose> | |
| 8110 </refnamediv> | |
| 8111 | |
| 8112 <refsynopsisdiv> | |
| 8113 <programlisting xml:id="html.extra.head.links.frag"> | |
| 8114 <xsl:param name="html.extra.head.links" select="0"></xsl:param> | |
| 8115 </programlisting> | |
| 8116 </refsynopsisdiv> | |
| 8117 | |
| 8118 <refsection><info><title>Description</title></info> | |
| 8119 | |
| 8120 <para>If non-zero, extra <tag>link</tag> elements will be | |
| 8121 generated in the <tag>head</tag> of chunked HTML files. These | |
| 8122 extra links point to chapters, appendixes, sections, etc. as supported | |
| 8123 by the <quote>Site Navigation Bar</quote> in Mozilla 1.0 (as of CR1, at least). | |
| 8124 </para> | |
| 8125 | |
| 8126 </refsection> | |
| 8127 </refentry> | |
| 8128 | |
| 8129 <refentry version="5.0" xml:id="root.filename"> | |
| 8130 <refmeta> | |
| 8131 <refentrytitle>root.filename</refentrytitle> | |
| 8132 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> | |
| 8133 </refmeta> | |
| 8134 <refnamediv> | |
| 8135 <refname>root.filename</refname> | |
| 8136 <refpurpose>Identifies the name of the root HTML file when chunking</refpurpose> | |
| 8137 </refnamediv> | |
| 8138 | |
| 8139 <refsynopsisdiv> | |
| 8140 <programlisting xml:id="root.filename.frag"> | |
| 8141 <xsl:param name="root.filename">index</xsl:param> | |
| 8142 </programlisting> | |
| 8143 </refsynopsisdiv> | |
| 8144 | |
| 8145 <refsection><info><title>Description</title></info> | |
| 8146 | |
| 8147 <para>The <parameter>root.filename</parameter> is the base filename for | |
| 8148 the chunk created for the root of each document processed. | |
| 8149 </para> | |
| 8150 | |
| 8151 </refsection> | |
| 8152 </refentry> | |
| 8153 | |
| 8154 <refentry version="5.0" xml:id="base.dir"> | |
| 8155 <refmeta> | |
| 8156 <refentrytitle>base.dir</refentrytitle> | |
| 8157 <refmiscinfo class="other" otherclass="datatype">uri</refmiscinfo> | |
| 8158 </refmeta> | |
| 8159 <refnamediv> | |
| 8160 <refname>base.dir</refname> | |
| 8161 <refpurpose>The base directory of chunks</refpurpose> | |
| 8162 </refnamediv> | |
| 8163 | |
| 8164 <refsynopsisdiv> | |
| 8165 <programlisting xml:id="base.dir.frag"> | |
| 8166 <xsl:param name="base.dir"></xsl:param> | |
| 8167 </programlisting> | |
| 8168 </refsynopsisdiv> | |
| 8169 | |
| 8170 <refsection><info><title>Description</title></info> | |
| 8171 | |
| 8172 <para>If specified, the <parameter>base.dir</parameter> parameter identifies | |
| 8173 the output directory for chunks. (If not specified, the output directory | |
| 8174 is system dependent.)</para> | |
| 8175 | |
| 8176 <para>Starting with version 1.77 of the stylesheets, | |
| 8177 the param's value will have a trailing slash added if it does | |
| 8178 not already have one.</para> | |
| 8179 | |
| 8180 <caution><para>Do not use <parameter>base.dir</parameter> | |
| 8181 to add a filename prefix string to chunked files. | |
| 8182 Instead, use the <parameter>chunked.filename.prefix</parameter> | |
| 8183 parameter.</para></caution> | |
| 8184 | |
| 8185 </refsection> | |
| 8186 </refentry> | |
| 8187 | |
| 8188 <refentry version="5.0" xml:id="chunked.filename.prefix"> | |
| 8189 <refmeta> | |
| 8190 <refentrytitle>chunked.filename.prefix</refentrytitle> | |
| 8191 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 8192 </refmeta> | |
| 8193 <refnamediv> | |
| 8194 <refname>chunked.filename.prefix</refname> | |
| 8195 <refpurpose>Filename prefix for chunked files</refpurpose> | |
| 8196 </refnamediv> | |
| 8197 | |
| 8198 <refsynopsisdiv> | |
| 8199 <programlisting xml:id="chunked.filename.prefix.frag"> | |
| 8200 <xsl:param name="chunked.filename.prefix"></xsl:param> | |
| 8201 </programlisting> | |
| 8202 </refsynopsisdiv> | |
| 8203 | |
| 8204 <refsection><info><title>Description</title></info> | |
| 8205 | |
| 8206 <para>If specified, the <parameter>chunked.filename.prefix</parameter> | |
| 8207 parameter specifies a prefix string to add to each generated chunk filename. | |
| 8208 For example:</para> | |
| 8209 <programlisting><xsl:param name="chunked.filename.prefix">admin-<xsl:pa
ram></programlisting> | |
| 8210 <para>will produce chunked filenames like:</para> | |
| 8211 <programlisting>admin-index.html | |
| 8212 admin-ch01.html | |
| 8213 admin-ch01s01.html | |
| 8214 ... | |
| 8215 </programlisting> | |
| 8216 | |
| 8217 <caution><para>Trying to use the <parameter>base.dir</parameter> | |
| 8218 parameter to add a string prefix (by omitting the trailing slash) | |
| 8219 no longer works (it never worked completely anyway). That parameter | |
| 8220 value should contain only a directory path, and | |
| 8221 now gets a trailing slash appended if it was omitted from the param.</para></cau
tion> | |
| 8222 </refsection> | |
| 8223 </refentry> | |
| 8224 | |
| 8225 <refentry version="5.0" xml:id="generate.manifest"> | |
| 8226 <refmeta> | |
| 8227 <refentrytitle>generate.manifest</refentrytitle> | |
| 8228 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 8229 </refmeta> | |
| 8230 <refnamediv> | |
| 8231 <refname>generate.manifest</refname> | |
| 8232 <refpurpose>Generate a manifest file?</refpurpose> | |
| 8233 </refnamediv> | |
| 8234 | |
| 8235 <refsynopsisdiv> | |
| 8236 <programlisting xml:id="generate.manifest.frag"><xsl:param name="generate
.manifest" select="0"></xsl:param></programlisting> | |
| 8237 </refsynopsisdiv> | |
| 8238 | |
| 8239 <refsection><info><title>Description</title></info> | |
| 8240 | |
| 8241 <para>If non-zero, a list of HTML files generated by the | |
| 8242 stylesheet transformation is written to the file named by | |
| 8243 the <parameter>manifest</parameter> parameter.</para> | |
| 8244 | |
| 8245 </refsection> | |
| 8246 </refentry> | |
| 8247 | |
| 8248 <refentry version="5.0" xml:id="manifest"> | |
| 8249 <refmeta> | |
| 8250 <refentrytitle>manifest</refentrytitle> | |
| 8251 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 8252 </refmeta> | |
| 8253 <refnamediv> | |
| 8254 <refname>manifest</refname> | |
| 8255 <refpurpose>Name of manifest file</refpurpose> | |
| 8256 </refnamediv> | |
| 8257 | |
| 8258 <refsynopsisdiv> | |
| 8259 <programlisting xml:id="manifest.frag"> | |
| 8260 <xsl:param name="manifest">HTML.manifest</xsl:param> | |
| 8261 </programlisting> | |
| 8262 </refsynopsisdiv> | |
| 8263 | |
| 8264 <refsection><info><title>Description</title></info> | |
| 8265 | |
| 8266 <para>The name of the file to which a manifest is written (if the | |
| 8267 value of the <parameter>generate.manifest</parameter> parameter | |
| 8268 is non-zero).</para> | |
| 8269 | |
| 8270 </refsection> | |
| 8271 </refentry> | |
| 8272 | |
| 8273 <refentry version="5.0" xml:id="manifest.in.base.dir"> | |
| 8274 <refmeta> | |
| 8275 <refentrytitle>manifest.in.base.dir</refentrytitle> | |
| 8276 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 8277 </refmeta> | |
| 8278 <refnamediv> | |
| 8279 <refname>manifest.in.base.dir</refname> | |
| 8280 <refpurpose>Should the manifest file be written into <parameter>base.dir</parame
ter>?</refpurpose> | |
| 8281 </refnamediv> | |
| 8282 | |
| 8283 <refsynopsisdiv> | |
| 8284 <programlisting xml:id="manifest.in.base.dir.frag"> | |
| 8285 <xsl:param name="manifest.in.base.dir" select="0"></xsl:param> | |
| 8286 </programlisting> | |
| 8287 </refsynopsisdiv> | |
| 8288 | |
| 8289 <refsection><info><title>Description</title></info> | |
| 8290 | |
| 8291 <para>If non-zero, the manifest file as well as project files for HTML Help and | |
| 8292 Eclipse Help are written into <parameter>base.dir</parameter> instead | |
| 8293 of the current directory.</para> | |
| 8294 | |
| 8295 </refsection> | |
| 8296 </refentry> | |
| 8297 | |
| 8298 <refentry version="5.0" xml:id="chunk.toc"> | |
| 8299 <refmeta> | |
| 8300 <refentrytitle>chunk.toc</refentrytitle> | |
| 8301 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 8302 </refmeta> | |
| 8303 <refnamediv> | |
| 8304 <refname>chunk.toc</refname> | |
| 8305 <refpurpose>An explicit TOC to be used for chunking</refpurpose> | |
| 8306 </refnamediv> | |
| 8307 | |
| 8308 <refsynopsisdiv> | |
| 8309 <programlisting xml:id="chunk.toc.frag"> | |
| 8310 <xsl:param name="chunk.toc"></xsl:param> | |
| 8311 </programlisting> | |
| 8312 </refsynopsisdiv> | |
| 8313 | |
| 8314 <refsection><info><title>Description</title></info> | |
| 8315 | |
| 8316 <para>The <parameter>chunk.toc</parameter> identifies an explicit TOC that | |
| 8317 will be used for chunking. This parameter is only used by the | |
| 8318 <filename>chunktoc.xsl</filename> stylesheet (and customization layers built | |
| 8319 from it).</para> | |
| 8320 | |
| 8321 </refsection> | |
| 8322 </refentry> | |
| 8323 | |
| 8324 <refentry version="5.0" xml:id="chunk.tocs.and.lots"> | |
| 8325 <refmeta> | |
| 8326 <refentrytitle>chunk.tocs.and.lots</refentrytitle> | |
| 8327 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 8328 </refmeta> | |
| 8329 <refnamediv> | |
| 8330 <refname>chunk.tocs.and.lots</refname> | |
| 8331 <refpurpose>Should ToC and LoTs be in separate chunks?</refpurpose> | |
| 8332 </refnamediv> | |
| 8333 | |
| 8334 <refsynopsisdiv> | |
| 8335 <programlisting xml:id="chunk.tocs.and.lots.frag"> | |
| 8336 <xsl:param name="chunk.tocs.and.lots" select="0"></xsl:param> | |
| 8337 </programlisting> | |
| 8338 </refsynopsisdiv> | |
| 8339 | |
| 8340 <refsection><info><title>Description</title></info> | |
| 8341 | |
| 8342 <para>If non-zero, ToC and LoT (List of Examples, List of Figures, etc.) | |
| 8343 will be put in a separate chunk. At the moment, this chunk is not in the | |
| 8344 normal forward/backward navigation list. Instead, a new link is added to the | |
| 8345 navigation footer.</para> | |
| 8346 | |
| 8347 <para>This feature is still somewhat experimental. Feedback welcome.</para> | |
| 8348 | |
| 8349 </refsection> | |
| 8350 </refentry> | |
| 8351 | |
| 8352 <refentry version="5.0" xml:id="chunk.separate.lots"> | |
| 8353 <refmeta> | |
| 8354 <refentrytitle>chunk.separate.lots</refentrytitle> | |
| 8355 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 8356 </refmeta> | |
| 8357 <refnamediv> | |
| 8358 <refname>chunk.separate.lots</refname> | |
| 8359 <refpurpose>Should each LoT be in its own separate chunk?</refpurpose> | |
| 8360 </refnamediv> | |
| 8361 | |
| 8362 <refsynopsisdiv> | |
| 8363 <programlisting xml:id="chunk.separate.lots.frag"> | |
| 8364 <xsl:param name="chunk.separate.lots" select="0"></xsl:param> | |
| 8365 </programlisting> | |
| 8366 </refsynopsisdiv> | |
| 8367 | |
| 8368 <refsection><info><title>Description</title></info> | |
| 8369 | |
| 8370 <para>If non-zero, each of the ToC and LoTs | |
| 8371 (List of Examples, List of Figures, etc.) | |
| 8372 will be put in its own separate chunk. | |
| 8373 The title page includes generated links to each of the separate files. | |
| 8374 </para> | |
| 8375 <para> | |
| 8376 This feature depends on the | |
| 8377 <parameter>chunk.tocs.and.lots</parameter> | |
| 8378 parameter also being non-zero. | |
| 8379 </para> | |
| 8380 | |
| 8381 </refsection> | |
| 8382 </refentry> | |
| 8383 | |
| 8384 <refentry version="5.0" xml:id="chunk.tocs.and.lots.has.title"> | |
| 8385 <refmeta> | |
| 8386 <refentrytitle>chunk.tocs.and.lots.has.title</refentrytitle> | |
| 8387 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 8388 </refmeta> | |
| 8389 <refnamediv> | |
| 8390 <refname>chunk.tocs.and.lots.has.title</refname> | |
| 8391 <refpurpose>Should ToC and LoTs in a separate chunks have title?</refpurpose> | |
| 8392 </refnamediv> | |
| 8393 | |
| 8394 <refsynopsisdiv> | |
| 8395 <programlisting xml:id="chunk.tocs.and.lots.has.title.frag"> | |
| 8396 <xsl:param name="chunk.tocs.and.lots.has.title" select="1"></xsl:param&
gt; | |
| 8397 </programlisting> | |
| 8398 </refsynopsisdiv> | |
| 8399 | |
| 8400 <refsection><info><title>Description</title></info> | |
| 8401 | |
| 8402 <para>If non-zero title of document is shown before ToC/LoT in | |
| 8403 separate chunk.</para> | |
| 8404 | |
| 8405 </refsection> | |
| 8406 </refentry> | |
| 8407 | |
| 8408 <refentry version="5.0" xml:id="chunk.section.depth"> | |
| 8409 <refmeta> | |
| 8410 <refentrytitle>chunk.section.depth</refentrytitle> | |
| 8411 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> | |
| 8412 </refmeta> | |
| 8413 <refnamediv> | |
| 8414 <refname>chunk.section.depth</refname> | |
| 8415 <refpurpose>Depth to which sections should be chunked</refpurpose> | |
| 8416 </refnamediv> | |
| 8417 | |
| 8418 <refsynopsisdiv> | |
| 8419 <programlisting xml:id="chunk.section.depth.frag"> | |
| 8420 <xsl:param name="chunk.section.depth" select="1"></xsl:param> | |
| 8421 </programlisting> | |
| 8422 </refsynopsisdiv> | |
| 8423 | |
| 8424 <refsection><info><title>Description</title></info> | |
| 8425 | |
| 8426 <para>This parameter sets the depth of section chunking.</para> | |
| 8427 | |
| 8428 </refsection> | |
| 8429 </refentry> | |
| 8430 | |
| 8431 <refentry version="5.0" xml:id="chunk.first.sections"> | |
| 8432 <refmeta> | |
| 8433 <refentrytitle>chunk.first.sections</refentrytitle> | |
| 8434 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 8435 </refmeta> | |
| 8436 <refnamediv> | |
| 8437 <refname>chunk.first.sections</refname> | |
| 8438 <refpurpose>Chunk the first top-level section?</refpurpose> | |
| 8439 </refnamediv> | |
| 8440 | |
| 8441 <refsynopsisdiv> | |
| 8442 <programlisting xml:id="chunk.first.sections.frag"> | |
| 8443 <xsl:param name="chunk.first.sections" select="0"></xsl:param> | |
| 8444 </programlisting> | |
| 8445 </refsynopsisdiv> | |
| 8446 | |
| 8447 <refsection><info><title>Description</title></info> | |
| 8448 | |
| 8449 <para>If non-zero, a chunk will be created for the first top-level | |
| 8450 <tag>sect1</tag> or <tag>section</tag> elements in | |
| 8451 each component. Otherwise, that section will be part of the chunk for | |
| 8452 its parent. | |
| 8453 </para> | |
| 8454 | |
| 8455 </refsection> | |
| 8456 </refentry> | |
| 8457 | |
| 8458 <refentry version="5.0" xml:id="chunk.quietly"> | |
| 8459 <refmeta> | |
| 8460 <refentrytitle>chunk.quietly</refentrytitle> | |
| 8461 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 8462 </refmeta> | |
| 8463 <refnamediv> | |
| 8464 <refname>chunk.quietly</refname> | |
| 8465 <refpurpose>Omit the chunked filename messages.</refpurpose> | |
| 8466 </refnamediv> | |
| 8467 | |
| 8468 <refsynopsisdiv> | |
| 8469 <programlisting xml:id="chunk.quietly.frag"> | |
| 8470 <xsl:param name="chunk.quietly" select="0"></xsl:param> | |
| 8471 </programlisting> | |
| 8472 </refsynopsisdiv> | |
| 8473 | |
| 8474 <refsection><info><title>Description</title></info> | |
| 8475 | |
| 8476 <para>If zero (the default), the XSL processor emits a message naming | |
| 8477 each separate chunk filename as it is being output. | |
| 8478 If nonzero, then the messages are suppressed. | |
| 8479 </para> | |
| 8480 | |
| 8481 </refsection> | |
| 8482 </refentry> | |
| 8483 | |
| 8484 <refentry version="5.0" xml:id="chunk.append"> | |
| 8485 <refmeta> | |
| 8486 <refentrytitle>chunk.append</refentrytitle> | |
| 8487 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 8488 </refmeta> | |
| 8489 <refnamediv> | |
| 8490 <refname>chunk.append</refname> | |
| 8491 <refpurpose>Specifies content to append to chunked HTML output</refpurpose> | |
| 8492 </refnamediv> | |
| 8493 | |
| 8494 <refsynopsisdiv> | |
| 8495 <programlisting xml:id="chunk.append.frag"><xsl:param name="chunk.append">
</xsl:param></programlisting> | |
| 8496 </refsynopsisdiv> | |
| 8497 | |
| 8498 <refsection><info><title>Description</title></info> | |
| 8499 | |
| 8500 <para>Specifies content to append to the end of HTML files output by | |
| 8501 the <filename>html/chunk.xsl</filename> stylesheet, after the closing | |
| 8502 <code><html></code> tag. You probably don’t want to set any value | |
| 8503 for this parameter; but if you do, the only value it should ever be | |
| 8504 set to is a newline character: <code>&#x0a;</code> or | |
| 8505 <code>&#10;</code></para> | |
| 8506 | |
| 8507 </refsection> | |
| 8508 </refentry> | |
| 8509 | |
| 8510 <refentry version="5.0" xml:id="navig.graphics"> | |
| 8511 <refmeta> | |
| 8512 <refentrytitle>navig.graphics</refentrytitle> | |
| 8513 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 8514 </refmeta> | |
| 8515 <refnamediv> | |
| 8516 <refname>navig.graphics</refname> | |
| 8517 <refpurpose>Use graphics in navigational headers and footers?</refpurpose> | |
| 8518 </refnamediv> | |
| 8519 | |
| 8520 <refsynopsisdiv> | |
| 8521 <programlisting xml:id="navig.graphics.frag"> | |
| 8522 <xsl:param name="navig.graphics" select="0"></xsl:param> | |
| 8523 </programlisting> | |
| 8524 </refsynopsisdiv> | |
| 8525 | |
| 8526 <refsection><info><title>Description</title></info> | |
| 8527 | |
| 8528 <para>If non-zero, the navigational headers and footers in chunked | |
| 8529 HTML are presented in an alternate style that uses graphical icons for | |
| 8530 Next, Previous, Up, and Home. Default graphics are provided in the | |
| 8531 distribution. If zero, text is used instead of graphics. | |
| 8532 </para> | |
| 8533 | |
| 8534 </refsection> | |
| 8535 </refentry> | |
| 8536 | |
| 8537 <refentry version="5.0" xml:id="navig.graphics.extension"> | |
| 8538 <refmeta> | |
| 8539 <refentrytitle>navig.graphics.extension</refentrytitle> | |
| 8540 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 8541 </refmeta> | |
| 8542 <refnamediv> | |
| 8543 <refname>navig.graphics.extension</refname> | |
| 8544 <refpurpose>Extension for navigational graphics</refpurpose> | |
| 8545 </refnamediv> | |
| 8546 | |
| 8547 <refsynopsisdiv> | |
| 8548 <programlisting xml:id="navig.graphics.extension.frag"> | |
| 8549 <xsl:param name="navig.graphics.extension">.gif</xsl:param> | |
| 8550 </programlisting> | |
| 8551 </refsynopsisdiv> | |
| 8552 | |
| 8553 <refsection><info><title>Description</title></info> | |
| 8554 | |
| 8555 <para>Sets the filename extension to use on navigational graphics used | |
| 8556 in the headers and footers of chunked HTML.</para> | |
| 8557 | |
| 8558 </refsection> | |
| 8559 </refentry> | |
| 8560 | |
| 8561 <refentry version="5.0" xml:id="navig.graphics.path"> | |
| 8562 <refmeta> | |
| 8563 <refentrytitle>navig.graphics.path</refentrytitle> | |
| 8564 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 8565 </refmeta> | |
| 8566 <refnamediv> | |
| 8567 <refname>navig.graphics.path</refname> | |
| 8568 <refpurpose>Path to navigational graphics</refpurpose> | |
| 8569 </refnamediv> | |
| 8570 | |
| 8571 <refsynopsisdiv> | |
| 8572 <programlisting xml:id="navig.graphics.path.frag"> | |
| 8573 <xsl:param name="navig.graphics.path">images/</xsl:param> | |
| 8574 </programlisting> | |
| 8575 </refsynopsisdiv> | |
| 8576 | |
| 8577 <refsection><info><title>Description</title></info> | |
| 8578 | |
| 8579 <para>Sets the path, probably relative to the directory where the HTML | |
| 8580 files are created, to the navigational graphics used in the | |
| 8581 headers and footers of chunked HTML. | |
| 8582 </para> | |
| 8583 | |
| 8584 </refsection> | |
| 8585 </refentry> | |
| 8586 | |
| 8587 <refentry version="5.0" xml:id="navig.showtitles"> | |
| 8588 <refmeta> | |
| 8589 <refentrytitle>navig.showtitles</refentrytitle> | |
| 8590 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 8591 </refmeta> | |
| 8592 <refnamediv> | |
| 8593 <refname>navig.showtitles</refname> | |
| 8594 <refpurpose>Display titles in HTML headers and footers?</refpurpose> | |
| 8595 </refnamediv> | |
| 8596 | |
| 8597 <refsynopsisdiv> | |
| 8598 <programlisting xml:id="navig.showtitles.frag"><xsl:param name="navig.showtit
les">1</xsl:param></programlisting> | |
| 8599 </refsynopsisdiv> | |
| 8600 | |
| 8601 <refsection><info><title>Description</title></info> | |
| 8602 | |
| 8603 <para>If non-zero, | |
| 8604 the headers and footers of chunked HTML | |
| 8605 display the titles of the next and previous chunks, | |
| 8606 along with the words 'Next' and 'Previous' (or the | |
| 8607 equivalent graphical icons if navig.graphics is true). | |
| 8608 If false (zero), then only the words 'Next' and 'Previous' | |
| 8609 (or the icons) are displayed. | |
| 8610 </para> | |
| 8611 | |
| 8612 </refsection> | |
| 8613 </refentry> | |
| 8614 | |
| 8615 </reference> | |
| 8616 <reference xml:id="profiling"><title>Profiling</title> | |
| 8617 <partintro xml:id="partintro"> | |
| 8618 <para>The following parameters can be used for attribute-based | |
| 8619 profiling of your document. For more information about profiling, see | |
| 8620 <link xmlns:xlink="http://www.w3.org/1999/xlink" role="tcg" xlink:href="Profilin
g.html">Profiling (conditional text)</link>.</para> | |
| 8621 </partintro> | |
| 8622 <refentry version="5.0" xml:id="profile.arch"> | |
| 8623 <refmeta> | |
| 8624 <refentrytitle>profile.arch</refentrytitle> | |
| 8625 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 8626 </refmeta> | |
| 8627 <refnamediv> | |
| 8628 <refname>profile.arch</refname> | |
| 8629 <refpurpose>Target profile for <tag class="attribute">arch</tag> | |
| 8630 attribute</refpurpose> | |
| 8631 </refnamediv> | |
| 8632 | |
| 8633 <refsynopsisdiv> | |
| 8634 <programlisting xml:id="profile.arch.frag"> | |
| 8635 <xsl:param name="profile.arch"></xsl:param> | |
| 8636 </programlisting> | |
| 8637 </refsynopsisdiv> | |
| 8638 | |
| 8639 | |
| 8640 <refsection><info><title>Description</title></info> | |
| 8641 | |
| 8642 <para>The value of this parameter specifies profiles which should be | |
| 8643 included in the output. You can specify multiple profiles by | |
| 8644 separating them by semicolon. You can change separator character by | |
| 8645 <parameter>profile.separator</parameter> | |
| 8646 parameter.</para> | |
| 8647 | |
| 8648 <para>This parameter has effect only when you are using profiling | |
| 8649 stylesheets (<filename>profile-docbook.xsl</filename>, | |
| 8650 <filename>profile-chunk.xsl</filename>, …) instead of normal | |
| 8651 ones (<filename>docbook.xsl</filename>, | |
| 8652 <filename>chunk.xsl</filename>, …).</para> | |
| 8653 | |
| 8654 </refsection> | |
| 8655 </refentry> | |
| 8656 | |
| 8657 <refentry version="5.0" xml:id="profile.audience"> | |
| 8658 <refmeta> | |
| 8659 <refentrytitle>profile.audience</refentrytitle> | |
| 8660 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 8661 </refmeta> | |
| 8662 <refnamediv> | |
| 8663 <refname>profile.audience</refname> | |
| 8664 <refpurpose>Target profile for <tag class="attribute">audience</tag> | |
| 8665 attribute</refpurpose> | |
| 8666 </refnamediv> | |
| 8667 | |
| 8668 <refsynopsisdiv> | |
| 8669 <programlisting xml:id="profile.audience.frag"> | |
| 8670 <xsl:param name="profile.audience"></xsl:param> | |
| 8671 </programlisting> | |
| 8672 </refsynopsisdiv> | |
| 8673 | |
| 8674 <refsection><info><title>Description</title></info> | |
| 8675 | |
| 8676 <para>Value of this parameter specifies profiles which should be | |
| 8677 included in the output. You can specify multiple profiles by | |
| 8678 separating them by semicolon. You can change separator character by | |
| 8679 <parameter>profile.separator</parameter> | |
| 8680 parameter.</para> | |
| 8681 | |
| 8682 <para>This parameter has effect only when you are using profiling | |
| 8683 stylesheets (<filename>profile-docbook.xsl</filename>, | |
| 8684 <filename>profile-chunk.xsl</filename>, …) instead of normal | |
| 8685 ones (<filename>docbook.xsl</filename>, | |
| 8686 <filename>chunk.xsl</filename>, …).</para> | |
| 8687 | |
| 8688 </refsection> | |
| 8689 </refentry> | |
| 8690 | |
| 8691 <refentry version="5.0" xml:id="profile.condition"> | |
| 8692 <refmeta> | |
| 8693 <refentrytitle>profile.condition</refentrytitle> | |
| 8694 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 8695 </refmeta> | |
| 8696 <refnamediv> | |
| 8697 <refname>profile.condition</refname> | |
| 8698 <refpurpose>Target profile for <tag class="attribute">condition</tag> | |
| 8699 attribute</refpurpose> | |
| 8700 </refnamediv> | |
| 8701 | |
| 8702 <refsynopsisdiv> | |
| 8703 <programlisting xml:id="profile.condition.frag"> | |
| 8704 <xsl:param name="profile.condition"></xsl:param> | |
| 8705 </programlisting> | |
| 8706 </refsynopsisdiv> | |
| 8707 | |
| 8708 <refsection><info><title>Description</title></info> | |
| 8709 | |
| 8710 <para>The value of this parameter specifies profiles which should be | |
| 8711 included in the output. You can specify multiple profiles by | |
| 8712 separating them by semicolon. You can change separator character by | |
| 8713 <parameter>profile.separator</parameter> | |
| 8714 parameter.</para> | |
| 8715 | |
| 8716 <para>This parameter has effect only when you are using profiling | |
| 8717 stylesheets (<filename>profile-docbook.xsl</filename>, | |
| 8718 <filename>profile-chunk.xsl</filename>, …) instead of normal | |
| 8719 ones (<filename>docbook.xsl</filename>, | |
| 8720 <filename>chunk.xsl</filename>, …).</para> | |
| 8721 | |
| 8722 </refsection> | |
| 8723 </refentry> | |
| 8724 | |
| 8725 <refentry version="5.0" xml:id="profile.conformance"> | |
| 8726 <refmeta> | |
| 8727 <refentrytitle>profile.conformance</refentrytitle> | |
| 8728 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 8729 </refmeta> | |
| 8730 <refnamediv> | |
| 8731 <refname>profile.conformance</refname> | |
| 8732 <refpurpose>Target profile for <tag class="attribute">conformance</tag> | |
| 8733 attribute</refpurpose> | |
| 8734 </refnamediv> | |
| 8735 | |
| 8736 <refsynopsisdiv> | |
| 8737 <programlisting xml:id="profile.conformance.frag"> | |
| 8738 <xsl:param name="profile.conformance"></xsl:param> | |
| 8739 </programlisting> | |
| 8740 </refsynopsisdiv> | |
| 8741 | |
| 8742 <refsection><info><title>Description</title></info> | |
| 8743 | |
| 8744 <para>The value of this parameter specifies profiles which should be | |
| 8745 included in the output. You can specify multiple profiles by | |
| 8746 separating them by semicolon. You can change separator character by | |
| 8747 <parameter>profile.separator</parameter> | |
| 8748 parameter.</para> | |
| 8749 | |
| 8750 <para>This parameter has effect only when you are using profiling | |
| 8751 stylesheets (<filename>profile-docbook.xsl</filename>, | |
| 8752 <filename>profile-chunk.xsl</filename>, …) instead of normal | |
| 8753 ones (<filename>docbook.xsl</filename>, | |
| 8754 <filename>chunk.xsl</filename>, …).</para> | |
| 8755 | |
| 8756 </refsection> | |
| 8757 </refentry> | |
| 8758 | |
| 8759 <refentry version="5.0" xml:id="profile.lang"> | |
| 8760 <refmeta> | |
| 8761 <refentrytitle>profile.lang</refentrytitle> | |
| 8762 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 8763 </refmeta> | |
| 8764 <refnamediv> | |
| 8765 <refname>profile.lang</refname> | |
| 8766 <refpurpose>Target profile for <tag class="attribute">lang</tag> | |
| 8767 attribute</refpurpose> | |
| 8768 </refnamediv> | |
| 8769 | |
| 8770 <refsynopsisdiv> | |
| 8771 <programlisting xml:id="profile.lang.frag"> | |
| 8772 <xsl:param name="profile.lang"></xsl:param> | |
| 8773 </programlisting> | |
| 8774 </refsynopsisdiv> | |
| 8775 | |
| 8776 <refsection><info><title>Description</title></info> | |
| 8777 | |
| 8778 <para>The value of this parameter specifies profiles which should be | |
| 8779 included in the output. You can specify multiple profiles by | |
| 8780 separating them by semicolon. You can change separator character by | |
| 8781 <parameter>profile.separator</parameter> | |
| 8782 parameter.</para> | |
| 8783 | |
| 8784 <para>This parameter has effect only when you are using profiling | |
| 8785 stylesheets (<filename>profile-docbook.xsl</filename>, | |
| 8786 <filename>profile-chunk.xsl</filename>, …) instead of normal | |
| 8787 ones (<filename>docbook.xsl</filename>, | |
| 8788 <filename>chunk.xsl</filename>, …).</para> | |
| 8789 | |
| 8790 </refsection> | |
| 8791 </refentry> | |
| 8792 | |
| 8793 <refentry version="5.0" xml:id="profile.os"> | |
| 8794 <refmeta> | |
| 8795 <refentrytitle>profile.os</refentrytitle> | |
| 8796 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 8797 </refmeta> | |
| 8798 <refnamediv> | |
| 8799 <refname>profile.os</refname> | |
| 8800 <refpurpose>Target profile for <tag class="attribute">os</tag> | |
| 8801 attribute</refpurpose> | |
| 8802 </refnamediv> | |
| 8803 | |
| 8804 <refsynopsisdiv> | |
| 8805 <programlisting xml:id="profile.os.frag"> | |
| 8806 <xsl:param name="profile.os"></xsl:param> | |
| 8807 </programlisting> | |
| 8808 </refsynopsisdiv> | |
| 8809 | |
| 8810 <refsection><info><title>Description</title></info> | |
| 8811 | |
| 8812 <para>The value of this parameter specifies profiles which should be | |
| 8813 included in the output. You can specify multiple profiles by | |
| 8814 separating them by semicolon. You can change separator character by | |
| 8815 <parameter>profile.separator</parameter> | |
| 8816 parameter.</para> | |
| 8817 | |
| 8818 <para>This parameter has effect only when you are using profiling | |
| 8819 stylesheets (<filename>profile-docbook.xsl</filename>, | |
| 8820 <filename>profile-chunk.xsl</filename>, …) instead of normal | |
| 8821 ones (<filename>docbook.xsl</filename>, | |
| 8822 <filename>chunk.xsl</filename>, …).</para> | |
| 8823 | |
| 8824 </refsection> | |
| 8825 </refentry> | |
| 8826 | |
| 8827 <refentry version="5.0" xml:id="profile.revision"> | |
| 8828 <refmeta> | |
| 8829 <refentrytitle>profile.revision</refentrytitle> | |
| 8830 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 8831 </refmeta> | |
| 8832 <refnamediv> | |
| 8833 <refname>profile.revision</refname> | |
| 8834 <refpurpose>Target profile for <tag class="attribute">revision</tag> | |
| 8835 attribute</refpurpose> | |
| 8836 </refnamediv> | |
| 8837 | |
| 8838 <refsynopsisdiv> | |
| 8839 <programlisting xml:id="profile.revision.frag"> | |
| 8840 <xsl:param name="profile.revision"></xsl:param> | |
| 8841 </programlisting> | |
| 8842 </refsynopsisdiv> | |
| 8843 | |
| 8844 <refsection><info><title>Description</title></info> | |
| 8845 | |
| 8846 <para>The value of this parameter specifies profiles which should be | |
| 8847 included in the output. You can specify multiple profiles by | |
| 8848 separating them by semicolon. You can change separator character by | |
| 8849 <parameter>profile.separator</parameter> | |
| 8850 parameter.</para> | |
| 8851 | |
| 8852 <para>This parameter has effect only when you are using profiling | |
| 8853 stylesheets (<filename>profile-docbook.xsl</filename>, | |
| 8854 <filename>profile-chunk.xsl</filename>, …) instead of normal | |
| 8855 ones (<filename>docbook.xsl</filename>, | |
| 8856 <filename>chunk.xsl</filename>, …).</para> | |
| 8857 | |
| 8858 </refsection> | |
| 8859 </refentry> | |
| 8860 | |
| 8861 <refentry version="5.0" xml:id="profile.revisionflag"> | |
| 8862 <refmeta> | |
| 8863 <refentrytitle>profile.revisionflag</refentrytitle> | |
| 8864 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 8865 </refmeta> | |
| 8866 <refnamediv> | |
| 8867 <refname>profile.revisionflag</refname> | |
| 8868 <refpurpose>Target profile for <tag class="attribute">revisionflag</tag> | |
| 8869 attribute</refpurpose> | |
| 8870 </refnamediv> | |
| 8871 | |
| 8872 <refsynopsisdiv> | |
| 8873 <programlisting xml:id="profile.revisionflag.frag"> | |
| 8874 <xsl:param name="profile.revisionflag"></xsl:param> | |
| 8875 </programlisting> | |
| 8876 </refsynopsisdiv> | |
| 8877 | |
| 8878 <refsection><info><title>Description</title></info> | |
| 8879 | |
| 8880 <para>The value of this parameter specifies profiles which should be | |
| 8881 included in the output. You can specify multiple profiles by | |
| 8882 separating them by semicolon. You can change separator character by | |
| 8883 <parameter>profile.separator</parameter> | |
| 8884 parameter.</para> | |
| 8885 | |
| 8886 <para>This parameter has effect only when you are using profiling | |
| 8887 stylesheets (<filename>profile-docbook.xsl</filename>, | |
| 8888 <filename>profile-chunk.xsl</filename>, …) instead of normal | |
| 8889 ones (<filename>docbook.xsl</filename>, | |
| 8890 <filename>chunk.xsl</filename>, …).</para> | |
| 8891 | |
| 8892 </refsection> | |
| 8893 </refentry> | |
| 8894 | |
| 8895 <refentry version="5.0" xml:id="profile.role"> | |
| 8896 <refmeta> | |
| 8897 <refentrytitle>profile.role</refentrytitle> | |
| 8898 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 8899 </refmeta> | |
| 8900 <refnamediv> | |
| 8901 <refname>profile.role</refname> | |
| 8902 <refpurpose>Target profile for <tag class="attribute">role</tag> | |
| 8903 attribute</refpurpose> | |
| 8904 </refnamediv> | |
| 8905 | |
| 8906 <refsynopsisdiv> | |
| 8907 <programlisting xml:id="profile.role.frag"> | |
| 8908 <xsl:param name="profile.role"></xsl:param> | |
| 8909 </programlisting> | |
| 8910 </refsynopsisdiv> | |
| 8911 | |
| 8912 <refsection><info><title>Description</title></info> | |
| 8913 | |
| 8914 <para>The value of this parameter specifies profiles which should be | |
| 8915 included in the output. You can specify multiple profiles by | |
| 8916 separating them by semicolon. You can change separator character by | |
| 8917 <parameter>profile.separator</parameter> | |
| 8918 parameter.</para> | |
| 8919 | |
| 8920 <para>This parameter has effect only when you are using profiling | |
| 8921 stylesheets (<filename>profile-docbook.xsl</filename>, | |
| 8922 <filename>profile-chunk.xsl</filename>, …) instead of normal | |
| 8923 ones (<filename>docbook.xsl</filename>, | |
| 8924 <filename>chunk.xsl</filename>, …).</para> | |
| 8925 | |
| 8926 <warning> | |
| 8927 <para>Note that <tag class="attribute">role</tag> is often | |
| 8928 used for other purposes than profiling. For example it is commonly | |
| 8929 used to get emphasize in bold font:</para> | |
| 8930 | |
| 8931 <programlisting><emphasis role="bold">very important</emphasis></pro
gramlisting> | |
| 8932 | |
| 8933 <para>If you are using <tag class="attribute">role</tag> for | |
| 8934 these purposes do not forget to add values like <literal>bold</literal> to | |
| 8935 value of this parameter. If you forgot you will get document with | |
| 8936 small pieces missing which are very hard to track.</para> | |
| 8937 | |
| 8938 <para>For this reason it is not recommended to use <tag class="attribute">role</
tag> attribute for profiling. You should | |
| 8939 rather use profiling specific attributes like <tag class="attribute">userlevel</
tag>, <tag class="attribute">os</tag>, <tag class="attribute">arch</tag>, <tag c
lass="attribute">condition</tag>, etc.</para> | |
| 8940 </warning> | |
| 8941 | |
| 8942 </refsection> | |
| 8943 </refentry> | |
| 8944 | |
| 8945 <refentry version="5.0" xml:id="profile.security"> | |
| 8946 <refmeta> | |
| 8947 <refentrytitle>profile.security</refentrytitle> | |
| 8948 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 8949 </refmeta> | |
| 8950 <refnamediv> | |
| 8951 <refname>profile.security</refname> | |
| 8952 <refpurpose>Target profile for <tag class="attribute">security</tag> | |
| 8953 attribute</refpurpose> | |
| 8954 </refnamediv> | |
| 8955 | |
| 8956 <refsynopsisdiv> | |
| 8957 <programlisting xml:id="profile.security.frag"> | |
| 8958 <xsl:param name="profile.security"></xsl:param> | |
| 8959 </programlisting> | |
| 8960 </refsynopsisdiv> | |
| 8961 | |
| 8962 <refsection><info><title>Description</title></info> | |
| 8963 | |
| 8964 <para>The value of this parameter specifies profiles which should be | |
| 8965 included in the output. You can specify multiple profiles by | |
| 8966 separating them by semicolon. You can change separator character by | |
| 8967 <parameter>profile.separator</parameter> | |
| 8968 parameter.</para> | |
| 8969 | |
| 8970 <para>This parameter has effect only when you are using profiling | |
| 8971 stylesheets (<filename>profile-docbook.xsl</filename>, | |
| 8972 <filename>profile-chunk.xsl</filename>, …) instead of normal | |
| 8973 ones (<filename>docbook.xsl</filename>, | |
| 8974 <filename>chunk.xsl</filename>, …).</para> | |
| 8975 | |
| 8976 </refsection> | |
| 8977 </refentry> | |
| 8978 | |
| 8979 <refentry version="5.0" xml:id="profile.status"> | |
| 8980 <refmeta> | |
| 8981 <refentrytitle>profile.status</refentrytitle> | |
| 8982 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 8983 </refmeta> | |
| 8984 <refnamediv> | |
| 8985 <refname>profile.status</refname> | |
| 8986 <refpurpose>Target profile for <tag class="attribute">status</tag> | |
| 8987 attribute</refpurpose> | |
| 8988 </refnamediv> | |
| 8989 | |
| 8990 <refsynopsisdiv> | |
| 8991 <programlisting xml:id="profile.status.frag"> | |
| 8992 <xsl:param name="profile.status"></xsl:param> | |
| 8993 </programlisting> | |
| 8994 </refsynopsisdiv> | |
| 8995 | |
| 8996 <refsection><info><title>Description</title></info> | |
| 8997 | |
| 8998 <para>The value of this parameter specifies profiles which should be | |
| 8999 included in the output. You can specify multiple profiles by | |
| 9000 separating them by semicolon. You can change separator character by | |
| 9001 <parameter>profile.separator</parameter> | |
| 9002 parameter.</para> | |
| 9003 | |
| 9004 <para>This parameter has effect only when you are using profiling | |
| 9005 stylesheets (<filename>profile-docbook.xsl</filename>, | |
| 9006 <filename>profile-chunk.xsl</filename>, …) instead of normal | |
| 9007 ones (<filename>docbook.xsl</filename>, | |
| 9008 <filename>chunk.xsl</filename>, …).</para> | |
| 9009 | |
| 9010 </refsection> | |
| 9011 </refentry> | |
| 9012 | |
| 9013 <refentry version="5.0" xml:id="profile.userlevel"> | |
| 9014 <refmeta> | |
| 9015 <refentrytitle>profile.userlevel</refentrytitle> | |
| 9016 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 9017 </refmeta> | |
| 9018 <refnamediv> | |
| 9019 <refname>profile.userlevel</refname> | |
| 9020 <refpurpose>Target profile for <tag class="attribute">userlevel</tag> | |
| 9021 attribute</refpurpose> | |
| 9022 </refnamediv> | |
| 9023 | |
| 9024 <refsynopsisdiv> | |
| 9025 <programlisting xml:id="profile.userlevel.frag"> | |
| 9026 <xsl:param name="profile.userlevel"></xsl:param> | |
| 9027 </programlisting> | |
| 9028 </refsynopsisdiv> | |
| 9029 | |
| 9030 <refsection><info><title>Description</title></info> | |
| 9031 | |
| 9032 <para>The value of this parameter specifies profiles which should be | |
| 9033 included in the output. You can specify multiple profiles by | |
| 9034 separating them by semicolon. You can change separator character by | |
| 9035 <parameter>profile.separator</parameter> | |
| 9036 parameter.</para> | |
| 9037 | |
| 9038 <para>This parameter has effect only when you are using profiling | |
| 9039 stylesheets (<filename>profile-docbook.xsl</filename>, | |
| 9040 <filename>profile-chunk.xsl</filename>, …) instead of normal | |
| 9041 ones (<filename>docbook.xsl</filename>, | |
| 9042 <filename>chunk.xsl</filename>, …).</para> | |
| 9043 | |
| 9044 </refsection> | |
| 9045 </refentry> | |
| 9046 | |
| 9047 <refentry version="5.0" xml:id="profile.vendor"> | |
| 9048 <refmeta> | |
| 9049 <refentrytitle>profile.vendor</refentrytitle> | |
| 9050 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 9051 </refmeta> | |
| 9052 <refnamediv> | |
| 9053 <refname>profile.vendor</refname> | |
| 9054 <refpurpose>Target profile for <tag class="attribute">vendor</tag> | |
| 9055 attribute</refpurpose> | |
| 9056 </refnamediv> | |
| 9057 | |
| 9058 <refsynopsisdiv> | |
| 9059 <programlisting xml:id="profile.vendor.frag"> | |
| 9060 <xsl:param name="profile.vendor"></xsl:param> | |
| 9061 </programlisting> | |
| 9062 </refsynopsisdiv> | |
| 9063 | |
| 9064 <refsection><info><title>Description</title></info> | |
| 9065 | |
| 9066 <para>The value of this parameter specifies profiles which should be | |
| 9067 included in the output. You can specify multiple profiles by | |
| 9068 separating them by semicolon. You can change separator character by | |
| 9069 <parameter>profile.separator</parameter> | |
| 9070 parameter.</para> | |
| 9071 | |
| 9072 <para>This parameter has effect only when you are using profiling | |
| 9073 stylesheets (<filename>profile-docbook.xsl</filename>, | |
| 9074 <filename>profile-chunk.xsl</filename>, …) instead of normal | |
| 9075 ones (<filename>docbook.xsl</filename>, | |
| 9076 <filename>chunk.xsl</filename>, …).</para> | |
| 9077 | |
| 9078 </refsection> | |
| 9079 </refentry> | |
| 9080 | |
| 9081 <refentry version="5.0" xml:id="profile.wordsize"> | |
| 9082 <refmeta> | |
| 9083 <refentrytitle>profile.wordsize</refentrytitle> | |
| 9084 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 9085 </refmeta> | |
| 9086 <refnamediv> | |
| 9087 <refname>profile.wordsize</refname> | |
| 9088 <refpurpose>Target profile for <tag class="attribute">wordsize</tag> | |
| 9089 attribute</refpurpose> | |
| 9090 </refnamediv> | |
| 9091 | |
| 9092 <refsynopsisdiv> | |
| 9093 <programlisting xml:id="profile.wordsize.frag"> | |
| 9094 <xsl:param name="profile.wordsize"></xsl:param> | |
| 9095 </programlisting> | |
| 9096 </refsynopsisdiv> | |
| 9097 | |
| 9098 <refsection><info><title>Description</title></info> | |
| 9099 | |
| 9100 <para>The value of this parameter specifies profiles which should be | |
| 9101 included in the output. You can specify multiple profiles by | |
| 9102 separating them by semicolon. You can change separator character by | |
| 9103 <parameter>profile.separator</parameter> | |
| 9104 parameter.</para> | |
| 9105 | |
| 9106 <para>This parameter has effect only when you are using profiling | |
| 9107 stylesheets (<filename>profile-docbook.xsl</filename>, | |
| 9108 <filename>profile-chunk.xsl</filename>, …) instead of normal | |
| 9109 ones (<filename>docbook.xsl</filename>, | |
| 9110 <filename>chunk.xsl</filename>, …).</para> | |
| 9111 | |
| 9112 </refsection> | |
| 9113 </refentry> | |
| 9114 | |
| 9115 <refentry version="5.0" xml:id="profile.attribute"> | |
| 9116 <refmeta> | |
| 9117 <refentrytitle>profile.attribute</refentrytitle> | |
| 9118 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 9119 </refmeta> | |
| 9120 <refnamediv> | |
| 9121 <refname>profile.attribute</refname> | |
| 9122 <refpurpose>Name of user-specified profiling attribute</refpurpose> | |
| 9123 </refnamediv> | |
| 9124 | |
| 9125 <refsynopsisdiv> | |
| 9126 <programlisting xml:id="profile.attribute.frag"> | |
| 9127 <xsl:param name="profile.attribute"></xsl:param> | |
| 9128 </programlisting> | |
| 9129 </refsynopsisdiv> | |
| 9130 | |
| 9131 <refsection><info><title>Description</title></info> | |
| 9132 | |
| 9133 <para>This parameter is used in conjuction with | |
| 9134 <parameter>profile.value</parameter>.</para> | |
| 9135 | |
| 9136 <para>This parameter has effect only when you are using profiling | |
| 9137 stylesheets (<filename>profile-docbook.xsl</filename>, | |
| 9138 <filename>profile-chunk.xsl</filename>, …) instead of normal | |
| 9139 ones (<filename>docbook.xsl</filename>, | |
| 9140 <filename>chunk.xsl</filename>, …).</para> | |
| 9141 | |
| 9142 </refsection> | |
| 9143 </refentry> | |
| 9144 | |
| 9145 <refentry version="5.0" xml:id="profile.value"> | |
| 9146 <refmeta> | |
| 9147 <refentrytitle>profile.value</refentrytitle> | |
| 9148 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 9149 </refmeta> | |
| 9150 <refnamediv> | |
| 9151 <refname>profile.value</refname> | |
| 9152 <refpurpose>Target profile for user-specified attribute</refpurpose> | |
| 9153 </refnamediv> | |
| 9154 | |
| 9155 <refsynopsisdiv> | |
| 9156 <programlisting xml:id="profile.value.frag"> | |
| 9157 <xsl:param name="profile.value"></xsl:param> | |
| 9158 </programlisting> | |
| 9159 </refsynopsisdiv> | |
| 9160 | |
| 9161 <refsection><info><title>Description</title></info> | |
| 9162 | |
| 9163 <para>When you are using this parameter you must also specify name of | |
| 9164 profiling attribute with parameter | |
| 9165 <parameter>profile.attribute</parameter>.</para> | |
| 9166 | |
| 9167 <para>The value of this parameter specifies profiles which should be | |
| 9168 included in the output. You can specify multiple profiles by | |
| 9169 separating them by semicolon. You can change separator character by | |
| 9170 <parameter>profile.separator</parameter> | |
| 9171 parameter.</para> | |
| 9172 | |
| 9173 <para>This parameter has effect only when you are using profiling | |
| 9174 stylesheets (<filename>profile-docbook.xsl</filename>, | |
| 9175 <filename>profile-chunk.xsl</filename>, …) instead of normal | |
| 9176 ones (<filename>docbook.xsl</filename>, | |
| 9177 <filename>chunk.xsl</filename>, …).</para> | |
| 9178 | |
| 9179 </refsection> | |
| 9180 </refentry> | |
| 9181 | |
| 9182 <refentry version="5.0" xml:id="profile.separator"> | |
| 9183 <refmeta> | |
| 9184 <refentrytitle>profile.separator</refentrytitle> | |
| 9185 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 9186 </refmeta> | |
| 9187 <refnamediv> | |
| 9188 <refname>profile.separator</refname> | |
| 9189 <refpurpose>Separator character for compound profile values</refpurpose> | |
| 9190 </refnamediv> | |
| 9191 | |
| 9192 <refsynopsisdiv> | |
| 9193 <programlisting xml:id="profile.separator.frag"> | |
| 9194 <xsl:param name="profile.separator">;</xsl:param> | |
| 9195 </programlisting> | |
| 9196 </refsynopsisdiv> | |
| 9197 | |
| 9198 <refsection><info><title>Description</title></info> | |
| 9199 | |
| 9200 <para>Separator character used for compound profile values. See <parameter>profi
le.arch</parameter></para> | |
| 9201 | |
| 9202 </refsection> | |
| 9203 </refentry> | |
| 9204 | |
| 9205 </reference> | |
| 9206 <reference xml:id="htmlhelp"><title>HTML Help</title> | |
| 9207 <refentry version="5.0" xml:id="htmlhelp.encoding"> | |
| 9208 <refmeta> | |
| 9209 <refentrytitle>htmlhelp.encoding</refentrytitle> | |
| 9210 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 9211 </refmeta> | |
| 9212 <refnamediv> | |
| 9213 <refname>htmlhelp.encoding</refname> | |
| 9214 <refpurpose>Character encoding to use in files for HTML Help compiler.</refpurpo
se> | |
| 9215 </refnamediv> | |
| 9216 | |
| 9217 <refsynopsisdiv> | |
| 9218 <programlisting xml:id="htmlhelp.encoding.frag"> | |
| 9219 <xsl:param name="htmlhelp.encoding">iso-8859-1</xsl:param> | |
| 9220 </programlisting> | |
| 9221 </refsynopsisdiv> | |
| 9222 | |
| 9223 <refsection><info><title>Description</title></info> | |
| 9224 | |
| 9225 <para>The HTML Help Compiler is not UTF-8 aware, so you should always use an | |
| 9226 appropriate single-byte encoding here. See also <link xmlns:xlink="http://www.w3
.org/1999/xlink" xlink:href="HtmlHelp.html#HelpProcOptions" role="tcg">Processin
g options</link>.</para> | |
| 9227 | |
| 9228 </refsection> | |
| 9229 </refentry> | |
| 9230 | |
| 9231 <refentry version="5.0" xml:id="htmlhelp.autolabel"> | |
| 9232 <refmeta> | |
| 9233 <refentrytitle>htmlhelp.autolabel</refentrytitle> | |
| 9234 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 9235 </refmeta> | |
| 9236 <refnamediv> | |
| 9237 <refname>htmlhelp.autolabel</refname> | |
| 9238 <refpurpose>Should tree-like ToC use autonumbering feature?</refpurpose> | |
| 9239 </refnamediv> | |
| 9240 | |
| 9241 <refsynopsisdiv> | |
| 9242 <programlisting xml:id="htmlhelp.autolabel.frag"> | |
| 9243 <xsl:param name="htmlhelp.autolabel" select="0"></xsl:param> | |
| 9244 </programlisting> | |
| 9245 </refsynopsisdiv> | |
| 9246 | |
| 9247 <refsection><info><title>Description</title></info> | |
| 9248 | |
| 9249 <para>Set this to non-zero to include chapter and section numbers into ToC | |
| 9250 in the left panel.</para> | |
| 9251 | |
| 9252 </refsection> | |
| 9253 </refentry> | |
| 9254 | |
| 9255 <refentry version="5.0" xml:id="htmlhelp.chm"> | |
| 9256 <refmeta> | |
| 9257 <refentrytitle>htmlhelp.chm</refentrytitle> | |
| 9258 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 9259 </refmeta> | |
| 9260 <refnamediv> | |
| 9261 <refname>htmlhelp.chm</refname> | |
| 9262 <refpurpose>Filename of output HTML Help file.</refpurpose> | |
| 9263 </refnamediv> | |
| 9264 | |
| 9265 <refsynopsisdiv> | |
| 9266 <programlisting xml:id="htmlhelp.chm.frag"> | |
| 9267 <xsl:param name="htmlhelp.chm">htmlhelp.chm</xsl:param> | |
| 9268 </programlisting> | |
| 9269 </refsynopsisdiv> | |
| 9270 | |
| 9271 <refsection><info><title>Description</title></info> | |
| 9272 | |
| 9273 <para>Set the name of resulting CHM file</para> | |
| 9274 | |
| 9275 </refsection> | |
| 9276 </refentry> | |
| 9277 | |
| 9278 <refentry version="5.0" xml:id="htmlhelp.default.topic"> | |
| 9279 <refmeta> | |
| 9280 <refentrytitle>htmlhelp.default.topic</refentrytitle> | |
| 9281 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 9282 </refmeta> | |
| 9283 <refnamediv> | |
| 9284 <refname>htmlhelp.default.topic</refname> | |
| 9285 <refpurpose>Name of file with default topic</refpurpose> | |
| 9286 </refnamediv> | |
| 9287 | |
| 9288 <refsynopsisdiv> | |
| 9289 <programlisting xml:id="htmlhelp.default.topic.frag"> | |
| 9290 <xsl:param name="htmlhelp.default.topic"></xsl:param> | |
| 9291 </programlisting> | |
| 9292 </refsynopsisdiv> | |
| 9293 | |
| 9294 <refsection><info><title>Description</title></info> | |
| 9295 | |
| 9296 <para>Normally first chunk of document is displayed when you open HTML | |
| 9297 Help file. If you want to display another topic, simply set its | |
| 9298 filename by this parameter.</para> | |
| 9299 | |
| 9300 <para>This is useful especially if you don't generate ToC in front of | |
| 9301 your document and you also hide root element in ToC. E.g.:</para> | |
| 9302 | |
| 9303 <programlisting><xsl:param name="generate.book.toc" select="0"/> | |
| 9304 <xsl:param name="htmlhelp.hhc.show.root" select="0"/> | |
| 9305 <xsl:param name="htmlhelp.default.topic">pr01.html</xsl:param> | |
| 9306 </programlisting> | |
| 9307 | |
| 9308 </refsection> | |
| 9309 </refentry> | |
| 9310 | |
| 9311 <refentry version="5.0" xml:id="htmlhelp.display.progress"> | |
| 9312 <refmeta> | |
| 9313 <refentrytitle>htmlhelp.display.progress</refentrytitle> | |
| 9314 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 9315 </refmeta> | |
| 9316 <refnamediv> | |
| 9317 <refname>htmlhelp.display.progress</refname> | |
| 9318 <refpurpose>Display compile progress?</refpurpose> | |
| 9319 </refnamediv> | |
| 9320 | |
| 9321 <refsynopsisdiv> | |
| 9322 <programlisting xml:id="htmlhelp.display.progress.frag"> | |
| 9323 <xsl:param name="htmlhelp.display.progress" select="1"></xsl:param> | |
| 9324 </programlisting> | |
| 9325 </refsynopsisdiv> | |
| 9326 | |
| 9327 <refsection><info><title>Description</title></info> | |
| 9328 | |
| 9329 <para>Set to non-zero to to display compile progress | |
| 9330 </para> | |
| 9331 | |
| 9332 </refsection> | |
| 9333 </refentry> | |
| 9334 | |
| 9335 <refentry version="5.0" xml:id="htmlhelp.hhp"> | |
| 9336 <refmeta> | |
| 9337 <refentrytitle>htmlhelp.hhp</refentrytitle> | |
| 9338 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 9339 </refmeta> | |
| 9340 <refnamediv> | |
| 9341 <refname>htmlhelp.hhp</refname> | |
| 9342 <refpurpose>Filename of project file.</refpurpose> | |
| 9343 </refnamediv> | |
| 9344 | |
| 9345 <refsynopsisdiv> | |
| 9346 <programlisting xml:id="htmlhelp.hhp.frag"> | |
| 9347 <xsl:param name="htmlhelp.hhp">htmlhelp.hhp</xsl:param> | |
| 9348 </programlisting> | |
| 9349 </refsynopsisdiv> | |
| 9350 | |
| 9351 <refsection><info><title>Description</title></info> | |
| 9352 | |
| 9353 <para>Change this parameter if you want different name of project | |
| 9354 file than htmlhelp.hhp.</para> | |
| 9355 | |
| 9356 </refsection> | |
| 9357 </refentry> | |
| 9358 | |
| 9359 <refentry version="5.0" xml:id="htmlhelp.hhc"> | |
| 9360 <refmeta> | |
| 9361 <refentrytitle>htmlhelp.hhc</refentrytitle> | |
| 9362 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 9363 </refmeta> | |
| 9364 <refnamediv> | |
| 9365 <refname>htmlhelp.hhc</refname> | |
| 9366 <refpurpose>Filename of TOC file.</refpurpose> | |
| 9367 </refnamediv> | |
| 9368 | |
| 9369 <refsynopsisdiv> | |
| 9370 <programlisting xml:id="htmlhelp.hhc.frag"> | |
| 9371 <xsl:param name="htmlhelp.hhc">toc.hhc</xsl:param> | |
| 9372 </programlisting> | |
| 9373 </refsynopsisdiv> | |
| 9374 | |
| 9375 <refsection><info><title>Description</title></info> | |
| 9376 | |
| 9377 <para>Set the name of the TOC file. The default is <filename>toc.hhc</filename>.
</para> | |
| 9378 | |
| 9379 </refsection> | |
| 9380 </refentry> | |
| 9381 | |
| 9382 <refentry version="5.0" xml:id="htmlhelp.hhk"> | |
| 9383 <refmeta> | |
| 9384 <refentrytitle>htmlhelp.hhk</refentrytitle> | |
| 9385 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 9386 </refmeta> | |
| 9387 <refnamediv> | |
| 9388 <refname>htmlhelp.hhk</refname> | |
| 9389 <refpurpose>Filename of index file.</refpurpose> | |
| 9390 </refnamediv> | |
| 9391 | |
| 9392 <refsynopsisdiv> | |
| 9393 <programlisting xml:id="htmlhelp.hhk.frag"> | |
| 9394 <xsl:param name="htmlhelp.hhk">index.hhk</xsl:param> | |
| 9395 </programlisting> | |
| 9396 </refsynopsisdiv> | |
| 9397 | |
| 9398 <refsection><info><title>Description</title></info> | |
| 9399 | |
| 9400 <para>set the name of the index file. The default is <filename>index.hhk</filena
me>.</para> | |
| 9401 | |
| 9402 </refsection> | |
| 9403 </refentry> | |
| 9404 | |
| 9405 <refentry version="5.0" xml:id="htmlhelp.hhp.tail"> | |
| 9406 <refmeta> | |
| 9407 <refentrytitle>htmlhelp.hhp.tail</refentrytitle> | |
| 9408 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 9409 </refmeta> | |
| 9410 <refnamediv> | |
| 9411 <refname>htmlhelp.hhp.tail</refname> | |
| 9412 <refpurpose>Additional content for project file.</refpurpose> | |
| 9413 </refnamediv> | |
| 9414 | |
| 9415 <refsynopsisdiv> | |
| 9416 <programlisting xml:id="htmlhelp.hhp.tail.frag"> | |
| 9417 <xsl:param name="htmlhelp.hhp.tail"></xsl:param> | |
| 9418 </programlisting> | |
| 9419 </refsynopsisdiv> | |
| 9420 | |
| 9421 <refsection><info><title>Description</title></info> | |
| 9422 | |
| 9423 <para>If you want to include some additional parameters into project file, | |
| 9424 store appropriate part of project file into this parameter.</para> | |
| 9425 | |
| 9426 </refsection> | |
| 9427 </refentry> | |
| 9428 | |
| 9429 <refentry version="5.0" xml:id="htmlhelp.hhp.window"> | |
| 9430 <refmeta> | |
| 9431 <refentrytitle>htmlhelp.hhp.window</refentrytitle> | |
| 9432 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 9433 </refmeta> | |
| 9434 <refnamediv> | |
| 9435 <refname>htmlhelp.hhp.window</refname> | |
| 9436 <refpurpose>Name of default window.</refpurpose> | |
| 9437 </refnamediv> | |
| 9438 | |
| 9439 <refsynopsisdiv> | |
| 9440 <programlisting xml:id="htmlhelp.hhp.window.frag"> | |
| 9441 <xsl:param name="htmlhelp.hhp.window">Main</xsl:param> | |
| 9442 </programlisting> | |
| 9443 </refsynopsisdiv> | |
| 9444 | |
| 9445 <refsection><info><title>Description</title></info> | |
| 9446 | |
| 9447 <para>Name of default window. If empty no [WINDOWS] section will be | |
| 9448 added to project file.</para> | |
| 9449 | |
| 9450 </refsection> | |
| 9451 </refentry> | |
| 9452 | |
| 9453 <refentry version="5.0" xml:id="htmlhelp.hhp.windows"> | |
| 9454 <refmeta> | |
| 9455 <refentrytitle>htmlhelp.hhp.windows</refentrytitle> | |
| 9456 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 9457 </refmeta> | |
| 9458 <refnamediv> | |
| 9459 <refname>htmlhelp.hhp.windows</refname> | |
| 9460 <refpurpose>Definition of additional windows</refpurpose> | |
| 9461 </refnamediv> | |
| 9462 | |
| 9463 <refsynopsisdiv> | |
| 9464 <programlisting xml:id="htmlhelp.hhp.windows.frag"> | |
| 9465 <xsl:param name="htmlhelp.hhp.windows"></xsl:param> | |
| 9466 </programlisting> | |
| 9467 </refsynopsisdiv> | |
| 9468 | |
| 9469 <refsection><info><title>Description</title></info> | |
| 9470 | |
| 9471 <para>Content of this parameter is placed at the end of [WINDOWS] | |
| 9472 section of project file. You can use it for defining your own | |
| 9473 addtional windows.</para> | |
| 9474 | |
| 9475 </refsection> | |
| 9476 </refentry> | |
| 9477 | |
| 9478 <refentry version="5.0" xml:id="htmlhelp.enhanced.decompilation"> | |
| 9479 <refmeta> | |
| 9480 <refentrytitle>htmlhelp.enhanced.decompilation</refentrytitle> | |
| 9481 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 9482 </refmeta> | |
| 9483 <refnamediv> | |
| 9484 <refname>htmlhelp.enhanced.decompilation</refname> | |
| 9485 <refpurpose>Allow enhanced decompilation of CHM?</refpurpose> | |
| 9486 </refnamediv> | |
| 9487 | |
| 9488 <refsynopsisdiv> | |
| 9489 <programlisting xml:id="htmlhelp.enhanced.decompilation.frag"> | |
| 9490 <xsl:param name="htmlhelp.enhanced.decompilation" select="0"></xsl:para
m> | |
| 9491 </programlisting> | |
| 9492 </refsynopsisdiv> | |
| 9493 | |
| 9494 <refsection><info><title>Description</title></info> | |
| 9495 | |
| 9496 <para>When non-zero this parameter enables enhanced decompilation of CHM.</para> | |
| 9497 | |
| 9498 </refsection> | |
| 9499 </refentry> | |
| 9500 | |
| 9501 <refentry version="5.0" xml:id="htmlhelp.enumerate.images"> | |
| 9502 <refmeta> | |
| 9503 <refentrytitle>htmlhelp.enumerate.images</refentrytitle> | |
| 9504 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 9505 </refmeta> | |
| 9506 <refnamediv> | |
| 9507 <refname>htmlhelp.enumerate.images</refname> | |
| 9508 <refpurpose>Should the paths to all used images be added to the project file?</r
efpurpose> | |
| 9509 </refnamediv> | |
| 9510 | |
| 9511 <refsynopsisdiv> | |
| 9512 <programlisting xml:id="htmlhelp.enumerate.images.frag"> | |
| 9513 <xsl:param name="htmlhelp.enumerate.images" select="0"></xsl:param> | |
| 9514 </programlisting> | |
| 9515 </refsynopsisdiv> | |
| 9516 | |
| 9517 <refsection><info><title>Description</title></info> | |
| 9518 | |
| 9519 <para>Set to non-zero if you insert images into your documents as | |
| 9520 external binary entities or if you are using absolute image paths.</para> | |
| 9521 | |
| 9522 </refsection> | |
| 9523 </refentry> | |
| 9524 | |
| 9525 <refentry version="5.0" xml:id="htmlhelp.force.map.and.alias"> | |
| 9526 <refmeta> | |
| 9527 <refentrytitle>htmlhelp.force.map.and.alias</refentrytitle> | |
| 9528 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 9529 </refmeta> | |
| 9530 <refnamediv> | |
| 9531 <refname>htmlhelp.force.map.and.alias</refname> | |
| 9532 <refpurpose>Should [MAP] and [ALIAS] sections be added to the project file uncon
ditionally?</refpurpose> | |
| 9533 </refnamediv> | |
| 9534 <refsynopsisdiv> | |
| 9535 <programlisting xml:id="htmlhelp.force.map.and.alias.frag"> | |
| 9536 <xsl:param name="htmlhelp.force.map.and.alias" select="0"></xsl:param&g
t; | |
| 9537 </programlisting> | |
| 9538 </refsynopsisdiv> | |
| 9539 <refsection><info><title>Description</title></info> | |
| 9540 <para>Set to non-zero if you have your own | |
| 9541 <literal>alias.h</literal> and <literal>context.h</literal> | |
| 9542 files and you want to include references to them in the project | |
| 9543 file.</para> | |
| 9544 </refsection> | |
| 9545 </refentry> | |
| 9546 | |
| 9547 <refentry version="5.0" xml:id="htmlhelp.map.file"> | |
| 9548 <refmeta> | |
| 9549 <refentrytitle>htmlhelp.map.file</refentrytitle> | |
| 9550 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 9551 </refmeta> | |
| 9552 <refnamediv> | |
| 9553 <refname>htmlhelp.map.file</refname> | |
| 9554 <refpurpose>Filename of map file.</refpurpose> | |
| 9555 </refnamediv> | |
| 9556 <refsynopsisdiv> | |
| 9557 <programlisting xml:id="htmlhelp.map.file.frag"> | |
| 9558 <xsl:param name="htmlhelp.map.file">context.h</xsl:param> | |
| 9559 </programlisting> | |
| 9560 </refsynopsisdiv> | |
| 9561 <refsection><info><title>Description</title></info> | |
| 9562 <para>Set the name of map file. The default is | |
| 9563 <filename>context.h</filename>. (used for context-sensitive | |
| 9564 help).</para> | |
| 9565 </refsection> | |
| 9566 </refentry> | |
| 9567 | |
| 9568 <refentry version="5.0" xml:id="htmlhelp.alias.file"> | |
| 9569 <refmeta> | |
| 9570 <refentrytitle>htmlhelp.alias.file</refentrytitle> | |
| 9571 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 9572 </refmeta> | |
| 9573 <refnamediv> | |
| 9574 <refname>htmlhelp.alias.file</refname> | |
| 9575 <refpurpose>Filename of alias file.</refpurpose> | |
| 9576 </refnamediv> | |
| 9577 | |
| 9578 <refsynopsisdiv> | |
| 9579 <programlisting xml:id="htmlhelp.alias.file.frag"> | |
| 9580 <xsl:param name="htmlhelp.alias.file">alias.h</xsl:param> | |
| 9581 </programlisting> | |
| 9582 </refsynopsisdiv> | |
| 9583 | |
| 9584 <refsection><info><title>Description</title></info> | |
| 9585 | |
| 9586 <para>Specifies the filename of the alias file (used for context-sensitive help)
.</para> | |
| 9587 | |
| 9588 </refsection> | |
| 9589 </refentry> | |
| 9590 | |
| 9591 <refentry version="5.0" xml:id="htmlhelp.hhc.section.depth"> | |
| 9592 <refmeta> | |
| 9593 <refentrytitle>htmlhelp.hhc.section.depth</refentrytitle> | |
| 9594 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> | |
| 9595 </refmeta> | |
| 9596 <refnamediv> | |
| 9597 <refname>htmlhelp.hhc.section.depth</refname> | |
| 9598 <refpurpose>Depth of TOC for sections in a left pane.</refpurpose> | |
| 9599 </refnamediv> | |
| 9600 | |
| 9601 <refsynopsisdiv> | |
| 9602 <programlisting xml:id="htmlhelp.hhc.section.depth.frag"> | |
| 9603 <xsl:param name="htmlhelp.hhc.section.depth">5</xsl:param> | |
| 9604 </programlisting> | |
| 9605 </refsynopsisdiv> | |
| 9606 | |
| 9607 <refsection><info><title>Description</title></info> | |
| 9608 | |
| 9609 <para>Set the section depth in the left pane of HTML Help viewer. </para> | |
| 9610 | |
| 9611 </refsection> | |
| 9612 </refentry> | |
| 9613 | |
| 9614 <refentry version="5.0" xml:id="htmlhelp.hhc.show.root"> | |
| 9615 <refmeta> | |
| 9616 <refentrytitle>htmlhelp.hhc.show.root</refentrytitle> | |
| 9617 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 9618 </refmeta> | |
| 9619 <refnamediv> | |
| 9620 <refname>htmlhelp.hhc.show.root</refname> | |
| 9621 <refpurpose>Should there be an entry for the root element in the ToC?</refpurpos
e> | |
| 9622 </refnamediv> | |
| 9623 | |
| 9624 <refsynopsisdiv> | |
| 9625 <programlisting xml:id="htmlhelp.hhc.show.root.frag"> | |
| 9626 <xsl:param name="htmlhelp.hhc.show.root" select="1"></xsl:param> | |
| 9627 </programlisting> | |
| 9628 </refsynopsisdiv> | |
| 9629 | |
| 9630 <refsection><info><title>Description</title></info> | |
| 9631 | |
| 9632 <para>If set to zero, there will be no entry for the root element in the | |
| 9633 ToC. This is useful when you want to provide the user with an expanded | |
| 9634 ToC as a default.</para> | |
| 9635 | |
| 9636 </refsection> | |
| 9637 </refentry> | |
| 9638 | |
| 9639 <refentry version="5.0" xml:id="htmlhelp.hhc.folders.instead.books"> | |
| 9640 <refmeta> | |
| 9641 <refentrytitle>htmlhelp.hhc.folders.instead.books</refentrytitle> | |
| 9642 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 9643 </refmeta> | |
| 9644 <refnamediv> | |
| 9645 <refname>htmlhelp.hhc.folders.instead.books</refname> | |
| 9646 <refpurpose>Use folder icons in ToC (instead of book icons)?</refpurpose> | |
| 9647 </refnamediv> | |
| 9648 | |
| 9649 <refsynopsisdiv> | |
| 9650 <programlisting xml:id="htmlhelp.hhc.folders.instead.books.frag"> | |
| 9651 <xsl:param name="htmlhelp.hhc.folders.instead.books" select="1"></xsl:p
aram> | |
| 9652 </programlisting> | |
| 9653 </refsynopsisdiv> | |
| 9654 | |
| 9655 <refsection><info><title>Description</title></info> | |
| 9656 | |
| 9657 <para>Set to non-zero for folder-like icons or zero for book-like icons in the T
oC. | |
| 9658 If you want to use folder-like icons, you must switch off the binary ToC using | |
| 9659 <parameter>htmlhelp.hhc.binary</parameter>. | |
| 9660 | |
| 9661 </para> | |
| 9662 | |
| 9663 </refsection> | |
| 9664 </refentry> | |
| 9665 | |
| 9666 <refentry version="5.0" xml:id="htmlhelp.hhc.binary"> | |
| 9667 <refmeta> | |
| 9668 <refentrytitle>htmlhelp.hhc.binary</refentrytitle> | |
| 9669 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 9670 </refmeta> | |
| 9671 <refnamediv> | |
| 9672 <refname>htmlhelp.hhc.binary</refname> | |
| 9673 <refpurpose>Generate binary ToC?</refpurpose> | |
| 9674 </refnamediv> | |
| 9675 | |
| 9676 <refsynopsisdiv> | |
| 9677 <programlisting xml:id="htmlhelp.hhc.binary.frag"> | |
| 9678 <xsl:param name="htmlhelp.hhc.binary" select="1"></xsl:param> | |
| 9679 </programlisting> | |
| 9680 </refsynopsisdiv> | |
| 9681 | |
| 9682 <refsection><info><title>Description</title></info> | |
| 9683 | |
| 9684 <para>Set to non-zero to generate a binary TOC. You must create a binary TOC | |
| 9685 if you want to add Prev/Next buttons to toolbar (which is default | |
| 9686 behaviour). Files with binary TOC can't be merged.</para> | |
| 9687 | |
| 9688 </refsection> | |
| 9689 </refentry> | |
| 9690 | |
| 9691 <refentry version="5.0" xml:id="htmlhelp.hhc.width"> | |
| 9692 <refmeta> | |
| 9693 <refentrytitle>htmlhelp.hhc.width</refentrytitle> | |
| 9694 <refmiscinfo class="other" otherclass="datatype">integer</refmiscinfo> | |
| 9695 </refmeta> | |
| 9696 <refnamediv> | |
| 9697 <refname>htmlhelp.hhc.width</refname> | |
| 9698 <refpurpose>Width of navigation pane</refpurpose> | |
| 9699 </refnamediv> | |
| 9700 | |
| 9701 <refsynopsisdiv> | |
| 9702 <programlisting xml:id="htmlhelp.hhc.width.frag"> | |
| 9703 <xsl:param name="htmlhelp.hhc.width"></xsl:param> | |
| 9704 </programlisting> | |
| 9705 </refsynopsisdiv> | |
| 9706 | |
| 9707 <refsection><info><title>Description</title></info> | |
| 9708 | |
| 9709 <para>This parameter specifies the width of the navigation pane (containing TOC
and | |
| 9710 other navigation tabs) in pixels.</para> | |
| 9711 | |
| 9712 </refsection> | |
| 9713 </refentry> | |
| 9714 | |
| 9715 <refentry version="5.0" xml:id="htmlhelp.title"> | |
| 9716 <refmeta> | |
| 9717 <refentrytitle>htmlhelp.title</refentrytitle> | |
| 9718 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 9719 </refmeta> | |
| 9720 <refnamediv> | |
| 9721 <refname>htmlhelp.title</refname> | |
| 9722 <refpurpose>Title of HTML Help</refpurpose> | |
| 9723 </refnamediv> | |
| 9724 | |
| 9725 <refsynopsisdiv> | |
| 9726 <programlisting xml:id="htmlhelp.title.frag"> | |
| 9727 <xsl:param name="htmlhelp.title"></xsl:param> | |
| 9728 </programlisting> | |
| 9729 </refsynopsisdiv> | |
| 9730 | |
| 9731 <refsection><info><title>Description</title></info> | |
| 9732 | |
| 9733 <para>Content of this parameter will be used as a title for generated | |
| 9734 HTML Help. If empty, title will be automatically taken from document.</para> | |
| 9735 | |
| 9736 </refsection> | |
| 9737 </refentry> | |
| 9738 | |
| 9739 <refentry version="5.0" xml:id="htmlhelp.show.menu"> | |
| 9740 <refmeta> | |
| 9741 <refentrytitle>htmlhelp.show.menu</refentrytitle> | |
| 9742 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 9743 </refmeta> | |
| 9744 <refnamediv> | |
| 9745 <refname>htmlhelp.show.menu</refname> | |
| 9746 <refpurpose>Should the menu bar be shown?</refpurpose> | |
| 9747 </refnamediv> | |
| 9748 | |
| 9749 <refsynopsisdiv> | |
| 9750 <programlisting xml:id="htmlhelp.show.menu.frag"> | |
| 9751 <xsl:param name="htmlhelp.show.menu" select="0"></xsl:param> | |
| 9752 </programlisting> | |
| 9753 </refsynopsisdiv> | |
| 9754 | |
| 9755 <refsection><info><title>Description</title></info> | |
| 9756 | |
| 9757 <para>Set to non-zero to have an application menu bar in your HTML Help window. | |
| 9758 </para> | |
| 9759 | |
| 9760 </refsection> | |
| 9761 </refentry> | |
| 9762 | |
| 9763 <refentry version="5.0" xml:id="htmlhelp.show.toolbar.text"> | |
| 9764 <refmeta> | |
| 9765 <refentrytitle>htmlhelp.show.toolbar.text</refentrytitle> | |
| 9766 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 9767 </refmeta> | |
| 9768 <refnamediv> | |
| 9769 <refname>htmlhelp.show.toolbar.text</refname> | |
| 9770 <refpurpose>Show text under toolbar buttons?</refpurpose> | |
| 9771 </refnamediv> | |
| 9772 | |
| 9773 <refsynopsisdiv> | |
| 9774 <programlisting xml:id="htmlhelp.show.toolbar.text.frag"> | |
| 9775 <xsl:param name="htmlhelp.show.toolbar.text" select="1"></xsl:param> | |
| 9776 </programlisting> | |
| 9777 </refsynopsisdiv> | |
| 9778 | |
| 9779 <refsection><info><title>Description</title></info> | |
| 9780 | |
| 9781 <para>Set to non-zero to display texts under toolbar buttons, zero to switch | |
| 9782 off displays.</para> | |
| 9783 | |
| 9784 </refsection> | |
| 9785 </refentry> | |
| 9786 | |
| 9787 <refentry version="5.0" xml:id="htmlhelp.show.advanced.search"> | |
| 9788 <refmeta> | |
| 9789 <refentrytitle>htmlhelp.show.advanced.search</refentrytitle> | |
| 9790 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 9791 </refmeta> | |
| 9792 <refnamediv> | |
| 9793 <refname>htmlhelp.show.advanced.search</refname> | |
| 9794 <refpurpose>Should advanced search features be available?</refpurpose> | |
| 9795 </refnamediv> | |
| 9796 | |
| 9797 <refsynopsisdiv> | |
| 9798 <programlisting xml:id="htmlhelp.show.advanced.search.frag"> | |
| 9799 <xsl:param name="htmlhelp.show.advanced.search" select="0"></xsl:param&
gt; | |
| 9800 </programlisting> | |
| 9801 </refsynopsisdiv> | |
| 9802 | |
| 9803 <refsection><info><title>Description</title></info> | |
| 9804 | |
| 9805 <para>If you want advanced search features in your help, turn this | |
| 9806 parameter to 1.</para> | |
| 9807 | |
| 9808 </refsection> | |
| 9809 </refentry> | |
| 9810 | |
| 9811 <refentry version="5.0" xml:id="htmlhelp.show.favorities"> | |
| 9812 <refmeta> | |
| 9813 <refentrytitle>htmlhelp.show.favorities</refentrytitle> | |
| 9814 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 9815 </refmeta> | |
| 9816 <refnamediv> | |
| 9817 <refname>htmlhelp.show.favorities</refname> | |
| 9818 <refpurpose>Should the Favorites tab be shown?</refpurpose> | |
| 9819 </refnamediv> | |
| 9820 | |
| 9821 <refsynopsisdiv> | |
| 9822 <programlisting xml:id="htmlhelp.show.favorities.frag"> | |
| 9823 <xsl:param name="htmlhelp.show.favorities" select="0"></xsl:param> | |
| 9824 </programlisting> | |
| 9825 </refsynopsisdiv> | |
| 9826 | |
| 9827 <refsection><info><title>Description</title></info> | |
| 9828 | |
| 9829 <para>Set to non-zero to include a Favorites tab in the navigation pane | |
| 9830 of the help window.</para> | |
| 9831 | |
| 9832 </refsection> | |
| 9833 </refentry> | |
| 9834 | |
| 9835 <refentry version="5.0" xml:id="htmlhelp.button.hideshow"> | |
| 9836 <refmeta> | |
| 9837 <refentrytitle>htmlhelp.button.hideshow</refentrytitle> | |
| 9838 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 9839 </refmeta> | |
| 9840 <refnamediv> | |
| 9841 <refname>htmlhelp.button.hideshow</refname> | |
| 9842 <refpurpose>Should the Hide/Show button be shown?</refpurpose> | |
| 9843 </refnamediv> | |
| 9844 | |
| 9845 <refsynopsisdiv> | |
| 9846 <programlisting xml:id="htmlhelp.button.hideshow.frag"> | |
| 9847 <xsl:param name="htmlhelp.button.hideshow" select="1"></xsl:param> | |
| 9848 </programlisting> | |
| 9849 </refsynopsisdiv> | |
| 9850 | |
| 9851 <refsection><info><title>Description</title></info> | |
| 9852 | |
| 9853 <para>Set to non-zero to include the Hide/Show button shown on toolbar</para> | |
| 9854 | |
| 9855 </refsection> | |
| 9856 </refentry> | |
| 9857 | |
| 9858 <refentry version="5.0" xml:id="htmlhelp.button.back"> | |
| 9859 <refmeta> | |
| 9860 <refentrytitle>htmlhelp.button.back</refentrytitle> | |
| 9861 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 9862 </refmeta> | |
| 9863 <refnamediv> | |
| 9864 <refname>htmlhelp.button.back</refname> | |
| 9865 <refpurpose>Should the Back button be shown?</refpurpose> | |
| 9866 </refnamediv> | |
| 9867 | |
| 9868 <refsynopsisdiv> | |
| 9869 <programlisting xml:id="htmlhelp.button.back.frag"> | |
| 9870 <xsl:param name="htmlhelp.button.back" select="1"></xsl:param> | |
| 9871 </programlisting> | |
| 9872 </refsynopsisdiv> | |
| 9873 | |
| 9874 <refsection><info><title>Description</title></info> | |
| 9875 | |
| 9876 <para>Set to non-zero to include the Hide/Show button shown on toolbar</para> | |
| 9877 | |
| 9878 </refsection> | |
| 9879 </refentry> | |
| 9880 | |
| 9881 <refentry version="5.0" xml:id="htmlhelp.button.forward"> | |
| 9882 <refmeta> | |
| 9883 <refentrytitle>htmlhelp.button.forward</refentrytitle> | |
| 9884 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 9885 </refmeta> | |
| 9886 <refnamediv> | |
| 9887 <refname>htmlhelp.button.forward</refname> | |
| 9888 <refpurpose>Should the Forward button be shown?</refpurpose> | |
| 9889 </refnamediv> | |
| 9890 | |
| 9891 <refsynopsisdiv> | |
| 9892 <programlisting xml:id="htmlhelp.button.forward.frag"> | |
| 9893 <xsl:param name="htmlhelp.button.forward" select="0"></xsl:param> | |
| 9894 </programlisting> | |
| 9895 </refsynopsisdiv> | |
| 9896 | |
| 9897 <refsection><info><title>Description</title></info> | |
| 9898 | |
| 9899 <para>Set to non-zero to include the Forward button on the toolbar.</para> | |
| 9900 | |
| 9901 </refsection> | |
| 9902 </refentry> | |
| 9903 | |
| 9904 <refentry version="5.0" xml:id="htmlhelp.button.stop"> | |
| 9905 <refmeta> | |
| 9906 <refentrytitle>htmlhelp.button.stop</refentrytitle> | |
| 9907 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 9908 </refmeta> | |
| 9909 <refnamediv> | |
| 9910 <refname>htmlhelp.button.stop</refname> | |
| 9911 <refpurpose>Should the Stop button be shown?</refpurpose> | |
| 9912 </refnamediv> | |
| 9913 | |
| 9914 <refsynopsisdiv> | |
| 9915 <programlisting xml:id="htmlhelp.button.stop.frag"> | |
| 9916 <xsl:param name="htmlhelp.button.stop" select="0"></xsl:param> | |
| 9917 </programlisting> | |
| 9918 </refsynopsisdiv> | |
| 9919 | |
| 9920 <refsection><info><title>Description</title></info> | |
| 9921 | |
| 9922 <para>If you want Stop button shown on toolbar, turn this | |
| 9923 parameter to 1.</para> | |
| 9924 | |
| 9925 </refsection> | |
| 9926 </refentry> | |
| 9927 | |
| 9928 <refentry version="5.0" xml:id="htmlhelp.button.refresh"> | |
| 9929 <refmeta> | |
| 9930 <refentrytitle>htmlhelp.button.refresh</refentrytitle> | |
| 9931 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 9932 </refmeta> | |
| 9933 <refnamediv> | |
| 9934 <refname>htmlhelp.button.refresh</refname> | |
| 9935 <refpurpose>Should the Refresh button be shown?</refpurpose> | |
| 9936 </refnamediv> | |
| 9937 | |
| 9938 <refsynopsisdiv> | |
| 9939 <programlisting xml:id="htmlhelp.button.refresh.frag"> | |
| 9940 <xsl:param name="htmlhelp.button.refresh" select="0"></xsl:param> | |
| 9941 </programlisting> | |
| 9942 </refsynopsisdiv> | |
| 9943 | |
| 9944 <refsection><info><title>Description</title></info> | |
| 9945 | |
| 9946 <para>Set to non-zero to include the Stop button on the toolbar.</para> | |
| 9947 | |
| 9948 </refsection> | |
| 9949 </refentry> | |
| 9950 | |
| 9951 <refentry version="5.0" xml:id="htmlhelp.button.home"> | |
| 9952 <refmeta> | |
| 9953 <refentrytitle>htmlhelp.button.home</refentrytitle> | |
| 9954 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 9955 </refmeta> | |
| 9956 <refnamediv> | |
| 9957 <refname>htmlhelp.button.home</refname> | |
| 9958 <refpurpose>Should the Home button be shown?</refpurpose> | |
| 9959 </refnamediv> | |
| 9960 | |
| 9961 <refsynopsisdiv> | |
| 9962 <programlisting xml:id="htmlhelp.button.home.frag"> | |
| 9963 <xsl:param name="htmlhelp.button.home" select="0"></xsl:param> | |
| 9964 </programlisting> | |
| 9965 </refsynopsisdiv> | |
| 9966 | |
| 9967 <refsection><info><title>Description</title></info> | |
| 9968 | |
| 9969 <para>Set to non-zero to include the Home button on the toolbar.</para> | |
| 9970 | |
| 9971 </refsection> | |
| 9972 </refentry> | |
| 9973 | |
| 9974 <refentry version="5.0" xml:id="htmlhelp.button.home.url"> | |
| 9975 <refmeta> | |
| 9976 <refentrytitle>htmlhelp.button.home.url</refentrytitle> | |
| 9977 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 9978 </refmeta> | |
| 9979 <refnamediv> | |
| 9980 <refname>htmlhelp.button.home.url</refname> | |
| 9981 <refpurpose>URL address of page accessible by Home button</refpurpose> | |
| 9982 </refnamediv> | |
| 9983 | |
| 9984 <refsynopsisdiv> | |
| 9985 <programlisting xml:id="htmlhelp.button.home.url.frag"> | |
| 9986 <xsl:param name="htmlhelp.button.home.url"></xsl:param> | |
| 9987 </programlisting> | |
| 9988 </refsynopsisdiv> | |
| 9989 | |
| 9990 <refsection><info><title>Description</title></info> | |
| 9991 | |
| 9992 <para>URL address of page accessible by Home button.</para> | |
| 9993 | |
| 9994 </refsection> | |
| 9995 </refentry> | |
| 9996 | |
| 9997 <refentry version="5.0" xml:id="htmlhelp.button.options"> | |
| 9998 <refmeta> | |
| 9999 <refentrytitle>htmlhelp.button.options</refentrytitle> | |
| 10000 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 10001 </refmeta> | |
| 10002 <refnamediv> | |
| 10003 <refname>htmlhelp.button.options</refname> | |
| 10004 <refpurpose>Should the Options button be shown?</refpurpose> | |
| 10005 </refnamediv> | |
| 10006 | |
| 10007 <refsynopsisdiv> | |
| 10008 <programlisting xml:id="htmlhelp.button.options.frag"> | |
| 10009 <xsl:param name="htmlhelp.button.options" select="1"></xsl:param> | |
| 10010 </programlisting> | |
| 10011 </refsynopsisdiv> | |
| 10012 | |
| 10013 <refsection><info><title>Description</title></info> | |
| 10014 | |
| 10015 <para>If you want Options button shown on toolbar, turn this | |
| 10016 parameter to 1.</para> | |
| 10017 | |
| 10018 </refsection> | |
| 10019 </refentry> | |
| 10020 | |
| 10021 <refentry version="5.0" xml:id="htmlhelp.button.print"> | |
| 10022 <refmeta> | |
| 10023 <refentrytitle>htmlhelp.button.print</refentrytitle> | |
| 10024 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 10025 </refmeta> | |
| 10026 <refnamediv> | |
| 10027 <refname>htmlhelp.button.print</refname> | |
| 10028 <refpurpose>Should the Print button be shown?</refpurpose> | |
| 10029 </refnamediv> | |
| 10030 | |
| 10031 <refsynopsisdiv> | |
| 10032 <programlisting xml:id="htmlhelp.button.print.frag"> | |
| 10033 <xsl:param name="htmlhelp.button.print" select="1"></xsl:param> | |
| 10034 </programlisting> | |
| 10035 </refsynopsisdiv> | |
| 10036 | |
| 10037 <refsection><info><title>Description</title></info> | |
| 10038 | |
| 10039 <para>Set to non-zero to include the Print button on the toolbar. | |
| 10040 </para> | |
| 10041 | |
| 10042 </refsection> | |
| 10043 </refentry> | |
| 10044 | |
| 10045 <refentry version="5.0" xml:id="htmlhelp.button.locate"> | |
| 10046 <refmeta> | |
| 10047 <refentrytitle>htmlhelp.button.locate</refentrytitle> | |
| 10048 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 10049 </refmeta> | |
| 10050 <refnamediv> | |
| 10051 <refname>htmlhelp.button.locate</refname> | |
| 10052 <refpurpose>Should the Locate button be shown?</refpurpose> | |
| 10053 </refnamediv> | |
| 10054 | |
| 10055 <refsynopsisdiv> | |
| 10056 <programlisting xml:id="htmlhelp.button.locate.frag"> | |
| 10057 <xsl:param name="htmlhelp.button.locate" select="0"></xsl:param> | |
| 10058 </programlisting> | |
| 10059 </refsynopsisdiv> | |
| 10060 | |
| 10061 <refsection><info><title>Description</title></info> | |
| 10062 | |
| 10063 <para>If you want Locate button shown on toolbar, turn this | |
| 10064 parameter to 1.</para> | |
| 10065 | |
| 10066 </refsection> | |
| 10067 </refentry> | |
| 10068 | |
| 10069 <refentry version="5.0" xml:id="htmlhelp.button.jump1"> | |
| 10070 <refmeta> | |
| 10071 <refentrytitle>htmlhelp.button.jump1</refentrytitle> | |
| 10072 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 10073 </refmeta> | |
| 10074 <refnamediv> | |
| 10075 <refname>htmlhelp.button.jump1</refname> | |
| 10076 <refpurpose>Should the Jump1 button be shown?</refpurpose> | |
| 10077 </refnamediv> | |
| 10078 <refsynopsisdiv> | |
| 10079 <programlisting xml:id="htmlhelp.button.jump1.frag"> | |
| 10080 <xsl:param name="htmlhelp.button.jump1" select="0"></xsl:param> | |
| 10081 </programlisting> | |
| 10082 </refsynopsisdiv> | |
| 10083 <refsection><info><title>Description</title></info> | |
| 10084 <para>Set to non-zero to include the <literal>Jump1</literal> button on the to
olbar.</para> | |
| 10085 </refsection> | |
| 10086 </refentry> | |
| 10087 | |
| 10088 <refentry version="5.0" xml:id="htmlhelp.button.jump1.url"> | |
| 10089 <refmeta> | |
| 10090 <refentrytitle>htmlhelp.button.jump1.url</refentrytitle> | |
| 10091 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 10092 </refmeta> | |
| 10093 <refnamediv> | |
| 10094 <refname>htmlhelp.button.jump1.url</refname> | |
| 10095 <refpurpose>URL address of page accessible by Jump1 button</refpurpose> | |
| 10096 </refnamediv> | |
| 10097 | |
| 10098 <refsynopsisdiv> | |
| 10099 <programlisting xml:id="htmlhelp.button.jump1.url.frag"> | |
| 10100 <xsl:param name="htmlhelp.button.jump1.url"></xsl:param> | |
| 10101 </programlisting> | |
| 10102 </refsynopsisdiv> | |
| 10103 | |
| 10104 <refsection><info><title>Description</title></info> | |
| 10105 | |
| 10106 <para>URL address of page accessible by Jump1 button.</para> | |
| 10107 | |
| 10108 </refsection> | |
| 10109 </refentry> | |
| 10110 | |
| 10111 <refentry version="5.0" xml:id="htmlhelp.button.jump1.title"> | |
| 10112 <refmeta> | |
| 10113 <refentrytitle>htmlhelp.button.jump1.title</refentrytitle> | |
| 10114 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 10115 </refmeta> | |
| 10116 <refnamediv> | |
| 10117 <refname>htmlhelp.button.jump1.title</refname> | |
| 10118 <refpurpose>Title of Jump1 button</refpurpose> | |
| 10119 </refnamediv> | |
| 10120 | |
| 10121 <refsynopsisdiv> | |
| 10122 <programlisting xml:id="htmlhelp.button.jump1.title.frag"> | |
| 10123 <xsl:param name="htmlhelp.button.jump1.title">User1</xsl:param> | |
| 10124 </programlisting> | |
| 10125 </refsynopsisdiv> | |
| 10126 | |
| 10127 <refsection><info><title>Description</title></info> | |
| 10128 | |
| 10129 <para>Title of Jump1 button.</para> | |
| 10130 | |
| 10131 </refsection> | |
| 10132 </refentry> | |
| 10133 | |
| 10134 <refentry version="5.0" xml:id="htmlhelp.button.jump2"> | |
| 10135 <refmeta> | |
| 10136 <refentrytitle>htmlhelp.button.jump2</refentrytitle> | |
| 10137 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 10138 </refmeta> | |
| 10139 <refnamediv> | |
| 10140 <refname>htmlhelp.button.jump2</refname> | |
| 10141 <refpurpose>Should the Jump2 button be shown?</refpurpose> | |
| 10142 </refnamediv> | |
| 10143 | |
| 10144 <refsynopsisdiv> | |
| 10145 <programlisting xml:id="htmlhelp.button.jump2.frag"> | |
| 10146 <xsl:param name="htmlhelp.button.jump2" select="0"></xsl:param> | |
| 10147 </programlisting> | |
| 10148 </refsynopsisdiv> | |
| 10149 | |
| 10150 <refsection><info><title>Description</title></info> | |
| 10151 | |
| 10152 <para>Set to non-zero to include the Jump2 button on the toolbar.</para> | |
| 10153 | |
| 10154 </refsection> | |
| 10155 </refentry> | |
| 10156 | |
| 10157 <refentry version="5.0" xml:id="htmlhelp.button.jump2.url"> | |
| 10158 <refmeta> | |
| 10159 <refentrytitle>htmlhelp.button.jump2.url</refentrytitle> | |
| 10160 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 10161 </refmeta> | |
| 10162 <refnamediv> | |
| 10163 <refname>htmlhelp.button.jump2.url</refname> | |
| 10164 <refpurpose>URL address of page accessible by Jump2 button</refpurpose> | |
| 10165 </refnamediv> | |
| 10166 | |
| 10167 <refsynopsisdiv> | |
| 10168 <programlisting xml:id="htmlhelp.button.jump2.url.frag"> | |
| 10169 <xsl:param name="htmlhelp.button.jump2.url"></xsl:param> | |
| 10170 </programlisting> | |
| 10171 </refsynopsisdiv> | |
| 10172 | |
| 10173 <refsection><info><title>Description</title></info> | |
| 10174 | |
| 10175 <para>URL address of page accessible by Jump2 button.</para> | |
| 10176 | |
| 10177 </refsection> | |
| 10178 </refentry> | |
| 10179 | |
| 10180 <refentry version="5.0" xml:id="htmlhelp.button.jump2.title"> | |
| 10181 <refmeta> | |
| 10182 <refentrytitle>htmlhelp.button.jump2.title</refentrytitle> | |
| 10183 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 10184 </refmeta> | |
| 10185 <refnamediv> | |
| 10186 <refname>htmlhelp.button.jump2.title</refname> | |
| 10187 <refpurpose>Title of Jump2 button</refpurpose> | |
| 10188 </refnamediv> | |
| 10189 | |
| 10190 <refsynopsisdiv> | |
| 10191 <programlisting xml:id="htmlhelp.button.jump2.title.frag"> | |
| 10192 <xsl:param name="htmlhelp.button.jump2.title">User2</xsl:param> | |
| 10193 </programlisting> | |
| 10194 </refsynopsisdiv> | |
| 10195 | |
| 10196 <refsection><info><title>Description</title></info> | |
| 10197 | |
| 10198 <para>Title of Jump2 button.</para> | |
| 10199 | |
| 10200 </refsection> | |
| 10201 </refentry> | |
| 10202 | |
| 10203 <refentry version="5.0" xml:id="htmlhelp.button.next"> | |
| 10204 <refmeta> | |
| 10205 <refentrytitle>htmlhelp.button.next</refentrytitle> | |
| 10206 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 10207 </refmeta> | |
| 10208 <refnamediv> | |
| 10209 <refname>htmlhelp.button.next</refname> | |
| 10210 <refpurpose>Should the Next button be shown?</refpurpose> | |
| 10211 </refnamediv> | |
| 10212 | |
| 10213 <refsynopsisdiv> | |
| 10214 <programlisting xml:id="htmlhelp.button.next.frag"> | |
| 10215 <xsl:param name="htmlhelp.button.next" select="1"></xsl:param> | |
| 10216 </programlisting> | |
| 10217 </refsynopsisdiv> | |
| 10218 | |
| 10219 <refsection><info><title>Description</title></info> | |
| 10220 | |
| 10221 <para>Set to non-zero to include the Next button on the toolbar.</para> | |
| 10222 | |
| 10223 </refsection> | |
| 10224 </refentry> | |
| 10225 | |
| 10226 <refentry version="5.0" xml:id="htmlhelp.button.prev"> | |
| 10227 <refmeta> | |
| 10228 <refentrytitle>htmlhelp.button.prev</refentrytitle> | |
| 10229 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 10230 </refmeta> | |
| 10231 <refnamediv> | |
| 10232 <refname>htmlhelp.button.prev</refname> | |
| 10233 <refpurpose>Should the Prev button be shown?</refpurpose> | |
| 10234 </refnamediv> | |
| 10235 | |
| 10236 <refsynopsisdiv> | |
| 10237 <programlisting xml:id="htmlhelp.button.prev.frag"> | |
| 10238 <xsl:param name="htmlhelp.button.prev" select="1"></xsl:param> | |
| 10239 </programlisting> | |
| 10240 </refsynopsisdiv> | |
| 10241 | |
| 10242 <refsection><info><title>Description</title></info> | |
| 10243 | |
| 10244 <para>Set to non-zero to include the Prev button on the toolbar. | |
| 10245 </para> | |
| 10246 | |
| 10247 </refsection> | |
| 10248 </refentry> | |
| 10249 | |
| 10250 <refentry version="5.0" xml:id="htmlhelp.button.zoom"> | |
| 10251 <refmeta> | |
| 10252 <refentrytitle>htmlhelp.button.zoom</refentrytitle> | |
| 10253 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 10254 </refmeta> | |
| 10255 <refnamediv> | |
| 10256 <refname>htmlhelp.button.zoom</refname> | |
| 10257 <refpurpose>Should the Zoom button be shown?</refpurpose> | |
| 10258 </refnamediv> | |
| 10259 | |
| 10260 <refsynopsisdiv> | |
| 10261 <programlisting xml:id="htmlhelp.button.zoom.frag"> | |
| 10262 <xsl:param name="htmlhelp.button.zoom" select="0"></xsl:param> | |
| 10263 </programlisting> | |
| 10264 </refsynopsisdiv> | |
| 10265 | |
| 10266 <refsection><info><title>Description</title></info> | |
| 10267 | |
| 10268 <para>Set to non-zero to include the Zoom button on the toolbar. | |
| 10269 </para> | |
| 10270 | |
| 10271 </refsection> | |
| 10272 </refentry> | |
| 10273 | |
| 10274 <refentry version="5.0" xml:id="htmlhelp.remember.window.position"> | |
| 10275 <refmeta> | |
| 10276 <refentrytitle>htmlhelp.remember.window.position</refentrytitle> | |
| 10277 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 10278 </refmeta> | |
| 10279 <refnamediv> | |
| 10280 <refname>htmlhelp.remember.window.position</refname> | |
| 10281 <refpurpose>Remember help window position?</refpurpose> | |
| 10282 </refnamediv> | |
| 10283 | |
| 10284 <refsynopsisdiv> | |
| 10285 <programlisting xml:id="htmlhelp.remember.window.position.frag"> | |
| 10286 <xsl:param name="htmlhelp.remember.window.position" select="0"></xsl:pa
ram> | |
| 10287 </programlisting> | |
| 10288 </refsynopsisdiv> | |
| 10289 | |
| 10290 <refsection><info><title>Description</title></info> | |
| 10291 | |
| 10292 <para>Set to non-zero to remember help window position between starts.</para> | |
| 10293 | |
| 10294 </refsection> | |
| 10295 </refentry> | |
| 10296 | |
| 10297 <refentry version="5.0" xml:id="htmlhelp.window.geometry"> | |
| 10298 <refmeta> | |
| 10299 <refentrytitle>htmlhelp.window.geometry</refentrytitle> | |
| 10300 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 10301 </refmeta> | |
| 10302 <refnamediv> | |
| 10303 <refname>htmlhelp.window.geometry</refname> | |
| 10304 <refpurpose>Set initial geometry of help window</refpurpose> | |
| 10305 </refnamediv> | |
| 10306 | |
| 10307 <refsynopsisdiv> | |
| 10308 <programlisting xml:id="htmlhelp.window.geometry.frag"> | |
| 10309 <xsl:param name="htmlhelp.window.geometry"></xsl:param> | |
| 10310 </programlisting> | |
| 10311 </refsynopsisdiv> | |
| 10312 | |
| 10313 <refsection><info><title>Description</title></info> | |
| 10314 | |
| 10315 <para>This parameter specifies initial position of help | |
| 10316 window. E.g.</para> | |
| 10317 | |
| 10318 <programlisting><xsl:param name="htmlhelp.window.geometry">[160,64,992,704
]</xsl:param></programlisting> | |
| 10319 | |
| 10320 </refsection> | |
| 10321 </refentry> | |
| 10322 | |
| 10323 <refentry version="5.0" xml:id="htmlhelp.use.hhk"> | |
| 10324 <refmeta> | |
| 10325 <refentrytitle>htmlhelp.use.hhk</refentrytitle> | |
| 10326 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 10327 </refmeta> | |
| 10328 <refnamediv> | |
| 10329 <refname>htmlhelp.use.hhk</refname> | |
| 10330 <refpurpose>Should the index be built using the HHK file?</refpurpose> | |
| 10331 </refnamediv> | |
| 10332 | |
| 10333 <refsynopsisdiv> | |
| 10334 <programlisting xml:id="htmlhelp.use.hhk.frag"> | |
| 10335 <xsl:param name="htmlhelp.use.hhk" select="0"></xsl:param> | |
| 10336 </programlisting> | |
| 10337 </refsynopsisdiv> | |
| 10338 | |
| 10339 <refsection><info><title>Description</title></info> | |
| 10340 | |
| 10341 <para>If non-zero, the index is created using the HHK file (instead of using <ta
g role="html">object</tag> | |
| 10342 elements in the HTML files). For more information, see <link xmlns:xlink="http:/
/www.w3.org/1999/xlink" role="tcg" xlink:href="HtmlHelp.html#HHGenIndex">Generat
ing an index</link>.</para> | |
| 10343 </refsection> | |
| 10344 </refentry> | |
| 10345 | |
| 10346 <refentry version="5.0" xml:id="htmlhelp.only"> | |
| 10347 <refmeta> | |
| 10348 <refentrytitle>htmlhelp.only</refentrytitle> | |
| 10349 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 10350 </refmeta> | |
| 10351 <refnamediv> | |
| 10352 <refname>htmlhelp.only</refname> | |
| 10353 <refpurpose>Should only project files be generated?</refpurpose> | |
| 10354 </refnamediv> | |
| 10355 | |
| 10356 <refsynopsisdiv> | |
| 10357 <programlisting xml:id="htmlhelp.only.frag"> | |
| 10358 <xsl:param name="htmlhelp.only" select="0"></xsl:param> | |
| 10359 </programlisting> | |
| 10360 </refsynopsisdiv> | |
| 10361 | |
| 10362 <refsection><info><title>Description</title></info> | |
| 10363 | |
| 10364 | |
| 10365 <para>Set to non-zero if you want to play with various HTML Help parameters | |
| 10366 and you don't need to regenerate all HTML files. This setting will not | |
| 10367 process whole document, only project files (hhp, hhc, hhk,...) will be | |
| 10368 generated.</para> | |
| 10369 | |
| 10370 | |
| 10371 </refsection> | |
| 10372 </refentry> | |
| 10373 | |
| 10374 </reference> | |
| 10375 <reference xml:id="eclipse_help"><title>Eclipse Help Platform</title> | |
| 10376 <refentry version="5.0" xml:id="eclipse.autolabel"> | |
| 10377 <refmeta> | |
| 10378 <refentrytitle>eclipse.autolabel</refentrytitle> | |
| 10379 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 10380 </refmeta> | |
| 10381 <refnamediv> | |
| 10382 <refname>eclipse.autolabel</refname> | |
| 10383 <refpurpose>Should tree-like ToC use autonumbering feature?</refpurpose> | |
| 10384 </refnamediv> | |
| 10385 | |
| 10386 <refsynopsisdiv> | |
| 10387 <programlisting xml:id="eclipse.autolabel.frag"> | |
| 10388 <xsl:param name="eclipse.autolabel" select="0"></xsl:param> | |
| 10389 </programlisting> | |
| 10390 </refsynopsisdiv> | |
| 10391 | |
| 10392 <refsection><info><title>Description</title></info> | |
| 10393 | |
| 10394 <para>If you want to include chapter and section numbers into ToC in | |
| 10395 the left panel, set this parameter to 1.</para> | |
| 10396 | |
| 10397 </refsection> | |
| 10398 </refentry> | |
| 10399 | |
| 10400 <refentry version="5.0" xml:id="eclipse.plugin.name"> | |
| 10401 <refmeta> | |
| 10402 <refentrytitle>eclipse.plugin.name</refentrytitle> | |
| 10403 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 10404 </refmeta> | |
| 10405 <refnamediv> | |
| 10406 <refname>eclipse.plugin.name</refname> | |
| 10407 <refpurpose>Eclipse Help plugin name</refpurpose> | |
| 10408 </refnamediv> | |
| 10409 | |
| 10410 <refsynopsisdiv> | |
| 10411 <programlisting xml:id="eclipse.plugin.name.frag"> | |
| 10412 <xsl:param name="eclipse.plugin.name">DocBook Online Help Sample</xsl:p
aram> | |
| 10413 </programlisting> | |
| 10414 </refsynopsisdiv> | |
| 10415 | |
| 10416 <refsection><info><title>Description</title></info> | |
| 10417 | |
| 10418 <para>Eclipse Help plugin name.</para> | |
| 10419 | |
| 10420 </refsection> | |
| 10421 </refentry> | |
| 10422 | |
| 10423 <refentry version="5.0" xml:id="eclipse.plugin.id"> | |
| 10424 <refmeta> | |
| 10425 <refentrytitle>eclipse.plugin.id</refentrytitle> | |
| 10426 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 10427 </refmeta> | |
| 10428 <refnamediv> | |
| 10429 <refname>eclipse.plugin.id</refname> | |
| 10430 <refpurpose>Eclipse Help plugin id</refpurpose> | |
| 10431 </refnamediv> | |
| 10432 | |
| 10433 <refsynopsisdiv> | |
| 10434 <programlisting xml:id="eclipse.plugin.id.frag"> | |
| 10435 <xsl:param name="eclipse.plugin.id">com.example.help</xsl:param> | |
| 10436 </programlisting> | |
| 10437 </refsynopsisdiv> | |
| 10438 | |
| 10439 <refsection><info><title>Description</title></info> | |
| 10440 | |
| 10441 <para>Eclipse Help plugin id. You should change this id to something | |
| 10442 unique for each help.</para> | |
| 10443 | |
| 10444 </refsection> | |
| 10445 </refentry> | |
| 10446 | |
| 10447 <refentry version="5.0" xml:id="eclipse.plugin.provider"> | |
| 10448 <refmeta> | |
| 10449 <refentrytitle>eclipse.plugin.provider</refentrytitle> | |
| 10450 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 10451 </refmeta> | |
| 10452 <refnamediv> | |
| 10453 <refname>eclipse.plugin.provider</refname> | |
| 10454 <refpurpose>Eclipse Help plugin provider name</refpurpose> | |
| 10455 </refnamediv> | |
| 10456 | |
| 10457 <refsynopsisdiv> | |
| 10458 <programlisting xml:id="eclipse.plugin.provider.frag"> | |
| 10459 <xsl:param name="eclipse.plugin.provider">Example provider</xsl:param&g
t; | |
| 10460 </programlisting> | |
| 10461 </refsynopsisdiv> | |
| 10462 | |
| 10463 <refsection><info><title>Description</title></info> | |
| 10464 | |
| 10465 <para>Eclipse Help plugin provider name.</para> | |
| 10466 | |
| 10467 </refsection> | |
| 10468 </refentry> | |
| 10469 | |
| 10470 </reference> | |
| 10471 <reference xml:id="webhelp"><title>WebHelp</title> | |
| 10472 <refentry version="5.0" xml:id="webhelp.autolabel"> | |
| 10473 <refmeta> | |
| 10474 <refentrytitle>webhelp.autolabel</refentrytitle> | |
| 10475 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 10476 </refmeta> | |
| 10477 <refnamediv> | |
| 10478 <refname>webhelp.autolabel</refname> | |
| 10479 <refpurpose>Should tree-like ToC use autonumbering feature?</refpurpose> | |
| 10480 </refnamediv> | |
| 10481 | |
| 10482 <refsynopsisdiv> | |
| 10483 <programlisting xml:id="webhelp.autolabel.frag"> | |
| 10484 <xsl:param name="webhelp.autolabel">0</xsl:param> | |
| 10485 </programlisting> | |
| 10486 </refsynopsisdiv> | |
| 10487 | |
| 10488 <refsection><info><title>Description</title></info> | |
| 10489 <para>To include chapter and section numbers the table of contents pane, set thi
s parameter to 1.</para> | |
| 10490 </refsection> | |
| 10491 </refentry> | |
| 10492 | |
| 10493 <refentry version="5.0" xml:id="webhelp.base.dir"> | |
| 10494 <refmeta> | |
| 10495 <refentrytitle>webhelp.base.dir</refentrytitle> | |
| 10496 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 10497 </refmeta> | |
| 10498 <refnamediv> | |
| 10499 <refname>webhelp.base.dir</refname> | |
| 10500 <refpurpose>The base directory for webhelp output.</refpurpose> | |
| 10501 </refnamediv> | |
| 10502 | |
| 10503 <refsynopsisdiv> | |
| 10504 <programlisting xml:id="webhelp.base.dir.frag"> | |
| 10505 <xsl:param name="webhelp.base.dir">docs</xsl:param> | |
| 10506 </programlisting> | |
| 10507 </refsynopsisdiv> | |
| 10508 | |
| 10509 <refsection><info><title>Description</title></info> | |
| 10510 <para>If specified, the <parameter>webhelp.base.dir</parameter> | |
| 10511 parameter identifies the output directory for webhelp. (If not | |
| 10512 specified, the output directory is system dependent.) By default, this | |
| 10513 parameter is set to <filename>docs</filename>.</para> | |
| 10514 | |
| 10515 </refsection> | |
| 10516 </refentry> | |
| 10517 | |
| 10518 <refentry version="5.0" xml:id="webhelp.common.dir"> | |
| 10519 <refmeta> | |
| 10520 <refentrytitle>webhelp.common.dir</refentrytitle> | |
| 10521 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 10522 </refmeta> | |
| 10523 <refnamediv> | |
| 10524 <refname>webhelp.common.dir</refname> | |
| 10525 <refpurpose>Path to the directory for the common webhelp resources (JavaScript,
css, common images, etc).</refpurpose> | |
| 10526 </refnamediv> | |
| 10527 | |
| 10528 <refsynopsisdiv> | |
| 10529 <programlisting xml:id="webhelp.common.dir.frag"> | |
| 10530 <xsl:param name="webhelp.common.dir">../common/</xsl:param> | |
| 10531 </programlisting> | |
| 10532 </refsynopsisdiv> | |
| 10533 | |
| 10534 <refsection><info><title>Description</title></info> | |
| 10535 <para>By default, webhelp creates a common directory containing resources such a
s JavaScript files, css, common images, etc. In some cases you may prefer to sto
re these files in a standard location on your site and point all webhelp documen
ts to that location. You can use this parameter to control the urls written to t
hese common resources. For example, you might set this parameter to <code>/commo
n</code> and create a single common directory at the root of your web server. <
/para> | |
| 10536 </refsection> | |
| 10537 </refentry> | |
| 10538 | |
| 10539 <refentry version="5.0" xml:id="webhelp.default.topic"> | |
| 10540 <refmeta> | |
| 10541 <refentrytitle>webhelp.default.topic</refentrytitle> | |
| 10542 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 10543 </refmeta> | |
| 10544 <refnamediv> | |
| 10545 <refname>webhelp.default.topic</refname> | |
| 10546 <refpurpose>The name of the file to which the start file in the webhelp base dir
ectory redirects</refpurpose> | |
| 10547 </refnamediv> | |
| 10548 | |
| 10549 <refsynopsisdiv> | |
| 10550 <programlisting xml:id="webhelp.default.topic.frag"> | |
| 10551 <xsl:param name="webhelp.default.topic">index.html</xsl:param> | |
| 10552 </programlisting> | |
| 10553 </refsynopsisdiv> | |
| 10554 | |
| 10555 <refsection><info><title>Description</title></info> | |
| 10556 <para>Currently webhelp creates a base directory and puts the output | |
| 10557 files in a <filename>content</filename> subdirectory. It creates a | |
| 10558 file in the base directory that redirects to a configured file in the | |
| 10559 <filename>content</filename> directory. The | |
| 10560 <parameter>webhelp.default.topic</parameter> parameter lets you | |
| 10561 configure the name of the file that is redirected to. | |
| 10562 <note> | |
| 10563 <para>This parameter will be removed from a future version of | |
| 10564 webhelp along with the <filename>content</filename> | |
| 10565 directory.</para> | |
| 10566 </note> | |
| 10567 </para> | |
| 10568 </refsection> | |
| 10569 </refentry> | |
| 10570 | |
| 10571 <refentry version="5.0" xml:id="webhelp.include.search.tab"> | |
| 10572 <refmeta> | |
| 10573 <refentrytitle>webhelp.include.search.tab</refentrytitle> | |
| 10574 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 10575 </refmeta> | |
| 10576 <refnamediv> | |
| 10577 <refname>webhelp.include.search.tab</refname> | |
| 10578 <refpurpose>Should the webhelp output include a Search tab?</refpurpose> | |
| 10579 </refnamediv> | |
| 10580 | |
| 10581 <refsynopsisdiv> | |
| 10582 <programlisting xml:id="webhelp.include.search.tab.frag"> | |
| 10583 <xsl:param name="webhelp.include.search.tab">true</xsl:param> | |
| 10584 </programlisting> | |
| 10585 </refsynopsisdiv> | |
| 10586 | |
| 10587 <refsection><info><title>Description</title></info> | |
| 10588 <para>Set this parameter to 0 to suppress the search tab from webhelp output.</p
ara> | |
| 10589 </refsection> | |
| 10590 </refentry> | |
| 10591 | |
| 10592 <refentry version="5.0" xml:id="webhelp.indexer.language"> | |
| 10593 <refmeta> | |
| 10594 <refentrytitle>webhelp.indexer.language</refentrytitle> | |
| 10595 <refmiscinfo class="other" otherclass="datatype"/> | |
| 10596 </refmeta> | |
| 10597 <refnamediv> | |
| 10598 <refname>webhelp.indexer.language</refname> | |
| 10599 <refpurpose>The language to use for creating the webhelp search index.</refpurpo
se> | |
| 10600 </refnamediv> | |
| 10601 | |
| 10602 <refsynopsisdiv> | |
| 10603 <programlisting xml:id="webhelp.indexer.language.frag"> | |
| 10604 <xsl:param name="webhelp.indexer.language">en</xsl:param> | |
| 10605 </programlisting> | |
| 10606 </refsynopsisdiv> | |
| 10607 | |
| 10608 <refsection><info><title>Description</title></info> | |
| 10609 <para>To support stemming in the client-side webhelp stemmer, you must provide t
he language code. By default, the following languages are supported: | |
| 10610 <itemizedlist> | |
| 10611 <listitem> | |
| 10612 <para><code>en</code>: English</para> | |
| 10613 </listitem> | |
| 10614 <listitem> | |
| 10615 <para><code>de</code>: German</para> | |
| 10616 </listitem> | |
| 10617 <listitem> | |
| 10618 <para><code>fr</code>: French</para> | |
| 10619 </listitem> | |
| 10620 <listitem> | |
| 10621 <para><code>zh</code>: Chinese</para> | |
| 10622 </listitem> | |
| 10623 <listitem> | |
| 10624 <para><code>ja</code>: Japanese</para> | |
| 10625 </listitem> | |
| 10626 <listitem> | |
| 10627 <para><code>ko</code>: Korean</para> | |
| 10628 </listitem> | |
| 10629 </itemizedlist> | |
| 10630 See the webhelp documentation for information on adding support for additional l
anguages. | |
| 10631 </para> | |
| 10632 </refsection> | |
| 10633 </refentry> | |
| 10634 | |
| 10635 <refentry version="5.0" xml:id="webhelp.start.filename"> | |
| 10636 <refmeta> | |
| 10637 <refentrytitle>webhelp.start.filename</refentrytitle> | |
| 10638 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 10639 </refmeta> | |
| 10640 <refnamediv> | |
| 10641 <refname>webhelp.start.filename</refname> | |
| 10642 <refpurpose>The name of the start file in the webhelp base directory.</refpurpos
e> | |
| 10643 </refnamediv> | |
| 10644 | |
| 10645 <refsynopsisdiv> | |
| 10646 <programlisting xml:id="webhelp.start.filename.frag"> | |
| 10647 <xsl:param name="webhelp.start.filename">index.html</xsl:param> | |
| 10648 </programlisting> | |
| 10649 </refsynopsisdiv> | |
| 10650 | |
| 10651 <refsection><info><title>Description</title></info> | |
| 10652 <para>Currently webhelp creates a base directory and puts the output | |
| 10653 files in a <filename>content</filename> subdirectory. It creates a | |
| 10654 file in the base directory that redirects to a configured file in the | |
| 10655 <filename>content</filename> directory. The <parameter>webhelp.start.filename</p
arameter> parameter lets you configure the name of the redirect file. | |
| 10656 <note> | |
| 10657 <para>This parameter will be removed from a future version of | |
| 10658 webhelp along with the <filename>content</filename> | |
| 10659 directory.</para> | |
| 10660 </note> | |
| 10661 </para> | |
| 10662 </refsection> | |
| 10663 </refentry> | |
| 10664 | |
| 10665 <refentry version="5.0" xml:id="webhelp.tree.cookie.id"> | |
| 10666 <refmeta> | |
| 10667 <refentrytitle>webhelp.tree.cookie.id</refentrytitle> | |
| 10668 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 10669 </refmeta> | |
| 10670 <refnamediv> | |
| 10671 <refname>webhelp.tree.cookie.id</refname> | |
| 10672 <refpurpose>Controls how the cookie that stores the webhelp toc state is named.<
/refpurpose> | |
| 10673 </refnamediv> | |
| 10674 | |
| 10675 <refsynopsisdiv> | |
| 10676 <programlisting xml:id="webhelp.tree.cookie.id.frag"> | |
| 10677 <xsl:param name="webhelp.tree.cookie.id" select="concat( 'treeview-', count(/
/node()) )"></xsl:param> | |
| 10678 </programlisting> | |
| 10679 </refsynopsisdiv> | |
| 10680 | |
| 10681 <refsection><info><title>Description</title></info> | |
| 10682 <para>The webhelp output does not use a frameset. Instead, the table of contents
is a div on each page. To preserve the state of the table of contents as the us
er navigates from page to page, webhelp stores the state in a cookie and reads t
hat cookie when you get to the next page. If you've published several webhelp do
cuments on the same domain, it is important that each cookie have a unique id. I
n lieu of calling on a GUID generator, by default this parameter is just set to
the number of nodes in the document on the assumption that it is unlikely that y
ou will have more than one document with the exact number of nodes. A more optim
al solution would be for the user to pass in some unique, stable identifier from
the build system to use as the webhelp cookie id. For example, if you have safe
guards in place to ensure that the xml:id of the root element of each document w
ill be unique on your site, then you could set webhelptree.cookie.id as follows: | |
| 10683 <programlisting> | |
| 10684 <xsl:param name="webhelp.tree.cookie.id"> | |
| 10685 <xsl:choose> | |
| 10686 <xsl:when test="/*/@xml:id"> | |
| 10687 <xsl:value-of select="concat('treeview-',/*/@xml:id)"/> | |
| 10688 </xsl:when> | |
| 10689 <xsl:otherwise> | |
| 10690 <xsl:value-of select="concat( 'treeview-', count(//node()) )"/> | |
| 10691 </xsl:otherwise> | |
| 10692 </xsl:choose> | |
| 10693 </xsl:param> | |
| 10694 </programlisting> | |
| 10695 </para> | |
| 10696 </refsection> | |
| 10697 </refentry> | |
| 10698 | |
| 10699 </reference> | |
| 10700 <reference xml:id="javahelp"><title>JavaHelp</title> | |
| 10701 <refentry version="5.0" xml:id="javahelp.encoding"> | |
| 10702 <refmeta> | |
| 10703 <refentrytitle>javahelp.encoding</refentrytitle> | |
| 10704 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 10705 </refmeta> | |
| 10706 <refnamediv> | |
| 10707 <refname>javahelp.encoding</refname> | |
| 10708 <refpurpose>Character encoding to use in control files for JavaHelp.</refpurpose
> | |
| 10709 </refnamediv> | |
| 10710 | |
| 10711 <refsynopsisdiv> | |
| 10712 <programlisting xml:id="javahelp.encoding.frag"> | |
| 10713 <xsl:param name="javahelp.encoding">iso-8859-1</xsl:param> | |
| 10714 </programlisting> | |
| 10715 </refsynopsisdiv> | |
| 10716 | |
| 10717 <refsection><info><title>Description</title></info> | |
| 10718 | |
| 10719 <para>JavaHelp crashes on some characters when written as character | |
| 10720 references. In that case you can use this parameter to select an appropriate enc
oding.</para> | |
| 10721 | |
| 10722 </refsection> | |
| 10723 </refentry> | |
| 10724 | |
| 10725 | |
| 10726 | |
| 10727 | |
| 10728 </reference> | |
| 10729 <reference xml:id="l10n"><title>Localization</title> | |
| 10730 <refentry version="5.0" xml:id="l10n.gentext.language"> | |
| 10731 <refmeta> | |
| 10732 <refentrytitle>l10n.gentext.language</refentrytitle> | |
| 10733 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 10734 </refmeta> | |
| 10735 <refnamediv> | |
| 10736 <refname>l10n.gentext.language</refname> | |
| 10737 <refpurpose>Sets the gentext language</refpurpose> | |
| 10738 </refnamediv> | |
| 10739 | |
| 10740 <refsynopsisdiv> | |
| 10741 <programlisting xml:id="l10n.gentext.language.frag"> | |
| 10742 <xsl:param name="l10n.gentext.language"></xsl:param> | |
| 10743 </programlisting> | |
| 10744 </refsynopsisdiv> | |
| 10745 | |
| 10746 <refsection><info><title>Description</title></info> | |
| 10747 | |
| 10748 <para>If this parameter is set to any value other than the empty string, its | |
| 10749 value will be used as the value for the language when generating text. Setting | |
| 10750 <parameter>l10n.gentext.language</parameter> overrides any settings within the | |
| 10751 document being formatted.</para> | |
| 10752 | |
| 10753 <para>It's much more likely that you might want to set the | |
| 10754 <parameter>l10n.gentext.default.language</parameter> parameter.</para> | |
| 10755 | |
| 10756 </refsection> | |
| 10757 </refentry> | |
| 10758 | |
| 10759 <refentry version="5.0" xml:id="l10n.gentext.default.language"> | |
| 10760 <refmeta> | |
| 10761 <refentrytitle>l10n.gentext.default.language</refentrytitle> | |
| 10762 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 10763 </refmeta> | |
| 10764 <refnamediv> | |
| 10765 <refname>l10n.gentext.default.language</refname> | |
| 10766 <refpurpose>Sets the default language for generated text</refpurpose> | |
| 10767 </refnamediv> | |
| 10768 | |
| 10769 <refsynopsisdiv> | |
| 10770 <programlisting xml:id="l10n.gentext.default.language.frag"> | |
| 10771 <xsl:param name="l10n.gentext.default.language">en</xsl:param> | |
| 10772 </programlisting> | |
| 10773 </refsynopsisdiv> | |
| 10774 | |
| 10775 <refsection><info><title>Description</title></info> | |
| 10776 | |
| 10777 <para>The value of the <parameter>l10n.gentext.default.language</parameter> | |
| 10778 parameter is used as the language for generated text if no setting is provided | |
| 10779 in the source document.</para> | |
| 10780 | |
| 10781 </refsection> | |
| 10782 </refentry> | |
| 10783 | |
| 10784 <refentry version="5.0" xml:id="l10n.gentext.use.xref.language"> | |
| 10785 <refmeta> | |
| 10786 <refentrytitle>l10n.gentext.use.xref.language</refentrytitle> | |
| 10787 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 10788 </refmeta> | |
| 10789 <refnamediv> | |
| 10790 <refname>l10n.gentext.use.xref.language</refname> | |
| 10791 <refpurpose>Use the language of target when generating cross-reference text?</re
fpurpose> | |
| 10792 </refnamediv> | |
| 10793 | |
| 10794 <refsynopsisdiv> | |
| 10795 <programlisting xml:id="l10n.gentext.use.xref.language.frag"> | |
| 10796 <xsl:param name="l10n.gentext.use.xref.language" select="0"></xsl:param
> | |
| 10797 </programlisting> | |
| 10798 </refsynopsisdiv> | |
| 10799 | |
| 10800 <refsection><info><title>Description</title></info> | |
| 10801 | |
| 10802 <para>If non-zero, the language of the target will be used when | |
| 10803 generating cross reference text. Usually, the <quote>current</quote> | |
| 10804 language is used when generating text (that is, the language of the | |
| 10805 element that contains the cross-reference element). But setting this parameter | |
| 10806 allows the language of the element <emphasis>pointed to</emphasis> to control | |
| 10807 the generated text.</para> | |
| 10808 | |
| 10809 <para>Consider the following example:</para> | |
| 10810 | |
| 10811 <informalexample> | |
| 10812 <programlisting><para lang="en">See also <xref linkend="chap3"/>.<
;/para> | |
| 10813 </programlisting> | |
| 10814 </informalexample> | |
| 10815 | |
| 10816 <para>Suppose that Chapter 3 happens to be written in German. | |
| 10817 If <parameter>l10n.gentext.use.xref.language</parameter> is non-zero, the | |
| 10818 resulting text will be something like this:</para> | |
| 10819 | |
| 10820 <blockquote> | |
| 10821 <para>See also Kapital 3.</para> | |
| 10822 </blockquote> | |
| 10823 | |
| 10824 <para>Where the more traditional rendering would be:</para> | |
| 10825 | |
| 10826 <blockquote> | |
| 10827 <para>See also Chapter 3.</para> | |
| 10828 </blockquote> | |
| 10829 | |
| 10830 </refsection> | |
| 10831 </refentry> | |
| 10832 | |
| 10833 <refentry version="5.0" xml:id="l10n.lang.value.rfc.compliant"> | |
| 10834 <refmeta> | |
| 10835 <refentrytitle>l10n.lang.value.rfc.compliant</refentrytitle> | |
| 10836 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
| 10837 </refmeta> | |
| 10838 <refnamediv> | |
| 10839 <refname>l10n.lang.value.rfc.compliant</refname> | |
| 10840 <refpurpose>Make value of lang attribute RFC compliant?</refpurpose> | |
| 10841 </refnamediv> | |
| 10842 | |
| 10843 <refsynopsisdiv> | |
| 10844 <programlisting xml:id="l10n.lang.value.rfc.compliant.frag"> | |
| 10845 <xsl:param name="l10n.lang.value.rfc.compliant" select="1"></xsl:param&
gt; | |
| 10846 </programlisting> | |
| 10847 </refsynopsisdiv> | |
| 10848 | |
| 10849 <refsection><info><title>Description</title></info> | |
| 10850 | |
| 10851 <para>If non-zero, ensure that the values for all <tag class="attribute">lang</t
ag> attributes in HTML output are RFC | |
| 10852 compliant<footnote><para>Section 8.1.1, <link xmlns:xlink="http://www.w3.org/199
9/xlink" xlink:href="http://www.w3.org/TR/REC-html40/struct/dirlang.html#h-8.1.1
">Language Codes</link>, in the HTML 4.0 Recommendation states that: | |
| 10853 | |
| 10854 <blockquote><para>[RFC1766] defines and explains the language codes | |
| 10855 that must be used in HTML documents.</para> | |
| 10856 <para>Briefly, language codes consist of a primary code and a possibly | |
| 10857 empty series of subcodes: | |
| 10858 | |
| 10859 <literallayout class="monospaced">language-code = primary-code ( "-" subcode )*<
/literallayout> | |
| 10860 </para> | |
| 10861 <para>And in RFC 1766, <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:hr
ef="http://www.ietf.org/rfc/rfc1766.txt">Tags for the Identification | |
| 10862 of Languages</link>, the EBNF for "language tag" is given as: | |
| 10863 | |
| 10864 <literallayout class="monospaced">Language-Tag = Primary-tag *( "-" Subtag ) | |
| 10865 Primary-tag = 1*8ALPHA | |
| 10866 Subtag = 1*8ALPHA</literallayout> | |
| 10867 </para> | |
| 10868 </blockquote> | |
| 10869 </para></footnote>. | |
| 10870 | |
| 10871 by taking any underscore characters in any <tag class="attribute">lang</tag> val
ues found in source documents, and | |
| 10872 replacing them with hyphen characters in output HTML files. For | |
| 10873 example, <literal>zh_CN</literal> in a source document becomes | |
| 10874 <literal>zh-CN</literal> in the HTML output form that source. | |
| 10875 | |
| 10876 <note> | |
| 10877 <para>This parameter does not cause any case change in <tag class="attribute">la
ng</tag> values, because RFC 1766 | |
| 10878 explicitly states that all "language tags" (as it calls them) "are | |
| 10879 to be treated as case insensitive".</para> | |
| 10880 </note> | |
| 10881 </para> | |
| 10882 | |
| 10883 </refsection> | |
| 10884 </refentry> | |
| 10885 | |
| 10886 <refentry version="5.0" xml:id="writing.mode"> | |
| 10887 <refmeta> | |
| 10888 <refentrytitle>writing.mode</refentrytitle> | |
| 10889 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo> | |
| 10890 </refmeta> | |
| 10891 <refnamediv> | |
| 10892 <refname>writing.mode</refname> | |
| 10893 <refpurpose>Direction of text flow based on locale</refpurpose> | |
| 10894 </refnamediv> | |
| 10895 | |
| 10896 <refsynopsisdiv> | |
| 10897 <programlisting xml:id="writing.mode.frag"> | |
| 10898 <xsl:param name="writing.mode"> | |
| 10899 <xsl:call-template name="gentext"> | |
| 10900 <xsl:with-param name="key">writing-mode</xsl:with-param> | |
| 10901 <xsl:with-param name="lang"> | |
| 10902 <xsl:call-template name="l10n.language"> | |
| 10903 <xsl:with-param name="target" select="/*[1]"></xsl:with-param&g
t; | |
| 10904 </xsl:call-template> | |
| 10905 </xsl:with-param> | |
| 10906 </xsl:call-template> | |
| 10907 </xsl:param> | |
| 10908 </programlisting> | |
| 10909 </refsynopsisdiv> | |
| 10910 | |
| 10911 <refsection><info><title>Description</title></info> | |
| 10912 | |
| 10913 <para>Sets direction of text flow and text alignment based on locale. | |
| 10914 The value is normally taken from the gentext file for the | |
| 10915 lang attribute of the document's root element, using the | |
| 10916 key name 'writing-mode' to look it up in the gentext file. | |
| 10917 But this param can also be | |
| 10918 set on the command line to override that gentext value. | |
| 10919 </para> | |
| 10920 <para>Accepted values are: | |
| 10921 <variablelist> | |
| 10922 <varlistentry> | |
| 10923 <term>lr-tb</term> | |
| 10924 <listitem> | |
| 10925 <para>Left-to-right text flow in each line, lines stack top to bottom.</pa
ra> | |
| 10926 </listitem> | |
| 10927 </varlistentry> | |
| 10928 <varlistentry> | |
| 10929 <term>rl-tb</term> | |
| 10930 <listitem> | |
| 10931 <para>Right-to-left text flow in each line, lines stack top to bottom.</pa
ra> | |
| 10932 </listitem> | |
| 10933 </varlistentry> | |
| 10934 <varlistentry> | |
| 10935 <term>tb-rl</term> | |
| 10936 <listitem> | |
| 10937 <para>Top-to-bottom text flow in each vertical line, lines stack right to
left. | |
| 10938 Supported by only a few XSL-FO processors. Not supported in HTML output.</
para> | |
| 10939 </listitem> | |
| 10940 </varlistentry> | |
| 10941 <varlistentry> | |
| 10942 <term>lr</term> | |
| 10943 <listitem> | |
| 10944 <para>Shorthand for lr-tb.</para> | |
| 10945 </listitem> | |
| 10946 </varlistentry> | |
| 10947 <varlistentry> | |
| 10948 <term>rl</term> | |
| 10949 <listitem> | |
| 10950 <para>Shorthand for rl-tb.</para> | |
| 10951 </listitem> | |
| 10952 </varlistentry> | |
| 10953 <varlistentry> | |
| 10954 <term>tb</term> | |
| 10955 <listitem> | |
| 10956 <para>Shorthand for tb-rl.</para> | |
| 10957 </listitem> | |
| 10958 </varlistentry> | |
| 10959 </variablelist> | |
| 10960 </para> | |
| 10961 | |
| 10962 </refsection> | |
| 10963 </refentry> | |
| 10964 | |
| 10965 </reference> | |
| 10966 <appendix xml:id="stylesheet"><title>The Stylesheet</title> | |
| 10967 | |
| 10968 <para>The <filename>param.xsl</filename> stylesheet is just a wrapper | |
| 10969 around all these parameters.</para> | |
| 10970 | |
| 10971 <programlisting xml:id="top"> | |
| 10972 | |
| 10973 <!-- This file is generated from param.xweb --> | |
| 10974 | |
| 10975 <xsl:stylesheet exclude-result-prefixes="src" version="1.0"> | |
| 10976 | |
| 10977 <!-- ******************************************************************** | |
| 10978 $Id: param.xweb 9658 2012-10-29 22:28:34Z bobstayton $ | |
| 10979 ******************************************************************** | |
| 10980 | |
| 10981 This file is part of the XSL DocBook Stylesheet distribution. | |
| 10982 See ../README or http://docbook.sf.net/release/xsl/current/ for | |
| 10983 copyright and other information. | |
| 10984 | |
| 10985 ******************************************************************** --> | |
| 10986 | |
| 10987 <src:fragref linkend="abstract.notitle.enabled.frag"></src:fragref> | |
| 10988 <src:fragref linkend="activate.external.olinks.frag"></src:fragref> | |
| 10989 <src:fragref linkend="admon.graphics.extension.frag"></src:fragref> | |
| 10990 <src:fragref linkend="admon.graphics.frag"></src:fragref> | |
| 10991 <src:fragref linkend="admon.graphics.path.frag"></src:fragref> | |
| 10992 <src:fragref linkend="admon.style.frag"></src:fragref> | |
| 10993 <src:fragref linkend="admon.textlabel.frag"></src:fragref> | |
| 10994 <src:fragref linkend="annotate.toc.frag"></src:fragref> | |
| 10995 <src:fragref linkend="annotation.css.frag"></src:fragref> | |
| 10996 <src:fragref linkend="annotation.graphic.close.frag"></src:fragref> | |
| 10997 <src:fragref linkend="annotation.graphic.open.frag"></src:fragref> | |
| 10998 <src:fragref linkend="annotation.js.frag"></src:fragref> | |
| 10999 <src:fragref linkend="annotation.support.frag"></src:fragref> | |
| 11000 <src:fragref linkend="appendix.autolabel.frag"></src:fragref> | |
| 11001 <src:fragref linkend="author.othername.in.middle.frag"></src:fragref>
; | |
| 11002 <src:fragref linkend="autotoc.label.in.hyperlink.frag"></src:fragref>
; | |
| 11003 <src:fragref linkend="autotoc.label.separator.frag"></src:fragref> | |
| 11004 <src:fragref linkend="base.dir.frag"></src:fragref> | |
| 11005 <src:fragref linkend="biblioentry.item.separator.frag"></src:fragref>
; | |
| 11006 <src:fragref linkend="bibliography.collection.frag"></src:fragref> | |
| 11007 <src:fragref linkend="bibliography.numbered.frag"></src:fragref> | |
| 11008 <src:fragref linkend="bibliography.style.frag"></src:fragref> | |
| 11009 <src:fragref linkend="blurb.on.titlepage.enabled.frag"></src:fragref>
; | |
| 11010 <src:fragref linkend="bridgehead.in.toc.frag"></src:fragref> | |
| 11011 <src:fragref linkend="callout.defaultcolumn.frag"></src:fragref> | |
| 11012 <src:fragref linkend="callout.graphics.extension.frag"></src:fragref>
; | |
| 11013 <src:fragref linkend="callout.graphics.frag"></src:fragref> | |
| 11014 <src:fragref linkend="callout.graphics.number.limit.frag"></src:fragref
> | |
| 11015 <src:fragref linkend="callout.graphics.path.frag"></src:fragref> | |
| 11016 <src:fragref linkend="callout.list.table.frag"></src:fragref> | |
| 11017 <src:fragref linkend="callout.unicode.frag"></src:fragref> | |
| 11018 <src:fragref linkend="callout.unicode.number.limit.frag"></src:fragref&
gt; | |
| 11019 <src:fragref linkend="callout.unicode.start.character.frag"></src:fragr
ef> | |
| 11020 <src:fragref linkend="callouts.extension.frag"></src:fragref> | |
| 11021 <src:fragref linkend="chapter.autolabel.frag"></src:fragref> | |
| 11022 <src:fragref linkend="chunk.append.frag"></src:fragref> | |
| 11023 <src:fragref linkend="chunk.first.sections.frag"></src:fragref> | |
| 11024 <src:fragref linkend="chunk.quietly.frag"></src:fragref> | |
| 11025 <src:fragref linkend="chunk.section.depth.frag"></src:fragref> | |
| 11026 <src:fragref linkend="chunk.separate.lots.frag"></src:fragref> | |
| 11027 <src:fragref linkend="chunk.toc.frag"></src:fragref> | |
| 11028 <src:fragref linkend="chunk.tocs.and.lots.frag"></src:fragref> | |
| 11029 <src:fragref linkend="chunk.tocs.and.lots.has.title.frag"></src:fragref
> | |
| 11030 <src:fragref linkend="chunked.filename.prefix.frag"></src:fragref> | |
| 11031 <src:fragref linkend="citerefentry.link.frag"></src:fragref> | |
| 11032 <src:fragref linkend="collect.xref.targets.frag"></src:fragref> | |
| 11033 <src:fragref linkend="component.label.includes.part.label.frag"></src:f
ragref> | |
| 11034 <src:fragref linkend="contrib.inline.enabled.frag"></src:fragref> | |
| 11035 <src:fragref linkend="css.decoration.frag"></src:fragref> | |
| 11036 <src:fragref linkend="current.docid.frag"></src:fragref> | |
| 11037 <src:fragref linkend="custom.css.source.frag"></src:fragref> | |
| 11038 <src:fragref linkend="default.float.class.frag"></src:fragref> | |
| 11039 <src:fragref linkend="default.image.width.frag"></src:fragref> | |
| 11040 <src:fragref linkend="default.table.frame.frag"></src:fragref> | |
| 11041 <src:fragref linkend="default.table.width.frag"></src:fragref> | |
| 11042 <src:fragref linkend="docbook.css.link.frag"></src:fragref> | |
| 11043 <src:fragref linkend="docbook.css.source.frag"></src:fragref> | |
| 11044 <src:fragref linkend="draft.mode.frag"></src:fragref> | |
| 11045 <src:fragref linkend="draft.watermark.image.frag"></src:fragref> | |
| 11046 <src:fragref linkend="ebnf.assignment.frag"></src:fragref> | |
| 11047 <src:fragref linkend="ebnf.statement.terminator.frag"></src:fragref> | |
| 11048 <src:fragref linkend="ebnf.table.bgcolor.frag"></src:fragref> | |
| 11049 <src:fragref linkend="ebnf.table.border.frag"></src:fragref> | |
| 11050 <src:fragref linkend="eclipse.autolabel.frag"></src:fragref> | |
| 11051 <src:fragref linkend="eclipse.plugin.id.frag"></src:fragref> | |
| 11052 <src:fragref linkend="eclipse.plugin.name.frag"></src:fragref> | |
| 11053 <src:fragref linkend="eclipse.plugin.provider.frag"></src:fragref> | |
| 11054 <src:fragref linkend="editedby.enabled.frag"></src:fragref> | |
| 11055 <src:fragref linkend="email.delimiters.enabled.frag"></src:fragref> | |
| 11056 <src:fragref linkend="emphasis.propagates.style.frag"></src:fragref> | |
| 11057 <src:fragref linkend="entry.propagates.style.frag"></src:fragref> | |
| 11058 <src:fragref linkend="exsl.node.set.available.frag"></src:fragref> | |
| 11059 <src:fragref linkend="firstterm.only.link.frag"></src:fragref> | |
| 11060 <src:fragref linkend="footer.rule.frag"></src:fragref> | |
| 11061 <src:fragref linkend="footnote.number.format.frag"></src:fragref> | |
| 11062 <src:fragref linkend="footnote.number.symbols.frag"></src:fragref> | |
| 11063 <src:fragref linkend="formal.procedures.frag"></src:fragref> | |
| 11064 <src:fragref linkend="formal.title.placement.frag"></src:fragref> | |
| 11065 <src:fragref linkend="funcsynopsis.decoration.frag"></src:fragref> | |
| 11066 <src:fragref linkend="funcsynopsis.style.frag"></src:fragref> | |
| 11067 <src:fragref linkend="function.parens.frag"></src:fragref> | |
| 11068 <src:fragref linkend="generate.consistent.ids.frag"></src:fragref> | |
| 11069 <src:fragref linkend="generate.css.header.frag"></src:fragref> | |
| 11070 <src:fragref linkend="generate.id.attributes.frag"></src:fragref> | |
| 11071 <src:fragref linkend="generate.index.frag"></src:fragref> | |
| 11072 <src:fragref linkend="generate.legalnotice.link.frag"></src:fragref> | |
| 11073 <src:fragref linkend="generate.manifest.frag"></src:fragref> | |
| 11074 <src:fragref linkend="generate.meta.abstract.frag"></src:fragref> | |
| 11075 <src:fragref linkend="generate.revhistory.link.frag"></src:fragref> | |
| 11076 <src:fragref linkend="generate.section.toc.level.frag"></src:fragref>
; | |
| 11077 <src:fragref linkend="generate.toc.frag"></src:fragref> | |
| 11078 <src:fragref linkend="glossary.collection.frag"></src:fragref> | |
| 11079 <src:fragref linkend="glossary.sort.frag"></src:fragref> | |
| 11080 <src:fragref linkend="glossentry.show.acronym.frag"></src:fragref> | |
| 11081 <src:fragref linkend="glossterm.auto.link.frag"></src:fragref> | |
| 11082 <src:fragref linkend="graphic.default.extension.frag"></src:fragref> | |
| 11083 <src:fragref linkend="graphicsize.extension.frag"></src:fragref> | |
| 11084 <src:fragref linkend="graphicsize.use.img.src.path.frag"></src:fragref&
gt; | |
| 11085 <src:fragref linkend="header.rule.frag"></src:fragref> | |
| 11086 <src:fragref linkend="highlight.default.language.frag"></src:fragref>
; | |
| 11087 <src:fragref linkend="highlight.source.frag"></src:fragref> | |
| 11088 <src:fragref linkend="highlight.xslthl.config.frag"></src:fragref> | |
| 11089 <src:fragref linkend="html.append.frag"></src:fragref> | |
| 11090 <src:fragref linkend="html.base.frag"></src:fragref> | |
| 11091 <src:fragref linkend="html.cellpadding.frag"></src:fragref> | |
| 11092 <src:fragref linkend="html.cellspacing.frag"></src:fragref> | |
| 11093 <src:fragref linkend="html.cleanup.frag"></src:fragref> | |
| 11094 <src:fragref linkend="html.ext.frag"></src:fragref> | |
| 11095 <src:fragref linkend="html.extra.head.links.frag"></src:fragref> | |
| 11096 <src:fragref linkend="html.head.legalnotice.link.multiple.frag"></src:f
ragref> | |
| 11097 <src:fragref linkend="html.head.legalnotice.link.types.frag"></src:frag
ref> | |
| 11098 <src:fragref linkend="html.longdesc.frag"></src:fragref> | |
| 11099 <src:fragref linkend="html.longdesc.link.frag"></src:fragref> | |
| 11100 <src:fragref linkend="html.script.frag"></src:fragref> | |
| 11101 <src:fragref linkend="html.script.type.frag"></src:fragref> | |
| 11102 <src:fragref linkend="html.stylesheet.frag"></src:fragref> | |
| 11103 <src:fragref linkend="html.stylesheet.type.frag"></src:fragref> | |
| 11104 <src:fragref linkend="htmlhelp.alias.file.frag"></src:fragref> | |
| 11105 <src:fragref linkend="htmlhelp.autolabel.frag"></src:fragref> | |
| 11106 <src:fragref linkend="htmlhelp.button.back.frag"></src:fragref> | |
| 11107 <src:fragref linkend="htmlhelp.button.forward.frag"></src:fragref> | |
| 11108 <src:fragref linkend="htmlhelp.button.hideshow.frag"></src:fragref> | |
| 11109 <src:fragref linkend="htmlhelp.button.home.frag"></src:fragref> | |
| 11110 <src:fragref linkend="htmlhelp.button.home.url.frag"></src:fragref> | |
| 11111 <src:fragref linkend="htmlhelp.button.jump1.frag"></src:fragref> | |
| 11112 <src:fragref linkend="htmlhelp.button.jump1.title.frag"></src:fragref&g
t; | |
| 11113 <src:fragref linkend="htmlhelp.button.jump1.url.frag"></src:fragref> | |
| 11114 <src:fragref linkend="htmlhelp.button.jump2.frag"></src:fragref> | |
| 11115 <src:fragref linkend="htmlhelp.button.jump2.title.frag"></src:fragref&g
t; | |
| 11116 <src:fragref linkend="htmlhelp.button.jump2.url.frag"></src:fragref> | |
| 11117 <src:fragref linkend="htmlhelp.button.locate.frag"></src:fragref> | |
| 11118 <src:fragref linkend="htmlhelp.button.next.frag"></src:fragref> | |
| 11119 <src:fragref linkend="htmlhelp.button.options.frag"></src:fragref> | |
| 11120 <src:fragref linkend="htmlhelp.button.prev.frag"></src:fragref> | |
| 11121 <src:fragref linkend="htmlhelp.button.print.frag"></src:fragref> | |
| 11122 <src:fragref linkend="htmlhelp.button.refresh.frag"></src:fragref> | |
| 11123 <src:fragref linkend="htmlhelp.button.stop.frag"></src:fragref> | |
| 11124 <src:fragref linkend="htmlhelp.button.zoom.frag"></src:fragref> | |
| 11125 <src:fragref linkend="htmlhelp.chm.frag"></src:fragref> | |
| 11126 <src:fragref linkend="htmlhelp.default.topic.frag"></src:fragref> | |
| 11127 <src:fragref linkend="htmlhelp.display.progress.frag"></src:fragref> | |
| 11128 <src:fragref linkend="htmlhelp.encoding.frag"></src:fragref> | |
| 11129 <src:fragref linkend="htmlhelp.enhanced.decompilation.frag"></src:fragr
ef> | |
| 11130 <src:fragref linkend="htmlhelp.enumerate.images.frag"></src:fragref> | |
| 11131 <src:fragref linkend="htmlhelp.force.map.and.alias.frag"></src:fragref&
gt; | |
| 11132 <src:fragref linkend="htmlhelp.hhc.binary.frag"></src:fragref> | |
| 11133 <src:fragref linkend="htmlhelp.hhc.folders.instead.books.frag"></src:fr
agref> | |
| 11134 <src:fragref linkend="htmlhelp.hhc.frag"></src:fragref> | |
| 11135 <src:fragref linkend="htmlhelp.hhc.section.depth.frag"></src:fragref>
; | |
| 11136 <src:fragref linkend="htmlhelp.hhc.show.root.frag"></src:fragref> | |
| 11137 <src:fragref linkend="htmlhelp.hhc.width.frag"></src:fragref> | |
| 11138 <src:fragref linkend="htmlhelp.hhk.frag"></src:fragref> | |
| 11139 <src:fragref linkend="htmlhelp.hhp.frag"></src:fragref> | |
| 11140 <src:fragref linkend="htmlhelp.hhp.tail.frag"></src:fragref> | |
| 11141 <src:fragref linkend="htmlhelp.hhp.window.frag"></src:fragref> | |
| 11142 <src:fragref linkend="htmlhelp.hhp.windows.frag"></src:fragref> | |
| 11143 <src:fragref linkend="htmlhelp.map.file.frag"></src:fragref> | |
| 11144 <src:fragref linkend="htmlhelp.only.frag"></src:fragref> | |
| 11145 <src:fragref linkend="htmlhelp.remember.window.position.frag"></src:fra
gref> | |
| 11146 <src:fragref linkend="htmlhelp.show.advanced.search.frag"></src:fragref
> | |
| 11147 <src:fragref linkend="htmlhelp.show.favorities.frag"></src:fragref> | |
| 11148 <src:fragref linkend="htmlhelp.show.menu.frag"></src:fragref> | |
| 11149 <src:fragref linkend="htmlhelp.show.toolbar.text.frag"></src:fragref>
; | |
| 11150 <src:fragref linkend="htmlhelp.title.frag"></src:fragref> | |
| 11151 <src:fragref linkend="htmlhelp.use.hhk.frag"></src:fragref> | |
| 11152 <src:fragref linkend="htmlhelp.window.geometry.frag"></src:fragref> | |
| 11153 <src:fragref linkend="id.warnings.frag"></src:fragref> | |
| 11154 <src:fragref linkend="ignore.image.scaling.frag"></src:fragref> | |
| 11155 <src:fragref linkend="img.src.path.frag"></src:fragref> | |
| 11156 <src:fragref linkend="index.links.to.section.frag"></src:fragref> | |
| 11157 <src:fragref linkend="index.method.frag"></src:fragref> | |
| 11158 <src:fragref linkend="index.number.separator.frag"></src:fragref> | |
| 11159 <src:fragref linkend="index.on.role.frag"></src:fragref> | |
| 11160 <src:fragref linkend="index.on.type.frag"></src:fragref> | |
| 11161 <src:fragref linkend="index.prefer.titleabbrev.frag"></src:fragref> | |
| 11162 <src:fragref linkend="index.range.separator.frag"></src:fragref> | |
| 11163 <src:fragref linkend="index.term.separator.frag"></src:fragref> | |
| 11164 <src:fragref linkend="inherit.keywords.frag"></src:fragref> | |
| 11165 <src:fragref linkend="insert.olink.page.number.frag"></src:fragref> | |
| 11166 <src:fragref linkend="insert.olink.pdf.frag.frag"></src:fragref> | |
| 11167 <src:fragref linkend="insert.xref.page.number.frag"></src:fragref> | |
| 11168 <src:fragref linkend="javahelp.encoding.frag"></src:fragref> | |
| 11169 <src:fragref linkend="keep.relative.image.uris.frag"></src:fragref> | |
| 11170 <src:fragref linkend="l10n.gentext.default.language.frag"></src:fragref
> | |
| 11171 <src:fragref linkend="l10n.gentext.language.frag"></src:fragref> | |
| 11172 <src:fragref linkend="l10n.gentext.use.xref.language.frag"></src:fragre
f> | |
| 11173 <src:fragref linkend="l10n.lang.value.rfc.compliant.frag"></src:fragref
> | |
| 11174 <src:fragref linkend="label.from.part.frag"></src:fragref> | |
| 11175 <src:fragref linkend="linenumbering.everyNth.frag"></src:fragref> | |
| 11176 <src:fragref linkend="linenumbering.extension.frag"></src:fragref> | |
| 11177 <src:fragref linkend="linenumbering.separator.frag"></src:fragref> | |
| 11178 <src:fragref linkend="linenumbering.width.frag"></src:fragref> | |
| 11179 <src:fragref linkend="link.mailto.url.frag"></src:fragref> | |
| 11180 <src:fragref linkend="make.clean.html.frag"></src:fragref> | |
| 11181 <src:fragref linkend="make.graphic.viewport.frag"></src:fragref> | |
| 11182 <src:fragref linkend="make.single.year.ranges.frag"></src:fragref> | |
| 11183 <src:fragref linkend="make.valid.html.frag"></src:fragref> | |
| 11184 <src:fragref linkend="make.year.ranges.frag"></src:fragref> | |
| 11185 <src:fragref linkend="manifest.frag"></src:fragref> | |
| 11186 <src:fragref linkend="manifest.in.base.dir.frag"></src:fragref> | |
| 11187 <src:fragref linkend="manual.toc.frag"></src:fragref> | |
| 11188 <src:fragref linkend="menuchoice.menu.separator.frag"></src:fragref> | |
| 11189 <src:fragref linkend="menuchoice.separator.frag"></src:fragref> | |
| 11190 <src:fragref linkend="navig.graphics.extension.frag"></src:fragref> | |
| 11191 <src:fragref linkend="navig.graphics.frag"></src:fragref> | |
| 11192 <src:fragref linkend="navig.graphics.path.frag"></src:fragref> | |
| 11193 <src:fragref linkend="navig.showtitles.frag"></src:fragref> | |
| 11194 <src:fragref linkend="nominal.image.depth.frag"></src:fragref> | |
| 11195 <src:fragref linkend="nominal.image.width.frag"></src:fragref> | |
| 11196 <src:fragref linkend="nominal.table.width.frag"></src:fragref> | |
| 11197 <src:fragref linkend="olink.base.uri.frag"></src:fragref> | |
| 11198 <src:fragref linkend="olink.debug.frag"></src:fragref> | |
| 11199 <src:fragref linkend="olink.doctitle.frag"></src:fragref> | |
| 11200 <src:fragref linkend="olink.lang.fallback.sequence.frag"></src:fragref&
gt; | |
| 11201 <src:fragref linkend="olink.properties.frag"></src:fragref> | |
| 11202 <src:fragref linkend="othercredit.like.author.enabled.frag"></src:fragr
ef> | |
| 11203 <src:fragref linkend="para.propagates.style.frag"></src:fragref> | |
| 11204 <src:fragref linkend="part.autolabel.frag"></src:fragref> | |
| 11205 <src:fragref linkend="phrase.propagates.style.frag"></src:fragref> | |
| 11206 <src:fragref linkend="pixels.per.inch.frag"></src:fragref> | |
| 11207 <src:fragref linkend="points.per.em.frag"></src:fragref> | |
| 11208 <src:fragref linkend="preface.autolabel.frag"></src:fragref> | |
| 11209 <src:fragref linkend="prefer.internal.olink.frag"></src:fragref> | |
| 11210 <src:fragref linkend="preferred.mediaobject.role.frag"></src:fragref>
; | |
| 11211 <src:fragref linkend="process.empty.source.toc.frag"></src:fragref> | |
| 11212 <src:fragref linkend="process.source.toc.frag"></src:fragref> | |
| 11213 <src:fragref linkend="profile.arch.frag"></src:fragref> | |
| 11214 <src:fragref linkend="profile.attribute.frag"></src:fragref> | |
| 11215 <src:fragref linkend="profile.audience.frag"></src:fragref> | |
| 11216 <src:fragref linkend="profile.condition.frag"></src:fragref> | |
| 11217 <src:fragref linkend="profile.conformance.frag"></src:fragref> | |
| 11218 <src:fragref linkend="profile.lang.frag"></src:fragref> | |
| 11219 <src:fragref linkend="profile.os.frag"></src:fragref> | |
| 11220 <src:fragref linkend="profile.revision.frag"></src:fragref> | |
| 11221 <src:fragref linkend="profile.revisionflag.frag"></src:fragref> | |
| 11222 <src:fragref linkend="profile.role.frag"></src:fragref> | |
| 11223 <src:fragref linkend="profile.security.frag"></src:fragref> | |
| 11224 <src:fragref linkend="profile.separator.frag"></src:fragref> | |
| 11225 <src:fragref linkend="profile.status.frag"></src:fragref> | |
| 11226 <src:fragref linkend="profile.userlevel.frag"></src:fragref> | |
| 11227 <src:fragref linkend="profile.value.frag"></src:fragref> | |
| 11228 <src:fragref linkend="profile.vendor.frag"></src:fragref> | |
| 11229 <src:fragref linkend="profile.wordsize.frag"></src:fragref> | |
| 11230 <src:fragref linkend="punct.honorific.frag"></src:fragref> | |
| 11231 <src:fragref linkend="qanda.defaultlabel.frag"></src:fragref> | |
| 11232 <src:fragref linkend="qanda.in.toc.frag"></src:fragref> | |
| 11233 <src:fragref linkend="qanda.inherit.numeration.frag"></src:fragref> | |
| 11234 <src:fragref linkend="qanda.nested.in.toc.frag"></src:fragref> | |
| 11235 <src:fragref linkend="qandadiv.autolabel.frag"></src:fragref> | |
| 11236 <src:fragref linkend="refclass.suppress.frag"></src:fragref> | |
| 11237 <src:fragref linkend="refentry.generate.name.frag"></src:fragref> | |
| 11238 <src:fragref linkend="refentry.generate.title.frag"></src:fragref> | |
| 11239 <src:fragref linkend="refentry.separator.frag"></src:fragref> | |
| 11240 <src:fragref linkend="refentry.xref.manvolnum.frag"></src:fragref> | |
| 11241 <src:fragref linkend="reference.autolabel.frag"></src:fragref> | |
| 11242 <src:fragref linkend="root.filename.frag"></src:fragref> | |
| 11243 <src:fragref linkend="rootid.frag"></src:fragref> | |
| 11244 <src:fragref linkend="runinhead.default.title.end.punct.frag"></src:fra
gref> | |
| 11245 <src:fragref linkend="runinhead.title.end.punct.frag"></src:fragref> | |
| 11246 <src:fragref linkend="section.autolabel.frag"></src:fragref> | |
| 11247 <src:fragref linkend="section.autolabel.max.depth.frag"></src:fragref&g
t; | |
| 11248 <src:fragref linkend="section.label.includes.component.label.frag"></sr
c:fragref> | |
| 11249 <src:fragref linkend="segmentedlist.as.table.frag"></src:fragref> | |
| 11250 <src:fragref linkend="shade.verbatim.frag"></src:fragref> | |
| 11251 <src:fragref linkend="shade.verbatim.style.frag"></src:fragref> | |
| 11252 <src:fragref linkend="show.comments.frag"></src:fragref> | |
| 11253 <src:fragref linkend="show.revisionflag.frag"></src:fragref> | |
| 11254 <src:fragref linkend="simplesect.in.toc.frag"></src:fragref> | |
| 11255 <src:fragref linkend="spacing.paras.frag"></src:fragref> | |
| 11256 <src:fragref linkend="suppress.footer.navigation.frag"></src:fragref>
; | |
| 11257 <src:fragref linkend="suppress.header.navigation.frag"></src:fragref>
; | |
| 11258 <src:fragref linkend="suppress.navigation.frag"></src:fragref> | |
| 11259 <src:fragref linkend="table.borders.with.css.frag"></src:fragref> | |
| 11260 <src:fragref linkend="table.cell.border.color.frag"></src:fragref> | |
| 11261 <src:fragref linkend="table.cell.border.style.frag"></src:fragref> | |
| 11262 <src:fragref linkend="table.cell.border.thickness.frag"></src:fragref&g
t; | |
| 11263 <src:fragref linkend="table.footnote.number.format.frag"></src:fragref&
gt; | |
| 11264 <src:fragref linkend="table.footnote.number.symbols.frag"></src:fragref
> | |
| 11265 <src:fragref linkend="table.frame.border.color.frag"></src:fragref> | |
| 11266 <src:fragref linkend="table.frame.border.style.frag"></src:fragref> | |
| 11267 <src:fragref linkend="table.frame.border.thickness.frag"></src:fragref&
gt; | |
| 11268 <src:fragref linkend="tablecolumns.extension.frag"></src:fragref> | |
| 11269 <src:fragref linkend="target.database.document.frag"></src:fragref> | |
| 11270 <src:fragref linkend="targets.filename.frag"></src:fragref> | |
| 11271 <src:fragref linkend="tex.math.delims.frag"></src:fragref> | |
| 11272 <src:fragref linkend="tex.math.file.frag"></src:fragref> | |
| 11273 <src:fragref linkend="tex.math.in.alt.frag"></src:fragref> | |
| 11274 <src:fragref linkend="textdata.default.encoding.frag"></src:fragref> | |
| 11275 <src:fragref linkend="textinsert.extension.frag"></src:fragref> | |
| 11276 <src:fragref linkend="toc.list.type.frag"></src:fragref> | |
| 11277 <src:fragref linkend="toc.max.depth.frag"></src:fragref> | |
| 11278 <src:fragref linkend="toc.section.depth.frag"></src:fragref> | |
| 11279 <src:fragref linkend="ulink.target.frag"></src:fragref> | |
| 11280 <src:fragref linkend="use.embed.for.svg.frag"></src:fragref> | |
| 11281 <src:fragref linkend="use.extensions.frag"></src:fragref> | |
| 11282 <src:fragref linkend="use.id.as.filename.frag"></src:fragref> | |
| 11283 <src:fragref linkend="use.local.olink.style.frag"></src:fragref> | |
| 11284 <src:fragref linkend="use.role.as.xrefstyle.frag"></src:fragref> | |
| 11285 <src:fragref linkend="use.role.for.mediaobject.frag"></src:fragref> | |
| 11286 <src:fragref linkend="use.svg.frag"></src:fragref> | |
| 11287 <src:fragref linkend="variablelist.as.table.frag"></src:fragref> | |
| 11288 <src:fragref linkend="variablelist.term.break.after.frag"></src:fragref
> | |
| 11289 <src:fragref linkend="variablelist.term.separator.frag"></src:fragref&g
t; | |
| 11290 <src:fragref linkend="webhelp.autolabel.frag"></src:fragref> | |
| 11291 <src:fragref linkend="webhelp.base.dir.frag"></src:fragref> | |
| 11292 <src:fragref linkend="webhelp.common.dir.frag"></src:fragref> | |
| 11293 <src:fragref linkend="webhelp.default.topic.frag"></src:fragref> | |
| 11294 <src:fragref linkend="webhelp.include.search.tab.frag"></src:fragref>
; | |
| 11295 <src:fragref linkend="webhelp.indexer.language.frag"></src:fragref> | |
| 11296 <src:fragref linkend="webhelp.start.filename.frag"></src:fragref> | |
| 11297 <src:fragref linkend="webhelp.tree.cookie.id.frag"></src:fragref> | |
| 11298 <src:fragref linkend="writing.mode.frag"></src:fragref> | |
| 11299 <src:fragref linkend="xref.label-page.separator.frag"></src:fragref> | |
| 11300 <src:fragref linkend="xref.label-title.separator.frag"></src:fragref>
; | |
| 11301 <src:fragref linkend="xref.title-page.separator.frag"></src:fragref> | |
| 11302 <src:fragref linkend="xref.with.number.and.title.frag"></src:fragref>
; | |
| 11303 | |
| 11304 </xsl:stylesheet> | |
| 11305 </programlisting> | |
| 11306 | |
| 11307 </appendix> | |
| 11308 </book> | |
| OLD | NEW |
|---|
Chromium Code Reviews
Issue 1394993002:
Doing some cleanup. (Closed)
Base URL: https://github.com/dart-lang/www.dartlang.org.git@master