xerif

Open Source Typesetting System

Repository
Git URL https://github.com/transpect/xerif.git
SVN URL https://github.com/transpect/xerif

Source ⬇

tx:bits2epub

Dependencies

Synopsis

<tx:bits2epub xmlns:tx="http://transpect.io/xerif">
  <p:input port="source" primary="true"/>
  <p:input port="params" primary="false"/>
  <p:input port="meta" primary="false"/>
  <p:output port="result" primary="true"/>
  <p:output port="html" primary="false"/>
  <p:option name="out-dir-uri" select="'out'"/>
  <p:option name="debug" select="'yes'"/>
  <p:option name="debug-dir-uri" select="'debug'"/>
  <p:option name="status-dir-uri" select="'status'"/>
</tx:bits2epub>

tx:copy-images

This step is used to copy the images into the output directory and patch the XML filerefs accordingly.

Dependencies

Synopsis

<tx:copy-images xmlns:tx="http://transpect.io/xerif">
  <p:input port="source" primary="true"/>
  <p:input port="params" primary="false"/>
  <p:output port="result" primary="true"/>
  <p:option name="debug" required="false" select="'no'"/>
  <p:option name="debug-dir-uri"/>
  <p:option name="fail-on-error" select="'true'"/>
</tx:copy-images>

tx:customer-outputs

Dependencies

Synopsis

<tx:customer-outputs xmlns:tx="http://transpect.io/xerif">
  <p:input port="source" primary="true"/>
  <p:input port="params" primary="false"/>
  <p:output port="result" sequence="true"/>
  <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="resolve-uri('status')"/>
</tx:customer-outputs>

tx:docx2evolve

Dependencies

Synopsis

<tx:docx2evolve xmlns:tx="http://transpect.io/xerif">
  <p:input port="source" sequence="true" primary="true"/>
  <p:input port="meta" sequence="true" primary="false"/>
  <p:output port="result" primary="true"/>
  <p:output port="hub-flat" primary="false"/>
  <p:output port="hub-rich" primary="false"/>
  <p:output port="report" sequence="true"/>
  <p:option name="file" required="true"/>
  <p:option name="out-dir-uri" select="'out'"/>
  <p:option name="table-headers-and-footers-from-tblLook" select="'no'"/>
  <p:option name="debug" select="'yes'"/>
  <p:option name="debug-dir-uri" select="'debug'"/>
  <p:option name="status-dir-uri" select="'status'"/>
  <p:option name="interface-language" select="'de'"/>
</tx:docx2evolve>

tx:evolve-hub

Dependencies

Synopsis

<tx:evolve-hub xmlns:tx="http://transpect.io/xerif">
  <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="debug" required="false" select="'no'"/>
  <p:option name="debug-dir-uri" select="'debug'"/>
  <p:option name="debug-indent" select="'false'"/>
  <p:option name="status-dir-uri" select="'status'"/>
</tx:evolve-hub>

tx:export-chunks

Dependencies

Synopsis

<tx:export-chunks xmlns:tx="http://transpect.io/xerif">
  <p:input port="source" primary="true"/>
  <p:input port="tei" primary="false"/>
  <p:input port="paths" primary="false"/>
  <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="resolve-uri('status')"/>
</tx:export-chunks>

tx:generate-xmp

This step creates from the input file an XMP metadata document.

Dependencies

Synopsis

<tx:generate-xmp xmlns:tx="http://transpect.io/xerif">
  <p:input port="source" primary="true"/>
  <p:input port="meta" primary="false"/>
  <p:input port="params" primary="false"/>
  <p:output port="result" primary="true"/>
  <p:option name="debug" required="false" select="'no'"/>
  <p:option name="debug-dir-uri"/>
  <p:option name="fail-on-error" select="'true'"/>
</tx:generate-xmp>

tx:get-paths

Generate clades document from recursive directory listing and evaluate matching clades for input file.

Dependencies

Synopsis

<tx:get-paths xmlns:tx="http://transpect.io/xerif">
  <p:input port="params"/>
  <p:output port="result" primary="true"/>
  <p:output port="report" sequence="true" primary="false"/>
  <p:option name="file" required="true"/>
  <p:option name="debug"/>
  <p:option name="debug-dir-uri"/>
  <p:option name="status-dir-uri"/>
</tx:get-paths>

tx:html2epub

Dependencies

Synopsis

<tx:html2epub xmlns:tx="http://transpect.io/xerif">
  <p:input port="source" primary="true"/>
  <p:input port="params" primary="false"/>
  <p:input port="meta" primary="false"/>
  <p:output port="result" primary="true"/>
  <p:output port="html" primary="false"/>
  <p:output port="report" sequence="true" primary="false"/>
  <p:option name="out-dir-uri" select="'out'"/>
  <p:option name="debug" select="'yes'"/>
  <p:option name="debug-dir-uri" select="'debug'"/>
  <p:option name="status-dir-uri" select="'status'"/>
</tx:html2epub>

tx:htmlreport

Converts TEI XML to HTML and creates an HTML report with existing SVRL reports.

Dependencies

Synopsis

<tx:htmlreport xmlns:tx="http://transpect.io/xerif">
  <p:input port="source" primary="true"/>
  <p:input port="paths" primary="false"/>
  <p:input port="reports" sequence="true" primary="false"/>
  <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'"/>
</tx:htmlreport>

tx:hub2epub

Dependencies

Synopsis

<tx:hub2epub xmlns:tx="http://transpect.io/xerif">
  <p:input port="source" primary="true"/>
  <p:input port="params" primary="false"/>
  <p:input port="meta" primary="false"/>
  <p:output port="result" primary="true"/>
  <p:output port="xml" primary="false"/>
  <p:output port="report" sequence="true" primary="false"/>
  <p:output port="epub-path" primary="false"/>
  <p:option name="out-dir-uri" select="'out'"/>
  <p:option name="debug" select="'yes'"/>
  <p:option name="debug-dir-uri" select="'debug'"/>
  <p:option name="status-dir-uri" select="'status'"/>
  <p:option name="interface-language" select="'de'"/>
  <p:option name="output-xml" select="'tei'"/>
</tx:hub2epub>

tx:hub2idml

Dependencies

Synopsis

<tx:hub2idml xmlns:tx="http://transpect.io/xerif">
  <p:input port="source" primary="true"/>
  <p:input port="paths" primary="false"/>
  <p:output port="idmlval"/>
  <p:output port="idml" sequence="true"/>
  <p:option name="template" select="'xml2idml/template.idml'"/>
  <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="resolve-uri('status')"/>
</tx:hub2idml>

tx:insert-meta

This step transforms the metadata to hub and inserts it into the source document.

Dependencies

Synopsis

<tx:insert-meta xmlns:tx="http://transpect.io/xerif">
  <p:input port="source" primary="true"/>
  <p:input port="params" primary="false"/>
  <p:input port="meta" primary="false"/>
  <p:output port="result"/>
  <p:option name="debug" select="'no'"/>
  <p:option name="debug-dir-uri" select="'debug'"/>
</tx:insert-meta>

tx:load-meta

This pipeline serves as wrapper for a tr:dynamic-transformation-pipeline where you can specify your customer-specific metadata loading. The output of tr:dynamic-transformation-pipeline is expedted to be an hub info element containing the metadata as DocBook representation.

Dependencies

Synopsis

<tx:load-meta xmlns:tx="http://transpect.io/xerif">
  <p:input port="source"/>
  <p:output port="result" sequence="true" primary="false"/>
  <p:output port="report" sequence="true" primary="false"/>
  <p:option name="debug" select="'no'"/>
  <p:option name="debug-dir-uri" select="'debug'"/>
</tx:load-meta>

tx:main

Converts docx to hub and generates LaTeX and an HTML report

Dependencies

Synopsis

<tx:main xmlns:tx="http://transpect.io/xerif">
  <p:input port="params" primary="true"/>
  <p:input port="schema" primary="false"/>
  <p:output port="result" primary="true"/>
  <p:output port="tex" primary="false"/>
  <p:output port="html" primary="false"/>
  <p:output port="htmlreport" primary="false"/>
  <p:output port="hub-flat" primary="false"/>
  <p:output port="hub-rich" primary="false"/>
  <p:output port="epub-path" primary="false"/>
  <p:option name="file" required="true"/>
  <p:option name="out-dir-uri" select="'out'"/>
  <p:option name="debug" select="'yes'"/>
  <p:option name="debug-dir-uri" select="'debug'"/>
  <p:option name="status-dir-uri" select="'status'"/>
  <p:option name="interface-language" select="'de'"/>
  <p:option name="layout" select="'c'"/>
  <p:option name="toc-depth" select="3"/>
  <p:option name="numbering-depth" select="3"/>
  <p:option name="title-pages" select="'yes'"/>
  <p:option name="notes-type" select="'footnotes'"/>
  <p:option name="notes-per-chapter" select="'no'"/>
  <p:option name="endnotes-with-chapter" select="'no'"/>
  <p:option name="notes-per-chapter-notoc" select="'yes'"/>
  <p:option name="pubtype" select="'mono'"/>
  <p:option name="running-header" select="'no'"/>
  <p:option name="run-local" select="'no'"/>
  <p:option name="file-ext" select="'docx'"/>
  <p:option name="create-idml" required="false" select="'no'"/>
  <p:option name="idml-target-uri"/>
</tx:main>

tx:tei2epub

Dependencies

Synopsis

<tx:tei2epub xmlns:tx="http://transpect.io/xerif">
  <p:input port="source" primary="true"/>
  <p:input port="params" primary="false"/>
  <p:input port="meta" primary="false"/>
  <p:output port="result" primary="true"/>
  <p:output port="html" primary="false"/>
  <p:option name="out-dir-uri" select="'out'"/>
  <p:option name="debug" select="'yes'"/>
  <p:option name="debug-dir-uri" select="'debug'"/>
  <p:option name="status-dir-uri" select="'status'"/>
</tx:tei2epub>

tx:validate

Validates TEI with RelaxNG and Schematron and generates SVRL reports.

Dependencies

Synopsis

<tx:validate xmlns:tx="http://transpect.io/xerif">
  <p:input port="source" primary="true"/>
  <p:input port="paths" primary="false"/>
  <p:input port="epub-file-uri" primary="false"/>
  <p:input port="schema" primary="false"/>
  <p:input port="hub" sequence="true" primary="false"/>
  <p:output port="result" primary="true"/>
  <p:output port="reports" sequence="true" primary="false"/>
  <p:option name="debug" select="'yes'"/>
  <p:option name="debug-dir-uri" select="'debug'"/>
  <p:option name="status-dir-uri" select="'status'"/>
  <p:option name="interface-language" select="'de'"/>
</tx:validate>

tx:xml2tex

Dependencies

Synopsis

<tx:xml2tex xmlns:tx="http://transpect.io/xerif">
  <p:input port="source" primary="true"/>
  <p:input port="params" primary="false"/>
  <p:output port="result"/>
  <p:option name="debug" select="'no'"/>
  <p:option name="debug-dir-uri" select="'debug'"/>
  <p:option name="status-dir-uri" select="'status'"/>
</tx:xml2tex>

GitHub sync date: 2024-04-23+02:00