Skip to content

Commit d82b991

Browse files
pixelbracketscalien666
authored andcommitted
[FEATURE] Docs: Add screenshot & configuration links
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.
1 parent 9bf1a0d commit d82b991

File tree

4 files changed

+21
-16
lines changed

4 files changed

+21
-16
lines changed

Documentation/Administration/Configuration/Index.rst

+6-4
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,16 @@ Set up API
1111
.. attention::
1212
Before using the DeepL API, you need to get an API key from your `DeepL Profile`_.
1313

14-
Go to :guilabel:`Admin Tools > Settings > Extension Configuration`.
14+
Go to the :ref:`extension configuration <extensionConfiguration>`
15+
in :guilabel:`Admin Tools > Settings > Extension Configuration`.
1516

1617
Open the settings for :guilabel:`wv_deepltranslate` and add your API key.
1718

1819
.. figure:: /Images/Reference/configuration.png
1920
:alt: The Extension configuration settings showing two input fields for DeepL API key
2021

21-
The extension is set up to auto-detect the corresponding DeepL API URL.
22+
The correct DeepL API endpoint for free or pro plans is auto-detected
23+
by the extension and the given API key format.
2224

2325
.. _sitesetup:
2426

@@ -81,8 +83,8 @@ The same option is available in the Select field as DeepL API Supported.
8183
Configure tables
8284
----------------
8385

84-
If not default set, you need to define the `l10n_mode` for the fields you want to
85-
have translatable by `wv_deepltranslate`.
86+
If not set by default, you need to define the `l10n_mode` for the fields you
87+
want to have translatable by `wv_deepltranslate`.
8688

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

Documentation/Administration/Installation/Index.rst

+2-4
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,8 @@ You can download the extension using one of the following methods:
2626
You can always get current version from `TER`_ by downloading the zip
2727
version. Upload the file afterwards in the Extension Manager.
2828

29-
and :ref:`configure <extensionConfiguration>` it.
30-
31-
Within your own site configuration follow the instructions for
32-
:ref:`table configuration <tableConfiguration>`.
29+
The extension then needs to be :ref:`configured <configuration>`
30+
in order to display translation buttons in the desired languages.
3331

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

Loading

README.md

+13-8
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ for languages supported by [DeepL](https://www.deepl.com/de/docs-api/).
2121
* Synchronise glossaries to DeepL API
2222
* Translate content using your glossaries
2323

24+
![Screenshot](Documentation/Images/example-of-deepl-translation-selection-in-typo3-backend.png)
25+
2426
## Early-Access-Programm
2527

2628
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.
@@ -38,26 +40,29 @@ Find out more: https://www.web-vision.de/en/deepl.html
3840

3941
Install with your favour:
4042

41-
* [TER](https://extensions.typo3.org/extension/wv_deepltranslate/)
42-
* Extension Manager
43-
* composer
43+
* [Composer](https://packagist.org/packages/web-vision/wv_deepltranslate)
44+
* [TER / Extension Manager](https://extensions.typo3.org/extension/wv_deepltranslate/)
45+
* [Git](https://github.com/web-vision/wv_deepltranslate)
4446

4547
We prefer composer installation:
4648
```bash
4749
composer req web-vision/wv_deepltranslate
4850
```
4951

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

5659
## Sponsors
60+
5761
We appreciate very much the sponsorships of the developments and features in
5862
the DeepL Translate Extension for TYPO3.
5963

6064
### DeepL Glossary feature sponsored by
65+
6166
* [Universität Osnabrück](https://www.uni-osnabrueck.de)
6267
* [Hochschule für Musik Würzburg](https://www.hfm-wuerzburg.de)
6368
* [Carl von Ossietzky Universität Oldenburg](https://uol.de/)

0 commit comments

Comments
 (0)