XLIFF Version 2.1

Committee Specification Draft 01 /
Public Review Draft 01

14 October 2016

Specification URIs
This version:
http://docs.oasis-open.org/xliff/xliff-core/v2.1/csprd01/xliff-core-v2.1-csprd01.html (Authoritative)
http://docs.oasis-open.org/xliff/xliff-core/v2.1/csprd01/xliff-core-v2.1-csprd01.pdf
http://docs.oasis-open.org/xliff/xliff-core/v2.1/csprd01/xliff-core-v2.1-csprd01.xml
Previous version:
N/A
Latest version:
http://docs.oasis-open.org/xliff/xliff-core/v2.1/xliff-core-v2.1.html (Authoritative)
http://docs.oasis-open.org/xliff/xliff-core/v2.1/xliff-core-v2.1.pdf
http://docs.oasis-open.org/xliff/xliff-core/v2.1/xliff-core-v2.1.xml
Technical Committee:
OASIS XML Localisation Interchange File Format (XLIFF) TC
Chair:
Bryan Schnabel (bryan.s.schnabel@tektronix.com), Individual
Editors:
David Filip (david.filip@adaptcentre.ie), Trinity College Dublin (ADAPT)
Tom Comerford (tom@supratext.com), Individual
Soroush Saadatfar (soroush.saadatfar@ul.ie), Localisation Research Centre
Felix Sasaki (felix@sasakiatcf.com), Individual
Yves Savourel (ysavourel@enlaso.com), ENLASO Corporation
Additional artifacts:

This prose specification is one component of a Work Product that also includes:

Related Work:

This specification replaces or supersedes:

Declared XML Namespaces:
  • urn:oasis:names:tc:xliff:document:2.0

  • urn:oasis:names:tc:xliff:matches:2.0

  • urn:oasis:names:tc:xliff:glossary:2.0

  • urn:oasis:names:tc:xliff:fs:2.0

  • urn:oasis:names:tc:xliff:metadata:2.0

  • urn:oasis:names:tc:xliff:resourcedata:2.0

  • urn:oasis:names:tc:xliff:changetracking:2.1

  • urn:oasis:names:tc:xliff:sizerestriction:2.0

  • urn:oasis:names:tc:xliff:validation:2.0

  • urn:oasis:names:tc:xliff:itsm:2.1

Abstract:

This document defines version 2.1 of the XML Localisation Interchange File Format (XLIFF). The purpose of this vocabulary is to store localizable data and carry it from one step of the localization process to the other, while allowing interoperability between and among tools.

Status:

This document was last revised or approved by the OASIS XML Localisation Interchange File Format (XLIFF) TC on the above date. The level of approval is also listed above. Check the “Latest version” location noted above for possible later revisions of this document.

Technical Committee members should send comments on this specification to the Technical Committee's email list. Others should send comments to the Technical Committee by using the "Send A Comment" button on the Technical Committee's web page at https://www.oasis-open.org/committees/xliff/.

For information on whether any patents have been disclosed that may be essential to implementing this specification, and any offers of patent licensing terms, please refer to the Intellectual Property Rights section of the Technical Committee web page (https://www.oasis-open.org/committees/xliff/ipr.php).

Citation format:

When referencing this specification the following citation format should be used:

[XLIFF-2.1]

XLIFF Version 2.1. Edited by David Filip, Tom Comerford, Soroush Saadatfar, Felix Sasaki, and Yves Savourel. 14 October 2016. OASIS Committee Specification Draft 01 / Public Review Draft 01. http://docs.oasis-open.org/xliff/xliff-core/v2.1/csprd01/xliff-core-v2.1-csprd01.html. Latest version: http://docs.oasis-open.org/xliff/xliff-core/v2.1/xliff-core-v2.1.html.


Notices

Copyright © OASIS Open 2016. All Rights Reserved.

All capitalized terms in the following text have the meanings assigned to them in the OASIS Intellectual Property Rights Policy (the "OASIS IPR Policy"). The full Policy may be found at the OASIS website.

This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published, and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this section are included on all such copies and derivative works. However, this document itself may not be modified in any way, including by removing the copyright notice or references to OASIS, except as needed for the purpose of developing any document or deliverable produced by an OASIS Technical Committee (in which case the rules applicable to copyrights, as set forth in the OASIS IPR Policy, must be followed) or as required to translate it into languages other than English.

The limited permissions granted above are perpetual and will not be revoked by OASIS or its successors or assigns.

This document and the information contained herein is provided on an "AS IS" basis and OASIS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY OWNERSHIP RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

OASIS requests that any OASIS Party or any other party that believes it has patent claims that would necessarily be infringed by implementations of this OASIS Committee Specification or OASIS Standard, to notify OASIS TC Administrator and provide an indication of its willingness to grant patent licenses to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification.

OASIS invites any party to contact the OASIS TC Administrator if it is aware of a claim of ownership of any patent claims that would necessarily be infringed by implementations of this specification by a patent holder that is not willing to provide a license to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification. OASIS may include such claims on its website, but disclaims any obligation to do so.

OASIS takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on OASIS' procedures with respect to rights in any document or deliverable produced by an OASIS Technical Committee can be found on the OASIS website. Copies of claims of rights made available for publication and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this OASIS Committee Specification or OASIS Standard, can be obtained from the OASIS TC Administrator. OASIS makes no representation that any information or list of intellectual property rights will at any time be complete, or that any claims in such list are, in fact, Essential Claims.

The name "OASIS" is a trademark of OASIS, the owner and developer of this specification, and should be used only to refer to the organization and its official outputs. OASIS welcomes reference to, and implementation and use of, specifications, while reserving the right to enforce its marks against misleading uses. Please see https://www.oasis-open.org/policies-guidelines/trademark for above guidance.


Table of Contents

1 Introduction
1.1 Terminology
1.1.1 Key words
1.1.2 Definitions
1.1.3 Key concepts
1.2 Normative References
1.3 Non-Normative References
2 Conformance
3 Fragment Identification
3.1 Selectors for Core Elements
3.2 Selectors for Modules and Extensions
3.3 Relative References
3.4 Examples
4 The Core Specification
4.1 General Processing Requirements
4.2 Elements
4.2.1 Tree Structure
4.2.2 Structural Elements
4.2.3 Inline Elements
4.3 Attributes
4.3.1 XLIFF Attributes
4.3.2 XML namespace
4.4 CDATA sections
4.5 XML Comments
4.6 XML Processing Instructions
4.7 Inline Content
4.7.1 Text
4.7.2 Inline Codes
4.7.3 Annotations
4.7.4 Sub-Flows
4.7.5 White Spaces
4.7.6 Bidirectional Text
4.7.7 Target Content Modification
4.7.8 Content Comparison
4.8 Segmentation
4.8.1 Segments Representation
4.8.2 Segments Order
4.8.3 Segmentation Modification
4.9 Extension Mechanisms
4.9.1 Extension Points
4.9.2 Constraints
4.9.3 Processing Requirements
5 The Modules Specifications
5.1 Translation Candidates Module
5.1.1 Introduction
5.1.2 Module Namespace and Validation Artifacts
5.1.3 Module Fragment Identification Prefix
5.1.4 Translation Candidate Annotation
5.1.5 Module Elements
5.1.6 Module Attributes
5.1.7 Example:
5.2 Glossary Module
5.2.1 Introduction
5.2.2 Module Namespace and Validation Artifacts
5.2.3 Module Fragment Identification Prefix
5.2.4 Module Elements
5.2.5 Module Attributes
5.2.6 Example:
5.3 Format Style Module
5.3.1 Introduction
5.3.2 Module Namespace and Validation Artifacts
5.3.3 Module Fragment Identification Prefix
5.3.4 Module Specification
5.3.5 Module Attributes
5.4 Metadata Module
5.4.1 Introduction
5.4.2 Module Namespace and Validation Artifacts
5.4.3 Module Fragment Identification Prefix
5.4.4 Module Elements
5.4.5 Module Attributes
5.5 Resource Data Module
5.5.1 Introduction
5.5.2 Module Namespace and Validation Artifacts
5.5.3 Module Fragment Identification Prefix
5.5.4 Module Elements
5.5.5 Module Attributes
5.5.6 Examples:
5.6 Change Tracking Module
5.6.1 Introduction
5.6.2 Module Namespace and Validation Artifacts
5.6.3 Conformance to the Change Tracking Module Specification
5.6.4 Module Fragment Identification Prefix
5.6.5 Module Elements
5.6.6 Module Attributes
5.6.7 Example:
5.7 Size and Length Restriction Module
5.7.1 Introduction
5.7.2 Module Namespace and Validation Artifacts
5.7.3 Module Fragment Identification Prefix
5.7.4 Module Elements
5.7.5 Module Attributes
5.7.6 Standard profiles
5.7.7 Third party profiles
5.7.8 Conformance
5.7.9 Example
5.8 Validation Module
5.8.1 Introduction
5.8.2 Module Namespace and Validation Artifacts
5.8.3 Module Fragment Identification Prefix
5.8.4 Module Elements
5.8.5 Module Attributes
5.9 ITS Module
5.9.1 Introduction
5.9.2 Module Namespace and Validation Artifacts
5.9.3 Module Fragment Identification Prefix
5.9.4 Conformance to the ITS Module Specification
5.9.5 ITS Tools Referencing
5.9.6 ITS data categories defined in the ITS Module
5.9.7 ITS categories available through XLIFF Core and other Modules
5.9.8 ITS categories that have a partial overlap with XLIFF features
5.9.9 ITS categories that do not represent metadata after Extraction of content into XLIFF
5.9.10 ITS Mapping Annotations
5.9.11 Module Elements
5.9.12 Module Attributes
5.9.13 Examples:

Appendixes

A Media Type Registration Template for XLIFF Version 2.0 and higher Versions
A.1 Regsitration Template
A.1.1 Detailed Security Considerations
A.1.1.1 Privacy, trust and integrity
A.1.1.2 Core
A.1.1.3 Resource Data Module
A.1.1.4 ITS Module
A.1.1.5 Other potentially security sensitive constructs
B Machine Readable Validation Artifacts (Informative)
B.1 XML Schemas Tree
B.2 Support Schemas
C Specification Change Tracking (Informative)
C.1 High Level Summary of Changes made in Comparison to XLIFF Version 2.0
D Acknowledgements (Informative)

1 Introduction

XLIFF is the XML Localization Interchange File Format designed by a group of multilingual content publishers, software providers, localization service providers, localization tools providers and researchers. It is intended to give any multilingual content owner a single interchange file format that can be understood by any localization provider, using any conformant localization tool. While the primary focus is on being a lossless interchange format, usage of XLIFF as a processing format is neither encouraged nor discouraged or prohibited.

All text is normative unless otherwise labeled. The following common methods are used for labeling portions of this specification as informative and hence non-normative:

Appendices and sections marked as "(Informative)" or "Non-Normative" in title,
Notes (sections with the "Note" title),
Warnings (sections with the "Warning" title),
Examples (mainly example code listings, tree diagrams, but also any inline examples or illustrative exemplary lists in otherwise normative text),
Schema and other validation artifacts listings (the corresponding artifacts are normative, not their listings).

1.1 Terminology

1.1.1 Key words

The key words MUST, MUST NOT, REQUIRED, SHALL, SHALL NOT, SHOULD, SHOULD NOT, RECOMMENDED, MAY, and OPTIONAL are to be interpreted as described in [RFC 2119].

1.1.2 Definitions

Agent

any application or tool that generates (creates), reads, edits, writes, processes, stores, renders or otherwise handles XLIFF Documents.

Agent is the most general application conformance target that subsumes all other specialized user agents disregarding whether they are defined in this specification or not.

Enrich, Enriching

the process of associating module and extension based metadata and resources with the Extracted XLIFF payload

Processing Requirements

  • Enriching MAY happen at the time of Extraction.

Note

Extractor knowledge of the native format is not assumed while Enriching.

Enricher, Enricher Agent

any Agent that performs the Enriching process

Extract, Extraction

the process of encoding localizable content from a native content or User Interface format as XLIFF payload, so that localizable parts of the content in the source language are available for Translation into the target language along with the necessary context information

Extractor, Extractor Agent

any Agent that performs the Extraction process

Merge, Merging

the process of importing XLIFF payload back to the originating native format, based on the full knowledge of the Extraction mechanism, so that the localized content or User Interface strings replace the source language in the native format

Merger, Merger Agent

an Agent that performs the Merge process

Warning

Unless specified otherwise, any Merger is deemed to have the same knowledge of the native format as the Extractor throughout the specification.

Mergers independent of Extractors can succeed, but it is out of scope of this specification to specify interoperability for Merging back without the full Extractor knowledge of the native format.

Modify, Modification

the process of changing core and module XLIFF structural and inline elements that were previously created by other Writers

Processing Requirements

  • XLIFF elements MAY be Modified and Enriched at the same time.

Note

Extractor or Enricher knowledge of the native format is not assumed while Modifying.

Modifier, Modifier Agent

an Agent that performs the Modification process

Translation, Translate

a rendering of the meaning of the source text, expressed in the target language

Writer, Writer Agent

an Agent that creates, generates, or otherwise writes an XLIFF Document for whatever purpose, including but not limited to Extractor, Modifier, and Enricher Agents.

Note

Since XLIFF is intended as an exchange format rather than a processing format, many applications will need to generate XLIFF Documents from their internal processing formats, even in cases when they are processing XLIFF Documents created by another Extractor.

1.1.3 Key concepts

XLIFF Core

The core of XLIFF 2.1 consists of the minimum set of XML elements and attributes required to (a) prepare a document that contains text extracted from one or more files for localization, (b) allow it to be completed with the translation of the extracted text, and (c) allow the generation of Translated versions of the original document.

The XML namespace that corresponds to the core subset of XLIFF 2.1 is "urn:oasis:names:tc:xliff:document:2.0".

XLIFF-defined (elements and attributes)

The following is the list of allowed schema URN prefixes for XLIFF-defined elements and attributes:

urn:oasis:names:tc:xliff:

However, the following namespaces are NOT considered XLIFF-defined for the purposes of the XLIFF 2.1 specification:

urn:oasis:names:tc:xliff:document:1.0
urn:oasis:names:tc:xliff:document:1.1
urn:oasis:names:tc:xliff:document:1.2
urn:oasis:names:tc:xliff:changetracking:2.0

Elements and attributes from other namespaces are not XLIFF-defined.

XLIFF Document

Any XML document that declares the namespace "urn:oasis:names:tc:xliff:document:2.0" as its main namespace, has <xliff> as the root element and complies with the XML Schemas and the declared Constraints that are part of this specification.

XLIFF Module

A module is an OPTIONAL set of XML elements and attributes that stores information about a process applied to an XLIFF Document and the data incorporated into the document as result of that process.

Each official module defined for XLIFF 2.1 has its grammar defined in an independent XML Schema with a separate namespace.

1.2 Normative References

[BCP 47] M. Davis, Tags for Identifying Languages, http://tools.ietf.org/html/bcp47 IETF (Internet Engineering Task Force).

[HTML5] Ian Hickos, Robin Berjon, Steve Faulkner, Travis Leithead, Erika Doyle Navara, Edward O'Connor, Silvia Pfeiffer HTML5. A vocabulary and associated APIs for HTML and XHTML, http://www.w3.org/TR/html5/ W3C Recommendation 28 October 2014.

[ITS] David Filip, Shaun McCance, Dave Lewis, Christian Lieske, Arle Lommel, Jirka Kosek, Felix Sasaki, Yves Savourel Internationalization Tag Set (ITS) Version 2.0, http://www.w3.org/TR/its20/ W3C Recommendation 29 October 2013.

[NOTE-datetime] M. Wolf, C. Wicksteed, Date and Time Formats, http://www.w3.org/TR/NOTE-datetime W3C Note, 15th Setember 1997.

[NVDL] International Standards Organization, ISO/IEC 19757-4, Information Technology - Document Schema Definition Languages (DSDL) - Part 4: Namespace-based Validation Dispatching Language (NVDL), http://standards.iso.org/ittf/PubliclyAvailableStandards/c038615_ISO_IEC_19757-4_2006(E).zip ISO, June 1, 2006.

[RFC 2119] H. Thompson and C. Lilley, XML Media Types, http://www.ietf.org/rfc/rfc2119.txt IETF (Internet Engineering Task Force) RFC 2119, March 1997.

[RFC 3987] M. Duerst and M. Suignard, Internationalized Resource Identifiers (IRIs), https://www.ietf.org/rfc/rfc3987.txt IETF (Internet Engineering Task Force) RFC 3987, January 2005.

[RFC 7303] S. Bradner, Key words for use in RFCs to Indicate Requirement Levels, https://www.tools.ietf.org/html/rfc7303 IETF (Internet Engineering Task Force) RFC 7303, July 2014.

[Schematron] International Standards Organization, ISO/IEC 19757-3, Information Technology - Document Schema Definition Languages (DSDL) - Part 3: Rule-Based Validation — Schematron (Second Edition), http://standards.iso.org/ittf/PubliclyAvailableStandards/c055982_ISO_IEC_19757-3_2016.zip ISO, January 15, 2016.

[UAX #9] M. Davis, UNICODE BIDIRECTIONAL ALGORITHM, http://www.unicode.org/reports/tr9/ Unicode Bidirectional Algorithm.

[UAX #15] M. Davis, K. Whistler, UNICODE NORMALIZATION FORMS, http://www.unicode.org/reports/tr15/ Unicode Normalization Forms.

[Unicode] The Unicode Consortium, The Unicode Standard, http://www.unicode.org/versions/latest/ Mountain View, CA: The Unicode Consortium, 2012.

[XML] W3C, Extensible Markup Language (XML) 1.0, http://www.w3.org/TR/xml/ (Fifth Edition) W3C Recommendation 26 November 2008.

[XML namespace] W3C, Schema document for namespace http://www.w3.org/XML/1998/namespace http://www.w3.org/2001/xml.xsd [http://www.w3.org/2009/01/xml.xsd]. at http://docs.oasis-open.org/xliff/xliff-core/v2.1/csprd01/schemas/informativeCopiesOf3rdPartySchemas/w3c/xml.xsd in this distribution

[XML Catalogs] Norman Walsh, XML Catalogs, https://www.oasis-open.org/committees/download.php/14809/xml-catalogs.html OASIS Standard V1.1, 07 October 2005.

[XML Schema] W3C, XML Schema, refers to the two part standard comprising [XML Schema Structures] and [XML Schema Datatypes] (Second Editions) W3C Recommendations 28 October 2004.

[XML Schema Datatypes] W3C, XML Schema Part 2: Datatypes, http://www.w3.org/TR/xmlschema-2/ (Second Edition) W3C Recommendation 28 October 2004.

[XML Schema Structures] W3C, XML Schema Part 1: Structures, https://www.w3.org/TR/xmlschema-1/ (Second Edition) W3C Recommendation 28 October 2004.

1.3 Non-Normative References

[LDML] Unicode Locale Data Markup Language http://unicode.org/reports/tr35/

[SRX] Segmentation Rules eXchange http://www.gala-global.org/oscarStandards/srx/

[UAX #29] M. Davis, UNICODE TEXT SEGMENTATION, http://www.unicode.org/reports/tr29/ Unicode text Segmentation.

[XML I18N BP] Best Practices for XML Internationalization, 13 February 2008, http://www.w3.org/TR/xml-i18n-bp/ W3C Working Group.

2 Conformance

  1. Document Conformance

    1. XLIFF is an XML vocabulary, therefore conformant XLIFF Documents MUST be well formed and valid [XML] documents.

    2. Conformant XLIFF Documents MUST be valid instances of the official Core XML Schema (http://docs.oasis-open.org/xliff/xliff-core/v2.1/csprd01/schemas/xliff_core_2.0.xsd) that is a part of this multipart Work Product.

    3. As not all aspects of the XLIFF specification can be expressed in terms of XML Schemas, conformant XLIFF Documents MUST also comply with all relevant elements and attributes definitions, normative usage descriptions, and Constraints specified in this specification document.

    4. XLIFF Documents MAY contain custom extensions, as defined in the Extension Mechanisms section.

  2. Application Conformance

    1. XLIFF Writers MUST create conformant XLIFF Documents to be considered XLIFF compliant.

    2. Agents processing conformant XLIFF Documents that contain custom extensions are not REQUIRED to understand and process non-XLIFF elements or attributes. However, conformant applications SHOULD preserve existing custom extensions when processing conformant XLIFF Documents, provided that the elements that contain custom extensions are not removed according to XLIFF Processing Requirements or the extension's own processing requirements.

    3. All Agents MUST comply with Processing Requirements for otherwise unspecified Agents or without a specifically set target Agent.

    4. Specialized Agents defined in this specification - this is Extractor, Merger, Writer, Modifier, and Enricher Agents - MUST comply with the Processing Requirements targeting their specifically defined type of Agent on top of Processing Requirements targeting all Agents as per point c. above.

    5. XLIFF is a format explicitly designed for exchanging data among various Agents. Thus, a conformant XLIFF application MUST be able to accept XLIFF Documents it had written after those XLIFF Documents were Modified or Enriched by a different application, provided that:

      1. The processed files are conformant XLIFF Documents,

      2. in a state compliant with all relevant Processing Requirements.

  3. Backwards Compatibility

    1. Conformant applications are REQUIRED to support XLIFF 2.0.

    2. Conformant applications are NOT REQUIRED to support XLIFF 1.2 or previous Versions.

Note

XLIFF Documents conformant to this specification are not and cannot be conformant to XLIFF 1.2 or earlier versions. If an application needs to support for whatever business reason both XLIFF 2 and XLIFF 1.2 or earlier, these will need to be supported as separate functionalities.

3 Fragment Identification

Because XLIFF Documents do not follow the usual behavior of XML documents when it comes to element identifiers, this specification defines how Agents MUST interpret the fragment identifiers in IRIs pointing to XLIFF Documents.

Note

Note that some identifiers may change during the localization process. For example <data> elements may be re-grouped or not depending on how tools treat identical original data.

Constraints

  • A fragment identifier MUST match the following format:

    <expression>      ::= "#" ["/"] <selector> {<selectorSeparator> <selector>}
    <selector>        ::= [<prefix> <prefixSeparator>] <id>
    <prefix>          ::= NMTOKEN
    <id>              ::= NMTOKEN
    <prefixSeparator> ::= "="
    <selectorSeparator>  ::= "/"
  • There MUST NOT be two identical prefixes in the expression.

  • When used, the following selectors MUST be declared in this order: file selector, group selector and unit selector.

  • The selectors for modules or extensions, <note>, <segment> or <ignorable> or source inline elements, target inline elements and <data> have the following constraints:

    • Only one of them MAY be used in the expression.

    • The one used MUST be the last selector of the expression.

Warning

Please note that due to the above Constraints, referencing fragments using third party namespaces within Modules or extensions (including but not limited to XLIFF Core or the Metadata Module) is not possible. This is to restrict the complexity of the fragment identification mechanism, as it would otherwise have potentially unlimited depth.

3.1 Selectors for Core Elements

  • The prefix f indicates a <file> id and the value of that id is unique among all <file> id attribute values within the enclosing <xliff> element.

  • The prefix g indicates a <group> id and the value of that id is unique among all <group> id attribute values within the enclosing <file> element.

  • The prefix u indicates a <unit> id and the value of that id is unique among all <unit> id attribute values within the enclosing <file> element.

  • The prefix n indicates a <note> id and the value of that id is unique among all <note> id attribute values within the immediate enclosing <file>, <group>, or <unit> element.

  • The prefix d indicates a <data> id and the value of that id is unique among all <data> id attribute values within the enclosing <unit> element.

  • The prefix t indicates an id for an inline element in the <target> element and the value of that id is unique within the enclosing <unit> element (with the exception of the matching inline elements in the <source>).

  • No prefix indicates an id for a <segment> or an <ignorable> or an inline element in the <source> element and the value of that id is unique within the enclosing <unit> element (with the exception of the matching inline elements in the <target>).

3.2 Selectors for Modules and Extensions

A selector for a module or an extension uses a registered prefix and the value of that id is unique within the immediate enclosing <file>, <group> or <unit> element.

Constraints

  • The prefix of a module or an extension MUST be an NMTOKEN longer than 1 character and MUST be defined in the module or extension specification.

  • The prefix of a module or an extension MUST be registered with the XLIFF TC.

  • A given module or extension namespace URI MUST be associated with a single prefix.

  • A prefix MAY be associated with more than one namespace URI (to allow for example different versions of a given module or extension to use the same prefix).

See also the constraints related to how IDs need to be specified in extensions (which applies for modules as well).

3.3 Relative References

Fragment identifiers that do not start with a character / (U+002F) are relative to their location in the document, or to the document being processed.

Any unit, group or file selector missing to resolve the relative reference is obtained from the immediate enclosing unit, group or file elements.

3.4 Examples

Given the following XLIFF document:

<xliff xmlns="urn:oasis:names:tc:xliff:document:2.0" version="2.0"
 srcLang="en" trgLang="fr">
 <file id="f1">
  <notes>
   <note id="n1">note for file.</note>
  </notes>
  <unit id="u1">
   <my:elem xmlns:my="myNamespaceURI" id="x1">data</my:elem>
   <notes>
    <note id="n1">note for unit</note>
   </notes>
   <segment id="s1">
    <source><pc id="1">Hello <mrk id="m1" type="term">World</mrk>!</pc>
    </source>
    <target><pc id="1">Bonjour le <mrk id="m1" type="term">Monde</mrk> !
    </pc></target>
   </segment>
  </unit>
 </file>
</xliff>

You can have the following fragment identifiers:

  • #f=f1/u=u1/1 refers to the element <pc id="1"> of the source content of the element <unit id="u1">.

  • #f=f1/u=u1/t=1 refers to the element <pc id="1"> of the target content of the element <unit id="u1">.

  • #f=f1/n=n1 refers to the element <note id="n1"> of the element <file id="f1">.

  • #f=f1/u=u1/n=n1 refers to the element <note id="n1"> of the element <unit id="u1">.

  • #f=f1/u=u1/s1 refers to the element <segment id="s1"> of the element <unit id="u1">.

  • Assuming the extension defined by the namespace URI myNamespaceURI has registered the prefix myprefix, the expression #f=f1/u=u1/myprefix=x1 refers to the element <my:element id="x1"> of the element <unit id="u1">.

4 The Core Specification

XLIFF is a bilingual document format designed for containing text that needs Translation, its corresponding translations and auxiliary data that makes the Translation process possible.

At creation time, an XLIFF Document MAY contain only text in the source language. Translations expressed in the target language MAY be added at a later time.

The root element of an XLIFF Document is <xliff>. It contains a collection of <file> elements. Typically, each <file> element contains a set of <unit> elements that contain the text to be translated in the <source> child of one or more <segment> elements. Translations are stored in the <target> child of each <segment> element.

4.1 General Processing Requirements

  • An Agent processing a valid XLIFF Document that contains XLIFF-defined elements and attributes that it cannot handle MUST preserve those elements and attributes.

  • An Agent processing a valid XLIFF Document that contains custom elements and attributes that it cannot handle SHOULD preserve those elements and attributes.

4.2 Elements

This section contains a description of all elements used in XLIFF Core.

4.2.1 Tree Structure

Legend:

1 = one
+ = one or more
? = zero or one
* = zero or more
<xliff>
|
+---<file> +
  |
  +---<skeleton> ?
  | |
  | +---<other> *
  |
  +---<other> *
  |
  +---<notes> ?
  | |
  | +---<note> +
  |
  +---At least one of (<unit> OR <group>)
      | |
      | +---<unit>
      |   |
      |   +---<other> *
      |   |
      |   +---<notes> ?
      |   | |
      |   | +---<note> +
      |   |
      |   +---<originalData> ?
      |   | |
      |   | +---<data> +
      |   |
      |   +---At least one of (<segment> OR <ignorable>)
      |       | |
      |       | +---<segment>
      |       |   |
      |       |   +---<source> 1
      |       |   |
      |       |   +---<target> ?
      |       |
      |       +---<ignorable>
      |           |
      |           +---<source> 1
      |           |
      |           +---<target> ?
      |
      +---<group>
          |
          +---<other> *
          |
          +---<notes> ?
          | |
          | +---<note> +
          |
          +---At least one of (<unit> OR <group>)


  

4.2.2 Structural Elements

The structural elements used in XLIFF Core are: <xliff>, <file>, <skeleton>, <group>, <unit>, <segment>, <ignorable>, <notes>, <note>, <originalData>, <data>, <source> and <target>.

4.2.2.1 xliff

Root element for XLIFF documents.

Contains:

- One or more <file> elements

Attributes:

- version, REQUIRED
- srcLang, REQUIRED
- trgLang, OPTIONAL
- xml:space, OPTIONAL
- attributes from other namespaces, OPTIONAL

Constraints

4.2.2.2 file

Container for localization material extracted from an entire single document, or another high level self contained logical node in a content structure that cannot be described in the terms of documents.

Note

Sub-document artifacts such as particular sheets, pages, chapters and similar are better mapped onto the <group> element. The <file> element is intended for the highest logical level. For instance a collection of papers would map to a single XLIFF Document, each paper will be represented with one <file> element, whereas chapters and subsections will map onto nested <group> elements.

Contains:

- Zero or one <skeleton> element followed by
- elements from other namespaces, OPTIONAL
- Zero or one <notes> element followed by
- One or more <unit> or <group> elements in any order.

Attributes:

- id, REQUIRED
- canResegment, OPTIONAL
- original, OPTIONAL
- translate, OPTIONAL
- srcDir, OPTIONAL
- trgDir, OPTIONAL
- xml:space, OPTIONAL
- attributes from other namespaces, OPTIONAL

Constraints

  • The following XLIFF Module elements are explicitly allowed by the wildcard other:

    - Zero or one <ctr:changeTrack> elements
    - Zero or one <mda:metadata> elements
    - Zero or one <res:resourceData> element
    - Zero or one <slr:profiles> elements
    - Zero or one <slr:data> elements
    - Zero or one <val:validation> elements
    - Zero, one, or more <itsm:provenanceRecords> elements
  • Module and Extension elements MAY be used in any order.

  • The following XLIFF Module attributes are explicitly allowed by the wildcard other:

    - attributes from the namespace urn:oasis:names:tc:xliff:fs:2.0, OPTIONAL, provided that the Constraints specified in the Format Style Module are met.
    - attributes from the namespace urn:oasis:names:tc:xliff:sizerestriction:2.0, OPTIONAL, provided that the Constraints specified in the Size and Length Restriction Module are met.
    - attributes from the namespace urn:oasis:names:tc:xliff:itsm:2.1, OPTIONAL, provided that the Constraints specified in the ITS Module are met.
4.2.2.3 skeleton

Container for non-translatable material pertaining to the parent <file> element.

Contains:

Either

- Non-translatable text
- elements from other namespaces

or

- is empty.

Attributes:

- href, OPTIONAL

Constraints

  • The attribute href is REQUIRED if and only if the <skeleton> element is empty.

Processing Requirements

  • Modifiers and Enrichers processing an XLIFF Document that contains a <skeleton> element MUST NOT change that element, its attributes, or its content.

  • Extractors creating an XLIFF Document with a <skeleton> element MUST leave the <skeleton> element empty if and only if they specify the attribute href.

4.2.2.4 group

Provides a way to organize units into a structured hierarchy.

Note that this is especially useful for mirroring a source format's hierarchical structure.

Contains:

- elements from other namespaces, OPTIONAL
- Zero or one <notes> element followed by
- Zero, one or more <unit> or <group> elements in any order.

Attributes:

- id, REQUIRED
- name, OPTIONAL
- canResegment, OPTIONAL
- translate, OPTIONAL
- srcDir, OPTIONAL
- trgDir, OPTIONAL
- type, OPTIONAL
- xml:space, OPTIONAL
- attributes from other namespaces, OPTIONAL

Constraints

  • The following XLIFF Module elements are explicitly allowed by the wildcard other:

    - Zero or one <ctr:changeTrack> elements
    - Zero or one <mda:metadata> elements
    - Zero or one <slr:data> elements
    - Zero or one <val:validation> elements
    - Zero, one, or more <itsm:provenanceRecords> elements
  • Module and Extension elements MAY be used in any order.

  • The following XLIFF Module attributes are explicitly allowed by the wildcard other:

    - attributes from the namespace urn:oasis:names:tc:xliff:fs:2.0, OPTIONAL, provided that the Constraints specified in the Format Style Module are met.
    - attributes from the namespace urn:oasis:names:tc:xliff:sizerestriction:2.0, OPTIONAL, provided that the Constraints specified in the Size and Length Restriction Module are met.
    - attributes from the namespace urn:oasis:names:tc:xliff:itsm:2.1, OPTIONAL, provided that the Constraints specified in the ITS Module are met.
4.2.2.5 unit

Static container for a dynamic structure of elements holding the extracted translatable source text, aligned with the Translated text.

Contains:

- elements from other namespaces, OPTIONAL
- Zero or one <notes> elements followed by
- Zero or one <originalData> element followed by
- One or more <segment> or <ignorable> elements in any order.

Attributes:

- id, REQUIRED
- name, OPTIONAL
- canResegment, OPTIONAL
- translate, OPTIONAL
- srcDir, OPTIONAL
- trgDir, OPTIONAL
- xml:space, OPTIONAL
- type, OPTIONAL
- attributes from other namespaces, OPTIONAL

Constraints

4.2.2.6 segment

This element is a container to hold in its aligned pair of children elements the minimum portion of translatable source text and its Translation in the given Segmentation.

Contains:

- One <source> element followed by
- Zero or one <target> element

Attributes:

- id, OPTIONAL
- canResegment, OPTIONAL
- state, OPTIONAL
- subState, OPTIONAL
4.2.2.7 ignorable

Part of the extracted content that is not included in a segment (and therefore not translatable). For example tools can use <ignorable> to store the white space and/or codes that are between two segments.

Contains:

- One <source> element followed by
- Zero or one <target> element

Attributes:

- id, OPTIONAL
4.2.2.8 notes

Collection of comments.

Contains:

- One or more <note> elements
4.2.2.9 note

This is an XLIFF specific way how to present end user readable comments and annotations. A note can contain information about <source>, <target>, <unit>, <group>, or <file> elements.

Contains:

- Text

Attributes:

- id, OPTIONAL
- appliesTo, OPTIONAL
- category, OPTIONAL
- priority, OPTIONAL
- attributes from other namespaces, OPTIONAL

Constraints

  • The following XLIFF Module attributes are explicitly allowed by the wildcard other:

    - fs:fs, OPTIONAL
    - fs:subFs, OPTIONAL
4.2.2.10 originalData

Unit-level collection of original data for the inline codes.

Contains:

- One or more <data> elements
4.2.2.11 data

Storage for the original data of an inline code.

Contains:

- Non-translatable text
- Zero, one or more <cp> elements.

Non-translatable text and <cp> elements MAY appear in any order.

Attributes:

- id, REQUIRED
- dir, OPTIONAL
- xml:space, OPTIONAL, the value is restricted to preserve on this element
4.2.2.12 source

Portion of text to be translated.

Contains:

- Text
- Zero, one or more <cp> elements
- Zero, one or more <ph> elements
- Zero, one or more <pc> elements
- Zero, one or more <sc> elements
- Zero, one or more <ec> elements
- Zero, one or more <mrk> elements
- Zero, one or more <sm> elements
- Zero, one or more <em> elements

Text and inline elements may appear in any order.

Attributes:

- xml:lang, OPTIONAL
- xml:space, OPTIONAL
4.2.2.13 target

The translation of the sibling <source> element.

Contains:

- Text
- Zero, one or more <cp> elements
- Zero, one or more <ph> elements
- Zero, one or more <pc> elements
- Zero, one or more <sc> elements
- Zero, one or more <ec> elements
- Zero, one or more <mrk> elements
- Zero, one or more <sm> elements
- Zero, one or more <em> elements

Text and inline elements may appear in any order.

Attributes:

- xml:lang, OPTIONAL
- xml:space, OPTIONAL
- order, OPTIONAL

Constraints

4.2.3 Inline Elements

The XLIFF Core inline elements at the <source> or <target> level are: <cp>, <ph>, <pc>, <sc>, <ec>, <mrk>, <sm> and <em>.

The elements at the <unit> level directly related to inline elements are: <originalData> and <data>.

4.2.3.1 cp

Represents a Unicode character that is invalid in XML.

Contains:

This element is always empty.

Parents:

<data>, <mrk>, <source>, <target> and <pc>

Attributes:

- hex, REQUIRED

Example:

<unit id="1">
 <segment>
  <source>Ctrl+C=<cp hex="0003"/></source>
 </segment>
</unit>

The example above shows a character U+0003 (Control C) as it has to be represented in XLIFF.

Processing Requirements

  • Writers MUST encode all invalid XML characters of the content using <cp>.

  • Writers MUST NOT encode valid XML characters of the content using <cp>.

4.2.3.2 ph

Represents a standalone code of the original format.

Contains:

This element is always empty.

Parents:

<source>, <target>, <pc> and <mrk>

Attributes:

- canCopy, OPTIONAL
- canDelete, OPTIONAL
- canReorder, OPTIONAL
- copyOf, OPTIONAL
- disp, OPTIONAL
- equiv, OPTIONAL
- id, REQUIRED.
- dataRef, OPTIONAL
- subFlows, OPTIONAL
- subType, OPTIONAL
- type, OPTIONAL
- attributes from other namespaces, OPTIONAL

Example:

<unit id="1">
 <originalData>
  <data id="d1">%d</data>
  <data id="d2">&lt;br/></data>
 </originalData>
 <segment>
  <source>Number of entries: <ph id="1" dataRef="d1" />
<ph id="2" dataRef="d2"/>(These entries are only the ones matching the
current filter settings)</source>
 </segment>
</unit>

Constraints

  • The following XLIFF Module attributes are explicitly allowed by the wildcard other:

    - attributes from the namespace urn:oasis:names:tc:xliff:fs:2.0, OPTIONAL, provided that the Constraints specified in the Format Style Module are met.
    - attributes from the namespace urn:oasis:names:tc:xliff:sizerestriction:2.0, OPTIONAL, provided that the Constraints specified in the Size and Length Restriction Module are met.
  • No other attributes MUST be used.

4.2.3.3 pc

Represents a well-formed spanning original code.

Contains:

- Text
- Zero, one or more <cp> elements
- Zero, one or more <ph> elements
- Zero, one or more <pc> elements
- Zero, one or more <sc> elements
- Zero, one or more <ec> elements
- Zero, one or more <mrk> elements
- Zero, one or more <sm> elements
- Zero, one or more <em> elements

Text and inline elements may appear in any order.

Parents:

- <source>
- <target>
- <pc>
-<mrk>

Attributes:

- canCopy, OPTIONAL
- canDelete, OPTIONAL
- canOverlap, OPTIONAL
- canReorder, OPTIONAL
- copyOf, OPTIONAL
- dispEnd, OPTIONAL
- dispStart, OPTIONAL
- equivEnd, OPTIONAL
- equivStart, OPTIONAL
- id, REQUIRED
- dataRefEnd, OPTIONAL
- dataRefStart, OPTIONAL
- subFlowsEnd, OPTIONAL
- subFlowsStart, OPTIONAL
- subType, OPTIONAL
- type, OPTIONAL
- dir, OPTIONAL
- attributes from other namespaces, OPTIONAL

Example:

<unit id="1">
 <originalData>
  <data id="1">&lt;B&gt;</data>
  <data id="2">&lt;/B&gt;</data>
 </originalData>
 <segment><pc id="1" dataRefStart="1" dataRefEnd="2">Important</pc>
text</source>
 </segment>
</unit>

Constraints

  • The following XLIFF Module attributes are explicitly allowed by the wildcard other:

    - attributes from the namespace urn:oasis:names:tc:xliff:fs:2.0, OPTIONAL, provided that the Constraints specified in the Format Style Module are met.
    - attributes from the namespace urn:oasis:names:tc:xliff:sizerestriction:2.0, OPTIONAL, provided that the Constraints specified in the Size and Length Restriction Module are met.
  • No other attributes MUST be used.

Processing Requirements

  • Extractors MUST NOT use the <pc> element to represent standalone codes.

    Rationale: Using a spanning code for a standalone code can easily result in having text inside a span where the original format does not allow it.

4.2.3.4 sc

Start of a spanning original code.

Contains:

This element is always empty.

Parents:

<source>, <target>, <pc> and <mrk>

Attributes:

- canCopy, OPTIONAL
- canDelete, OPTIONAL
- canOverlap, OPTIONAL
- canReorder, OPTIONAL
- copyOf, OPTIONAL
- dataRef, OPTIONAL
- dir, OPTIONAL
- disp, OPTIONAL
- equiv, OPTIONAL
- id, REQUIRED
- isolated, OPTIONAL
- subFlows, OPTIONAL
- subType, OPTIONAL
- type, OPTIONAL
- attributes from other namespaces, OPTIONAL

Example:

<unit id="1">
 <segment>
  <source><sc id="1" type="fmt" subType="xlf:b"/>First sentence. </source>
 </segment>
 <segment>
  <source>Second sentence.<ec startRef="1" type="fmt" subType="xlf:b"/>
  </source>
 </segment>
</unit>

Constraints

  • The following XLIFF Module attributes are explicitly allowed by the wildcard other:

    - attributes from the namespace urn:oasis:names:tc:xliff:fs:2.0, OPTIONAL, provided that the Constraints specified in the Format Style Module are met.
    - attributes from the namespace urn:oasis:names:tc:xliff:sizerestriction:2.0, OPTIONAL, provided that the Constraints specified in the Size and Length Restriction Module are met.
  • No other attributes MUST be used.

  • The values of the attributes canCopy, canDelete, canReorder and canOverlap MUST be the same as the values the ones in the <ec> element corresponding to this start code.

  • The attribute isolated MUST be set to yes if and only if the <ec> element corresponding to this start marker is not in the same <unit>, and set to no otherwise.

Processing Requirements

  • Extractors MUST NOT use the <sc> / <ec> pair to represent standalone codes.

    Rationale: Using a spanning code for a standalone code can easily result in having text inside a span where the original format does not allow it.

4.2.3.5 ec

End of a spanning original code.

Contains:

This element is always empty.

Parents:

<source>, <target>, <pc> and <mrk>

Attributes:

- canCopy, OPTIONAL
- canDelete, OPTIONAL
- canOverlap, OPTIONAL
- canReorder, OPTIONAL
- copyOf, OPTIONAL
- dataRef, OPTIONAL
- dir, OPTIONAL
- disp, OPTIONAL
- equiv, OPTIONAL
- id, OPTIONAL
- isolated, OPTIONAL
- startRef, OPTIONAL
- subFlows, OPTIONAL
- subType, OPTIONAL
- type, OPTIONAL
- attributes from other namespaces, OPTIONAL

Example:

<unit id="1">
 <originalData>
  <data id="d1">\b </data>
  <data id="d2">\i </data>
  <data id="d3">\b0 </data>
  <data id="d4">\i0 </data>
 </originalData>
 <segment>
  <source>Text in <sc id="1" dataRef="d1"/>bold <sc id="2" dataRef="d2"/>
and<ec startRef="1" dataRef="d3"/> italics<ec startRef="2" dataRef="d4"/>.
  </source>
 </segment>
</unit>

Constraints

  • The following XLIFF Module attributes are explicitly allowed by the wildcard other:

    - attributes from the namespace urn:oasis:names:tc:xliff:fs:2.0, OPTIONAL, provided that the Constraints specified in the Format Style Module are met.
    - attributes from the namespace urn:oasis:names:tc:xliff:sizerestriction:2.0, OPTIONAL, provided that the Constraints specified in the Size and Length Restriction Module are met.
  • No other attributes MUST be used.

  • The values of the attributes canCopy, canDelete and canOverlap MUST be the same as the values the ones in the <sc> element corresponding to this end code.

  • The value of the attribute canReorder MUST be no if the value of canReorder is firstNo in the <sc> element corresponding to this end code.

  • The attribute isolated MUST be set to yes if and only if the <sc> element corresponding to this end code is not in the same <unit> and set to no otherwise.

  • If and only if the attribute isolated is set to yes, the attribute id MUST be used instead of the attribute startRef that MUST be used otherwise.

  • If and only if the attribute isolated is set to yes, the attribute dir MAY be used, otherwise the attribute dir MUST NOT be used on the <ec> element.

Processing Requirements

  • Extractors MUST NOT use the <sc> / <ec> pair to represent standalone codes.

    Rationale: Using a spanning code for a standalone code can easily result in having text inside a span where the original format does not allow it.

4.2.3.6 mrk

Represents an annotation pertaining to the marked span.

Contains:

- Text
- Zero, one or more <cp> elements
- Zero, one or more <ph> elements
- Zero, one or more <pc> elements
- Zero, one or more <sc> elements
- Zero, one or more <ec> elements
- Zero, one or more <mrk> elements
- Zero, one or more <sm> elements
- Zero, one or more <em> elements

Text and inline elements may appear in any order.

Parents:

<source>, <target>, <pc> and <mrk>

Attributes:

- id, REQUIRED
- translate, OPTIONAL
- type, OPTIONAL
- ref, OPTIONAL
- value, OPTIONAL
- attributes from other namespaces, OPTIONAL

Constraints

  • The [XML namespace] MUST NOT be used at this extension point.

  • The following XLIFF Module attributes are explicitly allowed by the wildcard other:

    - attributes from the namespace urn:oasis:names:tc:xliff:fs:2.0, OPTIONAL, provided that the Constraints specified in the Format Style Module are met.
    - attributes from the namespace urn:oasis:names:tc:xliff:sizerestriction:2.0, OPTIONAL, provided that the Constraints specified in the Size and Length Restriction Module are met.
    - attributes from the namespace urn:oasis:names:tc:xliff:itsm:2.1, OPTIONAL, provided that the Constraints specified in the ITS Module are met.

See the Annotations section for more details and examples on how to use the <mrk> element.

4.2.3.7 sm

Start marker of an annotation where the spanning marker cannot be used for wellformedness reasons.

Contains:

This element is always empty.

Parents:

<source>, <target>, <pc> and <mrk>

Attributes:

- id, REQUIRED
- translate, OPTIONAL
- type, OPTIONAL
- ref, OPTIONAL
- value, OPTIONAL
- attributes from other namespaces, OPTIONAL

Constraints

  • The [XML namespace] MUST NOT be used at this extension point.

  • The following XLIFF Module attributes are explicitly allowed by the wildcard other:

    - attributes from the namespace urn:oasis:names:tc:xliff:fs:2.0, OPTIONAL, provided that the Constraints specified in the Format Style Module are met.
    - attributes from the namespace urn:oasis:names:tc:xliff:sizerestriction:2.0, OPTIONAL, provided that the Constraints specified in the Size and Length Restriction Module are met.
    - attributes from the namespace urn:oasis:names:tc:xliff:itsm:2.1, OPTIONAL, provided that the Constraints specified in the ITS Module are met.

See the Annotations section for more details and examples on how to use the <sm> element.

4.2.3.8 em

End marker of an annotation where the spanning marker cannot be used for wellformedness reasons.

Contains:

This element is always empty.

Parents:

<source>, <target>, <pc> and <mrk>

Attributes:

- startRef, REQUIRED

See the Annotations section for more details and examples on how to use the <em> element.

4.3 Attributes

This section lists all the various attributes used in XLIFF core elements.

4.3.1 XLIFF Attributes

The attributes defined in XLIFF 2.0 are: appliesTo, canCopy, canDelete, canOverlap, canReorder, canResegment, category, copyOf, dataRef, dataRefEnd, dataRefStart, dir, disp, dispEnd, dispStart, equiv, equivEnd, equivStart, hex, href, id, isolated, name, order, original, priority, ref, srcDir, srcLang, startRef, state, subFlows, subFlowsEnd, subFlowsStart, subState, subType, trgLang, translate, trgDir, type, value and version.

4.3.1.1 appliesTo

Comment target - indicates the element to what the content of the note applies.

Value description: source or target.

Default value: undefined.

Used in: <note>.

4.3.1.2 canCopy

Replication editing hint - indicates whether or not the inline code can be copied.

Value description: yes if the code can be copied, no if the code is not intended to be copied.

Default value: yes.

Used in: <pc>, <sc>, <ec>, <ph>.

4.3.1.3 canDelete

Deletion editing hint - indicates whether or not the inline code can be deleted.

Value description: yes if the code can be deleted, no if the code is not allowed to be deleted.

Default value: yes.

Used in: <pc>, <sc>, <ec>, <ph>.

4.3.1.4 canOverlap

Code can overlap - indicates whether or not the spanning code where this attribute is used can enclose partial spanning codes (i.e. a start code without its corresponding end code, or an end code without its corresponding start code).

Value description: yes or no.

Default value: default values for this attribute depend on the element in which it is used:

Used in: <pc>, <sc> and <ec>

Example:

<unit id="1">
 <originalData>
  <data id="1">\i1 </data>
  <data id="2">\i0 </data>
  <data id="3">{\b </data>
  <data id="4">}</data>
 </originalData>
 <segment>
  <source><pc id="1" dataRefStart="3" dataRefEnd="4" canOverlap="no">Bold,
<sc id="2" dataRef="1" canOverlap="yes"/>both</pc>,
italics<ec startRef="2" dataRef="2"/></source>
 </segment>
</unit>
4.3.1.5 canReorder

Re-ordering editing hint - indicates whether or not the inline code can be re-ordered. See Editing Hints section for more details.

Value description: yes in case the code can be re-ordered, firstNo when the code is the first element of a sequence that cannot be re-ordered, no when it is another element of such a sequence.

Default value: yes.

Used in: <pc>, <sc>, <ec>, <ph>.

4.3.1.6 canResegment

Can resegment - indicates whether or not the source text in the scope of the given canResegment flag can be reorganized into a different structure of <segment> elements within the same parent <unit>.

Value description: yes or no.

Default value: default values for this attribute depend on the element in which it is used:

  • When used in <file>:

    The value yes.

  • When used in any other element:

    The value of the canResegment attribute of its parent element.

Used in: <file> <group> <unit>, and <segment>.

4.3.1.7 category

Category - provides a way to categorize notes.

Value description: Text.

Default value: undefined

Used in: <note>.

4.3.1.8 copyOf

Reference to base code - holds the id of the base code of a copied code.

Value description: NMTOKEN. The id value of the base code of which this code is a copy.

Default value: undefined

Used in: <ph>, <pc>, <sc>, <ec>.

Example:

<unit id="1">
 <segment>
  <source>Äter <pc id="1">katter möss</pc>?</source>
  <target>Do <pc id="1">cats</pc> eat <pc id="2" copyOf="1">mice</pc>?
  </target>
 </segment>
</unit>
4.3.1.9 dataRef

Original data reference - holds the identifier of the <data> element that contains the original data for a given inline code.

Value description: An [XML Schema Datatypes] NMTOKEN that MUST be the value of the id attribute of one of the <data> element listed in the same <unit> element.

Default value: undefined.

Used in: <ph>, <sc>, <ec>.

Example:

<unit id="1">
 <originalData>
  <data id="d1">{0}</data>
 </originalData>
 <segment>
  <source>Error in '<ph id="1" dataRef="d1"/>'.</source>
  <target>Erreur dans '<ph id="1" dataRef="d1"/>'.</target>
 </segment>
</unit>

The example above shows a <ph> element that has its original data stored outside the content, in a <data> element.

4.3.1.10 dataRefEnd

Original data reference - holds the identifier of the <data> element that contains the original data for the end marker of a given inline code.

Value description: An [XML Schema Datatypes] NMTOKEN that MUST be the value of the id attribute of one of the <data> element listed in the same <unit> element.

Default value: undefined.

Used in: <pc>.

Example:

<unit id="1">
 <originalData>
  <data id="d1">&lt;EM></data>
  <data id="d2">&lt;/EM></data>
 </originalData>
 <segment>
  <source><pc id="1" dataRefStart="d1" dataRefEnd="d2">Efficiency</pc>
is the operative word here.</source>
  <target><pc id="1" dataRefStart="d1" dataRefEnd="d2">Efficacité</pc>
est le mot clé ici.</target>
 </segment>
</unit>

The example above shows two <pc> elements with their original data stored outside the content, in two <data> elements.

4.3.1.11 dataRefStart

Original data reference - holds the identifier of the <data> element that contains the original data for the start marker of a given inline code.

Value description: An [XML Schema Datatypes] NMTOKEN that MUST be the value of the id attribute of one of the <data> element listed in the same <unit> element.

Default value: undefined.

Used in: <pc>.

Example:

<unit id="1">
 <originalData>
  <data id="d1">&lt;EM></data>
  <data id="d2">&lt;/EM></data>
 </originalData>
 <segment>
  <source><pc id="1" dataRefStart="d1" dataRefEnd="d2">Efficiency</pc>
is the operative word here.</source>
  <target><pc id="1" dataRefStart="d1" dataRefEnd="d2">Efficacité</pc>
est le mot clé ici.</target>
 </segment>
</unit>

The example above shows two <pc> elements with their original data stored outside the content, in two <data> elements.

4.3.1.12 dir

Directionality - indicates the directionality of content.

Value description: ltr (Left-To-Right), rtl (Right-To-Left), or auto (determined heuristically, based on the first strong directional character in scope, see [UAX #9]).

Default value: default values for this attribute depend on the element in which it is used:

  • When used in a <pc>, <sc>, or <ec> element that has a <source> element as its parent:

    The value of the srcDir attribute of the <unit> element, in which the elements are located.

  • When used in a <pc>, <sc>, or <ec> element that has a <target> element as its parent:

    The value of the trgDir attribute of the <unit> element, in which the elements are located.

  • When used in a <pc>, <sc>, or <ec> element that has a <pc> element as its parent:

    The value of the dir attribute of the parent <pc> element.

  • When used in <data>:

    The value auto.

Used in: <data>, <pc>, <sc>, and <ec>.

4.3.1.13 disp

Display text - holds an alternative user-friendly display representation of the original data of the inline code.

Value description: Text.

Default value: undefined

Used in: <ph>, <sc>, <ec>.

Example:

<unit id="1">
 <originalData>
  <data id="d1">{1}</data>
 </originalData>
 <segment>
 <source>Welcome back <ph id="1" disp="[UserName]" dataRef="d1"/>!</source>
 </segment>
</unit>

Note

To provide a plain text equivalent of the code, use the equiv attribute.

4.3.1.14 dispEnd

Display text - holds an alternative user-friendly display representation of the original data of the end marker of an inline code.

Value description: Text.

Default value: undefined

Used in: <pc>.

Example:

<unit id="1">
 <originalData>
  <data id="d1">\cf1\ul\b\f1\fs24 </data>
  <data id="d2">\cf0\ulnone\b0\f0\fs22 </data>
 </originalData>
 <segment>
  <source>Example of <pc id="1" dataRefStart="d1" dataRefEnd="d2"
dispStart="&lt;span>" dispEnd="&lt;/span>">formatted
text</pc>.</source>
 </segment>
</unit>

In the example above, the dispStart and dispEnd attributes provide a more user-friendly representation of the original formatting codes.

Note

To provide a plain text equivalent of the code, use the equivEnd attribute.

4.3.1.15 dispStart

Display text - holds an alternative user-friendly display representation of the original data of the start marker of an inline code.

Value description: Text.

Default value: undefined

Used in: <pc>.

Example:

<unit id="1">
 <originalData>
  <data id="d1">\cf1\ul\b\f1\fs24 </data>
  <data id="d2">\cf0\ulnone\b0\f0\fs22 </data>
 </originalData>
 <segment>
  <source>Example of <pc id="1" dataRefStart="d1" dataRefEnd="d2"
dispStart="&lt;span>" dispEnd="&lt;/span>">formatted
text</pc>.</source>
 </segment>
</unit>

In the example above, the dispStart and dispEnd attributes provide a more user-friendly representation of the original formatting codes.

Note

To provide a plain text equivalent of the code, use the equivStart attribute.

4.3.1.16 equiv

Equivalent text - holds a plain text representation of the original data of the inline code that can be used when generating a plain text representation of the content.

Value description: Text.

Default value: an empty string.

Used in: <ph>, <sc>, <ec>.

Example:

<unit id="1">
 <originalData>
  <data id="d1">&amp;</data>
 </originalData>
 <segment>
  <source>Open <ph id="1" equiv="" dataRef="d1"/>File</source>
 </segment>
</unit>

In this example the equiv attribute of the <ph> element is used to indicate that the original data of the code can be ignored in the text representation of the string. This could, for instance, help a spell-checker tool to process the content as "Open File".

Note

To provide a user-friendly representation, use the disp attribute.

4.3.1.17 equivEnd

Equivalent text - holds a plain text representation of the original data of the end marker of an inline code that can be used when generating a plain text representation of the content.

Value description: Text.

Default value: an empty string

Used in: <pc>.

Example:

<unit id="1">
 <originalData>
  <data id="d1">&lt;span class="link" onclick="linkTo('dbId5345')"></data>
  <data id="d2">&lt;/span></data>
 </originalData>
 <segment>
  <source>The jam made of <pc id="1" dataRefStart="d1" equivStart=""
dataRefEnd="d2" equivEnd="">lingonberries</pc> is quite tasty.</source>
 </segment>
</unit>

Note

To provide a user-friendly representation, use the dispEnd attribute.

4.3.1.18 equivStart

Equivalent text - holds a plain text representation of the original data of the start marker of an inline code that can be used when generating a plain text representation of the content.

Value description: Text.

Default value: an empty string

Used in: <pc>.

Example:

<unit id="1">
 <originalData>
  <data id="d1">&lt;span class="link" onclick="linkTo('dbId5345')"></data>
  <data id="d2">&lt;/span></data>
 </originalData>
 <segment>
  <source>The jam made of <pc id="1" dataRefStart="d1" equivStart=""
dataRefEnd="d2" equivEnd="">lingonberries</pc> is quite tasty.</source>
 </segment>
</unit>

Note

To provide a user-friendly representation, use the dispStart attribute.

4.3.1.19 hex

Hexadecimal code point - holds the value of a Unicode code point that is invalid in XML.

Value description: A canonical representation of the hexBinary [XML Schema Datatypes] data type: Two hexadecimal digits to represent each octet of the Unicode code point. The allowed values are any of the values representing code points invalid in XML, between hexadecimal 0000 and 10FFFF (both included).

Default value: undefined

Used in: <cp>.

Example:

<cp hex="001A"/><cp hex="0003"/>

The example above shows a character U+001A and a character U+0003 as they have to be represented in XLIFF.

4.3.1.20 href

href - a pointer to the location of an external skeleton file pertaining to the enclosing <file> element..

Value description: IRI.

Default value: undefined

Used in: <skeleton>.

4.3.1.21 id

Identifier - a character string used to identify an element.

Value description: NMTOKEN. The scope of the values for this attribute depends on the element, in which it is used.

  • When used in a <file> element:

    The value MUST be unique among all <file> id attribute values within the enclosing <xliff> element.

  • When used in <group> elements:

    The value MUST be unique among all <group> id attribute values within the enclosing <file> element.

  • When used in <unit> elements:

    The value MUST be unique among all <unit> id attribute values within the enclosing <file> element.

  • When used in <note> elements:

    The value MUST be unique among all <note> id attribute values within the immediate enclosing <file>, <group>, or <unit> element.

  • When used in <data> elements:

    The value MUST be unique among all <data> id attribute values within the enclosing <unit> element.

  • When used in <segment>, <ignorable>, <mrk>, <sm>, <pc>, <sc>, <ec>, or <ph> elements:

    • The inline elements enclosed by a <target> element MUST use the duplicate id values of their corresponding inline elements enclosed within the sibling <source> element if and only if those corresponding elements exist.

    • Except for the above exception, the value MUST be unique among all of the above within the enclosing <unit> element.

Default value: undefined

Used in: <file>, <group>, <unit>, <note>, <segment>, <ignorable>, <data>, <sc>, <ec>, <ph>, <pc>, <mrk> and <sm>.

4.3.1.22 isolated

Orphan code flag - indicates if the start or end marker of a spanning inline code is not in the same <unit> as its corresponding end or start code.

Value description: yes if this start or end code is not in the same <unit> as its corresponding end or start code, no if both codes are in the same <unit>.

Default value: no.

Used in: <sc>, <ec>.

Example:

   <file id="f2" xmlns:abc="urn:abc">
   <unit id="1">
     <mtc:matches>
       <mtc:match id="tc01" ref="seg2">
         <source><sc id="1" isolated="yes"/>Warning:</source>
         <target><sc id="1" isolated="yes"/>Attention :</target>
       </mtc:match>
     </mtc:matches>
     <segment id="seg2">
       <source><pc id="1">Warning: File not found.</pc></source>
     </segment>
   </unit>
 </file>

In the example above the <sc> elements have their isolated attribute set to yes because they do not have their corresponding <ec> elements.

4.3.1.23 name

Resource name - the original identifier of the resource corresponding to the Extracted <unit> or <group>.

For example: the key in the key/value pair in a Java properties file, the ID of a string in a Windows string table, the index value of an entry in a database table, etc.

Value description: Text.

Default value: undefined.

Used in: <unit> and <group>.

4.3.1.24 order

target order - indicates the order, in which to compose the target content parts.

Value description: A positive integer.

Default value: implicit, see below

When order is not explicitly set, the <target> order corresponds to its sibling <source>, i.e. it is not being moved anywhere when composing target content of the enclosing <unit> and the implicit order value is of that position within the <unit>.

Used in: <target>.

Constraints

  • The value of the order attribute MUST be unique within the enclosing <unit> element.

  • The value of each of the order attributes used within a <unit> element MUST NOT be higher than N, where N is the number of all current <segment> and <ignorable> children of the said <unit> element.

See the Segments Order section for the normative usage description.

4.3.1.25 original

Original file - a pointer to the location of the original document from which the content of the enclosing <file> element is extracted.

Value description: IRI.

Default value: undefined

Used in: <file>.

4.3.1.26 priority

Priority - provides a way to prioritize notes.

Value description: Integer 1-10.

Default value: 1

Used in: <note>.

Note

Please note that 1 is the highest priority that can be interpreted as an alert, e.g. an [ITS] Localization Note of the type alert. The best practice is to use only one alert per an annotated element, and the full scale of 2-10 can be used for prioritizing notes of lesser importance than the alert.

4.3.1.27 ref

Reference - holds a reference for the associated annotation.

Value description: A value of the [XML Schema Datatypes] type anyURI. The semantics of the value depends on the type of annotation:

Default value: undefined

Used in: <mrk> or <sm>.

Example:

<unit id="1">
 <segment>
  <source>The <pc id="1">ref</pc> attribute of a term
annotation holds a <mrk id="m1" type="term"
ref="http://dbpedia.org/page/Uniform_Resource_Identifier">URI</mrk>
pointing to more information about the given term.</source>
 </segment>
</unit>
4.3.1.28 srcDir

Source directionality - indicates the directionality of the source content.

Value description: ltr (Left-To-Right), rtl (Right-To-Left), , or auto (determined heuristically, based on the first strong directional character in scope, see [UAX #9]).

Default value: default values for this attribute depend on the element in which it is used:

  • When used in <file>:

    The value auto.

  • When used in any other element:

    The value of the srcDir attribute of its parent element.

Used in: <file>, <group>, and <unit>.

4.3.1.29 srcLang

Source language - the code of the language, in which the text to be Translated is expressed.

Value description: A language code as described in [BCP 47].

Default value: undefined

Used in: <xliff>.

4.3.1.30 startRef

Start code or marker reference - The id of the <sc> element or the <sm> element a given <ec> element or <em> element corresponds.

Value description: NMTOKEN.

Default value: undefined

Used in: <ec>, <em>.

Example:

<unit id="1">
 <segment>
  <source><sc id="1"/>Bold, <sc id="2"/>both<ec startRef="1"/>,
italics<ec startRef="2"/></source>
 </segment>
</unit>
4.3.1.31 state

State - indicates the state of the translation of a segment.

Value description: The value MUST be set to one of the following values:

initial - indicates the segment is in its initial state.
translated - indicates the segment has been translated.
reviewed - indicates the segment has been reviewed.
final - indicates the segment is finalized and ready to be used.

One can further specify the state of the Translation using the subState attribute.

Default value: initial

Used in: <segment>

Processing Requirements

  • Writers updating the attribute state MUST also update or delete subState.

4.3.1.32 subFlows

Sub-flows list - holds a list of id attributes corresponding to the <unit> elements that contain the sub-flows for a given inline code.

Value description: A list of NMTOKEN values separated by spaces. Each value corresponds to the id attribute of a <unit> element.

Default value: undefined

Used in: <ph>, <sc>, <ec>.

Example:

See the example in the Sub-Flows section.

4.3.1.33 subFlowsEnd

Sub-flows list - holds a list of id attributes corresponding to the <unit> elements that contain the sub-flows for the end marker of a given inline code.

Value description: A list of NMTOKEN values separated by spaces. Each value corresponds to the id attribute of a <unit> element.

Default value: undefined

Used in: <pc>.

Example:

See the example in the Sub-Flows section.

4.3.1.34 subFlowsStart

Sub-flows list - holds a list of id attributes corresponding to the <unit> elements that contain the sub-flows for the start marker of a given inline code.

Value description: A list of NMTOKEN values separated by spaces. Each value corresponds to the id attribute of a <unit> element.

Default value: undefined

Used in: <pc>.

Example:

See the example in the Sub-Flows section.

4.3.1.35 subState

subState - indicates a user-defined status for the <segment> element.

Value description:

The value is composed of a prefix and a sub-value separated by a character : (U+003A).

The prefix is a string uniquely identifying a collection of values for a specific authority. The sub-value is any string value defined by an authority.

The prefix xlf is reserved for this specification.

Other prefixes and sub-values MAY be defined by the users.

Default value: undefined

Used in: <segment>

Constraints

  • If the attribute subState is used, the attribute state MUST be explicitly set.

Processing Requirements

  • Writers updating the attribute state MUST also update or delete subState.

4.3.1.36 subType

subType - indicates the secondary level type of an inline code.

Value description:

The value is composed of a prefix and a sub-value separated by a character : (U+003A).

The prefix is a string uniquely identifying a collection of sub-values for a specific authority. The sub-value is any string value defined by the authority.

The prefix xlf is reserved for this specification, and the following sub-values are defined:

xlf:lb - Line break
xlf:pb - Page break
xlf:b - Bold
xlf:i - Italics
xlf:u - Underlined
xlf:var - Variable

Other prefixes and sub-values MAY be defined by the users.

Default value: undefined

Used in: <pc>, <sc>, <ec> and <ph>

Constraints

  • If the attribute subType is used, the attribute type MUST be specified as well.

  • The reserved xlf: prefixed values map onto the type attribute values as follows:

    For xlf:b, xlf:i, xlf:u, xlf:lb, and xlf:pb, the REQUIRED value of the type attribute is fmt.
    For xlf:var, the REQUIRED value of the type attribute is ui.

Processing Requirements

  • Modifiers updating the attribute type MUST also update or delete subType.

4.3.1.37 trgLang

Target language - the code of the language, in which the Translated text is expressed.

Value description: A language code as described in [BCP 47].

Default value: undefined

Used in: <xliff>.

4.3.1.38 translate

Translate - indicates whether or not the source text in the scope of the given translate flag is intended for Translation.

Value description: yes or no.

Default value: default values for this attribute depend on the element in which it is used:

  • When used in <file>:

    The value yes.

  • When used in any other admissible structural element (<group> or <unit>):

    The value of the translate attribute of its parent element.

  • When used in annotations markers <mrk> or <sm>:

    The value of the translate attribute of the innermost <mrk> or <unit> element, in which the marker in question is located.

Used in: <file> <group> <unit>, <mrk> and <sm>.

4.3.1.39 trgDir

Target directionality - indicates the directionality of the target content.

Value description: ltr (Left-To-Right), rtl (Right-To-Left), or auto (determined heuristically, based on the first strong directional character in scope, see [UAX #9]).

Default value: default values for this attribute depend on the element in which it is used:

  • When used in <file>:

    The value auto.

  • When used in any other element:

    The value of the trgDir attribute of its parent element.

Used in: <file>, <group>, and <unit>.

4.3.1.40 type

Type - indicates the type of an element.

Value description: allowed values for this attribute depend on the element in which it is used.

  • When used in <pc> , <sc> , <ec> or <ph> :

    The value MUST be set to one of the following values:

    fmt - Formatting (e.g. a <b> element in HTML)
    ui - User interface element
    quote - Inline quotation (as opposed to a block citation)
    link - Link (e.g. an <a> element in HTML)
    image - Image or graphic
    other - Type of element not covered by any of the other top-level types.

    Example:

    <segment>
    <source xml:lang="cs" <pc type="quote">Blázen, chce dobýt točnu v takovém
    počasí</pc>, dodal slovy svého oblíbeného imaginárního autora.</source>
    <target xml:lang="en"><pc type="quote">Madman, he wants to conquer the
    pole in this weather</pc>, offered he the words of his favourite
    imaginary playwright.</source>
    </segment>

    One can further specify the type of a code using the subType attribute.

    Default value: Undefined

  • When used in <mrk> or <sm> :

    One of the following values: generic, comment, term, or a user-defined value that is composed of a prefix and a sub-value separated by a character : (U+003A).

    The prefix is a string uniquely identifying a collection of sub-values for a specific authority. The sub-value is any string value defined by the authority.

    Default value: generic

  • When used in <group> or <unit> :

    A value that is composed of a prefix and a sub-value separated by a character : (U+003A).

    The prefix is a string uniquely identifying a collection of sub-values for a specific authority. The sub-value is any string value defined by the authority. The prefix xlf is reserved.

    Default value: Undefined

Used in: <group> , <unit> , <pc> , <sc> , <ec> , <mrk> , <ph> and <sm> .

Processing Requirements

4.3.1.41 value

Value - holds a value for the associated annotation.

Value description: Text.

Default value: undefined

Used in: <mrk> and <sm>.

4.3.1.42 version

XLIFF Version - is used to specify the Version of the XLIFF Document. This corresponds to the Version number of the XLIFF specification that the XLIFF Document adheres to.

Value description: Text.

Default value: undefined

Used in: <xliff>.

4.3.2 XML namespace

The attributes from XML namespace used in XLIFF 2.0 are: xml:lang and xml:space.

4.3.2.1 xml:lang

Language - the xml:lang attribute specifies the language variant of the text of a given element. For example: xml:lang="fr-FR" indicates the French language as spoken in France.

Value description: A language code as described in [BCP 47].

Default value: default values for this attribute depend on the element in which it is used:

  • When used in a <source> element:

    The value set in the srcLang attribute of the enclosing <xliff> element.

  • When used in a <target> element:

    The value set in the trgLang attribute of the enclosing <xliff> element.

  • When used in any other element:

    The value of the xml:lang attribute of its parent element.

Used in: <source>, <target> and where extension attributes are allowed.

4.3.2.2 xml:space

White spaces - the xml:space attribute specifies how white spaces (ASCII spaces, tabs and line-breaks) are to be treated.

Value description: default or preserve. The value default signals that an application's default white-space processing modes are acceptable for this element; the value preserve indicates the intent that applications preserve all the white space. This declared intent is considered to apply to all elements within the content of the element where it is specified, unless overridden with another instance of the xml:space attribute. For more information see the section on xml:space in the [XML] specification.

Default value: default values for this attribute depend on the element in which it is used:

  • When used in <data>:

    The value preserve.

  • When used in <xliff>:

    The value default.

  • When used in any other element:

    The value of the xml:space attribute of its parent element.

Used in: <xliff>, <file>, <group>, <unit>, <source>, <target>, and <data>.

4.4 CDATA sections

CDATA sections (<![CDATA[...]]>) are allowed in XLIFF content, but on output they MAY be changed into normal escaped content.

Note that avoiding CDATA sections is considered a best practice from the internationalization viewpoint [XML I18N BP].

Processing Requirements

  • Agents MUST process CDATA sections.

  • Writers MAY preserve the original CDATA sections.

4.5 XML Comments

XML comments (<!--...--!>) are allowed in XLIFF content, but they are ignored in the parsed content.

For example:

<source>Text content <!--IMPORTANT-->that is important</source>

and

<source>Text content that is important</source>

are identical after parsing and correspond to the same following parsed content:

Text content that is important

To annotate a section of the content with a comment that is recognized and preserved by XLIFF user agents, use the <note> element, or the <mrk> element.

Processing Requirements

  • Agents MUST ignore XML comments. That is the XLIFF parsed content is the same whether or not there is an XML comment in the document.

  • Writers MAY preserve XML comments on output.

4.6 XML Processing Instructions

XML Processing Instructions [XML] (see specifically http://www.w3.org/TR/REC-xml/#sec-pi) are an XML mechanism to "allow documents to contain instructions for applications." XML Processing Instructions are allowed in XLIFF content but they are ignored in the parsed content in the same sense as XML Comments.

Processing Requirements

  • Agents MUST NOT use Processing Instructions as a means to implement a feature already specified in XLIFF Core or Modules.

  • Writers SHOULD preserve XML Processing Instructions in an XLIFF Document.

Warning

Please note that Agents using Processing Instructions to implement XLIFF Core or Module features are not compliant XLIFF applications disregarding whether they are otherwise conformant.

Warning

Although this specification encourages XLIFF Agents to preserve XML Processing Instructions, it is not and cannot be, for valid processing reasons, an absolute protection and it is for instance highly unlikely that Processing Instructions could survive an XLIFF roundtrip at the <segment> level or lower. Hence implementers are discouraged from using XML Processing Instructions at the <segment> and lower levels.

4.7 Inline Content

The XLIFF inline content defines how to encode the content Extracted from the original source. The content includes the following types of data:

  • Text -- Textual content.

  • Inline codes -- Sequences of content that are not linguistic text, such as formatting codes, variable placeholders, etc.

    For example: the element <b> in HTML, or the placeholder {0} in a Java string.

  • Annotations -- Markers that delimit a span of the content and carry or point to information about the specified content.

    For example: a flag indicating that a given section of text is not intended for translation, or an element indicating that a given expression in the text is a term associated with a definition.

There are two elements that contain inline markup in XLIFF: <source> and <target>.

In some cases, data directly associated with inline elements MAY also be stored at the <unit> level in an <originalData> element.

4.7.1 Text

The XLIFF inline markup does not prescribe how to represent normal text, besides that it MUST be valid XML.

4.7.1.1 Characters invalid in XML

Because the content represented in XLIFF can be extracted from anywhere, including software resources and other material that can contain control characters, XLIFF needs to be able to represent all Unicode code points [Unicode].

However, XML does not have the capability to represent all Unicode code points [Unicode], and does not provide any official mechanism to escape the forbidden code points.

To remedy this, the inline markup provides the <cp> element.

The syntax and semantic of <cp> in XLIFF are similar to the ones of <cp> in the Unicode Locale Data Markup Language [LDML].

4.7.2 Inline Codes

The specification takes into account two types of codes:

Original code

An original code is a code that exists in the original document being extracted into XLIFF.

Added code

An added code is a code that does not exist in the original document, but has been added to the content at some point after extraction.

Any code (original or added) belongs to one of the two following categories:

Standalone

A standalone code is a code that corresponds to a single position in the content. An example of such code is the <br/> element in HTML.

Spanning

A spanning code is a code that encloses a section of the content using a start and an end marker. There are two kinds of spanning codes:

  • Codes that can overlap, that is: they can enclose a non-closing or a non-opening spanning code. Such codes do not have an XML-like behavior. For example the RTF code \b1...\b0 is a spanning code that is allowed to overlap.

  • Codes that cannot overlap, that is: they cannot enclose a partial spanning code and have an XML-like behavior at the same time. An example of such code is the <emphasis>...</emphasis> element in DocBook.

When the opening or closing marker of a spanning code does not have its corresponding closing or opening marker in the same unit, it is an orphan code.

4.7.2.1 Representation of the codes

Spanning codes present a set of challenges in XLIFF:

First, because the code format of the original data extracted to XLIFF does not need to be XML, spanning codes can overlap.

For example, in the following RTF content, the format markers are in a sequence: start bold, start italics, end bold, end italics. This does not translate into a well-formed mapping.

Text in \b bold \i and\b0  italics\i0

Another challenge is the possible effect of segmentation: A spanning code can start in one segment and end in another.

For example, in the following HTML content, the segmentation splits the text independently of the codes so the starting and ending tags of the <B>...</B> element end up in different parts of the <unit> element:

[Sentence <B>one. ][Sentence two.][ ][Sentence</B> three.]

Finally, a third potential cause of complication is that the start or the end markers of a spanning code can become orphans if their segment is used outside of its original <unit>.

For example, an entry with bold text can be broken down into two segments:

Segment 1 = "<b>Warning found: "
Segment 2 = "The file is read-only</b>"

And later, one of the segments can be re-used outside its original <unit>, for instance as a translation candidate:

New segment = "<b>Warning found - see log</b>"
Fuzzy match = "<b>Warning found: "

Because of these use cases, the representation of a spanning code cannot always be mapped to a similar spanning element in XLIFF.

When taking into account these issues, the possible use cases and their corresponding XLIFF representations are as follow:

Table 1. Inline code use cases

Use CaseExample of Representation
Standalone code<ph id='1'/>
Well-formed spanning code<pc id='1'>text</pc>
Start marker of spanning code<sc id='1'/>
End marker of spanning code<ec startRef='1'/>
Orphan start marker of spanning code<sc id='1' isolated='yes'/>
Orphan end marker of spanning code<ec id='1' isolated='yes'/>
4.7.2.2 Usage of <pc> and <sc>/<ec>

A spanning code MUST be represented using a <sc> element and a <ec> element if the code is not well-formed or orphan.

For example, the following RTF content has two spans of formatting:

Text in \b bold \i and\b0  italics\i0

They can only be represented using two pairs of <sc> and <ec> elements:

<unit id="1">
 <originalData>
  <data id="d1">\b </data>
  <data id="d2">\i </data>
  <data id="d3">\b0 </data>
  <data id="d4">\i0 </data>
 </originalData>
 <segment>
  <source>Text in <sc id="1" dataRef="d1"/>bold <sc id="2" dataRef="d2"/>
and<ec startRef="1" dataRef="d3"/> italics<ec startRef="2" dataRef="d4"/>.
  </source>
 </segment>
</unit>

If the spanning code is well-formed it MAY be represented using either a single <pc> element or using a pair of <sc> and a <ec> elements.

For example, the following RTF content has a single span of formatting:

Text in \b bold\b0 .

It can be represented using either notations:

Text in <pc id="1" canOverlap="yes" dataRefStart="c1" dataRefEnd="c2">
bold</pc>.
Text in <sc id="1" dataRef="c1"/>bold<ec startRef="1" dataRef="c2"/>.

Processing Requirements

  • When both the <pc> and the <sc>/<ec> representations are possible, Extractors and Modifiers MAY use either one as long as all the information of the inline code (e.g. original data, sub-flow indicators, etc.) are preserved.

  • When converting representation between a pair of <sc> and <ec> elements and a <pc> element or vice-versa, Modifiers MUST map their attributes as shown in the following table:

    Table 2. Mapping between attributes

    <pc> attributes<sc> attributes<ec> attributes
    ididstartRef / id (see <ec>)
    typetypetype
    subTypesubTypesubType
    dispStartdisp 
    dispEnd disp
    equivStartequiv 
    equivEnd equiv
    subFlowsStartsubFlows 
    subFlowsEnd subFlows
    dataRefStartdataRef 
    dataRefEnd dataRef
     isolatedisolated
    canCopycanCopycanCopy
    canDeletecanDeletecanDelete
    canReordercanReordercanReorder
    copyOfcopyOfcopyOf
    canOverlapcanOverlapcanOverlap
    dirdirdir
  • Agents MUST be able to handle any of the above two types of inline code representation.

4.7.2.3 Storage of the original data

Most of the time, inline codes correspond to an original construct in the format from which the content was extracted. This is the original data.

XLIFF tries to abstract and normalize as much as possible the extracted content because this allows a better re-use of the material across projects. Some tools require access to the original data in order to create the translated document back into its original format. Others do not.

4.7.2.3.1 No storage of the original data

In this option, the original data of the inline code is not preserved inside the XLIFF document.

The tool that created the initial XLIFF document is responsible for providing a way to re-create the original format properly when merging back the content.

For example, for the following HTML content:

This <B>naked mole rat</B> is <B>pretty ugly</B>.

one possible XLIFF representation is the following:

<unit id="1">
 <segment>
  <source>This <pc id="1">naked mole rat</pc>
is <pc id="2">pretty ugly</pc>.</source>
  <target>Cet <pc id="1">hétérocéphale</pc>
est <pc id="2">plutôt laid</pc>.</target>
 </segment>
</unit>
4.7.2.3.2 Storage of the original data

In this option, the original data of the inline code is stored in a structure that resides outside the content (i.e. outside <source> or <target>) but still inside the <unit> element.

The structure is an element <originalData> that contains a list of <data> entries uniquely identified within the <unit> by an id attribute. In the content, each inline code using this mechanism includes a dataRef attribute that points to a <data> element where its corresponding original data is stored.

For example, for the following HTML content:

This <B>naked mole rat</B> is <B>pretty ugly</B>.

The following XLIFF representation stores the original data:

<unit id="1">
 <originalData>
  <data id="d1">&lt;B></data>
  <data id="d2">&lt;/B></data>
 </originalData>
 <segment>
  <source>This <pc id="1" dataRefStart="d1" dataRefEnd="d2">
    naked mole rat</pc> is <pc id="2" dataRefStart="d1" dataRefEnd="d2">
    pretty ugly</pc>.</source>
  <target>Cet <pc id="1" dataRefStart="d1" dataRefEnd="d2">
    hétérocéphale</pc> est <pc id="2" dataRefStart="d1" dataRefEnd="d2">
    plutôt laid</pc>.</target>
 </segment>
</unit>

Note

This mechanism allows to re-use identical original data by pointing to the same <data> element.

4.7.2.4 Adding Codes

When processing content, there are possible cases when new inline codes need to be added.

For example, in the following HTML help content, the text has the name of a button in bold:

Press the <b>Emergency Stop</b> button
to interrupt the count-down sequence.

In the translated version, the original label needs to remain in English because the user interface, unlike the help, is not translated. However, for convenience, a translation is also provided and emphasized using another style. That new formatting needs to be added:

Appuyez sur le bouton <b>Emergency Stop</b> (<i>Arrêt d'urgence</i>)
pour interrompre le compte à rebours.

Having to split a single formatted span of text into several separate parts during translation, can serve as another example. For instance, the following sentence in Swedish uses bold on the names of two animals:

Äter <b>katter möss</b>?

But the English translation separates the two names and therefore needs to duplicate the bold codes.

Do <b>cats</b> eat <b>mice</b>?

Processing Requirements

  • Modifiers MAY add inline codes.

  • The id value of the added code MUST be different from all id values in both source and target content of the unit where the new code is added.

  • Mergers MAY ignore added inline codes when Merging the Translated content back into the original format.

There are several ways to add codes:

4.7.2.4.1 Duplicating an existing code

One way to create a new code is to duplicate an existing one (called the base code).

If the base code is associated with some original data: the new code simply uses the same data.

For example, the translation in the following unit, the second inline code is a duplicate of the first one:

<unit id="1">
 <originalData>
  <data id="d1">&lt;b></data>
  <data id="d2">&lt;/b></data>
 </originalData>
 <segment>
  <source>Äter <pc id="1" dataRefStart="d1" dataRefEnd="d2">katter
möss</pc>?</source>
  <target>Do <pc id="1" dataRefStart="d1" dataRefEnd="d2">cats</pc>
eat <pc id="2" dataRefStart="d1" dataRefEnd="d2">mice</pc>?</target>
 </segment>
</unit>

If the base code has no associated data, the new code MUST use the copyOf attribute to indicate the id of the base code. This allows the merging tool to know what original data to re-use.

For example, the translation in the following unit, the second inline code is a duplicate of the first one:

<unit id="1">
 <segment>
  <source>Esznek <pc id="1">a magyarok svéd húsgombócot</pc>?</source>
  <target>Do <pc id="1">Hungarians</pc> eat 
<pc id="2" copyOf="1">Swedish meatballs</pc>?</target>
 </segment>
</unit>

Processing Requirements

  • Modifiers MUST NOT clone a code that has its canCopy attribute is set to no.

  • The copyOf attribute MUST be used when, and only when, the base code has no associated original data.

4.7.2.4.2 Creating a brand-new code

Another way to add a code is to create it from scratch. For example, this can happen when the translated text requires additional formatting.

For example, in the following unit, the UI text needs to stay in English, and is also translated into French as a hint for the French user. The French translation for the UI text is formatted in italics:

<unit id="1">
 <originalData>
  <data id="d1">&lt;b></data>
  <data id="d2">&lt;/b></data>
  <data id="n1">&lt;i></data>
  <data id="n2">&lt;/i></data>
 </originalData>
 <segment>
  <source>Press the <pc id="1" dataRefStart="d1" dataRefEnd="d2">
    Emergency Stop</pc> button to interrupt the count-down sequence.
  </source>
  <target>Appuyez sur le bouton
    <pc id="1" dataRefStart="d1" dataRefEnd="d2">Emergency Stop</pc>
    (<pc id="2" dataRefStart="n1" dataRefEnd="n2">Arrêt d'urgence</pc>)
    pour interrompre le compte à rebours.
  </target>
 </segment>
</unit>
4.7.2.4.3 Converting text into a code

Another way to add a code is to convert part of the extracted text into code. In some cases the inline code can be created after extraction, using part of the text content. This can be done, for instance, to get better matches from an existing TM, or better candidates from an MT system.

For example, it can happen that a tool extracting a Java properties file to XLIFF is not sophisticated enough to treat HTML or XML snippets inside the extracted text as inline code:

# text property for the widget 'next'
nextText: Click <ui>Next</ui>

Resulting XLIFF content:

<unit id="1">
 <segment>
  <source>Click &lt;ui>Next&lt;/ui></source>
 </segment>
</unit>

But another tool, later in the process, can be used to process the initial XLIFF document and detect additional inline codes. For instance here the XML elements such as <ui>.

The original data of the new code is the part of the text content that is converted as inline code.

<unit id="1">
 <originalData>
  <data id="d1">&lt;ui></data>
  <data id="d2">&lt;/ui></data>
 </originalData>
 <segment>
  <source>Click <pc id="1" dataRefStart="d1" dataRefEnd="d2">Next</pc>
  </source>
 </segment>
</unit>

Warning

Converting XLIFF text content into original data for inline code might need a tool-specific process as the tool which did the initial extraction could have applied some conversion to the original content to create the XLIFF content (e.g. un-escape special characters).

4.7.2.5 Removing Codes

When processing content, there are some possible cases when existing inline codes need to be removed.

For an example the translation of a sentence can result in grouping of several formatted parts into a single one. For instance, the following sentence in English uses bold on the names of two animals:

Do <b>cats</b> eat <b>mice</b>?

But the Swedish translation group the two names and therefore needs only a single bolded part.

Äter <b>katter möss</b>?

Processing Requirements

  • User agents MAY remove a given inline code only if its canDelete attribute is set to yes.

  • When removing a given inline code, the user agents MUST remove its associated original data, except if the original data is shared with another inline code that remains in the unit.

    Note that having to delete the original data is unlikely because such original data is likely to be associated to an inline code in the source content.

There are several ways to remove codes:

4.7.2.5.1 Deleting a code

One way to remove a code is to delete it from the extracted content. For example, in the following unit, the translated text does not use the italics formatting. It is removed from the target content, but the original data are preserved because they are still used in the source content.

<unit id="1">
 <originalData>
  <data id="d1">&lt;i></data>
  <data id="d2">&lt;/i></data>
 </originalData>
 <segment>
  <source>I read <pc id="1" dataRefStart="d1" dataRefEnd="d2">Little
House on the Prairie</pc> to my children.</source>
  <target>子供に「大草原の小さな家」を読みました。</target>
 </segment>
</unit>
4.7.2.5.2 Converting a code into text

Another way to remove an inline code is to convert it into text content. This is likely to be a rare use case. It is equivalent to deleting the code, with the addition to place the original data for the given code into the content, as text. This can be done, for example, to get better matches from an existing TM, or better candidates from an MT system.

For instance, the following unit has an inline code corresponding to a variable place-holder. A tool can temporarily treat this variable as text to get better matches from an existing TM.

<unit id="1">
 <originalData>
  <data id="d1">%s</data>
 </originalData>
 <segment>
  <source>Cannot find '<ph id="1" dataRef="d1"/>'.</source>
 </segment>
</unit>

The modified unit would end up like as shown below. Note that because the original data was not associated with other inline code it has been removed from the unit:

<unit id="1">
 <segment>
  <source>Cannot find '%s'.</source>
 </segment>
</unit>

Warning

Converting the original data of an inline code into text content might need a tool-specific process as the tool which did the initial extraction could have applied some conversion to the original content.

4.7.2.6 Editing Hints

XLIFF provides some information about what editing operations are applicable to inline codes:

  • A code can be deleted: That is, the code element as well as its original data (if any are attached) are removed from the document. This hint is represented with the canDelete attribute. The default value is yes: deletion is allowed.

    For example, the following extracted C string has the code <ph id='1'/> set to be not deletable because removing the original data (the variable placeholder %s) from the string would result in an error when running the application:

  • A code can be copied: That is, the code is used as a base code for adding another inline code. See Section 4.7.2.4.1, “Duplicating an existing code” for more details. This hint is represented with the canCopy attribute. The default value is yes: copy is allowed.

  • A code can be re-ordered: That is, a given code can be moved before or after another inline code. This hint is represented with the canReorder attribute. The default value is yes: re-ordering is allowed.

Note

Please note that often those properties are related and appear together. For example, the code in the first unit shown below is a variable placeholder that has to be preserved and cannot be duplicated, and when several of such variables are present, as in the second unit, they cannot be re-ordered:

<unit id="1">
 <originalData>
  <data id="d1">%s</data>
 </originalData>
 <segment>
  <source>Can't open '<ph id="1" dataRef="d1" canCopy="no"
      canDelete="no"/>'.</source>
 </segment>
</unit>
<unit id="2">
 <originalData>
  <data id="d1">%s</data>
  <data id="d2">%d</data>
 </originalData>
 <segment>
  <source>Number of <ph id="1" dataRef="d1" canCopy="no" canDelete="no"
    canReorder="firstNo"/>: 
    <ph id="2" dataRef="d2" canCopy="no" canDelete="no" canReorder="no"/>.
  </source>
 </segment>
</unit>

See the Target Content Modification section for additional details on editing.

Constraints

  • When the attribute canReorder is set to no or firstNo, the attributes canCopy and canDelete MUST also be set to no.

  • Inline codes re-ordering within a source or target content MAY be limited by defining non-reorderable sequences. Such sequence is made of a first inline code with the attribute canReorder set to firstNo and zero or more following codes with canReorder set to no.

    Note

    A non-reorderable sequence made of a single code with canReorder set to firstNo are allowed just for Extraction convenience and are equivalent to a code with the attribute canReorder set to yes.

Processing Requirements

  • Extractors SHOULD set the canDelete, canCopy and canReorder attributes for the codes that need to be treated differently than with the default settings.

  • The number and order of the inline codes making up a non-reorderable sequence MUST NOT be changed.

  • A whole non-reorderable sequence MAY be moved before or after another non-reorderable sequence.

  • When a non-reorderable sequence is made of a single non-reorderable code, Modifiers MAY remove the canReorder attribute of that code or change its value to yes.

  • Modifiers MUST NOT delete inline codes that have their attribute canDelete set to no.

  • Modifiers MUST NOT replicate inline codes that have their attribute canCopy set to no.

4.7.3 Annotations

An annotation is an element that associates a section of the content with some metadata information.

Annotations MAY be created by an Extractor that generated the initial XLIFF Document, or by any other Modifier or Enricher later in the process. For example, after an Extractor creates the document, an Enricher can annotate the source content with terminological information.

Annotations are represented using either the <mrk> element, or the pair of <sm> and <em> elements.

4.7.3.1 Type of Annotations

There are several pre-defined types of annotation and definition of custom types is also allowed.

4.7.3.1.1 Translate Annotation

This annotation is used to indicate whether a span of content is translatable or not.

Usage:

  • The id attribute is REQUIRED

  • The translate attribute is REQUIRED and set to yes or no

  • The type attribute is OPTIONAL and set to generic (this is the default value)

For example:

He saw his <mrk id="m1" translate="no">doppelgänger</mrk>.

Note

This annotation overrides the translate attribute set or inherited at the <unit> level.

Note

The translate attribute can also be used at the same time as another type of annotation. For example:

He saw his <mrk id="m1" translate="no" type="term">doppelgänger
</mrk>.
4.7.3.1.2 Term Annotation

This annotation is used to mark up a term in the content, and possibly associate information to it.

Usage:

  • The id attribute is REQUIRED

  • The type attribute is REQUIRED and set to term

  • The value attribute is OPTIONAL and contains a short definition of the term

  • The ref attribute is OPTIONAL and contains a URI pointing to information on the term

  • The translate attribute is OPTIONAL and set to yes or no

For example:

  <file id="f-t_a">
   <unit id="1">
     <segment>
       <source>He is my <mrk id="m1" type="term"
           ref="http://dbpedia.org/page/Doppelgänger">doppelgänger</mrk>.
       </source>
     </segment>
   </unit>
 </file>
        
4.7.3.1.3 Comment Annotation

This annotation is used to associate a span of content with a comment.

Usage:

  • The id attribute is REQUIRED

  • The type attribute is REQUIRED and set to comment

  • If the value attribute is present it contains the text of the comment. If and only if the value attribute is not present, the ref attribute MUST be present and contain the URI of a <note> element within the same enclosing <unit> element that holds the comment.

  • The translate attribute is OPTIONAL and set to yes or no

For example, here with the value attribute:

The <mrk id="m1" type="comment"
 value="Possible values: Printer or Stacker"><ph id="1" dataRef="d1"/>
</mrk>
has been enabled.

And here using the ref attribute:

<unit id="1">
 <notes>
  <note id="n1" appliesTo="target">Please check the 
translation for 'namespace'. One also can use 'espace de nom',
but I think most technical manuals use the English
term.</note>
 </notes>
 <segment>
  <source>You use your own namespace.</source>
  <target>Vous pouvez utiliser votre propre <mrk id="m1"
type="comment" ref="#n1">namespace</mrk>.</target>
 </segment>
</unit>
4.7.3.1.4 Custom Annotation

The <mrk> element can be used to implement custom annotations.

A custom annotation MUST NOT provide the same functionality as a pre-defined annotation.

Usage:

  • The id attribute is REQUIRED

  • The type attribute is REQUIRED and set to a unique user-defined value.

  • The translate attribute is OPTIONAL and set to yes or no

  • The use and semantics of the value and ref attributes are user-defined.

For example:

One of the earliest surviving works of literature is
<mrk id="m1" type="myCorp:isbn" value="978-0-14-44919-8">The 
Epic of Gilgamesh</mrk>.
4.7.3.2 Splitting Annotations

Annotations can overlap spanning inline codes or other annotations. They also can be split by segmentation. Because of this, a single annotation span can be represented using a pair of <sm> and <em> elements instead of a single <mrk> element.

For example, one can have the following content:

<unit id="1">
 <segment>
  <source>Sentence A. <mrk id="m1" type="comment" 
value="Comment for B and C">Sentence B. Sentence C.</mrk></source>
 </segment>
</unit>

After a user agent performs segmentation, the annotation element <mrk> is changed to a pair of <sm> and <em> elements:

<unit id="1">
 <segment>
  <source>Sentence A. </source>
 </segment>
 <segment>
  <source><sm id="m1" type="comment" 
value="Comment for B and C"/>Sentence B. </source>
 </segment>
 <segment>
  <source>Sentence C.<em startRef="m1"/></source>
 </segment>
</unit>

4.7.4 Sub-Flows

A sub-flow is a section of text embedded inside an inline code, or inside another section of text.

For example, the following HTML content includes two sub-flows: The first one is the value of the title attribute ("Start button"), and the second one is the value of the alt attribute ("Click here to start!"):

Click to start: <img title="Start button"
 src="btnStart.png" alt="Click here to start!"/>

Another example is the following DITA content where the footnote "A Palouse horse is the same as an Appaloosa." is defined at the middle of a sentence:

Palouse horses<fn>A Palouse horse is the same as
 an Appaloosa.</fn> have spotted coats.

In XLIFF, each sub-flow is stored in its own <unit> element, and the subFlows attribute is used to indicate the location of the embedded content.

Therefore the HTML content of the example above can be represented like below:

<unit id="1">
 <segment>
  <source>Start button</source>
 </segment>
</unit>
<unit id="2">
 <segment>
  <source>Click here to start!</source>
 </segment>
</unit>
<unit id="3">
 <segment>
  <source>Click to start: <ph id="1" subFlows="1 2"/></source>
 </segment>
</unit>

Constraints

  • An inline code containing or delimiting one or more sub-flows MUST have an attribute subFlows that holds a list of the identifiers of the <unit> elements where the sub-flows are stored.

  • Sub-flows MUST be in the same <file> element as the <unit> element from which they are referenced.

Processing Requirements

  • Extractors SHOULD store each sub-flow in its own <unit> element.

  • Extractors MAY order the <unit> elements of the sub-flows and the <unit> element, from where the sub-flows are referenced, as they see fit.

Note

Please note that the static structure encoded by <file>, <group>, and <unit> elements is principally immutable in XLIFF Documents and hence the unit order initially set by the Extractor will be preserved throughout the roundtrip even in the special case of sub-flows.

4.7.5 White Spaces

While white spaces can be significant or insignificant in the original format, they are always treated as significant when stored as original data in XLIFF. See the definition of the <data> element.

Processing Requirements

  • For the inline content and all non empty inline elements: The white spaces MUST be preserved if the value for xml:space set or inherited at the enclosing <unit> level is preserve, and they MAY be preserved if the value is default.

4.7.6 Bidirectional Text

Text directionality in XLIFF content is defined by inheritance. Source and target content can have different directionality.

The initial directionality for both the source and the target content is defined in the <file> element, using the OPTIONAL attributes srcDir for the source and trgDir for the target. The default value for both attributes is auto.

The <group> and <unit> elements also have the two OPTIONAL attributes srcDir and trgDir. The default value of the srcDir is inherited from the value of the srcDir attribute of the respective parent element. The default value of the trgDir attribute is inherited from the value of the trgDir attribute of the respective parent element.

The <pc>, <sc>, and isolated <ec> elements have an OPTIONAL attribute dir with a value ltr, rtl, or auto. The default value is inherited from the parent <pc> element. In case the inline element is a child of a <source> element, the default value is inherited from the srcDir value of the enclosing <unit> element. In case the inline element is a child of a <target> element, the default value is inherited from the trgDir value of the enclosing <unit> element.

Warning

While processing isolated <ec> elements with explicitly set directionality, please beware that unlike directionality set on the <pc> and <sc> , this method decreases the stack level as per [UAX #9].

In addition, the <data> element has an OPTIONAL attribute dir with a value ltr, rtl, or auto that is not inherited. The default value is auto.

Directionality of source and target text contained in the <source> and <target> elements is fully governed by [UAX #9], whereas explicit XLIFF-defined structural and directionality markup is a higher-level protocol in the sense of [UAX #9]. The XLIFF-defined value auto determines the directionality based on the first strong directional character in its scope and XLIFF-defined inline directionality markup behaves exactly as Explicit Directional Isolate Characters, see [UAX #9], http://www.unicode.org/reports/tr9/#Directional_Formatting_Characters.

Note

Please note that this specification does not define explicit markup for inline directional Overrides or Embeddings; in case those are needed. Extractors and Modifiers will need to use [UAX #9] defined Directional Formatting Characters.

4.7.7 Target Content Modification

This section defines the rules Writers need to follow when working with the target content of a given segment in order to provide interoperability throughout the whole process.

The Extractor MAY create the initial target content as it sees fit.

The Merger is assumed to have the same level of processing and native format knowledge as the Extractor. Providing an interoperable way to convert native documents into XLIFF with one tool and back to the native format with another tool without the same level of knowledge is outside the scope of this specification.

The Writers Modifying the target content of an XLIFF Document between the Extractor and the Merger ensure interoperability by applying specific rules. These rules are separated into two cases: When there is an existing target and when there is no existing target.

4.7.7.1 Without an Existing Target

When there is no existing target, the processing requirements for a given segment are the following:

Processing Requirements

  • Writers MAY leave the segment without a target.

  • Modifiers MAY create a new target as follows:

    • Modifiers MAY add translation of the source text.

    • Modifiers MUST put all non-removable inline codes in the target.

    • Modifiers MUST preserve the order of all the non-reorderable inline codes.

    • Modifiers MAY put any removable inline code in the target.

    • Modifiers MAY add inline codes.

    • Modifiers MAY add or remove annotations.

    • Modifiers MAY convert any <pc> element into a pair of <sc> and <ec> elements.

    • Modifiers MAY convert, if it is possible, any pair of <sc> and <ec> elements into a <pc> element.

4.7.7.2 With an Existing Target

When working with a segment with content already in the target, Writers MUST choose one of the three behaviors described below:

Processing Requirements

  • Writers MAY leave the existing target unchanged.

  • Modifiers MAY modify the existing target as follow:

    • Modifiers MAY add or Modify translatable text.

    • Writers MUST preserve all non-removable inline codes, regardless whether or not they exist in the source.

    • Writers MUST preserve any non-reorderable inline codes in the existing target.

    • Writers MUST NOT add any non-reorderable inline codes to the target.

    • Modifiers MAY remove any removable inline codes in the target.

    • Modifiers MAY add inline codes (including copying any cloneable inline codes of the existing target).

    • Modifiers MAY add or remove annotations.

    • Modifiers MAY convert any <pc> element into a pair of <sc> and <ec> elements.

    • Modifiers MAY convert, if it is possible, any pair of <sc> and <ec> elements into a <pc> element.

  • Modifiers MAY delete the existing target and start over as if working without an existing target.

4.7.8 Content Comparison

This specification defines two types of content equality:

  • Equality type A: Two contents are equal if their normalized forms are equal.

  • Equality type B: Two contents are equal if, in their normalized forms and with all inline code markers replaced by the value of their equiv attributes, the resulting strings are equal.

A content is normalized when:

  • The text nodes are in Unicode Normalized Form C defined in the Unicode Annex #15: Unicode Normalization Forms [UAX #15].

  • All annotation markers are removed.

  • All pairs of <sc> and <ec> elements that can be converted into a <pc> element, are converted.

  • All adjacent text nodes are merged into a single text node.

  • For all the text nodes with the white space property set to default, all adjacent white spaces are collapsed into a single space.

4.8 Segmentation

In the context of XLIFF, a segment is content which is either a unit of extracted text, or has been created from a unit of extracted text by means of a segmentation mechanism such as sentence boundary detection. For example, a segment can be a title, the text of a menu item, a paragraph or a sentence in a paragraph.

In the context of XLIFF, other types representations sometimes called "segmentation" can be represented using annotations. For example: the terms in a segment can be identified and marked up using the term annotation.

XLIFF does not specify how segmentation is carried out, only how to represent its result. Material provisions regarding segmentation can be found for instance in the Segmentation Rules eXchange standard [SRX] or [UAX #29].

4.8.1 Segments Representation

In XLIFF each segment of processed content is represented by a <segment> element.

A <unit> can comprise a single <segment>.

Each <segment> element has one <source> element that contains the source content and one OPTIONAL <target> element that can be empty or contain the translation of the source content at a given state.

Content parts between segments are represented with the <ignorable> element, which has the same content model as <segment>.

For example:

<unit id="1">
 <segment>
  <source>First sentence.</source>
  <target>Première phrase.</target>
 </segment>
 <ignorable>
  <source> </source>
 </ignorable>
 <segment>
  <source>Second sentence.</source>
 </segment>
</unit>

4.8.2 Segments Order

Some Agents (e.g. aligner tools) can segment content, so that the target segments are not in the same order as the source segments.

To be able to map order differences, the <target> element has an OPTIONAL order attribute that indicates its position in the sequence of segments (and inter-segments). Its value is an integer from 1 to N, where N is the sum of the numbers of the <segment> and <ignorable> elements within the given enclosing <unit> element.

Warning

When Writers set explicit order on <target> elements, they have to check for conflicts with implicit order, as <target> elements without explicit order correspond to their sibling <source> elements. Beware that moving one <target> element is likely to cause a renumbering domino effect throughout the enclosing <unit> element.

For example, the following HTML documents have the same paragraph with three sentences in different order:

<p lang='en'>Sentence A. Sentence B. Sentence C.</p>
<p lang='fr'>Phrase B. Phrase C. Phrase A.</p>

The XLIFF representation of the content, after segmentation and alignment, would be:

<unit id="1">
 <segment id="1">
  <source>Sentence A.</source>
  <target order="5">Phrase A.</target>
 </segment>
 <ignorable>
  <source> </source>
 </ignorable>
 <segment id="2">
  <source>Sentence B.</source>
  <target order="1">Phrase B.</target>
 </segment>
 <ignorable>
  <source> </source>
 </ignorable>
 <segment id="3">
  <source>Sentence C.</source>
  <target order="3">Phrase C.</target>
 </segment>
</unit>

4.8.3 Segmentation Modification

When Modifying segmentation of a <unit>, Modifiers MUST meet the Constraints and follow the Processing Requirements defined below:

Constraints

  • Integrity of the inline codes MUST be preserved. See the section on Inline Codes and on Annotations for details.

  • The entire source content of any one <unit> element MUST remain logically unchanged: <segment> elements or their data MUST NOT be moved or joined across units.

Warning

Note that when splitting or joining segments that have both source and target content it is advisable to keep the resulting segments linguistically aligned, which is likely to require human linguistic expertise and hence manual re-segmentation. If the linguistically correct alignment cannot be guaranteed, discarding the target content and retranslating the resulting source segments is worth considering.

Processing Requirements

  • When the Modifiers perform a split operation:

    • Only <segment> or <ignorable> elements that have their canResegment value resolved to yes MAY be split.

    • All new <segment> or <ignorable> elements created and their <source> and <target> children MUST have the same attribute values as the original elements they were created from, as applicable, except for the id attributes and, possibly, for the order, state and subState attributes.

    • Any new id attributes MUST follow the <segment> or <ignorable> id constraints.

    • If there was a target content in the original segment and if the state attribute of the original segment was not initial, the state attributes of the segments resulting from the split (and possibly their corresponding subState attributes) MAY be changed to reflect the fact that the target content MAY need to be verified as the new segmentation MAY have desynchronized the alignment between the source and target contents.

  • When the Modifiers perform a join operation:

  • When the Modifiers or Mergers perform a join operation:

    • Two elements (<segment> or <ignorable>) MUST NOT be joined if their <target> have resolved order values that are not consecutive.

    • The attributes of the elements to be joined (<segment> or <ignorable>) and the attributes of their <source> and <target> MUST be carried over in the resulting joined elements.

    • If attributes of elements to be joined (<segment> or <ignorable>) differ, or if the attributes of their <source> or <target> differ, the resulting joined elements MUST comply with following rules:

      • If the state attributes of the <segment> elements differ: the state attribute of the joined <segment> MUST be set to the "earliest" of the values specified in the original <segment> elements. The sequence of state values are defined in the following order: 1: initial, 2: translated, 3: reviewed, and 4: final.

      • The subState attribute MUST be the one associated with the state attribute selected to be used in the joined <segment>. If no subState attribute is associated with that state, the joined <segment> MUST NOT have a subState.

      • If the xml:space attributes differ: The <source> and <target> of the joined element MUST be set to xml:space="preserve".

  • When the Modifiers or Mergers perform a join or a split operation:

4.9 Extension Mechanisms

XLIFF 2.0 offers two mechanisms for storing custom data in an XLIFF document:

  1. Using the Metadata module for storing custom data in elements defined by the official XLIFF specification.

  2. Using the standard XML namespace mechanism for storing data in elements or attributes defined in a custom XML Schema.

Both mechanisms can be used simultaneously.

4.9.1 Extension Points

The following XLIFF Core elements allow storing custom data in <mda:metadata> elements or in elements from a custom XML namespace:

- <file>
- <group>
- <unit>

The following XLIFF Core elements accept custom attributes:

- <xliff>
- <file>
- <group>
- <unit>
- <note>
- <mrk>
- <sm>
4.9.1.1 Extensibility of XLIFF Modules

For extensibility of XLIFF Modules please refer to the relevant Module Sections.

4.9.2 Constraints

  • When using identifiers, an extension MUST use either an attribute named id or the attribute xml:id to specify them.

  • Extensions identifiers MUST be unique within their immediate <file>, <group> or <unit> enclosing element.

  • Identifier values used in extensions MUST be of type xs:NMTOKEN or compatible with xs:NMTOKEN (e.g. xs:NAME and xs:ID are compatible).

These constraints are needed for the fragment identification mechanism.

4.9.3 Processing Requirements

  • A user extension, whether implemented using <mda:metadata> or using a custom namespace, MUST NOT provide the same functionality as an existing XLIFF core or module feature, however it MAY complement an extensible XLIFF core feature or module feature or provide a new functionality at the provided extension points.

  • Mergers MUST NOT rely on custom namespace extensions, other than the ones possibly defined in <skeleton>, to create the Translated version of the original document.

  • Writers that do not support a given custom namespace based user extension SHOULD preserve that extension without Modification.

5 The Modules Specifications

This section specifies the OPTIONAL Modules that MAY be used along with Core for advanced functionality.

5.1 Translation Candidates Module

5.1.1 Introduction

The source text of a document can be pre-processed against various translation resources (TM, MT, etc.) to provide translation candidates. This module provides an XLIFF capability to store lists of possible translations along with information about the similarity of the match, the quality of the translation, its provenance, etc.

5.1.2 Module Namespace and Validation Artifacts

The namespace for the Translation Candidates module is: urn:oasis:names:tc:xliff:matches:2.0

Schema and Schematron for this module are available at http://docs.oasis-open.org/xliff/xliff-core/v2.1/csprd01/schemas/matches.xsd and http://docs.oasis-open.org/xliff/xliff-core/v2.1/csprd01/schemas/matches.sch.

5.1.3 Module Fragment Identification Prefix

The fragment identification prefix for the Translation Candidates module is: mtc

5.1.4 Translation Candidate Annotation

This annotation can be used to mark up the scope of a translation candidate within the content of a unit. This module can reference any source or even target spans of content that are referencable via the XLIFF Fragment Identification mechanism, however in case the corresponding fragment is not suitably delimited, the best way how to mark the relevant span is to use the following annotation.

Usage:

  • The id attribute is REQUIRED

  • The type attribute is REQUIRED and set to mtc:match

  • The ref attribute is not used.

  • The translate attribute is OPTIONAL

For example:

<unit id="1">
  <mtc:matches>
    <mtc:match ref="#m1">
      <source>He is my friend.</source>
      <target>Il est mon ami.</target>
    </mtc:match>
    <mtc:match ref="#m1">
      <source>He is my best friend.</source>
      <target>Il est mon meilleur ami.</target>
    </mtc:match>
  </mtc:matches>
  <segment>
    <source><mrk id="m1" type="mtc:match">He is my friend.</mrk></source>
  </segment>
  <segment>
    <source>Yet, I barely see him.</source>
  </segment>
</unit>

5.1.5 Module Elements

The elements defined in the Translation Candidates module are: <matches> and <match>.

5.1.5.1 Tree Structure

Legend:

1 = one
+ = one or more
? = zero or one
* = zero or more
<matches>
|
+---<match> +
  |
  +---<mda:metadata> ?
  |
  +---<xlf:originalData> ?
  |
  +---<xlf:source> 1
  |
  +---<xlf:target> 1
  |
  +---<other> *


  
5.1.5.2 matches

Collection of matches retrieved from any leveraging system (MT, TM, etc.)

Contains:

- One or more <match> elements
5.1.5.3 match

A potential translation suggested for a part of the source content of the enclosing <unit> element.

Contains:

- Zero or one <mda:metadata> element followed by.
- Zero or one <originalData> element followed by
- One <source> element followed by
- One <target> element followed by
- elements from other namespaces, OPTIONAL

Attributes:

- id, OPTIONAL
- matchQuality, OPTIONAL
- matchSuitability, OPTIONAL
- origin, OPTIONAL
- ref, REQUIRED
- reference, OPTIONAL
- similarity, OPTIONAL
- subType, OPTIONAL
- type, OPTIONAL
- attributes from other namespaces, OPTIONAL

Constraints

  • When a <target> element is a child of <match> and the reference attribute is set to yes, the OPTIONAL xml:lang attribute's value is not REQUIRED to be equal to the value of the trgLang attribute of the enclosing <xliff> element.

  • The following XLIFF Module attributes are explicitly allowed by the wildcard other:

    - attributes from the namespace urn:oasis:names:tc:xliff:itsm:2.1, OPTIONAL, provided that the Constraints specified in the ITS Module are met.

5.1.6 Module Attributes

The attributes defined in the Translation Candidates module are: id, matchQuality, matchSuitability, origin, ref, reference, similarity, subType, and type.

5.1.6.1 id

Identifier - a character string used to identify a <match> element.

Value description: NMTOKEN.

Default value: undefined

Used in: <match>.

Constraints

  • The id value MUST be unique within the enclosing <matches> element.

5.1.6.2 matchQuality

Match quality - indicates the quality of the <target> child of a <match> element based on an external benchmark or metric.

Value description: a decimal number between 0.0 and 100.0.

Default value: undefined

Used in: <match>.

Note

This attribute can carry a human review based metrics score, a Machine Translation self-reported confidence score etc.

5.1.6.3 matchSuitability

Match suitability - indicates the general suitability and relevance of its <match> element based on various external benchmarks or metrics pertaining to both the <source> and the <target> children of the <match>.

This attribute is intended to carry a value that can be combined from values provided in similarity and matchQuality attributes based on an externally provided algorithm.

Value description: a decimal number between 0.0 and 100.0.

Default value: undefined

Used in: <match>.

Note

This attribute is also useful for mapping match-quality as specified in XLIFF 1.2 because 1.2 is not capable of discerning between the source similarity and the target quality.

Processing Requirements

  • Agents processing this module MUST make use of matchSuitability for match ordering purposes if the attribute is specified.

5.1.6.4 origin

Match origin - indicates the tool, system or repository that generated a <match> element. This is a free text short informative description. For example, 'Microsoft Translator Hub' or 'tm-client123-v456', or 'MSTH (52217d25-d9e7-54a2-af44-3d4e4341d112_healthc).'

Value description: Text.

Default value: undefined

Used in: <match>.

5.1.6.5 ref

Reference - points to a span of text within the same unit, to which the translation candidate is relevant.

Value description: IRI

Default value: undefined

Used in: <match>.

Constraints

  • The value of the ref attribute MUST point to a span of text within the same <unit> element where the <match> is located.

5.1.6.6 reference

Reference - indicates that the <target> child of the <match> element contains a Translation into a reference language rather than into the target language. For example, a German translation can be used as reference by a Luxembourgish translator.

Value description: yes or no.

Default value: no.

Used in: <match>

5.1.6.7 similarity

Similarity - indicates the similarity level between the content of the <source> child of a <match> element and the translatable text being matched.

Value description: a decimal number between 0.0 and 100.0.

Default value: undefined

Used in: <match>.

5.1.6.8 subType

Sub-type - indicates the sub-type, i.e. a secondary level type, of a <match> element.

Value description:

The value is composed of a prefix and a sub-value separated by a character : (U+003A). The prefix is a string uniquely identifying a collection of values for a specific authority. The sub-value is any string value defined by an authority.

The prefix xlf is reserved for this specification, but no sub-values are defined for it at this time. Other prefixes and sub-values MAY be defined by the users.

  • Default value: undefined

Used in: <match>

Constraints

  • If the attribute subType is used, the attribute type MUST be explicitly set.

Processing Requirements

  • Writers updating the attribute type MUST also update or delete subType .

5.1.6.9 type

Type - indicates the type of a <match> element, it gives the value providing additional information on how the match was generated or qualifying further the relevance of the match. The list of pre-defined values is general and user-specific information can be added using the subType attribute.

Value description:

Table 3. Values

ValueDescription
amAssembled Match: candidate generated by assembling parts of different translations. For example: constructing a candidate by using the known translations of various spans of content of the source.
mtMachine Translation: candidate generated by a machine translation system.
icmIn Context Match: candidate for which the content context of the translation was the same as the one of the current source. For example: the source text for both contents is also preceded and/or followed by an identical source segment, or both appear as e.g. level 2 headings.
idmIdentifier-based Match: candidate that has an identifier identical to the one of the source content. For example: the previous translation of a given UI component with the same ID. match that has an identifier identical to the source content.
tbTerm Base: candidate obtained from a terminological database, i.e. the whole source segment matches with a source term base entry.
tmTranslation Memory: candidate based on a simple match of the source content.
otherCandidate of a top level type not covered by any of the above definitions.
  • Default value: tm

Used in: <match>

Processing Requirements

  • Writers updating the attribute type MUST also update or delete subType .

5.1.7 Example:

<mtc:matches>
   <mtc:match id="[NMTOKEN]">
      <xlf:source>
         <!-- text data -->
      </xlf:source>
      <xlf:target>
         <!-- text data -->
      </xlf:target>
      <xlf:originalData>
         <xlf:data id="[NMTOKEN]">
            <xlf:cp hex="[required]">
               <!-- text data -->
            </xlf:cp>
         </xlf:data>
      </xlf:originalData>
      <mda:metadata>
         <mda:metagroup>
            <!-- One or more of mda:metagroup or mda:meta -->
         </mda:metagroup>
      </mda:metadata>
      <!-- Zero, one or more elements from any namespace -->
   </mtc:match>
</mtc:matches>
      

5.2 Glossary Module

5.2.1 Introduction

Simple glossaries, consisting of a list of terms with a definition or translation, can be optionally embedded in an XLIFF document using the namespace mechanism to include elements from the Glossary module.

5.2.2 Module Namespace and Validation Artifacts

The namespace for the Glossary module is: urn:oasis:names:tc:xliff:glossary:2.0

Schema and Schematron for this module are available at http://docs.oasis-open.org/xliff/xliff-core/v2.1/csprd01/schemas/glossary.xsd and http://docs.oasis-open.org/xliff/xliff-core/v2.1/csprd01/schemas/glossary.sch

5.2.3 Module Fragment Identification Prefix

The fragment identification prefix for the Glossary module is: gls

5.2.4 Module Elements

The elements defined in the Glossary module are: <glossary>, <glossEntry>, <term>, <translation> and <definition>.

5.2.4.1 Tree Structure

Legend:

1 = one
+ = one or more
? = zero or one
* = zero, one or more
<glossary>
|
+---<glossEntry> +
  |
  +---<term> 1
  |
  +---<translation> *
  |
  +---<definition> ?
  |
  +---<other> *


  
5.2.4.2 glossary

Container for a list of glossary terms.

Contains:

- One or more <glossEntry> elements.
5.2.4.3 glossEntry

Glossary entry.

Contains:

- One <term> element followed by
- Zero, one or more <translation> elements followed by
- Zero or one <definition> element followed by
- elements from other namespaces, OPTIONAL

Attributes:

- id , OPTIONAL
- ref , OPTIONAL
- attributes from other namespaces, OPTIONAL

Constraints

5.2.4.4 term

A term in the glossary, expressed in the source language of the enclosing <xliff> element.

Contains:

- Text

Attributes:

- source , OPTIONAL
- attributes from other namespaces, OPTIONAL
5.2.4.5 translation

A translation of the sibling <term> element expressed in the target language of the enclosing <xliff> element. Multiple translations can be specified as synonyms.

Contains:

- Text

Attributes:

- id, OPTIONAL
- ref , OPTIONAL
- source, OPTIONAL
- attributes from other namespaces, OPTIONAL
5.2.4.6 definition

Optional definition in plain text for the term stored in the sibling <term> element.

Contains:

- Text

Attributes:

- source , OPTIONAL
- attributes from other namespaces, OPTIONAL

5.2.5 Module Attributes

The attributes defined in the Glossary module are: id, ref, and source

5.2.5.1 id

Identifier - a character string used to identify a <glossEntry> or <translation> element.

Value description: NMTOKEN

Default value: undefined

Used in:<glossEntry> and <translation>

Constraints

5.2.5.2 ref

Reference - points to a span of source or target text within the same unit, to which the glossary entry is relevant.

Value description: IRI

Default value: undefined

Used in: <glossEntry> and <translation>.

Constraints

  • The value of the ref attribute MUST point to a span of text within the same <unit> element, where the enclosing <glossary> element is located.

5.2.5.3 source

Source - indicates the origin of the content of the element where the attribute is defined.

Value description: Text.

Default value: undefined

Used in:<term>, <translation>, and <definition>.

5.2.6 Example:

  
     <unit id="1">
     <gls:glossary>
       <gls:glossEntry ref="#m1">
         <gls:term source="publicTermbase">TAB key</gls:term>
         <gls:translation id="1" source="myTermbase">Tabstopptaste
         </gls:translation>
         <gls:translation ref="#t=m1" source="myTermbase">TAB-TASTE
         </gls:translation>
         <gls:definition source="publicTermbase">A keyboard key that is
             traditionally used to insert tab characters into a document.
         </gls:definition>
       </gls:glossEntry>
     </gls:glossary>
     <segment>
       <source>Press the <mrk id="m1" type="term">TAB key</mrk>.</source>
       <target>Drücken Sie die <mrk id="m1" type="term">TAB-TASTE</mrk>.
       </target>
     </segment>
   </unit>

5.3 Format Style Module

5.3.1 Introduction

This is intended as a namespace mechanism to carry inside an XLIFF document information needed for generating a quick at a glance HTML preview of XLIFF content using a predefined set of simple HTML formatting elements.

5.3.2 Module Namespace and Validation Artifacts

The namespace for the Format style module is: urn:oasis:names:tc:xliff:fs:2.0

Schema and Schematron for this module are available at http://docs.oasis-open.org/xliff/xliff-core/v2.1/csprd01/schemas/fs.xsd and http://docs.oasis-open.org/xliff/xliff-core/v2.1/csprd01/schemas/fs.sch.

5.3.3 Module Fragment Identification Prefix

Format Style module does not have a fragment identification prefix. Prefix fs is reserved in case it became needed in the future developments of this module.

5.3.4 Module Specification

Format Style module consists of just two attributes: fs and subFs. It does not specify any elements.

Format Style allows most structural and inline XLIFF core elements to convey basic formatting information using a predefined subset of HTML formatting elements. It primarily enables the generation of HTML pages or snippets for preview and review purposes. It MUST NOT be used to prescribe a roundtrip to a source document format.

The fs attribute holds the name of an HTML formatting element. If additional style information is needed, the OPTIONAL subFs attribute is provided.

Constraints

  • The Format Style attributes MUST be configured in such a way that the HTML [HTML5] snippet resulting at the <file> level is valid.

Processing Requirements

Note

The above constraint and validation method will make sure that the snippets are renderable by standard HTML browsers.

5.3.5 Module Attributes

The attributes defined in the Format Style module are: fs, subFs.

5.3.5.1 fs

Format style attribute, fs - allows most structural and inline XLIFF core elements to convey basic formatting information using a predefined subset of HTML formatting elements (for example, HTML elements names like <script> are not included). It enables the generation of HTML pages or snippets for preview and review purposes. If additional style information is needed, the OPTIONAL subFs attribute is provided.

Value description:

Table 4. Values

aanchor
b bold text style
bdo I18N BiDi over-ride
big large text style
blockquote long quotation
body document body
br forced line break
button push button
caption table caption
center shorthand for DIV align=center
cite citation
code computer code fragment
col table column
colgroup table column group
dd definition description
del deleted text
div generic language/style container
dl definition list
dt definition term
em emphasis
h1 heading
h2 heading
h3 heading
h4 heading
h5 heading
h6 heading
head document head
hr horizontal rule
html document root element
i italic text style
imgimage
label form field label text
legend fieldset legend
li list item
ol ordered list
p paragraph
pre preformatted text
q short inline quotation
s strike-through text style
samp sample program output, scripts, etc.
select option selector
small small text style
span generic language/style container
strike strike-through text
strong strong emphasis
sub subscript
sup superscript
table
tbody table body
td table data cell
tfoot table footer
th table header cell
thead table header
title document title
tr table row
tt teletype or monospaced text style
u underlined text style
ul unordered list

Default value: undefined.

Used in: <file>, <unit>, <note>, <sc>, <ec>, <ph>, <pc>, <mrk>, and <sm>.

Warning

The fs attribute is not intended to facilitate Merging back into the original format.

Constraints

  • The fs MUST only be used with <ec> in cases where the isolated attribute is set to 'yes'.

Processing Requirements

  • Writers updating the attribute fs MUST also update or delete subFs.

Example: To facilitate HTML preview, fs can be applied to XLIFF like this like:

<xliff xmlns:fs="urn:oasis:names:tc:xliff:fs:2.0">
 <file fs:fs="html">
  <unit id="1" fs:fs="p">
   <segment>
    <source>Mick Jones renewed his interest in the Vintage
        <pc id="1" fs:fs="strong">'72 Telecaster Thinline </pc> guitar.
        <ph id="ph2" fs:fs="br" />He says <pc fs:fs="q">I love 'em</pc>
        <ph id="ph1" fs:fs="img" fs:subFs="src,smileface.png" /></source>
  </segment>
  </unit>
 </file>
</xliff>

With an XSL stylesheet like this:

<xsl:template match="*" priority="2"
    xmlns:fs="urn:oasis:names:tc:xliff:fs:2.0">
 <xsl:choose>
  <xsl:when test="@fs:fs">
   <xsl:element name="{@fs:fs}">
    <xsl:if test="@fs:subFs">
	 <xsl:variable name="att_name" select="substring-before(@fs:subFs,',')" />
	 <xsl:variable name="att_val" select="substring-after(@fs:subFs,',')" />
	 <xsl:attribute name="{$att_name}">
	  <xsl:value-of select="$att_val" />
	 </xsl:attribute>
	</xsl:if>
    <xsl:apply-templates />
   </xsl:element>
  </xsl:when>
  <xsl:otherwise>
   <xsl:apply-templates />
  </xsl:otherwise>
 </xsl:choose>
</xsl:template>

You can generate a an HTML page like this:

<html>
   <p>Mick Jones renewed his interest in the Vintage
      <strong>'72 Telecaster Thinline </strong> guitar.
      <br/>He says <q>I love 'em</q>
      <img src="smileface.png"/>
   </p>
</html>
5.3.5.2 subFs

Sub-format style, subFs - allows extra metadata, like URL for example, to be added in concert with the fs attribute.

Value description: The subFs attribute is used to specify the HTML attributes to use along with the HTML element declared in the fs attribute. It is a list of name/value pairs. Each pair is separated from the next with a backslash (\). The name and the value of a pair are separated with a comma (,). Both literal backslash and comma characters are escaped with a backslash prefix.

Default value: undefined.

Used in: <file>, <unit>, <note>, <source>, <target>, <sc>, <ec>, <ph>, <pc>, <mrk>, and <sm>.

Warning

The subFs attribute is not intended to facilitate Merging back into the original format.

Constraints

  • Commas (,) and backslashes (\) in the value parts of the subFs MUST be escaped with a backslash (\).

  • If the attribute subFs is used, the attribute fs MUST be specified as well.

  • The subFs MUST only be used with <ec> in cases where the isolated attribute is set to 'yes'.

Processing Requirements

  • Writers updating the attribute fs MUST also update or delete subFs.

Example: For complex HTML previews that require more than one attribute on an HTML preview element, attribute pairs are separated by backslashes (\). Any literal comma or backslash in an attribute value MUST be escaped with a backslash.

For example, we would use this convention:

<ph id="p1" fs="img" subFs="src,c:\\docs\\images\\smile.png\alt,
    My Happy Smile\title,Smiling faces\, are nice" />

To produce this HTML preview:

<img src="c:\docs\images\smile.png" alt="My Happy Smile"
    title="Smiling faces, are nice" />

5.4 Metadata Module

5.4.1 Introduction

The Metadata module provides a mechanism for storing custom metadata using elements that are part of the official XLIFF specification.

5.4.2 Module Namespace and Validation Artifacts

The namespace for the Metadata module is: urn:oasis:names:tc:xliff:metadata:2.0

Schema and Schematron for this module are available at http://docs.oasis-open.org/xliff/xliff-core/v2.1/csprd01/schemas/metadata.xsd and http://docs.oasis-open.org/xliff/xliff-core/v2.1/csprd01/schemas/metadata.sch.

5.4.3 Module Fragment Identification Prefix

The fragment identification prefix for the Metadata module is: mda

5.4.4 Module Elements

The elements defined in the Metadata module are: <metadata>, <metaGroup>, and <meta>.

5.4.4.1 Tree Structure

Legend:

+ = one or more
<metadata>
|
+---<metaGroup> +
  |
  +---At least one of (<metaGroup> OR <meta>)
      |
      +---<meta>


  
5.4.4.2 metadata

Container for metadata associated with the enclosing element.

Contains:

- One or more <metaGroup> elements

Attributes:

- id, OPTIONAL

Example: Metadata can be used to store XML attribute names and values for XLIFF Documents that do not use a skeleton. The following XML sample contains attributes on the <document> and <row> elements.

<document version="3" phase="draft">
   <table>
    <row style="head"><cell>Name</cell><cell>Position</cell></row>
	<row><cell>Patrick K.</cell><cell>Right Wing</cell></row>
	<row><cell>Bryan B.</cell><cell>Left Wing</cell></row>
   </table>
</document>

The Metadata module can be used to preserve these attributes for a round trip without using a skeleton:

<?xml version="1.0" encoding="utf-8"?>
<xliff xmlns="urn:oasis:names:tc:xliff:document:2.0"
       xmlns:fs="urn:oasis:names:tc:xliff:fs:2.0"
       xmlns:mda="urn:oasis:names:tc:xliff:metadata:2.0"
       version="2.0" srcLang="en">
   <file id="f1">
      <group id="g1" name="document">
         <mda:metadata>
            <mda:metaGroup category="document_xml_attribute">
               <mda:meta type="version">3</mda:meta>
               <mda:meta type="phase">draft</mda:meta>
            </mda:metaGroup>
         </mda:metadata>
         <group id="g2" name="table">
            <group id="g3" name="row">
               <mda:metadata>
                  <mda:metaGroup category="row_xml_attribute">
                     <mda:meta type="style">head</mda:meta>
                  </mda:metaGroup>
               </mda:metadata>
               <unit id="u1" name="cell">
                  <segment>
                     <source>Name</source>
                  </segment>
               </unit>
               <unit id="u2" name="cell">
                  <segment>
                     <source>Position</source>
                  </segment>
               </unit>
            </group>
            <group id="g4" name="row">
               <unit id="u3" name="cell">
                  <segment>
                     <source>Patrick K.</source>
                  </segment>
               </unit>
               <unit id="u4" name="cell">
                  <segment>
                     <source>Right Wing</source>
                  </segment>
               </unit>
            </group>
            <group id="g5" name="row">
               <unit id="u5" name="cell">
                  <segment>
                     <source>Bryan B.</source>
                  </segment>
               </unit>
               <unit id="u6" name="cell">
                  <segment>
                     <source>Left Wing</source>
                  </segment>
               </unit>
            </group>
         </group>
      </group>
   </file>
</xliff>
5.4.4.3 metaGroup

Provides a way to organize metadata into a structured hierarchy.

Contains:

- One or more <metaGroup> or <meta> elements in any order.

Attributes:

- id, OPTIONAL
- category, OPTIONAL
- appliesTo, OPTIONAL
5.4.4.4 meta

Container for a single metadata component.

Contains:

- Non-translatable text

Attributes:

- type, REQUIRED

5.4.5 Module Attributes

The attributes defined in the Metadata module are: appliesTo, category, id, and type.

5.4.5.1 appliesTo

Indicates the element to which the content of the metagroup applies.

Value description: source, target, or ignorable.

Default value: undefined.

Used in: <metaGroup>.

5.4.5.2 category

category - indicates a category for metadata contained in the enclosing <metaGroup> element.

Value description: Text.

Default value: undefined.

Used in: <metaGroup>.

5.4.5.3 id

Identifier - a character string used to identify a <metadata> or <metaGroup> element.

Value description: NMTOKEN

Default value: undefined

Used in:<metadata> and <metaGroup>

Constraints

5.4.5.4 type

type - indicates the type of metadata contained by the enclosing element.

Value description: Text.

Default value: undefined.

Used in: <meta>.

5.5 Resource Data Module

5.5.1 Introduction

The Resource Data module provides a mechanism for referencing external resource data that MAY need to be modified or used as contextual reference during translation.

5.5.2 Module Namespace and Validation Artifacts

The namespace for the Resource Data module is: urn:oasis:names:tc:xliff:resourcedata:2.0

Schema and Schematron for this module are available at http://docs.oasis-open.org/xliff/xliff-core/v2.1/csprd01/schemas/resource_data.xsd and http://docs.oasis-open.org/xliff/xliff-core/v2.1/csprd01/schemas/resource_data.sch.

5.5.3 Module Fragment Identification Prefix

The fragment identification prefix for the Resource Data module is: res

5.5.4 Module Elements

The elements defined in the Resource Data module are: <resourceData>, <resourceItemRef>, <resourceItem>, <source>, <target>, and <reference>.

5.5.4.1 Tree Structure

Legend:

? = zero or one
* = zero, one or more
<resourceData>
|
+---<resourceItemRef> *
|
+---<resourceItem> *
  |
  +---<source> ?
  | |
  | +---<other> *
  |
  +---<target> ?
  | |
  | +---<other> *
  |
  +---<reference> *


  
5.5.4.2 resourceData

Parent container for resource data associated with the enclosing element.

Contains:

At least one of the following

- Zero, one or more <resourceItemRef> elements.
- Zero, one or more <resourceItem> elements.
5.5.4.3 resourceItemRef

Specifies a reference to an associated <resourceItem> element located at the <file> level.

Contains:

This element is always empty.

Attributes:

- id, OPTIONAL
- ref, REQUIRED
- attributes from other namespaces, OPTIONAL

Constraints

Processing Requirements

5.5.4.4 resourceItem

Container for specific resource data that is either intended for Modification, or to be used as contextual reference during Translation.

Contains:

At least one of the following

- Zero or one <source> element followed by
- Zero or one <target> element followed by
- Zero, one or more <reference> elements

Attributes:

- mimeType, OPTIONAL
- id, OPTIONAL
- context, OPTIONAL
- attributes from other namespaces, OPTIONAL

Constraints

Processing Requirements

5.5.4.5 source

References the actual resource data that is either intended for Modification, or to be used as contextual reference during Translation.

Contains:

Either

- elements from other namespaces

or

- is empty.

Attributes:

- href, OPTIONAL
- xml:lang, OPTIONAL
- attributes from other namespaces, OPTIONAL

Constraints

  • The attribute href is REQUIRED if and only if <source> is empty.

  • When the OPTIONAL xml:lang attribute is present, its value MUST be equal to the value of the srcLang attribute of the enclosing <xliff> element.

Processing Requirements

5.5.4.6 target

References the localized counterpart of the sibling <source> element.

Contains:

Either

- elements from other namespaces

or

- is empty.

Attributes:

- href, OPTIONAL
- xml:lang, OPTIONAL
- attributes from other namespaces, OPTIONAL

Constraints

  • The attribute href is REQUIRED if and only if <target> is empty.

  • When the OPTIONAL xml:lang attribute is present, its value MUST be equal to the value of the trgLang attribute of the enclosing <xliff> element.

Processing Requirements

5.5.4.7 reference

References contextual data relating to the sibling <source> and <target> elements, such as a German screenshot for a Luxembourgish translator.

Contains:

- This element is always empty.

Attributes:

- href, REQUIRED
- xml:lang, OPTIONAL
- attributes from other namespaces, OPTIONAL

Constraints

  • When the OPTIONAL xml:lang attribute is present, its value does not need to be equal to the value of the srcLang or trgLang attribute of the enclosing <xliff> element.

Processing Requirements

5.5.5 Module Attributes

The attributes defined in the Resource Data module are: id, xml:lang, mimeType, context, href, and ref.

5.5.5.1 id

Identifier - A character string used to identify a <resourceData> element.

Value description: NMTOKEN

Default value: undefined

Used in:<resourceItem> and <resourceItemRef>

5.5.5.2 xml:lang

Language - The xml:lang attribute specifies the language variant of the text of a given element. For example: xml:lang="fr-FR" indicates the French language as spoken in France.

Value description: A language code as described in [BCP 47].

Default value: undefined

Used in: <source>, <target>, and <reference>.

5.5.5.3 mimeType

MIME type, mimeType - indicates the type of a resource object. This generally corresponds to the content type of [RFC 2045], the MIME specification; e.g. mimeType="text/xml" indicates the resource data is a text file of XML format.

Value description: A MIME type. An existing MIME type MUST be used from a list of standard values.

Default value: undefined

Used in:<resourceItem>

Note

If you cannot use any of the standard MIME type values as specified above, a new MIME type can be registered according to [RFC 2048].

5.5.5.4 context

Contextual Information - Indicates whether an external resource is to be used for context only and not modified.

Value description: yes or no

Default value: yes

Used in:<resourceItem>

5.5.5.5 href

Hypertext Reference, href - IRI referencing an external resource.

Value description: IRI.

Default value: undefined

Used in:<source>, <target>, and <reference>

5.5.5.6 ref

Resource Item Reference - holds a reference to an associated <resourceItem> element located at the <file> level.

Value description: An [XML Schema Datatypes] NMTOKEN

Default value: undefined

Used in:<resourceItemRef>

Constraints

  • The ref attribute value MUST be the value of the id attribute of the <resourceItem> element being referenced.

5.5.6 Examples:

In this example, the <resourceData> module at <file> level references external XML that contains resource data for a user interface control. The control is the container for the text “Load Registry Config” and needs to be resized to accommodate the increased length of the string due to translation. The <resourceItemRef> element contained in the <resourceData> module at <unit> level provides the reference between them. The name attribute of the <unit> element could serve as the key for an editor to associate <source> and <target> text with the resource data contained in the referenced XML and display it for modification.


  <file id="f1">
    <res:resourceData>
      <res:resourceItem id="r1" mimeType="text/xml" context="no">
        <res:source href="resources\en\registryconfig.resources.xml" />
        <res:target href="resources\de\registryconfig.resources.xml" />
      </res:resourceItem>
    </res:resourceData>
    <unit id="1" name="130;WIN_DLG_CTRL_">
      <res:resourceData>
        <res:resourceItemRef ref="r1" />
      </res:resourceData>
      <segment id="1" state="translated">
        <source>Load Registry Config</source>
        <target>Registrierungskonfiguration laden</target>
      </segment>
    </unit>
  </file>

In this example, the <resourceData> module at the <unit> level contains elements from another namespace (abc), which could be displayed for modification in an editor that understands how to process the namespace.


<file id="f2" xmlns:abc="urn:abc">
  <unit id="1">
    <res:resourceData>
      <res:resourceItem id="r1" context="no">
        <res:source>
          <abc:resourceType>button</abc:resourceType>
          <abc:resourceHeight>40</abc:resourceHeight>
          <abc:resourceWidth>75</abc:resourceWidth>
        </res:source>
        <res:target>
          <abc:resourceType>button</abc:resourceType>
          <abc:resourceHeight>40</abc:resourceHeight>
          <abc:resourceWidth>150</abc:resourceWidth>
        </res:target>
      </res:resourceItem>
    </res:resourceData>
    <segment id="1" state="translated">
      <source>Load Registry Config</source>
      <target>Registrierungskonfiguration laden</target>
    </segment>
  </unit>
</file>

In this example, the <resourceData> module references multiple static images that an editor can make use of as context while translating or reviewing.


<file id="f3">
  <res:resourceData>
    <res:resourceItem id="r1" mimeType="image/jpeg" context="yes">
      <res:source xml:lang="en-us"
          href="resources\en\registryconfig1.resources.jpg" />
      <res:target xml:lang="lb-lu"
          href="resources\lb\registryconfig1.resources.jpg" />
      <res:reference xml:lang="de-de"
          href="resources\de\registryconfig1.resources.jpg" />
    </res:resourceItem>
    <res:resourceItem id="r2" mimeType="image/jpeg" context="yes">
      <res:source xml:lang="en-us"
          href="resources\en\registryconfig2.resources.jpg" />
      <res:target xml:lang="lb-lu"
          href="resources\lb\registryconfig2.resources.jpg" />
    </res:resourceItem>
  </res:resourceData>
  <unit id="1">
    <res:resourceData>
      <res:resourceItemRef ref="r1" />
      <res:resourceItemRef ref="r2" />
    </res:resourceData>
    <segment id="1" state="translated">
      <source>Remove Registry Config</source>
      <target>Registrierungskonfiguration entfernen</target>
    </segment>
  </unit>
</file>

5.6 Change Tracking Module

5.6.1 Introduction

The Change Tracking module is used to store previous and current versions information for XLIFF elements and attributes in case of changes and revisions made by Modifiers conformant to this module specification.

Note

Because the Change Tracking Feature is an optional module that can be legally ignored by Core only Modifiers, the only safe way how to record a version of content that can be reintroduced as result of a roll back is to store the whole unit data within the Change track item element. Contrary to generic change tracking or versioning approaches, it's not enough to store just your changes.

5.6.2 Module Namespace and Validation Artifacts

The namespace for the Change Tracking module is: urn:oasis:names:tc:xliff:changetracking:2.1

Schema and Schematron for this module are available at http://docs.oasis-open.org/xliff/xliff-core/v2.1/csprd01/schemas/change_tracking.xsd and http://docs.oasis-open.org/xliff/xliff-core/v2.1/csprd01/schemas/change_tracking.sch.

5.6.3 Conformance to the Change Tracking Module Specification

Application Conformance

  • Conformant Modifiers MUST store and process XLIFF Document based revision data in compliance with this module's Constraints and Processing Requirements.

Backwards compatibility

  • Conformant applications MAY support the previous version of the Change Tracking Module in XLIFF 2.0 Documents

  • In XLIFF 2.1 Documents, the urn:oasis:names:tc:xliff:changetracking:2.0 namespace based data SHALL be considered as Extension by all Agents.

5.6.4 Module Fragment Identification Prefix

The fragment identification prefix for the Change Tracking module is: ctr

5.6.5 Module Elements

The elements defined in the Change Tracking module are: <changeTrack>, <revisions>, <revision>, <item>, and <simpleItem>.

5.6.5.1 Tree Structure

Legend:

+ = one or more
<changeTrack>
|
+---<revisions> +
  |
  +---<revision> +
    |
    +---<item> +
      |
      +---Exactly one of
          | | | |
          | | | +---One or more of
          | | |     |
          | | |     +---<xlf:segment> 1
          | | |     |
          | | |     +---<xlf:ignorable> 1
          | | |
          | | +---One of
          | |     |
          | |     +---<xlf:source> 1
          | |     |
          | |     +---<xlf:target> ?
          | |
          | +---<xlf:target> 1
          |
          +---(Content Type D)

  
5.6.5.2 changeTrack

Top level wrapper for change tracking information associated with descendants of the enclosing XLIFF Core structural element.

Contains:

- One or more <revisions> elements.

Parents:

- <file>
- <group>
- <unit>

Constraints

  • When used on <file> or <group> elements, only first cousin (i.e. children of the sibling <notes> element) <note> elements are in scope of the <changeTrack>.

  • When used on <unit> elements, the <unit> itself and all of it's XLIFF Core descendants are in scope.

5.6.5.3 revisions

Container for logical groups of revisions associated with an element within the scope of the parent <changeTrack> element.

Contains:

- One or more <revision> elements.

Attributes:

- appliesTo, REQUIRED
- ref, OPTIONAL
- id, OPTIONAL

Constraints

  • In case the REQUIRED appliesTo attribute value is set to source or target and there is more than one <source> or <target> element in scope, the value of the ref attribute MUST be equal to the NMTOKEN value of the id attribute of the parent <segment> or <ignorable> element of the referenced <source> or <target> element.

  • In all other cases where multiple elements of the same name are in scope, the ref attribute value MUST be equal to the value of the id attribute of the referenced element itself.

  • The value of the attribute appliesTo fully governs the type of content allowed in the grandchildren of specific <revisions> elements:

    • For <item> and <simpleItem> elements with the attribute property other than content only Content Type D is allowed and no XLIFF Core Inline Elements MUST be used.

    • For all <item> and <simpleItem> elements with the attribute property set to content:

      • If and only if appliesTo equals unit, the grandchild MUST be an <item> element of the Content Type A.

      • If and only if appliesTo is set to segment or ignorable, the grandchild MUST be an <item> element of the Content Type B or C.

      • If and only appliesTo is set to note, source, or target the grandchild MAY be a <simpleItem> element. In case the <item> element is used, Content Type D is REQUIRED.

Processing Requirements

  • Modifying agents MAY create <revisions> elements with attributes.

  • Modifying agents SHOULD NOT modify <revisions> and its attributes defined in this module.

  • Modifying agents SHOULD NOT remove <revisions> and its attributes defined in this module.

  • When the appliesTo attribute refers to an element that has multiple instances within the scope, the ref attribute MUST be used to reference an individual instance.

    Example 1. Using <notes> as an example:

          <notes>
            <note id="n1">new note</note>
            <note id="n2">another note</note>  
          </notes>
          <ctr:changeTrack>
            <ctr:revisions appliesTo="note" ref="n1">
              <ctr:revision>
                <ctr:item property="content">old note</ctr:item>
              </ctr:revision>
            </ctr:revisions>
          </ctr:changeTrack>
          
5.6.5.4 revision

Container for specific revisions associated with elements within the scope of the enclosing <changeTrack> element as narrowed down by attributes of the parent <revisions> element.

Contains:

- At most one <xlf:originalData> element followed by
- One or more <item> elements.

Attributes:

- author, OPTIONAL
- datetime, REQUIRED
- version, OPTIONAL
- id, OPTIONAL
- attributes from other namespaces, OPTIONAL

Constraints

  • The following XLIFF Module attributes are explicitly allowed by the wildcard other:

    - attributes from the namespace urn:oasis:names:tc:xliff:itsm:2.1, OPTIONAL, provided that the Constraints specified in the ITS Module are met.

Processing Requirements

  • Modifying agents MAY create <revision> elements with attributes.

  • Modifying agents SHOULD NOT modify <revision> and its attributes defined in this module.

  • Modifying agents MAY remove <revision> and its attributes defined in this module if and only if there is more than one instance of <revision> present. For example, a user agent can decide to preserve only the most current revision.

5.6.5.5 item

Container for a specific revision associated with an element referenced from the enclosing <revisions> element.

Contains:

Attributes:

- property, REQUIRED
- id, OPTIONAL
- attributes from other namespaces, OPTIONAL

Constraints

Note

If it appears that the <item> needs to contain an unhandled orphan code, it uses a wrong Content Type. Try higher level of Content, Content Type A will always work, but might be too verbose for some simple cases..

Processing Requirements

  • Modifiers MAY create <item> elements with attributes.

  • Modifiers SHOULD NOT change <item> and its attribute defined in this module.

  • Modifiers SHOULD NOT remove <item> and its attribute defined in this module, unless they are removed as part of a <revision> element removed according to its own Processing Requirements.

5.6.5.6 simpleItem

A simplified container for a specific revision associated with an element referenced from the enclosing <revisions> element. <simpleItem> has a simplified data model (only Content Type D compared to <item) to cater for simple notes, or target only change tracking without changing segmentation.

Contains:

Attributes:

- property, REQUIRED
- attributes from other namespaces, OPTIONAL

Constraints

Note

If it appears that the <simpleItem> needs to contain an unhandled orphan code, it uses a wrong Content Type and hence the tracked content is not expressible within <simpleItem> and tracking via <item> is needed.

Processing Requirements

  • Modifying agents MAY create <simpleItem> elements with attributes.

  • Modifying agents SHOULD NOT modify <simpleItem> and its attribute defined in this module.

  • Modifying agents SHOULD NOT remove <simpleItem> and its attribute defined in this module, unless they are removed as part of a <revision> element removed according to its own processing requirements.

5.6.6 Module Attributes

The attributes defined in the Change Tracking module are: appliesTo, author, datetime, id, property, ref, and version.

5.6.6.1 appliesTo

appliesTo – Indicates a specific XLIFF Core element within the scope of the enclosing <changeTrack> element. All revisions within the enclosing <revisions> element apply to the element indicated by this attribute.

Value description: NMTOKEN name of an admissible XLIFF element:

note
unit
segment
ignorable
source
target

Constraints

  • In case there is more than one XLIFF Core element of the name indicated by the appliesTo NMTOKEN within the scope of the enclosing <changeTrack> element the ??? attribute MUST be set to make the reference unambiguous.

Default value: undefined

Used in:<revisions>

5.6.6.2 author

author - Indicates the user or agent that created or modified the referenced element or its attributes.

Value description: Text.

Default value: undefined

Used in:<revision>.

5.6.6.3 datetime

Date and Time, datetime - Indicates the date and time the referenced element or its attributes were created or modified.

Value description: Date in one of the formats defined in [NOTE-datetime].

Default value: undefined

Used in:<revision>.

5.6.6.4 id

Identifier - a character string used to identify a <revisions>, <revision>, <item>, or <simpleItem> element within their enclosing <changeTrack> element.

Value description: NMTOKEN

Default value: undefined

Used in: <revisions>, <revision>, <item>, and <simpleItem>.

Constraints

Note

This id attribute is not being used from the Change Tracking Module itself. It's merely a convenience to be able to reference Change Tracking Module elements externally or from custom Extensions using the XLIFF Fragment Identification Mechanism. Change Tracking Module references the tracked Core data using its own appliesTo and ref attributes and does not use self reference.

5.6.6.5 property

property – Indicates the type of revision data.

Value description: The value MUST be either content to signify the content of an element, or the name of the attribute relating to the revision data.

Default value: none

Used in:<item>.

5.6.6.6 ref

Reference - Indicates which XLIFF Core element in scope of the specific <ctr:revisions> element is tracked.

Value description: An [XML Schema Datatypes] NMTOKEN

Default value: undefined

Used in:<revisions>

Processing Requirements

  • Modifiers that MUST set this ref attribute according to the Constraints of the attribute appliesTo must create any missing xlf:id attributes to allow for setting of this ref attribute.

5.6.6.7 version

version - Indicates the version of the referenced element or its attributes that were created or modified.

Value description: NMTOKEN.

Default value: undefined

Used in:<revision>.

Constraints

  • The values of the attribute version MUST be unique within the enclosing <revisions> element.

5.6.7 Example:

The following example shows change tracking for <source>, <target>, and <notes>. Current and previous versions are both stored in the Change Tracking module.

  
     <unit id="1">
     <ctr:changeTrack>
       <ctr:revisions appliesTo="source">
         <ctr:revision author="system" datetime="2013-07-15T10:00:00+8:00"
             version="r1">
           <ctr:item property="content">Hello World</ctr:item>
         </ctr:revision>
         <ctr:revision author="system" datetime="2013-06-15T10:00:00+8:00"
             version="r2">
           <ctr:item property="content">Hello</ctr:item>
         </ctr:revision>
         <ctr:revision author="system" datetime="2013-05-15T10:00:00+8:00"
             version="r3">
           <ctr:item property="content">Hi</ctr:item>
         </ctr:revision>
       </ctr:revisions>
       <ctr:revisions appliesTo="target">
         <ctr:revision author="Frank" datetime="2013-07-17T11:00:00+8:00"
             version="r1">
           <ctr:item property="content">Guten Tag Welt</ctr:item>
         </ctr:revision>
         <ctr:revision author="Frank" datetime="2013-06-17T11:00:00+8:00"
             version="r2">
           <ctr:item property="content">Hallo</ctr:item>
         </ctr:revision>
         <ctr:revision author="Frank" datetime="2013-05-17T11:00:00+8:00"
             version="r3">
           <ctr:item property="content">Grüsse</ctr:item>
         </ctr:revision>
       </ctr:revisions>
       <ctr:revisions appliesTo="note" ref="n1">
         <ctr:revision author="Bob" datetime="2013-07-16T10:30:00+8:00"
             version="r1">
           <ctr:item property="content">The translation should be formal
           </ctr:item>
           <ctr:item property="category">instruction</ctr:item>
         </ctr:revision>
         <ctr:revision author="Bob" datetime="2013-05-16T10:30:00+8:00"
             version="r2">
           <ctr:item property="content">The translation should be informal
           </ctr:item>
           <ctr:item property="category">comment</ctr:item>
         </ctr:revision>
       </ctr:revisions>
       <ctr:revisions appliesTo="note" ref="n2">
         <ctr:revision author="Bob" datetime="2013-07-18T10:30:00+8:00"
             version="r1">
           <ctr:item property="content">Please Review my translation
           </ctr:item>
         </ctr:revision>
       </ctr:revisions>
     </ctr:changeTrack>
     <notes>
       <note category="instruction" id="n1">The translation should be
       formal</note>
       <note category="comment" id="n2">Please Review my translation</note>
     </notes>
     <segment>
       <source>Hello World</source>
       <target>Guten Tag Welt</target>
     </segment>
   </unit>

5.7 Size and Length Restriction Module

5.7.1 Introduction

The Size and Length Restriction module provides a mechanism to annotate the XLIFF content with information on storage and general size restrictions.

The restriction framework has support for two distinct types of restrictions; storage size restrictions and general size restriction. The reason for this is that it is often common to have separate restrictions between storage and display / physical representation of data. Since it would be impossible to define all restrictions here a concept of restriction profile is introduced. The profiles for storage size and general size are independent. The information related to restriction profiles are stored in the processing invariant part of the XLIFF file like the <xlf:file>, <xlf:group> and <xlf:unit> elements and contained within elements defined in this module. The information regarding the specific restrictions are stored on the processing invariant parts and on the inline elements as attributes or attributes referencing data in the elements defined in this module. To avoid issues with segmentation no information regarding size restrictions is present on <xlf:segment>, <xlf:source> and <xlf:target> elements. The module defines a namespace for all the elements and attributes it introduces, in the rest of the module specification elements and attributes are in this namespace unless stated otherwise. In other parts of the XLIFF specification the prefix "slr" is used to refer to this module's namespace. For clarity the prefix "xlf" will be used for XLIFF Core elements and attributes. Profile names use the same namespace-like naming convention as user defined values in the XLIFF Core specification. The names SHOULD be composed of two components separated by a colon. <authority>:<name>. The authority "xliff" is reserved for profiles defined by the OASIS XLIFF Technical Committee.

5.7.2 Module Namespace and Validation Artifacts

The namespace for the Size and Length restriction module is: urn:oasis:names:tc:xliff:sizerestriction:2.0

Schema and Schematron for this module are available at http://docs.oasis-open.org/xliff/xliff-core/v2.1/csprd01/schemas/size_restriction.xsd and http://docs.oasis-open.org/xliff/xliff-core/v2.1/csprd01/schemas/size_restriction.sch.

5.7.3 Module Fragment Identification Prefix

The fragment identification prefix for the Size and Length restriction module is: slr

5.7.4 Module Elements

The elements defined in the Size and Length restriction module are: <profiles>, <normalization> and <data>.

5.7.4.1 Tree Structure

Legend:

? = zero or one
<profiles>
|
+---<normalization> ?
|
+---<other> *


  
5.7.4.2 profiles

This element selects the restriction profiles to use in the document. If no storage or general profile is specified the default values (empty) of those elements will disable restriction checking in the file.

Contains:

- Zero or one <normalization> element followed by
- elements from other namespaces, OPTIONAL

Attributes:

- generalProfile, OPTIONAL
- storageProfile, OPTIONAL

Processing Requirements

  • Any overall configuration or settings related to the selected profile MUST be placed in child elements of this element.

  • Data not related to the configuration of the selected profiles MUST NOT be placed in this element.

5.7.4.3 normalization

This element is used to hold the attributes specifying the normalization form to apply to storage and size restrictions defined in the standard profiles.

Contains:

This element is always empty.

Attributes:

- general, OPTIONAL
- storage, OPTIONAL

Processing Requirements

  • If this element is not present no normalization SHOULD be performed for the standard profiles.

  • Other profiles MAY use this element in its specified form but MUST NOT add new extensions to it.

5.7.4.4 data

This elements act as a container for data needed by the specified profile to check the part of the XLIFF document that is a sibling or descendant of a sibling of this element. It is not used by the default profiles.

Contains:

- elements from other namespaces, OPTIONAL

Attributes:

- profile, REQUIRED
- attributes from other namespaces, OPTIONAL

Processing Requirements

  • Third party profiles MUST place all data in this element instead of using other extension points if the data serves no other purpose in the processing of the document.

  • Data not used by the specified profile MUST NOT be placed in this element.

5.7.5 Module Attributes

The attributes defined in the Size and Length restriction module are: storageProfile, generalProfile, storage, general, profile, storageRestriction, sizeRestriction, equivStorage , sizeInfo and sizeInfoRef.

5.7.5.1 storageProfile

This attribute specifies, which profile to use while checking storage size restrictions. Empty string means that no restrictions are applied.

Value description: Name of restriction profile to use for storage size restrictions.

Default value: empty string

Used in:<profiles>.

5.7.5.2 generalProfile

This attribute specifies, which profile to use while checking the general size restrictions. Empty string means that no restrictions apply.

Value description: Name of restriction profile to use for general size restrictions.

Default value: empty string

Used in:<profiles>.

5.7.5.3 storage

This attribute specifies the normalization form to apply for storage size restrictions. Only the normalization forms C and D as specified by the Unicode Consortium are supported, see Unicode Standard Annex #15.

Value description: normalization to apply.

Table 5. Values

ValueDescription
noneNo additional normalization SHOULD be done, content SHOULD be used as represented in the document. It is possible that other Agents have already done some type of normalization when Modifying content. This means that this setting could give different results depending on what Agents are used to perform a specific action on the XLIFF Document.
nfcNormalization Form C MUST be used
nfdNormalization Form D MUST be used

Default value: none

Used in: <normalization>.

5.7.5.4 general

This attribute specifies the normalization to apply for general size restrictions. Only the normalization forms C and D as specified by the Unicode Consortium are supported, see Unicode Standard Annex #15.

Value description: normalization to apply.

Table 6. Values

ValueDescription
noneNo additional normalization SHOULD be done, content SHOULD be used as represented in the document. It is possible that other Agents have already done some type of normalization when Modifying content. This means that this setting could give different results depending on what Agents are used to perform a specific action on the XLIFF Document.
nfcNormalization Form C MUST be used
nfdNormalization Form D MUST be used

Default value: none

Used in:<normalization>.

5.7.5.5 profile

This attribute is used on the <data> element to indicate what profile the contents of that element apply to.

Value description: Name of a restriction profile

Default value: undefined

Used in:<data>.

5.7.5.6 storageRestriction

This attribute specifies the storage restriction to apply to the collection descendants of the element it is defined on.

Value description: Interpretation of the value is dependent on selected storageProfile. It MUST represent the restriction to apply to the indicated sub part of the document.

Default value: undefined

Used in: <file>, <group>, <unit>, <mrk>, <sm>, <pc> and <sc>.

5.7.5.7 sizeRestriction

This attribute specifies the size restriction to apply to the collection descendants of the element it is defined on.

Value description: Interpretation of the value is dependent on selected generalProfile. It MUST represent the restriction to apply to the indicated sub part of the document.

Default value: undefined

Used in: <file>, <group>, <unit>, <mrk>, <sm>, <pc> and <sc>.

5.7.5.8 equivStorage

This attribute provides a means to specify how much storage space an inline element will use in the native format. This size contribution is then added to the size contributed by the textual parts. This attribute is only allowed on the <ec> element if that element has the isolated attribute set to yes. Otherwise the attribute on the paired <sc> element also cover its partner <ec> element.

Value description: Interpretation of the value is dependent on selected storageProfile. It MUST represent the equivalent storage size represented by the inline element.

Default value: undefined

Used in: <pc>, <sc>, <ec>, <ph> and

5.7.5.9 sizeInfo

This attribute is used to associate profile specific information to inline elements so that size information can be decoupled from the native format or represented when the native data is not available in the XLIFF document. It can be used on both inline elements and structural elements to provide information on things like GUI dialog or control sizes, expected padding or margins to consider for size, what font is used for contained text and so on. This attribute is only allowed on the <ec> element if that element has the isolated attribute set to yes. Otherwise the attribute on the paired <sc> element also cover its partner <ec> element.

Value description: Interpretation of the value is dependent on selected generalProfile. It MUST represent information related to how the element it is attached to contributes to the size of the text or entity in which it occurs or represents.

Default value: undefined

Used in: <file>, <group>, <unit>, <pc>, <sc>, <ec>, and <ph>.

Constraints

  • This attribute MUST NOT be specified if and only if sizeInfoRef is used. They MUST NOT be specified at the same time.

5.7.5.10 sizeInfoRef

This attribute is used to point to data that provide the same function as the sizeInfo attribute does, but with the data stored outside the inline content of the XLIFF segment. This attribute is only allowed on the <ec> element if that element has the isolated attribute set to yes. Otherwise the attribute on the paired <sc> element also cover its partner <ec> element.

Value description: a reference to data that provide the same information that could be otherwise put in a sizeInfo attribute. The reference MUST point to an element in a <data> element that is a sibling to the element this attribute is attached to or a sibling to one of its ancestors.

Default value: undefined

Used in: <file>, <group>, <unit>, <pc>, <sc>, <ec>, and <ph>,

Constraints

  • This attribute MUST NOT be specified if and only if sizeInfo is used. They MUST NOT be specified at the same time.

5.7.6 Standard profiles

5.7.6.1 General restriction profile ”xliff:codepoints”

This profile implements a simple string length restriction based on the number of Unicode code points. It is OPTIONAL to specify if normalization is to be applied using the <normalization> element and the general attribute. This profile makes use of the following attributes from this module:

5.7.6.1.1 sizeRestriction

The value of this attribute holds the ”maximum” or ”minimum and maximum” size of the string. Either size MUST be an integer. The maximum size MAY also be ’*’ to denote that there is no maximum restriction. If only a maximum is specified it is implied that the minimum is 0 (empty string). The format of the value is the OPTIONAL minimum size and a coma followed by a maximum size (”[minsize,]maxsize”). The default value is ’*’ which evaluates to a string with unbounded size.

5.7.6.1.2 sizeInfo

The value of this attribute is an integer representing how many code points the element it is set on is considered to contribute to the total size. If empty, the default for all elements is 0.

5.7.6.2 Storage restriction profiles ”xliff:utf8”, ”xliff:utf16” and ”xliff:utf32”

These three profiles define the standard size restriction profiles for the common Unicode character encoding schemes. It is OPTIONAL to specify if normalization is to be applied using the <normalization>element and the storage. All sizes are represented in 8bit bytes. The size of text for these profiles is the size of the text converted to the selected encoding without any byte order marks attached. The encodings are specified by the Unicode Consortium in chapter 2.5 of the Unicode Standard [Unicode].

Table 7. Profiles

NameDescription
xliff:utf8The number of 8bit bytes needed to represent the string encoded as UTF-8 as specified by the Unicode consortium.
xliff:utf16The number of 8bit bytes needed to represent the string encoded as UTF-16 as specified by the Unicode consortium.
xliff:utf32The number of 8bit bytes needed to represent the string encoded as UTF-32 as specified by the Unicode consortium.

These profiles make use of the following attributes from this module:

5.7.6.2.1 storageRestriction

The value of this attribute holds the ”maximum” or ”minimum and maximum” size of the string. Either size MUST be an integer. The maximum size MAY also be ’*’ to denote that there is no maximum restriction. If only a maximum is specified it is implied that the minimum is 0 (empty string). The format of the value is the OPTIONAL minimum size and a coma followed by a maximum size (”[minsize,]maxsize”). The default value is ’*’ which evaluates to a string with unbounded size.

5.7.6.2.2 equivStorage

The value of this attribute is an integer representing how many bytes the element it is set on is considered to contribute to the total size. If empty the default is 0. The <cp> is always converted to its representation in the profiles encoding and the size of that representation is used as the size contributed by the <cp>.

5.7.7 Third party profiles

The general structure of this module together with the extensibility mechanisms provided has been designed with the goal to cater for all practically thinkable size restriction schemes. For example, to represent two dimensional data, a profile can adopt a coordinate style for the values of the general restriction attributes. For instance {x,y} to represent width and height, or {{x1,y1},{x2,y2}} to represent a bounding box. It is also possible to embed information necessary to drive for instance a display simulator and attach that data to text in order to be able to perform device specific checking. Providing font information and checking glyph based general size are other feasible options.

5.7.8 Conformance

To claim conformance to the XLIFF size and length restriction module an Agent MUST meet the following criteria:

  • MUST be compliant with the schema of the XLIFF Core specification and its extensions provided in this module.

  • MUST follow all processing requirements set forth in this module specification regarding the general use of elements and attributes.

  • MUST support all standard profiles with normalization set to none.

  • SHOULD support all standard profiles with all modes of normalization.

  • MAY support additional third party profiles for storage or general restrictions.

  • MUST provide at least one of the following:

    • add size and length restriction information to an XLIFF Document

    • if it supports the profile(s) specified in the XLIFF Document it MUST provide a way to check if the size and length restrictions in the document are met according to the profile(s) requirements.

5.7.9 Example

A short example on how this module can be used is provided here with inline XML comments explaining the usage of the module features.

	<xliff version="2.0" srcLang="en-us"
    xmlns="urn:oasis:names:tc:xliff:document:2.0"
    xmlns:slr="urn:oasis:names:tc:xliff:sizerestriction:2.0">
    <file id="f1">
        <slr:profiles generalProfile="xliff:codepoints"
            storageProfile="xliff:utf8">
            <!-- Select standard UTF-8 storage encoding and standard
                codepoint size restriction both with NFC normalization-->
            <slr:normalization general="nfc" storage="nfc" />
        </slr:profiles>
        <!-- The group should not require more than 255 bytes of storage
             And have at most 90 codepoints. Note that the sum of the unit
             sizes are larger than this the total content of the group
             must still be at most 90 codepoints. -->
        <group id="g1" slr:storageRestriction="255"
            slr:sizeRestriction="90">
            <!-- This unit must not contain more than 60 code points -->
            <unit id="u1" slr:sizeRestriction="60">
                <segment>
                    <!-- The spanning <pc> element require 7 bytes of
                        storage in the native format. Its content must not
                        have more than 25 codepoints -->
                <source>This is a small <pc equivStorage="7"
                    slr:sizeRestriction="25">size restriction</pc> example.
                </source>
                </segment>
            </unit>
            <!-- This unit must not have more than 35 codepoints -->
            <unit id="u2" slr:sizeRestriction="35">
                <segment>
                    <source>With a group structure.</source>
                </segment>
            </unit>
        </group>
    </file>
</xliff>
	

5.8 Validation Module

5.8.1 Introduction

This module defines a specific set of validation rules that can be applied to target text both globally and locally. Further constraints can be defined that allow rules to be applied to target text based on conditions in the source text or disabled to override a global scope.

5.8.2 Module Namespace and Validation Artifacts

The namespace for the Validation module is: urn:oasis:names:tc:xliff:validation:2.0

Schema and Schematron for this module are available at http://docs.oasis-open.org/xliff/xliff-core/v2.1/csprd01/schemas/validation.xsd and http://docs.oasis-open.org/xliff/xliff-core/v2.1/csprd01/schemas/validation.sch.

5.8.3 Module Fragment Identification Prefix

The fragment identification prefix for the Validation module is: val

5.8.4 Module Elements

The elements defined in the Validation module are: <validation> and <rule>.

5.8.4.1 Tree Structure

Legend:

+ = one or more
<validation>
|
+---<rule> +


  
5.8.4.2 validation

Parent container for a list of rules and constraints to apply to the target text of the enclosing element.

Contains:

- One or more <rule> elements.

Attributes:

- attributes from other namespaces, OPTIONAL

Processing Requirements

5.8.4.3 rule

A specific rule and constraint to apply to the target text of the enclosing element.

Contains:

- This element is always empty.

Attributes:

- isPresent, OPTIONAL
- occurs, OPTIONAL
- isNotPresent, OPTIONAL
- startsWith, OPTIONAL
- endsWith, OPTIONAL
- existsInSource, OPTIONAL
- caseSensitive, OPTIONAL
- normalization, OPTIONAL
- disabled, OPTIONAL
- attributes from other namespaces, OPTIONAL

Constraints

Processing Requirements

  • Writers MAY create and add new <rule> elements, provided that the new rules do not contradict rules already present.

  • Modifiers MUST NOT change attributes defined in this module that are already present in any <rule> element.

  • Modifiers MUST NOT remove either <rule> elements or their attributes defined in this module.

5.8.5 Module Attributes

The attributes defined in the Validation module are: isPresent, occurs, isNotPresent, startsWith, endsWith, existsInSource, caseSensitive, normalization, and disabled.

5.8.5.1 isPresent

This rule attribute specifies that a string MUST be present in the target text at least once.

For example, the following is valid:

<unit id="1">
  <val:validation>
    <val:rule isPresent="online" />
  </val:validation>
  <segment id="1">
    <source>Choose an option in the online store.</source>
    <target>Escolha uma opção na loja online.</target>
  </segment>
</unit>

Whereas the following is invalid:

<unit id="1">
  <val:validation>
    <val:rule isPresent="loja" />
  </val:validation>
  <segment id="1">
    <source>Choose an option in the online store.</source>
    <target>Escolha uma opção na online store.</target>
  </segment>
</unit>

Other rule attributes can be combined with isPresent to produce the following results:

isPresent=”loja” - loja is found in the target text at least once.
isPresent=”loja” occurs=”1” - loja is found in the target text exactly once.
isPresent=”loja” existsInSource=”yes” - loja is found in both source and target text the same number of times.
isPresent=”loja” existsInSource=”yes” occurs=”1” - loja is found in both source and target text and occurs in target text exactly once.

Value description: Text.

Default value: none

Used in: <rule>

5.8.5.2 occurs

This rule attribute is used with the isPresent rule attribute to specify the exact number of times a string MUST be present in the target text. When this rule attribute is not used, then the string MUST be present in the target text at least once.

For example, the following is valid:

<unit id="1">
  <val:validation>
    <val:rule isPresent="loja" occurs="2" />
  </val:validation>
  <segment id="1">
    <source>Choose a store option in the online store.</source>
    <target>Escolha uma opção de loja na loja online.</target>
  </segment>
</unit>

Whereas the following is invalid:

<unit id="1">
  <val:validation>
    <val:rule isPresent="loja" occurs="2" />
  </val:validation>
  <segment id="1">
    <source>Choose a store option in the online store.</source>
    <target>Escolha uma opção de loja na online store.</target>
  </segment>
</unit>

Value description: A number of 1 or greater.

Default value: none

Used in: <rule>

5.8.5.3 isNotPresent

This rule attribute specifies that a string MUST NOT be present in the target text.

For example, the following is valid:

<unit id="1">
  <val:validation>
    <val:rule isNotPresent="store" />
  </val:validation>
  <segment id="1">
    <source>Choose an option in the online store.</source>
    <target>Escolha uma opção na loja online.</target>
  </segment>
</unit>

Whereas the following is invalid:

<unit id="1">
  <val:validation>
    <val:rule isNotPresent="store" />
  </val:validation>
  <segment id="1">
    <source>Choose an option in the online store.</source>
    <target>Escolha uma opção na online store.</target>
  </segment>
</unit>

Value description: Text.

Default value: none

Used in: <rule>

5.8.5.4 startsWith

This rule attribute specifies that a string MUST start with a specific value.

For example, the following is valid:

<unit id="1">
  <val:validation>
    <val:rule startsWith="*" />
  </val:validation>
  <segment id="1">
    <source>*Choose an option in the online store.</source>
    <target>*Escolha uma opção na loja online.</target>
  </segment>
</unit>

Whereas the following is invalid:

<unit id="1">
  <val:validation>
    <val:rule startsWith="*" />
  </val:validation>
  <segment id="1">
    <source>*Choose an option in the online store.</source>
    <target>Escolha uma opção na loja online.</target>
  </segment>
</unit>

Value description: Text.

Default value: none

Used in: <rule>

5.8.5.5 endsWith

This rule attribute specifies that a string MUST end with a specific value.

For example, the following is valid:

<unit id="1">
  <val:validation>
    <val:rule endsWith=":" />
  </val:validation>
  <segment id="1">
    <source>Choose an option in the online store:</source>
    <target>Escolha uma opção na loja online:</target>
  </segment>
</unit>

Whereas the following is invalid:

<unit id="1">
  <val:validation>
    <val:rule endsWith=":" />
  </val:validation>
  <segment id="1">
    <source>Choose an option in the online store:</source>
    <target>Escolha uma opção na online store.</target>
  </segment>
</unit>

Value description: Text.

Default value: none

Used in: <rule>

5.8.5.6 existsInSource

When this rule attribute is used with another rule attribute and is set to yes, it specifies that for the rule to succeed, the condition MUST be satisfied in both source and target text. This rule attribute is valid only when used with one of the following rule attributes: isPresent, startsWith, or endsWith.

When existsInSource is set to no, it will have no impact on execution of rules, except for overriding rules where existsInSource is set to yes on a higher level.

For example, the following are valid:

<unit id="1">
  <val:validation>
    <val:rule endsWith=":" existsInSource="yes" />
  </val:validation>
  <segment id="1">
    <source>Choose an option in the online store:</source>
    <target>Escolha uma opção na loja online:</target>
  </segment>
</unit>
...
<unit id="2">
  <val:validation>
    <val:rule endsWith=":" existsInSource="no" />
  </val:validation>
  <segment id="1">
    <source>Choose an option in the online store.</source>
    <target>Escolha uma opção na loja online:</target>
  </segment>
</unit>

Whereas the following is invalid:

<unit id="1">
  <val:validation>
    <val:rule endsWith=":" existsInSource="yes" />
  </val:validation>
  <segment id="1">
    <source>Choose an option in the online store.</source>
    <target>Escolha uma opção na loja online:</target>
  </segment>
</unit>

Value description: yes or no

Default value: no

Used in: <rule>

Constraints

5.8.5.7 caseSensitive

This rule attribute specifies whether the test defined within that rule is case sensitive or not.

Value description: yes if the test is case sensitive, no if the test is case insensitive.

Default value: yes.

Used in: <rule>

5.8.5.8 normalization

This rule attribute specifies the normalization type to apply when validating a rule. Only the normalization forms C and D as specified in [UAX #15].

Value description: The allowed values are listed in the table below along with their corresponding types of normalization to be applied.

Table 8. Values

ValueDescription
noneNo normalization SHOULD be done.
nfcNormalization Form C MUST be used.
nfdNormalization Form D MUST be used.

Default value: nfc

Used in: <rule>

5.8.5.9 disabled

This rule attribute determines whether a rule MUST or MUST NOT be applied within the scope of its enclosing element. For example, a rule defined at the <file> level can be disabled at the <unit> level.

This attribute is provided to allow for overriding execution of rules set at higher levels, see <val:validation>.

In the following example, the isNotPresent rule is applied in its entirety to the first unit, but not to the second.

<file id="f1">
 <val:validation>
    <val:rule isPresent="store" />
 </val:validation>
 <unit id="1">
   <segment id="1">
     <source>Choose an option in the online store:</source>
     <target>Escolha uma opção na loja online:</target>
   </segment>
 </unit>
 <unit id="2">
    <val:validation>
      <val:rule isPresent="store" disabled="yes" />
    </val:validation>
    <segment id="1">
      <source>Choose an option in the application store:</source>
      <target>Escolha uma opção na application store:</target>
    </segment>
  </unit>
</file>

Value description: yes or no

Default value: no

Used in: <rule>

5.9 ITS Module

5.9.1 Introduction

This module defines Inline Annotations (normative usage descriptions for attributes on inline annotation markers), attributes and elements that are needed to map [ITS] data categories using only XLIFF-defined elements and attributes. The module also defines an external rules file to be used by generic ITS processors working with XLIFF Documents. This module only defines attributes and annotations that are not available through XLIFF Core or other Modules. This module specification also contains normative provisions for mapping of [ITS] data categories and features that are available via XLIFF Core and other modules (ITS categories available through XLIFF Core and other Modules and ITS categories that have a partial overlap with XLIFF features) or other Modules outside of the ITS Module (ITS categories that have a partial overlap with XLIFF features). Finally an overview of data categories is provided where the information is or can be fully expressed by Extraction behavior and therefore those categories or their parts (sub-categories) cannot be represented as metadata within XLIFF Documents (ITS categories that do not represent metadata after Extraction of content into XLIFF).

Note

This module specification chiefly describes how the [ITS] data categories need to be expressed within XLIFF Documents. Some metadata categories are typically Extracted from native source formats, others would be first injected into XLIFF Documents by Enriching Agents and might be useful or not in the target content after Merging back to the native format in the target natural language. For all metadata categories that can be encoded within XLIFF Documents, there is an important XLIFF specific distinction between structural and inline elements in XLIFF. Some categories can only be expressed inline in XLIFF Documents. Others can be also expressed on structural markup levels; in such a case, inheritance (or not) from the XLIFF structural levels is important. Nevertheless, even the inline only metadata categories can be in scope of ITS Tools Referencing that can be set on structural levels and possible inheritance of relevant itsm:annotatorsRef values needs to be always checked by implementers.

5.9.2 Module Namespace and Validation Artifacts

The namespace for the ITS module is: urn:oasis:names:tc:xliff:itsm:2.1.

Schema and Schematron for this module are available at http://docs.oasis-open.org/xliff/xliff-core/v2.1/csprd01/schemas/itsm.xsd and http://docs.oasis-open.org/xliff/xliff-core/v2.1/csprd01/schemas/itsm.sch.

5.9.3 Module Fragment Identification Prefix

The fragment identification prefix for the ITS module is: itsm.

5.9.4 Conformance to the ITS Module Specification

Note

Some ITS data categories like Translate are supported natively by XLIFF. Other data categories are not supported by XLIFF because they are focusing on source content and not XLIFF content. The below conformance statement is only relevant for data categories for which the usage in XLIFF 2.1 is normatively defined in this XLIFF 2.1 ITS Module. Like in the [ITS] 2.0 specification, there is no interrelation between data categories.

Processing Requirements

  • Conformant ITS Processors MUST be able to use the external global rules included in the module's Schematron file http://docs.oasis-open.org/xliff/xliff-core/v2.1/csprd01/schemas/itsm.sch and compute ITS data categories encoded in XLIFF Documents as per [ITS] Conformance clauses 2-1, 2-2, 2-3, and 2-4.

    • In cases where any of the above specified global rules identifies an empty <sm> element, conformant ITS Processors SHOULD be able identify the closing <em> marker and process the relevant ITS data category as applied on the span delimited by those corresponding empty markers.

  • Conformant Agents MUST be XLIFF Conformant in the sense of XLIFF Application Conformance and also implement at least one [ITS] data category defined in the section ITS data categories defined in the ITS Module of this ITS Module or provide full support for at least one of the [ITS] custom annotations (ITS Mapping Annotations) specified in the Section ITS categories that have a partial overlap with XLIFF features.

    In particular:

    • Conformant Extractors MUST be capable of Extracting at least one of the above specified ITS data categories from a source format and encode it in a resulting conformant XLIFF Document with ITS Module based metadata.

    • Conformant Enrichers MUST be capable of Enriching XLIFF Documents with at least one of the above specified ITS data categories.

    • Conformant Modifiers MUST be capable of updating at least one of the above specified ITS data categories according to its own Constraints and Processing Requirements as specified in the ITS Module.

    • Conformant Mergers MUST be capable of Merging metadata of at least one of the above specified ITS data categories back to the respective native format (with full knowledge of the Extraction mechanism) in the target natural language.

5.9.5 ITS Tools Referencing

[ITS] Tools Annotation mechanism provides a way to record tools that produced [ITS] metadata.

Warning

This mechanism is reserved for recording producers of ITS metadata. General provenance information can be recorded using the Provenance data category mapping defined in this Module. If an Agent records the revision history of previous versions, they need do this using the Change Tracking Module, possibly extended with ITS Module Provenance metadata.

Note

The ITS Tools Referencing mechanism has to be always used with the MT Confidence data category. The Terminology and Text Analysis metadata categories have to use ITS Tools Referencing conditionally, i.e. whenever they specify itsm:termConfidence or itsm:taConfidence respectively.

With all other [ITS] metadata categories, there is no express need to use the ITS Tools Referencing mechanism. It is nevertheless advised that the relevant ITS Tooling metadata is Extracted where available and Modified when the relevant ITS metadata category information changes during the XLIFF Document processing. Finally, all conformant Agents and ITS Processors need to be able to compute the ITS Tools Referencing information in case this has been provided by other conformant Agents earlier in the workflow as per the ITS Module Conformance section.

Processing Requirements

  • Writers MUST use the attribute itsm:annotatorsRef to express the information provided through the [ITS] Tools Annotation mechanism in XLIFF Documents. COMMENT: NEED TO AGREE WHETHER ITS SECTION NEEDS SPECIAL MENTION FOR EACH DATA CATEGORY THAT INFORMTION IS WRITTEN IN XLIFF DOCUMENTS.

5.9.5.1 ITS Tools Annotation

This is used to express the [ITS] Tools Annotation mechanism on inline markers.

Usage:

  • The id attribute is REQUIRED.

  • The itsm:annotatorsRef attribute is REQUIRED.

  • The type attribute is OPTIONAL and set to itsm:generic.

  • The translate attribute is OPTIONAL.

5.9.6 ITS data categories defined in the ITS Module

The following [ITS] data categories are fully specified within this module:

5.9.6.1 Allowed Characters

Used to specify the characters that are permitted in a given piece of content. See [ITS] Allowed Characters for further details.

Processing Requirements

5.9.6.1.1 Structural Elements

If a structural element of the original document has a Allowed Characters annotation, it is recommended to represent that annotation using a <mrk> element that encloses the whole content of the <source> element.

Example 2. Extraction of Allowed Characters at structural levels

Original:

...
<p its-allowed-characters="[a-ZA-Z]">Text</p>
...

Extraction:

...
<unit id="1">
 <segment>
  <source><mrk id="m1" type="itsm:generic" itsm:allowedCharacters="[a-ZA-Z]">Text</mrk></source>
 </segment>
</unit>
...
5.9.6.1.2 Inline Elements

Use the ITS attribute on the <mrk> element:

Original:

...
<p>user name: <span its-allowed-characters='[a-ZA-Z]'>johnDoe</span></p>
...

Extraction:

...
<unit id="1">
 <segment>
  <source>user name: <mrk id="m1" type="itsm:generic" itsm:allowedCharacters="[a-ZA-Z]">johnDoe</mrk>.</source>
 </segment>
</unit>
...
5.9.6.1.3 ITS Allowed Characters Annotation

This is used to fully map to and from the [ITS] Alllowed Characters data category.

Usage:

  • The allowedCharacters attribute is REQUIRED and used to map to and from the [ITS] defined allowedCharacters attribute.

  • The type attribute is OPTIONAL and set to itsm:generic.

  • The translate attribute is OPTIONAL.

5.9.6.2 Domain

Identifies the topic, theme, or subject of the content in scope. See [ITS] Domain for details.

Processing Requirements

5.9.6.2.1 Structural Elements

Example 3. Extraction of Domain at structural levels

Original: COMMENT: SHOULD WE HAVE ALWAYS HTML EXAMPLES?

        <!doctype html>
        <html lang="en">
         <head>
          <meta charset="utf-8">
            <title>Data Category: Domain</title>
            <script type="application/its+xml">
             <its:rules xmlns:its="http://www.w3.org/2005/11/its" version="2.0"
              xmlns:h="http://www.w3.org/1999/xhtml">
                <its:domainRule selector="//h:*[@class='dom1']" domainPointer="./@class"
                 domainMapping="dom1 domain1" />
             </its:rules>
           </script>
         </head>
         <body>
           <p class="dom1">Text in the domain domain1</p>
         </body>
        </html>
      

Extraction:

        ...
        <unit id='2' itsm:domains="domain1">
         <segment>
           <source>Text in the domain domain1</source>
         </segment>
        </unit>
        ...
        
5.9.6.2.2 Inline Elements

Use <mrk> or an <sm/> / <em/> pair with the itsm:domains attribute set.

See the ITS Domain Annotation for the normative usage description on inline markers. COMMENT: SAME QUESTION AS BEFORE: SHOULD THE ACTUAL LINKED CONTENT BE HERE DIRECTLY?

5.9.6.2.3 ITS Domain Annotation

This is used to express inline the [ITS] Domain data category. COMMENT: HOW TO REPRESENT NON-WELLFORMED SPANS IN XLIFF (EXPRESSED WITH SM) WITH DOMAIN, SINCE IN ITS DOMAIN ONLY WORKS GLOBALLY? THIS WILL BE A PROBLEM FOR CREATING THE RULES FILE FOR MANY DATA CATEGORIES: WE CANNOT COMPARE THINGS THAT ARE SM / EM :( - WORKAROUND ONLY WITH XPATH 2.0 POSSIBLE, IT SEEMS. WOULD BE GOOD TO HAVE (MORE EXAMPLES) WITH SM / EM.

Usage:

  • The id attribute is REQUIRED.

  • The itsm:domains attribute is REQUIRED.

  • The type attribute is OPTIONAL and set to itsm:generic.

  • The translate attribute is OPTIONAL.

Example 4. Extraction of Domain metadata on inline elements

Original:

<!doctype html>
<html lang="en">
 <head>
  <meta charset="utf-8">
  <title>Data Category: Domain</title>
  <script type="application/its+xml">
   <its:rules xmlns:its="http://www.w3.org/2005/11/its" version="2.0"
    xmlns:h="http://www.w3.org/1999/xhtml">
    <its:domainRule selector="//h:*[@class='dom1']" domainPointer="./@class"
     domainMapping="dom1 domain1" />
   </its:rules>
  </script>
 </head>
 <body>
  <p>Span of text <span class="dom1">in the domain domain1</span></p>
 </body>
</html> 
       

Extraction:

...
<unit id="1">
 <segment>
  <source>Span of text <pc id="1"><mrk id="m1" type="itsm:generic" itsm:domains="domain1"
  >in the domain domain1</mrk></pc></source>
 </segment>
</trans-unit>
...
5.9.6.3 Locale Filter

COMMENT: WE NEED TO MAKE SURE THAT THERE IS IMPLEMENTATION COMMITMENT FOR THE DATA CATEGORY.

Expresses that a node is only applicable to certain locales. See [ITS] Locale Filter for further details.

Processing Requirements

5.9.6.3.1 Structural Elements

When the target locale in XLIFF is undefined, the locale filter data category MAY be Extracted using the ITS Locale Filter Annotation.

Example 5. Extraction of Locale Filter at structural levels

Original: COMMENT: examples need replacement of "its" prefix with "itsm"

<p its-locale-filter-list='fr'>Text A</p>
<p its-locale-filter-list='ja'>Text B</p>
      

Extraction:

<xliff srcLang='en' ...>
... 
<unit id='1' itsm:localeFilterList='fr'>
 <segment>
  <source>Text A</source>
 </segment>
</unit>
<unit id='2' itsm:localeFilterList='ja'>
 <segment>
  <source>Text B</source>
 </segment>
</unit>
...
        

When the target locale in XLIFF is defined, use the translate attribute. (yes if the target locale applies, no if it does not). It is also recommended to keep the original ITS attributes, so the file could potentially be re-purposed (even if it has a current target).

Original:

<p its-locale-filter-list='fr'>Text A</p>
<p its-locale-filter-list='ja'>Text B</p>
      

Extraction:

<xliff srcLang='en' trgLang='fr' ...>
... 
<unit id='1' translate='yes' itsm:localeFilterList='fr'>
 <segment>
  <source>Text A</source>
 </segment>
</unit>
<unit id='2' translate='no' itsm:localeFilterList='ja'>
 <segment>
  <source>Text B</source>
 </segment>
</unit>
        
5.9.6.3.2 Inline Elements

When the target locale in XLIFF is undefined, use the <mrk> element with the original ITS attributes.

Original:

<p>Text <span its-locale-filter-list='fr' its-locale-filter-type='exclude'>text</span></p>
      

Extraction:

<xliff srcLang='en' ...>
... 
<unit id='1'>
 <segment>
  <source>Text <pc id='1'><mrk id='m1' type='itsm:generic' 
   itsm:localeFilterList='fr' itsm:localeFilterType='exclude'>text</mrk></pc></source>
 </segment>
</unit>
        

When the target locale in XLIFF is defined, use the <mrk> element with translate='yes' if the target does apply or translate='no' if it does not. It is also recommended to keep the original ITS attributes, so the file could potentially be re-purposed (even if it has a current target).

Original:

<p>Text <span its-locale-filter-list='fr' its-locale-filter-type='exclude'>text</span></p>
      

Extraction:

<xliff srcLang='en' trgLang='fr'...>
... 
<unit id='1'>
 <segment>
  <source>Text <pc id='1'><mrk id='m1' type='itsm:generic' translate='no'
   itsm:localeFilterList='fr' itsm:localeFilterType='exclude'>text</mrk></pc></source>
 </segment>
</unit>
        
5.9.6.3.3 ITS Locale Filter Annotation

This is used to fully map to and from the [ITS] Locale Filter data category.

Usage:

  • The localeFilterList attribute is REQUIRED and used to map to and from the [ITS] defined localeFilterList attribute.

  • The type attribute is OPTIONAL and set to itsm:generic.

  • The itsm:localeFilterType attribute is OPTIONAL and used to map to and from the [ITS] defined localeFilterList attribute.

  • The translate attribute is OPTIONAL.

5.9.6.4 Localization Quality Issue

COMMENT: ADD AN EXAMPLE OF TOOLS ANNOTATION THAT PROCESSES STANDOFF MARKUP, SO THAT THE INHERITANCE OF TOOLS ANNOTATION (= RELATED TO THE ACTUAL CONTENT; NOT THE STANDOFF INFORMATION) BECOMES CLEAR. SHOW WHAT HAPPENS IF THERE ARE TWO VALUES TO STANDOFF WITH ANNOTATORSREF IN PARALLEL, E.G. THE FOLLOWING IN THE SAME <target> ELEMENT:

<mrk id="m1" type="itsm:generic" itsm:annotatorsRef="localization-quality-issue|toolXYZ1"

itsm:locQualityIssuesRef="#itsm=lqi1">c'es le conteneur</mrk>

<mrk id="m1" type="itsm:generic" itsm:annotatorsRef="localization-quality-issue|toolXYZ2"

itsm:locQualityIssuesRef="#itsm=lqi1">c'es le conteneur</mrk> ALSO NEED TO MAKE SURE THAT ANNOTATORSREF CANNOT APPEAR IN STANDOFF ELEMENT(S); THE ITS SCHEMA FOR THE STANDOFF ELEMENTS SHOULD HELP WITH THAT.

Expresses information related to localization quality assessment tasks in the form of highlighted issues. See [ITS] Localization Quality Issue for more details. COMMENT: MOST OF THE SECTIONS ARE WRITTEN LIKE EXTRACTION, BUT MOST OF THE CASES ONE WORKS WITH THE ITS INFORMATION IN AN XLIFF DOCUMENT! ACTION: CREATE SENTENCE IN INTRO PARAGRAPH THAT ITS INFO IS MOSTLY USED IN XLIFF ITSELF. ACTION: CLARIFY IN THE MODULE INTRODUCTION THAT THE TERMS "STRUCTURAL" AND "INLINE" REFER TO REPRESENTING ITS IN XLIFF DOCUMENTS. ACTION: FELIX TO CHECK ITS SCHEMA FOR THAT CONSTRAINT.

Processing Requirements

5.9.6.4.1 Structural Elements

Localization Quality Issue is not to be used at structural levels. If a structural element of the original document has [ITS] Localization Quality Issue information associated, it MUST be anyway Extracted using the ITS Localization Quality Issue Annotation. ACTION: HAVE FOR THE STANDOFF DATA CATEGORIES (E.G. LQI, LQR, ...) THE GUIDANCE THAT FOR EXTRACTING FROM E.G. HTML TO XLIFF ONE NEEDS TO CONVERT XML:ID INTO ID, CONVERSION IS NEEDED TO AVOID CLASHES IF THERE IS THE SAME ID IN MULTIPLE (HTML) FILES.

Note

If human reviewers or other QA agents (Enriching Agents from the XLIFF specification point of view), need to insert general comments pertaining to whole structural elements such as paragraphs, sections, or files rather than to specific inline portions of source or target content, the Localization Note data category is more suitable.

5.9.6.4.2 Inline Elements

Use <mrk> or an <sm/> / <em/> pair with the attributes: itsm:locQualityIssueComment, itsm:locQualityIssueEnabled, itsm:locQualityIssueProfileRef, itsm:locQualityIssuesRef, itsm:locQualityIssueSeverity, and itsm:locQualityIssueType.

See the ITS Localization Quality Issue Annotation for the normative usage description of those attributes.

Because the same or overlapping spans of source or target text can be associated with more than one quality issue, this category provides its own elements that are to be used at the unit level as an alternative to the inline only annotations, especially in cases the inline only annotations would not be expressive enough to capture the issues to be reported. If more than one quality issue applies to the same content the particulars of those issues need to be stored in standoff annotations.

For specifics of the standoff annotation, see the <locQualityIssue> and <locQualityIssues> elements and the attributes itsm:locQualityIssuesRef and id.

5.9.6.4.3 ITS Localization Quality Issue Annotation

This is used to fully map to and from the [ITS] Localization Quality Issue data category. ACTION: SOROUSH OR OTHERS TO COMPARE THIS TO CONSTRAINTS FOR LQI IN ITS SPEC, SEE https://www.w3.org/TR/its20/#lqissueDefs, AND ALIGN AS MUCH AS POSSIBLE.

Usage:

Warning

Usage of the itsm:locQualityIssuesRef attribute implies usage of Localization Quality Issue standoff elements. See <locQualityIssues> and <locQualityIssue> for related Constraints and Processing Requirements.

Example 6. Enriching XLIFF Documents with Localization Quality Issue Annotations

Simple (i.e. without stand off):

<unit id="1">
 <segment>
  <source>This is the content</source>
  <target><mrk id="m1" type="itsm:generic" itsm:locQualityIssueType="misspelling"
               itsm:locQualityIssueComment="'c'es' is unknown. Could be 'c'est'"
               itsm:locQualityIssueSeverity="50">c'es</mrk> le contenu</target>
  </segment>
</unit> 

Stand off:

<unit id="1">
 <itsm:locQualityIssues id="lqi1">
  <itsm:locQualityIssue 
       locQualityIssueType="misspelling"
       locQualityIssueComment="'c'es' is unknown. Could be 'c'est'"
       locQualityIssueSeverity="50" />
  <itsm:locQualityIssue 
       locQualityIssueType="grammar"
       locQualityIssueComment="Sentence is not capitalized"
       locQualityIssueSeverity="30" />
 </itsm:locQualityIssues>
 <segment>
  <source>This is the content</source>
  <target><mrk id="m1" type="itsm:generic"
               its:locQualityIssuesRef="lqi1">c'es le contenu</mrk></target>
 </segment>
</unit>   
5.9.6.5 Localization Quality Rating

Expresses results of localization quality assessment in the form of aggreagated ratings, either as scores or as voting results. See [ITS] Localization Quality Rating for more details.

Processing Requirements

5.9.6.5.1 Structural Elements

Localization Quality Rating is usually expressed at structural levels as it normally expresses summary rating (scoring or voting) information for larger chunks of text. Rating information inherits to lower level elements but can be overridden at lower levels.

Attributes MAY be set on XLIFF Core structural elements, so that the following advanced Constraints are met.

Constraints

5.9.6.5.2 Inline Elements

Use <mrk> or an <sm/> / <em/> pair with the following attributes: itsm:locQualityRatingProfileRef, itsm:locQualityRatingScore, itsm:locQualityRatingScoreThreshold, itsm:locQualityRatingVote, itsm:locQualityRatingVoteThreshold.

See the ITS Localization Quality Rating Annotation for the normative usage description of those attributes inline.

5.9.6.5.3 ITS Localization Quality Rating Annotation

This is used to fully map to and from the [ITS] Localization Quality Rating data category on inline elements.

Usage:

Note

This annotation can be in scope of Localization Quality Rating attributes set at structural levels. So for instance a portion of target text with only a score set can inherit threshold and/or rating profile information set at a group or file level. Also summary 0-100 ratings set at higher levels can be for instance overridden with voting set at unit or inline elements. Keep in mind that for a specific portion of text only one can exist a rating or a vote result and these are to be accompanied with different threshhold attributes. [Create example with complex behavior as described in the Note]

Example 7. Enriching XLIFF Documents with Localization Quality Rating Annotations

<unit id="1">
 <segment> 
  <source>Some text and a term</source>
  <target>Du texte et un <mrk type="itsm:generic" itsm:locQualityRatingVote="37"
    itsm:locQualityRatingVoteThreshold="15"
    its:locQualityRatingProfileRef="http://example.org/qaModel/v13">terme</mrk></target>
  </segment>
</unit>
5.9.6.5.4 Translation Candidates

In the Translation Candidates module, the [ITS] Localization Quality Rating category maps as follows:

XLIFF Core elements used within the <match> elements inherit their values from parents as usual except that their top level ancestor is <match>, not <file>.

Constraints

5.9.6.6 Text Analysis

Annotates content with lexical or conceptual information for the purpose of contextual disambiguation of words and multiword phrases meanings. See [ITS] Text Analysis for details.

Processing Requirements

5.9.6.6.1 Structural Elements

Text Analysis is not to be used at structural levels. If a structural element of the original document has [ITS] Text Analysis information associated, it MAY be Extracted using the ITS Text Analysis Annotation.

Example 8. Extraction of Text Analysis at structural levels

Original:

<p its-ta-class-ref="http://nerd.eurecom.fr/ontology#Place"
   its-ta-ident-ref="http://dbpedia.org/resource/Arizona">Arizona</p>
      

Extraction:

        ...
        <unit id="1">
         <segment>
          <source><mrk id="m1" type="itsm:generic"
               its:taClassRef="http://nerd.eurecom.fr/ontology#Place"
               its:taIdentRef="http://dbpedia.org/resource/Arizona">Arizona</mrk>
          </source>
         </segment>
        </unit>
        ...
        
5.9.6.6.2 Inline Elements

Use <mrk> or an <sm/> / <em/> pair with the following attributes: itsm:taClassRef, itsm:taConfidence, itsm:taSource, itsm:taIdent, and itsm:taIdentRef.

See the ITS Text Analysis Annotation for the normative usage description of those attributes.

5.9.6.6.3 ITS Text Analysis Annotation

This is used to fully map to and from the [ITS] Text Analysis data category.

Usage:

Warning

This annotation can be syntactically in scope of a relevant itsm:annotatorsRef attribute, while it still fails to resolve with the intended value. This can happen if more then one disambiguation providers were used. COMMENT: WARNING HAS THE SAME ISSUE AS IN OTHER PLACES.

Example 9. Extraction of ITS Text Analytics metadata in scope of the ITS tools annotation

Original:

<div its-annotators-ref="text-analysis|http://enrycher.ijs.si">
...
 <p><span its-ta-class-ref="http://nerd.eurecom.fr/ontology#Place"
its-ta-confidence="0.99"
its-ta-ident-ref="http://dbpedia.org/resource/Arizona">Arizona</span></p>
...
</div>

Extracted:

<unit id="1" itsm:annotatorsRef="text-analysis|http://enrycher.ijs.si">
 <segment>
  <source><mrk id="m1" type="itsm:generic"
               itsm:taClassRef="http://nerd.eurecom.fr/ontology#Place"
               itsm:taIdentRef="http://dbpedia.org/resource/Arizona"
               itsm:taConfidence="0.99" >
               Arizona</mrk>
  </source>
 </segment>
</unit>     

5.9.7 ITS categories available through XLIFF Core and other Modules

The following [ITS] data categories are fully available via XLIFF Core and other XLIFF modules:

5.9.7.1 Localization Note

Provides a way to communicate notes to localizers about a particular item of content. See [ITS] Localization Note for details.

5.9.7.1.1 Structural Elements

Localization Notes present in source content at structural levels are Extracted using the XLIFF Core <note> element. ITS attribute locNoteType is mapped onto the XLIFF Core attribute priority. The value alert is mapped onto priority 1. The value description is mapped onto any of the integers 2-10.

Example 10. Extraction of a Localization note at a structural level

Original:

<msgList xmlns:its= "http://www.w3.org/2005/11/its" xml:space= "preserve" its:version= "2.0">
  <data name= "LISTFILTERS_VARIANT" its:locNote= "Keep the leading space!" its:locNoteType= "alert">
    <value> Variant {0} = {1} ({2}) </value> 
  </data>
  <data its:locNote= "%1\$s is the original text's date in the format YYYY-MM-DD HH:MM always in GMT">
    <value>Translated from English content dated <span id= "version-info">%1\$s</span> GMT.</value>
  </data>
</msgList>
        

Extraction:

<file id="1" xml:space="preserve">
 <unit id="1" name="LISTFILTERS_VARIANT">
  <notes><note priority="1">Keep the leading space! </note></notes>
   <segment>
    <source> Variant {0} = {1} ({2}) </source>
   </segment>
 </unit>
 <unit id="2" name="LISTFILTERS_VARIANT">
  <notes><note priority="2">%1\$s is the original text's date in the format YYYY-MM-DD HH:MM always in GMT </note></notes>
   <segment>
    <source>Translated from English content dated <pc id="1">%1\$s</pc> GMT.</source>
   </segment>
 </unit>
</file>
        

Warning

The values of the ITS attribute locNoteRef are to be dereferenced during Extraction, so that the Localization Note text can be included verbatim in the XLIFF <note> element. A corresponding attribute is NOT provided through the ITS Module to discourage external references from XLIFF Notes. The locNoteRef attribute and its value still can be preserved on Extraction via extensibility, however this information will not have a guaranteed roundtrip protection and the XLIFF Note itself still better include the dereferced Localization Note text.

5.9.7.1.2 Inline Elements

Localization Notes present on inline spans of source content are Extracted using the XLIFF Core Annotations mechanism. Use <mrk> or an <sm/> / <em/> pair with type="comment". See Comment Annotation.

Comment Annotations can either contain the Localization Note text as the value of the attribute value or otherwise have to reference a <note> element within the same enclosing <unit>. In case no <note> element is referenced, it is assumed that the ITS locNoteType is description. In case the referenced <note> element has priority 1 or does not have the priority attribute set explicitly, the ITS locNoteType is alert. Explicitely set values 2-10 map onto the ITS locNoteType value description.

Example 11. Extraction of an inline Localization Note

Original:

<!DOCTYPE html>
<htmllang=en>
  <head>
    <metacharset=utf-8>
    <title>LocNote test: Default</title>
  </head>
  <body>
    <p>This is a 
      <spanits-loc-note="Check with terminology engineer" its-loc-note-type= alert>
      motherboard</span>.
    </p>
  </body>
</html>     

Extraction:

<xliff version="2.1" srcLang="EN"
  <file id=1>
   <unit id='1'>
     <notes>
        <note id="1" priority="1">Check with terminology engineer</note>
     </notes>
     <segment>
       <source>This is a 
         <mrk id="1" type="comment" ref="#n=1">motherboard</mrk>.</source>
     </segment>
   </unit>
  </file>
<xliff>        
5.9.7.2 Preserve Space

Indicates how to handle whitespace in a given content portion. See [ITS] Preserve Space for details.

5.9.7.2.1 Structural Elements

Whitespace handling at the structural level is indicated with xml:space in XLIFF Core and extensions:

Example 12. Extraction of preserved whitespace at the structural level

Original:

<listing xml:space='preserve'>Line 1
Line 2</listing>
        

Extraction:

<unit id='1' xml:space='preserve'>
 <segment>
  <source>Line 1
Line 2</source>
 </segment>
</unit>
        

5.9.7.2.2 Inline Elements

It is not possible to use [XML namespace] on XLIFF inline elements. It is advised that mixed Preserve Space behavior is NOT used inline in source formats. The advised way to extract content with mixed Preserve Space behavior is for the Extractor agent to perform the following:

  1. Normalize the whitespace in the content as needed, i.e. preserving whitespace spans where they need to be preserved, normalizing elsewhere.

  2. Then, extract the content with ???xml:space set to preserve on the structural level, i.e. unit or higher.

Note

Even in case Extractors don't perform the normalization step, it is safer to set ???xml:space to preserve on the structural level, since any potentially superfluous whitespace characters can be removed by human Agents during translation or editing, whereas inheriting of the default value default could lead to irreversible loss of significant whitespace characters.

Whitespace handling can be also set independently for text segments and ignorable text portions within an Extracted unit and for the source and target language within the same <segment> or <ignorable> element using the OPTIONAL xml:space attribute at the <source> and <target> elements.

It is important to note that the value of the xml:space attribute is restricted to preserve on the <data> element.

5.9.7.3 Translate

Indicates whether content is translatable or not. See [ITS] Translate for details.

ITS data category Translate in source content influences how Extractors prepare source content for Translation via XLIFF Documents.

5.9.7.3.1 Structural Elements

Use the translate attribute:

Example 13. Extraction of Translate at structural levels

Original:

        <p translate='yes'>Translatable text</p>
        <p translate='no'>Non-translatable text</p>
      

Extraction:

        <unit id='1' translate="yes">
          <segment>
            <source>Translatable text</source>
          </segment>
        </unit>
        <unit id='2' translate="no">
          <segment>
            <source>Non-translatable text</source>
          </segment>
        </unit>
        

If an element is not translatable you can also simply not extract it.

5.9.7.3.2 Inline Elements

Use <mrk> or an <sm/> / <em/> pair with translate='yes|no'. A fall-back option is to extract the non-translatable content as inline code. However, it is worth noting that Extracting non-translatable text as inline code data can hide important context information from translators, human or machine. The Extraction as code data is preferable if the non-translatable text has purely programmatic purpose and bears no linguistic relationship to the surrounding translatable text.

Example 14. Extraction of non-translatable inline text using Annotation markers

Original:

        <p>Text <code translate='no'>Code</code></p>
      

Extraction:

        <unit id='1'>
          <segment>
            <source>Text <pc id='1'/><mrk id='m1' translate='no'>Code</mrk></pc></source>
          </segment>
        </unit>
        

or

Example 15. Hiding of non-translatable inline text using an inline code

       <unit id='1'>
          <segment>
            <source>Text <ph id='1'/></source>
          </segment>
       </unit>     
      
5.9.7.4 External Resource

Indicates that a node represents or references potentially translatable data in a resource outside the document. Examples of such resources are external images and audio or video files. See [ITS] External Resource for details.

5.9.7.4.1 Structural Elements

External Resource is not to be used at structural levels. If a structural element of the original document has [ITS] External Resource information associated, it MAY be Extracted using the XLIFF Resource Data Module. The instructor needs to determine the mime type of the external resource, since this is not available via [ITS] External Resource information.

Example 16. Extraction of External Resource at structural levels

Original:


<its:rules version="2.0" xmlns:its="http://www.w3.org/2005/11/its"
 xmlns:html="http://www.w3.org/1999/xhtml">
 <its:externalResourceRefRule selector="//html:video/@src"
  externalResourceRefPointer="."/>
 <its:externalResourceRefRule selector="//html:video/@poster"
  externalResourceRefPointer="."/>
</its:rules> ..
<video
 height=360
 poster=video-image.png
 src=http://www.example.com/video/v2.mp
 width=640>
 
      

Extraction:

...
<res:resourceData>
      <res:resourceItem id="r1" mimeType="image/png" context="no">
        <res:source href="video-image.png" />
      </res:resourceItem>
    </res:resourceData>
...
        
5.9.7.4.2 Inline Elements

External resources is Extracted using the XLIFF Resource Data module. Use a <res:source> element as a child of a <res:resourceItem>element.

Example 17. Extraction of External Resource at inline levels

Original:


<!doctype html>
<html lang="en">
 <head>
  <meta charset="utf-8">
  <title>Data Category: External Resource</title>
  <script type="application/its+xml">
   <its:rules xmlns:its="http://www.w3.org/2005/11/its" version="2.0" xmlns:h="http://www.w3.org/1999/xhtml">
    <its:externalResourceRefRule selector="//h:img" externalResourceRefPointer="@src"/>
   </its:rules>
  </script>
 </head>
 <body>
  <p>Image: <img src="example.png" alt="Text for the image"></p>
 </body>
</html>
 
      

Extraction:


<res:resourceData>
      <res:resourceItem id="r1" mimeType="image/png" context="no">
        <res:source href="example.png" />
      </res:resourceItem>
    </res:resourceData>
...
        

5.9.8 ITS categories that have a partial overlap with XLIFF features

The following [ITS] data cetegories are partially covered with XLIFF Core or Modules other than the ITS Module:

5.9.8.1 Language Information

Indicates the natural langauge in which content is expressed. See [ITS] Language Information for details.

5.9.8.1.1 Structural Elements

XLIFF Documents are normally bilingual, hence the source and target language are indicated at the top level using the srcLang and trgLang attributes set on the xliff element. The Language Information values set on the top level, strictly constrain the values of xml:lang set or inherited on the <source> element for source content and on the <target> element for target content.

Note

Because XLIFF Documents are normally source-monolingual, whole paragraphs in the source document that are not in the main source language are generally not to be extracted. If there is a need to extract such content into a single XLIFF Documents, the XLIFF output has to use the inline Annotations mechanism together with the ITS Language Information Annotation, because the structurally set or inherited source language is constrained by the XLIFF Core srcLang attribute value. Analogaically, the structurally set target language is constrained by the trgLang attribute value. Thus also paragrpahs other than in the main target language have to be inline annotated using the same mechanism.

5.9.8.1.2 Inline Elements

It is not possible to use [XML namespace] on XLIFF inline elements. It is advised that content in different languages is NOT used inline in source formats. Still there are use cases for mixed language use inline, like referencing non-localized UI or hardwrae elements, discussing foreign vocabulary or analyzing poetry in the original language using short inline examples. These scenarios cannot be fully supported with XLIFF Core only.

In case the inlie elements in other than the main language are not supposed to be translated (e.g. referenced non localized UI or hardware elements), they can be marked as not translatable uisng the XLIFF Core Translate annotation. However, the specific Language Information would not be readily accessible during the roundtrip if not combined with the Language Information Annotation defined here in the ITS Module.

Note

If there is a need to make the different language information available throughout the roundtrip, the XLIFF output has to use the inline Annotations mechanism together with the ITS Language Information Annotation, because the structurally set and thus inherited inline source language is constrained by the XLIFF Core srcLang attribute value. Analogaically, the structurally set (and inline inherited) target language is constrained by the trgLang attribute value. Thus also inline portions in other than the main target language have to be inline annotated using the same mechanism.

Warning

Preserving source elements content that is in other than the main source language as original data stored outside of the translatable content at the unit level and referenced from placeholder codes is NOT advised, as important context would be very likely hidden from translators, human or machine.

Example 18. Core only extraction and roundtrip of a non localized hardware reference in other than the main source language

Original:

 <p>
   Use the <span class="HWbutton" xml:lang="DE-DE">Aus</span> button to completely switch off the machine.
 </p>
     

Extraction:

<unit id='1'>
  <originalData>
    <data id="d1">&lt;span class="HWbutton" xml:lang="DE-DE"></data>
    <data id="d2">&lt;/span></data>
  </originalData>
  <segment>
    <source>
      Use the <pc id="1" dataRefStart="d1" dataRefEnd="d2"><mrk id=2 translate="no">Aus</mrk></pc>
      button to completely switch off the machine.
    </source>
  </segment>
</unit>
        

Please note that the Language Information has been preserved for Merging back in the referenced original data, is however not availble in an interoperable way during the roundtrip.

5.9.8.1.3 ITS Language Information Annotation

This is used to fully map to and from the [ITS] Language Information data category, including full inline support that cannot be provided via the XLIFF Core due to normative Constraints.

Usage:

  • The id attribute is REQUIRED.

  • The itsm:lang attribute is REQUIRED.

  • The type attribute is OPTIONAL and set to itsm:generic.

  • The translate attribute is OPTIONAL.

Example 19. Extraction of Language Information

Original:

<!doctype html>
<html lang="en">
 <head>
  <meta charset="utf-8">
  <title>My Document</title>
 </head>
 <body>
  <p>Span of text <span lang="fr">en français</span>.</p>
 </body>
</html>
        

Extraction:

...
<unit id='2'>
 <segment>
  <source>Span of text <pc id='1'><mrk id="m1" itsm:lang="fr" type="itsm:generic"
   >en français</mrk></pc>.</source>
 </segment>
</unit>
...        
5.9.8.2 MT Confidence

communicates the confidence score from a machine translation engine for the accuracy of a translation it has provided [ITS] MT Confidence for details.

Warning

MT Confidence is not intended to provide a score that is comparable among or between Machine Translation engines and platforms. This data category does NOT aim to establish any sort of correlation between the confidence score and either human evaluation of MT usefulness, or post-editing cognitive effort.

5.9.8.2.1 Within the Translation Candidates module

The most natural step to introduce the MT Confidence metadata into the multilingual content life cycle is during the XLIFF roundtrip, when the XLIFF Document is being Enriched with Translation Candidates from a specific MT Service or via an MT Services broker. The MT Confidence metadata included with the MT provided matches MAY be used by human or machine Modifiers who populate the XLIFF Core <target> elements with matches.

In the Translation Candidates Module, there is a partial overlap between the [ITS] MT Confidence and XLIFF-defined features. See the mtConfidence attribute for the mapping details, Advanced Constraints and Processing Requirements.

Example 20. MT Confidence as Translation Candidates metadata

<xliff xmlns="urn:oasis:names:tc:xliff:document:2.0" 
       xmlns:mtc="urn:oasis:names:tc:xliff:matches:2.0"
       xmlns:itsm="urn:oasis:names:tc:xliff:itsm:2.1"
       version="2.0" srcLang="en" trgLang="fr">
  <file id="f1" itsm:annotatorsRef="mt-confidence|MTServices-XYZ">
   <unit id="1">
    <mtc:matches>
       <!-- Score provided by MTServices-XYZ -->
       <mtc:match ref="#m1" matchQuality="89.82">
        <source>Text</source>
        <target >Texte</target>
    </mtc:match>
       <!-- Score provided by MTProvider-ABC -->
       <mtc:match ref="#m1" matchQuality="67.8"
              itsm:annotatorsRef="mt-confidence|MTProvider-ABC">
        <source>Text</source>
        <target >Texte</target>
     </mtc:match>
     <!-- Score provided by MTProvider-JKL -->
     <mtc:match ref="#m1" matchQuality="65"
              itsm:annotatorsRef="mt-confidence|MTProvider-JKL">
        <source>Text</source>
        <target >texte</target>
     </mtc:match>
     <!-- Score provided by MTServices-XYZ -->
     <mtc:match ref="#m1" matchQuality="89.82">
        <source>Some text</source>
        <target>Du texte</target>
     </mtc:match>
    </mtc:matches>
    <segment>
       <source><mrk id='m1' type='mtc:match'>Text</mrk></source>
    </segment>
   </unit>
  </file>
</xliff>        
        
      

Warning

Generic ITS Processors cannot directly read MT Confidence data from the XLIFF Translation Candidates Module because ITS 2.0 does not define a global pointer for this data category.

5.9.8.2.2 Structural Elements

It is NOT advised that [ITS] MT Confidence be used at a structural level because meaningful MT Confidence scores will vary from segment to segment. If a structural element of an original document has an [ITS] MT Confidence annotation, it MAY be represented upon Extraction using the MT Confidence Inline Annotation. The whole unit source content MUST be enclosed within the annotation in such a case, possibly spanning multiple segments.

5.9.8.2.3 Inline Elements

Example 21. Extraction of ITS MT Confidence Metadata from a Raw MTed source document

Original:

 <p>
   <span its:mtConfidence="0.8982" its:annotatorsRef="mt-confidence|MTServices-XYZ">Some Machine Translated text.
   </span>
 </p>
     

Extraction from a raw MT original:

<unit id="u1">
  <segment>  
    <source>
     <mrk id="m1" type="itsm:generic"
      itsm:mtConfidence="0.8982"
      itsm:annotatorsRef="mt-confidence|MTServices-XYZ"
       >Some Machine Translated text.</mrk>
    </source>
  </segment> 
</unit>       
5.9.8.2.4 MT Confidence Annotation

This is used to fully map to and from the [ITS] MT Confidence data category in XLIFF Core.

Usage:

Warning

This annotation can be syntactically in scope of a relevant itsm:annotatorsRef attribute, while it still fails to resolve with the intended value. This can happen if more then one MT and/or MT Confidence providers were used.

Example 22. Populating XLIFF Core targets with raw MT along with ITS MT Confidence metadata

Original:

 <p>
   Some human authored text for translation.
 </p>
     

Extracted text Enriched with a Machine Translated candidate and the same candidate inserted into the core target:

<unit id="u1">
  <mtc:matches>
     </mtc:match>
       <mtc:match ref="#m1" matchQuality="67.8"
              itsm:annotatorsRef="mt-confidence|GoogleTranslate">
        <source xml:lang="EN">Some human authored text for translation.</source>
        <target xml:lang="CS">Některé lidské napsaný text určený k překladu .</target>
     </mtc:match>
  </mtc:matches>
  <segment>  
    <source xml:lang="EN">
      Some human authored text for translation.
    </source>
    <target xml:lang="CS">
     <mrk id="m1" type="itsm:generic"
      itsm:mtConfidence="0.678"
      itsm:annotatorsRef="mt-confidence|GoogleTranslate">
      Některé lidské napsaný text určený k překladu .
     </mrk>
    </target>
  </segment> 
</unit>       

Raw MT Merged back into the original format with MT Confidence metadata:

 <p>
   <span its:mtConfidence="0.678" its:annotatorsRef="mt-confidence|GoogleTranslate">
   Některé lidské napsaný text určený k překladu .
   </span>
 </p>
     

Processing Requirements

Warning

The MT Confidence Annotations need to be removed whenever the original MT is modified, no matter if by human post-editors or some automated post-editing methods. This is however not enforceable since the subsecquent Modifiers might not be aware of the ITS Module data. Thus it is not advised to transfer the MT Confidence data onto XLIFF Core targets if any sort of post editing is foreseen or possible in the subsesquent steps of the XLIFF Roundtrip. Preserving the MT Confodence data in XLIFF Core <target> elements only makes sense if the data needs to be preserved throughout Merging back to the original format, for instance for data analytic purposes or to color code the raw MTed target text for the end user based on the MT Confidence scores.

5.9.8.3 Provenance

Communicate the identity of agents that have been involved in the translation of the content or the revision of the translated content. This allows translation and translation revision consumers, such as post-editors, translation quality reviewers, or localization workflow managers, to assess how the performance of these agents may impact the quality of the translation. Translation and translation revision agents can be identified as a person, a piece of software or an organization that has been involved in providing a translation or revision that resulted in the selected content. See [ITS] Provenance for more details.

Warning

Provenance data category is used to record human, tools or organizational producers of Translations or revisions, in other words it records producers of the payload. To record [ITS] metadata producers, the ITS Tools Referencing mechanism needs to be used.

Processing Requirements

5.9.8.3.1 Structural Elements

Provenance metadata are more likely to appear on structural elements than on inline elements in source and target documents, therefore Provenance attributes listed in the above Processing Requirement are allowed on all structural levels.

It is possible that Provenance metadata will be Extracted from source content but more likely Provenance metadata will be first introduced into the translated content during the XLIFF based roundtrip.

Example 23. Provenance metadata added by Modifiers or Enrichers on structural levels

In this example a person of the name Honza Novák has been the translator of the whole unit content and Franta Kocourek the reviser of the whole translation.

...
  <unit id="1" itsm:person="Honza Novák" itsm:revPerson="Franta Kocourek">
    <segment>
      <source>Economy has been growing in 2016.</source>
      <target>Hospodářství v průběhu roku 2016 rostlo.</mrk></target>
    </segment>
    <segment>
      <source>Prognosis for 2017 is unclear.</source>
      <target>Předpověď očekávaného růstu pro rok 2017 je nejasná.</target>
  </unit>
...        
      

Preserving the Provenance metadata in the target content after Merging the Translations back to the original format can be useful, the metadata could be for instance used in a check in and publishing process within a content management system.

Example 24. Provenance metadata preserved by Mergers in the native format.

In this example the translator and reviser Provenance metadata introduced during the XLIFF roundtrip has been preserved after Merging of the Translations back to HTML.

...
    <p its-person="Honza Novák" its-rev-person="Franta Kocourek">
    Hospodářství v průběhu roku 2016 rostlo. Předpověď očekávaného růstu pro rok 2017 je nejasná.
    </p>
...        
      

If standoff Provenance elements are used at structural levels, these need to occur on the same or an ancestor element of the element where the standoff reference is used. See the itsm:provenanceRecordsRef

5.9.8.3.2 Inline Elements

Use <mrk> or an <sm/> / <em/> pair with the Provenance data category attributes listed in the above Processing Requirement.

See the ITS Provenance Annotation for the normative usage description of those attributes inline.

Because the same or overlapping spans of source or target text can be associated with more than one Provenance record, for instance over time, this category provides its own elements that are to be used at the unit level as a more expressive alternative to the inline only annotations.

For specifics of the standoff annotation, see the <provenanceRecord> and <provenanceRecords> elements and the attributes provenanceRecordsRef and id.

5.9.8.3.3 ITS Provenance Annotation

This is used to fully map to and from the [ITS] Provenance data category when used inline.

Usage:

Warning

Usage of the itsm:provenanceRecordsRef attribute implies usage of Provenance standoff elements. See <provenanceRecords> and <provenanceRecord> for related Constraints and Processing Requirements.

Example 25. Enriching XLIFF Documents with Provenance Annotations

Inline only (i.e. without stand off):

...
  <unit id='1'>
   <segment>
      <source>Economy has been growing in 2016.</source>
      <target>
        <mrk id="m1" type="itsm:generic" itsm:tool="Microsoft Hub" itsm:person="Honza Novák"
         itsm:revPerson="Franta Kocourek">
        Hospodářství v průběhu roku 2016 rostlo.
        </mrk>
      </target>
   </segment>
   <segment>
      <source>Prognosis for 2017 is unclear.</source>
      <target>
        <mrk id="m2" type="itsm:generic" itsm:tool="Microsoft Hub" itsm:person="Honza Novák">
        Předpověď očekávaného růstu pro rok 2017 je nejasná.
        </mrk>
      </target>
   </segment>
  </unit>
...

In this example, both segments were translated by Microsoft Hub and by Honza Novák from Překlady Novák, sro. The first segment was also revised by Franta Kocourek from Kocourkov s.r.o., while the second segment hasn't been revised. Because order of attributes cannot have semantics in XML, we can only speculate about the order in which the people and tools had contributed to the workflow.

Stand off:

...
  <unit id='1'>
   <itsm:provenanceRecords id="prov1">
      <provenanceRecord revPerson="Franta Kocourek" revOrg="Kocourkov s.r.o."/>
      <provenanceRecord person="Honza Novák" org="Překlady Novák, sro" tool="GreatCATTool"/>
      <provenanceRecord tool="Microsoft Hub"/>  
   </itsm:provenanceRecords>
   <itsm:provenanceRecords id="prov2">
      <provenanceRecord revPerson="Květoň Zřídkaveselý" revOrg="CoolCopy"/>
      <provenanceRecord revTool="ACME QA Checker" revOrg="CoolCopy"/>
      <provenanceRecord revPerson="Franta Kocourek" revOrg="Kocourkov s.r.o."/>      
      <provenanceRecord person="Honza Novák" org="Překlady Novák, sro" tool="GreatCATTool"/>
      <provenanceRecord tool="Microsoft Hub"/>
   </itsm:provenanceRecords>

   <segment>
      <source>Economy has been growing in 2016.</source>
      <target>
        <mrk id="m1" type="itsm:generic" itsm:provenanceRecordsRef="#itsm=prov1">
        Hospodářství v průběhu roku 2016 rostlo.
        </mrk>
      </target>
   </segment>
   <segment>
      <source>Prognosis for 2017 is unclear.</source>
      <target>
        <mrk id="m2" type="itsm:generic" itsm:provenanceRecordsRef="#itsm=prov2">
        Hospodářství v průběhu roku 2016 rostlo.
        </mrk>
      </target>
   </segment>
  </unit>
...

In this example, stacking of the individual records indicates relative time, so both segments were first translated by Microsoft Hub, then by Honza Novák from Překlady Novák, sro using GreatCATTool. Both segments were subsequently revised by Franta Kocourek from Kocourkov s.r.o. (using an unknown revision tool), and finally, the second segment has been revised at CoolCopy by a tool ACME QA Checker and once more by a human Květoň Zřídkaveselý from CoolCopy. Indicating both the first and second revisers, as well as the sequence of different translation tools would have been impossible if the annotation was inline only.

5.9.8.4 Terminology

Marks terms and optionally associates them with information, such as definitions. See [ITS] Terminology for details.

ITS Terminology information is useful during Translation and related localization processes. Thus it is beneficial when Extractors preserve the ITS Terminology information in XLIFF Documents.

Target language terminology data and metada introduced during the Translation can be Merged back into the target language content in the original format.

Warning

The XLIFF Core Term Annotation does not support all aspects of the [ITS] Terminology data category. For instance, the XLIFF Core Term Annotation cannot be used to mark a span as not a term, which is needed to map ITS term="no". In case lossless roundtrip of this category needs to be achieved, the Core Annotation needs to be extended as defined by the ITS Terminology Annotation.

5.9.8.4.1 Structural Elements

Even if ITS Terminology metadata appears on structural elements in the source format, this information needs to be Extracted using the XLIFF Core Annotations mechanism. Use <mrk> or an <sm/> / <em/> pair with type="term". See Term Annotation.

Example 26. Extraction of Terminology from structural elements

Original:

        <p its-term='yes'>Term</p>
      

Extraction:

       <unit id='1'>
         <segment>
           <source><mrk id="m1" type="term">Term</mrk></source>
         </segment>
       </unit>
        
5.9.8.4.2 Inline Elements

Inline Terminology information MAY be Extracted using the XLIFF Core Annotations mechanism. Use <mrk> or an <sm/> / <em/> pair with type="term". See Term Annotation.

Example 27. Extraction of inline Terminology using Annotation markers

Original:

        <p>Text with a <span its-term='yes'>term</span>.</p>
      

Extraction:

        <unit id='1'>
          <segment>
            <source>Text with a <pc id='1'><mrk id="m1" type="term">term</mrk></pc>.</source>
          </segment>
        </unit>
        
5.9.8.4.3 ITS Terminology Annotation

This is used to fully map to and from the [ITS] Terminology data category, including the aspects that are not supported via the XLIFF Core Term Annotation.

Usage:

  • The id attribute is REQUIRED.

  • The type attribute is REQUIRED and set:

    • either to itsm:term-no, which maps to and from the [ITS] defined term attribute set to no,

    • or to term, which maps to and from the [ITS] defined term attribute set to yes.

  • Not more than one of the following two attributes MAY be set:

    • The value attribute is OPTIONAL and contains a short definition of the term that an Extractor obtained by dereferencing the [ITS] defined termInfoPointer or added by an Enricher.

    • The ref attribute is OPTIONAL and used to map to and from the [ITS] defined termInfoRef attribute.

  • The translate attribute is OPTIONAL.

  • The itsm:termConfidence attribute is OPTIONAL and used to map to and from the [ITS] defined termConfidence attribute.

  • The itsm:annotatorsRef attribute is REQUIRED if and only if the itsm:termConfidence attribute is present and NOT in scope of another relevant itsm:annotatorsRef attribute, in all other cases it is OPTIONAL.

Warning

This annotation can be syntactically in scope of a relevant itsm:annotatorsRef attribute, while it still fails to resolve with the intended value. This can happen if more then one terminology providers were used. COMMENT: HARD TO UNDERSTAND THE INTENTION OF THE WARNING, NEEDS REWRITING OR SHOULD BE DROPPED.

Example 28. Extraction of ITS Terminology with termConfidence

<div its-annotators-ref="terminology|http://example.org/TermService">
...
 <p>Text with a <span its-term='yes' its-term-info-ref='http://en.wikipedia.org/wiki/Terminology'
 its-term-confidence='0.9'>term</span>.</p>
...
</div>

Extracted:

  <unit id='1' its:annotatorsRef='terminology|http://example.com/termchecker'>
    <segment>
     <source>Text with a <pc id="1"><mrk id="m1" type="term"
     ref="http://en.wikipedia.org/wiki/Terminology"
     itsm:termConfidence="0.9">term</mrk></pc>.</source>
    </segment>
  </unit>      
     
5.9.8.5 Storage Size

Mapping for this metadata category has not been specified in XLIFF Version 2.1

Processing Requirements

Note

An XLIFF-defined common profile could be made part of this module in a future Version of XLIFF.

5.9.9 ITS categories that do not represent metadata after Extraction of content into XLIFF

The following [ITS] data categories can be represented via Extraction and Merging behavior of XLIFF conformant Agents without including any ITS specific metadata in the XLIFF Documents:

5.9.9.1 Directionality

The Directionality data category allows the user to specify the base writing direction of blocks, embeddings, and overrides for the Unicode bidirectional algorithm [add normative biblio]. In XLIFF the usage of this data category along the ITS lines is discouraged, since XLIFF provides its own mechanism to specify directionality [Link to core Directionality mechanism].

5.9.9.2 Elements Within Text

The Elements Within Text data category reveals if and how an element affects the way text content behaves from a linguistic viewpoint. This information is for example relevant to provide basic text segmentation hints for tools such as translation memory systems. See [ITS] Elements Within Text for details.

The Elements Within Text data category is used by ITS processors to generate XLIFF documents. This process is done by ITS processors, not by XLIFF Writers or other types of XLIFF implementations, to understand how to extract source content. The data category is not represented directly in XLIFF Documents.

The data category provides three values: yes, no and nested. See the ITS 2.0 specification for examples of how to use these values in general XML vocabularies or in HTML. The below examples show how to deal with the values in XLIFF.

COMMENT: THE BELOW EXAMPLES AND THE WHOLE SECTION RATHER ADDRESSES ITS PROCESSORS, NOT XLIFF IMPLEMENTATIONS. SO THIS MAY NOT BE NEEDED IN THIS SPEC AT ALL. THERE COULD BE AN APPENDIX THAT SHOWS HOW AN ITS PROCESSOR WOULD RESULT IN XLIFF. THE APPENDIX COULD CONTAIN ALL THE GUIDANCE FOR AN XLIFF EXTRACTOR DEPLOYING ITS. THAT IS TRUE FOR ALL EXAMPLES IN THE XLIFF 2.1 DRAFT THAT MAP ITS INFORMATION INTO XLIFF.

5.9.9.2.1 Elements Within Text Value Yes

The element should be mapped to one of the XLIFF 2.1 inline elements: <pc>, <sc>/<ec> or <ph>, while its content is extracted.

Example for using pc - Original:

...
   <p>This paragraph contains <span its-within-text="yes">a spanned part</span>.</p>
...
      

Extraction:

        ...
<unit id="u1">
 <originalData>
  <data id="d1">&lt;span its-within-text="yes"&gt;</data>
  <data id="d2">&lt;/span&gt;</data>
 </originalData>
 <segment>
 <source>This paragraph contains <pc id="pc1" dataRefStart="d1"
  dataRefEnd="d2">a spanned part </pc>.
 </source>
 </segment>
</unit>
        ...
        

Example for using sc/ec - Original:

...
 <p>A paragraph where <u>the formatted text appears in more than one
 segment. The second sentence here.</u></p>
...
      

Extraction:

        ...
<unit id="u1">
   <originalData>
      <data id="d1">&lt;u&gt;</data>
      <data id="d2">&lt;/u&gt;</data>
   </originalData>
   <segment>
      <source>A paragraph where <sc id="sc1" dataRef=”d1” type="fmt"
              subType="xlf:u"/>the formatted text takes more than one
              segment.  
      </source>
   </segment>
   <segment>
      <source> The second sentence here.<ec dataRef=”d2”
              startRef="sc1"/>
      </source>
   </segment>
</unit>
        ...
        

Example for using ph - Original:

...
   <p>This sentence has a breakpoint<br/>inside.</p>
...
      

Extraction:

        ...
<unit id="u1">
   <originalData>
      <data id="d1">&lt;br/&gt;</data>
   </originalData>
   <segment>
      <source>This sentence has a breakpoint<ph id="ph1" dataRef="d1"
              type=”fmt” subType=”xlf:lb”/>inside.
      </source>
   </segment>
</unit>
        ...
        
5.9.9.2.2 Elements Within Text Value Nested

The sub-flow (i.e. element’s content) should be stored in a different unit while the original element is replaced by a ph element and order of the flow defined by the subFlows attribute. COMMENT: NEED TO REFINE THE EXAMPLE E.G. WITH AN IMAGE WHICH HAS THEN A TITLE AND AN ALT ATTRIBUTE; IMAGE WOULD NOT BE FROM HTML SINCE ATTRIBUTES ARE NOT TAKEN INTO ACCOUNT IN ELEMENTS WITHIN TEXT; MAYBE USE DITA OR DOCBOOK "FIGURE" ELEMENTS?

Example - Original:

...
   <p>This paragraph has a textarea embeded textarea; <textarea title="Additional Information" 
    its-within-text="nested">Add content    
      here...</textarea>.</p>
...
      

Extraction:

        ...
<unit id="u1">
   <segment>
      <source>Additional Information</source>
   </segment>
</unit>
<unit id="u2">
   <segment>
      <source>Add content here...</source>
   </segment>
</unit>
<unit id="u3">
   <segment>
      <source>This paragraph has a textarea embeded textarea; <ph
              id="ph1" subFlows="u1 u2"/></source>
   </segment>
</unit>        ...
        

All the sub-flows and the unit element which invokes them must be in the same file element.

5.9.9.2.3 Elements Within Text Value No

In XLIFF 2.1 such element content should be stored in separate unit elements.

Example - Original:

...
   <ul>
      <li>First sentence</li>
      <li>Second sentence</li>
   </ul>
...
      

Extraction:

        ...
<unit id="u1">
   <segment>
    <source>First sentence</source>
   </segment>
  </unit>
  <unit id="u2">
   <segment>
    <source>Second sentence</source>
   </segment>
</unit>
        ...
        
5.9.9.3 ID Value

The ID Value data category indicates a value that can be used as a unique identifier for a given part of the content. As XLIFF 2.1 identifiers are not globally unique, this data category does not have any correspondence in XLIFF. Still the id information could be represented in XLIFF 2.1. E.g. if there is an HTML file with id attributes, the attributes could be stored as names (e.g. with the XLIFF name attribute) or ids (with the XLIFF id attribute) in XLIFF, but being unique per XLIFF file (not per XLIFF document). COMMENT: ADD AN EXAMPLE OF HOW E.G. HTML ID ATTRIBUTES END UP IN XLIFF 2.1. dF: Maybe this should be moved to partial overlap?

5.9.9.4 Locale Filter

Dependent on workflow specifics and business requirements, this data category can be fully represented by Extraction and Merging behavior without explicitly representing Locale Filter metadata in XLIFF Documents. See the ITS Module for the normative description of how this metadata can be explicitly represented if needed. COMMENT: MAKE CLEAR THAT THERE ARE TWO HANDLINGS, ONE IS NOT TO REPRESENT THE DATA CATEGORY, THE OTHER IS IN THE MODULE. THE EXTRACTION IS FOR ITS PROCESSORS GENERATING XLIFF, THE DIRECT REPRESENTATION IS FOR XLIFF PROCESSORS.

5.9.9.5 Target Pointer

Is used to associate the node of a given source content (i.e., the content to be translated) and the node of its corresponding target content (i.e., the source content translated into a given target language). See [ITS] Target Pointer for details.

This data category is not mapped to XLIFF but used by extracting and merging tools to get the source content from the original document and put back the translated content at its proper location.

Note that ITS processors working on XLIFF documents should use the following rule to locate the source and target content:

<its:targetPointerRule selector="//xlf:source" targetPointer="../xlf:target"/>
  

5.9.10 ITS Mapping Annotations

This lists all custom Annotations that are needed for [ITS] support in XLIFF Documents but are not available through XLIFF Core Annotations or other module specific annotations. Use of XLIFF Core Annotations for the ITS Mapping purposes is described in sections ITS categories available through XLIFF Core and ITS categories that have a partial overlap with XLIFF features sections of this ITS Module.

The following is the summary of internal links to all relevant Annotations:

5.9.11 Module Elements

The ITS Module defines the following elements:

<locQualityIssue>, <locQualityIssues>, <provenanceRecord>, and <provenanceRecords> .

5.9.11.1 Tree Structure

Legend:

1 = one
+ = one or more
? = zero or one
* = zero, one or more
<locQualityIssues>
|
+---<locQualityIssue> +
  
<provenanceRecords>
|
+---<provenanceRecord> +
  
5.9.11.2 locQualityIssue

Localization Quality Issue - a standoff element to hold information about a single [ITS] defined Localization Quality Issue.

Contains:

This element is always empty.

Parents:

- <locQualityIssues>

Attributes:

- locQualityIssueType, OPTIONAL
- locQualityIssueComment, OPTIONAL
- locQualityIssueSeverity, OPTIONAL
- locQualityIssueProfileRef, OPTIONAL
- locQualityIssueEnabled, OPTIONAL

Constraints

Processing Requirements

5.9.11.3 locQualityIssues

Localization Quality Issues - a standoff wrapper element to group any number of single issue elements related to the same span of source or target content.

Contains:

- One or more <locQualityIssue> elements

Parents:

- <unit>

Attributes:

- id , REQUIRED

Constraints

Processing Requirements

5.9.11.4 provenanceRecord

Provenance Record - a standoff element to hold information of a single [ITS] defined Provenance Record.

Contains:

This element is always empty.

Parents:

- <provenanceRecords>

Attributes:

- itsm:org, OPTIONAL
- itsm:orgRef, OPTIONAL
- itsm:person, OPTIONAL
- itsm:personRef, OPTIONAL
- itsm:revOrg, OPTIONAL
- itsm:revOrgRef, OPTIONAL
- itsm:revPerson, OPTIONAL
- itsm:revPersonRef, OPTIONAL
- itsm:revTool, OPTIONAL
- itsm:revToolRef, OPTIONAL
- itsm:tool, OPTIONAL
- itsm:toolRef, OPTIONAL

Processing Requirements

5.9.11.5 provenanceRecords

Provenance Records - a standoff wrapper element to group any number of single Provenance Record elements related to the same span of source or target content.

Contains:

- One or more <itsm_provenanceRecord> elements

Parents:

- <unit>
- <group>
- <file>

Attributes:

- id , REQUIRED

Constraints

Processing Requirements

5.9.12 Module Attributes

The attributes defined in the ITS Module are: allowedCharacters, annotatorsRef, domains, id, lang, localeFilterList, localeFilterType, locQualityIssueComment, locQualityIssueEnabled, locQualityIssueProfileRef, locQualityIssuesRef, locQualityIssueSeverity, itsm:locQualityIssueType, locQualityRatingProfileRef, locQualityRatingScore, locQualityRatingScoreThreshold, locQualityRatingVote, locQualityRatingVoteThreshold, mtConfidence, org, orgRef, person, personRef, provenanceRecordsRef, revOrg, revOrgRef, revPerson, revPersonRef, revTool, revToolRef, taClassRef, taConfidence, taIdent, taIdentRef, taSource, termConfidence tool toolRef ... WIP, more to be added

5.9.12.1 Allowed Characters

AllowedCharacters - the allowedCharacters attribute exactly corresponds to the [ITS] defined allowedCharacters attribute. See the allowedCharacters definition in the [ITS] specification for details on the purpose of the attribute and permitted values.

Value description: See the allowedCharacters definition in the [ITS] specification.

Default value: none.

Used in: <mrk> and <sm>.

See the ITS Allowed Characters Annotation for the normative usage description of this attribute when used inline; advanced Constraints follow from that normative usage description.

5.9.12.2 annotatorsRef

Annotators Reference - the annotatorsRef attribute holds provenance information about tools that produced [ITS] metadata. See [ITS] Tools Annotation mechanism. COMMENT: THE ONLY THING THAT CHANGES FOR ANNOTATORS REF IS THE NAMESPACE. WE SHOULD NOT ADD MORE CONSTRAINT DESCRIPTIONS AND TERMINOLOGY, E.G: "TRIPLES", AND JUST REFER TO THE ITS SPEC.

Value description:

The value is a text string following the below outlined Constraints. COMMENT: DEFAULT VALUE IS OK, WRT TO CONSTRAINTS WE SHOULD JUST POINT TO THE ITS SPEC.

Default value:: default values for this attribute depend on the element in which it is used:

Constraints

  • Values of the annotatorsRef MUST consist of triples of the following parts in the exact order:

    1. ITS Data category identifier, see the table below for admissible values. No other values MUST be used.

    2. character | VERTICAL LINE (U+007C) as the separator

    3. IRI

  • The text string MUST be composed from space separated triples or comprise exactly one triple.

  • Each ITS data category identifier MUST NOT be used more than once.

  • The space separated triples MUST be ordered alphabetically as per the ITS Data category identifier.

Table 9. ITS Data category identifiers COMMENTS: WE SHOULD JUST POINT TO THE LIST OF DATA CATEGRIES IN THE ITS SPEC.

1.allowed-charactersfor Allowed Characters
2.directionalityfor Directionality
3.domainfor Domain
4.elements-within-textfor Elements Within Text
5.external-resourcefor External Resource
6.id-valuefor ID Value
7.language-informationfor Language Information
8.locale-filterfor Locale Filter
9.localization-notefor Localization Note
10.localization-quality-issuefor Localization Quality Issue
11.localization-quality-ratingfor Localization Quality Rating
12.mt-confidencefor MT Confidence
13.preserve-spacefor Preserve Space
14.provenancefor Provenance
15.storage-sizefor Storage Size
16.target-pointerfor Target Pointer
17.terminologyfor Terminology
18.text-analysisfor Text Analysis
19.translatefor Translate

Note

The IRI part of the value string is used as the annotator identifier. The semantics of how the IRI identifies the ITS producing tool is not prescribed. Possible mechanisms are for instance: to encode information directly in the IRI, as parameters or similar; to reference an external resource that provides such information, an XML file, an RDF declaration and so on; or to reference another part of the document that provides such information. COMMENT: NODE NOT NEEDED HERE, JUST REFER TO THE ITS SPEC.

Used in: <file> <group> <unit>, <mrk>, <sm>, <mtc:match>, <ctr:revisions>, or <ctr:revision> .

Processing Requirements

  • When resolving any actual local value of the annotatorsRef attribute, Modifiers and Enrichers MUST combine the actual set value with all default values inherited from higher levels as follows:

    On any given node, the information provided by this mechanism is a space-separated list of the accumulated references (triples) found in the annotatorsRef attributes declared in the enclosing elements and sorted by data category identifiers. For each data category, the IRI part is the one of the inner-most declaration. COMMENT: AGAIN DON'T REPEAT THE CONTENT FROM THE ITS SPEC RATHER REFER TO IT.

See the ITS Tools Annotation for the normative usage description of this attribute inline.

5.9.12.3 domains

Domains - the domains attribute expresses the [ITS] Domain data category.

Value description: The value is a text string, however commas if present separate distinct domain values within the string.

Default value:: default values for this attribute depend on the element in which it is used:

  • When used in <file>:

    The value is undefined.

  • When used in any other admissible structural element (<group> or <unit>):

    The value of the domains attribute of its parent element (which can be undefined).

  • When used in annotations markers <mrk> or <sm>:

    The value of the domains attribute of the innermost <mrk>, <unit>, or <mtc:match> element, element, in which the marker in question is located (which can be undefined).

  • When used in the <mtc:match> element:

    The value is undefined.

Used in: <file> <group> <unit>, <mrk>, <sm>, and <mtc:match>.

See the ITS Domain Annotation for the normative usage description of this attribute inline.

5.9.12.4 id

Identifier - a character string used to identify a <locQualityIssues> or <provenanceRecords> element.

Value description: NMTOKEN

Default value: undefined

Used in:<locQualityIssues> and <provenanceRecords>.

Constraints

5.9.12.5 lang

Language information - the lang attribute specifies the language variant of the text of a given inline span of source or target content. For example: itsm:lang="fr-FR" indicates the French language as spoken in France.

Value description: A language code as described in [BCP 47].

Default value:

The value of the xml:lang or itsm:lang attribute set or inherited on the parent element of the <mrk> or <sm> element in question.

Used in: <mrk> and <sm>.

See the ITS Language Information Annotation for the normative usage description of this attribute.

Note

itsm:lang is an attribute analogical to xml:lang. Unlike xml:lang, it is allowed on inline Annotations. The normative behavior of this attribute results from the XLIFF Core behavior as further specified by the ITS Language Information Annotation.

5.9.12.6 localeFilterList

LocaleFilterList - the localeFilterList attribute exactly corresponds to the [ITS] defined localeFilterList attribute. See the localeFilterList definition in the [ITS] specification for details on the purpose of the attribute and permitted values.

Value description: See the localeFilterList definition in the [ITS] specification.

Default value: "*".

Used in: <mrk> and <sm>.

See the ITS Locale Filter Annotation for the normative usage description of this attribute when used inline; advanced Constraints follow from that normative usage description.

5.9.12.7 localeFilterType

LocaleFilterType - the localeFilterType attribute exactly corresponds to the [ITS] defined localeFilterType attribute. See the localeFilterType definition in the [ITS] specification for details on the purpose of the attribute and permitted values.

Value description: See the localeFilterType definition in the [ITS] specification.

Default value: "include".

Used in: <mrk> and <sm>.

See the ITS Locale Filter Annotation for the normative usage description of this attribute when used inline; advanced Constraints follow from that normative usage description.

5.9.12.8 locQualityIssueComment

Localization Quality Issue Comment - the locQualityIssueComment attribute exactly corresponds to the [ITS] defined locQualityIssueComment attribute.

This attribute is intended for human readable comments pertaining to or guidance how to address a specific Localization Quality Issue.

Value description: text string.

Default value:: undefined

Used in: <mrk> and <sm>, or in <locQualityIssue>.

See the ITS Localization Issue Annotation for the normative usage description of this attribute when used inline; advanced Constraints follow from that normative usage description.

See <locQualityIssue> for standoff usage Constraints.

5.9.12.9 locQualityIssueEnabled

Localization Quality Issue Enabled - the locQualityIssueEnabled attribute exactly corresponds to the [ITS] defined locQualityIssueEnabled attribute.

This is a flag to enable or disable a particular issue.

Value description: yes when issue enabled , no otherwise.

Default value: yes.

Note

The attribute locQualityIssueEnabled set to no can be used for instance to disable false positives that were produced by an automated QA tool.

Used in: <mrk> and <sm>, or in <locQualityIssue>.

See the ITS Localization Issue Annotation for the normative usage description of this attribute when used inline; advanced Constraints follow from that normative usage description. See <locQualityIssue> for standoff usage Constraints.

5.9.12.10 locQualityIssueProfileRef

Localization Quality Issue Quality Model Profile Reference - the locQualityIssueProfileRef attribute exactly corresponds to the [ITS] defined locQualityIssueProfileRef attribute.

This attribute references a quality model that has been used to identify and evaluate a particular issue.

Value description: IRI.

Default value: undefined

Note

It is strongly advised that the IRI value of the locQualityIssueProfileRef attribute is resolvable, so that human evaluators can find out about the referenced Quality Model.

Used in: <mrk> and <sm>, or in <locQualityIssue>.

See the ITS Localization Issue Annotation for the normative usage description of this attribute when used inline; advanced Constraints follow from that normative usage description.

See <locQualityIssue> for standoff usage Constraints.

5.9.12.11 locQualityIssuesRef

Localization Quality Standoff Reference - the locQualityIssuesRef attribute maps to and from the [ITS] defined locQualityIssuesRef attribute.

This attribute references the collection of Localization Issues that pertain to the content span from where the reference is declared.

Value description: NMTOKEN

Default value: undefined.

Used in: <mrk> and <sm>.

See the ITS Localization Issue Annotation for the normative usage description of this attribute.

Constraints

Processing Requirements

5.9.12.12 locQualityIssueSeverity

Localization Quality Issue Severity - the locQualityIssueSeverity attribute exactly corresponds to the [ITS] defined locQualityIssueSeverity attribute.

This attribute provides the severity score for a particular issue, the higher the number the higher the severity. Tools are expected to interpret this score within their own severity rating system.

Value description: a decimal number between 0.0 and 100.0.

Default value: undefined

Warning

The locQualityIssueSeverity attribute is intended to be used in concert with the ??? attribute that is to provide information on the applicable Quality Model. Without providng quality model information, the severity score between 0 and 100 is very likely to be useless and not interoperable.

Used in: <mrk> and <sm>, or in <locQualityIssue>.

See the ITS Localization Quality Issue Annotation for the normative usage description of this attribute when used inline; advanced Constraints follow from that normative usage description.

See <locQualityIssue> for standoff usage Constraints.

5.9.12.13 locQualityIssueType

Localization Quality Issue Type - the locQualityIssueType attribute exactly corresponds to the [ITS] defined locQualityIssueType attribute.

Value description: a text string, exactly one value from the following list:

terminology
mistranslation
omission
untranslated
addition
duplication
inconsistency
grammar
legal
register
locale-specific-content
locale-violation
style
characters
misspelling
typographical
formatting
inconsistent-entities
numbers
markup
pattern-problem
whitespace
internationalization
length
non-conformance
uncategorized
other

For normative usage description and informative guidance for the above values, see [ITS] http://www.w3.org/TR/its20/#lqissue-typevalues.

Default value:: undefined

Used in: <mrk> and <sm>, or in <locQualityIssue>.

See the ITS Localization Issue Annotation for the normative usage description of this attribute when used inline; advanced Constraints follow from that normative usage description.

See <locQualityIssue> for standoff usage Constraints.

5.9.12.14 locQualityRatingProfileRef

Localization Quality Rating Quality Model Profile Reference - the locQualityRatingProfileRef attribute exactly corresponds to the [ITS] defined locQualityRatingProfileRef attribute.

This attribute references a quality assessment model that has been used for the rating (either scoring or voting).

Value description: IRI.

Default value: default values for this attribute depend on the element in which it is used:

Note

It is strongly advised that the IRI value of the locQualityRatingProfileRef attribute is resolvable, so that human evaluators can find out about the referenced Quality Assessment Model.

Used in: <file> <group> <unit>, <mrk>, <sm>, and the <mtc:match> element..

See the ITS Localization Rating Annotation for the normative usage description of this attribute when used inline; advanced Constraints follow from that normative usage description.

See Localization Quality Rating on Structural Elements for advanced Constraints when used on strcutural elements (<file>, <group>, and <unit>).

See Localization Quality Rating in Translation Candidates Module for advanced Constraints when used within the Translation Candidates Module.

5.9.12.15 locQualityRatingScore

Localization Quality Rating Score - the locQualityRatingScore attribute exactly corresponds to the [ITS] defined locQualityRatingScore attribute.

This attribute provides the quality rating score pertaining to a structural or inline portion of target text, the higher the number the better the quality rating. Tools are expected to interpret this score within their own quality rating system.

Value description: a decimal number between 0.0 and 100.0.

Default value: default values for this attribute depend on the element in which it is used:

Warning

The locQualityRatingScore attribute is intended to be used in concert with the locQualityRatingProfileRef attribute that is to provide information on the applicable Quality Assessment Model and with the locQualityRatingScoreThreshold attribute. Without providng quality assessment model information and/or an acceptance threshold, the score between 0 and 100 is very likely to be useless and not interoperable.

Used in: <file>, <group>, <unit>, <mrk>, and <sm>.

Constraints

See the ITS Localization Quality Rating Annotation for the normative usage description of this attribute when used inline; advanced Constraints follow from that normative usage description.

See Localization Quality Rating on Structural Elements for advanced Constraints when used on strcutural elements (<file>, <group>, and <unit>).

See Localization Quality Rating in Translation Candidates Module for advanced Constraints when used within the Translation Candidates Module.

5.9.12.16 locQualityRatingScoreThreshold

Localization Quality Rating Score Threshold - the locQualityRatingScoreThreshold attribute exactly corresponds to the [ITS] defined locQualityRatingScoreThreshold attribute.

This attribute provides the quality rating score threshold pertaining to any locQualityRatingScore attribute in scope. Scores under the given threshold indicte a quality check fail.

Value description: a decimal number between 0.0 and 100.0.

Default value: default values for this attribute depend on the element in which it is used:

Warning

The locQualityRatingScoreThreshold attribute is intended to be used in concert with the locQualityRatingProfileRef attribute that is to provide information on the applicable Quality Assessment Model. Without providng quality assessment model information behind the acceptance threshold, the score between 0 and 100 is very likely to be useless and not interoperable.

Used in: <file>, <group>, <unit>, <mrk>, and <sm>.

See the ITS Localization Quality Rating Annotation for the normative usage description of this attribute when used inline; advanced Constraints follow from that normative usage description.

See Localization Quality Rating on Structural Elements for advanced Constraints when used on strcutural elements (<file>, <group>, and <unit>).

See Localization Quality Rating in Translation Candidates Module for advanced Constraints when used within the Translation Candidates Module.

5.9.12.17 locQualityRatingVote

Localization Quality Rating Vote - the locQualityRatingVote attribute exactly corresponds to the [ITS] defined locQualityRatingVote attribute.

This attribute provides the quality rating voting (crowd assessment) results pertaining to a structural or inline portion of target text, the higher the number the more positive votes or the better margin of positive votes over negative votes. Tools are expected to interpret this value within their own quality rating system.

Value description: an Integer.

Default value: default values for this attribute depend on the element in which it is used:

Warning

The locQualityRatingVote attribute is intended to be used in concert with the locQualityRatingScoreThreshold attribute, that encodes the vote's success or failure criteria and ideally also the locQualityRatingProfileRef attribute that is to provide information on the applicable Quality Assessment Model. Without providng a success threshold or quality assessment model information, the integer encoding the voting (crowd assessment) results is very likely to be useless and not interoperable.

Used in: <file>, <group>, <unit>, <mrk>, <sm>, and <mtc:match>.

See the ITS Localization Quality Rating Annotation for the normative usage description of this attribute when used inline; advanced Constraints follow from that normative usage description.

See Localization Quality Rating on Structural Elements for advanced Constraints when used on strcutural elements (<file>, <group>, and <unit>).

See Localization Quality Rating in Translation Candidates Module for advanced Constraints when used within the Translation Candidates Module.

5.9.12.18 locQualityRatingVoteThreshold

Localization Quality Rating Vote Threshold - the locQualityRatingVoteThreshold attribute exactly corresponds to the [ITS] defined locQualityRatingVoteThreshold attribute.

This attribute provides the minimum passing vote threshold for any Localization Quality Rating Votes that are in scope of the ??? attribute.

Value description: an Integer.

Default value: default values for this attribute depend on the element in which it is used:

Warning

The locQualityRatingVoteThreshold attribute is intended to be used in concert with the locQualityRatingProfileRef attribute that is to provide information on the applicable Quality Assessment Model. Without providng the quality assessment model information, the voting threshold integer is very likely to be useless and not interoperable.

Used in: <file>, <group>, <unit>, <mrk>, <sm>, and <mtc:match>.

See the ITS Localization Quality Rating Annotation for the normative usage description of this attribute when used inline; advanced Constraints follow from that normative usage description.

See Localization Quality Rating on Structural Elements for advanced Constraints when used on strcutural elements (<file>, <group>, and <unit>).

See Localization Quality Rating in Translation Candidates Module for advanced Constraints when used within the Translation Candidates Module.

5.9.12.19 mtConfidence

Machine Translation Confidence - the mtConfidence attribute exactly corresponds to the [ITS] defined mtConfidence attribute.

Value description: floating point number between 0 and 1.

The number represents the self reported confidence of the application or service providing the MT Confidence metadata, the higher the better.

Default value:: undefined

Used in: <mrk>, and <sm>.

Constraints

See the ITS MT Confidence Annotation for the full normative usage description of this attribute. Other advanced Constraints follow from that normative usage description.

Processing Requirements

5.9.12.20 org

Organization - the org attribute exactly corresponds to the [ITS] defined org attribute.

Value description: Text

The text string is supposed to identify an organizational translation agent as per Organizational provenance information.

Default value: default values for this attribute depend on the element in which it is used:

Used in: <file>, <goup>, <unit>, <mrk>, <sm>, <provenanceRecord>, <mtc:match>, and <ctr:revision>.

See the ITS Provenance Annotation for the normative usage description of this attribute on inline elements. Advanced Constraints follow from that normative usage description.

5.9.12.21 orgRef

Organization Reference - the orgRef attribute exactly corresponds to the [ITS] defined orgRef attribute.

Value description: IRI

The IRI is supposed to resolve as human or machine readable Organizational provenance information.

Default value: default values for this attribute depend on the element in which it is used:

Used in: <file>, <goup>, <unit>, <mrk>, <sm>, <provenanceRecord>, <mtc:match>, and <ctr:revision>.

See the ITS Provenance Annotation for the normative usage description of this attribute on inline elements. Advanced Constraints follow from that normative usage description.

5.9.12.22 person

Person - the person attribute exactly corresponds to the [ITS] defined person attribute.

Value description: Text

The text string is supposed to identify a human translation agent as per Human provenance information.

Default value: default values for this attribute depend on the element in which it is used:

Used in: <file>, <goup>, <unit>, <mrk>, <sm>, <provenanceRecord>, <mtc:match>, and <ctr:revision>.

See the ITS Provenance Annotation for the normative usage description of this attribute on inline elements. Advanced Constraints follow from that normative usage description.

5.9.12.23 personRef

Person Reference - the personRef attribute exactly corresponds to the [ITS] defined personRef attribute.

Value description: IRI

The IRI is supposed to resolve as human or machine readable Human provenance information.

Default value: default values for this attribute depend on the element in which it is used:

Used in: <file>, <goup>, <unit>, <mrk>, <sm>, <provenanceRecord>, <mtc:match>, and <ctr:revision>.

See the ITS Provenance Annotation for the normative usage description of this attribute on inline elements. Advanced Constraints follow from that normative usage description.

5.9.12.24 provenanceRecordsRef

Provenance Records Standoff Reference - the provenanceRecordsRef attribute maps to and from the [ITS] defined provenanceRecordsRef attribute.

This attribute references the collection of Provenance Records that pertain to the content span or structural element content from where the reference is declared.

Value description: IRI

Default value: undefined.

Used in: <file>, <goup>, <unit>, <mrk>, <sm>, <mtc:match>, and <ctr:revision>.

See the ITS Localization Issue Annotation for the normative usage description of this attribute inline.

Constraints

Processing Requirements

5.9.12.25 revOrg

Organization - the revOrg attribute exactly corresponds to the [ITS] defined revOrg attribute.

Value description: Text

The text string is supposed to identify an organizational translation agent as per Organizational provenance information.

Default value: default values for this attribute depend on the element in which it is used:

Used in: <file>, <goup>, <unit>, <mrk>, <sm>, <provenanceRecord>, <mtc:match>, and <ctr:revision>.

See the ITS Provenance Annotation for the normative usage description of this attribute on inline elements. Advanced Constraints follow from that normative usage description.

5.9.12.26 revOrgRef

Revision Organization Reference - the revOrgRef attribute exactly corresponds to the [ITS] defined revOrgRef attribute.

Value description: IRI

The IRI is supposed to resolve as human or machine readable Organizational revision provenance information.

Default value: default values for this attribute depend on the element in which it is used:

Used in: <file>, <goup>, <unit>, <mrk>, <sm>, <provenanceRecord>, <mtc:match>, and <ctr:revision>.

See the ITS Provenance Annotation for the normative usage description of this attribute on inline elements. Advanced Constraints follow from that normative usage description.

5.9.12.27 revPerson

Revision Person - the revPerson attribute exactly corresponds to the [ITS] defined revPerson attribute.

Value description: Text

The text string is supposed to identify a human translation revision agent as per Human revision provenance information.

Default value: default values for this attribute depend on the element in which it is used:

Used in: <file>, <goup>, <unit>, <mrk>, <sm>, <provenanceRecord>, <mtc:match>, and <ctr:revision>.

See the ITS Provenance Annotation for the normative usage description of this attribute on inline elements. Advanced Constraints follow from that normative usage description.

5.9.12.28 revPersonRef

Revision Person Reference - the revPersonRef attribute exactly corresponds to the [ITS] defined revPersonRef attribute.

Value description: IRI

The IRI is supposed to resolve as human or machine readable Human revision provenance information.

Default value: default values for this attribute depend on the element in which it is used:

Used in: <file>, <goup>, <unit>, <mrk>, <sm>, <provenanceRecord>, <mtc:match>, and <ctr:revision>.

See the ITS Provenance Annotation for the normative usage description of this attribute on inline elements. Advanced Constraints follow from that normative usage description.

5.9.12.29 revTool

Revision Tool - the revTool attribute exactly corresponds to the [ITS] defined revTool attribute.

Value description: Text

The text string is supposed to identify a software tool translation revision agent as per Tool-related revision provenance information.

Default value: default values for this attribute depend on the element in which it is used:

Used in: <file>, <goup>, <unit>, <mrk>, <sm>, <provenanceRecord>, <mtc:match>, and <ctr:revision>.

See the ITS Provenance Annotation for the normative usage description of this attribute on inline elements. Advanced Constraints follow from that normative usage description.

5.9.12.30 revToolRef

Revision Tool Reference - the revToolRef attribute exactly corresponds to the [ITS] defined revToolRef attribute.

Value description: IRI

The IRI is supposed to resolve as human or machine readable Tool-related revision provenance information.

Default value: default values for this attribute depend on the element in which it is used:

Used in: <file>, <goup>, <unit>, <mrk>, <sm>, <provenanceRecord>, <mtc:match>, and <ctr:revision>.

See the ITS Provenance Annotation for the normative usage description of this attribute on inline elements. Advanced Constraints follow from that normative usage description.

5.9.12.31 taClassRef

Text Analysis Class Reference - the taClassRef attribute exactly corresponds to the [ITS] defined taClassRef attribute.

Value description: IRI

The IRI is supposed to resolve as human or machine readable Entity type / concept class information.

Default value:: undefined

Used in: <mrk>, and <sm>.

See the ITS Text Analysis Annotation for the normative usage description of this attribute. Advanced Constraints follow from that normative usage description.

5.9.12.32 taConfidence

Text Analysis Confidence - the taConfidence attribute exactly corresponds to the [ITS] defined taConfidence attribute.

Value description: floating point number between 0 and 1.

The number represents the self reported confidence of the application or service providing the Text Analysis metadata, the higher the better.

Default value:: undefined

Used in: <mrk>, and <sm>.

Constraints

See the ITS Text Analysis Annotation for the full normative usage description of this attribute. Other advanced Constraints follow from that normative usage description.

5.9.12.33 taIdent

Text Analysis Concept Identifier - the taIdent attribute exactly corresponds to the [ITS] defined taIdent attribute.

Value description: text string

The text string is supposed to be a human or machine redable identifier of a concept within a collection of text analysis concept resources, in the sense of an identifier of the concept in the collection.

Default value:: undefined

Used in: <mrk>, and <sm>.

Constraints

  • When the attribute taIdent is set, the taSource attribute MUST be set as well.

See the ITS Text Analysis Annotation for the full normative usage description of this attribute. Other advanced Constraints follow from that normative usage description.

5.9.12.34 taIdentRef

Text Analysis Identifier - the taIdentRef attribute exactly corresponds to the [ITS] defined taIdentRef attribute.

Value description: IRI

The IRI is supposed to reference an external resource for the disambiguated entity in the sense of identifier of the text analysis target.

Default value:: undefined

Used in: <mrk>, and <sm>.

See the ITS Text Analysis Annotation for the normative usage description of this attribute. Advanced Constraints follow from that normative usage description.

5.9.12.35 taSource

Text Analysis Source - the taSource attribute exactly corresponds to the [ITS] defined taSource attribute.

Value description: text string

The text string is supposed to be a human or machine redable name of a collection of text analysis concept resources, in the sense of an identifier of the collection source.

Default value:: undefined

Used in: <mrk>, and <sm>.

Constraints

  • When the attribute taSource is set, the taIdent attribute MUST be set as well.

See the ITS Text Analysis Annotation for the full normative usage description of this attribute. Other advanced Constraints follow from that normative usage description.

5.9.12.36 termConfidence

Terminology Confidence - the termConfidence attribute exactly corresponds to the [ITS] defined termConfidence attribute.

Value description: floating point number between 0 and 1.

The number represents the self reported confidence of the application or service providing the Terminology metadata, the higher the better.

Default value:: undefined

Used in: <mrk>, and <sm>.

Constraints

See the ITS Terminology Annotation for the full normative usage description of this attribute. Other advanced Constraints follow from that normative usage description.

5.9.12.37 tool

Tool - the tool attribute exactly corresponds to the [ITS] defined tool attribute.

Value description: Text

The text string is supposed to identify a software tool translation agent as per Tool-related provenance information.

Default value: default values for this attribute depend on the element in which it is used:

Used in: <file>, <goup>, <unit>, <mrk>, <sm>, <provenanceRecord>, <mtc:match>, and <ctr:revision>.

See the ITS Provenance Annotation for the normative usage description of this attribute on inline elements. Advanced Constraints follow from that normative usage description.

5.9.12.38 toolRef

Tool Reference - the toolRef attribute exactly corresponds to the [ITS] defined toolRef attribute.

Value description: IRI

The IRI is supposed to resolve as human or machine readable Tool-related provenance information.

Default value: default values for this attribute depend on the element in which it is used:

Used in: <file>, <goup>, <unit>, <mrk>, <sm>, <provenanceRecord>, <mtc:match>, and <ctr:revision>.

See the ITS Provenance Annotation for the normative usage description of this attribute on inline elements. Advanced Constraints follow from that normative usage description.

5.9.13 Examples:

Example 29. ITS Category Example 1

What does the example demonstrate.. etc

  To be created

Appendix A Media Type Registration Template for XLIFF Version 2.0 and higher Versions

This Appendix is based on the Committee Specification 01 of the Media Type Registration Template for XLIFF Version 2.0 published on 22 September 2014, which is also the latest version of the Registration Template, as the TC decided to merge the template (with some necessary editorial updates) with this XLIFF Version 2.1 specification. Additionally, the Security Considerations have been substantially expanded based on an IESG Expret feedback, as per this archived converstaion https://lists.oasis-open.org/archives/xliff/201502/msg00004.html. XLIFF 2.0 was provisionally registered as application/xliff+xml in the IANA Provisional Standard Media Type Registry.

This Appendix content will be used to seek final media type registration for XLIFF Version 2.0 and higher Versions (including this XLIFF Versions 2.1).

A.1 Regsitration Template

  • Type name: application

  • Subtype name: xliff+xml

  • Required parameters: N/A

  • Optional parameters: N/A

  • Encoding considerations:

    Same as encoding considerations of application/xml as specified in [RFC 7303]

  • Security considerations:

    Apart from all of the security considerations described in [RFC 7303], XLIFF Vesrion 2.0 and higher has the following Security considerations:

    Extensibility: XLIFF permits extensions. Hence it is possible that application xliff+xml may describe content that has security implications beyond those described here.

    Direct external reference mechanisms: An XLIFF document has a number of attributes of the type URI or IRI, all of which may be dereferenced and some of them should be dereferenced. Therefore, the security issues of [RFC 3987] Section 8 should be considered. In addition, the contents of resources identified by file: URIs can in some cases be accessed, processed and returned as results.

    More details can be found in the Detailed Security Considerations section of this Appendix.

  • Interoperability considerations:

    Same as interoperability considerations described in [RFC 7303]

    Also, interoperability requirements are specified throughout the specification and summarized in its Conformance Section.

  • Published specification:

    XLIFF Version 2.0 (OASIS Standard) http://docs.oasis-open.org/xliff/xliff-core/v2.0/os/xliff-core-v2.0-os.html will be superseded by XLIFF Version 2.1 (OASIS Standard) http://docs.oasis-open.org/xliff/xliff-core/v2.1/os/xliff-core-v2.1-os.html that was last published on 14 October 2016 in the Committee Specification Draft 01 / Public Review Draft 01 (csprd01) stage at http://docs.oasis-open.org/xliff/xliff-core/v2.1/xliff-core-v2.1.html and is backwards compatible with XLIFF Version 2.0.

  • Applications that use this media type:

    XLIFF conformant applications, according to the Conformance Section of this specification

  • Fragment identifier considerations:

    Generic XML processors won't be able to resolve XLIFF fragment identifiers, as the fragment identification syntax is specific for XLIFF and has been defined in its Fragment Identification section as of csd03/csprd03 of XLIFF Version 2.0.

  • Intended usage: COMMON

  • Restrictions on usage: N/A

  • Author:

    OASIS XML Localisation Interchange File Format (XLIFF) TC Editors: Tom Comerford, <tom@supratext.com>; David Filip, <david.filip@adaptcentre.ie>; Yves Savourel, <ysavourel@enlaso.com>

  • Change controller:

    OASIS XML Localisation Interchange File Format (XLIFF) TC https://www.oasis-open.org/committees/xliff/

    Bryan Schnabel, <bryan.s.schnabel@tektronix.com>, Chair

    Tom Comerford, <tom@supratext.com>, Secretary

    David Filip, <david.filip@adaptcentre.ie>, Secretary

  • Provisional registration? (standards tree only): NO

  • Additional information:

    • Deprecated alias names for this type: N/A

    • Magic number(s): N/A

    • File extension(s): xlf

    • Macintosh file type code(s): "TEXT"

  • Person & email address to contact for further information:

    OASIS Technical Committee administration <tc-admin@oasis-open.org>

A.1.1 Detailed Security Considerations

A.1.1.1 Privacy, trust and integrity

XLIFF is a format for localization and translation, privacy, trust and integrity requirements will widely depend on the type of content that is being exchanged translating end user manuals for a dishwasher will have lower privacy requirements than translating clinical tests results for a pharma company.

The XLIFF format does not offer any internal mechanisms to provide privacy, convey trust or verify the integrity of XLIFF documents. If such features are needed varies from case to case. Implementations that will process documents in cases where one or more of these features are required need to implement that outside of the XLIFF format. Transport privacy may for example be provided by SSL/TLS. Storage privacy could be implemented by encrypting the XLIFF content using XML encryption or some other appropriate means. Likewise the trust and integrity checks could be implemented using XML signatures or by some other technology that is appropriate for the particular implementation.

A.1.1.2 Core

<skeleton> via attribute href

There is no requirement that an implementation dereference and load the skeleton. But it must be assumed that some do. An implementation is free to provide any type of resource as the skeleton including executables.

<mrk> via attribute ref for Term Annotations and some custom annotations

For term annotations there may be a risk by downloading or directing the user to access an external resource. For custom annotations the same applies but an implementation is not required to process the ref attribute on custom annotations but it must be expected that some will. Especially the term annotation one may be an issue as a reasonable implementation may just launch the URI expecting a web browser or viewer application to handle it.

A.1.1.3 Resource Data Module

<res:source> via attribute href

<res:target> via attribute href

Both of these may reference executable or otherwise unsafe external data. Either as a resource that need processing or to present additional information to the user from a resource of arbitrary type. Essentially the same considerations as for the term annotation in core applies here especially for reference material. The intent is to present arbitrary typed data to the user.

A.1.1.4 ITS Module

As the ITS Module brings a large number of ITS features natively to XLIFF, Security considerations of application/its+xml, as described in [ITS] https://www.w3.org/TR/its20/#its-mime-type should be taken into consideration, albeit largely overlapping with XLIFF general Security considerations described above.

A.1.1.5 Other potentially security sensitive constructs
A.1.1.5.1 Extension by arbitrary XML on <file>, <group> and <unit>

Allows embedding of arbitrary XML structures at these points.

A.1.1.5.2 Extension by custom attributes on <xliff>, <file>, <group>, <unit>,<note>,<mrk> and <sm>

Custom attribute extension is likely not as sensitive as embedding of arbitrary XML structures and will not in itself pose any threat except potentially for the implementers of the extension.

A.1.1.5.3 Format Style Module

Uses HTML element names as values of the attribute fs

Validating allowed element names may decrease risk, but due to the attribute subFs cannot eliminate it. Attribute subFs allows arbitrary additional attributes for injection into HTML elements defined in the fs attributes. This could be used to inject active content such as JavaScript into the preview HTML document or reference external resources. Implementations need to take normal precautions when rendering, as if rendering an arbitrary page on the web unless it can know for sure it can trust the document. XLIFF itself does not provide a facility to communicate trust or protect a document from modification. If such features are needed they must be implemented external the XLIFF format.

Actual consumable HTML is only produced by implementers of this modules via XSLT or similar.

Appendix B Machine Readable Validation Artifacts (Informative)

This appendix summarizes information on machine readable validation artifacts for XLIFF Version 2.1

  1. XLIFF Core [XML Schema],

    http://docs.oasis-open.org/xliff/xliff-core/v2.1/csprd01/schemas/xliff_core_2.0.xsd

  2. [XML Catalog] of XLIFF Defined XML Schemas,

    http://docs.oasis-open.org/xliff/xliff-core/v2.1/csprd01/schemas/catalog.xml

  3. Master [NVDL] file governing validation of all XLIFF Defined namespaces by XML Schemas, Schematron Schemas and other rules if and as required,

    http://docs.oasis-open.org/xliff/xliff-core/v2.1/csprd01/schemas/xliff_2_advanced_validation.nvdl

  4. XLIFF Core [Schematron] Schema,

    http://docs.oasis-open.org/xliff/xliff-core/v2.1/csprd01/schemas/xliff_core_2.1.sch

  5. XML and Schematron Schemas of XLIFF Modules are referenced from those modules.

The basic grammar and structure of XLIFF 2.1 is defined using nine (9) XML Schemas and one (1) XML catalog. The module schemas are specifically referenced from their respective modules.

Advanced static Constraints and dynamic Processing Requirements that could not be expressed using [XML Schema] 1.0 are expressed in nine (9) Schematron schemas.

Relationships among all of the above mentioned machine readable validation artifacts provided as part of this multipart product is expressed using one (1) NVDL schema.

B.2 Support Schemas

Third party support schemas that are normatively referenced from this specification or from the machine readable artifacts that are a part of this multipart product are distributed along with the XLIFF-defined schemas in a subfolder named informativeCopiesOf3rdPartySchemas and further subdivided in folders according to the owner/maintainer of the schema.

Warning

Schema copies in this sub-folder are provided solely for implementers convenience and are NOT a part of the OASIS multipart product. These schemas belong to their respective owners and their use is governed by their owners' respective IPR policies. The support schemas are organized in folders per owner/maintainer. It is the implementer's sole responsibility to ensure that their local copies of all schemas are the appropriate up to date versions.

Currently the only included third party support schema is http://www.w3.org/2001/xml.xsd [http://www.w3.org/2009/01/xml.xsd] at http://docs.oasis-open.org/xliff/xliff-core/v2.1/csprd01/schemas/informativeCopiesOf3rdPartySchemas/w3c/xml.xsd in this distribution.

Appendix C Specification Change Tracking (Informative)

C.1 High Level Summary of Changes made in Comparison to XLIFF Version 2.0

This is to facilitate human tracking of changes between XLIFF Versions 2.1 and 2.0.

  1. Two major features are being added in XLIFF Version 2.1:

    1. Advanced Validation methods

    2. Native Support for ITS 2.0

  2. The Change Tracking Module has undergone a major overhaul based on feedback from the community registered at XLIFF Symposia. The overall working of the Change Tracking Module did not change but it now allows inclusion of XLIFF Core elements up to <segment> or <ignorable> in the Change Track <item> elements and all inline elements in <simpleItem>elements. It now also allows for inclusion of original data that can be referenced from items.

  3. Apart from the three major changes mentioned above, numerous editorial bugfixes were made to secure greater clarity, either by fixing example errors or omissions, or by reorganizing normative content, so that the intent becomes clear and unequivocal at some troublesome places highlighted by XLIFF 2.0 implementers.

    Nevertheless, the practical workings of the XLIFF Core hasn't been affected and none of the changes have affected the core namespace "urn:oasis:names:tc:xliff:document:2.0" or the XLIFF Core [XML Schema], http://docs.oasis-open.org/xliff/xliff-core/v2.1/csprd01/schemas/xliff_core_2.0.xsd that expresses its basic grammar and structure.

Appendix D Acknowledgements (Informative)

The following individuals have participated in the creation of this specification and are gratefully acknowledged:

  • Comerford, Tom - Individual

  • Estreen, Fredrik - Lionbridge

  • Filip, David - TCD, ADAPT Centre (formerly Localisation Research Centre)

  • King, Ryan - Microsoft

  • Morado Vázquez, Lucía - University of Geneva

  • Phil Ritchie - Vistatec

  • Soroush Saadatfar, Localisation Research Centre

  • Felix Sasaki - Individual

  • Savourel, Yves - ENLASO Corporation

  • Schnabel, Bryan - Individual

xliff-core-v2.1-csprd01
Standards Track Work Product

Copyright © OASIS Open 2016. All rights reserved.
14 October 2016