Re: minor doc improvements

From: Neil Conway <neilc(at)samurai(dot)com>
To: Peter Eisentraut <peter_e(at)gmx(dot)net>
Cc: pgsql-patches(at)postgresql(dot)org
Subject: Re: minor doc improvements
Date: 2004-03-04 02:32:12
Message-ID: 4046952C.1000404@samurai.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-patches

Peter Eisentraut wrote:
> ISTM that the linking changes you propose are stretching the semantics
> of DocBook. If you want to link, why not just use <link>. By using
> <xref> plus endterm you're doing the same thing indirectly and you rely
> on the remote endterm having a sensible grammatical structure that fits
> into the local sentence.

I didn't know about the <link> tag, thanks for the suggestion. (I
won't claim to be a DocBook expert.)

Can you suggest when <xref> should be used, and when <link> is the
right tag to use?

(The fact that the endterm of the xref must fit into the grammatical
structure of the local sentence doesn't seem like a major problem to
me. If we change the endterm of *any* xref, couldn't that disturb the
xref's local sentence? i.e. don't the existing uses of <xref> in the
docs suffer from the same problem?)

-Neil

In response to

Browse pgsql-patches by date

  From Date Subject
Next Message Tom Lane 2004-03-04 04:05:03 Re: tighten input to float4/float8/oid
Previous Message Peter Eisentraut 2004-03-04 02:14:23 Re: minor doc improvements