Re: gnome-doc package

[Daniel Veillard <veillard redhat com>]

On Mon, Mar 11, 2002 at 10:30:58PM -0600, Eric Baudais wrote:
> Most distrobutions have the Docbook XML DTD and stylesheets packaged.  Even if 
> we don't agree with where they put them this really isn't a place for us to 
> interfere.
> 
> I think that where the stylesheets and DTD are located is not as important as 
> ensuring that the user has a XML catalog working so the DTD and stylesheets 
> can be looked up locally by xsltproc.

  Agreed 100% . The addendum is to locate and install those resources
in the catalog if they are not yet referenced, if the installation is
not too exotic, this can be automated, c.f. the script I provided
which I think is now shipped with scrollkeeper. It is available from
    http://xmlsoft.org/XSLT/docbook.html

My version does something like:
orchis:~ -> XML/doc/buildDocBookCatalog 
Found DocBook XML 4.1.2 DTD in /usr/share/xml/docbook/dtd/4.1.2
Found ISO DocBook entities in /usr/share/xml/docbook/dtd/4.1.2/ent
Found DocBook XSLT stylesheets in /u/veillard/XSLT/tests/docbook
orchis:~ -> 

  and it creates the catalog files in the home as xmlcatalog and
dbkxmlcatalog . Run as root it will try to update /etc/xml/catalog.

> > As I see it, this leaves two issues, then:
> > 
> > 1) The "xmldocs.make", "sgmldocs.make" bits
> > 
> > 2) How to ensure that the DTD/stylesheet are properly installed and
> >    registered with the catalog
> 
> The DocBook help converter is residing in libgnome right now.  If we are 
> serious about making this package then I think it would make sense to move the 
> help converters out of libgnome and into gnome-doc or whatever we call it.  

  I don't have the technical bits to comment on this.

> The goals of this package, as I see it, is to contain all the stuff necessary 
> to insure the user has a working documentation environment.  This would 
> include the help converters and possibly an OMF generator we decide to 
> include later.

  To answer the other part of the thread about the way to check the catalog
has the correct resources, libxml2 installs an xmlcatalog binary which can
be used precisely for this. The script:
    http://xmlsoft.org/buildDocBookCatalog
rely on it to create/modify catalog entries. It can be used for checking too
in a far more reliable way than your suggestion:

: What needs to be tested for is a file which contains:
: <!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN"  "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd";>

 What you really want to do is to check that the catalog system includes
at least the public ID of the DocBook XML 4.1.2 dtd and the default stylesheet:

orchis:~ -> xmlcatalog /etc/xml/catalog "-//OASIS//DTD DocBook XML V4.1.2//EN" 
file:///usr/share/xml/docbook/dtd/4.1.2/docbookx.dtd
orchis:~ ->

it's installed in that box

paphio:~ -> xmlcatalog /etc/xml/catalog "-//OASIS//DTD DocBook XML V4.1.2//EN" 
No entry for PUBLIC -//OASIS//DTD DocBook XML V4.1.2//EN
paphio:~ -> 

it's not there
Same goes for the stylesheets except ypu will have to use the canonical
URL for the stylesheet like

orchis:~ -> xmlcatalog /etc/xml/catalog "http://docbook.sourceforge.net/release/xsl/1.45/html/docbook.xsl";
file:///u/veillard/XSLT/tests/docbook/html/docbook.xsl
orchis:~ -> 

Daniel

-- 
Daniel Veillard      | Red Hat Network https://rhn.redhat.com/
veillard redhat com  | libxml Gnome XML XSLT toolkit  http://xmlsoft.org/
http://veillard.com/ | Rpmfind RPM search engine http://rpmfind.net/