From: Bruce Momjian <bruce@momjian.us>
To: Peter Eisentraut <peter.eisentraut@2ndquadrant.com>
Cc: Tom Lane <tgl@sss.pgh.pa.us>
Cc: PostgreSQL-documentation <pgsql-docs@postgresql.org>
Subject: Re: Adding xreflable
Date: Fri, 22 May 2020 12:45:18 -0400
Message-ID: <20200522164518.GG30409@momjian.us> (raw)
In-Reply-To: <8315c0ca-7758-8823-fcb6-f37f9413e6b6@2ndquadrant.com>
References: <20200515123923.GB3894@momjian.us>
<18482.1589549850@sss.pgh.pa.us>
<20200515134900.GD3894@momjian.us>
<19807.1589551746@sss.pgh.pa.us>
<20200515142204.GE3894@momjian.us>
<22323.1589555218@sss.pgh.pa.us>
<20200515153034.GG3894@momjian.us>
<20200515164747.GH3894@momjian.us>
<8315c0ca-7758-8823-fcb6-f37f9413e6b6@2ndquadrant.com>
On Fri, May 22, 2020 at 12:09:18PM +0200, Peter Eisentraut wrote:
> On 2020-05-15 18:47, Bruce Momjian wrote:
> > Done. Thanks for the tips.
>
> This doesn't seem right. By adding xreflabels you are changing the
> appearance for all links pointing to the target, not only from the release
> notes. For example, if you now do
>
> see <xref linkend="vacuum-basics"/> and <xref linkend="autovacuum"/>
>
> which are both sect2s in the same chapter, then you get a rendered text of
>
> see Section 24.1.1 and autovacuum
>
> which is bizarre.
>
> If you want the link appearance to change only in the release notes, then
> the right approach is to use the <link> tag, as was done before.
Ugh, I see what you mean. I have read doc/src/sgml/README.links many
times and still get confused. What you are saying is that if there is
no xreflabel on a target, you can get the chapter/section via <xref> or
specify text via <link>. But, if there is an xreflabel on the target,
you can't get the chapter/section anymore --- you can only get the
xreflabel via <xref>, or specify text via <link>, right?
I added 13 xreflabels in commits 85af628da5 and 75fcdd2ae2. What I am
thinking of doing is to look at all references to the id's associated
with those xreflabels and remove the xreflabel if the chapter/section
is required, and if not, convert <link> to <xref> where the link text
matches the xreflabel. Does that sound like a good plan?
--
Bruce Momjian <bruce@momjian.us> https://momjian.us
EnterpriseDB https://enterprisedb.com
+ As you are, so once was I. As I am, so you will be. +
+ Ancient Roman grave inscription +
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients using the --to and --cc options:
reply via email
To: pgsql-docs@postgresql.org
Cc: bruce@momjian.us, peter.eisentraut@2ndquadrant.com, tgl@sss.pgh.pa.us
Subject: Re: Adding xreflable
In-Reply-To: <20200522164518.GG30409@momjian.us>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox