Name
cx:epubcheck — Checks the conformance of EPUB files.
Synopsis
| Input port | Primary | Sequence | Content types |
|---|---|---|---|
| source | ✔ | application/zip application/epub+zip |
| Output port | Primary | Sequence | Content types |
|---|---|---|---|
| result | ✔ | applicatin/zip application/epub+zip | |
| report | ✔ | xml json |
| Option name | Type | Default value |
|---|---|---|
| assert-valid | xs:boolean | true() |
| parameters | map(xs:QName,item()*)? | () |
| report-format | xs:string | 'xvrl' |
Declaration
1 |<p:declare-step xmlns:p="http://www.w3.org/ns/xproc">
| <p:input port="source" content-types="application/zip application/epub+zip"/>
| <p:output port="result"
| content-types="applicatin/zip application/epub+zip"
5 | primary="true"/>
| <p:output port="report" sequence="true" content-types="xml json"/>
| <p:option name="parameters" as="map(xs:QName,item()*)?"/>
| <p:option name="assert-valid" select="true()" as="xs:boolean"/>
| <p:option name="report-format" select="'xvrl'" as="xs:string"/>
10 |</p:declare-step>Installation
The cx:epubcheck step is not included in the standard XML Calabash release.
You must
obtain it separately
and install it on your classpath before you can use this step.
(More detailed instructions, T.B.D.)
Description
The cx:epubcheck step uses the
W3C
EPUBCheck validator to check the conformance of EPUB files. It
generates an XVRL report on the report port.
If assert-valid is true, any errors reported by EPUBCheck will
cause the step to fail.
Regardless of whether or not any warnings or errors are reported, the original EPUB file is passed from the source port to the result port without change.
Additional dependencies
In addition to the standard dependencies, the
cx:epubcheck step relies on these libraries:
- epubcheck, version 5.0.1
The underlying EPUBCheck library.