Skip to content

Commit 14fbab0

Browse files
sarahmccarthy123froemken
authored andcommitted
[TASK] Overhaul extension development concepts (#6217)
Releases: main, 13.4
1 parent 4de9b04 commit 14fbab0

File tree

13 files changed

+85
-91
lines changed

13 files changed

+85
-91
lines changed

Documentation/ExtensionArchitecture/FileStructure/Classes/Index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88
Extension folder `Classes` for PHP classes
99
==========================================
1010

11-
Contains all PHP classes. One class per file. Should have sub folders like
11+
Contains all the PHP classes in an extension, with one class per file. Should have subfolders like
1212
:code:`Controller/`, :code:`Domain/`, :code:`Service/` or :code:`View/`.
13-
For more details on class file namings and PHP namespaces, see chapter
13+
For more details on class file naming and PHP namespaces, see chapter
1414
:ref:`namespaces <namespaces>`.
1515

1616
Typical PHP classes in this folder:

Documentation/ExtensionArchitecture/FileStructure/Configuration/Backend/Index.rst

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@
1111
Extension folder `Configuration/Backend`
1212
========================================
1313

14-
The folder :file:`EXT:my_extension/Configuration/Backend/` may contain
15-
configuration that is important within the TYPO3 Backend.
14+
The folder :file:`EXT:my_extension/Configuration/Backend/` contains
15+
configuration that is important in the TYPO3 Backend.
1616

17-
All files in this directory are automatically included during the TYPO3
17+
All files in this directory are automatically included during TYPO3
1818
bootstrap.
1919

2020
.. _extension-configuration-backend-ajaxroutes:
@@ -25,8 +25,7 @@ bootstrap.
2525
:regex: /^.*Configuration\/Backend\/AjaxRoutes\.php$/
2626
:shortDescription: Defines routes for backend Ajax requests
2727

28-
In this file routes for Ajax requests that should be used in the backend can
29-
be defined.
28+
Defines file routes for Ajax requests in the backend.
3029

3130
Read more about :ref:`Using Ajax in the backend <ajax-backend>`.
3231

@@ -40,10 +39,9 @@ bootstrap.
4039
:regex: /^.*Configuration\/Backend\/Routes\.php$/
4140
:shortDescription: Defines routes for backend controllers
4241

43-
This file maps the URI paths used in the backend to the controller that should
44-
be used.
42+
This file maps URI paths in the backend to controllers.
4543

46-
Most backend routes defined in the TYPO3 core can be found in the following
44+
Backend routes defined in the TYPO3 core are in the following
4745
file, which you can use as example:
4846

4947
:t3src:`backend/Configuration/Backend/Routes.php`
@@ -58,6 +56,6 @@ bootstrap.
5856
:regex: /^.*Configuration\/Backend\/Modules\.php$/
5957
:shortDescription: Defines the backend module configuration
6058

61-
This file is used for the
59+
This file is used for
6260
:ref:`Backend module configuration <backend-modules-configuration>`. See that
6361
chapter for details.

Documentation/ExtensionArchitecture/FileStructure/Configuration/Extbase/Persistence/Index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
:file:`Persistence`
77
===================
88

9-
This folder can contain the following files:
9+
This folder contains the following file:
1010

1111
.. _extension-configuration-extbase-persistence-classes:
1212

@@ -16,8 +16,8 @@ This folder can contain the following files:
1616
:regex: /^.*Configuration\/Extbase\/Persistence\/Classes\.php$/
1717
:shortDescription: Contains the mapping between a database table and its Extbase model
1818

19-
In the file :file:`EXT:my_extension/Configuration/Extbase/Persistence/Classes.php` the
20-
mapping between a database table and its model can be configured. The mapping
19+
:file:`EXT:my_extension/Configuration/Extbase/Persistence/Classes.php` is
20+
used to configure mapping between a database table and its model. The mapping
2121
in this file overrides the automatic mapping by naming convention.
2222

2323
.. seealso::

Documentation/ExtensionArchitecture/FileStructure/Configuration/Icons.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
:regex: /^.*Configuration\/Icons\.php$/
1515
:shortDescription: Registration of custom icons
1616

17-
In this file custom icons can be registered in the
17+
This file registers custom icons to the
1818
:php:`\TYPO3\CMS\Core\Imaging\IconRegistry`.
1919

2020
See the :ref:`Icon API <icon>` for details.

Documentation/ExtensionArchitecture/FileStructure/Configuration/Index.rst

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,15 @@
1111
Extension folder `Configuration`
1212
================================
1313

14-
The folder :file:`EXT:my_extension/Configuration/` may contain
14+
The folder :file:`EXT:my_extension/Configuration/` contains
1515
configuration of different types.
1616

17-
Some of the sub directories in here have reserved names with special meanings.
17+
Most subdirectories have reserved names.
1818

19-
All files in this directory and in the sub directories :file:`TCA` and
20-
:file:`Backend` are automatically included during the TYPO3 bootstrap.
19+
Files in the root of this directory and in the :file:`TCA` and
20+
:file:`Backend` subdirectories are automatically included during TYPO3 bootstrap.
2121

22-
The following files and folders are commonly found in the :file:`Configuration`
23-
folder:
22+
The typical file structure is:
2423

2524

2625
.. directory-tree::

Documentation/ExtensionArchitecture/FileStructure/Configuration/PageTsconfig.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
Page TSconfig can be set using
1313
`the site as Page TSconfig provider <https://docs.typo3.org/permalink/t3tsref:include-static-page-tsconfig-per-site>`_
1414

15-
Only put page TSconfig in this file which absolutely has to be set globally.
15+
Only put global page TSconfig in this file.
1616

1717
.. typo3:file:: page.tsconfig
1818
:scope: extension
@@ -21,7 +21,7 @@
2121
:shortDescription: Global page TSconfig
2222

2323
In this file global page TSconfig can be stored. It will be automatically
24-
included for all pages.
24+
included in all pages.
2525

2626
For details see
2727
:ref:`Setting the page TSconfig globally <t3tsref:pagesettingdefaultpagetsconfig>`.

Documentation/ExtensionArchitecture/FileStructure/Configuration/ServicesYaml.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
`Services.yaml`
1010
===============
1111

12-
It is possible to use a YAML or PHP format:
12+
It is possible to use YAML or PHP format:
1313

1414
.. typo3:file:: Services.yaml
1515
:scope: extension
@@ -23,7 +23,7 @@ It is possible to use a YAML or PHP format:
2323
:regex: /^.*Configuration\/Services\.php$/
2424
:shortDescription: Dependency injection service configuration
2525

26-
Services can be configured in this file. TYPO3 uses it for:
26+
This file can configure services. TYPO3 uses it for:
2727

2828
* :ref:`Dependency Injection <configure-dependency-injection-in-extensions>`
2929
* :ref:`Event Listeners <EventDispatcherRegistration>`

Documentation/ExtensionArchitecture/FileStructure/Configuration/Sets/Index.rst

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,12 @@ Extension folder `Configuration/Sets`
1111
`Site sets <https://docs.typo3.org/permalink/t3coreapi:site-sets>`_ have
1212
been introduced.
1313

14-
In this directory TYPO3 extensions can provide their
14+
This directory contains an extension's
1515
`Site sets <https://docs.typo3.org/permalink/t3coreapi:site-sets>`_.
1616

17-
Each set must be saved in its own directory and have at least a file called
18-
:file:`config.yaml`.
17+
Each set must be in its own directory and consist of at least a
18+
:file:`config.yaml` file.
19+
1920

2021
.. _extension-configuration-sets-config-yaml:
2122

@@ -25,8 +26,8 @@ Each set must be saved in its own directory and have at least a file called
2526
:regex: /^.*Configuration\/Sets\/[\w\-]+\/config\.yaml$/
2627
:shortDescription: Contains the definition of a site set. Mandatory.
2728

28-
Contains the `definition of a site set <https://docs.typo3.org/permalink/t3coreapi:site-sets-definition>`_
29-
and its dependencies.
29+
Contains the `definition of the site set <https://docs.typo3.org/permalink/t3coreapi:site-sets-definition>`_
30+
and any dependencies.
3031

3132
Example:
3233

@@ -40,8 +41,8 @@ Example:
4041
:regex: /^.*Configuration\/Sets\/[\w\-]+\/settings\.yaml$/
4142
:shortDescription: Override settings defined by other sets.
4243

43-
In this file an extension can override settings defined by other sets. For
44-
example :ref:`Settings provided by site set "Fluid Styled Content" <typo3/cms-fluid-styled-content:site-set-fluid-styled-content-settings>`:
44+
In this file an extension can override settings defined by other sets, for
45+
example, :ref:`settings defined in the "Fluid Styled Content" site set <typo3/cms-fluid-styled-content:site-set-fluid-styled-content-settings>`:
4546

4647
.. literalinclude:: /ApiOverview/SiteHandling/_Sets/_site-package/_settings-map.yaml
4748
:language: yaml
@@ -66,12 +67,12 @@ Example:
6667
:regex: /^.*Configuration\/Sets\/[\w\-]+\/setup\.typoscript$/
6768
:shortDescription: Provides frontend TypoScript for sites depending on this set.
6869

69-
This file contains the Frontend :ref:`TypoScript <t3tsref:guide-overview>`
70-
that the set should provide. If the
70+
This file contains a set's Frontend
71+
:ref:`TypoScript <t3tsref:guide-overview>`. If the
7172
extension keeps its TypoScript in folder `TypoScript <https://docs.typo3.org/permalink/t3coreapi:extension-configuration-typoscript>`_
72-
for backward compatibility reasons this file **should** contain an import of
73-
file :file:`Configuration/TypoScript/setup.typoscript` for the main set of the
74-
extension:
73+
for backward compatibility reasons, this file **should** import
74+
the :file:`Configuration/TypoScript/setup.typoscript` file in the main
75+
extension set:
7576

7677
.. code-block:: typoscript
7778
:caption: EXT:my_extension/Configuration/Sets/MySet/setup.typoscript
@@ -87,8 +88,8 @@ Example:
8788
:regex: /^.*Configuration\/Sets\/[\w\-]+\/constants\.typoscript$/
8889
:shortDescription: Provides frontend TypoScript constants for sites depending on this set.
8990

90-
This file contains the Frontend TypoScript Constants that the set should
91-
provide. This file can be used if your extension depends on other extensions
91+
This file contains the Frontend TypoScript Constants in the set.
92+
This file should be used if the extension depends on other extensions
9293
that still rely on TypoScript constants.
9394

9495
.. _extension-configuration-sets-page-tsconfig:
@@ -100,4 +101,4 @@ Example:
100101
:shortDescription: Provides page TSconfig (backend TypoScript) for sites depending on this set.
101102

102103
This file contains the :ref:`Page TSconfig <t3tsref:pagetoplevelobjects>`
103-
(backend TypoScript) that the set should provide.
104+
(backend TypoScript).

Documentation/ExtensionArchitecture/FileStructure/Configuration/TCA/Index.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@
1010
Extension folder `Configuration/TCA`
1111
====================================
1212

13-
The folder :file:`EXT:my_extension/Configuration/TCA/` may contain or override
13+
The folder :file:`EXT:my_extension/Configuration/TCA/` can contain or override
1414
:ref:`TCA (Table Configuration Array) <t3tca:introduction>` data.
1515

16-
All files in this directory are automatically included during the TYPO3
16+
All files in this directory are automatically included during TYPO3
1717
:ref:`bootstrap <bootstrapping>`.
1818

1919
.. versionadded:: 12.0
20-
Files within :file:`Configuration/TCA/` files are loaded within a dedicated scope.
21-
This means that variables defined in those files cannot leak to any other
22-
TCA file during the TCA compilation process.
20+
Files in :file:`Configuration/TCA/` are loaded in a dedicated scope.
21+
This means that variables defined in the files cannot leak to other
22+
TCA files during the TCA compilation process.
2323

2424
.. note::
2525
In TYPO3 v11 and below, variables declared in these files were in a shared scope,

Documentation/ExtensionArchitecture/FileStructure/Configuration/TsConfig/Index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@
99
.. versionadded:: 13.1
1010

1111
Page TSconfig can be set using
12-
`the site et as Page TSconfig provider <https://docs.typo3.org/permalink/t3tsref:include-static-page-tsconfig-per-site>`_
12+
`the site set as a Page TSconfig provider <https://docs.typo3.org/permalink/t3tsref:include-static-page-tsconfig-per-site>`_
1313

14-
Default user TSconfig can be provided in file
14+
Default user TSconfig can be put in the file
1515
:ref:`extension-configuration-user_tsconfig`.
1616

1717
.. typo3:file:: something.tsconfig

0 commit comments

Comments
 (0)