W3C home > Mailing lists > Public > public-i18n-its@w3.org > January to March 2005

draft of requirement related to entities

From: Lieske, Christian <christian.lieske@sap.com>
Date: Thu, 24 Mar 2005 15:48:03 +0100
Message-ID: <0F568FE519230641B5F84502E0979DD10280EA29@dewdfe12.wdf.sap.corp>
To: <public-i18n-its@w3.org>


Yves and myself took the action item to come up with a first draft of
requirements related to entities. Please find our initial
thoughts below.

The initial impetus for creating this requirement is

Best regards,
Christian and Yves


User-defined entities must be used only with care. XML applications
which make use of entities have to build in such a way that
entities can be localized easily (ie. the XML application has to be
internationalized wrt. entities).


XML applications (ie. a combination of DTD/XSD, stylesheets, XML
instances) often are subdivided into physical units called entities (see
Various types of entities exist (see

1- A character entity. The entity defines a single Unicode character.

Example: <!ENTITY aacute "&#225;" >

2- A short element-free text. The entity defines a short text that
contains only text (no element or other XML constructs). This is
for instance an entity for a product name.

Example: <!ENTITY ProductName "PictoMagic for Windows" >

3- A longer text with one or more elements. The entity defines a piece
of boiler-plate text such as a copyright paragraph.

Example: <!ENTITY CopyrightInfo "<a href='\copyright.htm'>Copyright</a>
2005 W3C.">

Two aspects of entities are of particular importance wrt.
internationalization and localization:

1.	entities are defined
2.	entities are used

The snippet

	<!ENTITY ProductName "PictoMagic for Windows" >

for example defines an entity called 'ProductName', and the snippet

	The latest version of &ProductName; features many enhancements.

references/uses the entity.

If internationalization and localization are not addressed for
entity-related work several issues may arise:

1.	Entity reference cannot be resolved
Example: the definition is not available to the XML processor

2.	Entity definition does not fit with the surrounding context
Example: The context in 'Das Produkt &ProductName; ist mit vielen
Erweiterungen ausgestattet worden' is German whereas the
definition may be in English

3.	Entity definition does not fit with the surrounding context
Example: The syntax in 'The latest version of &ProductName; features
many enhancements' may be incorrect if the definition
designates an object in plural.


Ideally, the solution which the WG will produce will be applicable not
only wrt. entities but also in the realm of XInclude (see
http://www.w3.org/TR/xinclude/) or even fragments (see 
Received on Thursday, 24 March 2005 14:48:39 UTC

This archive was generated by hypermail 2.3.1 : Tuesday, 6 January 2015 20:43:04 UTC