modules-cascade.html

<?xml version="1.0" encoding="UTF-8"?><html xmlns="http://www.w3.org/1999/xhtml" xml:base="../modules-cascade.html">
   <head>
      <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
      <title>cascade</title>
      <meta name="viewport" content="width=device-width, initial-scale=1.0" />
      <meta http-equiv="X-UA-Compatible" content="IE=edge" />
      <meta name="theme-color" content="#FF9800" />
      <link rel="apple-touch-icon-precomposed" href="icons/apple-touch-icon-152x152.png" />
      <meta name="msapplication-TileImage" content="icons/mstile-144x144.png" />
      <link rel="icon" href="icons/favicon-32x32.png" sizes="32x32" />
      <link type="text/css" rel="stylesheet" media="screen,projection" href="css/prism.css" />
      <link type="text/css" rel="stylesheet" media="screen,projection" href="css/materialize.min.css" />
      <link type="text/css" rel="stylesheet" media="screen,projection" href="css/le-tex.css" />
   </head>
   <body id="modules-cascade">
      <header>
         <div class="container"><a href="#" data-activates="tr-nav" class="button-collapse top-nav circle hide-on-large-only"><i class="mdi-navigation-menu"></i></a></div>
         <ul id="tr-nav" class="side-nav fixed" style="width:260px">
            <li class="logo"><a id="logo-container" href="#" class="brand-logo"><object id="front-page-logo" type="image/svg+xml" data="icons/logo-transpect.svg">Your browser does not support SVG</object></a></li>
            <li class="naventry-1st"><a href="index.html">About</a></li>
            <li class="naventry-1st"><a href="getting-started.html">Getting Started</a></li>
            <li class="active no-padding">
               <ul class="collapsible collapsible-accordion">
                  <li class="active naventry-1st" id="d42574e418"><a class="active collapsible-header">Modules</a><div style="display:block" class="collapsible-body">
                        <ul>
                           <li class="naventry-2nd"><a href="modules-CoCoTeX.html">CoCoTeX</a></li>
                           <li class="naventry-2nd"><a href="modules-ace-daisy.html">ace-daisy</a></li>
                           <li class="naventry-2nd"><a href="modules-basex-svn-api.html">basex-svn-api</a></li>
                           <li class="naventry-2nd"><a href="modules-bib-parser.html">bib-parser</a></li>
                           <li class="naventry-2nd"><a href="modules-bits2hub.html">bits2hub</a></li>
                           <li class="naventry-2nd"><a href="modules-calabash-distro.html">calabash-distro</a></li>
                           <li class="naventry-2nd"><a href="modules-calabash-frontend.html">calabash-frontend</a></li>
                           <li class="active naventry-2nd"><a href="modules-cascade.html">cascade</a></li>
                           <li class="naventry-2nd"><a href="modules-control.html">control</a></li>
                           <li class="naventry-2nd"><a href="modules-control-backend.html">control-backend</a></li>
                           <li class="naventry-2nd"><a href="modules-crossref.html">crossref</a></li>
                           <li class="naventry-2nd"><a href="modules-css-tools.html">css-tools</a></li>
                           <li class="naventry-2nd"><a href="modules-docx2hub.html">docx2hub</a></li>
                           <li class="naventry-2nd"><a href="modules-docx2hub-frontend.html">docx2hub-frontend</a></li>
                           <li class="naventry-2nd"><a href="modules-docx2jats-demo.html">docx2jats-demo</a></li>
                           <li class="naventry-2nd"><a href="modules-docx2tex.html">docx2tex</a></li>
                           <li class="naventry-2nd"><a href="modules-docx_modify-lib.html">docx_modify-lib</a></li>
                           <li class="naventry-2nd"><a href="modules-epub-font-subsetter.html">epub-font-subsetter</a></li>
                           <li class="naventry-2nd"><a href="modules-epub2epub.html">epub2epub</a></li>
                           <li class="naventry-2nd"><a href="modules-epub2hub-lib.html">epub2hub-lib</a></li>
                           <li class="naventry-2nd"><a href="modules-epubcheck-extension.html">epubcheck-extension</a></li>
                           <li class="naventry-2nd"><a href="modules-epubcheck-idpf.html">epubcheck-idpf</a></li>
                           <li class="naventry-2nd"><a href="modules-epubcheck-transpect.html">epubcheck-transpect</a></li>
                           <li class="naventry-2nd"><a href="modules-epubtools.html">epubtools</a></li>
                           <li class="naventry-2nd"><a href="modules-epubtools-frontend.html">epubtools-frontend</a></li>
                           <li class="naventry-2nd"><a href="modules-evolve-hub.html">evolve-hub</a></li>
                           <li class="naventry-2nd"><a href="modules-font-obfuscate-extension.html">font-obfuscate-extension</a></li>
                           <li class="naventry-2nd"><a href="modules-fontmaps.html">fontmaps</a></li>
                           <li class="naventry-2nd"><a href="modules-github-api.html">github-api</a></li>
                           <li class="naventry-2nd"><a href="modules-html2hub.html">html2hub</a></li>
                           <li class="naventry-2nd"><a href="modules-html2xlsx.html">html2xlsx</a></li>
                           <li class="naventry-2nd"><a href="modules-htmlreports.html">htmlreports</a></li>
                           <li class="naventry-2nd"><a href="modules-htmltables.html">htmltables</a></li>
                           <li class="naventry-2nd"><a href="modules-htmltemplates.html">htmltemplates</a></li>
                           <li class="naventry-2nd"><a href="modules-hub2bits.html">hub2bits</a></li>
                           <li class="naventry-2nd"><a href="modules-hub2dbk.html">hub2dbk</a></li>
                           <li class="naventry-2nd"><a href="modules-hub2docx-frontend.html">hub2docx-frontend</a></li>
                           <li class="naventry-2nd"><a href="modules-hub2docx-lib.html">hub2docx-lib</a></li>
                           <li class="naventry-2nd"><a href="modules-hub2html.html">hub2html</a></li>
                           <li class="naventry-2nd"><a href="modules-hub2tei.html">hub2tei</a></li>
                           <li class="naventry-2nd"><a href="modules-idml2xml.html">idml2xml</a></li>
                           <li class="naventry-2nd"><a href="modules-idml2xml-frontend.html">idml2xml-frontend</a></li>
                           <li class="naventry-2nd"><a href="modules-idml_docx-to-docbook_epub-demo.html">idml_docx-to-docbook_epub-demo</a></li>
                           <li class="naventry-2nd"><a href="modules-idmlvalidation.html">idmlvalidation</a></li>
                           <li class="naventry-2nd"><a href="modules-image-props-extension.html">image-props-extension</a></li>
                           <li class="naventry-2nd"><a href="modules-image-transform-extension.html">image-transform-extension</a></li>
                           <li class="naventry-2nd"><a href="modules-jats2html.html">jats2html</a></li>
                           <li class="naventry-2nd"><a href="modules-javascript-extension.html">javascript-extension</a></li>
                           <li class="naventry-2nd"><a href="modules-jing-trang-patch.html">jing-trang-patch</a></li>
                           <li class="naventry-2nd"><a href="modules-kindlegen-amzn.html">kindlegen-amzn</a></li>
                           <li class="naventry-2nd"><a href="modules-latex-math-images.html">latex-math-images</a></li>
                           <li class="naventry-2nd"><a href="modules-logo.html">logo</a></li>
                           <li class="naventry-2nd"><a href="modules-map-style-names.html">map-style-names</a></li>
                           <li class="naventry-2nd"><a href="modules-markdown2hub.html">markdown2hub</a></li>
                           <li class="naventry-2nd"><a href="modules-mathtype-extension.html">mathtype-extension</a></li>
                           <li class="naventry-2nd"><a href="modules-mml-normalize.html">mml-normalize</a></li>
                           <li class="naventry-2nd"><a href="modules-mml2tex.html">mml2tex</a></li>
                           <li class="naventry-2nd"><a href="modules-nlm-stylechecker.html">nlm-stylechecker</a></li>
                           <li class="naventry-2nd"><a href="modules-officeopenxml-validation.html">officeopenxml-validation</a></li>
                           <li class="naventry-2nd"><a href="modules-pdf2fxl.html">pdf2fxl</a></li>
                           <li class="naventry-2nd"><a href="modules-proj-eval.html">proj-eval</a></li>
                           <li class="naventry-2nd"><a href="modules-pygmentize-xpl.html">pygmentize-xpl</a></li>
                           <li class="naventry-2nd"><a href="modules-rng-extension.html">rng-extension</a></li>
                           <li class="naventry-2nd"><a href="modules-schema-bits.html">schema-bits</a></li>
                           <li class="naventry-2nd"><a href="modules-schema-html.html">schema-html</a></li>
                           <li class="naventry-2nd"><a href="modules-schema-jats.html">schema-jats</a></li>
                           <li class="naventry-2nd"><a href="modules-schema-onix.html">schema-onix</a></li>
                           <li class="naventry-2nd"><a href="modules-schematron.html">schematron</a></li>
                           <li class="naventry-2nd"><a href="modules-sdox2hub.html">sdox2hub</a></li>
                           <li class="naventry-2nd"><a href="modules-semex.html">semex</a></li>
                           <li class="naventry-2nd"><a href="modules-split-docx.html">split-docx</a></li>
                           <li class="naventry-2nd"><a href="modules-stylemapper-frontend.html">stylemapper-frontend</a></li>
                           <li class="naventry-2nd"><a href="modules-stylemapper-lib.html">stylemapper-lib</a></li>
                           <li class="naventry-2nd"><a href="modules-svn-extension.html">svn-extension</a></li>
                           <li class="naventry-2nd"><a href="modules-tei2bits.html">tei2bits</a></li>
                           <li class="naventry-2nd"><a href="modules-tei2html.html">tei2html</a></li>
                           <li class="naventry-2nd"><a href="modules-tei2hub.html">tei2hub</a></li>
                           <li class="naventry-2nd"><a href="modules-tokenized-to-tree.html">tokenized-to-tree</a></li>
                           <li class="naventry-2nd"><a href="modules-transpect.github.io.html">transpect.github.io</a></li>
                           <li class="naventry-2nd"><a href="modules-transpectdoc.html">transpectdoc</a></li>
                           <li class="naventry-2nd"><a href="modules-unwrap-mml.html">unwrap-mml</a></li>
                           <li class="naventry-2nd"><a href="modules-unzip-extension.html">unzip-extension</a></li>
                           <li class="naventry-2nd"><a href="modules-upload-webcomponent.html">upload-webcomponent</a></li>
                           <li class="naventry-2nd"><a href="modules-use-css-decorator-classes.html">use-css-decorator-classes</a></li>
                           <li class="naventry-2nd"><a href="modules-xerif.html">xerif</a></li>
                           <li class="naventry-2nd"><a href="modules-xerif-demo.html">xerif-demo</a></li>
                           <li class="naventry-2nd"><a href="modules-xerif-latex.html">xerif-latex</a></li>
                           <li class="naventry-2nd"><a href="modules-xlsx2html-frontend.html">xlsx2html-frontend</a></li>
                           <li class="naventry-2nd"><a href="modules-xlsx2html-lib.html">xlsx2html-lib</a></li>
                           <li class="naventry-2nd"><a href="modules-xml2idml.html">xml2idml</a></li>
                           <li class="naventry-2nd"><a href="modules-xml2tex.html">xml2tex</a></li>
                           <li class="naventry-2nd"><a href="modules-xproc-util.html">xproc-util</a></li>
                           <li class="naventry-2nd"><a href="modules-xproc3kit.html">xproc3kit</a></li>
                           <li class="naventry-2nd"><a href="modules-xslt-util.html">xslt-util</a></li>
                        </ul>
                     </div>
                  </li>
               </ul>
            </li>
            <li class="naventry-1st"><a href="styleguide.html">Styleguide</a></li>
            <li class="naventry-1st"><a href="tutorial.html">Tutorials</a></li>
         </ul>
      </header>
      <main>
         <div class="section orange" id="index-banner">
            <div class="container">
               <h1 id="tr-title" class="light header center-on-small-only white-text">cascade</h1>
               <h4 id="tr-subtitle" class="light orange-text text-lighten-4 center-on-small-only">Libraries to implement a transpect cascade configuration</h4>
            </div>
         </div>
         <div class="container">
            <div class="row">
               <div class="col s12 m9 l10" id="tr-content">
                  <div class="card">
                     <div class="card-content"><span class="card-title">Repository</span><table class="informaltable">
                           <tbody>
                              <tr>
                                 <td>Git URL</td>
                                 <td><code class="language-markup">https://github.com/transpect/cascade.git</code></td>
                              </tr>
                              <tr>
                                 <td>SVN URL</td>
                                 <td><code class="language-markup">https://github.com/transpect/cascade</code></td>
                              </tr>
                              <tr>
                                 <td>Base URI</td>
                                 <td><code class="language-markup">http://transpect.io/cascade/</code></td>
                              </tr>
                           </tbody>
                        </table>
                        <p><a href="https://github.com/transpect/cascade" class="btn-flat  orange lighten-4">Source ⬇</a></p>
                     </div>
                  </div>
                  <div id="tr-clades-from-filename-stdout" class="section scrollspy">
                     <h2 class="header">tr:clades-from-filename-stdout</h2>
                     <p>
                        This step provides the clades of one filename 
                        as separated tokens.
                        </p>
                     <h4>Import</h4>
                     <pre><code class="language-markup">&lt;p:import href="http://transpect.io/cascade/xpl/clades-from-filename-stdout.xpl"/&gt;</code></pre>
                     <h4>Dependencies</h4>
                     <ul>
                        <li>
                           <p><a href="modules-cascade.html">cascade</a></p>
                        </li>
                     </ul>
                     <h4>Synopsis</h4>
                     <pre><code class="language-markup">&lt;tr:clades-from-filename-stdout xmlns:tr="http://transpect.io"&gt;
  &lt;p:input port="conf"/&gt;
  &lt;p:output port="result" sequence="true"/&gt;
  &lt;p:option name="filename"/&gt;
  &lt;p:option name="separator" select="'
'"/&gt;
  &lt;p:option name="get-full-path" select="'no'"/&gt;
  &lt;p:option name="order" select="'ascending'"/&gt;
  &lt;p:option name="exclude-filter" select="''"/&gt;
  &lt;p:option name="debug" select="'yes'"/&gt;
  &lt;p:option name="debug-dir-uri" select="'debug'"/&gt;
  &lt;p:option name="status-dir-uri" select="'status'"/&gt;
&lt;/tr:clades-from-filename-stdout&gt;</code></pre>
                  </div>
                  <div id="tr-directory-loop" class="section scrollspy">
                     <h2 class="header">tr:directory-loop</h2>
                     <p>
                        The step performs a recursive directory listing and
                        looks for parameter documents named 'params.xml'. The parameter documents
                        are included in the XML directory listing.  
                        </p>
                     <h4>Import</h4>
                     <pre><code class="language-markup">&lt;p:import href="http://transpect.io/cascade/xpl/directory-loop.xpl"/&gt;</code></pre>
                     <h4>Dependencies</h4>
                     <ul>
                        <li>
                           <p><a href="modules-xproc-util transpect.github.io.html">xproc-util transpect.github.io</a></p>
                        </li>
                     </ul>
                     <h4>Synopsis</h4>
                     <pre><code class="language-markup">&lt;tr:directory-loop xmlns:tr="http://transpect.io"&gt;
  &lt;p:output port="result"/&gt;
  &lt;p:option name="depth" select="-1"/&gt;
  &lt;p:option name="path" required="true"/&gt;
  &lt;p:option name="exclude-filter"/&gt;
&lt;/tr:directory-loop&gt;</code></pre>
                  </div>
                  <div id="tr-identity-fallback" class="section scrollspy">
                     <h2 class="header">tr:identity-fallback</h2>
                     <h4>Import</h4>
                     <pre><code class="language-markup">&lt;p:import href="http://transpect.io/cascade/xpl/dynamic-transformation-identity-fallback.xpl"/&gt;</code></pre>
                     <h4>Synopsis</h4>
                     <pre><code class="language-markup">&lt;tr:identity-fallback xmlns:tr="http://transpect.io"&gt;
  &lt;p:input port="source" primary="true"/&gt;
  &lt;p:input port="stylesheet"/&gt;
  &lt;p:input port="meta"/&gt;
  &lt;p:input port="parameters" primary="true"/&gt;
  &lt;p:output port="result" primary="true"/&gt;
  &lt;p:option name="debug" required="false" select="'no'"/&gt;
  &lt;p:option name="debug-dir-uri"/&gt;
&lt;/tr:identity-fallback&gt;</code></pre>
                  </div>
                  <div id="tr-dynamic-transformation-pipeline" class="section scrollspy">
                     <h2 class="header">tr:dynamic-transformation-pipeline</h2>
                     <p>This encapsulates the dynamic loading of an XSLT stylesheet and an XPL pipeline and
                        execution of the
                        pipeline. Dynamic loading means that the most specific (specificity tr: work, series,
                        publisher, common) XSL and XPL
                        files will be loaded. The pipeline usually consists of transformations with the same
                        dynamically loaded stylesheet in different
                        modes, according to the dynamically loaded pipeline (that consists of tr:xslt-mode
                        steps). The pipeline may have multiple
                        documents on the source and result ports. The transformation will be applied to each
                        document in turn. <br xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://docbook.org/ns/docbook"></br>    Additional input files that will be passed to each transformation may be sent
                        to the additional-input port. They must be 
                        wrapped in cx:document with the appropriate port name of the dynamically executed
                        pipeline. Even if you don’t have additional 
                        inputs, make sure to always include the additional-inputs port when invoking tr:dynamic-transformation-pipeline.
                        Connect it to
                        p:empty by default. Please note the difference between a sequence of source documents
                        (will be transformed one by one) and a
                        sequence of additional files (will be available to the dynamically loaded pipeline
                        and will typically be used as additional
                        input documents for some of the tr:xslt-mode steps therein, thus making it available
                        via the default collection in each 
                        transformation).<br xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://docbook.org/ns/docbook"></br>    There is a limitation that additional inputs are limited to single documents per
                        port. If you have a sequence, you’ll have 
                        to wrap it into a custom element before wrapping it in the cx:document.<br xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://docbook.org/ns/docbook"></br>    There is also an options port. You may submit options in a cx:options document
                        with cx:option entries (with name and value
                        attributes). These options will be merged with the debug and debug-dir-uri options
                        and passed on to the dynamically loaded
                        pipeline. Before preparing a cx:options document, check whether the options can be
                        read in the dynamically invoked pipeline
                        from the primary parameter port.
                        </p>
                     <h4>Import</h4>
                     <pre><code class="language-markup">&lt;p:import href="http://transpect.io/cascade/xpl/dynamic-transformation-pipeline.xpl"/&gt;</code></pre>
                     <h4>Dependencies</h4>
                     <ul>
                        <li>
                           <p><a href="modules-cascade.html">cascade</a></p>
                        </li>
                     </ul>
                     <h4>Synopsis</h4>
                     <pre><code class="language-markup">&lt;tr:dynamic-transformation-pipeline xmlns:tr="http://transpect.io"&gt;
  &lt;p:input port="source" sequence="true" primary="true"/&gt;
  &lt;p:input port="additional-inputs" sequence="true" primary="false"/&gt;
  &lt;p:input port="options" sequence="true"/&gt;
  &lt;p:input port="paths" primary="true"/&gt;
  &lt;p:output port="report" sequence="true"/&gt;
  &lt;p:output port="result" sequence="true" primary="true"/&gt;
  &lt;p:option name="load"/&gt;
  &lt;p:option name="fallback-xsl" required="false" select="'http://transpect.io/cascade/xsl/dynamic-transformation-identity-fallback.xsl'"/&gt;
  &lt;p:option name="fallback-xpl" required="false" select="''"/&gt;
  &lt;p:option name="debug" required="false" select="'no'"/&gt;
  &lt;p:option name="debug-dir-uri" required="false" select="'debug'"/&gt;
&lt;/tr:dynamic-transformation-pipeline&gt;</code></pre>
                  </div>
                  <div id="tr-get-clades-from-dirs" class="section scrollspy">
                     <h2 class="header">tr:get-clades-from-dirs</h2>
                     <p>
                        
                        <p xmlns:p="http://www.w3.org/ns/xproc" xmlns:tr="http://transpect.io" xmlns:c="http://www.w3.org/ns/xproc-step" xmlns:j="http://marklogic.com/json" xmlns:cx="http://xmlcalabash.com/ns/extensions" xmlns:xlink="http://www.w3.org/1999/xlink">This step converts a transpect clades document from the output
                           of <code>tr:directory-loop</code>. The clades document can be used
                           as input for the <code>tr:paths</code> step.</p>
                        
                        <p xmlns:p="http://www.w3.org/ns/xproc" xmlns:tr="http://transpect.io" xmlns:c="http://www.w3.org/ns/xproc-step" xmlns:j="http://marklogic.com/json" xmlns:cx="http://xmlcalabash.com/ns/extensions" xmlns:xlink="http://www.w3.org/1999/xlink">Parameter sets can be stored as <code>params.xml</code> in the corresponding 
                           directory. There are predefined parameters which are used to control how the 
                           clades are generated.</p>
                        
                        <pre xmlns:p="http://www.w3.org/ns/xproc" xmlns:tr="http://transpect.io" xmlns:c="http://www.w3.org/ns/xproc-step" xmlns:j="http://marklogic.com/json" xmlns:cx="http://xmlcalabash.com/ns/extensions" xmlns:xlink="http://www.w3.org/1999/xlink"><code>&lt;c:param-set xmlns:c="http://www.w3.org/ns/xproc-step"&gt;
&lt;c:param name="exclude-filter" value="'(xsl|xpl|schematron)'"/&gt;&lt;-- exclude directories from cascade --&gt;
&lt;c:param name="clade-role" value="global"/&gt;&lt;-- assign a specific clade role to the directory --&gt;
&lt;/c:param-set&gt;</code></pre>
                        </p>
                     <h4>Import</h4>
                     <pre><code class="language-markup">&lt;p:import href="http://transpect.io/cascade/xpl/get-clades-from-dirs.xpl"/&gt;</code></pre>
                     <h4>Dependencies</h4>
                     <ul>
                        <li>
                           <p><a href="modules-xproc-util transpect.github.io.html">xproc-util transpect.github.io</a></p>
                        </li>
                        <li>
                           <p><a href="modules-xslt-util.html">xslt-util</a></p>
                        </li>
                     </ul>
                     <h4>Synopsis</h4>
                     <pre><code class="language-markup">&lt;tr:get-clades-from-dirs xmlns:tr="http://transpect.io"&gt;
  &lt;p:input port="params"/&gt;
  &lt;p:output port="result" primary="true"/&gt;
  &lt;p:output port="directory-param-sets" primary="false"/&gt;
  &lt;p:option name="resolve-params" select="'yes'"/&gt;
  &lt;p:option name="debug" select="'yes'"/&gt;
  &lt;p:option name="debug-dir-uri" select="'debug'"/&gt;
  &lt;p:option name="status-dir-uri" select="concat($debug-dir-uri, '/status')"/&gt;
&lt;/tr:get-clades-from-dirs&gt;</code></pre>
                  </div>
                  <div id="tr-load-cascaded" class="section scrollspy">
                     <h2 class="header">tr:load-cascaded</h2>
                     <p>Loads the most specific XML file $filename from a sequence of paths, supplied as 
                        parameters on the paths port ($s9y1-path, $s9y2-path, …, in descending specificity).
                        
                        The XML file can be an XProc pipeline, an XSLT stylesheet, a Schematron schema, an
                        XHTML file, whatever.  
                        If no document named {$filename} is found at a given path, it checks whether {$filename}.xsl
                        exists.
                        If it exist, the main template of this XSL is invoked and this should return the document
                        that was 
                        originally expected at {$filename}.
                        If neither a proper {$filename} nor {$filename}.xsl can be found under any of the
                        paths, and if
                        a non-empty option $fallback is specified, the fallback file will be used. 
                        </p>
                     <h4>Import</h4>
                     <pre><code class="language-markup">&lt;p:import href="http://transpect.io/cascade/xpl/load-cascaded.xpl"/&gt;</code></pre>
                     <h4>Dependencies</h4>
                     <ul>
                        <li>
                           <p><a href="modules-cascade.html">cascade</a></p>
                        </li>
                     </ul>
                     <h4>Synopsis</h4>
                     <pre><code class="language-markup">&lt;tr:load-cascaded xmlns:tr="http://transpect.io"&gt;
  &lt;p:input port="paths" primary="true"/&gt;
  &lt;p:input port="source" sequence="true" primary="true"/&gt;
  &lt;p:input port="catalog" sequence="true"/&gt;
  &lt;p:output port="result" primary="true"/&gt;
  &lt;p:option name="filename" required="true"/&gt;
  &lt;p:option name="required" required="false" select="'yes'"/&gt;
  &lt;p:option name="fallback" required="false" select="''"/&gt;
  &lt;p:option name="set-xml-base-attribute" required="false" select="'yes'"/&gt;
  &lt;p:option name="debug" required="false" select="'no'"/&gt;
  &lt;p:option name="debug-dir-uri"/&gt;
&lt;/tr:load-cascaded&gt;</code></pre>
                  </div>
                  <div id="tr-load-cascaded-binary" class="section scrollspy">
                     <h2 class="header">tr:load-cascaded-binary</h2>
                     <h4>Import</h4>
                     <pre><code class="language-markup">&lt;p:import href="http://transpect.io/cascade/xpl/load-cascaded.xpl"/&gt;</code></pre>
                     <h4>Dependencies</h4>
                     <ul>
                        <li>
                           <p><a href="modules-cascade.html">cascade</a></p>
                        </li>
                     </ul>
                     <h4>Synopsis</h4>
                     <pre><code class="language-markup">&lt;tr:load-cascaded-binary xmlns:tr="http://transpect.io"&gt;
  &lt;p:input port="paths" primary="true"/&gt;
  &lt;p:output port="result" primary="true"/&gt;
  &lt;p:option name="filename" required="true"/&gt;
  &lt;p:option name="required" required="false" select="'yes'"/&gt;
  &lt;p:option name="fallback" required="false" select="''"/&gt;
  &lt;p:option name="result-with-file-prefix" required="false" select="'no'"/&gt;
  &lt;p:option name="debug" required="false" select="'no'"/&gt;
  &lt;p:option name="debug-dir-uri"/&gt;
&lt;/tr:load-cascaded-binary&gt;</code></pre>
                  </div>
                  <div id="tr-load-whole-cascade" class="section scrollspy">
                     <h2 class="header">tr:load-whole-cascade</h2>
                     <p>Loads all documents of a specific name from the path cascade. 
                        With the default order of 'least-specific-first', the most generic document will be
                        first, the most specific last.
                        The option 'order' may be set to 'most-specific-first'.</p>
                     <h4>Import</h4>
                     <pre><code class="language-markup">&lt;p:import href="http://transpect.io/cascade/xpl/load-cascaded.xpl"/&gt;</code></pre>
                     <h4>Synopsis</h4>
                     <pre><code class="language-markup">&lt;tr:load-whole-cascade xmlns:tr="http://transpect.io"&gt;
  &lt;p:input port="paths" primary="true"/&gt;
  &lt;p:output port="result" sequence="true" primary="true"/&gt;
  &lt;p:option name="filename" required="true"/&gt;
  &lt;p:option name="order" select="'least-specific-first'"/&gt;
&lt;/tr:load-whole-cascade&gt;</code></pre>
                  </div>
                  <div id="tr-paths-for-files-xml" class="section scrollspy">
                     <h2 class="header">tr:paths-for-files-xml</h2>
                     <p>
                        An implementation of paths-for-files which provides XML output
                        </p>
                     <h4>Import</h4>
                     <pre><code class="language-markup">&lt;p:import href="http://transpect.io/cascade/xpl/paths-for-files-xml.xpl"/&gt;</code></pre>
                     <h4>Dependencies</h4>
                     <ul>
                        <li>
                           <p><a href="modules-cascade.html">cascade</a></p>
                        </li>
                     </ul>
                     <h4>Synopsis</h4>
                     <pre><code class="language-markup">&lt;tr:paths-for-files-xml xmlns:tr="http://transpect.io"&gt;
  &lt;p:input port="conf"/&gt;
  &lt;p:output port="result"/&gt;
  &lt;p:option name="filenames"/&gt;
  &lt;p:option name="clades" select="''"/&gt;
  &lt;p:option name="debug" required="false" select="'no'"/&gt;
  &lt;p:option name="debug-dir-uri" required="false" select="resolve-uri('debug')"/&gt;
  &lt;p:option name="status-dir-uri" required="false" select="'status?enabled=false'"/&gt;
  &lt;p:option name="fail-on-error" select="'false'"/&gt;
&lt;/tr:paths-for-files-xml&gt;</code></pre>
                  </div>
                  <div id="tr-paths-for-files" class="section scrollspy">
                     <h2 class="header">tr:paths-for-files</h2>
                     <p>Will calculate the content repository locations for a space separated
                        sequence of flat filenames. The filenames must adhere to the naming conventions, e.g.,
                        101026_04711_RAT.idml or 101027_00123_ADHOC_fig_2-3.pdf.</p>
                     <h4>Import</h4>
                     <pre><code class="language-markup">&lt;p:import href="http://transpect.io/cascade/xpl/paths-for-files.xpl"/&gt;</code></pre>
                     <h4>Dependencies</h4>
                     <ul>
                        <li>
                           <p><a href="modules-cascade.html">cascade</a></p>
                        </li>
                        <li>
                           <p><a href="modules-xproc-util transpect.github.io.html">xproc-util transpect.github.io</a></p>
                        </li>
                     </ul>
                     <h4>Synopsis</h4>
                     <pre><code class="language-markup">&lt;tr:paths-for-files xmlns:tr="http://transpect.io"&gt;
  &lt;p:input port="conf" primary="true"/&gt;
  &lt;p:output port="result" primary="true"/&gt;
  &lt;p:option name="filenames" required="true"/&gt;
  &lt;p:option name="clades" select="''"/&gt;
  &lt;p:option name="debug" required="false" select="'no'"/&gt;
  &lt;p:option name="debug-dir-uri" required="false" select="resolve-uri('debug')"/&gt;
  &lt;p:option name="status-dir-uri" required="false" select="'status?enabled=false'"/&gt;
  &lt;p:option name="fail-on-error" select="'false'"/&gt;
&lt;/tr:paths-for-files&gt;</code></pre>
                  </div>
                  <div id="tr-paths" class="section scrollspy">
                     <h2 class="header">tr:paths</h2>
                     <p>
                        This step provides the transpect cascade paths document for a given filename. 
                        The filename is passed with the <code xmlns:p="http://www.w3.org/ns/xproc" xmlns:tr="http://transpect.io" xmlns:c="http://www.w3.org/ns/xproc-step" xmlns:j="http://marklogic.com/json" xmlns:cx="http://xmlcalabash.com/ns/extensions" xmlns:xlink="http://www.w3.org/1999/xlink">file</code> option. <br xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://docbook.org/ns/docbook"></br>    The step takes two inputs. First, the step expects a transpect clades 
                        configuration. Clades are a hierarchical structure of configuration layers. 
                        These layers are typically represented as directories on the filesystem, where 
                        transpect steps search for overrides. Second, the step takes an XSLT stylesheet. The
                        
                        stylesheet imports the <code xmlns:p="http://www.w3.org/ns/xproc" xmlns:tr="http://transpect.io" xmlns:c="http://www.w3.org/ns/xproc-step" xmlns:j="http://marklogic.com/json" xmlns:cx="http://xmlcalabash.com/ns/extensions" xmlns:xlink="http://www.w3.org/1999/xlink">paths.xsl</code> and is used to override some of its functions, especially for
                        detecting clades based upon file names or other strings.<br xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://docbook.org/ns/docbook"></br>    A RelaxNG schema for the clades configuration is here: <code xmlns:p="http://www.w3.org/ns/xproc" xmlns:tr="http://transpect.io" xmlns:c="http://www.w3.org/ns/xproc-step" xmlns:j="http://marklogic.com/json" xmlns:cx="http://xmlcalabash.com/ns/extensions" xmlns:xlink="http://www.w3.org/1999/xlink">../schema/cascade.rng</code>.
                        </p>
                     <h4>Import</h4>
                     <pre><code class="language-markup">&lt;p:import href="http://transpect.io/cascade/xpl/paths.xpl"/&gt;</code></pre>
                     <h4>Dependencies</h4>
                     <ul>
                        <li>
                           <p><a href="modules-xproc-util transpect.github.io.html">xproc-util transpect.github.io</a></p>
                        </li>
                     </ul>
                     <h4>Synopsis</h4>
                     <pre><code class="language-markup">&lt;tr:paths xmlns:tr="http://transpect.io"&gt;
  &lt;p:input port="conf"/&gt;
  &lt;p:input port="stylesheet" primary="true"/&gt;
  &lt;p:input port="params" sequence="true"/&gt;
  &lt;p:output port="result" primary="true"/&gt;
  &lt;p:output port="report" sequence="true" primary="false"/&gt;
  &lt;p:option name="debug" select="'no'"/&gt;
  &lt;p:option name="debug-dir-uri" select="'debug'"/&gt;
  &lt;p:option name="status-dir-uri" select="'status?enabled=false'"/&gt;
  &lt;p:option name="interface-language" select="'en'"/&gt;
  &lt;p:option name="clades" select="''"/&gt;
  &lt;p:option name="file" required="true"/&gt;
  &lt;p:option name="pipeline" select="'unknown'"/&gt;
  &lt;p:option name="progress" select="'no'"/&gt;
  &lt;p:option name="progress-to-stdout" required="false" select="'no'"/&gt;
  &lt;p:option name="determine-transpect-project-version" required="false" select="'no'"/&gt;
&lt;/tr:paths&gt;</code></pre>
                  </div>
                  <div id="d42791e245" class="status">
                     <h2 class="header status"></h2>
                     <p class="last-updated">GitHub sync date: 2025-01-08+01:00</p>
                  </div>
               </div>
               <div class="col hide-on-small-only m3 l2">
                  <div class="toc-wrapper pin-top" style="top: 0px;">
                     <div style="height: 1px;">
                        <ul id="tr-toc" class="table-of-contents">
                           <li><a href="#tr-clades-from-filename-stdout" class="active">tr:clades-from-filename-stdout</a></li>
                           <li><a href="#tr-directory-loop">tr:directory-loop</a></li>
                           <li><a href="#tr-identity-fallback">tr:identity-fallback</a></li>
                           <li><a href="#tr-dynamic-transformation-pipeline">tr:dynamic-transformation-pipeline</a></li>
                           <li><a href="#tr-get-clades-from-dirs">tr:get-clades-from-dirs</a></li>
                           <li><a href="#tr-load-cascaded">tr:load-cascaded</a></li>
                           <li><a href="#tr-load-cascaded-binary">tr:load-cascaded-binary</a></li>
                           <li><a href="#tr-load-whole-cascade">tr:load-whole-cascade</a></li>
                           <li><a href="#tr-paths-for-files-xml">tr:paths-for-files-xml</a></li>
                           <li><a href="#tr-paths-for-files">tr:paths-for-files</a></li>
                           <li><a href="#tr-paths">tr:paths</a></li>
                           <li><a href="#d42791e245"></a></li>
                        </ul>
                     </div>
                  </div>
               </div>
            </div>
         </div>
      </main>
      <footer class="page-footer grey">
         <div class="container">
            <div class="row">
               <div id="tr-footer-1" class="col s12 m6 l4">
                  <h5 class="white-text">GitHub</h5>
                  <p class="white-text">Checkout the transpect repositories on GitHub and use transpect in your project. 
                     Give us feedback, create issues and make pull requests.</p>
                  <p><a target="_blank" href="https://github.com/transpect" class="btn red">GitHub</a></p>
               </div>
               <div id="tr-footer-2" class="col s12 m6 l4">
                  <h5 class="white-text">Twitter</h5>
                  <p class="white-text">News from le-tex’ XML machine room. Mostly related to 
                     XSLT/XPath 2+, XProc, Relax NG, Schematron, and our 
                     open-source framework transpect.
                     </p>
                  <p><a target="_blank" href="https://twitter.com/intent/user?screen_name=letexml" class="btn red">Follow @letexml</a></p>
               </div>
               <div id="tr-footer-3" class="col s12 m6 l4"><a target="_blank" href="http://www.le-tex.de"><object id="letex-logo" type="image/svg+xml" data="icons/logo-le-tex.svg">Your browser does not support SVG</object></a></div>
            </div>
         </div>
         <div class="footer-copyright grey darken-1">
            <div class="container">
               <div class="row">
                  <div id="tr-footer-copyright-1" class="col s12 m6 l6">
                     <p class="white-text left">le-tex publishing services GmbH, <span class="current-year">2025</span></p>
                  </div>
                  <div id="tr-footer-copyright-2" class="col s12 m6 l6">
                     <p>
                        		<a class="white-text right" href="http://www.le-tex.de">http://www.le-tex.de</a>
                        		<a rel="me" href="https://fosstodon.org/@letexml" aria-label="Mastodon"></a>
                        	      </p>
                  </div>
               </div>
            </div>
         </div>
      </footer><script type="text/javascript" src="https://code.jquery.com/jquery-2.1.1.min.js"></script><script type="text/javascript" src="js/prism.js"></script><script type="text/javascript" src="js/materialize.min.js"></script><script src="js/init.js"></script></body>
</html>