Skip to content

Commit

Permalink
[TASK] Update texts with DeepL write
Browse files Browse the repository at this point in the history
  • Loading branch information
calien666 committed Jul 13, 2024
1 parent 3270fd7 commit a8219af
Show file tree
Hide file tree
Showing 13 changed files with 93 additions and 99 deletions.
9 changes: 4 additions & 5 deletions Documentation/Administration/AutoTranslatePrefix/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Expand Down
6 changes: 3 additions & 3 deletions Documentation/Administration/Installation/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -28,7 +28,7 @@ extension by one of the following methods:

and :ref:`configure <extensionConfiguration>` it.

Inside your own site configuration follow the instructions for
Within your own site configuration follow the instructions for
:ref:`table configuration <tableConfiguration>`.

.. _TER: https://extensions.typo3.org/extension/wv_deepltranslate
Expand Down
10 changes: 5 additions & 5 deletions Documentation/Administration/Updates/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ Updates
Version 3.x > 4.x
=================

If you are upgrading from 3.x on TYPO3 11 LTS to 12 LTS and you used site config
setup of translations, you simply can update.
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 upgrade fom TYPO3 below v11 you have to define the target languages in
the site configuration. See the :ref:`sitesetup<Site Setup section>` in this
documentation.
If you are upgrading from a TYPO3 version below v11, you need to define the target
languages in the site configuration. See :ref:`sitesetup<Site Setup section>`
in this documentation.

Version 2.x > 3.x
=================
Expand Down
17 changes: 8 additions & 9 deletions Documentation/Editor/AutoTranslatePrefix/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
36 changes: 17 additions & 19 deletions Documentation/Editor/Glossary/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,57 +5,55 @@
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

.. 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:

Expand Down
16 changes: 8 additions & 8 deletions Documentation/Editor/Usage/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand All @@ -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
Expand Down
15 changes: 7 additions & 8 deletions Documentation/Faq/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,24 @@ FAQ
My dropdown in the site configuration is empty
----------------------------------------------

This happens, if TYPO3 cached the request from DeepL API for allowed languages
but no API key was provided. In this case, clear your system cache in TYPO3.
Normally no cache files should be created, when no API key is provided.
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 take no effect, delete the cached files manually. The location
is the following:
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 loads the cache again and the dropdown should have all translatable
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
35 changes: 17 additions & 18 deletions Documentation/Housekeeping/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion Documentation/Introduction/About/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.deepl.com/>`__ supported languages.
28 changes: 14 additions & 14 deletions Documentation/Introduction/Contribution/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://docs.typo3.org/p/web-vision/wv_deepltranslate/main/en-us/>`__.
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 <https://docs.typo3.org/p/web-vision/wv_deepltranslate/main/en-us/>`__.

Contribution workflow
---------------------

#. Please always create an issue on `Github <https://github.com/web-vision/wv_deepltranslate/issues>`__
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.
4 changes: 2 additions & 2 deletions Documentation/Introduction/Sponsoring/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------------------------------
Expand Down
2 changes: 1 addition & 1 deletion Documentation/Reference/ExtensionConfiguration/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
Loading

0 comments on commit a8219af

Please sign in to comment.