Similar to zipping the specified directory and running dita install on the zipped file.This tool is capable of carrying out conversions between fonts, and it even supports batch conversion to convert hundreds at the same time.
This is especially useful if you have a customized PDF plugin inside your documentation repository as you can simply specify this plugin and let dita-ot-helper do the work of zipping, installing and using it for you. (Re-) Installs a plugin from its source directory. my-plugin.zip, /home/example/plugin.zip
Installs the plugin from the plugin ZIP file path. Installs the plugin from the plugin ZIP file URL (via the internet). Installs (if non-existent) a plugin by its name from the registry. Gets passed to the -f argument of the dita command. This accepts a few different types of plugin specifiers documented in the table below. dita-ot-helper will ensure these plugins are installed (or, if not, try to (re-) install them) before compilation. Gets passed to the -r argument of the dita command.Īn array of plugin paths. Relative (to the config.json) or absolute path to a resource file, e.g., a map containing key definitions.
Gets passed to the -propertyfile argument of the dita command. Relative (to the config.json) or absolute path of a. Gets passed to the -o argument of the dita command. Relative (to the config.json) or absolute path of the output directory of the compiled file. Gets passed to the -i argument of the dita command. Relative (to the config.json) or absolute path to your input file. However, we recommend using dita-ot-helper.json or config.json for clarity. Note: Your configuration file can have any possible filename. The tool will then automatically install the plugins and compile the document according to those specifications.īelow, you can find all the options you can put into your configuration file. Using a JSON config file (which is required for using dita-ot-helper), you can define: The project configuration file for the dita-ot-helper tool. Something went wrong while installing DITA-OT using the -i flag To provide an example, we'll assume you have the following directory structure (samples/sample-3 provides a similar example):ĭita-ot-helper will process (i.e., compile) all the JSON files matching the patterns.Īborted due to non-existent or non-readable config file When you have multiple configurations, e.g., for multiple maps and/or multiple deliverables per map, it is possible to compile all of them using just one command. Basic knowledge of glob patterns is required to fully understand this task. For possible glob patterns and other information, please refer to their documentation. The CLI makes use of the node glob library.
Compile multiple documentsĬompile multiple documents with one command using glob patterns Your document is now compiled and is in the out folder next to your config.json. If compilation isn't successful, re-run the command using the -verbose option and follow the instructions in the error message shown there. This is especially useful for autonomous environments such as Continuous Integration as it allows you to compile DITA documents with one command without a lot of setup.Īfter a short while, the tool outputs > Compilation successful. This then installs the specified version of DITA-OT in a temporary location (this gets deleted after the command is run). You can also specify a specific version of DITA-OT. In this case, just add the -i or -install argument to your command. It's possible to compile documents using the helper without having DITA-OT installed. Tip: Compiling documents without having DITA-OT installed on your system