summaryrefslogtreecommitdiffstats
path: root/htdocs/source/index.html
blob: 803909e8bfa24ddf12c70ff347c5af7651eca88f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
<!--#set var="title" value="Source Code Availability for The W3C Markup Validation Service"
--><!--#set var="relroot" value="../"
--><!--#include virtual="../header.html" -->
<div class="doc">
  <h2>Source code availability<br />for the W3C Markup Validator</h2>
  <h3 id="TableOfContents">Table of Contents</h3>

  <div id="toc">
    <ul>
      <li><a href="#getting">Retrieving and browsing the Code</a>
       <ul>	
	<li><a href="#browse">Browsing the code</a></li>
	<li><a href="#tarball">Download tarballs</a></li>
	<li><a href="#rpm">Fedora/Red Hat RPM package</a></li>
          <li><a href="#suse">openSUSE/SUSE Linux RPM package</a></li>
	<li><a href="#deb">Debian GNU/Linux package</a></li>
	<li><a href="#mac">Mac OS X Application</a></li>
	<li><a href="#CVS">Mercurial repository</a></li>
       </ul>
      </li>
      <li><a href="#using">Using the code</a></li>
    </ul>
  </div>

  <h3><a name="getting" id="getting"></a>Retrieving and browsing the Code</h3>

    <p><a id="skip" name="skip"></a>
    The source code for the <a href="../"><acronym title="World Wide Web Consortium">W3C</acronym>
    Markup Validation Service</a> is available under the terms of the
    <a href="http://www.w3.org/Consortium/Legal/copyright-software"><acronym title="World Wide Web Consortium">W3C</acronym>
	Software License</a>. Source tarball of the latest production
      version is always available at
      &lt;<a href="http://validator.w3.org/validator.tar.gz">http://validator.w3.org/validator.tar.gz</a>&gt;.
      Development code is only available from the Mercurial repository.
    </p>

          <h4><a id="browse" name="browse"></a>Browsing the code</h4>

  <p>
    If you just want to glance at the code, or see its revision
    history, you can
    <a href="http://dvcs.w3.org/hg/markup-validator/file/tip/">browse it on
    the web</a>.
  </p>
  <p>
    The most interesting files are currently
    <a href="http://dvcs.w3.org/hg/markup-validator/file/tip/httpd/cgi-bin/check">a
    CGI script called "check"</a> that does pretty much everything,
    and possibly also <a
    href="http://dvcs.w3.org/hg/markup-validator/file/tip/httpd/conf/httpd.conf">the
    httpd.conf configuration file snippet for Apache</a>.
    Select the topmost revision numbers on these
    pages to see the most recent revision of each file.
    </p>
  
          <h4><a id="tarball" name="tarball"></a>Download the code in tarballs</h4>

	   <p>
            If you want a copy of all the files that make up the service, you
            can download a tarball of <a href="http://validator.w3.org/validator.tar.gz">the code</a>
	    (~300kB) and <a href="http://validator.w3.org/sgml-lib.tar.gz">the <acronym
              title="Document Type Definitions">DTDs</acronym></a> (~500kB).
          </p>
  
        <h4><a id="rpm" name="rpm"></a>Fedora/Red Hat RPM package</h4>

          <p>
            Fedora RPM packages of the validator are included in Fedora.
            The name of the validator package is <tt>w3c-markup-validator</tt>,
            use the standard automated package management tools of the
            distribution (such as yum) to install it along with its
            dependencies.
          </p>
          <p>
            For Red Hat Enterprise Linux and derivative distributions, the
            <tt>w3c-markup-validator</tt> package is available in
            <a href="http://fedoraproject.org/wiki/EPEL">EPEL</a>.
          </p>
  
  <h4><a id="suse" name="suse"></a>openSUSE/SUSE Linux RPM package</h4>

          <p>
    openSUSE/SUSE Linux RPM packages of the validator are available,
    courtesy of Sierk Bornemann, at software.openSUSE.org,
    &lt;<a href="http://software.opensuse.org/">http://software.opensuse.org/</a>&gt;.
    Starting with openSUSE 10.3, the latest stable validator package and all its
    dependencies are included in the official stable openSUSE distribution.
    The name of the validator package is <tt>w3c-markup-validator</tt>,
    use the standard automated package management tools of the
    distribution (such as <em>YaST</em>, <em>zypper</em>, <em>smart</em>,
    <em>apt4rpm</em> or <em>yum</em>) to install it along with its
    dependencies.
          </p>
          <p>
    Additionally, you can also get these and other needed packages
    from the openSUSE Software Repository at
    &lt;<a href="http://download.opensuse.org/repositories/validators/">http://download.opensuse.org/repositories/validators/</a>&gt;
    or from one of its mirrors, or (except needed Perl packages)
    from sierkbornemann.de,
    &lt;<a href="http://sierkbornemann.de/pub/tools/w3c-markup-validator/">http://sierkbornemann.de/pub/tools/w3c-markup-validator/</a>&gt;.
    Needed Perl packages are provided through the openSUSE Software Repository at
    &lt;<a href="http://download.opensuse.org/repositories/devel:/languages:/perl/">http://download.opensuse.org/repositories/devel:/languages:/perl/</a>&gt;.
          </p>
  
        <h4><a name="deb" id="deb"></a>Debian GNU/Linux package</h4>

          <p>
            A Debian package is available, courtesy of Fr&eacute;d&eacute;ric
            Sch&uuml;tz. 
          </p>
          <p>
            Starting with Debian 3.1 ("Sarge"), the package and all its
            dependencies are included in the official Debian distribution, and
            can be installed by running the command <kbd>apt-get install
            w3c-markup-validator</kbd> as root.
          </p>
          <p>
            Debian 4.0 ("Etch") includes version 0.7.4 of the validator; the
            Debian Testing and Unstable distributions usually include the latest
            version.
          </p>

        <h4 id="mac">Mac OS X Application</h4>
        <p>
          The Validator is also packaged as a standalone Mac OS X Application,
          called <a href="http://habilis.net/validator-sac/">Validator <abbr title="[Stand Alone Complex]">S.A.C.</abbr></a>, courtesy of <a href="http://habilis.net/chuck/" title="Chuck Houpt's Home Page">Chuck Houpt</a>.</p>

        <h4><a id="CVS" name="CVS"></a>Mercurial repository</h4>

          <p>
            If you intend to actively mirror the code and/or contribute
            patches to the code, you should install and become familiar
            with <a href="http://mercurial.selenic.com/">Mercurial</a>;
            this is the tool we use for revision control.
          </p>
          <p>
            For instructions on how to retrieve the code using Mercurial, 
            see our <a href="http://dvcs.w3.org/hg/markup-validator/">web-based
              interface to the repository</a>.
          </p>
            
  <h3><a id="using" name="using"></a>Using the code</h3>

     <p>
      The purpose of making the source code available is partly to allow
      others to set up mirrors of the service (either publicly or within
      an intranet behind a firewall), but also to allow us to collaborate
      on making the service better! If you are interested in helping with 
      the development, we suggest you  first <a href="../docs/install.html">install</a>
      the code and <a href="../docs/devel.html">read our instructions for developers</a>.
  </p>

</div>
<!--#include virtual="../footer.html" -->
  </body>
</html>