Annotation of 2002/css-validator/manual.html.en, revision 1.21

1.1       ot          1: <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
                      2:     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
                      3: <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
                      4: <head>
1.18      ot          5:   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
1.1       ot          6:   <title>CSS Validator User Manual</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.3       ot         10:     @import "style/base.css";    
                     11:     @import "style/docs.css";
1.1       ot         12:   </style>
                     13:   <meta name="revision"
1.21    ! ylafon     14:   content="$Id: manual.html.en,v 1.20 2009-03-25 20:13:53 ot Exp $" />
        !            15:   <!-- SSI Template Version: $Id: manual.html.en,v 1.20 2009-03-25 20:13:53 ot Exp $ -->
1.1       ot         16: </head>
                     17: 
                     18: <body>
                     19:   <div id="banner">
1.7       ot         20:    <h1 id="title"><a href="http://www.w3.org/"><img alt="W3C" width="110" height="61" id="logo" src="./images/w3c.png" /></a>
                     21:    <a href="./"><span>CSS Validation Service</span></a></h1>
                     22:    <p id="tagline">
                     23:      Check Cascading Style Sheets (CSS) and (X)HTML documents with style sheets
                     24:    </p>
                     25:   </div>
1.1       ot         26: 
                     27: <div id="main">
                     28: <!-- This DIV encapsulates everything in this page - necessary for the positioning -->
                     29: 
                     30: <div class="doc">
                     31: <h2>CSS Validator User's Manual</h2>
                     32: 
                     33: <h3 id="TableOfContents">Table of Contents</h3>
                     34: 
                     35: <div id="toc">
                     36: <ul>
                     37:   <li><a href="#use">How to use the CSS Validator</a>
                     38:     <ul>
                     39:       <li><a href="#url">Validation by URL
                     40:       response</a></li>
                     41:       <li><a href="#fileupload">Validation by file upload</a></li>
                     42:       <li><a href="#directinput">Validation by direct input</a></li>
1.5       ot         43:       <li><a href="#basicvalidation">What does the basic validation do?</a></li>
1.1       ot         44:     </ul>
                     45:   </li>
                     46:   <li><a href="#advanced">Advanced validation</a>
                     47:     <ul>
                     48:        <li><a href="#paramwarnings">Warnings parameter</a></li>
                     49:        <li><a href="#paramprofile">Profile parameter</a></li>
                     50:        <li><a href="#parammedium">Medium parameter</a></li>
                     51:     </ul>
                     52:   </li>
                     53:   <li><a href="#expert">For the experts</a>
                     54:     <ul>
                     55:        <li><a href="#requestformat">Validation Request Format</a></li>
                     56:        <li><a href="#api">CSS Validator Web Service API</a></li>
                     57:     </ul>
                     58:    </li>
                     59: </ul>
                     60: </div>
                     61: 
                     62: <p id="skip"></p>
                     63: 
                     64: <h3 id="use">How to use the CSS Validator</h3>
                     65: 
                     66: <p>
                     67: The simplest way to check a document is to use the basic interface. In this page
                     68:  you will find three forms corresponding to three possibilities:
                     69: </p>
                     70: 
                     71: <h4 id="url">Validation by URL</h4>
                     72: <p>
1.6       ot         73:     Simply enter the URL of the document you want to validate. 
1.1       ot         74:     This document can be HTML or CSS one.
                     75: </p>
                     76: <img style="display: block; margin-left:auto; margin-right: auto;" 
                     77:     src="./images/uri_basic.png" alt="Validation by URI form" />
                     78: 
                     79: <h4 id="fileupload">Validation by file upload</h4>    
                     80: <p>
                     81:     This solution allows you to upload and check a local file. Click the 
                     82:     "Browse..." button and select the file you want to check.
                     83: </p>
                     84: <img style="display: block; margin-left:auto; margin-right: auto;" 
                     85:     src="./images/file_upload_basic.png" 
                     86:     alt="Validation by File Upload" />
                     87: <p>
                     88:     In this case, only CSS documents are allowed. It means that you 
                     89:     cannot upload (X)HTML documents. You also must be careful with 
                     90:     @import rules since they will be followed only if they explicitely 
                     91:     reference a public URL (so, forget relative paths with this solution)
                     92: </p>
                     93:    
                     94: <h4 id="directinput">Validation by direct input</h4>
                     95: <p>
                     96:     This method is perfect for testing CSS fragments. You just have to
                     97:     write your CSS in the textarea
                     98: </p>
                     99: <img style="display: block; margin-left:auto; margin-right: auto;" 
                    100:     src="./images/direct_input_basic.png" 
                    101:     alt="Validation by direct input" />
                    102: <p>
                    103:     The same comments as before apply. Note that this solution is 
                    104:     very convenient if you have a problem and need some help from the community. 
                    105:     It's also very useful to report a bug, since you can link to the resulting 
                    106:     URL to give a test case.
                    107: </p>    
                    108: 
                    109: <h4 id="basicvalidation">What does the basic validation do?</h4>
                    110: 
                    111: <p>    
                    112:     When using the basic interface, the validator will check the compliance 
1.10      ot        113:     against <a href="http://www.w3.org/TR/CSS21">CSS 2.1</a>, which is the current 
1.1       ot        114:     CSS technical recommendation.<br />
                    115:     It will produce an XHTML output without any warning (you will only see 
                    116:     errors).<br />
                    117:     The medium is set to "all", which is the medium suitable for all devices 
                    118:     (see <a href="http://www.w3.org/TR/CSS2/media.html">
                    119:     http://www.w3.org/TR/CSS2/media.html</a> for a complete description of 
                    120:     media).
                    121: </p>
                    122: 
                    123: <h3 id="advanced">Advanced validation</h3>
                    124: 
                    125: <p>
                    126:     If you need a more specific check, you can use the advanced interface which 
                    127:     allows to specify three parameters. Here is a little help on each of these 
                    128:     parameters.
                    129: </p>
                    130: 
                    131: <h4 id="paramwarnings">Warnings</h4>
                    132: 
                    133: <p>
                    134:     This parameter is useful to tune the verbosity of the CSS Validator. Indeed,
                    135:     The validator can give you two types of messages: errors and warnings.
                    136:     Errors are given when the checked CSS does not respect the CSS 
                    137:     recommendation. Warnings are different from errors since they do not state a
                    138:     problem regarding the specification. They are here to warn (!) the CSS 
                    139:     developper that some points might be dangerous and could lead to a strange
                    140:     behaviour on some user agents.
                    141: </p>
                    142: <p>
                    143:     A typical warning concerns font-family: if you do not provide a generic font,
                    144:     you will get a warning saying that you should add one at the end of the rule,
                    145:     otherwise a user agent that doesn't know any of the other fonts will switch 
                    146:     to it's default one, which may result in strange display.
                    147: </p>
                    148: 
                    149: <h4 id="paramprofile">Profile</h4>
                    150: 
                    151: <p>
                    152:     The CSS validator can check different CSS profiles. A profile lists all the 
                    153:     features that an implementation on a particular platform is expected to 
                    154:     implement. This definition is taken from 
                    155:     <a href="http://www.w3.org/Style/2004/css-charter-long.html#modules-and-profiles0">
                    156:        the CSS site
                    157:     </a>. The default choice corresponds to the current most used one: 
                    158:     <a href="http://www.w3.org/TR/CSS2">CSS 2</a>.
                    159: </p>
                    160: 
                    161: <h4 id="parammedium">Medium</h4>
                    162: 
                    163: <p>
                    164:     The medium parameter is the equivalent of the @media rule, applying to all 
                    165:     the document. You will find more information about media at 
                    166:     <a href="http://www.w3.org/TR/CSS2/media.html">
                    167:        http://www.w3.org/TR/CSS2/media.html
                    168:     </a>.
                    169: </p>
                    170: 
                    171: <h3 id="expert">Experts Only</h3>
                    172: 
                    173: <h4 id="requestformat">Validation Request Format</h4>
                    174: <p>Below is a table of the parameters you can use to send a query to the W3C
                    175: CSS Validator.</p>
                    176: 
                    177: <p>If you want to use W3C's public validation server, use the parameters
                    178: below in conjunction with the following base URI:<br />
                    179: <kbd>http://jigsaw.w3.org/css-validator/validator</kbd><br />
1.6       ot        180: replace with the address of your own server if you want to call a private
1.1       ot        181: instance of the validator.</p>
                    182: 
                    183: <p><strong>Note</strong>: If you wish to call the validator programmatically
                    184: for a batch of documents, please make sure that your script will
                    185: <code>sleep</code> for <strong>at least 1 second</strong> between requests.
                    186: The CSS Validation service is a free, public service for all, your respect is
                    187: appreciated. thanks.</p>
                    188: 
                    189: <table class="refdoc">
                    190:   <tbody>
                    191:     <tr>
                    192:       <th>Parameter</th>
                    193:       <th>Description</th>
                    194:       <th>Default value</th>
                    195:     </tr>
                    196:     <tr>
                    197:       <th>uri</th>
                    198:       <td>The <acronym title="Universal Resource Locator">URL</acronym> of
                    199:         the document to validate. CSS and HTML documents are allowed.</td>
                    200:       <td>None, but either this parameter, or <code>text</code> must be
                    201:       given.</td>
                    202:     </tr>
                    203:     <tr>
                    204:       <th>text</th>
                    205:       <td>The document to validate, only CSS is allowed.</td>
                    206:       <td>None, but either this parameter, or <code>uri</code> must be
                    207:       given.</td>
                    208:     </tr>
                    209:     <tr>
                    210:       <th>usermedium</th>
                    211:       <td>The <a href="http://www.w3.org/TR/CSS2/media.html">medium</a> used 
                    212:          for the validation, like <code>screen</code>,
                    213:          <code>print</code>, <code>braille</code>...</td>
                    214:       <td><code>all</code></td>
                    215:     </tr>
                    216:     <tr>
                    217:       <th>output</th>
                    218:       <td>Triggers the various outputs formats of the validator. Possible 
                    219:        formats are 
                    220:        <code>text/html</code> and <code>html</code> (XHTML document, 
                    221:        Content-Type: text/html), 
                    222:        <code>application/xhtml+xml</code> and <code>xhtml</code> (XHTML 
                    223:        document, Content-Type: application/xhtml+xml), 
                    224:        <code>application/soap+xml</code> and <code>soap12</code> (SOAP 1.2 
                    225:        document, Content-Type: application/soap+xml), 
                    226:        <code>text/plain</code> and <code>text</code> (text document, 
                    227:        Content-Type: text/plain),
1.6       ot        228:        everything else (XHTML document, Content-Type: text/html)       
1.1       ot        229:       </td>
                    230:       <td>html</td>
                    231:     </tr>
                    232:     <tr>
                    233:       <th>profile</th>
                    234:       <td>The CSS profile used for the validation. It can be
                    235:         <code>css1</code>, <code>css2</code>, <code>css21</code>,
                    236:         <code>css3</code>, <code>svg</code>, <code>svgbasic</code>,
                    237:         <code>svgtiny</code>, <code>mobile</code>, <code>atsc-tv</code>,
                    238:         <code>tv</code> or <code>none</code></td>
                    239:       <td>the most recent W3C
                    240:         Recommendation: CSS 2</td>
                    241:     </tr>
                    242:     <tr>
                    243:       <th>lang</th>
                    244:       <td>The language used for the response, currently, <code>en</code>,
1.12      ot        245:         <code>fr</code>, <code>it</code>, <code>ko</code>, <code>ja</code>, <code>es</code>,
1.6       ot        246:         <code>zh-cn</code>, <code>nl</code>, <code>de</code>, <code>it</code>, 
                    247:         <code>pl</code>.</td>
1.1       ot        248:       <td>English (<code>en</code>).</td>
                    249:     </tr>
                    250:     <tr>
                    251:       <th>warning</th>
                    252:       <td>The warning level, <code>no</code> for no warnings, <code>0</code> 
                    253:        for less warnings, <code>1</code>or <code>2</code> for more warnings
                    254:       </td>
                    255:       <td>2</td>
                    256:     </tr>
                    257:   </tbody>
                    258: </table>
                    259: 
                    260: <h4 id="api">CSS Validator Web Service API: SOAP 1.2 validation interface documentation</h4>
                    261: <p>    
                    262:     For more technical help, in particular about the SOAP 1.2 output and all 
                    263:     the possible ways to call the validator, see the 
                    264:     <a href="./api.html">CSS Validator Web Service API</a>.       
                    265: </p>
                    266: 
                    267: </div>
                    268: </div>
                    269: <!-- End of "main" DIV. -->
                    270: 
                    271:    <ul class="navbar"  id="menu">
                    272:        <li><strong><a href="./" title="Home page for the W3C CSS Validation Service">Home</a></strong> <span class="hideme">|</span></li>
1.2       ot        273:        <li><a href="about.html" title="About this service">About</a> <span class="hideme">|</span></li>
                    274:         <li><a href="documentation.html" title="Documentation for the W3C CSS Validation Service">Documentation</a> <span class="hideme">|</span></li>
                    275:         <li><a href="DOWNLOAD.html" title="Download the CSS validator">Download</a> <span class="hideme">|</span></li>
                    276:         <li><a href="Email.html" title="How to provide feedback on this service">Feedback</a> <span class="hideme">|</span></li>
                    277:         <li><a href="thanks.html" title="Credits and Acknowlegments">Credits</a><span class="hideme">|</span></li>
1.1       ot        278:       </ul>
                    279: 
1.4       ot        280:       <ul id="lang_choice">
1.13      ot        281:      
1.20      ot        282:      <li><a href="manual.html.bg"
                    283:     lang="bg"
                    284:     xml:lang="bg"
                    285:     hreflang="bg"
                    286:     rel="alternate">Български</a></li>
                    287:   <li><a href="manual.html.de"
1.13      ot        288:          lang="de"
                    289:          xml:lang="de"
                    290:          hreflang="de"
                    291:          rel="alternate">Deutsch</a>
                    292:      </li>
                    293:      
1.15      ot        294:      <li><a href="manual.html.en"
1.13      ot        295:          lang="en"
                    296:          xml:lang="en"
                    297:          hreflang="en"
                    298:          rel="alternate">English</a>
                    299:      </li>
                    300:      
1.15      ot        301:      <li><a href="manual.html.es"
1.13      ot        302:          lang="es"
                    303:          xml:lang="es"
                    304:          hreflang="es"
                    305:          rel="alternate">Español</a>
                    306:      </li>
                    307:      
1.15      ot        308:      <li><a href="manual.html.fr"
1.13      ot        309:          lang="fr"
                    310:          xml:lang="fr"
                    311:          hreflang="fr"
                    312:          rel="alternate">Français</a>
                    313:      </li>
                    314:      
1.15      ot        315:      <li><a href="manual.html.ko"
1.13      ot        316:          lang="ko"
                    317:          xml:lang="ko"
                    318:          hreflang="ko"
                    319:          rel="alternate">한국어</a>
                    320:      </li>
                    321:      
1.15      ot        322:      <li><a href="manual.html.it"
1.13      ot        323:          lang="it"
                    324:          xml:lang="it"
                    325:          hreflang="it"
                    326:          rel="alternate">Italiano</a>
                    327:      </li>
                    328:      
1.15      ot        329:      <li><a href="manual.html.nl"
1.13      ot        330:          lang="nl"
                    331:          xml:lang="nl"
                    332:          hreflang="nl"
                    333:          rel="alternate">Nederlands</a>
                    334:      </li>
                    335:      
1.15      ot        336:      <li><a href="manual.html.ja"
1.13      ot        337:          lang="ja"
                    338:          xml:lang="ja"
                    339:          hreflang="ja"
                    340:          rel="alternate">日本語</a>
                    341:      </li>
                    342:      
1.15      ot        343:      <li><a href="manual.html.pl-PL"
1.13      ot        344:          lang="pl-PL"
                    345:          xml:lang="pl-PL"
                    346:          hreflang="pl-PL"
                    347:          rel="alternate">Polski</a>
                    348:      </li>
                    349:      
1.15      ot        350:      <li><a href="manual.html.pt-BR"
1.13      ot        351:          lang="pt-BR"
                    352:          xml:lang="pt-BR"
                    353:          hreflang="pt-BR"
                    354:          rel="alternate">Português</a>
                    355:      </li>
                    356:      
1.15      ot        357:      <li><a href="manual.html.ru"
1.13      ot        358:          lang="ru"
                    359:          xml:lang="ru"
                    360:          hreflang="ru"
                    361:          rel="alternate">Русский</a>
                    362:      </li>
                    363:      
1.15      ot        364:      <li><a href="manual.html.sv"
1.13      ot        365:          lang="sv"
                    366:          xml:lang="sv"
                    367:          hreflang="sv"
                    368:          rel="alternate">Svenska</a>
                    369:      </li>
                    370:      
1.15      ot        371:      <li><a href="manual.html.zh-cn"
1.13      ot        372:          lang="zh-cn"
                    373:          xml:lang="zh-cn"
                    374:          hreflang="zh-cn"
                    375:          rel="alternate">简体中文</a>
                    376:      </li>
                    377: </ul>
                    378: 
                    379: 
                    380: 
1.4       ot        381: 
                    382: 
1.14      ot        383: 
                    384: 
1.7       ot        385:    <div id="footer">
1.1       ot        386:    <p id="activity_logos">
1.7       ot        387: 
1.1       ot        388:       <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>
                    389:    </p>
                    390: 
                    391:    <p id="support_logo">
1.17      ot        392:    <a href="http://www.w3.org/QA/Tools/Donate">
                    393:    <img src="http://www.w3.org/QA/Tools/I_heart_validator" alt="I heart Validator logo" title=" Validators Donation Program" />
                    394:    </a>
1.1       ot        395:    </p>
                    396: 
                    397:     <p class="copyright">
1.16      ot        398:       <a rel="Copyright" href="http://www.w3.org/Consortium/Legal/ipr-notice#Copyright">Copyright</a> &copy; 1994-2009
1.1       ot        399:       <a href="http://www.w3.org/"><acronym title="World Wide Web Consortium">W3C</acronym></a>&reg;
                    400: 
                    401:       (<a href="http://www.csail.mit.edu/"><acronym title="Massachusetts Institute of Technology">MIT</acronym></a>,
1.21    ! ylafon    402:       <a href="http://www.ercim.eu/"><acronym title="European Research Consortium for Informatics and Mathematics">ERCIM</acronym></a>,
1.1       ot        403:       <a href="http://www.keio.ac.jp/">Keio</a>),
                    404:       All Rights Reserved.
                    405:       W3C <a href="http://www.w3.org/Consortium/Legal/ipr-notice#Legal_Disclaimer">liability</a>,
                    406:       <a href="http://www.w3.org/Consortium/Legal/ipr-notice#W3C_Trademarks">trademark</a>,
                    407:       <a rel="Copyright" href="http://www.w3.org/Consortium/Legal/copyright-documents">document use</a>
                    408:       and <a rel="Copyright" href="http://www.w3.org/Consortium/Legal/copyright-software">software licensing</a>
                    409: 
                    410:       rules apply. Your interactions with this site are in accordance
                    411:       with our <a href="http://www.w3.org/Consortium/Legal/privacy-statement#Public">public</a> and
                    412:       <a href="http://www.w3.org/Consortium/Legal/privacy-statement#Members">Member</a> privacy
                    413:       statements.
                    414:     </p>
                    415: 
1.7       ot        416: </div>
1.1       ot        417:   </body>
                    418: </html>
                    419: 
                    420: 
                    421: 

Webmaster