Skip to main content

In-context translating on production

· 3 min read
Štěpán Granát

Image

Tolgee in-context feature is now available on any production page which is using our integration library! In-context translating brings following advantages:

  • Translations editing directly on your page
  • Creating and uploading screenshots with one click
  • Assurance that new translations fit into your layout before release

In this article, I will show you how it works and how to set it up.

What do you need

  1. Your web page which is using Tolgee (at least version 3.3.0)
  2. Chrome browser
  3. Access to Tolgee platform (or the API key)

Get Tolgee Chrome extension

Firstly, install Tolgee Tools Chrome extension. After installation, it should be visible in the extensions list. It's practical to pin it (with the pin symbol), so it's visible in the header bar.

Extensions list

Now, if you navigate to any website that is using Tolgee, it should change its color. If you click on it you should see the following dialog:

Tolgee Tools dialog

Possible issues

  • If Tolgee stays grey and you can't open the dialog, try refreshing the page
    • If it stays grey after the refresh, it means that the page is not using Tolgee SDK
  • If you use old version of Tolgee, upgrade Tolgee SDK to version 3.3.0 or newer
  • If the dialog opens but the input fields are disabled, it means that in-context is already turned on by default (this should happen only when you run Tolgee locally)

Obtain an API key

If you have an API key already you can skip this part.

  1. Log in to Tolgee platform
  2. Click Account settings in the user menu (right-top corner)

Api keys

  1. Pick an API key from a list (make sure it's for correct project):

Api key list

  • If the key is not created yet, create a new one by "+" button. Make sure, that correct project is selected, leave all permissions enabled and click Create.

Api key new

  1. Copy the API key

Provide the API key to Tolgee

  1. Navigate back to your website
  2. Open Tolgee Tools extension
  3. Fill the API key
    • If API url is empty, fill it with https://app.tolgee.io (unless you use self-hosted Tolgee platform)
  4. Click Apply
  5. You should see green message with the name of your project if your url and key are correct

Api key new

  1. Try opening Translation dialog by holding Alt/Option + clicking on any translation
  2. You should see "Quick translation" dialog

Quck translation dialog

Done!

Now you can use In-context to edit any translation on your website and the changes are sent directly to Tolgee platform.

Read more in In-context documentation

Context banner

Štěpán Granát
Štěpán is a passionate developer responsible for Frontend and SDK development at Tolgee. He's on a mission to make software localization as easy as pie while keeping it smart. 🧠