Skip to content

Commit

Permalink
[DOCS] Rename .rst includes to .rst.txt
Browse files Browse the repository at this point in the history
All files ending on .rst are interpreted as documents in both the new and old rendering. This leads to warnings and errors. So all files to be included are renamend to .rst.txt as is standard.

Additionally include files should not include the Includes.rst.txt as it is already included in the main file. Those includes are removed.

Resolves: #103353
Releases: main, 12.4
Change-Id: I42850eddf788fabf04e8f51b88e4f053d947a63a
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/83393
Tested-by: Garvin Hicking <gh@faktor-e.de>
Reviewed-by: Garvin Hicking <gh@faktor-e.de>
Tested-by: core-ci <typo3@b13.com>
Reviewed-by: Lina Wolf <112@linawolf.de>
Tested-by: Lina Wolf <112@linawolf.de>
  • Loading branch information
linawolf committed Mar 9, 2024
1 parent d90f3d2 commit 6a0740b
Show file tree
Hide file tree
Showing 934 changed files with 1,143 additions and 1,143 deletions.
@@ -1,4 +1,4 @@
.. include:: /Includes.rst.txt


getRootForm()
'''''''''''''
Expand Down
@@ -1,4 +1,4 @@
.. include:: /Includes.rst.txt


setIdentifier()
'''''''''''''''
Expand Down
@@ -1,4 +1,4 @@
.. include:: /Includes.rst.txt


setLabel()
''''''''''
Expand Down
@@ -1,4 +1,4 @@
.. include:: /Includes.rst.txt


setOptions()
''''''''''''
Expand Down
186 changes: 93 additions & 93 deletions typo3/sysext/form/Documentation/D/FrontendRendering/Index.rst

Large diffs are not rendered by default.

Expand Up @@ -131,7 +131,7 @@ implementationClassName
- :ref:`"Custom finisher implementations"<concepts-finishers-customfinisherimplementations>`

:aspect:`Description`
.. include:: properties/implementationClassName.rst
.. include:: properties/implementationClassName.rst.txt


.. _prototypes.<prototypeIdentifier>.finishersdefinition.<finisheridentifier>.options:
Expand Down Expand Up @@ -240,7 +240,7 @@ formeditor.iconIdentifier
ToDo
:aspect:`Description`
.. include:: properties/iconIdentifier.rst
.. include:: properties/iconIdentifier.rst.txt


.. _prototypes.<prototypeIdentifier>.finishersdefinition.<finisheridentifier>.formeditor.label:
Expand All @@ -267,7 +267,7 @@ formeditor.label
- :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>`

:aspect:`Description`
.. include:: properties/label.rst
.. include:: properties/label.rst.txt


.. _prototypes.<prototypeIdentifier>.finishersdefinition.<finisheridentifier>.formeditor.predefineddefaults:
Expand All @@ -294,7 +294,7 @@ formeditor.predefinedDefaults
ToDo
:aspect:`Description`
.. include:: properties/predefinedDefaults.rst
.. include:: properties/predefinedDefaults.rst.txt


.. _prototypes.<prototypeIdentifier>.finishersdefinition.<finisheridentifier>.formengine:
Expand Down Expand Up @@ -348,7 +348,7 @@ FormEngine.label
- :ref:`"Translate form plugin settings"<concepts-formplugin-translation-formengine>`

:aspect:`Description`
.. include:: properties/formEngine/label.rst
.. include:: properties/formEngine/label.rst.txt


.. _prototypes.<prototypeIdentifier>.finishersdefinition.<finisheridentifier>.FormEngine.elements:
Expand All @@ -375,7 +375,7 @@ FormEngine.elements
- :ref:`"Translate form plugin settings"<concepts-formplugin-translation-formengine>`

:aspect:`Description`
.. include:: properties/formEngine/elements.rst
.. include:: properties/formEngine/elements.rst.txt


.. _prototypes.<prototypeidentifier>.finishersdefinition.<finisheridentifier>-concreteconfigurations:
Expand Down
Expand Up @@ -43,7 +43,7 @@ implementationClassName
- :ref:`"Custom finisher implementations"<concepts-finishers-customfinisherimplementations>`

:aspect:`Description`
.. include:: ../properties/implementationClassName.rst
.. include:: ../properties/implementationClassName.rst.txt


.. _prototypes.<prototypeIdentifier>.finishersdefinition.closure.options.closure:
Expand Down Expand Up @@ -109,7 +109,7 @@ formeditor.iconIdentifier
ToDo
:aspect:`Description`
.. include:: ../properties/iconIdentifier.rst
.. include:: ../properties/iconIdentifier.rst.txt


.. _prototypes.<prototypeIdentifier>.finishersdefinition.closure.formeditor.label:
Expand Down Expand Up @@ -146,7 +146,7 @@ formeditor.label
- :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>`

:aspect:`Description`
.. include:: ../properties/label.rst
.. include:: ../properties/label.rst.txt


.. _prototypes.<prototypeIdentifier>.finishersdefinition.closure.formeditor.predefineddefaults:
Expand Down Expand Up @@ -183,4 +183,4 @@ formeditor.predefinedDefaults
ToDo
:aspect:`Description`
.. include:: ../properties/predefinedDefaults.rst
.. include:: ../properties/predefinedDefaults.rst.txt
Expand Up @@ -42,7 +42,7 @@ implementationClassName
- :ref:`"Custom finisher implementations"<concepts-finishers-customfinisherimplementations>`

:aspect:`Description`
.. include:: ../properties/implementationClassName.rst
.. include:: ../properties/implementationClassName.rst.txt


.. _prototypes.<prototypeIdentifier>.finishersdefinition.confirmation.options.message:
Expand Down Expand Up @@ -266,7 +266,7 @@ formeditor.iconIdentifier
ToDo
:aspect:`Description`
.. include:: ../properties/iconIdentifier.rst
.. include:: ../properties/iconIdentifier.rst.txt


.. _prototypes.<prototypeIdentifier>.finishersdefinition.confirmation.formeditor.label:
Expand Down Expand Up @@ -303,7 +303,7 @@ formeditor.label
- :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>`

:aspect:`Description`
.. include:: ../properties/label.rst
.. include:: ../properties/label.rst.txt


.. _prototypes.<prototypeIdentifier>.finishersdefinition.confirmation.formeditor.predefineddefaults:
Expand Down Expand Up @@ -340,5 +340,5 @@ formeditor.predefinedDefaults
ToDo
:aspect:`Description`
.. include:: ../properties/predefinedDefaults.rst
.. include:: ../properties/predefinedDefaults.rst.txt

Expand Up @@ -76,7 +76,7 @@ formeditor.iconIdentifier
ToDo
:aspect:`Description`
.. include:: ../properties/iconIdentifier.rst
.. include:: ../properties/iconIdentifier.rst.txt


.. _prototypes.<prototypeIdentifier>.finishersdefinition.deleteuploads.formeditor.label:
Expand Down Expand Up @@ -110,5 +110,5 @@ formeditor.label
- :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>`

:aspect:`Description`
.. include:: ../properties/label.rst
.. include:: ../properties/label.rst.txt

Expand Up @@ -42,7 +42,7 @@ implementationClassName
- :ref:`"Custom finisher implementations"<concepts-finishers-customfinisherimplementations>`

:aspect:`Description`
.. include:: ../properties/implementationClassName.rst
.. include:: ../properties/implementationClassName.rst.txt


.. _prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.options.subject:
Expand Down Expand Up @@ -515,7 +515,7 @@ formeditor.iconIdentifier
ToDo
:aspect:`Description`
.. include:: ../properties/iconIdentifier.rst
.. include:: ../properties/iconIdentifier.rst.txt


.. _prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.formeditor.label:
Expand Down Expand Up @@ -549,7 +549,7 @@ formeditor.label
- :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>`

:aspect:`Description`
.. include:: ../properties/label.rst
.. include:: ../properties/label.rst.txt


.. _prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.formeditor.predefineddefaults:
Expand Down Expand Up @@ -597,7 +597,7 @@ formeditor.predefinedDefaults
ToDo
:aspect:`Description`
.. include:: ../properties/predefinedDefaults.rst
.. include:: ../properties/predefinedDefaults.rst.txt


.. _prototypes.<prototypeIdentifier>.finishersdefinition.emailtoreceiver.formengine.label:
Expand Down Expand Up @@ -630,7 +630,7 @@ FormEngine.label
- :ref:`"Translate form plugin settings"<concepts-formplugin-translation-formengine>`

:aspect:`Description`
.. include:: ../properties/formEngine/label.rst
.. include:: ../properties/formEngine/label.rst.txt


@ToDo
Expand Down Expand Up @@ -781,4 +781,4 @@ FormEngine.elements
- :ref:`"Translate form plugin settings"<concepts-formplugin-translation-formengine>`

:aspect:`Description`
.. include:: ../properties/formEngine/elements.rst
.. include:: ../properties/formEngine/elements.rst.txt
Expand Up @@ -42,7 +42,7 @@ implementationClassName
- :ref:`"Custom finisher implementations"<concepts-finishers-customfinisherimplementations>`

:aspect:`Description`
.. include:: ../properties/implementationClassName.rst
.. include:: ../properties/implementationClassName.rst.txt


.. _prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.options.subject:
Expand Down Expand Up @@ -515,7 +515,7 @@ formeditor.iconIdentifier
ToDo
:aspect:`Description`
.. include:: ../properties/iconIdentifier.rst
.. include:: ../properties/iconIdentifier.rst.txt


.. _prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.formeditor.label:
Expand Down Expand Up @@ -549,7 +549,7 @@ formeditor.label
- :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>`

:aspect:`Description`
.. include:: ../properties/label.rst
.. include:: ../properties/label.rst.txt


.. _prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.formeditor.predefineddefaults:
Expand Down Expand Up @@ -597,7 +597,7 @@ formeditor.predefinedDefaults
ToDo
:aspect:`Description`
.. include:: ../properties/predefinedDefaults.rst
.. include:: ../properties/predefinedDefaults.rst.txt


.. _prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.formengine.label:
Expand Down Expand Up @@ -630,7 +630,7 @@ FormEngine.label
- :ref:`"Translate form plugin settings"<concepts-formplugin-translation-formengine>`

:aspect:`Description`
.. include:: ../properties/formEngine/label.rst
.. include:: ../properties/formEngine/label.rst.txt


.. _prototypes.<prototypeIdentifier>.finishersdefinition.emailtosender.formengine.elements:
Expand Down Expand Up @@ -780,4 +780,4 @@ FormEngine.elements
- :ref:`"Translate form plugin settings"<concepts-formplugin-translation-formengine>`

:aspect:`Description`
.. include:: ../properties/formEngine/elements.rst
.. include:: ../properties/formEngine/elements.rst.txt
Expand Up @@ -42,7 +42,7 @@ implementationClassName
- :ref:`"Custom finisher implementations"<concepts-finishers-customfinisherimplementations>`

:aspect:`Description`
.. include:: ../properties/implementationClassName.rst
.. include:: ../properties/implementationClassName.rst.txt


.. _prototypes.<prototypeIdentifier>.finishersdefinition.flashmessage.options.messagebody:
Expand Down Expand Up @@ -256,7 +256,7 @@ formeditor.iconIdentifier
ToDo
:aspect:`Description`
.. include:: ../properties/iconIdentifier.rst
.. include:: ../properties/iconIdentifier.rst.txt


.. _prototypes.<prototypeIdentifier>.finishersdefinition.flashmessage.formeditor.label:
Expand Down Expand Up @@ -297,7 +297,7 @@ formeditor.label
- :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>`

:aspect:`Description`
.. include:: ../properties/label.rst
.. include:: ../properties/label.rst.txt


.. _prototypes.<prototypeIdentifier>.finishersdefinition.flashmessage.formeditor.predefineddefaults:
Expand Down Expand Up @@ -338,4 +338,4 @@ formeditor.predefinedDefaults
ToDo
:aspect:`Description`
.. include:: ../properties/predefinedDefaults.rst
.. include:: ../properties/predefinedDefaults.rst.txt
Expand Up @@ -42,7 +42,7 @@ implementationClassName
- :ref:`"Custom finisher implementations"<concepts-finishers-customfinisherimplementations>`

:aspect:`Description`
.. include:: ../properties/implementationClassName.rst
.. include:: ../properties/implementationClassName.rst.txt


.. _prototypes.<prototypeIdentifier>.finishersdefinition.redirect.options.pageuid:
Expand Down Expand Up @@ -253,7 +253,7 @@ formeditor.iconIdentifier
ToDo
:aspect:`Description`
.. include:: ../properties/iconIdentifier.rst
.. include:: ../properties/iconIdentifier.rst.txt


.. _prototypes.<prototypeIdentifier>.finishersdefinition.redirect.formeditor.label:
Expand Down Expand Up @@ -292,7 +292,7 @@ formeditor.label
- :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>`

:aspect:`Description`
.. include:: ../properties/label.rst
.. include:: ../properties/label.rst.txt


.. _prototypes.<prototypeIdentifier>.finishersdefinition.redirect.formeditor.predefineddefaults:
Expand Down Expand Up @@ -331,7 +331,7 @@ formeditor.predefinedDefaults
ToDo
:aspect:`Description`
.. include:: ../properties/predefinedDefaults.rst
.. include:: ../properties/predefinedDefaults.rst.txt


.. _prototypes.<prototypeIdentifier>.finishersdefinition.redirect.formengine.label:
Expand Down Expand Up @@ -364,7 +364,7 @@ FormEngine.label
- :ref:`"Translate form plugin settings"<concepts-formplugin-translation-formengine>`

:aspect:`Description`
.. include:: ../properties/formEngine/label.rst
.. include:: ../properties/formEngine/label.rst.txt


.. _prototypes.<prototypeIdentifier>.finishersdefinition.redirect.formengine.elements:
Expand Down Expand Up @@ -417,5 +417,5 @@ FormEngine.elements
- :ref:`"Translate form plugin settings"<concepts-formplugin-translation-formengine>`

:aspect:`Description`
.. include:: ../properties/formEngine/elements.rst
.. include:: ../properties/formEngine/elements.rst.txt

Expand Up @@ -42,7 +42,7 @@ implementationClassName
- :ref:`"Custom finisher implementations"<concepts-finishers-customfinisherimplementations>`

:aspect:`Description`
.. include:: ../properties/implementationClassName.rst
.. include:: ../properties/implementationClassName.rst.txt


.. _prototypes.<prototypeIdentifier>.finishersdefinition.savetodatabase.options.table:
Expand Down Expand Up @@ -448,7 +448,7 @@ formeditor.iconIdentifier
ToDo
:aspect:`Description`
.. include:: ../properties/iconIdentifier.rst
.. include:: ../properties/iconIdentifier.rst.txt


.. _prototypes.<prototypeIdentifier>.finishersdefinition.savetodatabase.formeditor.label:
Expand Down Expand Up @@ -484,7 +484,7 @@ formeditor.label
- :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>`

:aspect:`Description`
.. include:: ../properties/label.rst
.. include:: ../properties/label.rst.txt


.. _prototypes.<prototypeIdentifier>.finishersdefinition.savetodatabase.formeditor.predefineddefaults:
Expand Down Expand Up @@ -520,4 +520,4 @@ formeditor.predefinedDefaults
ToDo
:aspect:`Description`
.. include:: ../properties/predefinedDefaults.rst
.. include:: ../properties/predefinedDefaults.rst.txt
@@ -1,4 +1,4 @@
.. include:: /Includes.rst.txt


Every array key must match to the related finisher option name.
For example, the - :ref:`"[Redirect] finisher"<prototypes.\<prototypeidentifier>.finishersdefinition.redirect>` has the option - :ref:`"pageUid"<prototypes.\<prototypeIdentifier>.finishersdefinition.redirect.options.pageuid>`.
Expand Down
@@ -1,4 +1,4 @@
.. include:: /Includes.rst.txt


Finisher options are overwritable within the ``form plugin``.
If the "Override finisher settings" checkbox is selected within the ``form plugin``, every finisher who has a - :ref:`"FormEngine"<prototypes.\<prototypeIdentifier>.finishersdefinition.\<finisheridentifier>.formengine>` configuration, is shown in a separate tab.
Expand Down
@@ -1,4 +1,4 @@
.. include:: /Includes.rst.txt


An icon identifier which must be registered through the :php:`\TYPO3\CMS\Core\Imaging\IconRegistry`.
This icon will be shown within the - :ref:`"Inspector [CollectionElementHeaderEditor]"<prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.collectionelementheadereditor>` if the finisher is selected.

0 comments on commit 6a0740b

Please sign in to comment.