DeltaXML Core Documentation

DeltaXML Core is a powerful programmers' toolkit and we provide a wide range of technical documents, "how to guides", and support material.

Start here

Take the Tour A guided tour of DeltaXML Core technology

Reference, Release and API documentation

DeltaXML Core Format Specification (deltaV2)
All you need to know about how changes are represented in the delta file
deltaV2 schematron
specifies the formal grammar rules for a delta file

Product ReadMe (How to use the release): Java Platform ReadMe / .NET Platform ReadMe
Programmers/API documentation: Javadoc / .NET platform API
Release Notes Tells you what has changed in each new release

Samples and Guides

The following samples and guides consider common use-cases and other features available with DeltaXML Core and its included filters. Samples provide documentation, code, data files and ant scripts that can be run. They are included on the website and as directories in the product release - download an evaluation and experiment. Guides are stand-alone documents available on thus website.

DXP Filter Pipelines

Sample: How to specify a pipeline using DXP or Java
Explains how to set up a PipelinedComparator and also shows how DXP pipelines relate to Java API calls.
Guide: Guide to DeltaXML Pipeline Configuration (with DXP)
DXP is an XML format which allows you to define a set of filters to run before and after comparison

Topics for both Document and Data Centric XML

Sample: How to ignore changes in XML documents
An example pipeline showing how to post-process a delta result to "ignore" certain changes.
Sample: How to improve matching in ordered data using keys
Explains when and how to add DeltaXML 'keys' to your input data in order to have more control over the matching process.
Sample: How to use XInclude with DeltaXML
An example pipeline that instructs the XML parser to process XInclude statements before passing the input data to DeltaXML Core.

Topics for XML Documents

Sample: How to build a pipeline for a specific XML format
Step-by-step guide to building a pipeline for comparing a specific XML format. Uses XHTML as an example input format and brings together functionality from several of the other samples into a single pipeline.
Sample: How to use word by word text comparison
An explanation of how to perform a detailed comparison on textual changes using Java filters included with DeltaXML Core.
Guide: Filters for Document Processing
Describes how to process documents and configure filters to handle text formatting etc.
Sample: How to process change in formatting elements
Explains why inline formatting elements need special processing in order to minimise the impact that changing them has on the result file.
Sample: How to preserve input doctype information
Explains how to include doctype information in the result file that is determined by the input file doctype rather than hard-coded into the pipeline.
Sample: How to preserve processing instructions and comments
Explains how to convert processing instructions and comments into XML markup (and back again) so that they are not removed by DeltaXML Core.
Guide: How to manage white space
White space needs careful attention, this tell you what to look for

Topics for XML Data

Sample: How to compare orderless data
Explains how and why to instruct DeltaXML Core to treat XML data as an orderless set of elements.
Sample: How to detect and handle a move
An example pipeline showing how to post-process a delta file to detect and mark data that has been moved.
Sample: How to handle numeric tolerances
An example pipeline showing how to post-process a delta file to allow for tolerances when comparing numerical data.
Guide: How to handle mixed ordered and orderless elements
Even if only some data is orderless, DeltaXML Core can handle it for you

Integrating DeltaXML Core

The following discuss using the Java APIs and are generally independent of any filters used in the processing pipelines.

Guide: How to compare large files
What to look out for when comparing large documents (hundreds of Mb)
Sample: How to use a catalog resolver with DeltaXML
A code sample to show how to instruct DeltaXML Core to make use of catalog files.
Sample: How to use W3C DOM input/output with DeltaXML
A simple code sample showing how to use in memory DOM strucutures as inputs/outputs.
Sample: How to use XOM input/output with DeltaXML
A simple code sample showing how to use in memory XOM structures as inputs/outputs.
Sample: How to integrate DeltaXML into a Java Servlet
An example servlet showing how DeltaXML could be used and deployed in a servlet engine or Java EE application server. Also serves as a multithreaded test case.

Format Specific Information

Guide: How to compare XML Schema (.xsd)
Worked Example: SVG processing
Worked Example: xhtml processing

Legacy Product Documentation

(this information is useful for users of prior releases)

Support

Support Forum