Schematron plugin

Parent: DITA-OT Plugins

org.doctales.schematron is a DITA-OT plugin for validating DITA-XML files with Schematron. This plugins is based on ph-schematron.

Installing the Plugin

  1. Move to the ~/bin directory of the DITA-OT.

  2. Install the plugin using the dita command.

    dita --install https://github.com/doctales/org.doctales.schematron/archive/master.zip

Using the Plugin

You need to either set the ‘schematron.map.validation.files’ and/or ‘schematron.map.validation.files’ property. The validation is then triggered automatically after the DITA-OT preprocessing phase.

Parameters

ParameterValuesDescription

schematron.processing.engine

"schematron", "xslt", "pure"

Default: pure

Engine used to validate DITA maps and topics
schematron.map.validation.files


Comma separated list of Schematron files for map validation
schematron.topic.validation.files

Comma separated list of Schematron files for topic validation
schematron.fail

"true", "false"

Default: true

Indicates, whether the build should fail, if a role fires with a certain role level.
schematron.failon.fatal

"true", "false"

Default: true

Indicates, whether the build should fail, if a Schematron rule with role 'fatal' is fired.
schematron.failon.error

"true", "false"

Default: true

Indicates, whether the build should fail, if a Schematron rule with role 'error' is fired.
schematron.failon.warning

"true", "false"

Default: false

Indicates, whether the build should fail, if a Schematron rule with role 'warning' is fired.
schematron.failon.info

"true", "false"

Default: false

Indicates, whether the build should fail, if a Schematron rule with role 'info' is fired.