HTML Compare Configuration File Schema Guide

This guide provides a short description of each element and attribute defined in the XML schema for the HTML 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 occurrence indicators are described below:

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

Element Index

HTML Compare Configuration File Schema Guide | characterByCharacter 9

HTML Compare Configuration File Schema Guide | columnKeyingMode 26

HTML Compare Configuration File Schema Guide | comparisonType 3

HTML Compare Configuration File Schema Guide | configuration 1

HTML Compare Configuration File Schema Guide | formattingConfiguration 4

HTML Compare Configuration File Schema Guide | formattingElements 10

HTML Compare Configuration File Schema Guide | htmlConfiguration 5

HTML Compare Configuration File Schema Guide | ignoreColumnOrder 27

HTML Compare Configuration File Schema Guide | ignoreFormattingElements 11

HTML Compare Configuration File Schema Guide | inputAHighlightColour 13

HTML Compare Configuration File Schema Guide | inputAStyling 14

HTML Compare Configuration File Schema Guide | inputBHighlightColour 15

HTML Compare Configuration File Schema Guide | inputBStyling 16

HTML Compare Configuration File Schema Guide | invalidTableBehaviour 28

HTML Compare Configuration File Schema Guide | mathmlConfiguration 6

HTML Compare Configuration File Schema Guide | mathmlGranularity 17

HTML Compare Configuration File Schema Guide | normalizeTableColumns 29

HTML Compare Configuration File Schema Guide | parameters 2

HTML Compare Configuration File Schema Guide | retainComments 12

HTML Compare Configuration File Schema Guide | svgConfiguration 7

HTML Compare Configuration File Schema Guide | svgEnabled 18

HTML Compare Configuration File Schema Guide | svgFallbackChangedPercentage 19

HTML Compare Configuration File Schema Guide | svgFallbackEnabled 20

HTML Compare Configuration File Schema Guide | svgGranularity 21

HTML Compare Configuration File Schema Guide | svgNumericToleranceEnabled 22

HTML Compare Configuration File Schema Guide | svgNumericToleranceValue 23

HTML Compare Configuration File Schema Guide | svgZIndexEnabled 24

HTML Compare Configuration File Schema Guide | tableConfiguration 8

HTML Compare Configuration File Schema Guide | validationLevel 30

HTML Compare Configuration File Schema Guide | warningReportMode 31

HTML Compare Configuration File Schema Guide | zIndexMarkupStyle 25

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 HTML Compare.

Contained by

Contains

Element	Description
HTML Compare Configuration File Schema Guide \| 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

/ HTML Compare Configuration File Schema Guide | configuration

Contains

Element	Description
HTML Compare Configuration File Schema Guide \| comparisonType	These parameters control how text is compared
HTML Compare Configuration File Schema Guide \| formattingConfiguration	These parameters control which HTML elements are marked as inline structural changes
HTML Compare Configuration File Schema Guide \| htmlConfiguration	These parameters control html specific configurations
HTML Compare Configuration File Schema Guide \| mathmlConfiguration	These parameters control how MathML is managed
HTML Compare Configuration File Schema Guide \| svgConfiguration	These parameters control how SVG changes are displayed
HTML Compare Configuration File Schema Guide \| tableConfiguration	These parameters control how tables are compared

Element: comparisonType 3

These parameters control how text is compared.

Contained by

/ HTML Compare Configuration File Schema Guide | configuration / HTML Compare Configuration File Schema Guide | parameters

Contains

Element	Description
HTML Compare Configuration File Schema Guide \| characterByCharacter	Specifies whether to perform a character by character comparison or not

Element: formattingConfiguration 4

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

Contained by

/ HTML Compare Configuration File Schema Guide | configuration / HTML Compare Configuration File Schema Guide | parameters

Contains

Element	Description
HTML Compare Configuration File Schema Guide \| formattingElements	Sets the comma and/or space separated list of inline and block level formatting elements
HTML Compare Configuration File Schema Guide \| ignoreFormattingElements	If set to true, any formatting elements, and ones specified using formattingElements parameter, will not show any sorts of changes (addition, deletion, modified)
HTML Compare Configuration File Schema Guide \| retainComments	whether changes in comments should be processed

Element: htmlConfiguration 5

These parameters control html specific configurations.

Contained by

/ HTML Compare Configuration File Schema Guide | configuration / HTML Compare Configuration File Schema Guide | parameters

Contains

Element	Description
HTML Compare Configuration File Schema Guide \| inputAHighlightColour	Sets the deleted element highlight colour
HTML Compare Configuration File Schema Guide \| inputAStyling	Sets the deleted element highlight colour
HTML Compare Configuration File Schema Guide \| inputBHighlightColour	Sets the added element highlight colour
HTML Compare Configuration File Schema Guide \| inputBStyling	Sets the added element highlight colour

Element: mathmlConfiguration 6

These parameters control how MathML is managed.

Contained by

/ HTML Compare Configuration File Schema Guide | configuration / HTML Compare Configuration File Schema Guide | parameters

Contains

Element	Description
HTML Compare Configuration File Schema Guide \| mathmlGranularity	Specifies the granularity at which the differences between the two MathML expressions will be represented

Element: svgConfiguration 7

These parameters control how SVG changes are displayed.

Contained by

/ HTML Compare Configuration File Schema Guide | configuration / HTML Compare Configuration File Schema Guide | parameters

Contains

Element	Description
HTML Compare Configuration File Schema Guide \| svgEnabled	Enables SVG comparison should be carried out
HTML Compare Configuration File Schema Guide \| svgFallbackChangedPercentage	Defines the threshold at which fallback occurs if svgFallbackEnabled is true
HTML Compare Configuration File Schema Guide \| svgFallbackEnabled	Fallback to the ADJACENT result if alignment is below the defined threshold (set by fallbackChangePercentage)
HTML Compare Configuration File Schema Guide \| svgGranularity	Specifies how to display SVG changes
HTML Compare Configuration File Schema Guide \| svgNumericToleranceEnabled	Enables svg numeric tolerance, changes less than numericToleranceValue are ignored
HTML Compare Configuration File Schema Guide \| svgNumericToleranceValue	Defines the threshold value for numeric tolerance
HTML Compare Configuration File Schema Guide \| svgZIndexEnabled	Enables representation of Z index changes
HTML Compare Configuration File Schema Guide \| zIndexMarkupStyle	Sets the markup colour for representation of Z index changes

Element: tableConfiguration 8

These parameters control how tables are compared.

Contained by

/ HTML Compare Configuration File Schema Guide | configuration / HTML Compare Configuration File Schema Guide | parameters

Contains

Element	Description
HTML Compare Configuration File Schema Guide \| columnKeyingMode	Specifies the column keying mode used to match HTML columns when table processing is enabled
HTML Compare Configuration File Schema Guide \| ignoreColumnOrder	Determines whether ignoring HTML table column order is enabled
HTML Compare Configuration File Schema Guide \| invalidTableBehaviour	This parameter declares what type of processing should be used for those tables that are marked as invalid
HTML Compare Configuration File Schema Guide \| normalizeTableColumns	Determines whether HTML table column specification is normalized
HTML Compare Configuration File Schema Guide \| validationLevel	This parameter declares how strict table validation is
HTML Compare Configuration File Schema Guide \| warningReportMode	Specifies how certain warnings generated during the comparison process are reported

Element: characterByCharacter 9

Specifies whether to perform a character by character comparison or not.

Contained by

/ HTML Compare Configuration File Schema Guide | configuration / HTML Compare Configuration File Schema Guide | parameters / HTML Compare Configuration File Schema Guide | comparisonType

Contains

Type: xs:boolean

Element: formattingElements 10

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

Contained by

/ HTML Compare Configuration File Schema Guide | configuration / HTML Compare Configuration File Schema Guide | parameters / HTML Compare Configuration File Schema Guide | formattingConfiguration

Contains

Type: xs:string

Element: ignoreFormattingElements 11

If set to true, any formatting elements, and ones specified using formattingElements parameter, will not show any sorts of changes (addition, deletion, modified).

Contained by

/ HTML Compare Configuration File Schema Guide | configuration / HTML Compare Configuration File Schema Guide | parameters / HTML Compare Configuration File Schema Guide | formattingConfiguration

Contains

Type: xs:boolean

Element: retainComments 12

whether changes in comments should be processed

Contained by

/ HTML Compare Configuration File Schema Guide | configuration / HTML Compare Configuration File Schema Guide | parameters / HTML Compare Configuration File Schema Guide | formattingConfiguration

Contains

Type: xs:boolean

Element: inputAHighlightColour 13

Sets the deleted element highlight colour.

Contained by

/ HTML Compare Configuration File Schema Guide | configuration / HTML Compare Configuration File Schema Guide | parameters / HTML Compare Configuration File Schema Guide | htmlConfiguration

Contains

Type: xs:string

Element: inputAStyling 14

Sets the deleted element highlight colour.

Contained by

/ HTML Compare Configuration File Schema Guide | configuration / HTML Compare Configuration File Schema Guide | parameters / HTML Compare Configuration File Schema Guide | htmlConfiguration

Contains

Type: xs:string

Element: inputBHighlightColour 15

Sets the added element highlight colour.

Contained by

/ HTML Compare Configuration File Schema Guide | configuration / HTML Compare Configuration File Schema Guide | parameters / HTML Compare Configuration File Schema Guide | htmlConfiguration

Contains

Type: xs:string

Element: inputBStyling 16

Sets the added element highlight colour.

Contained by

/ HTML Compare Configuration File Schema Guide | configuration / HTML Compare Configuration File Schema Guide | parameters / HTML Compare Configuration File Schema Guide | htmlConfiguration

Contains

Type: xs:string

Element: mathmlGranularity 17

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

Contained by

/ HTML Compare Configuration File Schema Guide | configuration / HTML Compare Configuration File Schema Guide | parameters / HTML Compare Configuration File Schema Guide | mathmlConfiguration

Contains

Attribute	Type	Description
mode	[enum]	"adjacent" - Reports the differences to the MathML by repeating A and B MathML inputs adjacent to each other. "detailed-adjacent" - 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. Permitted values / descriptions: adjacent detailed-adjacent inline

Attribute

Type

Description

mode

[enum]

"adjacent" - Reports the differences to the MathML by repeating A and B MathML inputs adjacent to each other. "detailed-adjacent" - 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.

Permitted values / descriptions:

adjacent detailed-adjacent inline

Element: svgEnabled 18

Enables SVG comparison should be carried out.

Contained by

/ HTML Compare Configuration File Schema Guide | configuration / HTML Compare Configuration File Schema Guide | parameters / HTML Compare Configuration File Schema Guide | svgConfiguration

Contains

Type: xs:boolean

Element: svgFallbackChangedPercentage 19

Defines the threshold at which fallback occurs if svgFallbackEnabled is true

Contained by

/ HTML Compare Configuration File Schema Guide | configuration / HTML Compare Configuration File Schema Guide | parameters / HTML Compare Configuration File Schema Guide | svgConfiguration

Contains

Type: xs:double

Element: svgFallbackEnabled 20

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

Contained by

/ HTML Compare Configuration File Schema Guide | configuration / HTML Compare Configuration File Schema Guide | parameters / HTML Compare Configuration File Schema Guide | svgConfiguration

Contains

Type: xs:boolean

Element: svgGranularity 21

Specifies how to display SVG changes.

Contained by

/ HTML Compare Configuration File Schema Guide | configuration / HTML Compare Configuration File Schema Guide | parameters / HTML Compare Configuration File Schema Guide | svgConfiguration

Contains

Attribute	Type	Description
mode	[enum]	"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. Permitted values / descriptions: adjacent detailed-adjacent

Attribute

Type

Description

mode

[enum]

"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.

Permitted values / descriptions:

adjacent detailed-adjacent

Element: svgNumericToleranceEnabled 22

Enables svg numeric tolerance, changes less than numericToleranceValue are ignored

Contained by

/ HTML Compare Configuration File Schema Guide | configuration / HTML Compare Configuration File Schema Guide | parameters / HTML Compare Configuration File Schema Guide | svgConfiguration

Contains

Type: xs:boolean

Element: svgNumericToleranceValue 23

Defines the threshold value for numeric tolerance.

Default is '1%', can also be provided as numeric value (in pixels)

Contained by

/ HTML Compare Configuration File Schema Guide | configuration / HTML Compare Configuration File Schema Guide | parameters / HTML Compare Configuration File Schema Guide | svgConfiguration

Contains

Type: xs:string

Element: svgZIndexEnabled 24

Enables representation of Z index changes

Contained by

/ HTML Compare Configuration File Schema Guide | configuration / HTML Compare Configuration File Schema Guide | parameters / HTML Compare Configuration File Schema Guide | svgConfiguration

Contains

Type: xs:boolean

Element: zIndexMarkupStyle 25

Sets the markup colour for representation of Z index changes.

Default is purple.

Contained by

/ HTML Compare Configuration File Schema Guide | configuration / HTML Compare Configuration File Schema Guide | parameters / HTML Compare Configuration File Schema Guide | svgConfiguration

Contains

Type: xs:string

Element: columnKeyingMode 26

Specifies the column keying mode used to match HTML columns when table processing is enabled.

Contained by

/ HTML Compare Configuration File Schema Guide | configuration / HTML Compare Configuration File Schema Guide | parameters / HTML Compare Configuration File Schema Guide | tableConfiguration

Contains

Attribute	Type	Description
mode	[enum]	"auto" - DocumentComparator manages the entire keying process automatically. If desired this mode also allows for user-defined column keys in the input files. "position" - DocumentComparator matches table columns based on their position. Indexing starts from 1 and the maximum position is defined by the number of columns described by col attribute. Permitted values / descriptions: auto position

Attribute

Type

Description

mode

[enum]

"auto" - DocumentComparator manages the entire keying process automatically. If desired this mode also allows for user-defined column keys in the input files. "position" - DocumentComparator matches table columns based on their position. Indexing starts from 1 and the maximum position is defined by the number of columns described by col attribute.

Permitted values / descriptions:

auto position

Element: ignoreColumnOrder 27

Determines whether ignoring HTML table column order is enabled.

Contained by

/ HTML Compare Configuration File Schema Guide | configuration / HTML Compare Configuration File Schema Guide | parameters / HTML Compare Configuration File Schema Guide | tableConfiguration

Contains

Type: xs:boolean

Element: invalidTableBehaviour 28

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

Contained by

/ HTML Compare Configuration File Schema Guide | configuration / HTML Compare Configuration File Schema Guide | parameters / HTML Compare Configuration File Schema Guide | tableConfiguration

Contains

Attribute	Type	Description
mode	[enum]	"fail" - Throw an exception. "propagateUp" - Propagate the changes to the table-level. "compareAsXml" - Compare the table content as well-formed XML. Permitted values / descriptions: fail propagateUp compareAsXml

Attribute

Type

Description

mode

[enum]

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

Permitted values / descriptions:

fail propagateUp compareAsXml

Element: normalizeTableColumns 29

Determines whether HTML table column specification is normalized.

Contained by

/ HTML Compare Configuration File Schema Guide | configuration / HTML Compare Configuration File Schema Guide | parameters / HTML Compare Configuration File Schema Guide | tableConfiguration

Contains

Type: xs:boolean

Element: validationLevel 30

This parameter declares how strict table validation is.

Contained by

/ HTML Compare Configuration File Schema Guide | configuration / HTML Compare Configuration File Schema Guide | parameters / HTML Compare Configuration File Schema Guide | tableConfiguration

Contains

Attribute	Type	Description
mode	[enum]	"relaxed" - Performs relaxed validation. Invalidities which are known to have no effect on subsequent processing will not cause that processing to be bypassed. "strict" - Performs strict validation. All invalidities will cause the appropriate subsequent processing to be bypassed. Permitted values / descriptions: relaxed strict

Attribute

Type

Description

mode

[enum]

"relaxed" - Performs relaxed validation. Invalidities which are known to have no effect on subsequent processing will not cause that processing to be bypassed. "strict" - Performs strict validation. All invalidities will cause the appropriate subsequent processing to be bypassed.

Permitted values / descriptions:

relaxed strict

Element: warningReportMode 31

Specifies how certain warnings generated during the comparison process are reported.

Contained by

/ HTML Compare Configuration File Schema Guide | configuration / HTML Compare Configuration File Schema Guide | parameters / HTML Compare Configuration File Schema Guide | tableConfiguration

Contains

Attribute	Type	Description
mode	[enum]	"pis" - Reports warning using processing instructions with the format dxml_warn warning content "message" - Reports warnings using xsl:message. These are typically sent to std.out but this can be changed by configuring the relevant Saxon Configuration object. "comments" - Reports warnings using XML comments. Permitted values / descriptions: message comments pis

Attribute

Type

Description

mode

[enum]

"pis" - Reports warning using processing instructions with the format dxml_warn warning content "message" - Reports warnings using xsl:message. These are typically sent to std.out but this can be changed by configuring the relevant Saxon Configuration object. "comments" - Reports warnings using XML comments.

Permitted values / descriptions:

message comments pis

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