Annotation of 2002/css-validator/DOWNLOAD.html.en, revision 1.11

1.7       ot          1: <?xml version="1.0" encoding="utf-8"?>
                      2: <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
                      3:     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
                      4: <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
                      5: <head>
                      6:   <title>Download and Install the CSS Validator</title>
                      7:   <link rev="made" href="mailto:www-validator-css@w3.org" />
                      8:   <link rev="start" href="./" title="Home Page" />
                      9:   <style type="text/css" media="all">
1.8       ot         10:     @import "base.css";  
                     11:        @import "docs.css";
1.7       ot         12:   </style>
                     13:   <meta name="revision"
1.11    ! ot         14:   content="$Id: DOWNLOAD.html.en,v 1.10 2006/06/22 07:00:29 ot Exp $" />
        !            15:   <!-- SSI Template Version: $Id: DOWNLOAD.html.en,v 1.10 2006/06/22 07:00:29 ot Exp $ -->
1.1       plehegar   16: 
1.7       ot         17: </head>
1.1       plehegar   18: 
1.7       ot         19: <body>
                     20: 
                     21:   <div id="banner">
                     22:     <h1 id="title"><a href="http://www.w3.org/"><img height="48" alt="W3C" id="logo" src="http://www.w3.org/Icons/WWW/w3c_home_nb" /></a>
                     23:     <a href="./"><img src="images/css_validation_service.png" alt="CSS Validation Service" /></a></h1>
                     24:    </div>
                     25: 
                     26: 
                     27: <h2>Download and Install the CSS Validator</h2>
1.8       ot         28: <h3 id="download">Download the CSS Validator</h3>      
1.7       ot         29: 
1.8       ot         30:        <h4 id="source">Download the source</h4>
1.1       plehegar   31:     <p>
                     32:       The <a href='http://dev.w3.org/cvsweb/2002/css-validator'>CSS validator</a> is available for download using CVS.
                     33:       Follow the <a href='http://dev.w3.org/cvsweb/'>instructions</a> to
1.4       plehegar   34:       access the W3C CVS public server and get 2002/css-validator. Note
1.8       ot         35:       that the online version of the CSS Validator is generally older than the CVS
                     36:       version so results and appearance may vary slightly...
1.7       ot         37:     </p>       
1.8       ot         38:        <h4>Download as java package (jar or war)</h4>
                     39:        <p>TBD... we just need a stable location to put jar/war archives on a regular basis</p>
1.7       ot         40: 
                     41: <h3>Installation guide</h3>
                     42: <p>The CSS validation service is a servlet software, written in Java. It may be installed on any servlet engine, 
                     43: and can also be used as a simple command-line tool. 
                     44: The official W3C CSS Validation service is running with the Jigsaw server, which is the recommended setup.
                     45: However, for the sake of simplicity, we will, in this document, mostly provide details on how to install 
1.8       ot         46: it as an online servlet with Apache's servlet engine Tomcat.</p>
1.7       ot         47: 
                     48: <p>Some instructions on installing the servlet with Jigsaw, as well as running it from a command-line environment,
                     49: are also given below. </p>
                     50: 
1.8       ot         51: <h4 id="prereq">Prerequisites</h4>
1.7       ot         52: 
1.8       ot         53: <p>This installation guide assumes that you have downloaded, installed and tested: </p>
                     54: <ul class="instructions">
                     55:        <li>A working java environment,</li>
                     56:        <li>The <a href="http://ant.apache.org/">Ant</a> java building tool</li>
1.9       ot         57:        <li>A java Web servlet container such as 
1.8       ot         58:                <a href="http://www.w3.org/Jigsaw/">Jigsaw</a>, <a href="http://tomcat.apache.org/">Tomcat</a> or
                     59:                <a href="http://www.mortbay.org/">Jetty</a> if you plan on using the validator as an online service. 
                     60:                This guide only covers Tomcat and Jigsaw in details.</li>
                     61: </ul>
                     62: <p id="prereq-libs">For the installation of the validator onto your system, you will 
                     63:        need to download and/or find in your system a number of java libraries:</p>
                     64: <ul class="instructions">
                     65:        <li>servlet.jar
                     66:        (which, if you have Tomcat installed in [<span class="const">TOMCAT_DIR</span>],
                     67:         you should find in [<span class="const">TOMCAT_DIR</span>]/common/lib/, possibly 
                     68:        under the name servlet-api.jar. If not, get it at 
                     69:        <a href="http://java.sun.com/products/servlet/download.html">java.sun.com</a></li>
                     70:        <li><a href="http://jigsaw.w3.org/Devel/classes-2.2/20060329/">jigsaw.jar</a></li>
                     71:        <li>xercesImpl.jar and xml-apis.jar (which can be downloaded with
                     72:        <a href="http://www.apache.org/dist/xml/xerces-j/">xerces-j-bin</a>).</li>
1.7       ot         73: </ul>
                     74: 
1.8       ot         75: <h4>Install the CSS Validator with Tomcat</h4>
                     76: <ol class="instructions">
1.7       ot         77:        <li>
1.8       ot         78:                Download validator as explained <a href="#source">above</a>.
                     79:        </li>
                     80:        <li>Copy the whole source folder  ("<span class="dir">.../css-validator/</span>") to the <span class="dir">webapps</span>
                     81:                directory within your installation of tomcat. usually, this will be 
                     82:                <span class="dir">[<span class="const">TOMCAT_DIR</span>]/webapps/</span>.
                     83:                The Validator's sources are now in <span class="dir">[<span class="const">TOMCAT_DIR</span>]/webapps/css-validator</span>,
                     84:                which we will now call <span class="dir">[<span class="const">VALIDATOR_DIR</span>]</span>.
1.7       ot         85:        </li>
1.10      ot         86:        <li>In "<span class="dir">[<span class="const">VALIDATOR_DIR</span>]</span>" create a directory "<span class="dir">WEB-INF</span>", and In "<span class="dir">[<span class="const">VALIDATOR_DIR</span>]/WEB-INF</span>" create a directory "<span class="dir">lib</span>":<br />
                     87:                <kbd>mkdir -p WEB-INF/lib</kbd>
                     88:                </li>
1.8       ot         89:        <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>
                     90:        <li>Compile the validator's source: from the directory <span class="dir">[<span class="const">VALIDATOR_DIR</span>]</span>,
                     91:                Run <kbd>ant</kbd>, while making sure that the jar files you downloaded are correctly set in you CLASSPATH environment variable. 
                     92:                Generally, the following will just work:<br />
                     93:                <kbd>CLASSPATH=.:./WEB-INF/lib:$CLASSPATH ant</kbd>
1.7       ot         94:        </li>
1.8       ot         95:        <li>Copy or move "<span class="dir">[<span class="const">VALIDATOR_DIR</span>]/</span><span class="file">css-validator.jar</span>"
                     96:        to "<span class="dir">[<span class="const">VALIDATOR_DIR</span>]/WEB-INF/lib/</span>".</li>
1.7       ot         97:        <li>
1.8       ot         98:                Copy or move file "<span class="file">web.xml</span>" from
                     99:                "<span class="dir">[<span class="const">VALIDATOR_DIR</span>]/</span>" to
                    100:                "<span class="dir">[<span class="const">VALIDATOR_DIR</span>]/WEB-INF/</span>".
1.7       ot        101:        </li>
1.8       ot        102:     <li>
                    103:                Finally, reload the Tomcat server:<br />
                    104: <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>
1.7       ot        105:        </li>
1.8       ot        106: </ol>
1.7       ot        107: 
                    108: <h4>Install on Jigsaw Web Server</h4>
1.8       ot        109: <ol class="instructions">
                    110: <li>First, download the source as described above, get the necessary jars, and build the source with <kbd>ant</kbd>.</li>
1.7       ot        111: 
                    112: <li>Then you have to configure the validator home directory (usually this is
                    113: css-validator) so that it can work as a servlet container. For this purpose
                    114: you need to have Jigsaw installed (see the Jigsaw pages for a short
                    115: instruction (it is really easy)) and then start Jigsaw Admin. Change the
                    116: HTTPFrame to ServletDirectoryFrame.</li>
                    117: 
                    118: <li>The next step is to create a resource "validator", with as class
                    119: 'ServletWrapper' and as frame 'ServletWrapperFrame'. The latter should add
                    120: itself automagically. The class of the servlet is
                    121: org.w3c.css.servlet.CssValidator. If there already exists a file named
                    122: 'validator', please rename it. It is important that this 'alias' is always
                    123: named 'validator'.</li>
                    124: 
                    125: <li>Finally, start jigsaw and run the validator. Check which HTML you want to
                    126: invoke. Usually your URL will look like this:<br />
                    127: http://localhost:8001/css-validator/validator.html</li>
1.8       ot        128: </ol>
1.7       ot        129: 
                    130: <h3>Command-line usage</h3>
                    131: 
                    132: <p>The CSS validator can also be used as a command-line tool, if your computer
1.8       ot        133: has java installed. build the css-validator.jar as explained above, and run as:<br />
                    134: <kbd>java -jar css-validator.jar http://www.w3.org/</kbd>
                    135: </p>
1.7       ot        136: 
                    137:    <ul class="navbar"  id="menu">
                    138:        <li><strong><a href="./" title="Home page for the W3C CSS Validation Service">Home</a></strong> <span class="hideme">|</span></li>
1.11    ! ot        139:        <li><a href="about.html" title="About this service">About</a> <span class="hideme">|</span></li>
1.7       ot        140: 
1.11    ! ot        141:         <li><a href="documentation.html" title="Documentation for the W3C CSS Validation Service">Documentation</a> <span class="hideme">|</span></li>
        !           142:         <li><a href="Email.html" title="How to provide feedback on this service">Feedback</a> <span class="hideme">|</span></li>
        !           143:         <li><a href="thanks.html" title="Credits and Acknowlegments">Credits</a><span class="hideme">|</span></li>
1.7       ot        144: 
                    145:       </ul>
                    146: 
                    147:    <p id="activity_logos">
                    148:       <a href="http://www.w3.org/QA/" title="W3C's Quality Assurance Activity, bringing you free Web quality tools and more"><img src="http://www.w3.org/QA/2002/12/qa-small.png" alt="QA" /></a><a href="http://www.w3.org/Style/CSS/learning" title="Learn more about Cascading Style Sheets"><img src="images/woolly-icon" alt="CSS" /></a>
                    149:    </p>
                    150: 
                    151:    <p id="support_logo">
                    152: Support this tool, become a<br />
                    153: <a href="http://www.w3.org/Consortium/supporters"><img src="http://www.w3.org/Consortium/supporter-logos/csupporter.png" alt="W3C Supporter" /></a>
                    154:    </p>
                    155: 
                    156:     <p class="copyright">
                    157:       <a rel="Copyright" href="http://www.w3.org/Consortium/Legal/ipr-notice#Copyright">Copyright</a> &copy; 1994-2006
                    158:       <a href="http://www.w3.org/"><acronym title="World Wide Web Consortium">W3C</acronym></a>&reg;
                    159: 
                    160:       (<a href="http://www.csail.mit.edu/"><acronym title="Massachusetts Institute of Technology">MIT</acronym></a>,
                    161:       <a href="http://www.ercim.org/"><acronym title="European Research Consortium for Informatics and Mathematics">ERCIM</acronym></a>,
                    162:       <a href="http://www.keio.ac.jp/">Keio</a>),
                    163:       All Rights Reserved.
                    164:       W3C <a href="http://www.w3.org/Consortium/Legal/ipr-notice#Legal_Disclaimer">liability</a>,
                    165:       <a href="http://www.w3.org/Consortium/Legal/ipr-notice#W3C_Trademarks">trademark</a>,
                    166:       <a rel="Copyright" href="http://www.w3.org/Consortium/Legal/copyright-documents">document use</a>
                    167: 
                    168:       and <a rel="Copyright" href="http://www.w3.org/Consortium/Legal/copyright-software">software licensing</a>
                    169: 
                    170:       rules apply. Your interactions with this site are in accordance
                    171:       with our <a href="http://www.w3.org/Consortium/Legal/privacy-statement#Public">public</a> and
                    172:       <a href="http://www.w3.org/Consortium/Legal/privacy-statement#Members">Member</a> privacy
                    173:       statements.
1.4       plehegar  174:     </p>
1.7       ot        175: 
                    176: 
1.1       plehegar  177:   </body>
1.7       ot        178: 
1.1       plehegar  179: </html>
1.7       ot        180: 
                    181: 
                    182: 
                    183: 

Webmaster