diff options
| -rwxr-xr-x | htdocs/docs/errors.html | 182 | ||||
| -rwxr-xr-x | htdocs/docs/help.html | 170 | ||||
| -rwxr-xr-x | htdocs/docs/index.html | 12 | ||||
| -rwxr-xr-x | htdocs/docs/users.html | 132 |
4 files changed, 435 insertions, 61 deletions
diff --git a/htdocs/docs/errors.html b/htdocs/docs/errors.html index 67f6395..418ed3d 100755 --- a/htdocs/docs/errors.html +++ b/htdocs/docs/errors.html @@ -1,5 +1,5 @@ -<!--#set var="revision" value="\$Id: errors.html,v 1.20 2002-10-23 23:11:30 link Exp $" ---><!--#set var="date" value="\$Date: 2002-10-23 23:11:30 $" +<!--#set var="revision" value="\$Id: errors.html,v 1.21 2002-11-06 02:45:20 ot Exp $" +--><!--#set var="date" value="\$Date: 2002-11-06 02:45:20 $" --><!--#set var="title" value="Error Explanations for The W3C MarkUp Validation Service" --><!--#set var="relroot" value="../" --><!--#include virtual="../header.html" --> @@ -9,6 +9,184 @@ they are used here with his permission. </p> +<h2>Table of Contents</h2> +<ul> + +<li><a href="#undef-id"> +“<code>ID ‘<var>FOO</var>’ already defined</code>” +</a></li> + +<li><a href="#unterm-comment-1"> +“<code>entity end not allowed in comment</code>” +</a></li> + +<li><a href="#unterm-comment-2"> +“<code>name start character invalid: only s and comment allowed in +comment declaration</code>” +</a></li> + +<li><a href="#bad-comment"> +“<code>unknown declaration type ‘<var>FOO</var>’</code>” +</a></li> + +<li><a href="#attr-quoted"> +“<code>an attribute value must be a literal unless it +contains only name characters</code>” +</a></li> + +<li><a href="#attr-char"> +“<code>character `X' not allowed in attribute specification list</code>” +</a></li> + +<li><a href="#name-length"> +“<code>length of attribute value must not exceed +LITLEN less NORMSEP (1022)</code>” +</a></li> + +<li><a href="#undef-tag"> +“<code>element ‘<var>FOO</var>’ +undefined</code>” +</a></li> + +<li><a href="#not-allowed"> +“<code>document type does not allow element +‘<var>FOO</var>’ here</code>” +</a></li> + +<li><a href="#not-contained"> +“<code> +document type does not allow element ‘ +<var>FOO</var>’ here; assuming missing ‘ +<var>BAR</var>’ start-tag” +</code> +</a></li> + +<li><a href="#attr-undef"> +“<code>there is no attribute +‘<var>FOO</var>’ +for this element (in this HTML version)</code>” +</a></li> + +<li><a href="#undef-attr-val"> +“<code>‘<var>FOO</var>’ +is not a member of the group specified in the +declared value of this attribute</code>” +</a></li> + +<li><a href="#bad-attr-char"> +“<code>syntax of attribute value does not conform +to declared value</code>” +</a></li> + +<li><a href="#attr-bad-name"> +“<code>value of attribute ‘<var>FOO</var>’ +invalid: "#" cannot start a name</code>” +</a></li> + +<li><a href="#bad-abbrev-attr"> +“<code>‘<var>FOO</var>’ is not a member of +a group specified for any attribute</code>” +</a></li> + +<li><a href="#attr-missing"> +“<code>required attribute ‘<var>FOO</var>’ +not specified</code>” +</a></li> + +<li><a href="#no-end-tag"> +“<code>end tag for ‘<var>FOO</var>’ +omitted, but its declaration does not permit this</code>” +</a></li> + +<li><a href="#floating-close"> +“<code>end tag for element ‘<var>FOO</var>’ +which is not open</code>” +</a></li> + +<li><a href="#omitted-content"> +“<code>end tag for ‘<var>FOO</var>’ +which is not finished</code>” +</a></li> + +<li><a href="#no-start-tag"> +“<code>start tag for ‘<var>FOO</var>’ +omitted, but its declaration does not permit this</code>” +</a></li> + +<li><a href="#bad-entity"> +“<code>unknown entity ‘<var>FOO</var>’</code>” +</a></li> + +<li><a href="#bad-char"> +“<code>non SGML character number ###</code>” +</a></li> + +<li><a href="#unicode-char"> +“<code>`####' is not a valid character number</code>” +</a></li> + +<li><a href="#bad-pub-id"> +“<code>cannot generate system identifier for entity `HTML'</code>” +</a></li> + +<li><a href="#missing-subel"> +“<code>missing a required sub-element of +‘<var>FOO</var>’</code>” +</a></li> + +<li><a href="#start-tag"> +“<code>start tag was here</code>” +</a></li> + +<li><a href="#utf8-bom"> +“<code>UTF-8 'BOM' detected and removed</code>” +</a></li> + +<li><a href="#text-not-allowed"> +“<code> text is not allowed here; try wrapping the text +in a more descriptive container</code>” +</a></li> + +<li><a href="#unkn-att-val"> +“<code> value of attribute +‘<var>FOO</var>’ cannot be ‘<var>BAR</var>’; +must be one of ‘<var>FOO</var>’, ‘<var>BAR</var>’, +‘<var>BAZ</var>’</code>” +</a></li> + +<li><a href="#no-attr-end"> +“<code>character ‘<var>FOO</var>’ not allowed +in attribute specification list possibly caused by a missing +quotation mark ending a previous attribute value</code>” +</a></li> + +<li><a href="#dup-attr"> +“<code>duplicate specification of attribute +‘<var>FOO</var>’</code>” +</a></li> + +<li><a href="#invalid-attr-val"> +“<code>invalid attribute value</code>” +</a></li> + +<li><a href="#attr-spec-nmtoken"> +“<code>an attribute specification must start with a name +or name token</code>” +</a></li> + +<li><a href="#inval-comment"> +“<code>invalid comment declaration; +check your comment syntax</code>” +</a></li> + +<li><a href="#assuming-missing-starttag"> +“<code>element ‘<var>FOO</var>’ not allowed here; +assuming missing ‘<var>BAR</var>’ start-tag</code>”</a> +</li> +</ul> + +<h2>Listing of errors and their explanation</h2> + <dl> <dt><a id="undef-id" name="dup-id">“<code>ID ‘<var>FOO</var>’ already defined</code>”</a></dt> <dd> diff --git a/htdocs/docs/help.html b/htdocs/docs/help.html index 71e31ec..781aab0 100755 --- a/htdocs/docs/help.html +++ b/htdocs/docs/help.html @@ -1,17 +1,63 @@ -<!--#set var="revision" value="\$Id: help.html,v 1.7 2002-10-23 23:11:30 link Exp $" ---><!--#set var="date" value="\$Date: 2002-10-23 23:11:30 $" +<!--#set var="revision" value="\$Id: help.html,v 1.8 2002-11-06 02:45:20 ot Exp $" +--><!--#set var="date" value="\$Date: 2002-11-06 02:45:20 $" --><!--#set var="title" value="Help for The W3C MarkUp Validation Service" --><!--#set var="relroot" value="../" --><!--#include virtual="../header.html" --> - <div id="skip"> - <h2 id="what-is-it">What does The Validator do?</h2> - The Validator is sort of like <code>lint</code> for C. It compares +<div id="toc"> +<h2>Table of contents</h2> +<ul> + <li>About the Markup Validator + <ul> + <li> + <a href="#what-is-it">What is the Markup Validator and what does it do?</a> + </li> + <li> + <a href="#why-validate">Why validate?</a> + </li> + <li> + <a href="#others">What other validators are there?</a> + </li> + <li> + <a href="#how">How does The Validator work?</a> + </li> + </ul> + </li> + <li>Using this service + <ul> + <li> + <a href="#manual">How do I use the Markup validator?</a> + </li> + <li> + <a href="#errors">What are these error messages?</a> + </li> + <li> + <a href="#munged-doctype">Many error messages? Don't panic.</a> + </li> + <li> + <a href="#cleanup">I don't want error messages, I want you to clean up my page!</a> + </li> + </ul> + </li> + +</ul> + + + +<div id="skip"> +<h2 id=#about">About the Markup Validator</h2> + <h3 id="what-is-it">What is the Markup Validator and what does it do?</h3> + <p> + The Markup Validator is a free tool and service that checks the + syntax of (X)HTML documents.</p> + <p> + The Validator is sort of like <code>lint</code> for C. It compares your HTML document to the defined syntax of HTML and reports any discrepancies. - </div> - <div> - <h2 id="why-validate">Why should I validate my HTML pages?</h2> + </p> + <p><a href="../about.html">Learn more</a> about the Markup Validator.</p> + + <h3 id="why-validate">Why should I validate my HTML pages?</h3> <p> One of the important maxims of computer programming is: <q>Be conservative in what you produce; be liberal in what you accept.</q> @@ -31,48 +77,82 @@ sure your pages are legal HTML. The best way to do that is by running your documents through one or more HTML validators. </p> - </div> - <div><h2 id="others">What other validators are there?</h2><p>FIXME</p></div> - <div> - <h2 id="how">How does The Validator work?</h2> - The Validator is based on <a href="http://www.jclark.com/">James + + <h3 id="others">What other validators are there?</h3> + <p> + We're doing our best to provide clear and reliable results as well as + a good interface with the Markup Validator, but for some reason you + may want to check other validators. Here are a few choices: + </p> + <ul> + <li><a href="http://valet.webthing.com/page/">Page Valet</a>, part of the + <a href="http://valet.webthing.com/">Site Valet</a> suite.</li> + <li><a href="http://www.htmlhelp.com/tools/validator/">WDG's HTML validator</a></li> + </ul> + + <p> + Looking for validators at W3C, but not the Markup Validator? + Check out the list of <a href="http://www.w3.org/QA/Tools/#validators">validators at W3C</a>, + including well-known <a href="http://jigsaw.w3.org/css-validator/">CSS validator</a>, + <a href="http://validator.w3.org/checklink">link checker</a>, etc. + </p> + + + <h3 id="how">How does The Validator work?</h3> + <p> + The Validator is based on <a href="http://www.jclark.com/">James Clark</a>'s <code><a href="http://www.jclark.com/sp/">nsgmls</a></code> SGML parser. The Validator itself is a CGI script that fetches your URL, passes it through <code>nsgmls</code>, and post-processes the resulting error list for easier reading. - </div> - <div> - <h2 id="choosing-dtd">How do I set The Validator to validate in - HTML2/HTML3/Netscape mode?</h2> - Unlike WebTechs, The Validator does not allow you to select a document - type on the fly. If your document is not intended to be HTML - 2.0-compliant, you must add a corresponding <code>DOCTYPE</code> - declaration to your document; see <a href="sgml.html#doctype">the - section on <code>DOCTYPE</code></a> for more information. If your - document does not have a <code>DOCTYPE</code> declaration, The - Validator will assume an HTML 4.0 document type (and will tell - you it is doing so). - </div> - <div> - <h2 id="munged-doctype">Help! The Validator spewed a zillion error - messages on my page!</h2> - <p> - Don't panic. Did The Validator complain about your - <code>DOCTYPE</code> declaration (or lack thereof)? Make sure your - document has a syntactically correct <code>DOCTYPE</code> - declaration, as described in the <a href="sgml.html#doctype">section - on <code>DOCTYPE</code></a>, and make sure it correctly identifies - the type of HTML you're using. Then run it through The Validator - again; if you're lucky, you should get a lot fewer errors. - </p> - <p> - If this doesn't help, then you may be experiencing a cascade failure - — one error that gets The Validator so confused that it can't - make sense of the rest of your page. Try correcting the first few - errors and running your page through The Validator again. - </p> - </div> + </p> +</div> + + + +<div> +<h2 id="using">Using this service</h2> + + <h3 id="manual">How do I use this service?</h3> + <p> + Most probably, you will want to use the online Markup Validation service. + Read the <a href="users.html">user's manual</a> for further help with this + service. + </p> + </p> + If, for some reason, you prefer running your own instance of the Markup Validator, + check out our <a href="devel.html">developer's documentation</a>. + </p> + + <h3 id="errors">What are these error messages?</h3> + + <h3 id="munged-doctype">Many error messages? Don't panic.</h3> + <p> + Don't panic. Did The Validator complain about your + <code>DOCTYPE</code> declaration (or lack thereof)? Make sure your + document has a syntactically correct <code>DOCTYPE</code> + declaration, as described in the <a href="sgml.html#doctype">section + on <code>DOCTYPE</code></a>, and make sure it correctly identifies + the type of HTML you're using. Then run it through The Validator + again; if you're lucky, you should get a lot fewer errors. + </p> + <p> + If this doesn't help, then you may be experiencing a cascade failure + — one error that gets The Validator so confused that it can't + make sense of the rest of your page. Try correcting the first few + errors and running your page through The Validator again. + </p> + <p> + Be patient, with a little time and experience you will learn to use the + Markup Validator to clean up your HTML documents in no time. + </p> + + <h3 id="cleanup">I don't want error messages, I want you to clean up my page!</h3> + <p>The Markup Validator can not do this for you. You may want to have a look + at tools such as <a href="http://tidy.sourceforge.net">HTML Tidy</a>.</p> + + </div> <!--#include virtual="../footer.html" --> </body> </html> diff --git a/htdocs/docs/index.html b/htdocs/docs/index.html index f1dfdb0..06d8cb5 100755 --- a/htdocs/docs/index.html +++ b/htdocs/docs/index.html @@ -1,19 +1,21 @@ -<!--#set var="revision" value="\$Id: index.html,v 1.7 2002-10-23 23:11:30 link Exp $" ---><!--#set var="date" value="\$Date: 2002-10-23 23:11:30 $" +<!--#set var="revision" value="\$Id: index.html,v 1.8 2002-11-06 02:45:20 ot Exp $" +--><!--#set var="date" value="\$Date: 2002-11-06 02:45:20 $" --><!--#set var="title" value="Documentation Index for The W3C MarkUp Validation Service" --><!--#set var="relroot" value="../" --><!--#include virtual="../header.html" --> <p id="skip"> Here you'll find the documentation for The W3C MarkUp Validation Service. - What little there is of it; additions eagerly accepted! <tt>:-)</tt> + What little there is of it; + <a href="../feedback.html">additions eagerly accepted</a>!<tt>:-)</tt> </p> <dl> <dt><a href="help.html">W3C Validator Help</a></dt> - <dd><p>A quick intro and help to get you started.</p></dd> + <dd><p>A quick intro and help to get you started, with answers to + a few Frequently Asked Questions. Read this first.</p></dd> <dt><a href="users.html">W3C Validator Users Guide</a></dt> <dd><p>The Users Guide for the W3C Validator.</p></dd> - <dt><a href="sgml.html">SGML Cheat Sheet</a></dt> + <dt><a href="sgml.html">SGML (basics) and the MarkUp Validator</a></dt> <dd> <p> A quick introduction to SGML concepts as they apply to the diff --git a/htdocs/docs/users.html b/htdocs/docs/users.html index 1f7b90f..739ef10 100755 --- a/htdocs/docs/users.html +++ b/htdocs/docs/users.html @@ -1,8 +1,20 @@ -<!--#set var="revision" value="\$Id: users.html,v 1.8 2002-10-23 23:11:30 link Exp $" ---><!--#set var="date" value="\$Date: 2002-10-23 23:11:30 $" +<!--#set var="revision" value="\$Id: users.html,v 1.9 2002-11-06 02:45:20 ot Exp $" +--><!--#set var="date" value="\$Date: 2002-11-06 02:45:20 $" --><!--#set var="title" value="User Documentation for The W3C MarkUp Validation Service" --><!--#set var="relroot" value="../" --><!--#include virtual="../header.html" --> + <div id="toc"> + <h2 id="tableofcontents">Table of contents</h2> + <ul> + <li><a href="#Quickstart">Quick Start</a></li> + <li><a href="#Introduction">Introduction</a></li> + <li><a href="#Options">Validator's options</a></li> + <li><a href="#Calling">Calling/Linking to the Validator</a></li> + <li><a href="#Interpret">Interpreting the results</a></li> + <li><a href="#CommaTools">Comma Tools</a></li> + <li><a href="#Installing">Installing the Markup Validator Locally</a></li> + </ul> + <div id="Quickstart"> <h2 id="skip">Quick Start</h2> @@ -77,7 +89,7 @@ </div> <div id="Calling" class="stb"> - <h2>Calling the Validator</h2> + <h2>Calling/Linking to the Validator</h2> <p> You can link directly to the Validator home page, or you can call the Validator CGI program. The home page is <URL:<a @@ -117,11 +129,19 @@ <div id="Interpret" class="stb"> <h2>Interpreting the results</h2> <p> - Interpreting the error messages isn't quite what you'd call easy. The - error messages are generated in the context of a full SGML environment - which demands a somewhat higher level of technical detail then your - average HTML document. We're working on ways to make the error messages - more friendly, but for now feel free to email the + In spite of our efforts, interpreting the MarkUp Validator's error messages + isn't quite what you'd call easy. The error messages are generated in the + context of a full SGML environment which demands a somewhat higher level + of technical detail then your average HTML document. We have set up a page + listing <a href="errors.html">errors and their explanation</a>, which should + help you find out what meaning lies behind the cryptic messages, and fix + your markup. + </p> + <p> + We're working on ways to make the error messages more friendly, but for now, + if the <a href="errors.html">errors explanation page</a> doesn't work for you, + feel free to email the + (<a href="http://lists.w3.org/Archives/Public/www-validator">publicly archived</a>) <a href="mailto:www-validator@w3.org">www-validator@w3.org</a> mailing list if you need help interpreting the results. This will have the added benefit of letting us know which error messages are causing @@ -130,10 +150,104 @@ we can validate to see for ourselves. </p> </div> + + <div id="CommaTools"> + <h2>Comma Tools / Site Tools</h2> + <p> + This site uses "comma tools", as does <a href="http://www.w3.org/,tools">W3C</a> + and other sites. This means you can append a string (starting with a comma, hence + the name) to the URI (address) of any page on the site and trigger + a few administrative or technical tools for this page. + </p> + + <table class="comma"> + <tr class="comma"> + <th>What it does</th> + <th>Tool used</th> + <th>, shortcut</th> + </tr> + + <tr class="comma"> + <td class="comma.desc"> + A plain text version of the page. + </td> + <td class="comma.tool"> + <a href="/Web/Tools/html2txt">HTML2Text</a> + </td> + <td class="comma.shortcut"> + ,text + </td> + </tr> + + <tr class="comma"> + <td class="comma.desc"> + Validate the MarkUp. + </td> + <td class="comma.tool"> + W3C Markup Validator + </td> + <td class="comma.shortcut"> + ,validate + </td> + </tr> + + + <tr class="comma"> + <td class="comma.desc"> + Check links (anchors). + </td> + <td class="comma.tool"> + W3C Link Checker + </td> + <td class="comma.shortcut"> + ,checklink or ,checklinks + </td> + </tr> + + + <tr class="comma"> + <td class="comma.desc"> + Check links (recursively) + </td> + <td class="comma.tool"> + W3C Link Checker + </td> + <td class="comma.shortcut"> + ,rchecklink or ,rchecklinks + </td> + </tr> + + + <tr class="comma"> + <td class="comma.desc"> + A version of the page with linearized tables. + </td> + <td class="comma.tool"> + Tablin + </td> + <td class="comma.shortcut"> + ,tablin + </td> + </tr> + + <tr class="comma"> + <td class="comma.desc"> + CVS history for the page or resource. + </td> + <td class="comma.tool"> + CVSWeb + </td> + <td class="comma.shortcut"> + ,cvs or ,cvslog + </td> + </tr> + + </table> + <div id="Installing" class="stb"> <h2>Installing a local Validator</h2> <p> - You can download the Validator to tun on your own system, but it's not + You can download the Validator to run on your own system, but it's not recommended for average users as the process is rather complex and involves obscure incantations on the command line. <tt>:-)</tt> </p> |