Localization

Overview

Companies expanding into global markets or supporting a multilingual user base need to publish content in multiple languages. Localization makes it easy to deliver in-app messages in a variety of languages. Guides and the Resource Center can be written in your preferred language, content is then exported as an XLIFF file (the standard format for translation data), translated outside of Pendo, and then imported back into Pendo. Pendo uses the language metadata you pass through in the installation snippet or browser metadata to display the appropriate language to your user. This feature is available for both web and native mobile Guides (v2).

Localization App and Guide Setup - Runtime: 5:09

 

 

Requirements

  • Pendo Admin users can access and manage your Localization settings in Subscription Settings
  • Pendo Users with Create Guides from layouts or from scratch can edit translations
  • Agent Version 2.15.15 or greater. Localization leverages the Visual Design Studio, this is the minimum version required for this feature.

 

Setup Localization Settings

Localization Settings are app specific and can be enabled for individual apps in a multi app subscription. Go to Subscription Settings in the Settings menu and select your app.

LocSet1.png

 

Enable Localization in the Localization Settings tab. This shows the Localization Settings that are applied to all Guides in that app.

LocSet2.png

 

Language Preference Metadata

Pendo determines which language to serve visitors based on the Visitor’s local metadata. Use the default language metadata that Pendo collects from the Visitor's browser or setup a custom language metadata value in the Install Snippet and Data Mappings settings. The metadata field name and values of that metadata are up to you.

Select the language metadata value in the drop down menu.

Note: Pendo highly recommends that you use your own values for analytics accuracy but a visitor’s browser language metadata can be used if you don’t have another option.

 

Supported Guide Languages

1. Click on + Language to add all the languages you will need for Guide translations.

_Language.png

2. Select the language from the drop down menu. The list shows all available languages and the default metadata value collected by the browser for that language.

3. Change the metadata to match your custom language metadata value if necessary.

4. Click Add to save the new language. Repeat this process until you have added all of your languages.

 AddLanguage.png

 

Supported Languages shows a list of all added languages. Hover over a language to show the Edit and Delete buttons.

AllLanguage.png

 

Missing Translation Language Behavior

Missing Translation Language Behavior controls if a visitor sees a Guide in the default language when their translated language is not available for that Guide. This could be because that language has not yet been translated or is not set up in your Pendo subscription.

Note: This is an important setting that will prevent a user from seeing a Guide if they have a language setting that doesn’t match any of your preferences.
For example, a user may set their preferred language to Korean in their browser even though they can read English. This user would not see any Guides unless they were translated into Korean. 

MissingLanguage.png

Toggle On to display Guides using the default language, indicated in Supported Languages.

Toggle Off to hide Guides if the available translated languages do not match the visitor's language metadata. 

Note: This setting also applies to the guides in the Resource Center.

 

Translate Your Guide

Translate a Guide by exporting the XLIFF file, adding the translation into the file, and importing the translated file back into the Guide's Localization Details. The XLIFF formats translations for any text entered into a Building Block with the exception of unstructured text in images and code blocks. The alt text and URL used for images is available for translation in the XLIFF.

For example, text in a Text Block and button text are captured in the XLIFF but text in an uploaded image is not. If you have a translated version of the image hosted, you can replace the image URL in the XLIFF file so the Guide loads your translated image instead of the image added to the original Guide.

Always start with a completed Guide that has the final version of all text. The translation file will not update if you edit your Guide content in Visual Design Studio after exporting your XLIFF file. You'll need to repeat the export, translate, import process if you make content changes.

 

Localization is accessed from the Guide Details page of the Guide you're translating.

1. Find the Localization tile in Guide Details.

2. Click Edit to manage Localization for this Guide.

LocalizationTile.png

 

3. Click Export to download the XLIFF file for your Guide so it can be translated.

This file contains your Guide content as strings that can be translated into your desired languages. If it is a multi-step guide, strings from each step is included in the same file.

LocalizationEdit.png

 

Authored Language is used to change the source language in the XLIFF file. It is typically US English but can be changed to any of the languages setup in Localization Settings. Edit the Authored Language if it does not match the language the Guide was written in.

Tip: Companies who translate their apps and app content usually have a Translation Department or service who perform the text translation. This department uses dedicated translation tools to assist with the process, like Smartling or Xliff Editor. Pendo doesn't recommend any particular translation tools, translation services, or provide translation for Guide content.

 

Working With XLIFF Code

XLIFF is the industry standard file format for content translation and localization. It identifies the specific UI elements and text contents, the original and translated languages, and the original and translated content. The XLIFF file exported from Pendo provides the code for all translatable content in the entire Guide. Each object is organized by <trans-unit> in the code. The file exported from Pendo is ready for translation and does not have a target language or any target content. If you need to translate into multiple languages, each language requires its own XLIFF file. A single file will not support translation into more than one target language.

A trans-unit is an individual block of text in the code. You may have multiple trans-units in a single Guide step. It's important that each trans-unit is translated individually. Translating multiple blocks of text in a single trans-unit is unsupported. You can edit the translated phrasing in the XLIFF file for the target language to improve readability and formatting in the rendered version of the translated Guide if needed.

  • source-language-"en-US" - Language code for the source content
  • target-language=" " - Language code the text is being translated into
  • <source></source> - Source content from the Guide written in the source language
  • <target></target> - The container where the translated text is entered for each <trans-unit>  

Example

<xliff...>
<file... source-language="en-US" target-language="fr-FR">
...
<trans-unit id="ID String">
<source>Hello</source>
<target>Bonjour</target>
<note>TextView</note>
</trans-unit>
...
</file>
</xliff>

 

Pendo XLIFF Code Sample

<xliff version="1.2" xmlns="urn:oasis:names:tc:xliff:document:1.2">
<file original="ID STRING" datatype="pendoguide"
source-language="en-US" target-language="TRANSLATED LANGUAGE CODE">
<body>
<group id="ID STRING">
<note></note>
<trans-unit id="ID STRING">
<source>How likely are you to recommend us to a friend or coworker?</source>
<target>TRANSLATED LANGUAGE TEXT</target>
<note>TextView</note>
</trans-unit>
...
</group>
</body>
</file>
</xliff>

 

Import the Translation

To activate the translated version of a Guide, import the translated XLIFF file for the translated language into the Localization tile.

1. Click Edit to manage Localization for this Guide.

LocalizationTile.png

 

2. Click Import next to the Untranslated Language to upload the translated XLIFF file. The Untranslated Language should be the same as the target language in the file.

Import.png

 

When the import is complete, the language moves from Untranslated to Translated. The Import button will still be available to update the Translated Language later.

 

3. Click Done to close the Edit view of the Localization Tile.

Warning: The XLIFF file must match to the corresponding Guide. If the content of the XLIFF file does not match the Guide, the import will fail. The upload validates that all target containers have translated content. If some target containers are empty, a notification informs you that some content may be missing but the file is still imported.

 

Test and Preview Your Translated Guides

Use the Viewing language dropdown at the top of the Guide Settings to preview your Guide in your translated language.

SpanishGuide.png

 

You can make changes to the XLIFF file and reimport as many times as you need. 

Publish the Guide when you're satisfied with the translated version. If the Guide is already public, the translation is available as soon as the import is complete.

 

Translate the Resource Center

The process for translating the Resource Center is the same as translating Guides. The Localization tile for the Resource Center is in the Resource Center Details page in the Guides section. The resource center localization includes translations for the Resource Center name, module title and sub-titles, and for any guide names included in the resource center. The guides' content is translated in the context of the guide itself. 

If any guide name is missing from the translation file, the Missing Translation Language Behavior setting (see above) takes effect. 

 

 

RCNav.png

RClocalization.png

 

Available Translations in the Resource Center XLIFF File

  • All Module Titles
  • All Module Subtitles
  • Guide Name, Keywords, Search Bar, and Search Results text in Guide List Modules
  • Guide Name and Step Counter in Onboarding Modules

Announcements and Guide content, other than the name, is translated using Localization settings for the specific Guide.

Note: The content of a Sandbox Module cannot be translated with Localization. The Localization tool cannot pull text out of custom code. To deliver translated content in a Sandbox Module, review the code and translate the content of the existing Sandbox Module, create a new Sandbox Module with the translated content, and use segmentation and language metadata to display the appropriate Sandbox Module.

 

Frequently Asked Questions

How will turning on Localization effect my Classic Designer Guides?

Guides created in the Classic Designer cannot be localized. The Missing Translation Language Behavior setting does not block Classic Designer Guides. Users will still see Classic Designer Guides even if the setting is set to hide them if the users’s language has not been translated.

 

What language file type is supported?

XLIFF 1.2 format only.

 

Which Languages are Supported?

  • Afrikaans (af)
  • Amharic (am)
  • Bulgarian (bg)
  • Catalan (ca)
  • Chinese(zh)
  • Chinese - Hong Kong (zh-HK)
  • Chinese - PRC (zh-CN)
  • Chinese - Taiwan (zh-TW)
  • Croatian (hr)
  • Czech (cs)
  • Danish (da)
  • Dutch (nl)
  • Dutch - Belgium (nl-BE) 
  • English (en)
  • English - Australia (en-AU)
  • English - Canada (en-CA)
  • English - Ireland (en-IE)
  • English - New Zealand (en-NZ)
  • English - UK (en-GB)
  • English (US) (en-US)
  • Estonian (et)
  • Filipino (fil)
  • Finnish (fi)
  • French (fr)
  • French - Belgium (fr-BE)
  • French - Canada (fr-CA)
  • French - France (fr-FR)
  • German (de)
  • German - Austria (de-AT)
  • German - Switzerland (de-CH)
  • Greek (el)
  • Hindi (hi)
  • Hungarian (hu)
  • Indonesian (id)
  • Italian (it)
  • Japanese (ja)
  • Korean (ko)
  • Latvian (lv)
  • Lithuanian (lt)
  • Malay (ms)
  • Norwegian (no)
  • Polish (pl)
  • Portuguese (pt)
  • Portuguese - Brazil (pt-BR)
  • Portuguese - Portugal (pt-PT)
  • Romanian (ro)
  • Russian (ru)
  • Serbian (sr)
  • Slovak (sk)
  • Slovenian (sl)
  • Spanish (es)
  • Spanish - Chile (es-CL)
  • Spanish - Latin America (es-419)
  • Spanish - Mexico (es-MX)
  • Spanish - Spain (es-ES)
  • Swahili (sw)
  • Swedish (sv)
  • Thai (th)
  • Turkish (tr)
  • Ukrainian (uk)
  • Vietnamese (vi)
  • Zulu (zu)

Note: Right-to-left languages (e.g., Hebrew and Arabic) are not supported yet.

 

Is this supported for Mobile Guides as well?

Native mobile Guides can be translated just like web Guides by any customer using the mobile V2 SDKs.

The mobile SDKs send the device language in the "language" metadata field, just like the web agent. You can also setup localization to use any alternative user metadata field for the device language in the Application Settings.

 

Does Pendo translate the Guides for me?

No. We provide you with an XLIFF file that you can translate.

 

Can I localize an NPS Guide?

Yes. NPS is a type of Pendo Guide and has a Localization tile on the Guide Details Page if Localization is enabled. Once you translate your NPS survey, responders will see it in their native language. NPS emails are not translated.

If you don’t see the Localization option, you might have an older NPS poll that needs to be upgraded. Learn about upgrading your NPS Guide.

 

Can I analyze Guides according to Language?

Yes. Navigate to your Guide and choose Guide Metrics. Using the filter, you can select the language dropdown option and choose a different language.

language-filter.png