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 10:22:04 -0400
Message-ID: <20200515142204.GE3894@momjian.us> (raw)
In-Reply-To: <19807.1589551746@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>
On Fri, May 15, 2020 at 10:09:06AM -0400, Tom Lane wrote:
> Bruce Momjian <bruce@momjian.us> writes:
> > On Fri, May 15, 2020 at 09:37:30AM -0400, Tom Lane wrote:
> >> Why? Our convention generally is to refer to the command, not to the ref
> >> page as such.
>
> > Uh, for the release notes, I am referencing the doc page about the
> > feature, and without the xref, I have to mention it twice, e.g.:
>
> Oh, you're talking about the application man pages not the SQL command
> ones. I'd still be inclined to solve it with something paralleling
> the way we handle SQL command references.
Well, I would like both the SQL command references and the application
man pages to have xreflabel text.
> Quickly comparing the pgupgrade page to a couple of SQL commands,
> it's not real obvious what is missing. Maybe there's something
> in the stylesheet support, not the ref pages as such?
I would like to change this:
<refentry id="pgupgrade">
to
<refentry id="pgupgrade" xreflabel="pg_upgrade">
so I can do this in the release notes:
<xref linkend="pgupgrade"/>
and not:
<link linkend="pgupgrade"><application>pg_upgrade</link>
All the other extensions already do this:
<sect1 id="sepgsql" xreflabel="sepgsql">
--
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: <20200515142204.GE3894@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