Re: Adding xreflable - Mailing list pgsql-docs

From Bruce Momjian
Subject Re: Adding xreflable
Date
Msg-id 20200515142204.GE3894@momjian.us
Whole thread Raw
In response to Re: Adding xreflable  (Tom Lane <tgl@sss.pgh.pa.us>)
Responses Re: Adding xreflable
List pgsql-docs
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 +



pgsql-docs by date:

Previous
From: "Daniel Westermann (DWE)"
Date:
Subject: Relnotes for 13: There is word missing in UUID generation sentence
Next
From: Bruce Momjian
Date:
Subject: Re: Relnotes for 13: There is word missing in UUID generationsentence