XLIFF 1.1 Specification

Committee Specification, 31 Oct 2003

This version:: http://www.oasis-open.org/committees/xliff/documents/cs-xliff-core-1.1-20031031.htm

Latest version:: http://www.oasis-open.org/committees/xliff/documents/xliff-specification.htm

Previous version:: http://www.oasis-open.org/committees/xliff/documents/cs-xliff-core-1.1-20031020.htm

Editors:: Yves Savourel <ysavourel@translate.com>
John Reid <jreid@novell.com>

This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this paragraph are included on all such copies and derivative works. However, this document itself may not be modified in any way, such as by removing the copyright notice or references to OASIS, except as needed for the purpose of developing OASIS specifications, in which case the procedures for copyrights defined in the OASIS Intellectual Property Rights document must be followed, or as required to translate it into languages other than English.

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

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

Abstract

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

Status of this Document

This Committee Specification was approved for publication by the OASIS XLIFF Technical Committee. It is a stable document which represents the consensus of the committee. Comments may be sent to xliff-comment@lists.oasis-open.org.

1. Introduction

2. General Structure

2.1. Header

2.2. Body

2.3. Named Groups

2.4. Inline Elements

2.5. Extensibility

2.5.1. Adding Elements
2.5.2. Adding Attributes
2.5.3. Adding Attribute Values
2.5.4. Validating Documents with Extensions

2.6. Embedding XLIFF

3. Detailed Specifications

3.1. XML Declaration

3.2. Elements

3.2.1. Top-level and Header Elements
3.2.2. Named Group Elements
3.2.3. Structural Elements
3.2.4. Inline Elements
3.2.5. Delimiter Element

3.3. Attributes

3.3.1. XLIFF Attributes
3.3.2. XML Namespace Attributes

Appendices

A. XLIFF Tree Structure
B. Document Type Definition and Schema
C. Changes Since Previous Version (Non-Normative)
D. Naming Guidelines (Non-Normative)
E. XLIFF Technical Committee (Non-Normative)
F. References

1. Introduction

XLIFF is the XML Localization Interchange File Format designed by a group of software providers, localization service providers, and localization tools providers. It is intended to give any software provider a single interchange file format that can be understood by any localization provider. It is loosely based on the OpenTag version 1.2 specification and borrows from the TMX 1.2 specification. However, it is different enough from either one to be its own format.

2. General Structure

XLIFF is an XML application, as such it begins with an XML declaration. After the XML declaration comes the XLIFF document itself, enclosed within the <xliff> element. An XLIFF document is composed of one or more sections, each enclosed within a <file> element. The <file> element consists of a <header> element, which contains metadata about the <file>, and a <body> element, which contains the extracted translatable data from the <file>. The translatable data within <trans-unit> elements is organized into <source> and <target> paired elements. These <trans-unit> elements can be grouped recursively in <group> elements.

In addition, XLIFF provides the ability to maintain information about the processing of the file via the <phase> element. Possible translations for a specific <source> element can be generated from any number of MT (Machine Translation) and CAT (Computer Assisted Translation) systems and stored near the <source> in <alt-trans> elements. Context for a <source> that could be used by a translator or a TM (Translation Memory) system is provided by the <context> element. Binary data can be made available via the <bin-unit>, which may also be translated and contain an associated <trans-unit>.

It is strongly recommended that content within the <file> element be uniformly bilingual. In other words, each <source> and <target> element that is a child of <trans-unit> is of the same language as the source-language and target-language attributes of the <file> element, respectively. The xml:lang attribute should not be used in those elements. The exception is that <source> and <target> elements that are children of <alt-trans> may contain an xml:lang attribute of a different language than that of the source-language and target-language attributes of the <file> element.

<xliff version='1.1'
 xmlns='urn:oasis:names:tc:xliff:document:1.1'>
 <file original='hello.txt' source-language='en' target-language='fr'
  datatype='plaintext'>
  <body>
   <trans-unit id='hi'>
    <source>Hello world</source>
    <target>Bonjour le monde</target>
    <alt-trans>
     <target xml:lang='es'>Hola mundo</target>
    </alt-trans>
   </trans-unit>
  </body>
 </file>
</xliff>

The complete tree structure is available in Appendix A.

2.1. Header

The XLIFF <header> contains metadata about the file and the localization process. It contains the <skl>, <phase-group>, <glossary>, <reference>, <count-group>, <tool>, <prop-group>, and <note> elements. The <skl> element contains either a skeleton file of the file submitted for localization or a hypertext link to that file.

The <phase-group> element contains information about each processing phase used in localizing the file; references to these phases are stored along with the translations. The <glossary> and <reference> elements may contain hypertext links to a glossary and reference file, respectively, or the actual glossary and reference data that can be used in the localization process.

The <count-group> element is a grouping element of count information of the entire file. The <prop-group> element (deprecated) contains tool-specific information used in combining the data with the skeleton file or storing the data in a repository. The <note> element contains instructions for the localization process. The <count-group>, <prop-group>, and <note> elements can also appear in the body of the file.

2.2. Body

The XLIFF <body> contains the structure and the localizable content from the file. It contains the <group>, <trans-unit> and <bin-unit> elements. The structure is described using the <group>, <trans-unit>, <bin-unit> elements. The <group> element is a general purpose structural element used in describing the hierarchy of the file; it can contain other <group> elements as children as well as <trans-unit> and <bin-unit> elements.

The <trans-unit> and <bin-unit> elements contain the translatable portions of the document. The <trans-unit> element contains the text to be translated, the translations, and other related information. The <bin-unit> contains binary data that may or may not need to be translated; it also can contain translated versions of the binary object as well as other related information.

In the <trans-unit> element the text to be translated is contained in a <source> element. This element may contain inline elements that either remove the codes from the source (<g>, <x/>, <bx/>, <ex/>) or that mask off codes left inline (<bpt>, <ept>, <sub>, <it>, <ph>). The translated text is contained in a <target> element that has the same inline codes available to it as does the <source> element. Translation matches generated by a TM or MT or entered by a translator may be provided in an <alt-trans> element, which also contains the <source> and <target> elements.

At every structural level contextual information for the localization process can be provided by the <context-group> named group element, count information by the <count-group> named group element, and tool-specific information by the <prop-group> named group element (deprecated).

2.3. Named Groups

XLIFF allows grouping of certain elements into named groups. A named group is simply a grouping element with a name attribute. These named groups can be interspersed throughout the file with information designed for specific purposes. Using XML processing instructions different actions can be performed with specific named groups. The named group elements are <context-group>, <count-group> and <prop-group> (deprecated).

The <count-group> element contains counts of words, translations, dialogs, or anything else that may need to be counted in the file. A different named group could be stored by the client, translator, reviewer, and localization engineer. Processing instructions could inform a system which of these <count-group> to update during the localization process.

The <prop-group> element contains tool specific data that can be used in creating the translated file, storing the translations, and any other specific task. Processing instructions can indicate to the tools which named <prop-group> to use when updating the repository or combining the localized data with the skeleton file to create a translated file. Note that the <prop-group> has been deprecated in version 1.1.

2.4. Inline Elements

The content of the <source> and the <target> elements can include one or more inline elements (also called "content markup"). Those elements are used to represent codes that reside within the source or target text, for example the formatting codes to mark a section of a sentence in bold.

There are three different types of inline elements:

Elements that have a content, and for which this content is the actual native code of the original data (escaped for XML if necessary). These elements are: <bpt>, <ept>, <it>, and <ph>.
Elements that are empty and act has placeholders for a native code that is either in the Skeleton file or generated automatically. these elements are: <g>, <bx/>, <ex/>, and <x/>.
The <sub> element, which can be inside <bpt>, <ept>, <it>, and <ph> to delimit a translatable run of text within a native inline code, for example the value of an ALT attribute in a <IMG> element in HTML.

The first two types of inline elements can be classified into three main categories depending on their function, and regardless the method they use to hold the native codes:

A) Codes that either begin or end an instruction, and whose beginning and ending functions both appear within a translation unit. For example, an instruction to begin embolden for a range of words which is then followed in the same translation unit by an instruction to end bold formatting. The elements that can handle such cases are: <bpt>, <ept>, <g>, <bx/>, and <ex/>.

B) Codes that either begin or end an instruction, but whose beginning and ending functions are not both contained within a single translation unit. For example, an instruction to embolden text may apply to the first of three sentences in a paragraph contained within a single translation unit, but the instruction to turn off bolding may only appear at the end of the third sentence. Its beginning instruction is present in the first translation unit, while its closing tag is present in the third translation unit. The elements that can handle such cases are: <it> and <x/>.

C) Codes that represent self-contained functions that do not require explicit ending instructions. Images or cross-reference tokens are examples of these standalone codes. The elements that can handle such cases are: <ph> and <x/>.

The guidelines for using the inline elements are as follows:

Use <bpt> or <bx/> for opening each code that has a corresponding closing code in the content. Use <bpt> to mask the code and <bx/> to replace the code. The <bpt> and <bx/> elements should be followed by a matching <ept> or <ex/> element, respectively, within the same translation unit. These paired elements are matched by setting their rid attributes to the same value. For example: <bpt id='2' rid='1'>xx</bpt> ... <ept id='3' rid='1'>xx</ept> and <bx id='4' rid='2'/> ... <ex id='5' rid='2'/>. If the rid attribute is not present (in a 1.0 document for example), the attribute id is used to match both tags. For example: <bpt id='5'>xx</bpt> ... <ept id='5'>xx</ept>.
Use <ept> or <ex/> for closing each code that has a corresponding opening code in the content. Use <ept> to mask the code and <ex/> to replace the code. The <ept> and <ex/> elements should be preceded by a matching <bpt> and <bx/> element, respectively. These paired elements are matched by setting their rid attributes to the same value. For example: <bpt id='2' rid='1'>xx</bpt> ... <ept id='3' rid='1'>xx</ept> and <bx id='4' rid='2'/> ... <ex id='5' rid='2'/>. If the rid attribute is not present (in a 1.0 document for example), the attribute id is used to match both tags. For example: <bpt id='5'>xx</bpt> ... <ept id='5'>xx</ept>.
Use <g> to replace any inline code of the original document that has a beginning and an end and can be moved within its parent structural element.
Use <ph> or <x/> for standalone codes. Use <ph> to mask the code and <x/> to replace the code. Standalone codes are codes that are not opening or closing of a pair, for example empty elements in XML.
Use <it> for opening or closing each code that has no corresponding closing or opening code in the source element. In some cases, because of the segmentation, you may have opening and closing codes that have no corresponding closing or opening codes within the same translation unit. Use <it> to encapsulate those codes. The <it> element has a mandatory pos attribute that should be set to "begin" or "end" depending on whether the isolated code is an opening or a closing code.
Use the xid attribute of the <bx/>, <ex/> and <x/> elements to relate a <trans-unit> or <bin-unit> that contains the content of that replaced code.

As XLIFF inline elements are closely related to TMX inline elements, further examples of usage of these tags may be found in their specification's Content Markup section.

2.5. Extensibility

At times, it may be useful to extend the set of information available in an XLIFF document by inserting constructs defined in various other XML vocabularies. You can add non-XLIFF elements, as well as attributes and attribute values. Adding elements and attributes use the namespace mechanism [XML Names]. Adding attribute values generally involves preceding the value by an "x-" (e.g. <context context-type='x-for-engineers'>).

Although XLIFF offers this extensibility mechanism, in order to avoid a nimiety of information and increase interoperability between tools, it is strongly recommended to use XLIFF capabilities whenever possible, rather than to create non-standard user-defined elements or attributes.

2.5.1. Adding Elements

XLIFF provides several extension points in the following elements: <header>, <group>, <tool>, <trans-unit>, <alt-trans>, and <bin-unit>.

Several non-XLIFF element can be used at each extension point. The content of each element can be any valid XML content (empty content, PCDATA, mixed content, and so forth).

For example, the following XLIFF code shows how to add user-defined elements (in bold) within an XLIFF document:

<xliff version='1.1'
 xmlns='urn:oasis:names:tc:xliff:document:1.1'
 xmlns:sup='http://www.ChaucerState.ac.pg/Frm/XLFSup-v1'>
 <file original='passus-1.doc' source-language='enm' datatype='plaintext'>
  <group>
   <sup:SourceInfo>
    <sup:Book>Piers Plowman, Passus 1</sup:Book>
    <sup:Author>William Langland</sup:Author>
   </sup:SourceInfo>
   <sup:WorkInfo Task='transcription' Context='Middle-English:1360'/>
   <trans-unit id='1'>
    <source xml:lang='enm'>What this mountaigne bymeneth</source>
    <target xml:lang='en'>What this mountain means</target>
    <sup:Reference Type='strophe'>1-a</sup:Reference>
   </trans-unit>
   <trans-unit id='2'>
    <source xml:lang='enm'>and the merke dale</source>
    <target xml:lang='en'>and the dark dale</target>
    <sup:Reference Type='strophe'>1-b</sup:Reference>
   </trans-unit>
   <trans-unit id='3'>
    <source xml:lang='enm'>And the feld ful of folk</source>
    <target xml:lang='en'>And the field full of folk</target>
    <sup:Reference Type='strophe'>2-a</sup:Reference>
   </trans-unit>
   <trans-unit id='4'>
    <source xml:lang='enm'>I shal yow faire shewe.</source>
    <target xml:lang='en'>I fairly will show.</target>
    <sup:Reference Type='strophe'>2-b</sup:Reference>
   </trans-unit>
  </group>
 </file>
</xliff>

The non-XLIFF elements used in the example above would be defined as the following:

<xsd:schema targetNamespace="XLFSup-v1"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:sup="http://www.ChaucerState.ac.pg/Frm/XLFSup-v1"
 elementFormDefault="qualified" attributeFormDefault="unqualified">
 <xsd:element name="SourceInfo">
  <xsd:complexType>
   <xsd:sequence maxOccurs="unbounded">
    <xsd:element name="Book" type="xsd:string"/>
    <xsd:element name="Author" type="xsd:string"/>
   </xsd:sequence>
  </xsd:complexType>
 </xsd:element>
 <xsd:element name="WorkInfo">
  <xsd:complexType>
   <xsd:attribute name="Task" type="xsd:string"/>
   <xsd:attribute name="Context" type="xsd:string"/>
  </xsd:complexType>
 </xsd:element>
 <xsd:element name="Reference">
  <xsd:complexType>
   <xsd:simpleContent>
    <xsd:extension base="xsd:string">
     <xsd:attribute name="Type" type="xsd:string"/>
    </xsd:extension>
   </xsd:simpleContent>
  </xsd:complexType>
 </xsd:element>
</xsd:schema>

It is not possible to add non-XLIFF elements in either the <source> or <target> elements. However, the <mrk> element can be used to markup sections of the text with user-defined values assigned to the mtype attribute. You can also add non-XLIFF attributes to most of the inline elements used in <source> and <target>.

2.5.2. Adding Attributes

Attributes of a namespace different than XLIFF can be included in several XLIFF elements.

The following elements allow non-XLIFF attributes: <file>, <group>, <trans-unit>, <source>, <target>, <tool>, <bin-unit>, <bin-source>, <bin-target>, <alt-trans>, <mrk>, <g>, <x/>, <bx/>, <ex/>, <bpt>, <ept>, <ph>, and <it>.

For instance, the following XLIFF code illustrates how to use attributes from the XHTML vocabulary (in bold) in the <group> and <trans-unit> XLIFF elements. The example shows how to carry formatting information about an extracted table:

<xliff version='1.1'
 xmlns='urn:oasis:names:tc:xliff:document:1.1'
 xmlns:htm='http://www.w3.org/TR/REC-html40'>
 <file original='table.htm' source-language='en' datatype='html'>
  <group restype='table' htm:border='1' htm:cellpadding='5'
   htm:cellspacing='0' htm:width='100%'>
   <group restype='row'>
    <trans-unit id='1' htm:valign='top' htm:width='30%'>
     <source>Text of row 1 column 1</source>
    </trans-unit>
    <trans-unit id='2' htm:valign='top' htm:width='30%'>
     <source>Text of row 1 column 2</source>
    </trans-unit>
   </group>
   <group restype='row'>
    <trans-unit id='3' htm:valign='top' htm:width='30%'>
     <source>Text of row 2 column 1</source>
    </trans-unit>
    <trans-unit id='4' htm:valign='top' htm:width='30%'>
     <source>Text of row 2 column 2</source>
    </trans-unit>
   </group>
  </group>
 </file>
</xliff>

In each of the XLIFF elements allowing non-XLIFF attributes: there is no specific location where to insert the non-XLIFF attributes, and there is no limit to the number of non-XLIFF attributes that can be used.

2.5.3. Adding Attribute Values

Many attributes in XLIFF offer a list of enumerated values. Some applications may find it necessary to add user-defined values to these lists. XLIFF allows for such extension.

The attributes where the list of values can be extended are the following: context-type, count-type, ctype, datatype, mtype, restype, size-unit, state, state-qualifier, unit, priority, and purpose.

User-defined values must start with an "x-" prefix. There is no specified mechanism to validate individual user-defined values. The XLIFF schema will allow any value starting with "x-" in addition to the pre-defined values.

For example, the following excerpt shows how the user-defined value x-for-engineer can be utilized in a document:

...
<group>
 <context-group name='EngineersData'>
  <context context-type='x-for-engineers'>Data...</context>
...

2.5.4. Validating Documents with Extensions

In order to validate an XLIFF document that contains non-XLIFF parts, you can use the schema validation mechanism: In addition to the namespace declarations, add the schemaLocation attribute of the XML Schema-instance namespace to define what schemas to use to validate the document (XLIFF and the non-XLIFF namespaces).

<xliff version='1.1'
 xmlns='urn:oasis:names:tc:xliff:document:1.1'
 xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
 xsi:schemaLocation='
  urn:oasis:names:tc:xliff:document:1.1 xliff-core-1.1.xsd
  http://www.ChaucerState.ac.pg/Frm/XLFSup-v1 XLFSup-v1.xsd'
>
...
</xliff>

See http://www.w3.org/XML/Schema for more information on XML Schema and validation.

2.6. Embedding XLIFF

XML Namespace provides a convenient mechanism to use XLIFF constructs within another XML vocabulary.

If necessary an XLIFF document, or parts of a document can be embedded within another XML document. The only requirement for this is on the side of the XML format that includes the XLIFF data. For the document to be valid, the schema of the given document type must include a definition for external elements.

If the including XML format uses XML Schema, it should include an <any> element in the definition of the element where the XLIFF data can be inserted. For example, the following XSD excerpt illustrates the case of an element type dataBlockType that can contain zero, one or more XLIFF constructs after a mandatory <type> element:

...
<xsd:complexType name="dataBlockType">
 <xsd:sequence>
  <xsd:element name="type" type="string" minOccurs="0"/>
  <xsd:any namespace="##other" processContents="strict" minOccurs="0" maxOccurs="unbounded"/>
 </xsd:sequence>
</xsd:complexType>
...

The ways of inserting different vocabulary in an XML document using XSD are described in section "Any Element, Any Attribute" in the document "XML Schema Part 0: Primer" available here: http://www.w3.org/TR/xmlschema-0/#any.

3. Detailed Specifications

3.1. XML Declaration

The XML declaration is strongly recommended. It indicates the XML version and sets the defaults for the encoding of the file. For example, the following declaration specifies the document is in ISO 8859-1, the Latin-1 encoding.

<?xml version="1.0" encoding="iso-8859-1"?>

As in all XML files, the default encoding for an XLIFF file is assumed to be either UTF-8, which is a superset of the 7-bit ASCII character set, or UTF-16, which is UCS-2 with surrogate pairs for code points above U+FFFF. Thus, for these character sets, the encoding declaration is not necessary. Further, all XML parsers support these encodings. If the encoding is in UTF-16 the first character of the file must be the Unicode Byte-Order-Mark, U+FEFF, which indicates the endianness of the file. Other encodings may be desirable and may be generally supported by XML parsers. These must be declared using the encoding declaration. The values to use for the encoding declaration are defined in the [IANA Charsets] listing.

If necessary, you can also specify a namespace for XLIFF. The namespace identifier for this standard is "urn:oasis:names:tc:xliff:document:1.1".

A minimal XLIFF document with one entry looks something like this:

<?xml version="1.0"?>
<xliff version="1.1">
 <file source-language="EN" datatype="plaintext" original="file.ext">
  <body>
   <trans-unit id="1">
    <source>Hello World!</source>
   </trans-unit>
  </body>
 </file>
</xliff>

If you need to validate the document, use the schema validation mechanism: In addition to the namespace declarations, add the schemaLocation attribute of the XML Schema-instance namespace to define what schema files to use. The same example as above would then look like this:

<?xml version="1.0"?>
<xliff version='1.1'
 xmlns='urn:oasis:names:tc:xliff:document:1.1'
 xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
 xsi:schemaLocation='
  urn:oasis:names:tc:xliff:document:1.1 xliff-core-1.1.xsd'>
 <file source-language="EN" datatype="plaintext" original="file.ext">
  <body>
   <trans-unit id="1">
    <source>Hello World!</source>
   </trans-unit>
  </body>
 </file>
</xliff>

If a document of a previous compatible version of XLIFF is to be validated with the schema of a newer version, the document should use the same mechanism.

For validating documents that include non-XLIFF namespaces see the section Validating Documents with Extensions.

3.2. Elements

XLIFF elements can be divided into five main categories: the top-level and header elements, the named group elements, the structural elements, the inline elements, and the delimiter elements. Attributes are shared among them.

Top Level and Header elements	`<xliff>`, `<file>`, `<header>`, `<skl>`, `<external-file>`, `<internal-file>`, `<glossary>`, `<reference>`, `<phase-group>`, `<phase>`, `<tool>`, `<note>`.
Named Group Elements	`<context-group>`, `<context>`, `<count-group>`, `<count>`, `<prop-group>`, `<prop>`.
Structural elements	`<body>`, `<group>`, `<trans-unit>`, `<source>`, `<target>`, `<bin-unit>`, `<bin-source>`, `<bin-target>`, `<alt-trans>`.
Inline elements	`<g>`, `<x/>`, `<bx/>`, `<ex/>`, `<bpt>`, `<ept>`, `<sub>`, `<it>`, `<ph>`.
Delimiter element	`<mrk>`.

3.2.1. Top-level and Header Elements

The top-level and header elements are the following:

<xliff>

XLIFF document - The <xliff> element encloses all the other elements of the document. The required version attribute specifies the version of XLIFF. The optional xml:lang attribute is used to specify the language of the content of the document.

Required attributes:

version.

Optional attributes:

xml:lang.

Contents:

One or more <file> elements.

<file>

File - The <file> element corresponds to a single extracted original document. The required original attribute specifies the name of the file from which this file content is derived. The required datatype attribute specifies the format of the original file; e.g. "html". The required source-language attribute specifies the language of the <source> content. The optional target-language attribute is used to specify the language of the <target> content. The optional tool-id attribute accepts the id of the <tool> used to generate this XLIFF document. The optional date attribute is used to specify the creation date of this XLIFF file. The optional xml:space attribute is used to specify how white-spaces are to be treated. The optional category attribute is used to specify a general category of the content of the file; e.g. "medical". The optional product-name attribute is used to specify the name of the product which uses this file. The optional product-version and build-num attributes are used to specify the revision of the product from which this file comes. The tool and ts attributes have been deprecated in XLIFF 1.1.

Required attributes:

original, source-language, datatype.

Optional attributes:

tool, tool-id, date, xml:space, ts, category, target-language, product-name, product-version, build-num.

Contents:

Zero or one <header> element, followed by
One <body> element.

File header - The <header> element contains metadata relating to the <file> element.

Required attributes:

None.

Optional attributes:

None.

Contents:

zero or one <skl> element, followed by
zero or one <phase-group> element, followed by
zero, one or more <glossary>, <reference>, <count-group>, <prop-group>, <note>, <tool> elements, in any order, followed by
Zero, one or more non-XLIFF elements.

While for backward compatibility reasons no order is enforced for the elements before the non-XLIFF elements, the recommended order is the one in which they are listed here.

<skl>

Skeleton file - The <skl> element contains the skeleton file or the location of the skeleton file. The skeleton file is a template that can be used in recreating the original file, from the <source> content, or the translated file, from the <target> content.

Required attributes:

None.

Optional attributes:

None

Contents:

Either exactly one <internal-file> or one <external-file> element.

<internal-file>

Internal file - The <internal-file> element contains the actual file being referenced. It is a child of the <skl>, <glossary>, and <reference> elements. The format of the file is specified by the optional form attribute, which accepts mime-type values. The crc attribute accepts a value that can be used to precisely identify and assure the authenticity of the file.

Required attributes:

None.

Optional attributes:

form, crc.

Contents:

An embedded file.

<external-file>

External file - The <external-file> element specifies the location of the actual file being referenced. The required href attribute provides a URI to the file. The crc attribute accepts a value that can be used to precisely identify and assure the authenticity of the file. The uid attribute allows a unique ID to be assigned to the file.

Required attributes:

href.

Optional attributes:

uid, crc.

Contents:

The <external-file> is an empty element, including attributes only.

Glossary - The <glossary> element points to or contains a glossary, which can be used in the localization of the file.

Required attributes:

None.

Optional attributes:

None.

Contents:

The glossary description and either exactly one <internal-file> or one <external-file> element.

Reference - The <reference> element points to or contains reference material, which can aid in the localization of the file.

Required attributes:

None.

Optional attributes:

None.

Contents:

A description of the reference material and either exactly one <internal-file> or one <external-file> element.

<note>

Note - The <note> element is used to add localization-related comments to the XLIFF document. The content of <note> may be instructions from developers about how to handle the <source>, comments from the translator about the translation, or any comment from anyone involved in processing the XLIFF file. The optional xml:lang attribute specifies the language of the note content. The optional from attribute indicates who entered the note. The optional priority attribute allows a priority from 1 (high) to 10 (low) to be assigned to the note. The optional annotates attribute indicates if the note is a general note or, in the case of a <trans-unit>, pertains specifically to the to the <source> or the <target> element.

Required attributes:

None.

Optional attributes:

xml:lang, from, priority, annotates.

Contents:

Text, no standard elements.

<phase-group>

Phase group - The <phase-group> element contains information about the task that has been performed on the file. This phase information is specific to the tools and workflow used in processing the file.

Required attributes:

None.

Optional attributes:

None.

Contents:

One or more <phase> elements.

<phase>

Phase information - The <phase> contains metadata about the tasks performed in a particular process. The optional phase-name attribute uniquely identifies the phase for reference within the file. The required process-name attribute identifies the kind of process the phase corresponds to; e.g. "proofreading". The optional company-name attribute identifies the company performing the task. The optional tool-id attribute references the <tool> used in performing the task. The optional date attribute provides a timestamp indicating when the task was performed. The optional job-id attribute allows an ID to be assigned to the job. The optional contact-name, contact-email, and contact-phone attributes all refer to the person performing the task.

Required attributes:

phase-name, process-name.

Optional attributes:

company-name, tool, tool-id, date, job-id, contact-name, contact-email, contact-phone.

Contents:

Zero, one or more <note> elements.

<tool>

Tool - The <tool> element describes the tool that has been used to execute a given task in the document. The required tool-id attribute uniquely identifies the tool for reference within the file. The required tool-nameattribute specifies the actual tool name. The optional tool-versionattribute provides the version of the tool. The optional tool-company attribute provides the name of the company that produced the tool.

Required attributes:

tool-id, tool-name.

Optional attributes:

tool-version, tool-company.

Contents:

Zero, one or more non-XLIFF elements.

3.2.2. Named Group Elements

The named group elements are the following:

<count-group>

Count group - The <count-group> element holds count elements relating to the level in the tree in which it occurs. Each group for <count> elements must be named, allowing different uses for each group. The required name attribute uniquely identifies the <count-group> within the file.

Required attributes:

name.

Optional attributes:

None.

Contents:

One or more <count> elements.

<count>

Count - The <count> element contains information about counts. For each <count> element the required count-type attribute indicates what kind of count the element represents, and the optional unit attribute indicates the unit of the count (by default: word). A list of values for count-type and unit is provided. The optional phase-name attribute references the <phase> in which the count was produced.

Required attributes:

count-type.

Optional attributes:

phase-name, unit.

Contents:

Number (the count value).

<context-group>

Context group - The <context-group> element holds context elements relating to the level in the tree in which it occurs. Thus context can be set at a <group> level, a <trans-unit> level, or a <alt-trans> level.

Each <context-group> element must be named, allowing different uses for each group. These uses can be controlled through the use of XML processing instructions.

Because the <context-group> element may occur at a very high level, a default context can be established for all <trans-unit> elements within a file. This default can be overridden at many subsequent levels.

The required name attribute uniquely identifies the <context-group> within the file. The optional crc attribute allows a verification of the data. The optional purpose attribute indicates to what use this context information is used; e.g. "match" indicates the context information is for memory lookups.

Required attributes:

name.

Optional attributes:

crc, purpose.

Contents:

One or more <context> elements.

Context - The <context> element describes the context of a <source> within a <trans-unit> or a <alt-trans>. The purpose of this context information is to allow certain pieces of text to have different translations depending on where they came from. The translation of a piece of text may differ if it is a web form or a dialog or an Oracle form or a Lotus form for example. This information is thus required by a translator when working on the file. Likewise, the information may be used by any tool proposing to automatically leverage the text successfully.

The required context-type attribute indicates what the context information is; e.g. "recordtitle" indicates the name of a record in a database. The optional match-mandatory attribute indicates that translations of the <source> elements within the scope of this context must have the same context. The optional crc attribute allows a verification of the data.

Required attributes:

context-type.

Optional attributes:

match-mandatory, crc.

Contents:

Text, no standard elements.

<prop-group>

Property group - The <prop-group> element contains <prop> elements. Each <prop-group> element may be named, allowing different uses for each group. These uses can be controlled through the use of XML processing instructions.

Important: The <prop-group> element is DEPRECATED in version 1.1. Instead, use attributes defined in a namespace different from XLIFF. See the Extensibility section for more information.

Required attributes:

None.

Optional attributes:

name.

Contents:

One or more <prop> elements.

<prop>

Property - The <prop> element allows the tools to specify non-standard information in the XLIFF document. This information can be used by the tools that have produced the file or that translate the file or that do any other amount of processing specific to the producer.

Important: The <prop> element is DEPRECATED in version 1.1. Instead, use attributes defined in a namespace different from XLIFF. See the Extensibility section for more information.

Required attributes:

prop-type.

Optional attributes:

xml:lang.

Contents:

Tool-specific data or text, no standard elements.

3.2.3. Structural Elements

The structural elements specify the frame of a XLIFF document as well as contextual and processing information. The <source> element contains the extracted data and, possibly, inline elements.

<body>

File body - The <body> element contains the content from the file.

Required attributes:

None.

Optional attributes:

None.

Contents:

Zero, one or more <group>, <trans-unit>, <bin-unit> elements, in any order.

<group>

Group - The <group> element specifies a set of elements that should be processed together. For example: all the items of a menu, etc. Note that a <group> element can contain other <group> elements. The <group> element can be used to describe the hierarchy of the file.

The optional id attribute is used to identify the <group> within the file. The optional datatype attribute specifies the data type of the content of the <group>; e.g. "winres" for Windows resources. The optional xml:space attribute is used to specify how white-spaces are to be treated within the <group>. The optional restype, resname, extradata, help-id, menu, menu-option, menu-name, coord, font, css-style, style, exstyle, and extype attributes describe the resources contained within the <group>. The optional translate attribute provides a default value for all <trans-unit> elements contained within the <group>. The optional reformat attribute specifies whether and which attributes can be modified for the <target> elements of the <group>. The optional maxbytes and minbytes attributes specify the required maximum and minimum number of bytes for the translation units within the <group>. The optional size-unit attribute determines the unit for the optional maxheight, minheight, maxwidth, and minwidth attributes, which limit the size of the resource described by the <group>. The optional charclass attribute restricts all translation units in the scope of the <group> to a subset of characters. The optional ts attribute has been deprecated in XLIFF 1.1. Lists of values for the datatype, restype, and size-unit attributes are provided by this specification.

Required attributes:

None.

Optional attributes:

id, datatype, xml:space, ts, restype, resname, extradata, help-id, menu, menu-option, menu-name, coord, font, css-style, style, exstyle, extype, translate, reformat, maxbytes, minbytes, size-unit, maxheight, minheight, maxwidth, minwidth, charclass.

Contents:

Zero, one or more <context-group> elements, followed by
Zero, one or more <count-group> elements, followed by
Zero, one or more <prop-group> elements, followed by
Zero, one or more <note> elements, followed by
Zero, one or more non-XLIFF elements, followed by
One or more <group>, <trans-unit>, <bin-unit> elements, in any order.

All <context-group>, <count-group>, <prop-group>, <note> and non-XLIFF elements pertain to the subsequent elements in the tree but can be overridden within a child element.

<trans-unit>

Translation unit - The <trans-unit> elements contains a <source>, <target> and associated elements.

The required id attribute is used to identify the <trans-unit> within the file. The optional approved attribute indicates whether the translation has been approved by a reviewer. The optional translate attribute indicates whether the <trans-unit> is to be translated. The optional reformat attribute specifies whether and which attributes can be modified for the <target> element of the <trans-unit>. The optional xml:space attribute is used to specify how white-spaces are to be treated within the <trans-unit>. The optional datatype attribute specifies the data type of the content of the <trans-unit>; e.g. "winres" for Windows resources. The optional ts attribute has been deprecated in XLIFF 1.1. The optional phase-name attribute references the phase that the <trans-unit> is in. The optional restype, resname, extradata, help-id, menu, menu-option, menu-name, coord, font, css-style, style, exstyle, and extype attributes describe the resource contained within the <trans-unit>. The optional maxbytes and minbytes attributes specify the required maximum and minimum number of bytes for the text inside the <source> and <target> elements of the <trans-unit>. The optional size-unit attribute determines the unit for the optional maxheight, minheight, maxwidth, and minwidth attributes, which limit the size of the resource described by the <trans-unit>. The optional charclass attribute restricts all <source> and <target> text in the scope of the <trans-unit> to a subset of characters. Lists of values for the datatype, restype, and size-unit attributes are provided by this specification.

Required attributes:

id.

Optional attributes:

approved, translate, reformat, xml:space, datatype, ts, phase-name, restype, resname, extradata, help-id, menu, menu-option, menu-name, coord, font, css-style, style, exstyle, extype, maxbytes, minbytes, size-unit, maxheight, minheight, maxwidth, minwidth, charclass.

Contents:

One <source> element, followed by
Zero or one <target> element, followed by
Zero, one or more <context-group>, <count-group>, <prop-group>, <note>, <alt-trans> elements, in any order, followed by
Zero, one or more non-XLIFF elements.

All child elements of <trans-unit> pertain to their sibling <source> element.
While for backward compatibility reasons no order is enforced for the elements before the non-XLIFF elements, the recommended order is the one in which they are listed here.

Source text - The <source> element is used to delimit a unit of text that could be a paragraph, a title, a menu item, a caption, etc. The content of the <source> is generally the translatable text, depending upon the translate attribute of the parent <trans-unit>. The optional xml:lang attribute is used to specify the content language of the <source>; this should always match source-language as a child of <trans-unit> but can vary as a child of <alt-trans>. The optional ts attribute has been deprecated in XLIFF 1.1.

Required attributes:

None.

Optional attributes:

xml:lang, ts.

Contents:

Text,
Zero, one or more of the following elements: <g>, <x/>, <bx/>, <ex/>, <bpt>, <ept>, <ph>, <it>, <mrk>, in any order.

Target - The <target> element contains the translation of the content of the sibling <source> element. The optional state and state-qualifier attributes indicate in which state the <target> is. The optional phase-name attribute references the <phase> in which the <target> was last modified. The optional xml:lang attribute is used to specify the content language of the <target>; this should always match target-language as a child of <trans-unit> but can vary as a child of <alt-trans>. The optional coord, font, css-style, style, and exstyle attributes describe the resource contained within the <target>; these are the modifiable attributes for the <trans-unit> depending upon the reformat attribute of the parent <trans-unit>. The optional ts attribute has been deprecated in XLIFF 1.1. A list of preferred values for the restype, state, and state-qualifier attributes are provided by this specification.

Required attributes:

None.

Optional attributes:

state, phase-name, xml:lang, ts, restype, resname, coord, font, css-style, style, exstyle.

Contents:

Text,
Zero, one or more of the following elements: <g>, <x/>, <bx/>, <ex/>, <bpt>, <ept>, <ph>, <it>, <mrk>, in any order.

<alt-trans>

Translation match - The <alt-trans> element contains possible translations in <target> elements along with optional context, notes, etc. The optional match-quality attribute provides a value indicating the exactness of the match between the <source> of the <alt-trans> and that of the <source> element of the parent <trans-unit>; e.g. "90%". The optional tool-id attribute accepts the id of the <tool> used to generate this <alt-trans>. The optional crc attribute allows a verification of the data. The optional xml:lang attribute is used to specify the content language of the <alt-trans>. The optional xml:space attribute is used to specify how white-spaces are to be treated within the <alt-trans>. The optional datatype attribute specifies the data type of the content of the <alt-trans>; e.g. "winres" for Windows resources. The optional restype, resname, extradata, help-id, menu, menu-option, menu-name, coord, font, css-style, style, exstyle, and extype attributes describe the resource contained within the <alt-trans>. The optional origin attribute specifies where the alternate translation comes from; e.g. a previous version of the product. The tool and ts attributes have been deprecated in XLIFF 1.1. Lists of values for the datatype and restype attributes are provided by this specification.

Required attributes:

None.

Optional attributes:

match-quality, tool, tool-id, crc, xml:lang, datatype, xml:space, ts, restype, resname, extradata, help-id, menu, menu-option, menu-name, coord, font, css-style, style, exstyle, extype, origin.

Contents:

Zero or one <source> element, followed by
One or more <target> elements, followed by
Zero, one or more <context-group>, <prop-group>, <note> elements, in any order, followed by
Zero, one or more non-XLIFF elements.

All child elements of <alt-trans> pertain to their sibling <target> element.
While for backward compatibility reasons no order is enforced for the elements before the non-XLIFF elements, the recommended order is the one in which they are listed here.

<bin-unit>

Binary unit - The <bin-unit> element contains a binary object that may or may not be translatable. The required id attribute is used to identify the <bin-unit> within the file. The required mime-type attribute specifies the data type of the binary object based on RFC 1341. The optional approved attribute indicates whether the translation has been approved by a reviewer. The optional translate attribute indicates whether the <bin-unit> is to be translated. The optional reformat attribute specifies whether and which attributes can be modified for the <bin-target> element of the <bin-unit>. The optional ts attribute has been deprecated in XLIFF 1.1. The optional phase-name attribute references the phase that the <bin-unit> is in. The optional restype and resname attributes describe the resource contained within the <bin-unit>. Lists of values for the restype attribute is provided by this specification.

Required attributes:

id, mime-type.

Optional attributes:

approved, translate, reformat, ts, phase-name, restype, resname.

Contents:

One<bin-source> element, followed by
Zero or one <bin-target> element, followed by
Zero, one or more <context-group>, <count-group>, <prop-group>, <note>, <trans-unit> elements, in any order, followed by
Zero, one or more non-XLIFF elements.

All child elements of <bin-unit> pertain to their sibling <bin-source> element.
While for backward compatibility reasons no order is enforced for the elements before the non-XLIFF elements, the recommended order is the one in which they are listed here.

<bin-source>

Binary source -The <bin-source> element is the container for the binary source data. The optional ts attribute has been deprecated in XLIFF 1.1.

Required attributes:

None.

Optional attributes:

ts.

Contents:

One of <internal-file> or <external-file>.

<bin-target>

Binary target -The <bin-target> element is the container for the translated version of the binary data. The optional mime-type attribute specifies the data type of the binary object based on RFC 1341. The optional ts attribute has been deprecated in XLIFF 1.1. The optional state and state-qualifier attributes indicate in which state the <bin-target> is. The optional phase-name attribute references the phase that the <bin-target> is in. The optional restype and resname attributes describe the resource contained within the <bin-target>. A list of values for the restype, state, and state-qualifier attributes are provided by this specification.

Required attributes:

None.

Optional attributes:

mime-type, ts, state, phase-name, restype, resname.

Contents:

One of <internal-file> or <external-file>.

3.2.4. Inline Elements

The inline elements are the elements that can appear inside the <source> and <target> elements. They enclose or replace any formatting or control codes that is not text, but resides within the text unit.

<g>

Generic group placeholder - The <g> element is used to replace any inline code of the original document that has a beginning and an end, does not overlap other paired inline codes, and can be moved within its parent structural element. The required id attribute is used to reference the replaced code in the skeleton file. The optional ctype attribute allows you to specify what kind of attribute the placeholder represents; e.g. "bold". The optional ts attribute has been deprecated in XLIFF 1.1. The optional clone attribute indicates whether this <g> element may be duplicated. The optional xid attribute references a <trans-unit> or <bin-unit>, through its id attribute value, which can contain any translatable text from the replaced code. A list of values for the ctype attribute is available. A <g> element can contain another <g> element.

Required attributes:

id.

Optional attributes:

ctype, ts, clone, xid.

Contents:

Text,
Zero, one or more of the following elements: <g>, <x/>, <bx/>, <ex/>, <bpt>, <ept>, <ph>, <it>, <mrk>, in any order.

<x/>

Generic placeholder - The <x/> element is used to replace any code of the original document. The required id attribute is used to reference the replaced code in the skeleton file. The optional ctype attribute allows you to specify what kind of attribute the placeholder represents; e.g. "bold". The optional ts attribute has been deprecated in XLIFF 1.1. The optional clone attribute indicates whether this <x/> element may be duplicated. The optional xid attribute references a <trans-unit> or <bin-unit>, through its id attribute value, which can contain any translatable text from the replaced code. A list of values for the ctype attribute is provided by this specification.

Required attributes:

id.

Optional attributes:

ctype, ts, clone, xid.

Contents:

Empty.

<bx/>

Begin paired placeholder - The <bx/> element is used to replace a beginning paired code of the original document. It should be used for paired codes that do not follow XML well-formedness rules (i.e. no overlapping elements). If the paired codes follow that rule, it is strongly recommended that the <g> element is used because it simplifies processing. The <bx/> element should be followed by a matching <ex/> element. These paired elements are related via their rid attributes. If the rid attribute is not present (in a 1.0 document for example), the attribute id is used to match both tags. The required id attribute is used to reference the replaced code in the skeleton file. The optional ctype attribute allows you to specify what kind of attribute the placeholder represents; e.g. "bold". The optional ts attribute has been deprecated in XLIFF 1.1. The optional clone attribute indicates whether this <bx/> element may be duplicated. The optional xid attribute references a <trans-unit> or <bin-unit>, through its id attribute value, which can contain any translatable text from the replaced code. A list of values for the ctype attribute is provided by this specification.

Required attributes:

id.

Optional attributes:

rid, ctype, ts, clone, xid.

Contents:

Empty.

<ex/>

End paired placeholder - The <ex/> element is used to replace an ending paired code of the original document. It should be used for paired codes that do not follow XML well-formedness rules (i.e. no overlapping elements). If the paired codes follow that rule, it is strongly recommended that the <g> element is used because it simplifies processing. The <ex/> element should be preceded by a matching <bx/> element. These paired elements are related via their rid attributes. If the rid attribute is not present (in a 1.0 document for example), the attribute id is used to match both tags. The required id attribute is used to reference the replaced code in the skeleton file. The optional ts attribute has been deprecated in XLIFF 1.1. The optional xid attribute references a <trans-unit> or <bin-unit>, through its id attribute value, which can contain any translatable text from the replaced code.

Required attributes:

id.

Optional attributes:

rid, ts, xid.

Contents:

Empty.

<ph>

Placeholder - The <ph> element is used to delimit a sequence of native stand-alone codes in the translation unit. The required id attribute is used to identify the <ph> inline code. The optional ctype attribute allows you to specify what kind of attribute the placeholder represents; e.g. "bold". The optional ts attribute has been deprecated in XLIFF 1.1. The optional crc attribute allows a verification of the data. The optional assoc attribute specifies whether this placeholder code is associated with the text prior or after. The optional xid attribute references a <trans-unit> or <bin-unit>, through its id attribute value, which can contain any translatable text from the replaced code. A list of values for the ctype attribute is provided by this specification.

Required attributes:

id.

Optional attributes:

ctype, ts, crc, assoc, xid.

Contents:

Code data,
Zero, one or more <sub> elements.

<bpt>

Begin paired tag - The <bpt> element is used to delimit the beginning of a paired sequence of native codes. Each <bpt> has a corresponding <ept> element within the translation unit. These paired elements are related via their rid attributes. If the rid attribute is not present (in a 1.0 document for example), the attribute id is used to match both tags. The required id attribute is used to identify the <bpt> inline code. The optional ctype attribute allows you to specify what kind of attribute the code represents; e.g. "bold". The optional ts attribute has been deprecated in XLIFF 1.1. The optional crc attribute allows a verification of the data. The optional xid attribute references a <trans-unit> or <bin-unit>, through its id attribute value, which can contain any translatable text from the inline code. A list of values for the ctype attribute is provided by this specification.

Required attributes:

id.

Optional attributes:

rid, ctype, ts, crc, xid.

Contents:

Code data,
Zero, one or more <sub> elements.

<ept>

End paired tag - The <ept> element is used to delimit the end of a paired sequence of native codes. Each <ept> has a corresponding <bpt> element within the translation unit. These paired elements are related via their rid attributes. If the rid attribute is not present (in a 1.0 document for example), the attribute id is used to match both tags. The required id attribute is used to identify the <ept> inline code. The optional ts attribute has been deprecated in XLIFF 1.1. The optional crc attribute allows a verification of the data. The optional xid attribute references a <trans-unit> or <bin-unit>, through its id attribute value, which can contain any translatable text from the inline code.

Required attributes:

id.

Optional attributes:

rid, ts, crc, xid.

Contents:

Code data,
Zero, one or more <sub> elements.

<it>

Isolated tag - The <it> element is used to delimit a beginning/ending sequence of native codes that does not have its corresponding ending/beginning within the translation unit. The required id attribute is used to identify the <it> inline code. The required pos attribute specifies whether this is the begin or end code. The optional ctype attribute allows you to specify what kind of attribute the code represents; e.g. "bold". The optional ts attribute has been deprecated in XLIFF 1.1. The optional crc attribute allows a verification of the data. The optional xid attribute references a <trans-unit> or <bin-unit>, through its id attribute value, which can contain any translatable text from the inline code. A list of values for the ctype attribute is provided by this specification.

Required attributes:

id, pos.

Optional attributes:

rid, ctype, ts, crc, xid.

Contents:

Code data,
Zero, one or more <sub> elements.

<sub>

Sub-flow - The <sub> element is used to delimit sub-flow text inside a sequence of native code, for example: the definition of a footnote or the text of a title attribute in a HTML <a> element. The optional datatype attribute specifies the data type of the content of the <sub>; e.g. "html". The optional ctype attribute allows you to specify what kind of attribute the code represents. The optional xid attribute references a <trans-unit> or <bin-unit>, through its id attribute value, which can contain any translatable text from the inline code. Lists of values for the ctype and datatype attributes are provided by this specification.

Required attributes:

None.

Optional attributes:

datatype, ctype, xid.

Contents:

Text,
Zero, one or more of the following elements: <g>, <x/>, <bx/>, <ex/>, <bpt>, <ept>, <ph>, <it>, <mrk>, in any order.

3.2.5. Delimiter Element

XLIFF defines an additional element to support various types of text processing. This element is usually not generated by the extraction module and are ignored most of the time during merging, but it can be very powerful with tools such as Machine Translation, glossary handling, quality assurance, etc.

<mrk>

Marker - The <mrk> element delimits a section of text that has special meaning, such as a terminological unit, a proper name, an item that should not be modified, etc. It can be used for various processing tasks. For example, to indicate to a Machine Translation tool proper names that should not be translated; for terminology verification, to mark suspect expressions after a grammar checking. The <mrk> element is usually not generated by the extraction tool and it is not part of the tags used to merge the XLIFF file back into its original format. The required mtype attribute specifies what is being delimited; e.g. "abbrev" for an abbreviation. The optional ts attribute has been deprecated in XLIFF 1.1. The optional comment attribute allow a free-form comment to be entered. A list of values for the mtype attribute is provided by this specification.

Required attributes:

mtype.

Optional attributes:

mid, ts, comment.

Contents:

Text,
Zero, one or more of the following elements: <g>, <x/>, <bx/>, <ex/>, <bpt>, <ept>, <ph>, <it>, <mrk>, in any order.

3.3. Attributes

This section lists the various attributes used in the XLIFF elements. An attribute is never specified more than once for each element. Along with some of the attributes are the list of their possible values.

XLIFF attributes annotates, approved, assoc, build-num, ctype, category, charclass, comment, company-name, contact-email, contact-name, contact-phone, context-type, coord, count-type, crc, css-style, datatype, date, exstyle, extradata, extype, font, form, from, help-id, href, id, job-id, match-mandatory, match-quality, maxheight, maxbytes, maxwidth, menu, menu-name, menu-option, mid, mime-type, minheight, minbytes, minwidth, mtype, name, original, phase-name, pos, priority, process-name, product-name, product-version, prop-type, purpose, reformat, resname, restype, rid, size-unit, source-language, state, state-qualifier, style, tool, tool-company, tool-id, tool-name, tool-version, target-language, translate, ts, uid, unit, version, xid.

XML namespace attributes xml:lang, xml:space.

3.3.1. XLIFF Attributes

annotates

Annotates - Indicates if a <note> element pertains to the <source> or the <target>, or neither in particular.

Value description:

source, target, or general.

Default value:

general.

Used in:

<note>.

approved

Approved - Indicates whether a translation is final or has passed its final review.

Value description:

Boolean: yes or no.

Default value:

no.

Used in:

<trans-unit>,<bin-unit>.

assoc

Association - Indicates the association of a <ph> with the text prior or after the inline element.

Value description:

preceding (the element is associated with the text preceding the element), following (the element is associated with the text following the element), and both (the element is associated with the text on both sides).

Default value:

Undefined.

Used in:

<ph>.

build-num

Build number - The build number of the version of the product or application the localizable material is for. For example: build-num="12" for the 12th build of the new version of a product.

Value description:

Alpha-numeric.

Default value:

Undefined.

Used in:

<file>.

Value	Description
`database`	Indicates a database content.
`element`	Indicates the content of an element within an XML document.
`elementtitle`	Indicates the name of an element within an XML document.
`linenumber`	Indicates the line number from the sourcefile (see context-type="sourcefile") where the <source> is found.
`numparams`	Indicates a the number of parameters contained within the <source>.
`paramnotes`	Indicates notes pertaining to the parameters in the <source>.
`record`	Indicates the content of a record within a database.
`recordtitle`	Indicates the name of a record within a database.
`sourcefile`	Indicates the original source file in the case that multiple files are merged to form the original file from which the XLIFF file is created. This differs from the original <file> attribute in that this sourcefile is one of many that make up that file.

Value	Description
`num-usages`	Indicates the count units are items that are used X times in a certain context; example: this is a reusable text unit which is used 42 times in other texts.
`repetition`	Indicates the count units are translation units existing already in the same document.
`total`	Indicates a total count.

XLIFF 1.1 Specification

Committee Specification, 31 Oct 2003

Abstract

Status of this Document

Table of Contents

1. Introduction

2. General Structure

2.1. Header

2.2. Body

2.3. Named Groups

2.4. Inline Elements

2.5. Extensibility

2.5.1. Adding Elements

2.5.2. Adding Attributes

2.5.3. Adding Attribute Values

2.5.4. Validating Documents with Extensions

2.6. Embedding XLIFF

3. Detailed Specifications

3.1. XML Declaration

3.2. Elements

3.2.1. Top-level and Header Elements

3.2.2. Named Group Elements

3.2.3. Structural Elements

3.2.4. Inline Elements

3.2.5. Delimiter Element

3.3. Attributes

3.3.1. XLIFF Attributes