DITA Comparison Configuration File Schema Guide

This guide provides a short description of each element and attribute defined in the XML schema for the DITA Compare REST topic configuration file. A fuller description of the configuration file, along with the examples and an explanation of the main concepts can be found in the User Guide and associated documentation.

An occurrence indicator is used here for cases other than where a child element may occur once and only once. The occurrent indicators are descibed below:

[*] - Zero or more
[?] - Zero or once
[+] - One or more

Element Index

addInlineFormattingElements 47

addOutputClassAtts 76

calsTableProcessing 66

characterByCharacter 69

common 27

compareSVG 55

comparisonParameters 4

configuration 1

detectMoves 43

ditaConfiguration 10

ditaMarkup 28

elementMoves 11

fallbackChangePercentage 56

forceSpecialization 30

formattingElements 12

framemakerTcsTableChangeMode 89

getSVGZIndex 57

grouping 72

htmlTableProcessing 67

ignoreInlineFormatting 48

inlineFormattingElements 49

inputASVGMarkupStyle 58

inputBSVGMarkupStyle 59

invalidReferencedSVGBehaviour 60

invalidTableBehaviour 68

isNumericToleranceEnabled 61

mapBackupSuffix 18

mapCleanTemp 19

mapCopyScope 20

mapPairRemainingMapName 21

mapParameters 5

mapResultOrigin 22

mapResultStructure 23

mapScanTopicsForReferences 24

mapTopicExceptionPropagationMode 25

mapUncomparedTopicMarkup 26

mathml 14

mathmlGranularity 53

mathmlProcessing 54

modifiedAttributeMode 35

moveSourceRevision 44

moveTargetRevision 45

newOutputclass 80

newRevision 81

newVersionAtts 82

numericToleranceValue 62

oldOutputClass 83

oldRevision 84

oldVersionAtts 85

outputEncodingDeclaration 31

outputFormat 74

outputImageRefForm 52

outputParameters 6

oxygenTcsDeletedSpaceMode 90

oxygenTcsVersion 91

parameters 2

phraseContainerExclusions 86

phraseElementName 87

preservationMode 75

removeInlineFormattingElements 50

removeMoveSource 46

removeRevAttributeRegex 39

selectingUnrepresentableChange 8

showNonPhraseChanges 88

stepsConflictResolution 40

strictTaskModel 41

svgComparison 15

svgComparisonGranularity 63

svgFallback 64

trackedChangedAuthor 92

trackedChanges 29

trackedChangesDate 93

unmarkedChangeMode 36

versionAtt 95

whitespaceProcessingMode 70

wordByWord 71

xmetalTcsTableChangeMode 94

xmlVersionDeclaration 34

zIndexSVGMarkupStyle 65

Element Detail

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

Element: configuration 1

The root element for defining the configuration for DITA Compare REST.

Contained by

/

Contains

Element	Description
parameters	The root element for defining the configuration parameters for the comparison

Element: parameters 2

The root element for defining the configuration parameters for the comparison.

Contained by

/ configuration

Contains

Element	Description
advancedParameters	The advanced settings parameters provide a finer level of control over the comparison, the output, and error reporting
comparisonParameters	These parameters control how the comparison is performed
mapParameters	These parameters control how the map comparison is performed
outputParameters	These parameters enable the form of the output to be configured

Element: advancedParameters 3

The advanced settings parameters provide a finer level of control over the comparison, the output, and error reporting.

Contained by

/ configuration / parameters

Contains

Element	Description
advancedBehaviour	Parameters used to override or force specific behaviours
selectingUnrepresentableChange	These parameters are used to specify how unrepresentable change can be handled
validation	Input validation and reporting

Element: comparisonParameters 4

These parameters control how the comparison is performed.

Contained by

/ configuration / parameters

Contains

Element	Description
ditaConfiguration	The DITA configuration parameters apply to all output formats
elementMoves	These parameters control element moves handling and defines the values for revision attribute
formattingElements	These parameters control which DITA elements are marked as inline structural changes
imageComparison	Parameters managing image comparison
mathml	Parameters managing MathML
svgComparison	These parameters control how SVG changes are displayed
tableComparison	These parameters control how tables are compared
textComparison	These parameters control how text is compared and whitespace handled

Element: mapParameters 5

These parameters control how the map comparison is performed.

Contained by

/ configuration / parameters

Contains

Element	Description
mapBackupSuffix	Sets the suffix for the backup file that needs to be created during comparison
mapCleanTemp	Sets whether to clean temporary files introduced when performing the comparison
mapCopyScope	Sets how to copy a DITA map and its content to an output directory
mapPairRemainingMapName	Sets the name of the remaining topic references ditamap
mapResultOrigin	Sets the map input used to form the basis of the output
mapResultStructure	Sets how the result map is constructed
mapScanTopicsForReferences	Specifies whether to scan topics for references
mapTopicExceptionPropagationMode	Sets the action to perform when there is an exception raised during the processing of a topic
mapUncomparedTopicMarkup	Sets what updates should be performed to un-compared/unaligned topics (in the context of a DITA map comparison)

Element: outputParameters 6

These parameters enable the form of the output to be configured.

Contained by

/ configuration / parameters

Contains

Element	Description
common	The output parameters that are either used to specify a specific output type or apply to all output types
ditaMarkup	The DITA markup output format specific parameters provide control over how the 'rev' and 'status' attributes are used to represent change
trackedChanges	The tracked changes output format specific parameters provide a way of configuring tracked change output and editor/format specific output

Element: advancedBehaviour 7

Parameters used to override or force specific behaviours.

Contained by

/ configuration / parameters / advancedParameters

Contains

Element	Description
forceSpecialization	Specifies whether or not to force result specialization when the input types are different
outputEncodingDeclaration	Sets the character encoding output to use in the XML declaration
topicPublicId	Specifies the publicId to use for a Topic doctype
topicSystemId	Specifies the systemId to use for a Topic doctype
xmlVersionDeclaration	Sets the version to use in the XML declaration

Element: selectingUnrepresentableChange 8

These parameters are used to specify how unrepresentable change can be handled.

Contained by

/ configuration / parameters / advancedParameters

Contains

Element	Description
modifiedAttributeMode	Specifies how modified attributes should be included in the output
unmarkedChangeMode	Specifies how to handle data that cannot contain difference markup

Element: validation 9

Input validation and reporting.

Contained by

/ configuration / parameters / advancedParameters

Contains

Element	Description
validateInputs	Specifies whether to validate input documents
warningReportMode	Sets the mode to use for reporting recoverable errors and warnings

Element: ditaConfiguration 10

The DITA configuration parameters apply to all output formats.

They are used to control both conflict resolution and which topics are considered to be part of the document.

Contained by

/ configuration / parameters / comparisonParameters

Contains

Element	Description
removeRevAttributeRegex	This parameter specifies the regular expression that matches 'rev' attributes to be stripped
stepsConflictResolution	Specifies how to resolve conflicts between a task body's mutually exclusive steps and steps-unordered elements
strictTaskModel	Specifies whether inputs are using the “strict task model” added in DITA 1
useIdsAsKeys	Specifies whether to use id attribute value as keys in order to provide identity during comparison

Element: elementMoves 11

These parameters control element moves handling and defines the values for revision attribute.

Contained by

/ configuration / parameters / comparisonParameters

Contains

Element	Description
detectMoves	If set to true, then elements moves are handled - if the elements have ids on them
moveSourceRevision	Specifies the string value to use for the rev attribute for source of moved content
moveTargetRevision	Specifies the string value to use for the rev attribute for target of moved content
removeMoveSource	If set to true, then move source will be removed

Element: formattingElements 12

These parameters control which DITA elements are marked as inline structural changes.

Contained by

/ configuration / parameters / comparisonParameters

Contains

Element	Description
addInlineFormattingElements	A comma and/or space separated list of inline formatting elements, which will be added to the value of the inline-formatting-elements parameter
ignoreInlineFormatting	If set to true, any changes that consist only of the addition, deletion or modification of DITA inline markup elements are not noted as changes
inlineFormattingElements	Sets the comma and/or space separated list of inline formatting elements
removeInlineFormattingElements	A comma and/or space separated list of inline formatting elements, which will be removed from the value of the inline-formatting-elements parameter

Element: imageComparison 13

Parameters managing image comparison.

Contained by

/ configuration / parameters / comparisonParameters

Contains

Element	Description
imageCompare	Specifies whether to compare images
outputImageRefForm	Specifies output image ref form after image comparison

Element: mathml 14

Parameters managing MathML

Contained by

/ configuration / parameters / comparisonParameters

Contains

Element	Description
mathmlGranularity	Specifies the granularity at which the differences between the two MathML expressions will be represented
mathmlProcessing	Specifies whether to apply MathML processing

Element: svgComparison 15

These parameters control how SVG changes are displayed.

Contained by

/ configuration / parameters / comparisonParameters

Contains

Element	Description
compareSVG	Whether SVG comparison should be carried out
fallbackChangePercentage	Defines the threshold at which fallback occurs if svgFallback is true
getSVGZIndex	Whether z index changes are allowed or not
inputASVGMarkupStyle	How to render input specific to input A
inputBSVGMarkupStyle	How to render input specific to input B
invalidReferencedSVGBehaviour	Specifies how to handle invalid referenced SVG images
isNumericToleranceEnabled	Whether numeric tolerance is allowed or not
numericToleranceValue	Defines the numeric tolerance value if numeric tolerance value is true
svgComparisonGranularity	Specifies how to display SVG changes
svgFallback	Fallback to the ADJACENT result if alignment is below the defined threshold (set by fallbackChangePercentage)
zIndexSVGMarkupStyle	Defines the z index mark up style value if z index value is true

Element: tableComparison 16

These parameters control how tables are compared.

Contained by

/ configuration / parameters / comparisonParameters

Contains

Element	Description
calsTableProcessing	Specifies whether to apply CALS table processing
htmlTableProcessing	Specifies whether to apply HTML table/DITA simpletable processing
invalidTableBehaviour	This parameter declares what type of processing should be used for those tables that are marked as invalid

Element: textComparison 17

These parameters control how text is compared and whitespace handled.

Contained by

/ configuration / parameters / comparisonParameters

Contains

Element	Description
characterByCharacter	Specifies whether to compare text character by character
whitespaceProcessingMode	Specifies how to handle whitespace changes
wordByWord	Specifies whether to perform detailed text comparison or not

Element: mapBackupSuffix 18

Sets the suffix for the backup file that needs to be created during comparison.

Contained by

/ configuration / parameters / mapParameters

Contains

Type: xs:string

Element: mapCleanTemp 19

Sets whether to clean temporary files introduced when performing the comparison.

Contained by

/ configuration / parameters / mapParameters

Contains

Attribute

Type

Description

mode

[enum]

Permitted values / descriptions:

yes: Clean temporary giles created during the map comparison.
no: Do not clean temporary files created during the map comparison.
auto: Clean the temporary files only when the comparison is being performed on a copy of the input. This is the default.

Element: mapCopyScope 20

Sets how to copy a DITA map and its content to an output directory.

Contained by

/ configuration / parameters / mapParameters

Contains

Attribute

Type

Description

mode

[enum]

Permitted values / descriptions:

local: References with local scope are copied to the output directory. This is the default.
local-and-peer: References with local and peer scope are copied to the output directory.
all: All map level references (including external scope) are copied to the output directory.

Element: mapPairRemainingMapName 21

Sets the name of the remaining topic references ditamap.

Contained by

/ configuration / parameters / mapParameters

Contains

Type: xs:string

Element: mapResultOrigin 22

Sets the map input used to form the basis of the output.

Contained by

/ configuration / parameters / mapParameters

Contains

Attribute

Type

Description

mode

[enum]

Permitted values / descriptions:

A: Sets the A document map to be used as basis of the output.
B: Sets the B document map to be used as basis of the output. This is the default.

Element: mapResultStructure 23

Sets how the result map is constructed.

Contained by

/ configuration / parameters / mapParameters

Contains

Attribute

Type

Description

mode

[enum]

Permitted values / descriptions:

topic-set: Sets the result map to contain a flat list of topic references that appear in the order that they were first encountered in the result origin. This is the default.
map-pair: Sets the result map to contain two sub-maps: the 'updated' result origin map (and submaps); and the 'missing' topic references map.
unified-map: Sets the result map to contain the 'updated' result origin map, as well as deleted topic references in positions as close as possible their original location.

Element: mapScanTopicsForReferences 24

Specifies whether to scan topics for references.

Contained by

/ configuration / parameters / mapParameters

Contains

Attribute	Type	Description
enabled	booleanType	Set false to disable scan topics for references.

Element: mapTopicExceptionPropagationMode 25

Sets the action to perform when there is an exception raised during the processing of a topic.

Contained by

/ configuration / parameters / mapParameters

Contains

Attribute

Type

Description

mode

[enum]

Permitted values / descriptions:

fast-fail: Propagates the exception as quickly as possible to the map comparison.
phase-fail: Propagates the exception at the end of each phase of the comparison.
slow-fail: Propagates the exception once other topics and map-level operations have completed their processing. This is the default.

Element: mapUncomparedTopicMarkup 26

Sets what updates should be performed to un-compared/unaligned topics (in the context of a DITA map comparison).

Contained by

/ configuration / parameters / mapParameters

Contains

Attribute

Type

Description

mode

[enum]

Permitted values / descriptions:

auto: If DITA Markup is the selected output format, behave as if 'mark-changes' had been selected, otherwise behave as if 'leave-alone' had been selected. This is the default.
mark-change: Mark the top-level topic element of un-compared topics as added or deleted, in the manner specified by the other topic level parameters.
do-not-modify: Do no update the un-compared topics.

Element: common 27

The output parameters that are either used to specify a specific output type or apply to all output types.

Contained by

/ configuration / parameters / outputParameters

Contains

Element	Description
grouping	Specifies whether adjacent changes (insertions or deletions) should be grouped into a single insertion and/or deletion block
indentOutput	Sets whether the result should be indented
outputFormat	Specifies what type of output is produced
preservationMode	Sets the mode to use for preserving original data

Element: ditaMarkup 28

The DITA markup output format specific parameters provide control over how the 'rev' and 'status' attributes are used to represent change.

Contained by

/ configuration / parameters / outputParameters

Contains

Element	Description
addOutputClassAtts	Specifies whether to include an 'outputclass' attribute for marking changes
addRevisionAtts	Specifies whether the result should use 'rev' attributes to mark change
addStatusAtts	Specifies whether the result should use 'status' attributes to mark change
includeDeleted	Specifies whether to include deleted content in the result
newOutputclass	Specifies the string value to use for the outputclass attribute of added content
newRevision	Sets the mode to use for preserving original data
newVersionAtts	Specifies attributes to place on to added elements in the result
oldOutputClass	Specifies the string value to use for the outputclass attribute of deleted content
oldRevision	Specifies the string value to use for the rev attribute of deleted content
oldVersionAtts	Specifies attributes to place on deleted elements in the result
phraseContainerExclusions	Specifies any specializations where phrases have been removed from the content model
phraseElementName	Specifies the element name to use in place of ph in the result
showNonPhraseChanges	Specifies whether to textually mark changes to text where ph elements are not allowed

Element: trackedChanges 29

The tracked changes output format specific parameters provide a way of configuring tracked change output and editor/format specific output.

Contained by

/ configuration / parameters / outputParameters

Contains

Element	Description
framemakerTcsTableChangeMode	Specifies how changes in tables should be tracked
oxygenTcsDeletedSpaceMode	Specifies how deleted spaces should be handled
oxygenTcsVersion	Specifies the version of Oxygen editor used to display, accept and reject the tracked changes
trackedChangedAuthor	Specifies the author name that is embedded into the generated insertion and deletion processing instruction
trackedChangesDate	Specifies the time-stamp that is embedded into the generated insertion and deletion processing instruction
xmetalTcsTableChangeMode	Specifies how changes in tables should be tracked

Element: forceSpecialization 30

Specifies whether or not to force result specialization when the input types are different.

Contained by

/ configuration / parameters / advancedParameters / advancedBehaviour

Contains

Attribute	Type	Description
enabled	booleanType	Set false to disable forcing result specialization.

Element: outputEncodingDeclaration 31

Sets the character encoding output to use in the XML declaration.

Contained by

/ configuration / parameters / advancedParameters / advancedBehaviour

Contains

Type: xs:string

Element: topicPublicId 32

Specifies the publicId to use for a Topic doctype.

Contained by

/ configuration / parameters / advancedParameters / advancedBehaviour

Contains

Type: xs:string

Element: topicSystemId 33

Specifies the systemId to use for a Topic doctype.

Contained by

/ configuration / parameters / advancedParameters / advancedBehaviour

Contains

Type: xs:string

Element: xmlVersionDeclaration 34

Sets the version to use in the XML declaration.

Contained by

/ configuration / parameters / advancedParameters / advancedBehaviour

Contains

Attribute

Type

Description

mode

[enum]

Permitted values / descriptions:

1.0: Ensure the xml version is set to '1.0'.
1.1: Ensure the xml version is set to '1.1'.
system: Use the 'B' document's xml version (as provided by the parser).

Element: modifiedAttributeMode 35

Specifies how modified attributes should be included in the output.

Contained by

/ configuration / parameters / advancedParameters / selectingUnrepresentableChange

Contains

Attribute

Type

Description

mode

[enum]

Permitted values / descriptions:

automatic: The behaviour will depend on other parameter settings, primarily the output-format. If the output format is able to show attribute changes, modified attributes will not be processed differently, otherwise 'B' mode will be chosen.
B: Output the 'B' version of modified attributes and any added ('B') attributes. Note that deleted ('A') attributes will not be output.
BA: Output the 'B' version of modified attributes. Output both inserted ('B') and deleted ('A') attributes.
A: Output the 'A' version of modified attributes and any deleted ('A') attributes. Note that added ('B') attributes will not be output.
AB: Output the 'A' version of modified attributes. Output both inserted ('B') and deleted ('A') 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.

Element: unmarkedChangeMode 36

Specifies how to handle data that cannot contain difference markup.

Contained by

/ configuration / parameters / advancedParameters / selectingUnrepresentableChange

Contains

Attribute

Type

Description

mode

[enum]

Permitted values / descriptions:

B: Output the 'B' version of modified items; output inserted ('B') items; do not output deleted ('A') items.
BdA: As 'B' except when processing an internal subset declaration, in which case act as 'BA'.
BA: Output the 'B' version of modified items; output both inserted ('B') and deleted ('A') items.
A: Output the 'A' version of modified items; output deleted ('A') items; do not output inserted ('B') items.
AdB: As 'A' except when processing an internal subset declaration, in which case act as 'AB'.
AB: Output the 'A' version of modified items; output both inserted ('B') and deleted ('A') items.

Element: validateInputs 37

Specifies whether to validate input documents.

Contained by

/ configuration / parameters / advancedParameters / validation

Contains

Attribute	Type	Description
enabled	booleanType	Set false to disable validation of input documents.

Element: warningReportMode 38

Sets the mode to use for reporting recoverable errors and warnings.

Contained by

/ configuration / parameters / advancedParameters / validation

Contains

Attribute

Type

Description

mode

[enum]

Permitted values / descriptions:

messageReport: The recoverable errors and warnings as XSL messages, which are typically visible when the comparison is run from a command-line terminal.
pis: Add the recoverable errors and warnings as processing instructions.
comments: Add the recoverable errors and warnings as comments.
markupAdd: the recoverable errors and warnings as document content.

Element: removeRevAttributeRegex 39

This parameter specifies the regular expression that matches 'rev' attributes to be stripped.

Contained by

/ configuration / parameters / comparisonParameters / ditaConfiguration

Contains

Type: xs:string

Element: stepsConflictResolution 40

Specifies how to resolve conflicts between a task body's mutually exclusive steps and steps-unordered elements.

Contained by

/ configuration / parameters / comparisonParameters / ditaConfiguration

Contains

Attribute

Type

Description

mode

[enum]

Permitted values / descriptions:

preferA: Use the element name from the 'A' document to contain the compared entries.
preferB: Use the element name from the 'B' document to contain the compared entries.
preferSteps: Use a steps element to contain the compared entries.
preferStepsUnordered: Use a steps-unordered element to contain the compared entries.

Element: strictTaskModel 41

Specifies whether inputs are using the “strict task model” added in DITA 1.

2 (which reflects how tasks are defined pre-1.2) or the “general task model” which allows for a looser definition of elements under taskbody.

Contained by

/ configuration / parameters / comparisonParameters / ditaConfiguration

Contains

Attribute	Type	Description
enabled	booleanType	Set false to disable using the "strict task model".

Element: useIdsAsKeys 42

Specifies whether to use id attribute value as keys in order to provide identity during comparison.

Contained by

/ configuration / parameters / comparisonParameters / ditaConfiguration

Contains

Attribute	Type	Description
enabled	booleanType	Set false to disable using the id attribute as keys.

Element: detectMoves 43

If set to true, then elements moves are handled - if the elements have ids on them.

If this feature is set to true then it also overrides the value of the parameter ‘useIdsAsKeys’.

Contained by

/ configuration / parameters / comparisonParameters / elementMoves

Contains

Attribute	Type	Description
enabled	booleanType	Set false to disable moves handling.

Element: moveSourceRevision 44

Specifies the string value to use for the rev attribute for source of moved content.

Contained by

/ configuration / parameters / comparisonParameters / elementMoves

Contains

Type: xs:string

Element: moveTargetRevision 45

Specifies the string value to use for the rev attribute for target of moved content.

Contained by

/ configuration / parameters / comparisonParameters / elementMoves

Contains

Type: xs:string

Element: removeMoveSource 46

If set to true, then move source will be removed.

Contained by

/ configuration / parameters / comparisonParameters / elementMoves

Contains

Attribute	Type	Description
enabled	booleanType	Set false to keep move source.

Element: addInlineFormattingElements 47

A comma and/or space separated list of inline formatting elements, which will be added to the value of the inline-formatting-elements parameter.

Contained by

/ configuration / parameters / comparisonParameters / formattingElements

Contains

Type: xs:string

Element: ignoreInlineFormatting 48

If set to true, any changes that consist only of the addition, deletion or modification of DITA inline markup elements are not noted as changes.

Contained by

/ configuration / parameters / comparisonParameters / formattingElements

Contains

Attribute	Type	Description
enabled	booleanType	Set false to disable formatting handling.

Element: inlineFormattingElements 49

Sets the comma and/or space separated list of inline formatting elements.

Contained by

/ configuration / parameters / comparisonParameters / formattingElements

Contains

Type: xs:string

Element: removeInlineFormattingElements 50

A comma and/or space separated list of inline formatting elements, which will be removed from the value of the inline-formatting-elements parameter.

Contained by

/ configuration / parameters / comparisonParameters / formattingElements

Contains

Type: xs:string

Element: imageCompare 51

Specifies whether to compare images.

Contained by

/ configuration / parameters / comparisonParameters / imageComparison

Contains

Attribute	Type	Description
enabled	booleanType	Set false to disable image comparison.

Element: outputImageRefForm 52

Specifies output image ref form after image comparison.

By default outputs the href attribute as it appears in the source document.

Contained by

/ configuration / parameters / comparisonParameters / imageComparison

Contains

Attribute

Type

Description

mode

[enum]

Permitted values / descriptions:

source: Output the href attribute as it appears in the source document.
absolute: Output the href attribute as it is resolved.

Element: mathmlGranularity 53

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

Contained by

/ configuration / parameters / comparisonParameters / mathml

Contains

Attribute

Type

Description

mode

[enum]

Permitted values / descriptions:

adjacent: Reports the differences to the MathML by repeating A and B MathML inputs adjacent to each other.
detailedAdjacent: Reports the differences to the MathML by repeating the A and B MathML inputs adjacent to each other, with individual changes highlighted.
inline: Reports the differences within the MathML without duplicating A and B.

Element: mathmlProcessing 54

Specifies whether to apply MathML processing.

Contained by

/ configuration / parameters / comparisonParameters / mathml

Contains

Attribute	Type	Description
enabled	booleanType	Set false to disable MathML processing.

Element: compareSVG 55

Whether SVG comparison should be carried out.

Contained by

/ configuration / parameters / comparisonParameters / svgComparison

Contains

Type: xs:boolean

Element: fallbackChangePercentage 56

Defines the threshold at which fallback occurs if svgFallback is true

Contained by

/ configuration / parameters / comparisonParameters / svgComparison

Contains

Type: xs:double

Element: getSVGZIndex 57

Whether z index changes are allowed or not

Contained by

/ configuration / parameters / comparisonParameters / svgComparison

Contains

Type: xs:boolean

Element: inputASVGMarkupStyle 58

How to render input specific to input A

Contained by

/ configuration / parameters / comparisonParameters / svgComparison

Contains

Type: xs:string

Element: inputBSVGMarkupStyle 59

How to render input specific to input B

Contained by

/ configuration / parameters / comparisonParameters / svgComparison

Contains

Type: xs:string

Element: invalidReferencedSVGBehaviour 60

Specifies how to handle invalid referenced SVG images.

Contained by

/ configuration / parameters / comparisonParameters / svgComparison

Contains

Attribute

Type

Description

mode

[enum]

Permitted values / descriptions:

fail: Throws an exception.
warn: Output a warning, output of which is controlled by warningReportMode.
ignore: Ignore errors with referenced SVG

Element: isNumericToleranceEnabled 61

Whether numeric tolerance is allowed or not

Contained by

/ configuration / parameters / comparisonParameters / svgComparison

Contains

Type: xs:boolean

Element: numericToleranceValue 62

Defines the numeric tolerance value if numeric tolerance value is true

Contained by

/ configuration / parameters / comparisonParameters / svgComparison

Contains

Type: xs:string

Element: svgComparisonGranularity 63

Specifies how to display SVG changes.

Contained by

/ configuration / parameters / comparisonParameters / svgComparison

Contains

Attribute

Type

Description

mode

[enum]

Permitted values / descriptions:

adjacent: Reports the differences to the SVG by repeating A and B SVG inputs adjacent to each other.
detailed-adjacent: Reports the differences to the SVG by repeating the A and B SVG inputs adjacent to each other, with individual changes highlighted.

Element: svgFallback 64

Fallback to the ADJACENT result if alignment is below the defined threshold (set by fallbackChangePercentage).

Contained by

/ configuration / parameters / comparisonParameters / svgComparison

Contains

Type: xs:boolean

Element: zIndexSVGMarkupStyle 65

Defines the z index mark up style value if z index value is true

Contained by

/ configuration / parameters / comparisonParameters / svgComparison

Contains

Type: xs:string

Element: calsTableProcessing 66

Specifies whether to apply CALS table processing.

Contained by

/ configuration / parameters / comparisonParameters / tableComparison

Contains

Attribute	Type	Description
enabled	booleanType	Set false to disable CALS table processing.

Element: htmlTableProcessing 67

Specifies whether to apply HTML table/DITA simpletable processing.

Contained by

/ configuration / parameters / comparisonParameters / tableComparison

Contains

Attribute	Type	Description
enabled	booleanType	Set false to disable HTML table processing.

Element: invalidTableBehaviour 68

This parameter declares what type of processing should be used for those tables that are marked as invalid.

Contained by

/ configuration / parameters / comparisonParameters / tableComparison

Contains

Attribute

Type

Description

mode

[enum]

Permitted values / descriptions:

fail: Throw an exception.
propagateUp: Propagate the changes to the table-level.
compareAsXml: Compare the table content as well-formed XML.

Element: characterByCharacter 69

Specifies whether to compare text character by character

Contained by

/ configuration / parameters / comparisonParameters / textComparison

Contains

Attribute	Type	Description
enabled	booleanType	Set true to enable character-by-character comparison.

Element: whitespaceProcessingMode 70

Specifies how to handle whitespace changes.

Contained by

/ configuration / parameters / comparisonParameters / textComparison

Contains

Attribute

Type

Description

mode

[enum]

Permitted values / descriptions:

show: Display the differences in whitespace where possible.
cdata: Ignore differences in whitespace, unless they occur within a CDATA section (or are explicitly preserved).
ignore: Ignore differences in whitespace that is not explicitly preserved.
normalize: Normalize whitespace in inputs before comparison.
automatic: Chooses the most appropriate mode based on other parameter settings. This is dependent on two other parameters 'outputFormat' and the 'preservationMode', as discussed in the main whitespace processing mode documentation.

Element: wordByWord 71

Specifies whether to perform detailed text comparison or not.

Contained by

/ configuration / parameters / comparisonParameters / textComparison

Contains

Attribute	Type	Description
enabled	booleanType	Set false to disable word-by-word comparison.

Element: grouping 72

Specifies whether adjacent changes (insertions or deletions) should be grouped into a single insertion and/or deletion block.

Contained by

/ configuration / parameters / outputParameters / common

Contains

Attribute	Type	Description
enabled	booleanType	Set false to disable change grouping.

Element: indentOutput 73

Sets whether the result should be indented.

Contained by

/ configuration / parameters / outputParameters / common

Contains

Attribute

Type

Description

mode

[enum]

Permitted values / descriptions:

yes: The value representing the String value 'yes'. Output is indented.
no: The value representing the String value 'no'. Output is not indented.

Element: outputFormat 74

Specifies what type of output is produced.

Contained by

/ configuration / parameters / outputParameters / common

Contains

Attribute

Type

Description

mode

[enum]

Permitted values / descriptions:

dita-markup: Differences are marked up using DITA's rev and status attributes.
arbortext-tcs: Differences are marked up in the Arbortext tracked change format.
oxygen-tcs: Differences are marked up in the Oxygen tracked change format.
xmetal-tcs: Differences are marked up in the XMetaL tracked change format.
framemaker-tcs: Differences are marked up in the FrameMaker tracked change format.

Element: preservationMode 75

Sets the mode to use for preserving original data.

Contained by

/ configuration / parameters / outputParameters / common

Contains

Attribute

Type

Description

mode

[enum]

Permitted values / descriptions:

automatic: Chooses the most appropriate setting based on the output format. If tracked changes are being produced, this will be 'roundTrip', otherwise 'docAndAttrib' will be used.
document: Preserve document typing information.
docAndAttrib: Preserve document typing and original attribute information.
roundTrip: Preserve document type, entity usage, and attribute usage data.
entityRef: Enhance round-trip processing by analysing entity contents.
nestedEntityRef: Enhance round-trip processing by analysing both entity and nested entity contents.

Element: addOutputClassAtts 76

Specifies whether to include an 'outputclass' attribute for marking changes.

Contained by

/ configuration / parameters / outputParameters / ditaMarkup

Contains

Attribute	Type	Description
enabled	booleanType	Set false to disable including an 'outputclass' attribute.

Element: addRevisionAtts 77

Specifies whether the result should use 'rev' attributes to mark change.

Contained by

/ configuration / parameters / outputParameters / ditaMarkup

Contains

Attribute	Type	Description
enabled	booleanType	Set false to disable using 'rev' attributes to mark change.

Element: addStatusAtts 78

Specifies whether the result should use 'status' attributes to mark change.

Contained by

/ configuration / parameters / outputParameters / ditaMarkup

Contains

Attribute	Type	Description
enabled	booleanType	Set false to disable using 'status' attributes to mark change.

Element: includeDeleted 79

Specifies whether to include deleted content in the result.

Contained by

/ configuration / parameters / outputParameters / ditaMarkup

Contains

Attribute	Type	Description
enabled	booleanType	Set false to disable including deleted content in the result.

Element: newOutputclass 80

Specifies the string value to use for the outputclass attribute of added content.

Contained by

/ configuration / parameters / outputParameters / ditaMarkup

Contains

Type: xs:string

Element: newRevision 81

Sets the mode to use for preserving original data.

Contained by

/ configuration / parameters / outputParameters / ditaMarkup

Contains

Type: xs:string

Element: newVersionAtts 82

Specifies attributes to place on to added elements in the result

Contained by

/ configuration / parameters / outputParameters / ditaMarkup

Contains

Element	Description
versionAtt	Custom version attribute datatype

Element: oldOutputClass 83

Specifies the string value to use for the outputclass attribute of deleted content.

Contained by

/ configuration / parameters / outputParameters / ditaMarkup

Contains

Type: xs:string

Element: oldRevision 84

Specifies the string value to use for the rev attribute of deleted content.

Contained by

/ configuration / parameters / outputParameters / ditaMarkup

Contains

Type: xs:string

Element: oldVersionAtts 85

Specifies attributes to place on deleted elements in the result

Contained by

/ configuration / parameters / outputParameters / ditaMarkup

Contains

Element	Description
versionAtt	Custom version attribute datatype

Element: phraseContainerExclusions 86

Specifies any specializations where phrases have been removed from the content model.

Contained by

/ configuration / parameters / outputParameters / ditaMarkup

Contains

Type: xs:string

Element: phraseElementName 87

Specifies the element name to use in place of ph in the result.

Contained by

/ configuration / parameters / outputParameters / ditaMarkup

Contains

Type: xs:string

Element: showNonPhraseChanges 88

Specifies whether to textually mark changes to text where ph elements are not allowed.

Contained by

/ configuration / parameters / outputParameters / ditaMarkup

Contains

Attribute

Type

Description

mode

[enum]

Permitted values / descriptions:

where-valid: Uses -[[old-text]]- +[[new-text]]+ delimiters to show change where ph is not a valid DITA.
always: Always wrap change in the element set by phrase-element-name.
never: Do not show change where a 'phrase-element-name' element is not valid.

Element: framemakerTcsTableChangeMode 89

Specifies how changes in tables should be tracked.

Contained by

/ configuration / parameters / outputParameters / trackedChanges

Contains

Attribute

Type

Description

mode

[enum]

Permitted values / descriptions:

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

Element: oxygenTcsDeletedSpaceMode 90

Specifies how deleted spaces should be handled.

Contained by

/ configuration / parameters / outputParameters / trackedChanges

Contains

Attribute

Type

Description

mode

[enum]

Permitted values / descriptions:

automatic: Chooses the delete space processing mode based on the declared oxygen-tcs-version parameter.
normlize: Allows deleted text to be viewed correctly prior to oXygen 14 release.
keep: Keeps the original whitespace formating of the deleted region.

Element: oxygenTcsVersion 91

Specifies the version of Oxygen editor used to display, accept and reject the tracked changes.

Contained by

/ configuration / parameters / outputParameters / trackedChanges

Contains

Type: xs:float

Element: trackedChangedAuthor 92

Specifies the author name that is embedded into the generated insertion and deletion processing instruction.

Contained by

/ configuration / parameters / outputParameters / trackedChanges

Contains

Type: xs:string

Element: trackedChangesDate 93

Specifies the time-stamp that is embedded into the generated insertion and deletion processing instruction.

Contained by

/ configuration / parameters / outputParameters / trackedChanges

Contains

Type: xs:string

Element: xmetalTcsTableChangeMode 94

Specifies how changes in tables should be tracked.

Contained by

/ configuration / parameters / outputParameters / trackedChanges

Contains

Attribute

Type

Description

mode

[enum]

Permitted values / descriptions:

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

Element: versionAtt 95

Custom version attribute datatype

Contained by

/ configuration / parameters / outputParameters / ditaMarkup / newVersionAtts

/ configuration / parameters / outputParameters / ditaMarkup / oldVersionAtts

Contains

Attribute	Type	Description
localName		Custom version attribute local name.
value		Custom version attribute value.
namespaceUri		Custom version attribute namespace URI.
prefix		Custom version prefix.

(This documentation was auto-generated from the XML Schema for the DITA Compare REST topic configuration file.)