HTML Parameters

add-index-toc, parameter [1]
add-toc-root, parameter [1]
appendix-number-format, parameter [1]
base-font-size, parameter [1]
body-bottom-margin, parameter [1]
body-font-family, parameter [1]
body-start-indent, parameter [1]
body-top-margin, parameter [1]
{{break}}, page header/footer variable [1]
cause-number-format, parameter [1]
center, parameter [1]
chain-pages, parameter [1]
chain-topics, parameter [1]
- See also ignore-navigation-links, parameter
{{chapter-title}}, page header/footer variable [1]
choice-bullets, parameter [1]
cover-image, parameter [1]
css, parameter [1]
cssResourceName, parameter [1]
custom-css, parameter [1]
default-table-width, parameter [1]
{{document-date}}, page header/footer variable [1]
{{document-title}}, page header/footer variable [1]
.docx, filename extension [1]
EPUB 2, output format [1]
epub2-compatible, parameter [1]
EPUB 3, output format [1] [2] [3] [4]
epub-identifier, parameter [1]
equation-block-equation-width, parameter [1]
equation-block-number-width, parameter [1]
equation-number-after, parameter [1]
equation-number-before, parameter [1]
extended-toc, parameter [1]
external-href-after, parameter [1]
external-href-before, parameter [1]
external-link-icon-height, parameter [1]
external-link-icon-name, parameter [1]
external-link-icon-width, parameter [1]
external-resource-base, parameter [1]
footer-center, parameter [1]
footer-center-width, parameter [1]
footer-height, parameter [1]
footer-left, parameter [1]
footer-left-width, parameter [1]
footer-right, parameter [1]
footer-right-width, parameter [1]
footer-separator, parameter [1]
format-to-type, parameter [1]
generate-epub-trigger, parameter [1]
generator-info, parameter [1]
header-center, parameter [1]
header-center-width, parameter [1]
header-height, parameter [1]
header-left, parameter [1]
header-left-width, parameter [1]
header-right, parameter [1]
header-right-width, parameter [1]
header-separator, parameter [1]
hhc-basename, parameter [1]
hhp-template, parameter [1]
hhx-basename, parameter [1]
highlight-source, parameter [1]
hyphenate, parameter [1]
ignore-navigation-links, parameter [1]
- See also chain-topics, parameter
{{image(URI)}}, page header/footer variable [1]
imagemap [1]
index-column-gap, parameter [1]
index-range-separator, parameter [1]
javascripts, parameter [1]
justified, parameter [1]
link-auto-text, parameter [1]
link-bullet, parameter [1]
mark-external-links, parameter [1]
mark-important-steps, parameter [1]
MathJax [1] [2]
mathjax, parameter [1]
mathjax-url, parameter [1]
MathML [1] [2]
menucascade-separator, parameter [1]
navigation-icon-height, parameter [1]
navigation-icon-suffix, parameter [1]
navigation-icon-width, parameter [1]
note-icon-height, parameter [1]
note-icon-list, parameter [1]
note-icon-suffix, parameter [1]
note-icon-width, parameter [1]
number, parameter [1]
number-separator1, parameter [1]
number-separator2, parameter [1]
number-toc-entries, parameter [1]
.odt, filename extension [1]
outputclass, attribute [1]
page-bottom-margin, parameter [1]
pagebreak, processing-instruction [1]
{{page-count}}, page header/footer variable [1]
page-height, parameter [1]
page-inner-margin, parameter [1]
{{page-number}}, page header/footer variable [1]
page-orientation, parameter [1]
page-outer-margin, parameter [1]
page-ref-after, parameter [1]
page-ref-before, parameter [1]
{{page-sequence}}, page header/footer variable [1] [2]
page-top-margin, parameter [1]
page-width, parameter [1]
paper-type, parameter [1]
part-number-format, parameter [1]
pdf-outline, parameter [1]
plugin-id, parameter [1]
plugin-index-basename [1]
plugin-name, parameter [1]
plugin-provider, parameter [1]
plugin-toc-basename, parameter [1]
plugin-version, parameter [1]
Preferences dialog [1]
prepend-chapter-to-section-number, parameter [1]
Publish DITA MAP dialog [1]
remedy-number-format, parameter [1]
.rtf, filename extension [1]
screen-resolution, parameter [1]
{{section1-title}}, page header/footer variable [1]
show-draft-comments, parameter [1]
show-external-links, parameter [1]
show-imagemap-links, parameter [1]
show-link-page, parameter [1]
show-xref-page, parameter [1]
syntax highlighting [1]
title-after, parameter [1]
title-color, parameter [1]
title-font-family, parameter [1]
title-page, parameter [1]
title-prefix-separator1, parameter [1]
{{topic-title}}, page header/footer variable [1] [2]
troubleSolution-number-format, parameter [1]
two-sided, parameter [1]
ul-li-bullets, parameter [1]
unordered-step-bullets, parameter [1]
use-note-icon, parameter [1]
watermark, parameter [1]
watermark-image, parameter [1]
whc-index-basename, parameter [1]
wh-collapse-toc, parameter [1]
wh---CSS_VAR_NAME, parameter [1]
whc-toc-basename, parameter [1]
wh-index-numbers, parameter [1]
wh-inherit-font-and-colors, parameter [1]
wh-jquery, parameter [1]
wh-layout, parameter [1]
wh-local-jquery, parameter [1]
wh-responsive-ui, parameter [1]
wh-ui-language, parameter [1]
wh-user-css, parameter [1]
wh-user-footer, parameter [1]
wh-user-header, parameter [1]
wh-user-resources, parameter [1]
wh-use-stemming, parameter [1]
.wml, filename extension [1]
XFC, XSL-FO processor [1] [2]
xfc-render-as-table, parameter [1]
xhtml-mime-type, parameter [1]
xref-auto-text, parameter [1]
xsl-resources-directory, parameter [1]

HTML Parameters

The following table lists the parameters that are common to the stylesheets that generate XHTML or HTML. They apply to the stylesheets that produce XHTML, HTML, Web Help and HTML Help, Eclipse Help and EPUB.

Parameter Value Description

add-index-toc

Allowed values are: 'yes' and 'no'.

Default value: 'yes'.

Specifies whether an A-Z list should be added at the beginning of the back-of-the-book index.

chain-pages

Allowed values are: 'none', 'top', 'bottom' or 'both'.

Default value: 'none'.

Specifies whether a header and/or a footer containing navigation icons should be generated in order to link together all the HTML pages.

Note

There is no need to specify a value other than 'none' when generating Web Help, HTML Help, Eclipse Help, EPUB and Java™ Help.

chain-topics

Allowed values are: 'yes' and 'no'.

Default value: 'no'.

Specifies whether navigation icons should be generated in order to link together all the topics.

See also related parameter: ignore-navigation-links.

Note

There is no need to specify a value other than 'no' when generating Web Help, HTML Help, Eclipse Help, EPUB and Java™ Help.

css

URL.

Default value: ''.

Low-level parameter specifying which CSS stylesheet to use to style the generated (X)HTML pages.

When neither css nor custom-css is specified, the default CSS stylesheet being used is xsl-resources-directory/base.css.

Restriction

Not supported by the stylesheets that generate EPUB.

cssResourceName

URL basename relative to the directory specified by parameter xsl-resources-directory.

Default value: 'base.css'.

Very low-level parameter specifying which CSS stylesheet to use. This CSS stylesheet is expected to be found in the resources directory.

Note

This parameter is not useful unless you develop a plug-in implementing a DITA specialization. More information in https://www.xmlmind.com/ditac/_distrib/doc/manual/webhelp/specialize.html.

custom-css

URL.

Default value: ''.

Specifies the custom CSS stylesheet used to style the generated (X)HTML pages. This high-level parameter has priority over low-level parameter css.

This custom CSS stylesheet is copied to directory xsl-resources-directory. Therefore custom-css requires directory xsl-resources-directory to be specified as an URL which is relative to the output directory (e.g. xsl-resources-directory='res').

How to use custom-css is explained in https://www.xmlmind.com/ditac/_distrib/doc/manual/webhelp/manual-6.html#customCSS.

default-table-width

A percentage, typically something like '100%' or '90%'.

Default value: '' (as narrow as possible).

The default width of <table> and <simpletable> elements.

external-link-icon-height

Length. A length may have a unit. Default is px.

Default value: '10'.

The height of the “opens in new window” icon.

external-link-icon-name

Basename.

Default value: 'new_window.png'.

The basename of the “opens in new window” icon. This icon is found in the resources directory.

external-link-icon-width

Length. A length may have a unit. Default is px.

Default value: '10'.

The width of the “opens in new window”' icon.

format-to-type

Zero or more DITA format/MIME type pairs. Example: "txt text/plain xml application/xml html text/html".

Default value: '', which means that DITA xref/@format is not converted to XHTML a/@type.

Allows to map DITA xref/@format to XHTML a/@type.

Using default empty value, <xref scope="external" format="txt" href="http://acme.com/info.xyz"> is converted to <a href="http://acme.com/info.xyz" target="_blank">. The fact that file extension ".xyz" is unknown may cause problems when attempting to navigate or download file "info.xyz" using a Web browser.

If -p format-to-type "txt text/plain" is passed to ditac then <xref scope="external" format="txt" href="http://acme.com/info.xyz"> is converted to <a type="text/plain" href="http://acme.com/info.xyz" target="_blank">, which is better.

generator-info

String

Default value: 'XMLmind DITA Converter VERSION'.

The name of the software which has been used to create the HTML pages.

Specify an empty string if you don't want to have a <meta name="generator" content="XXX"/> element added to your HTML pages.

ignore-navigation-links

Allowed values are: 'yes', 'no' and 'auto'.

Default value: 'auto' for XHTML and its variants; 'yes' for Web Help, Java Help, HTML Help, Eclipse Help and EPUB

If 'yes', do not generate the navigation links corresponding to topicref attribute @collection-type.

If 'no', generate the navigation links corresponding to topicref attribute @collection-type.

If 'auto', generate the navigation links corresponding to topicref attribute @collection-type, unless chain-topics=yes.

javascripts

String. List of URLs separated by whitespace.

Default value: ''.

The URLs specified in this parameter must point to JavaScript files. These URLs are converted to <script> XHTML elements added to the <html>/<head> elements of the XHTML files generated by ditac.

Note that an URL may end with ';async', ';defer' or a combination of both flags. These flags are translated to the corresponding attributes of the <script> element. Example:

https://cdn.mathjax.org/mathjax/latest/¬
MathJax.js?config=MML_CHTML;async

is translated to:

<script type="text/javascript" async="async"
src="https://cdn.mathjax.org/mathjax/latest/¬
MathJax.js?config=MML_CHTML">
</script>

mathjax

Allowed values are: 'yes', 'no' and 'auto'.

Default value: 'no'.

Very few web browsers (Firefox) can natively render MathML. Fortunately, there is MathJax. MathJax is a JavaScript display engine for mathematics that works in all browsers.

'yes': Add a <script> XHTML element loading MathJax to the <html>/<head> elements of all XHTML files generated by ditac.
'auto': Same as 'yes', but add <script> only to generated XHTML files containing MathML.

Ignored by all XHTML-based formats but XHTML and Web Help.

mathjax-url

String.

Default value: the URL pointing to the MathJax CDN, as recommended in the MathJax documentation.

The URL allowing to load the MathJax engine configured for rendering MathML.

Ignored unless parameter mathjax is set to 'yes'or 'auto'.

mark-external-links

Allowed values are: 'yes' and 'no'.

Default value: 'no'.

Specifies whether an external link should be marked using a “opens in new window” icon.

navigation-icon-height

Length. A length may have a unit. Default is px.

Default value: '16'.

The height of a navigation icon.

navigation-icon-suffix

String.

Default value: '.png'.

The suffix of a navigation icon.

The root names of navigation icons are fixed:

first, first_disabled,
last, last_disabled,
next, next_disabled,
previous, previous_disabled,
parent, parent_disabled,
child, child_disabled.

For example, if note-icon-suffix='.svg', the default resources directory is expected to contain first.svg, first_disabled.svg, last.svg, etc.

In principle, there is no need for an end-user to specify any of the navigation-icon-suffix, navigation-icon-width or navigation-icon-height parameters.

navigation-icon-width

Length. A length may have a unit. Default is px.

Default value: '16'.

The width of a navigation icon.

screen-resolution

Positive integer.

Default value: '96'.

The resolution of the screen in dot per inch (DPI). This resolution is used to convert image dimensions such as 3cm to pixels.

xhtml-mime-type

A MIME type without a parameter such as 'text/html', 'application/xhtml+xml', 'application/xml' or the empty string ('').

Default value: see prose.

Low-level parameter. Do not change default value unless you know what you are doing.

Specify 'text/html' to serve XHTML as HTML.
This is the default value for all (X)HTML-based output formats except for EPUB 2 and (X)HTML5.
Specify 'application/xhtml+xml' if you prefer to serve XHTML as XML.
This is the default value for EPUB 2.
Specify an empty string if you prefer not to generate <meta http-equiv="Content-Type">.
This is the default value for (X)HTML5 for which a <meta charset="UTF-8"> is generated instead.