Crowdin In-Context works with the help of a one-line Javascript snippet and pseudo-language package. It creates a pseudo-language package based on the localization files uploaded to your project, which later will be integrated into your application as an additional localization language.
Integrated pseudo-language contains special identifiers instead of the original texts. Thus when switching your app to that language, all labels are converted to special identifiers. Javascript searches for those identifiers and replaces them with editable labels. So, the In-context page of your web app will look the same as your application, with the only difference that translatable strings will be editable.
Translations are made directly in the app, with no need to open the Editor. A simplified version of Crowdin Editor will be displayed, with all the functionality (TM, machine translation, approve/vote option, comments, terms) provided. Thus, it’s easier to make and review translations since translators can preview them in a real context.
There are two common approaches to integrate Crowdin In-Context with your application:
Staging or translation environment
If you are not planning to invite your end-users to help with translations or not considering using a “translation mode” in your production application, integrating Crowdin In-Context to your staging or dedicated translation app environment would be a good solution.
Production environment
Crowdin In-Context doesn’t require any code changes in your application so that you can use it even on production. You decide how to turn it on and which segment of users will use it. The most common use cases are the following:
Follow the integration setup guide in your Crowdin project to set up In-context. The guide can be found in the left-hand panel in your project, under Tools > In-Context.
After the integration is successfully set up and you have refreshed your application, you should see the invitation dialog and Crowdin login box.
You can add these parameters to the _jipt
array in the configuration snippet.
_jipt.push(['preload_texts', true]);
Speeds up dynamic content displaying within the In-Context tool by preloading all source strings. Automatically disabled for large projects (5000+ strings). Acceptable values: true, false.
_jipt.push(['touch_optimized', true]);
This option is enabled on touchscreens by default and makes the translation button next to each translatable string permanently visible instead of showing on hover. Acceptable values: true, false.
_jipt.push(['before_commit', function(source, translation, context, language_code) { return status_obj; }]);
Функция для проверки предложения перед коммитом.
Параметры | |
source | Исходный текст |
translation | Текст перевода |
context | Контекст исходной строки |
language_code | Код языка перевода (коды языка) |
Возвращаемые значения | |
status_obj | Объект. status_obj.status может быть "ок", "ошибка" или "исправлено". В случае ошибки, status_obj.message содержит описание ошибки. Когда статус «исправлен», status_obj.correction содержит исправленный перевод |
_jipt.push(['before_dom_insert', function(text, node, attribute) { return 'text'; }]);
Функция для преобразования строки перед ее подставлением в DOM.
Параметры | |
text | Строка для вставки |
node необязательный | DOM element in which the text must be inserted. It may be omitted if the text doesn't have a target element (text inside the browser's pop-ups) |
attribute необязательный | The attribute of DOM element, if the text is part of an attribute |
Возвращаемые значения | |
text | Строка для вставки |
false | Если функция возвращает false, то DOM не будет обновляться |
_jipt.push(['escape', function() { window.location.href = "http://app_domain.com"; }]);
If defined, users can close the In-Context overlay if they don’t want to translate. Реализуйте эту функцию на вашей стороне. Depending on the In-Context integration approach, it must change the app’s language or redirect from the translation environment to the production app.