Configuration Properties

Private use characters are used to encode special character entities that are difficult to preserve when performing XSLT processing.

com.deltaxml.config.JavaPlatform.useSAXParserFactory

Specifies whether to use the SAXParserFactory rather than JAXP determined one.

In Java there is a standard mechanism for determine which XML parsers and XSLT transformers to use, based on the way in which a user has configured their computer; this is know as JAXP. This property provides a mechanism for insisting that the Saxon XSLT processor is used.

The default value is 'false'.

com.deltaxml.cmdline.forceOverwrite

Specifies whether the command line tool overwrites output files without prompting.

When set to true all 'non-optimised' processing stages have an intermediate result associated with them, in the form of a file with name 'DitaCompare__<stage name>.xml'. Some filters in the pipeline processing are optimised by essentially merging their processing; in these cases the result of the merged filters is produced.

This output is only intended for use when directed by DeltaXML support staff.

The default value is 'false'.

com.deltaxml.dita.DitaCompare.debug

Specifies whether the intermediate results are produced for debugging.

When set to true the time it taken by each of processing stages is recorded. Note that a zero time duration indicates one of two situations, either the stage was too fast to register a time, or more likely that stage has been 'optimized' (merged into another stage) and so is included in another stages results.

This output is only intended for use when directed by DeltaXML support staff.

The default value is 'false'.

com.deltaxml.dita.DitaCompare.timing

Specifies whether times for processing each filter are produced to the standard-output/console.

com.deltaxml.ext.catalog.files

Specifies the external catalog files to be searched.

The tool is preconfigured to include the catalog's for supported document versions. However, this mechanism provides a means for supplementing/overriding given catalog entries with a user defined catalog.

Note that this property can be bypassed by directly changing the default definition of the more general xml.catalog.files property (see below).

The default value is '' (the empty string).

xml.catalog.files

Specifies the catalog files to be searched.

This string provides a mechanism for setting the underpinning Apache XML commons resolver's catalog search path. Note that as this is a Java system property, it can be overridden on the command-line via use of the -Dxml.catalog.files=value JVM argument (or environmental setting). In general, this mechanism will only set the property, if it does not already exist.

Note changing the catalog files, can change what it means for a document to be valid, and thus affect the way in which the document comparison processing should be performed. For example, it can affect the allowed order of elements. Therefore, it is not possible for the tool to guarantee that valid inputs result in valid outputs if its catalog(s) have be modified or replaced.

The default value is '${com.deltaxml.ext.catalog.files};${com.deltaxml.rsc.catalog.files}'.

com.deltaxml.rsc.catalog.files

Specifies the the fixed internal catalog files to be searched.

This property cannot be modified, but can be referenced to enable the internal catalogs to be searched. By default the xml.catalog.files (see above) searches this catalog after any external catalog supplied by the user, via the com.deltaxml.ext.catalog.files property (see above), has been searched.

java.property.name

Provide the initial value for an unset java property.

It is possible to use a deltaxmlConfig.xml file to provide arbitrary Java system properties, so long as they do not already have a definition provided, such as one provided by a JVM argument (-Djava.property.name=value) or the environment. For example it is possible to specify the Apache catalog verbosity by setting the initial value of the xml.catalog.verbosity system property. This can be useful for seeing which the catalog(s) are actually being loaded and used.

In general, this mechanism will only set the property, if it does not already exist.