Skip to content

Commit cd16564

Browse files
calien666calien666
committed
[TASK] Initial restructuring of documentation matching TYPO3 standards
1 parent 424c3bc commit cd16564

22 files changed

Lines changed: 724 additions & 219 deletions

File tree

‎.editorconfig‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,4 +57,4 @@ indent_size = 2
5757

5858
# .htaccess
5959
[{_.htaccess,.htaccess}]
60-
indent_style = tab
60+
indent_style = tab

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ composer.lock
88
var
99
.php-cs-fixer.cache
1010
.DS_Store
11+
/Documentation-GENERATED-temp/
1112
/*.http
1213
http-client.env.json
1314
/.test-results

‎Documentation/Administration/Configuration/Index.rst‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
.. _configuration:
2+
3+
Configuration
4+
=============
5+
6+
.. attention::
7+
8+
This section is only needed for TYPO3 v9 and v10, as since v11 all
9+
translation configuration is done in the SiteConfiguration instead.
10+
11+
This extension ships a backend module for configuring translations.
12+
For getting the backend

‎Documentation/Administration/Index.rst‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
.. _administration:
2+
3+
==============
4+
Administration
5+
==============
6+
7+
.. toctree::
8+
:maxdepth: 5
9+
:titlesonly:
10+
11+
Installation/Index
12+
Configuration/Index

‎Documentation/Administration/Installation/Index.rst‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
.. include:: /Includes.rst.txt
2+
3+
.. _installation:
4+
5+
Installation
6+
============
7+
8+
The extension needs to be installed as any other extension of TYPO3 CMS. Get the
9+
extension by one of the following methods:
10+
11+
#. **Use composer**: Run
12+
13+
.. code-block:: bash
14+
15+
composer require web-vision/wv_deepltranslate
16+
17+
in your TYPO3 installation.
18+
19+
#. **Get it from the Extension Manager:** Switch to the module :guilabel:`Admin Tools > Extensions`.
20+
Switch to :guilabel:`Get Extensions` and search for the extension key
21+
*wv_deepltranslate* and import the extension from the repository.
22+
23+
#. **Get it from typo3.org:** You can always get current version from `TER`_
24+
by downloading the zip version. Upload the file afterwards in the Extension
25+
Manager.
26+
27+
and :ref:`configure <extensionConfiguration>` it.
28+
29+
.. _TER: https://extensions.typo3.org/extension/wv_deepltranslate
30+
31+
Compatibility
32+
-------------
33+
34+
DeepL Translate supports:
35+
36+
================= ======= =======
37+
DeepL Translate TYPO3 PHP
38+
================= ======= =======
39+
2.3 9-11 >=7.4
40+

‎Documentation/ChangeLog/Index.rst‎

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,6 @@
1-
2-
3-
.. ==================================================
4-
.. FOR YOUR INFORMATION
5-
.. --------------------------------------------------
6-
.. -*- coding: utf-8 -*- with BOM.
7-
8-
.. ==================================================
9-
.. DEFINE SOME TEXTROLES
10-
.. --------------------------------------------------
11-
.. role:: underline
12-
.. role:: typoscript(code)
13-
.. role:: ts(typoscript)
14-
:class: typoscript
15-
.. role:: php(code)
1+
.. include:: /Includes.rst.txt
162

3+
.. _changelog:
174

185
Change Log
196
----------

‎Documentation/Editor/Index.rst‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
.. include:: ../Includes.rst.txt
2+
3+
.. _users-manual:
4+
5+
Users manual
6+
============
7+
8+
Translating content elements
9+
----------------------------
10+
11+
Once the extension is installed and API key provided, we are good to go for
12+
translating content elements. On translating content element, there appears
13+
additional four options apart from normal translate and copy.
14+
15+
* Deepl Translate(auto detect).
16+
* Deepl Translate.
17+
* Google Translate(auto detect).
18+
* Google Translate.
19+
20+
.. figure:: ../Images/UserManual/deepl.png
21+
:height: 450px
22+
:alt: Deepl Options
23+
24+
Deepl translate options
25+
26+
.. figure:: ../Images/UserManual/google.png
27+
:height: 450px
28+
:alt: Google Options
29+
30+
Google translate options
31+
32+
Deepl Module Settings
33+
-------------------------------
34+
35+
The settings module helps to assign the system languages to either DeepL
36+
supported languages or to Google supported languages.
37+
38+
For example you can assign German to Austrian German sys language if you wish.
39+
For assigning a language to a sys language you must enter it's iso code (ISO 639-1).
40+
41+
.. figure:: ../Images/UserManual/settings.png
42+
:width: 800px
43+
:alt: Settings
44+
45+
Module Settings
46+
47+
Translating TCA Records
48+
-----------------------
49+
50+
Deepltranslate supports translation of specific fields of TCA records. It
51+
understands fields which need to be translated, only if their ``l10n_mode``
52+
is set to ``prefixLangTitle``.
53+
54+
Example
55+
-------
56+
57+
Translating fields from ``tx_news``
58+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
59+
60+
Add the fields, you want to auto translate to TCA/Overrides:
61+
``EXT:sitepackage/Configuration/TCA/Overrides/tx_news_domain_model_news.php``
62+
63+
.. code-block:: php
64+
65+
$GLOBALS['TCA']['tx_news_domain_model_news']['columns']['bodytext']['l10n_mode'] = 'prefixLangTitle';
66+
$GLOBALS['TCA']['tx_news_domain_model_news']['columns']['teaser']['l10n_mode'] = 'prefixLangTitle';

‎Documentation/Faq/Index.rst‎

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,11 @@
1-
.. ==================================================
2-
.. FOR YOUR INFORMATION
3-
.. --------------------------------------------------
4-
.. -*- coding: utf-8 -*- with BOM.
5-
6-
.. include:: ../Includes.txt
7-
8-
1+
.. include:: ../Includes.rst.txt
92

103
.. _faq:
114

125
FAQ
136
===
147

15-
16-
What will be the cost for Deepl Api subscription?
8+
What will be the cost for DeepL Api subscription?
179
----------------------------------------------------------------
1810

1911
You can find all the details regarding Deepl Api usage here:
@@ -24,4 +16,5 @@ You can find all the details regarding Deepl Api usage here:
2416
What will be the cost for Google translate Api?
2517
--------------------------------------------------------------
2618

27-
As of now we are using free google translate Api service.There is a character limit of 5000 words per single translation.
19+
As of now we are using free google translate Api service. There is a character
20+
limit of 5000 words per single translation.

Documentation/Images/UserManual/configuration.png renamed to Documentation/Images/Reference/configuration.png

File renamed without changes.

‎Documentation/Includes.rst.txt‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
.. More information about this file:
2+
https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html#includes-rst-txt
3+
4+
.. ----------
5+
.. text roles
6+
.. ----------
7+
8+
.. role:: aspect(emphasis)
9+
.. role:: bash(code)
10+
.. role:: html(code)
11+
.. role:: js(code)
12+
.. role:: php(code)
13+
.. role:: rst(code)
14+
.. role:: sep(strong)
15+
.. role:: sql(code)
16+
17+
.. role:: tsconfig(code)
18+
:class: typoscript
19+
20+
.. role:: typoscript(code)
21+
.. role:: xml(code)
22+
:class: html
23+
24+
.. role:: yaml(code)
25+
26+
.. default-role:: code
27+
28+
.. ---------
29+
.. highlight
30+
.. ---------
31+
32+
.. By default, code blocks use PHP syntax highlighting
33+
34+
.. highlight:: php

0 commit comments

Comments
 (0)