epubcheck-transpect

XProc pipeline to check EPUBs for compliance with IDPF EPUB2/3, Amazon MOBI/KF8 and custom Schematron

Repository
Git URLhttps://github.com/transpect/epubcheck-transpect.git
SVN URLhttps://github.com/transpect/epubcheck-transpect
Base URIhttp://transpect.io/epubcheck-transpect/

Source ⬇

epubcheck:file-iteration

This step is used to unzip the EPUB and to generate an XML representation of the EPUB package.

Import

<p:import href="http://transpect.io/epubcheck-transpect/xpl/epubcheck-file-iteration.xpl"/>

Dependencies

Synopsis

<epubcheck:file-iteration xmlns:epubcheck="http://transpect.io/epubcheck">
  <p:input port="source" primary="true"/>
  <p:input port="params" primary="false"/>
  <p:output port="result" primary="true"/>
  <p:output port="report" sequence="true" primary="false"/>
  <p:option name="file" required="true"/>
  <p:option name="severity-default-name" select="'warning'"/>
  <p:option name="debug" select="'yes'"/>
  <p:option name="debug-dir-uri" select="'debug'"/>
  <p:option name="status-dir-uri" select="concat($debug-dir-uri, '/status')"/>
</epubcheck:file-iteration>

epubcheck:htmlreport

Takes the SVRL results and the HTML files and provide a HTML report of the EPUB package.

Import

<p:import href="http://transpect.io/epubcheck-transpect/xpl/epubcheck-htmlreport.xpl"/>

Dependencies

Synopsis

<epubcheck:htmlreport xmlns:epubcheck="http://transpect.io/epubcheck">
  <p:input port="source" primary="true"/>
  <p:input port="reports" sequence="true" primary="false"/>
  <p:input port="params" primary="false"/>
  <p:output port="result"/>
  <p:option name="debug" select="'yes'"/>
  <p:option name="debug-dir-uri" select="'debug'"/>
  <p:option name="status-dir-uri" select="concat($debug-dir-uri, '/status')"/>
  <p:option name="severity-default-name" select="'error'"/>
  <p:option name="report-title" select="'epubcheck'"/>
</epubcheck:htmlreport>

epubcheck:load-html

Loads the HTML files and parse their CSS style information.

Import

<p:import href="http://transpect.io/epubcheck-transpect/xpl/epubcheck-load-html.xpl"/>

Dependencies

Synopsis

<epubcheck:load-html xmlns:epubcheck="http://transpect.io/epubcheck">
  <p:input port="source"/>
  <p:output port="result" primary="true"/>
  <p:output port="report" primary="false"/>
  <p:option name="href" required="true"/>
  <p:option name="debug" select="'yes'"/>
  <p:option name="debug-dir-uri" select="'debug'"/>
  <p:option name="status-dir-uri" select="concat($debug-dir-uri, '/status')"/>
</epubcheck:load-html>

epubcheck:transpect

Checks EPUB for compatibility to IDPF EPUB, Amazon KF8/MOBI and various retailers. The can also use a custom Schematron file which is applied to an XML representation of the EPUB package.

Import

<p:import href="http://transpect.io/epubcheck-transpect/xpl/epubcheck-transpect.xpl"/>

Dependencies

Synopsis

<epubcheck:transpect xmlns:epubcheck="http://transpect.io/epubcheck">
  <p:input port="params" primary="true"/>
  <p:input port="schematron" sequence="true" primary="false"/>
  <p:output port="result"/>
  <p:option name="file" required="true"/>
  <p:option name="htmlreport" select="'report.html'"/>
  <p:option name="severity-default-name" select="'warning'"/>
  <p:option name="phase" select="''"/>
  <p:option name="debug" select="'yes'"/>
  <p:option name="debug-dir-uri" select="'debug'"/>
  <p:option name="status-dir-uri" select="concat($debug-dir-uri, '/status')"/>
</epubcheck:transpect>

epubcheck:validate

Validates the EPUB with Schematron and XProc wrappers for IDPF epubcheck and Amazon KindleGen.

Import

<p:import href="http://transpect.io/epubcheck-transpect/xpl/epubcheck-validate.xpl"/>

Dependencies

Synopsis

<epubcheck:validate xmlns:epubcheck="http://transpect.io/epubcheck">
  <p:input port="source" primary="true"/>
  <p:input port="params" primary="false"/>
  <p:input port="schematron" sequence="true" primary="false"/>
  <p:output port="result" primary="true"/>
  <p:output port="report" sequence="true" primary="false"/>
  <p:option name="file" required="true"/>
  <p:option name="debug" select="'yes'"/>
  <p:option name="debug-dir-uri" select="'debug'"/>
  <p:option name="status-dir-uri" select="concat($debug-dir-uri, '/status')"/>
</epubcheck:validate>

GitHub sync date: 2017-07-06+02:00