Re: Docbook 5.x

From: Alexander Law <exclusion(at)gmail(dot)com>
To: Peter Eisentraut <peter(dot)eisentraut(at)2ndquadrant(dot)com>, obartunov(at)gmail(dot)com, Alvaro Herrera <alvherre(at)2ndquadrant(dot)com>, Alexander Lakhin <a(dot)lakhin(at)postgrespro(dot)ru>
Cc: Jürgen Purtz <juergen(at)purtz(dot)de>, pgsql-docs(at)postgresql(dot)org
Subject: Re: Docbook 5.x
Date: 2016-11-16 11:30:32
Message-ID: aab72af9-928c-e116-d342-804bf78911c6@gmail.com
Views: Raw Message | Whole Thread | Download mbox
Thread:
Lists: pgsql-docs

Hello Peter,

I saw that you committed the patch to switch the html build to XSLT by
default.
So It seems, now we can continue the move to XML.
I'd suggest to move in several steps.
Please see the attached scripts.
The main script is 7_check_conversion.sh. It performs all the conversion
and checks whether the html output is the same.
I suggest to split conversion in three commits.
Commit#0 is for manual corrections - it replaces "<" with "&lt;" and so
on in some sgml's and it doesn't affect the build or outputs.
It needed just for the next step - automatic conversion. These changes
to sgml's are countable and observable.

Commit#1 performs conversion of all SGML's to make them compatible with
XML (as much as possible). (Thanks to Jurgen for his sgml2xml.pl script.)
These changes to sgml's are massive, but they are produced
automatically, so we need just to check the script and make sure that
the output is the same.
After that commit we still can use SGML build.

And the last commit, commit#2 is for switching to XML. At that point
doc/src/sgml renamed to doc/src/xml, build environment modified and
cleaned, but changes in sgml/xml are minimal, so we can observe and
check them.

After the commit#2 we get all our docs in XML (DocBook 4.2) and can
build it just as we did with 'make html/man/...' before.
Maybe the commit#2 should be applied later, but commits #0 and #1 are
not intrusive and can be applied anytime.

Best regards,
Alexander

Attachment Content-Type Size
pg-doc.check.tar.bz2 application/x-bzip 20.7 KB

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Gunnar "Nick" Bluth 2016-11-16 12:57:13 Re: Missing important information in backup.sgml
Previous Message Gunnar "Nick" Bluth 2016-11-16 10:37:12 Missing important information in backup.sgml