Re: <indexterm> with <secondary>

From: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
To: Alexander Law <exclusion(at)gmail(dot)com>
Cc: Alvaro Herrera <alvherre(at)alvh(dot)no-ip(dot)org>, Pg Docs <pgsql-docs(at)postgresql(dot)org>
Subject: Re: <indexterm> with <secondary>
Date: 2017-10-25 20:23:20
Message-ID: 23010.1508963000@sss.pgh.pa.us
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

Alexander Law <exclusion(at)gmail(dot)com> writes:
> These duplicate entries caused by the zone attribute. If you'll remove
> it, you'll get only single entry (in secondary line).
> It seems that the following DocBook bugfix introduced the bug you
> encountered:
> https://github.com/docbook/xslt10-stylesheets/commit/f555842b

> I see the following solutions for the issue:
> 1. To customize this xsl template (remove @zone check) for our docs.
> 2. To remove @zone specification from indexterm's.
> Are there any reasons to specify it explicitly?

According to my understanding, the use of "zone" means that the
indexterm entry refers to the whole section named by the "zone" label,
not only the physical point the entry is at. So I think our usage
is correct in principle; for example, this would allow an index entry
to say something like "Section 4.2" not just "page 435". In practice,
though, the distinction seems merely pedantic: AFAICS it does not
affect either HTML output (which always gives you a hyperlink to the
containing section) or PDF output (which always gives you a page number).

So we could run around and remove the zone tags, but that still seems
like rather a grotty answer --- maybe someday we'd want them back,
if the doc toolchain were ever improved to make effective use of them.

How complicated is the "customize the xsl template" solution?

(BTW, I do not see the extra-entries bug at all in PDF output.)

regards, tom lane

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Alexander Lakhin 2017-10-26 06:40:11 Re: <indexterm> with <secondary>
Previous Message Alexander Lakhin 2017-10-25 15:06:57 Re: Duplicative index entries in v10/HEAD builds