DITA Map Validation and Completeness Check from the Command-Line Interface
History | Edit

Important: This command-line script requires a special Oxygen-Scripting license and does not work with a normal Oxygen XML Editor license. For more information and to obtain an Oxygen-Scripting license, see the Oxygen Scripting Web Page.
You can execute a Validate and Check for Completeness operation with a script ran from the command-line interface. The operation can be executed by running the following script:
  • Windows:
    validateCheckDITA.bat -i mainDitamapPath -s settingsFile -r reportFile
  • Linux:
    sh validateCheckDITA.sh -i mainDitamapPath -s settingsFile -r reportFile
  • Mac OS X:
    sh validateCheckDITAMac.sh -i mainDitamapPath -s settingsFile -r reportFile
The script is located in the Oxygen XML Editor installation folder and can be integrated in an external batch process launched from the command-line interface. The script accepts a variety command line arguments that allow you to configure the validation.

The accepted arguments are as follows:

mainDitamapPath
The path to the main DITA map file to validate. This is a required parameter.
settingsFile
The options file for the validate and completeness check. This file can be obtained from the DITA Map Completeness Check dialog box by using the Export Settings action. If this parameter is missing, the default options for the validation will be used.
reportFile
The file where the validation report will be saved. If this parameter is missing, the report will be displayed in the console.
Note: When using this script, some of the options that appear in the DITA Map Completeness Check dialog box are ignored. The ignored options include:
Tip: You can use DITAVAL filter files with the script by specifying one or more ditaval files in the Use DITAVAL filters: Other DITAVAL files option in the DITA Map Completeness Check dialog box.

Result: The validation result is displayed in the command line interface. This includes whether or not the validation was successful, the number of issues, and the path to the report file (if the reportFile parameter was used), or the actual content of the validation result if the reportFile parameter was not used.

Restriction: When using this script, the Saxon 9 XSLT processor used to apply custom Schematron checks is not licensed and therefore the Schematron cannot call external Java extensions.