More doc boilerplate

This commit is contained in:
Ian Barwick
2017-09-12 11:22:31 +09:00
parent d8c2f66c5b
commit 0c64b90427
5 changed files with 122 additions and 9 deletions

View File

@@ -24,7 +24,7 @@ all: html
html: html-stamp
html-stamp: bdr.sgml $(ALLSGML) $(GENERATED_SGML) stylesheet.dsl website-docs.css
html-stamp: repmgr.sgml $(ALLSGML) $(GENERATED_SGML) stylesheet.dsl website-docs.css
$(MKDIR_P) html
$(JADE.html.call) -i include-index $<
cp $(srcdir)/stylesheet.css $(srcdir)/website-docs.css html/
@@ -32,10 +32,10 @@ html-stamp: bdr.sgml $(ALLSGML) $(GENERATED_SGML) stylesheet.dsl website-docs.cs
version.sgml: ${repmgr_top_builddir}/repmgr_version.h
{ \
echo "<!ENTITY bdrversion \"$(REPMGR_VERSION)\">"; \
echo "<!ENTITY repmgrversion \"$(REPMGR_VERSION)\">"; \
} > $@
HTML.index: bdr.sgml $(ALMOSTALLSGML) stylesheet.dsl
HTML.index: repmgr.sgml $(ALMOSTALLSGML) stylesheet.dsl
@$(MKDIR_P) html
$(JADE.html.call) -V html-index $<
@@ -59,13 +59,13 @@ maintainer-clean:
rm -rf Makefile
zip: html
cp -r html bdr-docs-$(REPMGR_VERSION)
zip -r bdr-docs-$(REPMGR_VERSION).zip bdr-docs-$(REPMGR_VERSION)
rm -rf bdr-docs-$(REPMGR_VERSION)
cp -r html repmgr-docs-$(REPMGR_VERSION)
zip -r repmgr-docs-$(REPMGR_VERSION).zip repmgr-docs-$(REPMGR_VERSION)
rm -rf repmgr-docs-$(REPMGR_VERSION)
install: html
@$(MKDIR_P) $(DESTDIR)$(docdir)/$(docmoduledir)/bdr
@$(INSTALL_DATA) $(wildcard html/*.html) $(wildcard html/*.css) $(DESTDIR)$(docdir)/$(docmoduledir)/bdr
@echo Installed docs to $(DESTDIR)$(docdir)/$(docmoduledir)/bdr
@$(MKDIR_P) $(DESTDIR)$(docdir)/$(docmoduledir)/repmgr
@$(INSTALL_DATA) $(wildcard html/*.html) $(wildcard html/*.css) $(DESTDIR)$(docdir)/$(docmoduledir)/repmgr
@echo Installed docs to $(DESTDIR)$(docdir)/$(docmoduledir)/repmgr
.PHONY: html all

31
doc/filelist.sgml Normal file
View File

@@ -0,0 +1,31 @@
<!-- doc/filelist.sgml -->
<!ENTITY legal SYSTEM "legal.sgml">
<!ENTITY bookindex SYSTEM "bookindex.sgml">
<!--
Some parts of the documentation are also source for some plain-text
files used during installation. To selectively ignore or include
some parts (e.g., external xref's) when generating these files we use
these parameter entities. See also standalone-install.sgml.
-->
<!ENTITY % standalone-ignore "INCLUDE">
<!ENTITY % standalone-include "IGNORE">
<!--
By default, no index is included. Use -i include-index on the command line
to include it.
-->
<!ENTITY % include-index "IGNORE">
<!--
Create empty index element for processing by XSLT stylesheet.
-->
<!ENTITY % include-xslt-index "IGNORE">
<!--
Include external documentation sections
-->
<!ENTITY overview SYSTEM "overview.sgml">

7
doc/overview.sgml Normal file
View File

@@ -0,0 +1,7 @@
<chapter id="overview" xreflabel="Overview">
<title>repmgr overview</title>
<para>
repmgr is repmgr.
</para>
</chapter>

74
doc/repmgr.sgml Normal file
View File

@@ -0,0 +1,74 @@
<!-- doc/src/sgml/postgres.sgml -->
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
<!ENTITY % version SYSTEM "version.sgml">
%version;
<!ENTITY % filelist SYSTEM "filelist.sgml">
%filelist;
<!ENTITY repmgr "<productname>repmgr</productname>">
<!ENTITY postgres "<productname>PostgreSQL</productname>">
]>
<book id="repmgr">
<title>repmgr &repmgrversion; Documentation</title>
<bookinfo>
<corpauthor>2ndQuadrant Ltd</corpauthor>
<productname>repmgr</productname>
<productnumber>&repmgrversion;</productnumber>
&legal;
<abstract>
<para>
This book is the official documentation of repmgr &repmgrversion; for
use with PostgreSQL 9.6 or with a modified version of PostgreSQL 9.4.
It has been written by the &postgres; and repmgr developers and other
volunteers in parallel to the development of the repmgr software. It
describes all the functionality that the current version of repmgr officially
supports.
</para>
<para>
repmgr was developed by
<ulink url="http://2ndquadrant.com">2ndQuadrant</ulink>
along with contributions from other individuals and companies.
Contributions from the community are appreciated and welcome - get
in touch via <ulink url="http://github.com/2ndQuadrant/bdr">github</>
or <ulink url="https://groups.google.com/a/2ndquadrant.com/forum/#!forum/bdr-list">the mailing list/forum</>.
Multiple 2ndQuadrant customers contribute funding
to make repmgr development possible.
</para>
<para>
2ndQuadrant, a Platinum sponsor of the PostgreSQL project,
continues to develop repmgr to meet internal needs and those of customers.
Other companies as well as individual developers
are welcome to participate in the efforts.
</para>
<keywordset>
<keyword>repmgr</keyword>
</keywordset>
</bookinfo>
<part id="getting-started">
<title>Getting started</title>
&overview;
</part>
<part id="manual" xreflabel="repmgr administration manual">
<title>repmgr administration manual</title>
</part>
<![%include-index;[&bookindex;]]>
<![%include-xslt-index;[<index id="bookindex"></index>]]>
</book>

1
doc/version.sgml Normal file
View File

@@ -0,0 +1 @@
<!ENTITY repmgrversion "">