Re: omf, xml

On Thu, 2002-05-09 at 15:34, Matthias Clasen wrote:
> Am Don, 2002-05-09 um 02.35 schrieb John Fleck:
> > On Wed, 2002-05-08 at 17:16, Matthias Clasen wrote:
> > > 
> > > 2. What to do to make gtkdoc-mkhtml cope with Docbook XML:
> > > 
> > > - change gtk-doc.dcl to be the XML declaration
> > > 
> > > - adjust SGML_CATALOG_FILES to include the docbook xml catalog,
> > >   typically named CATALOG.db3xml, but make sure that it is not the first
> > >   catalog in SGML_CATALOG_FILES containing an uncommented SGML_DECL
> > >   declaration. Otherwise jade will try to parse the DSSSL stylesheets 
> > >   using the XML declaration, which doesn't work.
> > >    
> > 
> > An alternative approach worth considering here would be to use
> > xmlcatalogs and xsltproc to do the same job.
> But this needs to be coded first. The intent of my mail was to confirm
> that we can switch to XML without having to replace the backend for HTML
> transformation. 

Indeed. You are correct here.

> Here is how I would like to attack the install-docbook-xml issue:
> 1) Add --output-format option to gtkdoc-mkdb to optionally write xml 
>   (similar to the patch that started this thread)
> 2) Add --input-format option to gtkdoc-mkhtml to optionally read xml
>   (make it use the right SGML declaration)
> 3) Convert glib, pango, atk, gtk API docs to XML.
>   (my last mail contained a list of non-XML constructs which are
>    likely to need purging)
> 4) Figure out how to install the xml so that it can be used by the gnome2
>    help infrastructure.

Two things to be worked out here:

a) How to create an OMF file
If we use the minimal one, it could be created manually a single time by
the developer, with only the "date" element filled in dynamically when
the docs are built.

b) Location. For the GNOME2 help system, we just install the xml, and
Yelp renders it directly. So it'd be, I think, just a matter of
installing the xml side-by-side with the html. As long as ScrollKeeper
knows where it's been installed, that would be sufficient for Yelp to
find it, would it not Mikael?

> 5) Solve the cross-document linking problem for the installed xml either
>    - at install time, using the fixxref approach
>    - at display time, using olink support in the viewer (currently 
>      nonexisting, I guess) 
> 6) Later: consider replacing jade by xsl-based tools in gtkdoc-mkhtml.
> Does this sound reasonable ? If there are no objections, I would like to 
> go ahead with 1) - 3). John can probably explain what needs to be done
> for 4).
> Matthias 

John Fleck
jfleck inkstain net (h) jfleck abqjournal com (w)

"You don't want to die with the music still in you."
 - John Gardner

[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]