HTML Parameter Reference

Norman Walsh

$Id: param.xweb,v 1.21 2002/01/04 16:08:03 nwalsh Exp $


Table of Contents

Introduction
I. Admonitions
admon.graphics.extension - Extension for admonition graphics
admon.graphics.path - Path to admonition graphics
admon.graphics - Use graphics in admonitions?
admon.style - CSS style attributes for admonitions
II. Callouts
callout.defaultcolumn - Indicates what column callouts appear in by default
callout.graphics.extension - 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 callout graphic
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
III. EBNF
ebnf.table.bgcolor - Background color for EBNF tables
ebnf.table.border - Selects border on EBNF tables
IV. ToC/LoT/Index Generation
annotate.toc - Annotate the Table of Contents?
autotoc.label.separator - Separator between labels and titles in the ToC
generate.appendix.toc - Specify if a table of contents is required for an appendix
generate.article.toc - Specify if a toc is wanted for an article.
generate.book.toc - Do you want a table of contents in the book?
generate.chapter.toc - Do you want a table of contents for chapters?
generate.component.toc - Should TOCs be genereated in components (Chapters, Appendixes, etc.)?
generate.division.toc - Should TOCs be genereated in divisions (Books, Parts, etc.)?
generate.part.toc - Do you want an index for each part?
generate.preface.toc - Do you want a table of contents for the preface?
generate.qandadiv.toc - Is a Table of Contents created for QandADivs?
generate.qandaset.toc - Is a Table of Contents created for QandASets?
generate.reference.toc - Do you want a list of references?
generate.section.toc - Generate TOCs inside Sections?
generate.set.toc - Do you want a table of contents in each set?
generate.section.toc.level - Control depth of TOC generation in sections
generate.index - Do you want an index?
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?
process.source.toc - FIXME:
process.empty.source.toc - FIXME:
bridgehead.in.toc - Should bridgehead elements appear in the TOC?
V. 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 - Enable the textinsert extension element
use.extensions - Enable extensions
VI. Automatic labelling
chapter.autolabel - Are chapters automatically enumerated?
appendix.autolabel - Are Appendixes automatically enumerated?
part.autolabel - Are parts and references enumerated?
preface.autolabel - Are prefaces enumerated?
qandadiv.autolabel - Are divisions in QAndASets enumerated?
section.autolabel - Are sections enumerated?
section.label.includes.component.label - Do section labels include the component label?
label.from.part - Renumber chapters in each part?
VII. HTML
html.base - An HTML base URI
html.stylesheet.type - The type of the stylesheet used in the generated HTML
html.stylesheet - Name of the stylesheet to use in the generated HTML
use.id.as.filename - Use ID value of chunk elements as the filename?
css.decoration - Enable CSS decoration of elements
spacing.paras - Insert additional <p> elements for spacing?
emphasis.propagates.style - Pass emphasis role attribute through to HTML?
phrase.propagates.style - Pass phrase role attribute through to HTML?
stylesheet.result.type - Identifies the output format of this stylesheet
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
VIII. XSLT Processing
rootid - Specify the root element to format
suppress.navigation - Disable header and footer navigation
IX. Meta/*Info
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?
generate.legalnotice.link - TBD
X. 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 'RefName'(s)?
refentry.generate.title - Output title before 'RefName'(s)?
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?
XI. 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.border.style -
table.border.thickness -
table.border.color -
XII. QAndASet
qanda.defaultlabel - Sets the default for defaultlabel on QandASet.
qanda.inherit.numeration - Does enumeration of QandASet components inherit the numeration of parent elements?
XIII. Linking
link.mailto.url - Mailto URL for the LINK REL=made HTML HEAD element
ulink.target - The HTML anchor target for ULinks
olink.fragid - Names the fragment identifier portion of an OLink resolver query
olink.outline.ext - The extension of OLink outline files
olink.pubid - Names the public identifier portion of an OLink resolver query
olink.sysid - Names the system identifier portion of an OLink resolver query
olink.resolver - The root name of the OLink resolver (usually a script)
XIV. Bibliography
biblioentry.item.separator - Text to separate bibliography entries
bibliography.collection - Name of the bibliography collection file
XV. Glossary
glossterm.auto.link - Generate links from glossterm to glossentry automaticaly?
firstterm.only.link - Does automatic glossterm linking only apply to firstterms?
glossary.collection - Name of the glossary collection file
XVI. Miscellaneous
graphic.default.extension - Default extension for graphic filenames
formal.procedures - Selects formal or informal procedures
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 comment 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.
segmentedlist.as.table - Format segmented lists as tables?
variablelist.as.table - Format variablelists as tables?
tex.math.in.alt -
tex.math.file -
XVII. Chunking
using.chunker - Will the output be chunked?
html.ext - Identifies the extension of generated HTML files
root.filename - Identifies the name of the root HTML file when chunking
base.dir - The base directory of chunks
chunk.section.depth - Depth to which sections should be chunked
chunk.first.sections - Chunk the first top-level section?
saxon.character.representation - Saxon character representation used in generated HTML pages
default.encoding - Encoding used in generated HTML pages
output.method -
chunk.datafile - Name of the temporary file used to hold chunking data
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?
XVIII. 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.hhp - Filename of project file.
htmlhelp.hhc - Filename of TOC file.
htmlhelp.hhp.tail - Additional content for project file.
htmlhelp.enumerate.images - Should be paths to all used images added to project file?
htmlhelp.force.map.and.alias - Should be [MAP] and [ALIAS] section added to project file unconditionaly?
htmlhelp.map.file - Filename of map file.
htmlhelp.alias.file - Filename of map file.
htmlhelp.hhc.section.depth - Depth of TOC for sections in a left pane.
A. The Stylesheet