Howto Validate AsciiDoc3 DocBook 5.1

Published: 2020-08-06

DocBook is the de-facto standard for technical documentation; AsciiDoc3 uses DocBook version 4.5 by default - and this is sufficient for many (or the most) use cases. But 4.5 is feature frozen, the current version is DocBook 5.1. If you want to use the flexibility and the more modern conception of DocBook51, AsciiDoc3 supports you - probably the only software that comes with this feature: AsciiDoc Markup → DocBook51!

To obtain a docbook51 xml document, just compute:

asciidoc3 -b docbook51 test.txt

The text.xml file should be (highly recommended) validated before further processing. That means, a tool checks if all rules of the DocBook5.1 definition written in RelaxNG and Schematron have been included. We have to go two steps with two different tools: first to ensure the Relax Schema, second, the Schematron Schema.

You find the RelaxNG Schema and the tools in your distribution
/tests/docbook_validation/rng-docbook51.rng and online:

https://gitlab.com/asciidoc3/asciidoc3/-/tree/master/tests/docbook_validation

- ...
- asciidoc3_docbook51_relaxng_validation.py
- asciidoc3_docbook51_schematron_validation.py
- ...

The tools name show its purpose. You can validate just one file or all files in a distinct directory:

python3 ./tests/docbook_validation/asciidoc3_docbook51_relaxng_validation.py path/to/docbook_file.xml

python3 ./tests/docbook_validation/asciidoc3_docbook51_relaxng_validation.py

The tools refer to the following third party tools (you don’t need all of them):

  • xmllint

  • jing

  • sun java msv

  • lxml

  • xmlstarlet

Probably the easiest to handle are xmllint and lxml - see the docstring of the tools for more inormation. You can disable a program that is not present.
Find more information about AsciiDoc3’s full support of DocBook 5.1 in your distribution ../doc/readme_docbook51.txt or read online: https://gitlab.com/asciidoc3/asciidoc3/-/blob/master/doc/readme_docbook51.txt

Keywords: AsciiDoc3 3.2.0 DocBook v5.1 Validator RelaxNG Schematron Standalone HowTo

New Release 3.2.0 is in

Published: 2020-04-16

The new release is out:
AsciiDoc3-3.2.0

You’ll see some new features:

  • Full DocBook v5.1 support,

  • DocBook45 and DocBook51 validator (RelaxNG and Schematron included!),

  • Full support for installing via a Windows virtual envronment (venv),

  • Faster than ever,

  • . . .

To obtain the new version look here

Keywords: AsciiDoc3 3.2.0 DocBook v5.1 Validator Schematron Windows venv PyPI

Transition to New Release Starts

Published: 2020-04-14

Good news right now as the Easter holiday begins: the transition to the new AsciiDoc3 release 3.2.0 starts today. From now on you can download the release candidate on our server. This is not a beta, all of our tests look good - but we want to be sure and wait for a second battery of tests to run.
A shortened list of the new features:

  • Full (!) DocBook v5.1 support,

  • DocBook45 and DocBook51 validator (RelaxNG and Schematron included!),

  • Faster than ever,

  • . . .

In the next days the deb/rpm/zip/pypi files will follow …

wget https://asciidoc3.org/asciidoc3-3.2.0rc.tar.gz

(Edited 2020-04-11: md5sum asciidoc3-3.2.0rc.tar.gz a0cbef0ecaf9e9957a6adf284da9817a)

(Update 2020-04-14): New version 3.2.0 available via PyPI. This is not a beta, it’s the release candidate.

No virtual environment (venv):

pip3 install --index-url https://test.pypi.org/simple --user asciidoc3==3.2.0b1

With virtual environment (venv):

pip3 install --index-url https://test.pypi.org/simple asciidoc3==3.2.0b1

Keywords: AsciiDoc3 New Release DocBook v5.1 Validator Schematron Tarball PyPI

New Release 3.2.0 is in

Published: 2020-04-16

The new release is out:
AsciiDoc3-3.2.0
You’ll see some new features:

  • Full DocBook v5.1 support,

  • DocBook45 and DocBook51 validator (RelaxNG and Schematron included!),

  • Full support for installing via a Windows virtual envronment (venv),

  • Faster than ever,

  • . . .

To obtain the new version look here

Keywords: AsciiDoc3 3.2.0 DocBook v5.1 Validator Schematron Windows venv PyPI

AsciiDoc(3) standardization process

Published: 2020-02-16

The AsciiDoc MarkUp Language has become one of the leading tools for (not only) technical documentation and writing. But - perhaps you wonder at this - there exists no language definition or standardization. To change this, a working group using the Eclipse Foundation Specification Process was initiated, see more info here.
AsciiDoc3 has joined the group but it is too early to rate this process. We’ll see in the next months what happens and shall report from time to time.

Keywords: asciidoc3 standardization eclipse

To Top ↑