Localization with a Source Package

A source package includes both textual content and media content.

Package Contents

A source package can contain the following resources:

Note: Only translatable elements are included in the package. This means that elements with the translate attribute set to no are not included in the packages.
Target Language Folder
The folder that your localization provider uses to localize content. When you create a source package, you select locales, or target languages, for your localization job. For each of the locales, you'll generate a separate folder in the source package.

The folders are named using the locale code. For example, the folder for Canadian French localization is named fr-ca, and the folder for Polish localization is named pl.

Each target language folder contains the map targeted in the localization job and all dependencies, including submaps, topics and media. The files are located in a folder structure that is identical to your Heretto CCMS folder structure.

Note: The package contains complete text content from the dependencies of the map, including resource-only topics. In other words, the content added with content references (conref) or content key references (conkeyref) is localized.
Source Language Reference Folder
A folder that contains the source map and all dependencies in the source language. The files are located in a folder structure that is identical to your Heretto CCMS folder structure.
Important: The files can be used by your localization provider as a reference during the localization process. None of the files located in this folder should be localized. To localize content, your localization provider should use the target language folder(s).
Reference File
A published map, for example, localization-reference.pdf.
Remember: To add a reference file to the localization job, you must publish a map before creating the localization job. We recommend including a reference file in localization packages and instructing the localization provider on where to find it.
Project Notes
Notes that you add when you create a localization job. Project notes are useful to share information with the localization provider.
Remember: Always ask the localization provider to read the project-notes.txt file included in the package. Otherwise, they may ignore it.

Localize Content with a Source Package

Source packages contain both textual and media content.

  • 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.
Create and localize packages
  1. Create a source package. See Create a Source Package.
  2. Do any of the following:
  3. Upload the localized source package to Heretto CCMS. See Upload the Localized Source Package.
Verify and publish the localized content
  1. Optional: Preview the localized content. See View Localized Content.
  2. Publish the localized content.
    Remember: While publishing, set the Locales option to a desired target language.
If needed, do any of the following:

Create a Source Package

Create a Source package for a map, bundling together the content associated with the map, which is available in a ZIP file to download and send for localization. The Source package contains all DITA files, including your warehouse topics and media files. The files are located in a folder structure that is identical to your Heretto CCMS folder structure.
  1. Create a Source package for a map by doing one of the following:  
    OptionDescription
    Recommended: Create the Source 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 Source 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 select Localization Jobs.

    Create the Source package for a standard map: In the content library, right-click the map and select Localization Jobs.
  2. From the New Localization Job drop-down menu, select Source 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. 

      This information will be added to the Source package in the project-notes.txt file.

    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 a Heretto CCMS user who is responsible for the localization job. As a result, your localization provider will have this information at hand since it is included in the project-notes.txt file in the Source Package.

    3. In the Include field, select All Resources if you're localizing 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 one or more target languages.
    5. Click Save.
  4. Click Download Localization Package and save the ZIP file to your computer. 
    A ZIP file named localization-job-number.zip, for example, localization-job-106.zip, is saved to your computer. The ZIP file contains the following elements:
    source package contents
    where:
    • fr-ca folder contains DITA and media files that will be localized, in this case, into Canadian French (fr-ca)

    • pl folder contains DITA and media files that will be localized, in this case, into Polish (pl)

    • localization-reference-pdf folder contains the reference PDF

    • source-language-reference folder contains DITA and media files in the source language that will be used by the localization provider for the localization process

    • project-notes.txt contains project notes added as part of this localization job

    In both folders, DITA and media files are located in a folder structure that is identical to your Heretto CCMS folder structure.

  5. Send the ZIP file to your localization provider.

    If your localization provider is not familiar with localizing Heretto CCMS Source packages, you may want to share with them the documentation on Localize Source Package Content.

Localize Source 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 to which you unzip the file.
    Figure 1. Zipped and unzipped source package files
    Zipped and unzipped source package files
  2. Open the unzipped Source Package folder and:
    1. Go to the source-language-reference folder, and view the DITA and media files it contains for the localization provider.
    2. Read the project-notes.txt file that contains an email address for the project manager and important project-related information.
  3. In the target language folder, for example, fr-ca or pl, navigate down the folder structure to the DITA and media files and localize them.
    Important: You must save the localized files to their original location using the original file names and extensions.
  4. When you finish localizing all DITA and media files, zip the localized Source Package by right-clicking it and compressing it into a ZIP file. Name the new ZIP file exactly the same as the original ZIP file.
    Important: The new ZIP file must be named exactly the same as the original ZIP file.
    Zip file example
  5. Send the localized ZIP file back to the project manager or upload it to Heretto CCMS.

Upload the Localized Source Package

When your localization provider is done localizing your content, they send you an identical Source Package ZIP file with the same content. The only difference is that the DITA and media files in the target language folder(s) are now localized. Upload the ZIP file to Heretto CCMS and verify that 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, click the localization job for which you want to upload localized content.

    You can 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 Upload Response window, verify that the files you upload match the correct files in Heretto CCMS and click Save
    upload response

In the Status of Resources view, verify that all resources in your localization job show as Current. The number in green should say 100%. This means all resources are current. Your localized DITA content is uploaded to Heretto CCMS. You can now publish the localized content.