From c2ad2f64c48854ab21da1725279e972fa9456b76 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lukas=20K=C3=B6hler?= <noreply@example.com>
Date: Tue, 24 Jan 2023 08:24:07 +0000
Subject: [PATCH] [DOCS] Update finisher documentation
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Update the finisher documentation to accomodate changes
made within the deprecation notices:
- remove mixins from finisher backend configuration
- add note to explain "mixins" have been removed in TYPO3 v11
- add a header as well as a removeButton in Backend UI config
to restore functionality
- add a reminder to clear all caches to help newbies to see their
changes while testing
Releases: main
Resolves: #99691
Change-Id: Icad673f1e23f595b6ffbae9afef8d01425bd1ea2
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/77556
Reviewed-by: Björn Jacob <bjoern.jacob@tritum.de>
Tested-by: core-ci <typo3@b13.com>
Tested-by: Christian Kuhn <lolli@schwarzbu.ch>
Tested-by: Björn Jacob <bjoern.jacob@tritum.de>
Reviewed-by: Christian Kuhn <lolli@schwarzbu.ch>
---
.../I/Concepts/Finishers/Index.rst | 21 +++++++++++++------
1 file changed, 15 insertions(+), 6 deletions(-)
diff --git a/typo3/sysext/form/Documentation/I/Concepts/Finishers/Index.rst b/typo3/sysext/form/Documentation/I/Concepts/Finishers/Index.rst
index 70cda33713be..d4b43af9b23a 100644
--- a/typo3/sysext/form/Documentation/I/Concepts/Finishers/Index.rst
+++ b/typo3/sysext/form/Documentation/I/Concepts/Finishers/Index.rst
@@ -556,20 +556,25 @@ following to the backend yaml setup:
25:
identifier: 'CustomFinisher'
editors:
- __inheritances:
- 10: 'TYPO3.CMS.Form.mixins.formElementMixins.BaseCollectionEditorsMixin'
100:
+ # add expandable header area
+ identifier: header
label: "Custom Finisher"
- # custom field (input, required)
+ templateName: Inspector-CollectionElementHeaderEditor
+ 105:
+ # add remove button
+ identifier: removeButton
+ templateName: Inspector-RemoveElementEditor
110:
+ # add a field defined as a TextEditor
identifier: 'customField'
templateName: 'Inspector-TextEditor'
label: 'Custom Field'
propertyPath: 'options.customField'
propertyValidators:
10: 'NotEmpty'
- # email field
120:
+ # add another TextEditor
identifier: 'email'
templateName: 'Inspector-TextEditor'
label: 'Subscribers email'
@@ -578,7 +583,6 @@ following to the backend yaml setup:
propertyValidators:
10: 'NotEmpty'
20: 'FormElementIdentifierWithinCurlyBracesInclusive'
-
finishersDefinition:
CustomFinisher:
formEditor:
@@ -600,8 +604,13 @@ following to the backend yaml setup:
label: 'Subscribers email'
config:
type: 'text'
+
+Keep in mind that ``mixins`` **have been removed in TYPO3 v11** (see `#89742 <https://docs.typo3.org/c/typo3/cms-core/main/en-us/Changelog/10.2/Deprecation-89742-FormMixins.html>`__).
+Therefore, the header area as well as the remove button of the finisher have to be added manually
+(as shown in the example above).
-Make sure the setup file is registered in the backend:
+Make sure the setup file is registered in the backend and that you have cleared all caches in order
+to get all of your changes applied.
.. code-block:: typoscript
--
GitLab