Skip to main content

Translate content and set up a language switcher in Turtl Docs

Allow your readers to switch between languages on your Turtl Docs

Updated over 2 weeks ago

Note: The language switcher feature is only available with our Grow and Scale plans.

Turtl enables you to add a switch with a globe icon to your Turtl Doc, which enables users to access a version of a Turtl Doc in a different language.

This article explains:



How to translate a Turtl Doc

There are two different ways to translate your Turtl Doc: you can either use Hatch AI to automatically translate the content, or by uploading the content that has been translated in advance using bookmarklets. Both options are outlined below:

1. Translating a Turtl Doc Using Hatch AI

In the editor, click the Hatch AI button at the top of the content editor.

Now select “Translate” from the options provided.

Choose your language from any of our supported languages, and where you want to apply the translation. You can also provide the AI with other written instructions by clicking "Any translation rules I need to know about?". A good example might be to never translate specific brand words.

When you’re ready, click "Translate" and wait for the translation to be completed.

Pre-defining translation rules

You can also choose to pre-define translation rules for the AI at both a Doc level and a Team level. Doing so will pre-fill the translation rules in the editor when using the Turtl Editor AI features (but they can still be overridden).

Admins can set translation rules at a Team level. To do so, go to the Team dropdown and click on settings, then go to the "Hatch AI" tab.

On a Doc level, go to the Doc settings > Hatch AI tab and write your translation rules in the appropriate section.

2. Manually Translating a Turtl Doc Using Bookmarklets

Step 1: Copy your Master Doc

​​​Choose a Turtl Doc you would like to translate. Make a copy of the Doc and open the editor of that Doc.

Step 2: Set your Turtl Doc up for translations

Make sure you adjust the Doc (feature boxes, etc.) in a way that leaves enough space in case the translated content will be lengthier (give ⅓ of extra space), e.g:

Step 3: Set up bookmarklets

Please copy both of these bookmarklets and save them to your bookmark manager in your Chrome browser.

Start by opening your Bookmark Manager.

Somewhere within the Bookmark Manager background, right-click to add a new bookmark.

Give your bookmark a name and paste the relevant code from below into the URL, then click "Save".

Depending on your translation software, you can use either the JSON or SDLXML format.

JSON format

Download JSON file:

javascript:(function(){document.body.appendChild(document.createElement('script')).src=window.location.origin + '/bookmarklets/translation-export.js';})();

Upload translated JSON file:

javascript:(function(){ document.body.appendChild(document.createElement('script')).src=window.location.origin + '/bookmarklets/translation-import.js'; })();

SDLXML format

Download SDLXML file:

javascript:(function(){document.body.appendChild(document.createElement('script')).src=window.location.origin + '/bookmarklets/translate-sdlxml-export.js';})();

Upload translated SDLXML file:

javascript:(function(){document.body.appendChild(document.createElement('script')).src=window.location.origin + '/bookmarklets/translate-sdlxml-import.js';})();

Step 4: Using the bookmarklets

  1. Open the Turtl Doc you wish to translate and click on either the "Download JSON file" or "Download SDLXML file" bookmark.

This will download the JSON / SDLXML file to your device.

2. Have your translation team add the translated text directly into the file, replacing the original text.

3. When the translation is ready, open the same Turtl Doc in editor mode and click on "Upload translated JSON file" or "Upload translated SDLXML file". This will open your file manager. Select the translated JSON / SDLXML file and hit "Open". The translation will be applied to your Doc.


​4. Check the layout and update the name of the Doc.

5. Set up language settings on the Doc.

6. Publish and share.

You can finish there, or depending on how you distribute the Docs, you can set up a language switcher so that users can switch to their respective language. Please note that the following feature is available on the Unlimited plan.


How to set up a language switcher

Step 1:

Make sure your translated Docs are completed and ready to be published (translated content and assets are required ahead of time).

Step 2:

Ensure your translated Docs are all in the same workspace in Turtl - the globe functionality can only link Docs that are located within the same workspace.

Step 3:

Make sure you set up the language on your Docs accordingly.

Step 4:

Navigate to the "Extensions" tab within the Doc Settings. If you don’t already have the "Language Group" extension on your tenant, please contact your Customer Success Manager or get in touch with Support at support@turtl.co, and we can get this extension added to your account.

Step 5:

Enable the "Language group" extension on all of the Turtl Docs that you would like to be linked and prepared for language switching.

Step 6:

Ensure all of the Docs that have the "Language Group" extension enabled are published before sharing any of the links

After completing the steps, you should be able to easily change the language of your Doc using the globe icon.

Did this answer your question?