Part 1. HTML Parameter Reference

Table of Contents

1.1. Admonitions

admon.graphics.extension — Filename extension for admonition graphics

admon.graphics.path — Path to admonition graphics

admon.graphics — Use graphics in admonitions?

admon.textlabel — Use text label in admonitions?

admon.style — Specifies the CSS style attribute that should be added to admonitions.

1.2. Callouts

callout.defaultcolumn — Indicates what column callouts appear in by default

callout.graphics.extension — Filename extension for callout graphics

callout.graphics.number.limit — Number of the largest callout graphic

callout.graphics.path — Path to callout graphics

callout.graphics — Use graphics for callouts?

callout.list.table — Present callout lists using a table?

callout.unicode.number.limit — Number of the largest unicode callout character

callout.unicode.start.character — First Unicode character to use, decimal value.

callout.unicode — Use Unicode characters rather than images for callouts.

callouts.extension — Enable the callout extension

1.3. EBNF

ebnf.table.bgcolor — Background color for EBNF tables

ebnf.table.border — Selects border on EBNF tables

ebnf.assignment — The EBNF production assignment operator

ebnf.statement.terminator — Punctuation that ends an EBNF statement.

1.4. ToC/LoT/Index Generation

annotate.toc — Annotate the Table of Contents?

autotoc.label.separator — Separator between labels and titles in the ToC

autotoc.label.in.hyperlink — Include label in hyperlinked titles in TOC?

process.source.toc — Process a non-empty toc element if it occurs in a source document?

process.empty.source.toc — Generate automated TOC if toc element occurs in a source document?

bridgehead.in.toc — Should bridgehead elements appear in the TOC?

simplesect.in.toc — Should simplesect elements appear in the TOC?

manual.toc — An explicit TOC to be used for the TOC

toc.list.type — Type of HTML list element to use for Tables of Contents

toc.section.depth — How deep should recursive sections appear in the TOC?

toc.max.depth — How many levels should be created for each TOC?

generate.toc — Control generation of ToCs and LoTs

generate.section.toc.level — Control depth of TOC generation in sections

generate.index — Do you want an index?

index.method — Select method used to group index entries in an index

index.on.type — Select indexterms based on type attribute value

index.on.role — Select indexterms based on role value

index.links.to.section — HTML index entries link to container section title

index.prefer.titleabbrev — Should abbreviated titles be used as back references?

autolink.index.see — Link index see and seealso to index primary

index.term.separator — Override for punctuation separating an index term from its list of page references in an index

index.number.separator — Override for punctuation separating page numbers in index

index.range.separator — Override for punctuation separating the two numbers in a page range in index

1.5. Stylesheet Extensions

linenumbering.everyNth — Indicate which lines should be numbered

linenumbering.extension — Enable the line numbering extension

linenumbering.separator — Specify a separator between line numbers and lines

linenumbering.width — Indicates the width of line numbers

tablecolumns.extension — Enable the table columns extension function

textinsert.extension — Enables the textinsert extension element

textdata.default.encoding — Default encoding of external text files which are included using textdata element

graphicsize.extension — Enable the getWidth()/getDepth() extension functions

graphicsize.use.img.src.path — Prepend img.src.path before filenames passed to extension functions

use.extensions — Enable extensions

1.6. Automatic labelling

chapter.autolabel — Specifies the labeling format for Chapter titles

appendix.autolabel — Specifies the labeling format for Appendix titles

part.autolabel — Specifies the labeling format for Part titles

reference.autolabel — Specifies the labeling format for Reference titles

preface.autolabel — Specifices the labeling format for Preface titles

qandadiv.autolabel — Are divisions in QAndASets enumerated?

section.autolabel — Are sections enumerated?

section.autolabel.max.depth — The deepest level of sections that are numbered.

section.label.includes.component.label — Do section labels include the component label?

label.from.part — Renumber components in each part?

component.label.includes.part.label — Do component labels include the part label?

1.7. HTML

html.base — An HTML base URI

html.stylesheet — Name of the stylesheet(s) to use in the generated HTML

html.stylesheet.type — The type of the stylesheet used in the generated HTML

css.decoration — Enable CSS decoration of elements

html.script — Name of the script(s) to use in the generated HTML

html.script.type — The type of script used in the generated HTML

spacing.paras — Insert additional <p> elements for spacing?

emphasis.propagates.style — Pass emphasis role attribute through to HTML?

para.propagates.style — Pass para role attribute through to HTML?

phrase.propagates.style — Pass phrase role attribute through to HTML?

entry.propagates.style — Pass entry role attribute through to HTML?

html.longdesc — Should longdesc URIs be created?

html.longdesc.link — Should a link to the longdesc be included in the HTML?

make.valid.html — Attempt to make sure the HTML output is valid HTML

html.cleanup — Attempt to clean up the resulting HTML?

html.append — Specifies content to append to HTML output

draft.mode — Select draft mode

draft.watermark.image — The URI of the image to be used for draft watermarks

generate.id.attributes — Generate ID attributes on container elements?

generate.consistent.ids — Generate consistent id values if document is unchanged

generate.meta.abstract — Generate HTML META element from abstract?

make.clean.html — Make HTML conform to modern coding standards

docbook.css.source — Name of the default CSS input file

docbook.css.link — Insert a link referencing the default CSS stylesheet

custom.css.source — Name of a custom CSS input file

generate.css.header — Insert generated CSS styles in HEAD element

1.8. XSLT Processing

rootid — Specify the root element to format

suppress.navigation — Disable header and footer navigation

suppress.header.navigation — Disable header navigation

suppress.footer.navigation — Disable footer navigation

header.rule — Rule under headers?

footer.rule — Rule over footers?

id.warnings — Should warnings be generated for titled elements without IDs?

1.9. Meta/*Info and Titlepages

inherit.keywords — Inherit keywords from ancestor elements?

make.single.year.ranges — Print single-year ranges (e.g., 1998-1999)

make.year.ranges — Collate copyright years into ranges?

author.othername.in.middle — Is othername in author a middle name?

blurb.on.titlepage.enabled — Display personblurb and authorblurb on title pages?

contrib.inline.enabled — Display contrib output inline?

editedby.enabled — Display “Edited by” heading above editor name?

abstract.notitle.enabled — Suppress display of abstract titles?

othercredit.like.author.enabled — Display othercredit in same style as author?

generate.legalnotice.link — Write legalnotice to separate chunk and generate link?

generate.revhistory.link — Write revhistory to separate chunk and generate link?

html.head.legalnotice.link.types — Specifies link types for legalnotice link in html head

html.head.legalnotice.link.multiple — Generate multiple link instances in html head for legalnotice?

copy.rdfa.attributes — Copy RDFA attributes to HTML output

1.10. Reference Pages

funcsynopsis.decoration — Decorate elements of a funcsynopsis?

funcsynopsis.style — What style of funcsynopsis should be generated?

function.parens — Generate parens after a function?

refentry.generate.name — Output NAME header before refnames?

refentry.generate.title — Output title before refnames?

refentry.xref.manvolnum — Output manvolnum as part of refentry cross-reference?

citerefentry.link — Generate URL links when cross-referencing RefEntrys?

refentry.separator — Generate a separator between consecutive RefEntry elements?

refclass.suppress — Suppress display of refclass contents?

1.11. Tables

default.table.width — The default width of tables

nominal.table.width — The (absolute) nominal width of tables

table.borders.with.css — Use CSS to specify table, row, and cell borders?

table.cell.border.style — Specifies the border style of table cells

table.cell.border.thickness — Specifies the thickness of table cell borders

table.cell.border.color — Specifies the border color of table cells

table.frame.border.style — Specifies the border style of table frames

table.frame.border.thickness — Specifies the thickness of the frame border

table.frame.border.color — Specifies the border color of table frames

default.table.frame — The default framing of tables

html.cellspacing — Default value for cellspacing in HTML tables

html.cellpadding — Default value for cellpadding in HTML tables

1.12. QAndASet

qanda.defaultlabel — Sets the default for defaultlabel on QandASet.

qanda.inherit.numeration — Does enumeration of QandASet components inherit the numeration of parent elements?

qanda.in.toc — Should qandaentry questions appear in the document table of contents?

qanda.nested.in.toc — Should nested answer/qandaentry instances appear in TOC?

1.13. Linking

target.database.document — Name of master database file for resolving olinks

targets.filename — Name of cross reference targets data file

olink.base.uri — Base URI used in olink hrefs

use.local.olink.style — Process olinks using xref style of current document

current.docid — targetdoc identifier for the document being processed

olink.doctitle — show the document title for external olinks?

activate.external.olinks — Make external olinks into active links

olink.debug — Turn on debugging messages for olinks

olink.properties — Properties associated with the cross-reference text of an olink.

olink.lang.fallback.sequence — look up translated documents if olink not found?

insert.olink.page.number — Turns page numbers in olinks on and off

insert.olink.pdf.frag — Add fragment identifiers for links into PDF files

prefer.internal.olink — Prefer a local olink reference to an external reference

link.mailto.url — Mailto URL for the LINK REL=made HTML HEAD element

ulink.target — The HTML anchor target for ULinks

1.14. Cross References

collect.xref.targets — Controls whether cross reference data is collected

insert.xref.page.number — Turns page numbers in xrefs on and off

insert.xref.page.number.para — Turns page numbers in xrefs to paragraphs on and off

use.role.as.xrefstyle — Use role attribute for xrefstyle on xref?

xref.with.number.and.title — Use number and title in cross references

xref.label-page.separator — Punctuation or space separating label from page number in xref

xref.label-title.separator — Punctuation or space separating label from title in xref

xref.title-page.separator — Punctuation or space separating title from page number in xref

1.15. Lists

segmentedlist.as.table — Format segmented lists as tables?

variablelist.as.table — Format variablelists as tables?

variablelist.term.separator — Text to separate terms within a multi-term varlistentry

variablelist.term.break.after — Generate line break after each term within a multi-term varlistentry?

1.16. Bibliography

bibliography.style — Style used for formatting of biblioentries.

biblioentry.item.separator — Text to separate bibliography entries

bibliography.collection — Name of the bibliography collection file

bibliography.numbered — Should bibliography entries be numbered?

1.17. Glossary

glossterm.auto.link — Generate links from glossterm to glossentry automatically?

firstterm.only.link — Does automatic glossterm linking only apply to firstterms?

glossary.collection — Name of the glossary collection file

glossary.sort — Sort glossentry elements?

glossentry.show.acronym — Display glossentry acronyms?

1.18. Miscellaneous

formal.procedures — Selects formal or informal procedures

formal.title.placement — Specifies where formal object titles should occur

runinhead.default.title.end.punct — Default punctuation character on a run-in-head

runinhead.title.end.punct — Characters that count as punctuation on a run-in-head

show.comments — Display remark elements?

show.revisionflag — Enable decoration of elements that have a revisionflag

shade.verbatim — Should verbatim environments be shaded?

shade.verbatim.style — Properties that specify the style of shaded verbatim listings

punct.honorific — Punctuation after an honorific in a personal name.

tex.math.in.alt — TeX notation used for equations

tex.math.file — Name of temporary file for generating images from equations

tex.math.delims — Should equations output for processing by TeX be surrounded by math mode delimiters?

pixels.per.inch — How many pixels are there per inch?

points.per.em — Specify the nominal size of an em-space in points

use.svg — Allow SVG in the result tree?

menuchoice.separator — Separator between items of a menuchoice other than guimenuitem and guisubmenu

menuchoice.menu.separator — Separator between items of a menuchoice with guimenuitem or guisubmenu

default.float.class — Specifies the default float class

footnote.number.format — Identifies the format used for footnote numbers

table.footnote.number.format — Identifies the format used for footnote numbers in tables

footnote.number.symbols — Special characters to use as footnote markers

table.footnote.number.symbols — Special characters to use a footnote markers in tables

highlight.source — Should the content of programlisting be syntactically highlighted?

highlight.xslthl.config — Location of XSLTHL configuration file

highlight.default.language — Default language of programlisting

email.delimiters.enabled — Generate delimiters around email addresses?

exsl.node.set.available — Is the test function-available('exsl:node-set') true?

1.19. Annotations

annotation.support — Enable annotations?

annotation.js — URIs identifying JavaScript files with support for annotation popups

annotation.css — CSS rules for annotations

annotation.graphic.open — Image for identifying a link that opens an annotation popup

annotation.graphic.close — Image for identifying a link that closes an annotation popup

1.20. Graphics

img.src.path — Path to HTML/FO image files

keep.relative.image.uris — Should image URIs be resolved against xml:base?

graphic.default.extension — Default extension for graphic filenames

default.image.width — The default width of images

nominal.image.width — The nominal image width

nominal.image.depth — Nominal image depth

use.embed.for.svg — Use HTML embed for SVG?

make.graphic.viewport — Use tables in HTML to make viewports for graphics

preferred.mediaobject.role — Select which mediaobject to use based on this value of an object's role attribute.

link.to.self.for.mediaobject — Include a element to image objects itself to go to a full-size, freely-zoomable version

use.role.for.mediaobject — Use role attribute value for selecting which of several objects within a mediaobject to use.

ignore.image.scaling — Tell the stylesheets to ignore the author's image scaling attributes

1.21. Chunking

chunker.output.cdata-section-elements — List of elements to escape with CDATA sections

chunker.output.doctype-public — Public identifer to use in the document type of generated pages

chunker.output.doctype-system — System identifier to use for the document type in generated pages

chunker.output.encoding — Encoding used in generated pages

chunker.output.indent — Specification of indentation on generated pages

chunker.output.media-type — Media type to use in generated pages

chunker.output.method — Method used in generated pages

chunker.output.omit-xml-declaration — Omit-xml-declaration for generated pages

chunker.output.standalone — Standalone declaration for generated pages

saxon.character.representation — Saxon character representation used in generated HTML pages

html.ext — Identifies the extension of generated HTML files

use.id.as.filename — Use ID value of chunk elements as the filename?

html.extra.head.links — Toggle extra HTML head link information

root.filename — Identifies the name of the root HTML file when chunking

base.dir — The base directory of chunks

chunked.filename.prefix — Filename prefix for chunked files

generate.manifest — Generate a manifest file?

manifest — Name of manifest file

manifest.in.base.dir — Should the manifest file be written into base.dir?

chunk.toc — An explicit TOC to be used for chunking

chunk.tocs.and.lots — Should ToC and LoTs be in separate chunks?

chunk.separate.lots — Should each LoT be in its own separate chunk?

chunk.tocs.and.lots.has.title — Should ToC and LoTs in a separate chunks have title?

chunk.section.depth — Depth to which sections should be chunked

chunk.first.sections — Chunk the first top-level section?

chunk.quietly — Omit the chunked filename messages.

chunk.append — Specifies content to append to chunked HTML output

navig.graphics — Use graphics in navigational headers and footers?

navig.graphics.extension — Extension for navigational graphics

navig.graphics.path — Path to navigational graphics

navig.showtitles — Display titles in HTML headers and footers?

1.22. Profiling

profile.arch — Target profile for arch attribute

profile.audience — Target profile for audience attribute

profile.condition — Target profile for condition attribute

profile.conformance — Target profile for conformance attribute

profile.lang — Target profile for lang attribute

profile.os — Target profile for os attribute

profile.outputformat — Target profile for outputformat attribute

profile.revision — Target profile for revision attribute

profile.revisionflag — Target profile for revisionflag attribute

profile.role — Target profile for role attribute

profile.security — Target profile for security attribute

profile.status — Target profile for status attribute

profile.userlevel — Target profile for userlevel attribute

profile.vendor — Target profile for vendor attribute

profile.wordsize — Target profile for wordsize attribute

profile.attribute — Name of user-specified profiling attribute

profile.value — Target profile for user-specified attribute

profile.separator — Separator character for compound profile values

1.23. HTML Help

htmlhelp.encoding — Character encoding to use in files for HTML Help compiler.

htmlhelp.autolabel — Should tree-like ToC use autonumbering feature?

htmlhelp.chm — Filename of output HTML Help file.

htmlhelp.default.topic — Name of file with default topic

htmlhelp.display.progress — Display compile progress?

htmlhelp.hhp — Filename of project file.

htmlhelp.hhc — Filename of TOC file.

htmlhelp.hhk — Filename of index file.

htmlhelp.hhp.tail — Additional content for project file.

htmlhelp.hhp.window — Name of default window.

htmlhelp.hhp.windows — Definition of additional windows

htmlhelp.enhanced.decompilation — Allow enhanced decompilation of CHM?

htmlhelp.enumerate.images — Should the paths to all used images be added to the project file?

htmlhelp.force.map.and.alias — Should [MAP] and [ALIAS] sections be added to the project file unconditionally?

htmlhelp.map.file — Filename of map file.

htmlhelp.alias.file — Filename of alias file.

htmlhelp.hhc.section.depth — Depth of TOC for sections in a left pane.

htmlhelp.hhc.show.root — Should there be an entry for the root element in the ToC?

htmlhelp.hhc.folders.instead.books — Use folder icons in ToC (instead of book icons)?

htmlhelp.hhc.binary — Generate binary ToC?

htmlhelp.hhc.width — Width of navigation pane

htmlhelp.title — Title of HTML Help

htmlhelp.show.menu — Should the menu bar be shown?

htmlhelp.show.toolbar.text — Show text under toolbar buttons?

htmlhelp.show.advanced.search — Should advanced search features be available?

htmlhelp.show.favorities — Should the Favorites tab be shown?

htmlhelp.button.hideshow — Should the Hide/Show button be shown?

htmlhelp.button.back — Should the Back button be shown?

htmlhelp.button.forward — Should the Forward button be shown?

htmlhelp.button.stop — Should the Stop button be shown?

htmlhelp.button.refresh — Should the Refresh button be shown?

htmlhelp.button.home — Should the Home button be shown?

htmlhelp.button.home.url — URL address of page accessible by Home button

htmlhelp.button.options — Should the Options button be shown?

htmlhelp.button.print — Should the Print button be shown?

htmlhelp.button.locate — Should the Locate button be shown?

htmlhelp.button.jump1 — Should the Jump1 button be shown?

htmlhelp.button.jump1.url — URL address of page accessible by Jump1 button

htmlhelp.button.jump1.title — Title of Jump1 button

htmlhelp.button.jump2 — Should the Jump2 button be shown?

htmlhelp.button.jump2.url — URL address of page accessible by Jump2 button

htmlhelp.button.jump2.title — Title of Jump2 button

htmlhelp.button.next — Should the Next button be shown?

htmlhelp.button.prev — Should the Prev button be shown?

htmlhelp.button.zoom — Should the Zoom button be shown?

htmlhelp.remember.window.position — Remember help window position?

htmlhelp.window.geometry — Set initial geometry of help window

htmlhelp.use.hhk — Should the index be built using the HHK file?

htmlhelp.only — Should only project files be generated?

1.24. Eclipse Help Platform

eclipse.autolabel — Should tree-like ToC use autonumbering feature?

eclipse.plugin.name — Eclipse Help plugin name

eclipse.plugin.id — Eclipse Help plugin id

eclipse.plugin.provider — Eclipse Help plugin provider name

1.25. WebHelp

webhelp.autolabel — Should tree-like ToC use autonumbering feature?

webhelp.base.dir — The base directory for webhelp output.

webhelp.common.dir — Path to the directory for the common webhelp resources (JavaScript, css, common images, etc).

webhelp.default.topic — The name of the file to which the start file in the webhelp base directory redirects

webhelp.include.search.tab — Should the webhelp output include a Search tab?

webhelp.indexer.language — The language to use for creating the webhelp search index.

webhelp.start.filename — The name of the start file in the webhelp base directory.

webhelp.tree.cookie.id — Controls how the cookie that stores the webhelp toc state is named.

1.26. JavaHelp

javahelp.encoding — Character encoding to use in control files for JavaHelp.

1.27. Localization

l10n.gentext.language — Sets the gentext language

l10n.gentext.default.language — Sets the default language for generated text

l10n.gentext.use.xref.language — Use the language of target when generating cross-reference text?

l10n.lang.value.rfc.compliant — Make value of lang attribute RFC compliant?

writing.mode — Direction of text flow based on locale