From: Bruce Momjian <bruce@momjian.us>
To: Tom Lane <tgl@sss.pgh.pa.us>
Cc: PostgreSQL-documentation <pgsql-docs@postgresql.org>
Subject: Re: Adding xreflable
Date: Fri, 15 May 2020 11:30:34 -0400
Message-ID: <20200515153034.GG3894@momjian.us> (raw)
In-Reply-To: <22323.1589555218@sss.pgh.pa.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>
On Fri, May 15, 2020 at 11:06:58AM -0400, Tom Lane wrote:
> Bruce Momjian <bruce@momjian.us> writes:
> > Well, I would like both the SQL command references and the application
> > man pages to have xreflabel text.
>
> I guess my point is that in the other several thousand pages of the docs,
> we just use <xref linkend="sql-whatever"/> or <xref
> linkend="app-whatever"/>, and it looks fine and works fine. Why are you
> insisting on doing it differently in the release notes?
>
> (I also have a vague memory that we used to use special xref labels for
> SQL commands, and got rid of it. So this seems like undoing history
> with no solid reasoning. That was with the previous doc toolchain of
> course, but it's still the case that we don't seem to need this.)
I think I see it now. Our README.links says:
<xref>
use to get chapter/section number from the title of the target
--> link, or xreflabel if defined at the target, or refentrytitle if target
--> is a refentry; has no close tag
http://www.oasis-open.org/docbook/documentation/reference/html/xref.html
I was not aware that refentry can pull from refentrytitle. I just
tested it for pg_upgrade, and it worked fine. I will adjust the release
notes now to use them. Thanks.
--
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, tgl@sss.pgh.pa.us
Subject: Re: Adding xreflable
In-Reply-To: <20200515153034.GG3894@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