Download the PHP package arillo/silverstripe-deepl-translator without Composer
On this page you can find all versions of the php package arillo/silverstripe-deepl-translator. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download arillo/silverstripe-deepl-translator
More information about arillo/silverstripe-deepl-translator
Files in arillo/silverstripe-deepl-translator
Package silverstripe-deepl-translator
Short Description Adds deepl translations to silverstripe CMS
License BSD-3-Clause
Homepage https://github.com/arillo-ch/silverstripe-deepl-translator
Informations about the package silverstripe-deepl-translator
arillo/silverstripe-deepl-translator
Adds Deepl translation API to a Fluent translated SilverStripe CMS. For now it only adds UI-Elements to texty fields (TextField, TextareaField, HTMLEditorField) to translate their contents.
Installation
Configuration
Create a Deepl API key and add it to your .env
:
If you are using the glossary feature, it is necessary, to set a unique name prefix in your .env
.
It will prevent old glossaries from deletion if their names do not start with that name prefix.
This is handy if you are using the same API key in multiple instances (e.g. dev & prod).
Configure your DataObjects to display the Deepl translation handles.
NOTE: It is important, that this configurations happens AFTER fluent was added to these DataObjects. Otherwise the UI will not appear.
Let's assume you have the following fluent config, named myfluentcms
:
Field-wise translator
Apply the deepl config after #myfluentcms
:
Make URLSegmentFields translatable (CAUTION: is expirimental; JS implementation WIP):
Alternate field value gathering for field-wise translator
To preload current values for field-wise translations this module uses the following method $record->{$fieldName}
.
However, it is possible to specify an alternate data source by implementing a class method called deeplFieldValueFromRecord
to overwrite the default behavior, e.g.:
Add translation features to selected fields only:
Below you see an example configuration that will only add field-wiese translation features to Title
and Description
for that App\Model\MyDataObject
.
DataObject-wise translator
Automatically translates all translatable fields of a DataObject.
Just add Arillo\Deepl\DataObjectWiseTranslationExtension
to extensions of that DataObject class, e.g.:
Optionally you can define relations that also will be translated. Make sure that the according DataObject also use soem Fluent extensions.
To configure the wanted relations just use the deepl_dataobject_included_relations
configuration, e.g.:
Glossary
If you want to use the glossary features of Deepl, you can edit your glossaries in SiteConfig.
You need to set a glossary name prefix in your .env
, like so:
These prefixes are usefull if you run your app in different environments, e.g.: dev
or live
.
As of this writing, keep in mind that the deepl glossary API does not allow for updates of glossaries. So updates are deletes and creates. The purging mechanism takes the name prefixes into account. E.g.:
If your env is set to mysite-prod
it will only delete glossaries where the name starts with that prefix. This should help to prevent unwanted glossary deletes.
CMS
In CMS you have to add USE_DEEPL
permission to non-admin groups.
Alternatives
If you want to use Google Translate consider to use: bratiask/silverstripe-autotranslate
All versions of silverstripe-deepl-translator with dependencies
deeplcom/deepl-php Version ^1.3.0
amphp/parallel-functions Version ^1.1
arillo/silverstripe-cms-alpine Version dev-main