1
0

pi.xml 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002
  1. <?xml version="1.0"?>
  2. <reference><info><title>FO Processing Instruction Reference</title>
  3. <releaseinfo role="meta">
  4. $Id: pi.xsl 9267 2012-04-03 20:23:45Z bobstayton $
  5. </releaseinfo>
  6. </info>
  7. <partintro xml:id="partintro">
  8. <title>Introduction</title>
  9. <para>This is generated reference documentation for all
  10. user-specifiable processing instructions (PIs) in the DocBook
  11. XSL stylesheets for FO output.
  12. <note>
  13. <para>You add these PIs at particular points in a document to
  14. cause specific “exceptions” to formatting/output behavior. To
  15. make global changes in formatting/output behavior across an
  16. entire document, it’s better to do it by setting an
  17. appropriate stylesheet parameter (if there is one).</para>
  18. </note>
  19. </para>
  20. </partintro>
  21. <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_background-color">
  22. <refnamediv>
  23. <refname>dbfo_background-color</refname>
  24. <refpurpose>Sets background color for an image</refpurpose>
  25. </refnamediv>
  26. <refsynopsisdiv>
  27. <synopsis><tag class="xmlpi">dbfo background-color="<replaceable>color</replaceable>"</tag></synopsis>
  28. </refsynopsisdiv>
  29. <refsect1><title>Description</title>
  30. <para>Use the <tag class="xmlpi">dbfo background-color</tag> PI before or
  31. after an image (<tag>graphic</tag>, <tag>inlinegraphic</tag>,
  32. <tag>imagedata</tag>, or <tag>videodata</tag> element) as a
  33. sibling to the element, to set a background color for the
  34. image.</para>
  35. </refsect1><refsect1><title>Parameters</title>
  36. <variablelist>
  37. <varlistentry><term>background-color="<replaceable>color</replaceable>"</term>
  38. <listitem>
  39. <para>An HTML color value</para>
  40. </listitem>
  41. </varlistentry>
  42. </variablelist>
  43. </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
  44. <para><link role="tcg" xlink:href="BGcolor.html">Background color</link></para>
  45. </refsect1></refentry>
  46. <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_bgcolor">
  47. <refnamediv>
  48. <refname>dbfo_bgcolor</refname>
  49. <refpurpose>Sets background color on a table row or table cell</refpurpose>
  50. </refnamediv>
  51. <refsynopsisdiv>
  52. <synopsis><tag class="xmlpi">dbfo bgcolor="<replaceable>color</replaceable>"</tag></synopsis>
  53. </refsynopsisdiv>
  54. <refsect1><title>Description</title>
  55. <para>Use the <tag class="xmlpi">dbfo bgcolor</tag> PI as child of a table row
  56. or cell to set a background color for that table row or cell.</para>
  57. <para>This PI works for both CALS and HTML tables.</para>
  58. </refsect1><refsect1><title>Parameters</title>
  59. <variablelist>
  60. <varlistentry><term>bgcolor="<replaceable>color</replaceable>"</term>
  61. <listitem>
  62. <para>An HTML color value</para>
  63. </listitem>
  64. </varlistentry>
  65. </variablelist>
  66. </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
  67. <para><link role="tcg" xlink:href="BGtableColor.html#CellBGColor">Cell background color</link></para>
  68. </refsect1></refentry>
  69. <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_float-type">
  70. <refnamediv>
  71. <refname>dbfo_float-type</refname>
  72. <refpurpose>Specifies float behavior for a sidebar</refpurpose>
  73. </refnamediv>
  74. <refsynopsisdiv>
  75. <synopsis><tag class="xmlpi">dbfo float-type="margin.note"</tag></synopsis>
  76. </refsynopsisdiv>
  77. <refsect1><title>Description</title>
  78. <para>Use the <tag class="xmlpi">dbfo float-type</tag> PI to specify the float
  79. behavior for a <tag>sidebar</tag> (to cause the sidebar to be
  80. displayed as a marginal note).</para>
  81. </refsect1><refsect1><title>Parameters</title>
  82. <variablelist>
  83. <varlistentry><term>float-type="margin.note"</term>
  84. <listitem>
  85. <para>Specifies that the <tag>sidebar</tag> should be
  86. displayed as a marginal note.</para>
  87. </listitem>
  88. </varlistentry>
  89. </variablelist>
  90. </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
  91. <para><parameter>sidebar.float.type</parameter> (parameter),
  92. <parameter>sidebar.float.width</parameter> (parameter),
  93. <parameter>sidebar.properties</parameter> (attribute-set),
  94. <parameter>sidebar.title.properties</parameter> (attribute-set)
  95. </para>
  96. </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
  97. <para><link role="tcg" xlink:href="SideFloats.html#SidebarFloats">A sidebar as
  98. side float</link></para>
  99. </refsect1></refentry>
  100. <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_funcsynopsis-style">
  101. <refnamediv>
  102. <refname>dbfo_funcsynopsis-style</refname>
  103. <refpurpose>Specifies presentation style for a funcsynopsis</refpurpose>
  104. </refnamediv>
  105. <refsynopsisdiv>
  106. <synopsis><tag class="xmlpi">dbfo funcsynopsis-style="kr"|"ansi"</tag></synopsis>
  107. </refsynopsisdiv>
  108. <refsect1><title>Description</title>
  109. <para>Use the <tag class="xmlpi">dbfo funcsynopsis-style</tag> PI as a child of
  110. a <tag>funcsynopsis</tag> or anywhere within a funcsynopsis
  111. to control the presentation style for output of all
  112. <tag>funcprototype</tag> instances within that funcsynopsis.</para>
  113. </refsect1><refsect1><title>Parameters</title>
  114. <variablelist>
  115. <varlistentry><term>funcsynopsis-style="kr"</term>
  116. <listitem>
  117. <para>Displays <tag>funcprototype</tag> output in K&amp;R style</para>
  118. </listitem>
  119. </varlistentry>
  120. <varlistentry><term>funcsynopsis-style="ansi"</term>
  121. <listitem>
  122. <para>Displays <tag>funcprototype</tag> output in ANSI style</para>
  123. </listitem>
  124. </varlistentry>
  125. </variablelist>
  126. </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
  127. <para><parameter>funcsynopsis.style</parameter></para>
  128. </refsect1></refentry>
  129. <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_glossary-presentation">
  130. <refnamediv>
  131. <refname>dbfo_glossary-presentation</refname>
  132. <refpurpose>Specifies presentation style for a glossary</refpurpose>
  133. </refnamediv>
  134. <refsynopsisdiv>
  135. <synopsis><tag class="xmlpi">dbfo glossary-presentation="list"|"blocks"</tag></synopsis>
  136. </refsynopsisdiv>
  137. <refsect1><title>Description</title>
  138. <para>Use the <tag class="xmlpi">dbfo glossary-presentation</tag> PI as a child of
  139. a <tag>glossary</tag> to control its presentation style.</para>
  140. </refsect1><refsect1><title>Parameters</title>
  141. <variablelist>
  142. <varlistentry><term>glossary-presentation="list"</term>
  143. <listitem>
  144. <para>Displays the glossary as a list</para>
  145. </listitem>
  146. </varlistentry>
  147. <varlistentry><term>glossary-presentation="blocks"</term>
  148. <listitem>
  149. <para>Displays the glossary as blocks</para>
  150. </listitem>
  151. </varlistentry>
  152. </variablelist>
  153. </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
  154. <para><parameter>glossary.as.blocks</parameter></para>
  155. </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
  156. <para><link role="tcg" xlink:href="Glossaries.html#GlossaryFormatPrint">Glossary
  157. formatting in print</link></para>
  158. </refsect1></refentry>
  159. <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_glosslist-presentation">
  160. <refnamediv>
  161. <refname>dbfo_glosslist-presentation</refname>
  162. <refpurpose>Specifies presentation style for a glosslist</refpurpose>
  163. </refnamediv>
  164. <refsynopsisdiv>
  165. <synopsis><tag class="xmlpi">dbfo glosslist-presentation="list"|"blocks"</tag></synopsis>
  166. </refsynopsisdiv>
  167. <refsect1><title>Description</title>
  168. <para>Use the <tag class="xmlpi">dbfo glosslist-presentation</tag> PI as a child of
  169. a <tag>glosslist</tag> to control its presentation style.</para>
  170. </refsect1><refsect1><title>Parameters</title>
  171. <variablelist>
  172. <varlistentry><term>glosslist-presentation="list"</term>
  173. <listitem>
  174. <para>Displays the glosslist as a list</para>
  175. </listitem>
  176. </varlistentry>
  177. <varlistentry><term>glosslist-presentation="blocks"</term>
  178. <listitem>
  179. <para>Displays the glosslist as blocks</para>
  180. </listitem>
  181. </varlistentry>
  182. </variablelist>
  183. </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
  184. <para><parameter>glosslist.as.blocks</parameter> </para>
  185. </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
  186. <para><link role="tcg" xlink:href="Glossaries.html#GlossaryFormatPrint">Glossary
  187. formatting in print</link></para>
  188. </refsect1></refentry>
  189. <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_glossterm-width">
  190. <refnamediv>
  191. <refname>dbfo_glossterm-width</refname>
  192. <refpurpose>Specifies the glossterm width for a glossary or
  193. glosslist</refpurpose>
  194. </refnamediv>
  195. <refsynopsisdiv>
  196. <synopsis><tag class="xmlpi">dbfo glossterm-width="<replaceable>width</replaceable>"</tag></synopsis>
  197. </refsynopsisdiv>
  198. <refsect1><title>Description</title>
  199. <para>Use the <tag class="xmlpi">dbfo glossterm-width</tag> PI as a child of a
  200. <tag>glossary</tag> or <tag>glosslist</tag> to specify the
  201. width for output of <tag>glossterm</tag> instances in the
  202. output.</para>
  203. </refsect1><refsect1><title>Parameters</title>
  204. <variablelist>
  205. <varlistentry><term>glossterm-width="<replaceable>width</replaceable>"</term>
  206. <listitem>
  207. <para>Specifies the glossterm width (including units)</para>
  208. </listitem>
  209. </varlistentry>
  210. </variablelist>
  211. </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
  212. <para><parameter>glossterm.width</parameter>,
  213. <parameter>glossterm.separation</parameter>
  214. </para>
  215. </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
  216. <para><link role="tcg" xlink:href="Glossaries.html#GlossaryFormatPrint">Glossary
  217. formatting in print</link></para>
  218. </refsect1></refentry>
  219. <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_keep-together">
  220. <refnamediv>
  221. <refname>dbfo_keep-together</refname>
  222. <refpurpose>Specifies “keep” behavior for a table, example,
  223. figure, equation, procedure, or task</refpurpose>
  224. </refnamediv>
  225. <refsynopsisdiv>
  226. <synopsis><tag class="xmlpi">dbfo keep-together="auto"|"always"</tag></synopsis>
  227. </refsynopsisdiv>
  228. <refsect1><title>Description</title>
  229. <para>Use the <tag class="xmlpi">dbfo keep-together</tag> PI as a child of a
  230. formal object (<tag>table</tag>, <tag>example</tag>,
  231. <tag>figure</tag>, <tag>equation</tag>, <tag>procedure</tag>, or
  232. <tag>task</tag>) to specify “keep” behavior (to allow the object to
  233. “break” across a page).</para>
  234. <para>The PI also works with <tag>informaltable</tag>, <tag>informalexample</tag>,
  235. <tag>informalfigure</tag> and <tag>informalequation</tag>.
  236. </para>
  237. </refsect1><refsect1><title>Parameters</title>
  238. <variablelist>
  239. <varlistentry><term>keep-together="auto"</term>
  240. <listitem>
  241. <para>Enables the object to break across a page</para>
  242. </listitem>
  243. </varlistentry>
  244. <varlistentry><term>keep-together="always"</term>
  245. <listitem>
  246. <para>Prevents the object from breaking across a page (the
  247. default stylesheet behavior)</para>
  248. </listitem>
  249. </varlistentry>
  250. </variablelist>
  251. </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
  252. <para>formal.object.properties</para>
  253. </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
  254. <para><link role="tcg" xlink:href="PageBreaking.html#KeepTogetherPI">Keep-together processing instruction</link></para>
  255. </refsect1></refentry>
  256. <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_label-width">
  257. <refnamediv>
  258. <refname>dbfo_label-width</refname>
  259. <refpurpose>Specifies the label width for a qandaset, itemizedlist, orderedlist
  260. or calloutlist</refpurpose>
  261. </refnamediv>
  262. <refsynopsisdiv>
  263. <synopsis><tag class="xmlpi">dbfo label-width="<replaceable>width</replaceable>"</tag></synopsis>
  264. </refsynopsisdiv>
  265. <refsect1><title>Description</title>
  266. <para>Use the <tag class="xmlpi">dbfo label-width</tag> PI as a child of a
  267. <tag>qandaset</tag>, <tag>itemizedlist</tag>, <tag>orderedlist</tag>,
  268. or <tag>calloutlist</tag> to specify the width of labels.</para>
  269. </refsect1><refsect1><title>Parameters</title>
  270. <variablelist>
  271. <varlistentry><term>label-width="<replaceable>width</replaceable>"</term>
  272. <listitem>
  273. <para>Specifies the label width (including units)</para>
  274. </listitem>
  275. </varlistentry>
  276. </variablelist>
  277. </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
  278. <para><link role="tcg" xlink:href="QandAformat.html">Q and A formatting</link></para>
  279. </refsect1></refentry>
  280. <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_linenumbering.everyNth">
  281. <refnamediv>
  282. <refname>dbfo_linenumbering.everyNth</refname>
  283. <refpurpose>Specifies interval for line numbers in verbatims</refpurpose>
  284. </refnamediv>
  285. <refsynopsisdiv>
  286. <synopsis><tag class="xmlpi">dbfo linenumbering.everyNth="<replaceable>N</replaceable>"</tag></synopsis>
  287. </refsynopsisdiv>
  288. <refsect1><title>Description</title>
  289. <para>Use the <tag class="xmlpi">dbfo linenumbering.everyNth</tag> PI as a child
  290. of a “verbatim” element – <tag>programlisting</tag>,
  291. <tag>screen</tag>, <tag>synopsis</tag> — to specify
  292. the interval at which lines are numbered.</para>
  293. </refsect1><refsect1><title>Parameters</title>
  294. <variablelist>
  295. <varlistentry><term>linenumbering.everyNth="<replaceable>N</replaceable>"</term>
  296. <listitem>
  297. <para>Specifies numbering interval; a number is output
  298. before every <replaceable>N</replaceable>th line</para>
  299. </listitem>
  300. </varlistentry>
  301. </variablelist>
  302. </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
  303. <para><parameter>linenumbering.everyNth</parameter></para>
  304. </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
  305. <para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>
  306. </refsect1></refentry>
  307. <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_linenumbering.separator">
  308. <refnamediv>
  309. <refname>dbfo_linenumbering.separator</refname>
  310. <refpurpose>Specifies separator text for line numbers in verbatims</refpurpose>
  311. </refnamediv>
  312. <refsynopsisdiv>
  313. <synopsis><tag class="xmlpi">dbfo linenumbering.separator="<replaceable>text</replaceable>"</tag></synopsis>
  314. </refsynopsisdiv>
  315. <refsect1><title>Description</title>
  316. <para>Use the <tag class="xmlpi">dbfo linenumbering.separator</tag> PI as a child
  317. of a “verbatim” element – <tag>programlisting</tag>,
  318. <tag>screen</tag>, <tag>synopsis</tag> — to specify
  319. the separator text output between the line numbers and content.</para>
  320. </refsect1><refsect1><title>Parameters</title>
  321. <variablelist>
  322. <varlistentry><term>linenumbering.separator="<replaceable>text</replaceable>"</term>
  323. <listitem>
  324. <para>Specifies the text (zero or more characters)</para>
  325. </listitem>
  326. </varlistentry>
  327. </variablelist>
  328. </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
  329. <para><parameter>linenumbering.separator</parameter></para>
  330. </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
  331. <para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>
  332. </refsect1></refentry>
  333. <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_linenumbering.width">
  334. <refnamediv>
  335. <refname>dbfo_linenumbering.width</refname>
  336. <refpurpose>Specifies width for line numbers in verbatims</refpurpose>
  337. </refnamediv>
  338. <refsynopsisdiv>
  339. <synopsis><tag class="xmlpi">dbfo linenumbering.width="<replaceable>width</replaceable>"</tag></synopsis>
  340. </refsynopsisdiv>
  341. <refsect1><title>Description</title>
  342. <para>Use the <tag class="xmlpi">dbfo linenumbering.width</tag> PI as a child
  343. of a “verbatim” element – <tag>programlisting</tag>,
  344. <tag>screen</tag>, <tag>synopsis</tag> — to specify
  345. the width set aside for line numbers.</para>
  346. </refsect1><refsect1><title>Parameters</title>
  347. <variablelist>
  348. <varlistentry><term>linenumbering.width="<replaceable>width</replaceable>"</term>
  349. <listitem>
  350. <para>Specifies the width (inluding units)</para>
  351. </listitem>
  352. </varlistentry>
  353. </variablelist>
  354. </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
  355. <para><parameter>linenumbering.width</parameter></para>
  356. </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
  357. <para><link role="tcg" xlink:href="AnnotateListing.html#LineNumbering">Line numbering</link></para>
  358. </refsect1></refentry>
  359. <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_list-presentation">
  360. <refnamediv>
  361. <refname>dbfo_list-presentation</refname>
  362. <refpurpose>Specifies presentation style for a variablelist or
  363. segmentedlist</refpurpose>
  364. </refnamediv>
  365. <refsynopsisdiv>
  366. <synopsis><tag class="xmlpi">dbfo list-presentation="list"|"blocks"|"table"</tag></synopsis>
  367. </refsynopsisdiv>
  368. <refsect1><title>Description</title>
  369. <para>Use the <tag class="xmlpi">dbfo list-presentation</tag> PI as a child of
  370. a <tag>variablelist</tag> or <tag>segmentedlist</tag> to
  371. control the presentation style for the list (to cause it, for
  372. example, to be displayed as a table).</para>
  373. </refsect1><refsect1><title>Parameters</title>
  374. <variablelist>
  375. <varlistentry><term>list-presentation="list"</term>
  376. <listitem>
  377. <para>Displays the list as a list</para>
  378. </listitem>
  379. </varlistentry>
  380. <varlistentry><term>list-presentation="blocks"</term>
  381. <listitem>
  382. <para>(<tag>variablelist</tag> only) Displays the list as blocks</para>
  383. </listitem>
  384. </varlistentry>
  385. <varlistentry><term>list-presentation="table"</term>
  386. <listitem>
  387. <para>(<tag>segmentedlist</tag> only) Displays the list as a table</para>
  388. </listitem>
  389. </varlistentry>
  390. </variablelist>
  391. </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
  392. <itemizedlist>
  393. <listitem>
  394. <para><parameter>variablelist.as.blocks</parameter></para>
  395. </listitem>
  396. <listitem>
  397. <para><parameter>variablelist.as.table</parameter></para>
  398. </listitem>
  399. </itemizedlist>
  400. </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
  401. <para><link role="tcg" xlink:href="Variablelists.html#ListIndents">Variable list formatting in print</link></para>
  402. </refsect1></refentry>
  403. <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_list-width">
  404. <refnamediv>
  405. <refname>dbfo_list-width</refname>
  406. <refpurpose>Specifies the width of a horizontal simplelist</refpurpose>
  407. </refnamediv>
  408. <refsynopsisdiv>
  409. <synopsis><tag class="xmlpi">dbfo list-width="<replaceable>width</replaceable>"</tag></synopsis>
  410. </refsynopsisdiv>
  411. <refsect1><title>Description</title>
  412. <para>Use the <tag class="xmlpi">dbfo list-width</tag> PI as a child of a
  413. <tag>simplelist</tag> whose <tag class="attribute">class</tag>
  414. value is <literal>horizontal</literal>, to specify the width
  415. of the <tag>simplelist</tag>.</para>
  416. </refsect1><refsect1><title>Parameters</title>
  417. <variablelist>
  418. <varlistentry><term>list-width="<replaceable>width</replaceable>"</term>
  419. <listitem>
  420. <para>Specifies the <tag>simplelist</tag> width (including units)</para>
  421. </listitem>
  422. </varlistentry>
  423. </variablelist>
  424. </refsect1></refentry>
  425. <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_orientation">
  426. <refnamediv>
  427. <refname>dbfo_orientation</refname>
  428. <refpurpose>Specifies the orientation for a CALS table row or cell</refpurpose>
  429. </refnamediv>
  430. <refsynopsisdiv>
  431. <synopsis><tag class="xmlpi">dbfo orientation="0"|"90"|"180"|"270"|"-90"|"-180"|"-270"</tag></synopsis>
  432. </refsynopsisdiv>
  433. <refsect1><title>Description</title>
  434. <para>Use the <tag class="xmlpi">dbfo orientation</tag> PI as a child of a CALS
  435. <tag>table</tag> row or cell to specify the orientation
  436. (rotation) for the row or cell.</para>
  437. </refsect1><refsect1><title>Parameters</title>
  438. <variablelist>
  439. <varlistentry><term>orientation="0"|"90"|"180"|"270"|"-90"|"-180"|"-270"</term>
  440. <listitem>
  441. <para>Specifies the number of degrees by which the cell or
  442. row is rotated</para>
  443. </listitem>
  444. </varlistentry>
  445. </variablelist>
  446. </refsect1></refentry>
  447. <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_pgwide">
  448. <refnamediv>
  449. <refname>dbfo_pgwide</refname>
  450. <refpurpose>Specifies if an <tag>equation</tag> or <tag>example</tag> goes across full page width</refpurpose>
  451. </refnamediv>
  452. <refsynopsisdiv>
  453. <synopsis><tag class="xmlpi">dbfo pgwide="0"|"1"</tag></synopsis>
  454. </refsynopsisdiv>
  455. <refsect1><title>Description</title>
  456. <para>Use the <tag class="xmlpi">dbfo pgwide</tag> PI as a child of an
  457. <tag>equation</tag> or <tag>example</tag> to specify that the
  458. content should rendered across the full width of the page.</para>
  459. </refsect1><refsect1><title>Parameters</title>
  460. <variablelist>
  461. <varlistentry><term>pgwide="0"</term>
  462. <listitem>
  463. <para>If zero, the content is rendered across the current
  464. text flow</para>
  465. </listitem>
  466. </varlistentry>
  467. <varlistentry><term>pgwide="1"</term>
  468. <listitem>
  469. <para>If <code>1</code> (or any non-zero value), the
  470. content is rendered across the full width of the page</para>
  471. </listitem>
  472. </varlistentry>
  473. </variablelist>
  474. </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
  475. <para><parameter>pgwide.properties</parameter></para>
  476. </refsect1></refentry>
  477. <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_rotated-width">
  478. <refnamediv>
  479. <refname>dbfo_rotated-width</refname>
  480. <refpurpose>Specifies the width for a CALS table <tag>entry</tag> or
  481. <tag>row</tag></refpurpose>
  482. </refnamediv>
  483. <refsynopsisdiv>
  484. <synopsis><tag class="xmlpi">dbfo rotated-width="<replaceable>width</replaceable>"</tag></synopsis>
  485. </refsynopsisdiv>
  486. <refsect1><title>Description</title>
  487. <para>Use the <tag class="xmlpi">dbfo rotated-width</tag> PI as a child of
  488. <tag>entry</tag> or <tag>row</tag> instance in a CALS table to specify the
  489. width of that the <tag>entry</tag> or <tag>row</tag>; or
  490. use it higher up in table to cause the width to be inherited
  491. recursively down.</para>
  492. </refsect1><refsect1><title>Parameters</title>
  493. <variablelist>
  494. <varlistentry><term>rotated-width="<replaceable>width</replaceable>"</term>
  495. <listitem>
  496. <para>Specifies the width of a row or cell (including units)</para>
  497. </listitem>
  498. </varlistentry>
  499. </variablelist>
  500. </refsect1></refentry>
  501. <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_sidebar-width">
  502. <refnamediv>
  503. <refname>dbfo_sidebar-width</refname>
  504. <refpurpose>Specifies the width of a sidebar</refpurpose>
  505. </refnamediv>
  506. <refsynopsisdiv>
  507. <synopsis><tag class="xmlpi">dbfo sidebar-width="<replaceable>width</replaceable>"</tag></synopsis>
  508. </refsynopsisdiv>
  509. <refsect1><title>Description</title>
  510. <para>Use the <tag class="xmlpi">dbfo sidebar-width</tag> PI as a child of a
  511. <tag>sidebar</tag> to specify the width of the sidebar.</para>
  512. </refsect1><refsect1><title>Parameters</title>
  513. <variablelist>
  514. <varlistentry><term>sidebar-width="<replaceable>width</replaceable>"</term>
  515. <listitem>
  516. <para>Specifies the <tag>sidebar</tag> width (including units)</para>
  517. </listitem>
  518. </varlistentry>
  519. </variablelist>
  520. </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
  521. <para><parameter>sidebar.float.type parameter</parameter>,
  522. <parameter>sidebar.float.width parameter</parameter>,
  523. <parameter>sidebar.properties attribute-set</parameter>,
  524. <parameter>sidebar.title.properties</parameter>
  525. </para>
  526. </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
  527. <para><link role="tcg" xlink:href="SideFloats.html#SidebarFloats">A sidebar as
  528. side float</link></para>
  529. </refsect1></refentry>
  530. <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_start">
  531. <refnamediv>
  532. <refname>dbfo_start</refname>
  533. <refpurpose>(obsolete) Sets the starting number on an ordered list</refpurpose>
  534. </refnamediv>
  535. <refsynopsisdiv>
  536. <synopsis><tag class="xmlpi">dbfo start="<replaceable>character</replaceable>"</tag></synopsis>
  537. </refsynopsisdiv>
  538. <refsect1><title>Description</title>
  539. <para><emphasis>This PI is obsolete</emphasis>. The intent of
  540. it was to provide a means for setting a specific starting
  541. number for an ordered list. Instead of this PI, set a value
  542. for the <literal>override</literal> attribute on the first
  543. <tag>listitem</tag> in the list; that will have the same
  544. effect as what this PI was intended for.</para>
  545. </refsect1><refsect1><title>Parameters</title>
  546. <variablelist>
  547. <varlistentry><term>start="<replaceable>character</replaceable>"</term>
  548. <listitem>
  549. <para>Specifies the character to use as the starting
  550. number; use 0-9, a-z, A-Z, or lowercase or uppercase
  551. Roman numerals</para>
  552. </listitem>
  553. </varlistentry>
  554. </variablelist>
  555. </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
  556. <para><link role="tcg" xlink:href="Orderedlists.html#ListStartNum">List starting number</link></para>
  557. </refsect1></refentry>
  558. <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_table-width">
  559. <refnamediv>
  560. <refname>dbfo_table-width</refname>
  561. <refpurpose>Specifies the width for a CALS table or for revhistory
  562. output</refpurpose>
  563. </refnamediv>
  564. <refsynopsisdiv>
  565. <synopsis><tag class="xmlpi">dbfo table-width="<replaceable>width</replaceable>"</tag></synopsis>
  566. </refsynopsisdiv>
  567. <refsect1><title>Description</title>
  568. <para>Use the <tag class="xmlpi">dbfo table-width</tag> PI as a child or
  569. sibling of a CALS <tag>table</tag>, or as a child of an
  570. <tag>informaltable</tag>, <tag>entrytbl</tag>, or
  571. <tag>revhistory</tag> instance (which is rendered as a table
  572. in output) to specify the width of the table in output.</para>
  573. </refsect1><refsect1><title>Parameters</title>
  574. <variablelist>
  575. <varlistentry><term>table-width="<replaceable>width</replaceable>"</term>
  576. <listitem>
  577. <para>Specifies the table width (including units or as a percentage)</para>
  578. </listitem>
  579. </varlistentry>
  580. </variablelist>
  581. </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
  582. <para><link role="tcg" xlink:href="Tables.html#TableWidth">Table width</link></para>
  583. </refsect1></refentry>
  584. <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_term-width">
  585. <refnamediv>
  586. <refname>dbfo_term-width</refname>
  587. <refpurpose>Specifies the term width for a variablelist</refpurpose>
  588. </refnamediv>
  589. <refsynopsisdiv>
  590. <synopsis><tag class="xmlpi">dbfo term-width="<replaceable>width</replaceable>"</tag></synopsis>
  591. </refsynopsisdiv>
  592. <refsect1><title>Description</title>
  593. <para>Use the <tag class="xmlpi">dbfo term-width</tag> PI as a child of a
  594. <tag>variablelist</tag> to specify the width for
  595. <tag>term</tag> output.</para>
  596. </refsect1><refsect1><title>Parameters</title>
  597. <variablelist>
  598. <varlistentry><term>term-width="<replaceable>width</replaceable>"</term>
  599. <listitem>
  600. <para>Specifies the term width (including units)</para>
  601. </listitem>
  602. </varlistentry>
  603. </variablelist>
  604. </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
  605. <para><link role="tcg" xlink:href="Variablelists.html#ListIndents">Variable list formatting in print</link></para>
  606. </refsect1></refentry>
  607. <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_toc">
  608. <refnamediv>
  609. <refname>dbfo_toc</refname>
  610. <refpurpose>Specifies whether a TOC should be generated for a qandaset</refpurpose>
  611. </refnamediv>
  612. <refsynopsisdiv>
  613. <synopsis><tag class="xmlpi">dbfo toc="0"|"1"</tag></synopsis>
  614. </refsynopsisdiv>
  615. <refsect1><title>Description</title>
  616. <para>Use the <tag class="xmlpi">dbfo toc</tag> PI as a child of a
  617. <tag>qandaset</tag> to specify whether a table of contents
  618. (TOC) is generated for the <tag>qandaset</tag>.</para>
  619. </refsect1><refsect1><title>Parameters</title>
  620. <variablelist>
  621. <varlistentry><term>toc="0"</term>
  622. <listitem>
  623. <para>If zero, no TOC is generated</para>
  624. </listitem>
  625. </varlistentry>
  626. <varlistentry><term>toc="1"</term>
  627. <listitem>
  628. <para>If <code>1</code> (or any non-zero value),
  629. a TOC is generated</para>
  630. </listitem>
  631. </varlistentry>
  632. </variablelist>
  633. </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
  634. <para><link role="tcg" xlink:href="QandAtoc.html">Q and A list of questions</link>,
  635. <link role="tcg" xlink:href="QandAformat.html">Q and A formatting</link></para>
  636. </refsect1></refentry>
  637. <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo-need">
  638. <refnamediv>
  639. <refname>dbfo-need</refname>
  640. <refpurpose>Specify a need for space (a kind of soft page break)</refpurpose>
  641. </refnamediv>
  642. <refsynopsisdiv>
  643. <synopsis><tag class="xmlpi">dbfo-need height="<replaceable>n</replaceable>" [space-before="<replaceable>n</replaceable>"]</tag></synopsis>
  644. </refsynopsisdiv>
  645. <refsect1><title>Description</title>
  646. <para>A “need” is a request for space on a page. If the
  647. requested space is not available, the page breaks and the
  648. content that follows the need request appears on the next
  649. page. If the requested space is available, then no page break
  650. is inserted.</para>
  651. </refsect1><refsect1><title>Parameters</title>
  652. <variablelist>
  653. <varlistentry><term>height="<replaceable>n</replaceable>"</term>
  654. <listitem>
  655. <para>The amount of height needed (including units)</para>
  656. </listitem>
  657. </varlistentry>
  658. <varlistentry><term>space-before="<replaceable>n</replaceable>"</term>
  659. <listitem>
  660. <para>The amount of extra vertical space to add (including units)</para>
  661. </listitem>
  662. </varlistentry>
  663. </variablelist>
  664. </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
  665. <para><link role="tcg" xlink:href="PageBreaking.html#SoftPageBreaks">Soft page breaks</link></para>
  666. </refsect1></refentry>
  667. <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbfo_row-height">
  668. <refnamediv>
  669. <refname>dbfo_row-height</refname>
  670. <refpurpose>Specifies the height for a CALS table row</refpurpose>
  671. </refnamediv>
  672. <refsynopsisdiv>
  673. <synopsis><tag class="xmlpi">dbfo row-height="<replaceable>height</replaceable>"</tag></synopsis>
  674. </refsynopsisdiv>
  675. <refsect1><title>Description</title>
  676. <para>Use the <tag class="xmlpi">dbfo row-height</tag> PI as a child of a
  677. <tag>row</tag> to specify the height of the row.</para>
  678. </refsect1><refsect1><title>Parameters</title>
  679. <variablelist>
  680. <varlistentry><term>row-height="<replaceable>height</replaceable>"</term>
  681. <listitem>
  682. <para>Specifies the row height (including units)</para>
  683. </listitem>
  684. </varlistentry>
  685. </variablelist>
  686. </refsect1><refsect1 role="tcg"><title>Related Information in <link xlink:href="http://www.sagehill.net/docbookxsl/">DocBook XSL: The Complete Guide</link></title>
  687. <para><link role="tcg" xlink:href="RowHeight.html">Row height</link></para>
  688. </refsect1></refentry>
  689. </reference>