Gretyl's Portal

Heretto Help

Show Page Sections

Media Package

A media package bundles all media files related to a publication, such as screenshots or diagrams. It contains no textual content. It is useful for projects in which media content needs to be localized separately from textual content or when only media content needs to be re-localized. Media package is also a complementary package to the XLIFF package and XTM Integration as they are text-only packages.

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"/>

Media Package Localization Process

Media packages contain only media content, like screenshots 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 a 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 services provider (LSP). 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 Drawer opens.
  2. Create a localization package by doing one of the following:
    OptionDescription

    Recommended: Create a localization package for a released map

    1. In the Resource 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 Drawer, select Branches. You will see a list of branches related to your map.

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

    3. The Branches tab closes and you can see the Content Library in the branch you switched to.

    4. Click the map you want to localize and, in the Resource Drawer, select the Jobs tab.

    Create a localization package for a standard map

    In the Resource Drawer, select the Jobs tab.

  3. Click Create Localization Job.

Configure and create a media package

  1. From the Job Type drop-down menu, select Media Package.
  2. In the Manager field, choose the person you want this project to be assigned to.
  3. Click the Locales field and select applicable target languages.
  4. Click the Due Date field and set a deadline for this project.
  5. In the Notes field, enter information about the project, including information for the localization provider.
  6. In the Include drop-down menu, select an option:
    • If you are sending the files for localization for the first time, select All Resources.

    • If the files were already translated and you only need to send the changed files for localization, select Only Changed Resources. As a result, only the files that were modified since the last upload are included in the package.

    Figure 2. Media Package Configuration
    Media package localization job

    A summary of the configuration is added to the package in project-notes.txt.

  7. Click Create.

Download the package and send it for localization

  1. In the Jobs tab, click the newly created package.
  2. Click Download Localization Package.

    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.

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

    If your localization provider is not familiar with localizing Heretto CCMS media packages, you may want to share with them Localize Media Package Content.

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 3. Zipped and unzipped media files
    Zipped and unzipped media files on a Windows machine
  2. Open the unzipped Media localization 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.

    Figure 4. An example of what zipping a file looks like on a Windows® machine
    Zip files menu
  5. Send the localized ZIP file back to the project manager or upload it to Heretto CCMS.

Upload a 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.

    2. In the Resource Drawer that opens, select Releases.

    3. In the Releases tab, go to the desired 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.
    2. In the Resource Drawer that opens, select Branches.

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

    4. The Branches 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 Drawer that opens, 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.
    2. In the Resource Drawer that open, select the Jobs tab.

  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 localization package 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.

    A notification Update was successful! appears.

  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.

  5. Optional: If all work for this localization job is complete, mark the job complete by clicking Complete Job.

    The localization job status changes to Completed. You can no longer upload localized content for that package.