summaryrefslogtreecommitdiffstats
path: root/htdocs/source/index.html
blob: 9981124c761f88c94bc17061be686f449f83a09f (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
158
159
160
161
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>

<head>
  <title>W3C HTML Validation Service: Source Code</title>
  <link rev="made" href="mailto:gerald@w3.org">
  <meta name="keywords" content="HTML, Hypertext Markup Language, Validation,
    W3C HTML Validation Service, Source Code">
  <meta name="description" content="Source Code for W3C's Validation Service.">
  <meta name="revision"
    content="$Id: index.html,v 1.10 1999-09-27 10:11:21 gerald Exp $">
</head>

<body bgcolor="#FFFFFF" text="#000000" link="#0000ee" vlink="#551a8b">

<p>
  <a href="http://www.w3.org/"><img
     src="http://www.w3.org/Icons/WWW/w3c_home" height=48 border=0
     alt="W3C"></a>
</p>

<h1>W3C HTML Validation Service: Source Code</h1>

<p>
  The source code for the <a
  href="../">W3C HTML Validation Service</a> is available under the terms
  of the <a href="http://www.w3.org/Consortium/Legal/copyright-software">W3C
  Software Copyright</a>.
</p>

<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 -- there are <a
  href="/todo.html">many ways the service could be improved</a> but I
  only have a small amount of time to work on it myself.
</p>

<p>
  You can retrieve the code a number of ways:
</p>

<ul>

  <li>If you just want to glance at the code, or see its revision
  history, you can <a
  href="http://dev.w3.org/cgi-bin/cvsweb/validator/">browse it on the web</a>.

  <p>
  The most interesting files are currently <a
  href="http://dev.w3.org/cgi-bin/cvsweb/validator/httpd/cgi-bin/check">a
  CGI script called "check"</a> that does pretty much everything,
  and possibly also <a
  href="http://dev.w3.org/cgi-bin/cvsweb/validator/httpd/conf/httpd.conf">the
  httpd.conf</a>. (select the topmost revision numbers on these pages to see
  the most recent revision of each file.)
  </p>

  <li><p>If you want a copy of all the files that make up the
  service, you can <a href="../validator.tar.gz">grab a tar
  ball</a> (~1.5M, updated every day at 06:00 ET.)
  </p>

  <li><p><a name="CVS">If you intend to actively mirror the code</a>
  and/or contribute
  patches to the code, you should install and become familiar with <a
  href="http://www.cyclic.com/cvs/info.html">CVS</a>; this is the
  tool we use for revision control (it is also used by the <a
  href="http://dev.apache.org/">Apache</a> and <a
  href="http://www.mozilla.org/cvs.html">Mozilla</a> developers,
  and is generally a good thing to get to know.) <a
  href="http://www.loria.fr/~molli/cvs-index.html">More information
  on CVS</a> is available courtesy of <a
  href="http://www.loria.fr/~molli/">Pascal Molli</a>.</p>

  <p>
  Our CVS base is available read-only, using CVS pserver authentication
  a la:

  <blockquote><samp>
    bash$ <kbd><b>export
      CVSROOT=":pserver:anonymous@dev.w3.org:/sources/public"</b></kbd><br>
    bash$ <kbd><b>cvs login</b></kbd><br>
    (Logging in to anonymous@dev.w3.org)<br>
    CVS password: <kbd><b>anonymous</b></kbd><br>
    bash$ <kbd><b>cvs get validator</b></kbd><br>
    cvs server: Updating validator<br>
    cvs server: Updating validator/htdocs<br>
    U validator/htdocs/about.html<br>
    ...
  </samp></blockquote>

  <!-- using <b> above is evil, but the default kbd style in Netscape is
   goofy, and having that text boldfaced is ever so much clearer. - Gerald
    -->

</ul>

<h2>Prerequisites</h2>

<p>
  Before you will be able to get the code to run, you will need a few
  things already installed on your system:
</p>

<ul>

  <li>A Unix-like operating system. It may work with Windows NT or
  other systems, but I haven't tried it yet. It has worked on Linux,
  Solaris, FreeBSD, HP-UX, and Digital UNIX. If anyone tries it on other
  systems and gets it to work, please <a href="/feedback.html">let
  me know</a> (and <a href="/feedback.html">send me patches</a>, if
  they are needed to get it to work eleswhere.)

  <li><a href="http://www.jclark.com/sp/">SP version 1.2.1 or higher</a>.
  SP is the SGML parser used by the service. More recent versions than
  1.2.1 will also work; I am currently using version 1.3.

  <li><a href="/sgml-lib.tar.gz">A collection of DTDs and other SGML
  files</a> to validate against. You don't strictly <em>need</em> these
  on your system since SP will retrieve them off the Web if you use URIs
  in your doctypes, but you probably want them locally for efficiency.
  (You don't need to download this tar ball if you mirror everything
  using <a href="#CVS">CVS</a>.)

  <li>The <a href="http://www.linpro.no/lwp/">LWP Perl module</a>
  
  <li>A web server: I am currently running <a
  href="http://www.apache.org/">Apache</a> version 1.3.6, but likely any
  version will work, and other httpd's may work as well.

  <li><a href="http://www.perl.com/">Perl</a>: the <a
  href="http://dev.w3.org/cgi-bin/cvsweb/validator/httpd/cgi-bin/check">main
  CGI script</a> that does everything is written in Perl.

  <li><a href="http://www.weblint.org/">weblint</a> (optional):
  the service provides an option to run weblint on the page being
  validated. Currently this services uses version 1.017.

</ul>

<p>
  If anyone tries to use the code, and succeeds (or fails), please <a
  href="/feedback.html">let me know</a>!
</p>

<hr>

<address>
  <a href="http://validator.w3.org/check/referer"><img
     src="http://validator.w3.org/images/vh40.gif" height=31 width=88
     align=right border=0 alt="Valid W3C HTML 4.0!"></a>
  <a href="/feedback.html">Gerald Oskoboiny</A><br>
     $Date: 1999-09-27 10:11:21 $
</address>

</body>

</html>