Configuration File

Introduction

DITA Compare’s REST API has been designed with a configuration file due to the complexity of the API. Its structure is modelled on that used in our DITA Compare Parameters documentation for the Java API.

The schema for the configuration file is defined using an XML Schema (XSD), the XSD file is included in the product distribution rest-resources directory and it is documented here: Topic Comparison Configuration File Schema Guide.

There is also a sample available here: configuration-sample.xml

Editing the Configuration File

To help ensure that you create a valid configuration file, it is recommended that you use an XML editor that supports XSD validation and associate the file with the configuration file XSD. The XSD association is made using the xsi:schemaLocation attribute with a URI value that links to the configuration XSD file dita-topic-configuration.xsd, included in the distribution's resources directory. For example:

XML

<?xml version="1.0" encoding="UTF-8"?>
<configuration 
  xmlns="com.deltaxml.dita.rest.config" 
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
  xsi:schemaLocation="com.deltaxml.dita.rest.config dita-topic-configuration.xsd">
  ...
</configuration>

Note that in the above example, the configuration file elements use the default prefix that is bound to the com.deltaxml.dita.rest.config namespace. The namespace is therefore also included as the first part of the xsi:schemaLocation value.

With this XSD association in your configuration file, your XML editor should provide auto-completion and context-specific help documentation as you type.