Cross-references (was [PATCHES] PQescapeBytea documentation patch) - Mailing list pgsql-docs

From Tom Lane
Subject Cross-references (was [PATCHES] PQescapeBytea documentation patch)
Date
Msg-id 3946.1006290543@sss.pgh.pa.us
Whole thread Raw
List pgsql-docs
[ redirected from patches to pgsql-docs ]

Joe Conway <joseph.conway@home.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

pgsql-docs by date:

Previous
From: "Christopher Kings-Lynne"
Date:
Subject: Re: [SQL] PL/pgSQL examples NOT involving functions
Next
From: Joe Conway
Date:
Subject: Bytea docs (was Re: [PATCHES] bytea datatype documentation patch)