Subject: Re: Adding xreflable
To: Bruce Momjian <bruce@momjian.us>
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>
 <20200522164518.GG30409@momjian.us>
Cc: Tom Lane <tgl@sss.pgh.pa.us>,
 PostgreSQL-documentation <pgsql-docs@postgresql.org>
From: Peter Eisentraut <peter.eisentraut@2ndquadrant.com>
Organization: 2ndQuadrant
Message-ID: <28ff383a-59c1-c8a1-a4de-5f5f3e7e794d@2ndquadrant.com>
Date: Tue, 26 May 2020 13:41:41 +0200
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.14; rv:52.0)
 Gecko/20100101 Thunderbird/52.9.1
MIME-Version: 1.0
In-Reply-To: <20200522164518.GG30409@momjian.us>
Content-Type: text/plain; charset=utf-8; format=flowed
Content-Language: en-US
Content-Transfer-Encoding: 7bit
Precedence: bulk

On 2020-05-22 18:45, Bruce Momjian wrote:
> 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 think that's 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?

Both of those commits should be reverted.

I don't quite understand your plan, but if you mean, check whether 
anyone else links to the id in question, that doesn't sound sustainable. 
  A new link could be added at any time in the future.

I think the release notes should either just use a plain <xref> to link 
and use whatever generated text it gets, or if you don't like that, use 
<link>.  Which is basically what it was before, IIRC.

-- 
Peter Eisentraut              http://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services