Create a snapshot

When you create a snapshot, the DITA CMS creates an .xml file that contains the list of all the objects in the map along with their version numbers.

The map must not be locked, but the objects in the maps may be locked. When you create a snapshot, the map and its objects can be in any state.

Important note

To create the snapshot, the DITA CMS uses the latest released revisions of the objects in the map. Therefore, if you have locked documents in your map, the snapshot will not include these locked revisions but rather the latest released revisions of these objects.

In the default configuration, when you create a snapshot, the snapshot object is in the Authoring:review status (or the equivalent in your deployment).

You can create a snapshot from any view that lists the map (Search Results, DITA Map, Dependencies, etc.).

To create a snapshot of a map:

  1. In a view that lists the map, right-click the map and select Create snapshot.
    The Create Snapshot window appears:
    Create Snapshot window
    By default, the title of the map is used as the title of the snapshot.
  2. If desired, modify the snapshot title in the Title field.
    This might be useful to differentiate the snapshots for a map. For example, to indicate that a snapshot identifies the version of the Web Author Installation Guide that was sent for technical review, you could enter "Web Author Installation Guide - Tech Review".
  3. In the Version field, specify the version for this snapshot.

    If a branch is created from the snapshot, the branched map will automatically be assigned the version of the snapshot.

    Note: The version specified is the version of the snapshot and is not related to the product version.
  4. Click OK.
    The snapshot is created. As with any DITA CMS object, you can search for a snapshot in the Content Store. You can also output a snapshot, branch it, or publish it.