|
1 | 1 | .. include:: /Includes.rst.txt |
2 | 2 | .. _tca_property_fieldInformation_tcaDescription: |
| 3 | +.. _tca_property_fieldInformation_tcaDescription_examples: |
| 4 | +.. _tca_property_fieldInformation_tcaDescription_examples_activateTcaDescription: |
| 5 | +.. _tca_property_fieldInformation_tcaDescription_examples_renderDescription: |
3 | 6 |
|
4 | 7 | ============== |
5 | 8 | tcaDescription |
6 | 9 | ============== |
7 | 10 |
|
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. |
12 | 15 |
|
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>`_ |
14 | 20 |
|
15 | 21 | .. confval:: tcaDescription |
16 | 22 | :name: fieldInformation-tcaDescription |
17 | 23 | :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldInformation'] |
18 | 24 | :type: array |
19 | 25 | :Scope: fieldInformation |
20 | 26 |
|
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 |
0 commit comments