/[suikacvs]/markup/xml/xmlcc/xmlcc-work.en.html

Diff of /markup/xml/xmlcc/xmlcc-work.en.html

Parent Directory | Revision Log | View Patch Patch

-revision 1.26 by wakaba,
Sat Mar 29 06:35:16 2008 UTC
+revision 1.29 by wakaba,
Fri Oct 17 05:57:26 2008 UTC
 Line 18
  <div class="header">
  <h1>manakai's <abbr>XML</abbr> Conformance Checking</h1>
- <h2>Working Draft <time datetime=2008-03-29>29 March 2008</time></h2>
+ <h2>Working Draft <time datetime=2008-10-17>17 October 2008</time></h2>
  <dl class="versions-uri">
  <dt>This Version</dt>
 Line 79 
 project.  It might be updated, replaced,
  other documents at any time.  It is inappropriate to
  cite this document as other than <q>work in progress</q>.</p>
+ <p>The scope of this specification is explicitly limited to the <a
+ href="http://suika.fam.cx/www/markup/html/whatpm/readme">Whatpm</a>
+ implementation.  It is <em>not</em> the purpose of this specification
+ to define a general guideline to parse or to check XML documents.
+ This specification does <em>not</em> try to define a new version of
+ XML at all.
+ <p>This version of the specification supports the fourth edition of
+ XML 1.0 and the second edition of XML 1.1.  The fifth edition of XML
+.0 might be supported in a later version.  XML namespaces
+ specifications is expected to be supported in a later version of this
+ specification.
  <p>Comments on this document are welcome and
  may be sent to the <a href="#author">author</a>.</p>
-Line 92 
 normative version.</p>
+Line 105 
 normative version.</p>
  <p class=section-info>This section is <em>non$B!>(Bnormative</em>.</p>
- <div class="issue ed">...</div>
+ <p>This specification defines how the parsing and the conformance
+ checking of XML documents should be implemented in the <a
+ href="http://suika.fam.cx/www/markup/html/whatpm/readme">Whatpm</a>
+ XML parser and conformance checker.
+ <p>It is <em>not</em> the purpose of this specification to define,
+ e.g., how to parse XML documents in general; its scope is explicitly
+ limited to the <a
+ href="http://suika.fam.cx/www/markup/html/whatpm/readme">Whatpm</a>
+ implementation.
+ <div class="issue ed">...
+ <p>Much of invalid (well-formed or not) XML document parsing and XML document
+ / XML DOM conformance is left undefined so that this document provides a
+ guideline for conformance checkers.
+ </div>
  </div>
-Line 125 
 document, however, corresponding parts o
+Line 154 
 document, however, corresponding parts o
  specification should be consulted instead.</p>
  </div>
+ <div class=section id=processing-model>
+ <h2>Processing Model</h2>
+ <p>Conceptually, validation of an XML document is split into two
+ stages for the purpose of this specification: the <dfn
+ id=xml-document-parsing>XML document parsing</dfn> stage and the <dfn
+ id=dom-xml-conformance-checking>DOM XML conformance checking</dfn>
+ stage.
+ <p>The input to the XML document parsing stage is a byte sequence
+ representing the parsed XML document (and any additional metadata),
+ and the output are a DOM tree representing the XML document and zero
+ or more <a href="#error">errors</a>.  The processor that implements
+ this stage is called <dfn id=parser>parser</dfn>.  Requirements for a
+ parser are defined in the section of <a href="#parsing-xml">Parsing an
+ XML Document</a>.
+ <p>The input to the DOM XML conformance chcking stage is a DOM tree,
+ and the output are zero or more <a href="#error">errors</a>.  The
+ processor that implements this stage is called <dfn
+ id=conformance-checker>conformance checker</dfn>.  Requirements for a
+ conformance checker are defined in the section of <a
+ href="#checking-dom">Checking an XML DOM Tree</a>.
  <div class=section id=error-categories>
- <h2>Error Classification</h2>
+ <h3>Error Classification</h3>
+ <p class=ed>An <dfn id=error>error</dfn> is ...
  <p class=ed>If a <code>Document</code> node has no
  xml-well-formedness-error, entity-error, and unknown-error,
-Line 222 
 can be easily serialized into a valid XM
+Line 277 
 can be easily serialized into a valid XM
  #dt-interop for interoperability</p>
  <p>TODO: XML 1.1, XML Namespace 1.0/1.1, xml:base, xml:id
+ <p>TODO: XML "error"/"fatal error" is not always non-conforming (only
+ when MUST or SHOULD).
+ </div>
  </div>
  </div>
  <div class=section id=parsing-xml>
- <h2>Parsing <abbr>XML</abbr> Document</h2>
+ <h2>Parsing an <abbr>XML</abbr> Document</h2>
+ <p>When a byte stream that represents an XML document is given to a
+ parser, it <em class=rfc2119>MUST</em> create a DOM tree according to
+ relevant specifications <span class=ed>[XML10, XML11, XMLNAMES10,
+ XMLNAMES11, DOM3CORE, WEBDOMCORE, DOMDTDEF, MANAKAIDOMEXT]</span>.
+ <p>The parser <em class=rfc2119>MAY</em> continue the parsing of the
+ document even after a fatal error (as defined by the relavant
+ specifications) is encountered.  How the parsing ought to be continued
+ is not defined by this specification.
+ <!--
+   <div class="note memo informative">
+   <p>It is expected that the XML5 specification <span class=ed>@@ ref</span>
+   will define how the parser has to convert any string into DOM tree
+   completely.
+   </div>
+ -->
+ <p class=ed>A future version of this specification might define the
+ entire parser in terms of input stream preprocessor, tokenizer, and
+ tree constructor.
+ <p>In addition, the following requirements are applied to the parser:
- <p>When an <abbr>XML</abbr> document is parsed, the following clauses
- are applied:</p>
  <dl class=switch>
+ <dt>For each external entity (including the document entity and the external
+ subset entity, if any)
+   <dd>If there is a byte sequence that are not legal in the encoding in use,
+   then the parser <em class=rfc2119>MUST</em> raise an
+   <a href="#xml-misc-error" id=xme-illegal-bytes><code>xml-misc-error</code></a>.
+   <!--
+      <q>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.</q>
+   -->
+   <dd>If it is the document entity or a general entity, then:
+     <ul>
+     <li>If the input byte sequence for the entity begins with the
+     <abbr title="BYTE ORDER MARK" class=charname>BOM</abbr>, then the parser
+     <em class=rfc2119>MUST</em> set the <span class=ed>BOM flag</span> of
+     the node corresponding to the entity (the <code>Document</code> node
+     for the document entity or an <code>Entity</code> node for a general
+     entity) to <code>true</code>.
+     <!--
+       <q>Entities encoded in UTF-16 MUST and entities encoded in UTF-8 MAY
+       begin with the Byte Order Mark</q>
+     -->
+     <span class=ed>@@ flag must be checked later</span>
+     <!-- <?xml encoding=""?> must be reflected to xmlEncoding; this should be
+     enforced by DOM Core spec. -->
+     </ul>
+   <dd>If it is a parameter entity or the external subset entity, then:
+     <ul>
+     <li>If the character encoding of the entity is <code>UTF-16</code> but
+     the input byte stream for the entity does not begin with the
+     <abbr title="BYTE ORDER MARK" class=charname>BOM</abbr>, then the parser
+     <em class=rfc2119>MUST</em> raise an
+     <a href="#xml-misc-error" id=xme-pe-bom><code>xml-misc-error</code></a>.
+     <li class=ed>@@ encoding="" preferred name?
+ <!--
+ "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 addition, this should be checked later for Document and Entity nodes.
+ -->
+     </ul>
  <dt>For the document
    <dd>If the <abbr>XML</abbr> document does not begin with an
    <abbr>XML</abbr> declaration, then the parser <em class=rfc2119>MUST</em>
    raise an
    <a href="#xml-misc-recommentation" id=xmr-xml-decl><code>xml-misc-recommendation</code></a>.
+   <dd>If the document does not contain the document type declaration, or
+   if it does but the document type definition does not contain entity
+   declaration for any of <code>amp</code>, <code>lt</code>, <code>gt</code>,
+   <code>apos</code>, or <code>quot</code>, then the parser
+   <em class=rfc2119>MUST</em> raise
+   <a href="#xml-misc-recommentation" id=xmr-predefined-decl><code>xml-misc-recommendation</code></a>(s).
+   <!--
+     <q>For interoperability, valid documents SHOULD declare the entities
+     amp, lt, gt, apos, quot, in the form specified in 4.6 Predefined
+     Entities.</q>
+   -->
  <dt>For the document type declaration
    <dd class=ed>@@ read external entity
    <dd>The <code>entities</code> attribute of the <code>DocumentType</code>
-Line 401 
 parser
+Line 538 
 parser
    type declaration as <code>EMPTY</code> content, then the parser
    <em class=rfc2119>MUST</em> raise an
    <a href="#xml-misc-recommentation" id=xmr-empty-not-emptyelemtag><code>xml-misc-recommendation</code></a>.
+ <dt>For each attribute
+   <dd><p>The parser <em class=rfc2119>MUST</em> set the normalized value of
+   the attribute to the <code>value</code> attribute of the <code>Attr</code>
+   node created for the attribute.
+     <div class="note memo informative">
+     <p>That is, any entity reference has to be expanded.  Unexpanded entity
+     references in attribute values are discarded.
+     </div>
+ <dt>For each <code>xml:space</code> attribute
+   <dd>The parser <em class=rfc2119>MUST</em> set the normalized value of
+   the <code>xml:space</code> attribute to the <code>value</code> attribute
+   of the <code>Attr</code> node created for the attribute even if the
+   normalized value is different from <code>default</code> or
+   <code>preserve</code>.
+   <!-- In XML 1.0/1.1 specification, the attribute specification MAY be
+   ignored. -->
  <dt>For each parameter entity reference
-   <dd>If the declaration for the entity is not read (i.e. no declaration
+   <dd><p>Process as follows:
-   for the entity is processed or the external entity referenced by the
+     <ol>
-   declaration cannot be retrieved), then:
+     <li>If the declaration for the entity is <em>not</em> processed,
+     then:
+       <dl class=switch>
+       <dt>If the document contains no external entity or if the document
+       contains the <code>standalone</code> pseudo-attribute set to
+       <code>yes</code><!-- or the document contains no DTD -->
+         <dd>The parser <em class=rfc2119>MUST</em> raise an
+         <a href="#xml-well-formedness-error" id=wf-entdeclared-pe><code>xml-well-formedness-error</code></a>.
+       <dt>Otherwise
+         <dd>The parser <em class=rfc2119>MUST</em> raise an
+         <a href="#xml-validity-error" id=vc-entdeclared-pe><code>xml-validity-error</code></a>.
+       </dl>
+     <li>If the declaration for the entity <em>is</em> processed but the
+     referenced entity cannot be retrieved, then the parser
+     <em class=rfc2119>MUST</em> raise an
+     <span class=ed>@@ ??-error</span>.
+     </ol>
+     <p>In any of two cases above, process as follows:
      <ul>
-     <li>If the parameter entity is contained in a declaration, then the
+     <li>If the parameter entity reference is contained in a declaration, then
-     declaration <em class=rfc2119>MUST</em> be ignored <em>except</em> that
+     the declaration <em class=rfc2119>MUST</em> be ignored <em>except</em> that
      any error before the parameter entity <em class=rfc2119>MUST</em> be
      raised as usual.
-     <li>If the parameter entity is contained in the status portion of a
+     <li>If the parameter entity reference is contained in the status portion of
-     conditional section, then the conditional section
+     a conditional section, then the conditional section
      <em class=rfc2119>MUST</em> be processed as if it were an
      <code>IGNORE</code>d section.
      <li>The parser <em class=rfc2119>MUST NOT</em> process any entity or
-Line 432 
 parser
+Line 604 
 parser
      </ul>
  <dt>For each general entity reference in an attribute value or in the content
  of an element
-   <dd>If the declaration for the entity is not read (i.e. no declaration for
+   <dd><p>Process as follows:
-   the entity is processed or the external entity referenced by the declaration
+     <ol>
-   cannot be retrieved), then:
+     <li>If the <code>Name</code> of the entity reference is either
+     <code>amp</code>, <code>lt</code>, <code>gt</code>, <code>quot</code>,
+     or <code>apos</code>, then abort these steps.
+     <li>If the declaration for the entity is <em>not</em> processed,
+     then:
+       <dl class=switch>
+       <dt>If the document contains no external entity or if the document
+       contains the <code>standalone</code> pseudo-attribute set to
+       <code>yes</code><!-- or the document contains no DTD -->
+         <dd>The parser <em class=rfc2119>MUST</em> raise an
+         <a href="#xml-well-formedness-error" id=wf-entdeclared-ge><code>xml-well-formedness-error</code></a>.
+       <dt>Otherwise
+         <dd>The parser <em class=rfc2119>MUST</em> raise an
+         <a href="#xml-validity-error" id=vc-entdeclared-ge><code>xml-validity-error</code></a>.
+       </dl>
+     <li>If the declaration for the entity <em>is</em> processed but the
+     referenced entity cannot be retrieved, then the parser
+     <em class=rfc2119>MUST</em> raise an
+     <span class=ed>@@ ??-error</span>.
+     </ol>
+     <p>In any of two cases above, process as follows:
      <ul>
      <li>If the general entity reference is the first reference to an entity
      that is not read, then the parser <em class=rfc2119>MUST</em> raise an
-Line 442 
 of an element
+Line 635 
 of an element
      <span class=ed>@@ entity declared WFC?</span>
      <li class=ed>An unexpended entity reference node <em class=rfc2119>MUST</em> be inserted to the current node.
      </ul>
- </dl>
- <p class=ed>@@ MUST try to read external entity
+ <dt>For each comment <em>outside</em> of document type declaration
+   <dd>A <code>Comment</code> node <em class=rfc2119>MUST</em> be created
+   and inserted appropriately.
+   <!-- In XML 1.0/1.1 spec, this is optional. -->
+ </dl>
- <p>In addition, the parser has to check whether the
+ <p>The parser <em class=rfc2119>MUST</em> try to read any entity
- following constraints are met.
+ referenced by general or parameter entity references<!--,--> and the
+ external subset entity, if any<!--, and any general entity declared-->
+ in the document type definition.
+ <p><strong>Well-formedness constraints</strong>.  When the parser
+ detects a voilation to one of certain well-formedness constraints, it
+ <em class=rfc2119>MUST</em> raise an <a
+ href="#xml-well-formedness-error"><code>xml-well-formedness-error</code></a>.
+ The list of such well-formed constraints is as follows:
- <p><strong>Well-formedness constraints</strong>.  For each violation to
- one of constraints below, an
- <a href="#xml-well-formedness-error"><code>xml-well-formedness-error</code></a>
- <em class=rfc2119>MUST</em> be raised.  The list of well-formedness
- constraints is below:
  <ul>
  <li><a href="http://www.w3.org/TR/2006/REC-xml-20060816/#wfc-PEinInternalSubset">Well-formedness constraint: PEs in Internal Subset</a>
  <li><a href="http://www.w3.org/TR/2006/REC-xml-20060816/#GIMatch">Well-formedness constraint: Element Type Match</a>
-Line 466 
 constraints is below:
+Line 665 
 constraints is below:
  <li><a href="http://www.w3.org/TR/2006/REC-xml-20060816/#indtd">Well-formedness constraint: In DTD</a>
  </ul>
- <p><strong>Validity constraints</strong>.  For each violation to
+ <p><strong>Validity constraints</strong>.  When the parser detects a
- one of constraints below, an
+ violation to one of certain validity contraints, it <em
- <a href="#xml-validity-error"><code>xml-validity-error</code></a>.
+ class=rfc2119>MUST</em> raise an <a
- <em class=rfc2119>MUST</em> be raised.  The list of validity
+ href="#xml-validity-error"><code>xml-validity-error</code></a>.  The
- constraints is below:
+ list of such validity constraints is as follows:
  <ul>
  <li><a href="http://www.w3.org/TR/2006/REC-xml-20060816/#vc-PEinMarkupDecl">Validity constraint: Proper Declaration/PE Nesting</a>
  <li><a href="http://www.w3.org/TR/2006/REC-xml-20060816/#vc-PEinGroup">Validity constraint: Proper Group/PE Nesting</a>
  <li><a href="http://www.w3.org/TR/2006/REC-xml-20060816/#condsec-nesting">Validity constraint: Proper Conditional Section/PE Nesting</a>
+ <li><a href="http://www.w3.org/TR/2006/REC-xml-20060816/#vc-check-rmd">Validity constraint: Standalone Document Declaration</a>
  </ul>
- <p><strong>Other creteria</strong>.  For each violation to
+ <p><strong>Other creteria</strong>.  If the parser detects a violation
- one of constraints below, an
+ to one of certain additional constraints, it <em
- <a href="#xml-misc-recommendation"><code>xml-misc-recommendation</code></a>
+ class=rfc2119>MUST</em> raise an <a
- <em class=rfc2119>MUST</em> be raised.  The list of constraints is below:
+ href="#xml-misc-recommendation"><code>xml-misc-recommendation</code></a>.
+ The list of such constraints is as follows:
  <ul>
  <li><q>For interoperability, if a parameter-entity reference appears in a
  <code>choice</code>, <code>seq</code>, or <code>Mixed</code> construct, its
-Line 492 
 or <code>,</code>).</q>
+Line 695 
 or <code>,</code>).</q>
  text declaration.</q>
  </ul>
+ <p>The parser <em class=rfc2119>MUST</em> act as if it is a <a
+ href="http://www.w3.org/TR/2006/REC-xml-20060816/#dt-validating">validating
+ XML processor</a> for the purpose of informing of white space
+ characters appearing in <a
+ href="http://www.w3.org/TR/2006/REC-xml-20060816/#dt-elemcontent">element
+ content</a> (See <a
+ href="http://www.w3.org/TR/2006/REC-xml-20060816/#sec-white-space">Section
+.10</a> of the XML specification).
+   <div class="note memo informative">
+   <p>In other word, the <code>isElementContentWhitespace</code> attribute
+   of <code>Text</code> nodes has to be set appropriately.  Note that the
+   value of the attribute will be set to <code>false</code> for any
+   <code>Text</code> node in the content of an element whose declaration
+   is not processed.
+   </div>
+ <p>The parser <em class=rfc2119>MUST</em> raise at least one <a
+ href="#xml-well-formedness-error"
+ id=wfe-syntax><code>xml-well-formedness-error</code></a> if the entity
+ it parses does not match to the appropriate production rule in the XML
+ specification.  As an exception to this requirement, it <em
+ class=rfc2119>MAY</em> choose not to raise such an error if the error
+ will be raised by the conformance checker when the conformance checker
+ <a href="#algorithm-to-check-a-node" title="check a node">checks</a>
+ the <code>Document</code> object produced by the parser.
  <!--
+   <li><a href="http://www.w3.org/TR/2006/REC-xml-20060816/#ExtSubset">Well-formedness constraint: External Subset</a>
- @@ Need detailed review, but maybe should be in parsing phase
+   <li><a href="http://www.w3.org/TR/2006/REC-xml-20060816/#PE-between-Decls">Well-formedness constraint: PE Between Declarations</a>
- #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."
- @@ 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."
- @@ We should phrase out what the parser should do where the XML specification
- left undefined.  For example: Comment must be converted to a Comment node,
- illegal xml:space value must be preserved, so on.
- Warn <!ENTITY % xml... ...>
  -->
- <p>The parser <em class=rfc2119>MUST</em> raise an
- <a href="#xml-well-formedness-error" id=wfe-syntax><code>xml-well-formedness-error</code></a>
- for any failure to match to a production rule in the XML specification.
  <!--
-   <li><a href="http://www.w3.org/TR/2006/REC-xml-20060816/#ExtSubset">Well-formedness constraint: External Subset</a>
+   Inpossible to test:
-   <li><a href="http://www.w3.org/TR/2006/REC-xml-20060816/#PE-between-Decls">Well-formedness constraint: PE Between Declarations</a>
+     "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"
  -->
  </div>
  <div class="section" id=checking-dom>
- <h2>Checking <abbr>DOM</abbr></h2>
+ <h2>Checking an <abbr>XML</abbr> <abbr>DOM</abbr> Tree</h2>
  <p>The following algorithms and definitions are applied to
  <abbr>XML</abbr> documents; especially, they are not applied
-Line 1151 
 parsed entity)</dt>
+Line 1354 
 parsed entity)</dt>
      <li>If the <code>childNodes</code> list of <var>n</var> contains
      any nodes, then raise an
      <a href="#xml-well-formedness-error" id=wfe-pi-child><code>xml-well-formedness-error</code></a>.</li>
+     <li class=ed>@@ Warn if not declared
      </ol>
    </dd>
  <dt>If <var>n</var> is a <code>Text</code> node</dt>

 Legend:



Removed from v.1.26
 


changed lines


 
Added in v.1.29
 Legend:



Removed from v.1.26
 


changed lines


 
Added in v.1.29
-Removed from v.1.26
+Added in v.1.29

admin@suikawiki.org	ViewVC Help
Powered by ViewVC 1.1.24