diff options
Diffstat (limited to 'htdocs/docs')
| -rwxr-xr-x | htdocs/docs/errors.html | 6 | ||||
| -rwxr-xr-x | htdocs/docs/help.html | 12 | ||||
| -rwxr-xr-x | htdocs/docs/install.html | 78 | ||||
| -rwxr-xr-x | htdocs/docs/users.html | 12 | ||||
| -rwxr-xr-x | htdocs/docs/why.html | 6 |
5 files changed, 68 insertions, 46 deletions
diff --git a/htdocs/docs/errors.html b/htdocs/docs/errors.html index 43606d1..55184c1 100755 --- a/htdocs/docs/errors.html +++ b/htdocs/docs/errors.html @@ -1,5 +1,5 @@ -<!--#set var="revision" value="\$Id: errors.html,v 1.27 2004-05-09 15:56:50 link Exp $" ---><!--#set var="date" value="\$Date: 2004-05-09 15:56:50 $" +<!--#set var="revision" value="\$Id: errors.html,v 1.28 2004-07-21 15:07:10 link Exp $" +--><!--#set var="date" value="\$Date: 2004-07-21 15:07:10 $" --><!--#set var="title" value="Error Explanations for The W3C Markup Validation Service" --><!--#set var="relroot" value="../" --><!--#include virtual="../header.html" --> @@ -504,7 +504,7 @@ <ul> <li> <p> - A reference to a <abbr title="Uniform Resource Identifier">URI</abbr> + A reference to a <abbr title="Uniform Resource Locator">URL</abbr> that uses "<code class="inline">&</code>" as a separator between parameters, such as "<code class="inline">http://example.com/cgi-bin/prog?x=1&y=2</code>". diff --git a/htdocs/docs/help.html b/htdocs/docs/help.html index 5f5bba9..9a29828 100755 --- a/htdocs/docs/help.html +++ b/htdocs/docs/help.html @@ -1,5 +1,5 @@ -<!--#set var="revision" value="\$Id: help.html,v 1.15 2004-05-09 15:56:50 link Exp $" ---><!--#set var="date" value="\$Date: 2004-05-09 15:56:50 $" +<!--#set var="revision" value="\$Id: help.html,v 1.16 2004-07-21 15:07:10 link Exp $" +--><!--#set var="date" value="\$Date: 2004-07-21 15:07:10 $" --><!--#set var="title" value="Help for The W3C Markup Validation Service" --><!--#set var="relroot" value="../" --><!--#include virtual="../header.html" --> @@ -91,7 +91,7 @@ mailing-list.</p> </li> <li> <a href="#faq-referer">/check/referer does not work</a> or the validator says it does not support - my <a href="#faq-referer">"undefined" URI scheme</a> + my <a href="#faq-referer">"undefined" URL scheme</a> </li> </ul> </li> @@ -452,7 +452,7 @@ of WDG's excellent </p> <h4 id="faq-referer">/check/referer does not work - or - the validator says it does not support - my "undefined" URI scheme</h4> + my "undefined" URL scheme</h4> <p>Browsers and other Web agents usually send information about the page they come from, in a <code>Referer</code> header. The validator uses this information for a features that allows @@ -461,8 +461,8 @@ of WDG's excellent <p>Unfortunately, some zealous "security software" or Web proxies strip the referrer information from what the browser sends. Without this information the validator is not able to - find what the URI of the document to validate is, and gives the same error message as when it is - given a type of URI it does not understand.</p> + find what the URL of the document to validate is, and gives the same error message as when it is + given a type of URL it does not understand.</p> <p><strong>How to fix</strong>:</p> <ul> diff --git a/htdocs/docs/install.html b/htdocs/docs/install.html index 7f49476..ceba820 100755 --- a/htdocs/docs/install.html +++ b/htdocs/docs/install.html @@ -1,5 +1,5 @@ -<!--#set var="revision" value="\$Id: install.html,v 1.2 2004-05-09 15:56:50 link Exp $" ---><!--#set var="date" value="\$Date: 2004-05-09 15:56:50 $" +<!--#set var="revision" value="\$Id: install.html,v 1.3 2004-07-21 15:07:10 link Exp $" +--><!--#set var="date" value="\$Date: 2004-07-21 15:07:10 $" --><!--#set var="title" value="Installation Documentation for The W3C Markup Validation Service" --><!--#set var="relroot" value="../" --><!--#include virtual="../header.html" --> @@ -23,6 +23,7 @@ </ul> </li> <li><a href="#install-troubleshoot">Installation troubleshooting</a></li> + <li><a href="#post-install">Post-install options</a></li> <li><a href="#credits">Credits and Acknowledgments</a></li> </ul> </div> @@ -67,10 +68,10 @@ <p> Apart from a properly configured Web server, the Validator needs a - SGML parser -- that does all the hard work -- and several Perl - modules used by the "check" CGI script. + SGML parser -- that does all the hard work --, Perl (version 5.6.0 + or newer) and several Perl modules used by the "check" CGI script. </p> - <h5>SGML Parser: Open SP</h5> + <h5>SGML Parser: OpenSP</h5> <p> The SGML parser we're currently using is <code>OpenSP 1.5</code>, which can be found on the @@ -85,44 +86,57 @@ can be found on <a href="http://www.cpan.org/">CPAN</a> (minimum versions in parenthesis after the name). The following list was complete when CVS spit out: - <code>$Date: 2004-05-09 15:56:50 $</code>. <tt>:-)</tt> + <code>$Date: 2004-07-21 15:07:10 $</code>. <tt>:-)</tt> </p> - <p>One easy - and strongly recommended - way to take care of all these Perl module dependencies is to - install the <a href="http://search.cpan.org/dist/Bundle-W3C-Validator/">bundle available through CPAN</a> - as Bundle-W3C-Validator.</p> + <p> + One easy - and strongly recommended - way to take care of all these + Perl module dependencies is to install + <a href="http://search.cpan.org/dist/Bundle-W3C-Validator/">Bundle-W3C-Validator</a> + from CPAN. See the <a href="http://search.cpan.org/dist/Bundle-W3C-Validator/lib/Bundle/W3C/Validator.pm">documentation included with it</a> + for more details. + </p> - <h5>List of required Perl modules</h5> + <h5>List of required Perl module distributions</h5> <dl> - <dt><code>CGI (2.81)</code></dt> + <dt><a href="http://search.cpan.org/dist/CGI.pm/">CGI.pm</a> >= 2.81</dt> <dd> The all-singing, all-dancing, everything-<em>and</em>-the-kitchen-sink, Perl CGI library. This takes care of all those niggly little bits of CGI for us and make options parsing and file upload a breeze. </dd> - <dt><code>CGI::Carp</code></dt> - <dd>CGI-aware warn()/die()</dd> - <dt><code>File::Spec</code></dt> - <dd>Portable file and path name operations.</dd> - <dt><code>HTML::Parser (3.25)</code></dt> - <dd>Minimal HTML Parser used for preparse and finding metadata.</dd> - <dt><code>LWP::UserAgent (1.90)</code></dt> + <dt><a href="http://search.cpan.org/dist/Config-General/">Config-General</a></dt> + <dd> + Configuration file handling. + </dd> + <dt><a href="http://search.cpan.org/dist/HTML-Parser/">HTML-Parser</a> >= 3.25</dt> + <dd> + Minimal HTML parser used for preparse and finding metadata. + </dd> + <dt><a href="http://search.cpan.org/dist/libwww-perl/">libwww-perl</a> >= 5.60</dt> <dd> Gisle Aas' most excellent WWW library for Perl. This is where our support for downloading pages off the net comes from. </dd> - <dt><code>Set::IntSpan</code></dt><dd>Efficient Set operations.</dd> - <dt><code>Text::Iconv</code></dt> + <dt><a href="http://search.cpan.org/dist/Net-IP/">Net-IP</a></dt> + <dd> + IP address manipulation. + </dd> + <dt><a href="http://search.cpan.org/dist/Set-IntSpan/">Set-IntSpan</a></dt> + <dd> + Efficient set operations. + </dd> + <dt><a href="http://search.cpan.org/dist/Text-Iconv/">Text-Iconv</a></dt> <dd> Perl-native interface to the (g)libc iconv(3) library. Handles character set conversion issues. </dd> - <dt><code>Text::Wrap</code></dt> - <dd>Wrap text to a sane width. Needed for source output in results.</dd> - <dt><code>URI::Escape</code></dt> - <dd>Module to handle escaping special characters in URIs.</dd> + <dt><a href="http://search.cpan.org/dist/URI/">URI</a></dt> + <dd> + Library to handle URIs and escaping special characters in them. + </dd> </dl> <h4><a id="install-components" name="install-components"></a>Install the various necessary components:</h4> @@ -167,8 +181,8 @@ <dl> <dt>eref.cfg</dt> <dd> - Contains the mappings from element names to an URI fragment - (relative to a configurable URI) for their definitions. Used + Contains the mappings from element names to an URL fragment + (relative to a configurable URL) for their definitions. Used in output when the "Show Source Input" option is enabled. </dd> <dt>fpis.cfg</dt> @@ -177,7 +191,7 @@ </dd> <dt>frag.cfg</dt> <dd> - Maps error messages to an URI fragment identifier where an + Maps error messages to an URL fragment identifier where an explanation of that error can be found. </dd> <dt>type.cfg</dt> @@ -274,7 +288,7 @@ <h4>The miracle debug options</h4> <p>If the validator is misbehaving, you can try forcing various debug options by appending to - the URI the following string: <kbd>&debug=1&errors=1&esis=1&verbose=1</kbd></p> + the URL the following string: <kbd>&debug=1&errors=1&esis=1&verbose=1</kbd></p> <p>This can sometimes provide you with error messages that would not have appeared anywhere in non-debug mode, and can be helpful to diagnose the problem</p> @@ -283,6 +297,14 @@ <p>Don't hesitate to contact the public mailing-list www-validator@w3.org with all the details you can provide on what you did, tried, and what went wrong...</p> + <h3 id="post-install">Post-install options</h3> + <p>if the installation succeeded, you should be able to now use the Markup Validator on your own + system and network. You may want to give the validator a look and feel specific to your Web site. + The easiest way to achieve this is to edit <code>header.html</code> and <code>footer.html</code> + (in the <code>htdocs</code> directory), the header and footer markup snippets used to build all + pages for the validator.</p><p> You may also edit the Style Sheets (in the same directory), + especially <code>base.css</code> You may however want to avoid editing the other CSS files too + heavily, there is a risk you could make the output of the validator unusable.</p> </div> <div id="credits" class="stb"> diff --git a/htdocs/docs/users.html b/htdocs/docs/users.html index 1cd6f6f..0ecaea4 100755 --- a/htdocs/docs/users.html +++ b/htdocs/docs/users.html @@ -1,5 +1,5 @@ -<!--#set var="revision" value="\$Id: users.html,v 1.18 2004-05-09 15:56:50 link Exp $" ---><!--#set var="date" value="\$Date: 2004-05-09 15:56:50 $" +<!--#set var="revision" value="\$Id: users.html,v 1.19 2004-07-21 15:07:10 link Exp $" +--><!--#set var="date" value="\$Date: 2004-07-21 15:07:10 $" --><!--#set var="title" value="User Documentation for The W3C Markup Validation Service" --><!--#set var="relroot" value="../" --><!--#include virtual="../header.html" --> @@ -215,7 +215,7 @@ 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 - URI of the Validation results (an interface for these options will be + 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"> @@ -288,7 +288,7 @@ </p> <dl> <dt><code>uri</code></dt> - <dd>The URI of the document validated.</dd> + <dd>The URL of the document validated.</dd> <dt><code>modified</code></dt> <dd>The Last-Modified header field of the document as free-form text.</dd> <dt><code>server</code></dt> @@ -340,7 +340,7 @@ <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 + 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> @@ -360,7 +360,7 @@ A plain text version of the page. </td> <td class="comma-tool"> - <a href="http://www.w3.org/Web/Tools/html2txt">HTML2Text</a> + <a href="http://cgi.w3.org/cgi-bin/html2txt">HTML2Text</a> </td> <td class="comma-shortcut"> ,text diff --git a/htdocs/docs/why.html b/htdocs/docs/why.html index 40d4281..e594ec1 100755 --- a/htdocs/docs/why.html +++ b/htdocs/docs/why.html @@ -1,9 +1,9 @@ -<!--#set var="revision" value="\$Id: why.html,v 1.7 2004-05-09 15:56:50 link Exp $" ---><!--#set var="date" value="\$Date: 2004-05-09 15:56:50 $" +<!--#set var="revision" value="\$Id: why.html,v 1.8 2004-07-21 15:07:10 link Exp $" +--><!--#set var="date" value="\$Date: 2004-07-21 15:07:10 $" --><!--#set var="title" value="Why Validate?" --><!--#set var="relroot" value="../" --><!--#include virtual="../header.html" --> - <div id="skip" name="skip" class="colophon"> + <div id="skip" class="colophon"> <h2>Why Validate?</h2> <p> This document attempts to answer the questions many people have |