ITS Components
From OkapiWiki
Contents |
Overview
This page provides a status of what components implement ITS 1.0 and 2.0 and to what degree.
XML and HTML5 Support
Legend:
- ITS Engine - A Yes indicates that the data category is processed and the resulting information available using the ITraversal interface.
It also indicates that the implementation passes the ITS Test Suite for that data category. - Read - The markup existing in the input document is interpreted and represented in the extracted Okapi resources.
- Modify - If the Okapi representation of that data category is modified, it is modified in the output document as well.
- Remove - If the Okapi representation of that data category is removed, it is removed in the output document as well.
- Add - If an Okapi representation of that data category is added, the corresponding markup is also added in the output document.
- Global for structural - Denotes the capabilities for the data category when defined in a global rule and when related to an element that is not "within text".
- Global for inline - Denotes the capabilities for the data category when defined in a global rule and when related to an element that is declared as "within text".
- Local on structural - Denotes the capabilities for the data category when defined locally on an element that is not "within text".
- Local on inline - Denotes the capabilities for the data category when defined locally on an element that is declared as "within text".
- TBD - Means To be Decided. TBI - Means To Be Improved. N/A - means Not Applicable.
| Data Category | Scope | ITS Engine | XML Filter | HTML5-ITS Filter | Okapi Representation | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Read | Modify | Remove | Add | Read | Modify | Remove | Add | ||||
| Translate | Global for structural | Yes | Yes | N/A | N/A | N/A | Yes | N/A | N/A | N/A | Not to translate: not extracted |
| Global for inline | Yes | Yes | N/A | N/A | N/A | Yes | N/A | N/A | N/A | Not to translate: inline code | |
| Local on structural | Yes | Yes | No | No | TBD | Yes | No | No | TBD | Not to translate: not extracted | |
| Local on inline | Yes | Yes | No | No | TBD | Yes | No | No | TBD | Not to translate: inline code | |
| Localization Note | Global for structural | Yes | Yes | TBD | TBD | TBD | Yes | TBD | TBD | TBD | Note property on TextUnit |
| Global for inline | Yes | Yes | TBD | TBD | TBD | Yes | TBD | TBD | TBD | LOCNOTE annotation on <mrk> |
|
| Local on structural | Yes | Yes | TBD | TBD | TBD | Yes | TBD | TBD | TBD | Note property on TextUnit | |
| Local on inline | Yes | Yes | TBD | TBD | TBD | Yes | TBD | TBD | TBD | LOCNOTE annotation on <mrk> |
|
| Terminology | Global for structural | Yes | Yes, TBI | TBD | TBD | TBD | Yes, TBI | TBD | TBD | TBD | TermAnnotation on source TextContainer |
| Global for inline | Yes | Yes, TBI | TBD | TBD | TBD | Yes, TBI | TBD | TBD | TBD | TermAnnotation on source TextContainer | |
| Local on structural | Yes | Yes, TBI | TBD | TBD | TBD | Yes, TBI | TBD | TBD | TBD | TermAnnotation on source TextContainer | |
| Local on inline | Yes | Yes, TBI | TBD | TBD | TBD | Yes, TBI | TBD | TBD | TBD | TermAnnotation on source TextContainer | |
| Directionality | Global for structural | Yes | Not supported | ||||||||
| Global for inline | Yes | Not supported | |||||||||
| Local on structural | Yes | Not supported | |||||||||
| Local on inline | Yes | Not supported | |||||||||
| Language Information | Global for structural | Yes | Not supported | ||||||||
| Global for inline | Yes | Not supported | |||||||||
| Local on structural | Yes | Not supported | |||||||||
| Local on inline | Yes | Not supported | |||||||||
| Within Text | Global for structural | Yes | Yes, partially | TBD | TBD | TBD | Yes, partially | TBD | TBD | TBD | TextUnit or inline code |
| Global for inline | Yes | Yes, partially | TBD | TBD | TBD | Yes, partially | TBD | TBD | TBD | TextUnit or inline code | |
| Local on structural | Yes | Yes, partially | TBD | TBD | TBD | Yes, partially | TBD | TBD | TBD | TextUnit or inline code | |
| Local on inline | Yes | Yes, partially | TBD | TBD | TBD | Yes, partially | TBD | TBD | TBD | TextUnit or inline code | |
| Domain | Global for structural | Yes | Yes | TBD | TBD | TBD | Yes | TBD | TBD | TBD | DOMAIN annotation on TextUnit |
| Global for inline | Yes | TBD | TBD | TBD | TBD | TBD | TBD | TBD | TBD | TBD | |
| Text Analysis | Global for structural | Yes | Yes | TBD | TBD | TBD | Yes | TBD | TBD | TBD | TA annotation on source TextContainer |
| Global for inline | Yes | Yes | TBD | TBD | TBD | Yes | TBD | TBD | TBD | TA annotation on inline code | |
| Local on structural | Yes | Yes | TBD | TBD | TBD | Yes | TBD | TBD | TBD | TA annotation on source TextContainer | |
| Local on inline | Yes | Yes | TBD | TBD | TBD | Yes | TBD | TBD | Yes | TA annotation on inline code | |
| Locale Filter | Global for structural | Yes | Yes | N/A | N/A | N/A | Yes | N/A | N/A | N/A | Not to localize: not extracted |
| Global for inline | Yes | Yes | N/A | N/A | N/A | Yes | N/A | N/A | N/A | not to localize: inline code | |
| Local on structural | Yes | Yes | No | No | TBD | Yes | No | No | TBD | not to localize: not extracted | |
| Local on inline | Yes | Yes | No | No | TBD | Yes | No | No | TBD | Not to localize: inline code | |
| Provenance | Global for structural | Yes | Yes | TBD | TBD | TBD | Yes | TBD | TBD | TBD | PROV annotation on TextUnit |
| Global for inline | Yes | TBD | TBD | TBD | TBD | TBD | TBD | TBD | TBD | TBD | |
| Local on structural | Yes | Yes | TBD | TBD | TBD | Yes | TBD | TBD | TBD | PROV annotation on TextUnit | |
| Local on inline | Yes | TBD | TBD | TBD | TBD | TBD | TBD | TBD | Yes TBI | PROV annotation on inline code | |
| External Resource | Global for structural | Yes | Yes | TBD | TBD | TBD | Yes | TBD | TBD | TBD | EXTERNALRES annotation on TextUnit |
| Global for inline | Yes | Yes | TBD | TBD | TBD | Yes | TBD | TBD | TBD | EXTERNALRES annotation on inline code | |
| Target Pointer | Global for structural | Yes | TBD | TBD | TBD | TBD | TBD | TBD | TBD | TBD | Target content of the TextUnit |
| Global for inline | Yes | TBD | TBD | TBD | TBD | TBD | TBD | TBD | TBD | TBD | |
| Local on structural | Yes | TBD | TBD | TBD | TBD | TBD | TBD | TBD | TBD | Target content of the TextUnit | |
| Local on inline | Yes | TBD | TBD | TBD | TBD | TBD | TBD | TBD | TBD | TBD | |
| Id Value | Global for structural | Yes | Yes | N/A | N/A | N/A | Yes | N/A | N/A | N/A | TextUnit name |
| Global for inline | Yes | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A | |
| Local on structural | Yes | Yes | N/A | N/A | N/A | Yes | N/A | N/A | N/A | TextUnit name | |
| Local on inline | Yes | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A | |
| Preserve Space | Global for structural | Yes | Yes | N/A | N/A | N/A | Yes | N/A | N/A | N/A | Preserve Space on TextUnit |
| Global for inline | Yes | TBD | TBD | TBD | TBD | TBD | TBD | TBD | TBD | TBD | |
| Local on structural | Yes | Yes | N/A | N/A | N/A | Yes | N/A | N/A | N/A | Preserve Space on TextUnit | |
| Local on inline | Yes | TBD | TBD | TBD | TBD | TBD | TBD | TBD | TBD | TBD | |
| Localization Quality Issue | Global for structural | Yes | Yes | TBD | TBD | TBD | Yes | TBD | TBD | TBD | LQI annotation on TextUnit |
| Global for inline | Yes | Yes | TBD | TBD | TBD | Yes | TBD | TBD | TBD | LQI annotation on source/target TextContainer or inline code | |
| Local on structural | Yes | Yes | TBD | TBD | TBD | Yes | TBD | TBD | TBD | LQI annotation on TextUnit | |
| Local on inline | Yes | Yes | TBD | TBD | TBD | Yes | TBD | TBD | Yes TBI | LQI annotation on source/target TextContainer or inline code | |
| Localization Quality Rating | Local on structural | Yes | Yes | TBD | TBD | TBD | Yes | TBD | TBD | TBD | LQR annotation on TextUnit |
| Local on inline | Yes | TBD | TBD | TBD | TBD | TBD | TBD | TBD | TBD | TBD | |
| MT Confidence | Global for structural | Yes | Yes, TBI | TBD | TBD | TBD | Yes, TBI | TBD | TBD | TBD | MTCONFIDENCE annotation on source TextContainer |
| Global for inline | Yes | TBD | TBD | TBD | TBD | TBD | TBD | TBD | TBD | TBD | |
| Local on structural | Yes | Yes, TBI | TBD | TBD | TBD | Yes, TBI | TBD | TBD | TBD | MTCONFIDENCE annotation on source TextContainer | |
| Local on inline | Yes | TBD | TBD | TBD | TBD | TBD | TBD | TBD | TBD | TBD | |
| Allowed Characters | Global for structural | Yes | Yes | TBD | TBD | TBD | Yes | TBD | TBD | TBD | ALLOWEDCHARS annotation on TextUnit |
| Global for inline | Yes | Yes | TBD | TBD | TBD | Yes | TBD | TBD | TBD | ALLOWEDCHARS annotation on inline code | |
| Local on structural | Yes | Yes | TBD | TBD | TBD | Yes | TBD | TBD | TBD | ALLOWEDCHARS annotation on TextUnit | |
| Local on inline | Yes | Yes | TBD | TBD | TBD | Yes | TBD | TBD | Yes | ALLOWEDCHARS annotation on inline code | |
| Storage Size | Global for structural | Yes | Yes | TBD | TBD | TBD | Yes | TBD | TBD | TBD | STORAGESIZE annotation on TextUnit |
| Global for inline | Yes | Yes | TBD | TBD | TBD | Yes | TBD | TBD | TBD | STORAGESIZE annotation on inline code | |
| Local on structural | Yes | Yes | TBD | TBD | TBD | Yes | TBD | TBD | TBD | STORAGESIZE annotation on TextUnit | |
| Local on inline | Yes | Yes | TBD | TBD | TBD | Yes | TBD | TBD | Yes | STORAGESIZE annotation on inline code | |
You can find more information about ITS on this page.
XLIFF 1.2 Support
Okapi provides two main components for XLIFF 1.2:
- the XLIFF 1.2 Filter which is used to read an existing XLIFF document, extract its content and rewerite back the modified document.
- the XLIFF Writer wich provides a way to create XLIFF document from the API.
- The
http://www.w3.org/ns/its-xliff/(using the prefixitsxin this page) is currently used for the ITS information that cannot be directly mapped to XLIFF and not represented directly by a native ITS construct. - The recommended mapping between ITS 2.0 and XLIFF 1.2 is defined at http://www.w3.org/International/its/wiki/XLIFF_1.2_Mapping.
Note: Not all ITS data categories can be used in all XLIFF elements. ITS markup that is not at the locations defined in the table is not processed.
ITS is implemented as followed:
| Data Category | XLIFF 1.2 Markup | XLIFF 1.2 Filter | Okapi Representation | XLIFF 1.2 Writer | ||||
|---|---|---|---|---|---|---|---|---|
| Read | Rewrite | Modify | Remove | Add | ||||
| Translate | translate in <trans-unit> |
Yes | Yes | No | No | No | ITextUnit.[is/setIs]Translatable() |
Yes |
mtype='protected' in <mrk>or inline code |
Yes | Yes | No | No | No | Inline code | Yes | |
| Localization Note | <note> element in the text unit. |
Yes | Yes | TBD | TBD | TBD | NOTE property on TextUnit | Yes |
comment='TEXT' anditsx:locNoteType='alert|description'in <mrk> |
Yes | Yes | TBD | TBD | TBD | LOCNOTE annotation on inline code | Yes | |
| Terminology | mtype='term' anditsx:termInfoitsx:termInfoRef anditsx:termConfidence in <mrk> |
Yes TBI | Yes TBI | TBD | TBD | TBD | TERM annotation on inline code | Yes |
| Directionality | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A |
| Language Information | TBD | TBD | TBD | TBD | TBD | TBD | TBD | TBD |
| Within Text | Inline codes | Yes | Yes | Yes | Yes | Yes | Inline codes | Yes |
| Domain | itsx:domain in <trans-unit> |
Yes | Yes | TBD | TBD | TBD | DOMAIN annotation on TextUnit | Yes |
| Text Analysis | ITS attributes in <mrk> |
Yes TBI | Yes TBI | TBD | TBD | TBD | TA annotation on inline code | Yes |
| Locale Filter | TBD | TBD | TBD | TBD | TBD | TBD | TBD | TBD |
| Provenance | ITS attributes in <file>, <group>, <trans-unit>, <source>, <target> |
Yes | Yes | TBD | TBD | Yes TBI | PROV annotation (ITSProvenanceAnnotations) on StartSubDocument, StartGroup, TextUnit or TextContainer | Yes TBI |
ITS attributes in <mrk> |
Yes | Yes | TBD | TBD | Yes | PROV annotation (ITSProvenanceAnnotations) on inline code | Yes | |
| External Resource | itsx:externalResourceRef in <trans-unit> |
Yes | Yes | TBD | TBD | TBD | EXTERNALRES annotation on TextUnit | Yes |
itsx:externalResourceRef in inline code |
Yes | Yes | TBD | TBD | TBD | EXTERNALRES annotation on inline code | TBD | |
| Id Value | resname in <trans-unit> |
Yes | Yes | No | No | No | ITextUnit.[get/set]Name() |
Yes |
| Preserve Space | xml:space in <trans-unit> |
Yes | Yes | No | No | No | ITextUnit.[preserve/setPreserve]Whitespaces() |
Yes |
xml:space in inline code |
TBD | TBD | TBD | TBD | TBD | TBD | TBD | |
| Localization Quality Issue | ITS attributes in <source> or <target> |
Yes | Yes | TBD | TBD | Yes TBI | LQI annotation (ITSLQIAnnotations) on TextContainer | Yes |
ITS attributes in <mrk> |
Yes | Yes | TBD | TBD | Yes TBI | LQI annotation (ITSLQIAnnotations) on inline code | Yes | |
| Localization Quality Rating | TBD | TBD | TBD | TBD | TBD | TBD | TBD | TBD |
| MT Confidence | TBD | TBD | TBD | TBD | TBD | TBD | TBD | TBD |
| Allowed Characters | ITS attribute in in <source> or <target> |
Yes | Yes | TBD | TBD | TBD | ALLOWEDCHARS annotation on TextContainer | Yes |
ITS attribute in <mrk> |
Yes | Yes | TBD | TBD | TBD | ALLOWEDCHARS annotation on inline code | Yes | |
| Storage Size | ITS attributes in in <source> or <target> |
Yes | Yes | TBD | TBD | TBD | STORAGESIZE annotation on TextContainer | Yes |
ITS attributes in <mrk> |
Yes | Yes | TBD | TBD | TBD | STORAGESIZE annotation on inline code | Yes | |
You can find more information on the XLIFF 1.2 Filter on this page.
Enrycher Step
Support for the Enrycher Web service is implemented in the Enrycher Step.
This step allows you to markup the source content of text units with Text Analysis annotations (TA annotation on inline codes).
Terminology Extraction Step
The Text Analysis and the Terminology data categories can be utilized by the Term Extraction Step to extract term candidates.
