Large Document Sample (DITA-OT User Guide)

Summary

This sample compares two versions of the DITA Open Toolkit's User Guide, doc-1-6-3/userguide.ditamap and doc-1-7-2/userguide.ditamap, using the 'topic set', 'map pair' and 'unified map' map result structures. This is intended to illustrates the results of the comparison on a reasonable sized document. Please see the Map Sample, for a more detailed discussion on map comparison in general.

Script Features

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.

Java Platfrom

Using Ant

The sample comparison can be run via an ant build script using the following commands.

antRun all comparisons.
ant run
ant run-topic-set-ARun the 'topic set' comparison.
ant run-map-pair-BRun the 'map pair' comparison.
ant run-unified-map-BRun the 'unified map' comparison.
ant cleanRemove the generate output.

From the Command-Line

The 'topic-set' sample can be run directly by issuing the following command

For Windows

java -jar ..\..\deltaxml-dita.jar compare map doc-1-6-3\userguide.ditamap doc-1-7-2\userguide.ditamap topic-set-A ^
  map-result-origin=A ^
  map-result-structure=topic-set

PowerShell Usage: Replace the ^ line-continuation character with the ` character.

For Mac (or Unix)

java -jar ../../deltaxml-dita.jar compare map doc-1-6-3/userguide.ditamap doc-1-7-2/userguide.ditamap topic-set-A \
  map-result-origin=A \
  map-result-structure=topic-set

The 'map pair' or 'unified map' comparisons can be run in a similar manner to the 'topic set', but in this case the map-result-origin is B, the map-result-structure is map-pair or unified-map, and the map-copy-location is map-pair-B or unified-map-B.

.NET Platform

Using a Batch File

Run the rundemo.bat batch file either by entering rundemo from the command-line or by double-clicking on this file from Windows Explorer. This script runs the same comparison twice with different output settings (topic-set and unified-map).

From the Command-Line

The 'topic-set' sample comparison can also be run from the command line, using the following:

..\..\bin\deltaxml-dita.exe compare map doc-1-6-3/userguide.ditamap doc-1-7-2/userguide.ditamap topic-set-A ^
  map-result-origin=A ^
  map-result-structure=topic-set

The 'map pair' or 'unified-map' comparison can be run in a similar manner to the 'topic set', but in this case the map-result-orign is B, the map-result-structure is map-pair or unified-map, and the map-copy-location is map-pair-B or unified-map-B.