Release a locked map, topic, or image

The Release command saves your latest modifications to the server and frees the file so other users can edit it.

Prerequisites:
  • The document object (that is, a map, image, or topic) must be in the locked state.

  • Document objects can only be released by the user who locked them.

Releasing a map, topic, or image saves your latest modifications to the server and frees the file so other users can edit it. In the case of a map, the release command updates changes to the map's structure. In the case of an XML topic, the release command validates the topic to ensure that references are correct and that the XML is well-formed. If your XML document has errors, you will be able to save it locally, but you will not be able to release it to the server. Using the release function regularly serves two purposes:

  • Data preservation: saves a copy of your work in the repository.
  • Collaboration: shares your update with other users.

The Release function is available from all DITA CMS views.

To release a document:

  1. Search to locate the map, topic, or image you want to release.
  2. Select one or more document objects to release.
  3. Right-click and select Release.
    The Release dialog box appears:
    Figure 1. Releasing a topic

  4. Do one of the following to describe the changes since the last update:
    • Under Comment, enter a comment.
    • Select a comment from the Choose a previously entered comment area.
    • Select one or more comments in the Preset comments area.
    Note: If preset comments have not been configured for your DITA CMS, the Preset comments area will be blank.
  5. (Optional) If you are using a bug tracking system (such as JIRA or Bugzilla), add the bug number that you are fixing with this release in the Tracker link field.
    A link to the bug will be added to the Release History. To add more than one bug, separate them by a comma.
  6. (Optional) To update the document without releasing it, select Keep locked.
    Note: The Substantial Change option, selected by default, means that when the document is released, it can be advanced to the next status (typically edit/review). However, if you made a minor change to a previously-edited topic, you can clear the Substantial Change option. The document state will pass directly from rework to done (or according to your configuration) and the document will not appear in SMEs' Todo lists.
  7. Click OK.
    The document is updated in the repository of your Content Store. If you release a document that has not been changed, the lock is simply removed; no new document version is created in the DITA CMS. If you did not keep the file locked (Step 5), the file properties are displayed in black text in the various views. The comment you specified appears under Last User Comment in Todo Lists, as well as in the other places that file properties are displayed, such as Search Results view and DITA Map view.
Tip: The procedure above described how to release a closed topic. Alternatively, you can use release to update an already-open topic:
If you're using the Oxygen editor and you want to release a topic that's currently open in your editor, you can do one of the following:
  • In Text mode, right-click anywhere in the topic, then select Release.
  • Press CTRL+ALT+SHIFT+R.
  • Click the Release file button in the toolbar (Oxygen release topic button).