DeltaXML DITA Compare .NET API DocumentationDeltaXML DITA Compare .NET API Documentation
DeltaXML DITA Compare .NET API Documentation
The public classes within this package provide the DeltaXML DITA Compare product's API (Application Programming Interface). It is recommended that you start with one of the DitaCompareDotNet, DitaTopicCompareDotNet, DitaMapfileCompareDotNet, and DitaMapTopicsetCompareDotNet classes, which enable DITA documents, individual topics, and individual maps and map-aligned topic-sets to be compared respectively.

The DitaMapTopicsetCompareDotNet class provides a file based comparison of maps. Here, the topics within the input maps are aligned for a pairwise topic level comparison. And the results of this comparison are then presented in a map, using one of three available 'map result structures': topic-set, map-pair, and unified-map, as set by the DitaMapTopicsetCompareDotNet.MapResultStructure property.

Correctly aligning the topics when performing a map driven topic comparison is, in general, a difficult problem. However, there are some common sub-classes of this problem that are more tractable. For example, consider the context where a DITA document (and all of its source) are kept within a directory tree on the file system and document versioning is done by copying this directory. In this context the two DITA documents can be compared by gathering the relative paths from the top-level maps to each of the referenced DITA-topics, and comparing those topics that have the same relative paths. This is the default approach taken by the map comparator.

When using the default topic alignment approach it is possible to identify both the insertion of new topics and the deletion of old topics. However, it is not possible to handle topics whose relative location has changed. Therefore, a future version of this interface will provide a means of supplying a custom topic alignment algorithm.

The com.deltaxml.dita namespace contains IKVM converted Java classes for the DITA Compare product. Some of the classes in this namespace have been wrapped by .NET specific variants; they are located in the DeltaXML.DitaCompareApi namespace. Only the unwrapped IKVMed classes that are officially part of the .NET API are in the com.deltaxml.dita namespace documentation.

Namespaces

NamespaceDescription
DeltaXML.DitaCompareApi
This namespace contains the .Net Specific API for the DITA Compare product, and is the recomended starting point for learning about this product's API as a whole. Other aspects of the API are provided by IKVM conversion; please see the com.deltaxml.dita namespace documentation for details.
com.deltaxml.dita
This namespace contains IKVM converted Java classes for the DITA Compare product. Some of these classes have been wrapped by .NET specific variants, where this assists with their usage in a .NET context, such as by providing .NET versions of the file, stream, and URL handling. Other classes are automatically wrapped by the .NET conversion process, such as the primitive types and Exceptions. The remaining classes, such as the Java enumerations are not wrapped, as they are already straight forward to use in their current form within the .NET context. Only the unwrapped IKVMed classes that are officially part of the .NET API are documented here.

Please see the DeltaXML.DitaCompareApi namespace documentation for details of the .NET wrapped aspect of this API.