Skip to content

Commit

Permalink
[DOCS] Streamline the display of references to PHP class in EXT:form
Browse files Browse the repository at this point in the history
In some cases, classes are displayed like "TYPO3CMSCoreTypeContextualFeedbackSeverity"
as backslashes are neither quoted not enclosed in a ":php:" directive.

Where appropriate, we now link to the source code directly instead of just mentioning a class (with ":t3src:)". This is helpful, for example,
for the severity enum, when you just want to know the available cases.

Additionally, other mentions of PHP classes are now enclosed in a
":php:" directive instead double ticks.

Resolves: #101599
Releases: main, 12.4
Change-Id: I2b384e388e6b6544c0a534a2bb23e97bc7c7fc1e
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/80418
Tested-by: Lina Wolf <[email protected]>
Reviewed-by: Lina Wolf <[email protected]>
Tested-by: core-ci <[email protected]>
  • Loading branch information
brotkrueml authored and linawolf committed Aug 6, 2023
1 parent 781c1ac commit 8bdafa7
Show file tree
Hide file tree
Showing 31 changed files with 36 additions and 32 deletions.
4 changes: 2 additions & 2 deletions Documentation/D/FinisherOptions/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -658,11 +658,11 @@ severity
No

:aspect:`Default value`
\TYPO3\CMS\Core\Type\ContextualFeedbackSeverity::OK (0)
:php:`\TYPO3\CMS\Core\Type\ContextualFeedbackSeverity::OK` (0)

:aspect:`Description`
The flash message severity code.
See \TYPO3\CMS\Core\Type\ContextualFeedbackSeverity cases for the codes.
See :t3src:`core/Classes/Type/ContextualFeedbackSeverity.php` cases for the codes.


.. _apireference-finisheroptions-redirectfinisher:
Expand Down
2 changes: 1 addition & 1 deletion Documentation/I/Concepts/Configuration/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ configuration of the backend ``module.tx_[pluginkey]`` is used.
There are different ways to include the TypoScript configuration for the
backend:

- a) use the API function ``\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addTypoScriptSetup()``,
- a) use the API function :php:`\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addTypoScriptSetup()`,
- b) add the configuration to your existing TypoScript record.

In both cases, the ``form editor`` will work as expected regardless the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -177,14 +177,14 @@ options.severity
No

:aspect:`Default value`
\TYPO3\CMS\Core\Type\ContextualFeedbackSeverity::OK (0)
:php:`\TYPO3\CMS\Core\Type\ContextualFeedbackSeverity::OK` (0)

:aspect:`Good to know`
- :ref:`"FlashMessage finisher"<apireference-finisheroptions-flashmessagefinisher>`

:aspect:`Description`
The flash message severity code.
See \TYPO3\CMS\Core\Type\ContextualFeedbackSeverity cases for the codes.
See :t3src:`core/Classes/Type/ContextualFeedbackSeverity.php` cases for the codes.


.. _prototypes.<prototypeIdentifier>.finishersdefinition.flashmessage.options.translation.translationfiles:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. include:: /Includes.rst.txt

An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``.
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.
2 changes: 1 addition & 1 deletion Documentation/I/Config/proto/formElements/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -778,7 +778,7 @@ formEditor.iconIdentifier
ToDo
:aspect:`Description`
An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``.
An icon identifier which must be registered through the :php:`\TYPO3\CMS\Core\Imaging\IconRegistry`.
This icon will be shown within

- :ref:`"Inspector [FormElementHeaderEditor]"<prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ formEditor.iconIdentifier
ToDo
:aspect:`Description`
An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``.
An icon identifier which must be registered through the :php:`\TYPO3\CMS\Core\Imaging\IconRegistry`.
This icon will be shown within

- :ref:`"Inspector [FormElementHeaderEditor]"<prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ formEditor.iconIdentifier
ToDo
:aspect:`Description`
An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``.
An icon identifier which must be registered through the :php:`\TYPO3\CMS\Core\Imaging\IconRegistry`.
This icon will be shown within

- :ref:`"Inspector [FormElementHeaderEditor]"<prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ formEditor.iconIdentifier
ToDo
:aspect:`Description`
An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``.
An icon identifier which must be registered through the :php:`\TYPO3\CMS\Core\Imaging\IconRegistry`.
This icon will be shown within

- :ref:`"Inspector [FormElementHeaderEditor]"<prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ formEditor.iconIdentifier
ToDo
:aspect:`Description`
An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``.
An icon identifier which must be registered through the :php:`\TYPO3\CMS\Core\Imaging\IconRegistry`.
This icon will be shown within

- :ref:`"Inspector [FormElementHeaderEditor]"<prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ formEditor.iconIdentifier
ToDo
:aspect:`Description`
An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``.
An icon identifier which must be registered through the :php:`\TYPO3\CMS\Core\Imaging\IconRegistry`.
This icon will be shown within

- :ref:`"Inspector [FormElementHeaderEditor]"<prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ formEditor.iconIdentifier
ToDo
:aspect:`Description`
An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``.
An icon identifier which must be registered through the :php:`\TYPO3\CMS\Core\Imaging\IconRegistry`.
This icon will be shown within

- :ref:`"Inspector [FormElementHeaderEditor]"<prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ formEditor.iconIdentifier
ToDo
:aspect:`Description`
An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``.
An icon identifier which must be registered through the :php:`\TYPO3\CMS\Core\Imaging\IconRegistry`.
This icon will be shown within

- :ref:`"Inspector [FormElementHeaderEditor]"<prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ formEditor.iconIdentifier
ToDo
:aspect:`Description`
An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``.
An icon identifier which must be registered through the :php:`\TYPO3\CMS\Core\Imaging\IconRegistry`.
This icon will be shown within

- :ref:`"Inspector [FormElementHeaderEditor]"<prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ formEditor.iconIdentifier
ToDo
:aspect:`Description`
An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``.
An icon identifier which must be registered through the :php:`\TYPO3\CMS\Core\Imaging\IconRegistry`.
This icon will be shown within

- :ref:`"Inspector [FormElementHeaderEditor]"<prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ formEditor.iconIdentifier
ToDo
:aspect:`Description`
An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``.
An icon identifier which must be registered through the :php:`\TYPO3\CMS\Core\Imaging\IconRegistry`.
This icon will be shown within

- :ref:`"Inspector [FormElementHeaderEditor]"<prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ formEditor.iconIdentifier
ToDo
:aspect:`Description`
An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``.
An icon identifier which must be registered through the :php:`\TYPO3\CMS\Core\Imaging\IconRegistry`.
This icon will be shown within

- :ref:`"Inspector [FormElementHeaderEditor]"<prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ formEditor.iconIdentifier
ToDo
:aspect:`Description`
An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``.
An icon identifier which must be registered through the :php:`\TYPO3\CMS\Core\Imaging\IconRegistry`.
This icon will be shown within

- :ref:`"Inspector [FormElementHeaderEditor]"<prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ formEditor.iconIdentifier
ToDo
:aspect:`Description`
An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``.
An icon identifier which must be registered through the :php:`\TYPO3\CMS\Core\Imaging\IconRegistry`.
This icon will be shown within

- :ref:`"Inspector [FormElementHeaderEditor]"<prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ formEditor.iconIdentifier
ToDo
:aspect:`Description`
An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``.
An icon identifier which must be registered through the :php:`\TYPO3\CMS\Core\Imaging\IconRegistry`.
This icon will be shown within

- :ref:`"Inspector [FormElementHeaderEditor]"<prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ formEditor.iconIdentifier
ToDo
:aspect:`Description`
An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``.
An icon identifier which must be registered through the :php:`\TYPO3\CMS\Core\Imaging\IconRegistry`.
This icon will be shown within

- :ref:`"Inspector [FormElementHeaderEditor]"<prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ formEditor.iconIdentifier
ToDo
:aspect:`Description`
An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``.
An icon identifier which must be registered through the :php:`\TYPO3\CMS\Core\Imaging\IconRegistry`.
This icon will be shown within

- :ref:`"Inspector [FormElementHeaderEditor]"<prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ formEditor.iconIdentifier
ToDo
:aspect:`Description`
An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``.
An icon identifier which must be registered through the :php:`\TYPO3\CMS\Core\Imaging\IconRegistry`.
This icon will be shown within

- :ref:`"Inspector [FormElementHeaderEditor]"<prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ formEditor.iconIdentifier
ToDo
:aspect:`Description`
An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``.
An icon identifier which must be registered through the :php:`\TYPO3\CMS\Core\Imaging\IconRegistry`.
This icon will be shown within

- :ref:`"Inspector [FormElementHeaderEditor]"<prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ formEditor.iconIdentifier
ToDo
:aspect:`Description`
An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``.
An icon identifier which must be registered through the :php:`\TYPO3\CMS\Core\Imaging\IconRegistry`.
This icon will be shown within

- :ref:`"Inspector [FormElementHeaderEditor]"<prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ formEditor.iconIdentifier
ToDo
:aspect:`Description`
An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``.
An icon identifier which must be registered through the :php:`\TYPO3\CMS\Core\Imaging\IconRegistry`.
This icon will be shown within

- :ref:`"Inspector [FormElementHeaderEditor]"<prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ formEditor.iconIdentifier
ToDo
:aspect:`Description`
An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``.
An icon identifier which must be registered through the :php:`\TYPO3\CMS\Core\Imaging\IconRegistry`.
This icon will be shown within

- :ref:`"Inspector [FormElementHeaderEditor]"<prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ formEditor.iconIdentifier
ToDo
:aspect:`Description`
An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``.
An icon identifier which must be registered through the :php:`\TYPO3\CMS\Core\Imaging\IconRegistry`.
This icon will be shown within

- :ref:`"Inspector [FormElementHeaderEditor]"<prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ formEditor.iconIdentifier
ToDo
:aspect:`Description`
An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``.
An icon identifier which must be registered through the :php:`\TYPO3\CMS\Core\Imaging\IconRegistry`.
This icon will be shown within

- :ref:`"Inspector [FormElementHeaderEditor]"<prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ formEditor.iconIdentifier
ToDo
:aspect:`Description`
An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``.
An icon identifier which must be registered through the :php:`\TYPO3\CMS\Core\Imaging\IconRegistry`.
This icon will be shown within

- :ref:`"Inspector [FormElementHeaderEditor]"<prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.formelementheadereditor>`.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. include:: /Includes.rst.txt

An icon identifier which must be registered through the ``\TYPO3\CMS\Core\Imaging\IconRegistry``.
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 validator is selected.
4 changes: 4 additions & 0 deletions Documentation/Settings.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -59,3 +59,7 @@ t3coreapi = https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/
# ext_scheduler = https://docs.typo3.org/c/typo3/cms-scheduler/main/en-us/
# ext_seo = https://docs.typo3.org/c/typo3/cms-seo/main/en-us/
# ext_workspaces = https://docs.typo3.org/c/typo3/cms-workspaces/main/en-us/

[extlinks]

t3src = https://github.com/typo3/typo3/blob/main/typo3/sysext/%s | EXT:

0 comments on commit 8bdafa7

Please sign in to comment.