omf, xml

Folks -

Two issues came up at a release GNOME2 release team meeting involving
API documentation. Neither is GNOME-specific. Both would allow docs
produced by gtk-doc to be more easily integrated.

1) Is it possible to register API docs with ScrollKeeper? This seems
like a good idea, as it will allow any SK-aware help browser (both
GNOME's and KDE's are) to know the docs' location. It's relatively
straightforward - we simply need to create and install an OMF file.

2) DocBook xml. This is harder, but in conjunction with SK, API docs
written in DocBook xml could be indexed and therefore more easily
searchable. Because DocBook xml uses the libxml/libxslt toolkit, this
also would avoid the regular problem of jade/docbook installation that
so many first-time cvs builders confront. (Both GNOME and KDE are
switching to DocBook xml for their user manuals.)

Neither of these things should be done now, but I wanted to get a
discussion started, to see how this fits into gtk-doc's future plans.

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]