Transformation ParametersEdit online
This list includes the most common customization parameters that are available in the DITA Map PDF - based on HTML5 & CSS or DITA Map PDF -based on DITA & CSS (WYSIWYG) transformation scenarios. Other standard DITA-OT parameters were omitted for clarity, but they are still supported.
args.css |
You can use this to specify a list of CSS URLs to be used in addition to those specified in the dita.css.list parameter or publishing template (for the DITA Map PDF - based on HTML5 & CSS transformation). The files must have URL syntax and be separated using semicolons. |
args.input |
Specifies the master DITA map file for your documentation project. |
clean.temp |
Specifies whether the DITA-OT deletes the files in the temporary directory after it finishes a build. Allowed values: yes (default) / no |
css.processor.type |
Specifies the processor to use for the transformation. Allowed values: chemistry (default) / antenna-house / prince. |
css.processor.path.chemistry |
Path to the Oxygen PDF Chemistry executable file that needs to be run to generate the PDF (for example, C:\path\to\chemistry.bat on Windows). If this parameter is not set, the plugin will use the system's PATH environment variable to locate and start Oxygen PDF Chemistry. |
css.processor.path.antenna-house |
Path to the Antenna House executable file that needs to be run to generate the PDF (for example, C:\path\to\AHFCmd.exe on Windows). |
css.processor.path.prince |
Path to the Prince executable file that needs to be run to generate the PDF (for example, C:\path\to\prince.exe on Windows). |
editlink.remote.ditamap.url |
Use this parameter in conjunction with editlink.web.author.url
to add an Edit link next to the topic title in the PDF output. When a user
clicks the link, the topic is opened in Oxygen XML Web Author where they can
make changes that can be saved to a file server. The value should be set as the custom
URL of the main DITA map. For example, a GitHub custom URL might look
like this:
https://getFileContent/oxyengxml/userguide/master/UserGuide.ditamap. |
editlink.web.author.url |
This parameter needs to be used in conjunction with
editlink.remote.ditamap.url to add an Edit link next to the
topic title in the PDF output. When a user clicks the link, the topic is opened in
Oxygen XML Web Author where they can make changes that can be saved to a file
server. The value should be set as the URL of the Web Author installation. For
example:
https://www.oxygenxml.com/oxygen-xml-web-author/. |
show.changes.and.comments |
When set to |
figure.title.placement |
Controls the title placement of the figures, relative to the image. Possible values include top (default) and bottom. |
For the DITA Map PDF - based on HTML5 & CSS transformation type,
the following parameters can be used to specify a publishing template:
pdf.publishing.template |
Specifies the path to the folder containing the custom PDF template. |
pdf.publishing.template.descriptor |
Specifies the name of the descriptor to be loaded from the PDF template folder or package. If it is not specified, the first encountered descriptor will be loaded. |