Topicset Map Sample

 Table of Contents


1. Summary

This sample compares two DITA maps, doc1/maps/main.ditamap and doc2/maps/main.ditamap, using all three of the available map result structures: the 'topic set', the 'map-pair' and the 'unified-map'.

An alternative form of the 'map pair' and 'unified map' comparisons is provided, where the output format is set to oXygen tracked changes. This is done in order to illustrate that whether a topic contains reportable change is dependant on the output format. For example, the DITA markup output format cannot represent insertion, deletion or change within a comment, whereas the oXygen track changes output format can. Therefore, we have added a comment to the Aligning Topics topic, which appears in both results, but is only marked as changed in the DITA map file, when the tracked change output format is selected.

1.1. Script Features

The sample script (Ant or batch file - depending on download) includes examples with result structures set to topic-set, map-pair and unified-map. Different 'result origin' settings are also used.

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 these commands are put into the topic-set-A, map-pair-B and unified-map-B directories, which 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.

Please refer to Map Processing Section of the Reference and the map-result-structure parameter documentation for more details.



2. Running the sample

The sample resources and a description on how to run it can be found at: https://bitbucket.org/deltaxml/topicset-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-map.

#content .code