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

(10.4) DCP Schema Guide#advancedConfig 2

(10.4) DCP Schema Guide#advancedEntityReferenceUsage 75

(10.4) DCP Schema Guide#attributeChangeMarked 47

(10.4) DCP Schema Guide#booleanParameter 16

(10.4) DCP Schema Guide#booleanProperty 27

(10.4) DCP Schema Guide#calsTableConfiguration 18

(10.4) DCP Schema Guide#calsValidationLevel 35

(10.4) DCP Schema Guide#CDATA 78

(10.4) DCP Schema Guide#changeGatheringEnabled 57

(10.4) DCP Schema Guide#class 67

(10.4) DCP Schema Guide#comments 80

(10.4) DCP Schema Guide#contentModel 81

(10.4) DCP Schema Guide#defaultAttributeInfo 82

(10.4) DCP Schema Guide#defaults 43

(10.4) DCP Schema Guide#description 34

(10.4) DCP Schema Guide#detectMoves 58

(10.4) DCP Schema Guide#doctype 83

(10.4) DCP Schema Guide#documentComparator 1

(10.4) DCP Schema Guide#documentLocation 84

(10.4) DCP Schema Guide#elementSplittingEnabled 59

(10.4) DCP Schema Guide#elementSplittingThreshold 60

(10.4) DCP Schema Guide#enableMathml 45

(10.4) DCP Schema Guide#entityReferences 85

(10.4) DCP Schema Guide#entityReplacementText 86

(10.4) DCP Schema Guide#extensionPoints 3

(10.4) DCP Schema Guide#feature 26

(10.4) DCP Schema Guide#file 68

(10.4) DCP Schema Guide#filter 31

(10.4) DCP Schema Guide#finalPoint 32

(10.4) DCP Schema Guide#frameMakerTcsTableChangeMode 48

(10.4) DCP Schema Guide#fullDescription 4

(10.4) DCP Schema Guide#grouping 49

(10.4) DCP Schema Guide#htmlTableConfiguration 19

(10.4) DCP Schema Guide#htmlValidationLevel 39

(10.4) DCP Schema Guide#http 69

(10.4) DCP Schema Guide#ignorableWhitespace 87

(10.4) DCP Schema Guide#inputAExtensionPoints 11

(10.4) DCP Schema Guide#inputBExtensionPoints 12

(10.4) DCP Schema Guide#inputExtensionPoints 13

(10.4) DCP Schema Guide#inputPreFlatteningPoint 14

(10.4) DCP Schema Guide#invalidCalsTableBehaviour 36

(10.4) DCP Schema Guide#invalidHtmlTableBehaviour 40

(10.4) DCP Schema Guide#lexicalPreservation 20

(10.4) DCP Schema Guide#mathmlConfiguration 21

(10.4) DCP Schema Guide#mathmlGranularity 46

(10.4) DCP Schema Guide#mixedContentDetectionScope 61

(10.4) DCP Schema Guide#modifiedAttributeMode 50

(10.4) DCP Schema Guide#modifiedFormatOutput 51

(10.4) DCP Schema Guide#modifiedWhitespaceBehaviour 62

(10.4) DCP Schema Guide#moveAttributeXpath 63

(10.4) DCP Schema Guide#nestedEntityReferences 88

(10.4) DCP Schema Guide#normalizeHtmlTables 41

(10.4) DCP Schema Guide#orderlessPresentationMode 52

(10.4) DCP Schema Guide#orphanedWordDetectionEnabled 64

(10.4) DCP Schema Guide#orphanedWordLengthLimit 65

(10.4) DCP Schema Guide#orphanedWordMaxPercentage 66

(10.4) DCP Schema Guide#outerPiAndCommentProcessingMode 76

(10.4) DCP Schema Guide#outputExtensionPoints 15

(10.4) DCP Schema Guide#outputFormatConfiguration 22

(10.4) DCP Schema Guide#outputProperties 7

(10.4) DCP Schema Guide#outputType 72

(10.4) DCP Schema Guide#overrides 44

(10.4) DCP Schema Guide#parameter 70

(10.4) DCP Schema Guide#parserFeatures 8

(10.4) DCP Schema Guide#parserProperties 9

(10.4) DCP Schema Guide#pipelineParameters 5

(10.4) DCP Schema Guide#postTablePoint 29

(10.4) DCP Schema Guide#preAttributePoint 33

(10.4) DCP Schema Guide#preserveItems 77

(10.4) DCP Schema Guide#preTablePoint 30

(10.4) DCP Schema Guide#processCalsTables 37

(10.4) DCP Schema Guide#processHtmlTables 42

(10.4) DCP Schema Guide#processingInstructions 89

(10.4) DCP Schema Guide#processingMode 73

(10.4) DCP Schema Guide#property 25

(10.4) DCP Schema Guide#resource 71

(10.4) DCP Schema Guide#resultFormat 53

(10.4) DCP Schema Guide#resultReadabilityOptions 23

(10.4) DCP Schema Guide#retain 74

(10.4) DCP Schema Guide#standardConfig 6

(10.4) DCP Schema Guide#stringParameter 17

(10.4) DCP Schema Guide#stringProperty 28

(10.4) DCP Schema Guide#tableConfiguration 24

(10.4) DCP Schema Guide#trackChangesAuthor 54

(10.4) DCP Schema Guide#trackChangesDate 55

(10.4) DCP Schema Guide#transformerConfigurationProperties 10

(10.4) DCP Schema Guide#warningReportMode 38

(10.4) DCP Schema Guide#xmetalTcsTableChangeMode 56

(10.4) DCP Schema Guide#XMLDeclaration 79


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

Attribute

Type

Description

id

anyNameType

A unique identifier for this pipeline configuration - listed as 'configuration id' in the command-line description.

version

string

The DCP specification version this conforms to - fixed at '1.0'

description

string

Short description of this DCP configuration.

Element

Description

(10.4) DCP Schema Guide#advancedConfig

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

(10.4) DCP Schema Guide#extensionPoints

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

(10.4) DCP Schema Guide#fullDescription

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

(10.4) DCP Schema Guide#pipelineParameters

Container for all pipeline parameters

(10.4) DCP Schema Guide#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

/ (10.4) DCP Schema Guide#documentComparator

Contains

Element

Description

(10.4) DCP Schema Guide#outputProperties

Set Serializer property settings for the built in Saxon Serializer

(10.4) DCP Schema Guide#parserFeatures

Set features on the underlying SAX parser used in the pipeline

(10.4) DCP Schema Guide#parserProperties

Set properties on the underlying SAX parser used in the pipeline

(10.4) DCP Schema Guide#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

/ (10.4) DCP Schema Guide#documentComparator

Contains

Element

Description

(10.4) DCP Schema Guide#inputAExtensionPoints

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

(10.4) DCP Schema Guide#inputBExtensionPoints

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

(10.4) DCP Schema Guide#inputExtensionPoints

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

(10.4) DCP Schema Guide#inputPreFlatteningPoint

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

(10.4) DCP Schema Guide#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

/ (10.4) DCP Schema Guide#documentComparator

Contains

Element

Description

[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

/ (10.4) DCP Schema Guide#documentComparator

Contains

Element

Description

(10.4) DCP Schema Guide#booleanParameter

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

(10.4) DCP Schema Guide#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

/ (10.4) DCP Schema Guide#documentComparator

Contains

Element

Description

(10.4) DCP Schema Guide#calsTableConfiguration

Specifies configuration options for CALS table comparison

(10.4) DCP Schema Guide#htmlTableConfiguration

Specifies configuration options for HTML table comparison

(10.4) DCP Schema Guide#lexicalPreservation

Configures the way lexical information is preserved

(10.4) DCP Schema Guide#mathmlConfiguration

Specifies configuration options for MathML processing

(10.4) DCP Schema Guide#outputFormatConfiguration

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

(10.4) DCP Schema Guide#resultReadabilityOptions

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

(10.4) DCP Schema Guide#tableConfiguration

Specifies configuration options for table comparison

Element: outputProperties 7

Set Serializer property settings for the built in Saxon Serializer.

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#advancedConfig

Contains

Element

Description

(10.4) DCP Schema Guide#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

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#advancedConfig

Contains

Element

Description

(10.4) DCP Schema Guide#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

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#advancedConfig

Contains

Element

Description

(10.4) DCP Schema Guide#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

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#advancedConfig

Contains

Element

Description

(10.4) DCP Schema Guide#booleanProperty

A named boolean property

(10.4) DCP Schema Guide#stringProperty

A named string property

Element: inputAExtensionPoints 11

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

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints

Contains

Element

Description

(10.4) DCP Schema Guide#postTablePoint

The filter extension point immediately after table processing

(10.4) DCP Schema Guide#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

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints

Contains

Element

Description

(10.4) DCP Schema Guide#postTablePoint

The filter extension point immediately after table processing

(10.4) DCP Schema Guide#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

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints

Contains

Element

Description

(10.4) DCP Schema Guide#postTablePoint

The filter extension point immediately after table processing

(10.4) DCP Schema Guide#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

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints

Contains

Element

Description

(10.4) DCP Schema Guide#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

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints

Contains

Element

Description

(10.4) DCP Schema Guide#finalPoint

The final filter extension point in the DocumentComparator output pipeline

(10.4) DCP Schema Guide#postTablePoint

The filter extension point immediately after table processing

(10.4) DCP Schema Guide#preAttributePoint

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

(10.4) DCP Schema Guide#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

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#pipelineParameters

Contains

Attribute

Type

Description

name

NCName

The boolean parameter name

defaultValue

boolean

The default boolean value - may be overriden externally

Element

Description

(10.4) DCP Schema Guide#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

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#pipelineParameters

Contains

Attribute

Type

Description

name

NCName

The string parameter name

defaultValue

string

The default string value - may be overriden externally

Element

Description

(10.4) DCP Schema Guide#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

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig

Contains

Element

Description

(10.4) DCP Schema Guide#calsValidationLevel

Sets the ValidationLevel to use for CALS table validation

(10.4) DCP Schema Guide#invalidCalsTableBehaviour

Sets the behaviour to use when inputs contain invalid CALS tables

(10.4) DCP Schema Guide#processCalsTables

Sets whether the DocumentComparator should process CALS tables

(10.4) DCP Schema Guide#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

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig

Contains

Element

Description

(10.4) DCP Schema Guide#htmlValidationLevel

Sets the ValidationLevel to use for HTML table validation

(10.4) DCP Schema Guide#invalidHtmlTableBehaviour

Sets the behaviour to use when inputs contain invalid HTML tables

(10.4) DCP Schema Guide#normalizeHtmlTables

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

(10.4) DCP Schema Guide#processHtmlTables

Sets whether the DocumentComparator should process HTML tables

(10.4) DCP Schema Guide#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

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig

Contains

Element

Description

(10.4) DCP Schema Guide#defaults

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

(10.4) DCP Schema Guide#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

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig

Contains

Element

Description

(10.4) DCP Schema Guide#enableMathml

Sets whether the DocumentComparator should use MathML-specific processing

(10.4) DCP Schema Guide#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

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig

Contains

Element

Description

(10.4) DCP Schema Guide#attributeChangeMarked

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

(10.4) DCP Schema Guide#frameMakerTcsTableChangeMode

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

(10.4) DCP Schema Guide#grouping

Sets the behaviour for grouping adjacent changes

(10.4) DCP Schema Guide#modifiedAttributeMode

Determines how modified attributes are represented in the output

(10.4) DCP Schema Guide#modifiedFormatOutput

Sets the behaviour for outputting elements with modified formatting

(10.4) DCP Schema Guide#orderlessPresentationMode

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

(10.4) DCP Schema Guide#resultFormat

Specifies the format of results output from the DocumentComparator

(10.4) DCP Schema Guide#trackChangesAuthor

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

(10.4) DCP Schema Guide#trackChangesDate

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

(10.4) DCP Schema Guide#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

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig

Contains

Element

Description

(10.4) DCP Schema Guide#changeGatheringEnabled

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

(10.4) DCP Schema Guide#detectMoves

Sets the moves detection feature on or off

(10.4) DCP Schema Guide#elementSplittingEnabled

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

(10.4) DCP Schema Guide#elementSplittingThreshold

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

(10.4) DCP Schema Guide#mixedContentDetectionScope

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

(10.4) DCP Schema Guide#modifiedWhitespaceBehaviour

Set the ModifiedWhitespaceBehaviour to use for changes to whitespace

(10.4) DCP Schema Guide#moveAttributeXpath

Sets id attribute XPath to be used during moves detection

(10.4) DCP Schema Guide#orphanedWordDetectionEnabled

States whether or not orphaned word detection is enabled

(10.4) DCP Schema Guide#orphanedWordLengthLimit

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

(10.4) DCP Schema Guide#orphanedWordMaxPercentage

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

Element: tableConfiguration 24

Specifies configuration options for table comparison.

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

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig

Contains

Element

Description

(10.4) DCP Schema Guide#calsValidationLevel

Sets the ValidationLevel to use for CALS table validation

(10.4) DCP Schema Guide#invalidCalsTableBehaviour

Sets the behaviour to use when inputs contain invalid CALS tables

(10.4) DCP Schema Guide#processCalsTables

Sets whether the DocumentComparator should process CALS tables

(10.4) DCP Schema Guide#processHtmlTables

Sets whether the DocumentComparator should process HTML tables

(10.4) DCP Schema Guide#warningReportMode

Specifies how table invalidity warnings should be reported

Element: property 25

Sets the string value of a named property

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#advancedConfig / (10.4) DCP Schema Guide#outputProperties

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#advancedConfig / (10.4) DCP Schema Guide#parserProperties

Contains

Attribute

Type

Description

name

anyNameType

The parameter name

literalValue

string

The literal string value

parameterRef

string

Name of referenced pipelineParameter

xpath

[expression]

XPath expression returning the required type

Element: feature 26

Sets the boolean value of a named feature.

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#advancedConfig / (10.4) DCP Schema Guide#parserFeatures

Contains

Attribute

Type

Description

literalValue

boolean

The literal boolean value for the feature setting.

name

anyURI

The fully qualitifed feature name.

parameterRef

string

Name of referenced pipelineParameter

xpath

[expression]

XPath expression returning the required type

Element: booleanProperty 27

A named boolean property

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#advancedConfig / (10.4) DCP Schema Guide#transformerConfigurationProperties

Contains

Attribute

Type

Description

name

anyNameType

The parameter name

literalValue

boolean

The literal boolean value

parameterRef

string

Name of referenced pipelineParameter

xpath

[expression]

XPath expression returning the required type

Element: stringProperty 28

A named string property

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#advancedConfig / (10.4) DCP Schema Guide#transformerConfigurationProperties

Contains

Attribute

Type

Description

name

anyNameType

The parameter name

literalValue

string

The literal string value

parameterRef

string

Name of referenced pipelineParameter

xpath

[expression]

XPath expression returning the required type

Element: postTablePoint 29

The filter extension point immediately after table processing.

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputAExtensionPoints

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputBExtensionPoints

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputExtensionPoints

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#outputExtensionPoints

Contains

Element

Description

(10.4) DCP Schema Guide#filter

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

Element: preTablePoint 30

The filter extension point immediately before table processing.

The preTablePoint element must be placed before the postTablePoint element.

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputAExtensionPoints

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputBExtensionPoints

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputExtensionPoints

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#outputExtensionPoints

Contains

Element

Description

(10.4) DCP Schema Guide#filter

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

Element: filter 31

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

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputPreFlatteningPoint

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputAExtensionPoints / (10.4) DCP Schema Guide#postTablePoint

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputAExtensionPoints / (10.4) DCP Schema Guide#preTablePoint

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputBExtensionPoints / (10.4) DCP Schema Guide#postTablePoint

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputBExtensionPoints / (10.4) DCP Schema Guide#preTablePoint

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputExtensionPoints / (10.4) DCP Schema Guide#postTablePoint

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputExtensionPoints / (10.4) DCP Schema Guide#preTablePoint

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#outputExtensionPoints / (10.4) DCP Schema Guide#finalPoint

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#outputExtensionPoints / (10.4) DCP Schema Guide#postTablePoint

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#outputExtensionPoints / (10.4) DCP Schema Guide#preAttributePoint

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#outputExtensionPoints / (10.4) DCP Schema Guide#preTablePoint

Contains

Attribute

Type

Description

if

NCName

Enable filter when named boolean pipelineParameter is true.

unless

NCName

Disable filter when named boolean pipelineParameter is true.

when

string

Enable filter when XPath expression evaluates true.

Element

Description

(10.4) DCP Schema Guide#class

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

(10.4) DCP Schema Guide#file

Load an XSLT filter from the file system

(10.4) DCP Schema Guide#http

Load XSLT filter from an identified HTTP resource

(10.4) DCP Schema Guide#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

(10.4) DCP Schema Guide#resource

Load an XSLT filter as a resource in a jar file

Element: finalPoint 32

The final filter extension point in the DocumentComparator output pipeline.

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#outputExtensionPoints

Contains

Element

Description

(10.4) DCP Schema Guide#filter

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

Element: preAttributePoint 33

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

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#outputExtensionPoints

Contains

Element

Description

(10.4) DCP Schema Guide#filter

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

Element: description 34

Short summary of the purpose of the parameter.

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#pipelineParameters / (10.4) DCP Schema Guide#booleanParameter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#pipelineParameters / (10.4) DCP Schema Guide#stringParameter

Contains

Type: xs:string

Element: calsValidationLevel 35

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

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#calsTableConfiguration

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#tableConfiguration

Contains

Attribute

Type

Description

literalValue

[enum]

Permitted values / descriptions:


relaxedPerforms relaxed validation.strictPerforms strict validation.

parameterRef

string

Name of referenced pipelineParameter

xpath

[expression]

XPath expression returning the required type

Element: invalidCalsTableBehaviour 36

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

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#calsTableConfiguration

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#tableConfiguration

Contains

Attribute

Type

Description

literalValue

[enum]

Permitted values / descriptions:


compareAsXmlCompare tables as 'plain' XML.failThrow an Exception when invalid tables are encountered.propagateUpPropagate the changes to the <tgroup> level of the table.

parameterRef

string

Name of referenced pipelineParameter

xpath

[expression]

XPath expression returning the required type

Element: processCalsTables 37

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

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#calsTableConfiguration

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#tableConfiguration

Contains

Attribute

Type

Description

literalValue

boolean

Set true to enable processing of CALS tables

parameterRef

string

Name of referenced pipelineParameter

xpath

[expression]

XPath expression returning the required type

Element: warningReportMode 38

Specifies how table invalidity warnings should be reported.

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#calsTableConfiguration

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#htmlTableConfiguration

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#tableConfiguration

Contains

Attribute

Type

Description

literalValue

[enum]

Permitted values / descriptions:


commentsReports warnings using XML comments.messageReports warnings using <xsl:message/>.processingInstructionsReports warning using processing instructions with the format <?dxml_warn warning content ?>.

parameterRef

string

Name of referenced pipelineParameter

xpath

[expression]

XPath expression returning the required type

Element: htmlValidationLevel 39

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

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#htmlTableConfiguration

Contains

Attribute

Type

Description

literalValue

[enum]

Permitted values / descriptions:


relaxedPerforms relaxed validation.strictPerforms strict validation.

parameterRef

string

Name of referenced pipelineParameter

xpath

[expression]

XPath expression returning the required type

Element: invalidHtmlTableBehaviour 40

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

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#htmlTableConfiguration

Contains

Attribute

Type

Description

literalValue

[enum]

Permitted values / descriptions:


compareAsXmlCompare tables as 'plain' XML.failThrow an Exception when invalid tables are encountered.propagateUpPropagate the changes to the <tgroup> level of the table.

parameterRef

string

Name of referenced pipelineParameter

xpath

[expression]

XPath expression returning the required type

Element: normalizeHtmlTables 41

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

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#htmlTableConfiguration

Contains

Attribute

Type

Description

literalValue

boolean

Set true to enable normalization of HTML table column specification

parameterRef

string

Name of referenced pipelineParameter

xpath

[expression]

XPath expression returning the required type

Element: processHtmlTables 42

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

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#htmlTableConfiguration

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#tableConfiguration

Contains

Attribute

Type

Description

literalValue

boolean

Set true to enable processing of HTML tables

parameterRef

string

Name of referenced pipelineParameter

xpath

[expression]

XPath expression returning the required type

Element: defaults 43

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

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation

Contains

Element

Description

(10.4) DCP Schema Guide#outputType

Set the default PreservationOutputType for changes to preserved items

(10.4) DCP Schema Guide#processingMode

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

(10.4) DCP Schema Guide#retain

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

Element: overrides 44

Container for elements that override defaults for specific lexical preservation artifacts

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation

Contains

Element

Description

(10.4) DCP Schema Guide#advancedEntityReferenceUsage

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

(10.4) DCP Schema Guide#outerPiAndCommentProcessingMode

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

(10.4) DCP Schema Guide#preserveItems

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

Element: enableMathml 45

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

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#mathmlConfiguration

Contains

Attribute

Type

Description

literalValue

boolean

Set true to enable MathML processing

parameterRef

string

Name of referenced pipelineParameter

xpath

[expression]

XPath expression returning the required type

Element: mathmlGranularity 46

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

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#mathmlConfiguration

Contains

Attribute

Type

Description

literalValue

[enum]

Permitted values / descriptions:


adjacentReports the differences by repeating A and B MathML adjacent to each other.detailed-adjacentReports 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.inlineReports 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.

parameterRef

string

Name of referenced pipelineParameter

xpath

[expression]

XPath expression returning the required type

Element: attributeChangeMarked 47

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

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#outputFormatConfiguration

Contains

Attribute

Type

Description

literalValue

boolean

Set 'true' to mark changed attributes in output.

parameterRef

string

Name of referenced pipelineParameter

xpath

[expression]

XPath expression returning the required type

Element: frameMakerTcsTableChangeMode 48

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

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#outputFormatConfiguration

Contains

Attribute

Type

Description

literalValue

[enum]

Permitted values / descriptions:


downChanges in rows and cells are pushed down to the cell content level.ignoreAll changes in a table are ignored.upChanges in rows and cells are pushed up to the table level.

parameterRef

string

Name of referenced pipelineParameter

xpath

[expression]

XPath expression returning the required type

Element: grouping 49

Sets the behaviour for grouping adjacent changes.

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#outputFormatConfiguration

Contains

Attribute

Type

Description

literalValue

boolean

Set 'true' to group adjacent changes in output.

parameterRef

string

Name of referenced pipelineParameter

xpath

[expression]

XPath expression returning the required type

Element: modifiedAttributeMode 50

Determines how modified attributes are represented in the output.

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#outputFormatConfiguration

Contains

Attribute

Type

Description

literalValue

[enum]

Permitted values / descriptions:


useDefaultThe behaviour will depend on other parameter settings, primarily the output-format.changeThe associated modified attribute filter will be skipped, thus leaving the delta attribute change markup alone.AOutput the 'A' version of modified attributes and any deleted ('A') attributes.ABOutput the 'A' version of modified attributes.BOutput the 'B' version of modified attributes and any added ('B') attributes.BAOutput the 'B' version of modified attributes.encode-as-attributesOutput 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.

parameterRef

string

Name of referenced pipelineParameter

xpath

[expression]

XPath expression returning the required type

Element: modifiedFormatOutput 51

Sets the behaviour for outputting elements with modified formatting.

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#outputFormatConfiguration

Contains

Attribute

Type

Description

literalValue

[enum]

Permitted values / descriptions:


useDefaultChoose the most relevant behaviour based on other configuration settings.AOutput the formatting elements from the A input.BOutput the formatting elements from the B input.ABOutput the A and B formatting elements. Where A and B formatting elements overlap or are nested, use formatting elements from the A input.BAOutput the A and B formatting elements. Where A and B formatting elements overlap or are nested, use formatting elements from the B input.changeRepresent all formatting element changes using the deltaV2.1 format.content-groupOutput each formatting element change using a content group.

parameterRef

string

Name of referenced pipelineParameter

xpath

[expression]

XPath expression returning the required type

Element: orderlessPresentationMode 52

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

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#outputFormatConfiguration

Contains

Attribute

Type

Description

literalValue

[enum]

Permitted values / descriptions:


a_addsOutputs elements from the A input, in order, followed by elements only in the B input, in order.a_matches_deletes_addsOutputs elements from both inputs in their A order, followed by elements only in A and then elements only in B.b_deletesOutputs elements from the B input, in order, followed by elements only in the A input, in order.b_matches_adds_deletesOutputs elements from both inputs in their B order, followed by elements only in B and then elements only in A.

parameterRef

string

Name of referenced pipelineParameter

xpath

[expression]

XPath expression returning the required type

Element: resultFormat 53

Specifies the format of results output from the DocumentComparator.

The default resultFormat is 'delta'.

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#outputFormatConfiguration

Contains

Attribute

Type

Description

literalValue

[enum]

Permitted values / descriptions:


arbortext-tcReports changes using the Arbortext editor track changes format.deltaReports changes using the DeltaXML delta file result.oxygen-tcReports changes using oXygen Author track changes processing instructions.xmetal-tcReports changes using XMetaL track changes processing instructions.framemaker-tcReports changes using FrameMaker track changes processing instructions.

parameterRef

string

Name of referenced pipelineParameter

xpath

[expression]

XPath expression returning the required type

Element: trackChangesAuthor 54

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

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#outputFormatConfiguration

Contains

Attribute

Type

Description

literalValue

string

The author name to use.

parameterRef

string

Name of referenced pipelineParameter

xpath

[expression]

XPath expression returning the required type

Element: trackChangesDate 55

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

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#outputFormatConfiguration

Contains

Attribute

Type

Description

literalValue

dateTime

The date-time to use - example: 2001-10-26T21:32:52

parameterRef

string

Name of referenced pipelineParameter

xpath

[expression]

XPath expression returning the required type

Element: xmetalTcsTableChangeMode 56

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

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#outputFormatConfiguration

Contains

Attribute

Type

Description

literalValue

[enum]

Permitted values / descriptions:


downChanges in rows and cells are pushed down to the cell content level.ignoreAll changes in a table are ignored.upChanges in rows and cells are pushed up to the table level.

parameterRef

string

Name of referenced pipelineParameter

xpath

[expression]

XPath expression returning the required type

Element: changeGatheringEnabled 57

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

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#resultReadabilityOptions

Contains

Attribute

Type

Description

literalValue

boolean

Set true to enabled change gathering

parameterRef

string

Name of referenced pipelineParameter

xpath

[expression]

XPath expression returning the required type

Element: detectMoves 58

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

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#resultReadabilityOptions

Contains

Attribute

Type

Description

literalValue

boolean

Set true to enable moves detection feature

parameterRef

string

Name of referenced pipelineParameter

xpath

[expression]

XPath expression returning the required type

Element: elementSplittingEnabled 59

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

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#resultReadabilityOptions

Contains

Attribute

Type

Description

literalValue

boolean

Set true to enable element splitting

parameterRef

string

Name of referenced pipelineParameter

xpath

[expression]

XPath expression returning the required type

Element: elementSplittingThreshold 60

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

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#resultReadabilityOptions

Contains

Attribute

Type

Description

literalValue

Percentage

The threshold percentage as in integer (1 to 100)

parameterRef

string

Name of referenced pipelineParameter

xpath

[expression]

XPath expression returning the required type

Element: mixedContentDetectionScope 61

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

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#resultReadabilityOptions

Contains

Attribute

Type

Description

literalValue

[enum]

Permitted values / descriptions:


documentDetermine 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.localDetermine mixed content information for each element in turn, based on the contents of that element alone.

parameterRef

string

Name of referenced pipelineParameter

xpath

[expression]

XPath expression returning the required type

Element: modifiedWhitespaceBehaviour 62

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

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#resultReadabilityOptions

Contains

Attribute

Type

Description

literalValue

[enum]

Permitted values / descriptions:


useDefaultThe context dependent automatic whitespace setting.ignoreIgnore differences in whitespace that is not explicitly preserved.keepASimilar to 'ignore' except that 'A' document's whitespace is kept (instead of the 'B' document's whitespace).normalizeNormalize whitespace in inputs before comparison.showDisplay the differences in whitespace where possible

parameterRef

string

Name of referenced pipelineParameter

xpath

[expression]

XPath expression returning the required type

Element: moveAttributeXpath 63

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

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#resultReadabilityOptions

Contains

Attribute

Type

Description

literalValue

string

Sets id attribute XPath to be used during moves detection

parameterRef

string

Name of referenced pipelineParameter

xpath

[expression]

XPath expression returning the required type

Element: orphanedWordDetectionEnabled 64

States whether or not orphaned word detection is enabled.

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#resultReadabilityOptions

Contains

Attribute

Type

Description

literalValue

boolean

Enable/disable.

parameterRef

string

Name of referenced pipelineParameter

xpath

[expression]

XPath expression returning the required type

Element: orphanedWordLengthLimit 65

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

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#resultReadabilityOptions

Contains

Attribute

Type

Description

literalValue

unsignedLong


parameterRef

string

Name of referenced pipelineParameter

xpath

[expression]

XPath expression returning the required type

Element: orphanedWordMaxPercentage 66

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

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#resultReadabilityOptions

Contains

Attribute

Type

Description

literalValue

Percentage

An integer value (1 to 100) that is the max percentage of the total change size were a change is considered to be orphaned.

parameterRef

string

Name of referenced pipelineParameter

xpath

[expression]

XPath expression returning the required type

Element: class 67

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

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputPreFlatteningPoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputAExtensionPoints / (10.4) DCP Schema Guide#postTablePoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputAExtensionPoints / (10.4) DCP Schema Guide#preTablePoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputBExtensionPoints / (10.4) DCP Schema Guide#postTablePoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputBExtensionPoints / (10.4) DCP Schema Guide#preTablePoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputExtensionPoints / (10.4) DCP Schema Guide#postTablePoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputExtensionPoints / (10.4) DCP Schema Guide#preTablePoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#outputExtensionPoints / (10.4) DCP Schema Guide#finalPoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#outputExtensionPoints / (10.4) DCP Schema Guide#postTablePoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#outputExtensionPoints / (10.4) DCP Schema Guide#preAttributePoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#outputExtensionPoints / (10.4) DCP Schema Guide#preTablePoint / (10.4) DCP Schema Guide#filter

Contains

Attribute

Type

Description

name

anyNameType

The fully qualified name of the class.

Element: file 68

Load an XSLT filter from the file system.

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputPreFlatteningPoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputAExtensionPoints / (10.4) DCP Schema Guide#postTablePoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputAExtensionPoints / (10.4) DCP Schema Guide#preTablePoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputBExtensionPoints / (10.4) DCP Schema Guide#postTablePoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputBExtensionPoints / (10.4) DCP Schema Guide#preTablePoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputExtensionPoints / (10.4) DCP Schema Guide#postTablePoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputExtensionPoints / (10.4) DCP Schema Guide#preTablePoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#outputExtensionPoints / (10.4) DCP Schema Guide#finalPoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#outputExtensionPoints / (10.4) DCP Schema Guide#postTablePoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#outputExtensionPoints / (10.4) DCP Schema Guide#preAttributePoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#outputExtensionPoints / (10.4) DCP Schema Guide#preTablePoint / (10.4) DCP Schema Guide#filter

Contains

Attribute

Type

Description

path

string

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:


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

Element: http 69

Load XSLT filter from an identified HTTP resource.

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputPreFlatteningPoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputAExtensionPoints / (10.4) DCP Schema Guide#postTablePoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputAExtensionPoints / (10.4) DCP Schema Guide#preTablePoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputBExtensionPoints / (10.4) DCP Schema Guide#postTablePoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputBExtensionPoints / (10.4) DCP Schema Guide#preTablePoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputExtensionPoints / (10.4) DCP Schema Guide#postTablePoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputExtensionPoints / (10.4) DCP Schema Guide#preTablePoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#outputExtensionPoints / (10.4) DCP Schema Guide#finalPoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#outputExtensionPoints / (10.4) DCP Schema Guide#postTablePoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#outputExtensionPoints / (10.4) DCP Schema Guide#preAttributePoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#outputExtensionPoints / (10.4) DCP Schema Guide#preTablePoint / (10.4) DCP Schema Guide#filter

Contains

Attribute

Type

Description

url

anyURI

The URL of the HTTP resource.

Element: parameter 70

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

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputPreFlatteningPoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputAExtensionPoints / (10.4) DCP Schema Guide#postTablePoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputAExtensionPoints / (10.4) DCP Schema Guide#preTablePoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputBExtensionPoints / (10.4) DCP Schema Guide#postTablePoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputBExtensionPoints / (10.4) DCP Schema Guide#preTablePoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputExtensionPoints / (10.4) DCP Schema Guide#postTablePoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputExtensionPoints / (10.4) DCP Schema Guide#preTablePoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#outputExtensionPoints / (10.4) DCP Schema Guide#finalPoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#outputExtensionPoints / (10.4) DCP Schema Guide#postTablePoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#outputExtensionPoints / (10.4) DCP Schema Guide#preAttributePoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#outputExtensionPoints / (10.4) DCP Schema Guide#preTablePoint / (10.4) DCP Schema Guide#filter

Contains

Attribute

Type

Description

name

anyNameType

The parameter name

literalValue

string

The literal string value

parameterRef

string

Name of referenced pipelineParameter

xpath

[expression]

XPath expression returning the required type

Element: resource 71

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

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputPreFlatteningPoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputAExtensionPoints / (10.4) DCP Schema Guide#postTablePoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputAExtensionPoints / (10.4) DCP Schema Guide#preTablePoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputBExtensionPoints / (10.4) DCP Schema Guide#postTablePoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputBExtensionPoints / (10.4) DCP Schema Guide#preTablePoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputExtensionPoints / (10.4) DCP Schema Guide#postTablePoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#inputExtensionPoints / (10.4) DCP Schema Guide#preTablePoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#outputExtensionPoints / (10.4) DCP Schema Guide#finalPoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#outputExtensionPoints / (10.4) DCP Schema Guide#postTablePoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#outputExtensionPoints / (10.4) DCP Schema Guide#preAttributePoint / (10.4) DCP Schema Guide#filter

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#extensionPoints / (10.4) DCP Schema Guide#outputExtensionPoints / (10.4) DCP Schema Guide#preTablePoint / (10.4) DCP Schema Guide#filter

Contains

Attribute

Type

Description

name

anyNameType

The resource name, for example, '/xsl/resource.xsl'

Element: outputType 72

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

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#defaults

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#overrides / (10.4) DCP Schema Guide#preserveItems / (10.4) DCP Schema Guide#CDATA

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#overrides / (10.4) DCP Schema Guide#preserveItems / (10.4) DCP Schema Guide#XMLDeclaration

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#overrides / (10.4) DCP Schema Guide#preserveItems / (10.4) DCP Schema Guide#comments

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#overrides / (10.4) DCP Schema Guide#preserveItems / (10.4) DCP Schema Guide#defaultAttributeInfo

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#overrides / (10.4) DCP Schema Guide#preserveItems / (10.4) DCP Schema Guide#doctype

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#overrides / (10.4) DCP Schema Guide#preserveItems / (10.4) DCP Schema Guide#entityReferences

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#overrides / (10.4) DCP Schema Guide#preserveItems / (10.4) DCP Schema Guide#ignorableWhitespace

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#overrides / (10.4) DCP Schema Guide#preserveItems / (10.4) DCP Schema Guide#processingInstructions

Contains

Attribute

Type

Description

literalValue

[enum]

Permitted values / descriptions:


useDefaultSpecifies that the default encoding style should be used.encodedThe encoded preservation element should appear encoded in the output.normalThe encoded preservation element should be decoded by the final output transformation (which is typically part of serialisation process).

parameterRef

string

Name of referenced pipelineParameter

xpath

[expression]

XPath expression returning the required type

Element: processingMode 73

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

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#defaults

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#overrides / (10.4) DCP Schema Guide#preserveItems / (10.4) DCP Schema Guide#CDATA

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#overrides / (10.4) DCP Schema Guide#preserveItems / (10.4) DCP Schema Guide#XMLDeclaration

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#overrides / (10.4) DCP Schema Guide#preserveItems / (10.4) DCP Schema Guide#comments

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#overrides / (10.4) DCP Schema Guide#preserveItems / (10.4) DCP Schema Guide#defaultAttributeInfo

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#overrides / (10.4) DCP Schema Guide#preserveItems / (10.4) DCP Schema Guide#doctype

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#overrides / (10.4) DCP Schema Guide#preserveItems / (10.4) DCP Schema Guide#entityReferences

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#overrides / (10.4) DCP Schema Guide#preserveItems / (10.4) DCP Schema Guide#ignorableWhitespace

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#overrides / (10.4) DCP Schema Guide#preserveItems / (10.4) DCP Schema Guide#processingInstructions

Contains

Attribute

Type

Description

literalValue

[enum]

Permitted values / descriptions:


useDefaultUse the default ProcessingModeAKeep the A versionABKeep the A version if it exists, otherwise keep the B versionAdBSame as A, except when handling internal subset declarations which are treated as ABBKeep the B versionBAKeep the B version if it exists, otherwise keep the A versionBdASame as B, except when handling internal subset declarations which are treated as BAchangeKeep change information as-is

parameterRef

string

Name of referenced pipelineParameter

xpath

[expression]

XPath expression returning the required type

Element: retain 74

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

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

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#defaults

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#overrides / (10.4) DCP Schema Guide#preserveItems / (10.4) DCP Schema Guide#CDATA

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#overrides / (10.4) DCP Schema Guide#preserveItems / (10.4) DCP Schema Guide#XMLDeclaration

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#overrides / (10.4) DCP Schema Guide#preserveItems / (10.4) DCP Schema Guide#comments

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#overrides / (10.4) DCP Schema Guide#preserveItems / (10.4) DCP Schema Guide#contentModel

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#overrides / (10.4) DCP Schema Guide#preserveItems / (10.4) DCP Schema Guide#defaultAttributeInfo

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#overrides / (10.4) DCP Schema Guide#preserveItems / (10.4) DCP Schema Guide#doctype

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#overrides / (10.4) DCP Schema Guide#preserveItems / (10.4) DCP Schema Guide#documentLocation

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#overrides / (10.4) DCP Schema Guide#preserveItems / (10.4) DCP Schema Guide#entityReferences

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#overrides / (10.4) DCP Schema Guide#preserveItems / (10.4) DCP Schema Guide#entityReplacementText

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#overrides / (10.4) DCP Schema Guide#preserveItems / (10.4) DCP Schema Guide#ignorableWhitespace

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#overrides / (10.4) DCP Schema Guide#preserveItems / (10.4) DCP Schema Guide#nestedEntityReferences

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#overrides / (10.4) DCP Schema Guide#preserveItems / (10.4) DCP Schema Guide#processingInstructions

Contains

Attribute

Type

Description

literalValue

boolean

Set true to keep information on a lexical preservation artifact.

parameterRef

string

Name of referenced pipelineParameter

xpath

[expression]

XPath expression returning the required type

Element: advancedEntityReferenceUsage 75

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

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#overrides

Contains

Attribute

Type

Description

literalValue

[enum]

Permitted values / descriptions:


useDefaultChoose one of the other three behaviours in a context dependent manner.changeKeep the encoded form of the entity reference, with its change markup.replaceExtract the replacement text from the encoded entity reference.splitThe encoded entity references have their replacement text removed and are split into 'new' and 'old' versions on detection of change.

parameterRef

string

Name of referenced pipelineParameter

xpath

[expression]

XPath expression returning the required type

Element: outerPiAndCommentProcessingMode 76

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

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#overrides

Contains

Attribute

Type

Description

literalValue

[enum]

Permitted values / descriptions:


useDefaultUse the default ProcessingModeAKeep the A versionABKeep the A version if it exists, otherwise keep the B versionAdBSame as A, except when handling internal subset declarations which are treated as ABBKeep the B versionBAKeep the B version if it exists, otherwise keep the A versionBdASame as B, except when handling internal subset declarations which are treated as BAchangeKeep change information as-is

parameterRef

string

Name of referenced pipelineParameter

xpath

[expression]

XPath expression returning the required type

Element: preserveItems 77

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

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#overrides

Contains

Element

Description

(10.4) DCP Schema Guide#CDATA

Controls preservation of CDATA sections found in the input documents

(10.4) DCP Schema Guide#XMLDeclaration

Controls preservation XML declarations in the input documents

(10.4) DCP Schema Guide#comments

Controls preservation of XML comment nodes found in the input documents

(10.4) DCP Schema Guide#contentModel

Controls preservation of DTD/Schema Element Content Model

(10.4) DCP Schema Guide#defaultAttributeInfo

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

(10.4) DCP Schema Guide#doctype

Controls preservation of DocType declarations and the internal DTD subset

(10.4) DCP Schema Guide#documentLocation

Controls preservation of the original document location (the systemId)

(10.4) DCP Schema Guide#entityReferences

Controls preservation of entity references found in the input documents

(10.4) DCP Schema Guide#entityReplacementText

Controls preservation of text to be used when entities are resolved

(10.4) DCP Schema Guide#ignorableWhitespace

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

(10.4) DCP Schema Guide#nestedEntityReferences

Controls preservation of entities references actually occurring within entities

(10.4) DCP Schema Guide#processingInstructions

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

Element: CDATA 78

Controls preservation of CDATA sections found in the input documents.

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#overrides / (10.4) DCP Schema Guide#preserveItems

Contains

Element

Description

(10.4) DCP Schema Guide#outputType

Set the default PreservationOutputType for changes to preserved items

(10.4) DCP Schema Guide#processingMode

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

(10.4) DCP Schema Guide#retain

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

Element: XMLDeclaration 79

Controls preservation XML declarations in the input documents.

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#overrides / (10.4) DCP Schema Guide#preserveItems

Contains

Element

Description

(10.4) DCP Schema Guide#outputType

Set the default PreservationOutputType for changes to preserved items

(10.4) DCP Schema Guide#processingMode

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

(10.4) DCP Schema Guide#retain

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

Element: comments 80

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

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#overrides / (10.4) DCP Schema Guide#preserveItems

Contains

Element

Description

(10.4) DCP Schema Guide#outputType

Set the default PreservationOutputType for changes to preserved items

(10.4) DCP Schema Guide#processingMode

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

(10.4) DCP Schema Guide#retain

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

Element: contentModel 81

Controls preservation of DTD/Schema Element Content Model.

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#overrides / (10.4) DCP Schema Guide#preserveItems

Contains

Element

Description

(10.4) DCP Schema Guide#retain

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

Element: defaultAttributeInfo 82

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

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#overrides / (10.4) DCP Schema Guide#preserveItems

Contains

Element

Description

(10.4) DCP Schema Guide#outputType

Set the default PreservationOutputType for changes to preserved items

(10.4) DCP Schema Guide#processingMode

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

(10.4) DCP Schema Guide#retain

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

Element: doctype 83

Controls preservation of DocType declarations and the internal DTD subset.

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#overrides / (10.4) DCP Schema Guide#preserveItems

Contains

Element

Description

(10.4) DCP Schema Guide#outputType

Set the default PreservationOutputType for changes to preserved items

(10.4) DCP Schema Guide#processingMode

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

(10.4) DCP Schema Guide#retain

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

Element: documentLocation 84

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

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#overrides / (10.4) DCP Schema Guide#preserveItems

Contains

Element

Description

(10.4) DCP Schema Guide#retain

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

Element: entityReferences 85

Controls preservation of entity references found in the input documents.

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#overrides / (10.4) DCP Schema Guide#preserveItems

Contains

Element

Description

(10.4) DCP Schema Guide#outputType

Set the default PreservationOutputType for changes to preserved items

(10.4) DCP Schema Guide#processingMode

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

(10.4) DCP Schema Guide#retain

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

Element: entityReplacementText 86

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

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#overrides / (10.4) DCP Schema Guide#preserveItems

Contains

Element

Description

(10.4) DCP Schema Guide#retain

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

Element: ignorableWhitespace 87

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

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#overrides / (10.4) DCP Schema Guide#preserveItems

Contains

Element

Description

(10.4) DCP Schema Guide#outputType

Set the default PreservationOutputType for changes to preserved items

(10.4) DCP Schema Guide#processingMode

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

(10.4) DCP Schema Guide#retain

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

Element: nestedEntityReferences 88

Controls preservation of entities references actually occurring within entities.

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#overrides / (10.4) DCP Schema Guide#preserveItems

Contains

Element

Description

(10.4) DCP Schema Guide#retain

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

Element: processingInstructions 89

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

Contained by

/ (10.4) DCP Schema Guide#documentComparator / (10.4) DCP Schema Guide#standardConfig / (10.4) DCP Schema Guide#lexicalPreservation / (10.4) DCP Schema Guide#overrides / (10.4) DCP Schema Guide#preserveItems

Contains

Element

Description

(10.4) DCP Schema Guide#outputType

Set the default PreservationOutputType for changes to preserved items

(10.4) DCP Schema Guide#processingMode

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

(10.4) DCP Schema Guide#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.