htmlreports

XProc steps for RelaxNG and Schematron validation and HTML reports

Repository
Git URL https://github.com/transpect/htmlreports.git
SVN URL https://github.com/transpect/htmlreports
Base URI http://transpect.io/htmlreports/

Source ⬇

tr:assemble-schematron

This step takes a cascade path parameter file as input and looks for a directory entitled schematron in each cascade level directory. The Schematron files within these directories are loaded and assembled. The most specific Schematron patterns override ones from more general cascade levels.

Import

<p:import href="http://transpect.io/htmlreports/xpl/assemble-schematron.xpl"/>

Dependencies

Synopsis

<tr:assemble-schematron xmlns:tr="http://transpect.io">
  <p:input port="paths" primary="true"/>
  <p:output port="result" primary="true"/>
  <p:output port="report" sequence="true" primary="false"/>
  <p:option name="debug" required="false" select="'no'"/>
  <p:option name="debug-dir-uri" select="'debug'"/>
  <p:option name="status-dir-uri" select="'status?enabled=false'"/>
  <p:option name="schematron-rule-msg" select="'no'"/>
</tr:assemble-schematron>

tr:check-styles

Import

<p:import href="http://transpect.io/htmlreports/xpl/check-styles.xpl"/>

Dependencies

Synopsis

<tr:check-styles xmlns:tr="http://transpect.io">
  <p:input port="source" primary="true"/>
  <p:input port="html-in"/>
  <p:input port="styledoc-xslt"/>
  <p:input port="parameters" primary="true"/>
  <p:output port="result" primary="true"/>
  <p:output port="doc-and-template-styles"/>
  <p:output port="report" sequence="true"/>
  <p:output port="schema" sequence="true"/>
  <p:output port="styledoc"/>
  <p:output port="htmlreport" sequence="true"/>
  <p:option name="debug" required="false" select="'no'"/>
  <p:option name="debug-dir-uri" select="'debug'"/>
  <p:option name="status-dir-uri" required="false" select="'status?enabled=false'"/>
  <p:option name="active" required="false" select="'true'"/>
  <p:option name="step-name" required="false" select="'sch_styles'"/>
  <p:option name="cssa" select="'styles/simple-template.cssa.xml'"/>
  <p:option name="differentiate-by-style" required="false" select="'false'"/>
  <p:option name="load-cssa-cascade" required="false" select="false()"/>
</tr:check-styles>

tr:errorPI2svrl

Import

<p:import href="http://transpect.io/htmlreports/xpl/errorPI2svrl.xpl"/>

Dependencies

Synopsis

<tr:errorPI2svrl xmlns:tr="http://transpect.io">
  <p:input port="source" primary="true"/>
  <p:input port="errorPI2svrl-xsl"/>
  <p:output port="result" primary="true"/>
  <p:output port="report" sequence="true"/>
  <p:option name="group-by-srcpath" required="false" select="'yes'"/>
  <p:option name="debug" required="false" select="'no'"/>
  <p:option name="debug-dir-uri" select="'debug'"/>
  <p:option name="status-dir-uri" select="'status?enabled=false'"/>
  <p:option name="pi-names" required="false" select="'letex'"/>
  <p:option name="severity" required="false" select="'warning'"/>
  <p:option name="step-name" select="''"/>
</tr:errorPI2svrl>

tr:htmlreports-summary

Pipeline for creating a meta HTML Report file: summarize all reports in one file.

Import

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

Dependencies

Synopsis

<tr:htmlreports-summary xmlns:tr="http://transpect.io">
  <p:input port="source"/>
  <p:input port="stylesheet"/>
  <p:option name="report-dir" required="true"/>
  <p:option name="recursive" required="false" select="'no'"/>
  <p:option name="htmlreport-file-regex" required="false" select="'^.*.report.xhtml$'"/>
  <p:option name="summary-report-filename" required="false" select="'reports.xhtml'"/>
  <p:option name="language" required="false" select="'en'"/>
  <p:option name="debug" required="false" select="'no'"/>
  <p:option name="debug-dir-uri" required="false" select="resolve-uri('debug')"/>
  <p:option name="status-dir-uri" required="false" select="'status'"/>
</tr:htmlreports-summary>

tr:list-checking-rules

Import

<p:import href="http://transpect.io/htmlreports/xpl/list-checking-rules.xpl"/>

Dependencies

Synopsis

<tr:list-checking-rules xmlns:tr="http://transpect.io">
  <p:input port="source" sequence="true" primary="true"/>
  <p:input port="stylesheet"/>
  <p:input port="parameters" primary="true"/>
  <p:output port="result" primary="true"/>
  <p:option name="debug" required="false" select="'no'"/>
  <p:option name="debug-dir-uri" select="'debug'"/>
  <p:option name="status-dir-uri" select="'status?enabled=false'"/>
  <p:option name="report-title" required="false" select="''"/>
  <p:option name="interface-language" required="false" select="'en'"/>
</tr:list-checking-rules>

tr:patch-svrl

This step patches error report(s) into an HTML document and provide an HTML report.

Import

<p:import href="http://transpect.io/htmlreports/xpl/patch-svrl.xpl"/>

Dependencies

Synopsis

<tr:patch-svrl xmlns:tr="http://transpect.io">
  <p:input port="source" primary="true"/>
  <p:input port="reports" sequence="true"/>
  <p:input port="params" primary="true"/>
  <p:output port="result" primary="true"/>
  <p:output port="secondary" sequence="true"/>
  <p:output port="msgs"/>
  <p:output port="severity-totals"/>
  <p:option name="debug" required="false" select="'no'"/>
  <p:option name="debug-dir-uri" select="'debug'"/>
  <p:option name="status-dir-uri" select="'status?enabled=false'"/>
  <p:option name="fail-on-error" select="'false'"/>
  <p:option name="max-errors-per-rule" required="false" select="'200'"/>
  <p:option name="severity-default-name" required="false" select="'no-role'"/>
  <p:option name="report-title" required="false" select="''"/>
  <p:option name="show-adjusted-srcpath" select="'yes'"/>
  <p:option name="discard-empty-schematron-outputs" required="false" select="'no'"/>
  <p:option name="suppress-embedding" select="''"/>
  <p:option name="suppress-embedding-by-fileext" select="'eps pdf tif tiff wmf'"/>
  <p:option name="max-base64-encoded-size-kb" select="1000"/>
</tr:patch-svrl>

tr:validate-with-rng-svrl

This step validates an XML document with a RelaxNG schema and provides the validation results as schematron report. The source XML document is also the primary output. The report output port provides the schematron report.

Import

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

Dependencies

Synopsis

<tr:validate-with-rng-svrl xmlns:tr="http://transpect.io">
  <p:input port="source" primary="true"/>
  <p:input port="schema" primary="false"/>
  <p:input port="errorPI2svrl-xsl"/>
  <p:output port="report" sequence="true"/>
  <p:output port="result" primary="true"/>
  <p:option name="debug" select="'yes'"/>
  <p:option name="debug-dir-uri" select="'debug'"/>
  <p:option name="status-dir-uri" select="'status?enabled=false'"/>
  <p:option name="remove-srcpaths" required="false" select="'true'"/>
  <p:option name="group-by-srcpath" required="false" select="'no'"/>
  <p:option name="step-name" select="''"/>
</tr:validate-with-rng-svrl>

tr:validate-with-schematron

Import

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

Dependencies

Synopsis

<tr:validate-with-schematron xmlns:tr="http://transpect.io">
  <p:input port="source" sequence="true" primary="true"/>
  <p:input port="html-in" sequence="true"/>
  <p:input port="parameters" primary="true"/>
  <p:output port="result" sequence="true" primary="true"/>
  <p:output port="report" sequence="true"/>
  <p:output port="htmlreport" sequence="true"/>
  <p:output port="schema" sequence="true"/>
  <p:option name="debug" required="false" select="'no'"/>
  <p:option name="debug-dir-uri" select="'debug'"/>
  <p:option name="status-dir-uri" select="'status?enabled=false'"/>
  <p:option name="phase" required="false" select="'#ALL'"/>
  <p:option name="active" required="false" select="'true'"/>
  <p:option name="schematron-rule-msg" select="'no'"/>
</tr:validate-with-schematron>

tr:validate-with-schematron2

Import

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

Synopsis

<tr:validate-with-schematron2 xmlns:tr="http://transpect.io">
  <p:input port="source" sequence="true" primary="true"/>
  <p:input port="html-in" sequence="true"/>
  <p:input port="schema"/>
  <p:input port="parameters" primary="true"/>
  <p:output port="result" sequence="true" primary="true"/>
  <p:output port="report" sequence="true"/>
  <p:output port="htmlreport" sequence="true"/>
  <p:option name="debug" required="false" select="'no'"/>
  <p:option name="debug-dir-uri"/>
  <p:option name="status-dir-uri"/>
  <p:option name="phase" select="'#ALL'"/>
</tr:validate-with-schematron2>

GitHub sync date: 2024-03-06+01:00