[TASK] Improve descriptions on how to provide TypoScript (#1438)

linawolf · web-flow · commit 0cb3594b2c00 · 2024-11-23T16:14:36.000+01:00
Releases: main, 13.4
diff --git a/Documentation/UsingSetting/AddTypoScriptWithExtensions.rst b/Documentation/UsingSetting/AddTypoScriptWithExtensions.rst
@@ -1,10 +1,12 @@
+:navigation-title: TypoScript in Extensions
+
 ..  include:: /Includes.rst.txt
 ..  index:: TypoScript in extensions
 ..  _extdev-add-typoscript:
 
-================================
-Add TypoScript in your extension
-================================
+================================================
+Provide frontend TypoScript in a TYPO3 extension
+================================================
 
 ..  versionchanged:: 13.1
     TypoScript on a per-site basis can now be included via
@@ -18,8 +20,8 @@ Add TypoScript in your extension
 ..  index:: TypoScript in extensions; File locations
 ..  _extdev-add-typoscript-extension:
 
-Create TypoScript files in your extension
-=========================================
+Provide TypoScript in your extension or site package
+====================================================
 
 TypoScript files **must** have the ending :file:`.typoscript`.
 
@@ -28,10 +30,11 @@ extension. Read more about how to
 :ref:`provide the TypoScript as set for TYPO3 v13 and above <extdev-add-typoscript-sets>`
 and :ref:`how to provide TypoScript for both TYPO3 v13 and v12 <extdev-add-typoscript-sets-v12>`.
 
-*   :file:`constants.typoscript` contains the constants
-*   :file:`setup.typoscript` contains the TypoScript setup
+*   :file:`constants.typoscript` contains the frontend TypoScript constants
+*   :file:`setup.typoscript` contains the frontend TypoScript
 
 ..  _extdev-add-typoscript-sets:
+..  _extdev-add-typoscript-sets-typoscript:
 
 TypoScript provided as site set (only TYPO3 v13.1 and above)
 ============================================================
@@ -41,10 +44,6 @@ The file structure of the extension could, for example look like this:
 ..  directory-tree::
     :show-file-icons: true
 
-    *   Classes
-
-        *   ...
-
     *   Configuration
 
         *   Sets
@@ -93,103 +92,209 @@ The sub set for an optional feature
     :language: yaml
     :caption: EXT:my_extension/Configuration/Sets/MyExtensionWithACoolFeature/config.yaml
 
-..  _extdev-add-typoscript-sets-typoscript:
 
-TypoScript files provided by the sets
--------------------------------------
+..  _extdev-add-typoscript-sets-override:
+
+Overriding the TypoScript
+-------------------------
 
-The TypoScript placed in the same folder like the set, contains your
-configurations.
+The TypoScript provided in the site set will be loaded exactly once and respect
+the dependencies defined in the site set configuration. Therefore if you
+have to override the frontend TypoScript of another site set your site set
+should depend on the other site set:
 
+..  code-block:: yaml
+    :caption: packages/my_site_package/Configuration/Sets/MySitePackage/config.yaml
+
+    name: my-vendor/my-site-package
+    label: My Set
+    dependencies:
+      - my-vendor/my-other-set
+      - some-vendor/some-extension
+
+Your extension can then safely override frontend TypoScript of the `some_extension`,
+for example:
+
+..  code-block:: typoscript
+    :caption: packages/my_site_package/Configuration/Sets/MySitePackage/setup.typoscript
+
+    plugin.some_extension_pi1.settings.someSetting = Special setting
+
+..  _extdev-add-typoscript-sets-v12-static_includes:
+..  _extdev-static-includes:
 ..  _extdev-add-typoscript-sets-v12:
 
-TypoScript provided by extensions supporting TYPO3 v12.4 and v13
-================================================================
+Supporting both site sets and TypoScript records
+================================================
 
-When an extension provides TypoScript and should be compatible with both
-TYPO3 v12.4 and v13, you can provide site sets but still support including
-the TypoScript in the :sql:`sys_template` record via `static_file_include`'s.
+..  versionchanged:: 13.1
+    With TYPO3 13.1
+    `site sets as TypoScript provider <https://docs.typo3.org/permalink/t3coreapi:site-sets-typoscript>`_
+    where introduced. Existing extensions **should** support site sets as well as
+    TypoScript records for backward compatibility reasons.
+
+..  warning::
+    For historic reasons you might still see filenames like :file:`setup.ts` and
+    :file:`setup.txt`. These files **cannot** be included with the
+    :ref:`@import <t3tsref:typoscript-syntax-import>` syntax. All frontend
+    TypoScript files **must** end on `.typoscript`.
+
+.. _extension-configuration-typoscript-set-record-one:
+
+One TypoScript include set
+--------------------------
 
-The files in the sets are the same as in the
-:ref:`example for TYPO3 v13 only <extdev-add-typoscript-sets>`.
+If your extension supported one static file include you should provide the same
+files in your main site set as well:
 
-The extended file structure of the extension could, for example look like this:
+.. code-block:: php
+   :caption: EXT:my_extension/Configuration/TCA/Overrides/sys_template.php (before and after)
+
+   \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addStaticFile(
+       'my_extension',
+       'Configuration/TypoScript/',
+       'Examples TypoScript'
+   );
+
+In your main site set provide the same files that where provided as includes
+by :php:`\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addStaticFile`
+until now:
 
 ..  directory-tree::
+    :level: 3
     :show-file-icons: true
 
-    *   Classes
+    *   packages/my_extension/Configuration/
 
-        *   ...
+        *   Sets
 
-    *   Configuration
+            *   MySet
 
-        *   Sets
+                *   config.yaml
+                *   constants.typoscript
+                *   setup.typoscript
 
-            *   MyExtension
 
-                *   :ref:`config.yaml <extdev-add-typoscript-sets-main>`
-                *   :ref:`constants.typoscript <extdev-add-typoscript-sets-typoscript>`
-                *   :ref:`setup.typoscript <extdev-add-typoscript-sets-typoscript>`
+        *   TypoScript
 
-            *   MyExtensionWithACoolFeature
+            *   constants.typoscript
+            *   setup.typoscript
 
-                *   :ref:`config.yaml <extdev-add-typoscript-sets-feature>`
-                *   :ref:`setup.typoscript <extdev-add-typoscript-sets-typoscript>`
+..  code-block:: typoscript
+    :caption: packages/my_extension/Configuration/Sets/MySet/constants.typoscript
 
-        *   TCA
+    @import 'EXT:my_extension/Configuration/TypoScript/setup.typoscript'
 
-            *   Overrides
+..  code-block:: typoscript
+    :caption: packages/my_extension/Configuration/Sets/MySet/setup.typoscript
 
-                sys_template.php
+    @import 'EXT:my_extension/Configuration/TypoScript/setup.typoscript'
 
+.. _extension-configuration-typoscript-set-record-multiple:
 
-    *   Resources
+Multiple TypoScript include sets
+--------------------------------
 
-        *   ...
+If there should be more then one set of TypoScript templates that may be
+included, they were usually stored in sub folders of
+:path:`Configuration/TypoScript` until now.
 
-    *   composer.json
-    *   ...
+When introducing site sets usually one site set per TypoScript record include
+set is needed:
 
+..  directory-tree::
+    :level: 3
+    :show-file-icons: true
 
-..  _extdev-add-typoscript-sets-v12-static_includes:
-..  _extdev-static-includes:
+    *   packages/my_extension/Configuration
+
+            *   TypoScript
+
+                *   SpecialFeature1
+
+                    *   constants.typoscript
+                    *   setup.typoscript
 
-Only when supporting TYPO3 v12.4: Make TypoScript available for static includes
--------------------------------------------------------------------
+                *   SpecialFeature2
 
-Make TypoScript available for static includes (only needed if your extensions aims to support TYPO3 v12.4):
+                    *   setup.typoscript
 
-..  literalinclude:: _Sets/_TcaOverridesSystemplateV12.php
-    :language: php
-    :caption: EXT:my_extension/Configuration/TCA/Overrides/sys_template.php
+                *   constants.typoscript
+                *   setup.typoscript
 
-If you include the TypoScript this way, it will not be automatically loaded.
-You MUST load it by adding the static include in the :guilabel:`Web > Template`
-module in the backend, see :ref:`static-includes`. This has the advantage of
-better configurability.
+            *   Sets
 
-This will load your constants and your setup once the template is
-included statically.
+                *   MyMainSet
+
+                    *   config.yaml
+                    *   constants.typoscript
+                    *   setup.typoscript
+
+                *   MySpecialFeature1Set
+
+                    *   config.yaml
+                    *   constants.typoscript
+                    *   setup.typoscript
+
+                *   MySpecialFeature2Set
+
+                    *   config.yaml
+                    *   setup.typoscript
+
+For backward compability reasons :php:`ExtensionManagementUtility::addStaticFile`
+still needs to be called for each folder that should be available in the TypoScript
+template record:
+
+.. code-block:: php
+   :caption: EXT:my_extension/Configuration/TCA/Overrides/sys_template.php
+
+   \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addStaticFile(
+       'my_extension',
+       'Configuration/TypoScript/',
+       'My Extension - Main TypoScript'
+   );
+
+   \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addStaticFile(
+       'my_extension',
+       'Configuration/TypoScript/Example1/',
+       'My Extension - Additional example 1'
+   );
+
+   \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addStaticFile(
+       'my_extension',
+       'Configuration/TypoScript/SpecialFeature2/',
+       'My Extension - Some special feature'
+   );
+
+Each site set then provides the TypoScript files the according location by
+importing it, for example:
+
+..  code-block:: typoscript
+    :caption: packages/my_extension/Configuration/Sets/MySet/setup.typoscript
+
+    @import 'EXT:my_extension/Configuration/TypoScript/MySpecialFeature2Set/setup.typoscript'
 
 ..  index:: TypoScript in extensions; Load always
 ..  _extdev-always-load:
 
 Make TypoScript available (always load)
 =======================================
 
-Only do this, if your TypoScript must really be always loaded in your site.
-If this is not the case, use the method described in the previous section
-:ref:`extdev-add-typoscript-sets`.
+
+Use :php:`ExtensionManagementUtility::addTypoScript` if the frontend
+TypoScript **must** be available in backend modules without page context,
+for example to :ref:`register the YAML of the EXT:form system extension
+for the backend <typo3/cms-form:concepts-configuration-yamlregistration-backend>`.
 
 ..  literalinclude:: _Sets/_ext_localconf.php
-    :language: php
     :caption: EXT:my_extension/ext_localconf.php
 
-It is also possible to put your TypoScript in a file called
-:ref:`ext_typoscript_setup.typoscript <t3coreapi:ext_typoscript_setup_typoscript>`
-or :ref:`ext_typoscript_constants.typoscript <t3coreapi:ext_typoscript_constants_typoscript>`
-(for constants).
+..  warning::
+    While the content from the files
+    `ext_typoscript_setup.typoscript <https://docs.typo3.org/permalink/t3coreapi:ext_typoscript_setup_typoscript>`_
+    and `ext_typoscript_constants.typoscript <https://docs.typo3.org/permalink/t3coreapi:ext_typoscript_constants_typoscript>`_
+    is loaded by default in sites based on **TypoScript records** it is not
+    loaded in sites depending on **site sets as TypoScript providers**.
 
 
 More information
diff --git a/Documentation/UsingSetting/Entering.rst b/Documentation/UsingSetting/Entering.rst
@@ -1,4 +1,5 @@
 :navigation-title: Backend Module
+
 ..  include:: /Includes.rst.txt
 ..  index:: TypoScript; TypoScript backend module
 ..  _typoscript_module:
diff --git a/Documentation/UsingSetting/Index.rst b/Documentation/UsingSetting/Index.rst
@@ -1,7 +1,9 @@
+:navigation-title: Usage
 ..  include:: /Includes.rst.txt
 ..  index:: TypoScript; Using and setting
 ..  _using-and-setting:
 
+============================
 Using and setting TypoScript
 ============================
 
@@ -19,8 +21,8 @@ The TypoScript template configuration can be viewed and edited in the
     :titlesonly:
 
     SiteTypoScriptProvider
-    Entering
     AddTypoScriptWithExtensions
+    Entering
     AccessTypoScriptWithExtensions
     Constants
     Register
diff --git a/Documentation/UsingSetting/SiteTypoScriptProvider.rst b/Documentation/UsingSetting/SiteTypoScriptProvider.rst
@@ -1,3 +1,5 @@
+:navigation-title: TypoScript in Sites
+
 ..  include:: /Includes.rst.txt
 ..  _typoscript-site-sets:
 
diff --git a/Documentation/UsingSetting/_Sets/_ext_localconf.php b/Documentation/UsingSetting/_Sets/_ext_localconf.php
@@ -7,5 +7,13 @@
 ExtensionManagementUtility::addTypoScript(
     'my_extension',
     'setup',
-    "@import 'EXT:my_extension/Configuration/TypoScript/setup.typoscript'",
+    '
+        module.tx_form {
+            settings {
+                yamlConfigurations {
+                    100 = EXT:my_site_package/Configuration/Form/CustomFormSetup.yaml
+                }
+            }
+        }
+    ',
 );

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`:navigation-title: Backend Module`
	`2`	`+`
`2`	`3`	`.. include:: /Includes.rst.txt`
`3`	`4`	`.. index:: TypoScript; TypoScript backend module`
`4`	`5`	`.. _typoscript_module:`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+:navigation-title: TypoScript in Sites`
	`2`	`+`
`1`	`3`	`.. include:: /Includes.rst.txt`
`2`	`4`	`.. _typoscript-site-sets:`
`3`	`5`