FEATURE: Add glossary management

[lorenzulrich]

This code is extracted from https://github.com/robert-heinig/Sitegeist.LostInTranslation/tree/feature/glossaries. Since this branch diverged heavily from the original package, I extracted all relevant changes to this branch.

This is not meant from merging as code style-wise the feature is not really in line with the rest of LostInTranslation. However, I'm pushing this as a base for discussion if we should bring this to a state that is mergeable.

This can be configured as follows:

Sitegeist:
  LostInTranslation:
    DeepLApi:
      glossary:
        backendModule:
          sortByLanguage: 'DE'
        languagePairs:
          -
            source: 'DE'
            target: 'EN'

This allows adding a glossary when DE is translated to EN. It relies on the deeplLanguage being set in the CR dimension configuration, e.g.:

Neos:
  ContentRepository:
    contentDimensions:
      language:
        label: 'Sprache'
        icon: icon-globe-europe
        default: de_CH
        defaultPreset: de_CH
        presets:
          de_CH:
            label: 'Deutsch'
            values:
              - de_CH
            uriSegment: ''
            options:
              deeplLanguage: 'DE'
          en_GB:
            label: 'English'
            values:
              - en_GB
            uriSegment: 'en'
            options:
              deeplLanguage: 'EN'
              translationStrategy: 'once'

Please be aware of the following:

• The DeepL glossary API does not allow editing a glossary item (see here). That means that every time the glossary is changed, a new glossary must be pushed to DeepL and the old one deleted. Therefore, you need to execute ./flow flow glossary:sync to set up and sync the glossary (also when installing it).
• The DeepL glossary apparently is not just a "search & replace" which will lead to unexpected results. Without enough text/context, it is possible that terms are not replaced or not replaced properly. I don't have more insight how it actually works, but found a mention of it here and have experienced the behaviour myself.

Resolves: #5
cc @robert-heinig

[lorenzulrich]

@mficzel What is your general opinion on this PR? Should this go to a separate package extending LostInTranslation or would you be willing/interested to include it?

[mficzel]

Did not really look into it as it says it is not Really meant to be merged. At least that is how I understood it.

[mficzel]

In general I would like to have glossaries in lost in translation. Will take deeper look the next days

[lorenzulrich]

Did not really look into it as it says it is not Really meant to be merged. At least that is how I understood it.

From a functional POV, it is ready and we have been using it in production for 1/2 year+.

There are some ToDos left in the code that need to be cleanup before merging. Depending on your deeper look, I'd be willing to update the code.

[mficzel]

I agree to the code, it would be really cool to finally have glossay support in here. So feel free to fix the remaining issues.

You can ping me via Slack for faster feedback. Otherwise it may take while until i notice movement here.

Thanks a lot for your help, it is greatly appreciated.

[lorenzulrich]

@mficzel PHPUnit is not happy here:

Error: Cannot initialize readonly property Sitegeist\LostInTranslation\Infrastructure\DeepL\DeepLTranslationService::$serverRequestFactory from scope Mock_AccessibleTestProxyf8c5d1ca5b11a34fe92f72f4fde95814_9b50f72f

How can this be resolved?

[lorenzulrich]

@mficzel Apart from the failing build, this is now ready for a final review. Most changes I added are related to documentation and configuration.

[mficzel]

@lorenzulrich after working on this for a bit i decided to try doing it a little more simple. See #52 for what i ended up with.

It would be great if you could test this and give feedback wether it works for you aswell.

[mficzel]

Was implemented here instead #63 thanks a lot for the inspiration to finally give it a shot