Internationalization Tag Set (ITS) Version 2.0 ITS20 W3C Working Draft 06 December 2012 http://www.w3.org/TR/2012/WD-its20-20121206/ ODD/XML document self-contained zipped archive XHTML Diff markup between publication 2012-06-26 and ITS 1.0 Recommendation 2007-04-03 XHTML Diff markup publication 2012-07-31 and publication 2012-06-26 XHTML Diff markup publication 2012-08-29 and publication 2012-07-31 XHTML Diff markup publication 2012-10-23 and publication 2012-08-29 XHTML Diff markup publication 2012-12-06 and publication 2012-10-23 http://www.w3.org/TR/2012/WD-its20-20121023/ http://www.w3.org/TR/its20/ Shaun McCane Invited Expert Dave Lewis TCD Arle Lommel DFKI Jirka Kosek UEP Felix Sasaki DFKI / W3C Fellow Yves Savourel ENLASO

This document defines data categories and their implementation as a set of elements and attributes called the Internationalization Tag Set (ITS) 2.0. ITS 2.0 is the successor of ITS 1.0; it is designed to foster the creation of multilingual Web content, focusing on HTML, XML based formats in general, and to leverage localization workflows based on the XML Localization Interchange File Format (XLIFF).

This section describes the status of this document at the time of its publication. Other documents may supersede this document. A list of current W3C publications and the latest revision of this technical report can be found in the W3C technical reports index at http://www.w3.org/TR/.

This document defines data categories and their implementation as a set of elements and attributes called the Internationalization Tag Set (ITS) 2.0. ITS 2.0 is the successor of ITS 1.0; it is designed to foster the creation of multilingual Web content, focusing on HTML, XML based formats in general, and to leverage localization workflows based on the XML Localization Interchange File Format (XLIFF).

This document was published by the MultilingualWeb-LT Working Group as a Last Call Working Draft. The Working Group expects to advance this Working Draft to Recommendation status (see W3C document maturity levels). The Last Call period ends 10 January 2013.

The normative sections of this document (from to and to ) are stable. The other, non-normative sections contain only explanatory material and will be updated in a later working draft. Hence, the Working Group especially encourages feedback on the normative sections. The goal is to move out of last call without any substantive changes to these sections.

To give feedback send your comments to public-multilingualweb-lt-comments@w3.org. Use "Comment on ITS 2.0 specification WD" in the subject line of your email. The archives for this list are publicly available. See also issues discussed within the Working Group and the list of changes since the previous publication.

Publication as a Working Draft does not imply endorsement by the W3C Membership. This is a draft document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate to cite this document as other than work in progress.

This document was produced by a group operating under the 5 February 2004 W3C Patent Policy. W3C maintains a public list of any patent disclosures made in connection with the deliverables of the group; that page also includes instructions for disclosing a patent. An individual who has actual knowledge of a patent which the individual believes contains Essential Claim(s) must disclose the information in accordance with section 6 of the W3C Patent Policy.

en

This is the first version of this document.

Introduction

This section is informative.

ITS 2.0 is a technology to add metadata to Web content, for the benefit of localization, language technologies, and internationalization. The ITS 2.0 specification both identifies concepts (such as Translate) that are important for internationalization and localization, and defines implementations of these concepts (termed “ITS data categories”) as a set of elements and attributes called the Internationalization Tag Set (ITS). The document provides implementations for HTML, serializations in NIF, and provides definitions of ITS elements and attributes in the form of XML Schema and RELAX NG .

This document aims to realize many of the ideas formulated in the ITS 2.0 Requirements document, in and .

Not all requirements listed there are addressed in this document. Those which are not addressed here are either covered in (potentially in an as yet unwritten best practice document on multilingual Web content), or may be addressed in a future version of this specification.

Relation to ITS 1.0 and New Principles
Relation to ITS 1.0

ITS 2.0 has the following relations to ITS 1.0:

It adopts and maintains the following principles from ITS 1.0:

It adopts the use of data categories to define discrete units of functionality It adopts the separation of data category definition from the mapping of the data category to a given content format It adopts the conformance principle of ITS1.0 that an implementation only needs to implement one data category to claim conformance to ITS 2.0
ITS 2.0 supports all ITS 1.0 data category definitions and adds new definitions, with the exceptions of Directionality and Ruby. ITS 2.0 adds a number of new data categories not found in ITS 1.0. While ITS 1.0 addressed only XML, ITS 2.0 specifies implementations of data categories in both XML and HTML.
New Principles

ITS 2.0 also adds the following principles and features not found in ITS 1.0:

ITS 2.0 data categories are intended to be format neutral, with support for XML, HTML, and NIF: a data category implementation only needs to support a single content format mapping in order to support a claim of ITS 2.0 conformance. ITS 2.0 provides algorithms to generate NIF out of HTML or XML with ITS 2.0 metadata. A global implementation of ITS 2.0 requires at least the XPath version 1.0. Other versions of XPath or other query languages (e.g., CSS selectors) can be expressed via a dedicated queryLanguage attribute.

The new data categories included in ITS 2.0 are:

Domain Disambiguation Locale Filter Provenance External Resource Target Pointer Id Value Preserve Space Localization Quality Issue Localization Quality Rating MT Confidence Allowed Characters Storage Size
Motivation for ITS

Content or software that is authored in one language (the source language) is often made available in additional languages or adapted with regard to other cultural aspects. This is done through a process called localization, where the original material is translated and adapted to the target audience.

In addition, document formats expressed by schemas may be used by people in different parts of the world, and these people may need special markup to support the local language or script. For example, people authoring in languages such as Arabic, Hebrew, Persian, or Urdu need special markup to specify directionality in mixed direction text.

From the viewpoints of feasibility, cost, and efficiency, it is important that the original material should be suitable for localization. This is achieved by appropriate design and development, and the corresponding process is referred to as internationalization. For a detailed explanation of the terms “localization” and “internationalization”, see .

Note: This should refer to the best practice document as well, when ready.

The increasing usage of XML as a medium for documentation-related content (e.g. DocBook and DITA as formats for writing structured documentation, well suited to computer hardware and software manuals) and software-related content (e.g. the eXtensible User Interface Language ) creates challenges and opportunities in the domain of XML internationalization and localization.

Typical Problems

The following examples sketch one of the issues that currently hinder efficient XML-related localization: the lack of a standard, declarative mechanism that identifies which parts of an XML document need to be translated. Tools often cannot automatically perform this identification.

Document with partially translatable content

In this document it is difficult to distinguish between those string elements that are translatable and those that are not. Only the addition of an explicit flag could resolve the issue.

Document with partially translatable content

Even when metadata are available to identify non-translatable text, the conditions may be quite complex and not directly indicated with a simple flag. Here, for instance, only the text in the nodes matching the expression //component[@type!='image']/data[@type='text'] is translatable.

Users and Usages of ITS
Potential Users of ITS

The ITS specification aims to provide different types of users with information about what markup should be supported to enable worldwide use and effective internationalization and localization of content. The following paragraphs sketch these different types of users, and their usage of ITS. In order to support all of these users, the information about what markup should be supported to enable worldwide use and effective localization of content is provided in this specification in two ways:

abstractly in the data category descriptions: concretely in the ITS schemas:
Schema developers starting a schema from the ground up

This type of user will find proposals for attribute and element names to be included in their new schema (also called "host vocabulary"). Using the attribute and element names proposed in the ITS specification may be helpful because it leads to easier recognition of the concepts represented by both schema users and processors. It is perfectly possible, however, for a schema developer to develop his own set of attribute and element names. The specification sets out, first and foremost, to ensure that the required markup is available, and that the behavior of that markup meets established needs.

Schema developers working with an existing schema

This type of user will be working with schemas such as DocBook, DITA, or perhaps a proprietary schema. The ITS Working Group has sought input from experts developing widely used formats such as the ones mentioned.

The question "How to use ITS with existing popular markup schemes?" is covered in more details (including examples) in a separate document: .

Developers working on existing schemas should check whether their schemas support the markup proposed in this specification, and, where appropriate, add the markup proposed here to their schema.

In some cases, an existing schema may already contain markup equivalent to that recommended in ITS. In this case it is not necessary to add duplicate markup since ITS provides mechanisms for associating ITS markup with markup in the host vocabulary which serves a similar purpose (see ). The developer should, however, check that the behavior associated with the markup in their own schema is fully compatible with the expectations described in this specification.

Vendors of content-related tools

This type of user includes companies which provide tools for authoring, translation or other flavors of content-related software solutions. It is important to ensure that such tools enable worldwide use and effective localization of content. For example, translation tools should prevent content marked up as not for translation from being changed or translated. It is hoped that the ITS specification will make the job of vendors easier by standardizing the format and processing expectations of certain relevant markup items, and allowing them to more effectively identify how content should be handled.

Content producers

This type of user comprises authors, translators and other types of content author. The markup proposed in this specification may be used by them to mark up specific bits of content. Aside: The burden of inserting markup can be removed from content producers by relating the ITS information to relevant bits of content in a global manner (see global, rule-based approach). This global work, however, may fall to information architects, rather than the content producers themselves.

Content producers often work with content management systems (CMS). In various CMS, some of the CMS fields only allow to store plain text. For these fields, the current ITS 2.0 data categories can only be applied globally and not with local attributes. This issue should be addressed in another way, apart from the ITS 2.0 standard. One way would be to allow HTML in these fields if possible, or using an extra field which allows HTML input and save the plain text of this extra field in the plain text field.

Machine Translation Systems

This type of service is intended for a broad user community ranging from developers and integrators through translation companies and agencies, freelance translators and post-editors to ordinary translation consumers and other types of MT employment. Data categories are envisaged for supporting and guiding the different automated backend processes of this service type, thereby adding substantial value to the service results as well as possible subsequent services. These processes include basic tasks, like parsing constraints and markup, and compositional tasks, such as disambiguation. These tasks consume and generate valuable metadata from and for third party users, for example, provenance information and quality scoring, and add relevant information for follow-on tasks, processes and services, such as MT post-editing, MT training and MT terminological enhancement.

Text Analytics

These types of users fulfil the role of providing services for automatic generation of metadata for improving localization, data integration or knowledge management workflows. This class of users comprises of developers and integrators of services that automate language technology tasks such as domain classification, named entity recognition and disambiguation, term extraction, language identification and others. Text analytics services generate data that contextualizes the raw content with more explicit information. This can be used to improve the output quality in machine translation systems, search result relevance in information retrieval systems, as well as management and integration of unstructured data in knowledge management systems.

Localization Workflow Managers

This type of users is concerend with localization workflows in which content goes through certain steps: preparation for localization, start of the localization process by e.g. a conversion into a bitext format like , the actual localization by human translators or machine translation and other adaptations of content, and finally the integration of the localized content into the original format. That format is often based on XML or HTML; (Web) content management systems are widely used for content creation, and their integration with localization workflows is an important task for the workflow manager. For the integration of content creation and localization, metadata plays a crucial role. E.g. an ITS data category like translate can trigger the extraction of localizable text. Metadata roundtripping, that is the availibility of metadata both before and after the localization process is crucial for many tasks of the localization workflow manager. An example is metadata based quality control, with checks like Have all pieces of content set to translate="no" been left unchanged?. Other pieces of metadata are relevant for proper internationalization during the localization workflow, e.g. the availibility of Directionality markup for adequate visualization of bidirectional text.

Ways to Use ITS

The ITS specification proposes several mechanisms for supporting worldwide use and effective internationalization and localization of content. We will sketch them below by looking at them from the perspectives of certain user types. For the purpose of illustration, we will demonstrate how ITS can indicate that certain parts of content should or should not be translated.

A content author uses an attribute on a particular element to say that the text in the element should not be translated.

Use of ITS by content author

The its:translate="no" attributes indicate that the path and the cmd elements should not be translated.

A content author or information architect uses markup at the top of the document to identify a particular type of element or context in which the content should not be translated.

Use of ITS by information architect

The translateRule element is used in the header of the document to indicate that none of the path or cmd elements should be translated.

A processor may insert markup at the top of the document which links to ITS information outside of the document.

Use of ITS by processor

A rules element is inserted in the header of the document. It has a XLink href attribute used to link to an ITS external rule document.

ITS rule file shared by different documents

The rules element contains several ITS rules that are common to different documents. One of them is a translateRule element that indicates that no path or cmd element should be translated.

A schema developer integrates ITS markup declarations in his schema to allow users to indicate that specific parts of the content should not be translated.

Following schema example has to updated once we have final XSD schema for ITS 2.0 An XSD schema with ITS declaration

The declarations for the translate attribute is added to a group of common attributes commonAtts. This allows to use the translate attribute within the documents like in .

The first two approaches above can be likened to the use of CSS in . Using a style attribute, an XHTML content author may assign a color to a particular paragraph. That author could also have used the style element at the top of the page to say that all paragraphs of a particular class or in a particular context would be colored red.

Usage in HTML

ITS 2.0 adds support for usage in HTML. In HTML, ITS local selection is realized via dedicated, data category specific attributes.

Add example of HTML with local attributes for illustration purposes

For the so-called “global approach” in HTML, this specification defines a link type for referring to files with global rules in .

Using ITS global rules in HTML

The link element points to the rules file EX-translateRule-html5-1.xml The rel attribute identifies the ITS specific link relation its-rules.

ITS rules file linked from HTML

The rules file linked in .

Support for legacy HTML content

ITS 2.0 does not define how to use ITS in HTML versions prior version 5. Users are encouraged to migrate their content to HTML or XHTML. While it is possible to use its-* attributes introduced for HTML5 in older versions of HTML (such as 3.2 or 4.01) and pages using these attributes will work without any problems, its-* attributes will be marked as invalid in validators.

Out of Scope

The definition of what a localization process or localization parameters must address is outside the scope of this standard and it does not address all of the mechanisms or data formats (sometimes called localization project parameters) that may be needed to configure localization workflows or process specific formats. However, it does define standard data categories that may be used in defining localization workflows or processing specific formats.

XML localization project parameters” is a generic term to name the mechanisms and data formats that allow localization tools to be configured in order to process a specific XML format. Examples of XML localization project parameters are the Trados “DTD Settings” file, and the SDLX “Analysis” file.

Important Design Principles

Abstraction via data categories: ITS defines data categories as an abstract notion for information needed for the internationalization and localization of XML documents and HTML documents. This abstraction is helpful in realizing independence from any one particular implementation (e.g., as an element or attribute). (See for a definition of the term data categories, for the definition of the various ITS data categories, and subsections in for the data category implementations.)

Powerful selection mechanism: For ITS markup that appears in an XML instance, the XML nodes to which the ITS-related information pertains must be clearly defined. Thus, ITS defines selection mechanisms to specify to what parts of an XML document an ITS data category and its values should be applied. Selection relies on the information which is given in the XML Information Set . ITS applications may implement inclusion mechanisms such as XInclude or DITA's conref.

Content authors, for example, need a simple way to work with the Translate data category in order to express whether the content of an element or attribute should be translated or not. Localization managers, on the other hand, need an efficient way to manage translations of large document sets based on the same schema. These needs could by realized by a specification of defaults for the Translate data category along with exceptions to those defaults (e.g. all p elements should be translated, but not p elements inside of an index element).

To meet these requirements this specification introduces mechanisms that add ITS information to XML documents, see . These mechanisms also provide a means for specifying ITS information for attributes (a task for which no standard means previously existed).

The ITS selection mechanisms allows you to provide information about content locally (specified at the XML or HTML element to which it pertains) or globally (specified in another part of the document). Global selection mechanisms can be in the same document, or in a separate file.

No dedicated extensibility: It may be useful or necessary to extend the set of information available for internationalization or localization purposes beyond what is provided by ITS. This specification does not define a dedicated extension mechanism, since ordinary XML mechanisms (e.g. XML Namespaces ) may be used.

Ease of integration:

ITS follows the example from section 4 of , by providing mostly global attributes for the implementation of ITS data categories. Avoiding elements for ITS purposes as much as possible ensures ease of integration into existing markup schemes, see section 3.14 in . Only for some requirements do additional child elements have to be used, see for example . ITS has no dependency on technologies which are still under development. ITS fits with existing work in the W3C architecture (e.g. use of for the selection mechanism and use of IRI's as references to relevant external resources).
Basic Concepts

This section is informative.

Selection

Information (e.g. "translate this") captured by ITS markup (e.g. its:translate='yes') always pertains to one or more XML or HTML nodes (primarily element and attribute nodes). In a sense, ITS markup “selects” the relevant node(s). Selection may be explicit or implicit. ITS distinguishes two approaches to selection: (1) local, and (2) using global rules.

The mechanisms defined for ITS selection resemble those defined in . The local approach can be compared to the style attribute in HTML/XHTML, and the approach with global rules is similar to the style element in HTML/XHTML. ITS usually uses XPath for identifying nodes although CSS and other query languages can be used if supported by application. Thus,

the local approach puts ITS markup in the relevant element of the host vocabulary (e.g. the author element in DocBook) the rule-based, global approach puts the ITS markup in elements defined by ITS itself (namely the rules element)

ITS markup can be used with XML documents (e.g. a DocBook article), or schemas (e.g. an XML Schema document for a proprietary document format).

The following two examples sketch the distinction between the local and global approaches, using the translate as one example of ITS markup.

Local Approach

The document in shows how a content author may use the ITS translate attribute to indicate that all content inside the author element should be protected from translation. Translation tools that are aware of the meaning of this attribute can then screen the relevant content from the translation process.

ITS markup on elements in an XML document (local approach)

For this example to work, the schema developer will need to add the translate attribute to the schema as a common attribute or on all the relevant element definitions. Note how there is an expectation in this case that inheritance plays a part in identifying which content does have to be translated and which does not. Tools that process this content for translation will need to implement the expected inheritance.

Global Approach

The document in shows a different approach to identifying non-translatable content, similar to that used with a style element in , but using an ITS-defined element called rules. It works as follows: A document can contain a rules element (placed where it does not impact the structure of the document, e.g., in a “head” section). It contains one or more ITS rule elements (for example translateRule). Each of these specific elements contains a selector attribute. As its name suggests, this attribute selects the node or nodes to which a corresponding ITS information pertains. The values of ITS selector attributes are XPath absolute location paths (or CSS selectors if queryLanguage is set to "css"). Information for the handling of namespaces in these path expressions is taken from namespace declarations at the current rule element.

Caveat Related to XSLT-based Processing of ITS Selector Attributes

The values of ITS selector attributes are XPath absolute location paths. Accordingly, the following is a legitimate value:

myElement/descendant-or-self::*/@*

Unfortunately, values like this cause trouble when they are used in XSLT-based processing of ITS where the values of the ITS selector attributes are used as values of match attributes of XSLT templates. The reason for this is the following: match attributes may only contain a restriction/subset of XPath expressions, so-called patterns.

Basically the following restrictions hold for patterns:

only axes "child" or "attribute" allowed "//" or "/" possible id() or key() function possible predicates possible

Using only XSLT patterns in ITS selector attributes helps to avoid this issue. In many cases, this is possible by using patterns with predicates. The value above may for example be rewritten as follows:

*[self::myElement]/@* | myElement//*/@*

ITS global markup in an XML document (rule-based approach)

For this approach to work, the schema developer needs to add the rules element and associated markup to the schema. In some cases global rules may be sufficient to allow the schema developer to avoid adding other ITS markup (such as an translate attribute) to the elements and attributes in the schema. However, it is likely that authors will want to use attributes on markup from time to time to override the general rule.

For specification of the Translate data category information, the contents of the rules element would normally be designed by an information architect familiar with the document format and familiar with, or working with someone familiar with, the needs of the localization group.

The global, rule-based approach has the following benefits:

Content authors do not have to concern themselves with creating additional markup or verifying that the markup was applied correctly. ITS data categories are associated with sets of nodes (for example all p elements in an XML instance) Changes can be made in a single location, rather than by searching and modifying local markup throughout a document (or documents, if the rules element is stored as an external entity) ITS data categories can designate attribute values as well as elements. It is possible to associate ITS markup with existing markup (for example the term element in DITA)

The commonality in both examples above is the markup translate='no'. This piece of ITS markup can be interpreted as follows:

it pertains to the Translate data category the attribute translate holds a value of no

The ITS selector attribute allows:

ITS data category attributes to appear in global rules (even outside of an XML document or schema) ITS data categories attributes to pertain to sets of XML nodes (for example all p elements in an XML document) ITS markup to pertain to attributes ITS markup to associate with existing markup (for example the term element in DITA)
Overriding and Inheritance

The power of the ITS selection mechanisms comes at a price: rules related to overriding/precedence, and inheritance, have to be established.

The document in shows how inheritance and overriding work for the Translate data category. By default elements are translatable. Here, the translateRule element declared in the header overrides the default for the head element inside text and for all its children. Because the title element is actually translatable, the global rule needs to be overridden by a local its:translate="yes". Note that the global rule is processed first, regardless of its position inside the document. In the main body of the document, the default applies, and here it is its:translate="no" that is used to set “faux pas” as non-translatable.

Overriding and Inheritance
Adding Information or Pointing to Existing Information

For some data categories, special attributes add or point to information about the selected nodes. For example, the Localization Note data category can add information to selected nodes (using a locNote element), or point to existing information elsewhere in the document (using a locNotePointer attribute).

The functionality of adding information to the selected nodes is available for each data category except Language Information. Pointing to existing information is not possible for data categories that express a closed set of values; that is: Translate, Directionality, Locale Filter and Elements Within Text.

The functionalities of adding information and pointing to existing information are mutually exclusive. That is to say, attributes for pointing and adding must not appear at the same rule element.

Notation and Terminology

This section is normative.

Notation

The keywords “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in .

The namespace URI that MUST be used by implementations of this specification is:

http://www.w3.org/2005/11/its

The namespace prefix used in this specification for this URI is “its”. It is recommended that implementations of this specification use this prefix.

In addition, the following namespaces are used in this document:

http://www.w3.org/2001/XMLSchema for the XML Schema namespace, here used with the prefix “xs” http://www.w3.org/1999/xlink for the XLink namespace, here used with the prefix “xlink” http://www.w3.org/1999/xhtml for the HTML namespace, here used with the prefix “h”
Data category

ITS defines data category as an abstract concept for a particular type of information for internationalization and localization of XML schemas and documents. The concept of a data category is independent of its implementation in an XML and HTML environment (e.g. using an element or attribute).

For each data category, ITS distinguishes between the following:

the prose description, see schema language independent formalization, see the "implementation" subsections in schema language specific implementations, see A data category and its implementation

The Translate data category conveys information as to whether a piece of content should be translated or not.

The simplest formalization of this prose description on a schema language independent level is a translate attribute with two possible values: yes and no. An implementation on a schema language specific level would be the declaration of the translate attribute in, for example, an XML Schema document or an RELAX NG document. A different implementation would be a translateRule element that allows for specifying global rules about the Translate data category.

Selection

selection encompasses mechanisms to specify to what parts of an XML or HTML document an ITS data category and its values should be applied to. Selection is discussed in detail in . Selection can be applied globally, see , and locally, see . As for global selection, ITS information can be added to the selected nodes, or it can point to existing information which is related to selected nodes.

The selection of the ITS data categories applies to textual values contained within element or attribute nodes. In some cases these nodes form pointers to other resources; a well-known example is the src attribute on the img element in HTML. The ITS Translate data category applies to the text of the pointer itself, not the object to which it points. Thus in the following example, the translation information specified via the translateRule element applies to the filename instructions.jpg, and is not an instruction to open the graphic and change the words therein.

Selecting the text of a pointer to an external object
ITS Local Attributes

ITS Local Attributes are all attributes defined in as a local markup.

Rule Elements

Rule Elements are all elements defined in as elements for global rules.

Usage of Internationalized Resource Identifiers in ITS

All attributes that have the type anyURI in the normative RELAX NG schema in MUST allow the usage of Internationalized Resource Identifiers (IRIs, or its successor) to ease the adoption of ITS in international application scenarios.

The Term HTML

This specification uses the term HTML to refer to HTML5 or its successor .

Conformance

This section is normative.

The usage of the term conformance clause in this section is in compliance with .

This specification defines three types of conformance: conformance of 1) ITS markup declarations , conformance of 2) processing expectations for ITS Markup and conformance of 3) processing expectations for ITS Markup in HTML. Also special conformance class is defined for using ITS markup in HTML5 document which servers as an applicable specification for HTML5+ITS. These conformance types and classes complement each other. An implementation of this specification MAY use them separately or together.

Conformance Type 1: ITS Markup Declarations

Description: ITS markup declarations encompass all declarations that are part of the Internationalization Tag Set. They do not concern the usage of the markup in XML documents. Such markup is subject to the conformance clauses in .

Definitions related to this conformance type: ITS markup declarations are defined in various subsections in in a schema language independent manner.

Who uses this conformance type: Schema designers integrating ITS markup declarations into a schema. All conformance clauses for this conformance type concern the position of ITS markup declarations in that schema, and their status as mandatory or optional.

Conformance clauses:

1-1: At least one of the following MUST be in the schema:

rules element one of the local ITS attributes span element ruby element

1-2: If the rules element is used, it MUST be part of the content model of at least one element declared in the schema. It SHOULD be in a content model for meta information, if this is available in that schema (e.g. the head element in ).

1-3: If the ruby element is used, it SHOULD be declared as an inline element.

1-4: If the span element is used, it SHOULD be declared as an inline element.

Full implementations of this conformance type will implement all markup declarations for ITS. Statements related to this conformance type MUST list all markup declarations they implement.

Examples: Examples of the usage of ITS markup declarations in various existing schemas are given in a separate document .

Conformance Type 2: The Processing Expectations for ITS Markup

Description: Processors need to compute the ITS information that pertains to a node in an XML document. The ITS processing expectations define how the computation has to be carried out. Correct computation involves support for selection mechanism, defaults / inheritance / overriding characteristics, and precedence. The markup MAY be valid against a schema which conforms to the clauses in .

Definitions related to this conformance type: The processing expectations for ITS markup make use of selection mechanisms defined in . The individual data categories defined in have defaults / inheritance / overriding characteristics, and allow for using ITS markup in various positions (global and local).

Who uses this conformance type: Applications that need to process the nodes captured by a data category for internationalization or localization. Examples of this type of application are: ITS markup-aware editors, or translation tools that make use of ITS markup to filter translatable text as an input to the localization process.

Application-specific processing (that is processing that goes beyond the computation of ITS information for a node) such as automated filtering of translatable content based on the Translate data category is not covered by the conformance clauses below.

Conformance clauses:

2-1: A processor MUST implement at least one data category. For each implemented data category, the following MUST be taken into account:

2-1-1: processing of at least one selection mechanism (global or local).

2-1-2: the default selections for the data category.

2-1-3: the precedence definitions for selections defined in , for the type of selections it processes.

2-2: If an application claims to process ITS markup for the global selection mechanism, it MUST process an XLink href attribute found on a rules elements.

2-3: If an application claims to process ITS markup implementing the conformance clauses 2-1, 2-2 and 2-3, it MUST process that markup with XML documents.

2-4: After processing ITS information on the basis of conformance clauses 2-1 and 2-2, an application MAY convert an XML document to NIF, using the algorithm described in .

The conformance clause 2-4 essentially means that the conversion to NIF is an optional feature of ITS 2.0, and that the conversion is independent of whether ITS information has been made available via the global or local selection mechanisms, see conformance clause 2-1-1.

Statements related to this conformance type MUST list all data categories they implement, and for each data category which type of selection they support, whether they support processing of XML. If the implementation provides the conversion to NIF (see conformance clause 2-4), this MUST be stated.

The above conformance clauses are directly reflected in the ITS 2.0 test suite. All tests specify which data category is processed (clause 2-1); they are relevant for (clause 2-1-1) global or local selection, or both; they require the processing of defaults and precedence of selections (clauses 2-1-2 and 2-1-3); for each data category there are tests with linked rules (2-2); and all types of tests are given for XML (clause 2-3). In addition, there are test cases for conversion to NIF (clause 2-4). Implementors are encouraged to organize their documentation in a similar way, so that users of ITS 2.0 easily can understand the processing capabilities available.

Conformance Type 3: Processing Expectations for ITS Markup in HTML

Description: Processors need to compute the ITS information that pertains to a node in a HTML document. The ITS processing expectations define how the computation has to be carried out. Correct computation involves support for selection mechanism, defaults / inheritance / overriding characteristics, and precedence.

Definitions related to this conformance type: The processing expectations for ITS markup make use of selection mechanisms defined in . The individual data categories defined in have defaults / inheritance / overriding characteristics, and allow for using ITS markup in various positions (local, external global and inline global).

Who uses this conformance type: Applications that need to process the nodes captured by a data category for internationalization or localization. Examples of this type of application are: ITS markup-aware editors, or translation tools that make use of ITS markup to filter translatable text as an input to the localization process.

Application-specific processing (that is processing that goes beyond the computation of ITS information for a node) such as automated filtering of translatable content based on the Translate data category is not covered by the conformance clauses below.

Conformance clauses:

3-1: A processor MUST implement at least one data category. For each implemented data category, the following MUST be taken into account:

3-1-1: processing of at least one selection mechanism (global or local).

3-1-2: the default selections for the data category.

3-1-3: the precedence definitions for selections defined in , for the type of selections it processes.

3-2: If an application claims to process ITS markup for the global selection mechanism, it MUST process a href attribute found on a link elements which has a rel attribute with the value its-rules.

3-3: If an application claims to process ITS markup implementing the conformance clauses 3-1, 3-2 and 3-3, it MUST process that markup within HTML documents.

Statements related to this conformance type MUST list all data categories they implement, and for each data category which type of selection they support.

Conformance Class for HTML5+ITS documents

Conforming HTML5+ITS documents are those that comply with all the conformance criteria for documents as defined in with the following exception:

Global attributes which can be used on all HTML elements are extended by attributes for local data categories as defined in .
Processing of ITS information

This section is normative.

Additional definitions about processing of HTML are given in .

Indicating the Version of ITS

The version of the ITS schema defined in this specification is 2.0. The version is indicated by the ITS version attribute. This attribute is mandatory for the rules element, where it MUST be in no namespace. If there is no rules element in an XML document, a prefixed ITS version attribute (e.g. its:version) MUST be provided at the root element of the document. If there is both a version attribute at the root element and a rules element in a document, they MUST NOT specify different versions.

External, linked rules can have different versions than internal rules.

Locations of Data Categories

ITS data categories can appear in two places:

Global rules: the selection is realized within a rules element. It contains rule elements for each data category. Each rule element has a selector attribute and possibly other attributes. The selector attribute contains an absolute selector as defined in . Locally in a document: the selection is realized using ITS local attributes, which are attached to an element node, or the span or ruby element. There is no additional selector attribute. The default selection for each data category defines whether the selection covers attributes and child elements. See .

The two locations are described in detail below.

Global, Rule-based Selection

Global, rule-based selection is implemented using the rules element. It contains zero or more rule elements. Each rule element has a mandatory selector attribute. This attribute and all other possible attributes on rule elements are in the empty namespace and used without a prefix.

If there is more than one rules element in an XML document, the rules from each section are to be processed at the same precedence level. The rules sections are to be read in document order, and the ITS rules with them processed sequentially. The versions of these rules elements MUST NOT be different.

Depending on the data category and its usage, there are additional attributes for adding information to the selected nodes, or for pointing to existing information in the document. For example, the Localization Note data category can be used for adding notes to selected nodes, or for pointing to existing notes in the document. For the former purpose, a locNote element can be used. For the latter purpose, a locNotePointer attribute can be used.

Each data category allows users to add information to the selected nodes except for language information. Pointing to existing information is not possible for data categories that express a closed set of values, that is: Translate, Directionality, Locale Filter, and Elements Within Text.

The functionalities of adding information and pointing to existing information are mutually exclusive. That is: markup for pointing and adding MUST NOT appear in the same rule element.

Global rules can appear in the XML document they will be applied to, or in a separate XML document. The precedence of their processing depends on these variations. See also .

Local Selection in an XML Document

Local selection in XML documents is realized with ITS local attributes or the span element. span serves just as a carrier for the local ITS attributes.

The data category determines what is being selected. The necessary data category specific defaults are described in .

Defaults for various data categories

By default the content of all elements in a document is translatable. The attribute its:translate="no" in the head element means that the content of this element, including child elements, should not be translated. The attribute its:translate="yes" in the title element means that the content of this element, should be translated (overriding the its:translate="no" in head). Attribute values of the selected elements or their children are not affected by local translate attributes. By default they are not translatable.

The default directionality of a document is left-to-right. The its:dir="rtl" in the quote element means that the directionality of the content of this element, including child elements and attributes, is right-to-left. Note that xml:lang indicates only the language, not the directionality.

The dir and translate attributes are not listed in the ITS attributes to be used in HTML. The reason is that these two attributes are available in HTML natively, so there is no need to provide them as its- attributes. The definition of the two attributes in HTML is compatibly, that is it provides the same values and interpretation, as the definition for the two data categories Translate and Directionality.

Query Language of Selectors
Choosing Query Language

Rule elements have attributes which contain absolute and relative selectors. Interpretation of these selectors depends on the actual query language. The query language is set by queryLanguage attribute on rules element. If queryLanguge is not specified XPath 1.0 is used as a default query language.

XPath 1.0

XPath 1.0 is identified by xpath value in queryLanguage attribute.

Absolute selector

The absolute selector MUST be an XPath expression which starts with "/". That is, it must be an AbsoluteLocationPath or union of AbsoluteLocationPaths as described in XPath 1.0. This ensures that the selection is not relative to a specific location. The resulting nodes MUST be either element or attribute nodes.

Context for evaluation of the XPath expression is as follows:

Context node is set to Root Node.

Both context position and context size are 1.

All variables defined by param elements are bind.

All functions defined in the XPath Core Function Library are available. It is an error for an expression to include a call to any other function.

The set of namespace declarations are those in scope on the element which has the attribute in which the expression occurs. This includes the implicit declaration of the prefix xml required by the XML Namespaces Recommendation; the default namespace (as declared by xmlns) is not part of this set.

XPath expressions with namespaces

The term element from the TEI is in a namespace http://www.tei-c.org/ns/1.0.

XPath expressions without namespaces

The term element from DocBook V4.5 is in no namespace.

Relative selector

The relative selector MUST use a RelativeLocationPath or an AbsoluteLocationPath as described in XPath 1.0. The XPath expression is evaluated relative to the nodes selected by the selector attribute.

The following attributes point to existing information: allowedCharactersPointer, disambigClassPointer, disambigClassRefPointer, disambigIdentPointer, disambigIdentRefPointer, disambigSourcePointer, domainPointer, externalResourceRefPointer, langPointer, locNotePointer, locNoteRefPointer, locQualityIssuesRefPointer, provenanceRecordsRefPointer, storageEncodingPointer, storageSizePointer, targetPointer, termInfoPointer, termInfoRefPointer.

Context for evaluation of the XPath expression is same as for absolute selector with the following changes:

Nodes selected by the expression in the selector attribute form the current node list.

Context node comes from the current node list.

The context position comes from the position of the current node in the current node list; the first position is 1.

The context size comes from the size of the current node list.

CSS Selectors

As of writing the working group has no implememtation commitment for CSS selectors. If this doesn't change CSS selectors will be marked as feature at risk for the candidate recommendation draft.

CSS Selectors are identified by css value in queryLanguage attribute.

Absolute selector

Absolute selector MUST be interpreted as selector as defined in Selectors Level 3. Both simple selectors and groups of selectors can be used.

Relative selector

Relative selector MUST be interpreted as selector as defined in Selectors Level 3. Selector is not evaluated against the complete document tree but only against subtrees rooted at nodes selected by selector in the selector attribute.

Additional query languages

ITS processors MAY support additional query languages. For each additional query language processor MUST define:

identifier of query language used in queryLanguage; rules for evaluating absolute selector to collection of nodes; rules for evaluating relative selector to collection of nodes.

Future versions of this specification MAY define additional query languages. The following query language identifiers are reserved: xpath, css, xpath2, xpath3, xquery, xquery3, xslt2, xslt3.

Variables in selectors

A param element (or several ones) can be placed as the first child element(s) of the rules element to define the default values of variables used in the various selectors used in the rules.

Implementation MUST support the param element for all query languages it supports and which at the same time define how variables are bind for evaluation of selector expression. Implementations SHOULD also provide means for changing the default values of the param elements. Such means are implementation-specific.

The param element has a required name attribute. The value of the name attribute is a QName, see . The content of the element is a string used as default value for the corresponding variable.

Using the param element to define the default value of a variable in a selector attribute.

The param element defines the default value for the $LCID variable. In this case, only the msg element with the attribute lcid set to 0x049 is seen as translatable.

In XSLT-based applications, it may make sense to map ITS parameters directly to XSLT parameters. To avoid naming conflicts one can use a prefix with the parameter name's value to distinguish between the ITS parameters and the XSLT parameters.

Link to External Rules

One way to associate a document with a set of external ITS rules is to use the optional XLink href attribute in the rules element. The referenced document must be a valid XML document containing at most one rules element. That rules element can be the root element or anywhere within the document tree (for example, the document could be an XML Schema).

The rules contained in the referenced document MUST be processed as if they were at the top of the rules element with the XLink href attribute.

External file EX-link-external-rules-1.xml with global rules:

The example demonstrates how metadata can be added to ITS rules.

Document with a link to EX-link-external-rules-1.xml

The result of processing the two documents above is the same as processing the following document.

Document with identical rules as in the case of included rules External rules file with the rules element as the root element

Like , these rules can be applied e.g. to . The only difference is that in , the rules element is the root element of the external file.

Applications processing global ITS markup MUST recognize the XLink href attribute in the rules element; they MUST load the corresponding referenced document and process its rules element before processing the content of the rules element where the original XLink href attribute is.

External rules may also have links to other external rules. The linking mechanism is recursive, the deepest rules being overridden by the top-most rules, if any.

Precedence between Selections

The following precedence order is defined for selections of ITS information in various positions (the first item in the list has the highest precedence):

Selection via explicit (that is, not inherited) local ITS markup in documents (ITS local attributes on a specific element)

Global selections in documents (using a rules element)

Inside each rules element the precedence order is: Any rule inside the rules element Any rule linked via the XLink href attribute

ITS does not define precedence related to rules defined or linked based on non-ITS mechanisms (such as processing instructions for linking rules).

Selections via defaults for data categories, see

In case of conflicts between global selections via multiple rules elements, the last rule has higher precedence.

The precedence order fulfills the same purpose as the built-in template rules of . Override semantics are always complete, that is all information provided via lower precedence is overriden by the higher precedence. E.g. defaults are overridden by inherited values, these are overriden by nodes selected via global rules, which are in turn overridden by local markup.

Conflicts between selections of ITS information which are resolved using the precedence order

The two elements title and author of this document should be treated as separate content when inside a prolog element, but as part of the content of their parent element otherwise. In order to make this distinction two withinTextRule elements are used:

The first rule specifies that title and author in general should be treated as an element within text. This overrides the default.

The second rule indicates that when title or author are found in a prolog element their content should be treated separately. This is normally the default, but the rule is needed to override the first rule.

Associating ITS Data Categories with Existing Markup

Some markup schemes provide markup which can be used to express ITS data categories. ITS data categories can be associated with such existing markup, using the global selection mechanism described in .

Associating existing markup with ITS data categories can be done only if the processing expectations of the host markup are the same as, or greater than, those of ITS. For example, the format can use its translate attribute to apply to “transcluded” content, going beyond the ITS 2.0 local selection mechanism, but not contradicting it.

Association of the ITS data categories Translate and Terminology with DITA 1.0 markup

In this example, there is an existing translate attribute in DITA, and it is associated with the ITS semantics using the its:rules section. Similarly, the DITA dt and term elements are associated with the ITS Terminology data category.

Global rules can be associated with a given XML document using different means:

By using an rules element in the document itself:

with the rules directly inside the document, as shown in with a link to an external rules file using the XLink href attribute, as shown in
By associating the rules and the document through a tool-specific mechanism. For example, for a command-line tool: providing the paths of both the XML document to process and its corresponding external rules file.
Conversion to NIF

This section defines an algorithm to convert XML or HTML documents (or their DOM representations) that contain ITS metadata to the RDF-based format NIF. The conversion results in RDF triples.

The algorithm is intended to extract the text from the XML/HTML/DOM for an NLP tool and can produce a lot of phantom predicates from excessive whitespace, which 1) increases the size of the intermediate mapping and 2) extracts this whitespace as text. This might decrease NLP performance. It is recommended to normalize whitespace in the input XML/HTML/DOM in order to minimize such phantom predicates. A normalized example is given below. The whitespace normalization algorithm itself is format dependent, e.g. it differs for HTML compared to general XML. Hence no normative algorithm for whitespace normalization is given as part of this specification.

Example of an HTML document with whitespace normalized as preparation for conversion to NIF

Welcome to Dublin in Ireland!

]]>

The conversion algorithm to generate NIF consists of seven steps.

STEP 1: Get an ordered list of all text nodes of the document.

STEP 2: Generate an XPath expression for each non-empty text node of all leaf elements and remember them.

STEP 3: Get the text for each node and make a tuple with the XPath expressions (X,T). Since the text nodes have a certain order we now have a list of ordered tuples ((x0,t0), (x1,t1), ..., (xn,tn)).

STEP 4 (optional): Serialize as XML or as RDF. The list with the XPath-to-text mapping can also be kept in memory. Part of a serialization example is given below.

. itsrdf:xpath2nif itsrdf:xpath2nif # ... itsrdf:xpath2nif ]]>

where

Example (continued)

. # "Welcome to " itsrdf:nif . # "Dublin" itsrdf:nif . # " in " itsrdf:nif . # "Ireland" itsrdf:nif . # "!" itsrdf:nif . # "Welcome to Dublin Ireland!" itsrdf:nif . ]]>

STEP 5: Create a context URI and attach the whole concatenated text of the document as reference.

STEP 6: Now attach any ITS metadata items from the XML/HTML/DOM input to respective NIF URIs.

STEP 7: Omit all irrelevant URIs (those that do not carry annotations, they will just bloat the data).

. rdf:type str:Context ; rdf:type str:OffsetBasedString ; # concatenate the whole text str:isString "$(t0+t1+t2+...+tn)" ; itsrdf:translate "yes"^^ ; str:occursIn . rdf:type str:String ; rdf:type str:OffsetBasedString ; itsrdf:translate "no"^^ ; itsrdf:disambigIdentRef ; str:referenceContext . rdf:type str:String ; rdf:type str:OffsetBasedString ; itsrdf:translate "no"^^ ; str:referenceContext . ]]>

A complete sample output in RDF/XML format after step 7, given the input document , is available at examples/nif/EX-nif-conversion-output.xml.

The conversion to NIF is the basis for natural language processing (NLP) applications, creating for example named entity annotations. A non-normative algorithm to integrate these annotations into the original input document is given in . The algorithm in that appendix is non-normative since many choices depend on the actual NLP application.

ITS Tools Annotation

In some cases, it may be important for instances of data categories to be associated with information about the processor that generated them. For example, the score of the MT Confidence data category (provided via the mtConfidence attribute) is meaningful only when the consumer of the information also knows what MT engine produced it, because the score provides the relative confidence of translations from the same MT engine but does not provide a score that can be reliably compared between MT engines. The same is true for confidence provided for the Disambiguation data category, providing confidence information via the disambigConfidence attribute, or the Terminology data category, providing confidence information via the termConfidence attribute.

ITS 2.0 provides a mechanism to associate such processor information with the use of individual data categories in a document, independently from data category annotations themselves.

The attribute annotatorsRef provides a way to associate all the annotations of a given data category within the element with information about the processor that generated those data category annotations.

Three cases of providing tool information can be expected:

information about tools used for creating or modifying the textual content;

information about tools that do 1), but also create ITS annotations, see ;

information about tools that don’t modify or create content, but just create ITS annotations.

annotatorsRef is only meant to be used when actual ITS annotation is involved, that is for 2) and 3). To express tool information related only to the creation or modification of textual content and independent of ITS data categories, that is case 1), one should use the tool or toolRef attribute provided by the Provenance data category.

An example of case 2) is an MT engine that modifies content and creates ITS MT Confidence annotations. Here the situation may occur that several tools are involved in creating MT Confidence annotations: the MT engine and the tool inserting the markup. The annotatorsRef attribute should identify the tool most useful in further processes, in this case the MT engine.

The value of annotatorsRef is a space-separated list of references where each reference is composed of two parts: a data category identifier and an IRI. These two parts are separated by a character | VERTICAL LINE (U+007C).

The data category identifier MUST be one of the identifiers specified in the data category overview table.

The IRI indicates information about the processor used to generate the data category annotation. No single means is specified for how this IRI should be used to indicate processor information. Possible mechanisms are: to encode information directly in the IRI, e.g. as parameters; to reference an external resource that provides such information, e.g. an XML file or an RDF declaration; or to reference another part of the document that provides such information.

In HTML documents, the mechanism is implemented with the its-annotators-ref attribute.

The attribute applies to the content of the element where it is declared (including its children elements) and to the attributes of that element.

On any given node, the information provided by this mechanism is a space-separated list of the accumulated references found it 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 declarartion.

Accumulation and Overriding of the annotatorsRef Values

In this example, the text shows the computed tools reference information for the given node. Note that the references are ordered alphabetically and that the IRI values are always the ones of the inner-most declaration.

Example of ITS Tools Annotation

The annotatorsRef attribute is used in this XML document to indicate that information about the processor that generated the mtConfidence values for the first two p elements are found in element with id="T1" in the external document tools.xml, while that information for the third p element is found in the element with id="T2" in the same document. In addition, annotatorsRef is used to identify a Web resource with information about the QA tool used to generate the Localization Quality Issue annotation in the document.

Example of ITS Tool Annotation

The its-annotators-ref attributes are used in this HTML document to indicate that the MT Confidence annotation on the first two span elements come from one MT (French to English) engine, while the annotation on the third comes from another (Italian to English) engine. Both its-annotators-ref attributes refer to a Web resource for information about the engine generating the MT Confidence annotation.

Using ITS Markup in HTML
Mapping of Local Data Categories to HTML

All data categories defined in and having local implementation might be used in HTML with the exception of Translate, Directionality, Ruby, and Language Information data categories.

The above mentioned data categories are excluded because HTML has native markup for them.

In HTML data categories are implemented as attributes. Name of HTML attribute is derived from the name of attribute defined in the local implementation by using the following rules: Attribute name is prefixed with its- Each uppercase letter in the attribute name is replaced by - (U+002D) followed by a lowercase variant of the letter.

Values of attributes which corresponds to data categories with a predefined set of values MUST be matched case-insensitively.

Case of attribute names is also irrelevant given the nature of HTML syntax. So in HTML terminology data category can be stored as its-term, ITS-TERM, its-Term etc. All those attributes are treated as equivalent and will gets normalized upon DOM construction.

Global rules

Various aspects for global rules in general, external global rules or inline global rules need to be taken into account.

By default XPath 1.0 will be used for selection in global rules. If users prefer easier selection mechanism, they can switch query language to CSS selectors by using the queryLanguage attribute, see .

HTML5 parsing algorithm automatically puts all HTML elements into XHTML namespace (http://www.w3.org/1999/xhtml). Selectors used in global rules must take this into account.

Link to external global rules is specified in href attribute of link element, with the link relation its-rules.

Using XPath in global rules linked from HTML documents does not create an additional burden to implementers. Parsing HTML content produces a DOM tree that can be directly queried using XPath, functionality supported by all major browsers.

Inline global rules MUST be specified inside script which has type attribute with the value application/its+xml. The script element itself SHOULD be child of head element. Comments MUST NOT be used inside global rules. Each script element MUST NOT contain more than one rules element.

It is preferred to use external global rules linked using link element.

Standoff Markup in HTML

The constraints for Provenance standoff markup in HTML and Localization quality issues markup in HTML MUST be followed.

Precedence between Selections

The following precedence order is defined for selections of ITS information in various positions of HTML document (the first item in the list has the highest precedence):

Implicit local selection in documents (ITS local attributes on a specific element)

Global selections in documents (using mechanism of external global rules or inline global rules)

ITS does not define precedence related to rules defined or linked based on non-ITS mechanisms (such as processing instructions for linking rules).

Selections via defaults for data categories, see

In case of conflicts between global selections via multiple rules elements, the last rule has higher precedence.

Using ITS Markup in XHTML

XHTML documents aimed at public consumption by Web browsers SHOULD use syntax for local attributes described in and SHOULD NOT use inline global rules in order to adhere to DOM Consistency HTML Design Principle.

Using ITS 2.0 markup in XHTML

This examples illustrates the use of ITS 2.0 local markup and global rules in XHTML.

Description of Data Categories

This section is normative.

This schema has been developed using the ODD (One Document Does it all) language of the Text Encoding Initiative (). This is a literate programming language for writing XML schemas, with three characteristics: (1) The element and attribute set is specified using an XML vocabulary which includes support for macros (like DTD entities, or schema patterns), a hierarchical class system for attributes and elements, and creation of modules. (2) The content models for elements and attributes is written using embedded RELAX NG XML notation. (3) Documentation for elements, attributes, value lists etc. is written inline, along with examples and other supporting material. XSLT transformations are provided by the TEI to extract documentation in HTML, XSL FO or LaTeX forms, and to generate RELAX NG documents and DTD. From the RELAX NG documents, James Clark's trang can be used to create XML Schema documents.
Position, Defaults, Inheritance and Overriding of Data Categories

The following table summarizes for each data category which selection, default value, and inheritance and overriding behavior applies. It also provides data category identifiers used in .

Default values apply if both local and global selection are absent. The default value for the Translate data category for example mandates that elements are translatable, and attributes are not translatable if there is no translateRule element and no translate attribute available.

Inheritance describes whether ITS information is applicable to child elements of nodes and attributes related to these nodes or their child notes. The inheritance for the Translate data category for example mandates that all child elements of nodes are translatable whereas all attributes related to these the nodes or their child notes are not translatable.

For ITS data categories with inheritance, the information conveyed by the data category can be overridden. For example, a local translate attribute overrides the Translate information conveyed by a global translateRule.

An ITS application is free to decide what pieces of content it uses. For example:

Terminology information is added to a term element. The information pertains only to the content of the element, since there is no inheritance for Terminology. Nevertheless an ITS application can make use of the complete element, e.g. including attribute nodes etc. Using Id value, a unique identifier is provided for a p element. An application can make use of the complete p element, including child nodes and attributes nodes. The application is also free to make use just of the string value of p. Nevertheless the id provided via ID value pertains only to the p element. It cannot be used to identify nested elements or attributes. Using target pointer, selected source element have the ITS information that their translation is available in a target element; see . This information does not inherit to child elements of target pointer. E.g., the translation of a span element nested in source is not available in a specific target element. Nevertheless, an application is free to use the complete content of source, including span, and e.g. present it to a translator.
Data category (identifier) Local Usage Global, rule-based selection Global adding of information Global pointing to existing information Default Values Inheritance for elements nodes Examples Translate (translate) Yes Yes Yes No translate="yes" for elements, and translate="no" for attributes Textual content of element, including content of child elements, but excluding attributes local, global Localization Note (localization-note) Yes Yes Yes Yes None Textual content of element, including content of child elements, but excluding attributes local, global Terminology (terminology) Yes Yes Yes Yes term="no" None local, global Directionality (directionality) Yes Yes Yes No dir="ltr" Textual content of element, including attributes and child elements local, global Ruby (ruby) Yes Yes Yes Yes None None local, global Language Information (language-information) No Yes No Yes None Textual content of element, including attributes and child elements global Elements Within Text (elements-within-text) Yes Yes Yes No withinText="no" None local, global Domain (domain) No Yes Yes Yes None Textual content of element, including attributes and child elements global Disambiguation (disambiguation) Yes Yes Yes Yes None None local, global Locale Filter (locale-filter) Yes Yes Yes No localeFilterList="*" Textual content of element, including attributes and child elements local, global Provenance (provenance) Yes Yes No Yes None Textual content of element, including child elements and attributes local, global External Resource (external-resource) No Yes No Yes None None global Target Pointer (target-pointer) No Yes No Yes None None global Id Value (id-value) No Yes No Yes None None global Preserve Space (preserve-space) Yes Yes Yes No default Textual content of element, including attributes and child elements local, global Localization Quality Issue (localization-quality-issue) Yes Yes Yes Yes None Textual content of element, including child elements, but excluding attributes local, global Localization Quality Rating (localization-quality-rating) Yes Yes Yes Yes None Textual content of element, including child elements, but excluding attributes local MT Confidence (mt-confidence) Yes Yes Yes No None Textual content of element, including child elements, but excluding attributes local, global Allowed Characters (allowed-characters) Yes Yes Yes Yes None Textual content of element, including child elements, but excluding attributes local, global Storage Size (storage-size) Yes Yes Yes Yes None None local, global
Defaults, inheritance and overriding behavior of data categories

In this example, the content of all the data elements is translatable because the default for the Translate data category in elements is yes. The content of revision and locNote is not translatable because the default is overridden by the local its:translate="no" attribute in the prolog element, and that value is inherited by all the children of prolog.

The localization note for the two first data elements is the text defined globally with the locNoteRule element. And this note is overridden for the last data element by the local locNote attribute.

The data categories differ with respect to defaults. This is due to existing standards and practices. It is common practice for example that information about translation refers only to textual content of an element. Thus, the default selection for the Translate data category is the textual content.

Translate
Definition

The Translate data category expresses information about whether the content of an element or attribute should be translated or not. The values of this data category are yes (translatable) or no (not translatable).

Implementation

The Translate data category can be expressed with global rules, or locally on an individual element. For elements, the data category information inherits to the textual content of the element, including child elements, but excluding attributes. The default is that elements are translatable and attributes are not.

GLOBAL: The translateRule element contains the following:

A required selector attribute. It contains an absolute selector which selects the nodes to which this rule applies. A required translate attribute with the value yes or no. The Translate data category expressed globally

The translateRule element specifies that the elements code must not be translated.

LOCAL: The following local markup is available for the Translate data category:

A translate attribute with the value yes or no.

It is not possible to override the Translate data category settings of attributes using local markup. This limitation is consistent with the advised practice of not using translatable attributes. If attributes need to be translatable (e.g., an HTML alt attribute), then this must be declared globally.

The Translate data category expressed locally

The local its:translate="no" specifies that the content of panelmsg must not be translated.

The Translate data category expressed locally in HTML

The local translate="no" attribute specifies that the content of span must not be translated.

Localization Note
Definition

The Localization Note data category is used to communicate notes to localizers about a particular item of content.

This data category can be used for several purposes, including, but not limited to:

Tell the translator how to translate parts of the content Expand on the meaning or contextual usage of a specific element, such as what a variable refers to or how a string will be used in the user interface Clarify ambiguity and show relationships between items sufficiently to allow correct translation (e.g., in many languages it is impossible to translate the word enabled in isolation without knowing the gender, number and case of the thing it refers to.) Indicate why a piece of text is emphasized (important, sarcastic, etc.)

Two types of informative notes are needed:

An alert contains information that the translator must read before translating a piece of text. Example: an instruction to the translator to leave parts of the text in the source language. A description provides useful background information that the translator will refer to only if they wish. Example: a clarification of ambiguity in the source text.

Editing tools may offer an easy way to create this type of information. Translation tools can be made to recognize the difference between these two types of localization notes, and present the information to translators in different ways.

Implementation

The Localization Note data category can be expressed with global rules, or locally on an individual element. For elements, the data category information inherits to the textual content of the element, including child elements, but excluding attributes.

GLOBAL: The locNoteRule element contains the following:

A required selector attribute. It contains an absolute selector which selects the nodes to which this rule applies. A required locNoteType attribute with the value description or alert.

Exactly one of the following:

A locNote element that contains the note itself and allows for local ITS markup. A locNotePointer attribute that contains a relative selector pointing to a node that holds the localization note. A locNoteRef attribute that contains an IRI referring to the location of the localization note. A locNoteRefPointer attribute that contains a relative selector pointing to a node that holds the IRI referring to the location of the localization note.
The locNote element

The locNoteRule element associates the content of the locNote element with the message with the identifier 'DisableInfo' and flags it as important. This would also work if the rule was in an external file, allowing to provide notes without modifying the source document.

The locNotePointer attribute

The locNotePointer attribute is a relative selector pointing to a node that holds the note.

The locNoteRef attribute

The locNoteRule element specifies that the message with the identifier 'NotFound' has a corresponding explanation note in an external file. The IRI for the exact location of the note is stored in the locNoteRef attribute.

The locNoteRefPointer attribute

The locNoteRefPointer attribute contains a relative selector pointing to a node that holds the IRI referring to the location of the note.

LOCAL: The following local markup is available for the Localization Note data category:

One of the following:

A locNote attribute that contains the note itself. A locNoteRef attribute that contains an IRI referring to the location of the localization note.

An optional locNoteType attribute with the valuedescription or alert. If the locNoteType attribute is not present, the type of localization note will be assumed to be description.

The Localization Note data category expressed locally The Localization Note data category expressed locally in HTML

It is generally recommended to avoid using attributes to store text, however, in this specific case, the need to provide the notes without interfering with the structure of the host document is outweighing the drawbacks of using an attribute.

Terminology
Definition

The Terminology data category is used to mark terms and optionally associate them with information, such as definitions. This helps to increase consistency across different parts of the documentation. It is also helpful for translation.

Existing terminology standards such as and its derived formats are about coding terminology data, while the ITS Terminology data category simply allows to identify terms in XML documents and optionally to point to corresponding information.

Implementation

The Terminology data category can be expressed with global rules, or locally on an individual element. There is no inheritance. The default is that neither elements nor attributes are terms.

GLOBAL: The termRule element contains the following:

A required selector attribute. It contains an absolute selector which selects the nodes to which this rule applies. A required term attribute with the value yes or no.

None or exactly one of the following:

A termInfoPointer attribute that contains a relative selector pointing to a node that holds the terminology information. A termInfoRef attribute that contains an IRI referring to the resource providing information about the term. A termInfoRefPointer attribute that contains a relative selector pointing to a node that holds the IRI referring to the location of the terminology information.
Usage of the termInfoPointer attribute Usage of the termInfoRef attribute Usage of the termInfoRefPointer attribute

LOCAL: The following local markup is available for the Terminology data category:

A term attribute with the value yes or no. An optional termInfoRef attribute that contains an IRI referring to the resource providing information about the term. An optional termConfidence attribute with the value of a rational number in the interval 0 to 1 (inclusive). The value follows the XML Schema decimal data type with the constraining facets minInclusive set to 0 and maxInclusive set to 1. termConfidence represents the confidence of the agents producing the annotation that the values of the term and, where provided, termInfoRef, are accurate. 1 represents the highest level of confidence.

Any node selected by the terminology data category with the termConfidence attribute specified MUST be contained in an element with the annotatorsRef (or in HTML its-annotators-ref) attribute specified for the Terminology data category. See for more information.

The Terminology data category expressed locally, including term information reference and confidence score. The Terminology data category expressed locally in HTML
Directionality

This section is informative.

As time of writing, directionality is not clearly defined in HTML, and no implementation commitment is seen for the Directionality data category in ITS 2.0. Hence this data category is defined as informative, creating a non-backward compatibly change to ITS 1.0. This note and this section may be updated with the proper guidance if the HTML definition is stabilized before ITS 2.0 moves to proposed recommendation status. Nevertheless, to be able to move to last call, the Directionality data category will not be defined as a normative feature of ITS 2.0.

Definition

The Directionality data category allows the user to specify the base writing direction of blocks, embeddings and overrides for the Unicode bidirectional algorithm. It has four values: ltr, rtl, lro and rlo.

ITS defines only the values of the Directionality data category and their inheritance. The behavior of text labeled in this way may vary, according to the implementation. Implementers are encouraged, however, to model the behavior on that described in the CSS 2.1 specification or its successor. In such a case, the effect of the data category's values would correspond to the following CSS rules:

Data category value: ltr (left-to-right text)

CSS rule: *[dir="ltr"] { unicode-bidi: embed; direction: ltr}

Data category value: rtl (right-to-left text)

CSS rule: *[dir="rtl"] { unicode-bidi: embed; direction: rtl}

Data category value: rlo (left-to-right override)

CSS rule: *[dir="lro"] { unicode-bidi: bidi-override; direction: ltr}

Data category value: rlo (right-to-left text)

CSS rule: *[dir="rlo"] { unicode-bidi: bidi-override; direction: rtl}

More information about how to use this data category is provided by .

Implementation

The Directionality data category can be expressed with global rules, or locally on an individual element. For elements, the data category information inherits to the textual content of the element, including child elements and attributes. The default is that both elements and attributes have the directionality of left-to-right.

GLOBAL: The dirRule element contains the following:

A required selector attribute. It contains an absolute selector which selects the nodes to which this rule applies. A required dir attribute with the value ltr, rtl, lro or rlo. Document which needs global rules for directionality

In this document the right-to-left directionality is marked using a direction attribute with a value rtlText.

The Directionality data category expressed with global rules

The dirRule element indicates that all elements with an attribute direction="rtlText" have right-to-left content.

LOCAL: The following local markup is available for the Directionality data category:

A dir attribute with the value ltr, rtl, lro or rlo. The Directionality data category expressed locally

On the first quote element, the its:dir="rtl" attribute indicates a right-to-left content.

The Directionality data category expressed locally in HTML
Ruby

This section is informative.

As time of writing, ruby is not clearly defined in HTML, and no implementation commitment is seen for the Ruby data category in ITS 2.0. Hence this data category is defined as informative, creating a non-backward compatibly change to ITS 1.0. This note and this section may be updated with the proper guidance if the HTML definition is stabilized before ITS 2.0 moves to proposed recommendation status. Nevertheless, to be able to move to last call, the Ruby data category will not be defined as a normative feature of ITS 2.0.

Definition

The Ruby data category is used for a run of text that is associated with another run of text, referred to as the base text. Ruby text is used to provide a short annotation of the associated base text. It is most often used to provide a reading (pronunciation) guide.

Implementation Examples for HTML need to be added;

The Ruby data category can be expressed with global rules, or locally. There is no inheritance.

GLOBAL: The rubyRule element contains the following:

A required selector attribute. It contains an absolute selector which selects the nodes to which this rule applies. This is the ruby base text. An optional rubyPointer attribute that contains a relative selector pointing to a node that corresponds to the ruby element. An optional rpPointer attribute that contains a relative selector pointing to a node that corresponds to the ruby parenthesis. An optional rubyText element that contains the ruby text. An optional rtPointer attribute that contains a relative selector pointing to a node that corresponds to the ruby text.

Where legacy formats do not contain ruby markup, it is still possible to associate ruby text with a specified range of document content using the rubyRule element.

Adding ruby text with a rubyRule element

LOCAL: In a document, the Ruby data category is realized with a ruby element. It contains the following:

Not sure if the following is correct and understandable. Also Ruby model was recently extended in HTML5, we should align to this probably. The ruby base text or span element that contains the ruby base text and allows for local ITS markup. An rp element that contains the ruby parenthesis. It is used in case of simple markup to specify characters that can denote the beginning and end of ruby text when user agents do not have other ways to present ruby text distinctively from the base text. An rt element that contains the ruby text and allows for local ITS markup.

All these elements share the attributes of the span element.

The Ruby data category expressed locally

The structure of the content model for the ruby element is identical with the structure of ruby markup as defined in .

Language Information
Definition

The element langRule is used to express the language of a given piece of content. The langPointer attribute points to the markup which expresses the language of the text selected by the selector attribute. This markup MUST use values that conform to . The recommended way to specify language identification is to use xml:lang in XML, and lang in HTML. The langRule element is intended only as a fall-back mechanism for documents where language is identified with another construct.

Pointing to language information via langRule

The following langRule element expresses that the content of all p elements (including attribute values and textual content of child elements) are in the language indicated by mylangattribute, which is attached to the p elements, and expresses language using values conformant to .

The Language Information data category only provides for rules to be expressed at a global level. Locally users are able to use xml:lang (which is defined by XML), or lang in HTML, or an attribute specific to the format in question (as in ).

In XML xml:lang is the preferable means of language identification. To ease the usage of xml:lang, a declaration for this attribute is part of the non-normative XML DTD and XML Schema document for ITS markup declarations. There is no declaration of xml:lang in the non-normative RELAX NG document for ITS, since in RELAX NG it is not necessary to declare attributes from the XML namespace.

Applying the Language Information data category to xml:lang attributes using global rules is not necessary, since xml:lang is the standard way to specify language information in XML. xml:lang is defined in terms of RFC 3066 or its successor ( is the "Best Common Practice" for language identification and encompasses and its successors.)

In HTML lang is the mandated means of language identification.

Implementation

The Language Information data category can be expressed only with global rules. For elements, the data category information inherits to the textual content of the element, including child elements and attributes. There is no default.

GLOBAL: The langRule element contains the following:

A required selector attribute. It contains an absolute selector which selects the nodes to which this rule applies. A required langPointer attribute that contains a relative selector pointing to a node that contains language information.
Elements Within Text
Definition

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. The values associated with this data category are:

yes : The element and its content are part of the flow of its parent element. For example the element strong in :

<strong>Appaloosa horses</strong> have spotted coats.

nested : The element is part of the flow of its parent element, its content is an independent flow. For example the element fn in :

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

no : The element splits the text flow of its parent element and its content is an independent text flow. For example the element p when inside the element li in DITA or XHTML:

<li>Palouse horses: <p>They have spotted coats.</p> <p>They have been bred by the Nez Perce.</p> </li>

Implementation

The Elements Within Text data category can be expressed with global rules, or locally on an individual element. There is no inheritance. The default is that elements are not within text.

GLOBAL: The withinTextRule element contains the following:

A required selector attribute. It contains an absolute selector which selects the nodes to which this rule applies. A required withinText attribute with the value yes, no or nested. Specifying elements within text with a withinTextRule element

LOCAL: The following local markup is available for the Elements Within Text data category:

A withinText attribute with the values yes, no or nested. The Elements Within Text data category expressed locally The Elements Within Text data category expressed locally in HTML
Domain
Definition

The Domain data category is used to identify the topic or subject of a given content. Such information allows to make more relevant lingusitic choices during various processes.

Examples of usage include:

Allowing machine translation systems to select the most appropriate engine and rules to translate the content. Providing a general indication of what terminology collection should be used by a translator.

This data category addresses various challenges:

Often domain-related information already exist in the document (e.g. keywords in the HTML meta element). The Domain data category provides a mechanism to point to this information. There are many flat or structured lists of domain related values, keywords, key phrases, classification codes, ontologies, etc. The Domain data category does not propose its own given list. Instead it provides a mapping mechanism to associate the values in the document with the values used by the consumer tool.
Implementation

The Domain data category can be expressed only with global rules. For elements, the data category information inherits to the textual content of the element, including child elements and attributes. There is no default.

The information provided by this data category is a comma-separated list of one or more values which is obtained by applying the following algorithm:

STEP 1: Set the initial value of the resulting string as an empty string.

STEP 2: Get the list of nodes resulting of the evaluation of the domainPointer attribute.

STEP 3: For each node:

STEP 3-1: If the node value contains a COMMA (U+002C):

STEP 3-1-1: Split the node value into separate strings using the COMMA (U+002C) as separator.

STEP 3-1-2: For each string:

STEP 3-1-2-1: Trim the leading and trailing white spaces of the string.

STEP 3-1-2-2: If the first character of the value is an APOSTROPHE (U+0027) or a QUOTATION MARK (U+0022): Remove it.

STEP 3-1-2-3: If the last character of the value is an APOSTROPHE (U+0027) or a QUOTATION MARK (U+0022): Remove it.

STEP 3-1-2-4: If the value is empty: Go to STEP 3-1-2.

STEP 3-1-2-5: Check if there is a mapping for the string (the mapping is case-insensitive):

STEP 3-1-2-5-1. If a mapping is found: Add the corresponding value to the result string.

STEP 3-1-2-5-2. Else (if no mapping is found): Add the string (in its original cases) to the result string.

STEP 3-2: Else (if the node value does not contain a COMMA (U+002C)):

STEP 3-2-1: Trim the leading and trailing white spaces of the string.

STEP 3-2-2: If the first character of the value is an APOSTROPHE (U+0027) or a QUOTATION MARK (U+0022): Remove it.

STEP 3-2-3: If the last character of the value is an APOSTROPHE (U+0027) or a QUOTATION MARK (U+0022): Remove it.

STEP 3-2-4: If the value is empty: Go to STEP 3.

STEP 3-2-5: Check if there is a mapping for the string (the mapping is case-insensitive):

STEP 3-2-5-1: If a mapping is found: Add the corresponding value to the result string.

STEP 3-2-5-2: Else (if no mapping is found): Add the string (in its original cases) to the result string.

STEP 4: Remove duplicated values from the resulting string.

STEP 5: Return the resulting string.

GLOBAL: The domainRule element contains the following:

A required selector attribute. It contains an absolute selector which selects the nodes to which this rule applies. A required domainPointer attribute that contains a relative selector pointing to a node that contains the domain information. An optional domainMapping attribute that contains a comma separated list of mappings between values in the content and consumer tool specific values. The left part of the pair corresponds to the source content and is unique within the mapping and case-insensitive. The right part of the mapping belongs to the consumer tool. Several left parts can map to a single right part. The values in the left or the right part of the mapping may contain spaces; in that case they MUST be delimited by quotation marks, that is pairs of APOSTROPHE (U+0027) or QUOTATION MARK (U+0022).

Although the domainMapping attribute it is optional, its usage is recommended. Many commercial machine translation systems use their own domain definitions; the domainMapping attribute will foster interoperability between these definitions and metadata items like keywords or dcterms.subject in Web pages or other types of content.

Values used in the domainMapping attribute are arbitrary strings. In some consumer systems or existing content, the domain may be identified via an IRI like http://example.com/domains/automotive. The domainMapping allows for using IRIs too. For the mapping, they are regarded as ordinary string values.

The domainRule element

The domainRule element expresses that the content of the HTML body element is in the domain expressed by the HTML meta element with the name attribute, value keywords. The domainPointer attribute points to that meta element.

The domainRule element

The domainRule element expresses that the content of the HTML body element is in the domain expressed by associated values. The domainPointer attribute points to the values in the source content. In this case it points to the meta elements with the name attribute set to keywords or to dcterms.subject. These elements hold the values in their content attributes. The domainMapping attribute contains the comma separated list of mappings. In the example, automotive is available in the source content, and auto is used within the consumer tool, e.g. a machine translation system.

In HTML the preferred way to express domain information is a meta element with the name attribute set to keywords, see standard metadata names in HTML. Alternatively, following the process for other metadata names the extension value of dcterms.subject can be used. The usage of both keywords and dcterms.subject is shown in example .

In the area of machine translation (e.g. machine translation systems or systems harvesting content for machine translation training), there is no agreed upon set of value sets for domain. Nevertheless it is recommended to use a small set of values both in source content and within consumer tools, to foster interoperability. If larger value sets are needed (e.g. detailed terms in the law or medical domain), mappings to the smaller value set needed for interoperability should be provided. An example would be a domainMapping attribute for generalizing the law domain: domainMapping="'criminal law' law, 'property law' law, 'contract law' law".

It is possible to have more than one domain associated with a piece of content. For example, if the consumer tool is a statistical machine translation engine, it could include corpora from all domains available in the source content in training the machine translation engine.

The consumer machine translation engine might choose to ignore the domain and take a one size fits all approach, or may be selective in which domains to use, based on the range of content marked with domain. For example, if the content has hundreds of sentences marked with domain automotive and medical, but only a couple of sentences marked with additional domains criminal law and property law, the consumer tool may opt to include its domains auto and medicine, but not law, since the extra training resources does not justify the improvement in the output.

Disambiguation
Definition

The Disambiguation data category is used to highlight (mark up) specific conceptual patterns that may require special treatment when localizing and translating content.

This data category can be used for several purposes, including, but not limited to:

Informing a translation service that a certain fragment of text is subject to follow specific translation rules, e.g. for proper names, or officially regulated translations, as well as to conveying a very specific meaning of the fragment. Informing content management systems and translation services about the intended conceptual type of a textual entity in order to enable processing based on this specific type for source and target languages, for example, when dealing with personal names, product names, or geographic names, chemical compounds, protein names, and so forth.

The use case for disambiguation is distinct from that for the Terminology data category. Disambiguation may directly inform human and automated translation activities in settings where either explicit terminology information is not (yet) available or would be not appropriate (general language case). The two data categories may also be complementary, e.g. when automatically generated disambiguation annotation provides input to a manual or automated term mining process that results in Terminology annotations.

Disambiguation support is achieved by associating a marked up fragment of text with an external web resource that can be dereferenced by a language review agent, i.e. by accessing the intended meaning or lexical choice of the fragment, and thereby contributing to its correct translation.

A fragment of text is disambiguated at different granularities: (1) lexical type, (2) ontological concept, or (3) named entity.

In the case of lexical type, the external resource may provide appropriate synonyms and example usage, such as what WordNet services do.

In the case of ontological concept, the external resource may provide a formalized conceptual definition arranged in a hierarchical framework of related concepts.

In the case of a named entity, the external resource may provide a fully fledged description of the associated real world entity. For instance, the word 'City' in the fragment 'I am going to the City' may be disambiguated on the basis of one of WordNet's synsets that can be represented by 'city', an ontological concept of 'City' that could represent a subclass of 'Populated Place' at the conceptual granularity level, or the central area of a particular city, e.g. 'City of London', as interpreted at the entity granularity level.

Linked data networks, such as DBpedia, further increase the interlinking of ontological concepts and named entity definitions for same things and in different languages, thereby offering the possibility to directly facilitate translation through a source language description.

Two types of disambiguation are possible:

Disambiguation for target type class, which explicitly describes the type class of the underlying concept or entity of the fragment. Disambiguation for target identity, which implicitly describes the intended meaning of the fragment through a link to an external resource.

Text analysis engines, such as named entity recognizers, named entity, concept and word sense disambiguation components do offer appropriate solutions to create the needed information. Content management systems are also able to present and visualize this information, or employ it to index their content. Machine translation services may use this information for optimizing their language and translation models.

Implementation

The Disambiguation data category can be expressed with global rules, or locally on an individual element. There is no inheritance.

When using disambiguation specifying the target identity, the user MUST use only one of the two addressing modes:

Using disambigSource and one of disambigIdent or disambigIdentPointer (at a global rule) to specify the collection and the identifier itself. Using one of disambigIdentRef or disambigIdentRefPointer (at a global rule) using an IRI for the disambiguation target.

GLOBAL: The disambiguationRule element contains the following:

A required selector attribute that contains an absolute selector which selects the nodes to which this rule applies. An optional disambigGranularity attribute that contains a string, specifying the granularity level of the disambiguation. The value MUST be one of the following identifiers: lexical-concept, ontology-concept, or entity. The default value is entity.

At least one of the following:

To specify the target type class, exactly one of the following:

A disambigClassPointer attribute that contains a relative selector pointing to a node specifying the type of entity or concept class behind the selector.

A disambigClassRefPointer attribute that contains a relative selector pointing to a node that holds an IRI that specifies the type of entity or concept class behind the selector.

To specify the target identity, exactly one of the following:

When using the addressing mode 1:

A disambigSourcePointer attribute that contains a relative selector to a node that holds the string representing the disambiguation identifier collection source.

A disambigIdentPointer attribute that contains a relative selector to a node that holds the string, representing the disambiguation identifier for the disambiguation target that is valid within the specified disambiguation source.

When using the addressing mode 2:

A disambigIdentRefPointer attribute that contains a relative selector pointing to a node that holds an IRI that represents a unique identifier for the disambiguation target.

For an example, see .

LOCAL: The following local markup is available for the Disambiguation data category:

An optional disambigConfidence attribute with the value of a rational number in the interval 0 to 1 (inclusive). The value follows the XML Schema decimal data type with the constraining facets minInclusive set to 0 and maxInclusive set to 1. disambigConfidence represents the confidence of the agents producing the annotation that the union of the values for the other disambiguation attributes in this instance are accurate. 1 represents the highest level of confidence.

An optional disambigGranularity attribute that contains a string, specifying the granularity level of the disambiguation. The value MUST be one of the following identifiers: lexical-concept, ontology-concept, or entity. The default value is entity.

At least one of the following:

To specify the target type class:

A disambigClassRef attribute that contains an IRI, specifying the type of entity or concept class behind the selector.

To specify the target identity, exactly one of the following:

When using the addressing mode 1:

A disambigSource attribute that contains a string representing the disambiguation identifier collection source.

A disambigIdent attribute that contains a string, representing the disambiguation identifier for the disambiguation target that is valid within the specified disambiguation source.

When using the addressing mode 2:

A disambigIdentRef attribute that contains an IRI that represents a unique identifier for the disambiguation target.

Any node selected by the disambiguation data category with the disambigConfidence attribute specified MUST be contained in an element with the annotatorsRef (or in HTML its-annotators-ref) attribute specified for the disambiguation data category. For more information, see .

Local mixed usage of Usage of disambigClassRef, disambigGranularity, and disambigIdentRef in HTML.

For referring to disambigClassRef values, implementors are encouraged to use an existing repository of entity types as long as they satisfy their requirements. For example, the Named Entity Recognition and Disambiguation ontology.

Furthermore, valid target types depend on the disambiguation granularity: types of entities are distinct from types of lexical concepts or ontology concepts. While this distinction exists, the specification does not prescribe a way of automatically inferring a disambiguation level from a target type.

When serializing the ITS mark-up in HTML, the preferred way is to serialize in RDFa Lite or Microdata due to the existing search and crawling infrastructure that is able to consume this kind of data.

Local mixed usage of disambigClassRefPointer, disambigIdentRefPointer, disambigGranularity in HTML+RDFa Lite.

See for the companion document with the mapping data.

Companion document, having the mapping data for .
Locale Filter
Definition

The Locale Filter data category specifies that a node is only applicable to certain locales.

This data category can be used for several purposes, including, but not limited to:

Include a legal notice only in locales for certain regions. Drop editorial notes from all localized output.

The Locale Filter data category associates with each selected node a list of extended language ranges conforming to . The list is comma-separated and can include the wildcard extended language range *. The list can also be empty. Whitespace surrounding language ranges is ignored.

To express that all locales should be included, one can use the wildcard * for the language range. To express that the content should not be included in any local, one can use the empty value.

Implementation

The Locale Filter data category can be expressed with global rules, or locally on an individual element. For elements, the data category information inherits to the textual content of the element, including child elements and attributes. The default is that the language range is *.

Implementations MUST NOT combine lists of language ranges from multiple rules or local attributes.

GLOBAL: The localeFilterRule element contains the following:

A required selector attribute. It contains an absolute selector which selects the nodes to which this rule applies. A required localeFilterList attribute with a comma-separated list of extended language ranges, or an empty string value. The Locale Filter data category expressed globally

The localeFilterRule element specifies that certain legal notice elements should only be shown in the specified locales. Note that using the extended language range *-CA in the localeFilterList attribute would cover all Canadian locales, including various minority languages in Canada.

The Locale Filter data category expressed globally

The localeFilterRule element specifies that editorial remarks should be removed from all translations.

LOCAL: The following local markup is available for the Locale Filter data category:

A localeFilterList attribute with a comma-separated list of extended language ranges, or an empty string value. The Locale Filter data category expressed locally
Provenance
Definition

The Provenance data category is used to 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 that resulted in the selected content.

This data category offers three types of information. First, it allows to identify translation agents. Second, it allows to identify revision agents. Third, if provenance information is needed that includes temporal or sequence information about translation processes (e.g. multiple revision cycles) or requires agents that support a wider range of activities, the data category offers a mechanism to refer to external provenance information.

The specification does not define the format of external provenance information, but it is recommended that an open provenance or change logging format be used, e.g. the W3C provenance data model .

Translation or translation revision tools, such as machine translation engines or computer assisted translation tools, may offer an easy way to create this information. Translation tools can then present this information to post-editors or translation workflow managers. Web applications may to present such information to consumers of translated documents.

The data category defines seven pieces of information:

Information Description Value Human provenance information Identification of a human translation agent A string or an IRI (only for the Ref attributes) Organisational provenance information Identification of an organization acting as a translation agent A string or an IRI (only for the Ref attributes) Tool related provenance information Identification of a software tool that was used in translating the selected content A string or an IRI (only for the Ref attributes) Human revision provenance information Identification of a human translation revision agent A string or an IRI (only for the Ref attributes) Organisational revision provenance information Identification of an organization acting as a translation revision agent A string or an IRI (only for the Ref attributes) Tool related revision provenance information Identification of a software tool that was used in revising the translation of the selected content A string or an IRI (only for the Ref attributes) Reference to external provenance information A reference to external provenance information A space (U+0020) separated list of IRIs

The tool related provenance and tool related revision provenance pieces of information are not meant to express information about tools used for creating ITS annotations themselves. For this purpose, ITS 2.0 provides a separate mechanism. See for details, especially the note on annotatorsRef usage scenarios.

Implementation

The Provenance data category can be expressed with global rules, or locally on individual elements. For elements, the data category information inherits to the textual content of the element, including child elements and attributes.

GLOBAL: The provRule element contains the following:

A required selector attribute. It contains an absolute selector which selects the nodes to which this rule applies.

A provenanceRecordsRefPointer attribute that contains a relative selector pointing to a node containing a list of provenance records. These are related to the content selected via the selector attribute.

The global rule does not apply to HTML as local markup is provided for direct annotation in HTML.

The Provenance data category used globally with standoff provenance records.

This example expresses provenance information in a standoff manner using provenanceRecords elements. The provRule element specifies that for any element with a ref attribute, that ref attribute holds a reference to an associated provenanceRecords element where the provenance information is listed. The legalnotice element has been revised two times. Hence, the related provenanceRecords element contains two provenanceRecord child elements.

LOCAL: Using the inline markup to represent the data category locally is limited to a single occurrence for a given content (e.g. one cannot have different toolRef attributes applied to the same span of text because the inner-most one would override the others). A local standoff markup is provided to allow such cases.

The following local markup is available for the Provenance data category:

Either (inline markup): at least one of the following attributes:

A person or personRef attribute that implement the human provenance information.

An org or orgRef attribute that implement the organisational provenance information.

A tool or toolRef attribute that implement the tool related provenance information.

A revPerson or revPersonRef attribute that implement the human revision provenance information.

A revOrg or revOrgRef attribute that implement the organisational revision provenance information.

A revTool or revToolRef attribute that implement the tool related revision provenance information.

A provRef attribute that implements the reference to external provenance descriptions.

Or (standoff markup):

A provenanceRecordsRef attribute. Its value is a IRI pointing to the provenanceRecords element containing the list of provenance records related to this content.

An element provenanceRecords which contains:

One or more elements provenanceRecord, each of which contains at least one of the following attributes:

A person or personRef attribute that implement the human provenance information.

An org or orgRef attribute that implement the organisational provenance information.

A tool or toolRef attribute that implement the tool related provenance information.

A revPerson or revPersonRef attribute that implement the human revision provenance information.

A revOrg or revOrgRef attribute that implement the organisational revision provenance information.

A revTool or revToolRef attribute that implement the tool related revision provenance information.

A provRef attribute that implements the reference to external provenance descriptions.

When the attributes person, personRef, org, orgRef, tool, toolRef, revPerson, revPersonRef, revOrg, revOrgRef, revTool, revToolRef and provRef are used in a standoff manner, the information they carry pertains to the content of the element that refers to the standoff annotation, not to the content of the element provenanceRecord where they are declared.

In HTML the standoff markup MUST be stored inside a script element. It MUST have a type attribute with the value application/its+xml. Its id attribute MUST be set to the same value as the xml:id attribute of the provenanceRecords element it contains.

Annotating provenance information in XML with local inline markup

The provenance related attributes at the par and legalnotice elements are used to associate the provenance information directly with the content of these elements.

Annotating provenance information in HTML with local inline markup

In this example several spans of content are associated with provenance information.

Annotating provenance information in HTML with local standoff markup

The following example shows a document using local standoff markup to encode provenance information. The p elements delimits the content to markup. They hold its-provenance-records-ref attributes that point to the standoff information inside the script elements.

External Resource
Definition

The External Resource data category 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.

Implementation

The External Resource data category can be expressed only with global rules. There is no inheritance. There is no default.

GLOBAL: The externalResourceRefRule element contains the following:

A required selector attribute. It contains an absolute selector which selects the nodes to which this rule applies. A required externalResourceRefPointer attribute that contains a relative selector pointing to a node that provides the IRI of the external resource. The externalResourceRefRule element

The externalResourceRefRule element expresses that the imagedata, audiodata and videodata elements contain references to external resources. These references are expressed via a fileref attribute. The externalResourceRefPointer attribute points to that attribute.

Two externalResourceRefRule elements used for external resources associated with HTML video elements

The two externalResourceRefRule elements select the src and the poster attributes at HTML video elements. These attributes identify different external resources, and at the same time contain the references to these resources. For this reason, the externalResourceRefPointer attributes point to the value of src and poster respectively. The underlying HTML document is given in .

An HTML document that can be used for .
Target Pointer
Definition

Some formats, such as those designed for localization or for multilingual resources, hold the same content in different languages inside a single document. The Target Pointer data category 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).

This specification makes no provision regarding the presence of the target nodes or their content: A target node may or may not exist and it may or may not have content.

This data category can be used for several purposes, including but not limited to:

Extract the source content to translate and put back the translation at its proper location.

Compare source and target content for quality verification.

Re-use existing translations when localizing the new version of an existing document.

Access aligned bi-lingual content to build memories, or to train machine translation engines.

In general, it is recommended to avoid developing formats where the same content is stored in different languages in the same document, unless for very specific use cases. See the best practices Working with multilingual documents from for further guidance.

Implementation

The Target Pointer data category can be expressed only with global rules. There is no inheritance. There is no default.

GLOBAL: The targetPointerRule element contains the following:

A required selector attribute. It contains an absolute selector which selects the nodes to which this rule applies. A required targetPointer attribute. It contains a relative selector that points to the node for the target content corresponding to the selected source node.

The source node and the target node may be of different types, but the target node must be able to contain the same content of the source node (e.g. an attribute node cannot be the target node of a source node that is an element with children).

Defining the target location of a source content with the targetPointerRule element
Id Value
Definition

The Id Value data category indicates a value that can be used as unique identifier for a given part of the content.

The recommended way to specify a unique identifier is to use xml:id or id in HTML (See the best practice Defining markup for unique identifiers from ). The idValueRule element is intended only as a fall-back mechanism for documents where unique identifiers are available with another construct.

Providing a unique identifier that is maintained in the original document can be useful for several purposes, for example:

Allow automated alignment between different versions of the source document, or between source and translated documents.

Improve the confidence in leveraged translation for exact matches.

Provide back-tracking information between displayed text and source material when testing or debugging.

The Id Value data category only provides for rules to be expressed at a global level. Locally, users are able to use xml:id (which is defined by XML) or id in HTML, or an attribute specific to the format in question (as in ).

Applying the Id Value data category to xml:id (in XML) or id (in HTML) attributes in global rules is not necessary, since these attributes are the recommended way to specify an identifier.

Implementation

The id Value data category can be expressed only with global rules. There is no inheritance. There is no default.

GLOBAL: The idValueRule element contains the following:

A required selector attribute. It contains an absolute selector which selects the nodes to which this rule applies. A required idValue attribute. It contains an XPath expression which constructs a string corresponding to the identifier of the node to which this rule applies. The identifier MUST be unique at least within the document. If the attribute xml:id is present or id in HTML for the selected node, the value of the xml:id attribute or id in HTML MUST take precedence over the idValue value. Pointing to an ID value with the idValueRule element

The idValueRule element indicates that the unique identifier for each <text> element is the value of the attribute name of its parent element.

Constructing ID values using the idValueRule element.

The idValue attribute allows to build composite values based on different attributes, element or event hard-coded text. Any of the String functions offered by XPath can be used. In the document below, the two elements <text> and <desc> are translatable, but they have only one corresponding identifier, the name attribute in their parent element.

To make sure the identifier is unique for both the content of <text> and the content of <desc>, the XPath expression concat(../@name, '_t') gives the identifier "settingsMissing_t" for the content of <text> and the expression concat(../@name, '_d') gives the identifier "settingsMissing_d" for the content of <desc>.

Using xml:id and idValueRule

When an xml:id attribute is present for a node selected by an idValueRule element, the value of xml:id takes precedence over the value defined by the idValueRule element. In the example below, the unique ID to use is “btnAgain” for the first <res> element, and “retryTip” for the second <res> element.

Preserve Space
Definition

The Preserve Space data category indicates how whitespace should be handled in content. The possible values for this data category are "default" and "preserve" and carry the same meaning as the corresponding values of the xml:space attribute. The default value is "default".

Implementation

The Preserve Space data category can be expressed with global rules, or locally using the xml:space attribute. For elements, the data category information inherits to the textual content of the element, including child elements and attributes.

The Preserve Space data category is not applicable to HTML documents because xml:space (and by extension Preserve Space) has no effect in documents parsed as text/html.

GLOBAL: The preserveSpaceRule element contains the following:

A required selector attribute. It contains an absolute selector which selects the nodes to which this rule applies. A required space attribute with the value "default" or "preserve". The Preserve Space data category expressed globally

The preserveSpaceRule element specifies that whitespace in all verse elements must be treated literally.

LOCAL: The xml:space attribute, as defined in section 2.10 of , maps exactly to the Preserve Space data category.

The Preserve Space data category expressed locally

The standard xml:space attribute specifies that the whitespace in the verse element must be treated literally.

Localization Quality Issue
Definition

The Localization Quality Issue data category is used to express information related to localization quality assessment tasks. Such tasks can be conducted on the translation of some source text into a target language or on the source text itself where its quality may impact on the localization process.

This data category can be used in a number of ways, including the following example scenarios:

An automatic quality checking tool flags a number of potential quality issues in an XML or HTML file and marks them up using ITS 2.0 markup. Other tools in the workflow then examine this markup and decide whether the file needs to be reviewed manually or passed on for further processing without a manual review stage.

A quality assessment process identifies a number of issues and adds the ITS markup to a rendered HTML preview of an XML file along with CSS styling that highlights these issues. The resulting HTML file is then sent back to the translator to assist his or her revision efforts.

A human reviewer working with a web-based tool adds quality markup, including comments and suggestions, to a localized text as part of the review process. A subsequent process examines this markup to ensure that changes were made.

The data category defines five pieces of information:

Information Description Value Notes Type A set of broad types of issues into which tool-specific issues can be categorized. One of the values defined in list of type values. ITS 2.0-compliant tools that use these types MUST map their internal values to these types. If the type of the issue is set to uncategorized, a comment MUST be specified as well. Comment A human-readable description of the quality issue. Text Severity A decimal value representing the severity of the issue, as defined by the model generating the metadata. A rational number in the interval 0 to 100 (inclusive). The value follows the XML Schema decimal data type with the constraining facets minInclusive set to 0 and maxInclusive set to 100. The higher values represent greater severity. It is up to tools to map the values of this to their own system to this scale. If needed, the original value can be passed along using a custom namespace for XML, or a data- attribute for HTML. Profile Reference A reference to a document describing the quality assessment model used for the issue. An IRI pointing to the reference document. The use of resolvable IRI is strongly recommended as it provides a way for human evaluators to learn more about the quality issues in use. Enabled A flag indicating whether the issue is enabled or not. A value yes or no, with the default value being yes. This flag is used to activate or deactivate issues. There is no prescribed behavior associated with activated or deactivated issues. One example of usage is a tool that allows the user to deactivate false positives so they are not displayed again each time the document is re-checked.
Implementation

The Localization Quality Issue data category can be expressed with global rules, or locally on individual elements. For elements, the data category information inherits to the textual content of the element, including child elements, but excluding attributes.

GLOBAL: The locQualityIssueRule element contains the following:

A required selector attribute. It contains an absolute selector which selects the nodes to which this rule applies.

Exactly one of the following:

Exactly one of the following:

A locQualityIssuesRef attribute. Its value is an IRI pointing to the locQualityIssues element containing the list of issues related to this content.

A locQualityIssuesRefPointer attribute that contains a relative selector pointing to a node with the exact same semantics as locQualityIssuesRef.

At least one of the following:

A locQualityIssueType attribute that implements the type information.

A locQualityIssueComment attribute that implements the comment information.

An optional locQualityIssueSeverity attribute that implements the severity information.

An optional locQualityIssueProfileRef attribute that implements the profile reference information.

An optional locQualityIssueEnabled attribute that implements the enabled information.

The attribute locQualityIssuesRefPointer does not apply to HTML as local markup is provided for direct annotation in HTML.

Annotating an issue in XML with locQualityIssueRule element

The locQualityIssueRule element associates the issue information with the value of the text attribute.

Annotating an issue in XML with local standoff markup and a global rule

The following example shows a document using local standoff markup to encode several issues. But because, in this case, the mrk element does not allow attributes from another namespace we cannot use locQualityIssuesRef directly. Instead, a global rule is used to map the function of locQualityIssuesRef to a non-ITS construct, here the ref attribute of any mrk elements that has its attribute type set to "x-itslq".

LOCAL: Using the inline markup to represent the data category locally is limited to a single occurrence for a given content (e.g. one cannot have different locQualityIssueType attributes applied to the same span of text because the inner-most one would override the others). A local standoff markup is provided to allow such cases.

The following local markup is available for the Localization Quality Issue data category:

Either (inline markup):

At least one of the following attributes:

A locQualityIssueType attribute that implements the type information.

A locQualityIssueComment attribute that implements the comment information.

An optional locQualityIssueSeverity attribute that implements the severity information.

An optional locQualityIssueProfileRef attribute that implements the profile reference information.

An optional locQualityIssueEnabled attribute that implements the enabled information.

Or (standoff markup):

A locQualityIssuesRef attribute. Its value is an IRI pointing to the locQualityIssues element containing the list of issues related to this content.

An element locQualityIssues with a xml:id attribute set to the identifier specified in the locQualityIssuesRef attribute. The locQualityIssues element contains:

One or more elements locQualityIssue, each of which contains:

At least one of the following attributes:

A locQualityIssueType attribute that implements the type information.

A locQualityIssueComment attribute that implements the comment information.

An optional locQualityIssueSeverity attribute that implements the severity information.

An optional locQualityIssueProfileRef attribute that implements the profile reference information.

An optional locQualityIssueEnabled attribute that implements the enabled information.

When the attributes locQualityIssueType, locQualityIssueComment, locQualityIssueSeverity, locQualityIssueProfileRef and locQualityIssueEnabled are used in a standoff manner, the information they carry pertains to the content of the element that refers to the standoff annotation, not to the content of the element locQualityIssue where they are declared.

In HTML the standoff markup MUST be stored inside a script element. It MUST have a type attribute with the value application/its+xml. Its id attribute MUST be set to the same value as the xml:id attribute of the locQualityIssues element it contains.

Annotating an issue in XML with local inline markup

The attributes locQualityIssueType, locQualityIssueComment and locQualityIssueSeverity are used to associate the issue information directly with a selected span of content.

Annotating an issue in HTML with local inline markup

In this example several spans of content are associated with a quality issue.

Annotating an issue in XML with local standoff markup

The following example shows a document using local standoff markup to encode several issues. The mrk element delimits the content to markup and holds a locQualityIssuesRef attribute that points to the locQualityIssues element where the issues are listed.

Annotating an issue in HTML with local standoff markup

The following example shows a document using local standoff markup to encode several issues. The span element delimits the content to markup and holds a loc-quality-issues-ref attribute that points to a special span element where the issues are listed within a set of other special span elements.

Localization Quality Rating
Definition

The Localization Quality Rating data category is used to express an overall measurement of the localization quality of a document or an item in a document.

This data category allows to specify a quality score or a voting result for a given item or document, as well as to indicate what constitutes a passing score or vote. It also allows to point to a profile describing the quality assessment model used for the scoring or the voting.

Implementation

The Localization Quality Rating data category is only expressed locally on individual elements. The data category information inherits to the textual content of the element, including child elements, but excluding attributes.

LOCAL: The following local markup is available for the Localization Quality Rating data category:

Exactly one of the following:

A locQualityRatingScore attribute. Its value is a rational number in the interval 0 to 100 (inclusive). The value follows the XML Schema decimal data type with the constraining facets minInclusive set to 0 and maxInclusive set to 100. The higher values represent better quality.

A locQualityRatingVote attribute. Its value is a signed integer with higher values indicating a better vote.

If locQualityRatingScore is used:

an optional locQualityRatingScoreThreshold attribute indicating the lowest score that constitutes a passing score in the profile used. Its value is a rational number in the interval 0 to 100 (inclusive). The value follows the XML Schema decimal data type with the constraining facets minInclusive set to 0 and maxInclusive set to 100.

If locQualityRatingVote is used:

an optional locQualityRatingVoteThreshold attribute indicating the lowest value that constitutes a passing vote in the profile used. Its value is a signed integer.

An optional locQualityRatingProfileRef attribute. Its value is an IRI pointing to the reference document describing the quality assessment model used for the scoring.

The Localization Quality Rating data category expressed locally in XML

The locQualityRatingScore, locQualityRatingThreshold and locQualityRatingProfileRef are used to score the quality of the document.

The Localization Quality Rating data category expressed locally in HTML

The its-loc-quality-rating-score, its-loc-quality-rating-score-threshold and its-loc-quality-rating-profile-ref are used to score the quality of the document.

MT Confidence
Definition

The MT Confidence data category is used to communicate the self-reported confidence score from a machine translation engine of the accuracy of a translation it has provided. It is not intended to provide a score that is comparable between machine translation engines and platforms. This data category does NOT aim to establish any sort of correlation between the self-reported confidence score and either human evaluation of MT usefulness, or post-editing cognitive effort. For harmonization’s sake, MT Confidence is provided as a rational number in the interval 0 to 1 (inclusive).

Implementers are expected to interpret the floating point number and present it to human and other consumers in a convenient form, such as percentage (0-100%) with up to 2 decimal digits, font or background color coding, etc.

This data category can be used for several purposes, including, but not limited to:

Automated prioritising of raw machine translated text for further processing based on empirically set thresholds.

Providing readers, translators, post-editors, reviewers and proof-readers of machine translated text with self-reported relative accuracy prediction.

MT confidence scores can be displayed e.g. on websites machine translated on the fly, by simple web-based translation editors or on Computer Aided Translation (CAT) tools.

Implementation

The MT Confidence category can be expressed with global rules or locally on individual elements. For elements, the data category information is inherited by the textual content of the element, including child elements, but excluding attributes.

Any node selected by the MT Confidence data category MUST be contained in an element with the annotatorsRef (or in HTML, its-annotators-ref) attribute specified for the MT Confidence data category. For more information, see .

GLOBAL: The mtConfidenceRule element contains the following:

A required selector attribute. It contains an absolute selector which selects the nodes to which this rule applies.

A required mtConfidence attribute with a value that represents the translation confidence score as a rational number in the interval 0 to 1 (inclusive). The value follows the XML Schema decimal data type with the constraining facets minInclusive set to 0 and maxInclusive set to 1.

Global usage of mtConfidenceRule in a HTML document to specify the confidence scores for the translation into English of the title attributes of two img elements.

Where the external ITS rules file is as shown:

XML file with external rules references from an HTML file.

LOCAL: the following local markup is available for the MT Confidence data category:

A mtConfidence attribute with a value that represents the translation confidence score as a rational number in the interval 0 to 1 (inclusive). The value follows the XML Schema decimal data type with the constraining facets minInclusive set to 0 and maxInclusive set to 1.

The MT Confidence data category expressed locally for the content of a span in an XML document. The MT Confidence data category expressed locally for the content of two separate spans in a HTML document.
Allowed Characters
Definition

The Allowed Characters data category is used to specify what characters are allowed in a given piece of content.

This data category can be used for various purposes, including the following examples:

Limiting the characters that may be used in the UI of a game due to font restrictions. Preventing illegal characters from being entered as text content that represents file or directory names. Controlling what characters can be used when translating examples of a login name in content.

The Allowed Characters data category is not intended to disallow HTML markup. The purpose is to restrict the content to various characters only, e.g., when the content is to be used for URL or filename generation. In most Content Management Systems, content is divided into several fields, some of which may be restricted to plain text, while in other fields HTML fragments may be allowed. Enforcing such restrictions is outside the scope of this data category. For further information see .

The set of characters that are allowed is specified using a regular expression. That is, each character in the selected content MUST be included in the set specified by the regular expression.

The regular expression is a character class construct as defined in the section Character Classes of XML Schema , with the assumption that the . metacharacter matches also CARRIAGE RETURN (U+000D) and LINE FEED (U+000F). That is with the dot-all option set.

Example of expressions (shown as XML source):

"[abc]" : allows the characters 'a', 'b' and 'c'. "[a-c]" : allows the characters 'a', 'b' and 'c'. "[a-zA-Z]" : allows the characters from 'a' to 'z' and from 'A' to 'Z'. "[^abc]" : allows any characters except 'a', 'b', and 'c'. "[^&#x0061;-c]" : allows any characters except 'a', 'b', and 'c'. "\w" : allows any character except the set of "punctuation", "separator" and "other" characters. "[&#x20;-&#x1ffff;-[&lt;>:&quot;\\/|\?*]]" : allows only the characters valid for Windows file names. "." : allows any character. "" : allows no character. "[a-&#x00ff;-[\s]]" : allows all characters between U+0061 and U+00FF except the characters SPACE (U+0020), TABULATION (U+0009), CARRIAGE RETURN (U+000D) and LINE FEED (U+000F).
Implementation

The Allowed Characters data category can be expressed with global rules, or locally on individual elements. For elements, the data category information inherits to the textual content of the element, including child elements, but excluding attributes.

GLOBAL: The allowedCharactersRule element contains the following:

A required selector attribute. It contains an absolute selector which selects the nodes to which this rule applies.

Exactly one of the following:

An allowedCharacters attribute that contains the regular expression indicating the allowed characters.

An allowedCharactersPointer attribute that contains a relative selector pointing to a node with the exact same semantics as allowedCharacters.

The Allowed Characters data category expressed globally in XML

The allowedCharactersRule element states that the translated content of elements content must not contain the characters * and +.

Mapping the Allowed Characters data category in XML

The attribute allowedCharactersPointer is used to map the data category to the non-ITS attribute set in this document. The attribute has the same semantics as allowedCharacters.

LOCAL: the following local markup is available for the Allowed Characters data category:

A allowedCharacters attribute that contains the regular expression indicating the allowed characters.

The Allowed Characters data category expressed locally in XML

The local allowedCharacters attribute specifies that the translated content of element panelmsg must contain only Unicode characters between U+0020 and U+00FE.

The Allowed Characters data category expressed locally in HTML

The local its-allowed-characters attribute specifies that the translated content of element code must not contain the characters other than 'a' to 'z' in any case and the characters underscore and minus.

Storage Size
Definition

The Storage Size data category is used to specify the maximum storage size of a given content.

This data category can be used for various purposes, including the following examples:

Verify during translation if a string fits into a fixed-size database field. Control the size of a string that is stored in a fixed-size memory buffer at run-time.

The storage size is expressed in bytes and is provided along with the character set encoding used to store the content.

Implementation

The Storage Size data category can be expressed with global rules, or locally on individual elements. There is no inheritance. The default value of the character set encoding is UTF-8.

GLOBAL: The storageSizeRule element contains the following:

A required selector attribute. It contains an absolute selector which selects the nodes to which this rule applies.

Exactly one of the following:

A storageSize attribute. It contains the maximum number of bytes the text of the selected node is allowed in storage.

A storageSizePointer attribute that contains a relative selector pointing to a node with the exact same semantics as storageSize.

None or exactly one of the following:

A storageEncoding attribute. It contains the name of the character set encoding used to calculate the number of bytes of the selected text. The name MUST be one of the names or aliases listed in the IANA Character Sets registry . The default value is "UTF-8".

A storageEncodingPointer attribute that contains a relative selector pointing to a node with the exact same semantics as storageEncoding.

An optional lineBreakType attribute. It indicates what type of line breaks the storage uses. The possible values are: cr for CARRIAGE RETURN (U+000D), lf for LINE FEED (U+000A), crlf for CARRIAGE RETURN (U+000D) followed by LINE FEED (U+000A), or nel for NEXT LINE (U+0085). The default value is lf.

The Storage Size data category expressed globally in XML

The storageSizeRule element is used to specify that, when encoded in ISO-8859-1, the content of the country element must not be more than 25 bytes. The name "Papouasie-Nouvelle-Guinée" is 25 character long and fits because all characters in ISO-8859-1 are encoded as a single byte.

Mapping the Storage Size data category in XML

The storageSizePointer attribute is used to map the non-ITS attribute max to the same functionality as storageSize. There is no character set encoding specified, so the default UTF-8 is assumed. Note that, while the name "Papouasie-Nouvelle-Guinée" is 25 character long, the character 'é' is encoded into two bytes in UTF-8. Therefore this name is one byte too long to fit in its storage destination.

LOCAL: the following local markup is available for the Storage Size data category:

A storageSize attribute. It contains the maximum number of bytes the text of the selected node is allowed in storage.

An optional storageEncoding attribute. It contains the name of the character set encoding used to calculate the number of bytes of the selected text. The name MUST be one of the names or aliases listed in the IANA Character Sets registry . The default value is "UTF-8".

An optional lineBreakType attribute. It indicates what type of line breaks the storage uses. The possible values are: cr for CARRIAGE RETURN (U+000D), lf for LINE FEED (U+000A), crlf for CARRIAGE RETURN (U+000D) followed by LINE FEED (U+000A), or nel for NEXT LINE (U+0085). The default value is lf.

The Storage Size data category expressed locally in XML

The storageSize attribute allows to specify different the maximum storage sizes throughout the document.

The Storage Size data category expressed locally in HTML

The its-storage-size is used here to specify the maximum number of bytes the two editable strings can have in UTF-8.

References Addison Phillips, Mark Davis. <ref target="http://www.rfc-editor.org/rfc/bcp/bcp47.txt">Tags for Identifying Languages</ref> , September 2009. Available at http://www.rfc-editor.org/rfc/bcp/bcp47.txt. <ref target="http://www.iana.org/assignments/character-sets">Character Sets</ref> Available at http://www.iana.org/assignments/character-sets. Karl Dubost, Lynne Rosental, Dominique Hazaël-Massieux, Lofton Henderson. <ref target="http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/">QA Framework: Specification Guidelines</ref> . W3C Recommendation 17 August 2005. Available at http://www.w3.org/TR/2005/REC-qaframe-spec-20050817/. The latest version of QAFRAMEWORK is available at http://www.w3.org/TR/qaframe-spec/. Information technology -- Document Schema Definition Language (DSDL) -- Part 2: Regular-grammar-based validation -- RELAX NG. International Organization for Standardization (ISO) ISO/IEC 19757-2:2003. S. Bradner. Key Words for use in RFCs to Indicate Requirement Levels. IETF RFC 2119, March 1997. Available at http://www.ietf.org/rfc/rfc2119.txt. Martin Dürst, Michel Suignard. <ref target="http://www.ietf.org/rfc/rfc3987.txt">Internationalized Resource Identifiers (IRIs)</ref> . RFC 3987, January 2005. See http://www.ietf.org/rfc/rfc3987.txt. Steve DeRose, Eve Maler, David Orchard, Norman Walsh. <ref target="http://www.w3.org/TR/2010/REC-xlink11-20100506/">XML Linking Language 1.1</ref> . W3C Recommendation 6 May 2010. Available at . The latest version of XLink 1.1 is available at http://www.w3.org/TR/xlink11/. Tim Bray, Jean Paoli, C.M. Sperberg-McQueen, et al., editors. <ref target="http://www.w3.org/TR/2006/REC-xml-20060816/">Extensible Markup Language (XML) 1.0 (Fourth Edition)</ref> , W3C Recommendation 16 August 2006. Available at http://www.w3.org/TR/2006/REC-xml-20060816/. The latest version of XML 1.0 is available at http://www.w3.org/TR/REC-xml/. John Cowan, Richard Tobin. <ref target="http://www.w3.org/TR/2004/REC-xml-infoset-20040204/">XML Information Set (Second Edition)</ref> . W3C Recommendation 4 February 2004. Available at http://www.w3.org/TR/2004/REC-xml-infoset-20040204/. The latest version of XML Infoset is available at http://www.w3.org/TR/xml-infoset/. Tim Bray, Dave Hollander, Andrew Layman, Richard Tobin. <ref target="http://www.w3.org/TR/2006/REC-xml-names-20060816/">Namespaces in XML (Second Edition)</ref> . W3C Recommendation 16 August 2006. Available at http://www.w3.org/TR/2006/REC-xml-names-20060816/. The latest version of XML Names is available at http://www.w3.org/TR/REC-xml-names/. Henry S. Thompson, David Beech, Murray Maloney, Noah Mendelsohn. <ref target="http://www.w3.org/TR/2004/REC-xmlschema-1-20041028/">XML Schema Part 1: Structures Second Edition</ref> . W3C Recommendation 28 October 2004. Available at http://www.w3.org/TR/2004/REC-xmlschema-1-20041028/. The latest version of XML Schema is available at http://www.w3.org/TR/xmlschema-1/. Paul V. Biron, Ashok Malhotra. <ref target="http://www.w3.org/TR/2004/REC-xmlschema-2-20041028/">XML Schema Part 2: Datatypes Second Edition</ref> . W3C Recommendation 28 October 2004. Available at http://www.w3.org/TR/2004/REC-xmlschema-2-20041028/. The latest version of XML Schema is available at http://www.w3.org/TR/xmlschema-2/. James Clark. <ref target="http://www.w3.org/TR/1999/REC-xpath-19991116/">XML Path Language (XPath) Version 1.0</ref> . W3C Recommendation 16 November 1999. Available at http://www.w3.org/TR/1999/REC-xpath-19991116/. The latest version of XPath 1.0 is available at http://www.w3.org/TR/xpath/ .
Internationalization Tag Set (ITS) MIME Type

This section defines a MIME type for Internationalization Tag Set (ITS) documents. It covers both ITS 1.0 and ITS 2.0.

Type name: application

Subtype name: its+xml

Required parameters: none

Optional parameters: charset

This parameter has identical semantics to the charset parameter of the "application/xml" media type as specified in IETF RFC 3023.

Encoding considerations: Identical to those of "application/xml" as described in IETF RFC 3023, section 3.2, as applied to an ITS document.

Security considerations: An ITS 1.0 or ITS 2.0 document may cause arbitrary URIs or IRIs to be dereferenced, via the @xlink:href attribute at the its:rules element. Therefore, the security issues of [RFC3987] 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. An implementation of ITS global rules requires the support of XPath 1.0 or its successor. Hence, processing of global rules might encompass dereferencing of URIs or IRIs during computation of XPath expressions. Arbitrary recursion is possible, as is arbitrarily large memory usage, and implementations may place limits on CPU and memory usage, as well as restricting access to system-defined functions. ITS 1.0 and ITS 2.0 permit extensions. Hence it is possible that application/its+xml may describe content that has security implications beyond those described here.

Interoperability considerations: There are no known interoperability issues.

Published specification: http://www.w3.org/TR/2007/REC-its-20070403/ and http://www.w3.org/TR/its20/.

Any XML document containing ITS 1.0 "its:rules" elements http://www.w3.org/TR/its/#selection-global can be labeled with application/its+xml. http://www.w3.org/TR/its/EX-link-external-rules-2.xml Provides an example of a document linking to a file with ITS 1.0 and ITS 2.0 "rules". The link target is at http://www.w3.org/TR/its/EX-link-external-rules-1.xml. There is no need that the link target has "its:rules" as a root element. The processing semantics is that rules are gathered in document order.

Applications that use this media type: This new media type is being registered to allow for deployment of ITS 1.0 and ITS 2.0 on the World Wide Web., e.g. by localization tools.

Additional information:

Magic number(s): none File extension(s): its Macintosh file type code(s): TEXT

Person & email address to contact for further information: World Wide Web Consortium <web-human at w3.org>

Intended usage: COMMON

Restrictions on usage: none

Author / Change controller: The Internationalization Tag Set (ITS) 1.0 and 2.0 specifications are a work product of the World Wide Web Consortium's Internationalization Tag Set Working Group. The W3C has change control over this specification.

Values for the Localization Quality Issue Type

The locQualityIssueType attribute provides a basic level of interoperability between different localization quality assurance systems. It offers a list of high-level quality issue types common in automatic and human localization quality assessment. Tools can map their internal types to these types in order to exchange information about the kinds of issues they identify and take appropriate action even if another tool does not know the specific issues identified by the generating tool.

The values listed in the following table are allowed for locQualityIssueType. The values a tool implementing the data category produces for the attribute MUST match one of the values provided in this table and MUST be semantically accurate. If a tool can map its internal values to these types it MUST do so and MUST NOT use the value other, which is reserved strictly for values that cannot be mapped to these values.

The ITS Interest Group maintains an informative mappings of tools to localization quality issue types. The ITS IG Wiki provides information on how to update that list.

Value Description Example Scope Notes terminology An incorrect term or a term from the wrong domain was used or terms are used inconsistently. The localization had “Pen Drive” when corporate terminology specified that “USB Stick” was to be used. The localization text inconsistently used "Start" and "Begin". A text renders the Hungarian term recsegőék as “buzzer bridge” in English to translate (a literal translation), but the term used in English should be “wedge block,” as specified in a terminology list supplied to the translator. S or T This value MUST NOT be used for simple typographical errors or word choice not related to defined terminologies. For example, a mistyping of “pin” as “pen” or the use of “imply” instead of “infer” (mistaking two commonly confused words) would not count as terminology issues and should be categorized as either spelling errors or mistranslations, depending on the nature of the issue. Terminology refers only to cases where incorrect choices about terms (either formal or commonly defined in a domain) are involved. mistranslation The content of the target mistranslates the content of the source. The English source reads "An ape succeeded in grasping a banana lying outside its cage with the help of a stick" but the Italian translation reads "l'ape riuscì a prendere la banana posta tuori dall sua gabbia aiutandosi con un bastone" ("A bee succeeded...") T Issues related to translation of specific terms related to the domain or task-specific language should be categorized as terminology issues. omission Necessary text has been omitted from the localization or source. One or more segments found in the source that should have been translated are missing in the target. S or T This type should not be used for missing whitespace or formatting codes, but instead should be reserved for linguistic content. untranslated Content that should have been translated was left untranslated. The source segment reads "The Professor said to Smith that he would hear from his lawyer" but the Hungarian localization reads "A professzor azt modta Smithnek, hogy he would hear from his lawyer." T omission takes precedence over untranslated. Omissions are distinct in that they address cases where text is not present, while untranslated addresses cases where text has been carried from the source untranslated. addition The translated text contains inappropriate additions. The translated text contains a note from the translator to himself to look up a term; the note should have been deleted but was not. T duplication Content has been duplicated improperly. A section of the target text was inadvertently copied twice in a copy and paste operation. T inconsistency The text is inconsistent with itself (NB: not for use with terminology inconsistency). The text states that an event happened in 1912 in one location but in another states that it happened in 1812. S or T grammar The text contains a grammatical error (including errors of syntax and morphology). The text reads "The guidelines says that users should use a static grounding strap." S or T legal The text is legally problematic (e.g., it is specific to the wrong legal system). The localized text is intended for use in Thailand but includes U.S. regulatory notices. A text translated into German contains comparative advertising claims that are not allowed by German law. S or T register The text is written in the wrong linguistic register of uses slang or other language variants inappropriate to the text. A financial text in U.S. English refers to dollars as "bucks". S or T locale-specific-content The localization contains content that does not apply to the locale for which it was prepared. A text translated for the Japanese market contains call center numbers in Texas and refers to special offers available only in the U.S. S or T Legally inappropriate material should be classified as legal. locale-violation Text violates norms for the intended locale. A text localized into German has dates in YYYY-MM-DD format instead of in DD.MM.YYYY. A text for the Irish market uses American-style foot and inch measurements instead of centimeters. A text intended for a U.S.-based audience uses U.K. spellings such as “centre” and “colour.” S or T This category should be used for spelling errors only if they relate specifically to locale expectations (e.g., a text consitently uses British instead of U.S. spellings for a text intended for the U.S.). If these errors are not systematic (e.g., a text uses U.S. spellings but has a single instance of “centre”), they should instead be counted as spelling errors. style The text contains stylistic errors. Company style guidelines dictates that all individuals be referred to as Mr. or Ms. with a family name, but the text refers to “Jack Smith”. S or T characters The text contains characters that are garbled or incorrect or that are not used in the language in which the content appears. A text should have a '•' but instead has a '¥' sign. A text translated into German omits the umlauts over 'ü', 'ö', and 'ä'. S or T misspelling The text contains a misspelling. A German text misspells the word "Zustellung" as "Zustellüng". S or T typographical The text has typographical errors such as omitted/incorrect punctuation, incorrect capitalization, etc. An English text has the following sentence: "The man whom, we saw, was in the Military and carried it's insignias". S or T formatting The text is formatted incorrectly. Warnings in the text are supposed to be set in italic face, but instead appear in bold face. Margins of the text are narrower than specified. S or T inconsistent-entities The source and target text contain different named entities (dates, times, place names, individual names, etc.) The name "Thaddeus Cahill" appears in an English source but is rendered as "Tamaš Cahill" in the Czech version. The date "February 9, 2007" appears in the source but the translated text has "2. September 2007". S or T numbers Numbers are inconsistent between source and target. A source text states that an object is 120 cm long, but the target text says it is 129 cm. long. S or T Some tools may correct for differences in units of measurement to reduce false positives. markup There is an issue related to markup or a mismatch in markup between source and target. The source segment has five markup tags but the target has only two. An opening tag in the text is missing a closing tag. S or T pattern-problem The text fails to match a pattern that defines allowable content (or matches one that defines non-allowable content). The tool disallows the regular expression pattern ['"”’][\.,] but the translated text contains "A leading “expert”, a political hack, claimed otherwise." S or T whitespace There is a mismatch in whitespace between source and target content or the text violates specific rules related to the use of whitespace.. A source segment starts with six space characters but the corresponding target segment has two non-breaking spaces at the start. The text uses a run of 12 space characters instead of a tab character to align numbers in a table. Two space characters appear after a period even though only a single period should be used. S or T internationalization There is an issue related to the internationalization of content. A line of programming code has embedded language-specific strings. A user interface element leaves no room for text expansion. A form allows only for U.S.-style postal addresses and expects five digit U.S. ZIP codes. S or T There are many kinds of internationalization issues. This category is therefore very heterogeneous in what it can refer to. length There is a significant difference in source and target length. The translation of a segment is five times as long as the source. T or S What constitutes a "significant" difference in length is determined by the model referred to in the locQualityIssueProfileRef. uncategorized The issue has not been categorized. A new version of a tool returns information on an issue that has not been previously checked and that is not yet classified. S or T This category has two uses: A tool can use it to pass through quality data from another tool in cases where the issues from the other tool are not classified (for example, a localization quality assurance tool interfaces with a third-party grammar checker). A tool's issues are not yet assigned to categories, and, until an updated assignment is made, they may be listed as uncategorized. In this case it is recommended that issues be assigned to appropriate categories as soon as possible since uncategorized does not foster interoperability. other Any issue that cannot be assigned to any values listed above. S or T This category allows for the inclusion of any issues not included in the previously listed values. This value MUST NOT be used for any tool- or model-specific issues that can be mapped to the values listed above. In addition, this value is not synonymous with uncategorized in that uncategorized issues may be assigned to another precise value, while other issues cannot. If a system has an "miscellaneous" or "other" category, it MUST be mapped to this value even if the specific instance of the issue might be mapped to another category.
Schemas for ITS

The following schemas define ITS elements and attributes and can be used as building blocks when you want to integrate ITS markup into your own XML vocabulary. You can see examples of such integration in Best Practices for XML Internationalization.

The following four schemas are provided:

1. NVDL document: The following document allows validation of ITS markup which has been added to a host vocabulary. Only ITS elements and attributes are checked. Elements and attributes of host language are ignored during validation against this NVDL document/schema.

NVDL schema for ITS

2. RELAX NG schema for elements and attributes: The NVDL schema depends on the following two schemas: RELAX NG schema for ITS elements, and RELAX NG schema for all ITS local attributes.

RELAX NG schema for ITS elements

(RELAX NG compact syntax version of schema)

RELAX NG schema for all ITS local attributes

(RELAX NG compact syntax version of schema)

3. Base RELAX NG schema for ITS: All ITS elements and attributes referenced by previous two schemas are defined in the base RELAX NG schema for ITS.

Base RELAX NG schema for ITS

(RELAX NG compact syntax version of schema)

4. Data type definitions: All datatypes used in the base RELAX NG schema are defined the following schema.

RELAX NG schema with datatypes for ITS

(RELAX NG compact syntax version of schema)

W3C XML Schema will be provided later.
References Richard Ishida. <ref target="http://www.w3.org/International/articles/inline-bidi-markup/">What you need to know about the bidi algorithm and inline markup</ref>. Article of the W3C Internationalization Activity, June 2005. Okapi Project. <ref target="http://www.opentag.com/okapi/wiki/index.php?title=CheckMate_-_Quality_Check_Configuration" >CheckMate – Quality Check Configuration</ref>. Available at http://www.opentag.com/okapi/wiki/index.php?title=CheckMate_-_Quality_Check_Configuration. Bert Bos, Tantek Çelik, Ian Hickson Håkon Wium Lie. <ref target="http://www.w3.org/TR/2011/REC-CSS2-20110607/">Cascading Style Sheets, level 2 revision 1 CSS 2.1 Specification</ref> . W3C Recommendation 7 June 2011. Available at http://www.w3.org/TR/2011/REC-CSS2-20110607/. The latest version of CSS2 is available at http://www.w3.org/TR/CSS21/. Michael Priestley, JoAnn Hackos, et. al., editors. <ref target=" https://www.oasis-open.org/committees/download.php/15316/dita10.zip">OASIS Darwin Information Typing Architecture (DITA) Language Specification v1.0</ref>. OASIS Standard 9 May 2005. Available at https://www.oasis-open.org/committees/download.php/15316/dita10.zip. Norman Walsh and Leonard Muellner. <ref target="http://www.docbook.org/">DocBook: The Definitive Guide</ref> . Available at http://www.docbook.org/. Richard Ishida, Susan Miller. Localization vs. Internationalization. Article of the W3C Internationalization Activity, January 2006. Ian Hickson <ref target="http://www.w3.org/TR/html5/">HTML5 – A vocabulary and associated APIs for HTML and XHTML</ref> . W3C Working Draft 29 March 2012. Available at http://www.w3.org/TR/html5/. (International Organization for Standardization). TermBase eXchange (TBX). [Geneva]: International Organization for Standardization, 2008. Yves Savourel. <ref target="http://www.w3.org/TR/2006/WD-itsreq-20060518/">Internationalization and Localization Markup Requirements</ref> . W3C Working Draft 18 May 2006. Available at http://www.w3.org/TR/2006/WD-itsreq-20060518/. The latest version of ITS REQ is available at http://www.w3.org/TR/itsreq/. Richard Ishida, Yves Savourel <ref target="http://people.w3.org/rishida/localizable-dtds/">Requirements for Localizable DTD Design</ref>. Working Draft 7 July 2003. Available at http://people.w3.org/rishida/localizable-dtds/. Tantek Çelik, Elika J. Etemad, Daniel Glazman, Ian Hickson, Peter Linss, John Williams <ref target="http://www.w3.org/TR/css3-selectors/">Selectors Level 3</ref> . W3C Recommendation 29 September 2011. Available at http://www.w3.org/TR/css3-selectors/. Named Entity Recognition and Disambiguation ontology (NERD) available at: http://nerd.eurecom.fr/ontology Information technology -- Document Schema Definition Languages (DSDL) -- Part 4: Namespace-based Validation Dispatching Language (NVDL). International Organization for Standardization (ISO) ISO/IEC 19757-4:2003. Michael Brauer et al. <ref target=" https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=office" >OASIS Open Document Format for Office Applications (OpenDocument).</ref> . Oasis Standard 1 May 2005. Available at https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=office. The latest version of OpenDocument is available at https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=office. Editors tbd. Provenance data model. Details to be completed. Need to complete entry for provenance data model. Harald Alvestrand. <ref target="http://www.ietf.org/rfc/rfc3066.txt">Tags for the Identification of Languages</ref>. RFC 3066, January 2001. Available at http://www.ietf.org/rfc/rfc3066.txt. Marcin Sawicki (until 10 October, 1999), Michel Suignard, Masayasu Ishikawa (石川 雅康), Martin Dürst, Tex Texin, <ref target="http://www.w3.org/TR/ruby/">Ruby Annotation</ref> . W3C Recommendation 31 May 2001. Available at http://www.w3.org/TR/2001/REC-ruby-20010531/ . The latest version of Ruby Annotation is available at http://www.w3.org/TR/ruby/. Information technology -- Document Schema Definition Languages (DSDL) -- Part 3: Rule-based validation -- Schematron. International Organization for Standardization (ISO) ISO/IEC 19757-3:2003. Lou Burnard and Syd Bauman (eds). <ref target="http://www.tei-c.org/Guidelines/P5/">Text Encoding Initiative Guidelines development version (P5)</ref> . TEI Consortium, Charlottesville, Virginia, USA, Text Encoding Initiative. Steven Pemberton et al. <ref target="http://www.w3.org/TR/2002/REC-xhtml1-20020801/">XHTML™ 1.0 The Extensible HyperText Markup Language (Second Edition)</ref> . W3C Recommendation 26 January 2000, revised 1 August 2002. Available at http://www.w3.org/TR/2002/REC-xhtml1-20020801/. The latest version of XHTML 1.0 is available at http://www.w3.org/TR/xhtml1/. XLIFF reference - tbd. Yves Savourel, Jirka Kosek, Richard Ishida. <ref target="http://www.w3.org/TR/2008/NOTE-xml-i18n-bp-20080213/">Best Practices for XML Internationalization</ref>. Available at http://www.w3.org/TR/2008/NOTE-xml-i18n-bp-20080213/. The latest version of xml-i18n-bp is available at http://www.w3.org/TR/xml-i18n-bp/. <ref target="http://www.w3.org/2002/xmlspec/">The XML Spec Schema and Stylesheets</ref> . Available at http://www.w3.org/2002/xmlspec/. James Clark. <ref target="http://www.w3.org/TR/1999/REC-xslt-19991116">XSL Transformations (XSLT) Version 1.0</ref> . W3C Recommendation 16 November 1999. Available at http://www.w3.org/TR/1999/REC-xslt-19991116. The latest version of XSLT 1.0 is available at http://www.w3.org/TR/xslt. <ref target="http://www.xulplanet.com/">exTensible User Interface Language</ref> . Available at http://www.xulplanet.com/.
Checking ITS Markup Constraints With Schematron Should this be removed? Brief discussion at Prague f2f seemed to say "yes", need to check with Jirka. Jirka: I think that conclusion was that I will update this to cover ITS 2.0

This section is informative.

Several constraints of ITS markup cannot be validated with ITS schemas. The following document allows for validating some of these constraints.

Testing constraints in ITS markup
Conversion NIF2ITS

The following algoritm relies on . It is assumed that the example has been converted to NIF, leading to the output exemplified for the ITS2NIF conversion algorithm.

As a natural language processing (NLP) tool, we choose DBpedia Spotlight. For this example let's assume DBpedia Spotlight linked "Ireland" to DBpedia:

rdf:type str:String ; itsrdf:disambigIdentRef . rdf:type . ]]>

The conversion algorithm to generate ITS out of NIF consists of two steps.

STEP 1: Send the text to any NIF web service, which creates the NLP annotation. The output of the Web service will be a NIF representation.

STEP 2: Use the mapping from ITS2NIF (available after step 7 of the ITS2NIF algorithm) to reintegrate annotations in the original ITS annotated document.

For step 2, three cases can occur.

Need to check that the annotations shown for case 1 and case 2 are conform to the latest definition of "disambiguation".

CASE 1: The NLP annotation created in NIF matches the text node. Solution: Attach the annotation to the parent element of the text node.

itsrdf:nif . # and: itsrdf:disambigIdentRef . # we can attach the metadata to the parent node: Ireland ]]>

CASE 2: The NLP annotation created in NIF is a substring of the text node. Solution: Create a new element, e.g. for HTML "span". A different input example is given below as case 2 is not covered in the original example input.

Welcome to Dublin in Ireland!

# ITS2NIF itsrdf:nif # DBpedia Spotlight returns: itsrdf:disambigIdentRef . # NIF2ITS

Welcome to Dublin in List of ITS 2.0 Global Elements and Local Attributes

The following table lists global ITS 2.0 elements inside rules element and local ITS 2.0 markup in XML and HTML. Note that for the local markup there are various constraints on what local attributes should be used together. Here these constraints are expressed via occurrence indicators: optional ?, alternatives |, or groups (...). Please check the related sub sections in defining local markup normatively.

In addition to below markup, ITS 2.0 provides a means to refer to the tools used to generate the markup: for XML the annotatorsRef attribute and for HTML the annotators-ref attribute. See for details, especially the note on annotatorsRef usage scenarios.

Data category Global element inside rules element Local XML attributes in ITS namespace HTML attributes Translate translateRule translate translate Localization Note locNoteRule (locNote | locNoteRef), locNoteType? (its-loc-note | loc-note-ref), loc-note-type? Terminology termRule term, termInfoRef?, termConfidence? its-term, its-term-info-ref?, its-term-confidence? Directionality dirRule dir dir Ruby rubyRule - - Language Information langRule xml:lang lang Elements Within Text withinTextRule withinText its-within-text Domain domainRule - - Disambiguation disambiguationRule disambigConfidence?, disambigGranularity?, at least one of (disambigClassRef, ((disambigSource, disambigIdent) | disambigIdentRef)) its-disambig-confidence?, its-disambig-granularity?, at least one of (its-disambig-class-ref, ((its-disambig-source, its-disambig-ident) | its-disambig-ident-ref)) Locale Filter localeFilterRule localeFilterList its-locale-filter-list Provenance provRule (At least one of ((person | personRef), (org | orgRef), (tool | toolRef), (revPerson | revPersonRef), (revOrg | revOrgRef), (revTool | revToolRef), provRef)) | provenanceRecordsRef (At least one of ((its-person | its-person-ref), (its-org | its-org-ref), (its-tool | its-tool-ref), (its-rev-person | its-rev-person-ref), (its-rev-org | its-rev-org-ref), (its-rev-tool | its-rev-tool-ref), its-prov-ref)) | its-provenance-records-ref External Resource externalResourceRefRule - - Target Pointer targetPointerRule - - Id Value idValueRule xml:id id Preserve Space preserveSpaceRule xml:space - Localization Quality Issue locQualityIssueRule (at least one of (locQualityIssueType, locQualityIssueComment), locQualityIssueSeverity?, locQualityIssueProfileRef?, locQualityIssueEnabled?) | locQualityIssuesRef (at least one of (its-loc-quality-issue-type, its-loc-quality-issue-comment), its-loc-quality-issue-severity?, its-loc-quality-issue-profile-ref?, its-loc-quality-issue-enabled?) | its-loc-quality-issues-ref Localization Quality Rating - (locQualityRatingScore, locQualityRatingScoreThreshold?) | (locQualityRatingVote, locQualityRatingVoteThreshold?), locQualityRatingProfileRef? (its-loc-quality-rating-score, its-loc-quality-rating-score-threshold?) | (its-loc-quality-rating-vote, its-loc-quality-rating-vote-threshold?), its-loc-quality-rating-profile-ref? MT Confidence mtConfidenceRule mtConfidence its-mt-confidence Allowed Characters allowedCharactersRule allowedCharacters its-allowed-characters Storage Size storageSizeRule storageSize, storageEncoding?, lineBreakType? its-storage-size, its-storage-encoding?, lits-line-break-type?

Revision Log

The following log records major changes that have been made to this document since the ITS 2.0 Working Draft 23 October 2012.

Clarified usage of Domain data category in HTML in response to issue-56. Added the enabled information in . Updated the Disambiguation data category. Fine tuned the algorithm to compute the result values of the Domain data category. Fix on : id attribute of script element now the same as of containing XML. NIF example fix - see action-284. Added a note to mark CSS selectors as feature at risk, see action-272. Defined in that an XPath based relative selector can also be an absolute location path - see the domainPointer attribute in and action-282. Defined Directionality and Ruby as non-normative features. See , note on directionality, note on ruby, and action-250. Update on Disambiguation example . See action-266 (related discussion). Made a simplification of Disambiguation used globally. See action-267. Added , see action-251. Added , see action-287 and action-288. Added see action-301. Added confidence score attributes to Disambiguation and MTConfidence data categories - see action-298 and action-299. Updated - now called Provenance instead of Translation Agent Provenance - see action-300. Added a note to differentiate Disambiguation from Terminology data category - see action-304. Reworked the for global rules and standoff markup as per action-303. Removed placeholder for text analysis annotation, since the text analysis annotation requirement is covered by the local disambiguation attribute disambigConfidence, in conjunction with . Added explanations about ITS 2.0 and plain text in CMS to and - see action-262 and action-302. Various edits, see summary mail and action-312 and action-317. Updated list of pointer attributes in , see action-308. Checked data category overview table, see action-313, and various edits, see summary mail. Clarification of pointer attribute values in , see mail for details. Online editing call - see call minutes and summary mail. Updated to remove all the pointers attributes, except provenanceRecordsRefPointer. Updated to remove the global rules and adjust the thresholds. Re-structered and added XHTML example. Made a normative section. Moved list of data category identifiers from to data category overview table, see action-330. Added : external rules with rules as the root element. See action-328. HTML5 in document now replaced with HTML, see action-327. Changed made during editing call 29 November, see editing call minutes. Made changes (see detailed description) to descriptions of allowed values for Localization Quality Issue (specifically terminology, locale-violation, and whitespace to respond to and clarify points raised by Daniel Naber. Added , see action-321. Renaming attribute for . See change description. Changes related to annotatorsRef, see Working Group call 2012-12-03 discussion. Changes related to disambigGranularity attribute, see Working Group call 2012-12-03 discussion and action-359.

The following log records major changes that have been made to this document since the ITS 2.0 Working Draft 29 August 2012.

Added a first draft of Added . Removed inline markup declarations. Addition of a locQualityRatingVote attribute and a locQualityRatingVotePointer attribute to . A clarification of ITS data category information and processing of content in . Added . Added . Added . Added a note about informative mappings of Values for the Localization Quality Issue Type to the ITS IG wiki.

Added a conformance clause about HTML versus XML processing.

Added links to XML and HTML examples to the data category overview table.

Added new kind of user to .

Added the algorithm to obtain the value of the Domain data category.

Updated the Allowed Characters data category for the empty string case and the way to define "allow any characters"..

Added sections related to NIF conversion ( and ) and a related conformance clause 2-4.

The following log records major changes that have been made to this document since the ITS 2.0 Working Draft 31 July 2012.

Added . Added . Added . Added support for different query language and reworked whole XPath and CSS Selectors integration. Added examples to . Simplified . Added a note about HTML and the attributes dir and translate to . Added definition of param element to . Added . Original Ruby markup model changed to HTML5 Ruby model. Updated references. Added . Added and the related . Added . Added a placeholder .

The following log records major changes that have been made to this document since the ITS 2.0 Working Draft 26 June 2012.

Various editorial changes (non-normative references update, style & grammar fixes). Made clarifications to , . Added explanatory note on precedence and overriding in . Reordered some components in . Restructured . Added as a stub. Added . Added . Added . Added local markup in . Added . Updated examples to use the version attribute with the value 2.0.

The following log records major changes that have been made to this document between the ITS 1.0 Recommendation and this document.

Clarified introduction to cover ITS 2.0 Added a subsection on the relation to ITS 1.0 to the introduction, see Created HTML based declarations for various data categories, see e.g. HTML declarations for the Terminology data category and the summary for local data categories in Created examples for these declarations, see e.g. Added placeholders for new data categories to Added a placeholder section
Acknowledgements

This document has been developed with contributions by the MultilingualWeb-LT Working Group: Mihael Arcan (DERI Galway at the National University of Ireland, Galway, Ireland), Pablo Badía (Linguaserve), Aaron Beaton (Opera Software), Aljoscha Burchardt (German Research Center for Artificial Intelligence (DFKI) Gmbh), Nicoletta CalzolarI (CNR--Consiglio Nazionale delle Ricerche), Mauricio del Olmo (Linguaserve), Giuseppe Deriard (Linguaserve), Pedro Luis Díez Orzas (Linguaserve), David Filip (University of Limerick), Leroy Finn (Trinity College Dublin), Karl Fritsche (Cocomore AG), Daniel Grasmick (Lucy Software and Services GmbH), Declan Groves (Centre for Next Generation Localisation), Moritz Hellwig (Cocomore AG), Manuel Honegger (University of Limerick), Dominic Jones (Trinity College Dublin), Milan Karásek (Moravia Worldwide), Jirka Kosek (University of Economics, Prague), Michael Kruppa (Cocomore AG), David Lewis (Trinity College Dublin), Fredrik Liden (ENLASO Corporation), Christian Lieske (SAP AG), Arle Lommel (German Research Center for Artificial Intelligence (DFKI) Gmbh), Shaun McCance ((public) Invited expert), Jan Nelson (Microsoft Corporation), Pablo Nieto Caride (Linguaserve), Naoto Nishio (University of Limerick), Philip O'Duffy (University of Limerick), Des Oates (Adobe Systems Inc.), Carina Pellar (Cocomore AG), Georgios Petasis (Institute of Informatics & Telecommunications (IIT), NCSR), Georg Rehm (German Research Center for Artificial Intelligence (DFKI) Gmbh), Phil Ritchie (VistaTEC), Thomas Rüdesheim (Lucy Software and Services GmbH), Nieves Sande (German Research Center for Artificial Intelligence (DFKI) Gmbh), Felix Sasaki (W3C Staff), Yves Savourel (ENLASO Corporation), Jörg Schütz (W3C Invited Experts), Ankit Srivastava (Centre for Next Generation Localisation), Tadej Štajner (Jozef Stefan Institute), Olaf-Michael Stefanov ((public) Invited expert), Najib Tounsi (Ecole Mohammadia d'Ingenieurs Rabat (EMI)), Clemens Weins (Cocomore AG).

A special thanks to Daniel Naber for introducing us to LanguageTool and for implementing Localization Quality Issue Type functionality in language tool.