- From: Yves Savourel via cvs-syncmail <cvsmail@w3.org>
- Date: Wed, 22 Aug 2012 11:45:24 +0000
- To: public-multilingualweb-lt-commits@w3.org
Update of /w3ccvs/WWW/International/multilingualweb/lt/drafts/its20
In directory hutz:/tmp/cvs-serv19827
Modified Files:
its20.html its20.odd
Log Message:
Continued implementing loc quality.
Index: its20.odd
===================================================================
RCS file: /w3ccvs/WWW/International/multilingualweb/lt/drafts/its20/its20.odd,v
retrieving revision 1.123
retrieving revision 1.124
diff -u -d -r1.123 -r1.124
--- its20.odd 22 Aug 2012 11:00:09 -0000 1.123
+++ its20.odd 22 Aug 2012 11:45:22 -0000 1.124
@@ -4297,7 +4297,6 @@
markup to ensure that changes were made.</p></item>
</list>
<p>The data category defines four pieces of information:</p>
- <note type="ed">TODO: Table</note>
<table border="1" xml:id="lqissueDefs">
<row role="head">
<cell>Information</cell>
@@ -4386,11 +4385,40 @@
</list>
</item>
</list>
- <exemplum xml:id="EX-locQualityNote-global-1">
- <head>TODO</head>
- <p>TODO</p>
+ <note>
+ <p>The attributes <att>locQualityIssuesRefPointer</att>, <att>locQualityIssueTypePointer</att>, <att>locQualityIssueCommentPointer</att>,
+ <att>locQualityIssueSeverityPointer</att> and <att>locQualityIssueProfileRefPointer</att> do not apply
+ to HTML as local markup is provided for direct annotation in HTML.</p>
+ </note>
+
+ <exemplum xml:id="EX-locQualityIssue-global-1">
+ <head>Annotating an issue in XML with <gi>locQualityIssueRule</gi> element</head>
+ <p>The <gi>locQualityIssueRule</gi> element associates the issue information with a selected span of content.</p>
+ <egXML xmlns="http://www.tei-c.org/ns/Examples"
+ target="examples/xml/EX-locQualityIssue-global-1.xml" />
</exemplum>
-
+ <exemplum xml:id="EX-locQualityIssue-global-2">
+ <head>Using <gi>locQualityIssueRule</gi> to map equivalent markup</head>
+ <p>The <gi>locQualityIssueRule</gi> element defines what constructs are equivalent to the native ITS markup for the
+ different pieces of information of the data category.</p>
+ <egXML xmlns="http://www.tei-c.org/ns/Examples"
+ target="examples/xml/EX-locQualityIssue-global-2.xml" />
+ </exemplum>
+ <exemplum xml:id="EX-locQualityIssue-html5-global">
+ <head>Annotating an issue in HTML5 with <gi>locQualityIssueRule</gi> element</head>
+ <p>The <gi>locQualityIssueRule</gi> element resides in a separate file
+ (<ptr target="#EX-locQualityIssueRule-html5-global" type="exref"/>) that associates the issue
+ information with a selected span of content in the HTML document.</p>
+ <egXML xmlns="http://www.tei-c.org/ns/Examples"
+ target="examples/html5/EX-locQualityIssue-html5-global.html" />
+ </exemplum>
+ <exemplum xml:id="EX-locQualityIssueRule-html5-global">
+ <head>External rule document associated with an HTML5 document</head>
+ <p>This document is used in <ptr target="#EX-locQualityIssue-html5-global" type="exref"/>:</p>
+ <egXML xmlns="http://www.tei-c.org/ns/Examples"
+ target="examples/html5/EX-locQualityIssueRule-html5-global.xml" />
+ </exemplum>
+
<p xml:id="lqissue-local">LOCAL: Using the inline markup to represent the data category locally is limited to a single
occurrence for a given content (e.g. one cannot have different <att>locQualityIssueType</att> attributes applied
to the same span of text because the inner-most one would override the others). Because there may be several
Index: its20.html
===================================================================
RCS file: /w3ccvs/WWW/International/multilingualweb/lt/drafts/its20/its20.html,v
retrieving revision 1.123
retrieving revision 1.124
diff -u -d -r1.123 -r1.124
--- its20.html 22 Aug 2012 11:00:08 -0000 1.123
+++ its20.html 22 Aug 2012 11:45:22 -0000 1.124
@@ -2314,7 +2314,7 @@
HTML preview of an XML file along with CSS styling that highlights these issues. The resulting HTML
file is then sent back to the translator to assist his or her revision efforts.</p></li><li><p>A human reviewer working with a web-based tool adds quality markup, including comments and
suggestions, to a localized text as part of the review process. A subsequent process examines this
- markup to ensure that changes were made.</p></li></ul><p>The data category defines four pieces of information:</p><span class="editor-note">[Ed. note: TODO: Table]</span><a name="lqissueDefs" id="lqissueDefs" shape="rect"/><table border="1"><thead><tr><td rowspan="1" colspan="1">Information</td><td rowspan="1" colspan="1">Description</td><td rowspan="1" colspan="1">Value</td><td rowspan="1" colspan="1">Notes</td></tr></thead><tbody><tr><td rowspan="1" colspan="1">Type</td><td rowspan="1" colspan="1">A set of broad types of issues into which tool-specific issues can be categorized.</td><td rowspan="1" colspan="1">One of the values defined in <a href="#lqissue-typevalues" shape="rect">list of type values</a>.</td><td rowspan="1" colspan="1">ITS 2.0-compliant tools that use these categories <a href="#rfc-keywords" shape="rect">MUST</a>
+ markup to ensure that changes were made.</p></li></ul><p>The data category defines four pieces of information:</p><a name="lqissueDefs" id="lqissueDefs" shape="rect"/><table border="1"><thead><tr><td rowspan="1" colspan="1">Information</td><td rowspan="1" colspan="1">Description</td><td rowspan="1" colspan="1">Value</td><td rowspan="1" colspan="1">Notes</td></tr></thead><tbody><tr><td rowspan="1" colspan="1">Type</td><td rowspan="1" colspan="1">A set of broad types of issues into which tool-specific issues can be categorized.</td><td rowspan="1" colspan="1">One of the values defined in <a href="#lqissue-typevalues" shape="rect">list of type values</a>.</td><td rowspan="1" colspan="1">ITS 2.0-compliant tools that use these categories <a href="#rfc-keywords" shape="rect">MUST</a>
map their internal values to these types.
If the type of the issue is set to <code>uncategorized</code>, a comment <a href="#rfc-keywords" shape="rect">MUST</a>
be specified as well.</td></tr><tr><td rowspan="1" colspan="1">Comment</td><td rowspan="1" colspan="1">A human-readable description of the quality issue.</td><td rowspan="1" colspan="1">Text</td><td rowspan="1" colspan="1"/></tr><tr><td rowspan="1" colspan="1">Severity</td><td rowspan="1" colspan="1">An decimal value representing the severity of the issue, as defined by the model generating the metadata.</td><td rowspan="1" colspan="1">A decimal between 0.0 to 100.0 (included), with higher values indicating greater severity.</td><td rowspan="1" colspan="1">It is up to tools to map the values of this to their own system to this scale. If needed, the
@@ -2328,7 +2328,64 @@
pointing to a node with the exact same semantics as <a class="itsmarkup" href="#locQualityIssueRule.attributes" shape="rect">locQualityIssueType</a>.</p></li></ul></li><li><p>Exactly one of the following:</p><ul><li><p>A <a class="itsmarkup" href="#locQualityIssueRule.attributes" shape="rect">locQualityIssueComment</a> attribute that implements the <a href="#lqissueDefs" shape="rect">comment information</a>.</p></li><li><p>A <a class="itsmarkup" href="#locQualityIssueRule.attributes" shape="rect">locQualityIssueCommentPointer</a> attribute that contains a <a href="#selectors" shape="rect">relative selector</a>
pointing to a node with the exact same semantics as <a class="itsmarkup" href="#locQualityIssueRule.attributes" shape="rect">locQualityIssueComment</a>.</p></li></ul></li></ul></li><li><p>None or exactly one of the following:</p><ul><li><p>A <a class="itsmarkup" href="#locQualityIssueRule.attributes" shape="rect">locQualityIssueSeverity</a> attribute that implements the <a href="#lqissueDefs" shape="rect">severity information</a>.</p></li><li><p>A <a class="itsmarkup" href="#locQualityIssueRule.attributes" shape="rect">locQualityIssueSeverityPointer</a> attribute that contains a <a href="#selectors" shape="rect">relative selector</a>
pointing to a node with the exact same semantics as <a class="itsmarkup" href="#locQualityIssueRule.attributes" shape="rect">locQualityIssueSeverity</a>.</p></li></ul></li><li><p>None or exactly one of the following:</p><ul><li><p>A <a class="itsmarkup" href="#locQualityIssueRule.attributes" shape="rect">locQualityIssueProfileRef</a> attribute that implements the <a href="#lqissueDefs" shape="rect">profile reference information</a>.</p></li><li><p>A <a class="itsmarkup" href="#locQualityIssueRule.attributes" shape="rect">locQualityIssueProfileRefPointer</a> attribute that contains a <a href="#selectors" shape="rect">relative selector</a>
- pointing to a node with the exact same semantics as <a class="itsmarkup" href="#locQualityIssueRule.attributes" shape="rect">locQualityIssueProfileRef</a>.</p></li></ul></li></ul><div class="exampleOuter"><div class="exampleHeader"><a name="EX-locQualityNote-global-1" id="EX-locQualityNote-global-1" shape="rect"/>Example 67: TODO</div><p>TODO</p></div><p id="lqissue-local">LOCAL: Using the inline markup to represent the data category locally is limited to a single
+ pointing to a node with the exact same semantics as <a class="itsmarkup" href="#locQualityIssueRule.attributes" shape="rect">locQualityIssueProfileRef</a>.</p></li></ul></li></ul><div class="note"><p class="prefix"><b>Note:</b></p><p>The attributes <a class="itsmarkup" href="#locQualityIssueRule.attributes" shape="rect">locQualityIssuesRefPointer</a>, <a class="itsmarkup" href="#locQualityIssueRule.attributes" shape="rect">locQualityIssueTypePointer</a>, <a class="itsmarkup" href="#locQualityIssueRule.attributes" shape="rect">locQualityIssueCommentPointer</a>,
+ <a class="itsmarkup" href="#locQualityIssueRule.attributes" shape="rect">locQualityIssueSeverityPointer</a> and <a class="itsmarkup" href="#locQualityIssueRule.attributes" shape="rect">locQualityIssueProfileRefPointer</a> do not apply
+ to HTML as local markup is provided for direct annotation in HTML.</p></div><div class="exampleOuter"><div class="exampleHeader"><a name="EX-locQualityIssue-global-1" id="EX-locQualityIssue-global-1" shape="rect"/>Example 67: Annotating an issue in XML with <a class="itsmarkup" href="#locQualityIssueRule" shape="rect">locQualityIssueRule</a> element</div><p>The <a class="itsmarkup" href="#locQualityIssueRule" shape="rect">locQualityIssueRule</a> element associates the issue information with a selected span of content.</p><div class="exampleInner"><pre xml:space="preserve">
+<doc
+ xmlns:its="http://www.w3.org/2005/11/its" >
+ <header>
+ <its:rules version="2.0">
+ <its:locQualityIssueRule
+ selector="//span[@id='q1']"
+ locQualityIssueType="typographical"
+ locQualitIssueyComment="Sentence without capitalization"
+ locQualityIssueSeverity="50"/>
+ </its:rules>
+ </header>
+ <para>
+ <span id="q1">this</span> is an example</para>
+</doc></pre></div><p>[Source file: <a href="examples/xml/EX-locQualityIssue-global-1.xml" shape="rect">examples/xml/EX-locQualityIssue-global-1.xml</a>]</p></div><div class="exampleOuter"><div class="exampleHeader"><a name="EX-locQualityIssue-global-2" id="EX-locQualityIssue-global-2" shape="rect"/>Example 68: Using <a class="itsmarkup" href="#locQualityIssueRule" shape="rect">locQualityIssueRule</a> to map equivalent markup</div><p>The <a class="itsmarkup" href="#locQualityIssueRule" shape="rect">locQualityIssueRule</a> element defines what constructs are equivalent to the native ITS markup for the
+ different pieces of information of the data category.</p><div class="exampleInner"><pre xml:space="preserve">
+<doc
+ xmlns:its="http://www.w3.org/2005/11/its" >
+ <header>
+ <its:rules version="2.0">
+ <its:locQualityIssueRule
+ selector="//issue"
+ locQualityIssueTypePointer="./@type"
+ locQualityIssueCommentPointer="./@note"
+ locQualityIssueSeverityPointer="./@value"
+ locQualityIssueProfileRefPointer="./@profile"/>
+ </its:rules>
+ </header>
+ <para>
+ <issue
+ type="typographical"
+ note="Sentence without capitalization"
+ value="50"
+ profile="http://example.org/qaModel/v13">this</issue> is an example</para>
+</doc></pre></div><p>[Source file: <a href="examples/xml/EX-locQualityIssue-global-2.xml" shape="rect">examples/xml/EX-locQualityIssue-global-2.xml</a>]</p></div><div class="exampleOuter"><div class="exampleHeader"><a name="EX-locQualityIssue-html5-global" id="EX-locQualityIssue-html5-global" shape="rect"/>Example 69: Annotating an issue in HTML5 with <a class="itsmarkup" href="#locQualityIssueRule" shape="rect">locQualityIssueRule</a> element</div><p>The <a class="itsmarkup" href="#locQualityIssueRule" shape="rect">locQualityIssueRule</a> element resides in a separate file
+ (<a href="#EX-locQualityIssueRule-html5-global" shape="rect">Example 70</a>) that associates the issue
+ information with a selected span of content in the HTML document.</p><div class="exampleInner"><pre xml:space="preserve">
+<html lang="en">
+ <head>
+ <meta charset="utf-8"/>
+ <title>Example</title>
+ <link href="EX-locQualityIssueRule-html5-global.xml" rel="its-rules"/>
+ </head>
+ <body>
+ <p>
+ <span id="q1">this</span> is an example.</p>
+ </body>
+</html></pre></div><p>[Source file: <a href="examples/html5/EX-locQualityIssue-html5-global.html" shape="rect">examples/html5/EX-locQualityIssue-html5-global.html</a>]</p></div><div class="exampleOuter"><div class="exampleHeader"><a name="EX-locQualityIssueRule-html5-global" id="EX-locQualityIssueRule-html5-global" shape="rect"/>Example 70: External rule document associated with an HTML5 document</div><p>This document is used in <a href="#EX-locQualityIssue-html5-global" shape="rect">Example 69</a>:</p><div class="exampleInner"><pre xml:space="preserve">
+<its:rules
+ xmlns:its="http://www.w3.org/2005/11/its" version="2.0">
+ <its:locQualityIssueRule
+ selector="//span[@id='q1']"
+ locQualityIssueType="typographical"
+ locQualityIssueComent="Sentence without capitalization"
+ locQualityIssueSeverity="50"/>
+</its:rules></pre></div><p>[Source file: <a href="examples/html5/EX-locQualityIssueRule-html5-global.xml" shape="rect">examples/html5/EX-locQualityIssueRule-html5-global.xml</a>]</p></div><p id="lqissue-local">LOCAL: Using the inline markup to represent the data category locally is limited to a single
occurrence for a given content (e.g. one cannot have different <a class="itsmarkup" href="#locQualityIssueRule.attributes" shape="rect">locQualityIssueType</a> attributes applied
to the same span of text because the inner-most one would override the others). Because there may be several
instances of a localization quality issue for a given ontent, a local <em>standoff markup</em> allowing
@@ -2345,7 +2402,7 @@
<a href="#lqissueDefs" shape="rect">profile reference information</a>.</p></li></ul></li></ul></li></ul></li></ul><p>Important: When the attributes <a class="itsmarkup" href="#locQualityIssueRule.attributes" shape="rect">locQualityIssueType</a>, <a class="itsmarkup" href="#locQualityIssueRule.attributes" shape="rect">locQualityIssueComment</a>, <a class="itsmarkup" href="#locQualityIssueRule.attributes" shape="rect">locQualityIssueSeverity</a>
and <a class="itsmarkup" href="#locQualityIssueRule.attributes" shape="rect">locQualityIssueProfileRef</a> (or their equivalent representations) are used in in a standoff manner, the information
they carry pertains to the content of the element that refers to the standoff annotation, not to the content of the element
- <a class="itsmarkup" href="#locQualityIssue" shape="rect">locQualityIssue</a> (or <code><span loc-quality-issue></code>in HTML) where they are declared.</p><div class="exampleOuter"><div class="exampleHeader"><a name="EX-locQualityNote-local-1" id="EX-locQualityNote-local-1" shape="rect"/>Example 68: TODO</div><p>TODO</p></div><p id="lqissue-typevalues">Values for the Localization Quality Issue Type:</p><p>The <a class="itsmarkup" href="#locQualityIssueRule.attributes" shape="rect">locQualityIssueType</a> attribute provides a basic level of interoperability between different localization quality
+ <a class="itsmarkup" href="#locQualityIssue" shape="rect">locQualityIssue</a> (or <code><span loc-quality-issue></code>in HTML) where they are declared.</p><div class="exampleOuter"><div class="exampleHeader"><a name="EX-locQualityNote-local-1" id="EX-locQualityNote-local-1" shape="rect"/>Example 71: TODO</div><p>TODO</p></div><p id="lqissue-typevalues">Values for the Localization Quality Issue Type:</p><p>The <a class="itsmarkup" href="#locQualityIssueRule.attributes" shape="rect">locQualityIssueType</a> attribute provides a basic level of interoperability between different localization quality
assurance systems. It offers a list of high-level quality issue types common in automatic and human localization quality assessment.
Tools can map their internal categories to these categories in order to exchange information about the kinds of issues they
identify and take appropriate action even if another tool does not know the specific issues identified by the generating tool.</p><p>The values listed in the following table are allowed for <a class="itsmarkup" href="#locQualityIssueRule.attributes" shape="rect">locQualityIssueType</a>. The values a tool implementing the data category
@@ -2776,7 +2833,7 @@
<h2><a href="#contents" shape="rect"><img src="images/topOfPage.gif" align="right" height="26" width="26" title="Go to the table of contents." alt="Go to the table of contents."/></a><a name="its-schematron-constraints" id="its-schematron-constraints" shape="rect"/>E Checking ITS Markup Constraints With Schematron (Non-Normative)</h2><p>
<em>This section is informative.</em>
</p><p>Several constraints of ITS markup cannot be validated with ITS schemas. The following <a title="Rule-based validation -- Schematron" href="#schematron" shape="rect">[Schematron]</a> document allows for validating some of these
- constraints.</p><div class="exampleOuter"><div class="exampleHeader"><a name="d3e8915" id="d3e8915" shape="rect"/>Example 69: Testing constraints in ITS markup</div><div class="exampleInner"><pre xml:space="preserve">
+ constraints.</p><div class="exampleOuter"><div class="exampleHeader"><a name="d3e8997" id="d3e8997" shape="rect"/>Example 72: Testing constraints in ITS markup</div><div class="exampleInner"><pre xml:space="preserve">
<sch:schema
xmlns:sch="http://www.ascc.net/xml/schematron" >
<!-- Schematron document to test constraints for global and local ITS markup.
@@ -2843,7 +2900,7 @@
<em>This section is informative.</em>
</p><p>The following <a title="Namespace-based Validation Dispatching Language (NVDL)" href="#nvdl" shape="rect">[NVDL]</a> document allows validation of ITS markup which has
been added to a host vocabulary. Only ITS elements and attributes are checked. Elements and
- attributes of host language are ignored during validation against this NVDL document/schema.</p><div class="exampleOuter"><div class="exampleHeader"><a name="d3e8937" id="d3e8937" shape="rect"/>Example 70: NVDL schema for ITS</div><div class="exampleInner"><pre xml:space="preserve"><rules xmlns="http://purl.oclc.org/dsdl/nvdl/ns/structure/1.0"> <namespace
+ attributes of host language are ignored during validation against this NVDL document/schema.</p><div class="exampleOuter"><div class="exampleHeader"><a name="d3e9019" id="d3e9019" shape="rect"/>Example 73: NVDL schema for ITS</div><div class="exampleInner"><pre xml:space="preserve"><rules xmlns="http://purl.oclc.org/dsdl/nvdl/ns/structure/1.0"> <namespace
ns="http://www.w3.org/2005/11/its"> <validate schema="its-elements.rng"/>
</namespace> <namespace ns="http://www.w3.org/2005/11/its" match="attributes">
<validate schema="its-attributes.rng"/> </namespace> <anyNamespace>
Received on Wednesday, 22 August 2012 11:45:31 UTC