From 5f511de97a1afa7914e577c61e6007d8afc0c81b Mon Sep 17 00:00:00 2001 From: Michael Smith Date: Fri, 6 Jul 2007 15:00:19 +0000 Subject: [PATCH] Added TCG links and param links to embedded doc of FO PIs. This completes the work on adding this doc for the FO stylesheets. --- xsl/fo/pi.xsl | 1038 +++++++++++++++++++++++++++---------------------- 1 file changed, 581 insertions(+), 457 deletions(-) diff --git a/xsl/fo/pi.xsl b/xsl/fo/pi.xsl index c4316c104..5af3d16c9 100644 --- a/xsl/fo/pi.xsl +++ b/xsl/fo/pi.xsl @@ -1,9 +1,9 @@ + xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" + xmlns:fo="http://www.w3.org/1999/XSL/Format" + exclude-result-prefixes="doc" + version='1.0'> - - -$Id$ - - - - The DocBook Project Development Team - - - - 2007 - The DocBook Project - - -FO Processing Instruction Reference - - -Introduction - -This is generated reference documentation for all - user-specifiable processing instructions (PIs) in the DocBook - XSL stylesheets for FO output. - - You add these PIs at particular points in a document to - cause specific “exceptions” to formatting/output behavior. To - make global changes in formatting/output behavior across an - entire document, it’s better to do it by setting an - appropriate stylesheet parameter (if there is one). - - - + + + $Id$ + + + + The DocBook Project Development Team + + + + 2007 + The DocBook Project + + + FO Processing Instruction Reference + + + Introduction + + This is generated reference documentation for all + user-specifiable processing instructions (PIs) in the DocBook + XSL stylesheets for FO output. + + You add these PIs at particular points in a document to + cause specific “exceptions” to formatting/output behavior. To + make global changes in formatting/output behavior across an + entire document, it’s better to do it by setting an + appropriate stylesheet parameter (if there is one). + + + -Sets background color for an image - - Use the dbfo background-color PI before or - after an image (graphic, inlinegraphic, - imagedata, or videodata element) as a - sibling to the element, to set a background color for the - image. - + Sets background color for an image + + Use the dbfo background-color PI before or + after an image (graphic, inlinegraphic, + imagedata, or videodata element) as a + sibling to the element, to set a background color for the + image. + dbfo background-color="color" - - - background-color="color" - - FIXME: A color value? [In hex, as a name, or what?] - - - - + + + background-color="color" + + An HTML color value + + + + + + Background color + @@ -82,23 +87,28 @@ $Id$ -Sets background color on an table row or table cell - - Use the dbfo bgcolor PI as child of a table row - or cell to set a background color for that table row or cell. - + Sets background color on a table row or table cell + + Use the dbfo bgcolor PI as child of a table row + or cell to set a background color for that table row or cell. + dbfo bgcolor="color" - - - bgcolor="color" - - FIXME: A color value? [In hex, as a name, or what?] - - - - + + + bgcolor="color" + + An HTML color value + + + + + + Cell background color + @@ -109,25 +119,36 @@ $Id$ -Specifies float behavior for a sidebar - - Use the dbfo float-type PI to specify the float - behavior for a sidebar (to cause the sidebar to be - displayed as a marginal note). - + Specifies float behavior for a sidebar + + Use the dbfo float-type PI to specify the float + behavior for a sidebar (to cause the sidebar to be + displayed as a marginal note). + dbfo float-type="margin.note" - - - float-type="margin.note" - - Specifies that the sidebar should be - displayed as a marginal note. - - - - + + + float-type="margin.note" + + Specifies that the sidebar should be + displayed as a marginal note. + + + + + + sidebar.float.type parameter, + sidebar.float.width parameter, + sidebar.properties attribute-set, + sidebar.title.properties + + + + A sidebar as + side float + @@ -138,28 +159,35 @@ $Id$ -Specifies presentation style for a glossary - - Use the dbfo glossary-presentation PI as a child of - a glossary to control its presentation style. - + Specifies presentation style for a glossary + + Use the dbfo glossary-presentation PI as a child of + a glossary to control its presentation style. + dbfo glossary-presentation="list"|"blocks" - - - glossary-presentation="list" - - Displayed the glossary as a list - - - glossary-presentation="blocks" - - Displays the glossary as blocks - - - - + + + glossary-presentation="list" + + Displays the glossary as a list + + + glossary-presentation="blocks" + + Displays the glossary as blocks + + + + + + glossary.as.blocks + + + Glossary + formatting in print + @@ -170,28 +198,35 @@ $Id$ -Specifies presentation style for a glosslist - - Use the dbfo glosslist-presentation PI as a child of - a glosslist to control its presentation style. - + Specifies presentation style for a glosslist + + Use the dbfo glosslist-presentation PI as a child of + a glosslist to control its presentation style. + dbfo glosslist-presentation="list"|"blocks" - - - glosslist-presentation="list" - - Displayed the glosslist as a list - - - glosslist-presentation="blocks" - - Displays the glosslist as blocks - - - - + + + glosslist-presentation="list" + + Displays the glosslist as a list + + + glosslist-presentation="blocks" + + Displays the glosslist as blocks + + + + + + glosslist.as.blocks + + + Glossary + formatting in print + @@ -202,26 +237,35 @@ $Id$ -Specifies the glossterm width for a glossary or - glosslist - - Use the dbfo glossterm-width PI as a child of a - glossary or glosslist to specify the - width for output of glossterm instances in the - output. - + Specifies the glossterm width for a glossary or + glosslist + + Use the dbfo glossterm-width PI as a child of a + glossary or glosslist to specify the + width for output of glossterm instances in the + output. + dbfo glossterm-width="width" - - - glossterm-width="width" - - FIXME: Specifies the glossterm width (in what units?) - - - - + + + glossterm-width="width" + + Specifies the glossterm width (including units) + + + + + + glossterm.width, + glossterm.separation + + + + Glossary + formatting in print + @@ -232,33 +276,40 @@ $Id$ -Specifies “keep” behavior for a table, example, - figure, or equation - - Use the dbfo keep-together PI as a child of a - formal object (table, example, - figure, or equation) or their informal - equivalents) to specify “keep” behavior for the object (to - allow the object to “break” across a page). - + Specifies “keep” behavior for a table, example, + figure, or equation + + Use the dbfo keep-together PI as a child of a + formal object (table, example, + figure, or equation) or their informal + equivalents) to specify “keep” behavior for the object (to + allow the object to “break” across a page). + dbfo keep-together="auto"|"always" - - - keep-together="auto" - - Enables the object to break across a page - - - keep-together="always" - - Prevents the object from breaking across a page (the - default stylesheet behavior) - - - - + + + keep-together="auto" + + Enables the object to break across a page + + + keep-together="always" + + Prevents the object from breaking across a page (the + default stylesheet behavior) + + + + + + formal.object.properties + + + Keep-together processing instruction + @@ -269,25 +320,28 @@ $Id$ -Specifies the label width for an itemizedlist, - orderedlist, or qandaset - - Use the dbfo label-width PI as a child of an - itemizedlist, orderedlist, or - qandaset to specify the width of labels. - + Specifies the label width for a qandaset + + Use the dbfo label-width PI as a child of a + qandaset to specify the width of labels. + dbfo label-width="width" - - - label-width="width" - - FIXME: Specifies the label width (in what units?) - - - - + + + label-width="width" + + FIXME: Specifies the label width (in what units?) + + + + + + Q and A formatting + @@ -298,119 +352,140 @@ $Id$ -Specifies the interval at which lines are numbered - output of verbatim environments - - Use the dbfo linenumbering.everyNth PI as a child - of a “verbatim” element – programlisting, - screen, synopsis — to specify - the interval at which lines are numbered. - + Specifies the interval at which lines are numbered in + output of verbatim environments + + Use the dbfo linenumbering.everyNth PI as a child + of a “verbatim” element – programlisting, + screen, synopsis — to specify + the interval at which lines are numbered. + dbfo linenumbering.everyNth="N" - - - linenumbering.everyNth="N" - - FIXME: Specifies numbering interval; a number is - output before every Nth line - - - - + + + linenumbering.everyNth="N" + + Specifies numbering interval; a number is output + before every Nth line + + + + + + linenumbering.everyNth + + + Line numbering + - + -Specifies the separator text used between line numbers - and content in output of verbatim environments - - Use the dbfo linenumbering.separator PI as a child - of a “verbatim” element – programlisting, - screen, synopsis — to specify - the separator text output between the line numbers and content. - + Specifies the separator text used between line numbers + and content in output of verbatim environments + + Use the dbfo linenumbering.separator PI as a child + of a “verbatim” element – programlisting, + screen, synopsis — to specify + the separator text output between the line numbers and content. + dbfo linenumbering.separator="text" - - - linenumbering.separator="text" - - FIXME: Specifies the text (zero or more characters) - - - - + + + linenumbering.separator="text" + + Specifies the text (zero or more characters) + + + + + + linenumbering.separator + + + Line numbering + - + -Specifies the width set aside for line numbers in - output of verbatim environments - - Use the dbfo linenumbering.width PI as a child - of a “verbatim” element – programlisting, - screen, synopsis — to specify - the width set aside for line numbers. - + Specifies the width set aside for line numbers in + output of verbatim environments + + Use the dbfo linenumbering.width PI as a child + of a “verbatim” element – programlisting, + screen, synopsis — to specify + the width set aside for line numbers. + dbfo linenumbering.width="width" - - - linenumbering.width="width" - - FIXME: Specifies the width (in what units?) - - - - + + + linenumbering.width="width" + + Specifies the width (inluding units) + + + + + + linenumbering.width + + + Line numbering + - + -Specifies the width of a horizontal simplelist - - Use the dbfo list-width PI as a child of a - simplelist whose class - value is horizontal, to specify the width - of the simplelist. - + Specifies the width of a horizontal simplelist + + Use the dbfo list-width PI as a child of a + simplelist whose class + value is horizontal, to specify the width + of the simplelist. + dbfo list-width="width" - - - list-width="width" - - FIXME: Specifies the simplelist width (in what units?) - - - - + + + list-width="width" + + Specifies the simplelist width (including units) + + + + @@ -421,36 +496,51 @@ $Id$ -Specifies presentation style for a variablelist or - segmentedlist - - Use the dbfo list-presentation PI as a child of - a variablelist or segmentedlist to - control the presentation style for the list (to cause it, for - example, to be displayed as a table). - + Specifies presentation style for a variablelist or + segmentedlist + + Use the dbfo list-presentation PI as a child of + a variablelist or segmentedlist to + control the presentation style for the list (to cause it, for + example, to be displayed as a table). + dbfo list-presentation="list"|"blocks"|"table" - - - list-presentation="list" - - Displayed the list as a list - - - list-presentation="blocks" - - (variablelist only) Displays the list as blocks - - - list-presentation="table" - - (segmentedlist only) Displays the list as a table - - - - + + + list-presentation="list" + + Displays the list as a list + + + list-presentation="blocks" + + (variablelist only) Displays the list as blocks + + + list-presentation="table" + + (segmentedlist only) Displays the list as a table + + + + + + + variablelist.as.blocks + + + variablelist.as.table + + + + + Variable list formatting in print + + @@ -461,25 +551,25 @@ $Id$ -Specifies the orientation for table row or cell - - Use the dbfo orientation PI as a child of an - table row or cell to specify the orientation - (rotation) for the row or cell. - + Specifies the orientation for table row or cell + + Use the dbfo orientation PI as a child of an + table row or cell to specify the orientation + (rotation) for the row or cell. + dbfo orientation="0"|"90"|"180"|"270"|"-90"|"-180"|"-270" - - - orientation="0"|"90"|"180"|"270"|"-90"|"-180"|"-270" - - Specifies the number of degrees by which the cell or - row is rotated - - - - + + + orientation="0"|"90"|"180"|"270"|"-90"|"-180"|"-270" + + Specifies the number of degrees by which the cell or + row is rotated + + + + @@ -493,30 +583,33 @@ $Id$ Species whether an equation or example should rendered across the full width of a page - - Use the dbfo pgwide PI as a child of an - equation or example to specify that the - content should rendered across the full width of the page. - + + Use the dbfo pgwide PI as a child of an + equation or example to specify that the + content should rendered across the full width of the page. + dbfo pgwide="0"|"1" - - - pgwide="0" - - If zero, the content is rendered across the current - text flow - - - pgwide="1" - - If 1 (or any non-zero value), the - content is rendered across the full width of the page - - - - + + + pgwide="0" + + If zero, the content is rendered across the current + text flow + + + pgwide="1" + + If 1 (or any non-zero value), the + content is rendered across the full width of the page + + + + + + pgwide.properties + @@ -529,53 +622,63 @@ $Id$ Specifies the width for a table entry or row - - Use the dbfo rotated-width PI as a child of an - entry or row instance to specify the - width of that the entry or row; or - use it higher up in table to cause the width to be inherited - recursively down. - + + Use the dbfo rotated-width PI as a child of an + entry or row instance to specify the + width of that the entry or row; or + use it higher up in table to cause the width to be inherited + recursively down. + dbfo rotated-width="width" - - - rotated-width="width" - - FIXME: Specifies the width of a row or cell (in what units?) - - - - + + + rotated-width="width" + + Specifies the width of a row or cell (including units) + + + + - + -Specifies the width of a sidebar - - Use the dbfo sidebar-width PI as a child of a - sidebar to specify the width of the sidebar. - + Specifies the width of a sidebar + + Use the dbfo sidebar-width PI as a child of a + sidebar to specify the width of the sidebar. + dbfo sidebar-width="width" - - - sidebar-width="width" - - FIXME: Specifies the sidebar width (in what units?) - - - - + + + sidebar-width="width" + + Specifies the sidebar width (including units) + + + + + + sidebar.float.type parameter, + sidebar.float.width parameter, + sidebar.properties attribute-set, + sidebar.title.properties + + + + A sidebar as + side float + @@ -586,26 +689,32 @@ $Id$ -Specifies the width for a table or for revhistory - output - - Use the dbfo table-width PI as a child of a - table or revhistory instance (which is - rendered as a table in output) to specify the width of the - table in output. - + Specifies the width for a table or for revhistory + output + + Use the dbfo table-width PI as a child or + sibling of a table, or as a child of an + informaltable, entrybl, or + revhistory instance (which is rendered as a table + in output) to specify the width of the table in output. + dbfo table-width="width" - - - table-width="width" - - FIXME: Specifies the table width (in what units?) - - - - + + + table-width="width" + + Specifies the table width (including units or as a percentage) + + + + + + Table width + @@ -616,24 +725,29 @@ $Id$ -Specifies the term width for a variablelist - - Use the dbfo term-width PI as a child of a - variablelist to specify the width for - term output. - + Specifies the term width for a variablelist + + Use the dbfo term-width PI as a child of a + variablelist to specify the width for + term output. + dbfo term-width="width" - - - term-width="width" - - FIXME: Specifies the term width (in what units?) - - - - + + + term-width="width" + + FIXME: Specifies the term width (in what units?) + + + + + + Variable list formatting in print + @@ -644,30 +758,38 @@ $Id$ -Species whether a TOC should be generated for a qandaset - - Use the dbfo toc PI as a child of a - jandaset to specify whether a table of contents - (TOC) is generated for the qandaset. - + Species whether a TOC should be generated for a qandaset + + Use the dbfo toc PI as a child of a + qandaset to specify whether a table of contents + (TOC) is generated for the qandaset. + dbfo toc="0"|"1" - - - toc="0" - - If zero, no TOC is generated - - - toc="1" - - If 1 (or any non-zero value), - a TOC is generated - - - - + + + toc="0" + + If zero, no TOC is generated + + + toc="1" + + If 1 (or any non-zero value), + a TOC is generated + + + + + + Q and A list of questions, + Q and A formatting + @@ -677,36 +799,37 @@ $Id$ - - -Specify a need for space (a kind of soft page break) - - A “need” is a request for space on a page. If the - requested space is not available, the page breaks and the - content that follows the need request appears on the next - page. If the requested space is available, then the request is - ignored. - + Specify a need for space (a kind of soft page break) + + A “need” is a request for space on a page. If the + requested space is not available, the page breaks and the + content that follows the need request appears on the next + page. If the requested space is available, then no page break + is inserted. + - dbfo-need height="n" - dbfo-need space-before="n" + dbfo-need height="n" [space-before="n"] - - - height="n" - - FIXME: the amount of height(?) needed? In what units? pt?. - - - space-before"n" - - FIXME: the amount of space needed before the - [something]? In what units? pt?. - - - - + + + height="n" + + The amount of height needed (including units) + + + space-before"n" + + The amount of extra vertical space to add (including units) + + + + + + Soft page breaks + @@ -743,49 +866,49 @@ $Id$ + not(following-sibling::listitem) and + not(following-sibling::step)"> + xsl:use-attribute-sets="normal.para.spacing"> + following-sibling::figure or + following-sibling::example or + following-sibling::equation"> + xsl:use-attribute-sets="formal.object.properties"> + following-sibling::informalfigure or + following-sibling::informalexample or + following-sibling::informalequation"> + xsl:use-attribute-sets="informal.object.properties"> + following-sibling::orderedlist or + following-sibling::variablelist or + following-sibling::simplelist"> + xsl:use-attribute-sets="informal.object.properties"> + following-sibling::step"> + xsl:use-attribute-sets="informal.object.properties"> @@ -793,13 +916,13 @@ $Id$ + following-sibling::sect2 or + following-sibling::sect3 or + following-sibling::sect4 or + following-sibling::sect5 or + following-sibling::section"> + xsl:use-attribute-sets="section.title.properties"> @@ -815,20 +938,20 @@ $Id$ + following-sibling::step"> + space-before="-{$height}" + space-after="0pt" + space-after.precedence="force"> + space-before="-{$height}" + space-after="0pt" + space-after.precedence="force"> @@ -848,6 +971,7 @@ $Id$ + -- 2.40.0