Help

Installation #

Translatable Descriptions does NOT automatically translate content for you. #

You will need to translate the content yourself.

Either through your own translation abilities or a translation tool such as Google Translation

How do I install Translate Descriptions? #

To install Translatable Product and Category Descriptions you can Click here to visit the app installation page and follow the on screen instructions.

Install page

Once installed a Translatable Product and Category Descriptions tab will be added to your Store's Control Panel Settings area:

Install page

Settings #

Default Language #

When multiple language blocks are found in a description but the visiting customers language does not match any of them this setting will determine which language block is shown to them.

The default is English.

An example would be if your description has Spanish and Russian language blocks but the customer is an English speaker. If this setting is not set to Spanish or Russian they will NOT see either block and could possibly see a Blank page.

Language blocks #

Usage #

Language blocks also known as Shortcodes are used to show language specific content to your store visitors.

To use a language block you simply add the following to a Product or Category description:

[lang="LOCALE_CODE"]Your description here[/lang]

LOCALE_CODE is the code of the necessary language, for example en, es, fr, de.

A list of available codes can be found here: List of ISO 639-1 codes

Make sure to use the 2 letter "639-1" code.

Rules #

  • You can use as many language blocks as you need.
  • You cannot put language blocks inside of each other.
  • Any content not inside a language block will be shown all visitors.
  • Language blocks can include html or any other type of description markup.

Examples #

  • 3 Language blocks:

    [lang="en"]English[/lang] [lang="es"]Español[/lang] [lang="ru"]русский[/lang]

    In this example, English visitors will only see "English", Spanish will only see "Español" and Russian visitors will only see "русский". A visitor who spoke something else, for example German would see nothing. To show those visitors content make sure to set a Default Language and have that Language Block available.

  • 2 Language blocks with content outside that will be visible to all visitors.

    Everyone will see this! [lang="es"]Only Spanish language visitors will see this![/lang] [lang="ru"]Only Russian language visitors will see this![/lang]

    In this example all visitors will see "Everyone will see this!". But Spanish or Russian visitors will see the extra content contained within their Language Block.

  • Language blocks don't have to be on a single line:

    Only Spanish speaking visitors will see the image below [lang="es"]

    [/lang]

Where do I put them? (Language blocks) #

Language blocks are placed inside a Product or Category description.

  • Product description:

    Product page
  • Category description:

    Category page

Features #

Forcing / Selecting Language #

By adding

?lang=LOCALE_CODE
to your Store's URL you can override the visitors language and force a language to be shown.

This can be useful if you would like to allow visitors the ability to choose a language to be displayed.

Here are a few examples using our demo store:

Force English: ?lang=en

Force Spanish: ?lang=es

Force Russian: ?lang=ru

An extremely simple "Language Selector" for your store could be the following:

<p>Choose your langauge: <a href="?lang=en">English</a> / <a href="?lang=es">Spanish</a> / <a href="?lang=ru">Russian</a></p>

Choose your langauge: English / Spanish / Russian


Advanced

If you would like to change the language with Javascript you can use the following:

translatableDescriptions.setLanguage('LOCALE_CODE');

Troubleshooting #

Language Blocks not displaying correctly? #

You want to make sure that your description HTML isn't being decoded. This can break the app and cause language blocks to appear broken.

To fix this, edit your description in HTML mode. The image below shows a product page with an arrow pointing at the HTML mode button.

Product page with an arrow pointing at the HTML mode button

Once in HTML mode you will see the "source code" of the products description. This is the raw HTML that is displayed and editing in this mode will stop HTML from being automatically decoded.

You will know if your HTML was decoded if you see a lot of the following mixed in your description:

Here's what the above would look like in your final description:

<
>
<div>
</div>
<p>
</p>

Below is an image of a description that has been decoded and would not be displayed correctly

HTML decoded product description

Contact #

How do I contact Translate Descriptions? #

If you need help or have a problem please email us at [email protected]