Skip to main content
Skip table of contents

DCP Schema Guide

This guide provides a short description of each element and attribute defined in the XML schema for the Document Comparator Pipeline (DCP). A fuller description of DCP, along with an example and an explanation of the main concepts can be found in the DCP User Guide.

Element Index

Element Detail

Elements are listed in document-tree order, top-level elements first, then alphabetically:

Element: documentComparator 1

The root element for defining the overrides to a DocumentComparator whose defaults are as described in the API documentation.

A Document Comparator instance with default settings is created if no child elements are present.

Contained by

/

Contains
AttributeTypeDescription
idanyNameType A unique identifier for this pipeline configuration - listed as 'configuration id' in the command-line description.
versionstring The DCP specification version this conforms to - fixed at '1.0'
descriptionstring Short description of this DCP configuration.
ElementDescription
advancedConfig Configuration options providing low-level control of the comparison, more general configuration options are in 'standardConfig'
extensionPoints Declare the extension points and contained filters to be inserted within the DocumentComparator pipeline
fullDescription Designed to provide meaningful description and basic help information to the user
pipelineParameters Container for all pipeline parameters
standardConfig Genaral configuration options for the DocumentComparator - see 'advancedConfig' for further options

Element: advancedConfig 2

Configuration options providing low-level control of the comparison, more general configuration options are in 'standardConfig'

Contained by
Contains
ElementDescription
outputProperties Set Serializer property settings for the built in Saxon Serializer
parserFeatures Set features on the underlying SAX parser used in the pipeline
parserProperties Set properties on the underlying SAX parser used in the pipeline
transformerConfigurationProperties Set configuration option on the Saxon XSLT transformers used in the pipeline

Element: extensionPoints 3

Declare the extension points and contained filters to be inserted within the DocumentComparator pipeline.

In EBNF the required sequence S of child elements is:

  • S := 'inputPreFlatteningPoint'? IP 'outputExtensionPoints'?
  • IP := 'inputExtensionPoints'? | ( 'inputAExtensionPoints'? 'inputBExtensionPoints'? )

Contained by
Contains
ElementDescription
inputAExtensionPoints Extension points for modifying input A filter chains, after element flattening
inputBExtensionPoints Extension points for modifying input B filter chains, after element flattening
inputExtensionPoints Extension points for modifying A and B input filter chains, after element flattening
inputPreFlatteningPoint Extension point for modifying A and B input filters, before element flattening
outputExtensionPoints Extension points for modifying output filter chains, after element flattening

Element: fullDescription 4

Designed to provide meaningful description and basic help information to the user.

It can contain PCDATA content. It should include a description of the Document Comparator configuration defined by the DCP. How this information is presented to users is a tool-dependent operation, for example a GUI-based tool may provide a pop-up window and show HTML formatted content.

Contained by
Contains
ElementDescription
[any]Any element permitted [mixed content]

Element: pipelineParameters 5

Container for all pipeline parameters.

Pipeline parameters have global scope and are referenced using the 'paremeterRef' attribute. Pipeline parameters have a default value that can be overridden through the API. The maximum number of child elements is not restricted.

Contained by
Contains
ElementDescription
booleanParameter Declare a boolean parameter that may be referenced by 'parameterRef' attributes or as $variables from within XPath expressions
stringParameter Declare a string parameter that may be referenced by 'parameterRef' attributes or as $variables from within XPath expressions

Element: standardConfig 6

Genaral configuration options for the DocumentComparator - see 'advancedConfig' for further options.

Contained by
Contains
ElementDescription
calsTableConfiguration Specifies configuration options for CALS table comparison
htmlTableConfiguration Specifies configuration options for HTML table comparison
lexicalPreservation Configures the way lexical information is preserved
mathmlConfiguration Specifies configuration options for MathML processing
outputFormatConfiguration Specifies configuration options related to the format of the comparison result from a DocumentComparator
resultReadabilityOptions Sets options to change the granularity and ordering of changes in the result in order to improve readability
svgConfiguration Specifies configuration options for SVG Comparison
tableConfiguration Specifies configuration options for table comparison

Element: outputProperties 7

Set Serializer property settings for the built in Saxon Serializer.

Contained by
Contains
ElementDescription
property Sets the string value of a named property

Element: parserFeatures 8

Set features on the underlying SAX parser used in the pipeline.

For more detail, see setParserFeature in the API documentation.

Contained by
Contains
ElementDescription
feature Sets the boolean value of a named feature

Element: parserProperties 9

Set properties on the underlying SAX parser used in the pipeline.

For more detail, see setParserProperty in the API documentation.

Contained by
Contains
ElementDescription
property Sets the string value of a named property

Element: transformerConfigurationProperties 10

Set configuration option on the Saxon XSLT transformers used in the pipeline.

The maximum number of child elements is not restricted.

Contained by
Contains
ElementDescription
booleanProperty A named boolean property
stringProperty A named string property

Element: inputAExtensionPoints 11

Extension points for modifying input A filter chains, after element flattening.

Contained by
Contains
ElementDescription
postTablePoint The filter extension point immediately after table processing
preTablePoint The filter extension point immediately before table processing

Element: inputBExtensionPoints 12

Extension points for modifying input B filter chains, after element flattening.

Contained by
Contains
ElementDescription
postTablePoint The filter extension point immediately after table processing
preTablePoint The filter extension point immediately before table processing

Element: inputExtensionPoints 13

Extension points for modifying A and B input filter chains, after element flattening.

Contained by
Contains
ElementDescription
postTablePoint The filter extension point immediately after table processing
preTablePoint The filter extension point immediately before table processing

Element: inputPreFlatteningPoint 14

Extension point for modifying A and B input filters, before element flattening.

Contained by
Contains
ElementDescription
filter An XSLT or Java XML processing filter to be loaded into the DocumentComparator pipeline

Element: outputExtensionPoints 15

Extension points for modifying output filter chains, after element flattening.

Contained by
Contains
ElementDescription
finalPoint The final filter extension point in the DocumentComparator output pipeline
postTablePoint The filter extension point immediately after table processing
preAttributePoint The filter extension point after table processing and just before attribute processing in the DocumentComparator output pipeline
preTablePoint The filter extension point immediately before table processing

Element: booleanParameter 16

Declare a boolean parameter that may be referenced by 'parameterRef' attributes or as $variables from within XPath expressions.

Contained by
Contains
AttributeTypeDescription
nameNCName The boolean parameter name
defaultValueboolean The default boolean value - may be overriden externally
ElementDescription
description Short summary of the purpose of the parameter

Element: stringParameter 17

Declare a string parameter that may be referenced by 'parameterRef' attributes or as $variables from within XPath expressions.

Contained by
Contains
AttributeTypeDescription
nameNCName The string parameter name
defaultValuestring The default string value - may be overriden externally
ElementDescription
description Short summary of the purpose of the parameter

Element: calsTableConfiguration 18

Specifies configuration options for CALS table comparison.

These configuration options can be specified on a DocumentComparator to configure its behaviour when comparing tables.

Contained by
Contains
ElementDescription
calsColumnKeyingMode Sets the column keying mode used to align table columns when the table processing is enabled
calsValidationLevel Sets the ValidationLevel to use for CALS table validation
ignoreColumnOrder Sets whether the DocumentComparator should ignore table column order
invalidCalsTableBehaviour Sets the behaviour to use when inputs contain invalid CALS tables
processCalsTables Sets whether the DocumentComparator should process CALS tables
warningReportMode Specifies how table invalidity warnings should be reported

Element: htmlTableConfiguration 19

Specifies configuration options for HTML table comparison.

These configuration options can be specified on a DocumentComparator to configure its behaviour when comparing tables.

Contained by
Contains
ElementDescription
htmlColumnKeyingMode Sets the column keying mode used to align table columns when the table processing is enabled
htmlValidationLevel Sets the ValidationLevel to use for HTML table validation
ignoreColumnOrder Sets whether the DocumentComparator should ignore table column order
invalidHtmlTableBehaviour Sets the behaviour to use when inputs contain invalid HTML tables
normalizeHtmlTables Sets whether the Document Comparator should normalize the specification of columns in HTML tables
processHtmlTables Sets whether the DocumentComparator should process HTML tables
warningReportMode Specifies how table invalidity warnings should be reported

Element: lexicalPreservation 20

Configures the way lexical information is preserved.

This is mostly for lexical artifacts that are not included in the standards for the XPath Data Model or XML Infoset. The exceptions are comment and processing-instruction nodes that are controlled here also.

Contained by
Contains
ElementDescription
defaults This required element is the container for elements that set the defaults for all lexical preservation artifacts
overrides Container for elements that override defaults for specific lexical preservation artifacts

Element: mathmlConfiguration 21

Specifies configuration options for MathML processing.

These configuration options can be specified on a DocumentComparator to configure its behaviour when comparing MathML.

Contained by
Contains
ElementDescription
enableMathml Sets whether the DocumentComparator should use MathML-specific processing
mathmlGranularity Sets the granularity at which the differences between two MathML expressions will be represented

Element: outputFormatConfiguration 22

Specifies configuration options related to the format of the comparison result from a DocumentComparator.

Contained by
Contains
ElementDescription
attributeChangeMarked Sets the behaviour for marking elements with an attribute changed marker - for cases where attribute changes can not otherwise be represented
frameMakerTcsTableChangeMode Specify how table changes are propagated for FrameMaker tracked changes representations, the default is down
grouping Sets the behaviour for grouping adjacent changes
modifiedAttributeMode Determines how modified attributes are represented in the output
modifiedFormatOutput Sets the behaviour for outputting elements with modified formatting
orderlessPresentationMode Specifies how the child elements of 'orderless' elements should be output
resultFormat Specifies the format of results output from the DocumentComparator
trackChangesAuthor Author name to use when generating tracked changes in the result document
trackChangesDate The date-time to be used for tracked change representations, otherwise the current date-time is used
xmetalTcsTableChangeMode Specify how table changes are propagated for XMetal tracked changes representations, the default is down

Element: resultReadabilityOptions 23

Sets options to change the granularity and ordering of changes in the result in order to improve readability.

Contained by
Contains
ElementDescription
changeGatheringEnabled Sets whether to change the order of consecutive changed items to improve readability
characterByCharacterEnabled Sets whether to enable character by character comparison
detectMoves Sets the moves detection feature on or off
elementSplittingEnabled Sets whether modified elements containing text should be split when the amount of unchanged text falls below a given percentage
elementSplittingThreshold Sets the percentage of unchanged text present in a modified element below which the element will be split
mixedContentDetectionScope Set the scope to use for determining if each element in the document is of a mixed-content type
modifiedWhitespaceBehaviour Set the ModifiedWhitespaceBehaviour to use for changes to whitespace
moveAttributeXpath Sets id attribute XPath to be used during moves detection
orphanedWordDetectionEnabled States whether or not orphaned word detection is enabled
orphanedWordLengthLimit Sets the maximum number of words to consider for orphaned word detection
orphanedWordMaxPercentage Sets the maximum proportion of the total change size that orphaned words can take while still being considered orphans
removeMoveSource Removes move source

Element: svgConfiguration 24

Specifies configuration options for SVG Comparison.

These configuration options can be specified on a DocumentComparator to configure its behaviour when comparing SVG.

Contained by
Contains
ElementDescription
enableNumericTolerance Sets whether to use a numeric tolerance
enableSVG Sets whether the DocumentComparator should do SVG comparison
enableZIndex Sets whether to use move handling within SVG Comparisons to markup Z-index changes
fallback Determines whether to fallback to {@link SVGComparisonGranularity
fallbackChangePercentage Sets Fallback Change Percentage setting for SVG comparison results
numericToleranceValue Sets the numeric tolerance value for SVG comparison results
svgGranularity Sets the granularity at which the differences between two SVG images will be represented
svgInputAMarkupStyle Sets the Input A SVG markup style setting for SVG comparison results
svgInputBMarkupStyle Sets the Input A SVG markup style setting for SVG comparison results
svgZIndexMarkupStyle Sets the Input Z SVG markup style setting for SVG comparison results
xPathToReferencedSVG Sets XPath to the referenced SVG

Element: tableConfiguration 25

Specifies configuration options for table comparison.

These configuration options can be specified on a DocumentComparator to configure its behaviour when comparing tables.

Contained by
Contains
ElementDescription
calsValidationLevel Sets the ValidationLevel to use for CALS table validation
invalidCalsTableBehaviour Sets the behaviour to use when inputs contain invalid CALS tables
processCalsTables Sets whether the DocumentComparator should process CALS tables
processHtmlTables Sets whether the DocumentComparator should process HTML tables
warningReportMode Specifies how table invalidity warnings should be reported

Element: property 26

Sets the string value of a named property

Contained by
Contains
AttributeTypeDescription
nameanyNameTypeThe parameter name
literalValuestring The literal string value
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: feature 27

Sets the boolean value of a named feature.

Contained by
Contains
AttributeTypeDescription
literalValueboolean The literal boolean value for the feature setting.
nameanyURI The fully qualitifed feature name.
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: booleanProperty 28

A named boolean property

Contained by
Contains
AttributeTypeDescription
nameanyNameTypeThe parameter name
literalValuebooleanThe literal boolean value
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: stringProperty 29

A named string property

Contained by
Contains
AttributeTypeDescription
nameanyNameTypeThe parameter name
literalValuestring The literal string value
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: postTablePoint 30

The filter extension point immediately after table processing.

Contained by
Contains
ElementDescription
filter An XSLT or Java XML processing filter to be loaded into the DocumentComparator pipeline

Element: preTablePoint 31

The filter extension point immediately before table processing.

The preTablePoint element must be placed before the postTablePoint element.

Contained by
Contains
ElementDescription
filter An XSLT or Java XML processing filter to be loaded into the DocumentComparator pipeline

Element: filter 32

An XSLT or Java XML processing filter to be loaded into the DocumentComparator pipeline.

There must be one 'class', 'http', 'resource' or 'file' child element for a filter element as this defines the filter type and how it is to be loaded. Attributes on the filter element may be used to control whether the filter is enabled or disabled.
Child 'parameter' elements may also be added so that parameter values are passed on to matching parameters in the XML filter. Any number of filter elements may be added to an extension point, filters are processed in the pipeline in order of occurrence.

Contained by
Contains
AttributeTypeDescription
ifNCName Enable filter when named boolean pipelineParameter is true.
unlessNCName Disable filter when named boolean pipelineParameter is true.
whenstring Enable filter when XPath expression evaluates true.
ElementDescription
class Load a Java class implementing the SAX XMLFilter interface from the ClassPath
file Load an XSLT filter from the file system
http Load XSLT filter from an identified HTTP resource
parameter A named parameter to supply to a filter - any XPath-item type (including a sequence) can be supplied to an XSLT filter using the xpath attribute
resource Load an XSLT filter as a resource in a jar file

Element: finalPoint 33

The final filter extension point in the DocumentComparator output pipeline.

Contained by
Contains
ElementDescription
filter An XSLT or Java XML processing filter to be loaded into the DocumentComparator pipeline

Element: preAttributePoint 34

The filter extension point after table processing and just before attribute processing in the DocumentComparator output pipeline.

The element must be placed after any ...TablePoint elements.

Contained by
Contains
ElementDescription
filter An XSLT or Java XML processing filter to be loaded into the DocumentComparator pipeline

Element: description 35

Short summary of the purpose of the parameter.

Contained by
Contains

Type: xs:string

Element: calsColumnKeyingMode 36

Sets the column keying mode used to align table columns when the table processing is enabled.

In AUTO mode, the comparator will automatically handle the entire keying process. Only AUTO mode allows for user-defined keys in the input files. This is not possible in other modes. In COLNAME mode, comparator will use column names (defined by @colname) as keys. In POSITION mode, comparator will use column positions as keys. Indexing starts from 1 and the maximum position is defined by the number of columns described by @cols attribute.

Contained by
Contains
AttributeTypeDescription
literalValue[enum]

Permitted values / descriptions:


auto
Automatically handles table column keying.
colname
Uses @colname attribute values as keys.
position
Uses table column positions as keys.
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: calsValidationLevel 37

Sets the ValidationLevel to use for CALS table validation.

A value of ValidationLevel.STRICT will cause the InvalidTableBehaviour mode to be used for any CALS invalidity. A value of ValidationLevel.RELAXED means that invalidities which are known to have no effect on CALS processing will not prevent CALS processing from running. N.B. Warnings will be reported according to the WarningReportMode regardless of the setting used here.

Contained by
Contains
AttributeTypeDescription
literalValue[enum]

Permitted values / descriptions:


relaxed
Performs relaxed validation.
strict
Performs strict validation.
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: ignoreColumnOrder 38

Sets whether the DocumentComparator should ignore table column order.

Contained by
Contains
AttributeTypeDescription
literalValuebooleanSet true to ignore table column order
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: invalidCalsTableBehaviour 39

Sets the behaviour to use when inputs contain invalid CALS tables.

Some of the processing used for CALS table comparison makes the assumption that the tables conform to the CALS specification. In order to avoid errors in this processing, the tables are first validated to ensure that it will work as expected. When tables are not valid, there are several options for the behaviour that the comparison should take. This enum is used to specify the options

Contained by
Contains
AttributeTypeDescription
literalValue[enum]

Permitted values / descriptions:


compareAsXml
Compare tables as 'plain' XML.
fail
Throw an Exception when invalid tables are encountered.
propagateUp
Propagate the changes to the <tgroup> level of the table.
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: processCalsTables 40

Sets whether the DocumentComparator should process CALS tables.

CALS table processing is recommended as it will perform sophisticated processing when comparing two CALS tables to ensure that the resulting CALS table is valid.

Contained by
Contains
AttributeTypeDescription
literalValuebooleanSet true to enable processing of CALS tables
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: warningReportMode 41

Specifies how table invalidity warnings should be reported.

Contained by
Contains
AttributeTypeDescription
literalValue[enum]

Permitted values / descriptions:


comments
Reports warnings using XML comments.
message
Reports warnings using <xsl:message/>.
processingInstructions
Reports warning using processing instructions with the format <?dxml_warn warning content ?>.
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: htmlColumnKeyingMode 42

Sets the column keying mode used to align table columns when the table processing is enabled.

In AUTO mode, the comparator will automatically handle the entire keying process. Only AUTO mode allows for user-defined keys in the input files. This is not possible in other modes. In POSITION mode,comparator will use column positions as keys. Indexing starts from 1 and the maximum position is defined by the number of columns described by @col attribute.

Contained by
Contains
AttributeTypeDescription
literalValue[enum]

Permitted values / descriptions:


auto
Automatically handles table column keying.
position
Uses table column positions as keys.
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: htmlValidationLevel 43

Sets the ValidationLevel to use for HTML table validation.

A value of ValidationLevel.STRICT will cause the InvalidTableBehaviour mode to be used for any HTML invalidity. A value of ValidationLevel.RELAXED means that invalidities which are known to have no effect on HTML processing will not prevent HTML processing from running. N.B. Warnings will be reported according to the WarningReportMode regardless of the setting used here.

Contained by
Contains
AttributeTypeDescription
literalValue[enum]

Permitted values / descriptions:


relaxed
Performs relaxed validation.
strict
Performs strict validation.
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: invalidHtmlTableBehaviour 44

Sets the behaviour to use when inputs contain invalid HTML tables.

Some of the processing used for HTML table comparison makes the assumption that the tables conform to the HTML specification. In order to avoid errors in this processing, the tables are first validated to ensure that it will work as expected. When tables are not valid, there are several options for the behaviour that the comparison should take. This enum is used to specify the options

Contained by
Contains
AttributeTypeDescription
literalValue[enum]

Permitted values / descriptions:


compareAsXml
Compare tables as 'plain' XML.
fail
Throw an Exception when invalid tables are encountered.
propagateUp
Propagate the changes to the <tgroup> level of the table.
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: normalizeHtmlTables 45

Sets whether the Document Comparator should normalize the specification of columns in HTML tables.

This setting is recommended when there is a difference between inputs of specifying columns, e.g. if one uses just * <colgroup> and another uses <col> without <colgroup>.

Contained by
Contains
AttributeTypeDescription
literalValueboolean Set true to enable normalization of HTML table column specification
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: processHtmlTables 46

Sets whether the DocumentComparator should process HTML tables.

HTML table processing is recommended as it will perform sophisticated processing when comparing two HTML tables to ensure that the resulting HTML table is valid.

Contained by
Contains
AttributeTypeDescription
literalValueboolean Set true to enable processing of HTML tables
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: defaults 47

This required element is the container for elements that set the defaults for all lexical preservation artifacts.

Contained by
Contains
ElementDescription
outputType Set the default PreservationOutputType for changes to preserved items
processingMode Sets the 'PreservationProcessingMode' for controlling behaviour when preserved lexical artifacts have changed
retain Sets whether information on a lexical preservation artifact is preserved in the pipeline

Element: overrides 48

Container for elements that override defaults for specific lexical preservation artifacts

Contained by
Contains
ElementDescription
advancedEntityReferenceUsage For controlling some specialist use cases, where both the entity references and their replacement text are compared
outerPiAndCommentProcessingMode Set processingMode for processing-instructions and comments occurring before or after the root element
preserveItems Container for preservation of specific lexical preservation artifacts, these override general preservation settings for all artifacts contained in the 'defaults' element

Element: enableMathml 49

Sets whether the DocumentComparator should use MathML-specific processing.

MathML processing is recommended as it will use MATHML-aware features when comparing two MathML expressions to ensure that the result can be rendered.

Contained by
Contains
AttributeTypeDescription
literalValueboolean Set true to enable MathML processing
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: mathmlGranularity 50

Sets the granularity at which the differences between two MathML expressions will be represented.

Contained by
Contains
AttributeTypeDescription
literalValue[enum]

Permitted values / descriptions:


adjacent
Reports the differences by repeating A and B MathML adjacent to each other.
detailed-adjacent
Reports the differences by repeating the A and B MathML adjacent to each other. Content within the adjacent A and B views is highlighted at the specific parts where it is different.
inline
Reports the differences inline within the MathML without duplicating A and B. If the differences are too complex to easily render inline, the 'detailed-adjacent' view is used.
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: attributeChangeMarked 51

Sets the behaviour for marking elements with an attribute changed marker - for cases where attribute changes can not otherwise be represented.

Contained by
Contains
AttributeTypeDescription
literalValueboolean Set 'true' to mark changed attributes in output.
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: frameMakerTcsTableChangeMode 52

Specify how table changes are propagated for FrameMaker tracked changes representations, the default is down.

Contained by
Contains
AttributeTypeDescription
literalValue[enum]

Permitted values / descriptions:


down
Changes in rows and cells are pushed down to the cell content level.
ignore
All changes in a table are ignored.
up
Changes in rows and cells are pushed up to the table level.
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: grouping 53

Sets the behaviour for grouping adjacent changes.

Contained by
Contains
AttributeTypeDescription
literalValueboolean Set 'true' to group adjacent changes in output.
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: modifiedAttributeMode 54

Determines how modified attributes are represented in the output.

Contained by
Contains
AttributeTypeDescription
literalValue[enum]

Permitted values / descriptions:


useDefault
The behaviour will depend on other parameter settings, primarily the output-format.
change
The associated modified attribute filter will be skipped, thus leaving the delta attribute change markup alone.
A
Output the 'A' version of modified attributes and any deleted ('A') attributes.
AB
Output the 'A' version of modified attributes.
B
Output the 'B' version of modified attributes and any added ('B') attributes.
BA
Output the 'B' version of modified attributes.
encode-as-attributes
Output the 'B' version of modified attributes and any added ('B') attributes but additionally show the changes encoded as attributes in the attribute-change ('ac') namespace.
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: modifiedFormatOutput 55

Sets the behaviour for outputting elements with modified formatting.

Contained by
Contains
AttributeTypeDescription
literalValue[enum]

Permitted values / descriptions:


useDefault
Choose the most relevant behaviour based on other configuration settings.
A
Output the formatting elements from the A input.
B
Output the formatting elements from the B input.
AB
Output the A and B formatting elements. Where A and B formatting elements overlap or are nested, use formatting elements from the A input.
BA
Output the A and B formatting elements. Where A and B formatting elements overlap or are nested, use formatting elements from the B input.
change
Represent all formatting element changes using the deltaV2.1 format.
content-group
Output each formatting element change using a content group.
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: orderlessPresentationMode 56

Specifies how the child elements of 'orderless' elements should be output.

Contained by
Contains
AttributeTypeDescription
literalValue[enum]

Permitted values / descriptions:


a_adds
Outputs elements from the A input, in order, followed by elements only in the B input, in order.
a_matches_deletes_adds
Outputs elements from both inputs in their A order, followed by elements only in A and then elements only in B.
b_deletes
Outputs elements from the B input, in order, followed by elements only in the A input, in order.
b_matches_adds_deletes
Outputs elements from both inputs in their B order, followed by elements only in B and then elements only in A.
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: resultFormat 57

Specifies the format of results output from the DocumentComparator.

The default resultFormat is 'delta'.

Contained by
Contains
AttributeTypeDescription
literalValue[enum]

Permitted values / descriptions:


arbortext-tc
Reports changes using the Arbortext editor track changes format.
delta
Reports changes using the DeltaXML delta file result.
oxygen-tc
Reports changes using oXygen Author track changes processing instructions.
xmetal-tc
Reports changes using XMetaL track changes processing instructions.
framemaker-tc
Reports changes using FrameMaker track changes processing instructions.
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: trackChangesAuthor 58

Author name to use when generating tracked changes in the result document.

Contained by
Contains
AttributeTypeDescription
literalValuestring The author name to use.
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: trackChangesDate 59

The date-time to be used for tracked change representations, otherwise the current date-time is used.

Contained by
Contains
AttributeTypeDescription
literalValuedateTime The date-time to use - example: 2001-10-26T21:32:52
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: xmetalTcsTableChangeMode 60

Specify how table changes are propagated for XMetal tracked changes representations, the default is down.

Contained by
Contains
AttributeTypeDescription
literalValue[enum]

Permitted values / descriptions:


down
Changes in rows and cells are pushed down to the cell content level.
ignore
All changes in a table are ignored.
up
Changes in rows and cells are pushed up to the table level.
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: changeGatheringEnabled 61

Sets whether to change the order of consecutive changed items to improve readability.

If the result contains a sequence of elements whose deltaxml:deltaV2 attribute values are mixed up in a sequence of As and Bs, enabling this feature will cause them to be reordered so that they are not mixed.

Contained by
Contains
AttributeTypeDescription
literalValuebooleanSet true to enabled change gathering
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: characterByCharacterEnabled 62

Sets whether to enable character by character comparison

Contained by
Contains
AttributeTypeDescription
literalValuebooleanSet true to enable character by character comparison
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: detectMoves 63

Sets the moves detection feature on or off.

The move detection feature uses unique ids to identify moves. These unique ids can be set using the option 'moveAttributeXpath'.

Contained by
Contains
AttributeTypeDescription
literalValuebooleanSet true to enable moves detection feature
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: elementSplittingEnabled 64

Sets whether modified elements containing text should be split when the amount of unchanged text falls below a given percentage.

Contained by
Contains
AttributeTypeDescription
literalValuebooleanSet true to enable element splitting
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: elementSplittingThreshold 65

Sets the percentage of unchanged text present in a modified element below which the element will be split.

Contained by
Contains
AttributeTypeDescription
literalValuePercentage The threshold percentage as in integer (1 to 100)
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: mixedContentDetectionScope 66

Set the scope to use for determining if each element in the document is of a mixed-content type.

The mixed content type affects whitespace processing. If DTD or XML Schema validation is used this setting has no effect.

Contained by
Contains
AttributeTypeDescription
literalValue[enum]

Permitted values / descriptions:


document
Determine if an element is mixed-content using information from elements of the same name in the document. Using this scope significantly slows processing for large files.
local
Determine mixed content information for each element in turn, based on the contents of that element alone.
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: modifiedWhitespaceBehaviour 67

Set the ModifiedWhitespaceBehaviour to use for changes to whitespace.

Here, both documents must have some whitespace at a given point in order for there to be a change in whitespace. This will then be processed in accordance with the specified behaviour. Whitespace insertions and deletions are not affected by the modified whitespace behaviour.

Contained by
Contains
AttributeTypeDescription
literalValue[enum]

Permitted values / descriptions:


useDefault
The context dependent automatic whitespace setting.
ignore
Ignore differences in whitespace that is not explicitly preserved.
keepA
Similar to 'ignore' except that 'A' document's whitespace is kept (instead of the 'B' document's whitespace).
normalize
Normalize whitespace in inputs before comparison.
show
Display the differences in whitespace where possible
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: moveAttributeXpath 68

Sets id attribute XPath to be used during moves detection.

This id attribute must be an unique identifier for an element. It is used to identify and detect source and target for an element move.

Contained by
Contains
AttributeTypeDescription
literalValuestringSets id attribute XPath to be used during moves detection
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: orphanedWordDetectionEnabled 69

States whether or not orphaned word detection is enabled.

Contained by
Contains
AttributeTypeDescription
literalValueboolean Enable/disable.
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: orphanedWordLengthLimit 70

Sets the maximum number of words to consider for orphaned word detection.

Sequences of words longer than the specified length will never be detected as orphaned words, regardless of the amount of changed words around them.

Contained by
Contains
AttributeTypeDescription
literalValueunsignedLong
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: orphanedWordMaxPercentage 71

Sets the maximum proportion of the total change size that orphaned words can take while still being considered orphans.

If the percentage value for a possibly orphaned section is less than or equal to this value, then it is classified as orphaned (unless there are more words than the length limit allows). The percentage value for a possibly orphaned section is calculated as follows:

Contained by
Contains
AttributeTypeDescription
literalValuePercentageAn integer value (1 to 100) that is the max percentage of the total change size were a change is considered to be orphaned.
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: removeMoveSource 72

Removes move source.

Contained by
Contains
AttributeTypeDescription
literalValuebooleanSet true to remove move source
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: enableNumericTolerance 73

Sets whether to use a numeric tolerance.

SVG comparison will check co-ordinate values are within specified tolerance and therefore can be considered having negligible change.

Contained by
Contains
AttributeTypeDescription
literalValueboolean Determines whether to use numeric tolerance
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: enableSVG 74

Sets whether the DocumentComparator should do SVG comparison.

SVG comparison is recommended as it will use SVG-aware features when comparing two SVG images to ensure that the result can be rendered.

Contained by
Contains
AttributeTypeDescription
literalValueboolean Set true to enable SVG comparison
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: enableZIndex 75

Sets whether to use move handling within SVG Comparisons to markup Z-index changes.

Contained by
Contains
AttributeTypeDescription
literalValueboolean Determines whether to use Z Index handling
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: fallback 76

Determines whether to fallback to {@link SVGComparisonGranularity.

ADJACENT}. SVG comparison granularity will fallback to SVGComparisonGranularity.ADJACENT if SVG exceeds the number changed elements defined by FallbackChangePercentage.

Contained by
Contains
AttributeTypeDescription
literalValueboolean Determines whether to fallback
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: fallbackChangePercentage 77

Sets Fallback Change Percentage setting for SVG comparison results.

The default value is 30.00%.

Contained by
Contains
AttributeTypeDescription
literalValuedouble Sets Fallback Change Percentage
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: numericToleranceValue 78

Sets the numeric tolerance value for SVG comparison results.

The default is 1%, but can be given as a fixed value. Adding '%' will switch value to percentage.

Contained by
Contains
AttributeTypeDescription
literalValuestring Sets the value for SVG numeric tolerance either a fixed value or percentage.
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: svgGranularity 79

Sets the granularity at which the differences between two SVG images will be represented.

Contained by
Contains
AttributeTypeDescription
literalValue[enum]

Permitted values / descriptions:


adjacent
Reports the differences by repeating A and B SVG adjacent to each other.
detailed-adjacent
Reports the differences by repeating the A and B SVG adjacent to each other. Content within the adjacent A and B views is highlighted at the specific parts where it is different.
animate-inline
Reports SVG differences by animating them by changing the opacity from 1 to 0 for delete and 0 to 1 for add. This setting will override any other SVG configuration.
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: svgInputAMarkupStyle 80

Sets the Input A SVG markup style setting for SVG comparison results.

The default is "red" and an SVG color can be provided as color names, RGB or RGBA values, HEX values, HSL or HSLA values.

Contained by
Contains
AttributeTypeDescription
literalValuestring Sets the Input A SVG markup style
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: svgInputBMarkupStyle 81

Sets the Input A SVG markup style setting for SVG comparison results.

The default is "green" and an SVG color can be provided as color names, RGB or RGBA values, HEX values, HSL or HSLA values.

Contained by
Contains
AttributeTypeDescription
literalValuestring Sets the Input A SVG markup style
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: svgZIndexMarkupStyle 82

Sets the Input Z SVG markup style setting for SVG comparison results.

The default is "purple" and an SVG color can be provided as color names, RGB or RGBA values, HEX values, HSL or HSLA values.

Contained by
Contains
AttributeTypeDescription
literalValuestring Sets the Input Z SVG markup style
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: xPathToReferencedSVG 83

Sets XPath to the referenced SVG.

Contained by
Contains
AttributeTypeDescription
literalValuestring Sets XPath to the referenced SVG.
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: class 84

Load a Java class implementing the SAX XMLFilter interface from the ClassPath.

Contained by
Contains
AttributeTypeDescription
nameanyNameTypeThe fully qualified name of the class.

Element: file 85

Load an XSLT filter from the file system.

Contained by
Contains
AttributeTypeDescription
pathstring The path of the filter to be loaded, relative paths are resolved according to the setting of the 'relBase' attribute.
relBase[enum]The relBase attribute is used to specify how the relative path to a file is resolved.

Permitted values / descriptions:


current
Resolve using the current working directory, obtained from the Java user.dir system property.
home
Resolve using the user's home directory.
dxp
Resolve using the directory containing the DXP file, when it is loaded from a file.

Element: http 86

Load XSLT filter from an identified HTTP resource.

Contained by
Contains
AttributeTypeDescription
urlanyURI The URL of the HTTP resource.

Element: parameter 87

A named parameter to supply to a filter - any XPath-item type (including a sequence) can be supplied to an XSLT filter using the xpath attribute.

Contained by
Contains
AttributeTypeDescription
nameanyNameTypeThe parameter name
literalValuestring The literal string value
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: resource 88

Load an XSLT filter as a resource in a jar file.

Contained by
Contains
AttributeTypeDescription
nameanyNameType The resource name, for example, '/xsl/resource.xsl'

Element: outputType 89

Set the default PreservationOutputType for changes to preserved items.

Used to specify how the lexically preserved items should be styled. Here, the two available styles are either 'normal' or 'encoded'. A third option of 'auto' enables the specified default style to be applied. Note that when 'auto' is selected for the default style then the default style is treated as 'normal'.

Contained by
Contains
AttributeTypeDescription
literalValue[enum]

Permitted values / descriptions:


useDefault
Specifies that the default encoding style should be used.
encoded
The encoded preservation element should appear encoded in the output.
normal
The encoded preservation element should be decoded by the final output transformation (which is typically part of serialisation process).
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: processingMode 90

Sets the 'PreservationProcessingMode' for controlling behaviour when preserved lexical artifacts have changed.

Contained by
Contains
AttributeTypeDescription
literalValue[enum]

Permitted values / descriptions:


useDefault
Use the default ProcessingMode
A
Keep the A version
AB
Keep the A version if it exists, otherwise keep the B version
AdB
Same as A, except when handling internal subset declarations which are treated as AB
B
Keep the B version
BA
Keep the B version if it exists, otherwise keep the A version
BdA
Same as B, except when handling internal subset declarations which are treated as BA
change
Keep change information as-is
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: retain 91

Sets whether information on a lexical preservation artifact is preserved in the pipeline.

The Java API equivalent is: 'setPreserve[artifactName]'.

Contained by
Contains
AttributeTypeDescription
literalValuebooleanSet true to keep information on a lexical preservation artifact.
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: advancedEntityReferenceUsage 92

For controlling some specialist use cases, where both the entity references and their replacement text are compared.

One use case where you might want to set this variable explicitly is: when you configure the comparator for standard 'round trip' lexical preservation, but the final output format cannot represent entity references. In this case, the REPLACE value can be used. This is an alternative to specifying a custom processing mode that performs round trip processing, except for entity references which are substituted for their values (i.e. their replacement text) prior to the comparison.

Contained by
Contains
AttributeTypeDescription
literalValue[enum]

Permitted values / descriptions:


useDefault
Choose one of the other three behaviours in a context dependent manner.
change
Keep the encoded form of the entity reference, with its change markup.
replace
Extract the replacement text from the encoded entity reference.
split
The encoded entity references have their replacement text removed and are split into 'new' and 'old' versions on detection of change.
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: outerPiAndCommentProcessingMode 93

Set processingMode for processing-instructions and comments occurring before or after the root element.

Contained by
Contains
AttributeTypeDescription
literalValue[enum]

Permitted values / descriptions:


useDefault
Use the default ProcessingMode
A
Keep the A version
AB
Keep the A version if it exists, otherwise keep the B version
AdB
Same as A, except when handling internal subset declarations which are treated as AB
B
Keep the B version
BA
Keep the B version if it exists, otherwise keep the A version
BdA
Same as B, except when handling internal subset declarations which are treated as BA
change
Keep change information as-is
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: preserveItems 94

Container for preservation of specific lexical preservation artifacts, these override general preservation settings for all artifacts contained in the 'defaults' element.

Contained by
Contains
ElementDescription
CDATA Controls preservation of CDATA sections found in the input documents
XMLDeclaration Controls preservation XML declarations in the input documents
comments Controls preservation of XML comment nodes found in the input documents
contentModel Controls preservation of DTD/Schema Element Content Model
defaultAttributeInfo Controls how information is preserved on DTD/Schema-defined default attributes added by the parser
doctype Controls preservation of DocType declarations and the internal DTD subset
documentLocation Controls preservation of the original document location (the systemId)
entityReferences Controls preservation of entity references found in the input documents
entityReplacementText Controls preservation of text to be used when entities are resolved
ignorableWhitespace Controls preservation of whitespace identified as ignorable by a DTD or XML Schema
nestedEntityReferences Controls preservation of entities references actually occurring within entities
processingInstructions Controls preservation of XML processing-instruction nodes found in the input documents

Element: CDATA 95

Controls preservation of CDATA sections found in the input documents.

Contained by
Contains
ElementDescription
outputType Set the default PreservationOutputType for changes to preserved items
processingMode Sets the 'PreservationProcessingMode' for controlling behaviour when preserved lexical artifacts have changed
retain Sets whether information on a lexical preservation artifact is preserved in the pipeline

Element: XMLDeclaration 96

Controls preservation XML declarations in the input documents.

Contained by
Contains
ElementDescription
outputType Set the default PreservationOutputType for changes to preserved items
processingMode Sets the 'PreservationProcessingMode' for controlling behaviour when preserved lexical artifacts have changed
retain Sets whether information on a lexical preservation artifact is preserved in the pipeline

Element: comments 97

Controls preservation of XML comment nodes found in the input documents.

Contained by
Contains
ElementDescription
outputType Set the default PreservationOutputType for changes to preserved items
processingMode Sets the 'PreservationProcessingMode' for controlling behaviour when preserved lexical artifacts have changed
retain Sets whether information on a lexical preservation artifact is preserved in the pipeline

Element: contentModel 98

Controls preservation of DTD/Schema Element Content Model.

Contained by
Contains
ElementDescription
retain Sets whether information on a lexical preservation artifact is preserved in the pipeline

Element: defaultAttributeInfo 99

Controls how information is preserved on DTD/Schema-defined default attributes added by the parser.

Contained by
Contains
ElementDescription
outputType Set the default PreservationOutputType for changes to preserved items
processingMode Sets the 'PreservationProcessingMode' for controlling behaviour when preserved lexical artifacts have changed
retain Sets whether information on a lexical preservation artifact is preserved in the pipeline

Element: doctype 100

Controls preservation of DocType declarations and the internal DTD subset.

Contained by
Contains
ElementDescription
outputType Set the default PreservationOutputType for changes to preserved items
processingMode Sets the 'PreservationProcessingMode' for controlling behaviour when preserved lexical artifacts have changed
retain Sets whether information on a lexical preservation artifact is preserved in the pipeline

Element: documentLocation 101

Controls preservation of the original document location (the systemId).

Contained by
Contains
ElementDescription
retain Sets whether information on a lexical preservation artifact is preserved in the pipeline

Element: entityReferences 102

Controls preservation of entity references found in the input documents.

Contained by
Contains
ElementDescription
outputType Set the default PreservationOutputType for changes to preserved items
processingMode Sets the 'PreservationProcessingMode' for controlling behaviour when preserved lexical artifacts have changed
retain Sets whether information on a lexical preservation artifact is preserved in the pipeline

Element: entityReplacementText 103

Controls preservation of text to be used when entities are resolved.

Contained by
Contains
ElementDescription
retain Sets whether information on a lexical preservation artifact is preserved in the pipeline

Element: ignorableWhitespace 104

Controls preservation of whitespace identified as ignorable by a DTD or XML Schema.

Contained by
Contains
ElementDescription
outputType Set the default PreservationOutputType for changes to preserved items
processingMode Sets the 'PreservationProcessingMode' for controlling behaviour when preserved lexical artifacts have changed
retain Sets whether information on a lexical preservation artifact is preserved in the pipeline

Element: nestedEntityReferences 105

Controls preservation of entities references actually occurring within entities.

Contained by
Contains
ElementDescription
retain Sets whether information on a lexical preservation artifact is preserved in the pipeline

Element: processingInstructions 106

Controls preservation of XML processing-instruction nodes found in the input documents.

Contained by
Contains
ElementDescription
outputType Set the default PreservationOutputType for changes to preserved items
processingMode Sets the 'PreservationProcessingMode' for controlling behaviour when preserved lexical artifacts have changed
retain Sets whether information on a lexical preservation artifact is preserved in the pipeline

This documentation was auto-generated from the DCP XML Schema XSD.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.