loco_translate

Loco Translate provides a normalised way to collect & gather internationalisation assets & translations into & from Loco.
Ensure an enhanced Developer Experience (DX) when dealing with translations & multilingual websites.

📖 Read the article 📖

You need Loco Translate if

• You want to use Loco as your Master Sass translation platform
• You want to push automatically a .po file from your Drupal instance to Loco,
• You want your Drupal environment to be updated automatically or manually from your Loco Sass,
• You want to use a module based on the Core Translation API,
• You want to deal with translation outside of Drupal UI,

Loco Translate can do a lot more than that, but those are some of the obvious uses of this module.

Features

• Offers a Dashboard to overview translations progress on Loco,
• Provide a utility script to push assets keys from Drupal to Loco,
• Expose a Drush command to pull assets & translations from Loco to Drupal,

Standard usage scenario

TBD

Versions

This module works on Drupal 8, Drupal 9, Drupal 10 & Drupal 11 !

The latest version should work with all Drupal 9/10/11 releases using Drush 10+,
and it is always recommended keeping Drupal core installations up to date.

Which version should I use?

Drupal Core Loco Translate 8.7.x 1.x 8.8.x 2.1 8.9.x 2.1 9.x 2.x 10.x 3.0.x 11.x 3.0.x

Dependencies

This module relies on Loco & the Loco PHP SDK.

• Loco PHP SDK is an external PHP library to communicate with the Loco API.

We assume, that you have installed loco/loco using Composer.

Supporting organizations

This project is sponsored by Antistatique. We are a Swiss Web Agency, Visit us at www.antistatique.net or Contact us.

Getting Started

We highly recommend you to install the module using composer.

composer require drupal/loco-translate

You can also install it using the drush or drupal console cli.

drush dl loco-translate
drupal module:install loco-translate

Configure your API Keys - as required by Loco - by adding the following code in your settings.php

/**
  * Loco Translate Export Key.
  *
  * @var string
*/
$config['loco_translate.settings']['api']['readonly_key'] = 'YOUR-KEY-HERE';

/**
  * Loco Translate Full Access Key.
  *
  * @var string
*/
$config['loco_translate.settings']['api']['fullaccess_key'] = 'YOUR-KEY-HERE';

Exposed Drush Commands

This module is shipped with drush commands to assist you in your workflow.

Push Command

The Push command will create new translations keys (a.k.a assets) into your Loco SaSS - from a reference .po files which should be in your Drupal or Local environmment:

drush loco:push --language="fr" ./translations/fr.po

Pull Command

The Pull command will fetch keys & translations from your Loco SaSS into Drupal:

drush loco:pull fr

Know issues

Getting the message 'Download error. Could not move downloaded file from Loco to destination translations://.'

Add the following code in your settings.php

/**
 * Translations file path.
 */
$config['locale.settings']['translation']['path'] = '/var/www/web/sites/default/files/translations';