Introduction
The Transifex app for Contentful offers versatile functionality, enabling users to seamlessly import and export content between Contentful and Transifex. It fully supports Text, RichText and Reference field types in your Entries and Assets. You can easily access and install the app directly from the Contentful marketplace.
š Note: The Transifex app can be installed on any Contentful environment apart from the master one.
Installing the Transifex app in your Contentful space
š Note: You'll need Project Maintainer or Administrator access to a Transifex project, where the source languageās locale is the same default locale you have in your Contentful space (learn more about how to configure Contentful locales here). The same applies to the projectās target languages.
To install the app:
Open Contentful
Navigate to Apps
Select Marketplace,
Choose Translation and Localization category
Find Transifex
Finally, click on the Install button.
Once it's installed:
Select your space and the corresponding environment.
Next, click on the Continue button.
You will be asked to authorize access for the Transifex app to your space to update your localized content and get information about the locales set up in your selected environment.
š Note: If you're experiencing difficulty connecting to Transifex, it's possible that the authorization popup is being blocked by certain browsers.
Now that the Transifex app is connected to Contentful, you will need to do the same for Transifex; click on the Connect with Transifex button.
If you are not already logged in, you will be asked to do so.
Then, you need to select the Transifex project that you want your localized content to reside in.
Once you click on the Allow button and you should see the following successful message:
Now itās time to go back to your contentful space and continue the installation process. You will see an updated summary of the selections you made in the previous steps.
If you want to change the connected Transifex project later, you can click on the āReset selected projectā button and follow the steps described above once again.
Finally, customize the integration settings to match your specific requirements and complete the installation process. Additional information regarding configuration options can be found in the following section.
Configuring your Transifex App
You can configure the app using the options that are described below.
Content Synchronization Options
If the option is unchecked, any translations found on Contentful are ignored and never sent to Transifex.
If the option is checked, then every time content is synced from Contentful to Transifex, the app checks each Entry (resource in Transifex) / language separately, and performs the following actions:
If the language for this Entry (resource in Transifex) is empty (meaning there are zero translations in Transifex), we retrieve the translated content from Contentful and send it to Transifex.
On the contrary, if there is at least one translation in Transifex for this Entry (resource in Transifex) /language, we consider Transifex as the source of truth. Consequently, we disregard the Contentful translations for that Entry/language and refrain from sending them to Transifex.
ā
This includes content detected during the integration setup or new content detected on a subsequent sync.
Any syncing actions on content with a resource in Transifex will not include translations updated on Contentful.
ā
Specifically, if any translations are present in Transifex's resources, Transifex is considered the source of truth, and any translations in Contentful will be ignored. A relevant warning should be displayed for the specific task in the activity logs.
Pull Content Options
Automatically syncing localized content back to Contentful can be configured per Entry in each target language. The app provides three options for automating the process of sending localized content back to Contentful:
100% translated or updated (for 100% translated)
100% reviewed or updated (for 100% reviewed)
100% proofread or updated (for 100% proofread)
Based on the chosen setting, this will be applied to individual Entries as they are localized in each target language. For example, once an Entry is fully translated into French, the French entry will be sent to Contentful. If the Chinese translation of the article is not fully translated, it will not be sent to Contentful.
All the sync options are triggered when the language reaches 100%. This means that if, for example, an already reviewed language is edited, the updated reviewed translation will be sent to Contentful automatically.
Assign plugin to content types
You have the flexibility to select one or more content types for the Transifex app to show up in the sidebar. If no content types are defined at the moment, you can skip this and continue with the installation; however, it's important to note that you should later choose the Transifex app to be displayed in the sidebar for any content type you create following the steps below:
Select āContent modelā from the top menu.
Click on a content type.
Select āSidebarā from the left menu.
Pick the Transifex app from the available items to appear in the sidebar.
ā ļøWarning: To change the selected content types later on, you will need to uninstall and install the app again.
Revisit Configuration
You can update the configuration at any time;
Go to Apps ā Installed apps
Click on the three dots next to the Transifex app and select Configure.
To enable the appās sidebar widget to more content types, you will need to uninstall and install the app again (see also "Uninstall the Transifex app from your Contentful space" section below).
š Note: Only one Transifex project can be connected to a Contentful space. If you would like part of your content to be translated into another Transifex project, then you need to move this content to another Contentful space.
Synchronizing your content with Transifex
Once you have installed the Transifex app in your Contentful space, you can start using the Transifex sidebar in Contentfulās Entry editor.
When you click on the āImport to Transifexā button, the respective Entry will be created as a resource in the Transifex project you have configured during the installation.
Upon successful transfer, you will see that the Entry is now linked.
š Note: If you remove the Transifex sidebar widget via the content typeās settings, the respective Entry will still remain linked, and the localized content will still be updated automatically, as initially configured. So, before you remove the Transifex sidebar widget, we recommend unlinking the Entry first (click on the āUnlinkā button).
For any updates done on the source content of the Entry, you can send these updates to Transifex so that your localization team can start working on those as well. To do that, you need to click on the āUpdateā button.
š Note:
All content can be transferred in Transifex if the respective Entry contains localizable fields. If all fields of an Entry are non-localizable, no resources will be created/updated in Transifex.
If an Entry contains References and Assets and is sent to Transifex for translation, the respective References and Assets will be sent as well.
You can see the translation progress in all target languages for this specific Entry at all times; just hit the Refresh button in your browser.
To have a better overview of all your linked Entries and a more detailed activity log of every action made in both directions, Contentful to Transifex and Transifex to Contentful, you can follow the link āOpen integration appā. You can find more information about the standalone integration app here.
If you want to see all translations for this Entry directly from Transifexās Editor to leave comments or open issues, assign tags to source strings, etc., follow the link āOpen Entry in Transifex Editorā. This will load the Editor where the respective resource and the first target language will be pre-selected, and all you have to do is select another target language if needed.
Uninstalling the Transifex app from your Contentful space
To uninstall the app:
Open Contentful
Navigate to Apps
Select āInstalled appsā from the left menu
Find Transifex
Click on the three dots next to it
Select āUninstallā
When you uninstall the app, all Entries are unlinked, and any tokens created by the app during the installation are revoked. You will also no longer be able to access the standalone integration app, but your Transifex access remains intact. The same applies to all source and localized content transferred to and from Transifex.
š Note: When you uninstall the app, all content previously synced with Transifex will remain in Transifex. If you wish to remove synced content, please follow the provided instructions here.