Re: XML API documentation

[Michael JasonSmith <MPJ17 student canterbury ac nz>]

On Thu, 2002-11-14 at 01:52, Mikael Hallendal wrote:
> One reason for using Scrollkeeper for Devhelp would be to have all the
> documentation listed in one place. Though I'm not really sure of the
> benefits of this since you don't want API docs in Yelp and you don't
> want user docs in Devhelp. 
At least two GNOME users have looked for development files in Yelp: Mark
Finlay and myself :)  I didn't even know of Devhelp until this thread
came along, I always used Galeon to browse Web pages.  There is a
Scrollkeeper  category for API documentation: "Development|Libraries",
so it is feasible to put them in Yelp.  As for non-development users, 
API documents in Yelp would be no more confusing as
system-administration man pages.

As far a Devhelp goes, it dose not seem to be very different from Yelp:
it has a two-pane window with a documentation tree on the left and the
rendered document on the right, much the same as Yelp.  I get the
feeling that the underlying pages are HTML-based, rather than Docbook,
but that can be changed.  Hay, wasn't someone suggesting that :)

While I'd love to create a sub-class of Yelp to provide the API
documentation, I think my supervisor would get a bit shitty with me :(

There, my 2¢.
-- 
Michael JasonSmith      http://www.cosc.canterbury.ac.nz/~mpj17/