RE: [ESW Wiki] Update of "its0503ReqEntities" by AndrzejZydron

 
Hi Andzej,

Please, remember to try to follow the conventions we talked about for adding comments in the requirements drafts: Whoever is the
owner should make the changes in the normal text, while the commenters should use bold and their initials to add comments. Otherwise
each author will get lost.
(See http://esw.w3.org/topic/itsHowTo for details on the conventions) 

This said, thanks for the addition and examples (I know it would not have been easy to just use comments to add all that).
Christian is going to re-work the document to integrate them. Feel free to comment after if you think we didn't do it right.

Cheers,
-yves



-----Original Message-----
From: public-i18n-its-request@w3.org [mailto:public-i18n-its-request@w3.org] On Behalf Of w3t-archive+esw-wiki@w3.org
Sent: Sunday, April 17, 2005 4:00 AM
To: w3t-archive+esw-wiki@w3.org
Subject: [ESW Wiki] Update of "its0503ReqEntities" by AndrzejZydron

Dear Wiki user,

You have subscribed to a wiki page or wiki category on "ESW Wiki" for change notification.

The following page has been changed by AndrzejZydron:
http://esw.w3.org/topic/its0503ReqEntities

------------------------------------------------------------------------------
  
   3. If entities are used, the XML instances should have standalone="no" in their XML declarations (see
http://www.w3.org/TR/REC-xml/#sec-rmd).
  
+ == Permissable use of user defined entities
+ 
+ Following on from the previous node one can also make the following recommendations:
+ 
+ 1. User defined entities should never be used within #PCDATA - the text content of an element. The reasons for this have been
outlined above.
+ 2. User defined enitities CAN be useful for the creation of boilerplate text. In this, and only this instance they can be very
beneficial.
+ 
+ In this instance the boilerplate text is held by Locale, so that depending on the target language the appropriate text is
selected. Boiler plate text by its very nature is used for headings etc. and is linguistically complete - it stands alone and does
not rely on any surrounding context. The boiler plate entities are only ever used within attributes. The composition process uses
the attribute values to display the appropriate target language text: 
+ 
+ e.g.
+ 
+ In the following example the DTD is fragmented so that multiple language versions can all share the key core components. Only the
bp_pl-pl_xml.ent defines the language specific boilerplate text:
+ 
+ sample-pl.dtd:
+ ------------------------------------------------------------------
+ <!ENTITY % conf PUBLIC "-//XML-INTL//ENTITIES pub Conf//EN" 
+ "sample.elm"> <!ENTITY % bp PUBLIC "-//XML-INTL//ENTITIES boilerplate 
+ XML-INTL//PL-PL" "bp_pl-pl_xml.ent"> <!ENTITY % cals PUBLIC 
+ "-//XML-INTL//ELEMENTS CALS Table XML//EN" "cals-xml.elm">
+ 
+ %conf;
+ %bp;
+ %cals;
+ 
+ ------------------------------------------------------------------
+ 
+ bp_pl-pl_xml.ent:
+ 
+ ------------------------------------------------------------------
+ 
+ <!ENTITY locale 'pl-PL'>
+ <!ENTITY copyright-owner 'XML-INTL Limited, PO Box 2167, Gerrards 
+ Cross, Bucks SL9 8XF, United Kingdom'> <!ENTITY copyright-text 
+ 'Niniejszy tekst jest własnością intelektualną XML-INTL, wszelkie 
+ prawa kopiowania tego tekstu są zastrzerzone'>
+ 
+ ------------------------------------------------------------------
+ 
+ sample.elm:
+ 
+ ------------------------------------------------------------------
+ 
+ <!ELEMENT heading (para+) >
+ <!ATTLIST heading
+         locale         CDATA #FIXED '&locale;'
+         copyright-owner CDATA #FIXED '&copyright-owner;'
+         copyright-text     CDATA #FIXED '&copyright-text;' >
+ 
+ ------------------------------------------------------------------
+ 
+ The key rule regarding the use of user defined entities with regards to i18n is NEVER allow entities within ANY PCDATA context
where they can cause immense problems. You CAN use entities for linguistically complete and stand alone text that is used for
boilerplate text.
+

Received on Monday, 18 April 2005 13:00:26 UTC