From 7c297f636decb3d78e43b48e2262071fb870d09c Mon Sep 17 00:00:00 2001 From: Norman Walsh Date: Mon, 8 Oct 2001 12:10:53 +0000 Subject: [PATCH] Removed param.xsl; it's now generated from param.xweb --- xsl/fo/.cvsignore | 4 + xsl/fo/Makefile | 11 +- xsl/fo/param.ent | 112 ++++ xsl/fo/param.xsl | 1290 --------------------------------------------- xsl/fo/param.xweb | 319 +++++++++++ 5 files changed, 445 insertions(+), 1291 deletions(-) create mode 100644 xsl/fo/param.ent delete mode 100644 xsl/fo/param.xsl create mode 100644 xsl/fo/param.xweb diff --git a/xsl/fo/.cvsignore b/xsl/fo/.cvsignore index c7dc21b88..0c6231e07 100644 --- a/xsl/fo/.cvsignore +++ b/xsl/fo/.cvsignore @@ -1 +1,5 @@ titlepage.templates.xsl +param.xsl +param.xml +param.html + diff --git a/xsl/fo/Makefile b/xsl/fo/Makefile index a9f41a4c5..1eb99b3d2 100644 --- a/xsl/fo/Makefile +++ b/xsl/fo/Makefile @@ -1,7 +1,16 @@ XSLT=../../cvstools/saxon XJPARSE=../../cvstools/xjparse -all: titlepage.templates.xsl +all: titlepage.templates.xsl param.xml param.xxx param.html + +param.html: param.xml + $(XSLT) $< ../docsrc/lrefentry.xsl $@ + +param.xml: param.xweb + $(XSLT) $< ../../litprog/wdocbook.xsl $@ + +param.xsl: param.xweb + $(XSLT) $< ../../litprog/xtangle.xsl $@ titlepage.templates.xsl: titlepage.templates.xml ../template/titlepage.xsl $(XSLT) $< ../template/titlepage.xsl $@ diff --git a/xsl/fo/param.ent b/xsl/fo/param.ent new file mode 100644 index 000000000..9c00b11d1 --- /dev/null +++ b/xsl/fo/param.ent @@ -0,0 +1,112 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/xsl/fo/param.xsl b/xsl/fo/param.xsl deleted file mode 100644 index 6c4ceeb15..000000000 --- a/xsl/fo/param.xsl +++ /dev/null @@ -1,1290 +0,0 @@ - - - - - - - - -$Id$ - -Walsh -Norman -19992000 -Norman Walsh - - -Formatting Object Parameter Reference - - -
Introduction - -This is technical reference documentation for the DocBook XSL -Stylesheets; it documents (some of) the parameters, templates, and -other elements of the stylesheets. - -This reference describes each of the Formatting Object -Stylesheet parameters. These are the easily -customizable parts of the stylesheet. If you want to specify -an alternate value for one or more of these parameters, you can do so -in a driver stylesheet. - -For example, if you want to turn on automatic section numbering, -you might create a driver stylesheet like this: - - - - - - - -]]> - -Naturally, you have to change the -href attribute on -<xsl:import> -to point to docbook.xsl -on your system. - -This is not intended to be user documentation. -It is provided for developers writing customization layers for the -stylesheets, and for anyone who's interested in how it -works. - -Although I am trying to be thorough, this documentation is known -to be incomplete. Don't forget to read the source, too :-) -
- - - - -docbook.css -text/css - - -kr - - - - -../images/ - - - - - -Extension for admonition graphics - -Sets the extension to use on admonition graphics. - - - - - - - - - - -. - - - - - -Are divisions in QAndASets enumerated? - -If true (non-zero), unlabeled qandadivs will be enumerated. - - - - - - - - -Does enumeration of QandASet components inherit the numeration of parent elements? - -If true (non-zero), numbered QandADiv elements and Questions and Answers inherit -the numeration of the ancestors of the QandASet. - - - - - - - - - -Default extension for graphic filenames - -If a graphic or mediaobject -includes a reference to a filename that does not include an extension, -and the format attribute is -unspecified, the default extension will be used. - - - - - - - 0.5em - 1em - 2em - 0.5em - 1em - 2em - always - - - - - bold - 12pt - false - always - - - -Properties of formal object titles - -This attribute set is used to specify the properties of formal -object titles. - - - - - - - 2em - 1.8em - 2.2em - bold - 18pt - 1.5em - 1.3em - 1.8em - false - always - - - -Properties of component titles - -This attribute set is used to specify the properties of component -titles. - - - - - - - 14pt - bold - false - always - - - -Properties of admonition titles - -This attribute set is used to specify the properties of admonition -titles. - - - - - - - 0.5em - 1em - 2em - 0.5em - 1em - 2em - - - - - 0.8em - 1em - 1.2em - - - - - - - - - - pt - - - - - - - - - -Visual properties of hotlinks - -This attribute set is used to specify properties of xrefs - - - - - - - -Turns page numbers in xrefs on and off - -When equal to 1, this parameter triggers generation of page -number citations after xrefs. - - - - - - - 1em - 0.8em - 1.2em - - - -Spacing properties of normal paragraphs - -This attribute set is used to specify the spacing properties -of normal paragraphs. - - - - - - - - 1em - 0.8em - 1.2em - - - -Spacing properties of list blocks - -This attribute set is used to specify the spacing properties -of list blocks. - - - - - - - - 1em - 0.8em - 1.2em - - - -Spacing properties of list items - -This attribute set is used to specify the spacing properties -of list items. - - - - - - - - -Specify the root element to format - -If rootid is specified, it must be the -value of an ID that occurs in the document being formatted. The entire -document will be loaded and parsed, but formatting will begin at the -element identified, rather than at the root. For example, this allows -you to process only chapter 4 of a book. -Because the entire document is available to the processor, automatic -numbering, cross references, and other dependencies are correctly -resolved. - - - - - - - -Use graphics for callouts? - -If non-zero, callouts are presented with graphics (e.g., reverse-video -circled numbers instead of "(1)", "(2)", etc.). -Default graphics are provided in the distribution. - - - - - - - - -First character to use for Unicode callouts - -If non-zero, callouts are presented with Unicode characters -starting with the character specified. Zero indicates that Unicode -callouts should not be used. - - - - - - - - -Font to use for Unicode dingbats - -The name of the font to specify around Unicode callout glyphs. -If set to the empty string, no font change will occur. - - - - - - - - -Number of the largest callout graphic - -If callout.graphics -is non-zero, graphics are used to represent -callout numbers. The value of -callout.graphics.number.limit -is -the largest number for which a graphic exists. If the callout number -exceeds this limit, the default presentation "(nnn)" will always -be used. - - - - - - - - -Number of the largest callout graphic - -If callout.graphics -is non-zero, graphics are used to represent -callout numbers. The value of -callout.graphics.number.limit -is -the largest number for which a graphic exists. If the callout number -exceeds this limit, the default presentation "(nnn)" will always -be used. - - - - - - - - -Extension for callout graphics - -Sets the extension to use on callout graphics. - - - - - - - -Path to callout graphics - -Sets the path, probably relative to the directory where the HTML -files are created, to the callout graphics. - - - - - - - - -Number of the largest callout graphic - -If callout.graphics -is non-zero, graphics are used to represent -callout numbers. The value of -callout.graphics.number.limit -is -the largest number for which a graphic exists. If the callout number -exceeds this limit, the default presentation "(nnn)" will always -be used. - - - - - - - - -Enable extensions - -If non-zero, extensions may be used. Each extension is -further controlled by its own parameter. But if -use.extensions is zero, no extensions will -be used. - - - - - - - - -Enable the textinsert extension element - -The textinsert extension element inserts the contents of a -a file into the result tree (as text). - - - - - - - - -Enable the line numbering extension - -If true, verbatim environments (elements that have the -format='linespecific' notation attribute: address, literallayout, -programlisting, screen, synopsis) that specify line numbering will -have, surprise, line numbers. - - - - - - - - -Indicate which lines should be numbered - -If line numbering is enabled, everyNth line will be numbered. - - - - - - - - -Indicates the width of line numbers - -If line numbering is enabled, line numbers will appear right -justified in a field "width" characters wide. - - - - - - - - -Specify a separator between line numbers and lines - -The separator is inserted between line numbers and lines in -the verbatim environment. - - - - - - - - -Enable the callout extension - -The callouts extension processes areaset -elements in ProgramListingCO and other text-based -callout elements. - - - - - - - - -Indicates what column callouts appear in by default - -If a callout does not identify a column (for example, if it uses -the linerange unit), -it will appear in the default column. - - - - - - - - -Enable the table columns extension function - -The table columns extension function adjusts the widths of table -columns in the HTML result to more accurately reflect the specifications -in the CALS table. - - - - - - - - -The (absolute) nominal width of tables - -In order to convert CALS column widths into FO column widths, it -is sometimes necessary to have an absolute table width to use for conversion -of mixed absolute and relative widths. This value must be an absolute -length (not a percentage). - - - - - - - -The default width of tables - -If specified, this value will be used for the WIDTH attribute on -tables that do not specify an alternate width (with the dbhtml processing -instruction). - - - - - - -Select the paper type - -The paper type is a convenient way to specify the paper size. -The list of known paper sizes includes USletter and most of the A, -B, and C sizes. See page.width.portrait, for example. - - - - - - - -Select the page orientation - -In portrait orientation, the short edge is horizontal; in -landscape orientation, it is vertical. - - - - - - - - 8.5in - 1682mm - 1189mm - 841mm - 594mm - 420mm - 297mm - 210mm - 148mm - 105mm - 74mm - 52mm - 37mm - 26mm - 1000mm - 707mm - 500mm - 353mm - 250mm - 176mm - 125mm - 88mm - 62mm - 44mm - 31mm - 917mm - 648mm - 458mm - 324mm - 229mm - 162mm - 114mm - 81mm - 57mm - 40mm - 28mm - 8.5in - - - - -Specify the physical size of the short edge of the page - -The portrait page width is the length of the short -edge of the physical page. - - - - - - - - 210mm - 11in - 8.5in - 2378mm - 1682mm - 1189mm - 841mm - 594mm - 420mm - 297mm - 210mm - 148mm - 105mm - 74mm - 52mm - 37mm - 1414mm - 1000mm - 707mm - 500mm - 353mm - 250mm - 176mm - 125mm - 88mm - 62mm - 44mm - 1297mm - 917mm - 648mm - 458mm - 324mm - 229mm - 162mm - 114mm - 81mm - 57mm - 40mm - 11in - - - - -Specify the physical size of the long edge of the page - -The portrait page height is the length of the long -edge of the physical page. - - - - - - - - - - - - - - - - - -The width of the physical page - -The page width is generally calculated from the -paper.type and -page.orientation. - - - - - - - - - - - - - - - - - -The height of the physical page - -The page height is generally calculated from the -paper.type and -page.orientation. - - - - - - - - -Is the document to be printed double sided? - -Double-sided documents are printed with a slightly wider margin -on the binding edge of the page. - -FIXME: The current set of parameters does not take writing direction -into account. - - - - - - - -Specifies the number of columns of text on the page - -The specified number of columns of text will appear on each page. - - - - - - - - -Specifies the height of the footer. - -The region after extent is the height of the area where footers -are printed. - - - - - - - - -Specifies the height of the header - -The region before extent is the height of the area where headers -are printed. - - - - - -1in - - -The top margin of the page - -The top page margin is the distance from the physical top of the -page to the first line of text (body or header). - - - - - -1in - - -The bottom margin of the page - -The bottom page margin is the distance from the physical bottom of -the page to the last line of text (body or footer). - - - - - - - - 1.25in - 1in - - - - -The inner page margin - -The inner page margin is the distance from binding edge of the -page to the first column of text. In the left-to-right, top-to-bottom writing -direction, this is the left margin of recto pages. -The inner and outer margins are usually the same unless the output -is double-sided. - - - - - - - - 0.75in - 10pc - - - - -The outer page margin - -The outer page margin is the distance from non-binding edge of the -page to the last column of text. In the left-to-right, top-to-bottom writing -direction, this is the right margin of recto pages. -The inner and outer margins are usually the same unless the output -is double-sided. - - - - - -24pt - - -The bottom margin of the body text - -The body bottom margin is the distance from the last line of text -in the page body to the bottom page margin. Note that the page footer, if -any, appears in the space between the body bottom margin and the page -bottom margin. - - - - - -24pt - - -FIXME: - -The body top margin is the distance from the page top margin to -the first line of text -in the page body. Note that the page header, if -any, appears in the space between the page top margin and the body -top margin. - - - - - -Times Roman - - -The default font family for body text - -The body font family is the default font used for text in the page body. - - - - - -Helvetica - - -The default font family for titles - -The title font family is used for titles (chapter, section, figure, -etc.) - - - - - -Courier - - -The default font family for monospace environments - -The monospace font family is used for verbatim environments -(program listings, screens, etc.). - - - - - -Helvetica - - -The default sans-serif font family - -The default sans-serif font family. At the present, this isn't -actually used by the stylesheets. - - - - - -Times Roman - - -The font family for copyright, quotes, and other symbols - -The dingbat font family is used for dingbats. If it is defined -as the empty string, no font change is effected around dingbats. - - - - - -10 - - -Specifies the default point size for body text - -The body font size is specified in two parameters -(body.font.master and body.font.size) -so that math can be performed on the font size by XSLT. - - - - - - - pt - - - -Specifies the default font size for body text - -The body font size is specified in two parameters -(body.font.master and body.font.size) -so that math can be performed on the font size by XSLT. - - - - - - - pt - - - -The font size for footnotes - -The footnote font size is used for...footnotes! - - - - - - -true - - -Specify hyphenation behavior - -If true, words may be hyphenated. Otherwise, they may not. - - - - - -justify - - -Specify the default text alignment - -The default text alignment is used for most body text. - - - - - - - - -Identifies the output format of this stylesheet - -The extension functions need to know if the output format -is HTML ('html') or XSL Formatting Objects ('fo'). This variable answers -that question. Valid settings are 'html' or 'fo'. - - - - - - - -Generate a table of contents for components? - -If non-zero, a table of contents is generated at the beginning -of each component (chapters, appendixes, etc.) - - - - - - - - -Generate a table of contents for divisions? - -If non-zero, a table of contents is generated at the beginning -of each division (sets, books, etc.) - - - - - - - - - - - - - - -Generate a list of titles for Figures? - -If non-zero, a list of titles is generated for Figures. - - - - - - - - -Generate a list of titles for Examples? - -If non-zero, a list of titles is generated for Examples. - - - - - - - - -Generate a list of titles for Equations? - -If non-zero, a list of titles is generated for Equations. - - - - - - - - -Generate a list of titles for Tables? - -If non-zero, a list of titles is generated for Tables. - - - - - - - - - - - - - - -Enable PassiveTeX extensions? - -If non-zero, -PassiveTeX -extensions will be used. At present, this consists of PDF bookmarks -and sorted index terms. - - - - - - - - -Enable Arbortext extensions? - -If non-zero, -Arbortext -extensions will be used. - - - - - - - - -Enable FOP extensions? - -If non-zero, -FOP -extensions will be used. At present, this consists of PDF bookmarks. - - - - - - - - -Enable XEP extensions? - -If non-zero, -XEP -extensions will be used. XEP extensions consists of PDF bookmarks and document information. - - - - - - - - -Default units for an unqualified dimension - -If an unqualified dimension is encountered (for example, in a -graphic width), the default-units will be used for the -units. Unqualified dimensions are not allowed in XSL Formatting Objects. - - - - - - - - - - - - -Renumber chapters in each part? - -If label.from.part is non-zero, components -(chapters, appendixes, etc.) -will be numbered from 1 in each part. Otherwise, -they will be numbered monotonically throughout each -book. - - - - - - - - -Selects formal or informal procedures - -Formal procedures are numbered and always hav a title. - - - - - - - - -Name of the bibliography collection file - -Tired of copying bibliography entries from one document to another? -Now you can maintain a central bibliography and let the stylesheets do -the copying for you. This parameter identifies the file (by URI reference) -that contains your complete bibliography collection. - - - - - - - - -Use an fo:list to format VariableLists? - -If non-zero, an fo:list will be used to format VariableLists. -Otherwise, nested fo:blocks will be used. - - - - - - - - -Characters that count as punctuation on a run-in-head - -FIXME: - - - - - - - - -Default punctuation character on a run-in-head - -FIXME: - - - - - - - - -Collate copyright years into ranges? - -If non-zero, copyright years will be collated into ranges. - - - - - - - -Print single-year ranges (e.g., 1998-1999) - -If non-zero, year ranges that span a single year will be printed -in range notation (1998-1999) instead of discrete notation -(1998, 1999). - - - - - diff --git a/xsl/fo/param.xweb b/xsl/fo/param.xweb new file mode 100644 index 000000000..5195b468d --- /dev/null +++ b/xsl/fo/param.xweb @@ -0,0 +1,319 @@ + +%param.ent; +]> + + +FO Parameter Reference + +$Id$ + + + Walsh + Norman + + + 1999 + 2000 + 2001 + Norman Walsh + + + +Introduction + +This is technical reference documentation for the DocBook XSL +Stylesheets; it documents (some of) the parameters, templates, and +other elements of the stylesheets. + +This reference describes each of the HTML Stylesheet parameters. +These are the easily customizable parts of the stylesheet. +If you want to specify an alternate value for one or more of these +parameters, you can do so in a driver stylesheet. + +For example, if you want to change the html.stylesheet +to reference.css, you might create a driver +stylesheet like this: + + + + + + reference.css + +]]> + +Naturally, you have to change the +href attribute on +<xsl:import> to point to +docbook.xsl on your system. (Or +chunk.xsl, if you're using chunking.) + +This is not intended to be user documentation. +It is provided for developers writing customization layers for the +stylesheets, and for anyone who's interested in how it +works. + +Although I am trying to be thorough, this documentation is known +to be incomplete. Don't forget to read the source, too :-) + + +The Parameters +&admon.graphics; +&admon.graphics.extension; +&admon.graphics.path; +&admonition.title.properties; +&alignment; +&appendix.autolabel; +&arbortext.extensions; +&author.othername.in.middle; +&biblioentry.item.separator; +&bibliography.collection; +&body.font.family; +&body.font.master; +&body.font.size; +&body.margin.bottom; +&body.margin.top; +&callout.defaultcolumn; +&callout.graphics; +&callout.graphics.extension; +&callout.graphics.number.limit; +&callout.graphics.path; +&callout.unicode; +&callout.unicode.font; +&callout.unicode.number.limit; +&callout.unicode.start.character; +&callouts.extension; +&chapter.autolabel; +&column.count; +&component.title.properties; +&default.table.width; +&default.units; +&dingbat.font.family; +&double.sided; +&footnote.font.size; +&fop.extensions; +&formal.object.properties; +&formal.procedures; +&formal.title.properties; +&format.variablelist.as.list; +&funcsynopsis.decoration; +&funcsynopsis.style; +&generate.book.equation.lot; +&generate.book.example.lot; +&generate.book.figure.lot; +&generate.book.table.lot; +&generate.book.toc; +&generate.component.toc; +&generate.division.equation.lot; +&generate.division.example.lot; +&generate.division.figure.lot; +&generate.division.table.lot; +&generate.division.toc; +&generate.index; +&graphic.default.extension; +&html.stylesheet; +&html.stylesheet.type; +&hyphenate; +&insert.xref.page.number; +&label.from.part; +&linenumbering.everyNth; +&linenumbering.extension; +&linenumbering.separator; +&linenumbering.width; +&list.block.spacing; +&list.item.spacing; +&make.single.year.ranges; +&make.year.ranges; +&monospace.font.family; +&monospace.verbatim.properties; +&nominal.table.width; +&normal.para.spacing; +&page.height; +&page.height.portrait; +&page.margin.bottom; +&page.margin.inner; +&page.margin.outer; +&page.margin.top; +&page.orientation; +&page.width; +&page.width.portrait; +&paper.type; +&part.autolabel; +&passivetex.extensions; +&preface.autolabel; +&process.empty.source.toc; +&process.source.toc; +&qanda.inherit.numeration; +&qandadiv.autolabel; +&refentry.generate.name; +&refentry.xref.manvolnum; +®ion.after.extent; +®ion.before.extent; +&rootid; +&runinhead.default.title.end.punct; +&runinhead.title.end.punct; +&sans.font.family; +§ion.autolabel; +§ion.label.includes.component.label; +&show.comments; +&stylesheet.result.type; +&tablecolumns.extension; +&textinsert.extension; +&title.font.family; +&toc.margin.properties; +&use.extensions; +&verbatim.properties; +&xep.extensions; +&xref.properties; +&table.border.thickness; +&table.border.padding; +&table.border.style; +&table.border.color; +&title.margin.left; + + + +The Stylesheet + +The param.xsl stylesheet is just a wrapper +around all these parameters. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -- 2.40.0