remove endterms and title ids

Started by Peter Eisentrautalmost 9 years ago4 messagesdocs
Beta feature

Hackorum builds and tests every patch posted to the lists, not only commitfest submissions. This is Hackorum's own CI rather than the PostgreSQL project's, and it is still under testing - please report anything that looks wrong.

won't retrysuccessCI history

You can run a PostgreSQL built from this patch straight from Docker, with no checkout and no build:

docker run --rm -p 5432:5432 ghcr.io/hackorum-dev/postgres-patch:t76106
psql -h localhost -U postgres

Built from patchset v1 (message #1), July 27, 2026 at 09:33 PM.

Every patchset is also pushed to a branch of our PostgreSQL fork, so you can check out the same tree CI built. Without a PostgreSQL checkout:

git clone --branch t76106_1 https://github.com/hackorum-dev/postgres.git

In a checkout you already have, add the fork once:

git remote add hackorum https://github.com/hackorum-dev/postgres.git

then, for this patchset and every later one:

git fetch hackorum t76106_1 && git checkout t76106_1

Patchset v1 (message #1) is on t76106_1

Jump to latest
#1Peter Eisentraut
peter_e@gmx.net

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

Attachments:

t76106_1
0001-Remove-endterms-and-title-ids.patchtext/plain; charset=UTF-8; name=0001-Remove-endterms-and-title-ids.patch; x-mac-creator=0; x-mac-type=0Download+104-138
#2Alvaro Herrera
alvherre@2ndquadrant.com
In reply to: Peter Eisentraut (#1)
Re: remove endterms and title ids

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

#3Alvaro Herrera
alvherre@2ndquadrant.com
In reply to: Alvaro Herrera (#2)
Re: remove endterms and title ids

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

#4Peter Eisentraut
peter_e@gmx.net
In reply to: Alvaro Herrera (#3)
Re: remove endterms and title ids

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