- From: CVS User dfilip <cvsmail@w3.org>
- Date: Fri, 21 Jun 2013 16:30:24 +0000
- To: public-multilingualweb-lt-commits@w3.org
Update of /w3ccvs/WWW/International/multilingualweb/lt/drafts/its20
In directory gil:/tmp/cvs-serv8655
Modified Files:
its20.odd
Log Message:
full spec normative/non-normative language check
------------------------------------------------------------
- reformulated keywords used w/o normative intention into non-normative language
- UPPERCASED and decorated couple of normative keywords
--- /w3ccvs/WWW/International/multilingualweb/lt/drafts/its20/its20.odd 2013/06/18 21:29:15 1.470
+++ /w3ccvs/WWW/International/multilingualweb/lt/drafts/its20/its20.odd 2013/06/21 16:30:24 1.471
@@ -166,7 +166,7 @@
important
- that the original material should be suitable for
+ that the original material is suitable for
downstream
@@ -212,8 +212,8 @@
internationalization, translation, and localization. ITS 2.0 in particular contributes
to concepts in the realm of metadata for internationalization, translation, and
localization related to core Web technologies such as XML. ITS does for example assist
- in production scenarios in which parts of an XML-based document should not be
- translated. ITS 2.0 bears many commonalities with its predecessor, <ref
+ in production scenarios, in which parts of an XML-based document are to be excluded
+ from translation. ITS 2.0 bears many commonalities with its predecessor, <ref
target="http://www.w3.org/TR/2007/REC-its-20070403/">ITS 1.0</ref> but provides
additional concepts that are designed to foster enhanced automated processing – e.g.
based on language technology such as entity recognition – related to multilingual Web
@@ -229,24 +229,24 @@
target="#xliff1.2" type="bibref"/> and <ptr target="#xliff2.0" type="bibref"/>), as
well as the Natural Language Processing Interchange Format <ptr target="#nif-reference"
type="bibref"/>.</p>
- <p>For the purpose of an introductory illustration, here is a series of examples related to the question, how ITS can indicate that certain parts of a document must not be translated.</p>
+ <p>For the purpose of an introductory illustration, here is a series of examples related to the question, how ITS can indicate that certain parts of a document are not intended for translation.</p>
<exemplum xml:id="EX-motivation-its-1">
- <head>Document in which some content must not be translated</head>
- <p>In this document it is difficult to distinguish between those <code>string</code> elements that should be translated and those that must not be translated. Explicit metadata is needed to resolve the issue.</p>
+ <head>Document in which some content has to be left untranslated</head>
+ <p>In this document it is difficult to distinguish between those <code>string</code> elements that are intended for translation and those that are not to be translated. Explicit metadata is needed to resolve the issue.</p>
<egXML xmlns="http://www.tei-c.org/ns/Examples"
target="examples/xml/EX-motivation-its-1.xml"/>
</exemplum>
- <p>ITS proposes several mechanisms which differ amongst others in terms of the usage scenario/user types for which the mechanism is most suitable.</p>
+ <p>ITS proposes several mechanisms, which differ amongst others in terms of the usage scenario/user types for which the mechanism is most suitable.</p>
<exemplum xml:id="EX-motivation-its-2">
- <head>Document that uses two different ITS mechanisms to indicate that some parts must not be translated.</head>
+ <head>Document that uses two different ITS mechanisms to indicate that some parts have to be left untranslated.</head>
<p>ITS provides two mechanisms to explicitly associate metadata with one
or more pieces of content (e.g. XML nodes): a <ref target="#basic-concepts-selection-global">global</ref>, rule-based
approach as well as a <ref target="#basic-concepts-selection-local">local</ref>, attribute-based approached. Here, for
instance, a <gi>translateRule</gi> first specifies that only every second element inside
- <code>keyvalue_pairs</code> must be translated; later, an ITS <att>translate</att> attribute specifics that
- one of these elements must not be translated.</p>
+ <code>keyvalue_pairs</code> is intnded for translation; later, an ITS <att>translate</att> attribute specifies that
+ one of these elements is not to be translated.</p>
<egXML xmlns="http://www.tei-c.org/ns/Examples"
target="examples/xml/EX-motivation-its-2.xml"/>
</exemplum>
@@ -343,7 +343,7 @@
<item>Dynamic multilingual: (for example, the area of machine translation systems): This
- part of the content must not be translated.</item>
+ part of the content has to be left untranslated.</item>
</list>
@@ -430,7 +430,7 @@
</div>
<div xml:id="extended-implementation-hints"><head>Extended implementation hints</head>
- <p xml:id="unicode-normalization">As a general guidance, implementations of ITS 2.0 should use a <ref target="http://www.w3.org/TR/2012/WD-charmod-norm-20120501/#sec-NormalizingTranscoder">normalizing transcoder</ref>. It converts from a legacy encoding to a Unicode encoding form and ensures that the result is in Unicode Normalization Form C. Further information on the topic of Unicode normalization is provided in <ptr target="#charmod-norm" type="bibref"/>.</p></div>
+ <p xml:id="unicode-normalization">As a general guidance, implementations of ITS 2.0 <ref target="#rfc-keywords">SHOULD</ref> use a <ref target="http://www.w3.org/TR/2012/WD-charmod-norm-20120501/#sec-NormalizingTranscoder">normalizing transcoder</ref>. It converts from a legacy encoding to a Unicode encoding form and ensures that the result is in Unicode Normalization Form C. Further information on the topic of Unicode normalization is provided in <ptr target="#charmod-norm" type="bibref"/>.</p></div>
</div>
<div xml:id="basic-concepts">
<head>Basic Concepts</head>
@@ -463,7 +463,7 @@
<list type="unordered">
<item><ref target="#trans-datacat">Translate</ref>: expresses information about whether
- a selected piece of content should be translated or not.</item>
+ a selected piece of content is intended for translation or not.</item>
<item><ref target="#locNote-datacat">Localization Note</ref>: communicates notes to
localizers about a particular item of content.</item>
<item><ref target="#terminology">Terminology</ref>: marks terms and optionally
@@ -516,7 +516,7 @@
unique identifier for a given part of the content. </item>
- <item><ref target="#preservespace">Preserve Space</ref>: indicates how whitespace should
+ <item><ref target="#preservespace">Preserve Space</ref>: indicates how whitespace is to
be handled in content.</item>
@@ -571,7 +571,7 @@
<div xml:id="basic-concepts-selection-local">
<head>Local Approach</head>
- <p>The document in <ptr target="#EX-basic-concepts-1" type="exref"/> shows how a content author may use the ITS <att>translate</att> attribute to indicate that all content inside the <code>author</code> element should be protected from translation (i.e. must not be translated). Translation tools that are aware of the meaning of the attribute can protect the relevant content from being translated (possibly still allowing translators to see the protected content as context information).</p>
+ <p>The document in <ptr target="#EX-basic-concepts-1" type="exref"/> shows how a content author can use the ITS <att>translate</att> attribute to indicate that all content inside the <code>author</code> element is not intended for translation (i.e. has to be left untranslated). Translation tools that are aware of the meaning of the attribute can protect the relevant content from being translated (possibly still allowing translators to see the protected content as context information).</p>
<exemplum xml:id="EX-basic-concepts-1">
<head>ITS markup on elements in an XML document (local approach) </head>
@@ -664,7 +664,7 @@
information.</p>
<p>Adding information and pointing to existing information are <emph>mutually
exclusive</emph>; attributes for adding information and attributes for pointing to the
- same information must not appear at the same rule element.</p>
+ same information <ref target="#rfc-keywords">MUST NOT</ref> appear at the same rule element.</p>
</div>
<div xml:id="specific-HTML-support"><head>Specific HTML support</head>
@@ -805,7 +805,7 @@
<item>Conformance clauses in <ptr target="#conformance-product-html5-its" type="specref"/> tell implementers how ITS 2.0 markup is integrated into <ptr type="bibref" target="#html5"/>.</item>
</list>
<p>The conformance clauses in <ptr target="#conformance-product-processing-expectations" type="specref"/> and <ptr type="specref" target="#conformance-product-html-processing-expectations"/> clarify how information needs to be made available for given pieces of markup when processing a dedicated ITS 2.0 data category. To allow for flexibility, an implementation can choose whether it wants to support only ITS 2.0 global or local information, or XML or HTML content. These choices are reflected in separate conformance clauses and also in the <ref target="@@@@">ITS 2.0 test suite</ref>.</p>
- <p>ITS 2.0 processing expectations only define which information needs to be made available. They do not define how that information actually should be used. This is due to the fact that there is a wide variety of usage scenarios for ITS 2.0, and a wide variety of tools for working with ITS 2.0 is possible. Each of these tools may have its own way of using ITS 2.0 data categories (see <ptr type="bibref" target="#mlw-metadata-us-impl"/> for more information).</p>
+ <p>ITS 2.0 processing expectations only define which information needs to be made available. They do not define how that information actually is to be used. This is due to the fact that there is a wide variety of usage scenarios for ITS 2.0, and a wide variety of tools for working with ITS 2.0 is possible. Each of these tools may have its own way of using ITS 2.0 data categories (see <ptr type="bibref" target="#mlw-metadata-us-impl"/> for more information).</p>
<note type="ed">Add link to test suite</note>
</div>
</div>
@@ -861,7 +861,7 @@
<exemplum>
<head>A data category and its implementation</head>
<p>The <ref target="#trans-datacat">Translate</ref> data category conveys information as
- to whether a piece of content should be translated or not.</p>
+ to whether a piece of content is intended for translation or not.</p>
<p>The simplest formalization of this prose description on a schema language-independent
level is a <att type="class">translate</att> attribute with two possible values:
<val>yes</val> and <val>no</val>. An implementation on a schema language-specific
@@ -876,7 +876,7 @@
<head>Selection</head>
<p><termStruct xml:id="termdef-selection" term="Selection"><term>selection</term>
encompasses mechanisms to specify to what parts of an XML or HTML document an ITS data
- category and its values should be applied to.</termStruct> Selection is discussed in
+ category and its values apply.</termStruct> Selection is discussed in
detail in <ptr type="specref" target="#its-processing"/>. Selection can be applied
globally, see <ptr target="#selection-global" type="specref"/>, and locally, see <ptr
target="#selection-local" type="specref"/>. As for global selection, ITS information
@@ -1282,9 +1282,9 @@
<p>By default the content of all elements in a document is translatable. The attribute
<code>its:translate="no"</code> in the <code>head</code> element means that the
- content of this element, including child elements, should not be translated. The
+ content of this element, including child elements, is not intended for translation. The
attribute <code>its:translate="yes"</code> in the <code>title</code> element means
- that the content of this element, should be translated (overriding the
+ that the content of this element, is to be translated (overriding the
<code>its:translate="no"</code> in <code>head</code>). Attribute values of the
selected elements or their children are not affected by local <att type="class"
>translate</att> attributes. By default they are not translatable.</p>
@@ -1323,7 +1323,7 @@
<div>
<head>Absolute selector</head>
<p>The absolute selector <ref target="#rfc-keywords">MUST</ref> be an XPath expression
- that starts with "<code>/</code>". That is, it must be an <ref
+ that starts with "<code>/</code>". That is, it <ref target="#rfc-keywords">MUST</ref> be an <ref
target="http://www.w3.org/TR/xpath/#NT-AbsoluteLocationPath">
AbsoluteLocationPath</ref> or union of <ref
target="http://www.w3.org/TR/xpath/#NT-AbsoluteLocationPath">
@@ -1488,7 +1488,7 @@
<p>One way to associate a document with a set of external ITS rules is to use the optional
XLink <ptr target="#xlink1" type="bibref"/><att>href</att> attribute in the
- <gi>rules</gi> element. The referenced document must be a valid XML document
+ <gi>rules</gi> element. The referenced document <ref target="#rfc-keywords">MUST</ref> be a valid XML document
containing at most one <gi>rules</gi> element. That <gi>rules</gi> element can be the
root element or be located anywhere within the document tree (for example, the document
could be an XML Schema).</p>
@@ -1578,14 +1578,13 @@
<head>Conflicts between selections of ITS information resolved using the precedence
order</head>
- <p>The two elements <code>title</code> and <code>author</code> of this document should
- be treated as separate content when inside a <code>prolog</code> element, but in other
+ <p>The two elements <code>title</code> and <code>author</code> of this document are intended as separate content when inside a <code>prolog</code> element, but in other
contexts as part of the content of their parent element. In order to make this
distinction two <gi>withinTextRule</gi> elements are used:</p>
<p>The first rule specifies that <code>title</code> and <code>author</code> in general
- should be treated as an element within text. This overrides the default.</p>
+ are to be treated as an element within text. This overrides the default.</p>
<p>The second rule indicates that when <code>title</code> or <code>author</code> are
- found in a <code>prolog</code> element their content should be treated separately.
+ found in a <code>prolog</code> element their content is to be treated separately.
This is normally the default, but the rule is needed to override the first rule.</p>
<!-- <p>Due to the rules described above, the local
@@ -1817,14 +1816,14 @@
</list><p><att>annotatorsRef</att> is only meant to be used when actual ITS
annotation is involved, that is for 2) and 3). To express tool information related
only to the creation or modification of textual content and independent of ITS
- data categories, that is case 1), one should use the tool or <att>toolRef</att>
+ data categories, that is case 1), the tool or <att>toolRef</att>
attribute provided by the <ref target="#provenance">Provenance</ref> data
- category.</p></item>
+ category is to be used.</p></item>
<item><p>An example of case 2) is an MT engine that modifies content and creates ITS
<ref target="#mtconfidence">MT Confidence</ref> annotations. Here the situation
may occur that several tools are involved in creating MT Confidence annotations:
the MT engine and the tool inserting the markup. The annotatorsRef attribute
- should identify the tool most useful in further processes, in this case the MT
+ is to identify the tool most useful in further processes, in this case the MT
engine.</p></item>
</list></note>
@@ -1838,7 +1837,7 @@
identifiers specified in the <ref target="#datacategories-overview">data category
overview table</ref>.</p></item>
<item><p>The IRI indicates information about the processor used to generate the data category annotation.
- No single means is specified for how this IRI should be used to indicate processor
+ No single means is specified for how this IRI has to be used to indicate processor
information. Possible mechanisms are: to encode information directly in the IRI,
e.g., as parameters; to reference an external resource that provides such
information, e.g. an XML file or an RDF declaration; or to reference another part of
@@ -1948,7 +1947,7 @@
<note>
<p>The HTML5 parsing algorithm automatically puts all HTML elements into the XHTML
namespace (<code>http://www.w3.org/1999/xhtml</code>). Selectors used in global rules
- must take this into account.</p>
+ <ref target="#rfc-keywords">MUST</ref> take this into account.</p>
</note>
<p xml:id="html5-external-global-rules">Linking to external global rules is specified in
the <att>href</att> attribute of <code>link</code> elements, with the link relation
@@ -2406,7 +2405,7 @@
<div xml:id="translatability-definition">
<head>Definition</head>
<p>The <ref target="#trans-datacat">Translate</ref> data category expresses information
- about whether the content of an element or attribute should be translated or not. The
+ about whether the content of an element or attribute is intended for translation or not. The
values of this data category are <val>yes</val> (translatable) or <val>no</val> (not
translatable).</p>
</div>
@@ -2435,7 +2434,7 @@
<head>The <ref target="#trans-datacat">Translate</ref> data category expressed
globally</head>
<p>The <gi>translateRule</gi> element specifies that the elements <code>code</code>
- must not be translated.</p>
+ is not to be translated.</p>
<egXML xmlns="http://www.tei-c.org/ns/Examples"
target="examples/xml/EX-translate-selector-1.xml"/>
</exemplum>
@@ -2452,12 +2451,12 @@
data category settings of attributes using local markup. This limitation is
consistent with the advised practice of not using translatable attributes. If
attributes need to be translatable, then
- this must be declared globally. Note that this restriciption does not apply to <ref target="#html5-translate-handling">HTML5</ref>.</p></note>
+ this has to be declared globally. Note that this restriciption does not apply to <ref target="#html5-translate-handling">HTML5</ref>.</p></note>
<exemplum xml:id="EX-translate-selector-2">
<head>The <ref target="#trans-datacat">Translate</ref> data category expressed
locally</head>
<p>The local <code>its:translate="no"</code> specifies that the content of
- <code>panelmsg</code> must not be translated.</p>
+ <code>panelmsg</code> is not to be translated.</p>
<egXML xmlns="http://www.tei-c.org/ns/Examples"
target="examples/xml/EX-translate-selector-2.xml"/>
</exemplum>
@@ -2465,7 +2464,7 @@
<head>The <ref target="#trans-datacat">Translate</ref> data category expressed locally
in HTML</head>
<p>The local <code>translate="no"</code> attribute specifies that the content of
- <code>span</code> must not be translated.</p>
+ <code>span</code> is not to be translated.</p>
<egXML xmlns="http://www.tei-c.org/ns/Examples"
target="examples/html5/EX-translate-html5-local-1.html" type="html5"/>
</exemplum>
@@ -2491,7 +2490,7 @@
</list>
<p>Two types of informative notes are needed:</p>
<list type="unordered">
- <item>An alert contains information that the translator must read before translating a
+ <item>An alert contains information that the translator has to read before translating a
piece of text. Example: an instruction to the translator to leave parts of the text
in the source language.</item>
<item>A description provides useful background information that the translator will
@@ -2978,8 +2977,8 @@
<list type="unordered">
<item>Allowing machine translation systems to select the most appropriate engine and
rules to translate the content.</item>
- <item>Providing a general indication of what terminology collection should be used by
- a translator.</item>
+ <item>Providing a general indication of what terminology collection is most suitable for use by
+ translators.</item>
</list>
<p>This data category addresses various challenges:</p>
<list type="unordered">
@@ -3147,10 +3146,10 @@
type="exref"/>.</p>
<p>In the area of machine translation (e.g., machine translation systems or systems
harvesting content for machine translation training), there is no agreed upon set of
- value sets for domain. Nevertheless it is recommended to use a small set of values
+ value sets for domain. Nevertheless, it is recommended to use a small set of values
both in source content and within consumer tools, to foster interoperability. If
larger value sets are needed (e.g., detailed terms in the law or medical domain),
- mappings to the smaller value set needed for interoperability should be provided. An
+ mappings to the smaller value set needed for interoperability is to be provided. An
example would be a <att>domainMapping</att> attribute for generalizing the law
domain: <code>domainMapping="'criminal law' law, 'property law' law, 'contract law'
law"</code>. </p>
@@ -3288,8 +3287,7 @@
once. When support for multiple annotations is necessary (e.g., when all three of
the annotations in the extended example above need to be accommodated) NIF 2.0, <ref
target="http://www.tei-c.org/release/doc/tei-p5-doc/en/html/NH.html#NHSO">TEI
- Stand-off Markup</ref>, or other so-called stand-off annotation mechanisms should
- be considered.</p>
+ Stand-off Markup</ref>, or other so-called stand-off annotation mechanisms is better suitable.</p>
<p>Some external resources such as DBpedia also provide information for some ontological concepts and named entity definitions in multiple languages, and this facilitates translation even more because a possible link traversal would allow a direct access to foreign language labels for named entities.</p>
</note>
</div>
@@ -3775,7 +3773,7 @@
</list>
<note>
<p xml:id="provenanceRecord-order">The order of <gi>provenanceRecord</gi> elements
- within a <gi>provenanceRecords</gi> element should reflect the order with which
+ within a <gi>provenanceRecords</gi> element <ref target="#rfc-keywords">SHOULD</ref> reflect the order with which
they were added to the document, with the most recently added one listed
first.</p>
</note>
@@ -3933,7 +3931,7 @@
target="#selectors">relative selector</ref> that points to the node for the target
content corresponding to the selected source node.</item>
</list>
- <note><p>The source node and the target node may be of different types, but the target node must be able
+ <note><p>The source node and the target node may be of different types, but the target node <ref target="#rfc-keywords">MUST</ref> be able
to contain the same content as the source node (e.g., an attribute node cannot be
the target node of a source node that is an element with children).</p></note>
<exemplum xml:id="EX-target-pointer-global-1">
@@ -4042,7 +4040,7 @@
<div xml:id="preservespace-definition">
<head>Definition</head>
<p>The <ref target="#preservespace">Preserve Space</ref> data category indicates how
- whitespace should be handled in content. The possible values for this data category
+ whitespace is to be handled in content. The possible values for this data category
are "default" and "preserve" and carry the same meaning as the corresponding values of
the <ref target="http://www.w3.org/TR/2008/REC-xml-20081126/#sec-white-space"
>xml:space</ref> attribute. The default value is "default". The Preserve Space data
@@ -4074,7 +4072,7 @@
<head>The <ref target="#preservespace">Preserve Space</ref> data category expressed
globally</head>
<p>The <gi>preserveSpaceRule</gi> element specifies that whitespace in all verse
- elements must be treated literally.</p>
+ elements <ref target="#rfc-keywords">MUST</ref> be treated literally.</p>
<egXML xmlns="http://www.tei-c.org/ns/Examples"
target="examples/xml/EX-preservespace-global-1.xml"/>
</exemplum>
@@ -4086,7 +4084,7 @@
<head>The <ref target="#preservespace">Preserve Space</ref> data category expressed
locally</head>
<p>The standard <code>xml:space</code> attribute specifies that the whitespace in the
- verse element must be treated literally.</p>
+ verse element <ref target="#rfc-keywords">MUST</ref> be treated literally.</p>
<egXML xmlns="http://www.tei-c.org/ns/Examples"
target="examples/xml/EX-preservespace-local-1.xml"/>
</exemplum>
@@ -4118,7 +4116,7 @@
subsequent process examines this markup to ensure that changes were
made.</p></item>
</list>
- <note><p xml:id="selecting-issues">What issues should be considered in quality
+ <note><p xml:id="selecting-issues">What issues are considered in quality
assessment tasks depends on the nature of the project and tools used. For more
information on setting translation project specifications and determining quality
expectations, implementers are encouraged to consult <ptr target="#isots11669"
@@ -4126,7 +4124,7 @@
target="#structuredspecs" type="bibref"/>. While these documents do not directly
address the definition of quality metrics, they provide useful guidance for
implementers interested in determining which localization quality issue values
- should be used for specific scenarios.</p></note>
+ are best for specific scenarios.</p></note>
<p>The data category defines five pieces of information:</p>
<table border="1" xml:id="lqissueDefs" width="100%">
<row role="head">
@@ -4321,7 +4319,7 @@
</item>
</list>
<note><p xml:id="locQualityIssue-order">The order of <gi>locQualityIssue</gi>
- elements within a <gi>locQualityIssues</gi> element should reflect the order
+ elements within a <gi>locQualityIssues</gi> element <ref target="#rfc-keywords">SHOULD</ref> reflect the order
with which they were added to the document, with the most recently added one
listed first.</p></note>
<p>When the attributes <att>locQualityIssueType</att>,
@@ -4654,7 +4652,7 @@
<head>The <ref target="#allowedchars">Allowed Characters</ref> data category expressed
globally in XML</head>
<p>The <gi>allowedCharactersRule</gi> element states that the translated content of
- elements <code>content</code> must not contain the characters <code>*</code> and
+ elements <code>content</code> cannot contain the characters <code>*</code> and
<code>+</code>.</p>
<egXML xmlns="http://www.tei-c.org/ns/Examples"
target="examples/xml/EX-allowedCharacters-global-1.xml"/>
@@ -4679,7 +4677,7 @@
<head>The <ref target="#allowedchars">Allowed Characters</ref> data category expressed
locally in XML</head>
<p>The local <att>allowedCharacters</att> attribute specifies that the translated
- content of element <code>panelmsg</code> must contain only Unicode characters
+ content of element <code>panelmsg</code> <ref target="#rfc-keywords">MUST</ref> contain only Unicode characters
between U+0020 and U+00FE.</p>
<egXML xmlns="http://www.tei-c.org/ns/Examples"
target="examples/xml/EX-allowedCharacters-local-1.xml"/>
@@ -4688,7 +4686,7 @@
<head>The <ref target="#allowedchars">Allowed Characters</ref> data category expressed
locally in HTML</head>
<p>The local <att>its-allowed-characters</att> attribute specifies that the translated
- content of element <code>code</code> must not contain the characters other than 'a'
+ content of element <code>code</code> cannot contain the characters other than 'a'
[183 lines skipped]
Received on Friday, 21 June 2013 16:30:26 UTC