/[pub]/test/html-webhacc/error-description-source.xml
Suika

Diff of /test/html-webhacc/error-description-source.xml

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.15 by wakaba, Wed Nov 7 12:20:44 2007 UTC revision 1.21 by wakaba, Fri Mar 21 08:59:47 2008 UTC
# Line 11  Web Document Conformance Checker (BETA)< Line 11  Web Document Conformance Checker (BETA)<
11  <body>  <body>
12  <h1>Description of Errors</h1>  <h1>Description of Errors</h1>
13    
14    <section id="html5-character-encoding">
15    <h2>HTML5 Character Encoding Errors</h2>
16    
17    <d:item name="character encoding" class="format-charset must" level="m">
18      <d:message xml:lang="en">Character encoding <code><var>$0</var></code>
19      is not allowed for <abbr>HTML</abbr> document.</d:message>
20      <d:desc xml:lang="en">
21        <p>The character encoding used for the document is not allowed
22        for <abbr>HTML</abbr> document.  The document is non‐conforming.</p>
23      </d:desc>
24    </d:item>
25    
26    <d:item name="character encoding" class="format-charset should"
27        level="s">
28      <d:message xml:lang="en">Character encoding <code><var>$0</var></code>
29      should not be used for <abbr>HTML</abbr> document.</d:message>
30      <d:desc xml:lang="en">
31        <p>The character encoding used for the document is not recommended
32        for <abbr>HTML</abbr> document.  The document is non‐conforming
33        unless there is any good reason to use that encoding.</p>
34      </d:desc>
35    </d:item>
36    
37    <d:item name="character encoding" class="format-charset warning"
38        level="w">
39      <d:message xml:lang="en">Use of UTF-8 is encouraged.</d:message>
40      <d:desc xml:lang="en">
41        <p>Use of UTF-8 as the character encoding of the document is encouraged,
42        though the use of another character encoding is still conforming.</p>
43      </d:desc>
44    </d:item>
45    
46    <d:item name="character encoding" class="format-charset unsupported"
47        level="unsupported">
48      <d:message xml:lang="en">Conformance for character encoding requirements
49      cannot be checked.</d:message>
50      <d:desc xml:lang="en">
51        <p>The conformance checker cannot detect whether the input document
52        met the requirements on character encoding, since the document
53        is not inputed as a serialized byte sequence.  The document is
54        not conforming if it is not encoded in an appropriate character
55        encoding with appropriate labeling.</p>
56      </d:desc>
57    </d:item>
58    
59    <d:item name="no character encoding declaration" class="format-charset error"
60        level="m">
61      <d:message xml:lang="en">There is no character encoding
62      declaration.</d:message>
63      <d:desc xml:lang="en">
64        <p>The document does not contain a character encoding
65        declaration.  Unless the character encoding is explicitly
66        specified in lower‐level protocol, e.g. in <abbr>HTTP</abbr>,
67        or is implied by <abbr>BOM</abbr>, there must be a character
68        encoding declaration.  The document is non‐conforming.</p>
69    
70        <p>The long character encoding declaration syntax
71        <code class="html bad example">&lt;meta http-equiv="Content-Type" content="text/html; charset=<var>charset-name</var>"></code>
72        is obsolete.  The new syntax is:</p>
73        <pre class="html example"><code>&lt;meta charset="<var>charset-name</var>"></code></pre>
74    
75        <p>Note that the <code>encoding</code> declaration in <abbr>XML</abbr>
76        declaration has no effect for <abbr>HTML</abbr> document.</p>
77      </d:desc>
78    </d:item>
79    
80    <d:item name="non ascii superset" class="format-charset error"
81        level="m">
82      <d:message xml:lang="en">No character encoding metadata is found
83      in lower‐level protocol nor is there <abbr>BOM</abbr>, while
84      character encoding <code><var>$0</var></code>
85      is not a superset of <abbr>ASCII</abbr>.</d:message>
86      <d:desc xml:lang="en">
87        <p>The document is not labeled with character encoding name
88        in lower‐level protocol, e.g. in <abbr>HTTP</abbr>, and
89        the document is not begin with <abbr>BOM</abbr>.  In addition,
90        the character encoding of the document is not a superset of
91        <abbr>ASCII</abbr>.  The document is non‐conforming.</p>
92    
93        <p>Unless there is a <abbr>BOM</abbr>, the character encoding
94        for the document must be specified in e.g. <abbr>HTTP</abbr>‐level,
95        as:</p>
96        <pre class="http example"><code>Content-Type: text/html; charset=<var>charset-name</var></code></pre>
97    
98        <p>Existence of <abbr>HTML</abbr> character encoding declaration, i.e.
99        <code class="html example">&lt;meta charset="<var>charset-name</var>"></code>,
100        does not allow to omit <code>charset</code> parameter
101        for <abbr>HTML</abbr> document encoded in non‐<abbr>ASCII</abbr>
102        compatible encoding.</p>
103    
104        <p>Character encodings <code>Shift_JIS</code>, <code>Windows-31J</code>,
105        and <code>ISO-2022-JP</code> are <em>not</em> a superset of
106        <abbr>ASCII</abbr> for the purpose of <abbr>HTML</abbr> conformance.</p>
107      </d:desc>
108    </d:item>
109    
110    <d:item name="charset label detected" class="format-charset warning"
111        level="w">
112      <d:message xml:lang="en">While parsing the document as
113      <code><var>$0</var></code>, a character encoding declaration specifying
114      character encoding as <code><var>$1</var></code> is found.  The document
115      is reparsed.</d:message>
116      <d:desc xml:lang="en">
117        <p>While parsing a document in a character encoding,
118        a character encoding declaration which declares the character
119        encoding of the document as another character encoding is found.
120        The occurence of this warning itself does not make the document
121        non‐conforming.  However, the failure of the first attempt to
122        to detect the character encoding might be a result of non‐conformance
123        of the document.</p>
124    
125        <p>The document will be reparsed from the beginning.  Some error
126        or warning might be reported again.</p>
127    
128        <p>These are suggestions to avoid this warning:</p>
129        <ul>
130        <li>Specify <code>charset</code> parameter in the <code>Content-Type</code>
131        field in the <abbr>HTTP</abbr> header, as:
132        <pre class="HTTP example"><code>Content-Type: text/html; charset="<var>charset-name</var>"</code></pre></li>
133        <li>Put the character encoding declaration
134        (<code class="html example">&lt;meta charset="<var>charset-name</var>"></code>)
135        just after <code class="html example">&lt;head></code> start tag.</li>
136        <li>Use <code>UTF-8</code>.</li>
137        </ul>
138      </d:desc>
139    </d:item>
140    </section>
141    
142  <section id="html5-tokenize-error">  <section id="html5-tokenize-error">
143  <h2>HTML5 Parse Errors in Tokenization Stage</h2>  <h2>HTML5 Parse Errors in Tokenization Stage</h2>
144    
# Line 889  p { Line 1017  p {
1017  <section id="attribute-value-errors">  <section id="attribute-value-errors">
1018  <h2>Attribute Value Errors</h2>  <h2>Attribute Value Errors</h2>
1019    
1020    <d:item name="charset:not registered" class="attribute-value-warning warning"
1021        level="w">
1022      <d:message xml:lang="en">Character encoding name <code><var>$0</var></code>
1023      is not registered.</d:message>
1024      <d:desc xml:lang="en">
1025        <p>The specified character encoding name is not registered to
1026        <abbr>IANA</abbr>.  Use of registered character encoding name
1027        is a good practice to facilitate interoperability.</p>
1028    
1029        <dl class="switch">
1030        <dt><code>EUC-TW</code></dt>
1031          <dd><code>EUC-TW</code> is not registered.  Unfortunately, there
1032          is no registered name for that character encoding.  Use
1033          Big5 encoding with character encoding name <code>Big5</code>
1034          if it is enough to represent the document.</dd>
1035        <dt><code>ISO-2022-JP-1</code></dt>
1036          <dd><code>ISO-2022-JP-1</code> is not registered, nevertheless
1037          this character encoding name is documented in
1038          <a href="urn:ietf:rfc:2237"><abbr>RFC</abbr> 2237</a>.  Use
1039          <code>ISO-2022-JP-2</code> instead, since that character encoding
1040          is a superset of ISO-2022-JP-1.</dd>
1041        <dt><code>ISO-2022-JP-3</code>, <code>ISO-2022-JP-3-plane1</code></dt>
1042          <dd>These names are not registered and obsoleted in favor of
1043          <code>ISO-2022-JP-2004</code> and
1044          <code>ISO-2022-JP-2004-plane1</code>.</dd>
1045        <dt><code>ISO-2022-JP-2003</code>,
1046        <code>ISO-2022-JP-2003-plane1</code></dt>
1047          <dd>These names are not registered and corrected to
1048          <code>ISO-2022-JP-2004</code> and
1049          <code>ISO-2022-JP-2004-plane1</code>.</dd>
1050        <dt><code>ISO-2022-JP-2004</code>,
1051        <code>ISO-2022-JP-2004-plane1</code></dt>
1052          <dd>These names are not registered.  Unfortunately, there is
1053          no registered name for these character encodings.</dd>
1054        <dt><code>UTF-8N</code></dt>
1055          <dd><code>UTF-8N</code> is not registered.  Character encoding
1056          name <code>UTF-8</code> represents UTF-8 encoding with or
1057          without <abbr>BOM</abbr>.</dd>
1058        </dl>
1059    
1060        <p><strong>WARNING</strong>: This error might be raised for
1061        a registered character encoding name, since the character encoding
1062        name database of the conformance checker is not complete yet.</p>
1063      </d:desc>
1064    </d:item>
1065    
1066    <d:item name="charset:private" class="attribute-value-warning warning"
1067        level="w">
1068      <d:message xml:lang="en"><code><var>$0</var></code> is a private
1069      character encoding name.</d:message>
1070      <d:desc xml:lang="en">
1071        <p>The specified character encoding name is a private name and
1072        not registered to <abbr>IANA</abbr>.  Use of registered character
1073        encoding name is a good practice to facilitate interoperability.</p>
1074    
1075        <dl class="switch">
1076        <dt><code>x-euc-jp</code></dt>
1077          <dd>Use <code>EUC-JP</code> for the Japanese <abbr>EUC</abbr>
1078          character encoding.</dd>
1079        <dt><code>x-sjis</code></dt>
1080          <dd>Use <code>Shift_JIS</code> for standard Shift encoding scheme of
1081          <abbr>JIS</abbr> coded character set, or <code>Windows-31J</code>
1082          for Microsoft standard character set as implemented by
1083          Microsoft Windows.</dd>
1084        </dl>
1085      </d:desc>
1086    </d:item>
1087    
1088    <d:item name="charset:syntax error" class="attribute-value-error"
1089        level="m">
1090      <d:message xml:lang="en">The specified value is syntactically not a
1091      character encoding name.</d:message>
1092      <d:desc xml:lang="en">
1093        <p>The attribute value must be a character encoding name.  However,
1094        the specified value is not a character encoding name syntactically.
1095        The document is non‐conforming.</p>
1096        <p>Character encoding name is a string of <abbr>ASCII</abbr>
1097        printable characters, up to 40 characters.</p>
1098      </d:desc>
1099    </d:item>
1100    
1101  <d:item name="enumerated:invalid"  <d:item name="enumerated:invalid"
1102      class="attribute-value-error">      class="attribute-value-error">
1103    <d:message xml:lang="en">This attribute only allow a limited set of    <d:message xml:lang="en">This attribute only allow a limited set of
# Line 922  p { Line 1131  p {
1131    
1132  <d:item name="enumerated:invalid:http-equiv:content-type"  <d:item name="enumerated:invalid:http-equiv:content-type"
1133      class="attribute-value-error">      class="attribute-value-error">
1134    <d:message xml:lang="en">Charset declaration syntax    <d:message xml:lang="en">Character encoding declaration syntax
1135    <code class="html bad example">&lt;meta http-equiv="Content-Type" content="text/html; charset=<var>charset-name</var>"></code>    <code class="html bad example">&lt;meta http-equiv="Content-Type" content="text/html; charset=<var>charset-name</var>"></code>
1136    is obsolete.</d:message>    is obsolete.</d:message>
1137    <d:desc xml:lang="en">    <d:desc xml:lang="en">
1138      <p>Old long charset declaration syntax      <p>Old long character encoding declaration syntax
1139      <code class="html bad example">&lt;meta http-equiv="Content-Type" content="text/html; charset=<var>charset-name</var>"></code>      <code class="html bad example">&lt;meta http-equiv="Content-Type" content="text/html; charset=<var>charset-name</var>"></code>
1140      is in use.  The document is non‐conforming.</p>      is in use.  The document is non‐conforming.</p>
1141    
1142      <p>The new charset declaration syntax is:      <p>The new character encoding declaration syntax is:
1143        <pre class="html example"><code>&lt;meta charset="<var>charset-name</var>"></code></pre>        <pre class="html example"><code>&lt;meta charset="<var>charset-name</var>"></code></pre>
1144      </p>      </p>
1145    </d:desc>    </d:desc>
# Line 985  p { Line 1194  p {
1194    </d:desc>    </d:desc>
1195  </d:item>  </d:item>
1196    
1197    <d:item name="mismatched charset name" class="attribute-value-error"
1198        level="m">
1199      <d:message xml:lang="en">Character encoding name <code><var>$1</var></code>
1200      is different from document character encoding
1201      <code><var>$0</var></code>.</d:message>
1202      <d:desc xml:lang="en">
1203        <p>The specified character encoding name is different from
1204        the character encoding of the document.  The document
1205        is non‐conforming.</p>
1206      </d:desc>
1207    </d:item>
1208    
1209  <d:item name="reserved browsing context name"  <d:item name="reserved browsing context name"
1210      class="attribute-value-error">      class="attribute-value-error">
1211    <d:message xml:lang="en">Browsing context name    <d:message xml:lang="en">Browsing context name
# Line 1232  p { Line 1453  p {
1453  </d:item>  </d:item>
1454  </section>  </section>
1455    
1456    <section id="information">
1457    <h2>Stability Information</h2>
1458    
1459    <d:item name="status:cr:element" class="level-i" level="i">
1460      <d:message xml:lang="en">This element is in the
1461      <strong>call for implementation</strong> stage.</d:message>
1462      <d:desc xml:lang="en">
1463        <p>The element is in the call for implementation stage.</p>
1464        
1465        <p>Usually, using the element is safe.  However, it is a new feature
1466        so that it might not be implemented correctly.  If it is found that
1467        the feature is hard or impossible to implement, the feature
1468        might be revised, or in some case it might be dropped.</p>
1469    
1470        <p>Elements defined by Atom 1.0 (IETF Proposed Standard), and XBL 2.0
1471        (W3C Candidate Recommendation) belong to this class.</p>
1472      </d:desc>
1473    </d:item>
1474    
1475    <d:item name="status:lc:element" class="level-i" level="i">
1476      <d:message xml:lang="en">This element is in the <strong>last
1477      call for comments</strong> stage.</d:message>
1478      <d:desc xml:lang="en">
1479        <p>The element is in the last call for comments stage.</p>
1480        
1481        <p>The element is relatively mature, though the standardization
1482        is not done yet.  It may be used for experiments.  Since it is a new
1483        feature, it might not be implemented correctly or at all.  If it is
1484        found that the feature is hard or impossible to implement, the feature
1485        might be revised or might be dropped.</p>
1486    
1487        <p>Elements defined by Web Forms 2.0 as well as some elements
1488        defined by HTML5 belong to this class.</p>
1489      </d:desc>
1490    </d:item>
1491    
1492    <d:item name="status:wd:element" class="level-i" level="i">
1493      <d:message xml:lang="en">This element is documented in a <strong>working
1494      draft</strong>.</d:message>
1495      <d:desc xml:lang="en">
1496        <p>The element is documented in a working or editor's draft
1497        and not yet completed.</p>
1498        
1499        <p>The element should not be used for any practical purpose.
1500        The feature might be drastically changed later or might be
1501        entirely removed.</p>
1502    
1503        <p>Most of new elements defined by HTML5 belong to this class.</p>
1504      </d:desc>
1505    </d:item>
1506    
1507    <d:item name="status:non-standard:element" class="level-i" level="i">
1508      <d:message xml:lang="en">This element is <strong>not part of any
1509      standard</strong> the conformance checker knows.</d:message>
1510      <d:desc xml:lang="en">
1511        <p>The element is not part of any standard or draft the conformance
1512        checker is aware of.</p>
1513        
1514        <p>The element should not be used for any practical purpose unless
1515        there is really a standard that defines the element.</p>
1516      </d:desc>
1517    </d:item>
1518    </section>
1519    
1520  <section id="unsupported-messages">  <section id="unsupported-messages">
1521  <h2><i>Unsupported</i> Messages</h2>  <h2><i>Unsupported</i> Messages</h2>
1522    
# Line 1354  to solve a problem in a confusing or pos Line 1639  to solve a problem in a confusing or pos
1639  It does not affect to the conformance of the document, and  It does not affect to the conformance of the document, and
1640  may sometimes be inappropriate.</td>  may sometimes be inappropriate.</td>
1641  </tr>  </tr>
1642  <tr id="level-unsupported" class="level-unsupported">  <tr id="level-i" class="level-i">
1643    <th scope="row">Information</th>
1644    <td>Conforming.</td>
1645    <td>An informational message just provides an additional information
1646    on the feature used in the document or the status of the retrieval
1647    or so on.
1648    It does not affect to the conformance of the document.</td>
1649    </tr>
1650    <tr id="level-u" class="level-u">
1651  <th scope="row">Not supported</th>  <th scope="row">Not supported</th>
1652  <td><em>Unknown</em>.</td>  <td><em>Unknown</em>.</td>
1653  <td>Some feature that is not supported by the conformance checker  <td>Some feature that is not supported by the conformance checker
# Line 1367  is used in the document.</td> Line 1660  is used in the document.</td>
1660  <section id="license">  <section id="license">
1661  <h2>License of This Document</h2>  <h2>License of This Document</h2>
1662    
1663  <p>Copyright <time>2007</time>  <p>Copyright <time>2007</time>‐<time>2008</time>
1664  <a href="http://suika.fam.cx/~wakaba/who?" rel="author" xml:lang="ja">Wakaba</a>  <a href="http://suika.fam.cx/~wakaba/who?" rel="author" xml:lang="ja">Wakaba</a>
1665  <code class="mail">&lt;<a href="mailto:[email protected]">[email protected]</a>></code>.</p>  <code class="mail">&lt;<a href="mailto:[email protected]">[email protected]</a>></code>.</p>
1666    
Legend:
Removed from v.1.15  
changed lines
  Added in v.1.21
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.24