DTBook Validator

This module validates a single DTBook document. It supports the following:

DTBook 2005-3 (with or without MathML 2/3)
DTBook 2005-2 (with or without MathML 2/3)
DTBook 2005-1
1.1.0

The input document is validated against RelaxNG schema and additional schematron rules. If the check-images option is true, then the validator ensures that any referenced images exist on disk.

Synopsis

Inputs

DTBook

The input DTBook document.
Media-type:
- application/x-dtbook+xml
Sequence: no

Reports

Validation report

Outputs

Validation report in XML and HTML

Validation report in two formats: the raw XML-formatted report, which is a concatenation of the reports from all types of validation used (RelaxNG, Schematron and custom), and the HTML-formatted version.

Validation report in two formats: the raw XML-formatted report, which is a concatenation of the reports from all types of validation used (RelaxNG, Schematron and custom), and the HTML-formatted version.
More details on the XML format.
Media-type:
- text
Raw validation report

Raw XML-formatted report which is a concatenation of the reports from all types of validation used (RelaxNG, Schematron and custom).

Raw XML-formatted report which is a concatenation of the reports from all types of validation used (RelaxNG, Schematron and custom).
More details on the file format.

Options

Check that images exist

Check to see that referenced images exist on disk.

Possible values: true or false

Default value: false
MathML version

Version of MathML in the DTBook file(s).

Possible values: One of the following:

3.0

2.0

Default value: 3.0
Validate against NIMAS 1.1

Validate using NIMAS 1.1 rules for DTBook.

Possible values: true or false

Default value: false

Usage: dp2 [GLOBAL_OPTIONS] dtbook-validator [OPTIONS]

Options:

--source source	The input DTBook document.
--check-images [check-images]	Check that images exist (default: `false`)
--mathml-version [mathml-version]	MathML version (default: `3.0`)
--nimas [nimas]	Validate against NIMAS 1.1 (default: `false`)
-o,--output [OUTPUT]	Path where to store the results. This option is mandatory when the job is not executed in the background
-z,--zip	Write the output to a zip file rather than to a folder
-n,--nicename [NICENAME]	Set job's nice name
-r,--priority [PRIORITY]	Set job's priority (high\|medium\|low)
-q,--quiet	Do not print the job's messages
-p,--persistent	Delete the job after it is executed
-b,--background	Sends the job and exits

Sample usage

This section shows how to use the DTBook Validator via the Pipeline 2 command line interface.

Run the script like this:

$ ./dp2 dtbook-validator
        --x-input-dtbook file:/path/to/book/dtbook.xml
        --o-result /tmp/t1
        --o-report /tmp/t2
        --o-html-report /tmp/t3
        --o-validation-status /tmp/t4
        --x-output-dir /tmp/dpout 

Make sure the directory /tmp/dpout already exists.

Also note the special syntax for the input file option, which has changed in this update (July 2013):

--x-input-dtbook file:/path/to/book/dtbook.xml

When execution is complete, you will see these files in the output directory that you specified:

dtbook-validation-report.xml
dtbook-validation-report.xhtml

Note: If instead of using the --x-output-dir option to put all output in one directory, you would rather specify a file path for each file, then just use the output parameters (prefixed by --o). Above they are shown as temp files (e.g. /tmp/t1) but they could just as easily store their output anywhere (e.g. /path/to/output/my-report.xml).

They are as follows:

`dtbook-validation-report.xml`

Raw validation output from DTBook validation. See ValidationReportXML for details on the file format.

`dtbook-validation-report.xhtml`

XHTML file containing a summary of all validation errors for the DTBook file.