Internationalization Tag Set (ITS) Version 2.0

1.1.1 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.

• 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 HTML5.

• Where ITS 1.0 data categories are implemented in XML, the implementation must be conformant with the ITS 1.0 approach to XML to claim conformance to ITS 2.0.

1.1.2 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, HTML5, RDFa, 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 RDFa and NIF out of HTML5 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.

As of the time of this writing, the new data categories included in ITS 2.0 are:

• Domain

• Disambiguation

• Locale Filter

• Provenance

• Text Analysis Annotation

1.2.1 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.

<resources>
 <section id="Homepage">
  <arguments>
   <string>page</string>
   <string>childlist</string>
  </arguments>
  <variables>
   <string>POLICY</string>
   <string>Corporate Policy</string>
  </variables>
  <keyvalue_pairs>
   <string>Page</string>
   <string>ABC Corporation - Policy Repository</string>
   <string>Footer_Last</string>
   <string>Pages</string>
   <string>bgColor</string>
   <string>NavajoWhite</string>
   <string>title</string>
   <string>List of Available Policies</string>
  </keyvalue_pairs>
 </section>
</resources>

<dialogue xml:lang="en-gb">
 <rsrc id="123">
  <component id="456" type="image">
   <data type="text">images/cancel.gif</data>
   <data type="coordinates">12,20,50,14</data>
  </component>
  <component id="789" type="caption">
   <data type="text">Cancel</data>
   <data type="coordinates">12,34,50,14</data>
  </component>
  <component id="792" type="string">
   <data type="text">Number of files: </data>
  </component>
 </rsrc>
</dialogue>

1.3.1 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: Section 6: Description of Data Categories

• concretely in the ITS schemas: Appendix D: Schemas E: Schemas for ITS

1.3.2 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.

<help
  xmlns:its="http://www.w3.org/2005/11/its" 
  its:version="2.0">
 <head>
  <title>Building the Zebulon Toolkit</title>
 </head>
 <body>
  <p>To re-compile all the modules of the Zebulon toolkit you need to go in the
    <path
     its:translate="no">\Zebulon\Current Source\binary</path> directory.
    Then from there, run batch file <cmd
     its:translate="no">Build.bat</cmd>.</p>
 </body>
</help>

• 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.

<help
  xmlns:its="http://www.w3.org/2005/11/its" 
  its:version="2.0">
 <head>
  <title>Building the Zebulon Toolkit</title>
  <its:rules version="2.0">
   <its:translateRule selector="//path | //cmd" translate="no"/>
  </its:rules>
 </head>
 <body>
  <p>To re-compile all the modules of the Zebulon toolkit you need to go in the
    <path>\Zebulon\Current Source\binary</path> directory.
    Then from there, run batch file <cmd>Build.bat</cmd>.</p>
 </body>
</help>

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

<help
  xmlns:its="http://www.w3.org/2005/11/its" 
  xmlns:xlink="http://www.w3.org/1999/xlink" 
  its:version="2.0">
 <head>
  <title>Building the Zebulon Toolkit</title>
  <its:rules version="2.0" xlink:href="EX-ways-to-use-its-4.xml"/>
 </head>
 <body>
  <p>To re-compile all the modules of the Zebulon toolkit you need to go in the
    <path>\Zebulon\Current Source\binary</path> directory.
    Then from there, run batch file <cmd>Build.bat</cmd>.</p>
 </body>
</help>

<its:rules
  xmlns:its="http://www.w3.org/2005/11/its"  version="2.0">
 <its:translateRule selector="//path | //cmd" translate="no"/>
</its:rules>

• 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.

<xs:schema
  xmlns:its="http://www.w3.org/2005/11/its" 
  xmlns:xs="http://www.w3.org/2001/XMLSchema"  elementFormDefault="qualified">
 <xs:import namespace="http://www.w3.org/2005/11/its" schemaLocation="its.xsd"/>
 <xs:attributeGroup name="commonAtts">
  <xs:attributeGroup ref="its:att.local.with-ns.attribute.translate"/>
  <xs:attribute name="id" type="xs:ID" use="optional"/>
 </xs:attributeGroup>
 <xs:element name="help">
  <xs:complexType>
   <xs:sequence>
    <xs:element name="head">
     <xs:complexType>
      <xs:sequence>
       <xs:element name="title" type="xs:string"/>
      </xs:sequence>
      <xs:attributeGroup ref="commonAtts"/>
     </xs:complexType>
    </xs:element>
    <xs:element name="body">
     <xs:complexType>
      <xs:choice minOccurs="1" maxOccurs="unbounded">
       <xs:element name="p">
        <xs:complexType mixed="true">
         <xs:choice minOccurs="0" maxOccurs="unbounded">
          <xs:element ref="path"/>
          <xs:element ref="cmd"/>
         </xs:choice>
         <xs:attributeGroup ref="commonAtts"/>
        </xs:complexType>
       </xs:element>
      </xs:choice>
     </xs:complexType>
    </xs:element>
   </xs:sequence>
   <xs:attributeGroup ref="its:att.version.attribute.version"/>
  </xs:complexType>
 </xs:element>
 <xs:element name="path">
  <xs:complexType mixed="true">
   <xs:attributeGroup ref="commonAtts"/>
  </xs:complexType>
 </xs:element>
 <xs:element name="cmd">
  <xs:complexType mixed="true">
   <xs:attributeGroup ref="commonAtts"/>
  </xs:complexType>
 </xs:element>
</xs:schema>

The first two approaches above can be likened to the use of CSS in [XHTML 1.0] . 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.

1.4.1 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 HTML5 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.

2.1.1 Local Approach

The document in Example 10 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.

<dbk:article

<article
  xmlns="http://docbook.org/ns/docbook" 

  xmlns:its="http://www.w3.org/2005/11/its" 
  xmlns:dbk="http://docbook.org/ns/docbook" 

  its:version="2.0" version="5.0" xml:lang="en">
 <dbk:info>
  <dbk:title>An example article</dbk:title>
  <dbk:author

 <info>
  <title>An example article</title>
  <author

    its:translate="no">
   <dbk:personname>
    <dbk:firstname>John</dbk:firstname>
    <dbk:surname>Doe</dbk:surname>
   </dbk:personname>
   <dbk:affiliation>
    <dbk:address>
     <dbk:email>foo@example.com</dbk:email>
    </dbk:address>
   </dbk:affiliation>
  </dbk:author>
 </dbk:info>
 <dbk:para>This is a short article.</dbk:para>
</dbk:article>

   <personname>
    <firstname>John</firstname>
    <surname>Doe</surname>
   </personname>
   <affiliation>
    <address>
     <email>foo@example.com</email>
    </address>
   </affiliation>
  </author>
 </info>
 <para>This is a short article.</para>
</article>

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.

2.1.2 Global Approach

The document in Example 11 shows a different approach to identifying non-translatable content, similar to that used with a style element in [XHTML 1.0] , 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"). "css"). Information for the handling of namespaces in these path expressions is taken from namespace declarations [XML Names] at the current rules rule element.

<myTopic
  xmlns:its="http://www.w3.org/2005/11/its" 
  xmlns="myNamescapeURI" id="topic01" xml:lang="en-us">
 <prolog>
  <title>Using ITS</title>
  <its:rules version="2.0">
   <its:translateRule selector="//n:term" translate="no"/>
  </its:rules>
 </prolog>
 <body>
  <p>ITS defines <term>data category</term> as an abstract
  concept for a particular type of information for 
  internationalization and localization of XML schemas and 
  documents.</p>
 </body>
</myTopic>

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)

5.2.1 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.

Another difference between adding and pointing is the usage of XPath: [Ed. note: Update to reflect queryLanguage. Probably create separate sections defining those things for XPath and CSS.] The value of the selector attribute MUST be an XPath expression which starts with " / ". That is, it must be an AbsoluteLocationPath as described in XPath 1.0 or its successor. This ensures that the selection is not relative to a specific location. The resulting nodes MUST be either element or attribute nodes. Attributes that point to existing information in the document, i.e. attributes whose name ends in ...Pointer , MUST use a RelativeLocationPath as described in XPath 1.0 or its successor. The XPath expression is evaluated relative to the nodes selected by the selector attribute. The following attributes point to existing information: locNotePointer , locNoteRefPointer , termInfoPointer , termInfoRefPointer , rubyPointer , rtPointer , rpPointer , rbcPointer , rtcPointer , rbspanPointer , langPointer . If namespaces [XML Names] are used in XPath expressions in the selector attribute or the pointing attributes, the following rules MUST be applied while processing XPath: For each prefix, there MUST be a namespace declaration in effect at the same rule element which allows to resolve the namespace URI of the prefix. Element and attribute names without a prefix are interpreted as having no namespace. To avoid a conflict with rule 2., default namespaces MUST NOT be used in the XPath expressions. [Ed. note: Need to define how default namespace work with HTML5.] Example 15: XPath expressions with namespaces The term element from the TEI is in a namespace <its:rules xmlns:its="http://www.w3.org/2005/11/its"  version="2.0">  <its:termRule selector="//tei:term" term="yes"/> </its:rules> [Source file: examples/xml/EX-selection-global-1.xml ] Example 16: XPath expressions without namespaces The qterm element from DocBook is in no namespace. <its:rules xmlns:its="http://www.w3.org/2005/11/its"  version="2.0">  <its:termRule selector="//qterm" term="yes"/> </its:rules> [Source file: examples/xml/EX-selection-global-2.xml ] 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 Section 5.4: Precedence 5.5: Precedence between Selections .

Markup for global, rule-based selection is defined as follows.

rules

[1]	rules	::=	element its:rules { rules.content, rules.attributes }
[2]	rules.content	::=	param *, ( translateRule | locNoteRule | termRule | dirRule | rubyRule | langRule | withinTextRule | domainRule | localeFilterRule | externalResourceRefRule | idValueRule )*
[3]	rules.attributes	::=	attribute version { xsd:float }, attribute xlink:href { xsd:anyURI }?, attribute xlink:type queryLanguage { "simple" "xpath" | "css" | text }?

param

[4]	param	::=	element its:param { param.content, param.attributes }
[5]	param.content	::=	text
[6]	param.attributes	::=	attribute name { string }

att.selector

[4] [7]	att.selector.attributes	::=	att.selector.attribute.selector
[5] [8]	att.selector.attribute.selector	::=	attribute selector { string }

att.version

[6] [9]	att.version.attributes	::=	att.version.attribute.version
[7] [10]	att.version.attribute.version	::=	attribute its:version { xsd:float }

5.2.2 Global selection within HTML5

Global rules work in HTML5 as follows.

1. Global rules will be attached externally using the link element, with the link relation its-rules .

2. In global rules XPath 1.0 will be used for selection.

3. If users prefer easier selection mechanism, they can switch query language to CSS selectors by using the queryLanguage attribute, see Section 2.1.3: queryLanguage 5.3.1: Choosing Query Language .

5.2.3 Local Selection in an XML Document

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

The content model of span permits arbitrary nesting of ruby markup, since the rb and rt elements themselves element can contain span . An application of ruby, however, MUST not use such arbitrary nesting.

The data category determines what is being selected. The necessary data category specific defaults are described in Section 6.1: Position, Defaults, Inheritance and Overriding of Data Categories .

<text
  xmlns:its="http://www.w3.org/2005/11/its" 
  its:version="2.0" xml:lang="en">
 <head
   its:translate="no">
  <author>Sven Corneliusson</author>
  <date>2006-09-26T17:34:04Z</date>
  <title
    its:translate="yes" role="header">Bidirectional Text</title>
 </head>
 <body>
  <par>In Arabic, the title <quote xml:lang="ar"
     its:dir="rtl">نشاط التدويل، W3C</quote>
     means <quote>Internationalization Activity, W3C</quote>.</par>
 </body>
</text>

Markup for local selection is defined as follows. The attribute group att.local.no-ns.attributes contains ITS attributes in no namespace and is used with the ITS elements span , locNote , ruby , rb , rt , rbc , rtc and rp . The attribute group att.local.with-ns.attributes contains namespace qualified ITS attributes and is used with elements from different namespaces. The attribute group att.local.html5.attributes contains ITS attribute for HTML5.

att.local.no-ns

[8] [11]	att.local.no-ns.attributes	::=	att.local.no-ns.attribute.translate , att.local.no-ns.attribute.locNote , att.local.no-ns.attribute.locNoteType , att.local.no-ns.attribute.locNoteRef , att.local.no-ns.attribute.termInfoRef , att.local.no-ns.attribute.term , att.local.no-ns.attribute.dir , att.local.no-ns.attribute.withinText , att.local.no-ns.attribute.localeFilterType , att.local.no-ns.attribute.localeFilterList
[9] [12]	att.local.no-ns.attribute.translate	::=	attribute translate { "yes" | "no" }?
[10] [13]	att.local.no-ns.attribute.locNote	::=	attribute locNote { string }?
[11] [14]	att.local.no-ns.attribute.locNoteType	::=	attribute locNoteType { "alert" | "description" }?
[12] [15]	att.local.no-ns.attribute.locNoteRef	::=	attribute locNoteRef { xsd:anyURI }?
[13] [16]	att.local.no-ns.attribute.termInfoRef	::=	attribute termInfoRef { xsd:anyURI }?
[14] [17]	att.local.no-ns.attribute.term	::=	attribute term { "yes" | "no" }?
[15] [18]	att.local.no-ns.attribute.dir	::=	attribute dir { "ltr" | "rtl" | "lro" | "rlo" }?
[16] [19]	att.local.no-ns.attribute.withinText	::=	attribute withinText { "yes" | "no" | "nested" }?
[17] att.local.no-ns.attribute.localeFilterType ::= attribute localeFilterType { "all" | "none" | "include" | "exclude" }? [18] [20]	att.local.no-ns.attribute.localeFilterList	::=	attribute localeFilterList { string }?

att.local.with-ns

[19] [21]	att.local.with-ns.attributes	::=	att.local.with-ns.attribute.translate , att.local.with-ns.attribute.locNote , att.local.with-ns.attribute.locNoteType , att.local.with-ns.attribute.locNoteRef , att.local.with-ns.attribute.termInfoRef , att.local.with-ns.attribute.term , att.local.with-ns.attribute.dir , att.local.with-ns.attribute.withinText , att.local.with-ns.attribute.localeFilterType , att.local.with-ns.attribute.localeFilterList
[20] [22]	att.local.with-ns.attribute.translate	::=	attribute its:translate { "yes" | "no" }?
[21] [23]	att.local.with-ns.attribute.locNote	::=	attribute its:locNote { string }?
[22] [24]	att.local.with-ns.attribute.locNoteType	::=	attribute its:locNoteType { "alert" | "description" }?
[23] [25]	att.local.with-ns.attribute.locNoteRef	::=	attribute its:locNoteRef { xsd:anyURI }?
[24] [26]	att.local.with-ns.attribute.termInfoRef	::=	attribute its:termInfoRef { xsd:anyURI }?
[25] [27]	att.local.with-ns.attribute.term	::=	attribute its:term { "yes" | "no" }?
[26] [28]	att.local.with-ns.attribute.dir	::=	attribute its:dir { "ltr" | "rtl" | "lro" | "rlo" }?
[27] [29]	att.local.with-ns.attribute.withinText	::=	attribute its:withinText { "yes" | "no" | "nested" }?
[28] att.local.with-ns.attribute.localeFilterType ::= attribute its:localeFilterType { "all" | "none" | "include" | "exclude" }? [29] [30]	att.local.with-ns.attribute.localeFilterList	::=	attribute its:localeFilterList { string }?

att.local.html5

[30] [31]	att.local.html5.attributes	::=	att.local.html5.attribute.its-loc-note , att.local.html5.attribute.its-loc-note-type , att.local.html5.attribute.its-loc-note-ref , att.local.html5.attribute.its-term-info-ref , att.local.html5.attribute.its-term , att.local.html5.attribute.its-within-text , att.local.html5.attribute.locale-filter-type , att.local.html5.attribute.locale-filter-list
[31] [32]	att.local.html5.attribute.its-loc-note	::=	attribute its-loc-note { string }?
[32] [33]	att.local.html5.attribute.its-loc-note-type	::=	attribute its-loc-note-type { "alert" | "description" }?
[33] [34]	att.local.html5.attribute.its-loc-note-ref	::=	attribute its-loc-note-ref { xsd:anyURI }?
[34] [35]	att.local.html5.attribute.its-term-info-ref	::=	attribute its-term-info-ref { xsd:anyURI }?
[35] [36]	att.local.html5.attribute.its-term	::=	attribute its-term { "yes" | "no" }?
[36] [37]	att.local.html5.attribute.its-within-text	::=	attribute its-within-text { "yes" | "no" | "nested" }?
[37] att.local.html5.attribute.locale-filter-type ::= attribute locale-filter-type { "all" | "none" | "include" | "exclude" }? [38]	att.local.html5.attribute.locale-filter-list	::=	attribute locale-filter-list { string }?

span

[39]	span	::=	element its:span { span.content, span.attributes }
[40]	span.content	::=	( text | ruby | span )*
[41]	span.attributes	::=	att.local.no-ns.attributes

5.3.1 Choosing Query Language

Rule elements have attributes which contain asbolute and relative selectors. Interpretation of these selectors depends on the actual query languge. 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.

5.3.2 XPath 1.0

XPath 1.0 is identified by xpath value in queryLanguage attribute.

<its:rules
  xmlns:its="http://www.w3.org/2005/11/its" 
  xmlns:tei="http://www.tei-c.org/ns/1.0" version="2.0">
 <its:termRule selector="//tei:term" term="yes"/>
</its:rules>

<its:rules
xmlns:its="http://www.w3.org/2005/11/its"
 version="2.0">
 <its:termRule selector="//term" term="yes"/>
</its:rules>

5.3.3 CSS Selectors

CSS Selectors are identified by css value in queryLanguage attribute.

5.3.4 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 .

5.3.5 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 [XML Names] .The content of the element is a string used as default value for the corresponding variable.

<doc
  xmlns:its="http://www.w3.org/2005/11/its" 
  its:version="2.0">
 <its:rules version="2.0">
  <its:param name="LCID">0x0409</its:param>
  <its:translateRule selector="/doc" translate="no"/>
  <its:translateRule selector="//msg[@lcid=$LCID]" translate="yes"/>
 </its:rules>
 <msg lcid="0x0409" num="1">Create a folder</msg>
 <msg lcid="0x0411" num="1">フォルダーを作成する</msg>
 <msg lcid="0x0407" num="1">Erstellen Sie einen Ordner</msg>
 <msg lcid="0x040c" num="1">Créer un dossier</msg>
</doc>

6.2.1 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).

6.2.2 Implementation

The Translate data category can be expressed with global rules, or locally on an individual element. The information applies 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 XPath expression absolute selector which selects the nodes to which this rule applies.

• A required translate attribute with the value "yes" or "no".

<its:rules
  xmlns:its="http://www.w3.org/2005/11/its"  version="2.0">
 <its:translateRule translate="no" selector="//code"/>
</its:rules>

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

• A translate attribute with the value "yes" or "no".

<messages
  xmlns:its="http://www.w3.org/2005/11/its" 
  its:version="2.0">
 <msg num="123">Click Resume Button on Status Display or  
    <panelmsg
    its:translate="no">CONTINUE</panelmsg> Button
    on printer panel</msg>
</messages>

<!DOCTYPE html>
<html lang="en">
 <head>
  <meta charset="utf-8"/>

  <meta charset="utf-8"><meta>

  <title>Translate flag test: Default</title>
 </head>
 <body>
  <p>The <span translate="no">World Wide Web Consortium</span> is
    making the World Web Web worldwide!</p>
 </body>
</html>

6.2.3 Markup Declarations for Translate

translateRule

[42]	translateRule	::=	element its:translateRule { translateRule.content, translateRule.attributes }
[43]	translateRule.content	::=	empty
[44]	translateRule.attributes	::=	att.selector.attributes , attribute translate { "yes" | "no" }

att.translate

[45]	att.translate.attributes	::=	att.translate.attribute.translate
[46]	att.translate.attribute.translate	::=	attribute its:translate { "yes" | "no" }?

att.translate.html5

[47]	att.translate.html5.attributes	::=	att.translate.html5.attribute.translate
[48]	att.translate.html5.attribute.translate	::=	attribute translate { "yes" | "no" }?

6.3.1 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.

6.3.2 Implementation

The Localization Note data category can be expressed with global rules, or locally on an individual element. The information applies 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 XPath expression 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 XPath expression selector pointing to a node that holds the localization note.

  • A locNoteRef attribute that contains a URI referring to the location of the localization note.

  • A locNoteRefPointer attribute that contains a relative XPath expression selector pointing to a node that holds the URI referring to the location of the localization note.

<myRes
  xmlns:its="http://www.w3.org/2005/11/its" >
 <head>
  <its:rules version="2.0"
    its:translate="no">
   <its:locNoteRule locNoteType="alert" selector="//msg[@id='DisableInfo']">
    <its:locNote>The variable {0} has three possible values: 'printer', 
        'stacker' and 'stapler options'.</its:locNote>
   </its:locNoteRule>
  </its:rules>
 </head>
 <body>
  <msg id="DisableInfo">The {0} has been disabled.</msg>
 </body>
</myRes>

<Res
  xmlns:its="http://www.w3.org/2005/11/its" >
 <prolog>
  <its:rules version="2.0">
   <its:translateRule selector="//msg/notes" translate="no"/>
   <its:locNoteRule locNoteType="description" selector="//msg/data" locNotePointer="../notes"/>
  </its:rules>
 </prolog>
 <body>
  <msg id="FileNotFound">
   <notes>Indicates that the resource file {0} could not be loaded.</notes>
   <data>Cannot find the file {0}.</data>
  </msg>
  <msg id="DivByZero">
   <notes>A division by 0 was going to be computed.</notes>
   <data>Invalid parameter.</data>
  </msg>
 </body>
</Res>

<myRes
  xmlns:its="http://www.w3.org/2005/11/its" >
 <head>
  <its:rules version="2.0">
   <its:locNoteRule locNoteType="description" selector="//msg[@id='NotFound']" locNoteRef="ErrorsInfo.html#NotFound"/>
  </its:rules>
 </head>
 <body>
  <msg id="NotFound">Cannot find {0} on {1}.</msg>
 </body>
</myRes>

<dataFile
  xmlns:its="http://www.w3.org/2005/11/its" >
 <prolog>
  <its:rules version="2.0">
   <its:locNoteRule locNoteType="description" selector="//data" locNoteRefPointer="../@noteFile"/>
  </its:rules>
 </prolog>
 <body>
  <string id="FileNotFound" noteFile="Comments.html#FileNotFound">
   <data>Cannot find the file {0}.</data>
  </string>
  <string id="DivByZero" noteFile="Comments.html#DivByZero">
   <data>Invalid parameter.</data>
  </string>
 </body>
</dataFile>

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 a URI referring to the location of the localization note.

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

<msgList
  xmlns:its="http://www.w3.org/2005/11/its"  xml:space="preserve"
  its:version="2.0">
 <data name="LISTFILTERS_VARIANT"
   its:locNote="Keep the leading space!"
   its:locNoteType="alert">
  <value> Variant {0} = {1} ({2})</value>
 </data>
 <data
   its:locNote="%1\$s is the original text's date in the format YYYY-MM-DD HH:MM always in GMT">
  <value>Translated from English content dated <span id="version-info">%1\$s</span> GMT.</value>
 </data>
</msgList>

<!DOCTYPE html>
<html lang="en">
 <head>
  <meta charset="utf-8"/>

  <meta charset="utf-8"><meta>

  <title>LocNote test: Default</title>
 </head>
 <body>
  <p>This is a <span its-loc-note="Check with terminology engineer" its-loc-note-type="alert">motherboard</span>.</p>
 </body>
</html>

6.3.3 Markup Declarations for Localization Note

locNoteRule

[49]	locNoteRule	::=	element its:locNoteRule { locNoteRule.content, locNoteRule.attributes }
[50]	locNoteRule.content	::=	locNote ?
[51]	locNoteRule.attributes	::=	att.selector.attributes , attribute locNotePointer { string }?, attribute locNoteType { "alert" | "description" }, attribute locNoteRef { xsd:anyURI }?, attribute locNoteRefPointer { string }?

locNote

[52]	locNote	::=	element its:locNote { locNote.content, locNote.attributes }
[53]	locNote.content	::=	( text | ruby | span )*
[54]	locNote.attributes	::=	att.local.no-ns.attributes

att.locNote

[55]	att.locNote.attributes	::=	att.locNote.attribute.locNote , att.locNote.attribute.locNoteType , att.locNote.attribute.locNoteRef
[56]	att.locNote.attribute.locNote	::=	attribute its:locNote { string }?
[57]	att.locNote.attribute.locNoteType	::=	attribute its:locNoteType { "alert" | "description" }?
[58]	att.locNote.attribute.locNoteRef	::=	attribute its:locNoteRef { xsd:anyURI }?

att.locNote.html5

[59]	att.locNote.html5.attributes	::=	att.locNote.html5.attribute.its-loc-note , att.locNote.html5.attribute.its-loc-note-type , att.locNote.html5.attribute.its-loc-note-ref
[60]	att.locNote.html5.attribute.its-loc-note	::=	attribute its-loc-note { string }?
[61]	att.locNote.html5.attribute.its-loc-note-type	::=	attribute its-loc-note-type { "alert" | "description" }?
[62]	att.locNote.html5.attribute.its-loc-note-ref	::=	attribute its-loc-note-ref { xsd:anyURI }?

6.4.1 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.

6.4.2 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 XPath expression absolute selector which selects the nodes to which this rule applies.

• A required term attribute with the value "yes" or "no".

• Exactly one of the following:

  • A termInfoPointer attribute that contains a relative XPath expression selector pointing to a node that holds the terminology information.

  • A termInfoRef attribute that contains a URI referring to the resource providing information about the term.

  • A termInfoRefPointer attribute that contains a relative XPath expression selector pointing to a node that holds the URI referring to the location of the terminology information. the URI referring to the location of the terminology information.

<text
  xmlns:its="http://www.w3.org/2005/11/its" >
 <its:rules version="2.0">
  <its:termRule selector="//term" term="yes" termInfoPointer="id(@def)"/>
 </its:rules>
 <p>We may define <term def="TDPV">discoursal point of view</term>
 as <gloss xml:id="TDPV">the relationship, expressed through discourse
  structure, between the implied author or some other addresser,
  and the fiction.</gloss>
 </p>
</text>

<text
xmlns:its="http://www.w3.org/2005/11/its"
>
 <its:rules version="2.0">
  <its:termRule selector="//term[1]" term="yes" termInfoRef="#TDPV"/>
 </its:rules>
 <p>We
may
define
<term>discoursal
point
of
view</term>
 as
<gloss xml:id="TDPV">the
relationship,
expressed
through
discourse
  structure,
between
the
implied
author
or
some
other
addresser,
  and
the
fiction.</gloss>
 </p>
</text>

<text
xmlns:its="http://www.w3.org/2005/11/its"
>
 <its:rules version="2.0">
  <its:termRule selector="//term" term="yes" termInfoRefPointer="@target"/>
 </its:rules>
 <p>We
may
define
<term target="#TDPV">discoursal
point
of
view</term>
 as
<gloss xml:id="TDPV">the
relationship,
expressed
through
discourse
  structure,
between
the
implied
author
or
some
other
addresser,
  and
the
fiction.</gloss>
 </p>
</text>

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 a URI referring to the resource providing information about the term.

<book
  xmlns:its="http://www.w3.org/2005/11/its" 
  its:version="2.0">
 <head>...</head>
 <body> ...  <p>And he said: you need a
   new <quote
     its:term="yes">motherboard</quote>
  </p> ...
  </body>
</book>

<!DOCTYPE html>
<html lang="en">
 <head>
  <meta charset="utf-8"/>

  <meta charset="utf-8"><meta>

  <title>Terminology test: default</title>
 </head>
 <body>
  <p>We need a new <span its-term="yes">motherboard</span>
  </p>
 </body>
</html>

6.4.3 Markup Declarations for Terminology

termRule

[63]	termRule	::=	element its:termRule { termRule.content, termRule.attributes }
[64]	termRule.content	::=	empty
[65]	termRule.attributes	::=	att.selector.attributes , attribute term { "yes" | "no" }, attribute termInfoRef { xsd:anyURI }?, attribute termInfoRefPointer { string }?, attribute termInfoPointer { string }?

att.term

[66]	att.term.attributes	::=	att.term.attribute.termInfoRef , att.term.attribute.term
[67]	att.term.attribute.termInfoRef	::=	attribute its:termInfoRef { xsd:anyURI }?
[68]	att.term.attribute.term	::=	attribute its:term { "yes" | "no" }?

att.term.html5

[69]	att.term.html5.attributes	::=	att.term.html5.attribute.its-term-info-ref , att.term.html5.attribute.its-term
[70]	att.term.html5.attribute.its-term-info-ref	::=	attribute its-term-info-ref { xsd:anyURI }?
[71]	att.term.html5.attribute.its-term	::=	attribute its-term { "yes" | "no" }?

6.5.1 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".

6.5.2 Implementation

The Directionality data category can be expressed with global rules, or locally on an individual element. The information applies 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 XPath expression absolute selector which selects the nodes to which this rule applies.

• A required dir attribute with the value "ltr", "rtl", "lro" or "rlo".

<text xml:lang="en">
 <body>
  <par>In Hebrew, the title <quote xml:lang="he" direction="rtlText">פעילות הבינאום, W3C</quote>
     means <quote>Internationalization Activity, W3C</quote>.</par>
 </body>
</text>

<its:rules
  xmlns:its="http://www.w3.org/2005/11/its"  version="2.0">
 <its:dirRule dir="rtl" selector="//*[@direction='rtlText']"/>
</its:rules>

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

• A dir attribute with the value "ltr", "rtl", "lro" or "rlo".

<text
  xmlns:its="http://www.w3.org/2005/11/its"  xml:lang="en"
  its:version="2.0">
 <body>
  <par>In Arabic, the title <quote xml:lang="ar"
     its:dir="rtl">نشاط التدويل، W3C</quote>
     means <quote>Internationalization Activity, W3C</quote>.</par>
 </body>
</text>

<!DOCTYPE html>
<html lang="en">
 <head>
  <meta charset="utf-8"/>

  <meta charset="utf-8"><meta>

  <title>Dir test: Default</title>
 </head>
 <body>
  <p>In Arabic, the title <quote xml:lang="ar" dir="rtl">نشاط التدويل، W3C</quote>
     means <quote>Internationalization Activity, W3C</quote>.</p>
 </body>
</html>

6.5.3 Markup Declarations for Directionality

dirRule

[72]	dirRule	::=	element its:dirRule { dirRule.content, dirRule.attributes }
[73]	dirRule.content	::=	empty
[74]	dirRule.attributes	::=	att.selector.attributes , attribute dir { "ltr" | "rtl" | "lro" | "rlo" }

att.dir

[75]	att.dir.attributes	::=	att.dir.attribute.dir
[76]	att.dir.attribute.dir	::=	attribute its:dir { "ltr" | "rtl" | "lro" | "rlo" }?

att.dir.html5

[77]	att.dir.html5.attributes	::=	att.dir.html5.attribute.dir
[78]	att.dir.html5.attribute.dir	::=	attribute dir { "ltr" | "rtl" | "lro" | "rlo" }?

6.6.1 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.

6.6.2 Implementation

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 XPath expression 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 XPath expression selector pointing to a node that corresponds to the ruby element.

• An optional rpPointer attribute that contains a relative XPath expression pointing to a node that corresponds to the ruby parenthesis. An optional rbcPointer attribute that contains a relative XPath expression pointing to a node that corresponds to the ruby base container. An optional rtcPointer selector attribute that contains a relative XPath expression pointing to a node that corresponds to the ruby text container. An optional rbspanPointer attribute that contains a relative XPath expression pointing to a node that corresponds to the rbspan attribute. parenthesis.

• An optional rubyText element that contains the ruby text.

• An optional rtPointer attribute that contains a relative XPath expression selector pointing to a node that corresponds to the ruby text.

<text
  xmlns:its="http://www.w3.org/2005/11/its" >
 <head> ... 
   <its:rules version="2.0">
   <its:rubyRule selector="/text/body/img[1]/@alt">
    <its:rubyText>World Wide Web Consortium</its:rubyText>
   </its:rubyRule>
  </its:rules>
 </head>
 <body>
  <img src="w3c_home.png" alt="W3C"/> ...
  </body>
</text>

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

• An rb 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 . It has an optional rbspan attribute. The rbspan attribute allows an 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.

<text
  xmlns:its="http://www.w3.org/2005/11/its" 
  its:version="2.0">
 <head> ... </head>
 <body>
  <p>この本は <its:ruby>
    <its:rb>慶応義塾大学</its:rb>
    <its:rp>(</its:rp>

        慶応義塾大学
        <its:rp>(</its:rp>

    <its:rt>けいおうぎじゅくだいがく</its:rt>
    <its:rp>)</its:rp>
   </its:ruby>の歴史を説明するものです。</p>
 </body>
</text>

6.6.3 Markup Declarations for Ruby

rubyRule

[79]	rubyRule	::=	element its:rubyRule { rubyRule.content, rubyRule.attributes }
[80]	rubyRule.content	::=	rubyText ?
[81]	rubyRule.attributes	::=	att.selector.attributes , attribute rubyPointer { string }?, attribute rtPointer { string }?, attribute rpPointer { string }?, attribute rbcPointer { string }?, attribute rtcPointer { string }?, attribute rbspanPointer { string }?

rubyText

[82]	rubyText	::=	element its:rubyText { rubyText.content, rubyText.attributes }
[83]	rubyText.content	::=	text
[84]	rubyText.attributes	::=	att.local.no-ns.attributes , attribute rbspan { string }?

ruby

[85]	ruby	::=	element its:ruby { ruby.content, ruby.attributes }
[86]	ruby.content	::=	( rb , ( text | span )+, ( rt | ( rp , rt , rp ) ) ) | ( rbc , rtc , rtc ? ) )+
[87]	ruby.attributes	::=	att.local.no-ns.attributes

rb [88] rb ::= element its:rb { rb.content, rb.attributes } [89] rb.content ::= ( text | span )* [90] rb.attributes ::= att.local.no-ns.attributes rt

[91] [88]	rt	::=	element its:rt { rt.content, rt.attributes }
[92] [89]	rt.content	::=	( text | span )*
[93] [90]	rt.attributes	::=	att.local.no-ns.attributes , attribute rbspan { string }? rbc [94] rbc ::= element its:rbc { rbc.content, rbc.attributes } [95] rbc.content ::= rb + [96] rbc.attributes ::= att.local.no-ns.attributes rtc [97] rtc ::= element its:rtc { rtc.content, rtc.attributes } [98] rtc.content ::= rt + [99] rtc.attributes ::= att.local.no-ns.attributes

rp

[100] [91]	rp	::=	element its:rp { rp.content, rp.attributes }
[101] [92]	rp.content	::=	text
[102] [93]	rp.attributes	::=	att.local.no-ns.attributes

6.7.1 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 [BCP47] . The recommended way to specify language identification is to use xml:lang . The langRule element is intended only as a fall-back mechanism for documents where language is identified with another construct.

<its:rules
  xmlns:its="http://www.w3.org/2005/11/its"  version="2.0">
 <its:langRule selector="//p" langPointer="@mylangattribute"/>
</its:rules>

6.7.2 Implementation

The Language Information data category can be expressed only with global rules. The information applies 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 XPath expression absolute selector which selects the nodes to which this rule applies.

• A required langPointer attribute that contains a relative XPath expression selector pointing to a node that contains language information.

6.7.3 Markup Declarations for Language Information

langRule

[103] [94]	langRule	::=	element its:langRule { langRule.content, langRule.attributes }
[104] [95]	langRule.content	::=	empty
[105] [96]	langRule.attributes	::=	att.selector.attributes , attribute langPointer { string }

6.8.1 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 [XHTML 1.0] :

  <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 [DITA 1.0] :

  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>

6.8.2 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 XPath expression absolute selector which selects the nodes to which this rule applies.

• A required withinText attribute with the value "yes", "no" or "nested". "no" or "nested".

<its:rules
  xmlns:its="http://www.w3.org/2005/11/its"  version="2.0">
 <its:withinTextRule withinText="yes" selector="//b | //em | //i"/>
</its:rules>

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

• A withinText attribute with the values "yes", "no" or "nested".

<text
  xmlns:its="http://www.w3.org/2005/11/its" 
  its:version="2.0">
 <body>
  <par>Text with <bold
     its:withinText="yes">bold</bold>.</par>
 </body>
</text>

<!DOCTYPE html>
<html lang="en">
 <head>
  <meta charset="utf-8"/>

  <meta charset="utf-8"><meta>

  <title>Within text test: Default</title>
 </head>
 <body>
  <p>Text with <span its-within-text="yes">bold</span>.</p>
 </body>
</html>

6.8.3 Markup Declarations for Elements Within Text

withinTextRule

[106] [97]	withinTextRule	::=	element its:withinTextRule { withinTextRule.content, withinTextRule.attributes }
[107] [98]	withinTextRule.content	::=	empty
[108] [99]	withinTextRule.attributes	::=	att.selector.attributes , attribute withinText { "yes" | "no" | "nested" }

att.withinText

[109] [100]	att.withinText.attributes	::=	att.withinText.attribute.withinText
[110] [101]	att.withinText.attribute.withinText	::=	attribute its:withinText { "yes" | "no" | "nested" }?

att.withinText.html5

[111] [102]	att.withinText.html5.attributes	::=	att.withinText.html5.attribute.its-within-text
[112] [103]	att.withinText.html5.attribute.its-within-text	::=	attribute its-within-text { "yes" | "no" | "nested" }?

6.9.1 Definition

The Domain data category is used to identify the domain of content.

This data category addresses various challenges:

• Often domain related information in content does exist, e.g. keywords in the HTML meta element. The Domain data category addresses this by providing a mechanism to point to this information.

• There are many flat or structured lists of domain related values, keywords, key phrases, classification codes, ontologies. The Domain data category does not propose a given list; rather it provides a mapping mechanism to associate values in content with consumer tool specific values needed for processing domain information.

6.9.2 Implementation

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

GLOBAL: The domainRule element contains the following:

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

• A required domainPointer attribute that contains a relative XPath expression 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 is part of the source content and unique within the mapping. 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 (Unicode code point U+0027) or QUOTATION MARK (U+0023).

<its:rules
  xmlns:its="http://www.w3.org/2005/11/its"  version="2.0">
 <its:domainRule selector="/html/body" domainPointer="/html/head/meta[@name='DC.subject']/@content"/>
</its:rules>

<its:rules
  xmlns:its="http://www.w3.org/2005/11/its"  version="2.0">
 <its:domainRule selector="/html/body" domainPointer="/html/head/meta[@name='DC.subject']/@content"
   domainMapping="automotive auto, medical medicine, 'criminal law' law, 'property law' law"/>
</its:rules>

6.9.3 Markup Declarations for Domain

domainRule

[113] [104]	domainRule	::=	element its:domainRule { domainRule.content, domainRule.attributes }
[114] [105]	domainRule.content	::=	empty
[115] [106]	domainRule.attributes	::=	att.selector.attributes , attribute domainPointer { string }, attribute domainMapping { string }?

6.10.1 Definition

The Disambiguation data category is used to communicate the mentions of specific concepts that may require special handling in the localization of the document.

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

• Informing translation systems that this fragment of text may not be literally translated, but subject to specific proper-name translation rules or official translations, as well as a very specific meaning of the phrases.

• Informing content management and translation systems about the type of the underlying entity in order to enable processing based on a specific type of the entity, for example, when handling personal names, product names or geographic names, chemical compounds, protein names and similar.

We introduce the following concepts:

• Entity Type Source: a domain of valid values, an identifier collection for entity types. Unless specified, it will be defined derived by default de-referencing mechanisms for the URI.

• Entity Type: the type of the entity, being one of values within the entity type source identifier collection.

• Disambiguation type: the level of disambiguation (lexical concept, ontology concept, entity). The disambiguation can happen at multiple levels. For instance, the level of lexical concepts disambiguates individual word surface forms, the level of ontology concepts disambiguates into deeper semantics, and the entity disambiguation works on the level of concrete instances. For instance, the word" City " in " I am going to the City " may be disambiguated in one of the WordNet synsets that can be represented by " city ", an updated version RDF ontology concept of a City that could represent a subclass of a PopulatedPlace, or the center area of a particular city, e.g. London City.

• Disambiguation Source: the identifier collection source used for locating the correct underlying identifier. It can be anything that can representing a collection of identifiers for words, concepts or entities, for instance, a knowledge base, an ontology or semantic network. Unless specified, it will be derived by default de-referencing mechanisms for the URI.

• Disambiguation Identifier: an identifier, unique within the current disambiguation identifier collection, specifying the actual identifier (meaning, concept or entity) behind the selected content.

Two types of Disambiguation data categories are needed to identify:

• Entity type, which describes the type of the underlying entity within a particular domain of types, as specified by the type source identifier collection.

• Disambiguation, which describes the actual underlying identifier or meaning that the mention refers to, either in a knowledge base, ontology or in a semantic network.

Text analysis engines, such as named entity recognizers, named entity, concept and word sense disambiguators can offer an easy way to create this document. For details information. Content management tools can present and visualize this information or use it to index their content. Machine translations systems may use it for training and translation when dealing with proper names and edge cases.

6.10.2 Implementation

The Disambiguation data category can be expressed with global rules, or locally on an individual element. The information applies to the textual content of the proposed element. There is no inheritance. The entity type follows inheritance rules.

GLOBAL: The disambiguationRule element contains the following:

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

• An optional entityTypeSourceRef attribute that contains a URI specifying the concrete identifier data category, see source (knowledge base, semantic network), used to determine the entity type.

• An optional entityTypeSourcePointer attribute that contains a relative XPath expression pointing to a node that represents the identifier data source (knowledge base, semantic network), used to determine the entity type.

• An optional entityTypeSourceRefPointer attribute that contains a relative XPath expression pointing to a node that holds the URI that represents the identifier data source (knowledge base, semantic network), used to determine the entity type.

• An optional entityTypeRef attribute that contains a URI, specifying the entity type behind the selector.

• An optional entityTypePointer attribute that contains a relative XPath expression pointing to a node specifying the entity type behind the selector.

• An optional entityTypeRefPointer attribute that contains a relative XPath expression pointing to a node that holds the URI that specifies the entity type behind the selector.

• An optional disambigType attribute that contains a string, specifying the specific semantics of the disambiguation. It can be one of "lexicalConcept", "ontologyConcept", or "entity".

• An optional disambigSourceRef attribute. It contains a URI representing the disambiguation identifier collection source.

• An optional disambigSourcePointer attribute. It contains a relative XPath expression pointing to a node that represents the disambiguation identifier collection source.

• An optional disambigSourceRefPointer attribute. It contains a relative XPath expression pointing to a node that holds the URI that represents the disambiguation identifier collection source.

• An optional disambigIdentRef attribute. It contains a URI that represents a unique identifier within the identifier collection.

• An optional disambigIdentPointer attribute. It contains a relative XPath expression pointing to a node that represents a unique identifier within the identifier collection.

• An optional disambigIdentRefPointer attribute. It contains a relative XPath expression pointing to a node that represents a unique identifier within the identifier collection.

<text
  xmlns:its="http://www.w3.org/2005/11/its" >
 <its:rules version="2.0">
  <its:disambiguationRule
    selector="/text/body/p/*[@id=’dublin’]"
    entityTypeSourceRef="http:/nerd.eurecom.fr/ontology"
    entityTypeRef="http:/nerd.eurecom.fr/ontology#Place"
    disambigType="entity"
    disambigSourceRef="http://dbpedia.org/"
    disambigIdentRef="http://dbpedia.org/resource/Dublin"/>
  <its:disambiguationRule
    selector="/text/body/p/*[@id=’capital’]"
    disambigType="lexicalConcept"
    disambigSourceRef="http://www.w3.org/2006/03/wn/wn20/rdf/wordnet-synset.rdf"
    disambigIdentRef="http://www.w3.org/2006/03/wn/wn20/instances/worsense-capital-noun-3"/>
 </its:rules>
 <body>
  <p>
   <span id="dublin">Dublin</span> is the <span id="capital">capital of Ireland</span>.</p>
 </body>
</text>

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

• An optional entityTypeSourceRef attribute that contains an URI specifying the concrete identifier data source (knowledge base, semantic network), used to determine the entity type.

• An optional entityTypeRef attribute that contains a URI specifying the entity type behind the selector.

• An optional disambigType attribute that contains a string, specifying the specific semantics of the disambiguation. It can be one of "lexicalConcept", "ontologyConcept", or "entity".

• An optional disambigSourceRef attribute. It contains a URI representing the disambiguation identifier collection source.

• An optional disambigIdentRef attribute. It contains a URI that represents a unique identifier within the identifier collection.

<!DOCTYPE html>

<html lang="en">
 <head>
  <meta charset="utf-8"><meta>
  <title>Entity: Local Test</title>
 </head>
 <body>
  <p>
   <span
     its-entity-type-source-ref="http://nerd.eurecom.fr/ontology"
     its-entity-type-ident-ref="http:/nerd.eurecom.fr/ontology#Place"
     its-disambig-source-ref="http://dbpedia.org/"
     its-disambig-ident-ref="http://dbpedia.org/resource/Dublin"
     its-disambig-type="entity">Dublin</span> is the <span its-disambig-source-ref="http://www.w3.org/2006/03/wn/wn20/rdf/wordnet-synset.rdf"
     its-disambig-ident-ref="http://www.w3.org/2006/03/wn/wn20/instances/worsense-capital-noun-3" its-disambig-type="lexicalConcept">capital</span> of Ireland.</p>
 </body>
</html>

<!DOCTYPE html>

<html
  xmlns:its="http://www.w3.org/2005/11/its"  lang="en">
 <head>
  <meta charset="utf-8"><meta>
  <title>Entity: Local Test</title>
 </head>
 <body prefix="its: http://www.w3.org/2005/11/its">
  <p>
   <span resource="http://dbpedia.org/resource/Dublin" typeof="http:/nerd.eurecom.fr/ontology#Place" property="name">Dublin</span> is the capital of Ireland.</p>
 </body>
</html>

<!DOCTYPE html>

<html
  xmlns:its="http://www.w3.org/2005/11/its"  lang="en">
 <head>
  <meta charset="utf-8"><meta>
  <title>Entity: Local Test</title>
 </head>
 <body prefix="its: http://www.w3.org/2005/11/its">
  <p>
   <span resource="http://dbpedia.org/resource/Dublin" typeof="http:/nerd.eurecom.fr/ontology#Place" property="name">Dublin</span> is the capital of Ireland.</p>
 </body>
</html>

6.10.3 Markup Declarations for Disambiguation

disambiguationRule

[107]	disambiguationRule	::=	element its:disambiguationRule { disambiguationRule.content, disambiguationRule.attributes }
[108]	disambiguationRule.content	::=	empty
[109]	disambiguationRule.attributes	::=	att.selector.attributes ,attribute entityTypeSourceRef { xsd:anyURI }?, attribute entityTypeSourcePointer { string }?, attribute entityTypeSourceRefPointer { string }?, attribute entityTypeRef { xsd:anyURI }?, attribute entityTypePointer { string }?, attribute entityTypeRefPointer { string }?, attribute disambigType { "lexicalConcept" | "ontologyConcept" | "entity" }?, attribute disambigSourceRef { xsd:anyURI }?, attribute disambigSourcePointer { string }?, attribute disambigSourceRefPointer { string }?, attribute disambigIdentRef { xsd:anyURI }?, attribute disambigIdentPointer { string }?, attribute disambigIdentRefPointer { string }?

att.disambiguation

[110]	att.disambiguation.attributes	::=	att.disambiguation.attribute.entityTypeSourceRef ,att.disambiguation.attribute.disambigType ,att.disambiguation.attribute.disambigSourceRef ,att.disambiguation.attribute.disambigIdentRef
[111]	att.disambiguation.attribute.entityTypeSourceRef	::=	attribute its:entityTypeSourceRef { xsd:anyURI }?
[112]	att.disambiguation.attribute.disambigType	::=	attribute its:disambigType { "lexicalConcept" | "ontologyConcept" | "entity" }?
[113]	att.disambiguation.attribute.disambigSourceRef	::=	attribute its:disambigSourceRef { xsd:anyURI }?
[114]	att.disambiguation.attribute.disambigIdentRef	::=	attribute its:disambigIdentRef { xsd:anyURI }?

att.disambiguation.html5

[115]	att.disambiguation.html5.attributes	::=	att.disambiguation.html5.attribute.its-entity-type-source-ref ,att.disambiguation.html5.attribute.its-disambig-type ,att.disambiguation.html5.attribute.its-disambig-source-ref ,att.disambiguation.html5.attribute.its-disambig-ident-ref
[116]	att.disambiguation.html5.attribute.its-entity-type-source-ref	::=	attribute its-entity-type-source-ref { xsd:anyURI }?
[117]	att.disambiguation.html5.attribute.its-disambig-type	::=	attribute its-disambig-type { "lexicalConcept" | "ontologyConcept" | "entity" }?
[118]	att.disambiguation.html5.attribute.its-disambig-source-ref	::=	attribute its-disambig-source-ref { xsd:anyURI }?
[119]	att.disambiguation.html5.attribute.its-disambig-ident-ref	::=	attribute its-disambig-ident-ref { xsd:anyURI }?

6.11.1 Definition

The Locale Filter data category specifies that a node is only applicable to certain locales, or that it is not 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 filter type and a list of extended language ranges conforming to [BCP47] . The list of language ranges is a comma-separated list of basic and can include the wildcard extended language ranges. range "*". The list can also be empty. Whitespace surrounding language ranges is ignored.

6.11.2 Implementation

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

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 XPath expression absolute selector which selects the nodes to which this rule applies.

• A required localeFilterType attribute with the value "all", "none", "include", or "exclude". An optional localeFilterList attribute with a comma-separated list of extended language ranges. ranges, or an empty string value.

<book
  xmlns:its="http://www.w3.org/2005/11/its" >

  xmlns:its="http://www.w3.org/2005/11/its" 
  its:version="2.0">

 <info>
  <its:rules version="2.0">
   <its:localeFilterRule selector="//legalnotice[@role='Canada']" localeFilterType="include" localeFilterList="en-CA, fr-CA"/>

   <its:localeFilterRule selector="//legalnotice[@role='Canada']" localeFilterList="en-CA, fr-CA"/>

  </its:rules>
  <legalnotice role="Canada">
   <para>This legal notice is only for Canadian locales.</para>
  </legalnotice>
 </info>
</book>

<section
  xmlns:its="http://www.w3.org/2005/11/its" >
 <info>
  <its:rules version="2.0">
   <its:localeFilterRule selector="//remark" localeFilterType="none"/>

   <its:localeFilterRule selector="//remark" localeFilterList=""/>

  </its:rules>
 </info>
 <remark>Note: This section will be written later.</remark>
</section>

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

• A localeFilterType attribute with the value "all", "none", "include", or "exclude". A localeFilterList attribute with a comma-separated list of extended language ranges. ranges, or an empty string value.

<book
  xmlns:its="http://www.w3.org/2005/11/its" >
 <info>
  <legalnotice
    its:localeFilterType="include"

    its:localeFilterList="en-CA, fr-CA">
   <para>This legal notice is only for Canadian locales.</para>
  </legalnotice>
 </info>
</book>

6.11.3 Markup Declarations for Locale Filter

localeFilterRule

[116] [120]	localeFilterRule	::=	element its:localeFilterRule { localeFilterRule.content, localeFilterRule.attributes }
[117] [121]	localeFilterRule.content	::=	empty
[118] [122]	localeFilterRule.attributes	::=	att.selector.attributes , attribute localeFilterType { "all" | "none" | "include" | "exclude" }, attribute localeFilterList { string }? }

att.localeFilter

[119] [123]	att.localeFilter.attributes	::=	att.localeFilter.attribute.localeFilterType , att.localeFilter.attribute.localeFilterList
[120] att.localeFilter.attribute.localeFilterType ::= attribute its:localeFilterType { "all" | "none" | "include" | "exclude" }? [121] [124]	att.localeFilter.attribute.localeFilterList	::=	attribute its:localeFilterList { string }?

att.localeFilter.html5

[122] [125]	att.localeFilter.html5.attributes	::=	att.localeFilter.html5.attribute.its-locale-filter-type , att.localeFilter.html5.attribute.its-locale-filter-list
[123] att.localeFilter.html5.attribute.its-locale-filter-type ::= attribute its-locale-filter-type { "all" | "none" | "include" | "exclude" }? [124] [126]	att.localeFilter.html5.attribute.its-locale-filter-list	::=	attribute its-locale-filter-list { string }?

6.14.1 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.

6.14.2 Implementation

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

GLOBAL: The externalResourceRefRule element contains the following:

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

• A required externalResourceRefPointer attribute that contains a relative XPath expression selector pointing to a node that provides the URI of the external resource.

<doc
  xmlns:its="http://www.w3.org/2005/11/its"  version="2.0">
 <its:externalResourceRefRule selector="//db:imagedata | //db:audiodata |  db:videodata" externalResourceRefPointer="@fileref"/>

  xmlns:db="http://docbook.org/ns/docbook" 
  xmlns:its="http://www.w3.org/2005/11/its" >
 <its:rules version="2.0">
  <its:externalResourceRefRule selector="//dbk:imagedata | //dbk:audiodata |  //dbk:videodata" externalResourceRefPointer="@fileref"/>
 </its:rules>
 <db:mediaobject>
  <db:videoobject>
   <db:videodata fileref="movie.avi"/>
  </videoobject>
  <db:imageobject>
   <db:imagedata fileref="movie-frame.gif"/>
  </imageobject>
  <db:textobject>
   <db:para>This video illustrates the proper way to assemble an inverting time distortion
       device. </para>
   <db:warning>
    <db:para> It is imperative that the primary and secondary temporal couplings not be
         mounted in the wrong order. Temporal catastrophe is the likely result. The
         future you destroy may be your own. </para>
   </warning>
  </textobject>
 </mediaobject>

</doc>

<its:rules
  xmlns:its="http://www.w3.org/2005/11/its"  version="2.0">
 <its:externalResourceRefRule selector="//html:video/@src" externalResourceRefPointer="."/>
 <its:externalResourceRefRule selector="//html:video/@poster" externalResourceRefPointer="."/>
</its:rules>

<!DOCTYPE
html>
<html lang="en">
 <head>
  <meta charset="utf-8"/>

  <meta charset="utf-8"><meta>

  <title>Video
element
example</title>
 </head>
 <body>
  <video
    width="640"
    height="360"
    src="http://www.example.com/video/v2.mp"
    poster="video-image.png">
   <p>If
your
browser
doesn't
support
the
<code>video</code>
element,
you
can
<a href="http://www.example.com/video/v2.mp">download
the
video</a>
instead.</p>
  </video>
 </body>
</html>

6.14.3 Markup Declarations for External Resource

externalResourceRefRule

[125] [127]	externalResourceRefRule	::=	element its:externalResourceRefRule { externalResourceRefRule.content, externalResourceRefRule.attributes }
[126] [128]	externalResourceRefRule.content	::=	empty
[127] [129]	externalResourceRefRule.attributes	::=	att.selector.attributes , attribute externalResourceRefPointer { string }

6.15.1 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.

6.15.2 Implementation

The Target Pointer data category can be expressed only with global rules. The information applies to the textual content of the element. 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.

<file
  xmlns:its="http://www.w3.org/2005/11/its" >
 <its:rules version="2.0">
  <its:translateRule selector="/file" translate="no"/>
  <its:translateRule selector="//source" translate="yes"/>
  <its:targetPointerRule selector="//source" targerPointer="../target"/>
 </its:rules>
 <entry id="one">
  <source>Remember last folder</source>
  <target/>
 </entry>
 <entry id="two">
  <source>Custom file filter:</source>
  <target/>
 </entry>
</file>

6.15.3 Markup Declarations for Target Pointer

targetPointerRule

[130]	targetPointerRule	::=	element its:targetPointerRule { targetPointerRule.content, targetPointerRule.attributes }
[131]	targetPointerRule.content	::=	empty
[132]	targetPointerRule.attributes	::=	att.selector.attributes ,attribute targetPointer { string }

6.16.1 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 (See the best practice “ Defining markup for unique identifiers ” from [XML i18n BP] ). 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 use 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.

6.16.2 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 should be located. The identifier MUST be unique at least within the document. If the attribute xml:id is present for the selected node, the value of the xml:id attribute MUST take precedence over the idValue value.

<resources
  xmlns:its="http://www.w3.org/2005/11/its" >
 <its:rules version="2.0">
  <its:translateRule translate="no" selector="/resources"/>
  <its:translateRule translate="yes" selector="//text"/>
  <its:idValueRule selector="//text" idValue="../@name"/>
 </its:rules>
 <entry name="btn.OK">
  <text>OK</text>
  <pos>1, 1</pos>
  <trig>sendOK</trig>
 </entry>
 <entry name="btn.CANCEL">
  <text>Cancel</text>
  <pos>2, 1</pos>
  <trig>cancelAll</trig>
 </entry>
</resources>

<doc
  xmlns:its="http://www.w3.org/2005/11/its" >
 <its:rules version="2.0">
  <its:idValueRule selector="//text" idValue="concat(../@name, '_t')"/>
  <its:idValueRule selector="//desc" idValue="concat(../@name, '_d')"/>
 </its:rules>
 <msg name="settingsMissing">
  <text>Can't find settings file.</text>
  <desc>The module cannot find the default settings file.
     You need to re-initialize the system.</desc>
 </msg>
</doc>

<file
  xmlns:its="http://www.w3.org/2005/11/its" >
 <its:rules version="2.0">
  <its:idValueRule selector="//res" idValue="@name"/>
 </its:rules>
 <res name="retryBtn" xml:id="btnAgain">Try Again</res>
 <res name="retryTip">click this to re-run the process with the current settings.</res>
</file>

6.16.3 Markup Declarations for Id Value

idValueRule

[133]	idValueRule	::=	element its:idValueRule { idValueRule.content, idValueRule.attributes }
[134]	idValueRule.content	::=	empty
[135]	idValueRule.attributes	::=	att.selector.attributes ,attribute idValue { string }

6.17.1 Definition

The Preserve Space data category indicates how whitespace should be handled in content. The possible values for the Preserve Space 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".

6.17.2 Implementation

The Preserve Space data category can be expressed with global rules, or locally using the xml:space attribute.

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".

<book
  xmlns:its="http://www.w3.org/2005/11/its" >
 <info>
  <its:rules
    its:version="2.0">
   <its:preserveSpaceRule selector="//verse" space="preserve"/>
  </its:rules>
 </info>
 <verse>
 ’Twas brillig, and the slithy toves
  Did gyre and gimble in the wabe;
 All mimsy were the borogoves,
  And the mome raths outgrabe.
 </verse>
</book>

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

<book
  xmlns:its="http://www.w3.org/2005/11/its" 
  its:version="2.0">
 <verse xml:space="preserve">
 'Twas brillig, and the slithy toves
  Did gyre and gimble in the wabe;
 All mimsy were the borogoves,
  And the mome raths outgrabe.
 </verse>
</book>

6.17.3 Markup Declarations for Preserve Space

preserveSpaceRule

[136]	preserveSpaceRule	::=	element its:preserveSpaceRule { preserveSpaceRule.content, preserveSpaceRule.attributes }
[137]	preserveSpaceRule.content	::=	empty
[138]	preserveSpaceRule.attributes	::=	att.selector.attributes ,attribute space { "default" | "preserve" }

6.18.1 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 four pieces of information:

6.18.2 Implementation

The Localization Quality Issue data category can be expressed with global rules, or locally on individual elements. The information applies 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.

• At least one of the following:

  • Exactly one of the following:

    • A locQualityIssuesRef attribute. Its value is a URI 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 .

  • Exactly one of the following:

    • A locQualityIssueType attribute that implements the type information .

    • A locQualityIssueTypePointer attribute that contains a relative selector pointing to a node with the exact same semantics as locQualityIssueType .

  • Exactly one of the following:

    • A locQualityIssueComment attribute that implements the comment information .

    • A locQualityIssueCommentPointer attribute that contains a relative selector pointing to a node with the exact same semantics as locQualityIssueComment .

• None or exactly one of the following:

  • A locQualityIssueSeverity attribute that implements the severity information .

  • A locQualityIssueSeverityPointer attribute that contains a relative selector pointing to a node with the exact same semantics as locQualityIssueSeverity .

• None or exactly one of the following:

  • A locQualityIssueProfileRef attribute that implements the profile reference information .

  • A locQualityIssueProfileRefPointer attribute that contains a relative selector pointing to a node with the exact same semantics as locQualityIssueProfileRef .

<doc
  xmlns:its="http://www.w3.org/2005/11/its" >
 <header>
  <its:rules version="2.0">
   <its:locQualityIssueRule
     selector="//span[@id='q1']"
     locQualityIssueType="typographical"
     locQualitIssueyComment="Sentence without capitalization"
     locQualityIssueSeverity="50"/>
  </its:rules>
 </header>
 <para>
  <span id="q1">this</span> is an example</para>
</doc>

<doc
  xmlns:its="http://www.w3.org/2005/11/its" >
 <header>
  <its:rules version="2.0">
   <its:locQualityIssueRule
     selector="//issue"
     locQualityIssueTypePointer="./@type"
     locQualityIssueCommentPointer="./@note"
     locQualityIssueSeverityPointer="./@value"
     locQualityIssueProfileRefPointer="./@profile"/>
  </its:rules>
 </header>
 <para>
  <issue
    type="typographical"
    note="Sentence without capitalization"
    value="50"
    profile="http://example.org/qaModel/v13">this</issue> is an example</para>
</doc>

<html lang="en">
 <head>
  <meta charset="utf-8"><meta>
  <title>Example</title>
  <link href="EX-locQualityIssueRule-html5-global.xml" rel="its-rules"><link>
 </head>
 <body>
  <p>
   <span id="q1">this</span> is an example.</p>
 </body>
</html>

<its:rules
xmlns:its="http://www.w3.org/2005/11/its"
 version="2.0">
 <its:locQualityIssueRule
   selector="//span[@id='q1']"
   locQualityIssueType="typographical"
   locQualityIssueComent="Sentence
without
capitalization"
   locQualityIssueSeverity="50"/>
</its:rules>

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 .

• Or (standoff markup):

  • A locQualityIssuesRef attribute. Its value is a URI pointing to the locQualityIssues element containing the list of issues related to this content.

  • An element locQualityIssues (or <span loc-quality-issues> in HTML) which contains:

    • One or more elements locQualityIssue (or <span its-loc-quality-issue> in HTML), 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 .

Important: When the attributes locQualityIssueType ,locQualityIssueComment ,locQualityIssueSeverity and locQualityIssueProfileRef (or their equivalent representations) are used in 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 (or <span loc-quality-issue> in HTML) where they are declared.

<doc
  xmlns:its="http://www.w3.org/2005/11/its" 
  its:version="2.0">
 <para>
  <span
    its:locQualityIssueType="typographical"
    its:locQualityIssueComment="Sentence without capitalization"
    its:locQualityIssueSeverity="50">this</span> is an example</para>
</doc>

<html lang="en">
 <head>
  <title>Telharmonium
1897</title>
  <style type="text/css">
  
[its-loc-quality-issue-type]{
  
background-color:yellow;
  
margin:2px;
  
}
  
[its-loc-quality-issue-severity
=
"100"]{
  
border:
2px
solid
red;
  
}
  
</style>
 </head>
 <body>
  <h1>Telharmonium
(1897)</h1>
  <p>
   <span
     its-loc-quality-issue-profile-ref="http://example.org/qaMovel/v1"
     its-loc-quality-issue-type="inconsistent-entities"
     its-loc-quality-issue-comment="Should
be
Thomas
Cahill."
     its-loc-quality-issue-severity="100"
     data-mytool-qacode="named_entity_not_found">Christian
Bale</span>(1867–1934)
conceived
of
an
instrument
that
could
transmit
its
sound
  
from
a
power
plant
for
hundreds
of
miles
to
listeners
over
telegraph
wiring.
Beginning
in
  
1889
the
sound
quality
of
regular
telephone
concerts
was
very
poor
on
account
of
the
buzzing
  
generated
by
carbon-granule
microphones.
As
a
result
Cahill
decided
to
set
a
new
standard
in
  
perfection
of
sound
<span
     its-loc-quality-issue-profile-ref="grammar"
     its-loc-quality-issue-type="spelling"
     its-loc-quality-issue-severity="50"
     its-loc-quality-issue-comment="should
be
"quality"">qulaity</span>
with
his
instrument,
a
standard
that
would
not
only
satisfy
listeners
but
that
  
would
overcome
all
the
flaws
of
traditional
instruments.</p>
 </body>
</html>

<xliff
  xmlns:its="http://www.w3.org/2005/11/its"  version="1.2"
  its:version="2.0">
 <file original="example.doc" source-language="en" datatype="plaintext">
  <body>
   <trans-unit id="1">
    <source xml:lang="en">This is the content</source>
    <target xml:lang="fr">
     <mrk mtype="x-itslq"
       its:locQualityIssuesRef="#lq1">c'es</mrk>
       le contenu</target>
    <its:locQualityIssues xml:id="lq1">
     <its:locQualityIssue locQualityIssueType="misspelling" locQualityIssueComment="'c'es' is unknown. Could be 'c'est'" locQualityIssueSeverity="50"/>
     <its:locQualityIssue locQualityIssueType="typographical" locQualityIssueComment="Sentence without capitalization" locQualityIssueSeverity="30"/>
    </its:locQualityIssues>
   </trans-unit>
  </body>
 </file>
</xliff>

<doc
  xmlns:its="http://www.w3.org/2005/11/its" 
  its:version="2.0">
 <file>
  <header>
   <its:rules>
    <its:locQualityIssueRule selector="//mrk[@type='x-itslq']" locQualityIssuesRefPointer="@ref"/>
   </its:rules>
  </header>
  <unit id="1">
   <segment>
    <source>This is the content</source>
    <target>
     <mrk type="x-itslq" ref="#lq1">c'es</mrk> le contenu</target>
   </segment>
   <its:locQualityIssues xml:id="lq1">
    <its:locQualityIssue locQualityIssueType="misspelling" locQualityIssueComment="'c'es' is unknown. Could be 'c'est'" locQualityIssueSeverity="50"/>
    <its:locQualityIssue locQualityIssueType="typographical" locQualityIssueComment="Sentence without capitalization" locQualityIssueSeverity="30"/>
   </its:locQualityIssues>
  </unit>
 </file>
</doc>

<html>
 <head>
  <title>Test</title>
  <script type="text/javascript" src="qaissues.js"><script>
  <style type="text/css">.qaissue { background-color: yellow; } </style>
 </head>
 <body onload="addqaissueattrs()">
  <p>
   <span its-loc-quality-issues-ref="#lq1">c'es</span> le contenu</p>
  <span its-loc-quality-issues="its-loc-quality-issues" id="lq1">
   <span
     its-loc-quality-issue="its-loc-quality-issue"
     its-loc-quality-issue-type="typographical"
     its-loc-quality-issue-coment="Sentence without capitalization"
     its-loc-quality-issue-severity="30"><span>
   <span
     its-loc-quality-issue="its-loc-quality-issue"
     its-loc-quality-issue-type="misspelling"
     its-loc-quality-issue-coment="'c'es' is unknown. Could be 'c'est'"
     its-loc-quality-issue-severity="50"><span>
  </span>
 </body>
</html>

6.18.3 Markup Declarations for Localization Quality Issue

locQualityIssueRule

[139]	locQualityIssueRule	::=	element its:locQualityIssueRule { locQualityIssueRule.content, locQualityIssueRule.attributes }
[140]	locQualityIssueRule.content	::=	empty
[141]	locQualityIssueRule.attributes	::=	att.selector.attributes ,attribute locQualityIssuesRef { xsd:anyURI }?, attribute locQualityIssuesRefPointer { string }?, attribute locQualityIssueType { "terminology" | "mistranslation" | "omission" | "untranslated" | "addition" | "duplication" | "inconsistency" | "grammar" | "legal" | "register" | "locale-specific-content" | "locale-violation" | "style" | "characters" | "misspelling" | "typographical" | "formatting" | "inconsistent-entities" | "numbers" | "markup" | "pattern-problem" | "whitespace" | "internationalization" | "length" | "uncategorized" | "other" }?, attribute locQualityIssueTypePointer { string }?, attribute locQualityIssueComment { string }?, attribute locQualityIssueCommentPointer { string }?, attribute locQualityIssueSeverity { string }?, attribute locQualityIssueSeverityPointer { string }?, attribute locQualityIssueProfileRef { xsd:anyURI }?, attribute locQualityIssueProfileRefPointer { string }?

att.locqualityissue

[142]	att.locqualityissue.attributes	::=	att.locqualityissue.attribute.locQualityIssuesRef ,att.locqualityissue.attribute.locQualityIssueType ,att.locqualityissue.attribute.locQualityIssueComment ,att.locqualityissue.attribute.locQualityIssueSeverity ,att.locqualityissue.attribute.locQualityIssueProfileRef
[143]	att.locqualityissue.attribute.locQualityIssuesRef	::=	attribute its:locQualityIssuesRef { xsd:anyURI }?
[144]	att.locqualityissue.attribute.locQualityIssueType	::=	attribute its:locQualityIssueType { "terminology" | "mistranslation" | "omission" | "untranslated" | "addition" | "duplication" | "inconsistency" | "grammar" | "legal" | "register" | "locale-specific-content" | "locale-violation" | "style" | "characters" | "misspelling" | "typographical" | "formatting" | "inconsistent-entities" | "numbers" | "markup" | "pattern-problem" | "whitespace" | "internationalization" | "length" | "uncategorized" | "other" }?
[145]	att.locqualityissue.attribute.locQualityIssueComment	::=	attribute its:locQualityIssueComment { string }?
[146]	att.locqualityissue.attribute.locQualityIssueSeverity	::=	attribute its:locQualityIssueSeverity { string }?
[147]	att.locqualityissue.attribute.locQualityIssueProfileRef	::=	attribute its:locQualityIssueProfileRef { xsd:anyURI }?

locQualityIssues

[148]	locQualityIssues	::=	element its:locQualityIssues { locQualityIssues.content }
[149]	locQualityIssues.content	::=	locQualityIssue +

locQualityIssue

[150]	locQualityIssue	::=	element its:locQualityIssue { locQualityIssue.content, locQualityIssue.attributes }
[151]	locQualityIssue.content	::=	empty
[152]	locQualityIssue.attributes	::=	attribute locQualityIssueType { "terminology" | "mistranslation" | "omission" | "untranslated" | "addition" | "duplication" | "inconsistency" | "grammar" | "legal" | "register" | "locale-specific-content" | "locale-violation" | "style" | "characters" | "misspelling" | "typographical" | "formatting" | "inconsistent-entities" | "numbers" | "markup" | "pattern-problem" | "whitespace" | "internationalization" | "length" | "uncategorized" | "other" }?, attribute locQualityIssueComment { string }?, attribute locQualityIssueSeverity { string }?, attribute locQualityIssueProfileRef { xsd:anyURI }?

att.locqualityissue.html5

[153]	att.locqualityissue.html5.attributes	::=	att.locqualityissue.html5.attribute.its-loc-quality-issues-ref ,att.locqualityissue.html5.attribute.its-loc-quality-issue-type ,att.locqualityissue.html5.attribute.its--loc-quality-issue-comment ,att.locqualityissue.html5.attribute.its-loc-quality-issue-severity ,att.locqualityissue.html5.attribute.its-loc-quality-issue-profile-ref
[154]	att.locqualityissue.html5.attribute.its-loc-quality-issues-ref	::=	attribute its-loc-quality-issues-ref { xsd:anyURI }?
[155]	att.locqualityissue.html5.attribute.its-loc-quality-issue-type	::=	attribute its-loc-quality-issue-type { "terminology" | "mistranslation" | "omission" | "untranslated" | "addition" | "duplication" | "inconsistency" | "grammar" | "legal" | "register" | "locale-specific-content" | "locale-violation" | "style" | "characters" | "misspelling" | "typographical" | "formatting" | "inconsistent-entities" | "numbers" | "markup" | "pattern-problem" | "whitespace" | "internationalization" | "length" | "uncategorized" | "other" }?
[156]	att.locqualityissue.html5.attribute.its--loc-quality-issue-comment	::=	attribute its--loc-quality-issue-comment { string }?
[157]	att.locqualityissue.html5.attribute.its-loc-quality-issue-severity	::=	attribute its-loc-quality-issue-severity { string }?
[158]	att.locqualityissue.html5.attribute.its-loc-quality-issue-profile-ref	::=	attribute its-loc-quality-issue-profile-ref { xsd:anyURI }?

6.19.1 Definition

The Localization Quality Précis data category is used to express an overall measurement of the localization quality of a document.

This data category allows to specify a quality score for a given document, as well as to indicate what constitutes a passing score. It also allows to point to a profile where the quality assessment model used for the scoring is described.

6.19.2 Implementation

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

GLOBAL: The locQualityPrecisRule 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 locQualityPrecisScore attribute. Its value is an integer between 0 and 100 (inclusive) with higher values indicating a better score.

  • A locQualityPrecisScorePointer attribute that contains a relative selector pointing to a node with the exact same semantics as locQualityPrecisScore .

• None or exactly one of the following:

  • A locQualityPrecisThreshold attribute. Its value is an integer between 0 and 100 (inclusive) which indicates the lowest score value that constitutes a passing score in the profile used.

  • A locQualityPrecisThresholdPointer attribute that contains a relative selector pointing to a node with the exact same semantics as locQualityPrecisThreshold .

• None or exactly one of the following:

  • A locQualityPrecisProfileRef attribute. Its value is a URI pointing to the reference document describing the quality assessment model used for the scoring.

  • A locQualityPrecisProfileRefPointer attribute that contains a relative selector pointing to a node with the exact same semantics as locQualityPrecisProfileRef .

<doc
  xmlns:its="http://www.w3.org/2005/11/its" >
 <header>
  <its:rules version="2.0">
   <its:locQualityScoreRule
     selector="/doc"
     locQualityPrecisScore="100"
     locQualityPrecisThreshold="95"
     locQualityPrecisProfileRef="http://example.org/qaModel/v13"/>
  </its:rules>
 </header>
 <para>This is an example</para>
</doc>

<doc
  xmlns:its="http://www.w3.org/2005/11/its" >
 <header qaScore="100" qaPassingScore="95" qaProfile="http://example.org/qaModel/v13">
  <title>Example</title>
  <its:rules version="2.0">
   <its:locQualityScoreRule
     selector="/doc"
     locQualityPrecisScorePointer="header/@qaScore"
     locQualityPrecisThresholdPointer="header/@qaPassingScore"
     locQualityPrecisProfileRefPointer="header/@qaProfile"/>
  </its:rules>
 </header>
 <para>This is an example</para>
</doc>

<html lang="en">
 <head>
  <meta charset="utf-8"><meta>
  <title>Example</title>
  <link href="EX-locQualityPrecisRule-html5-global.xml" rel="its-rules"><link>
 </head>
 <body>
  <p>This is an example.</p>
 </body>
</html>

<its:rules
xmlns:its="http://www.w3.org/2005/11/its"
 version="2.0">
 <its:locQualityPrecisRule
   selector="/html"
   locQualityPrecisScore="100"
   locQualityPrecisThreshold="95"
   locQualityPrecisProfileRef="http://example.org/qaModel/v13"/>
</its:rules>

LOCAL: The following local markup is available for the Localization Quality Précis data category:

• A locQualityPrecisScore attribute. Its value is an integer between 0 and 100 (inclusive) with higher values indicating a better score.

• An optional locQualityPrecisThreshold attribute. Its value is an integer between 0 and 100 (inclusive) which indicates the lowest score value that constitutes a passing score in the profile used.

• An optional locQualityPrecisProfileRef attribute. Its value is a URI pointing to the reference document describing the quality assessment model used for the scoring.

<doc
  xmlns:its="http://www.w3.org/2005/11/its" 
  its:version="2.0"
  its:locQualityPrecisScore="100"
  its:locQualityPrecisThreshold="95"
  its:locQualityPrecisProfileRef="http://example.org/qaModel/v13">
 <title>The Adventures of Tom Sawyer</title>
 <para>He got home pretty late that night, and when he climbed cautiously in at 
  the window, he uncovered an ambuscade, in the person of his aunt; and when she 
  saw the state his clothes were in her resolution to turn his Saturday holiday 
  into captivity at hard labor became adamantine in its firmness.</para>
</doc>

<html
  lang="en"
  its-loc-quality-precis-score="100"
  its-loc-quality-precis-threshold="95"
  its-loc-quality-precis-profile-ref="http://example.org/qaModel/v13">
 <head>
  <title>Rikki-tikki-tavi</title>
 </head>
 <body>
  <p>This is the story of the great war that Rikki-tikki-tavi fought single-handed,
     through the bath-rooms of the big bungalow in Segowlee cantonment. Darzee, the
     Tailorbird, helped him, and Chuchundra, the musk-rat, who never comes out into 
     the middle of the floor, but always creeps round by the wall, gave him advice, 
     but Rikki-tikki did the real fighting.</p>
 </body>
</html>

6.19.3 Markup Declarations for Localization Quality Issue

locQualityPrecisRule

[159]	locQualityPrecisRule	::=	element its:locQualityPrecisRule { locQualityPrecisRule.content, locQualityPrecisRule.attributes }
[160]	locQualityPrecisRule.content	::=	empty
[161]	locQualityPrecisRule.attributes	::=	att.selector.attributes ,attribute locQualityPrecisScore { string }?, attribute locQualityPrecisScorePointer { string }?, attribute locQualityPrecisThreshold { string }?, attribute locQualityPrecisThresholdPointer { string }?, attribute locQualityPrecisProfileRef { xsd:anyURI }?, attribute locQualityPrecisProfileRefPointer { string }?

att.locqualityprecis

[162]	att.locqualityprecis.attributes	::=	att.locqualityprecis.attribute.locQualityPrecisScore ,att.locqualityprecis.attribute.locQualityPrecisThreshold ,att.locqualityprecis.attribute.locQualityPrecisProfileRef
[163]	att.locqualityprecis.attribute.locQualityPrecisScore	::=	attribute its:locQualityPrecisScore { string }?
[164]	att.locqualityprecis.attribute.locQualityPrecisThreshold	::=	attribute its:locQualityPrecisThreshold { string }?
[165]	att.locqualityprecis.attribute.locQualityPrecisProfileRef	::=	attribute its:locQualityPrecisProfileRef { xsd:anyURI }?

att.locqualityprecis.html5

[166]	att.locqualityprecis.html5.attributes	::=	att.locqualityprecis.html5.attribute.its-loc-quality-precis-score ,att.locqualityprecis.html5.attribute.its-loc-quality-precis-threshold ,att.locqualityprecis.html5.attribute.its-loc-quality-precis-profile-ref
[167]	att.locqualityprecis.html5.attribute.its-loc-quality-precis-score	::=	attribute its-loc-quality-precis-score { string }?
[168]	att.locqualityprecis.html5.attribute.its-loc-quality-precis-threshold	::=	attribute its-loc-quality-precis-threshold { string }?
[169]	att.locqualityprecis.html5.attribute.its-loc-quality-precis-profile-ref	::=	attribute its-loc-quality-precis-profile-ref { xsd:anyURI }?