XML Calabash Reference

Table of Contents

• 1. Preface
  • 1. What is XML Calabash?
• 1. Running XML Calabash
  • 1. Setting up the environment
  • 2. The command line
  • 3. What do I do if it all goes wrong?
• 2. Configuration
  • 1. Saxon processor
  • 2. Saxon configuration
  • 3. Schema aware processing
  • 4. Debug
  • 5. Safe mode
  • 6. Alternate configuration file
  • 7. Logging style
  • 8. Entity resolver
  • 9. URI resolver
  • 10. Extension
  • 11. Binding
  • 12. Parameter
  • 13. Input
  • 14. Data input
  • 15. Output
  • 16. Library
  • 17. Step
  • 18. Pipeline
  • 19. Option
  • 20. Step error listener
  • 21. Serialization options
  • 22. Extension function
  • 23. FO processor
  • 24. CSS processor
  • 25. XProc configurer
  • 26. Default system property
  • 27. HTML parser
  • 28. Saxon configuration property
  • 29. Send mail configuration
• 3. Extensions
  • 1. System property extensions
  • 2. Extension Attributes
  • 3. Language Extensions
    • 3.1. General values extension
    • 3.2. XPointer on text
    • 3.3. Transparent JSON
  • 4. Extension functions
  • 5. Extension steps
• I. Standard XProc Steps
  • p:add-attribute - The standard p:add-attribute step
  • p:add-xml-base - The standard p:add-xml-base step
  • p:compare - The standard p:compare step
  • p:count - The standard p:count step
  • p:delete - The standard p:delete step
  • p:directory-list - The standard p:directory-list step
  • p:error - The standard p:error step
  • p:escape-markup - The standard p:escape-markup step
  • p:exec - The standard p:exec step
  • 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:in-scope-names - The standard p:in-scope-names step
  • p:insert - The standard p:insert 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:namespace-rename - The standard p:namespace-rename step
  • p:pack - The standard p:pack step
  • p:parameters - The standard p:parameters step
  • p:rename - The standard p:rename step
  • p:replace - The standard p:replace step
  • p:set-attributes - The standard p:set-attributes step
  • p:sink - The standard p:sink step
  • 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:template - The standard p:template step
  • p:unescape-markup - The standard p:unescape-markup step
  • p:unwrap - The standard p:unwrap step
  • p:uuid - The standard p:uuid step
  • p:validate-with-relax-ng - The standard p:validate-with-relax-ng step
  • p:validate-with-schematron - The standard p:validate-with-schematron step
  • p:validate-with-xml-schema - The standard p:validate-with-xml-schema step
  • p:wrap-sequence - The standard p:wrap-sequence step
  • p:wrap - The standard p:wrap 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 step
  • p:xslt - The standard p:xslt step
• II. Proposed EXProc Steps
  • pxp:nvdl - Perform NVDL validation
  • pxp:unzip - Extract documents from a ZIP file
  • pxp:zip - Update a ZIP file
  • pxf:copy - Copy a file
  • pxf:delete - Delete a file
  • pxf:head - Return the first few lines of a file
  • pxf:info - Return information about a file
  • pxf:mkdir - Create a directory
  • pxf:move - Move a file
  • pxf:tail - Return the last few lines of a file
  • pxf:tempfile - Create a temporary file
  • pxf:touch - Touch a file
  • pos:cwd - Return the current working directory
  • pos:env - Return a representation of the current OS environment
  • pos:info - Return information about the operating system
• III. XML Calabash Extension Steps
  • cx:collection-manager - Associate documents with a collection URI
  • cx:css-formatter - Format a document using CSS
  • cx:delta-xml - Run the DeltaXML comparitor
  • cx:eval - Evaluate a dynamically constructed pipeline
  • cx:get-cookies - Get the cookies returned by the previous HTTP request
  • cx:java-properties - Reads a Java properties file
  • cx:message - Output a message each time a document is processed
  • cx:metadata-extractor - Extract metadata from images
  • cx:namespace-delete - Delete namespace declarations
  • cx:pretty-print - Reformat whitespace in a document
  • cx:report-errors - Send error report to the user
  • cx:send-mail - Sends an email message
  • cx:set-cookies - Set cookies for subsequent HTTP requests
  • cx:uri-info - Information about a URI
  • cxu:compare - XML Unit comparison of two documents
• IV. MarkLogic XCC Steps
  • ml:adhoc-query - Run an adhoc query on MarkLogic Server
  • ml:insert-document - Insert a document into a database on MarkLogic Server
  • ml:invoke-module - Invoke a module on MarkLogic Server