Re: DocBook 5.2 - Mailing list pgsql-docs

On 27.09.22 09:12, Jürgen Purtz wrote:

Yeah, I think we'd have to convert all the supported versions to
make this palatable.  If the conversion is sufficiently automated,
that might not be a big lift.  (If it's *not* automated, I think
the change would never get off the ground even for HEAD, because
the docs are too much of a moving target.)

+1

The process is totally automated. There are general steps which work for every DocBook 4.x book. And there are Postgres-specific steps (doRealModifictions.sh) which looks for individual patterns per file. This is the critical part. Currently it's tested only with HEAD. My expectation is, that it should work also for translations to other languages because the patterns contain only elements and attributes, no text. But if they run against older versions it's likely that we need some changes or additional patterns. I'm willing to work on this if a) there is a consensus in the community that the work should go on and b) someone helps me to resolve the reported unacceptable runtime problem during PDF generation.

--

J. Purtz

DocBook 5.2 is published [1] [2].

This mail contains a new version of the PostgreSQL migration scripts (DocBook 4.5 format to 5.2 format). They are developed for PG versions 13 up to 17. Please see README.md for details. The generated output looks good at first glance, but: a) I don't have an idea how to guarantee that it looks REALLY identical at ALL places. Everyone is invited to search differences. b) pdf (resp. 'fo') cannot be generated. It seems to be a performance issue - a small number of test-pages works well. Concerning this issue I need help from someone with good xslt knowledge. c) On my laptop epub cannot be generated (for version 4.5 as well as for 5.2). dbtoepub is a ruby program.

Development and testing was done only at an Ubuntu 22.04 laptop. For those who want to see the results quickly, download [3] (converted sgml, html, and man files, 8MB) or [4] (plus postgres-full.xml, postgres.txt, html single page, 16 MB). The two files remain online for some days.

J. Purtz

[1] https://www.oasis-open.org/2024/02/13/the-docbook-schema-version-5-2-oasis-standard-published/
[2] https://github.com/docbook/docbook/releases/tag/5.2
[3] https://purtz.de/sgml_17beta1.zip
[4] https://purtz.de/sgml_17beta1_huge.zip

Compared to my last mail, the scripts have changed regarding the following topics:
- They use the current Docbook stylesheets 1.79.2 instead of 1.79.1 (cdn instead of sourceforge)
- All PG-stylesheets declare and use the Docbook namespace
- Implementation of different checks via 'diff'
- Elapsed time for all documentation generation targets is slightly better than with Docbook 4.5, especially for PDF generation

The README.md file reports the currently know problems and TODOs.

For those who want to see the results quickly, there is [1] for some time which contains migrated sgml, html, man, and PDF for 17beta2.

[1] https://purtz.de/sgml_17beta2.zip  (27MB)

J. Purtz