doc: enable creation of PDF files

HISTORY

@@ -4,6 +4,7 @@
         repmgr: improve "--dry-run" behaviour for "standby promote" and
           "standby switchover" (Ian)
         repmgrd: monitor standbys attached to primary (Ian)
+        general: documentation converted to DocBook XML format (Ian)
 
 4.3.1   2019-??-??
         repmgr: ensure BDR2-specific functionality cannot be used on

doc/Makefile

@@ -18,6 +18,10 @@ ifndef XSLTPROC
 XSLTPROC = $(missing) xsltproc
 endif
 
+ifndef FOP
+FOP = $(missing) fop
+endif
+
 override XSLTPROCFLAGS += --stringparam repmgr.version '$(REPMGR_VERSION)'
 
 GENERATED_SGML = version.sgml
@@ -53,6 +57,32 @@ zip: html
 	zip -r repmgr-docs-$(REPMGR_VERSION).zip repmgr-docs-$(REPMGR_VERSION)
 	rm -rf repmgr-docs-$(REPMGR_VERSION)
 
+##
+## Print
+##
+
+repmgr.pdf:
+	$(error Invalid target; use repmgr-A4.pdf or repmgr-US.pdf as targets)
+
+# Standard paper size
+
+repmgr-A4.fo: stylesheet-fo.xsl repmgr.sgml $(ALLSGML)
+	$(XMLLINT) $(XMLINCLUDE) --noout --valid $(word 2,$^)
+	$(XSLTPROC) $(XMLINCLUDE) $(XSLTPROCFLAGS) --stringparam paper.type A4 -o $@ $(wordlist 1,2,$^)
+
+repmgr-A4.pdf: repmgr-A4.fo
+	$(FOP) -fo $< -pdf $@
+
+# North American paper size
+
+repmgr-US.fo: stylesheet-fo.xsl repmgr.sgml $(ALLSGML)
+	$(XMLLINT) $(XMLINCLUDE) --noout --valid $(word 2,$^)
+	$(XSLTPROC) $(XMLINCLUDE) $(XSLTPROCFLAGS) --stringparam paper.type USletter -o $@ $(wordlist 1,2,$^)
+
+repmgr-US.pdf: repmgr-US.fo
+	$(FOP) -fo $< -pdf $@
+
+
 install: html
 	@$(MKDIR_P) $(DESTDIR)$(docdir)/$(docmoduledir)/repmgr
 	@$(INSTALL_DATA) $(wildcard html/*.html) $(wildcard html/*.css) $(DESTDIR)$(docdir)/$(docmoduledir)/repmgr

doc/appendix-release-notes.sgml

@@ -88,7 +88,8 @@
               as currently used by the main PostgreSQL project.
               This means it can now be built against any &repmgr; version
               (previously it was not possible to build the documentation against
-              PostgreSQL 10 or later).
+              PostgreSQL 10 or later), and makes it easier to provide the documentation
+              in other formats such as PDF.
             </para>
             <para>
               For further details see: <xref linkend="installation-build-repmgr-docs"/>

doc/install-requirements.sgml

@@ -93,7 +93,7 @@
     <table id="repmgr-compatibility-matrix">
       <title>&repmgr; compatibility matrix</title>
 
-      <tgroup cols="2">
+      <tgroup cols="3">
         <thead>
           <row>
             <entry>

doc/install-source.sgml

@@ -244,7 +244,18 @@ deb-src http://apt.postgresql.org/pub/repos/apt/ stretch-pgdg main</programlisti
     written in DocBook XML format. To build it locally as HTML, you'll need to
     install the required packages as described in the
     <ulink url="https://www.postgresql.org/docs/current/docguide-toolsets.html">
-      PostgreSQL documentation</ulink> then execute:
+      PostgreSQL documentation</ulink>.
+   </para>
+
+   <note>
+     <simpara>
+       In &repmgr; 4.3 and earlier, the documentation can only be built against
+       PostgreSQL 9.6 or earlier.
+     </simpara>
+   </note>
+
+   <para>
+     To build the documentation as HTML, execute:
    <programlisting>
     cd doc/ &amp;&amp; make</programlisting>
    </para>
@@ -260,12 +271,14 @@ deb-src http://apt.postgresql.org/pub/repos/apt/ stretch-pgdg main</programlisti
     cd doc/ &amp;&amp; make repmgr.html</programlisting>
    </para>
 
-   <note>
+   <para>
-     <simpara>
+     To build the documentation as a PDF file, after configuring and building
-       In &repmgr; 4.3 and earlier, the documentation can only be built against
+     the main &repmgr; source as described above, execute:
-       PostgreSQL 9.6 or earlier.
+   <programlisting>
-     </simpara>
+    cd doc/ &amp;&amp; make repmgr-A4.pdf</programlisting>
-   </note>
+   </para>
+
+
  </sect2>
 
 </sect1>

doc/repmgr.sgml

@@ -51,7 +51,7 @@
      &repmgr; is fully supported by 2ndQuadrant's
      <ulink url="https://www.2ndquadrant.com/en/support/support-postgresql/">24/7 Production Support</ulink>.
      2ndQuadrant, a Major Sponsor of the PostgreSQL project, continues to develop and maintain &repmgr;.
-     Other companies as well as individual developers are welcome to participate in the efforts.
+     Other organisations as well as individual developers are welcome to participate in the efforts.
    </para>
   </abstract>