User Guide
Table of Contents
User Guide
Releases
Releases
The Releases feature is a versioning tool that enables you to archive content at a specific point in time. The released version can then be downloaded, branched, and published whenever you want.
Creating a Release
Use the Releases Tab in the Resource Viewer to create a release and archive content in its current state.
Viewing a Release
Use the Releases Tab in the Resource Viewer to view a release.
Downloading a Release
Use the Releases Tab in the Resource Viewer to download the source files for a release.
Publishing a Release with the DITA OT
Use the Releases Tab in the Resource Viewer to publish a release.
Localizing a Release
Use the Releases Tab in the Resource Viewer to localize a release.
Branching a Release
Use the Releases Tab in the Resource Viewer to branch a release.
Deprecating a Release
Use the Releases Tab in the Resource Viewer to deprecate a release that is no longer the latest release.
Releases

The Releases feature is a versioning tool that enables you to archive content at a specific point in time. The released version can then be downloaded, branched, and published whenever you want.
section
The Releases feature enables you to track a document’s progress. When a release is created, an archive of the content at its current state is created. The release version cannot be modified, it is a permanent and unalterable archive. You can, however, continue to edit the original document normally.
The released version is stored with the original document. So if you need to view or generate output for the released version, you can. Think of a release as a snapshot of your content, which you can access whenever you want.
Note:You must be an Administrator or have specific user permissions to branch and release content.
Use the Releases Tab in the Resource Viewer to create, download, branch, publish, and depreciate releases.
section

Release Example

When you create a release, an archive of the content at its current state is created. In the example below, when you create a release for Map XYZ at the end of Quarter 1, a released version is saved with the original file. You can continue editing the original document without affecting the released version.

Creating a release at Q1
When the end of Quarter 2 arrives, you can create another release. All release versions are stored with the original file. For example:

Creating a release at Q2
When the end of Quarter 3 arrives, you can create another release.

Creating a release at Q3
You can continue to create releases for each milestone. These release versions can be accessed whenever you want.
section

Localization

In easyDITA, you can localize not only standard maps but also released maps. You can easily view the locales for a map, topic, or media file in the Locales Tab. Locales are versions of your content in a target language, for example, in Canadian French or Polish. The locales listed in the Locales Tab are locales for the standard map and the locales created for the releases of the map.
Creating a Release

Use the Releases Tab in the Resource Viewer to create a release and archive content in its current state.
  1. In the Content Manager , right-click a topic or map and select Releases.

    Expected Result
    The Releases Tab in the Resource Viewer displays.

  2. Click Create Release.

    Expected Result
    The Publish Release window displays.
  3. Enter a release name and notes.
  4. Click Publish Release. Releases Tab
result

A release is created for the topic or map and listed in the Releases Tab.

Viewing a Release

Use the Releases Tab in the Resource Viewer to view a release.
  1. In the Content Manager , right-click a topic or map and select Releases.

    Expected Result
    The Releases Tab in the Resource Viewer displays.

  2. Click View.

    Expected Result
    The release name and released content display in the Resource Viewer .

    Releases Tab Branching Tab

  3. Do any of the following:

    1. To navigate the topics, click a topic in the navigation pane.

      Step Information
    2. To navigate backwords or forwards, click Previous or Next.

      Step Information
result

You are viewing a release.

Downloading a Release

Use the Releases Tab in the Resource Viewer to download the source files for a release.
  1. In the Content Manager , right-click a topic or map and select Releases.

    Expected Result
    The Releases Tab in the Resource Viewer displays.

  2. Click Download Source (zip). Download dialog
  3. Click Save.
result

The source files for the release are downloaded as a zip folder to your computer.

Publishing a Release with the DITA OT

Use the Releases Tab in the Resource Viewer to publish a release.
  1. In the Content Manager , right-click a topic or map and select Releases.

    Expected Result
    The Releases Tab in the Resource Viewer displays.

  2. Click Output.

    Expected Result
    The Publishing interface displays.
    Note:Available options vary based on your configuration.

  3. In the Publishing interface, select DITA Open Toolkit.
  4. Click New Publish .

    Expected Result
  5. In the Description text box, enter a description. This is what will appear in the list of previous publishes.

    Example
  6. Click Add next to the publishing scenario you want to use.

    Step Information
    The default publishing scenarios are Basic 1.5.2 and Basic 1.5.3. The numbers refer to versions of the DITA Open Toolkit.
    To create multiple outputs from one map in a single publishing operation, add multiple publishing scenarios. For example, you could add Basic 1.5.3 twice – once for HTML, and once for PDF.

  7. Set the parameters for each publishing scenario you have selected.

    Step Information

    Note that parameters are specific to each publishing scenario as defined by your system administrator. Typical parameters are Transformation Type (transtype, which defines the output format), locale, or DITAVal file which lets you select a configuration file in the DITAVal format.

  8. Click Publish .

    Expected Result
    The Publishing Manager screen and the status of the publication job are displayed.
result

You published and downloaded the topic or map release.

Localizing a Release

Use the Releases Tab in the Resource Viewer to localize a release.
  1. In the Content Manager , right-click a released file and select Releases.

    Expected Result
    The Releases Tab in the Resource Viewer displays.
  2. Click Localize.

    Expected Result
    The Localization Manager interface displays.
  3. From the New Localization Job menu, select a localization package. Click Go.
  4. Configure your localization job:

    1. In the Project Notes field, enter any notes you have for the localization team. These notes will display in a TXT file in the localization package. Project Notes field
    2. (Optional) To modify the Manager, enter or select a user.
    3. (Source and Media Packages only) To include all resources in the source package, in the Include drop-down menu, select All Resources.
    4. In the Include field, select All Media if you localize the files for the first time or Only Changed Media if you have already localized the files.
    5. In the Pick Target Locales field, add one or more target languages.
    6. (Optional, XLIFF Package only) Under Pick Reference Content to Include, select the reference content you created earlier.

      Step Information
      Even though this step is optional, we recommend to always add reference content, for example PDF or HTML. It will be added in a folder to your XLIFF package.
  5. Click Save.

    Expected Result
    The localization job displays. The Project Notes, Manager, and Locales are displayed.
  6. Click Download Localization Package .
result

The localization job for the release is created and the source files are downloaded. You can send the file out for localization. Once the localization is complete, upload the file.

Branching a Release

Use the Releases Tab in the Resource Viewer to branch a release.
  1. In the Content Manager , right-click a topic or map and select Releases.

    Expected Result
    The Releases Tab in the Resource Viewer displays.

  2. Click Branch.

    Expected Result
    The Create New Branch window displays.
  3. Do one of the following:

    • To create a new branch, enter a new branch name.
    • To merge the release into another branch, select the branch.
  4. Click Save.

    Expected Result
    A dialog displays.
  5. Click OK.
result

The release is branched.

Deprecating a Release

Use the Releases Tab in the Resource Viewer to deprecate a release that is no longer the latest release.
  1. In the Content Manager , right-click a topic or map and select Releases.

    Expected Result
    The Releases Tab in the Resource Viewer displays.

  2. Click Deprecate this Release.

    Expected Result
    The release is deprecated and the release information is hidden.

result

The release is deprecated.