From: Michael Smith Date: Tue, 3 Jul 2007 11:48:38 +0000 (+0000) Subject: Consolidated processing of all FO PIs into wrapper templates in X-Git-Tag: release/1.79.1~6^2~2049 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=de9fcb12caca198d2ec0e6cd188adb4469aa625f;p=docbook-dsssl Consolidated processing of all FO PIs into wrapper templates in one place (the fo/pi.xsl file) and added embedded documentation for all of them. This makes it possible to now include generated documentation for the PIs in the output docs. Next stop: HTML PIs, then on to the common ones... This touched a lot of files and it is likely that I made some mistakes in moving the PI processing over. Meaning that some PIs might quit working or not work as expected after this change. So it will need to tested. Which is why we do dot-zero releases... --- diff --git a/xsl/fo/block.xsl b/xsl/fo/block.xsl index 046ca8cbc..2d42c8a91 100644 --- a/xsl/fo/block.xsl +++ b/xsl/fo/block.xsl @@ -244,11 +244,7 @@ - - - - + @@ -269,13 +265,9 @@ not(self::sidebarinfo)]"/> - + - - - - + @@ -348,11 +340,7 @@ - - - - + diff --git a/xsl/fo/formal.xsl b/xsl/fo/formal.xsl index cfdd116c3..0233d79f3 100644 --- a/xsl/fo/formal.xsl +++ b/xsl/fo/formal.xsl @@ -41,11 +41,7 @@ - - - - + @@ -131,11 +127,7 @@ - - - - + @@ -284,11 +276,7 @@ - - - - + @@ -466,11 +454,7 @@ - - - - + diff --git a/xsl/fo/glossary.xsl b/xsl/fo/glossary.xsl index ffd8a9a0b..718bdb698 100644 --- a/xsl/fo/glossary.xsl +++ b/xsl/fo/glossary.xsl @@ -44,19 +44,11 @@ - - - - + - - - - + @@ -237,19 +229,11 @@ &setup-language-variable; - - - - + - - - - + @@ -374,19 +358,11 @@ - - - - + - - - - + diff --git a/xsl/fo/graphics.xsl b/xsl/fo/graphics.xsl index 09563a5d5..4e94fec5c 100644 --- a/xsl/fo/graphics.xsl +++ b/xsl/fo/graphics.xsl @@ -192,10 +192,8 @@ - - - + + diff --git a/xsl/fo/htmltbl.xsl b/xsl/fo/htmltbl.xsl index e699fbc8a..1954d956b 100644 --- a/xsl/fo/htmltbl.xsl +++ b/xsl/fo/htmltbl.xsl @@ -157,10 +157,7 @@ - - - - + @@ -184,12 +181,8 @@ - - - - + - diff --git a/xsl/fo/lists.xsl b/xsl/fo/lists.xsl index 21a8aa3c4..ee31ed093 100644 --- a/xsl/fo/lists.xsl +++ b/xsl/fo/lists.xsl @@ -21,11 +21,7 @@ - - - - + @@ -188,11 +184,7 @@ - - - - + @@ -335,11 +327,7 @@ - - - - + @@ -364,11 +352,7 @@ - - - - + @@ -713,10 +697,10 @@ - + - + @@ -741,11 +725,7 @@ - - - - + @@ -1054,11 +1034,7 @@ - - - - + diff --git a/xsl/fo/pi.xsl b/xsl/fo/pi.xsl index c55b58e28..5f0a2c264 100644 --- a/xsl/fo/pi.xsl +++ b/xsl/fo/pi.xsl @@ -1,6 +1,8 @@ - - + + + +$Id$ + + + + The DocBook Project Development Team + + + + 2007 + The DocBook Project + + +FO Processing Instruction Reference + + +Introduction + +This is generated reference documentation for all + user-configurable 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). + + + + - - - filename + +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?] + + + + + + + + + + + + - - - + +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. + + + dbfo bgcolor="color" + + + + bgcolor="color" + + FIXME: A color value? [In hex, as a name, or what?] + + + + + + + + + + - - + +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. + + + + + + + - - filename + + - - + +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 + + + + + + + - - dir + + - + +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 + + + + + + + + + + + + - - - + +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?) + + + + + + + + + + + + - - - - - -
- - - - - - - - - - - - - - - - - - - - -
- - - - - -
-
+ +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) + + + + + + + + + + + - - + +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. + + + dbfo label-width="width" + + + + label-width="width" + + FIXME: Specifies the label width (in what units?) + + + + + + + + + + + + + + +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. + + + dbfo linenumbering.everyNth="N" + + + + linenumbering.everyNth="N" + + FIXME: Specifies numbering interval; a number is + output before every Nth line + + + + + + + + + + + + + + +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) + + + + + + + + + + + + - - No cmdsynopsis elements matched dbcmdlist PI, perhaps it's nested too deep? - - + +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?) + + + + + + + + + + + + -
- - - -
+ +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?) + + + + + + + + + + + - + +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 + + + + + + + + + + + + - - - + +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 + + + + + + + + + + + + - - - - - -
- - - - - - - - - - - - - - - - - - - - -
- - - - - -
-
+ + 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. + + + 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 + + + + + + + + + + + - - + + 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. + + + dbfo rotated-width="width" + + + + rotated-width="width" + + FIXME: Specifies the width of a row or cell (in what units?) + + + + + + + + + + + + - - No funcsynopsis elements matched dbfunclist PI, perhaps it's nested too deep? - - + +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?) + + + + + + + + + + + + -
- - - -
+ +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. + + + dbfo table-width="width" + + + + table-width="width" + + FIXME: Specifies the table width (in what units?) + + + + + + + + + + + - + +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?) + + + + + + + + + + + + - - + +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. + + + 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 + + + + + + + + + + + + - + + +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. + + + dbfo-need height="n" + dbfo-need 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?. + + + + + + @@ -293,7 +834,27 @@
+ + + + + + + filename + + + + + + + + + + + + + diff --git a/xsl/fo/qandaset.xsl b/xsl/fo/qandaset.xsl index 6096ded7f..a29692f67 100644 --- a/xsl/fo/qandaset.xsl +++ b/xsl/fo/qandaset.xsl @@ -21,11 +21,7 @@ - - - - + @@ -45,11 +41,7 @@ - - - - + @@ -156,11 +148,7 @@ - - - - + diff --git a/xsl/fo/table.xsl b/xsl/fo/table.xsl index 467580958..276afeade 100644 --- a/xsl/fo/table.xsl +++ b/xsl/fo/table.xsl @@ -72,11 +72,7 @@ works. - - - - + @@ -530,24 +526,20 @@ works. - - - - + - - - - + - - - + + + + + + + + @@ -749,10 +741,7 @@ works. - - - - + @@ -948,34 +937,26 @@ works. - - - + + - - - + + - - - + + - - - + + @@ -1002,10 +983,8 @@ works. - - - + + diff --git a/xsl/fo/titlepage.xsl b/xsl/fo/titlepage.xsl index dccd7f3d3..679756535 100644 --- a/xsl/fo/titlepage.xsl +++ b/xsl/fo/titlepage.xsl @@ -514,11 +514,7 @@ - - - - + diff --git a/xsl/fo/verbatim.xsl b/xsl/fo/verbatim.xsl index d975f769f..2286c1b6f 100644 --- a/xsl/fo/verbatim.xsl +++ b/xsl/fo/verbatim.xsl @@ -178,26 +178,20 @@ - - - + + - - - + + - - - + +