Compare snapshots and maps (redlining)

You can compare snapshots or maps to see the textual differences between them.

The Redline with function is like a word processor's compare function. It produces an output by comparing a version of the map in the Authoring or Localization cycle to one of the following objects:
  • a copy of that map with the Published:done status
  • a copy of that map from a Snapshot

The additions and deletions in the comparison are highlighted in different colors. This marking of the differences is referred to as redlining. The colors are configurable by the administrator.

Note: Changes at the map level are generally not highlighted by the redline comparison. The comparison shows only changes to objects in the map. It does not highlight if the topics have been reorganized or removed from the map. However, it can highlight when a new topic or object is added as any new text is considered an addition.

Changes to images in the topics might be highlighted depending on the type of change. If an image element is deleted or the image ID is replaced in the topic, then the change will be highlighted. However, changes to the .image file itself, such as adding a different format or editing the graphic, is not highlighted in the redline output.

Note: IXIASOFT recommends that your deployment use at least DITA Open Toolkit version 2.5.4 when using the redline comparison. Contact IXIASOFT Customer Support if you need assistance upgrading the DITA-OT.

To perform a redline comparison:

  1. Right-click the map and select Compare With > Redline with.
    The map and the current revisions of objects in it becomes the basis for the comparison.

    For example, if a topic is not in this current revision of the map, then it is not part of the comparison.

  2. Click the checkbox next to the map or snapshot to which you want to compare the map.
A PDF copy of the map is generated with the differences highlighted.

The comparison shows the current structure of the map you selected. The comparison highlights any textual differences between the current revisions of objects in the map and the revisions used in the map or snapshot that you compared the map with.