- From: Olivier Thereaux via cvs-syncmail <cvsmail@w3.org>
- Date: Fri, 16 Jun 2006 01:41:27 +0000
- To: www-validator-cvs@w3.org
Update of /sources/public/2002/css-validator
In directory hutz:/tmp/cvs-serv10552
Modified Files:
DOWNLOAD.html.en
Log Message:
simplifying installation sequence, removing long part about tomcat install
Index: DOWNLOAD.html.en
===================================================================
RCS file: /sources/public/2002/css-validator/DOWNLOAD.html.en,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -d -r1.7 -r1.8
--- DOWNLOAD.html.en 15 Jun 2006 06:49:36 -0000 1.7
+++ DOWNLOAD.html.en 16 Jun 2006 01:41:25 -0000 1.8
@@ -7,7 +7,8 @@
<link rev="made" href="mailto:www-validator-css@w3.org" />
<link rev="start" href="./" title="Home Page" />
<style type="text/css" media="all">
- @import "base.css";
+ @import "base.css";
+ @import "docs.css";
</style>
<meta name="revision"
content="$Id$" />
@@ -24,146 +25,88 @@
<h2>Download and Install the CSS Validator</h2>
-<h3>Download the CSS Validator</h3>
-<h4>Download as java package (jar or war)</h4>
-<p>TBD... we just need a stable location to put jar/war archives on a regular basis</p>
+<h3 id="download">Download the CSS Validator</h3>
-<h4>Download the source</h4>
+ <h4 id="source">Download the source</h4>
<p>
The <a href='http://dev.w3.org/cvsweb/2002/css-validator'>CSS validator</a> is available for download using CVS.
Follow the <a href='http://dev.w3.org/cvsweb/'>instructions</a> to
access the W3C CVS public server and get 2002/css-validator. Note
- that the online version of the CSS Validator is older than the CVS
- version so we may not have the same results...
+ that the online version of the CSS Validator is generally older than the CVS
+ version so results and appearance may vary slightly...
</p>
+ <h4>Download as java package (jar or war)</h4>
+ <p>TBD... we just need a stable location to put jar/war archives on a regular basis</p>
<h3>Installation guide</h3>
<p>The CSS validation service is a servlet software, written in Java. It may be installed on any servlet engine,
and can also be used as a simple command-line tool.
The official W3C CSS Validation service is running with the Jigsaw server, which is the recommended setup.
However, for the sake of simplicity, we will, in this document, mostly provide details on how to install
-it as an online servlet with Apache's servlet engine TOMCAT.</p>
+it as an online servlet with Apache's servlet engine Tomcat.</p>
<p>Some instructions on installing the servlet with Jigsaw, as well as running it from a command-line environment,
are also given below. </p>
-<h4>Install the CSS Validator with Tomcat</h4>
+<h4 id="prereq">Prerequisites</h4>
-<h5>Install the servlet engine: Tomcat</h5>
-<ul>
- <li>Download Tomcat:
- <ul>
- <li>
- This guide was tested using Apache Tomcat 5.5.16, available at :
- <a href="http://apache.crihan.fr/dist/tomcat/tomcat-5/v5.5.16/bin/apache-tomcat-5.5.16.tar.gz">apache-tomcat-5.5.16.tar.gz</a>.
- </li>
- <li>
- This version need java 1.5, but if you only have java 1.4 you can download a compatibility package :
- <a href="http://apache.crihan.fr/dist/tomcat/tomcat-5/v5.5.16/bin/apache-tomcat-5.5.16-compat.tar.gz">apache-tomcat-5.5.16-compat.tar.gz</a>.
- </li>
- </ul>
- </li>
- <li>Uncompress the Tomcat source:
- <ul>
- <li>
- "tar xvzf <span class="file">apache-tomcat-5.5.16.tar.gz</span>"
- (see <a href="http://w3cstag5:8001/dleroy/doc/tomcat/contenu-tomcat.txt">contenu-tomcat.txt</a>).<br />
- "tar xvzf <span class="file">apache-tomcat-5.5.16-compat.tar.gz</span>"
- (see <a href="http://w3cstag5:8001/dleroy/doc/tomcat/contenu-tomcat-compat.txt">contenu-tomcat-compat.txt</a>).<br />
- Tomcat server now is in <span class="dir">[<span class="const">TOMCAT_DIR</span>]</span>.
- </li>
- </ul>
- </li>
-<li>Test your tomcat installation:
- <ul>
- <li>
- "cd <span class="dir">apache-tomcat-5.5.16</span>; <span class="dir">./bin/</span><span class="file">startup.sh</span>"<br />
- Then in your browser : "<a href="http://localhost:8080/">http://localhost:8080</a>".
- </li>
- </ul>
-</li>
-<li>Configuration:
- <ul>
- <li>
- Open "<span class="dir">conf/</span><span class="file">tomcat-users.xml</span>" and add user manager :
- <span class="balise"><<span class="name">user</span>
- <span class="attr">name</span>=<span class="string">"manager"</span>
- <span class="attr">password</span>=<span class="string">"motdepasse"</span>
- <span class="attr">roles</span>=<span class="string">"manager"</span>
- /></span>.<br />
- To change the service's port open file : "<span class="dir">conf/</span><span class="file">server.xml</span>" and modify
- <span class="balise"><<span class="name">Service</span>
- <span class="attr">name</span>=<span class="string">"Catalina"</span>></span>
- ...
- <span class="balise"><<span class="name">Connector</span>
- <span class="attr">port</span>=<span class="string">"8080"</span> <span class="attr">...</span>></span>
- ... .
- </li>
- <li>
- To check changes you must reload the server.<br />
- In <span class="dir">[<span class="const">TOMCAT_DIR</span>]</span> use
- "<span class="dir">./bin/</span><span class="file">shutdown.sh</span>" then
- "<span class="dir">./bin/</span><span class="file">startup.sh</span>".
- </li>
- </ul>
-</li>
+<p>This installation guide assumes that you have downloaded, installed and tested: </p>
+<ul class="instructions">
+ <li>A working java environment,</li>
+ <li>The <a href="http://ant.apache.org/">Ant</a> java building tool</li>
+ <li>A java Web servlet container such as <a href="http://www.w3.org/Jigsaw/">Jigsaw</a>,
+ <a href="http://www.w3.org/Jigsaw/">Jigsaw</a>, <a href="http://tomcat.apache.org/">Tomcat</a> or
+ <a href="http://www.mortbay.org/">Jetty</a> if you plan on using the validator as an online service.
+ This guide only covers Tomcat and Jigsaw in details.</li>
+</ul>
+<p id="prereq-libs">For the installation of the validator onto your system, you will
+ need to download and/or find in your system a number of java libraries:</p>
+<ul class="instructions">
+ <li>servlet.jar
+ (which, if you have Tomcat installed in [<span class="const">TOMCAT_DIR</span>],
+ you should find in [<span class="const">TOMCAT_DIR</span>]/common/lib/, possibly
+ under the name servlet-api.jar. If not, get it at
+ <a href="http://java.sun.com/products/servlet/download.html">java.sun.com</a></li>
+ <li><a href="http://jigsaw.w3.org/Devel/classes-2.2/20060329/">jigsaw.jar</a></li>
+ <li>xercesImpl.jar and xml-apis.jar (which can be downloaded with
+ <a href="http://www.apache.org/dist/xml/xerces-j/">xerces-j-bin</a>).</li>
</ul>
-<h5>CSS Validator installation</h5>
-<ul>
+<h4>Install the CSS Validator with Tomcat</h4>
+<ol class="instructions">
<li>
- Download validator as explained <a href="#download">above</a>.
+ Download validator as explained <a href="#source">above</a>.
</li>
- <li>
- The Validator's sources are now in <span class="dir">[<span class="const">VALIDATOR_DIR</span>]</span> ("<span class="dir">.../2002/css-validator/</span>").
+ <li>Copy the whole source folder ("<span class="dir">.../css-validator/</span>") to the <span class="dir">webapps</span>
+ directory within your installation of tomcat. usually, this will be
+ <span class="dir">[<span class="const">TOMCAT_DIR</span>]/webapps/</span>.
+ The Validator's sources are now in <span class="dir">[<span class="const">TOMCAT_DIR</span>]/webapps/css-validator</span>,
+ which we will now call <span class="dir">[<span class="const">VALIDATOR_DIR</span>]</span>.
</li>
+ <li>In "<span class="dir">[<span class="const">VALIDATOR_DIR</span>]</span>" create a directory "<span class="dir">WEB-INF</span>".</li>
+ <li>In "<span class="dir">[<span class="const">VALIDATOR_DIR</span>]/WEB-INF</span>" create a directory "<span class="dir">lib</span>".</li>
+ <li>Copy all the jar files (from the <a href="#prereq-libs">prerequisites</a>) to the directory "<span class="dir">[<span class="const">VALIDATOR_DIR</span>]/WEB-INF/lib</span>"</li>
+ <li>Compile the validator's source: from the directory <span class="dir">[<span class="const">VALIDATOR_DIR</span>]</span>,
+ Run <kbd>ant</kbd>, while making sure that the jar files you downloaded are correctly set in you CLASSPATH environment variable.
+ Generally, the following will just work:<br />
+ <kbd>CLASSPATH=.:./WEB-INF/lib:$CLASSPATH ant</kbd>
+ </li>
+ <li>Copy or move "<span class="dir">[<span class="const">VALIDATOR_DIR</span>]/</span><span class="file">css-validator.jar</span>"
+ to "<span class="dir">[<span class="const">VALIDATOR_DIR</span>]/WEB-INF/lib/</span>".</li>
<li>
- In "<span class="dir">[<span class="const">VALIDATOR_DIR</span>]</span>" make a directory "<span class="dir">WEB-INF</span>".<br />
- In "<span class="dir">[<span class="const">VALIDATOR_DIR</span>]/WEB-INF</span>" make a directory "<span class="dir">lib</span>".<br />
- Add the libraries :
- <ol>
- <li>servlet.jar
- (which you should find in [<span class="const">TOMCAT_DIR</span>]/common/lib/, possibly under the name servlet-api.jar. If not, get it at
- <a href="http://java.sun.com/products/servlet/download.html">java.sun.com</a></li>
- <li><a href="http://jigsaw.w3.org/Devel/classes-2.2/20060329/">jigsaw.jar</a></li>
- <li>xercesImpl.jar and xml-apis.jar (which can be downloaded with
- <a href="http://www.apache.org/dist/xml/xerces-j/">xerces-j-bin</a>).</li>
- </ol>
-
- copy all these jar files to the directory
- "<span class="dir">[<span class="const">VALIDATOR_DIR</span>]/WEB-INF/lib</span>"
- and make sure the directory is in your CLASSPATH.
+ Copy or move file "<span class="file">web.xml</span>" from
+ "<span class="dir">[<span class="const">VALIDATOR_DIR</span>]/</span>" to
+ "<span class="dir">[<span class="const">VALIDATOR_DIR</span>]/WEB-INF/</span>".
</li>
- <li>Building the validator's source, css-validator.jar
- <ul>
- <li>"cd <span class="dir">[<span class="const">VALIDATOR_DIR</span>]/</span>; ant;"</li>
- <li>
- Copy or move file "<span class="file">web.xml</span>" from
- "<span class="dir">[<span class="const">VALIDATOR_DIR</span>]/</span>" to
- "<span class="dir">[<span class="const">VALIDATOR_DIR</span>]/WEB-INF/</span>".<br />
- Copy or move file "<span class="dir">[<span class="const">VALIDATOR_DIR</span>]/</span><span class="file">css-validator.jar</span>"
- to "<span class="dir">[<span class="const">VALIDATOR_DIR</span>]/WEB-INF/lib/</span>".<br />
- In "<span class="dir">[<span class="const">TOMCAT_DIR</span>]/webapps</span>" make link named
- "<span class="dir">css-validator</span>" to
- "<span class="dir">[<span class="const">VALIDATOR_DIR</span>]/</span>".<br />
- "ln -s <span class="dir">[<span class="const">VALIDATOR_DIR</span>]/</span> <span class="dir">css-validator</span>".
- </li>
- </ul>
-</li>
-<li>
- Finally, reload the Tomcat server:
- <ul>
- <li>
- "cd <span class="dir">[<span class="const">TOMCAT_DIR</span>]</span>; <span class="dir">./bin/</span><span class="file">shutdown.sh</span>; <span class="dir">./bin/</span><span class="file">startup.sh</span>;".<br />
- Next in your browser "<a href="http://localhost:8080/css-validator/validator.html.en">http://localhost:8080/css-validator/validator.html.en</a>".
- </li>
- </ul>
+ <li>
+ Finally, reload the Tomcat server:<br />
+<kbd>"cd <span class="dir">[<span class="const">TOMCAT_DIR</span>]</span>; <span class="dir">./bin/</span><span class="file">shutdown.sh</span>; <span class="dir">./bin/</span><span class="file">startup.sh</span>;"</kbd>
</li>
-</ul>
+</ol>
<h4>Install on Jigsaw Web Server</h4>
-<ul>
-<li>First, download the source as described above</li>
+<ol class="instructions">
+<li>First, download the source as described above, get the necessary jars, and build the source with <kbd>ant</kbd>.</li>
<li>Then you have to configure the validator home directory (usually this is
css-validator) so that it can work as a servlet container. For this purpose
@@ -181,15 +124,14 @@
<li>Finally, start jigsaw and run the validator. Check which HTML you want to
invoke. Usually your URL will look like this:<br />
http://localhost:8001/css-validator/validator.html</li>
-</ul>
+</ol>
<h3>Command-line usage</h3>
<p>The CSS validator can also be used as a command-line tool, if your computer
-has java installed. Download the css-validator.jar, and run as:</p>
-<pre>
-java -jar css-validator.jar http://www.w3.org/
-</pre>
+has java installed. build the css-validator.jar as explained above, and run as:<br />
+<kbd>java -jar css-validator.jar http://www.w3.org/</kbd>
+</p>
<ul class="navbar" id="menu">
<li><strong><a href="./" title="Home page for the W3C CSS Validation Service">Home</a></strong> <span class="hideme">|</span></li>
Received on Friday, 16 June 2006 01:41:33 UTC