DITA Open Toolkit

Ant parameters: PDF transformation

Certain parameters are specific to the PDF2 transformation.

Figure 1. Ant parameters: PDF transformation
args.bookmap-order
Specifies if the frontmatter and backmatter content order is retained in bookmap. The allowed values are retain and discard; the default value is discard.
args.bookmark.style
Specifies whether PDF bookmarks are by default expanded or collapsed. The allowed values are COLLAPSED and EXPANDED, the default value is COLLAPSE.
args.chapter.layout
Specifies whether chapter level TOCs are generated. The allowed values are MINITOC and BASIC; the default value is MINITOC.
args.fo.userconfig
Specifies the user configuration file for FOP.
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.rellinks

Specifies which links to include in the output. The following values are supported:

  • none – No links are included.
  • all – All links are included.
  • nofamily – Parent, child, next, and previous links are not included.

Default value depends on the transformation type.

args.xsl.pdf
Specifies an XSL file that is used to override the default XSL transformation (plugins\org.dita.pdf2\xsl\fo\topic2fo_shell.xsl). You must specify the fully qualified file name.
custom.xep.config
Specifies the user configuration file for RenderX.
customization.dir
Specifies the customization directory.
pdf.formatter
Specifies the XSL processor. The following values are supported:
  • ah – Antenna House Formatter
  • fop (default) – Apache FOP
  • xep – RenderX XEP Engine
The client package comes with Apache FOP; other XSL processors must be separately installed.
publish.required.cleanup
Specifies whether draft-comment and required-cleanup elements are included in the output. The allowed values are yes and no; the default value is the value of the args.draft parameter. Corresponds to XSLT parameter publishRequiredCleanup.
Note: This parameter is deprecated in favor of the args.draft parameter.
retain.topic.fo
Specifies whether to retain the generated FO file. The allowed values are yes and no; the default value is no. If the configuration property org.dita.pdf2.use-out-temp is set to false, this parameter is ignored.