Skip to content

Commit 684cf76

Browse files
committed
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.
1 parent 3709ca1 commit 684cf76

File tree

6 files changed

+280
-255
lines changed

6 files changed

+280
-255
lines changed

doc/src/sgml/Makefile

+2-3
Original file line numberDiff line numberDiff line change
@@ -134,9 +134,8 @@ INSTALL.html: %.html : stylesheet-text.xsl %.xml
134134
$(XMLLINT) --noout --valid $*.xml
135135
$(XSLTPROC) $(XSLTPROCFLAGS) $(XSLTPROC_HTML_FLAGS) $^ >$@
136136

137-
INSTALL.xml: standalone-install.sgml installation.sgml version.sgml
138-
$(OSX) $(SPFLAGS) $(SGMLINCLUDE) -x lower $(filter-out version.sgml,$^) >$@.tmp
139-
$(call mangle-xml,chapter)
137+
INSTALL.xml: standalone-profile.xsl standalone-install.xml postgres.xml
138+
$(XSLTPROC) $(XSLTPROCFLAGS) --xinclude $(wordlist 1,2,$^) >$@
140139

141140

142141
##

doc/src/sgml/filelist.sgml

-9
Original file line numberDiff line numberDiff line change
@@ -190,12 +190,3 @@
190190

191191
<!-- back matter -->
192192
<!ENTITY biblio SYSTEM "biblio.sgml">
193-
194-
<!--
195-
Some parts of the documentation are also source for some plain-text
196-
files used during installation. To selectively ignore or include
197-
some parts (e.g., external xref's) when generating these files we use
198-
these parameter entities. See also standalone-install.sgml.
199-
-->
200-
<!ENTITY % standalone-ignore "INCLUDE">
201-
<!ENTITY % standalone-include "IGNORE">

0 commit comments

Comments
 (0)