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

petere@postgresql.org (Peter Eisentraut) writes:
> Log Message:
> -----------
> 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.

            regards, tom lane

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.