%param.ent; ]> FO Parameter Reference Walsh Norman 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 Norman Walsh This is reference documentation for all user-configurable parameters in the DocBook XSL FO stylesheets (for generating XSL-FO output destined for final print/PDF output). Admonitions &admon.graphics; &admon.graphics.extension; &admon.graphics.path; &admon.textlabel; &admonition.title.properties; &admonition.properties; &graphical.admonition.properties; &nongraphical.admonition.properties; Callouts &calloutlist.properties; &callout.properties; &callout.defaultcolumn; &callout.graphics; &callout.graphics.extension; &callout.graphics.number.limit; &callout.graphics.path; &callout.icon.size; &callout.unicode; &callout.unicode.font; &callout.unicode.number.limit; &callout.unicode.start.character; &callouts.extension; ToC/LoT/Index Generation &autotoc.label.separator; &process.empty.source.toc; &process.source.toc; &generate.toc; &generate.index; &make.index.markup; &index.method; &index.on.type; &index.on.role; &index.preferred.page.properties; &index.entry.properties; &index.div.title.properties; &autolink.index.see; &index.number.separator; &index.range.separator; &index.term.separator; &xep.index.item.properties; &toc.section.depth; &toc.max.depth; &toc.indent.width; &toc.line.properties; &toc.leader.properties; &toc.margin.properties; &bridgehead.in.toc; &simplesect.in.toc; &generate.section.toc.level; Processor Extensions &arbortext.extensions; &axf.extensions; &fop.extensions; &fop1.extensions; &passivetex.extensions; &tex.math.in.alt; &tex.math.delims; &xep.extensions; Stylesheet Extensions &linenumbering.everyNth; &linenumbering.extension; &linenumbering.separator; &linenumbering.width; &tablecolumns.extension; &textinsert.extension; &textdata.default.encoding; &use.extensions; Automatic labelling &appendix.autolabel; &chapter.autolabel; &part.autolabel; &reference.autolabel; &preface.autolabel; §ion.autolabel; §ion.autolabel.max.depth; §ion.label.includes.component.label; &label.from.part; &component.label.includes.part.label; XSLT Processing &rootid; Meta/*Info &make.single.year.ranges; &make.year.ranges; &author.othername.in.middle; Reference Pages &funcsynopsis.decoration; &funcsynopsis.style; &function.parens; &refentry.generate.name; &refentry.generate.title; &refentry.pagebreak; &refentry.title.properties; &refentry.xref.manvolnum; &refclass.suppress; Tables &default.table.width; &nominal.table.width; &default.table.frame; &default.table.rules; &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; &table.caption.properties; Linking ¤t.docid; &activate.external.olinks; &collect.xref.targets; &insert.olink.page.number; &insert.olink.pdf.frag; &olink.base.uri; &olink.debug; &olink.doctitle; &olink.lang.fallback.sequence; &olink.properties; &prefer.internal.olink; &target.database.document; &targets.filename; &use.local.olink.style; Cross References &insert.xref.page.number; &insert.xref.page.number.para; &xref.properties; &xref.label-title.separator; &xref.label-page.separator; &xref.title-page.separator; &insert.link.page.number; Lists &compact.list.item.spacing; &itemizedlist.properties; &itemizedlist.label.properties; &itemizedlist.label.width; &list.block.properties; &list.block.spacing; &list.item.spacing; &mark.optional.procedure.steps; &orderedlist.properties; &orderedlist.label.properties; &orderedlist.label.width; &variablelist.max.termlength; &variablelist.term.separator; &variablelist.term.properties; &variablelist.term.break.after; QAndASet &qandadiv.autolabel; &qanda.inherit.numeration; &qanda.defaultlabel; &qanda.in.toc; &qanda.nested.in.toc; Bibliography &bibliography.style; &biblioentry.item.separator; &bibliography.collection; &bibliography.numbered; &biblioentry.properties; Glossary &glossterm.auto.link; &firstterm.only.link; &glossary.collection; &glossary.as.blocks; &glosslist.as.blocks; &glossentry.list.item.properties; &glossterm.block.properties; &glossdef.block.properties; &glossterm.list.properties; &glossdef.list.properties; &glossterm.width; &glossterm.separation; &glossentry.show.acronym; &glossary.sort; Miscellaneous &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.hyphenate; &ulink.hyphenate.chars; &shade.verbatim; &shade.verbatim.style; &hyphenate.verbatim; &hyphenate.verbatim.characters; &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; &footnote.properties; &table.footnote.properties; &footnote.mark.properties; &footnote.sep.leader.properties; &xref.with.number.and.title; &superscript.properties; &subscript.properties; &pgwide.properties; &highlight.source; &highlight.xslthl.config; &highlight.default.language; &email.delimiters.enabled; &email.mailto.enabled; §ion.container.element; &monospace.verbatim.font.width; &exsl.node.set.available; &show.bookmarks; &bookmarks.collapse; &xsl1.1.bookmarks; &generate.consistent.ids; &base.dir; &chunk.quietly; Graphics &graphic.default.extension; &default.image.width; &preferred.mediaobject.role; &use.role.for.mediaobject; &ignore.image.scaling; &img.src.path; &keep.relative.image.uris; Pagination and General Styles
Understanding XSL FO Margins To make sense of the parameters in this section, it's useful to consider .
Page Model 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 margin-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 margin-right.
&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; &force.blank.pages; &body.margin.bottom; &body.margin.top; &body.margin.inner; &body.margin.outer; &body.start.indent; &body.end.indent; &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; ®ion.inner.extent; ®ion.outer.extent; &default.units; &normal.para.spacing; ¶.properties; &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.table.properties; &header.table.height; &footer.table.properties; &footer.table.height; &header.content.properties; &footer.content.properties; &marker.section.level; &side.region.precedence; ®ion.inner.properties; ®ion.outer.properties; &inner.region.content.properties; &outer.region.content.properties;
Font Families &body.font.family; &dingbat.font.family; &monospace.font.family; &sans.font.family; &title.font.family; &symbol.font.family; Property Sets &formal.object.properties; &formal.title.properties; &informal.object.properties; &monospace.properties; &verbatim.properties; &monospace.verbatim.properties; &sidebar.properties; &sidebar.title.properties; &sidebar.float.type; &sidebar.float.width; &margin.note.properties; &margin.note.title.properties; &margin.note.float.type; &margin.note.width; &component.title.properties; &component.titlepage.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; &equation.number.properties; &table.properties; &task.properties; &informalfigure.properties; &informalexample.properties; &informalequation.properties; &informaltable.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; &abstract.properties; &abstract.title.properties; &index.page.number.properties; &revhistory.table.properties; &revhistory.table.cell.properties; &revhistory.title.properties; Profiling The following parameters can be used for attribute-based profiling of your document. For more information about profiling, see Profiling (conditional text). &profile.arch; &profile.audience; &profile.condition; &profile.conformance; &profile.lang; &profile.os; &profile.outputformat; &profile.revision; &profile.revisionflag; &profile.role; &profile.security; &profile.status; &profile.userlevel; &profile.vendor; &profile.wordsize; &profile.attribute; &profile.value; &profile.separator; Localization &l10n.gentext.language; &l10n.gentext.default.language; &l10n.gentext.use.xref.language; &l10n.lang.value.rfc.compliant; &writing.mode; EBNF &ebnf.assignment; &ebnf.statement.terminator; Prepress &crop.marks; &crop.mark.width; &crop.mark.offset; &crop.mark.bleed; DocBook Publishers &publishers.properties; &dialogue.properties; &drama.properties; &poetry.properties; &line.properties; &linegroup.properties; &speaker.properties; &stagedir.properties; &inlinestagedir.properties; The Stylesheet The param.xsl stylesheet is just a wrapper around all these parameters.