Get rid of parameterized marked sections in SGML
authorPeter Eisentraut <peter_e@gmx.net>
Fri, 15 Sep 2017 14:17:37 +0000 (10:17 -0400)
committerPeter Eisentraut <peter_e@gmx.net>
Wed, 27 Sep 2017 15:26:08 +0000 (11:26 -0400)
commit684cf76b83e9dc8aed12aeb9131d2208f61bd31f
tree717eec3b93fdefc609e931328eef2d843063122a
parent3709ca1cf069cee24ef8000cb6a479813b5537df
Get rid of parameterized marked sections in SGML

Previously, we created a variant of the installation instructions for
producing the plain-text INSTALL file by marking up certain parts of
installation.sgml using SGML parameterized marked sections.  Marked
sections will not work anymore in XML, so before we can convert the
documentation to XML, we need a new approach.

DocBook provides a "profiling" feature that allows selecting content
based on attributes, which would work here.  But it imposes a noticeable
overhead when building the full documentation and causes complications
when building some output formats, and given that we recently spent a
fair amount of effort optimizing the documentation build time, it seems
sad to have to accept that.

So as an alternative, (1) we create our own mini-profiling layer that
adjusts just the text we want, and (2) assemble the pieces of content
that we want in the INSTALL file using XInclude.  That way, there is no
overhead when building the full documentation and most of the "ugly"
stuff in installation.sgml can be removed and dealt with out of line.
doc/src/sgml/Makefile
doc/src/sgml/filelist.sgml
doc/src/sgml/installation.sgml
doc/src/sgml/standalone-install.sgml [deleted file]
doc/src/sgml/standalone-install.xml [new file with mode: 0644]
doc/src/sgml/standalone-profile.xsl [new file with mode: 0644]