Zendesk Connector (Guide & Support)

Localize Images with the Zendesk Connector

In addition to translating your text content, you may want to display different images on your translated sites. For example, if you mark up a screenshot with textual information, the translated version of that content should have its own image. Even if they are just product screenshots, the reader should see the screenshot in their language to insure the best understanding.

Smartling provides a feature to help you automate the process of using localized images in your localized content. This feature is applied by the Smartling Zendesk Connector and is not a feature of the Zendesk platform. It uses a common image file naming convention to manage localized versions of what are essentially the same image.

How it Works

If you want an image to be localized, update the file name of the source language version of the image to have the source language locale ID in its name.

When Smartling detects that the source content has images with this convention, it will look for a version of the image file with the target locale ID and if found it will use that image in the localized version of the article that is published to Zendesk.

If an image doesn’t use the naming convention or if a specific target language doesn’t have a corresponding localized version, then the source image will be exported back to Zendesk for that specific target language.

The Zendesk Connector will rewrite links to images when exporting translated images to Zendesk.

Important Considerations 

It’s important to use this feature if you want localized images because it is not recommended that you make any edits to the localized content in Zendesk when Smartling is being used to translate the content. Any changes made to the localized content directly in Zendesk may be lost when Smartling updates the localized content.

Updates can be triggered automatically or manually depending on your configuration. Smartling will always overwrite the localized content no matter what its state is. Using this feature and convention will save you the trouble of needing to manually assign localized images and make sure they will always be used no matter what updates are made to the content translations in Smartling.

Localized images will have the same re-sizing applied as your source image, so for best results, your localized images should have the same original dimensions as your source image.

This convention uses the Zendesk locale codes in the image file names, not the Smartling locale code. For example the Zendesk locale code for German is de, for localized German images use de in the file name. If you are using French (France) the locale code is fr-FR.

Step-by-Step Guide

  1. For the image that shows the original source language (your primary language), update the image file name to include the source language’s Zendesk locale code in the name.
    • For example, if your file is LocalizedImage.png, and your source language is English (United States), rename the file LocalizedImage_en-us.png.
    • You must use this convention on the file you upload to Zendesk and your link to it in the article.
  2. Insert the image into your Zendesk article, position and resize it as you like.
  3. Rename your localized images to have the same name as your source image, but with the appropriate locale code. For example, LocalizedImage_fr-fr.png and LocalizedImage_de-de.png.
  4. In the Zendesk Editor, click Insert Image.
  5. Upload each of your localized images, but do not click Insert.
  6. Click Close when all your images are uploaded.
    • Make sure to save/update the article in the source language so that your file uploads will be saved and associated with the article. They will be listed as “unused” images. 
      Zendesk does not display image names, only thumbnails. So check that you have named your files correctly before uploading.
  7. Translate your Zendesk article as normal.

Once your translated articles are published, they should display on your translated sites in the same position and at the same size as the source image.


Was this article helpful?