Re: [COMMITTERS] pgsql: Remove unnecessary xref endterm attributes and title ids The

From: Peter Eisentraut <peter_e(at)gmx(dot)net>
To: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
Cc: pgsql-docs(at)postgreSQL(dot)org
Subject: Re: [COMMITTERS] pgsql: Remove unnecessary xref endterm attributes and title ids The
Date: 2010-04-04 20:26:14
Message-ID: 1270412774.7026.2.camel@vanquo.pezone.net
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-committers pgsql-docs

On lör, 2010-04-03 at 11:15 -0400, Tom Lane wrote:
> > Remove unnecessary xref endterm attributes and title ids
>
> > The endterm attribute is mainly useful when the toolchain does not support
> > automatic link target text generation for a particular situation. In the
> > past, this was required by the man page tools for all reference page links,
> > but that is no longer the case, and it now actually gets in the way of
> > proper automatic link text generation. The only remaining use cases are
> > currently xrefs to refsects.
>
> I won't miss the need to write endterm, but what's the "remaining use
> cases" exactly? You need to explain to other people what's the new
> dispensation, if you don't want it to get messed up again.

Right, the upshot is that if the toolchain complains like this

openjade:indices.sgml:101:28:E: [xref to REFSECT2 unsupported]

then it means it cannot create a linkend text automatically and you need
to supply the endterm attribute to tell it what text to use. If it
doesn't complain, endterm should probably not be used.

In response to

Browse pgsql-committers by date

  From Date Subject
Next Message Tom Lane 2010-04-05 00:42:24 pgsql: Improve phrasing of warning message for NOTIFY queue getting too
Previous Message Tom Lane 2010-04-03 21:46:59 pgsql: Minor wording improvement.

Browse pgsql-docs by date

  From Date Subject
Next Message Devrim GÜNDÜZ 2010-04-05 12:05:38 Re: PDF build issue with 9.0 Alpha5
Previous Message Tom Lane 2010-04-04 16:26:17 Re: Undocumented trick in SELECT?