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 easyDITA 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 easyDITA. 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 easyDITA 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 easyDITA.

  1. Create an Media package for a map by doing one of the following: 
    OptionDescription
    Recommended: Create the Media package for a released map:
    1. In the content library, right-click the map and select Releases .

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

    Create the Media package for a branched map:
    1. From the Branch drop-down menu, select the branch that contains the map you want to localize.

    2. In the content library, right-click the map and click Localization Jobs .

    Create the Media package for a standard map:In the content library, right-click the map for which you want to create the Media package and click Localization Jobs .
  2. From the New Localization Job drop-down menu, select Media Package . Click Go .
  3. In the localization manager, configure and save your localization job:
    1. In the Project Notes field, enter information about the project, including information for the localization provider. 
    2. In the Manager field, leave your email address or change it to a different person.

      In the Manager field, you can add any string of characters. However, we recommend that you use it to add an email address to an easyDITA user who is responsible for the localization job. As a result, your localization provider will have this information at hand.

    3. In the Include field, select All Media if you localize the files for the first time or Only Changed Resources if you have already localized the files.
    4. In the Pick Target Locales field, add a target language or more. 
    5. Click Save .

    Your localization job appears. You can view the project notes, manager, locales, resources, and status of resources.

  4. 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 easyDITA folder structure. 

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

    If your localization provider is not familiar with localizing easyDITA 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
  2. Open the unzipped Media package folder and:
    1. 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.
  5. Send the localized ZIP file back to the project manager or upload it to easyDITA.

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 easyDITA and verify if localization is complete.

  1. Upload localized content for a map by doing one of the following:
    OptionDescription
    Recommended: Upload localized content for a released map:
    1. In the content library, right-click the map and select Releases .

    2. In the Releases tab, go to the release for which you want to upload content and click Localize .

    Upload localized content for a branched map:
    1. From the Branch drop-down menu, select the branch that contains the map you want to upload.

    2. In the content library, right-click the map and click Localization Jobs .

    Upload localized content for a standard map: In the content library, right-click the map and click Localization Jobs .
  2. In the Localization Jobs in Progress tab, select the localization job you want to upload localized content for.

    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 the Localization Jobs in Progress tab.

  3. Click Upload Localized Content and, in the Upload window, upload the ZIP file with localized content.
  4. In the localization manager, click show resources and verify if all files associated with your map are uploaded to easyDITA.

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

Your localized DITA content is now uploaded to easyDITA.