%param.ent; ]> $Id$ Walsh Norman 1999 2000 2001 Norman Walsh 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 XSL FO 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 :-) &admon.graphics; &admon.graphics.extension; &admon.graphics.path; &admon.textlabel; &admonition.title.properties; &admonition.properties; &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; &autotoc.label.separator; &process.empty.source.toc; &process.source.toc; &generate.toc; &generate.index; &make.index.markup; &index.preferred.page.properties; &xep.index.item.properties; &toc.section.depth; &toc.indent.width; &toc.margin.properties; &bridgehead.in.toc; &generate.section.toc.level; &arbortext.extensions; &axf.extensions; &fop.extensions; &passivetex.extensions; &tex.math.in.alt; &tex.math.delims; &xep.extensions; &linenumbering.everyNth; &linenumbering.extension; &linenumbering.separator; &linenumbering.width; &tablecolumns.extension; &textinsert.extension; &use.extensions; &appendix.autolabel; &chapter.autolabel; &part.autolabel; &preface.autolabel; §ion.autolabel; §ion.label.includes.component.label; &label.from.part; &rootid; &make.single.year.ranges; &make.year.ranges; &author.othername.in.middle; &funcsynopsis.decoration; &funcsynopsis.style; &function.parens; &refentry.generate.name; &refentry.generate.title; &refentry.pagebreak; &refentry.title.properties; &refentry.xref.manvolnum; &default.table.width; &nominal.table.width; &table.cell.padding; &table.frame.border.thickness; &table.frame.border.style; &table.frame.border.color; &table.cell.border.thickness; &table.cell.border.style; &table.cell.border.color; &table.table.properties; &target.database.document; &use.local.olink.style; ¤t.docid; &olink.doctitle; &qandadiv.autolabel; &qanda.inherit.numeration; &qanda.defaultlabel; &biblioentry.item.separator; &bibliography.collection; &bibliography.numbered; &glossterm.auto.link; &firstterm.only.link; &glossary.collection; &glossterm.separation; &glossterm.width; &glossary.as.blocks; &glosslist.as.blocks; &glossentry.show.acronym; &formal.procedures; &formal.title.placement; &runinhead.default.title.end.punct; &runinhead.title.end.punct; &show.comments; &punct.honorific; &segmentedlist.as.table; &variablelist.as.blocks; &blockquote.properties; &ulink.show; &ulink.footnotes; &ulink.footnote.number.format; &ulink.hyphenate; &shade.verbatim; &shade.verbatim.style; &use.svg; &use.role.as.xrefstyle; &menuchoice.separator; &menuchoice.menu.separator; &default.float.class; &footnote.number.format; &table.footnote.number.format; &footnote.number.symbols; &table.footnote.number.symbols; &xref.with.number.and.title; &superscript.properties; &subscript.properties; &graphic.default.extension; &default.image.width; &preferred.mediaobject.role; &use.role.for.mediaobject; &ignore.image.scaling;

In order for the parameters in this section to make sense, it is useful to consider .

Figure showing page margins This figure shows the physical page with the various FO page regions identified.

First, let's consider the regions on the page. The white region is the physical page. Its dimensions are determined by the page.height and page.width parameters. The yellow region is the region-body. The size and placement of the region body is constrained by the dimensions labelled in the figure. The pink region at the top of the page is the region-before. The darker area inside the region-before is the header text. In XSL, the default display alignment for a region is before, but the DocBook stylesheets still explicitly make it before. That's why the darker area is at the top. The pink region at the bottom of the page is the region-after. The darker area is the footer text. In XSL, the default display alignment for a region is before, but the DocBook stylesheets explicitly make it after. That's why the darker area is at the bottom. The dimensions in the figure are: The page-master margin-top. The region-before extent. The region-body margin-top. The region-after extent. The page-master margin-bottom. The region-body margin-bottom. The sum of the page-master margin-left and the region-body margin-left. In DocBook, the region-body margin-left is zero by default, so this is simply the page-master region-left. The sum of the page-master margin-right and the region-body margin-right. In DocBook, the region-body margin-right is zero by default, so this is simply the page-master region-left.

&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; &double.sided; &body.margin.bottom; &body.margin.top; &alignment; &hyphenate; &line-height; &column.count.back; &column.count.body; &column.count.front; &column.count.index; &column.count.lot; &column.count.titlepage; &column.gap.back; &column.gap.body; &column.gap.front; &column.gap.index; &column.gap.lot; &column.gap.titlepage; ®ion.after.extent; ®ion.before.extent; &default.units; &normal.para.spacing; &body.font.master; &body.font.size; &footnote.font.size; &title.margin.left; &draft.mode; &draft.watermark.image; &headers.on.blank.pages; &footers.on.blank.pages; &header.rule; &footer.rule; &header.column.widths; &footer.column.widths; &header.content.properties; &footer.content.properties; &marker.section.level; &body.font.family; &dingbat.font.family; &monospace.font.family; &sans.font.family; &title.font.family; &symbol.font.family; &list.block.spacing; &list.item.spacing; &compact.list.item.spacing; &variablelist.max.termlength; &insert.xref.page.number; &xref.properties; &xref.label-title.separator; &xref.label-page.separator; &xref.title-page.separator; &formal.object.properties; &formal.title.properties; &informal.object.properties; &monospace.properties; &verbatim.properties; &monospace.verbatim.properties; &sidebar.properties; §ion.title.properties; §ion.title.level1.properties; §ion.title.level2.properties; §ion.title.level3.properties; §ion.title.level4.properties; §ion.title.level5.properties; §ion.title.level6.properties; §ion.properties; §ion.level1.properties; §ion.level2.properties; §ion.level3.properties; §ion.level4.properties; §ion.level5.properties; §ion.level6.properties; &figure.properties; &example.properties; &equation.properties; &table.properties; &procedure.properties; &root.properties; &qanda.title.properties; &qanda.title.level1.properties; &qanda.title.level2.properties; &qanda.title.level3.properties; &qanda.title.level4.properties; &qanda.title.level5.properties; &qanda.title.level6.properties; &article.appendix.title.properties; Following parameters can be used for attribute value based profiling of your document. For more info about profiling look at http://docbook.sourceforge.net/projects/xsl/doc/tools/profiling.html. &profile.arch; &profile.condition; &profile.conformance; &profile.lang; &profile.os; &profile.revision; &profile.revisionflag; &profile.role; &profile.security; &profile.userlevel; &profile.vendor; &profile.attribute; &profile.value; &profile.separator; &l10n.gentext.language; &l10n.gentext.default.language; &l10n.gentext.use.xref.language; &ebnf.assignment; &ebnf.statement.terminator; The param.xsl stylesheet is just a wrapper around all these parameters.