Parent Directory
| 
Revision Log
++ ChangeLog 15 Sep 2008 07:20:09 -0000 2008-09-15 Wakaba <wakaba@suika.fam.cx> * error-description-source.xml: "control char" errors are now handled by UnicodeChecker module. New "non unicode" error added. ++ html/WebHACC/Language/ChangeLog 15 Sep 2008 07:20:35 -0000 2008-09-15 Wakaba <wakaba@suika.fam.cx> * HTML.pm: Set the mode of the UnicodeChecker as HTML5.
| 1 | <!DOCTYPE html> |
| 2 | <html xmlns="http://www.w3.org/1999/xhtml" |
| 3 | xmlns:d="http://suika.fam.cx/~wakaba/archive/2007/wdcc-desc/" |
| 4 | id="error-description"> |
| 5 | <head> |
| 6 | <base href="cc/"/> |
| 7 | <title xml:lang="en">Description of Errors — WebHACC (β)</title> |
| 8 | <title xml:lang="ja">誤りの説明 — WebHACC (β)</title> |
| 9 | <link rel="stylesheet" href="../cc-style"/> |
| 10 | <link rel="license" href="#license"/> |
| 11 | </head> |
| 12 | <body> |
| 13 | <header> |
| 14 | <h1><a href="../cc-about"><abbr title="Web Hypertext Application Conformance Checker (β)"><img src="../icons/title" alt="WebHACC"/></abbr></a></h1> |
| 15 | <h2>Description of Errors</h2> |
| 16 | </header> |
| 17 | |
| 18 | <d:cat name="WebHACC:Title"> |
| 19 | <d:text xml:lang="en">WebHACC (β)</d:text> |
| 20 | </d:cat> |
| 21 | |
| 22 | <d:cat name="WebHACC:Heading"> |
| 23 | <d:text xml:lang="en"> |
| 24 | <a href="../error-description#WebHACC:Heading" rel="help"><abbr title="Web Hypertext Application Conformance Checker (β)"><img src="../icons/title" alt="WebHACC"/></abbr></a> |
| 25 | </d:text> |
| 26 | <d:text xml:lang="ja"> |
| 27 | <a href="../error-description#WebHACC:Heading" rel="help"><abbr title="Web ハイパーテキスト応用適合性検査器 (β)"><img src="../icons/title" alt="WebHACC"/></abbr></a> |
| 28 | </d:text> |
| 29 | <d:desc xml:lang="en"> |
| 30 | <p><a href="./#input"><abbr title="Web Hypertext Application Conformance Checker">WebHACC</abbr></a> |
| 31 | is a <em>conformance checker</em> (or validator) for Web documents, |
| 32 | supporting <a href="../standards">latest Web standards</a> including |
| 33 | <a href="http://whatwg.org/html5"><abbr title="Hypertext Markup Language">HTML</abbr>5</a>, |
| 34 | <a href="urn:ietf:rfc:4287">Atom 1.0</a>, |
| 35 | <a href="http://www.w3.org/Style/CSS/current-work"><abbr title="Cascading Style Sheets">CSS</abbr>3</a>.</p> |
| 36 | |
| 37 | <p><strong><a href="./#input">Check your document</a></strong>, or |
| 38 | <a href="../cc-about">learn more about |
| 39 | <abbr title="Web Hypertext Application Conformance Checker">WebHACC</abbr></a>.</p> |
| 40 | </d:desc> |
| 41 | <d:desc xml:lang="ja"> |
| 42 | <p><a href="./#input"><abbr title="Web ハイパーテキスト応用適合性検査器">WebHACC</abbr></a> |
| 43 | は、 Web 文書のための<em>適合性検査器</em> (妥当性検証器) です。 |
| 44 | <a href="http://whatwg.org/html5"><abbr title="Hypertext Markup Language">HTML</abbr>5</a>、 |
| 45 | <a href="urn:ietf:rfc:4287">Atom 1.0</a>、 |
| 46 | <a href="http://www.w3.org/Style/CSS/current-work"><abbr title="Cascading Style Sheets">CSS</abbr>3</a> |
| 47 | などの<a href="../standards">最新の Web 標準</a>に対応しています。</p> |
| 48 | |
| 49 | <p><strong><a href="./#input">文書を検査する</a></strong></p> |
| 50 | |
| 51 | <p><a href="../cc-about"><abbr title="Web ハイパーテキスト応用適合性検査器">WebHACC</abbr> |
| 52 | の詳細</a></p> |
| 53 | </d:desc> |
| 54 | </d:cat> |
| 55 | |
| 56 | <section id="character-encoding-layer"> |
| 57 | <h2>Character Encoding Layer Errors</h2> |
| 58 | |
| 59 | <d:item name="fallback-char-error" |
| 60 | modules="Charset::DecodeHandle"> |
| 61 | <d:message xml:lang="en">Octet sequence <code><var>{octets}</var></code> |
| 62 | is not an allowed representation of the character |
| 63 | <code><var>{char}</var></code> — character reference |
| 64 | <code><var>{char:hexref}</var></code> should be used instead.</d:message> |
| 65 | <!-- HTML5 parse error --> |
| 66 | </d:item> |
| 67 | |
| 68 | <d:item name="fallback-unassigned-error" |
| 69 | modules="Charset::DecodeHandle"> |
| 70 | <d:message xml:lang="en">No character is assigned to octet sequence |
| 71 | <code><var>{octets}</var></code>.</d:message> |
| 72 | <!-- HTML5 parse error --> |
| 73 | </d:item> |
| 74 | |
| 75 | <d:item name="illegal-octets-error" |
| 76 | modules="Charset::DecodeHandle"> |
| 77 | <d:message xml:lang="en">Octet sequence <code><var>{octets}</var></code> |
| 78 | is illegal.</d:message> |
| 79 | </d:item> |
| 80 | |
| 81 | <d:item name="invalid-state-error" |
| 82 | modules="Charset::DecodeHandle::ISO2022JP"> |
| 83 | <!-- TODO: more user-friendly error message is desired... --> |
| 84 | <d:message xml:lang="en">The input stream is broken.</d:message> |
| 85 | <d:desc xml:lang="en"> |
| 86 | <p>The input stream is encoded in <code>ISO-2022-JP</code> |
| 87 | or its variant but is partially broken.</p> |
| 88 | |
| 89 | <p>Note that an <code>ISO-2022-JP</code> stream must end in the ASCII |
| 90 | state.</p> |
| 91 | </d:desc> |
| 92 | </d:item> |
| 93 | |
| 94 | <d:item name="unassigned-code-point-error" |
| 95 | modules="Charset::DecodeHandle"> |
| 96 | <d:message xml:lang="en">No character is assigned to octet sequence |
| 97 | <code><var>{octets}</var></code>.</d:message> |
| 98 | </d:item> |
| 99 | </section> |
| 100 | |
| 101 | <section id="html5-character-encoding"> |
| 102 | <h2>HTML5 Character Encoding Errors</h2> |
| 103 | |
| 104 | <d:item name="disallowed character encoding" |
| 105 | modules="ContentChecker"> |
| 106 | <d:message xml:lang="en">Character encoding <code><var>{text}</var></code> |
| 107 | is not allowed for <abbr>HTML</abbr> document.</d:message> |
| 108 | <d:desc xml:lang="en"> |
| 109 | <p>The character encoding used for the document is not allowed |
| 110 | for <abbr>HTML</abbr> document. The document is non‐conforming.</p> |
| 111 | </d:desc> |
| 112 | </d:item> |
| 113 | |
| 114 | <d:item name="bad character encoding" |
| 115 | modules="ContentChecker"> |
| 116 | <d:message xml:lang="en">Character encoding <code><var>{text}</var></code> |
| 117 | should not be used for <abbr>HTML</abbr> document.</d:message> |
| 118 | <d:desc xml:lang="en"> |
| 119 | <p>The character encoding used for the document is not recommended |
| 120 | for <abbr>HTML</abbr> document. The document is non‐conforming |
| 121 | unless there is any good reason to use that encoding.</p> |
| 122 | </d:desc> |
| 123 | </d:item> |
| 124 | |
| 125 | <d:item name="non-utf-8 character encoding" |
| 126 | modules="ContentChecker"> |
| 127 | <d:message xml:lang="en">Use of UTF-8 is encouraged (this document |
| 128 | is encoded in <code><var>{text}</var></code>).</d:message> |
| 129 | <d:desc xml:lang="en"> |
| 130 | <p>Use of UTF-8 as the character encoding of the document is encouraged, |
| 131 | though the use of another character encoding is still conforming.</p> |
| 132 | </d:desc> |
| 133 | </d:item> |
| 134 | |
| 135 | <d:item name="character encoding unchecked" |
| 136 | modules="ContentChecker"> |
| 137 | <d:message xml:lang="en">Conformance for character encoding requirements |
| 138 | cannot be checked, since the input is not a byte stream.</d:message> |
| 139 | <d:desc xml:lang="en"> |
| 140 | <p>The conformance checker cannot detect whether the input document |
| 141 | met the requirements on character encoding, since the document |
| 142 | is not inputed as a serialized byte sequence. The document is |
| 143 | not conforming if it is not encoded in an appropriate character |
| 144 | encoding with appropriate labeling.</p> |
| 145 | </d:desc> |
| 146 | </d:item> |
| 147 | |
| 148 | <d:item name="no character encoding declaration" |
| 149 | modules="ContentChecker"> |
| 150 | <d:message xml:lang="en">There is no character encoding |
| 151 | declaration.</d:message> |
| 152 | <d:desc xml:lang="en"> |
| 153 | <p>The document does not contain a character encoding |
| 154 | declaration. Unless the character encoding is explicitly |
| 155 | specified in lower‐level protocol, e.g. in <abbr>HTTP</abbr>, |
| 156 | or is implied by <abbr>BOM</abbr>, there must be a character |
| 157 | encoding declaration. The document is non‐conforming.</p> |
| 158 | |
| 159 | <p>The long character encoding declaration syntax |
| 160 | <code class="html bad example"><meta http-equiv="Content-Type" content="text/html; charset=<var>charset-name</var>"></code> |
| 161 | is obsolete. The new syntax is:</p> |
| 162 | <pre class="html example"><code><meta charset="<var>charset-name</var>"></code></pre> |
| 163 | |
| 164 | <p>Note that the <code>encoding</code> declaration in <abbr>XML</abbr> |
| 165 | declaration has no effect for <abbr>HTML</abbr> document.</p> |
| 166 | </d:desc> |
| 167 | </d:item> |
| 168 | |
| 169 | <d:item name="non ascii superset" |
| 170 | modules="ContentChecker"> |
| 171 | <d:message xml:lang="en">No character encoding metadata is found |
| 172 | in lower‐level protocol nor is there <abbr>BOM</abbr>, while |
| 173 | character encoding <code><var>{text}</var></code> |
| 174 | is not a superset of <abbr>ASCII</abbr>.</d:message> |
| 175 | <d:desc xml:lang="en"> |
| 176 | <p>The document is not labeled with character encoding name |
| 177 | in lower‐level protocol, e.g. in <abbr>HTTP</abbr>, and |
| 178 | the document is not begin with <abbr>BOM</abbr>. In addition, |
| 179 | the character encoding of the document is not a superset of |
| 180 | <abbr>ASCII</abbr>. The document is non‐conforming.</p> |
| 181 | |
| 182 | <p>Unless there is a <abbr>BOM</abbr>, the character encoding |
| 183 | for the document must be specified in e.g. <abbr>HTTP</abbr>‐level, |
| 184 | as:</p> |
| 185 | <pre class="http example"><code>Content-Type: text/html; charset=<var>charset-name</var></code></pre> |
| 186 | |
| 187 | <p>Existence of <abbr>HTML</abbr> character encoding declaration, i.e. |
| 188 | <code class="html example"><meta charset="<var>charset-name</var>"></code>, |
| 189 | does not allow to omit <code>charset</code> parameter |
| 190 | for <abbr>HTML</abbr> document encoded in non‐<abbr>ASCII</abbr> |
| 191 | compatible encoding.</p> |
| 192 | |
| 193 | <p>Character encodings <code>Shift_JIS</code>, <code>Windows-31J</code>, |
| 194 | and <code>ISO-2022-JP</code> are <em>not</em> a superset of |
| 195 | <abbr>ASCII</abbr> for the purpose of <abbr>HTML</abbr> conformance.</p> |
| 196 | </d:desc> |
| 197 | </d:item> |
| 198 | |
| 199 | <d:item name="sniffing:chardet" |
| 200 | modules="HTML::Parser"> |
| 201 | <d:message xml:lang="en">Character encoding of this document is sniffed |
| 202 | as <code><var>{text}</var></code> (Sniffed because no explicit specification |
| 203 | for the character encoding of this document is found in the transfer |
| 204 | procotol headers).</d:message> |
| 205 | </d:item> |
| 206 | |
| 207 | <d:item name="sniffing:default" |
| 208 | modules="HTML::Parser"> |
| 209 | <d:message xml:lang="en">Character encoding of this document is defaulted |
| 210 | to <code><var>{text}</var></code> because no explicit specification |
| 211 | for the character encoding of this document is found in the transfer |
| 212 | procotol headers.</d:message> |
| 213 | </d:item> |
| 214 | |
| 215 | <d:item name="chardecode:fallback" |
| 216 | modules="HTML::Parser"> |
| 217 | <d:message xml:lang="en">Results might be <em>wrong</em>, since the |
| 218 | conformance checker cannot find an appropriate decoder for the character |
| 219 | encoding used for the document.</d:message> |
| 220 | <d:desc xml:lang="en"> |
| 221 | <p>The conformance checker cannot find an appropriate decoder for |
| 222 | the character encoding used to encode characters in the document.</p> |
| 223 | |
| 224 | <p>This error is raised if:</p> |
| 225 | <ul> |
| 226 | <li>the conformance checker cannot find any decoder for the character |
| 227 | encoding in use, but it knows that the encoding is similar to another |
| 228 | character encoding, such that it uses the decoder for that character |
| 229 | encoding, and therefore some octets might be interpreted incorrectly, |
| 230 | or,</li> |
| 231 | <li>the conformance checker find a decoder for the character encoding |
| 232 | in use, but it does not know whether the decoder is conforming to the |
| 233 | relevant specification or not, and therefore some octets might be |
| 234 | interpreted incorrectly.</li> |
| 235 | </ul> |
| 236 | |
| 237 | <p>In either case, the result shown by the conformance checker might |
| 238 | contain wrong errors caused by errorneous decoder or might not contain |
| 239 | errors that should be raised if an appropriate decoder is used.</p> |
| 240 | |
| 241 | <!-- TODO: add advise that either install relevant modules or |
| 242 | join the developmenet of the modules... --> |
| 243 | </d:desc> |
| 244 | </d:item> |
| 245 | |
| 246 | <d:item name="chardecode:no error" |
| 247 | modules="HTML::Parser"> |
| 248 | <d:message xml:lang="en">Conformance error checking for the character |
| 249 | encoding <code><var>{text}</var></code> is not supported.</d:message> |
| 250 | </d:item> |
| 251 | |
| 252 | <d:item name="charset label:matching" |
| 253 | modules="HTML::Parser"> |
| 254 | <d:message xml:lang="en">Sniffed character encoding |
| 255 | <code><var>{text}</var></code> is same as the character encoding specified |
| 256 | in the character encoding declaration. This is <em>not</em> an |
| 257 | error.</d:message> |