I. Parameter reference
Table of Contents
- $additional-languages — Additional localization languages (beyond the default language)
- $align-char-default, $align-char-pad, $align-char-width — Support “char” alignment on CALS table cells
- $allow-eval — Process the
eval
processing instruction? - $annotate-toc — Annotate the table-of-contents?
- $annotation-collection — An external collection of annotations
- $annotation-mark — Identifying mark for annotations
- $annotation-placement — Determines where the annotation mark is placed
- $annotation-style — Selects the annotation style
- $annotations-js — Script to support popup (JavaScript) annotations
- $auto-toc — Automatically generate tables of contents
- $bibliography-collection — An external collection of bibliography entries
- $bibliography-style — The bibliography style
- $books-inherit-from — Identifies what inherited numeration applies to books
- $books-number-from — Identifies where book numeration begins
- $callout-default-column — Default column for callouts
- $callout-unicode-start — Initial callout character
- $chunk — Produce chunked output?
- $chunk-exclude — XPath expressions for excluding chunks
- $chunk-include — XPath expressions for identifying potential chunks
- $chunk-nav — Add keyboard navigation to chunks?
- $chunk-nav-js — Script to support keyboard navigation
- $chunk-output-base-uri — Output base URI for chunks
- $chunk-renumber-footnotes — Renumber footnotes when chunking?
- $chunk-section-depth — Returns the chunking depth for recursive sections
- $classsynopsis-indent — Indent for
classsynopsis
members - $component-numbers — Are components numbered?
- $component-numbers-inherit — Include component labels in section labels?
- $components-inherit-from — Identifies what inherited numeration applies to components
- $components-number-from — Identifies where component numeration begins
- $control-js — Script to support theme selection
- $copy-verbatim-js — Script to support dynamic copy button on verbatim listings
- $copyright-collapse-years — Collapse sequential copyright years into a range?
- $copyright-year-range-separator — Separator character for copyright year ranges
- $copyright-year-separator — Separator character for copyright years
- $date-date-format, $date-dateTime-format — Format strings for dates and dateTimes
- $dc-metadata — Output Dublin Core metadata?
- $debug — Debugging flags
- $default-float-style — Default float style
- $default-language — Default language
- $default-length-magnitude, $default-length-unit — The magnitude and units of the default length
- $default-theme — Default theme
- $division-numbers — Are divisions numbered?
- $division-numbers-inherit — Include division labels in component labels?
- $divisions-inherit-from — Identifies what inherited numeration applies to divisions
- $divisions-number-from — Identifies where division numeration begins
- $docbook-transclusion — Enable DocBook transclusion processing
- $dynamic-profile-error — How are errors in dynamic profiling handled?
- $dynamic-profile-variables — Dynamic profiling variables
- $dynamic-profiles — Is dynamic profiling enabled?
- $experimental-pmuj — Insert reverse links
- $fallback-js — Script to support audio/video fallback
- $footnote-numeration — How are footnotes numbered?
- $formal-object-title-placement — Specify placement of title on formal elements
- $formal-objects-inherit-from — Identifies what inherited numeration applies to formal-objects
- $formal-objects-number-from — Identifies where formal-object numeration begins
- $formalgroup-nested-object-title-placement — Specify placement of title on formal elements inside
formalgroup
- $funcsynopsis-default-style — Default style for function synopses
- $funcsynopsis-table-threshold — Maximium width of a function synopsis
- $funcsynopsis-trailing-punctuation — Trailing punctuation in function synopses
- $generate-html-page — Generate the HTML page structure around the styled document
- $generate-index — Automatically generate an index?
- $generate-nested-toc — Determines if subsubections appear in the table of contents
- $generate-toc — Generate a table-of-contents?
- $generate-trivial-toc — Generate a trivial table-of-contents?
- $generated-id-root — The string generated as the unique identifier for the root of the tree
- $generated-id-sep — The string generated to separate parts of a unique identifier
- $generator-metadata — Output generator metadata?
- $gentext-language — Specifies language for generated text
- $glossary-automatic-divisions — Divide glossaries into sections?
- $glossary-collection — An external collection of glossary entries
- $glossary-sort-entries — Sort glossaries?
- $html-extension — The extension used for HTML output when chunking
- $image-ignore-scaling — Ignore scaling?
- $image-nominal-height — Nominal height of an image
- $image-nominal-width — Nominal width of an image
- $image-property-warning — Warn if image properties cannot be obtained?
- $index-on-role, $index-on-type — Make distinct indexes based on role and type?
- $index-show-entries — Make index entries visible in the text?
- $indexed-section-groups — Generate index entries grouped by section
- $inline-xlink-href — Output href values after links?
- $lists-of-equations — Generate a list of equations?
- $lists-of-examples — Generate a list of examples?
- $lists-of-figures — Generate a list of figures?
- $lists-of-procedures — Generate a list of figures?
- $lists-of-tables — Generate a list of tables?
- $local-conventions — Transformation for local conventions
- $mathml-js — JavaScript library supporting MathML
- $mediaobject-accessibility — Accessibility settings for media objects
- $mediaobject-details-placement — Specify placement of details on media objects
- $mediaobject-exclude-extensions — Exclude media objects by extension
- $mediaobject-grouped-by-type — Are media grouped by type?
- $mediaobject-input-base-uri — Base URI of images and other media in the XML sources
- $mediaobject-output-base-uri — Base URI of images and other media in the output
- $mediaobject-output-paths — Preserve input mediaobject paths in output
- $mediaobject-video-element — Use the video element?
- $message-level — How chatty should status messages be?
- $nominal-page-width — The nominal page width
- $number-single-appendix — Number a single appendix?
- $olink-databases — External olink databases
- $orderedlist-item-numeration — Numeration for nested ordered lists
- $othername-in-middle — Treat othername as a middle name
- $output-media — The intended output media
- $oxy-markup — Is Oxygen change tracking markup rendered?
- $page-style — Select the page style
- $pagetoc-dynamic — Make the on-page ToC dynamic?
- $pagetoc-elements — Elements that should have an on-page ToC
- $pagetoc-js — Script to support the on-page ToC
- $paper-size — Select the paper style
- $persistent-toc — Generate a persistent Table of Contents?
- $persistent-toc-css — Persistent ToC CSS
- $persistent-toc-filename — Name of file that holds the persistent ToC
- $persistent-toc-js — Script to support the persistent ToC
- $persistent-toc-search — Generate a search box in the persistent ToC
- $personal-name-style — The style for formatting personal names
- $pixels-per-inch — The number of pixels per inch
- $presentation-css — CSS to support presentation mode
- $presentation-js — Script to support presentation mode
- $presentation-mode — Format the output for use as a presentation?
- $procedure-step-numeration — Numeration for nested procedure steps
- $productionset-lhs-rhs-separator — Separator in productions
- $profile-arch — Profile tokens for “arch”
- $profile-audience — Profile tokens for “audience”
- $profile-condition — Profile tokens for “condition”
- $profile-conformance — Profile tokens for “conformance”
- $profile-lang — Profile tokens for “xml:lang”
- $profile-os — Profile tokens for “os”
- $profile-outputformat — Profile tokens for “outputformat”
- $profile-revision — Profile tokens for “revision”
- $profile-revisionflag — Profile tokens for “revisionflag”
- $profile-role — Profile tokens for “role”
- $profile-security — Profile tokens for “security”
- $profile-separator — The profile separator character
- $profile-userlevel — Profile tokens for “userlevel”
- $profile-vendor — Profile tokens for “vendor”
- $profile-wordsize — Profile tokens for “wordsize”
- $qandadiv-default-toc — Generate a table-of-contents for
qandadiv
elements? - $qandaset-default-label — The default label for
qandaset
elements - $qandaset-default-toc — Generate a table-of-contents for
qandaset
elements? - $refentry-generate-name — Use “Name” as the title of a
refentry
- $refentry-generate-title — Use the subject of the page as the title of a
refentry
- $relax-ng-grammar — Validation grammar
- $resource-base-uri — Base URI of additional resources
- $revhistory-style — Rendering style for
revhistory
elements. - $section-numbers — Are sections numbered?
- $section-numbers-inherit — Include ancestor section labels?
- $section-toc-depth — Depth of sections in the table of contents
- $sections-inherit-from — Identifies what inherited numeration applies to sections
- $sections-number-from — Identifies where (top-level) section numeration begins
- $segmentedlist-style — Choose segmented list presentation style
- $sets-inherit-from — Identifies what inherited numeration applies to sets
- $sets-number-from — Identifies where set numeration begins
- $show-remarks — Show
remark
elements? - $sidebar-as-aside — Render
sidebar
as anaside
? - $sort-collation — Sorting collation
- $table-accessibility — Accessibility settings for tables
- $table-footnote-numeration — How are footnotes numbered in tables?
- $theme-picker — Allow users to select themes?
- $titleabbrev-passthrough — Pass
titleabbrev
elements through to the HTML - $transclusion-id-fixup — Transclusion ID fixup
- $transclusion-link-scope — Transclusion link scope
- $transclusion-prefix-separator — Transclusion separator
- $transclusion-suffix — Transclusion suffix
- $transform-after — Transform the process document
- $transform-before — Transform the preprocessed document
- $transform-original — Transform the original document
- $transformed-docbook-input — URI for transformed DocBook input
- $transformed-docbook-output — URI for transformed DocBook output
- $translate-suppress-elements — Elements in which translation is suppressed
- $unwrap-paragraphs — Attempt to unwrap paragraphs that contain block elements?
- $use-docbook-css — Create links to standard DocBook CSS stylesheets?
- $use-id-as-filename — Use id as filename when chunking
- $use-minified-css — Create links to minified CSS?
- $user-css-links — A list of user-defined CSS stylesheets
- $variablelist-panelset — Enable the “panelset” rendering for variable lists?
- $variablelist-termlength-threshold — Threshold value for considering
varlistentry
terms “long” - $varlistentry-separate-terms — Output separate terms for variable list entries?
- $vendor-css — Additional, vendor specific CSS
- $verbatim-callouts — A list determining how callouts are processed
- $verbatim-default-language — Default language for
programlisting
verbatim environments - $verbatim-embellish-linenumbers — Attempt to add line numbers to verbatim environments?
- $verbatim-embellishments — Attempt to embellish verbatim environments?
- $verbatim-line-style — List of verbatim elements to be rendered in the line style
- $verbatim-number-every-nth — Line numbering frequency
- $verbatim-number-first-line — Number the first line?
- $verbatim-number-minlines — Shortest listing to number
- $verbatim-number-separator — Separator between line numbers and lines
- $verbatim-numbered-elements — Verbatim environments that should be numbered
- $verbatim-plain-style — List of verbatim elements to be rendered in the plain style
- $verbatim-space — The space character to use when padding verbatim lines
- $verbatim-style-default — The default verbatim style
- $verbatim-syntax-highlight-css — Stylesheet for syntax highlighting
- $verbatim-syntax-highlight-languages — Languages for which syntax highlighting should be performed
- $verbatim-syntax-highlighter — Selects the syntax highlighter
- $verbatim-table-style — List of verbatim elements to be rendered in the table style
- $verbatim-trim-leading-blank-lines — Trim leading blank lines off of verbatim environments?
- $verbatim-trim-trailing-blank-lines — Trim trailing blank lines off of verbatim environments?
- $warn-about-missing-localizations — Warn about missing localization?
- $xlink-arclist-after — Suffix used for inline rendering of a list of XLink arcs
- $xlink-arclist-before — Prefix used for inline rendering of a list of XLink arcs
- $xlink-arclist-sep — Link separator used when rendering a list of XLink arcs
- $xlink-arclist-titlesep — Title separator used when rendering a list of XLink arcs
- $xlink-icon-closed — Icon indicating hidden XLink links
- $xlink-icon-open — XLink CSS
- $xlink-js — Script to support extended XLinks
- $xlink-style — Presentation style for XLink extended links
- $xlink-style-default — Default XLink style
- $xspec — Are we running XSpec tests?