Configuration Files

The various REST services accept an XML configuration file alongside inputs to customise comparison behaviour. DocBook, DITA, HTML, Merge, Check, PDF, Word, and PowerPoint all accept a configuration file alongside the inputs when specifying a comparison or operation.

File format

The configuration file is validated against the XML Schema included in the product distribution in the relevant samples directory e.g. samples/compare/docbook/. Associate it with the XSD to enable XML editor autocompletion.

XML

<?xml version="1.0" encoding="UTF-8"?>
<configuration xmlns="com.deltaxml.docbook.rest.config"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xsi:noNamespaceSchemaLocation="docbook-configuration.xsd">
  <parameters>
    <!-- configuration elements here -->
  </parameters>
</configuration>

Passing the configuration file via REST

Content-Disposition: form-data; name="configuration"
/path/to/config.xml

Examples of key configuration parameters

Comparison granularity — word-by-word or character-by-character
MathML granularity — adjacent, detailed-adjacent, or inline
Table processing — column keying, validation level, invalid table behaviour
Formatting elements — which elements to treat as inline formatting
Output-specific settings — markup styles for A and B content