The comparison result of the document or page with its copy may be represented in XML format. It contains the information about the types of modifications, that were made to the content, and locations of these changes in both files. See the description of XML tags in the table below. You can find the XML schema for comparison result in ComparisonResultXmlSchema.xsd file. This file is located in the Headers folder for macOS or the Inc folder for Linux and Windows (Start > Programs > ABBYY FineReader Engine 12 > Installation Folders > Include Files Folder) Description of XML Schema for Comparison ResultDocumentation Index
Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt
Use this file to discover all available pages before exploring further.
| Name | Type | Multiplicity | Parent Tag | Description |
|---|---|---|---|---|
| ComparisonResult | ComparisonResultType
Type elements Change — the detected change; has the ChangeType | 1 | no | The comparison result of two files. |
| Change | ChangeType
Type elements Location — the location of the detected change; has the LocationType TextChange — the change detected in the text; has the TextChangeType
Type attributes ModificationType — (required) the type of modification made to the content. It can be one of the following values: Deleted, Inserted, Modified | 0…unbounded | ComparisonResult | The information about one detected change. |
| Location | LocationType
Type elements Position — the position of the change in the text; has the PositionType Region — the region of the change; has the RegionType
Type attributes Type — (required) The location type. It can be one of the following values: Reference, User | 2 | Change | The location of the detected change. |
| TextChange | TextChangeType
Type elements ReferenceText — the text change in the original document or page (string) UserText — the text change in the document or page copy (string) | 1 | Change | The change detected in the text. |
| Position | PositionType
Type elements BlockNumber — the index of the text block in the page layout PageIndex — the page index ParagraphIndex — the index of the paragraph in the text block SymbolIndex — the index of the symbol in the text block
Type attributes Type — (required) The position type. It can be one of the following values: Begin, End | 2 | Location | The position of the change in the text. |
| Region | RegionType, the sequence of Rect tags
Type elements Rect — rectangle of a block region. Rectangle is represented as a set of coordinates divided by commas (string) PageIndex — (required) the index of the page with the detected changes | 1…unbounded | Location | The region of the change. |
