xml/xmlcc/xmlcc-work.en.html

<!DOCTYPE html>
<html lang="en" class="formal-specification status-work-in-progress">
<head>
<title>manakai's XML Conformance Checking</title>
<link rel="stylesheet" href="http://suika.fam.cx/www/style/html/spec">
<link rel="license" href="http://suika.fam.cx/c/gnu/fdl">
<style>
  a[id]::before {
    content: "[" attr(id) "]";
    color: gray;
    font-size: 70%;
    font-family: Courier New, monospace;
    vertical-align: 60%;
  }
</style>
</head>
<body class="has-abstract">

<div class="header">
<h1>manakai's <abbr>XML</abbr> Conformance Checking</h1>
<h2>Working Draft <time datetime=2007-12-01>1 December 2007</time></h2>

<dl class="versions-uri">
<dt>This Version</dt>
  <dd><code class="URI">&lt;<a href="http://suika.fam.cx/www/markup/xml/xmlcc/xmlcc-work"
      >http://suika.fam.cx/www/markup/xml/xmlcc/xmlcc-work</a>&gt;</code></dd>
<dt>Latest Version</dt>
  <dd><code class="URI">&lt;<a href="http://suika.fam.cx/www/markup/xml/xmlcc/xmlcc"
      >http://suika.fam.cx/www/markup/xml/xmlcc/xmlcc</a>&gt;</code></dd>
<dt>Latest Working Draft</dt>
  <dd><code class="URI">&lt;<a href="http://suika.fam.cx/www/markup/xml/xmlcc/xmlcc-work"
      >http://suika.fam.cx/www/markup/xml/xmlcc/xmlcc-work</a>&gt;</code></dd>
<!-- <dt>Previous Version</dt> -->
<dt>Version History</dt>
  <dd><code class=URI>&lt;<a href="http://suika.fam.cx/gate/cvs/markup/xml/xmlcc/xmlcc-work.en.html">http://suika.fam.cx/gate/cvs/markup/xml/xmlcc/xmlcc-work.en.html</a>&gt;</code></dd>
</dl>
<dl class="authors" id="author">
<dt>Author</dt>
  <dd><a href="http://suika.fam.cx/~wakaba/who?" rel="author"
      lang=ja>Wakaba</a>
  <code class="mail">&lt;<a href="mailto:[email protected]" rel="author"
      >[email protected]</a>&gt;</code></dd>
</dl>

<p class="copyright" lang="en">&#xA9; <time>2007</time> <a
    href="http://suika.fam.cx/~wakaba/who?" rel="author">Wakaba</a>.
Permission is granted to copy, distribute and/or modify this document
under the terms of the <a rel="license"
href="http://www.gnu.org/copyleft/fdl.html">GNU Free Documentation License</a>,
Version 1.2
or any later version published by the <a
href="http://www.fsf.org/">Free Software Foundation</a>;
with no Invariant Sections, no Front$B!>(BCover Texts, and no Back$B!>(BCover
Texts.  A copy of the license is
available at <code class="URI">&lt;<a
    href="http://www.gnu.org/copyleft/fdl.html"
    rel="license">http://www.gnu.org/copyleft/fdl.html</a>&gt;</code>.</p>
</div>

<div id="abstract" class="section">
<h2>Abstract</h2>

<div class="ed issue">...</div>

</div>

<div id="status" class="section">
<h2>Status of This Document</h2>

<p class=section-info><em>This section describes the status of this document
at the time of its publication.  Other documents
might supersede this document.</em></p>

<p>This document is a working draft, produced as part of the 
<a href="http://suika.fam.cx/www/markup/html/whatpm/readme">Whatpm</a>
subproject of the 
<a href="http://suika.fam.cx/www/manakai-core/doc/web/">manakai</a> 
project.  It might be updated, replaced, or obsoleted by
other documents at any time.  It is inappropriate to
cite this document as other than <q>work in progress</q>.</p>

<p>Comments on this document are welcome and
may be sent to the <a href="#author">author</a>.</p>

<p>Translations of thie document might be available.
The English version of the document is the only
normative version.</p>
</div>

<div id="introduction" class="section">
<h2>Introduction</h2>

<p class=section-info>This section is <em>non$B!>(Bnormative</em>.</p>

<div class="issue ed">...</div>


</div>

<div class="section" id="terminology">
<h2>Terminology</h2>

<p>The key words <q><em class="rfc2119">MUST</em></q>,
<q><em class="rfc2119">MUST NOT</em></q>,
<q><em class="rfc2119">SHOULD</em></q>,
<q><em class="rfc2119">SHOULD NOT</em></q>, and
<q><em class=rfc2119>MAY</em></q> in this
document are to be interpreted as described in 
<a href="urn:ietf:rfc:2119"><abbr title="Request for Comments">RFC</abbr> 
2119</a>
<cite class="bibref normative">[<a href="#ref-KEYWORDS">KEYWORDS</a>]</cite>.</p>

<!-- Strictly speaking the paragraph below is not part of terminology. -->
<p>All examples and notes in this specification are non$B!>(Bnormative,
as are all sections explicitly marked non$B!>(Bnormative.  Everything
else in this specification is normative.</p>

<p><span class=ed>Algorithm is normative but non-normative</span>.
In addition, the order in which <a href="#errors">errors</a> are
raised is undefined.</p>
</div>


<div class=section id=error-categories>
<h2>Error Classification</h2>

<p class=ed>If a <code>Document</code> node has no 
xml-well-formedness-error, entity-error, and unknown-error,
then it is well-formed.  If a well-formed <code>Document</code>
node has no xml-validity-error, it is valid.</p>

<div class="note memo">
<p>A well$B!>(Bformed <code>Document</code> can be safely serialized
into a well$B!>(Bformed XML document.  A valid <code>Document</code>
can be easily serialized into a valid XML document.</p>
</div>

<p class=ed>To be a conforming <a href="http://www.w3.org/TR/2006/REC-xml-20060816/#dt-validating">validating XML processor</a>,
...</p>

<p>Errors are classified into these 
<dfn id=error-category title="error category">error categories</dfn>:</p>

<dl id=errors>
<dt><dfn id=entity-error><code>entity-error</code></dfn></dt>
  <dd>
    <p class=ed>@@</p>
    <div class="note memo">
      <p>This <span class=ed>algorithm</span> does not support
      <abbr>DOM</abbr> tree with one or more <code>EntityReference</code>
      nodes.  It is expected that any entity references are expanded
      at the parse time and any unexpandable entity references
      make parse time errors raised so that never result in
      <abbr>DOM</abbr> tree with <code>EntityReference</code> nodes.</p>
    </div>
  </dd>
<dt><dfn id=round-trip-error><code>round-trip-error</code></dfn></dt>
  <dd class=ed>@@</dd>
<dt><dfn id=round-trip-warning><code>round-trip-warning</code></dfn></dt>
  <dd>
    <p>A <a href="#round-trip-warning"><code>round-trip-warning</code></a>
    will be raised when a construct, which might not be restored to the same
    construct when it is serialized and then re-parsed by a conforming
    processor, is encountered.</p>
    <div class="example memo">
      <p>For a <code>Comment</code> node a
      <a href="#round-trip-warning"><code>round-trip-warning</code></a> will
      be raised, since <abbr>XML</abbr> processors are not required to
      report texts of comments for applications.</p>
    </div>
  </dd>
<dt class=ed><dfn id=unknown-error><code>unknown-error</code></dfn>?</dt>
  <dd class=ed>@@</dd>
<dt><dfn id=xml-misc-error><code>xml-misc-error</code></dt>
  <dd>An <abbr>XML</abbr> <i>error</i> (<abbr>XML</abbr> 1.0
  <cite class="bibref normative">[<a href="#ref-XML10">XML10</a>]</cite> 
  <a href="http://www.w3.org/TR/2006/REC-xml-20060816/#dt-error">error</a> /
  <abbr>XML</abbr> 1.1
  <cite class="bibref normative">[<a href="#ref-XML11">XML11</a>]</cite>
  <a href="@@/#dt-error">error</a>)
  that is not classified to any other <a href="#error-category">error
  category</a>.</dd>
<dt><dfn id=xml-misc-fatal-error><code>xml-misc-fatal-error</code></dt>
  <dd>An <abbr>XML</abbr> <i>fatal error</i> (<abbr>XML</abbr> 1.0
  <cite class="bibref normative">[<a href="#ref-XML10">XML10</a>]</cite> 
  <a href="http://www.w3.org/TR/2006/REC-xml-20060816/#dt-fatal">fatal
  error</a> / <abbr>XML</abbr> 1.1
  <cite class="bibref normative">[<a href="#ref-XML11">XML11</a>]</cite>
  <a href="@@/#dt-fatal">fatal error</a>)
  that is not classified to any other <a href="#error-category">error
  category</a>. <span class=ed>@@ What errors fall into this category?</span></dd>
<dt><dfn id=xml-misc-recommendation><code>xml-misc-recommendation</code></dfn></dt>
  <dd>
    <p>An
    <a href="#xml-misc-recommendation"><code>xml-misc-recommendation</code></a>
    will be raised if a <em class=rfc2119>SHOULD</em>$B!>(Blevel requirement
    in <abbr>XML</abbr> specification is not met.</p>
  </dd>
<dt><dfn id=xml-validity-error><code>xml-validity-error</code></dfn></dt>
  <dd>A violation of validity constraint in XML document.</dd>
<dt><dfn id=xml-well-formedness-error><code>xml-well-formedness-error</code></dfn></dt>
  <dd><p>If an <code>xml-well-formedness-error</code> is raised,
  it would not be possible to generate an XML serialization that
  would match to the appropriate production rule and that would not 
  violate to any well$B!>(Bformedness constraint in XML
  specification <cite class="bibref normative">[<a href="#ref-XML10">XML10</a>,
  <a href="#ref-XML11">XML11</a>]</cite>.</p></dd>
</dl>

<div class=ed><p>@@ TODO: #dt-atuseroption at user option
(MAY or MUST), #dt-compat for compatibility,
#dt-interop for interoperability</p></div>

</div>

<div class=section id=parsing-xml>
<h2>Parsing <abbr>XML</abbr> Document</h2>

<ul>
<li>If the <abbr>XML</abbr> document does not begin with an
<abbr>XML</abbr> declaration, then raise an
<a href="#xml-misc-recommentation" id=xmr-xml-decl><code>xml-misc-recommendation</code></a>.</li>
<li>If the replacement text of an entity declaration is
<code>&lt;</code>, then raise an
<a href="#xml-misc-warning" id=xmw-entity-value-lt><code>xml-misc-warning</code></a>.<!--
"strongly advised to avoid" in a Note in Section 2.3 of [XML10], [XML11].
--></li>
<li>If there is an element type declaration whose <code>Name</code>
value is already declared, then raise an 
<a href="#xml-validity-error" id=vc-edunique><code>xml-validity-error</code></a>.</li>
<li>If attribute definition whose <code>Name</code> is
<code>xml:space</code> has <span class=ed>declared type different from 
(default|preserve), (default), or (preserve)</span>, then raise an
<a href="#xml-misc-error" id=xme-ad-xml-space><code>xml-misc-error</code></a>.
<span class=ed>@@ duplication with 
<a href="#xml-at-xml-space">#xml-at-xml-space</a>.<!--
<!ATTLIST e xml:space CDATA #IMPLIED xml:space CDATA #IMPLIED> --></span></li>
<li>If an empty-element tag is used for an element which is <em>not</em>
declared <code>EMPTY</code>, then raise an
<a href="#xml-misc-recommentation" id=xmr-emptyelemtag-not-empty><code>xml-misc-recommendation</code></a>.</li>
<li>If an empty-element tag is <em>not</em> used for an element which is
declared <code>EMPTY</code>, then raise an
<a href="#xml-misc-recommentation" id=xmr-empty-not-emptyelemtag><code>xml-misc-recommendation</code></a>.</li>
<!--

#vc-PEinMarkupDecl Validity constraint: Proper Declaration/PE Nesting
#wfc-PEinInternalSubset Well-formedness constraint: PEs in Internal Subset
#ExtSubset Well-formedness constraint: External Subset
#PE-between-Decls Well-formedness constraint: PE Between Declarations
#GIMatch Well-formedness constraint: Element Type Match
#uniqattspec Well-formedness constraint: Unique Att Spec
#NoExternalRefs Well-formedness constraint: No External Entity References
#CleanAttrVals Well-formedness constraint: No < in Attribute Values
#vc-PEinGroup Validity constraint: Proper Group/PE Nesting
"For interoperability, if a parameter-entity reference appears in a choice, seq, or Mixed construct, its replacement text SHOULD contain at least one non-blank character, and neither the first nor last non-blank character of the replacement text SHOULD be a connector (| or ,)."
"For interoperability, an XML processor MAY at user option issue a warning when more than one attribute-list declaration is provided for a given element type, or more than one attribute definition is provided for a given attribute, but this is not an error."
#condsec-nesting Validity constraint: Proper Conditional Section/PE Nesting
#wf-Legalchar Well-formedness constraint: Legal Character
#textent Well-formedness constraint: Parsed Entity
#norecursion Well-formedness constraint: No Recursion
#indtd Well-formedness constraint: In DTD
"External parsed entities SHOULD each begin with a text declaration."
"It is an error for a reference to an unparsed entity to appear in the EntityValue in an entity declaration."
#UniqueNotationName Validity constraint: Unique Notation Name

@@ Need detailed review, but maybe should be in parsing phase

#vc-check-rmd Validity constraint: Standalone Document Declaration

@@ Need dtailed review

#wf-entdeclared Well-formedness constraint: Entity Declared
#vc-entdeclared Validity constraint: Entity Declared
"For interoperability, valid documents SHOULD declare the entities amp, lt, gt, apos, quot, in the form specified in 4.6 Predefined Entities."
"If the entities lt or amp are declared, they MUST be declared as internal entities whose replacement text is a character reference to the respective character (less-than sign or ampersand) being escaped; the double escaping is REQUIRED for these entities so that references to them produce a well-formed result. If the entities gt, apos, or quot are declared, they MUST be declared as internal entities whose replacement text is the single character being escaped (or a character reference to that character; the double escaping here is OPTIONAL but harmless)."

@@ flaged and then reported in DOM check phase

"Entities encoded in UTF-16 MUST and entities encoded in UTF-8 MAY begin with the Byte Order Mark"
"In the absence of external character encoding information (such as MIME headers), parsed entities which are stored in an encoding other than UTF-8 or UTF-16 MUST begin with a text declaration"
"In an encoding declaration, the values "UTF-8", "UTF-16", "ISO-10646-UCS-2", and "ISO-10646-UCS-4" SHOULD be used for the various encodings and transformations of Unicode / ISO/IEC 10646, the values "ISO-8859-1", "ISO-8859-2", ... "ISO-8859-n" (where n is the part number) SHOULD be used for the parts of ISO 8859, and the values "ISO-2022-JP", "Shift_JIS", and "EUC-JP" SHOULD be used for the various encoded forms of JIS X-0208-1997. It is RECOMMENDED that character encodings registered (as charsets) with the Internet Assigned Numbers Authority [IANA-CHARSETS], other than those just listed, be referred to using their registered names; other encodings SHOULD use names starting with an "x-" prefix."

@@ in parsing phase

"It is a fatal error when an XML processor encounters an entity with an encoding that it is unable to process. It is a fatal error if an XML entity is determined (via default, encoding declaration, or higher-level protocol) to be in a certain encoding but contains byte sequences that are not legal in that encoding."

-->
</ul>
</div>

<div class="section" id=checking-dom>
<h2>Checking <abbr>DOM</abbr></h2>

<p>The following algorithms and definitions are applied to
<abbr>XML</abbr> documents; especially, they are not applied
to <abbr>HTML</abbr> documents.<!-- TODO: ref to HTML5 --></p>

<div class=section id=definitions>
<h3>Definitions</h3>

<p>The <dfn id=xml-version><abbr>XML</abbr> version</dfn> of a node is 
the <abbr>XML</abbr> version of the document to which the node belongs.
For a <code>Documemt</code> node, the <abbr>XML</abbr> version
of the document is the value of the <code>xmlVersion</code>
attribute of the node.  For a <code>DocumentType</code> node whose 
<code>ownerDocument</code> attribute is set to <code>null</code>,
the <abbr>XML</abbr> version of the document is <code>1.0</code><!--
since createDocumentType [DOM3CORE] assumes XML 1.0 [XML10TE] -->.
For any other node, the <abbr>XML</abbr> version of the document
is that of the <code>Document</code> node contained in the
<code>ownerDocument</code> attribute of the node.</p>

</div>


<div class=section id=checking-components>
<h3>Conformance Checking Algorithms for Components</h3>

<p>To
<dfn id=algorithm-to-validate-an-xml-character-data title="validate an XML string">to
validate an <abbr>XML</abbr> string (<dfn id=var-s><var>s</var></dfn>)</dfn>,
the following algorithm <em class=rfc2119>MUST</em> be used:</p>
<ol>
<li>If <var>s</var> contains a character that is <em>not</em> in
the character class <a href="#class-Char10"><code>Char10</code></a>, 
then raise an
<a href="#xml-well-formedness-error" id=wfe-illegal-char><code>xml-well-formedness-error</code></a>.</li>
<li>If <var>s</var> contains a character that is in the character
class <a href="#class-CompatChar10"><code>CompatChar10</code></a>,
then raise an
<a href="#xml-misc-warning" id=xmw-compat-char><code>xml-misc-warning</code></a>.</li>
<li>If <var>s</var> contains a character that is in the character
class <a href="#class-ControlChar10"><code>ControlChar10</code></a>,
then raise an
<a href="#xml-misc-warning" id=xmw-control-char><code>xml-misc-warning</code></a>.</li>
<li class=ed>@@ XML 1.1 support</li>
<li>If <var>s</var> contains a <code class=char>U+000D</code>
<code class=charname>CARRIAGE RETURN</code> character, then
raise a 
<a href="#round-trip-error" id=rte-cr><code>round-trip-error</code></a>.
<span class=ed>@@ We should not raise duplicate errors for U+000D
in attribute values.  In addition, we should support a mode where
U+000D will be serialized as &#x000D; (so that no round-trip-error
will be raised).</span></li>
</ol>

<p>To
<dfn id=algorithm-to-validate-a-name title="validate a Name">validate a
<code>Name</code> (<dfn id=var-name-s><var>s</var></dfn>)</dfn>, the following
algorithm <em class=rfc2119>MUST</em> be used:</p>
<ol>
<li>If <var>s</var> is an empty string, then raise an
<a href="#xml-well-formedness-error" id=wfe-name-empty><code>xml-well-formedness-error</code></a>.
Abort these steps.</li>
<li><a href="#algorithm-to-validate-an-xml-character-data" title="validate an XML string">Validate
<var>s</var> as an <abbr>XML</abbr> string</a>.</li>
<li>If the first character in <var>s</var> is a character that is 
<em>not</em> in the character class 
<a href="#class-NameStartChar10"><code>NameStartChar10</code></a>, then raise
an
<a href="#xml-well-formedness-error" id=wfe-name-startchar><code>xml-well-formedness-error</code></a>.</li>
<li>If a character other than the first character in <var>s</var> is a 
character that is <em>not</em> in the character class 
<a href="#class-NameChar10"><code>NameChar10</code></a>, then raise an
<a href="#xml-well-formedness-error" id=wfe-name-char><code>xml-well-formedness-error</code></a>.</li>
<li>If <var>s</var> begins with the string <code>xml</code> (in any
case combination), then raise an
<a href="#xml-misc-warning" id=xmw-reserved-name><code>xml-misc-warning</code></a>.
<span class=ed>@@ except for attribute names <code>xml:lang</code>,
<code>xml:space</code>, <code>xml:base</code>, <code>xml:id</code>,
<code>xmlns</code>, <code>xmlns:<var>*</var></code>,
pi name <code>xml-stylesheet</code>.</span><!--
"names beginning with a match to (('X'|'x')('M'|'m')('L'|'l')) are reserved for standardization in this or future versions of this specification.":
xmlns, xml-stylesheet, xml:base and xml:id specifications violate to this sentense!
--></li>
<!-- COLON in Name is a lowercase "should not" in a Note of [XML10],
[XML11]. -->
<li class=ed>@@ XML 1.1 support</li>
</ol>

<p>To
<dfn id=algorithm-to-validate-an-ncname title="validate an NCName">validate
an <code>NCName</code> (<dfn id=var-ncname-s><var>s</var></dfn>)</dfn>, the
following algorithm <em class=rfc2119>MUST</em> be used:</p>
<ol>
<li><a href="#algorithm-to-validate-a-name" title="validate a Name">Validate
<var>s</var> as a <code>Name</code></a>.</li>
<li class=ed>@@</li>
</ol>

<p>To 
<dfn id=algorithm-to-validate-a-public-identifier title="validate a public identifier">validate
a public identifier (<dfn id=var-pid><var>pid</var></dfn>)</dfn>, the
following algorithm <em class=rfc2119>MUST</em> be used:</p>
<ol>
<li>If <var>pid</var> is <code>null</code>, abort these steps.</li>
<li>If <var>pid</var> contains a character that is <em>not</em> in the
character class <a href="#class-PubidChar"><code>PubidChar</code></a>, then
raise an
<a href="#xml-well-formedness-error" id=wfe-pubid-char><code>xml-well-formedness-error</code></a>.</li>
  <li>If <var>pid</var> contains one of <code class=char>U+0009</code>
  <code class=charname>CHARACTER TABULATION</code>, 
  <code class=char>U+000A</code> <code class=charname>CARRIAGE RETURN</code>,
  and <code class=char>U+000D</code> <code class=charname>LINE FEED</code>
  characters, if the first character of <var>pid</var> is
  <code class=char>U+0020</code> <code class=charname>SPACE</code> character,
  if the last character of <var>pid</var> is <code class=char>U+0020</code>
  <code class=charname>SPACE</code> character, or if there is a
  <code class=char>U+0020</code> <code class=charname>SPACE</code> character
  immediately followed by another <code class=char>U+0020</code>
  <code class=charname>SPACE</code> character in <var>pid</var>, then it is a
  <a href="#round-trip-error" id=rte-pubid-space><code>round-trip-error</code></a>.
  <span class=ed>Is this really a roundtripness problem?  XML spec
  does only define the way to match public identifiers in fact, no
  canonical form.</span></li>
</ol>

<p>To 
<dfn id=algorithm-to-validate-a-system-identifier title="validate a system identifier">validate
a system identifier (<dfn id=var-sid><var>sid</var></dfn>)</dfn>, the
following algorithm <em class=rfc2119>MUST</em> be used:</p>
<ol>
  <li>If <var>sid</var> is <code>null</code>, abort these steps.</li>
<li><a href="#algorithm-to-validate-an-xml-character-data" title="validate an XML string">Validate
<var>sid</var> as an <abbr>XML</abbr> string</a>.</li>
  <li>If <var>sid</var> contains both <code class=char>U+0022</code>
  <code class=charname>QUOTATION MARK</code> (<code class=char>"</code>) and
  <code class=char>U+0027</code> <code class=charname>APOSTROPHE</code>
  (<code class=char>'</code>) characters, raise an
  <a href="#xml-well-formedness-error" id=wfe-sid-lit><code>xml-well-formedness-error</code></a>.</li>
  <li>If <var>sid</var> contains at least one <code class=char>U+0023</code>
  <code class=charname>NUMBER SIGN</code> (<code class=char>#</code>)
  character, then raise an
  <a href="#xml-misc-error" id=xme-sid-fragment><code>xml-misc-error</code></a>.</li>
  <li class=ed>@@ If <var>sid</var> cannot be converted to a URI
  reference, then raise a fact-level error (xml-misc-warning?).<!--
  XML 1.0 has no conformance language for system identifier being