Re: Cross-references (was [PATCHES] PQescapeBytea documentation

From: Peter Eisentraut <peter_e(at)gmx(dot)net>
To: Joe Conway <joseph(dot)conway(at)home(dot)com>
Cc: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>, <pgsql-docs(at)postgresql(dot)org>
Subject: Re: Cross-references (was [PATCHES] PQescapeBytea documentation
Date: 2001-11-21 22:12:54
Message-ID: Pine.LNX.4.30.0111212108300.614-100000@peter.localdomain
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs pgsql-interfaces pgsql-patches

Joe Conway writes:

> I did find a reference to a docbook tag which *might* be useful, if we
> can figure out how to use it. See:
>
> http://www.oasis-open.org/docbook/documentation/reference/html/olink.html
>
> The TargetDocEnt parameter seems to be defined in filelist.sgml, but it
> isn't clear to me what the other parameters should be.

In theory, <olink> would be the right solution, but it requires you to
declare all the possible links explicitly beforehand, and at a place which
is not near your actual link. I think this would be much too complicated
to set up and maintain.

It's currently possible to do cross-document links like this:

| For more information, see <![%set-of-books;[<xref
| linkend="whereever">]]><![%single-book;[the <citetitle>Administrator's
| Guide</citetitle>]]>.

(Think of this as equivalent to #ifdef's.)

However, this is pretty ugly, and I think we don't want to expand too much
on this mechanism because it doesn't work in XML.

I imagine we could work out a solution which works like this: <xref
linkend="somewhere" role="if-missing:<citetitle>Administrator's
Guide</citetitle>"> (the role attribute is available for arbitrary
customization, which we'd need to write), but the trick is that ID
checking is done during the SGML parsing stage, which is before stylesheet
processing, so that you'd still get warnings (errors?) about undefined
ids. Possibly, we could convince the olink element to fit this idea, but
then we'd need to write the entire olink processing anew.

So, a short-term solution isn't in sight.

--
Peter Eisentraut peter_e(at)gmx(dot)net

In response to

Browse pgsql-docs by date

  From Date Subject
Next Message Andrew G. Hammond 2001-11-22 01:09:42 Re: PL/pgSQL examples NOT involving functions
Previous Message Bruce Momjian 2001-11-21 21:25:08 Re: Documentation gap: Perl interfaces

Browse pgsql-interfaces by date

  From Date Subject
Next Message Oscar Serrano 2001-11-22 16:27:04 Re: What front end are people using?
Previous Message Darko Prenosil 2001-11-21 18:41:20 TTY debug

Browse pgsql-patches by date

  From Date Subject
Next Message Peter Eisentraut 2001-11-21 22:13:58 Re: Rejection of the smallest int8
Previous Message Peter Eisentraut 2001-11-21 22:12:06 Re: [PATCHES] Version checking when loading psql