[1.0.0] Zwirnis Translate

Zwirnis Translate
Beiträge und Textbausteine übersetzen / Translate posts and text modules

Plugin Version: 1.0.0
Plugin Kompatibilität: CF4 / Version >= 4.7.0
enthaltene Sprachen: Deutsch, Englisch (teilweise polnisch und italienisch)

Deutsch
Ein Plugin für CBACK-basierte Foren, welches verschiedene Übersetzungsmöglichkeiten für (sprichwörtlich) alle Bereiche des Forums bereitstellt. Die vom Plugin bereitgestellten Features können einzeln genutzt werden, man muss sie nicht alle zusammen verwenden.

Mit diesem Plugin kann man sein CBACK-Forum in hunderten verschiedenen Sprachen präsentieren. Auch die Nutzer können miteinander in ebenso vielen Sprachen miteinander kommunizieren.

Features

• Ermöglicht die Übersetzung jeglicher Beiträge im Forum per Übersetzungs-APIs.
  
• Ermöglicht die Übersetzung jeglicher Textbausteine des Forums, auch von Plugins sowohl per Übersetzungs-APIs als auch über PO-Sprachdateien.
  
• Bietet zur Übersetzung die Unterstützung von 3 der weltbesten Übersetzungs-APIs an - siehe Abschnitt "Unterstützte APIs"
  
• Datenschutz-konformer Einsatz: keinerlei Nutzerinformationen gehen an externe Dienste
  
  • nur die Texte von Beiträgen werden an diese übermittelt ohne jeglichen Zusammenhang mit anderen personenbezogenen Daten.
    
  
  
• Die unterstützten Übersetzungs-APIs können wahlweise für einzelne Nutzergruppen freigeschaltet werden.
  
• Automatisch übersetzte Beiträge und Textbausteine können jederzeit manuell durch dafür berechtigte Nutzer angepasst und somit optimiert werden.
  

Unterstützte APIs
Folgende APIs werden aktuell von diesem Plugin unterstützt:

• DeepL API:
  
  • zur Verwendung ist ein kostenpflichtiger API-Schlüssel notwendig
    
  • Informationen dazu: https://www.deepl.com/de/docs-api/
    
  
  
• Google Translator API
  
  • zur Verwendung ist ein Google-Konto des Foren-Betreibers sowie ein API-Schlüssel notwendig
    
  • ist ggfs. mit Kosten verbunden über die Google informiert
    
  • siehe: https://cloud.google.com/translate/pricing?hl=de
    
  
  
• Microsoft Azure Translator API:
  
  • zur Verwendung ist ein API-Schlüssel notwendig
    
  • ist ggfs. mit Kosten verbunden über die Microsoft informiert
    
  • siehe: https://azure.microsoft.com/de…-text-api/
    
  
  

Wichtig
Dieses Plugin stellt lediglich die Funktionalität zur Nutzung der o.g. APIs zur Verfügung.
Jegliche automatisierte Übersetzungen werden durch die externen Dienste bereitgestellt auf die der Plugin-Entwickler keinen Einfluss hat. Es kann in dem Zusammenhang auch jederzeit dazu kommen, dass durch Änderungen an den APIs der jeweiligen Anbieter dieses Plugin nicht mehr funktionsfähig ist bis ggfs. ein Update durch den Plugin-Entwickler erfolgt ist.
Bitte auch beachten, dass es sich um automatisierte Übersetzungen handelt die je nach Qualität der API unterschiedlich gut bei den Muttersprachlern ankommen.
Eine Nachjustierung jeglicher Übersetzungen, die auf dem Weg bezogen wurden, ist mit diesem Plugin möglich, erfordert jedoch eine manuelle Anpassung eines Übersetzers, der sowohl die Quell- wie auch Zielsprache beherrscht.

Funktionen des Plugins
Für jeden Nutzer:

• Jeder Nutzer kann in seinem Kontrollzentrum unter Extras auswählen in welcher Sprache er seine Beiträge verfasst. Diese kann von der Sprache seiner Foren-Ansicht abweichen.
  
• Hat der Nutzer keine Beitragssprache ausgewählt, wird seine Forensprache als Beitragsspreche angenommen.
  
• Unterhalb jedes Beitrags kann ein Text eingeblendet werden wenn die Browser-Sprache des aufrufenden sich von der des Beitrags-Posters unterscheidet. Er wird hier auf die Möglichkeit der Übersetzung in andere Sprachen hingewiesen, wobei seine eigene Sprache entsprechend hervorgehoben wird, wenn diese für seine Nutzergruppe freigeschaltet wurde. Durch Klick auf eine der Sprachen wird der Beitrag sofort über die jeweils konfigurierte API übersetzt. Diese Einstellung ist optional.
  
• Dafür freigeschaltete Nutzer erhalten im Kontrollzentrum eine neue Option über die sie festlegen können, welche Sprache sie unterstützen um automatisierte Beitragsübersetzungen nachträglich verbessern zu können. Sobald sie min. 1 Sprache ausgewählt haben wird ihnen eine Liste der Beiträge angezeigt, die in diese Sprache bereits übersetzt wurden und die ggfs. einer Kontrolle bedürfen. Diese Einstellung ist optional. Im ACP müssen die berechtigten Nutzer explizit dafür freigegeben werden.
  

Im Frontend:

• Jeder Beitrag wird der Beitrags- oder Foren-Sprache des Postenden versehen.
  
• Jedes Thema wird mit der Beitrags oder Foren-Sprache des Postenden versehen.
  
• Dadurch wird in der Foren-Übersicht neben dem Thema eine Sprach-Flagge angezeigt wenn die Browser-Sprache des aufrufenden sich von der des Themen-Eröffners unterscheidet.
  
• Ausgabe von Button mit Auswahl der zur Verfügung stehenden Sprachen unterhalb jedes Beitrags für berechtigte Nutzer. Durch Klick auf eine der Sprachen wird der Beitrag sofort über die jeweils konfigurierte API übersetzt. Diese Einstellung ist optional.
  
• Es werden nur die Sprachen angezeigt die für die Gruppe des aufrufenden Nutzers freigeschaltet wurden. Diese Einstellung ist optional.
  
• Der übersetzte Text ersetzt den originalen Text des Beitrags. Es wird jedoch ein Hinweis auf die automatisierte Übersetzung sowie ein Link um den Originaltext anzuzeigen eingeblendet.
  
• Ruft man ein Thema auf in dem bereits ein Text in der eigenen Sprache übersetzt vorliegt, wird dieser sofort angezeigt. Dadurch kann man jederzeit auch fremdsprachigen Themen nahtlos folgen.
  
• Für berechtigte Nutzer wird bei jedem Text ein Hinweis angezeigt, wenn dieser in einer Sprache übersetzt vorliegt die der berechtigte Nutzer angegeben hat zu beherrschen. Durch Klick auf den dort angezeigten Link kann er den automatisch übersetzten Text nachträglich ausbessern. Diese Einstellung ist optional. Siehe oben.
  
• Beim Schreiben eines neuen Beitrags kann man in der vollen Editor-Ansicht die eigene Beitragssprache wählen. Diese Einstellung wird beim Schreiben eines neuen Themas auch an das Thema als Eigenschaft gespeichert. Beim einfachen Editor wird angezeigt, welche Beitragssprache man eingestellt hat, kann diese an der Stelle jedoch nicht ändern.
  

Im Backend:

• Option um den Hinweistext zur möglichen Übersetzung unterhalb des Beitrags zu aktivieren. (Standard: aktiviert).
  
• Option um die Übersetzungsmöglichkeit unterhalb des Beitrags zu aktivieren. (Standard: aktiviert)
  
• Option um zu ermöglichen, dass jeder Nutzer einmal für ihn übersetzte Texte auch weiterhin sieht. Dadurch muss der Nutzer nicht jedes Mal neu auf den Button zum Übersetzen klicken. (Standard: aktiviert)
  
• Option um einzelnen Nutzern die nachträgliche Korrektur von übersetzten Beiträgen zu ermöglichen. (Standard: deaktiviert)
  
• Option um die berechtigten Nutzer auszuwählen.
  
• Einstellungsmöglichkeiten zur Nutzung der Microsoft Azure Translator API:
  
  • Kann separat aktiviert und deaktiviert werden (Standard: deaktiviert)
    
  • Hinterlegung eines API-Key (siehe Unten, Standard: leeres Feld)
    
  • Angabe, welche Sprachen den Nutzern im Forum zur Übersetzung zur Verfügung gestellt werden sollen. Diese Liste muss nach Erstinstallation des Plugins per Klick auf einen dafür vorgesehenen Button zunächst vom Microsoft Translator API-Server geladen werden, da sich die unterstützten Sprachen immer wieder ändern könnten.
    
  • Auswahl der Nutzergruppen, die die Übersetzung per Microsoft Translator API nutzen dürfen.
    
  
  
• Einstellungsmöglichkeiten zur Nutzung der DeepL API:
  
  • Kann separat aktiviert und deaktiviert werden (Standard: deaktiviert)
    
  • Hinterlegung eines API-Key (siehe Unten, Standard: leeres Feld)
    
  • Angabe, welche Sprachen den Nutzern im Forum zur Übersetzung zur Verfügung gestellt werden sollen. Diese Liste muss nach Erstinstallation des Plugins per Klick auf einen dafür vorgesehenen Button zunächst vom Microsoft Translator API-Server geladen werden, da sich die unterstützten Sprachen immer wieder ändern könnten.
    
  • Auswahl der Nutzergruppen, die die Übersetzung per DeepL API nutzen dürfen.
    
  
  
• Einstellungsmöglichkeiten zur Google Translator API:
  
  • Kann separat aktiviert und deaktiviert werden (Standard: deaktiviert)
    
  • Hinterlegung eines API-Key (siehe Unten, Standard: leeres Feld)
    
  • Angabe, welche Sprachen den Nutzern im Forum zur Übersetzung zur Verfügung gestellt werden sollen. Diese Liste muss nach Erstinstallation des Plugins per Klick auf einen dafür vorgesehenen Button zunächst vom Microsoft Translator API-Server geladen werden, da sich die unterstützten Sprachen immer wieder ändern könnten.
    
  • Auswahl der Nutzergruppen, die die Übersetzung per DeepL API nutzen dürfen.
    
  
  
• Alle erfassten Daten können optional bei Deinstallation des Plugins gelöscht werden. (Standard: deaktiviert)
  
• Button um alle Übersetzungen zu entfernen. Das entfernt wirklich alles, also: Beiträge und Textbausteine.
  

Demo:
In unserem Forum ist das Plugin aktuell auch für Gäste aktiviert. Hier ist z.B. ein Beitrag eines unserer englischsprachigen Nutzer, welchen man per Klick auf Deutsch, Italienisch oder Polnisch übersetzen lassen kann:
https://www.siedler3.net/not-r…t9595.html

abschließende Hinweise:
Die im Plugin vorhandene Möglichkeit alle Textbausteine des Forums zu übersetzen kann bereits genutzt werden. Allerdings kann es vorkommen, dass nicht alle Textbausteine im Frontend auch übersetzt angezeigt werden. Grund ist, dass nach aktuellem Stand entweder jedes Plugin mit Textbausteinen an dieses Plugin angepasst werden müsste oder CBACK eine Ergänzung beim Auslesen der Sprachdateien benötigt (wurde bereits angefragt).
Dieses Plugin ist eines von vielen Plugins, die die Siedler 3 Community seit langer Zeit im eigenen CBACK-Forum erfolgreich betreibt. Der Entwickler Zwirni ist auch hier im Cback-Forum angemeldet und kann eure Fragen beantworten.
Bei dem Plugin handelt es sich um das sowohl funktional als auch von den Code-Zeilen her umfangreichste Plugin für CBACK, welches Zwirni bisher entwickelt hat.

Englisch
A plugin for CBACK-based forums, which provides various translation options for (literally) all areas of the forum. The features provided by the plugin can be used individually, you don't have to use them all together.

With this plugin you can present your CBACK forum in hundreds of different languages. Also the users can communicate with each other in as many languages.

Features

• Enables the translation of any post in the forum via translation APIs.
  
• Allows the translation of any text modules of the forum, including plugins, via translation APIs as well as PO language files.
  
• Offers support for 3 of the world's best translation APIs - see section "Supported APIs".
  
• Data protection-compliant use: no user information goes to external services
  
  • only the texts of contributions are transmitted to them without any connection with other personal data.
    
  
  
• The supported translation APIs can optionally be enabled for individual user groups.
  
• Automatically translated articles and text modules can be manually adapted and thus optimized at any time by authorized users.
  

Supported APIs
The following APIs are currently supported by this plugin:

• DeepL API:
  
  • For use, a paid API key is required
    
  • Information about this: https://www.deepl.com/de/docs-api/
    
  
  
• Google Translator API
  
  • to use it you need a Google Account of the forum operator and an API key
    
  • is possibly associated with costs about which Google is informed
    
  • see: https://cloud.google.com/translate/pricing?hl=de
    
  
  
• Microsoft Azure Translator API:
  
  • an API key is required for use
    
  • is informed about the costs that Microsoft may incur
    
  • see: https://azure.microsoft.com/de…-text-api/
    
  
  

Important
This plugin only provides the functionality to use the above APIs.
Any automated translations are provided by external services over which the plugin developer has no control. In this context, it is possible that changes to the APIs of the respective providers may result in the plugin no longer functioning until an update is made by the plugin developer.
Please also note that these are automated translations which, depending on the quality of the API, are received differently by native speakers.
A readjustment of any translations obtained on the way is possible with this plugin, but requires a manual adjustment by a translator who knows both the source and target language.

Functions of the plugin
For every user:

• If the user has not selected a language for his posts, his forum language will be taken as the language of his posts.
  
• A text can be displayed below each post if the browser language of the calling user is different from the language of the post poster. The user will be informed here about the possibility of translation into other languages, whereby his own language will be highlighted accordingly if it has been activated for his user group. By clicking on one of the languages, the post is immediately translated via the configured API. This setting is optional.
  
• Unlocked users will get a new option in the control center where they can specify which language they support to improve automated post translations. As soon as they have selected at least one language, a list of posts will be displayed which have already been translated into this language and which may require checking. This setting is optional. In the ACP, the authorized users must be explicitly enabled for it.
  

In the front end:

• Each topic will be tagged with the posting or forum language of the posting person.
  
• This will display a language flag next to the topic in the forum overview if the browser language of the calling user is different from the browser language of the topic creator.
  
• Output of button with selection of the available languages below each post for authorized users. By clicking on one of the languages the post will be translated immediately via the configured API. This setting is optional.
  
• Only the languages that have been enabled for the group of the calling user are displayed. This setting is optional.
  
• The translated text will replace the original text of the post. However, a note about the automated translation and a link to display the original text will be displayed.
  
• If you call up a topic in which a text in your own language is already translated, it will be displayed immediately. This allows you to follow foreign-language topics seamlessly at any time.
  
• For authorized users a hint will be shown at each text, if it is translated in a language the authorized user has indicated to master. By clicking on the link displayed there, he can correct the automatically translated text afterwards. This setting is optional. See above.
  When writing a new post, you can select your own post language in the full editor view. This setting is also saved as a property when you write a new topic to the topic. The simple editor will show you the language you have selected, but you cannot change it here.
  

In the back end:

• Option to activate the text of the possible translation below the post. (default: activated).
  
• Option to activate the translation option below the post. (Default: activated)
  
• Option to allow each user to continue to see texts that have been translated for him or her. This way the user does not have to click the button for translating each time. (default: activated)
  
• Option to allow individual users to correct translated contributions at a later date. (default: deactivated)
  
• Option to select the authorized users.
  
• Settings options for using the Microsoft Azure Translator API:
  
  • Can be enabled and disabled separately (default: disabled)
    
  • Storage of an API key (see below, default: empty field)
    
  • Indication of which languages should be made available to users in the forum for translation. This list must be loaded from the Microsoft Translator API server after the first installation of the plugin by clicking on a button provided for this purpose, as the supported languages may change again and again.
    
  • Selection of user groups that are allowed to use the translation via Microsoft Translator API.
    
  
  
• Settings options for using the DeepL API:
  
  • Can be enabled and disabled separately (default: disabled)
    
  • Storage of an API key (see below, default: empty field)
    
  • Indication of which languages should be made available to users in the forum for translation. This list must be loaded from the Microsoft Translator API server after the first installation of the plugin by clicking on a button provided for this purpose, as the supported languages may change again and again.
    
  • Selection of the user groups that are allowed to use the translation via DeepL API.
    
  
  
• Settings options for the Google Translator API:
  
  • Can be enabled and disabled separately (default: disabled)
    
  • Storage of an API key (see below, default: empty field)
    
  • Indication of which languages should be made available to users in the forum for translation. This list must be loaded from the Microsoft Translator API server after the first installation of the plugin by clicking on a button provided for this purpose, as the supported languages may change again and again.
    
  • Selection of the user groups that are allowed to use the translation via DeepL API.
    
  
  
• All collected data can optionally be deleted when uninstalling the plugin. (default: deactivated)
  
• Button to remove all translations. This really removes everything, that is: posts and text modules.
  

Demo:
In our forum the plugin is currently also activated for guests. Here is for example a post by one of our English speaking users, which can be translated to German, Italian or Polish by clicking on it:
https://www.siedler3.net/not-r…t9595.html

final notes:
The plugin already offers the possibility to translate all text modules of the forum. However, it may happen that not all text modules in the frontend are displayed translated. The reason is that, according to the current status, either every plugin with text modules would have to be adapted to this plugin or CBACK needs a supplement when reading the language files (has already been requested).
This plugin is one of many plugins that the Settlers 3 community has been successfully running in its own CBACK forum for a long time. The developer Zwirni is also registered here in the Cback-Forum and can answer your questions.
The plugin is the most comprehensive plugin for CBACK, both functionally and in terms of code lines, which Zwirni has developed so far.

Download: https://lobby.siedler3.net/download/zwirni_translate.tar.gz (12 MB)