- From: Ville Skytta via cvs-syncmail <cvsmail@w3.org>
- Date: Mon, 08 Aug 2005 15:11:39 +0000
- To: www-validator-cvs@w3.org
Update of /sources/public/validator/htdocs/docs
In directory hutz:/tmp/cvs-serv29137/htdocs/docs
Modified Files:
install.html
Log Message:
Bring install instructions up to date. Just missed 0.7.0, I kind of knew
I should have committed this yesterday :(
Index: install.html
===================================================================
RCS file: /sources/public/validator/htdocs/docs/install.html,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -d -r1.13 -r1.14
--- install.html 3 Aug 2005 04:15:25 -0000 1.13
+++ install.html 8 Aug 2005 15:11:37 -0000 1.14
@@ -169,14 +169,24 @@
<li><p>Proceed with the Prerequisites, as detailed above.</p></li>
<li><p>Create a directory for the validator's installation. On Unix-based systems,
- the default will be <code>/usr/local/validator</code>.This directory
- will be referred as [validatorpath] throughout this guide.</p></li>
+ the default will be <code>/usr/local/validator</code>. This
+ directory will be referred to as <code>[validatorpath]</code>
+ throughout this guide.</p></li>
- <li><p>Unpack the archives of the validator and DTD library into <code>[validatorpath]</code></p>
- <p>The <code>[validatorpath]</code> directory should now have subdirectories named
- <code>htdocs</code>, <code>httpd</code>, <code>config</code> and <code>sgml-lib</code>
- (if you used CVS, the latter is actually in the <code>htdocs</code> subdirectory,
- but that is not really important).</p></li>
+ <li>
+ <p>
+ Unpack the archives of the validator and DTD library into a
+ temporary directory, and copy the directories
+ <code>htdocs</code>, <code>httpd/cgi-bin</code>, and
+ <code>share</code> from <code>validator-<em>X.X.X</em></code>
+ into <code>[validatorpath]</code>.
+ </p>
+ <p>
+ The <code>[validatorpath]</code> directory should now have
+ subdirectories named <code>cgi-bin</code>, <code>htdocs</code>,
+ and and <code>share</code>.
+ </p>
+ </li>
</ol>
<h4><a id="install-configure" name="install-configure"></a>Configure</h4>
<h5>Configuration files</h5>
@@ -191,29 +201,25 @@
are really mapping tables of some form -- to avoid having to check in
a new version of the code every time a new version of HTML comes out.
All configuration files can be found in
- <code>$CVSROOT/validator/htdocs/config/</code>.
+ <code>htdocs/config/</code>.
</p>
<p>
To really understand what each does you should read the source, but
here is a short description to get you started.
</p>
<dl>
- <dt>eref.cfg</dt>
- <dd>
- Contains the mappings from element names to an URL fragment
- (relative to a configurable URL) for their definitions. Used
- in output when the "Show Source Input" option is enabled.
- </dd>
- <dt>fpis.cfg</dt>
+ <dt>charset.cfg</dt>
<dd>
- Maps FPIs to plain text version strings.
+ Maps character sets to conversion parameters for validator's
+ internal UTF-8 conversion.
</dd>
- <dt>frag.cfg</dt>
+ <dt>eref.cfg</dt>
<dd>
- Maps error messages to an URL fragment identifier where an
- explanation of that error can be found.
+ Contains the mappings from element names to a URL path
+ (relative to a configurable URL) for their definitions. Used
+ in output when the "Show Parse Tree" option is enabled.
</dd>
- <dt>type.cfg</dt>
+ <dt>types.conf</dt>
<dd>
Maps MIME/HTTP Content-Types to an internal "document type" which
is used for treating HTML, XML, and XHTML in different ways.
@@ -232,15 +238,23 @@
<p>The following instructions are for the Apache Web server, and should be adapted
if you plan on using another server.</p>
<ol>
- <li><p>Edit the configuration of your Web server to refer to the specific configuration file
- for the Validation service.</p>
- <p>This can be done by adding this line:</p>
- <pre>Include [validatorpath]/httpd/conf/validator-httpd.conf</pre>
+ <li>
+ <p>
+ Edit the configuration of your Web server to refer to the
+ specific configuration file for the validator.
+ </p>
+ <p>
+ This can be done by inserting the contents of the
+ <code>httpd/conf/httpd.conf</code> file (from where you
+ unpacked the validator's tarball above) in your
+ <code>httpd.conf</code>, or by copying the file somewhere
+ and including it like:
+ </p>
+ <pre>Include /where/you/copied/it/httpd.conf</pre>
+ <p>
+ Then, start editing the validator specific part.
+ </p>
</li>
-
- <li><p>Copy <code>[validatorpath]/httpd/conf/httpd.conf</code> to
- <code>[validatorpath]/httpd/conf/validator-httpd.conf</code> and start
- editing this file.</p></li>
<li><p>You may want to set up a "virtual server" for the service. This can be done
by adding something similar to the following :</p>
@@ -262,15 +276,22 @@
<code>apachectl configtest</code> then <code>apachectl restart</code>)</p></li>
</ol>
- <h5>Configure the Validator itself</h5>
+ <h5>Configure the Validator itself</h5>
<ol>
- <li><p>Create the directory <code>/etc/w3c</code> and create a file called
- <code>validator.conf</code> using the file
- <code>[validatorpath]/htdocs/config/validator.conf</code> as
- template.</p></li>
- <li><p>
- Make changes to reflect where files are in your installation.</p>
- This file is well commented and this should be relatively straightforward. </li>
+ <li>
+ <p>
+ Create the directory <code>/etc/w3c</code> and copy a the files
+ from <code>[validatorpath]/htdocs/config/</code> to it.
+ </p>
+ </li>
+ <li>
+ <p>
+ Edit <code>/etc/w3c/validator.conf</code> to reflect where files
+ are in your installation, and configure other parameters there as
+ you wish. This file is well commented and modifying it should be
+ relatively straightforward.
+ </p>
+ </li>
</ol>
<h4><a id="install-check" name="install-check"></a>Check the installation</h4>
<ol>
Received on Monday, 8 August 2005 15:11:49 UTC