Re: Re: gtk-doc inter-document cross references

["Matthias Clasen" <matthiasc poet de>]

----- Original Message -----
From: "Mikael Hallendal" <micke codefactory se>
To: <gtk-doc-list gnome org>
Sent: Friday, October 19, 2001 1:18 PM
Subject: Re: Re: gtk-doc inter-document cross references


> Hi!
>
> Just noticed the thread on generating Docbook from gtk-doc. I have
> written most of DevHelp and would really like to see API-docs
> distributed as Docbook instead as HTML (which makes searching/generate
> TOC etc. much easier, I think).
>
> I'm currently rewriting DevHelp to GNOME2 (from scratch) and making it a
> generall help browser rather than just a API-doc browser.
>
> * Will this tag functions/identifiers as keywords in someway. So that
>   this information can be used for the search-functionality?
>   If so, the work to make the API-doc available for searching would be
>   kept at a minimum.

I fear that the docbook used internally be gtk-doc is not overly useful
without
some tweaking, it is really just an internal form for further processing.

Each function description currently comes out as a refsect2, with the
function name and an anchor inside the title, eg

<refsect2>
<title><anchor id="gtk-get-default-language">gtk_get_default_language
()</title>

>
> * How will links between for example gtk+ and glib work. Currently
>   "../glib/.." in gtk+ documentation?

Currently we emit all links are <link>s. The cross-document links are
converted into
special non-HTML markup by the DSSSL scripts, which gets then converted into
HTML links by a postprocessing step.

I guess using <olink>s would be much nicer if we could figure out which
links are
cross-document .


Matthias