Under maintenance

Heretto Help

Show Page Sections

Source Package

A source package contains both textual and media content, like screenshots, in its original format, like DITA and PNG files. Because of that, source packages are useful for the localization of large publications or projects that need to be completed by multiple translators. Source package is an all-in-one package type.

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 name, for example, fr-cs or pl, that your localization provider uses to save localized content. When you create a source package, you select locales, or target languages, for your localization job. For each of the locales, a separate folder is created 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.

Important:

If your content hasn't been translated before, all files in this folder are in the source language. If your content has been translated before, files in this folder contain the existing translation to the target language. Don't use files in this folder as the source for translation. Instead, use files from the source-language-reference folder.

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 named source-language-reference that contains the source map and all dependencies in the source language. Files it contains are located in a folder structure that is identical to your Heretto CCMS folder structure.
Important:

Use files in this folder as the source files for translation. However, never save the translation in this folder; always use a target language folder, like fr-ca or pl, instead.

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.

Source Package Localization Process

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:

    In the publishing job, set the Locales 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:

    Regardless of whether your content is translated in-house or by a localization provider, ensure that translator(s) familiarize themselves with information provided in Localize Source Package Content.

    • Send the source package to your localization provider.
    • Localize the package on your own.
  3. Upload the localized source package to Heretto CCMS. See Upload a Localized Source Package.
Verify and publish localized content
  1. Optional: Preview localized content. See View Localized Content.
  2. Publish localized content.
    Remember:

    In the publishing job, 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. 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 source package

  1. From the Job Type drop-down menu, select Source 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 1. Source Package Configuration
    Source Package localization job

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

  7. Click Create.

    Each localization job has a unique number that appears both in the interface and in the name of the downloaded ZIP file. The number helps you ensure you are uploading the correct file to the correct job.

    Note:

    Localization job numbers are only guaranteed to be unique, not sequential. Non-consecutive numbers are normal and expected.

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 localization-job-number.zip, for example, localization-job-101.zip, is saved to your computer. The ZIP file contains these elements:
    source package content
    Where:
    • source-language-reference folder 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:

      Use files in this folder as the source for translation. However, never save the translation in this folder; always use a target language folder, like de-de, instead.

    • de-de folder contains DITA files associated with your map.

      Important:

      If this content hasn't been translated before, all files in this folder are in the source language. If this content has been translated before, files in this folder contain the existing translation to the German (de-de) language. Don't use files in this folder as the source for translation. Instead, use files from the source-language-reference folder.

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

  3. 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 Localize Source Package Content.

Localize Source Package Content

When localizing source package, it is important to understand how to use each folder the package contains. Make sure to follow these guidelines to ensure your translation uploads to the CCMS correctly.

  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 2. Zipped and unzipped source package files
    Zipped and unzipped source package files
  2. Open the unzipped source package folder and read the project-notes.txt file that contains an email address for the project manager and important project-related information.
  3. Navigate down the source-language-reference folder structure and use the DITA and media files in this folder as the source for translation.

    One way of using the source-language-reference folder is creating a copy of the entire folder, translating the copied files into a target language, then copying the translation over into the existing target language folder, like fr-ca or pl.

    Important:

    Don't save your translation in the source-language-reference folder. Instead, always save it in a respective target language folder, like fr-ca or pl. Also, you must save the localized files under their original file names and extensions.

    Remember:

    Don't modify any attributes or elements in the DITA files; only modify the content they contain.

  4. Save your translation in a respective target language folder, like fr-ca or pl.

    Feel free to overwrite files in the target language folder or remove them before saving your translation.

    Note:

    If this content hasn't been translated before, all files in target language folders, like fr-ca or pl are in the source language. If this content has been translated before, files in target language folders contain the existing translation to the target language.

  5. 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
  6. Send the localized ZIP file back to the project manager or upload it to Heretto CCMS.

Upload a 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. 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 Source Package for this localization job.
  3. Click Upload Source 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.

  4. In the Upload localization package window, verify that the locales you upload match the locales in Heretto CCMS and click Apply.
    Figure 3. Upload localization package Window
    upload response

    A notification Update was successful! appears.

  5. In the Localizations in Progress section, verify that all resources in your localization job show as Current. The number in green should say 100%.
  6. Optional: Under Localizations in Progress, click any locale to verify that all files associated with your map are loaded to Heretto CCMS.
    Figure 4. Localization Job Overview
    Localization Job Overview
  7. 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.

Your localized content is uploaded to Heretto CCMS. You can now publish the localized content.