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 theDCP User Guide.

Element Index

Element Detail

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

Element: documentComparator 1

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

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

Contained by

Contains

Element: advancedConfig 2

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

Contained by

Contains

Element: extensionPoints 3

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

In EBNF the required sequence S of child elements is:

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

Contained by

Contains

Element: fullDescription 4

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

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

Contained by

Contains

Element: pipelineParameters 5

Container for all pipeline parameters.

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

Contained by

Contains

Element: standardConfig 6

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

Contained by

Contains

Element: outputProperties 7

Set Serializer property settings for the built in Saxon Serializer.

Contained by

Contains

Element: parserFeatures 8

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

For more detail, see setParserFeature in the API documentation.

Contained by

Contains

Element: parserProperties 9

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

For more detail, see setParserProperty in the API documentation.

Contained by

Contains

Element: transformerConfigurationProperties 10

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

The maximum number of child elements is not restricted.

Contained by

Contains

Element: inputAExtensionPoints 11

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

Contained by

Contains

Element: inputBExtensionPoints 12

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

Contained by

Contains

Element: inputExtensionPoints 13

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

Contained by

Contains

Element: inputPreFlatteningPoint 14

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

Contained by

Contains

Element: outputExtensionPoints 15

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

Contained by

Contains

Element: booleanParameter 16

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

Contained by

Contains

Element: stringParameter 17

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

Contained by

Contains

Element: calsTableConfiguration 18

Specifies configuration options for CALS table comparison.

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

Contained by

Contains

Element: htmlTableConfiguration 19

Specifies configuration options for HTML table comparison.

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

Contained by

Contains

Element: lexicalPreservation 20

Configures the way lexical information is preserved.

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

Contained by

Contains

Element: mathmlConfiguration 21

Specifies configuration options for MathML processing.

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

Contained by

Contains

Element: outputFormatConfiguration 22

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

Contained by

Contains

Element: resultReadabilityOptions 23

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

Contained by

Contains

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

Contains

Element: property 25

Sets the string value of a named property

Contained by

Contains

Element: feature 26

Sets the boolean value of a named feature.

Contained by

Contains

Element: booleanProperty 27

A named boolean property

Contained by

Contains

Element: stringProperty 28

A named string property

Contained by

Contains

Element: postTablePoint 29

The filter extension point immediately after table processing.

Contained by

Contains

Element: preTablePoint 30

The filter extension point immediately before table processing.

The preTablePoint element must be placed before the postTablePoint element.

Contained by

Contains

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

Contains

Element: finalPoint 32

The final filter extension point in the DocumentComparator output pipeline.

Contained by

Contains

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

Contains

Element: description 34

Short summary of the purpose of the parameter.

Contained by

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

Contains

Element: columnKeyingMode 36

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

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

Contained by

Contains

Element: ignoreColumnOrder 37

Sets whether the DocumentComparator should ignore CALS table column order.

Contained by

Contains

Element: invalidCalsTableBehaviour 38

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

Element: processCalsTables 39

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

Element: warningReportMode 40

Specifies how table invalidity warnings should be reported.

Contained by

Contains

Element: htmlValidationLevel 41

Sets the ValidationLevel to use for HTML table validation.

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

Contained by

Contains

Element: invalidHtmlTableBehaviour 42

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

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

Contained by

Contains

Element: normalizeHtmlTables 43

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

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

Contained by

Contains

Element: processHtmlTables 44

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

Element: defaults 45

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

Contained by

Contains

Element: overrides 46

Container for elements that override defaults for specific lexical preservation artifacts

Contained by

Contains

Element: enableMathml 47

Sets whether the DocumentComparator should use MathML-specific processing.

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

Contained by

Contains

Element: mathmlGranularity 48

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

Contained by

Contains

Element: attributeChangeMarked 49

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

Contained by

Contains

Element: frameMakerTcsTableChangeMode 50

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

Contained by

Contains

Element: grouping 51

Sets the behaviour for grouping adjacent changes.

Contained by

Contains

Element: modifiedAttributeMode 52

Determines how modified attributes are represented in the output.

Contained by

Contains

Element: modifiedFormatOutput 53

Sets the behaviour for outputting elements with modified formatting.

Contained by

Contains

Element: orderlessPresentationMode 54

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

Contained by

Contains

Element: resultFormat 55

Specifies the format of results output from the DocumentComparator.

The default resultFormat is 'delta'.

Contained by

Contains

Element: trackChangesAuthor 56

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

Contained by

Contains

Element: trackChangesDate 57

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

Contained by

Contains

Element: xmetalTcsTableChangeMode 58

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

Contained by

Contains

Element: changeGatheringEnabled 59

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

Element: detectMoves 60

Sets the moves detection feature on or off.

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

Contained by

Contains

Element: elementSplittingEnabled 61

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

Contained by

Contains

Element: elementSplittingThreshold 62

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

Contained by

Contains

Element: mixedContentDetectionScope 63

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

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

Contained by

Contains

Element: modifiedWhitespaceBehaviour 64

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

Element: moveAttributeXpath 65

Sets id attribute XPath to be used during moves detection.

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

Contained by

Contains

Element: orphanedWordDetectionEnabled 66

States whether or not orphaned word detection is enabled.

Contained by

Contains

Element: orphanedWordLengthLimit 67

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

Element: orphanedWordMaxPercentage 68

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

Element: class 69

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

Contained by

Contains

Element: file 70

Load an XSLT filter from the file system.

Contained by

Contains

Element: http 71

Load XSLT filter from an identified HTTP resource.

Contained by

Contains

Element: parameter 72

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

Element: resource 73

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

Contained by

Contains

Element: outputType 74

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

Element: processingMode 75

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

Contained by

Contains

Element: retain 76

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

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

Contained by

Contains

Element: advancedEntityReferenceUsage 77

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

Element: outerPiAndCommentProcessingMode 78

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

Contained by

Contains

Element: preserveItems 79

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

Contained by

Contains

Element: CDATA 80

Controls preservation of CDATA sections found in the input documents.

Contained by

Contains

Element: XMLDeclaration 81

Controls preservation XML declarations in the input documents.

Contained by

Contains

Element: comments 82

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

Contained by

Contains

Element: contentModel 83

Controls preservation of DTD/Schema Element Content Model.

Contained by

Contains

Element: defaultAttributeInfo 84

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

Contained by

Contains

Element: doctype 85

Controls preservation of DocType declarations and the internal DTD subset.

Contained by

Contains

Element: documentLocation 86

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

Contained by

Contains

Element: entityReferences 87

Controls preservation of entity references found in the input documents.

Contained by

Contains

Element: entityReplacementText 88

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

Contained by

Contains

Element: ignorableWhitespace 89

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

Contained by

Contains

Element: nestedEntityReferences 90

Controls preservation of entities references actually occurring within entities.

Contained by

Contains

Element: processingInstructions 91

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

Contained by

Contains

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