CTSX DeepL Translator

Edition

Incubator (services)

Issues

Git

Git

Latest

3.4.6

Compatible with Magnolia 6.2.

The CTSX DeepL module performs translations using the DeepL APIs. Translations are handled synchronously.

Installing with Maven

Maven is the easiest way to install the module. Add the following to your bundle:

In order to start the DeepL translation process, please make sure that the core and apps modules in the Content Translation Extended have already been installed.
<dependency>
  <groupId>info.magnolia.translation</groupId>
  <artifactId>magnolia-content-translation-support-ext-deepl</artifactId>
  <version>3.4.6</version>
</dependency>

Configuration

Configuration of the DeepL service provider is handled in the module config. This provider can be configured with the following properties.

Please set the clientToken field to the "Authentication Key for DeepL API" from your DeepL account. "Authentication Key for DeepL API" can be found under "Account" → "Plan" page, when you login to DeepL.

Please use JCR for module configuration. When using yaml, translation provider definition will not be loaded and connector will be not usable.

Property Description

class

required

Definition class for the translator to be used.

See info.magnolia.translation.ext.provider.deepl.definition.DeepLProviderDefinition.

clientId

required

Unused but needs a value.

clientToken

required

token from DeepL account

configName

required

Identifies the configuration within Magnolia.

defaultFlag

optional

The default configuration used by the system in the case of multiple translation services being used.

enabledFlag

required

Enable or disable the configuration using this flag.

implementationClass

required

Implementation class for interfacing with DeepL.

See info.magnolia.translation.ext.provider.deepl.translator.DeepLTranslator.

Sample configuration

'config':
  'jcr:primaryType': 'mgnl:content'
  'Deepl':
    'autoTranslationAllowed': 'false'
    'class': 'info.magnolia.translation.ext.provider.deepl.definition.DeeplProviderDefinition'
    'clientId': 'xxx'
    'clientToken': 'xxxxxx-xxxxx-xxxx-xxxx-xxxx'
    'configName': 'DeepL.com'
    'enabledFlag': 'true'
    'implementationClass': 'info.magnolia.translation.ext.provider.deepl.translator.DeeplTranslator'

Usage

After registration and starting, The Content Translation Support Extended (CTSX) module will bind the DeepL translator to Configuration field.

You can test the connection to the translator api before using.

How it works

Use the same steps outlined with CTSX Google Translator but you will choose DeepL instead of Google.com in the Configuration.

Feedback