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

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.12      ot         10:     @import "style/base.css";  
1.14      ot         11:     @import "style/docs.css";
1.7       ot         12:   </style>
                     13:   <meta name="revision"
1.17    ! ot         14:   content="$Id: DOWNLOAD.html.en,v 1.16 2007/01/31 05:58:56 ot Exp $" />
        !            15:   <!-- SSI Template Version: $Id: DOWNLOAD.html.en,v 1.16 2007/01/31 05:58:56 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>
1.15      ot         39: <!--   <p>TBD... we just need a stable location to put jar/war archives on a regular basis</p>-->
                     40:        <p><a href="http://www.w3.org/QA/Tools/css-validator/css-validator.jar">css-validator.jar</a></p>
                     41: 
1.7       ot         42: 
                     43: <h3>Installation guide</h3>
                     44: <p>The CSS validation service is a servlet software, written in Java. It may be installed on any servlet engine, 
                     45: and can also be used as a simple command-line tool. 
                     46: The official W3C CSS Validation service is running with the Jigsaw server, which is the recommended setup.
                     47: However, for the sake of simplicity, we will, in this document, mostly provide details on how to install 
1.8       ot         48: it as an online servlet with Apache's servlet engine Tomcat.</p>
1.7       ot         49: 
                     50: <p>Some instructions on installing the servlet with Jigsaw, as well as running it from a command-line environment,
                     51: are also given below. </p>
                     52: 
1.8       ot         53: <h4 id="prereq">Prerequisites</h4>
1.7       ot         54: 
1.8       ot         55: <p>This installation guide assumes that you have downloaded, installed and tested: </p>
                     56: <ul class="instructions">
                     57:        <li>A working java environment,</li>
                     58:        <li>The <a href="http://ant.apache.org/">Ant</a> java building tool</li>
1.9       ot         59:        <li>A java Web servlet container such as 
1.8       ot         60:                <a href="http://www.w3.org/Jigsaw/">Jigsaw</a>, <a href="http://tomcat.apache.org/">Tomcat</a> or
                     61:                <a href="http://www.mortbay.org/">Jetty</a> if you plan on using the validator as an online service. 
                     62:                This guide only covers Tomcat and Jigsaw in details.</li>
                     63: </ul>
                     64: <p id="prereq-libs">For the installation of the validator onto your system, you will 
                     65:        need to download and/or find in your system a number of java libraries:</p>
                     66: <ul class="instructions">
                     67:        <li>servlet.jar
                     68:        (which, if you have Tomcat installed in [<span class="const">TOMCAT_DIR</span>],
1.16      ot         69:         you should find in [<span class="const">TOMCAT_DIR</span>]/common/lib/) possibly 
1.8       ot         70:        under the name servlet-api.jar. If not, get it at 
                     71:        <a href="http://java.sun.com/products/servlet/download.html">java.sun.com</a></li>
                     72:        <li><a href="http://jigsaw.w3.org/Devel/classes-2.2/20060329/">jigsaw.jar</a></li>
                     73:        <li>xercesImpl.jar and xml-apis.jar (which can be downloaded with
                     74:        <a href="http://www.apache.org/dist/xml/xerces-j/">xerces-j-bin</a>).</li>
1.17    ! ot         75:        <li><a href="http://ccil.org/~cowan/XML/tagsoup/">tagsoup.jar</a></li>
1.7       ot         76: </ul>
                     77: 
1.8       ot         78: <h4>Install the CSS Validator with Tomcat</h4>
                     79: <ol class="instructions">
1.7       ot         80:        <li>
1.8       ot         81:                Download validator as explained <a href="#source">above</a>.
                     82:        </li>
                     83:        <li>Copy the whole source folder  ("<span class="dir">.../css-validator/</span>") to the <span class="dir">webapps</span>
1.16      ot         84:                directory within your installation of Tomcat. usually, this will be 
1.8       ot         85:                <span class="dir">[<span class="const">TOMCAT_DIR</span>]/webapps/</span>.
                     86:                The Validator's sources are now in <span class="dir">[<span class="const">TOMCAT_DIR</span>]/webapps/css-validator</span>,
                     87:                which we will now call <span class="dir">[<span class="const">VALIDATOR_DIR</span>]</span>.
1.7       ot         88:        </li>
1.10      ot         89:        <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 />
                     90:                <kbd>mkdir -p WEB-INF/lib</kbd>
                     91:                </li>
1.8       ot         92:        <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>
                     93:        <li>Compile the validator's source: from the directory <span class="dir">[<span class="const">VALIDATOR_DIR</span>]</span>,
                     94:                Run <kbd>ant</kbd>, while making sure that the jar files you downloaded are correctly set in you CLASSPATH environment variable. 
                     95:                Generally, the following will just work:<br />
                     96:                <kbd>CLASSPATH=.:./WEB-INF/lib:$CLASSPATH ant</kbd>
1.7       ot         97:        </li>
1.8       ot         98:        <li>Copy or move "<span class="dir">[<span class="const">VALIDATOR_DIR</span>]/</span><span class="file">css-validator.jar</span>"
                     99:        to "<span class="dir">[<span class="const">VALIDATOR_DIR</span>]/WEB-INF/lib/</span>".</li>
1.7       ot        100:        <li>
1.8       ot        101:                Copy or move file "<span class="file">web.xml</span>" from
                    102:                "<span class="dir">[<span class="const">VALIDATOR_DIR</span>]/</span>" to
                    103:                "<span class="dir">[<span class="const">VALIDATOR_DIR</span>]/WEB-INF/</span>".
1.7       ot        104:        </li>
1.8       ot        105:     <li>
                    106:                Finally, reload the Tomcat server:<br />
                    107: <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        108:        </li>
1.8       ot        109: </ol>
1.7       ot        110: 
                    111: <h4>Install on Jigsaw Web Server</h4>
1.8       ot        112: <ol class="instructions">
                    113: <li>First, download the source as described above, get the necessary jars, and build the source with <kbd>ant</kbd>.</li>
1.7       ot        114: 
                    115: <li>Then you have to configure the validator home directory (usually this is
                    116: css-validator) so that it can work as a servlet container. For this purpose
                    117: you need to have Jigsaw installed (see the Jigsaw pages for a short
                    118: instruction (it is really easy)) and then start Jigsaw Admin. Change the
                    119: HTTPFrame to ServletDirectoryFrame.</li>
                    120: 
                    121: <li>The next step is to create a resource "validator", with as class
                    122: 'ServletWrapper' and as frame 'ServletWrapperFrame'. The latter should add
                    123: itself automagically. The class of the servlet is
                    124: org.w3c.css.servlet.CssValidator. If there already exists a file named
                    125: 'validator', please rename it. It is important that this 'alias' is always
                    126: named 'validator'.</li>
                    127: 
1.16      ot        128: <li>Finally, start Jigsaw and run the validator. Check which HTML you want to
1.7       ot        129: invoke. Usually your URL will look like this:<br />
                    130: http://localhost:8001/css-validator/validator.html</li>
1.8       ot        131: </ol>
1.7       ot        132: 
                    133: <h3>Command-line usage</h3>
                    134: 
                    135: <p>The CSS validator can also be used as a command-line tool, if your computer
1.8       ot        136: has java installed. build the css-validator.jar as explained above, and run as:<br />
                    137: <kbd>java -jar css-validator.jar http://www.w3.org/</kbd>
                    138: </p>
1.7       ot        139: 
                    140:    <ul class="navbar"  id="menu">
                    141:        <li><strong><a href="./" title="Home page for the W3C CSS Validation Service">Home</a></strong> <span class="hideme">|</span></li>
1.11      ot        142:        <li><a href="about.html" title="About this service">About</a> <span class="hideme">|</span></li>
1.7       ot        143: 
1.11      ot        144:         <li><a href="documentation.html" title="Documentation for the W3C CSS Validation Service">Documentation</a> <span class="hideme">|</span></li>
                    145:         <li><a href="Email.html" title="How to provide feedback on this service">Feedback</a> <span class="hideme">|</span></li>
                    146:         <li><a href="thanks.html" title="Credits and Acknowlegments">Credits</a><span class="hideme">|</span></li>
1.7       ot        147: 
                    148:       </ul>
1.13      ot        149:  
                    150:       <ul id="lang_choice">
                    151:            <li><a href="DOWNLOAD.html.de"
                    152:                lang="de"
                    153:                xml:lang="de"
                    154:                hreflang="de"
                    155:                rel="alternate">Deutsch</a></li>
                    156:            <li><a href="DOWNLOAD.html.en"
                    157:                lang="en"
                    158:                xml:lang="en"
                    159:            hreflang="en"
                    160:            rel="alternate">English</a>  </li>
                    161:            <li><a href="DOWNLOAD.html.es"
                    162:            lang="es" xml:lang="es" hreflang="es"
                    163:            rel="alternate">Español</a></li>
                    164:            <li><a href="DOWNLOAD.html.fr"
                    165:            lang="fr"
                    166:            xml:lang="fr"
                    167:            hreflang="fr"
                    168:            rel="alternate">Français</a> </li>
                    169:            <li><a href="DOWNLOAD.html.it"
                    170:                lang="it"
                    171:                xml:lang="it"
                    172:                hreflang="it"
                    173:                rel="alternate">Italiano</a> </li>
                    174:            <li><a href="DOWNLOAD.html.nl"
                    175:                lang="nl"
                    176:                xml:lang="nl"
                    177:                hreflang="nl"
                    178:                rel="alternate">Nederlands</a> </li>
                    179:            <li><a href="DOWNLOAD.html.ja"
                    180:                lang="ja"
                    181:                xml:lang="ja"
                    182:                hreflang="ja"
                    183:                rel="alternate">日本語</a> </li>
                    184:            <li><a href="DOWNLOAD.html.pl-PL"
                    185:                lang="pl"
                    186:                xml:lang="pl"
                    187:                hreflang="pl"
                    188:                rel="alternate">Polski</a> </li>
                    189:            <li><a href="DOWNLOAD.html.zh-cn"
                    190:                lang="zh-hans"
                    191:                xml:lang="zh-hans"
                    192:                hreflang="zh-hans"
                    193:                rel="alternate">中文</a></li>
                    194:       </ul>
                    195: 
1.7       ot        196: 
                    197:    <p id="activity_logos">
                    198:       <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>
                    199:    </p>
                    200: 
                    201:    <p id="support_logo">
                    202: Support this tool, become a<br />
                    203: <a href="http://www.w3.org/Consortium/supporters"><img src="http://www.w3.org/Consortium/supporter-logos/csupporter.png" alt="W3C Supporter" /></a>
                    204:    </p>
                    205: 
                    206:     <p class="copyright">
                    207:       <a rel="Copyright" href="http://www.w3.org/Consortium/Legal/ipr-notice#Copyright">Copyright</a> &copy; 1994-2006
                    208:       <a href="http://www.w3.org/"><acronym title="World Wide Web Consortium">W3C</acronym></a>&reg;
                    209: 
                    210:       (<a href="http://www.csail.mit.edu/"><acronym title="Massachusetts Institute of Technology">MIT</acronym></a>,
                    211:       <a href="http://www.ercim.org/"><acronym title="European Research Consortium for Informatics and Mathematics">ERCIM</acronym></a>,
                    212:       <a href="http://www.keio.ac.jp/">Keio</a>),
                    213:       All Rights Reserved.
                    214:       W3C <a href="http://www.w3.org/Consortium/Legal/ipr-notice#Legal_Disclaimer">liability</a>,
                    215:       <a href="http://www.w3.org/Consortium/Legal/ipr-notice#W3C_Trademarks">trademark</a>,
                    216:       <a rel="Copyright" href="http://www.w3.org/Consortium/Legal/copyright-documents">document use</a>
                    217: 
                    218:       and <a rel="Copyright" href="http://www.w3.org/Consortium/Legal/copyright-software">software licensing</a>
                    219: 
                    220:       rules apply. Your interactions with this site are in accordance
                    221:       with our <a href="http://www.w3.org/Consortium/Legal/privacy-statement#Public">public</a> and
                    222:       <a href="http://www.w3.org/Consortium/Legal/privacy-statement#Members">Member</a> privacy
                    223:       statements.
1.4       plehegar  224:     </p>
1.7       ot        225: 
                    226: 
1.1       plehegar  227:   </body>
1.7       ot        228: 
1.1       plehegar  229: </html>
1.7       ot        230: 
                    231: 
                    232: 
                    233: 

Webmaster