switching documentation build to XSLT

From: Peter Eisentraut <peter(dot)eisentraut(at)2ndquadrant(dot)com>
To: pgsql-hackers <pgsql-hackers(at)postgresql(dot)org>
Subject: switching documentation build to XSLT
Date: 2016-11-10 13:49:55
Message-ID: 2cdfe551-eb7b-b319-c96d-0d53cc0c2db8@2ndquadrant.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs pgsql-hackers

Some work has been going on recently to be able to update our
documentation build tool chain. After discussion on pgsql-docs, the
people involved agree that it is time to move forward.

We are now proposing that we change the way the HTML documentation is
built from jade/openjade+docbook-dsssl to xsltproc+docbook-xsl.

If you can build the man pages now (make man, also included in make
world), then you don't need any new tools. The new HTML build will be
using the same tools. Otherwise, follow the documentation to set up
those tools and make that work.

The actual patch to make this change is attached. For the build
process, nothing changes, e.g., 'make' or 'make html' will still have
the same purposes.

For the time being, you will still be able to build the documentation
the old way with 'make oldhtml', but this is mainly so that we can
compare the output and work out any formatting kinks. Before this
patch, you can also build the documentation the new way using 'make
xslthtml', but that will go away.

I will submit a separate patch to the web site team to update the CSS
style sheets for the web site to match the new output.

There are more steps to be done after this, to move over the other
output formats (PDF), adjust the configure script, the documentation,
work out any remaining formatting problems, etc., so now is a good time
to get this rolling so that we have a good chance of reaching a steady
state before the end of the development cycle.

--
Peter Eisentraut http://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services

Attachment Content-Type Size
0001-Build-HTML-documentation-using-XSLT-stylesheets-by-d.patch text/x-patch 3.6 KB

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Euler Taveira 2016-11-10 14:46:34 Re: misleading ALTER TABLE SET STORAGE
Previous Message Alexander Law 2016-11-09 10:00:19 Re: Docbook 5.x

Browse pgsql-hackers by date

  From Date Subject
Next Message Kuntal Ghosh 2016-11-10 13:52:56 Re: Unlogged tables cleanup
Previous Message Fujii Masao 2016-11-10 13:35:14 Re: Adding in docs the meaning of pg_stat_replication.sync_state