DocBook Comparison Configuration Reference

DocBook Comparison Configuration reference

Configurations control the comparison behaviour and are passed at the time a comparison is invoked, either via the API, CLI, or REST configuration file. See JAVA API for equivalent Java methods. For CLI and REST, these are used via configuration file. The configuration file is validated against the XML Schema included in the product distribution in the relevant samples directory e.g. samples/compare/docbook/. Associate it with the XSD to enable XML editor autocompletion.

Parameters Appendix

'Automatic' parameter values

Where parameters can have the value automatic (generally used as the default value for that parameter), their actual value is calculated when the inputs are compared. This calculation is based on the values of other parameters; in the case of DocBook Compare this is typically the output-format parameter. Here, the idea is to set the value used for the parameter to that which is most appropriate for the given output format. When this automatic behaviour is inappropriate, the actual value of each parameter can be manually set to a specific values using the usual mechanisms. See the documentation for the individual parameters for details on what settings will be used.

Parameter Definitions

The parameter names available on the command-line tool and in the APIs are slightly different. In the command-line version, they are written as lower case words separated by a hyphen (e.g. validate-inputs). In the Java API version of the product, they can be accessed using set/get methods that use a camel-cased version of the name (e.g. setValidateInputs and getValidateInputs).

Parameter Summary Table

outputFormat. Specifies what type of output is produced.

This parameter can take the following values:

• docbook-markup. Differences are marked up using DocBook's revisonflag attribute.

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

The default value is 'docbook-markup'.

validateInputs. Sets whether to validate input documents.

If set to true and the inputs include a DOCTYPE, they will be validated against it. If they are not valid, the compare method will throw an InputLoadException.

The default value is 'true'.

enableXinclude. Sets whether the parser will process xincludes.

If set to true the parser will process xincludes while parsing the inputs.

The default value is 'true'.

characterByCharacter. Sets whether to compare text character by character.

If set to true, text is split into individual characters and compared so single character differences can be shown.

The default value is ‘false’

detectMoves. Sets to detect and handle element moves.

The default value is 'false'.

indent. Sets whether the result should be indented.

If run with a compare method that produces a serialized result, a value of yes causes the output to be pretty printed.

This parameter can take the following values:

• yes. The value representing the String value 'yes'. Output is indented.

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

The default value is 'no'.

whitespaceProcessingMode. Specifies how to handle whitespace changes.

When this option is set to 'show' whitespace differences are reported where possible. If the output-format is set to 'docbook-markup' and DocBook doctype is explicitly declared, then the whitespace will be reported wherever the doctype allows text (as opposed to inter-element whitespace). In all other cases, such as when tracked-change output format is selected, all whitespace changes can be shown.

This can lead to a significant amount of marked change throughout the document. When the parameter is set to 'ignore', whitespace differences are not shown; instead the 'B' document's whitespace is kept where possible.

Note that differences in whitespace are never ignored when the XML document explicitly states that the whitespace is important, via the xml:space attribute being set to 'preserve'.

The 'automatic' setting effectively behaves as either 'normalize' or 'ignore' depending on the value of the 'preservation-mode' and the 'output-format' parameters. Here, 'normalize' is chosen when: (1) the lexical preservation mode is set to 'automatic' and the output format is 'docbook-markup'; or (2) the lexical preservation mode is set to either 'document' or 'docAndAttrib'. In all other cases, the automatic preservation mode is treated as if it were 'ignore'.

This parameter can take the following values:

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

• keepA. Similar to 'ignore' except that 'A' document's whitespace is kept (instead of the 'B' document's whitespace).

• 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 'output-format' and the 'preservation-mode', as discussed in the main whitespace processing mode documentation.

The default value is 'automatic'.

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

This parameter can take the following values:

• message. Report 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.

• markup. Add the recoverable errors and warnings as document content.

The default value is 'pis'.

keyingMode. Sets the mode to use for adding keys to the input documents.

Keys can be added to the input documents to force particular parts of the document to match up during a comparison. This method can be used to turn on keying and also gives an option of what to use as keys in the input document.

This parameter can take the following values:

• preserve. Use existing deltaxml:key attributes from the input (and nothing else)

• useKeyThenId. Use a deltaxml:key attribute if present, otherwise use an id attribute if present

• useKeyThenCondition. Use a deltaxml:key attribute if present, otherwise use a condition attribute if present

• useId. Use an id attribute if present. Otherwise, do not use a key

• useCondition. Use a condition attribute if present. Otherwise, do not use a key

• remove. Remove all existing deltaxml:key attributes and do not add any others

The default value is 'preserve'.

showNonPhraseChanges. Sets whether to textually mark changes to text where <phrase>; elements are not allowed.

If text has changed within an element where phrase markup is not allowed, some other means must be used to process the changes. If this parameter is set to true , the changed text is wrapped in textual delimiters e.g. -[[old text ]]- +[[new text ]]+. If the value is set to false, no markup is used and only the new text is output.

The default value is 'true'.

additionalPhraseContainers. Sets the comma and/or space separated list of additional phrase elements using Clark notation.

The Clark notation represents an element by a string that has the form '{namespace}localname'. Elements in the default namespace are represented by '{}localname' (or simply 'localname' - thought this is not strictly in Clark notation).

This can be useful in situations where the DocBook has been customized to include some extra elements that contain phrase elements. Adding such elements via this parameter enables these elements to contain changes 'text changes' that are marked up using phrases.

The default value is ''.

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.

When comparing the following 2 para versions with ignore-inline-formatting switched on, no changes are marked up

<para>This is an important point</para>

<para>This is an <emphasis>important</emphasis> point</para>

see http://tdg.docbook.org/tdg/5.0/ch02.html#s.inline for a full list of inline markup elements

The default value is 'false'.

inlineFormattingElements. Sets the comma and/or space separated list of inline formatting elements using Clark notation. Only active when ignore-inline-formatting is set to true

This parameter overrides the built in list of docbook inline elements. If the parameter ignore-inline-formatting is set to true then the addition, deletion or modification of these elements will not be treated as changes.

The built in list is shown in the default, it is taken from http://tdg.docbook.org/tdg/5.0/ch02.html#s.inline and the same section for Docbook v4.5. Elements, http://tdg.docbook.org/tdg/4.5/ch02.html#ch02-logdiv

Those elements which do not contain content, such as xref and anchor are not included by default.

The Clark notation represents an element by a string that has the form '{namespace}localname'. Elements in the default namespace are represented by '{}localname' (or simply 'localname' - though this is not strictly in Clark notation). Whitespace in namespace or localname at end or beginning is removed. The occurence of '{' or '}' within namespace or localname is considered an error

The default value is 'abbrev, acronym, emphasis, phrase, quote, trademark, citation, citerefentry, citetitle, firstterm, glossterm, link, olink, ulink, foreignphrase, wordasword, computeroutput, literal, markup, prompt, replaceable, sgmltag, userinput, inlineequation, mathphrase, subscript, superscript, accel, guibutton, guiicon, guilabel, guimenu, guimenuitem, guisubmenu, keycap, keycode, keycombo, keysym, menuchoice, mousebutton, shortcut, action, classname, constant, errorcode, errorname, errortype, function, interface, msgtext, parameter, property, returnvalue, structfield, structname, symbol, token, type, varname, application, command, envar, filename, medialabel, option, systemitem, database, email, hardware, optional, {http://docbook.org/ns/docbook }abbrev, {http://docbook.org/ns/docbook }acronym, {http://docbook.org/ns/docbook }emphasis, {http://docbook.org/ns/docbook }phrase, {http://docbook.org/ns/docbook }quote, {http://docbook.org/ns/docbook }trademark, {http://docbook.org/ns/docbook }citation, {http://docbook.org/ns/docbook }citerefentry, {http://docbook.org/ns/docbook }citetitle, {http://docbook.org/ns/docbook }firstterm, {http://docbook.org/ns/docbook }glossterm, {http://docbook.org/ns/docbook }link, {http://docbook.org/ns/docbook }olink, {http://docbook.org/ns/docbook }foreignphrase, {http://docbook.org/ns/docbook }wordasword, {http://docbook.org/ns/docbook }computeroutput, {http://docbook.org/ns/docbook }literal, {http://docbook.org/ns/docbook }markup, {http://docbook.org/ns/docbook }prompt, {http://docbook.org/ns/docbook }replaceable, {http://docbook.org/ns/docbook }tag, {http://docbook.org/ns/docbook }userinput, {http://docbook.org/ns/docbook }inlineequation, {http://docbook.org/ns/docbook }mathphrase, {http://docbook.org/ns/docbook }subscript, {http://docbook.org/ns/docbook }superscript, {http://docbook.org/ns/docbook }accel, {http://docbook.org/ns/docbook }guibutton, {http://docbook.org/ns/docbook }guiicon, {http://docbook.org/ns/docbook }guilabel, {http://docbook.org/ns/docbook }guimenu, {http://docbook.org/ns/docbook }guimenuitem, {http://docbook.org/ns/docbook }guisubmenu, {http://docbook.org/ns/docbook }keycap, {http://docbook.org/ns/docbook }keycode, {http://docbook.org/ns/docbook }keycombo, {http://docbook.org/ns/docbook }keysym, {http://docbook.org/ns/docbook }menuchoice, {http://docbook.org/ns/docbook }mousebutton, {http://docbook.org/ns/docbook }shortcut, {http://docbook.org/ns/docbook }classname, {http://docbook.org/ns/docbook }constant, {http://docbook.org/ns/docbook }errorcode, {http://docbook.org/ns/docbook }errorname, {http://docbook.org/ns/docbook }errortype, {http://docbook.org/ns/docbook }function, {http://docbook.org/ns/docbook }msgtext, {http://docbook.org/ns/docbook }parameter, {http://docbook.org/ns/docbook }property, {http://docbook.org/ns/docbook }returnvalue, {http://docbook.org/ns/docbook }symbol, {http://docbook.org/ns/docbook }token, {http://docbook.org/ns/docbook }type, {http://docbook.org/ns/docbook }varname, {http://docbook.org/ns/docbook }application, {http://docbook.org/ns/docbook }command, {http://docbook.org/ns/docbook }envar, {http://docbook.org/ns/docbook }filename, {http://docbook.org/ns/docbook }option, {http://docbook.org/ns/docbook }systemitem, {http://docbook.org/ns/docbook }database, {http://docbook.org/ns/docbook }email, {http://docbook.org/ns/docbook }hardware, {http://docbook.org/ns/docbook }optional'.

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

Use this set to add to the value of inline-formatting-elements which you wish to be ignored when considering change processing.

Elements in this set are added to the set in inline-formatting-elements, before the set in remove-inline-formatting-elements is removed.

The default value is ''.

removeInlineFormattingElements. A comma and/or space separated list of inline formatting elements using Clark notation, which will be removed the list specified in the inline-formatting-elements parameter

Use this list to remove names from the value of inline-formatting-elements when the defaults include elements you wish not to be ignored as changes.

Elements in this set are removed to the set in inline-formatting-elements after the set in add-inline-formatting-elements has been added.

The default value is ''.

calsTableProcessing. Specifies whether to apply CALS table processing.

CALS table processing ensures that when valid (both syntactically and semantically according to the OASIS CALS table model documentation) input tables are provided the result will be a valid CALS table.

Simple changes to the table, such as changing the contents of an entry, adding a row or column are generally represented as fine grain changes. Because CALS entries can overlap or span multiple rows and columns, some types of change are difficult to represent at fine granularity, whilst ensuring validity. In these cases changes are represented at row (ie, groups of added/deleted rows) or even whole-table granularity.

Setting this parameter to false turns off this processing, therefore it is possible to generate an invalid table. However, if table validity is not a concern changes may be represented at finer granularity.

The default value is 'true'.

marCalsTableCellSpanExtentChanges.

When set, a changed revision flag attribute is added to table cell elements that have changed spans.

invalidTableBehaviour. In order to ensure that only valid CALS tables are passed to our specialized CALS table processing, each input table is marked either valid or invalid. This parameter declares what type of processing should be used for those tables that are marked as invalid. The 'warning report mode' parameter configures how recoverable errors are reported.

Three options are provided: fail, propagate up, and compare as XML. The fail option stops the comparison by throwing an appropriate exception (that includes the errors identified by the validity checker). The propagate up option ensures that changes to an invalid table (or more specifically 'tgroup') are represented at the table level. The compare as XML option essentially compares the tables as if they were well-formed XML.

Note that the results of the compare as XML option can differ from comparing the tables without CALS table processing enabled, as a small amount of CALS specific processing is applied to invalid tables in order to allow them to be compared against a similar valid table.

This parameter can take the following values:

• fail. Throw an exception.

• propagateUp. Propagate the changes to the table-level.

• compareAsXml. Compare the table content as well-formed XML.

The default value is 'propagateUp'.

htmlTableProcessing. Specifies whether to apply html table (otherwise known as DITA simpletable) processing.

HTML tables processing ensures that when valid input tables are provided - according to the HTML-4 or draft HTML-5 documentation - the result will be a valid HTML-4/5 table. Note that both inputs need to follow the same standard (ie be HTML-4 or HTML-5).

Simple changes to the table, such as changing the contents of a cell and adding a row or column are generally represented as fine grain changes. Because HTML entries can overlap or span multiple rows and columns, some types of change are difficult to represent at fine granularity, whilst ensuring validity. In these cases changes are represented at row (ie, groups of added/deleted rows) or even whole-table granularity.

DITA Simple tables are also handled by this filter. In this case, the syntactic constraints ensure that cells cannot overlap or span either rows or columns, therefore changes are represented at a fine grained level of detail.

Setting this parameter to false turns off this processing, therefore it is possible to generate an invalid table. However, if table validity is not a concern changes may be represented at finer granularity.

The default value is 'true'.

markHtmlTableCellSpanExtentChanges.

When set, a changed revision flag attribute is added to table cell elements that have changed spans.

grouping. Specifies whether adjacent changes (insertions or deletions) should be grouped into a single insertion and/or deletion block. One benefit of this is that changes to a consecutive group of words within a sentence are gathered into one insertion and one deletion block, rather than a series of individual word swaps. This makes it easier to read and understand the changes.

Note that when either HTML or CALS table processing modes are selected, then this grouping mechanism is turned off within the context of these tables. The table processing has its own specialised grouping mechanisms.

The default value is 'false'.

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

The default value is 'deltaxml'.

TrackedChangesDate. Specifies the time-stamp that is embedded into the generated insertion and deletion processing instruction. The default time-stamp is that of the time that the comparison is run.

The default value is 'xsl date'.

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

The format of the version is either '[0-9]+' or '[0-9]+.[0-9]+' without the enclosing string quotes, where: the first number sequence is the major number; and the optional second number sequence is the minor number.

This parameter is used to automatically set the relevant backwards compatibility options related to the oXygen tracked changes format. For example, prior to oXygen 14.0 release deleted whitespace needed to be normalised in order to consistently generate a reasonable result.

The default value is '11.2'.

oxygenTcsDeletedSpaceMode. Specifies how deleted spaces should be handled.

Prior to oXygen 14 whitespace within the deleted content of a processing instruction were sometimes not displayed correctly. A work-around was to normalise the space within a deleted region.

This parameter can take the following values:

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

The default value is 'automatic'.

xmetalTcsTableChangeMode. Specifies how changes in tables should be tracked.

The XMetaL editor cannot track the addition or deletion of a row or cell within a table. Such changes can be pushed down to the cell level, pushed up to the table level (e.g. a CALS or HTML 'table' element), or ignored. The advantage of pushing the changes down to the cell content level, is that this provides the highest level of change granularity, at the cost of having to accept or reject every changed cell in the table independently.

The push up processing means that any table that contains a row or cell level update is represented by a table level add and delete.

The ignore option is similar to the way in which track changes within tables are handled in XMetaL; as neither row insertion and deletion or cell splitting and merging is tracked. However, for clarity this mode of operation ignores all changes within a table, it simply produces the 'B' version of the table.

This parameter can take the following values:

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

• ignore. All changes in a table are ignored.

The default value is 'down'.

framemakerTcsTableChangeMode. 

Specifies how changes in tables should be tracked.

The FrameMaker editor cannot track the addition or deletion of a row or cell within a table. Such changes can be pushed down to the cell level, pushed up to the table level (e.g. a CALS or HTML 'table' element), or ignored. The advantage of pushing the changes down to the cell content level, is that this provides the highest level of change granularity, at the cost of having to accept or reject every changed cell in the table independently.

The push up processing means that any table that contains a row or cell level update is represented by a table level add and delete.

The ignore option is similar to the way in which track changes within tables are handled in FrameMaker; as neither row insertion and deletion or cell splitting and merging is tracked. However, for clarity this mode of operation ignores all changes within a table, it simply produces the 'B' version of the table.

This parameter can take the following values:

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

• ignore. All changes in a table are ignored.

The default value is 'down'.

preservationMode.

Sets the mode to use for preserving original data.

This mode can be used to preserve information for round trip processing.

The 'automatic' setting will have an effective setting of 'roundTrip' when the output format is a tracked change format and 'docAndAttrib' otherwise.

This parameter can take the following values:

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

The default value is 'automatic'.

xmlVersionDeclaration. Sets the version to use in the XML declaration.

The 'system' special value is introduced; selecting it has the affect of choosing 'B' document's xml-version (as provided by the parser).

This parameter can take the following values:

• 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).

The default value is 'system'.

outputEncodingDeclaration. Sets the character encoding output to use in the XML declaration. For example, 'UTF-8', 'ISO-8859-1', 'windows-1252', and 'ascii'. Precisely which encodings are available is dependent on the specific Java runtime environment that you use. Note that an invalid output encoding will cause an exception to be raised.

The 'system' special value is introduced; selecting it has the affect of choosing the 'B' document's character encoding.

The default value is 'system'.

standaloneDeclaration. This parameter no longer has any effect. Preserving the standalone declaration is not supported, due to incompatibilities in the underpinning parsing and serialisation technologies.

This parameter can take the following values:

• yes. Ensure the standalone attribute is set to 'yes' in the output XML declaration.

• no. Ensure the standalone attribute is set to 'no' in the output XML declaration.

• omit. Ensure there is no standalone attribute in the output XML declaration.

• system. Deprecated: has the same affect as the omit value.

The default value is 'omit'.

imageCompare. If set to true, the physical locations and possibly the actual images used will be compared rather than the string value of the location (fileref attribute) of the imagedata

In docbook terms imagedata element fileref attributes will be resolved to absolute locations and tested for equality. If they are not equal fileref URIs will be opened and the streamed image content will be compared byte by bte for equality.

This can mean that even though the fileref has not changed the image will be marked as a change if it resolves to different images within the context of A or B. Similarly if the fileref has changed but resolves to the same image within the context of A or B it will not be marked as a change.

The xml:base of both input files will be used to resolve the fileref to an absolute location. If no xml:base is given the XPAth base-uri() function is used. The resolved locations from A and B will then be compared for string equality. If they are the same then the fileref will not be marked as a change, if they are different then the URIs will be opened using URL.openStream and a byte-wise comparison of the images will be done. If any problem occurs then the images will be marked as changed, otherwise the result of the byte-wise comparison will be used to determine whether the image is marked as changed.

See also the following three sections on

• showImageChangesAtMediaobjectLevel

• outputImageRefForm

• outputImageRefFavourSourceDoc

The default value is 'false'.

showImageChangesAtMediaobjectLevel. If image-compare is set to true and determines that images have changed, show the changes as changes to the containing mediaobjects.

By default image changes are tracked as changes to the fileref attribute of the DocBook imagedata tag. Since changes to attributes are difficult to show in docbook, it may be preferable to show the change at the level of the containing mediaobject or inlinemediaobject by cloning them and showing the A and B versions as neighbouring siblings in the result document.

The default value is 'false'.

outputImageRefForm. If image-compare is set to true, this parameter controls the form output for fileref attributes of imagedata elements

This parameter can take the following values:

• absolute. the value will be the absolute location used to calculate whether the image has changed. This should mean that for filesystem filerefs at least the images should be visible in the result document. See image-compare for more detail on how the absolute form is calculated.

• source. the value will be as it appears in the source A or B document.

The default value is 'absolute'.

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

If image-compare is set to true and there are no differences in the A and B images, this determines which of the source Documents, A or B, will be used to set the value of the result fileref . This value will then be used as is or be turned into an absolute value depending on the value of output-image-ref-form

If images are identical it can still be the case that filrefs for A and B can point to different files, so there is a choice of the value used to derive the result, also if output-image-ref-form is set to 'source' the string values of the fileref attributes can be different.

For images that HAVE changed the value used in the result will be controlled by modified-attribute-mode. This generally defaults to the B value, so if you change output-image-ref-favour-source-doc it might be wise to change modified-attribute-mode as well.

This parameter can take the following values:

• A. The value from the 'A' source document will be used

• B. The value from the 'B' source document will be used

The default value is 'B'.

mathmlProcessing. When set to true MathML elements will be processed according to the granularity setting.

Setting this parameter to false turns off this processing, therefore it is possible to generate an invalid output. However, if MathML validity is not a concern changes may be represented at finer granularity.

The default value is 'true'.

mathmlGranularity. This parameter allows you to choose the way that MathML differences are displayed.  See the MathML section for examples.

This parameter can take the following values:

• adjacent

• detailed-adjacent 

• inline

The default is 'inline'.

svgProcessing

Sets whether to do SVG comparison. SVG comparison is recommended as it will use SVG XML-aware features when comparing two SVG images to ensure that the result can be rendered.

svgGranularity

Specifies the granularity at which the differences between two SVG images will be represented. SVG Granularity can be of three types - ‘detailed-adjacent', ‘adjacent', and 'animate-inline’. The default is 'detailed-adjacent’.

‘adjacent' reports the differences by repeating A and B SVG adjacent to each other.
'detailed-adjacent' reports the differences by repeating the A and B SVG adjacent to each other. Content within the adjacent A and B views is highlighted at the specific parts where it is different.
'animate-inline’ reports SVG differences by animating them by changing the opacity from 1 to 0 for delete and 0 to 1 for add. This setting will override any other SVG configuration.

svgFallback

Set whether SVG fallback is enabled. SVG comparison granularity will fallback to SVGComparisonGranularity.ADJACENT if SVG exceeds the number changed elements defined by FallbackChangePercentage.

svgFallbackChangePercentage

Sets fallback change percentage setting for SVG comparison results. The default value is 30.00%.

inputASvgMarkupStyle

Sets the Input A SVG markup style setting for SVG comparison results. The default is "red" and an SVG color can be provided as color names, RGB or RGBA values, HEX values, HSL or HSLA values.

inputBSvgMarkupStyle

Sets the Input B SVG markup style setting for SVG comparison results. The default is "green" and an SVG color can be provided as color names, RGB or RGBA values, HEX values, HSL or HSLA values.

zIndexSvgMarkupStyle

Sets the Input Z SVG markup style setting for SVG comparison results. The default is "purple" and an SVG color can be provided as color names, RGB or RGBA values, HEX values, HSL or HSLA values.

svgZIndex

Set whether SVG Z-Index representation is enabled. Uses move handling within SVG Comparisons to markup Z-index changes.

svgNumericTolerance

Sets whether to use SVG numeric tolerance. SVG comparison will check co-ordinate values are within specified tolerance and therefore can be considered having negligible change.

svgNumericToleranceValue

Sets the numeric tolerance value for SVG comparison results. The default is 1%, but can be given as a fixed value. Adding '%' will switch value to percentage.