This is an archived snapshot of W3C's public bugzilla bug tracker, decommissioned in April 2019. Please see the home page for more details.

Bug 5682 - Instructions not clear for sgml-lib path configuration
Summary: Instructions not clear for sgml-lib path configuration
Status: RESOLVED WORKSFORME
Alias: None
Product: Validator
Classification: Unclassified
Component: Website (show other bugs)
Version: HEAD
Hardware: PC Windows 2000
: P2 normal
Target Milestone: ---
Assignee: This bug has no owner yet - up for the taking
QA Contact: qa-dev tracking
URL: http://validator.w3.org/docs/install_...
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2008-05-08 07:36 UTC by Steve Akins
Modified: 2009-09-21 20:19 UTC (History)
2 users (show)

See Also:


Attachments

Description Steve Akins 2008-05-08 07:36:49 UTC
The instructions for installing and configuring the sgml-lib are not clear and are potentially incorrect.

Looking at the directory structure of the packages, the use of the Base variable and the instructions in http://validator.w3.org/docs/install.html, I think the following changes should be made to the instructions.

In the 'Configuration of the Validator' section it describes this:

For the SGML Library, c:/www/sgml-lib is declared. Notice that slashes are used here instead of windows-like back slashes.

What it should be be doing is this:
Change #Base = /usr/local/validator
To Base = C:/www/validator


Unpacking the sgml-lib should just go under C:\www\validator the same as the validator as per http://validator.w3.org/docs/install.html#install-components

I can rewrite the page if you like and send it to someone for update, just let me know how.

Cheers,
Steve Akins
Comment 1 Olivier Thereaux 2008-05-11 21:01:35 UTC
Have you looked at http://validator.w3.org/docs/install_win.html ?
Comment 2 Olivier Thereaux 2008-05-11 21:11:50 UTC
oh, I see your feedback is about install_win.html and not install.html - I was confused by the main bug text, my apologies.


(In reply to comment #0)
> I can rewrite the page if you like and send it to someone for update, just let
> me know how.

That would be great. Can you create a diff from the latest CVS version, which you can find at:
http://dev.w3.org/cvsweb/validator/htdocs/docs/install_win.html
?

Thanks.
Comment 3 Steve Akins 2008-05-12 03:53:37 UTC
Hi Oliver,

Here's the patch for version 1.16.

It looks like the 1.15 version described something similar to what I'm doing here.  For some reason it was changed in 1.16.  
 
I'm sorry but I don't have a huge amount of time or resources to help a whole lot and I don't have CVS or a UNIX environment. I hope the output below from WinMerge is enough.

Cheers,
Steve

91,92c91
<   <code>C:\www\pmm</code>, the validator itself in <code>C:\www\validator</code> and finally
<   the DTD-Collection in <code>C:\www\sgml-lib</code></p>
---
>   <code>C:\www\pmm</code>, the validator along with the DTD-Collection in <code>C:\www\validator</code></p>
248a248,260
> <h3 id="install-components">Install the various necessary components:</h3>
> 	<p>In a previous step you created a directory for the validator's installation called <code>C:\www\validator</code>.
> 	This directory will be referred to as <code>[validatorpath]</code>
> 	throughout this guide.</p>
> 	<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>
> <p>Within <code>[validatorpath]\htdocs</code> there should be an <code>sgml-lib</code> directory containing all the directories and files  from the DTD archive.</p>
> 
253,257c265,266
< <p>For the SGML <code>Library</code>, <code>c:/www/sgml-lib</code>
<   is declared. Notice that slashes are used here instead of 
<   windows-like back slashes.</p>
< 
< <p>The option <code>Home Page</code> has to be changed to the URL of 
---
> Uncomment and set the Base Path variable to <code>C:/www/validator</code>, notice that slashes are used here instead of windows-like
> back slashes.<p>The option <code>Home Page</code> has to be changed to the URL of 
288c297
<   #Base = /usr/local/validator
---
>   Base = C:/www/validator
300c309
<     Library = C:/www/sgml-lib
---
>     Library = $Base/htdocs/sgml-lib
Comment 4 Olivier Thereaux 2008-06-04 20:13:57 UTC
Hi Steve,

(In reply to comment #3)
> It looks like the 1.15 version described something similar to what I'm doing
> here.  For some reason it was changed in 1.16.  

There may have been a good reason behind that change, I am honestly not sure. I brought your comment, and you patch (thank you!) to the attention of David Tibbe, the contibutor in charge of the windows manual. Let's see if he can clarify for us.

Thanks.
Comment 5 David Tibbe 2008-07-03 19:58:45 UTC
Steve got the validator from the CVS repository. The sgml-lib is
included there and it is located in BASE\htdocs\sgml-lib. So in his
case, the objection is correct.

But the installation guide tells to use the tar ball that does not include the sgml-lib. It must be downloaded separately. To have a nice directory
structure, I supposed to extract it to c:\www\sgml-lib, so the directory
is outside the BASE and must be set explicitly.

As the guide is for an installation using the tar ball I suggest to keep the current way. Olivier acknowledged that already via mail.

Regards,
  David
Comment 6 Ville Skyttä 2009-09-21 20:19:33 UTC
Closing as worksforme per comment 5.