docbook2X Man-pages Stylesheets Reference

Guide to the stylesheet reference

For the most part, this reference assumes knowledge of XSLT. But if you are not familiar with XSLT, you can still look at the page of stylesheet parameters; they are the commonly used options to the stylesheets that may be directly set from the command line. Also take a look at the introductory text to each XSL file, which gives some general advice to tweaking the output of the stylesheets.

In the lists of stylesheet items, the following symbols are prefixed before each item to indicate their type:

[P]

A global parameter.

The synopsis for the parameter shows its default value.

[V]

A global variable.

[M]

A template mode.

[T]

A named template.

[t mode]

A template with a match attribute, for the given mode. If mode is omitted, that means the default mode.

These usually have no description; they are just listed so that you know the template exists.

Table of Contents

I. common/l10n
[P] localization-file - (URI of) XML document containing localization data
[V] l10n-data - XML element node containing localization-data
[P] default-document-language - Assumed language of the input document when it is not specified in the source
[T] l10n-match-language - Determine the language to translate to
[T] l10n-xml-language - Determine the language of the given XML fragment
[T] l10n-xml-actual-language - Undocumented
[M] l10n-substitution - Output localized text, substituting parameters if necessary
[t l10n-substitution] text() -
II. common/messages
[P] message-language - Undocumented
[T] l10n-message-choose-language - Undocumented
[t l10n-substitution] l:a1 -
[t l10n-substitution] l:a2 -
[t l10n-substitution] l:a3 -
[t l10n-substitution] l:a4 -
[t l10n-substitution] l:a5 -
[T] user-message - Emit a user message
[T] print-node-line-number - Display file name and line number of a node
[T] print-node-xpath - Display the path of a node
[t print-node-xpath] text() -
[t print-node-xpath] @* -
[t print-node-xpath] *[@id != ''] -
[t print-node-xpath] * -
[t print-node-xpath] / -
III. common/titles
[M] for-title - Provides access to element titles
[t title] title -
[t title] * -
[t title] text() -
[t for-title] set -
[t for-title] * -
[t for-title] book -
[t for-title] part -
[t for-title] preface|chapter|appendix -
[t for-title] partintro -
[t for-title] dedication -
[t for-title] colophon -
[t for-title] article -
[t for-title] reference -
[t for-title] refentry -
[t for-title] refsynopsisdiv -
[t for-title] section |sect1|sect2|sect3|sect4|sect5 |refsect1|refsect2|refsect3 |simplesect -
[t for-title] bibliography -
[t for-title] glossary -
[t for-title] index -
[t for-title] figure|table|example|equation -
[t for-title] qandaset|qandadiv -
[t for-title] abstract -
[t for-title] caution|tip|warning|important|note -
[t no-anchors] * -
[t no-anchors] footnote -
[t no-anchors] anchor -
[t no-anchors] ulink -
[t no-anchors] link -
[t no-anchors] olink -
[t no-anchors] indexterm -
[t no-anchors] xref -
IV. param
[P] user-message-prefix - Undocumented
[P] uppercase-headings - Make headings uppercase?
[P] manvolnum-cite-numeral-only - Man page section citation should use only the number
[P] quotes-on-literals - Display quotes on literal elements?
[P] show-comments - Display comment elements?
[P] function-parens - Generate parentheses after a function?
[P] xref-on-link - Should link generate a cross-reference?
[P] header-3 - Third header text
[P] header-4 - Fourth header text
[P] header-5 - Fifth header text
[P] default-manpage-section - Default man page section
[P] custom-localization-file - URI of XML document containing custom localization data
[P] custom-l10n-data - XML document containing custom localization data
[P] author-othername-in-middle - Is othername in author a middle name?
V. manpage
[T] manpage - Undocumented
VI. refentry
[t] reference -
[t] refentry -
[t header-text] * -
[t header-text] text() -
[t] refmeta -
[t] refentrytitle -
[t] manvolnum -
[t] refmiscinfo -
[t] refnamediv -
[t] refname -
[t] refpurpose -
[t] refdescriptor -
[t] refclass -
[t] refsynopsisdiv -
[t] refsection -
[t] refsect1 -
[t] refsect2 -
[T] uppercase-title - Undocumented
VII. sectioning
[T] SS-section - Undocumented
[T] SH-section - Undocumented
VIII. sections
[t] sect1|sect2|sect3|sect4|sect5|simplesect|section -
[t] title -
[t] titleabbrev -
[t] subtitle -
IX. admon
[T] admonition-title - Undocumented
[t] note|important|warning|caution|tip -
X. block
[T] block-object - Undocumented
[T] indented.block-object - Undocumented
[t] para|simpara -
[t] formalpara -
[t] formalpara/title -
[t] formalpara/para -
[t] blockquote -
[t] blockquote/title -
[t] attribution -
[t blockquote-attribution] attribution -
[t] epigraph -
[t] sidebar -
[t] abstract -
[t] msgset -
[t] msgentry -
[t] simplemsgentry -
[t] msg -
[t] msgmain -
[t] msgmain/title -
[t] msgsub -
[t] msgsub/title -
[t] msgrel -
[t] msgrel/title -
[t] msgtext -
[t] msginfo -
[t] msglevel|msgorig|msgaud -
[t] msgexplan -
[t] msgexplan/title -
[t] revhistory -
[t] revhistory/revision -
[t] revision/revnumber -
[t] revision/date -
[t] revision/authorinitials -
[t] revision/authorinitials[1] -
[t] revision/revremark -
[t] revision/revdescription -
[t] ackno -
XI. caption
[T] make-caption - Render as a ‘caption’
XII. formal
[T] formal-object - Undocumented
[T] formal-object-title - Undocumented
[T] informal-object - Undocumented
[T] semiformal-object - Undocumented
[t] figure|example -
[t] equation -
[t] informalfigure -
[t] informalexample -
[t] informalequation -
XIII. synop
[t] synopsis -
[t] cmdsynopsis -
[t cmdsynopsis] * -
[t cmdsynopsis] sbr -
[t cmdsynopsis] synopfragmentref -
[t synopfragment.number] synopfragment -
[t cmdsynopsis] synopfragment -
[t cmdsynopsis] command|option -
[t cmdsynopsis] replaceable -
[t cmdsynopsis] group|arg -
[t cmdsynopsis] group/* -
[t cmdsynopsis] group/group -
[t cmdsynopsis] group/option -
[t cmdsynopsis] group/arg -
[t] funcsynopsis -
[t funcsynopsis] * -
[t funcsynopsis] funcsynopsisinfo -
[T] funcprototype - Undocumented
[t funcsynopsis] modifier -
[t funcsynopsis] funcdef -
[t funcsynopsis] function -
[t funcsynopsis] void -
[t funcsynopsis] varargs -
[t funcsynopsis] paramdef -
[t funcsynopsis] paramdef/parameter -
[t funcsynopsis] funcparams -
XIV. table
[t] table -
[t] informaltable -
[t] tgroup -
[t] colspec|spanspec -
[t] thead|tbody|tfoot -
[t] row|entry -
[t] entrytbl[@cols='2'] -
[t entrytbl] thead -
[t entrytbl] tbody -
[t entrytbl] tfoot -
[t entrytbl-head] row -
[t entrytbl-body] row -
[T] copy-through - Undocumented
[t copy] @* -
XV. verbatim
[t] literallayout -
[t] programlisting|screen -
[t] address -
XVI. inline
[T] inline-plain - Undocumented
[T] inline-monospace - Undocumented
[T] inline-bold-monospace - Undocumented
[T] inline-italic-monospace - Undocumented
[T] inline-bold - Undocumented
[T] inline-italic - Undocumented
[T] inline-roman - Undocumented
[T] inline-superscript - Undocumented
[T] inline-subscript - Undocumented
[t] author -
[t] editor -
[t] othercredit -
[t] authorinitials -
[t] accel -
[t] action -
[t] application -
[t] classname -
[t] exceptionname -
[t] interfacename -
[t] methodname -
[t] command -
[t] computeroutput -
[t] constant -
[t] database -
[t] errorcode -
[t] errorname -
[t] errortype -
[t] errortext -
[t] envar -
[t] filename -
[t] refentrytitle/function -
[t] function -
[t] guibutton|guiicon|guilabel|guimenu|guimenuitem|guisubmenu -
[t] hardware -
[t] interface -
[t] interfacedefinition -
[t] keycap -
[t] keycode -
[t] keysym -
[T] inline-quoted - Undocumented
[T] inline-quoted-monospace - Undocumented
[t] literal -
[t] medialabel -
[t] shortcut -
[t] mousebutton -
[t] option -
[t] parameter -
[t] property -
[t] prompt -
[t] replaceable -
[t] returnvalue -
[t] structfield -
[t] structname -
[t] symbol -
[t] systemitem -
[t] token -
[t] type -
[t] userinput -
[t] abbrev -
[t] acronym -
[t] citerefentry -
[t] citetitle -
[t] emphasis[@role='strong' or @role='bold' or parent::emphasis] -
[t] emphasis -
[t] foreignphrase -
[t] markup -
[t] phrase -
[t] quote -
[t] varname -
[t] wordasword -
[t] lineannotation -
[t] superscript -
[t] subscript -
[t] trademark -
[t] firstterm -
[t] glossterm -
[t] sgmltag -
[T] format-sgmltag - Undocumented
[t] email -
[t] keycombo -
[t] menuchoice -
[T] format-menuchoice - Undocumented
[t] optional -
[t] citation -
[t] comment|remark -
[t] productname|productnumber -
[t] pob|street|city|state|postcode|country|phone|fax|otheraddr -
[t] firstname|surname|lineage|othername|honorific -
XVII. xref
[t] anchor -
[t] xref -
[t] link -
[t] ulink -
[M] xref-to - Give cross-reference markup
[t xref-to] * -
XVIII. glossary
[t] glossary[glossentry[1]/preceding-sibling::*] -
[t] glossary -
[t] glosslist -
[t] glossdiv -
[t] glossentry -
[t] glossentry/glossterm -
[t] glossentry/acronym -
[t] glossentry/abbrev -
[t] glossentry/revhistory -
[t] glossentry/glossdef -
[t] glossentry/glosssee|glossseealso -
[t glosssee.xref] glossentry -
[t glosssee.xref] glossentry/glossterm[1] -
[t glosssee.xref] * -
XIX. lists
[T] list.block - Undocumented
[t] itemizedlist -
[t] itemizedlist/listitem -
[t] orderedlist -
[t] orderedlist/listitem -
[t] variablelist -
[t] varlistentry -
[t] term[1] -
[t] term -
[t] varlistentry/listitem -
[t] simplelist -
[t] member -
[t] member[1] -
[t] simplelist[@type='inline'] -
[t] simplelist[@type='inline']/member -
[t] simplelist[@type='inline']/member[1] -
XX. index
[t] index -
[t] indexdiv -
[t] indexterm -
[t] primary -
[t] secondary|tertiary -
[t] see|seealso -
[t] indexentry -
[t] primaryie|secondaryie|tertiaryie|seeie|seealsoie -
XXI. info
[t] corpauthor -
[t] jobtitle -
[t] orgname -
[t] orgdiv -
[t] docinfo|prefaceinfo|chapterinfo|appendixinfo|articleinfo|artheader|glossaryinfo -
[t] bookinfo|setinfo|seriesinfo -
[t] referenceinfo|refentryinfo|refsect1info|refsect2info|refsect3info|refsynopsisdivinfo -
[t] sect1info|sect2info|sect3info|sect4info|sect5info|sectioninfo -
[t] objectinfo -
XXII. keywords
[t] keywordset -
[t] subjectset -
XXIII. toc
[t toc] * -
[t] toc -
[t] tocpart|tocchap|tocfront|tocback|tocentry -
[t] toclevel1|toclevel2|toclevel3|toclevel4|toclevel5 -
[t] lot|lotentry -
XXIV. beginpage
XXV. pi
[t] processing-instruction() -