W3C home > Mailing lists > Public > www-i18n-comments@w3.org > July 2006

More editorial nits wrt ITS

From: Richard Ishida <ishida@w3.org>
Date: Fri, 7 Jul 2006 20:11:32 +0100
To: <www-i18n-comments@w3.org>
Cc: <public-i18n-core@w3.org>
Message-ID: <014c01c6a1f9$294a1f50$6501a8c0@w3cishida>



6.3.2

the information associate to the selection...
the information associated with the selection...


The selection is the textual content of element...
The selection is the textual content of the element...


As for...
This is slowly driving me nuts.  It's not good usage ('as for...' is typically used to mean, 'on the other hand, wrt...'), but apart from that, there appear to be clear divisions marked by this phrase that would be better highlighted by some kind of heading.  It doesn't need to be, eg., 6.4.2.3, but a bolded "Global rules: " at the beginning of the first para related to that would help a lot in scanning, as well as look cleaner.

This would also simplify the following text. Eg.
"As for global rules, identifying terminology information at selected nodes is realized with a termRule element with a mandatory selector attribute."
could be 
"Global rules: Terminology information is identified by a termRule element, which has a mandatory selector attribute."

Also, the following sentence could be cleaner without the "In addition,"


As I try to understand the section on data categories, I keep wishing there was more standardization of the text. For instance, in one place we have "Directionality can be expressed with global rules or locally on an individual element." as the second sentence under implementation; elsewhere "Ruby can be expressed locally in a document or with global rules." as the first sentence; elsewhere "This data category can be expressed only in a set of rules. It cannot be expressed as local markup on an individual element."  And Language Information doesn't have an Implementation section at all.

It would be much easier to compare and contrast, but also pick up information if this was expressed in a standard form, eg. first sentence under "Implementation" is always
"XXX can be expressed with global rules, or locally on an individual element.", or, in the case like the third above "XXX can only be expressed locally on an individual element."

Several other similar standardisations could be applied to the data categories section.


6.5.2
"The dir attribute is used for the implementation of the directionality data category. It has the four values "ltr", "rtl", "lro" or "rlo"."
-> 
"The dir attribute takes the values "ltr", "rtl", "lro" or "rlo"."


6.6
It makes it harder to assimilate the ruby information that the local implementation is described first (unlike any other section).  Also it is not immediately clear that the last para describes one set of global rules, and 6.6.3 another.


6.6.2
"The functionality of pointing to existing ruby markup is realized with various pointer attributes for ruby."
"Various pointer attributes can be used to point to existing ruby markup."  Please list them here.


5.3.1
s/all other possible attributes at rule elements/all other possible attributes on rule elements/

5.3 intro
s/which are attached to the selected element node/which are attached to an element node/
You can argue that the author selected the element node, but it's confusing to say it that way given the importance of selection through attributes in global rules.


5.4
s/Application processing global ITS markup/Applications processing global ITS markup/


Example 19
"<dd>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.</dd>"
->
<dd>ITS defines <term>data category</term> as an abstract concept for a particular 
    type of information related to internationalization and localization of XML schemas
    and documents.</dd>

============
Richard Ishida
Internationalization Lead
W3C (World Wide Web Consortium)

http://www.w3.org/People/Ishida/
http://www.w3.org/International/
http://people.w3.org/rishida/blog/
http://www.flickr.com/photos/ishida/
Received on Friday, 7 July 2006 19:11:40 GMT

This archive was generated by hypermail 2.2.0+W3C-0.50 : Tuesday, 27 October 2009 08:32:36 GMT