diff options
Diffstat (limited to 'htdocs/docs/install.html')
| -rwxr-xr-x | htdocs/docs/install.html | 78 |
1 files changed, 50 insertions, 28 deletions
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"> |