README

Automatic Translations for Neos via DeeplApi

Documents and contents are translated automatically once editors choose to "create and copy" a version in another language. The included DeeplService can be used for other purposes as well.

The development was a collaboration of Sitegeist and Code Q.

Authors & Sponsors

Martin Ficzel - ficzel@sitegeist.de
Felix Gradinaru - fg@codeq.at

The development and the public releases of this package are generously sponsored by our employers http://www.sitegeist.de and http://www.codeq.at.

Installation

Sitegeist.LostInTranslation is available via Packagist. Run composer require sitegeist/lostintranslation.

We use semantic versioning so every breaking change will increase the major version number.

How it works

By default, all inline editable properties are translated using DeepL (see setting translateInlineEditables). To include other string properties in the automatic translation, the options.automaticTranslation: true can be used in the property configuration. Also, you can disable automatic translation in general for certain node types by setting options.automaticTranslation: false.

Some very common fields from Neos.Neos:Document are already configured to do so by default.

'Neos.Neos:Document':
  options:
      automaticTranslation: true
  properties:
    title:
      options:
        automaticTranslation: true
    titleOverride:
      options:
        automaticTranslation: true
    metaDescription:
      options:
        automaticTranslation: true
    metaKeywords:
      options:
        automaticTranslation: true

Also, automatic translation for all types derived from Neos.Neos:Node is enabled by default:

'Neos.Neos:Node':
  options:
      automaticTranslation: true

Configuration

This package needs an authenticationKey for the DeepL API from https://www.deepl.com/pro-api. There are free plans that support a limited number, but for productive use we recommend using a paid plan.

Sitegeist:
  LostInTranslation:
    DeepLApi:
      authenticationKey: '.........................'

The translation of nodes is configured via settings:

Sitegeist:
  LostInTranslation:
    nodeTranslation:
      #
      # Enable the automatic translations of nodes while they are adopted to another dimension
      #
      enabled: true

      #
      # Translate all inline editable fields without further configuration.
      #
      # If this is disabled, inline editables can be configured for translation by setting
      # `options.translateOnAdoption: true` for each property separately
      #
      translateInlineEditables: true

      #
      # The name of the language dimension. Usually needs no modification
      #
      languageDimensionName: 'language'

If a preset of the language dimension uses a locale identifier that is not compatible with DeepL, the deeplLanguage can be configured explicitly for this preset via options.deeplLanguage.

Neos:
  ContentRepository:
    contentDimensions:
      'language':

        #
        # The `defaultPreset` marks the source for all translations with mode `sync`
        #
        label: 'Language'
        default: 'en'
        defaultPreset: 'en'

        presets:

          #
          # English has to be configured differently for source and target as DeepL requires so,
          # the source and target are separated by a `:`
          #
          'en':
            label: 'English'
            values: ['en']
            uriSegment: 'en'
            options:
              deeplLanguage: 'EN:EN-GB'

          #
          # Danish uses a different locale identifier than DeepL, so the `deeplLanguage` has to be configured explicitly
          #
          'dk':
            label: 'Dansk'
            values: ['dk']
            uriSegment: 'dk'
            options:
              deeplLanguage: 'DA'

          #
          # For German, the dimension value de is used in uppercase
          #
          'de':
            label: 'Deutsch'
            values: ['de']
            uriSegment: 'de'

          #
          # The Bavarian language is not supported by DeepL and is disabled
          #
          'de_bar':
            label: 'Bayrisch'
            values: ['de_bar','de']
            uriSegment: 'de_bar'
            options:
              deeplLanguage: false

Ignoring Terms

You can define terms that should be ignored by DeepL in the configuration. The terms are evaluated case-insensitively when searching for them, however they will always be replaced with their actual occurrence.

This is how an example configuration could look like:

Sitegeist:
  LostInTranslation:
    DeepLApi:
      ignoredTerms:
        - 'Sitegeist'
        - 'Neos.io'
        - 'Hamburg'

Eel Helper

The package also provides two Eel helpers to translate texts in Fusion.

⚠️ Every one of these Eel helpers makes an individual request to DeepL. Thus, having many of them on one page can significantly slow down the performance if the page is uncached. :bulb: Only use while the translation cache is enabled!

To translate a single text you can use:

# ${Sitegeist.LostInTranslation.translate(string textToBeTranslated, string targetLanguage, string|null sourceLanguage = null): string}
${Sitegeist.LostInTranslation.translate('Hello world!', 'de', 'en')}
# Output: Hallo Welt!

To translate an array of texts you can use:

# ${Sitegeist.LostInTranslation.translate(array textsToBeTranslated, string targetLanguage, string|null sourceLanguage = null): array}
${Sitegeist.LostInTranslation.translate(['Hello world!', 'My name is...'], 'de', 'en')}
# Output: ['Hallo Welt!', 'Mein Name ist...']

Translation Cache

The plugin includes a translation cache for the DeepL API that stores the individual text parts and their translated results for up to one week. By default, the cache is enabled. To disable the cache, you need to set the following setting:

Sitegeist:
  LostInTranslation:
    DeepLApi:
      enableCache: false

Performance

For every translated node, a single request is made to the DeepL API. This can lead to significant delay when documents with lots of nodes are translated. It is likely that future versions will improve this.

Contribution

We will gladly accept contributions. Please send us pull requests.

Changelog

2.0.0

The preset option translationStrategy was introduced. There are now two auto-translation strategies:
- Strategy once will auto-translate the node once "on adoption", i.e. the editor switches to a different language dimension
- Strategy sync will auto-translate and sync the node every time a node is updated in the default preset language
The node setting options.translateOnAdoption has been renamed to options.automaticTranslation
The new node option options.automaticTranslation was introduced

sitegeist / lostintranslation

Maintainers

Details