Localization with a Media Package

A media package bundles all media files related to a map such as diagrams or screen captures.

Package Contents

A media package can contain the following resources:

Media Files

The target language folder, for example, fr-ca or pl, is the folder your localization provider uses to localize content. When you create a media package, you select locales, or target languages, for your localization job.

Each locale generates a separate folder in the media package. The folders are named by locale code, for example, the folder for Canadian French localization is named fr-ca, and the folder for Polish localization is named pl.

Manifest XML File
Each target language folder contains media files that are located in a folder structure that is identical to your Heretto CCMS folder structure. Each target language folder also contains a manifest.xml file that contains a list of media resources and their destination in the package.

The manifest.xml file can be used by the localization provider to effectively navigate the folder structure of the Media Package and ensure all files are localized.

Figure 1. Manifest XML File Example.

In the following example, you can see a media resource named Classic_Toaster.jpg and its destination in the folder structure.

<item resource-uuid="0d06da50-1169-11e6-9ac7-bc764e105744" resource-name="Classic_Toaster.jpg"
        destination="
                                    media-localization-package-102/pl/master/documentation/documents/Instructive_Learning_and_Training/Demo_Content/Hardware/_Global_Media/Classic_Toaster.jpg
                                "/>

Localize Content with a Media Package

Media packages contain only media content like graphics or diagrams.

  • Set the source language for the DITA content that you want to localize.
  • Recommended: Publish the reference content.
    Remember: While publishing, set the locale option to the source language.
  1. Create a media package. See Create a Media Package.
  2. Do any of the following:
  3. Upload the localized media package to Heretto CCMS. See Upload the Localized Media Package.
If needed, do any of the following:

Create a Media Package

When you create a Media package for a map, all media files associated with the map, for example, diagrams or screenshots, are bundled together and made available to you in the form of a ZIP file that you can download and send to your localization provider. The Media package contains no DITA maps or topics, only media files. The files are located in a folder structure that is identical to your Heretto CCMS folder structure.

Before you create a Media package, verify that the media file names contain no illegal characters, for example, spaces. If they do, you will not be able to upload the localized package back to Heretto CCMS.

  1. In the content library, click the map you want to localize.

    On the right side of the screen, the Resource Details Drawer appears.

  2. Create a localization package for a map by doing on of the following:
    OptionDescription

    Recommended: Create a localization package for a released map

    1. In the Resource Details Drawer, select Releases .

    2. In the Releases tab, go to the release you want to localize and click Localize.

    Create a localization package for a branched map

    1. In the Resource Details Drawer, select Branches. You will see the list of branches related to your map.

    2. In the Branching tab, switch to the branch that contains the map you want to localize.

    3. The Branching tab closes and you are back in the content library. Click the map for which you want to localize content.

    4. In the Resource Details Drawer on the right of the screen, select the Jobs Tab.

    Create a localization package for a standard map

    In the Resource Details Drawer, select the Jobs Tab.

  3. Click the Create Localization Job Button.
  4. Configure the Media package by completing the following steps:
    1. From the Job Type drop-down menu, select Media Package.
    2. In the Manager field, leave your email address or change it to a different person.
    3. Click the Locales field, and pick as many languages as you want.
    4. Click the Due Date field, and select as many languages as you want.
    5. In the Notes field, enter information about the project, including information for the localization provider.
    6. In the Include drop-down menu, select All Media if you localize the files for the first time or Only Changed Resources, select the kind of media you want to send to localization.
    Media package localization job
  5. Click the Create Button.
  6. In the Jobs tab, click the newly created package.
  7. Click Download Localization Package and save the ZIP file to your computer.

    A ZIP file named media-localization-package-number.zip, for example media-localization-package-108.zip, is saved to your computer. The ZIP file contains all media files associated with your map. The files are located in a folder structure that is identical to your Heretto CCMS folder structure.

  8. Send your Media ZIP file to your localization provider.

    If your localization provider is not familiar with localizing Heretto CCMS Media packages.

Localize Media Package Content

If needed, you can localize content in-house instead of sending it to an external localization provider.

  1. Save the ZIP file you received for localization to your computer and unzip it.
    Important: Do not change the name of the folder when you unzip the file.
    Figure 2. Zipped and unzipped media files
    Zipped and unzipped media files
  2. Open the unzipped Media package folder, navigate to a target language folder, for example fr-ca or pl, and open the manifest.xml file it contains.
    Tip: The manifest.xml file contains a list of media resources and their location in the package. Use it to effectively navigate the folder structure of the Media Package and ensure all files are localized.
  3. Navigate down the target language folder to media files and localize them.
    Important: You must save the localized files to their original location using the original file names and extensions.
  4. Zip the localized media package by right-clicking it and compressing it to a ZIP file.
    Important: The new ZIP file must be named exactly the same as the original ZIP file.
    Zip files menu
  5. Send the localized ZIP file back to the project manager or upload it to Heretto CCMS.

Upload the Localized Media Package

When your localization provider is done localizing your content, they send you an identical media ZIP file with the same content; the only difference is that the media files in the target language folder(s) are now localized. Upload the ZIP file to Heretto CCMS and verify if localization is complete.

  1. Navigate to the localization job for which you want to upload localized content back to Heretto CCMS by doing one of the following:
    OptionDescription
    Recommended: Upload localized content for a released map:
    1. In the content library, click the map for which you want to upload localized content. The Resource Details Drawer appears on the right side of the screen.

    2. In the Resource Details Drawer, select Releases.

    3. In the Releases tab, go to the proper release and click Localize.

    Upload localized content for a branched map:
    1. In the content library, click the map for which you want to upload localized content. The Resource Details Drawer appears on the right side of the screen.
    2. In the Resource Details Drawer, select Branches. You will see the list of branches related to your map.

    3. In the Branching tab, switch to the branch that contains the map for which you want to upload localized content.

    4. The Branching tab closes and you are back in the content library. Click the map for which you want to upload localized content.

    5. In the Resource Details Drawer on the right of the screen, select the Jobs Tab.
    Upload localized content for a standard map:
    1. In the content library, click the map for which you want to upload localized content. The Resource Details Drawer appears on the right side of the screen.
    2. In the Resource Details Drawer, select the Jobs Tab.

    Upload localized content for any map

    In the content library, go to Localization Jobs in the left pane.

  2. From the Localization Jobs list, select a job you want to upload localized content for. The value in the Job Type column will show Media Package for this localization job.
  3. Click Upload Media Package and in the Upload window, upload the ZIP file with localized content.

    You can easily identify the correct localization job by using the localization job number that you can see in both the ZIP file name and on the Localization Jobs list.

    If the localization process was done correctly, you will see the confirmation message saying: Localization package uploaded successfully.

  4. Under the Localization Jobs in Progress section of your current job, you can click any locale to verify if all files associated with your map are loaded to Heretto CCMS.

    After you upload your media ZIP file, all your media files should show as Current.