Topic Sample

 Table of Contents


1. Summary

This sample compares two DITA topic files in1.dita and in2.dita. Please read the content of the DITA markup result (results/dita-markup.dita) as it is designed to illustrate several of our DITA comparison product's features.

The sample uses either .NET or Java versions of DITA Compare, according to the version downloaded. Samples for both platforms are covered here.

1.1. Output Format

The result of this comparison depends on the selected output format, as discussed in the Output Formats Section of the Reference and summarized in the table below.

Output Format
EnumerationDescription
dita-markupMark changes using DITA's rev and status attributes.
arbortext-tcsMark changes using the Arbortext editor's tracked changes format.
framemaker-tcsMark changes using the FrameMaker editor's tracked changes format.
oxygen-tcsMark changes using the oXygen tracked changes format.
xmetal-tcsMark changes using the XMetaL tracked changes format.

1.2. Lexical Preservation

The sample scripts also set two parameters to preserve the lexical formatting of the source document.

  1. preservation-mode=roundTrip
  2. whitespace-processing-mode=ignore

2. Running the sample

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

#content .code