diff --git a/.ddev/config.yaml b/.ddev/config.yaml index 127940ce..7e2e9d8c 100644 --- a/.ddev/config.yaml +++ b/.ddev/config.yaml @@ -21,7 +21,6 @@ web_environment: - typo3DatabasePassword=root - typo3DatabaseUsername=root nodejs_version: "16" -DEEPL_API_KEY: "" # Key features of DDEV's config.yaml: diff --git a/Documentation/Administration/AutoTranslatePrefix/Index.rst b/Documentation/Administration/AutoTranslatePrefix/Index.rst index 859dd497..49fa15eb 100644 --- a/Documentation/Administration/AutoTranslatePrefix/Index.rst +++ b/Documentation/Administration/AutoTranslatePrefix/Index.rst @@ -5,11 +5,10 @@ Auto-translate-prefix ===================== -To enable tagging for Automatically Translated Pages and Content -the page activation of translated pages was extended in order to implement a control -possibility to implement. +To enable the tagging of automatically translated pages and content, the page +activation of translated pages has been extended to provide a means of control. -This information is passed in the Page Context Fluid template and can be used there to enable a page specific appearance. +This information is passed to the Page Context Fluid template, where it can be used to create a page-specific look. .. figure:: /Images/Editor/AutoTranslatePrefix/page-translation-prefix.png :alt: Page Frontend @@ -18,7 +17,7 @@ This information is passed in the Page Context Fluid template and can be used th ---- -To make this easy can also be used in the extension Partial. +To make this easier, you can also use the extension partial. .. code-block:: html diff --git a/Documentation/Administration/Configuration/Index.rst b/Documentation/Administration/Configuration/Index.rst index 1798f303..e19fec3b 100644 --- a/Documentation/Administration/Configuration/Index.rst +++ b/Documentation/Administration/Configuration/Index.rst @@ -5,10 +5,91 @@ Configuration ============= +Set up API +------------------------ + +.. attention:: + Before using the DeepL API, you need to get an API key from your `DeepL Profile`_. + +Go to :guilabel:`Admin Tools > Settings > Extension Configuration`. + +Open the settings for :guilabel:`wv_deepltranslate` and add your API key. + +.. figure:: /Images/Reference/configuration.png + :alt: The Extension configuration settings showing two input fields for DeepL API key + +The extension is set up to auto-detect the corresponding DeepL API URL. + +.. _sitesetup: + +Set up translation language +--------------------------- + +#. Go to :guilabel:`Site Management > Sites` and edit your site configuration +#. Switch to tab `Languages` and open your target + + .. figure:: /Images/Administration/site-config-deepl-settings-empty.png + :alt: Site settings for a TYPO3 language showing empty DeepL Target Language dropdown + +#. Go to :guilabel:`DeepL Settings` and set up your `Target Language (ISO Code)` + + .. figure:: /Images/Administration/site-config-selected-target.png + :alt: Selected target now set to German + +.. note:: + Although the drop-down list can also be set in the default language, there is + no point in defining a target language for the source language. + +Choice a Formality +------------------ + +The formality configuration has been moved from the extension configuration to the SiteConfig languages. +The Formality Select field is only displayed if the selected Target-Translate of DeepL is supported. + +.. note:: + For TYPO3 projects with more than one page root and language there is an upgrade wizard, + which migrates the global formality configuration in the language config. + + .. figure:: /Images/Administration/site-config-selected-target-formally.png + :alt: Selected target now set to German wird default formality + +The same option is available in the Select field as DeepL API Supported. + +.. confval:: deeplFormality + + :type: string + + Sets whether the translated text should lean towards formal or informal language. + Possible options: + + default + The default setting. If formal or informal depends on the language + + less + Less formal language. Will fail, if no formality support for language + + more + More formal language. Will fail, if no formality support for language + + prefer_less + Use less formal language, if possible, otherwise fallback to default + + prefer_more + Use more formal language, if possible, otherwise fallback to default + + +Configure tables +---------------- + +If not default set, you need to define the `l10n_mode` for the fields you want to +have translatable by `wv_deepltranslate`. + +See the :ref:`tableConfiguration` for details. + Detecting target language ------------------------- -From TYPO3 11.5 LTS on the detection of the target language works as following: +The following chain tries to detect the language to translate into: #. Set up DeepL Translation language in SiteConfiguration * Target languages detected from DeepL will only appear @@ -16,8 +97,13 @@ From TYPO3 11.5 LTS on the detection of the target language works as following: * Needed for detecting EN-GB, EN-US, PT-PT or PT-BR #. Fallback to Language ISO code +For currently allowed languages see the `DeepL conform language key`_. As this +extension retrieves available languages from the API, translations are restricted +to the languages listed in the official DeepL API documentation. + If none of these match against DeepL API, translation for this language is disabled for usage within DeepL. Translation buttons and dropdowns respect this setting. -.. _DeepL conform language key: https://www.deepl.com/de/docs-api/general/get-languages/ +.. _DeepL conform language key: https://developers.deepl.com/docs/api-reference/languages +.. _DeepL Profile: https://www.deepl.com/en/your-account/keys diff --git a/Documentation/Administration/Installation/Index.rst b/Documentation/Administration/Installation/Index.rst index 4a02c4f3..57bd324f 100644 --- a/Documentation/Administration/Installation/Index.rst +++ b/Documentation/Administration/Installation/Index.rst @@ -5,8 +5,8 @@ Installation ============ -The extension needs to be installed as any other extension of TYPO3 CMS. Get the -extension by one of the following methods: +The extension has to be installed like any other TYPO3 CMS extension. +You can download the extension using one of the following methods: #. **Use composer**: Run @@ -28,7 +28,7 @@ extension by one of the following methods: and :ref:`configure ` it. -Inside your own site configuration follow the instructions for +Within your own site configuration follow the instructions for :ref:`table configuration `. .. _TER: https://extensions.typo3.org/extension/wv_deepltranslate diff --git a/Documentation/Administration/Updates/Index.rst b/Documentation/Administration/Updates/Index.rst index 28d3a6cc..17dc9a0a 100644 --- a/Documentation/Administration/Updates/Index.rst +++ b/Documentation/Administration/Updates/Index.rst @@ -2,11 +2,25 @@ .. _updates: +======= Updates ======= +Version 3.x > 4.x +================= + +If you are upgrading from 3.x on TYPO3 11 LTS to 12 LTS and you have used the site +config setup for translations, you can simply update. + +Upgrade with Core Upgrade +------------------------- + +If you are upgrading from a TYPO3 version below v11, you need to define the target +languages in the site configuration. See :ref:`sitesetup` +in this documentation. + Version 2.x > 3.x ------------------ +================= .. note:: This Upgrade is only needed, if you are using glossary functionality. diff --git a/Documentation/Editor/AutoTranslatePrefix/Index.rst b/Documentation/Editor/AutoTranslatePrefix/Index.rst index 50d86071..2a4e2a35 100644 --- a/Documentation/Editor/AutoTranslatePrefix/Index.rst +++ b/Documentation/Editor/AutoTranslatePrefix/Index.rst @@ -5,29 +5,28 @@ Auto-translate-prefix ===================== -To enable tagging for Automatically Translated Page and Content -the Page Turned On of translated pages was extended to implement a control -possibility to implement. +To enable tagging of automatically translated pages and content, the page turned +on of translated pages has been extended to implement a control. .. figure:: /Images/Editor/AutoTranslatePrefix/page-translation-properties.png :alt: Page Property DeepL Translate -With each translation process of content the fields are updated. +Each time content is translated, the fields are updated. ---- -The field information "Last translation date" and "DeepL Translated content has not been checked". +The field information "Last translation date" and "DeepL Translated content has not been checked" are always transferred to the page object and can be queried in Fluid. -Thus, information and notes in Fluid template can be controlled if necessary. -This must be added to the template by a TYPO3 administrator or developer beforehand. +In this way, information and notes can be controlled in the Fluid template if required. +This must be added to the template by a TYPO3 administrator or developer. .. figure:: /Images/Editor/AutoTranslatePrefix/page-translation-prefix.png :alt: Page Frontend prefix -When an editor previews DeepL translated hidden page, -a DeepL badge is displayed in addition to the "Preview" badge in the upper right corner. +When an editor is previewing a hidden page translated by DeepL, a DeepL badge is +displayed in addition to the "Preview" badge in the upper right corner. .. figure:: /Images/Editor/AutoTranslatePrefix/page-translation-preview.png :alt: Page frontend preview diff --git a/Documentation/Editor/Glossary/Index.rst b/Documentation/Editor/Glossary/Index.rst index 3106364d..d85885e0 100644 --- a/Documentation/Editor/Glossary/Index.rst +++ b/Documentation/Editor/Glossary/Index.rst @@ -5,34 +5,33 @@ Glossaries ========== -You are able to define glossaries for your translation. Each glossary has a -name, a source language and a target language defined. The name is built by -the Page title and the target and source language. +You can define glossaries for your translations. Each glossary has a name, a source +language and a target language. The name is made up of the page title and the target +and source languages. .. figure:: /Images/Editor/glossaries-list-view.png :alt: List view of glossary items -On pages with Doktype 254 (Folder) and "Use Container" to "DeepL Glossar" set, -a synchronise button appears to easy sync the glossary terms listed in this page. +On pages with Doktype 254 (Folder) and "Use Container" set to "DeepL Glossary", +a synchronise button appears for easy synchronisation of the glossary terms listed in this page. Possible glossary combinations in multiple language translation modes are built -on the fly, so your glossary can be used from every target to source, **except** -the default system language. +on the fly, so your glossary can be used from any target to source, **except** the +default system language. -Each glossary shows you the current sync status to DeepL API in page settings. +Each glossary shows you the current sync status to the DeepL API in the page settings. .. figure:: /Images/Editor/glossary-sync-tab-not-synced.png :alt: Page settings tab *DeepL Translate* with not synced glossary -Adding terms is done by list module. +Adding terms is done through the list module. .. figure:: /Images/Editor/glossary-add-term.png :alt: Add entry via add record -To generate a glossary translation, simply translate the page via TYPO3 -translation dropdown to your needed glossary language. A custom translation -dropdown is shown, which only takes languages, where glossary entries can be -built to. +To generate a glossary translation, simply translate the page into the required +glossary language using the TYPO3 translation dropdown. A custom translation dropdown +will be displayed, which will only accept languages in which glossary entries can be created. .. figure:: /Images/Editor/glossary-page-translation.png :alt: Custom translation dropdown in list view @@ -40,22 +39,21 @@ built to. .. figure:: /Images/Editor/glossary-page-translation-select.png :alt: Possible translations based on source language EN -After that, you are able to make translations with the *Translate to* button. +After that you can make translations with the *Translate to* button. As the glossary entries are made for not using DeepL standard wording, the ability of translating entries by DeepL is disabled. .. figure:: /Images/Editor/glossary-entry-list.png :alt: Backend list view of glossary entries, original language english, translated to German -In page settings, Tab **DeepL Translate** you will retrieve current sync -information of this glossary to API. +You can retrieve the current sync information of this glossary to the API in the +page settings, tab **DeepL Translate**. .. note:: - Currenty **NO** automatic sync is done on save. Save and trigger sync - manually. + Current **NO** Automatic sync is performed on save. Save and trigger sync manually. -In each glossary directory a button is enabled to sync this glossary. +In each glossary directory, a button is enabled to synchronise that glossary. After sync the tab *DeepL Translate* should look like this: diff --git a/Documentation/Editor/Index.rst b/Documentation/Editor/Index.rst index e34a6593..7ce86e4e 100644 --- a/Documentation/Editor/Index.rst +++ b/Documentation/Editor/Index.rst @@ -2,7 +2,7 @@ .. _editor: -Editors +Editors manuel ======= How editors work with *wv_deepltranslate* is described in the following chapters. diff --git a/Documentation/Editor/Usage/Index.rst b/Documentation/Editor/Usage/Index.rst index a4debf24..46372c0e 100644 --- a/Documentation/Editor/Usage/Index.rst +++ b/Documentation/Editor/Usage/Index.rst @@ -8,9 +8,9 @@ Basic Usage Translating content elements ---------------------------- -Once the extension is installed and API key provided, we are good to go for -translating content elements. On translating content element, there appears -additional four options apart from normal translate and copy. +Once the extension is installed and the API key provided, we are ready to start +translating content elements. When translating a content element, there are four +additional options besides the normal translate and copy. * DeepL Translate (auto detect). * DeepL Translate. @@ -24,9 +24,9 @@ additional four options apart from normal translate and copy. Translating a page ------------------ -*wv_deepltranslate* adds a separate dropdown for DeepL translation of a page -to list and web module. The dropdown is filtered to not translated pages -and against DeepL API possible translation languages. +*wv_deepltranslate* adds a separate dropdown for DeepL translation of a page to +the list and web module. The dropdown is filtered to not translated pages and +against DeepL API possible translation languages. .. figure:: /Images/Editor/translation-dropdown.png :alt: Dropdown for DeepL translation @@ -40,8 +40,8 @@ translate button for the language you want. .. figure:: /Images/Editor/translation-buttons-page.png :alt: Translation buttons in list view -Languages not available will have no DeepL button. In this case use normal -translation. +Languages that are not available will have no DeepL button. In this case, +use normal translation. .. figure:: /Images/Editor/translation-button-news.png :alt: Translation button for tx_news, one language not available in DeepL diff --git a/Documentation/Faq/Index.rst b/Documentation/Faq/Index.rst index b5e0bcd2..161439d6 100644 --- a/Documentation/Faq/Index.rst +++ b/Documentation/Faq/Index.rst @@ -5,9 +5,27 @@ FAQ === +My dropdown in the site configuration is empty +---------------------------------------------- + +This happens if TYPO3 cached the request from the DeepL API for allowed languages, +but no API key was provided. In this case, empty your system cache in TYPO3. +Normally no cache files should be created when no API key is provided. + +If this step does not work, delete the cached files manually. The location is as follows: + +* composer based installation + `var/cache/data/wvdeepltranslate` +* legacy installation + `typo3temp/var/cache/data/wvdeepltranslate` + +After deleting the files in this directory and going to Site Configuration, the +extension will reload the cache and the dropdown should have all the translatable +language keys. + What will be the cost for DeepL API subscription? ----------------------------------------------------------------- +------------------------------------------------- -You can find all the details regarding DeepL API usage here: +You can find all the details regarding the usage of the DeepL API here: * https://www.deepl.com/pro-pricing.html diff --git a/Documentation/Files/versionSupport.csv b/Documentation/Files/versionSupport.csv index 11277a83..164a937d 100644 --- a/Documentation/Files/versionSupport.csv +++ b/Documentation/Files/versionSupport.csv @@ -1,2 +1,3 @@ -2.3,9-11,>=7.4 -3.0,9-11,>=7.4 +"2.3","9-11",">=7.4" +"3.0","9-11",">=7.4" +"4.0-4.x","11-12","7.4, 8.0, 8.1, 8.2, 8.3" diff --git a/Documentation/Housekeeping/Index.rst b/Documentation/Housekeeping/Index.rst index e93fa839..08f299b7 100644 --- a/Documentation/Housekeeping/Index.rst +++ b/Documentation/Housekeeping/Index.rst @@ -5,25 +5,25 @@ Housekeeping ============ -For cleanup, sync and overview, three CLI commands are available. +Three CLI commands are available for Cleanup, Sync and Overview. Overview -------- -To get an overview, how many glossaries are registered to DeepL, -you can use: +To get an overview of how many glossaries are registered with DeepL, you can use +the following: .. code-block:: bash vendor/bin/typo3 deepl:glossary:list -This will give you an overview of API connected glossaries, -number of entries, creation date and Glossary DeepL ID. +This will give you an overview of the API connected glossaries, number of +entries, creation date and Glossary DeepL ID. Cleanup ------- -Due to sync failures it is useful, to delete all DeepL glossaries. +Due to sync failures, it is useful to delete all DeepL glossaries. .. code-block:: bash @@ -33,28 +33,27 @@ Due to sync failures it is useful, to delete all DeepL glossaries. vendor/bin/typo3 deepl:glossary:cleanup --glossaryId 123-123 -This command retrieves information about all glossaries or one glossary in DeepL API -registered and deletes them from API. Additionally, each glossary ID -is checked against the database and if found, the database record is -updated. +This command retrieves information about all glossaries or one glossary registered +in the DeepL API and deletes them from the API. In addition, each glossary ID is +checked against the database and if found, the database record is updated. -Then the command checks local database, if any glossary has sync -information left and cleans up, too. +The command then checks the local database to see if any glossaries still have +sync information, and cleans them up too. -At the end you will get a table with all deleted glossary IDs and -the information, if database was updated to this glossary. +At the end you will get a table with all deleted glossary IDs and the information +if the database has been updated with this glossary. -Your glossaries in TYPO3 are not deleted with this command. +This command does not delete your glossaries in TYPO3. -After this, you are able to sync your glossaries again to DeepL. +After this, you are able to sync your glossaries with DeepL again. .. _sync-cli: Synchronisation --------------- -Synchronisation is done by CLI command or as scheduled task (as configured -CLI Command). +Synchronisation is performed by CLI command or as a scheduled task (as configured +CLI command). .. code-block:: bash diff --git a/Documentation/Images/Administration/site-config-deepl-settings-empty.png b/Documentation/Images/Administration/site-config-deepl-settings-empty.png new file mode 100644 index 00000000..e557bfb4 Binary files /dev/null and b/Documentation/Images/Administration/site-config-deepl-settings-empty.png differ diff --git a/Documentation/Images/Administration/site-config-selected-target-formally.png b/Documentation/Images/Administration/site-config-selected-target-formally.png new file mode 100644 index 00000000..d924ca9c Binary files /dev/null and b/Documentation/Images/Administration/site-config-selected-target-formally.png differ diff --git a/Documentation/Images/Administration/site-config-selected-target.png b/Documentation/Images/Administration/site-config-selected-target.png new file mode 100644 index 00000000..b990983f Binary files /dev/null and b/Documentation/Images/Administration/site-config-selected-target.png differ diff --git a/Documentation/Images/Editor/deepl.png b/Documentation/Images/Editor/deepl.png index 0244d0c9..6922c49b 100644 Binary files a/Documentation/Images/Editor/deepl.png and b/Documentation/Images/Editor/deepl.png differ diff --git a/Documentation/Images/Editor/glossary-add-term.png b/Documentation/Images/Editor/glossary-add-term.png index 20c91e53..898a9857 100644 Binary files a/Documentation/Images/Editor/glossary-add-term.png and b/Documentation/Images/Editor/glossary-add-term.png differ diff --git a/Documentation/Images/Faq/.gitkeep b/Documentation/Images/Faq/.gitkeep new file mode 100644 index 00000000..e69de29b diff --git a/Documentation/Images/Faq/analytics-dashboard.png b/Documentation/Images/Faq/analytics-dashboard.png deleted file mode 100644 index 08b1e61e..00000000 Binary files a/Documentation/Images/Faq/analytics-dashboard.png and /dev/null differ diff --git a/Documentation/Images/Faq/console-home.png b/Documentation/Images/Faq/console-home.png deleted file mode 100644 index 49bf31a6..00000000 Binary files a/Documentation/Images/Faq/console-home.png and /dev/null differ diff --git a/Documentation/Images/Faq/enable-api.png b/Documentation/Images/Faq/enable-api.png deleted file mode 100644 index f2bebcc3..00000000 Binary files a/Documentation/Images/Faq/enable-api.png and /dev/null differ diff --git a/Documentation/Images/Faq/getp12-file.png b/Documentation/Images/Faq/getp12-file.png deleted file mode 100644 index abfff882..00000000 Binary files a/Documentation/Images/Faq/getp12-file.png and /dev/null differ diff --git a/Documentation/Images/Faq/key-creation.png b/Documentation/Images/Faq/key-creation.png deleted file mode 100644 index bcfc0c1c..00000000 Binary files a/Documentation/Images/Faq/key-creation.png and /dev/null differ diff --git a/Documentation/Images/Faq/service-account.png b/Documentation/Images/Faq/service-account.png deleted file mode 100644 index b2972229..00000000 Binary files a/Documentation/Images/Faq/service-account.png and /dev/null differ diff --git a/Documentation/Images/Reference/configuration.png b/Documentation/Images/Reference/configuration.png index cf20c2b6..7791d281 100644 Binary files a/Documentation/Images/Reference/configuration.png and b/Documentation/Images/Reference/configuration.png differ diff --git a/Documentation/Images/UserManual/ce-types.png b/Documentation/Images/UserManual/ce-types.png deleted file mode 100644 index feef5cbc..00000000 Binary files a/Documentation/Images/UserManual/ce-types.png and /dev/null differ diff --git a/Documentation/Images/UserManual/page-content.png b/Documentation/Images/UserManual/page-content.png deleted file mode 100644 index e2fd73df..00000000 Binary files a/Documentation/Images/UserManual/page-content.png and /dev/null differ diff --git a/Documentation/Images/UserManual/select-container-plugin.png b/Documentation/Images/UserManual/select-container-plugin.png index 849899f4..8eeaaeb1 100644 Binary files a/Documentation/Images/UserManual/select-container-plugin.png and b/Documentation/Images/UserManual/select-container-plugin.png differ diff --git a/Documentation/Images/UserManual/select-glossary-record.png b/Documentation/Images/UserManual/select-glossary-record.png index 8dc2b5dc..898a9857 100644 Binary files a/Documentation/Images/UserManual/select-glossary-record.png and b/Documentation/Images/UserManual/select-glossary-record.png differ diff --git a/Documentation/Images/UserManual/standard-translations.png b/Documentation/Images/UserManual/standard-translations.png index 0bd9a826..52d16b6f 100644 Binary files a/Documentation/Images/UserManual/standard-translations.png and b/Documentation/Images/UserManual/standard-translations.png differ diff --git a/Documentation/Images/UserManual/tca-fields.png b/Documentation/Images/UserManual/tca-fields.png deleted file mode 100644 index f0b9c09e..00000000 Binary files a/Documentation/Images/UserManual/tca-fields.png and /dev/null differ diff --git a/Documentation/Images/UserManual/terms.png b/Documentation/Images/UserManual/terms.png index 0bd9a826..52d16b6f 100644 Binary files a/Documentation/Images/UserManual/terms.png and b/Documentation/Images/UserManual/terms.png differ diff --git a/Documentation/Introduction/About/Index.rst b/Documentation/Introduction/About/Index.rst index 47116cd3..44b614cc 100644 --- a/Documentation/Introduction/About/Index.rst +++ b/Documentation/Introduction/About/Index.rst @@ -5,5 +5,5 @@ What does it do? ================ -This extension provides automatic translation to pages, content and TCA record +This extension provides automatic translation for pages, content and TCA record fields using `DeepL `__ supported languages. diff --git a/Documentation/Introduction/Contribution/Index.rst b/Documentation/Introduction/Contribution/Index.rst index d24458e9..c0b47a0b 100644 --- a/Documentation/Introduction/Contribution/Index.rst +++ b/Documentation/Introduction/Contribution/Index.rst @@ -5,26 +5,26 @@ Contribution ============ -Contributions are essential to the success of open source projects, but are by -no means limited to contributing code. Much more can be done, for example by -improving `documentation `__. +Contributions are essential to the success of open source projects, but they are by no means +limited to contributing code. Much more can be done, for example by +improving the `documentation `__. Contribution workflow --------------------- #. Please always create an issue on `Github `__ - before starting a change. This is very helpful to understand what kind of issue - the pull request will solve and if your change will be accepted. + before starting a change. This is very helpful to understand what kind of problem the + pull request solves, and whether your change will be accepted. -#. Bug fixes: Please describe the type of bug you want to fix and provide - feedback on how to reproduce the problem. We will only accept bug fixes if we +#. Bug fixes: Please describe the nature of the bug you wish to report and provide + how to reproduce the problem. We will only accept bug fixes if we can can reproduce the problem. -#. Features: Not every feature is relevant to the majority of the users. - In addition: We do not want to make this extension more complicated in usability - for a marginal feature. It helps to have a discussion about a new feature before - opening a pull request. +#. Features: Not every feature is relevant to the majority of users. + In addition: We do not want to complicate the usability of this extension for a marginal feature. + It helps to have a discussion about a new feature before + before opening a pull request. -#. Please always create a pull request based on the updated release branch. That - ensures that necessary quality checks and tests are executed as a quality - raiser. +#. Please always create a pull request based on the updated release branch. This + ensures that the necessary quality checks and tests are performed as a quality + can be performed. diff --git a/Documentation/Introduction/Sponsoring/Index.rst b/Documentation/Introduction/Sponsoring/Index.rst index d57ccc55..64715437 100644 --- a/Documentation/Introduction/Sponsoring/Index.rst +++ b/Documentation/Introduction/Sponsoring/Index.rst @@ -3,8 +3,8 @@ Sponsors ======== -We appreciate very much the sponsorships of the developments and features for -the DeepL Translate Extension for TYPO3. +We very much appreciate the sponsorship of the development and features of the +DeepL Translate Extension for TYPO3. DeepL Glossary feature sponsored by ----------------------------------- diff --git a/Documentation/Reference/ExtensionConfiguration/Index.rst b/Documentation/Reference/ExtensionConfiguration/Index.rst index feddc4d5..ab27d38f 100644 --- a/Documentation/Reference/ExtensionConfiguration/Index.rst +++ b/Documentation/Reference/ExtensionConfiguration/Index.rst @@ -6,7 +6,7 @@ Extension Configuration ======================= -Some general settings can be configured in the Extension Configuration. +Some general settings must be configured in the Extension Configuration. #. Go to :guilabel:`Admin Tools > Settings > Extension Configuration` #. Choose :guilabel:`wv_deepltranslate` @@ -25,28 +25,6 @@ DeepL API Key Add your DeepL API Key here. -.. confval:: deeplFormality - - :type: string - - Sets whether the translated text should lean towards formal or informal language. - Possible options: - - default - The default setting. If formal or informal depends on the language - - less - Less formal language. Will fail, if no formality support for language - - more - More formal language. Will fail, if no formality support for language - - prefer_less - Use less formal language, if possible, otherwise fallback to default - - prefer_more - Use more formal language, if possible, otherwise fallback to default - .. _DeepL Free API: https://www.deepl.com/pro-checkout/account?productId=1200&yearly=false&trial=false .. _DeepL Pro: https://www.deepl.com/de/pro diff --git a/Documentation/Reference/TableConfiguration/Index.rst b/Documentation/Reference/TableConfiguration/Index.rst index 8b33f588..abc73bab 100644 --- a/Documentation/Reference/TableConfiguration/Index.rst +++ b/Documentation/Reference/TableConfiguration/Index.rst @@ -6,16 +6,21 @@ Table Configuration =================== -*wv_deepltranslate* supports translation of specific fields of TCA records. It -understands fields which need to be translated, only if their ``l10n_mode`` +*wv_deepltranslate* supports the translation of specific fields of TCA records. +It only understands fields to be translated only if their ``l10n_mode`` is set to ``prefixLangTitle``. -For detecting translatable fields, *wv_deepltranslate* uses a DataHandler hook. +.. attention:: + `wv_deepltranslate` only translates fields defined as TCA type `input` or `text`. + Other fields cannot currently be translated automatically due to limitations in + the DataHandler. -The following setup is needed, to get *wv_deepltranslate* work on your table: +*wv_deepltranslate* uses a DataHandler hook to detect translatable fields. + +The following setup is required to make *wv_deepltranslate* work on your table: .. code-block:: php :caption: /Configuration/TCA/Overrides/.php $GLOBALS['TCA']['']['columns']['']['l10n_mode'] = 'prefixLangTitle'; - $GLOBALS['TCA']['']['columns']['']['l10n_mode'] = 'prefixLangTitle'; + $GLOBALS['TCA']['']['columns']['']['l10n_mode'] = 'prefixLangTitle'; diff --git a/Documentation/Settings.cfg b/Documentation/Settings.cfg deleted file mode 100644 index ee9c213f..00000000 --- a/Documentation/Settings.cfg +++ /dev/null @@ -1,24 +0,0 @@ -[general] -project = DeepL Translate -version = main (development) -release = main (development) -copyright = since 2018 by web-vision GmbH & Contributors -t3author = web-vision GmbH -description = TYPO3 Extension to translate content and TCA records with DeepL - - -[html_theme_options] - -github_branch = main -github_repository = web-vision/wv_deepltranslate - -project_contact = hello@web-vision.de -project_discussions = -project_home = https://github.com/web-vision/wv_deepltranslate -project_issues = https://github.com/web-vision/wv_deepltranslate/issues -project_repository = https://github.com/web-vision/wv_deepltranslate - - -[extlinks] - -issue = https://github.com/web-vision/wv_deepltranslate/issues/%s | Issue #