Обсуждение: remove endterms and title ids

Поиск
Список
Период
Сортировка

remove endterms and title ids

От
Peter Eisentraut
Дата:
The attached patch removes endterm attributes from xref elements and the
associated id attributes on title elements.

Older documentation toolchains could not automatically generate text for
xrefs into refentries, so we had to use the endterm attribute to tell it
which text to create.  This is no longer necessary and can be removed.
In most cases, we can just rely on the automatically generated text.  In
the cases where that doesn't work, use the link element instead to
create the desired text locally instead of relying on text at a remote
location.

(This also removed a few spurious warnings in the FOP build as an
incidental benefit.)

-- 
Peter Eisentraut              http://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services

Вложения

Re: remove endterms and title ids

От
Alvaro Herrera
Дата:
Peter Eisentraut wrote:
> The attached patch removes endterm attributes from xref elements and the
> associated id attributes on title elements.
> 
> Older documentation toolchains could not automatically generate text for
> xrefs into refentries, so we had to use the endterm attribute to tell it
> which text to create.  This is no longer necessary and can be removed.
> In most cases, we can just rely on the automatically generated text.

So we had
   There are several caveats to be aware of when using this option — see
   _Building Indexes Concurrently_.

and with this patch we end up with
   There are several caveats to be aware of when using this option — see
   _the section called “Building Indexes Concurrently”_.

which looks pretty ugly to me.  I think getting rid of the
mostly-pointless id attributes is a good motivation, but I wonder if
there's a way to retain the text as originally generated.

-- 
Álvaro Herrera                https://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services


Re: remove endterms and title ids

От
Alvaro Herrera
Дата:
Can we have it emit something like 
   see section 4.5.3 “Building Indexes Concurrently”
by customizing the stylesheets?  I tried to figure out where the text is
emitted, but 'sectioncalled' does not appear in greps anywhere in the
docbooc-xsl dir.

-- 
Álvaro Herrera                https://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services


Re: remove endterms and title ids

От
Peter Eisentraut
Дата:
On 12/22/17 09:53, Alvaro Herrera wrote:
> Can we have it emit something like 
>    see section 4.5.3 “Building Indexes Concurrently”
> by customizing the stylesheets?  I tried to figure out where the text is
> emitted, but 'sectioncalled' does not appear in greps anywhere in the
> docbooc-xsl dir.

But these are sections inside ref pages, so they don't have numbers.

-- 
Peter Eisentraut              http://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services