Skip to content

Commit 629e902

Browse files
[Backport 14.3] [TASK] Render field descriptions next to the label in FormEngine (#1407)
[TASK] Render field descriptions next to the label in FormEngine (#1396) Resolves: TYPO3-Documentation/Changelog-To-Doc#1647 Releases: main, 14.3 (cherry picked from commit 2117dbc) Co-authored-by: Lina Wolf <48202465+linawolf@users.noreply.github.com>
1 parent da3e977 commit 629e902

6 files changed

Lines changed: 12 additions & 78 deletions

File tree

Documentation/CodeSnippets/Manual/FieldInformationRenderDescription.php

Lines changed: 0 additions & 17 deletions
This file was deleted.

Documentation/CodeSnippets/Manual/FieldInformationTcaDescription.php

Lines changed: 0 additions & 16 deletions
This file was deleted.

Documentation/ColumnsConfig/CommonProperties/FieldInformation/Index.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@ fieldInformation
88
The `fieldInformation` is a reserved area within a single form element between
99
the label and the form element itself.
1010

11-
.. include:: /Images/Rst/FieldInformationTcaDescription.rst.txt
12-
1311
.. confval:: fieldInformation
1412
:Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']
1513
:type: array
Lines changed: 12 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,27 @@
11
.. include:: /Includes.rst.txt
22
.. _tca_property_fieldInformation_tcaDescription:
3+
.. _tca_property_fieldInformation_tcaDescription_examples:
4+
.. _tca_property_fieldInformation_tcaDescription_examples_activateTcaDescription:
5+
.. _tca_property_fieldInformation_tcaDescription_examples_renderDescription:
36

47
==============
58
tcaDescription
69
==============
710

8-
Use this `fieldInformation` to allow adding a more detailed description to the
9-
form element. `tcaDescription` will read the `description` part of the
10-
TCA column definition. If that value starts with `LLL:` it will render a
11-
translated output. Else it will render the text unmodified.
11+
.. deprecated:: 14.2
12+
The `TcaDescription` field information render type has been deprecated.
13+
Field descriptions configured via `['columns']['my_field']['description'] <https://docs.typo3.org/permalink/t3tca:confval-columns-description>`_
14+
are now rendered automatically next to the field label.
1215

13-
.. include:: /Images/Rst/FieldInformationTcaDescription.rst.txt
16+
Remove any explicit :php:`tcaDescription` field information configuration from
17+
TCA when dropping TYPO3 13.4 support.
18+
19+
See `Deprecation: #109280 - FormEngine TcaDescription fieldInformation <https://docs.typo3.org/permalink/changelog:deprecation-109280-1742109280>`_
1420

1521
.. confval:: tcaDescription
1622
:name: fieldInformation-tcaDescription
1723
:Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldInformation']
1824
:type: array
1925
:Scope: fieldInformation
2026

21-
.. note::
22-
The HTML tags for this specific area are limited to:
23-
`<a>`, `<br>`, `<br/>`, `<div>`, `<em>`, `<i>`, `<p>`, `<strong>`,
24-
`<span>`, `<code>`.
25-
26-
`tcaDescription` is activated for most of the TYPO3 form elements by default.
27-
28-
.. _tca_property_fieldInformation_tcaDescription_examples:
29-
30-
Examples
31-
========
32-
33-
.. _tca_property_fieldInformation_tcaDescription_examples_activateTcaDescription:
34-
35-
Activate tcaDescription
36-
-----------------------
37-
38-
For most of the TYPO3 own form elements it is not needed to activate
39-
`tcaDescription` as it is activated by default. Before adding `tcaDescription`
40-
to any kind of form elements you have to make sure the element supports the
41-
rendering of `fieldInformation <https://docs.typo3.org/permalink/t3tca:confval-fieldinformation>`_.
42-
43-
.. literalinclude:: /CodeSnippets/Manual/FieldInformationTcaDescription.php
44-
:caption: EXT:my_extkey/Configuration/TCA/Overrides/pages.php
45-
46-
.. _tca_property_fieldInformation_tcaDescription_examples_renderDescription:
47-
48-
Render a description
49-
--------------------
50-
51-
As `tcaDescription` is activated for most of the TYPO3 own form elements,
52-
it just needs to set the `description <https://docs.typo3.org/permalink/t3tca:confval-columns-description>`_ property:
53-
54-
.. literalinclude:: /CodeSnippets/Manual/FieldInformationRenderDescription.php
55-
:caption: EXT:seo/Configuration/TCA/Overrides/pages.php
27+
.. deprecated:: 14.2
Binary file not shown.

Documentation/Images/Rst/FieldInformationTcaDescription.rst.txt

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)