Configuration File Schema Guide
This guide provides a short description of each element and attribute defined in the XML schema for the DocBook Compare 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 30
common 17
compareSVG 51
detectMoves 28
framemakerTcsTableChangeMode 65
grouping 59
imageCompare 34
indentOutput 60
keyingMode 29
mathml 12
moves 13
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 DocBook 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 | |
---|---|---|
alignment | Settings that affect the alignment/matching of documents | |
formattingElements | These parameters control which DocBook elements are marked as inline structural changes | |
imageComparison | Parameters managing image comparison | |
mathml | Parameters managing MathML | |
moves | Settings that affect the alignment/matching of documents | |
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: 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 | |
phraseChanges | Settings that affect the behaviour of displaying text changes | |
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 | |
---|---|---|
enableXinclude | If set to true the parser will process XIncludes while parsing the inputs | |
outputEncodingDeclaration | Sets the character encoding output to use in the XML declaration | |
standaloneDeclaration | This parameter no longer has any effect | |
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 | how modified attributes should be included in the output | |
unmarkedChangeMode | 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: alignment 9
Settings that affect the alignment/matching of documents.
Contained by
Contains
Element | Description | |
---|---|---|
detectMoves | Setting to detect and handle element moves | |
keyingMode | Sets the mode to use for adding keys to the input documents |
Element: formattingElements 10
These parameters control which DocBook 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 DocBook 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 11
Parameters managing image comparison.
Contained by
Contains
Element | Description | |
---|---|---|
imageCompare | Specifies whether to compare images | |
mediaObjectParentsList | Sets the comma and/or space separated list of media object parents using Clark notation | |
outputImageRefFavourSourceDoc | If image-compare is set to true, this parameter controls which imagedata fileref attribute, from A or B is use to derive the result fileref value when the image has not changed | |
outputImageRefForm | If image-compare is set to true, this parameter controls the form output for fileref attributes of imagedata elements | |
showImageChangesAtMediaObjectLevel | If image-compare is set to true and determines that images have changed, show the changes as changes to the containing mediaobjects | |
showImageChangesAtMediaObjectParentLevel | If image-compare is set to true and determines that images have changed, show the changes as changes to the parent element of mediaobject |
Element: mathml 12
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: moves 13
Settings that affect the alignment/matching of documents.
Contained by
Contains
Element | Description | |
---|---|---|
detectMoves | Setting to detect and handle element moves | |
removeMoveSource | Setting to remove source element moves |
Element: svgComparison 14
These parameters control how SVG changes are displayed.
Contained by
Contains
Element | Description | |
---|---|---|
InputASVGMarkupStyle | sets the A input markup colour | |
InputBSVGMarkupStyle | sets the B input markup colour | |
SVGFallback | Fallback to the ADJACENT result if alignment is below the defined threshold (set by fallbackChangePercentage) | |
SVGFallbackChangePercentage | Defines the threshold at which fallback occurs if svgFallback is true | |
SVGNumericTolerance | enables svg numeric tolerance, changes less than numericToleranceValue are ignored | |
SVGNumericToleranceValue | Defines the threshold value for numeric tolerance | |
SVGZIndex | enables representation of Z index changes | |
ZIndexSVGMarkupStyle | sets the markup colour for representation of Z index changes | |
compareSVG | Whether an SVG comparison should be carried out | |
svgComparisonGranularity | Specifies how to display SVG changes |
Element: tableComparison 15
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 processing | |
invalidTableBehaviour | This parameter declares what type of processing should be used for those tables that are marked as invalid |
Element: textComparison 16
These parameters control how text is compared and whitespace handled.
Contained by
Contains
Element | Description | |
---|---|---|
characterByCharacter | Specifies whether to perform a character by character comparison or not | |
whitespaceProcessingMode | Specifies how to handle whitespace changes | |
wordByWord | Specifies whether to perform detailed text comparison or not |
Element: common 17
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: phraseChanges 18
Settings that affect the behaviour of displaying text changes.
Contained by
Contains
Element | Description | |
---|---|---|
additionalPhraseContainers | Sets the comma and/or space separated list of additional phrase elements using Clark notation | |
showNonPhraseChanges | Sets whether to textually mark changes to text where phrase elements are not allowed |
Element: trackedChanges 19
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 | |
trackedChangesAuthor | 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: enableXinclude 20
If set to true the parser will process XIncludes while parsing the inputs.
Contained by
Contains
Type: xs:boolean
Element: outputEncodingDeclaration 21
Sets the character encoding output to use in the XML declaration.
Contained by
Contains
Type: xs:string
Element: standaloneDeclaration 22
This parameter no longer has any effect.
Preserving the standalone declaration is not supported, due to incompatibilities in the underpinning parsing and serialisation technologies.
Contained by
Contains
Attribute | Type | Description |
---|---|---|
mode | [enum] |
Permitted values / descriptions:
|
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
how modified attributes should be included in the output.
Contained by
Contains
Type: xs:string
Element: unmarkedChangeMode 25
how to handle data that cannot contain difference markup.
Contained by
Contains
Type: xs:string
Element: validateInputs 26
Specifies whether to validate input documents.
Contained by
Contains
Type: xs:boolean
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: detectMoves 28
Setting to detect and handle element moves.
Contained by
Contains
Type: xs:boolean
Element: keyingMode 29
Sets the mode to use for adding keys to the input documents.
Contained by
Contains
Attribute | Type | Description |
---|---|---|
mode | [enum] |
Permitted values / descriptions:
|
Element: addInlineFormattingElements 30
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 31
If set to true, any changes that consist only of the addition, deletion or modification of DocBook inline markup elements are not noted as changes.
Contained by
Contains
Type: xs:boolean
Element: inlineFormattingElements 32
Sets the comma and/or space separated list of inline formatting elements.
Contained by
Contains
Type: xs:string
Element: removeInlineFormattingElements 33
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 34
Specifies whether to compare images.
Contained by
Contains
Type: xs:boolean
Element: mediaObjectParentsList 35
Sets the comma and/or space separated list of media object parents using Clark notation.
Only active when showImageChangesAtMediaObjectParentLevel is set to true..
Contained by
Contains
Type: xs:string
Element: outputImageRefFavourSourceDoc 36
If image-compare is set to true, this parameter controls which imagedata fileref attribute, from A or B is use to derive the result fileref value when the image has not changed
Contained by
Contains
Attribute | Type | Description |
---|---|---|
mode | [enum] |
Permitted values / descriptions:
|
Element: outputImageRefForm 37
If image-compare is set to true, this parameter controls the form output for fileref attributes of imagedata elements
Contained by
Contains
Attribute | Type | Description |
---|---|---|
mode | [enum] |
Permitted values / descriptions:
|
Element: showImageChangesAtMediaObjectLevel 38
If image-compare is set to true and determines that images have changed, show the changes as changes to the containing mediaobjects.
Contained by
Contains
Type: xs:boolean
Element: showImageChangesAtMediaObjectParentLevel 39
If image-compare is set to true and determines that images have changed, show the changes as changes to the parent element of mediaobject.
Contained by
Contains
Type: xs:boolean
Element: mathmlGranularity 40
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 41
Specifies whether to apply MathML processing.
Contained by
Contains
Type: xs:boolean
Element: removeMoveSource 42
Setting to remove source element moves.
Contained by
Contains
Type: xs:boolean
Element: InputASVGMarkupStyle 43
sets the A input markup colour.
Default is red
Contained by
Contains
Type: xs:string
Element: InputBSVGMarkupStyle 44
sets the B input markup colour.
Default is green
Contained by
Contains
Type: xs:string
Element: SVGFallback 45
Fallback to the ADJACENT result if alignment is below the defined threshold (set by fallbackChangePercentage).
Contained by
Contains
Type: xs:boolean
Element: SVGFallbackChangePercentage 46
Defines the threshold at which fallback occurs if svgFallback is true
Contained by
Contains
Type: xs:double
Element: SVGNumericTolerance 47
enables svg numeric tolerance, changes less than numericToleranceValue are ignored
Contained by
Contains
Type: xs:boolean
Element: SVGNumericToleranceValue 48
Defines the threshold value for numeric tolerance.
Default is '1%', can also be provided as numeric value (in pixels)
Contained by
Contains
Type: xs:string
Element: SVGZIndex 49
enables representation of Z index changes
Contained by
Contains
Type: xs:boolean
Element: ZIndexSVGMarkupStyle 50
sets the markup colour for representation of Z index changes.
Default is purple.
Contained by
Contains
Type: xs:string
Element: compareSVG 51
Whether an SVG comparison should be carried out.
Contained by
Contains
Type: xs:boolean
Element: svgComparisonGranularity 52
Specifies how to display SVG changes.
Contained by
Contains
Attribute | Type | Description |
---|---|---|
mode | [enum] |
Permitted values / descriptions:
|
Element: calsTableProcessing 53
Specifies whether to apply CALS table processing.
Contained by
Contains
Type: xs:boolean
Element: htmlTableProcessing 54
Specifies whether to apply HTML table processing.
Contained by
Contains
Type: xs:boolean
Element: invalidTableBehaviour 55
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: characterByCharacter 56
Specifies whether to perform a character by character comparison or not.
Contained by
Contains
Type: xs:boolean
Element: whitespaceProcessingMode 57
Specifies how to handle whitespace changes.
Contained by
Contains
Attribute | Type | Description |
---|---|---|
mode | [enum] |
Permitted values / descriptions:
|
Element: wordByWord 58
Specifies whether to perform detailed text comparison or not.
Contained by
Contains
Type: xs:boolean
Element: grouping 59
Specifies whether adjacent changes (insertions or deletions) should be grouped into a single insertion and/or deletion block.
Contained by
Contains
Type: xs:boolean
Element: indentOutput 60
Sets whether the result should be indented.
Contained by
Contains
Attribute | Type | Description |
---|---|---|
mode | [enum] |
Permitted values / descriptions:
|
Element: outputFormat 61
Specifies what type of output is produced.
Contained by
Contains
Attribute | Type | Description |
---|---|---|
mode | [enum] |
Permitted values / descriptions:
|
Element: preservationMode 62
Sets the mode to use for preserving original data.
Contained by
Contains
Attribute | Type | Description |
---|---|---|
mode | [enum] |
Permitted values / descriptions:
|
Element: additionalPhraseContainers 63
Sets the comma and/or space separated list of additional phrase elements using Clark notation.
Contained by
Contains
Type: xs:string
Element: showNonPhraseChanges 64
Sets whether to textually mark changes to text where phrase elements are not allowed.
Contained by
Contains
Type: xs:boolean
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: trackedChangesAuthor 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:
|
(This documentation was auto-generated from the XML Schema for the DocBook Compare configuration file.)