Skip to content

Commit

Permalink
[FEATURE] Docs: Add screenshot & configuration links
Browse files Browse the repository at this point in the history
Make the documention link stand out a bit more and
add an example screenshot as this makes the package
more tangible for TYPO3 integrators.

Also refers more verbose to the necessary configuration.
  • Loading branch information
pixelbrackets authored and calien666 committed Oct 16, 2024
1 parent 9bf1a0d commit d82b991
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 16 deletions.
10 changes: 6 additions & 4 deletions Documentation/Administration/Configuration/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,16 @@ 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`.
Go to the :ref:`extension configuration <extensionConfiguration>`
in :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.
The correct DeepL API endpoint for free or pro plans is auto-detected
by the extension and the given API key format.

.. _sitesetup:

Expand Down Expand Up @@ -81,8 +83,8 @@ The same option is available in the Select field as DeepL API Supported.
Configure tables
----------------

If not default set, you need to define the `l10n_mode` for the fields you want to
have translatable by `wv_deepltranslate`.
If not set by default, you need to define the `l10n_mode` for the fields you
want to have translatable by `wv_deepltranslate`.

See the :ref:`tableConfiguration<table configuration>` for details.

Expand Down
6 changes: 2 additions & 4 deletions Documentation/Administration/Installation/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,8 @@ You can download the extension using one of the following methods:
You can always get current version from `TER`_ by downloading the zip
version. Upload the file afterwards in the Extension Manager.

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

Within your own site configuration follow the instructions for
:ref:`table configuration <tableConfiguration>`.
The extension then needs to be :ref:`configured <configuration>`
in order to display translation buttons in the desired languages.

.. _TER: https://extensions.typo3.org/extension/wv_deepltranslate

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ for languages supported by [DeepL](https://www.deepl.com/de/docs-api/).
* Synchronise glossaries to DeepL API
* Translate content using your glossaries

![Screenshot](Documentation/Images/example-of-deepl-translation-selection-in-typo3-backend.png)

## Early-Access-Programm

Early access partners of DeepL Translate will benefit from exclusive access to all add-ons, developer preview versions, access to private GitHub repositories, priority support, logo placement and a backlink on the official website. You will also get access to the DeepL Translate version 5.0 announced for TYPO3 v13.
Expand All @@ -38,26 +40,29 @@ Find out more: https://www.web-vision.de/en/deepl.html

Install with your favour:

* [TER](https://extensions.typo3.org/extension/wv_deepltranslate/)
* Extension Manager
* composer
* [Composer](https://packagist.org/packages/web-vision/wv_deepltranslate)
* [TER / Extension Manager](https://extensions.typo3.org/extension/wv_deepltranslate/)
* [Git](https://github.com/web-vision/wv_deepltranslate)

We prefer composer installation:
```bash
composer req web-vision/wv_deepltranslate
```

| | URL |
|------------------|-------------------------------------------------------------------|
| **Repository:** | https://github.com/web-vision/wv_deepltranslate |
| **Read online:** | https://docs.typo3.org/p/web-vision/wv_deepltranslate/main/en-us/ |
| **TER:** | https://extensions.typo3.org/extension/wv_deepltranslate/ |
The DeepL translation buttons are only displayed once you have set up the API
and desired target languages. Read the documentation to find out how to do this.

## Documentation

Read online: https://docs.typo3.org/p/web-vision/wv_deepltranslate/main/en-us/

## Sponsors

We appreciate very much the sponsorships of the developments and features in
the DeepL Translate Extension for TYPO3.

### DeepL Glossary feature sponsored by

* [Universität Osnabrück](https://www.uni-osnabrueck.de)
* [Hochschule für Musik Würzburg](https://www.hfm-wuerzburg.de)
* [Carl von Ossietzky Universität Oldenburg](https://uol.de/)
Expand Down

0 comments on commit d82b991

Please sign in to comment.