Analysis Results

In order not to lose any valuable information from external quality assurance, Across extended the XLIFF format as follows:
The extension has a root element analysisResults which contains a collection of analysisResult entries.
Each analysisResult entry consists of two parts:
1. errorRanges - original source and target content with special markup of ranges which are referenced in some found error(s).
2. Collection of errorInfos - errors found by QA tools.

analysisResult Element

Description	The root element of the structure. <analysisResult> Content: (errorRanges?, errorInfos) </analysisResult>
Parent element	trans-unit
Child elements	errorRanges, errorInfos
Attributes	none
Number of occurences	One ore more

Description	Information about ranges in source and/or target content where errors were found. <errorRanges> Content: (sourceContent, targetContent) </errorRanges>
Parent element	analysisResult
Child elements	sourceContent, targetContent
Attributes	none
Number of occurences	none or once

Description	Collection of errors found for a paragraph. <errorInfos> Content: (errorInfo*) </errorInfos>
Parent element	analysisResult
Child elements	errorInfo
Attributes	none
Number of occurences	Once

Description	Original source content with special markup of error ranges. <sourceContent> Content: (nonEmptyString \| errorRangeStart \| errorRangeEnd \| Any )* </sourceContent>
Parent element	errorRanges
Child elements	errorRangeStart , errorRangeEnd, any valid XML element
Attributes	none
Number of occurences	none or once

Description	Original target content with special markup of error ranges. <targetContent> Content: (nonEmptyString \| errorRangeStart \| errorRangeEnd \| Any )* </targetContent>
Parent element	errorRanges
Child elements	errorRangeStart, errorRangeEnd, any valid XML element
Attributes	none
Number of occurences	none or once

Description	Marks the start position of an error range, has a unique id value within the scope of the errorRanges section. <errorRangeStart id: index of error range > Content: ( empty ) </errorRangeStart >
Parent element	sourceContent, targetContent
Child elements	none
Attributes	id - identifier of an error range, unique in scope of errorRanges.
Number of occurences	any

Description	Marks the end position of an error range, has a unique id value within the scope of the errorRanges section. <errorRangeEnd id: index of error range > Content: ( empty ) </errorRangeEnd >
Parent element	sourceContent, targetContent
Child elements	none
Attributes	id - identifier of an error range, unique in scope of errorRanges.
Number of occurences	any

Description	Description of an error. <errorInfo> Content: (rangeId? \| description \| explanation? \| examples? \| proposals? )* </errorInfo>
Parent element	errorInfos
Child elements	rangeId, description, proposals
Attributes	none
Number of occurences	any

Description	Reference to a range defined in sourceContent and/or targetContent which the errorInfo is related to. <rangeId > Content: ( integer ) </rangeId >
Parent element	errorInfo
Child elements	none
Attributes	none
Number of occurences	none or once

Description	Detailed description of an error. <description> Content: ( errorCode? \| type \| title? \| instruction \| explanation \| examples ) </description>
Parent element	errorInfo
Child elements	type, errorCode, title, instruction, explanation, examples
Attributes	none
Number of occurences	once

Description	Type of an error, e.g. grammar, spelling, etc. <type> Content: ( nonEmptyString ) </type>
Parent element	description
Child elements	none
Attributes	none
Number of occurences	once

Description	Error code provided by a tool. <errorCode> Content: ( nonEmptyString ) </errorCode>
Parent element	description
Child elements	none
Attributes	none
Number of occurences	none or once

Description	Title of an error description. <explanation> Content: ( nonEmptyString \| br \| b \| i \| u \| H1 \| H2 \| H3 )* </explanation>
Parent element	description
Child elements	For details see: Rich Formatting Element
Attributes	none
Number of occurences	none or once

Description	Description of an error. <instruction> Content: ( nonEmptyString \| br \| b \| i \| u \| H1 \| H2 \| H3 )* </instruction>
Parent element	description
Child elements	For details see: Rich Formatting Element
Attributes	none
Number of occurences	none or once

Description	Detailed explanation of an error. <explanation> Content: ( nonEmptyString \| br \| b \| i \| u \| s \| H1 \| H2 \| H3 )* </explanation>
Parent element	description
Child elements	For details see: Rich Formatting Element
Attributes	none
Number of occurences	none or once

Description	Collection of examples. <examples> Content: ( example* ) </examples>
Parent element	description
Child elements	example
Attributes	none
Number of occurences	none or once

Description	Example. <example> Content: ( nonEmptyString \| br \| b \| i \| u \| s \| H1 \| H2 \| H3 )* </example>
Parent element	examples
Child elements	For details see: Rich Formatting Element
Attributes	none
Number of occurences	any

Description	Collection of proposals. <proposals> Content: ( proposal* ) </proposals>
Parent element	errorInfo
Child elements	proposal
Attributes	none
Number of occurences	none or once

Description	Proposal how to correct an error. <proposals> Content: ( text, extraInfo ) </proposals>
Parent element	proposals
Child elements	text, extraInfo
Attributes	none
Number of occurences	any

Description	Text of proposed replacement. <text> Content: ( nonEmptyString ) </text>
Parent element	proposal
Child elements	none
Attributes	none
Number of occurences	once

Description	Additional information to a proposal. <extraInfo> Content: ( nonEmptyString \| br \| b \| i \| u \| s \| H1 \| H2 \| H3 )* </extraInfo>
Parent element	proposal
Child elements	For details see: Rich Formatting Element
Attributes	none
Number of occurences	none or once

Description	Any element whose content can contain rich formatting markup. <RICH_FMT_ELEMEMT> Content: ( nonEmptyString \| br \| b \| i \| u \| s \| h1 \| h2 \| h3 )* </RICH_FMT_ELEMEMT>
Child elements	title1, title2, title3, br, b, i, u, s

Description of available formatting markup elements