This article provides best practices for teams that are responsible for creating and managing guides that will be displayed in multiple languages. Your organization may have an internal checklist that is used whenever a new guide is created and published. If you are using Pendo’s localization feature, we recommend adding some localization-specific items to that checklist. This helps to avoid errors and reduces the amount of time needed to localize each guide. If you are new to localization and need a comprehensive overview of Pendo’s localization functionality, see this Localization article for more information.
Before starting the localization process, create a clear plan of action. Identify the languages you want to support and determine the scope of the localization effort. Is this language already set up in the Pendo subscription and you just need to create new translations for specific guides, or do you also need to set up the language as a supported language for the subscription?
Tip: We highly recommend finalizing the content of your guide before you start the localization process.
The target language code in the XLIFF file needs to match the language preference metadata value for the intended language. To adjust this, navigate to Settings > Subscription Settings > Applications, select your application, App, and then select Localization settings.
All <target> fields in an XLIFF file must have a value, even if you are copying the same information from the <source> field.
<trans-unit id="ID string">
<source> Hello </source>
<target> Bonjour </target>
<note> TextView </note>
Although there are multiple tools available for content translation and localization, some tools can potentially cause XLIFF files to be incompatible when uploading to Pendo. Although Pendo doesn't recommend any particular translation tool or service, or provide translation for Guide content, we have seen many customers successfully use Crowdin, Xliff Editor, and Smartling.
If an already translated guide is cloned, the new copy of the guide needs to be translated again in Pendo. Unfortunately, the XLIFF file from the original guide won’t be compatible with the new copy of the guide. You must export the XLIFF file from the new copy of the guide for translation.
Video links that use non-Unicode characters need to be wrapped within a CDATA tag in the <target> field to display correctly.
<trans-unit id="ID string">
<note> interst.io.VideoPlayerView </note>
If the guide uses either Custom code blocks or the Guide badge icon (if set to custom text), these sections of the guide are not translated and appear in the default language. The other portions of the guide are translated.
Preview your guide
You can preview your guide to see how it looks with a different language using the imported XLIFF file. Select the required language from the Viewing dropdown within the guide settings.
Alternatively, you can also select Preview and then select a language from the dropdown.
Audit your XLIFF file
If you make additional content edits to a guide after you’ve already uploaded an XLIFF file, you must upload a new file. Modifying a guide can change the IDs within the XLIFF file so that the original imported translation file no longer aligns and causes an error. This also applies to new modules created in the Resource Center. You must upload a new translation file for the Resource Center if you add or remove modules.