<indexterm> with <secondary>

From: Alvaro Herrera <alvherre(at)alvh(dot)no-ip(dot)org>
To: Pg Docs <pgsql-docs(at)postgresql(dot)org>
Subject: <indexterm> with <secondary>
Date: 2017-03-15 16:05:25
Message-ID: 20170315160525.42x4wxtdhk3sa522@alvherre.pgsql
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

While reviewing Tomas' extended statistics patch I noticed that the new
docbook toolchain produces additional links for each indexterm, based on
the <secondary> tags there are. For instance, in 9.5 I see this:

statistics, Aggregate Functions, The Statistics Collector
of the planner, Statistics Used by the Planner, Updating Planner Statistics
https://www.postgresql.org/docs/9.5/static/bookindex.html#AEN186176

while in 10 I see this for the same source:

statistics, Aggregate Functions, Statistics Used by the Planner, Updating Planner Statistics, The Statistics Collector
of the planner, Statistics Used by the Planner, Updating Planner Statistics
https://www.postgresql.org/docs/devel/static/bookindex.html#indexdiv-S

Note that the links for entries on the <secondary>of the planner</> also
show up in the first list of links.

Is this intended? As we get more <secondary> entries, this gets busy
real quick, for no gain that I can see. For instance, I added this
entry:

<indexterm zone="extended-statistics">
<primary>statistics</primary>
<secondary>of the planner</secondary>
<tertiary>extended</tertiary>
</indexterm>

and this results in:

statistics, Aggregate Functions, Statistics Used by the Planner, Updating Planner Statistics, The Statistics Collector, Extended Statistics
of the planner, Statistics Used by the Planner, Updating Planner Statistics, Extended Statistics
extended, Extended Statistics

which seems altogether excessive. Perhaps this is a bug in the index
generation?

FWIW I'm leaning towards removing the <tertiary> in the new entry, which
results in this:

statistics, Aggregate Functions, Statistics Used by the Planner, Updating Planner Statistics, The Statistics Collector, Extended Statistics
of the planner, Statistics Used by the Planner, Updating Planner Statistics, Extended Statistics

I think this would be better:

statistics, Aggregate Functions, The Statistics Collector
of the planner, Statistics Used by the Planner, Updating Planner Statistics, Extended Statistics

--
Álvaro Herrera Developer, https://www.PostgreSQL.org/
Licensee shall have no right to use the Licensed Software
for productive or commercial use. (Licencia de StarOffice 6.0 beta)

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Alexander Law 2017-03-16 14:44:01 Re: <indexterm> with <secondary>
Previous Message Tom Lane 2017-03-14 13:36:14 Re: DECLARE syntax is different from the 2016 SQL standard