Ant parameters: Common HTML-based transformations
Certain parameters apply to all the HTML-based transformation types: Eclipse content, Eclipse help, HTML Help, JavaHelp, TocJS, and XHTML.
| Parameters | Description |
|---|---|
| args.artlbl | Specifies whether to generate a label for each image; the label will contain the image file name. The allowed values are yes and no; the default value is no. |
| args.breadcrumbs | Specifies whether to generate breadcrumb links. The allowed values are yes and no; the default value is no. Corresponds to the XSLT parameter BREADCRUMBS. |
| args.copycss | Specifies whether to copy the custom .css file to the output directory. |
| args.css | Specifies the name of a custom .css file. |
| args.csspath | Specifies the location of a copied .css file relative to the output directory. Corresponds to XSLT parameter CSSPATH. |
| args.cssroot | Specifies the directory that contains the custom .css file. DITA-OT will copy the file from this location. |
| args.dita.locale | Specifies the language locale file to use for sorting
index entries. Note: This parameter is not available for the XHTML
transformation.
|
| args.ftr | Specifies an XML file that contains content
for a running footer. Corresponds to XSLT parameter
FTR. Note: The XML file must contain valid XML. A common
practice is to place all content into a <div> element.
|
| args.gen.default.meta | Specifies whether to generate extra metadata that targets parental control scanners, meta elements with name="security" and name="Robots". The allowed values are yes and no; the default value is no. Corresponds to the XSLT parameter genDefMeta. |
| args.gen.task.lbl | Specifies whether to generate headings for sections within task topics. The allowed values are YES and NO; the default value is NO. Corresponds to the XSLT parameter GENERATE-TASK-LABELS. |
| args.hdf | Specifies an XML file that contains content to be placed in the document head. |
| args.hdr | Specifies an XML file that contains content
for a running header. Corresponds to the XSLT parameter
HDR. Note: The XML file must contain valid XML. A common
practice is to place all content into a <div> element.
|
| args.hide.parent.link | Specifies whether to hide
links to parent topics in the HTML or XHTML output. The allowed values are
yes and no; the default value is
no. Corresponds to the XSLT
parameter NOPARENTLINK.
Note: This parameter is deprecated in favor of the
args.rellinks parameter.
|
| args.rellinks |
Specifies which links to include in the output. The following values are supported:
Default value depends on the transformation type. |
| args.indexshow | Specifies whether the content of <indexterm> elements are rendered in the output. The allowed values are yes and no; the default value is no. |
| args.outext | Specifies the file extension for HTML or XHTML output. The default value is html. Corresponds to XSLT parameter OUTEXT. |
| args.xhtml.classattr | Specifies whether to include
the DITA class ancestry inside the XHTML elements .For example, the <prereq>
element (which is specialized from section) would generate class="section
prereq. The allowed values are yes and
no; the default value is yes. Corresponds to the XSLT parameter
PRESERVE-DITA-CLASS. Note: Beginning with DITA OT release
1.5.2, the default value is yes. For release 1.5 and 1.5.1, the
default value was no.
|
| args.xsl | Specifies a custom XSL file to be used instead of the default XSL transformation (xsl\dita2xhtml.xsl). The parameter must specify a fully qualified file name. |
| onlytopic.in.map | Specifies whether files that are linked to, or referenced with a @conref attribute, generate output. If set to yes, only files that are referenced directly from the map will generate output. |