Topic 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 35
common 16
detectMoves 32
ditaMarkup 17
elementMoves 10
framemakerTcsTableChangeMode 65
grouping 48
imageCompare 39
indentOutput 49
mathml 13
newRevision 57
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
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 | |
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
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
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 | |
tableComparison | These parameters control how tables are compared | |
textComparison | These parameters control how text is compared and whitespace handled |
Element: outputParameters 5
These parameters enable the form of the output to be configured.
Contained by
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 6
Parameters used to override or force specific behaviours.
Contained by
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 7
These parameters are used to specify how unrepresentable change can be handled.
Contained by
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 8
Input validation and reporting.
Contained by
Contains
Element | Description | |
---|---|---|
validateInputs | Specifies whether to validate input documents | |
warningReportMode | Sets the mode to use for reporting recoverable errors and warnings |
Element: ditaConfiguration 9
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
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 10
These parameters control element moves handling and defines the values for revision attribute.
Contained by
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 |
Element: formattingElements 11
These parameters control which DITA elements are marked as inline structural changes.
Contained by
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 12
Parameters managing image comparison.
Contained by
Contains
Element | Description | |
---|---|---|
imageCompare | Specifies whether to compare images | |
outputImageRefForm | Specifies output image ref form after image comparison |
Element: mathml 13
Parameters managing MathML
Contained by
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: tableComparison 14
These parameters control how tables are compared.
Contained by
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 15
These parameters control how text is compared and whitespace handled.
Contained by
Contains
Element | Description | |
---|---|---|
whitespaceProcessingMode | Specifies how to handle whitespace changes | |
wordByWord | Specifies whether to perform detailed text comparison or not |
Element: common 16
The output parameters that are either used to specify a specific output type or apply to all output types.
Contained by
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 17
The DITA markup output format specific parameters provide control over how the 'rev' and 'status' attributes are used to represent change.
Contained by
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 18
The tracked changes output format specific parameters provide a way of configuring tracked change output and editor/format specific output.
Contained by
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 19
Specifies whether or not to force result specialization when the input types are different.
Contained by
Contains
Attribute | Type | Description |
---|---|---|
enabled | booleanType | Set false to disable forcing result specialization. |
Element: outputEncodingDeclaration 20
Sets the character encoding output to use in the XML declaration.
Contained by
Contains
Type: xs:string
Element: topicPublicId 21
Specifies the publicId to use for a Topic doctype.
Contained by
Contains
Type: xs:string
Element: topicSystemId 22
Specifies the systemId to use for a Topic doctype.
Contained by
Contains
Type: xs:string
Element: xmlVersionDeclaration 23
Sets the version to use in the XML declaration.
Contained by
Contains
Attribute | Type | Description |
---|---|---|
mode | [enum] |
Permitted values / descriptions:
|
Element: modifiedAttributeMode 24
Specifies how modified attributes should be included in the output.
Contained by
Contains
Attribute | Type | Description |
---|---|---|
mode | [enum] |
Permitted values / descriptions:
|
Element: unmarkedChangeMode 25
Specifies how to handle data that cannot contain difference markup.
Contained by
Contains
Attribute | Type | Description |
---|---|---|
mode | [enum] |
Permitted values / descriptions:
|
Element: validateInputs 26
Specifies whether to validate input documents.
Contained by
Contains
Attribute | Type | Description |
---|---|---|
enabled | booleanType | Set false to disable validation of input documents. |
Element: warningReportMode 27
Sets the mode to use for reporting recoverable errors and warnings.
Contained by
Contains
Attribute | Type | Description |
---|---|---|
mode | [enum] |
Permitted values / descriptions:
|
Element: removeRevAttributeRegex 28
This parameter specifies the regular expression that matches 'rev' attributes to be stripped.
Contained by
Contains
Type: xs:string
Element: stepsConflictResolution 29
Specifies how to resolve conflicts between a task body's mutually exclusive steps and steps-unordered elements.
Contained by
Contains
Attribute | Type | Description |
---|---|---|
mode | [enum] |
Permitted values / descriptions:
|
Element: strictTaskModel 30
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
Contains
Attribute | Type | Description |
---|---|---|
enabled | booleanType | Set false to disable using the "strict task model". |
Element: useIdsAsKeys 31
Specifies whether to use id attribute value as keys in order to provide identity during comparison.
Contained by
Contains
Attribute | Type | Description |
---|---|---|
enabled | booleanType | Set false to disable using the id attribute as keys. |
Element: detectMoves 32
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
Contains
Attribute | Type | Description |
---|---|---|
enabled | booleanType | Set false to disable moves handling. |
Element: moveSourceRevision 33
Specifies the string value to use for the rev attribute for source of moved content.
Contained by
Contains
Type: xs:string
Element: moveTargetRevision 34
Specifies the string value to use for the rev attribute for target of moved content.
Contained by
Contains
Type: xs:string
Element: addInlineFormattingElements 35
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
Contains
Type: xs:string
Element: ignoreInlineFormatting 36
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
Contains
Attribute | Type | Description |
---|---|---|
enabled | booleanType | Set false to disable formatting handling. |
Element: inlineFormattingElements 37
Sets the comma and/or space separated list of inline formatting elements.
Contained by
Contains
Type: xs:string
Element: removeInlineFormattingElements 38
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
Contains
Type: xs:string
Element: imageCompare 39
Specifies whether to compare images.
Contained by
Contains
Attribute | Type | Description |
---|---|---|
enabled | booleanType | Set false to disable image comparison. |
Element: outputImageRefForm 40
Specifies output image ref form after image comparison.
By default outputs the href attribute as it appears in the source document.
Contained by
Contains
Attribute | Type | Description |
---|---|---|
mode | [enum] |
Permitted values / descriptions:
|
Element: mathmlGranularity 41
Specifies the granularity at which the differences between the two MathML expressions will be represented.
Contained by
Contains
Attribute | Type | Description |
---|---|---|
mode | [enum] |
Permitted values / descriptions:
|
Element: mathmlProcessing 42
Specifies whether to apply MathML processing.
Contained by
Contains
Attribute | Type | Description |
---|---|---|
enabled | booleanType | Set false to disable MathML processing. |
Element: calsTableProcessing 43
Specifies whether to apply CALS table processing.
Contained by
Contains
Attribute | Type | Description |
---|---|---|
enabled | booleanType | Set false to disable CALS table processing. |
Element: htmlTableProcessing 44
Specifies whether to apply HTML table/DITA simpletable processing.
Contained by
Contains
Attribute | Type | Description |
---|---|---|
enabled | booleanType | Set false to disable HTML table processing. |
Element: invalidTableBehaviour 45
This parameter declares what type of processing should be used for those tables that are marked as invalid.
Contained by
Contains
Attribute | Type | Description |
---|---|---|
mode | [enum] |
Permitted values / descriptions:
|
Element: whitespaceProcessingMode 46
Specifies how to handle whitespace changes.
Contained by
Contains
Attribute | Type | Description |
---|---|---|
mode | [enum] |
Permitted values / descriptions:
|
Element: wordByWord 47
Specifies whether to perform detailed text comparison or not.
Contained by
Contains
Attribute | Type | Description |
---|---|---|
enabled | booleanType | Set false to disable word-by-word comparison. |
Element: grouping 48
Specifies whether adjacent changes (insertions or deletions) should be grouped into a single insertion and/or deletion block.
Contained by
Contains
Attribute | Type | Description |
---|---|---|
enabled | booleanType | Set false to disable change grouping. |
Element: indentOutput 49
Sets whether the result should be indented.
Contained by
Contains
Attribute | Type | Description |
---|---|---|
mode | [enum] |
Permitted values / descriptions:
|
Element: outputFormat 50
Specifies what type of output is produced.
Contained by
Contains
Attribute | Type | Description |
---|---|---|
mode | [enum] |
Permitted values / descriptions:
|
Element: preservationMode 51
Sets the mode to use for preserving original data.
Contained by
Contains
Attribute | Type | Description |
---|---|---|
mode | [enum] |
Permitted values / descriptions:
|
Element: addOutputClassAtts 52
Specifies whether to include an 'outputclass' attribute for marking changes.
Contained by
Contains
Attribute | Type | Description |
---|---|---|
enabled | booleanType | Set false to disable including an 'outputclass' attribute. |
Element: addRevisionAtts 53
Specifies whether the result should use 'rev' attributes to mark change.
Contained by
Contains
Attribute | Type | Description |
---|---|---|
enabled | booleanType | Set false to disable using 'rev' attributes to mark change. |
Element: addStatusAtts 54
Specifies whether the result should use 'status' attributes to mark change.
Contained by
Contains
Attribute | Type | Description |
---|---|---|
enabled | booleanType | Set false to disable using 'status' attributes to mark change. |
Element: includeDeleted 55
Specifies whether to include deleted content in the result.
Contained by
Contains
Attribute | Type | Description |
---|---|---|
enabled | booleanType | Set false to disable including deleted content in the result. |
Element: newOutputclass 56
Specifies the string value to use for the outputclass attribute of added content.
Contained by
Contains
Type: xs:string
Element: newRevision 57
Sets the mode to use for preserving original data.
Contained by
Contains
Type: xs:string
Element: newVersionAtts 58
Specifies attributes to place on to added elements in the result
Contained by
Contains
Element | Description | |
---|---|---|
versionAtt | Custom version attribute datatype |
Element: oldOutputClass 59
Specifies the string value to use for the outputclass attribute of deleted content.
Contained by
Contains
Type: xs:string
Element: oldRevision 60
Specifies the string value to use for the rev attribute of deleted content.
Contained by
Contains
Type: xs:string
Element: oldVersionAtts 61
Specifies attributes to place on deleted elements in the result
Contained by
Contains
Element | Description | |
---|---|---|
versionAtt | Custom version attribute datatype |
Element: phraseContainerExclusions 62
Specifies any specializations where phrases have been removed from the content model.
Contained by
Contains
Type: xs:string
Element: phraseElementName 63
Specifies the element name to use in place of ph in the result.
Contained by
Contains
Type: xs:string
Element: showNonPhraseChanges 64
Specifies whether to textually mark changes to text where ph elements are not allowed.
Contained by
Contains
Attribute | Type | Description |
---|---|---|
mode | [enum] |
Permitted values / descriptions:
|
Element: framemakerTcsTableChangeMode 65
Specifies how changes in tables should be tracked.
Contained by
Contains
Attribute | Type | Description |
---|---|---|
mode | [enum] |
Permitted values / descriptions:
|
Element: oxygenTcsDeletedSpaceMode 66
Specifies how deleted spaces should be handled.
Contained by
Contains
Attribute | Type | Description |
---|---|---|
mode | [enum] |
Permitted values / descriptions:
|
Element: oxygenTcsVersion 67
Specifies the version of Oxygen editor used to display, accept and reject the tracked changes.
Contained by
Contains
Type: xs:float
Element: trackedChangedAuthor 68
Specifies the author name that is embedded into the generated insertion and deletion processing instruction.
Contained by
Contains
Type: xs:string
Element: trackedChangesDate 69
Specifies the time-stamp that is embedded into the generated insertion and deletion processing instruction.
Contained by
Contains
Type: xs:string
Element: xmetalTcsTableChangeMode 70
Specifies how changes in tables should be tracked.
Contained by
Contains
Attribute | Type | Description |
---|---|---|
mode | [enum] |
Permitted values / descriptions:
|
Element: versionAtt 71
Custom version attribute datatype
Contained by
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.)