Re: Patch to readd documentation

From: Oliver Jowett <oliver(at)opencloud(dot)com>
To: Kris Jurka <books(at)ejurka(dot)com>
Cc: Peter Eisentraut <peter_e(at)gmx(dot)net>, pgsql-jdbc(at)postgresql(dot)org
Subject: Re: Patch to readd documentation
Date: 2004-01-27 07:48:58
Message-ID: 401617EA.9050606@opencloud.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-jdbc

Kris Jurka wrote:
>
> On Tue, 27 Jan 2004, Oliver Jowett wrote:
>
>
>>Oliver Jowett wrote:
>>
>>>I think you should be able to validate the docs at the XML level using
>>>just the XML libraries provided with recent JDKs (I'll check if this
>>>works shortly). We do need the DocBook XML DTDs available to properly
>>>validate the document, but that seems less onerous than needing a recent
>>>XSLT processor plus DocBook stylesheets.
>>>
>>>Ant has a XMLValidate task that might be useful here.
>>
>>The attached patch implements this. It'll use a local copy of the
>>DocBook XML DTDs if present, otherwise it'll grab them from the system
>>URI given in pgjdbc.xml (i.e. from www.open-oasis.org). See the comments
>>in the patch for more details.
>>
>
>
> I don't see what the point of the xmlcatalog in its current incarnation
> is. It should either take a config parameter like building the
> documentation does as a path to the dtds

Yes. My patch was a proof of concept. If we decide to go this way the
local DTD location can certainly be configurable.

> or it should package them with
> it. As it stands the user would have to download the files and put them
> in this special doc directory. If that is the expected case we should
> just package them ourselves as I've recommended elsewhere.

I thought you were recommending packaging the stylesheets which is a
somewhat bigger proposition. The DTDs are around 300-400k uncompressed;
aren't the stylesheets much bigger (I saw 12MB mentioned)?

I don't really see it's worth packaging them in the CVS tree though.
It's trivial to install them if needed (literally, download and unzip
one file into your build tree; see the comments in the patch). Also it's
not actually necessary to have the DTDs stored locally, they'll get
fetched via HTTP at validation time if not present. Having a local copy
is just faster.

-O

In response to

Responses

Browse pgsql-jdbc by date

  From Date Subject
Next Message Kris Jurka 2004-01-27 08:45:26 Re: Patch to readd documentation
Previous Message Kris Jurka 2004-01-27 07:20:31 Re: Patch to readd documentation