Cross-references (was [PATCHES] PQescapeBytea documentation patch)

From: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
To: Joe Conway <joseph(dot)conway(at)home(dot)com>
Cc: pgsql-docs(at)postgreSQL(dot)org
Subject: Cross-references (was [PATCHES] PQescapeBytea documentation patch)
Date: 2001-11-20 21:09:03
Message-ID: 3946.1006290543@sss.pgh.pa.us
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs pgsql-interfaces pgsql-patches

[ redirected from patches to pgsql-docs ]

Joe Conway <joseph(dot)conway(at)home(dot)com> writes:
> I was trying (but gave up) to cross-reference back to the input escape
> table in the User's Guide, but could not get the documentation to
> compile with a cross-book xref (missing IDREF error). Can a cross-book
> xref be done?

AFAIK, not. If you look around you'll notice a bunch of vague cross-
references like

See the <citetitle>Administrator's Guide</> for details.

This pretty much sucks but as long as we maintain the notion that the
books should be separately buildable, I'm not sure there's a way to do
better.

As far as readers go, I don't see that there's any need for anything
but the integrated document --- and we could do better cross-references
in that setting than we are doing. The one good thing about the
separate books is that you can build just one (to check the markup of
a section you're working on) in a reasonable amount of time. Building
the integrated doc seems to take forever :-(

Anyone see a way out of this dilemma?

regards, tom lane

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Peter Eisentraut 2001-11-20 21:42:26 Re: bytea datatype documentation patch
Previous Message Bruce Momjian 2001-11-20 20:29:05 Re: PQescapeBytea documentation patch

Browse pgsql-interfaces by date

  From Date Subject
Next Message Joe Conway 2001-11-20 23:02:55 Re: Cross-references (was [PATCHES] PQescapeBytea documentation patch)
Previous Message Bruce Momjian 2001-11-20 20:29:05 Re: PQescapeBytea documentation patch

Browse pgsql-patches by date

  From Date Subject
Next Message Bruce Momjian 2001-11-20 21:09:43 Re: Documentation patch for PL/Python
Previous Message Marko Kreen 2001-11-20 20:56:10 pgcrypto: include sys/types.h in crypt-des.c