Your Account
avatar photo

guest

Logout
User GuideContent StrategieseasyDITA GuidesDITA GuidesFAQsRelease Details
contact support
Loading...
  • Contents
  • Releases
  • Create a Release
  • View a Release
  • Download a Release
  • Publish a Release
  • Localize a Release
  • Deprecate a Release
easyDITA User Guide > Version > Releases
send feedback
❮   Previous Next   ❯
  • Contents
  • Releases
  • Create a Release
  • View a Release
  • Download a Release
  • Publish a Release
  • Localize a Release
  • Deprecate a Release
Releases

Releases

Releases enable you to create non-editable copies, or snapshots, of maps with all dependencies at their current state.

Interface

The Releases tab enables you to manage all aspects of maps releases.
Note: Depending on your easyDITA configurations, some operations may be restricted to Administrators and users with specific permissions.
Figure 1. Releases Tab

The Releases tab enables you to do the following:

  • Create new releases
  • Localize releases
  • Publish releases
  • Branch releases
  • Preview releases
  • Download releases
  • Deprecate (or archive) releases

Guidelines

Keep the following guidelines in mind when working with releases:

  • Before creating a release, check the content for errors. You can do that by publishing your content and verifying how the output looks.
  • Establish a releases naming convention. Once you create a release, you cannot change its title.
  • The resources in releases do not count against your content object limits.

Example

Figure 2. Releases.

The following example shows three releases of a product guide created from the master branch. The releases cannot be edited.


Create a Release

Create a Release

Use the Releases tab in the resource manager to create a release and archive content in its current state.

  1. In the content library , right-click a topic or map and select Releases.
  2. Click Create Release. Publish Release window
  3. Enter a release name and notes.
  4. Click Publish Release. Releases tab
The newly created release is listed in the Releases tab.
View a Release

View a Release

View a release to see what the topic or map looked like when the release was create

  1. In the content library , right-click a topic or map and select Releases.
  2. Click View.

    The release name and released content show in the resource manager .

    Branching tab

  3. To navigate the topics, you can scroll or click a topic in the navigation pane.

Download a Release

Download a Release

Use the Releases tab in the resource manager to download the source files for a release.

  1. In the content library , right-click a topic or map and select Releases.
  2. Click Download Source (zip). Download dialog
  3. Click Save.
Publish a Release

Publish a Release

Publish a release by using the DITA Open Toolkit.

  1. In the content library , right-click a topic or map and select Releases.
  2. Next to the release that you want to publish, click View .
  3. In the top-right corner, click the Publish button.
  4. From the list on the left, select a publishing scenario.
    Figure 1. Publish Window
  5. Optional: In the Enter Description field, enter a meaningful description.
    Once you publish the document, this description appears in the list of finished publishing jobs.
  6. Set the publishing scenario options.
    Note: The publishing parameters are specific to each publishing scenario and are configured by your easyDITA administrator. The publishing scenarios can include the following parameters.
    transtype
    Defines output format, like PDF or HTML.
    args.filter or ditaval
    Enables you to select a DITAVAL file for conditional publishing.
    args.rellinks
    Specifies linking settings in the output.
    args.draft
    Specifies if the draft comment elements are included in the output.
    Locales
    Enables you to select a locale when publishing localized content.
    Webhooks
    Enables you to send webhooks on successful publish or any publish.
    Debug publish
    Generates additional files in the debug folder that you can use to troubleshoot your publication.
  7. Click Publish .
    The map or topic publishes. It may take a moment to complete.
    Figure 2. Output Tab
  8. Download the published files by hovering over the publishing job and clicking the Download icon.

Localize a Release

Localize a Release

Use the Releases tab in the resource manager to localize a release.

  1. In the content library , right-click a released file and select Releases.

    The Releases tab in the resource manager appears.

  2. Click Localize.
    Important: Localizing a release is distinct from localizing the source map content. The localized content for the release will stay with the release and the localized content will not show with the source map.

    The Localization Manager interface appears.

  3. From the New Localization Job menu, select a localization package and 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.

      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 .
  6. Click Download Localization Package and save the ZIP to your computer.
You can send out the downloaded file for localization. Once the localization is complete, upload the zip file back into easyDITA.
Deprecate a Release

Deprecate a Release

Deprecate a release that you no longer need.

  1. In the content library , right-click a topic or map and select Releases.
  2. Click Deprecate this Release.
    The release is deprecated, the release information is hidden, and the deprecated release minimized.
    Note: Deprecating a release does not delete it. Users with administrative privileges can un-deprecate a release at any time.


Loading...

There was a problem loading this topic

  • Jorsek LLC

    320 Goodman St. N.
    Suite 104
    Rochester, NY 14607
    USA
    Toll Free: 1-877-492-2960
  • Additional Resources

    • easydita.com
    • About
    • Resources
    • Support
Copyright © 2004-2017 Jorsek LLC. | Legal

Add/Remove Bookmark Sets