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: documentComparator1

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
fullDescriptionDesigned 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: advancedConfig2

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: extensionPoints3

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
inputAExtensionPointsExtension points for modifying input A filter chains, after element flattening
inputBExtensionPointsExtension points for modifying input B filter chains, after element flattening
inputExtensionPointsExtension points for modifying A and B input filter chains, after element flattening
inputPreFlatteningPointExtension point for modifying A and B input filters, before element flattening
outputExtensionPointsExtension points for modifying output filter chains, after element flattening

Element: fullDescription4

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: pipelineParameters5

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: standardConfig6

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

Contained by

Contains

ElementDescription
lexicalPreservationConfigures the way lexical information is preserved
outputFormatConfigurationSpecifies configuration options related to the format of the comparison result from a DocumentComparator
resultReadabilityOptionsSets options to change the granularity and ordering of changes in the result in order to improve readability
tableConfiguration Specifies configuration options for table comparison

Element: outputProperties7

Set Serializer property settings for the built in Saxon Serializer.

Contained by

Contains

ElementDescription
property Sets the string value of a named property

Element: parserFeatures8

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: parserProperties9

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: transformerConfigurationProperties10

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: inputAExtensionPoints11

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: inputBExtensionPoints12

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: inputExtensionPoints13

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: inputPreFlatteningPoint14

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: outputExtensionPoints15

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: booleanParameter16

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
descriptionShort summary of the purpose of the parameter

Element: stringParameter17

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
descriptionShort summary of the purpose of the parameter

Element: lexicalPreservation18

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
defaultsThis required element is the container for elements that set the defaults for all lexical preservation artifacts
overridesContainer for elements that override defaults for specific lexical preservation artifacts

Element: outputFormatConfiguration19

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

Contained by

Contains

ElementDescription
attributeChangeMarkedSets the behaviour for marking elements with an attribute changed marker - for cases where attribute changes can not otherwise be represented
modifiedAttributeModeDetermines how modified attributes are represented in the output
modifiedFormatOutputSets the behaviour for outputting elements with modified formatting
orderlessPresentationModeSpecifies how the child elements of 'orderless' elements should be output
resultFormatSpecifies the format of results output from the DocumentComparator
trackChangesAuthorAuthor name to use when generating tracked changes in the result document
trackChangesDateThe date-time to be used for tracked change representations, otherwise the current date-time is used
xmetalTcsTableChangeModeSpecify how table changes are propagated for XMetal tracked changes representations, the default is down

Element: resultReadabilityOptions20

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
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
modifiedWhitespaceBehaviour Set the ModifiedWhitespaceBehaviour to use for changes to whitespace
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

Element: tableConfiguration21

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: property22

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: feature23

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: booleanProperty24

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: stringProperty25

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: postTablePoint26

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: preTablePoint27

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: filter28

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: finalPoint29

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: preAttributePoint30

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: description31

Short summary of the purpose of the parameter.

Contained by

Contains

Type: xs:string

Element: defaults32

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

Contained by

Contains

ElementDescription
outputTypeSet the default PreservationOutputType for changes to preserved items
processingModeSets the 'PreservationProcessingMode' for controlling behaviour when preserved lexical artifacts have changed
retainSets whether information on a lexical preservation artifact is preserved in the pipeline

Element: overrides33

Container for elements that override defaults for specific lexical preservation artifacts

Contained by

Contains

ElementDescription
advancedEntityReferenceUsageFor controlling some specialist use cases, where both the entity references and their replacement text are compared
outerPiAndCommentProcessingModeSet processingMode for processing-instructions and comments occurring before or after the root element
preserveItemsContainer for preservation of specific lexical preservation artifacts, these override general preservation settings for all artifacts contained in the 'defaults' element

Element: attributeChangeMarked34

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: modifiedAttributeMode35

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: modifiedFormatOutput36

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.
change
Output the formatting element change in its deltaV2.1 version.
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: orderlessPresentationMode37

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: resultFormat38

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.
parameterRefstringName of referenced pipelineParameter
xpath[expression]XPath expression returning the required type

Element: trackChangesAuthor39

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: trackChangesDate40

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: xmetalTcsTableChangeMode41

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: changeGatheringEnabled42

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: elementSplittingEnabled43

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: elementSplittingThreshold44

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: modifiedWhitespaceBehaviour45

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: orphanedWordDetectionEnabled46

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: orphanedWordLengthLimit47

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: orphanedWordMaxPercentage48

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: calsValidationLevel49

Sets the ValidationLevel to use for CALS table validation.

A value of ValidationLevel.STRICT will cause the InvalidCalsTableBehaviour 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: invalidCalsTableBehaviour50

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 CALS 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: processCalsTables51

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: processHtmlTables52

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: warningReportMode53

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: class54

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

Contained by

Contains

AttributeTypeDescription
nameanyNameTypeThe fully qualified name of the class.

Element: file55

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: http56

Load XSLT filter from an identified HTTP resource.

Contained by

Contains

AttributeTypeDescription
urlanyURI The URL of the HTTP resource.

Element: parameter57

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: resource58

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: outputType59

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: processingMode60

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: retain61

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: advancedEntityReferenceUsage62

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: outerPiAndCommentProcessingMode63

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: preserveItems64

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
CDATAControls preservation of CDATA sections found in the input documents
XMLDeclarationControls preservation XML declarations in the input documents
commentsControls preservation of XML comment nodes found in the input documents
contentModelControls preservation of DTD/Schema Element Content Model
defaultAttributeInfoControls how information is preserved on DTD/Schema-defined default attributes added by the parser
doctypeControls preservation of DocType declarations and the internal DTD subset
entityReferencesControls preservation of entity references found in the input documents
entityReplacementTextControls preservation of text to be used when entities are resolved
ignorableWhitespaceControls preservation of whitespace identified as ignorable by a DTD or XML Schema
nestedEntityReferencesControls preservation of entities references actually occurring within entities
processingInstructionsControls preservation of XML processing-instruction nodes found in the input documents

Element: CDATA65

Controls preservation of CDATA sections found in the input documents.

Contained by

Contains

ElementDescription
outputTypeSet the default PreservationOutputType for changes to preserved items
processingModeSets the 'PreservationProcessingMode' for controlling behaviour when preserved lexical artifacts have changed
retainSets whether information on a lexical preservation artifact is preserved in the pipeline

Element: XMLDeclaration66

Controls preservation XML declarations in the input documents.

Contained by

Contains

ElementDescription
outputTypeSet the default PreservationOutputType for changes to preserved items
processingModeSets the 'PreservationProcessingMode' for controlling behaviour when preserved lexical artifacts have changed
retainSets whether information on a lexical preservation artifact is preserved in the pipeline

Element: comments67

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

Contained by

Contains

ElementDescription
outputTypeSet the default PreservationOutputType for changes to preserved items
processingModeSets the 'PreservationProcessingMode' for controlling behaviour when preserved lexical artifacts have changed
retainSets whether information on a lexical preservation artifact is preserved in the pipeline

Element: contentModel68

Controls preservation of DTD/Schema Element Content Model.

Contained by

Contains

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

Element: defaultAttributeInfo69

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

Contained by

Contains

ElementDescription
outputTypeSet the default PreservationOutputType for changes to preserved items
processingModeSets the 'PreservationProcessingMode' for controlling behaviour when preserved lexical artifacts have changed
retainSets whether information on a lexical preservation artifact is preserved in the pipeline

Element: doctype70

Controls preservation of DocType declarations and the internal DTD subset.

Contained by

Contains

ElementDescription
outputTypeSet the default PreservationOutputType for changes to preserved items
processingModeSets the 'PreservationProcessingMode' for controlling behaviour when preserved lexical artifacts have changed
retainSets whether information on a lexical preservation artifact is preserved in the pipeline

Element: entityReferences71

Controls preservation of entity references found in the input documents.

Contained by

Contains

ElementDescription
outputTypeSet the default PreservationOutputType for changes to preserved items
processingModeSets the 'PreservationProcessingMode' for controlling behaviour when preserved lexical artifacts have changed
retainSets whether information on a lexical preservation artifact is preserved in the pipeline

Element: entityReplacementText72

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

Contained by

Contains

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

Element: ignorableWhitespace73

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

Contained by

Contains

ElementDescription
outputTypeSet the default PreservationOutputType for changes to preserved items
processingModeSets the 'PreservationProcessingMode' for controlling behaviour when preserved lexical artifacts have changed
retainSets whether information on a lexical preservation artifact is preserved in the pipeline

Element: nestedEntityReferences74

Controls preservation of entities references actually occurring within entities.

Contained by

Contains

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

Element: processingInstructions75

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

Contained by

Contains

ElementDescription
outputTypeSet the default PreservationOutputType for changes to preserved items
processingModeSets the 'PreservationProcessingMode' for controlling behaviour when preserved lexical artifacts have changed
retainSets whether information on a lexical preservation artifact is preserved in the pipeline

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