Topicset Bookmap Sample

 Table of Contents


1. Summary

Note that any DITA map specialisation should be handled in a similar manner to the Bookmap specialisation, as the implementation works off the class attributes of the elements to determine whether a topic reference has been found. A current limitation is that the attribute names cannot be specialised.

1.1. Script Features

This sample script (Ant or batch file - depending on download) compares two DITA Bookmaps, book1/main.ditamap and book2/main.ditamap, using the 'topic set', 'map pair' and 'unified map' map result structures. Please refer to Map Processing Section of the Reference and the map-result-structure parameter documentation for more details on these result structures.

1.1.1. Result Origin

The 'result origin' is the input map that is used to form the basis of the output, as discussed in Map Processing Section of the Reference and the map-result-origin parameter documentation.

1.1.2. Output Structure and Destination

The output of the 'topic set', 'map pair' and 'unified-map' comparisons are put into the topic-set-A, map-pair-B and unified-map-B directories respectively. These directories contain a result-alias.ditamap file whose content references the actual results, but can be used as a result in its own right. Note that in the case of the map pair result, the alias combines the two main result maps into a single document.



2. Running the sample

The sample resources and a description on how to run it can be found at: https://bitbucket.org/deltaxml/topicset-book-map for Java and here for .NET.

The resources should be checked-out, cloned or downloaded and unzipped into the samples directory of the DITA Compare release. They should be located such that they are two levels below the top level release directory, for example DeltaXML-DITA-Compare-8_0_0_j/samples/topicset-book-map.


#content .code