Page tree
Skip to end of metadata
Go to start of metadata

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

Installation

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

<dependency>
    <groupId>info.magnolia.translation</groupId>
    <artifactId>magnolia-content-translation-support-ext-deepl</artifactId>
    <version>${CTSExtendedVersion}</version>
</dependency>

Versions

3.4Magnolia 6.2.8 


In order to start the DeepL translation process, please make sure that the core and apps modules which mentioned in Content Translation Extended have already been installed.

Configuration

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

class

required

Definition class for the translator to be used.

See info.magnolia.translation.ext.provider.deepl.definition.DeeplProviderDefinition
configName

required

The display name of the configuration in 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 translator API.

See info.magnolia.translation.ext.atls.translator.DeepLTranslator

clientId

required

not used, but needs a value

clientToken

required

token from DeepL account

Please set 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.


Sample config:

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