Branch topic(s)

Use this option to branch one or more topics within a branched map.

  • The root map must be open in the DITA Map view.
  • All referring documents must be in a state that allows them also to be branched.
Once you have branched a map, you can go on to branch the topics that it contains. When you branch a topic the system creates a new, editable version in the Authoring cycle and gives it the status Authoring:work (or its equivalent in your workflow).
Note: If the topic is referenced by multiple maps in the same branch (that is, the maps have the same branch tag), and the topic has already been branched in another map, then a new copy of the topic is not created. Instead, the map will be updated to reference the branched version of the topic. This ensures that a topic that was reused by multiple maps before the branching operation continues to be reused by the maps within a branch.

During the branch operation, the system attempts to update all references within the map (xrefs, rel-links, conrefs, etc.) to refer to the new copy of the topic. This requires that all the documents that contain these references be branched as well. In addition, the system provides you with the option of updating any other branched map that contains the topic with the new branched version.

If any of these referring topics is in a state that prevents its references from being updated – if a topic is locked by another user, for example – then you'll get an error message, listing the maps and topics that prevented the branch operation from being performed.

  1. In the DITA Map view, right-click the topic(s) and select the applicable option:
    • Branch > Branch Topic
    • Branch > Branch Topics
    You can select several documents by holding down CTRL or SHIFT and clicking the documents.
    If branching this document requires that other documents also be branched, the Branch Documents dialog appears. It displays a list of the documents that will be affected by this change and asks if you want to continue.
  2. Click OK.
A copy of the published topic(s) is created in the Authoring cycle and assigned the appropriate status. All branched topics automatically receive the same tag as the parent map.