DITA-OT parametersAll DITA-OT parameters
args.artlblargs.artlblparametersargs.artlblSpecifies whether to generate a label for each image; the label will contain the image file name. The allowed values are and ; the default value is .args.artlblargs.artlblparametersargs.artlblSpecifies whether to generate a label for each image; the label will contain the image file name. The allowed values are and ; the default value is .args.artlblargs.artlblparametersargs.artlblSpecifies whether to generate a label for each image; the label will contain the image file name. The allowed values are and ; the default value is .args.bookmap-orderargs.bookmap-orderparametersargs.bookmap-orderSpecifies if the frontmatter and backmatter content order is retained in bookmap. The allowed values are and ; the default value is .args.bookmark.styleargs.bookmark.styleparametersargs.bookmark.styleSpecifies whether PDF bookmarks are by default expanded or collapsed. The allowed values are and .args.chapter.layoutargs.chapter.layoutparametersargs.chapter.layoutSpecifies whether chapter level TOCs are generated. The allowed values are and ; the default value is .args.copycssargs.copycssparametersargs.copycssSpecifies whether to copy the custom .css file to the output directory. The allowed values are and ; the default value is .args.copycssargs.copycssparametersargs.copycssSpecifies whether to copy the custom .css file to the output directory. The allowed values are and ; the default value is .args.cssargs.cssparametersargs.cssSpecifies the name of a custom .css file.args.cssargs.cssparametersargs.cssSpecifies the name of a custom .css file.args.csspathargs.csspathparametersargs.csspathSpecifies the location of a copied .css file relative to the output directory.args.csspathargs.csspathparametersargs.csspathSpecifies the location of a copied .css file relative to the output directory.args.cssrootargs.cssrootparametersargs.cssrootSpecifies the directory that contains the custom .css file.args.cssrootargs.cssrootparametersargs.cssrootSpecifies the directory that contains the custom .css file.args.debugargs.debugparametersargs.debugdeprecated featuresparametersargs.debugSpecifies whether debugging information is included in the log. The allowed values are and ; the default value is .args.dita.localeargs.dita.localeparametersargs.dita.localeSpecifies the language locale file to use for sorting index entries.args.dita.localeargs.dita.localeparametersargs.dita.localeSpecifies the language locale file to use for sorting index entries.args.draftargs.draftparametersargs.draftSpecifies whether the content of <draft-comment> and <required-cleanup> elements is included in the output. The allowed values are and ; the default value is .args.eclipse.providerargs.eclipse.providerparametersargs.eclipse.providerSpecifies the name of the person or organization that provides the Eclipse help.args.eclipse.symbolic.nameargs.eclipse.symbolic.nameparametersargs.eclipse.symbolic.nameSpecifies the symbolic name (aka plugin ID) in the output for an Eclipse Help project.args.eclipse.versionargs.eclipse.versionparametersargs.eclipse.versionSpecifies the version number to include in the output.args.eclipsehelp.countryargs.eclipsehelp.countryparametersargs.eclipsehelp.countrySpecifies the region for the language that is specified by the args.args.eclipsehelp.jar.nameargs.eclipsehelp.jar.nameparametersargs.eclipsehelp.jar.nameSpecifies that the output should be zipped and returned using this name.args.eclipsehelp.languageargs.eclipsehelp.languageparametersargs.eclipsehelp.languageSpecifies the base language for translated content, such as en for English.args.figurelink.styleargs.figurelink.styleparametersargs.figurelink.styleSpecifies how cross references to figures are styled in output. The allowed values are , , and .args.filterargs.filterparametersargs.filterSpecifies a filter file to be used to include, exclude, or flag content.args.fo.userconfigargs.fo.userconfigparametersargs.fo.userconfigSpecifies the user configuration file for FOP.args.ftrargs.ftrparametersargs.ftrSpecifies an XML file that contains content for a running footer.args.ftrargs.ftrparametersargs.ftrSpecifies an XML file that contains content for a running footer.args.gen.default.metaargs.gen.default.metaparametersargs.gen.default.metaSpecifies whether to generate extra metadata that targets parental control scanners, meta elements with name="security" and name="Robots". The allowed values are and ; the default value is .args.gen.default.metaargs.gen.default.metaparametersargs.gen.default.metaSpecifies whether to generate extra metadata that targets parental control scanners, meta elements with name="security" and name="Robots". The allowed values are and ; the default value is .args.gen.task.lblargs.gen.task.lblparametersargs.gen.task.lblSpecifies whether to generate headings for sections within task topics. The allowed values are and .args.grammar.cacheargs.grammar.cacheparametersargs.grammar.cacheSpecifies whether the grammar-caching feature of the XML parser is used. The allowed values are and ; the default value is .args.hdfargs.hdfparametersargs.hdfSpecifies an XML file that contains content to be placed in the document head.args.hdfargs.hdfparametersargs.hdfSpecifies an XML file that contains content to be placed in the document head.args.hdrargs.hdrparametersargs.hdrSpecifies an XML file that contains content for a running header.args.hdrargs.hdrparametersargs.hdrSpecifies an XML file that contains content for a running header.args.hide.parent.linkargs.hide.parent.linkparametersargs.hide.parent.linkSpecifies whether to hide links to parent topics in the HTML5 output. The allowed values are and ; the default value is .args.hide.parent.linkargs.hide.parent.linkparametersargs.hide.parent.linkSpecifies whether to hide links to parent topics in the HTML or XHTML output. The allowed values are and ; the default value is .args.html5.classattrargs.html5.classattrparametersargs.html5.classattrSpecifies whether to include the DITA class ancestry inside the HTML5 elements. The allowed values are and ; the default value is .args.html5.contenttargetargs.html5.contenttargetparametersargs.html5.contenttargetSpecifies the value of the @target attribute on the <base> element in the TOC file.args.html5.tocargs.html5.tocparametersargs.html5.tocSpecifies the base name of the TOC file.args.html5.toc.classargs.html5.toc.classparametersargs.html5.toc.classSpecifies the value of the @class attribute on the <body> element in the TOC file.args.html5.toc.xslargs.html5.toc.xslparametersargs.html5.toc.xslSpecifies a custom XSL file to be used for TOC generation.args.htmlhelp.includefileargs.htmlhelp.includefileparametersargs.htmlhelp.includefileSpecifies the name of a file that you want included in the HTML Help.args.indexshowargs.indexshowparametersargs.indexshowSpecifies whether the content of <indexterm> elements are rendered in the output. The allowed values are and ; the default value is .args.indexshowargs.indexshowparametersargs.indexshowSpecifies whether the content of <indexterm> elements are rendered in the output. The allowed values are and ; the default value is .args.inputargs.inputparametersargs.inputSpecifies the master file for your documentation project.args.input.dirargs.input.dirparametersargs.input.dirSpecifies the base directory for your documentation project.args.logdirargs.logdirparametersargs.logdirdeprecated featuresparametersargs.logdirSpecifies the location where DITA-OT places log files for your project.args.outextargs.outextparametersargs.outextSpecifies the file extension for HTML5 output.args.outextargs.outextparametersargs.outextSpecifies the file extension for HTML or XHTML output.args.output.baseargs.output.baseparametersargs.output.baseSpecifies the name of the output file without file extension.args.rellinksargs.rellinksparametersargs.rellinksSpecifies which links to include in the output. The following values are supported:
  • – No links are included.
  • – All links are included.
  • – Parent links are not included.
  • – Parent, child, next, and previous links are not included.
args.tablelink.styleargs.tablelink.styleparametersargs.tablelink.styleSpecifies how cross references to tables are styled. The allowed values are , , and .args.xhtml.classattrargs.xhtml.classattrparametersargs.xhtml.classattrSpecifies whether to include the DITA class ancestry inside the XHTML elements. The allowed values are and ; the default value is .args.xhtml.contenttargetargs.xhtml.contenttargetparametersargs.xhtml.contenttargetSpecifies the value of the @target attribute on the <base> element in the TOC file.args.xhtml.tocargs.xhtml.tocparametersargs.xhtml.tocSpecifies the base name of the TOC file.args.xhtml.toc.classargs.xhtml.toc.classparametersargs.xhtml.toc.classSpecifies the value of the @class attribute on the <body> element in the TOC file.args.xhtml.toc.xslargs.xhtml.toc.xslparametersargs.xhtml.toc.xslSpecifies a custom XSL file to be used for TOC generation.args.xslargs.xslparametersargs.xslSpecifies a custom XSL file to be used instead of the default XSL transformation.args.xslargs.xslparametersargs.xslSpecifies a custom XSL file to be used instead of the default XSL transformation.args.xsl.pdfargs.xsl.pdfparametersargs.xsl.pdfSpecifies an XSL file that is used to override the default XSL transformation.axf.cmdaxf.cmdparametersaxf.cmdSpecifies the path to the Antenna House Formatter executable.axf.optaxf.optparametersaxf.optSpecifies the user configuration file for Antenna House Formatter.clean.tempclean.tempparametersclean.tempSpecifies whether DITA-OT deletes the files in the temporary directory after it finishes a build. The allowed values are and ; the default value is .conserve-memoryconserve-memoryparametersconserve-memoryConserve memory at the expense of processing speed The allowed values are and ; the default value is .custom.xep.configcustom.xep.configparameterscustom.xep.configSpecifies the user configuration file for RenderX.customization.dircustomization.dirparameterscustomization.dirSpecifies the customization directory.default.languagedefault.languageparametersdefault.languageSpecifies the default language for source documents.dita.dirdita.dirparametersdita.dirSpecifies where DITA-OT is installed.dita.input.valfiledita.input.valfileparametersdita.input.valfiledeprecated featuresparametersdita.input.valfileSpecifies a filter file to be used to include, exclude, or flag content.dita.temp.dirdita.temp.dirparametersdita.temp.dirSpecifies the location of the temporary directory.filter-stagefilter-stageparametersfilter-stageSpecifies whether filtering is done before all other processing, or after key and conref processing. The allowed values are and ; the default value is .force-uniqueforce-uniqueparametersforce-uniqueGenerate copy-to attributes to duplicate topicref elements. The allowed values are and ; the default value is .generate-debug-attributesgenerate-debug-attributesparametersgenerate-debug-attributesSpecifies whether the @xtrf and @xtrc debugging attributes are generated in the temporary files. The following values are supported:
  • (default) – Enables generation of debugging attributes
  • – Disables generation of debugging attributes
generate.copy.outergenerate.copy.outerparametersgenerate.copy.outerSpecifies whether to generate output files for content that is not located in or beneath the directory containing the DITA map file. The following values are supported:
  • (default) – Do not generate output for content that is located outside the DITA map directory.
  • – Shift the output directory so that it contains all output for the publication.
link-crawllink-crawlparameterslink-crawlSpecifies whether to crawl only those topic links found in maps, or all discovered topic links. The allowed values are and ; the default value is .maxJavaMemorymaxJavaMemoryparametersmaxJavaMemorySpecifies the amount of memory allocated to the RenderX process.nav-tocnav-tocparametersnav-tocSpecifies whether to generate a navigation TOC in topic pages. The following values are supported:
  • (default) – No TOC
  • – Partial TOC that shows the current topic
  • – Full TOC
onlytopic.in.maponlytopic.in.mapparametersonlytopic.in.mapSpecifies whether files that are linked to, or referenced with a @conref attribute, generate output. The allowed values are and ; the default value is .org.dita.pdf2.chunk.enabledorg.dita.pdf2.chunk.enabledparametersorg.dita.pdf2.chunk.enabledEnables chunk attribute processing. The following values are supported:
  • – Enables chunk processing
  • (default) – Disables chunk processing
org.dita.pdf2.i18n.enabledorg.dita.pdf2.i18n.enabledparametersorg.dita.pdf2.i18n.enabledEnables I18N font processing. The following values are supported:
  • (default) – Enables I18N processing
  • – Disables I18N processing
outer.controlouter.controlparametersouter.controlSpecifies how DITA-OT handles content files that are not located in or below the directory containing the master DITA map. The following values are supported:
  • – Fail quickly if files are going to be generated or copied outside of the directory.
  • (default) – Complete the operation if files will be generated or copied outside of the directory, but log a warning.
  • – Quietly finish without generating warnings or errors.
output.diroutput.dirparametersoutput.dirSpecifies the name and location of the output directory.outputFile.baseoutputFile.baseparametersoutputFile.baseSpecifies the base file name of the generated PDF file.pdf.formatterpdf.formatterparameterspdf.formatterSpecifies the XSL processor. The following values are supported:
  • – Antenna House Formatter
pdf.formatterpdf.formatterparameterspdf.formatterSpecifies the XSL processor.pdf.formatterpdf.formatterparameterspdf.formatterSpecifies the XSL processor. The following values are supported:
  • – RenderX XEP Engine
pdf.formatterpdf.formatterparameterspdf.formatterSpecifies the XSL processor. The following values are supported:
  • (default) – Apache FOP
processing-modeprocessing-modeparametersprocessing-modeSpecifies how DITA-OT handles errors and error recovery. The following values are supported:
  • – When an error is encountered, DITA-OT stops processing
  • (default) – When an error is encountered, DITA-OT attempts to recover from it
  • – When an error is encountered, DITA-OT continues processing but does not attempt error recovery
publish.required.cleanuppublish.required.cleanupparameterspublish.required.cleanupSpecifies whether draft-comment and required-cleanup elements are included in the output. The allowed values are and .publish.required.cleanuppublish.required.cleanupparameterspublish.required.cleanupSpecifies whether draft-comment and required-cleanup elements are included in the output. The allowed values are and .remove-broken-linksremove-broken-linksparametersremove-broken-linksRemove broken related links. The allowed values are and ; the default value is .root-chunk-overrideroot-chunk-overrideparametersroot-chunk-overrideOverride for map chunk attribute value.transtypetranstypeparameterstranstypeSpecifies the output format (transformation type).validatevalidateparametersvalidateSpecifies whether DITA-OT validates the content. The allowed values are and ; the default value is .