XML Calabash Reference
Version 3.0.30
for XML Calabash 3.0.30
Updated: 01 Dec 2025
Copyright © 2024–2025 Norman Walsh.
Table of Contents
- Preface
- 1. Dependencies
- 2. Language reference
- Part I. Standard steps
- p:add-attribute — The standard p:add-attribute step
- p:add-xml-base — The standard p:add-xml-base step
- p:archive — The standard p:archive step
- p:archive-manifest — The standard p:archive-manifest step
- p:cast-content-type — The standard p:cast-content-type step
- p:compare — The standard p:compare step
- p:compress — The standard p:compress step
- p:count — The standard p:count step
- p:css-formatter — The standard p:css-formatter step3.1
- p:delete — The standard p:delete step
- p:directory-list — The standard p:directory-list step3.1
- p:encode — The standard p:encode step
- p:error — The standard p:error step
- p:file-copy — The standard p:file-copy step3.1
- p:file-create-tempfile — The standard p:file-create-tempfile step3.1
- p:file-delete — The standard p:file-delete step3.1
- p:file-info — The standard p:file-info step3.1
- p:file-mkdir — The standard p:file-mkdir step3.1
- p:file-move — The standard p:file-move step3.1
- p:file-touch — The standard p:file-touch step3.1
- p:filter — The standard p:filter step
- p:hash — The standard p:hash step
- p:http-request — The standard p:http-request step
- p:identity — The standard p:identity step
- p:insert — The standard p:insert step
- p:invisible-xml — The standard p:invisible-xml step3.1
- p:json-join — The standard p:json-join step
- p:json-merge — The standard p:json-merge step
- p:label-elements — The standard p:label-elements step
- p:load — The standard p:load step
- p:make-absolute-uris — The standard p:make-absolute-uris step
- p:markdown-to-html — Converts Markdown formatted text to HTML3.1
- p:message — The standard p:message step
- p:namespace-delete — The standard p:namespace-delete step
- p:namespace-rename — The standard p:namespace-rename step
- p:os-exec — The standard p:os-exec step3.1
- p:os-info — The standard p:os-info step3.1
- p:pack — The standard p:pack step
- p:rename — The standard p:rename step
- p:replace — The standard p:replace step
- p:run — The standard p:run step3.1
- p:send-mail — The standard p:send-mail step3.1
- p:set-attributes — The standard p:set-attributes step
- p:set-properties — The standard p:set-properties step
- p:sink — The standard p:sink step
- p:sleep — The standard p:sleep step3.1
- p:split-sequence — The standard p:split-sequence step
- p:store — The standard p:store step
- p:string-replace — The standard p:string-replace step
- p:text-count — The standard p:text-count step
- p:text-head — The standard p:text-head step
- p:text-join — The standard p:text-join step
- p:text-replace — The standard p:text-replace step
- p:text-sort — The standard p:text-sort step
- p:text-tail — The standard p:text-tail step
- p:unarchive — The standard p:unarchive step
- p:uncompress — The standard p:uncompress step
- p:unwrap — The standard p:unwrap step
- p:uuid — The standard p:uuid step
- p:validate-with-dtd — The standard p:validate-with-dtd step3.1
- p:validate-with-json-schema — The standard p:validate-with-json-schema step3.1
- p:validate-with-nvdl — The standard p:validate-with-nvdl step3.1
- p:validate-with-relax-ng — The standard p:validate-with-relax-ng step3.1
- p:validate-with-schematron — The standard p:validate-with-schematron step3.1
- p:validate-with-xml-schema — The standard p:validate-with-xml-schema step3.1
- p:wrap — The standard p:wrap step
- p:wrap-sequence — The standard p:wrap-sequence step
- p:www-form-urldecode — The standard p:www-form-urldecode step
- p:www-form-urlencode — The standard p:www-form-urlencode step
- p:xinclude — The standard p:xinclude step
- p:xquery — The standard p:xquery step
- p:xsl-formatter — The standard p:xsl-formatter step3.1
- p:xslt — The standard p:xslt step
- Part II. EXProc extension steps
- ex:expand-templates — Expand value templates in a document
- ex:epubcheck — Checks the conformance of EPUB files
- Part III. XML Calabash extension steps
- cx:asciidoctor — Convert Asciidoctor documents
- cx:basex — Evaluate XQuery expressions
- cx:cache-add — Adds documents to the runtime cache
- cx:cache-delete — Deletes documents from the runtime cache
- cx:collection-manager — Create or update a named collection
- cx:ditaa — Draws diagrams with ditaa
- cx:ebnf-convert — Converts other EBNF notations to W3C EBNF
- cx:elemental — Evaluate XQuery expressions with Elemental
- cx:epubcheck — Checks the conformance of EPUB files
- cx:exist-db — Evaluate XQuery expressions with eXist-db
- cx:fileset — Approximates the Ant notion of a fileset
- cx:find — Searches for matching files
- cx:json-diff — Find the differences between two JSON documents
- cx:json-patch — Applies a patch to a JSON document
- cx:jsonpath — Queries a JSON document with JSONPath
- cx:javascript — Evaluate steps implemented in JavaScript
- cx:markup-blitz — Invisible XML processing with Markup Blitz
- cx:mathml-to-svg — Draws diagrams with mathml-to-svg
- cx:merge-properties — Merges the properties of two documents
- cx:metadata-extractor — Extracts metadata from images and other files
- cx:pipeline-messages — Accesses pipeline message output
- cx:polyglot — Evaluate steps implemented in other programming languages
- cx:plantuml — Draws diagrams with PlantUML
- cx:python — Evaluate steps implemented in Python
- cx:railroad — Draws railroad diagrams
- cx:selenium — Drive a web browser with Selenium
- cx:trang — Convert between schema formats
- cx:trang-files — Convert between schema formats
- cx:unique-id — Generates unique identifiers
- cx:wait-for-update — Wait for a document to change
- cx:xmlunit — Performs comparisons with xmlunit
- cx:xpath — Evaluate XPath expressions
- Part IV. RDF extension steps
- General Notes about RDF Support
- cx:rdf-merge — Combines RDF datasets
- cx:rdf-graph — Extracts a single graph from an RDF dataset
- cx:rdfa — Extracts RDFa from documents
- cx:sparql — Performs SPARQL queries on RDF datasets
- A. XProc Functions
- Glossary
- Bibliography
List of Figures
- 1. Example ditaa
- 1. Example MathML converted to SVG
- 2. Example MathML
- 1. Amaryllis
- 1. UML diagram
- 2. JSON diagram
- 3. EBNF diagram
- 1. The Expression production
- 2. The Number production
- 3. The op production
- 1. Overall structure of a cx:selenium script
- 2. A statement
- 3. A simple statement
- 4. A compound statement
- 5. A perform statement
- 6. An if block
- 7. A while block
- 8. An until block
- 9. An subroutine
- 10. The find statement
- 11. The set statement
- 12. The send statement
- 13. The click statement
- 14. The wait until ready statement
- 15. The wait statement
- 16. The pause statement
- 17. The message statement
- 18. The output statement
- 19. The window statement
- 20. The cookie statement
- 21. The scroll statement
- 22. The move statement
- 23. The move statement
- 24. The drag statement
- 25. The navigate statement
- 26. The refresh statement
- 27. The reset statement
- 28. The close statement
- 29. The key statement
- 30. The key names
- 31. The call statement
- 32. Names
- 33. Name start characters
- 34. Name following characters
- 35. Variable names
- 36. Strings
- 37. Durations
- 38. Integers
- 39. Numbers
List of Tables
List of Examples
- 2.1. A compound step declaration
- 2.2. An atomic step declaration
- 2.3. A pipeline input
- 2.4. A pipeline output
- 2.5. An atomic step output
- 2.6. Pipeline options
- 2.7. A function library in XSLT
- 2.8. Using the function library
- 2.9. Looping with for-each
- 2.10. Matching with viewport
- 2.11. An example choice
- 2.12. Using an if instruction
- 2.13. An example try/catch
- 2.14. Looping until a condition is true
- 2.15. Looping while a condition is true
- 1. Example ditaa source
- 1. Amaryllis metadata
- 2. Digital Camera metadata
- 3. PNG metadata
- 1. UML source
- 2. JSON source
- 3. JSON source
- 1. Example railroad source
- 2. Document properties for the Number diagram
