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

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

Webmaster