---

1. Introduction

TBX Link is a namespace based XML notation that enables specific identified terms within an XML document to be linked to a specific TBX - (TermBase eXchange (TBX) format) XML document.

The purpose of the TBX Link specification is to provide a rigorous notation for linking embedded terms in an XML document to a their entries in a TBX document or a TBX database repository.

2. Key Concepts

The use of TBX Link is predicated upon the existence of a TBX Document or database repository that contains the TBX term entries that are being linked to. TBX Link allows individual terms to be linked to such a repository.

2.1. TBX Document

The TBX document is the object that contains the terms that are linked to by the 'termid' attributes of individual terms.

2.2. Termbase

The Termbase resolves the actual identifier of the main TBX document or repository that the indivudual terms are linking to. The Termbase will allow a TBX Link compliant application to resolve the actual identifier and location of the TBX dataset.

3. General Structure

TBX Link provides a very simple namespace based XML notation to allow for the linking of terms to a TBX document.

The TBX Link document model hierarchical structure comprises the following elements:

tbx

This is the top level element for TBX Link.

term

The individual term elements.

An example of TBX Link usage:

<?xml version='1.0' encoding='UTF-8'?>
<doc xmlns:tbx="urn:lisa-tbxlink-tags">
    <tbx:tbx termbase="http://purl.org/xml-intl.com/tbx-link:8700" version="1.0" 
    date="2004-12-18T13:06:52Z" tool-name="XYZ Term Finder" tool-version="1.32" language="en_US">
    <p>An example paragraph with an embedded
	<tbx:term termid="a125fg" termbase="http://purl.org/xml-intl.com/tbx.xml">
	    term
	</tbx:term>
       that is linked to a non-default TBX repository.
    </p>
    <p>A second 
        <tbx:term termid="fde12a">
	   example
	</tbx:term>
       that uses the default TBX repository as specified in the "Termbase"
       attribute of the main "tbx:tbx" element.
    </p>
    </tbx:tbx>
</doc>

3.1. The Main TBX Link Element

The <tbx> element is the top level of the TBX Link hierarchy. It signals the start of the TBX Link namespace DOM tree. Its direct children are one or more <term> elements.

3.2. The Term Element

The <term> element is used link the encompassed term to its entry in the TBX repository.

4. Detailed Specifications

4.1. TBX Link Namespace Declaration

The TBX Link document structure is designed to exist as a namespace so that it can be embedded into any document.

The TBX Link namespace declaration will have the following form:

  xmlns:tbx="urn:lisa-tbxlink-tags"
  

All TBX Link elements will normally be prefixed with the TBX Link namespace identifier tbx:.

4.2. Elements

Elements

<tbx>, <term>.

4.2.1. TBX Link

The main TBX Link element has the following format:

<tbx>

TBX Link Element - The <tbx> element.

Required attributes:

termbase - the Termbase identifier for the default TBX Repository that is being linked to.

version - the fixed TBX Link current version id, currently "1.0".

date - the date that the TBX Link namespace was created for this document.

language - the language for the terms being linked to.

tool-name - the tool used to identify the TBX Link terms.

tool-version - the version identifier of the tool used to identify the TBX Link terms.

Optional attributes:

None.

Contents:

Zero or more <term> elements.

4.2.2. Term

The Term element has the following format:

<term>

The TBX Link Term Element.

Required attributes:

termid - The term identifier in the TBX repository.

Optional attributes:

termbase - the Termbase identifier for a non default TBX Repository that is being linked to.

date - the date that the term element was created.

language - the language of the term.

Contents:

The PCDATA contents of the term.

4.3. Attributes

This section lists the attributes used in the TBX Link elements. An attribute is never specified more than once for each element.

TBX Link attributes

date, language, version, termbase, termid, tool-name, tool-version,

4.3.1. TBX Link Attributes

date

Date - The date attribute indicates when a given element was created or modified.

Value description:

Date in [ISO 8601] Format. The recommended pattern to use is: CCYY-MM-DDThh:mm:ssZ 
Where: CCYY is the year (4 digits), MM is the month (2 digits), DD is the day (2 digits), hh is the hours (2 digits), mm is the minutes (2 digits), ss is the second (2 digits), and Z indicates the time is UTC time. For example:

date="2002-01-25T21:06:00Z"
is January 25, 2002 at 9:06pm GMT
is January 25, 2002 at 2:06pm US Mountain Time
is January 26, 2002 at 6:06am Japan time

Default value:

Undefined.

Used in:

<tbx>, <term>

language

language - The language for the main tbx or individual term elements.

Value description:

A language code as described in the [RFC 3066]. For more information see the section on xml:lang in the XML specification, and the erratum E11 (which replaces RFC 1766 by RFC 3066).

Default value:

Undefined.

Used in:

<tbx>, <term>

version

Version - The current TBX Link version number.

Value description:

The version number of this tbx document:

Fixed value:

1.0

Used in:

<tbx>.

termbase

Name - The identifier for the TBX repository. This should be in the form of a URL or some other system identifier that allows for the automatic resolution of the TBX repository.

Value description:

The TBX repository.

Default value:

Undefined

Used in:

<tbx>, <term>.

termid

Name - The identifier for the term in the TBX repository.

Value description:

the term key in the TBX repository.

Default value:

Undefined

Used in:

<term>.

tool-name

Name - The identifier of the tool used to insert the TBX Link elements.

Value description:

the name of the TBX Link tool.

Default value:

Undefined

Used in:

<tbx>.

tool-version

Name - The version identifier of the tool used to insert the TBX Link elements.

Value description:

the version identifier of the TBX Link tool.

Default value:

Undefined

Used in:

<tbx>.

A. TBX Link Tree Structure

The following figure shows the possible structure as a tree. Each element is followed by notation indicating its possible occurrence according to the corresponding legend.

(legend: 1 = one
         + = one or more
         ? = zero or one
         * = zero, one or more)

<tbx>1
|
+--- <term>*

B. TBX Link Document Type Definition and Schema

• The document type definition file for tbx is available at: http://www.xml-intl.com/dtd/TBX-Link.dtd.
• The XML schema for tbx is available at: http://www.xml-intl.com/dtd/TBX-Link.xsd

C. References