diff options
Diffstat (limited to 'htdocs/docs/users.html')
| -rwxr-xr-x | htdocs/docs/users.html | 266 |
1 files changed, 88 insertions, 178 deletions
diff --git a/htdocs/docs/users.html b/htdocs/docs/users.html index dc34737..1574ceb 100755 --- a/htdocs/docs/users.html +++ b/htdocs/docs/users.html @@ -1,5 +1,5 @@ -<!--#set var="revision" value="\$Id: users.html,v 1.25 2006-11-13 04:13:13 ot Exp $" ---><!--#set var="date" value="\$Date: 2006-11-13 04:13:13 $" +<!--#set var="revision" value="\$Id: users.html,v 1.26 2006-11-15 08:02:46 ot Exp $" +--><!--#set var="date" value="\$Date: 2006-11-15 08:02:46 $" --><!--#set var="title" value="User Documentation for The W3C Markup Validation Service" --><!--#set var="relroot" value="../" --><!--#include virtual="../header.html" --> @@ -14,11 +14,19 @@ <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="#Calling">Calling/Linking to the Validator</a> + <ul> + <li><a href="#API">Calling the validator's API</a></li> + </ul> + </li> + <li><a href="#Options_Params">Validator's options and output formats</a> + <ul> + <li><a href="#Options">Options and Parameters</a></li> + <li><a href="#Output">Output Formats</a></li> + <li><a href="#deprecated_options">Deprecated options</a></li> + </ul> + </li> <li><a href="#Interpret">Interpreting the results</a></li> - <li><a href="#Output">Output Options</a></li> - <li><a href="#CommaTools">Comma Tools</a></li> <li><a href="#Installing">Installing the Markup Validator Locally</a></li> </ul> </div> @@ -38,7 +46,7 @@ </p> <p> Alternatively, you can also copy and paste the <em>complete</em> markup - (including a <a href="help.html#faq-doctype">DOCTYPE declaration</a> + (including a <a href="help.html#faq-doctype">DOCTYPE declaration</a>) for a document in the "direct input" box. </p> </div> @@ -71,8 +79,50 @@ </p> </div> - <div id="Options" class="stb"> - <h3>The Options</h3> + <div id="Calling" class="stb"> + <h3>Calling/Linking to the Validator</h3> + <p> + You can link directly to the Validator home page, or you can call the + Validator CGI program. The home page is <<a + href="http://validator.w3.org/">http://validator.w3.org/</a>> at + the moment (and for the foreseeable future) and the CGI program can be + reached at <<a + href="http://validator.w3.org/check">http://validator.w3.org/check</a>>. + </p> + <p> + If you call the CGI program with extra path info matching "/referer" + (i.e. <<a href="http://validator.w3.org/check/referer">http://validator.w3.org/check/referer</a>>) + it will fetch the referring document and validate that. This means that + if you embed a link to that URL in your pages, following on that link + will send you the validation results for that page. + </p> + <p> + You can also link to the validation results for a specific page. You do + this by giving "check" an "uri" parameter pointing at the page you want + to validate. For example <<a href="http://validator.w3.org/check?uri=http://www.example.com/">http://validator.w3.org/check?uri=http://www.example.com/</a>> + will validate the www.example.com home page. + </p> + <p> + The various options are listed above in the section + "<a href="#Options">The Options</a>" in parenthesis after the long + name. To add options to your links directly, append the options + separated by a semi-colon. For example + <<a href="http://validator.w3.org/check?uri=http://www.example.com/;ss=1;outline=1;sp=1">http://validator.w3.org/check?uri=http://www.example.com/;ss=1;outline=1;sp=1</a>> + will validate the example.com home page with "Show Source", "Outline" and + "Show Parse Tree" on, but "Exclude Attributes" off. + </p> + <p> + You may also see these separated by ampersands, but this usage is + deprecated and support may be removed at some time in the future. + </p> + <h4 id="API">Calling the validator's API</h4> + <p>The Validator can also be called by programs through its <a href="api.html">API</a>. See full documentation for details.</p> + </div> + + + <div id="Options_Params" class="stb"> + <h3>Options and output formats</h3> + <h4 id="Options">Options and Parameters</h4> <p> In addition to the text field where you enter an URL -- or the file selection field if you are uploading files -- there are a few @@ -97,7 +147,7 @@ is not served with character encoding information. Think of this as a gentler override mechanism.</p> </dd> - <dt><a id="option-doctype" name="option-doctype"></a>Type</dt> + <dt><a id="option-doctype" name="option-doctype"></a>Document Type (Doctype)</dt> <dd> <p>This allows you to <strong>override</strong> the DOCTYPE declaration for you document. You may use this option for test @@ -131,14 +181,14 @@ </dd> - <dt><a id="option-no200" name="option-no200"></a>Validate error pages</dt> + <dt><a id="option-no200" name="option-no200"></a>Validate error pages (<code>no200</code>)</dt> <dd> <p>The Markup Validator will usually tell you if the page you tried to validate could not be retrieved (for example, if the server gave a "404 not found" message. In some circumstances you may want to be able to validate the error page sent by the server. This is the option to use then.</p> </dd> - <dt><a id="option-verbose" name="option-verbose"></a>Verbose Output</dt> + <dt><a id="option-verbose" name="option-verbose"></a>Verbose Output (<code>verbose</code>)</dt> <dd> <p>This option triggers verbose output. Verbose output adds more explanations and suggestions to the validation results, and gives more information on the @@ -147,52 +197,39 @@ unset.</p> </dd> </dl> - <h4>Deprecated options</h4> + <h4 id="Output">Output Options</h4> + <p> + In addition to the HTML output intended for human consumption in a + browser, the Validator has some experimental features to generate + machine parseable output in a few different forms. To enable these + output options, append "<code>;output=<option></code>" to the + URL of the Validation results (an interface for these options will be + provided when they exit the beta stage). + </p> + <dl> + <dt id="output-soap12">Web Service API (<em>NEW</em> in version 0.7.3)</dt> + <dd>Using the SOAP1.2 language over HTTP, this defines a web service with an output similar to the API for + the W3C CSS validator and Feed Validator. The <a href="api">Full documentation</a> for this API is available. + Can be called by using parameter <code>output=soap12</code>. This API is <em>still under development</em>, + and subject to change.</dd> + <dt id="output-earl">EARL/RDF</dt> + <dd>Produces output in the EARL RDF syntax. + Can be called by using parameter <code>output=earl</code>. <em>This output may change or be removed in the future</em>.</dd> + <dt id="output-n3">Notation3 </dt> + <dd>Produces output in the Notation3 RDF syntax. + Can be called by using parameter <code>output=n3</code>. <em>This output may change or be removed in the future</em>.</dd> + <dt id="output-xml">XML (<code>xml</code>)</dt> + <dd>This output option has been deprecated, and will be removed from subsequent versions of the validator. </dd> + </dl> + + <h4 id="deprecated_options">Deprecated options</h4> <p>A number of options once available have been deprecated and are not available any more. This includes the <em>Show parse tree</em> and <em>exclude attributes from the parse tree</em>, as well as <em>Show Esis</em> and <em>Show Raw Errors</em>. </p> - </div> - <div id="Calling" class="stb"> - <h3>Calling/Linking to the Validator</h3> - <p> - You can link directly to the Validator home page, or you can call the - Validator CGI program. The home page is <<a - href="http://validator.w3.org/">http://validator.w3.org/</a>> at - the moment (and for the foreseeable future) and the CGI program can be - reached at <<a - href="http://validator.w3.org/check">http://validator.w3.org/check</a>>. - </p> - <p> - If you call the CGI program with extra path info matching "/referer" - (i.e. <<a href="http://validator.w3.org/check/referer">http://validator.w3.org/check/referer</a>>) - it will fetch the referring document and validate that. This means that - if you embed a link to that URL in your pages, following on that link - will send you the validation results for that page. - </p> - <p> - You can also link to the validation results for a specific page. You do - this by giving "check" an "uri" parameter pointing at the page you want - to validate. For example <<a href="http://validator.w3.org/check?uri=http://www.example.com/">http://validator.w3.org/check?uri=http://www.example.com/</a>> - will validate the www.example.com home page. - </p> - <p> - The various options are listed above in the section - "<a href="#Options">The Options</a>" in parenthesis after the long - name. To add options to your links directly, append the options - separated by a semi-colon. For example - <<a href="http://validator.w3.org/check?uri=http://www.example.com/;ss=1;outline=1;sp=1">http://validator.w3.org/check?uri=http://www.example.com/;ss=1;outline=1;sp=1</a>> - will validate the example.com home page with "Show Source", "Outline" and - "Show Parse Tree" on, but "Exclude Attributes" off. - </p> - <p> - You may also see these separated by ampersands, but this usage is - deprecated and support may be removed at some time in the future. - </p> - </div> <div id="Interpret" class="stb"> <h3>Interpreting the results</h3> @@ -217,134 +254,7 @@ we can validate to see for ourselves. </p> </div> - <div id="Output" class="stb"> - <h3>Output Options</h3> - <p> - In addition to the HTML output intended for human consumption in a - browser, the Validator has some experimental features to generate - machine parseable output in a few different forms. To enable these - output options, append "<code>;output=<option></code>" to the - URL of the Validation results (an interface for these options will be - provided when they exit the beta stage). - </p> - <p class="shout" id="api-warning"> - <strong>These options are experimental!</strong> - The API and output formats are still subject to change without notice and - may well be removed or disabled at any time. <em>You have been warned!</em> - </p> - <dl> - <dt id="output-soap12">Web Service API (<em>NEW</em> in version 0.7.3)</dt> - <dd>Using the SOAP1.2 language over HTTP, this defines a web service with an output similar to the API for - the W3C CSS validator and Feed Validator. The <a href="api">Full documentation</a> for this API is available. - Can be called by using parameter <code>output=soap12</code></dd> - <dt id="output-earl">EARL/RDF</dt> - <dd>Produces output in the EARL RDF syntax. - Can be called by using parameter <code>output=earl</code>.</dd> - <dt id="output-n3">Notation3 </dt> - <dd>Produces output in the Notation3 RDF syntax. - Can be called by using parameter <code>output=n3</code>.</dd> - <dt id="output-xml">XML (<code>xml</code>)</dt> - <dd>This output option has been deprecated, and will be removed from subsequent versions of the validator. </dd> - </dl> - </div> - - <div id="CommaTools"> - <h3>Comma Tools / Site Tools</h3> - <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 URL (address) of any page on the site and trigger - a few administrative or technical tools for this page. </p> - - <p> - <strong>These tools are still under test, and reportedly do not work yet when - appended to a validation result page.</strong> - </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="http://cgi.w3.org/cgi-bin/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> <div id="Installing" class="stb"> <h3>Installing a local Validator</h3> |