Documentation generation with xtpxlib-xdoc

xtpxlib-xdoc is part of the xtpxlib library. xtpxlib contains software for processing XML, using languages like XSLT and XProc. It consists of several separate components, all named xtpxlib-*. Everything can be found on GitHub (https://github.com/xatapult).

The xtpxlib-xdoc component contains an XProc (1.0 and 3.0) based DocBook publication toolchain.

• Starting point is some narrative written in DocBook, with the following extensions:

  • Parameter references that are expanded (for dates, times, phrases, names, etc.)

  • Special elements that trigger conversions. These conversions can insert generated DocBook into the source. For instance complex tables, documentation, etc.

• The resulting "pure" DocBook can be used for further processing.

• The component contains specific pipelines for converting the DocBook to PDF and XHTML

Installation and usage information can be found on xtpxlib's main website https://www.xtpxlib.org.

Technical information:

Component documentation: https://xdoc.xtpxlib.org

License: GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007

Git URI: git@github.com:xatapult/xtpxlib-xdoc.git

Git site: https://github.com/xatapult/xtpxlib-xdoc

This component depends on:

• xtpxlib-container (Support for XML containers (multiple files wrapped into one))

• xtpxlib-common (Common component: Shared libraries and IDE support)

Release information:

v2.0 - 2023-07-19 (current)

Added XProc 3.0 support.

v1.1.2 - 2020-11-30

Various small changes and fixes

v1.1.1 - 2020-10-15

Added id-suffix option to generating code documentation.

When XProc options are declared twice (using @use-when), only the first is used.

v1.1 - 2020-05-01

Updated the DocBook to PDF conversion (added footnotes, callouts, nested tables, etc.).

v1.0.A - 2020-02-16

New logo and minor fixes.

(Abbreviated. Full release information in README.md)