Configuration Options

These configuration options and values may be used in the command line, in Java and in REST.  More details are available in Javadoc here and for REST here .

Examples of using the REST API are available on Postman documentation.


 Table of Contents

ResultType

The ResultType specifies the type of post-processing applied to the merge result. The types available are:

ResultType ValueDescriptionMerge Type
concurrentthree-way (concurrent3)sequential
DELTAV2the raw result with no post-processing.
ANALYZED_DELTAV2performs first-line analysis of the result and adds attributes to indicate types of change
RULE_PROCESSED_DELTAV2applies default rules to auto-resolve the simple change types 'add' and 'delete'.
SIMPLIFIED_DELTAV2a simplified form of the deltaV2 format
SIMPLIFIED_RULE_PROCESSED_DELTAV2the simplified format with the simple change types 'add' and 'delete' auto-resolved.
TWO_WAY_RESULTa three-way merge converted to a two-way result

RULE_PROCESSED_TWO_WAY_RESULTa three-way merge converted to a two-way result, with rule processing applied

THREE_WAY_OXYGEN_TRACK_CHANGESstandard three-way merge except changes are displayed in Oxygen's track changes format

Specific Javadoc ResultType pages:

ConcurrentMergeResultType

ThreeWayMergeResultType

SequentialMergeResultType

DoctypePreservationMode

Controls how DOCTYPE declarations appear in the result. The available modes are:

REMOVE_ALWAYSno doctypes appear in the result, irrespective of what's in the inputs.
PRESERVE_WHEN_UNCHANGEDif no changes then preserved, otherwise removed.
ERROR_WHEN_CHANGEDif changes signal error, otherwise preserved in result.

For Javadoc see here.

EntityReferencePreservationMode

Controls how general entity references appear in the result. The available modes are:

USE_REPLACEMENT_TEXTEntity references are replaced with their 'replacement text' (which may actually include general XML such as text, attributes and elements).
PRESERVE_REFERENCESEntity references remain in the body of the XML content. Declarations in the internal subset will also be preserved where possible. If multiple declarations with different values are used in the inputs then multiple declarations may appear in the result.
PRESERVE_REFERENCES_ENCODED_FORMEntity references remain in the body of the XML content in encoded output format. Declarations in the internal subset will also be preserved where possible. If multiple declarations with different values are used in the inputs then multiple declarations may appear in the result.

For Javadoc, see here.

WordByWord

Controls the granularity of text/PCDATA comparison, alignment and change reporting:

true Text is segmented into words (as described in Unicode Annex 29, Section 4), compared and results are then reported as this granularity.
false Text is compared and changes reported corresponding to the text/PCDATA structure found in the comparison inputs.

For Javadoc see here for Concurrent and here for Sequential. Three-way merge is here.

ElementSplitting

Sets whether elements containing significantly modified text should be split.

true Enable element splitting when WordByWord is true and the amount of unchanged text in an element falls below 10%.
false Disable element splitting.

The Javadoc entry for Concurrent Merge is here and for Sequential Merge is here. Three-way merge is here.

Debug

Controls the generation of intermediate pipeline debug files. This parameter is not available for REST API-based command-line interface.

true Intermediate pipeline debug files are generated.
false Intermediate pipeline debug files are not generated.

The Javadoc entry for Concurrent Merge is here and for Sequential Merge is here. Three-way merge is here.

Table Configuration

CALS and HTML (DITA Simple Tables) have their own separate configuration objects, CalsTableConfiguration and HtmlTableConfiguration respectively. These objects share most of the same properties:

ProcessTables

Controls whether to enable processing for that type of tables.

true Enables the table processing.
false Disables the table processing.

Javadoc for the CALS parameter and HTML parameter.

InvalidTableBehaviour

This parameter declares what type of processing should be used for invalid tables.

PROPAGATE_UP

Propagate the changes to the  <tgroup>  level of the table.

COMPARE_AS_XML

Compare tables as 'plain' XML.

FAIL

Throw an Exception when invalid CALS tables are encountered.

Javadoc for the CALS parameter and HTML parameter.

ValidationLevel

Controls the validation level to use for table validation.

RELAXED

Performs relaxed validation. Invalidities which are known to have no effect on subsequent processing will not cause that processing to be bypassed.

STRICT

Performs strict validation. All invalidities will cause the appropriate subsequent processing to be bypassed.

Javadoc for the CALS parameter and HTML parameter.

WarningReportMode

Specifies how table invalidity warnings should be reported.

PROCESSING_INSTRUCTIONS

Reports warning using processing instructions with the format  <?dxml_warn warning content ?> .

COMMENTS

Reports warnings using XML comments.

MESSAGE

Reports warnings using <xsl:message/>.

Javadoc for the CALS parameter and HTML parameter.

NormalizeTable

HTML Tables Only

Controls whether to normalize the specification of columns in HTML tables.

true Enables the table normalization.
false Disables the table normalization.

Javadoc for the HTML parameter.

Additional Three Way Merge Parameters

ThreeToTwoResultPreset

Presets the corresponding RuleConfiguration and ResultType settings. The types available are:

ALL_CHANGESshows as many changes as possible.
CONFLICTING_CHANGESshows conflicts for further resolution. Simple, non-conflicting adds, deletes and modifications are automatically resolved.
THEIR_CHANGESshows conflicts for further resolution. Additionally changes in the third input are displayed. Simple, non-conflicting changes in the second input are automatically resolved. This is designed for merge scenarios where the third input corresponds to the 'remote' or other users (their) branch.

The Javadoc is here.

ResultFormat

Specifies the result format when using three-to-two merge. The formats available are:

XML_DELTAproduces a deltaV2 result.
OXYGEN_TRACK_CHANGES

produces a result format which is an XML file with processing instructions used in the accept/reject interface of the oXygen XML editor/author

DITA_MARKUPproduces a DITA document, using rev and status attributes to mark changes

The Javadoc is here.

#content .code