Feature #85410

Allow TCA description property

Added by Christian Kuhn over 1 year ago. Updated about 1 year ago.

Status:
Closed
Priority:
Should have
Assignee:
-
Category:
-
Target version:
Start date:
2018-06-27
Due date:
% Done:

100%

PHP Version:
Tags:
Complexity:
Sprint Focus:

Related issues

Related to TYPO3 Core - Feature #71102: Allow definition of CSH within TCA Closed 2015-10-28
Related to TYPO3 Core - Feature #71081: Additional help text property for TCA field types Closed 2015-10-27
Related to TYPO3 Core - Bug #86720: Description for TCA type "slug" not possible Closed 2018-10-23

Associated revisions

Revision d421f7dc (diff)
Added by Christian Kuhn about 1 year ago

[FEATURE] Allow TCA description property

When the site configuration module has been introduced, it came
with a custom functionality to show an additional help text
when editing site records between the field label and the field input.

This useful feature is now changed into a general TCA feature
available everywhere: A new field information node expansion / "wizard"
is added to all form elements, the inline and flex containers: If
the property "description" is set for a TCA column type (same array
level as "label", it will show the value as localized string between
the field label and the input section.

There are three available render types for "wizard a-like" output:
  • Field information - text between label+field
  • Field control - buttons next to input sections like the link popup button
  • Field wizards - clickable stuff below the input section, for example
    the localization state selector
    If a field has been set to readOnly=true in TCA, field control and field
    wizards do not make sense to render since they are meant to act with the
    field value.
    The field information node however has only informational character
    which is useful for readOnly fields, too. Thus, this node expansion
    type is now the only one that is always rendered, even if a field has
    been set to readOnly.

Note this patch is fully covered by ext:styleguide (master) to have
examples for all changed elements now using the description property.

Resolves: #85410
Releases: master
Change-Id: Idcfacafa19b8208614b653b8fac22ce47bca3b8f
Reviewed-on: https://review.typo3.org/57397
Tested-by: TYPO3com <>
Reviewed-by: Jörg Bösche <>
Tested-by: Jörg Bösche <>
Reviewed-by: Andreas Wolf <>
Tested-by: Andreas Wolf <>

History

#1 Updated by Gerrit Code Review over 1 year ago

  • Status changed from New to Under Review

Patch set 1 for branch master of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/57397

#2 Updated by Gerrit Code Review over 1 year ago

Patch set 2 for branch master of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/57397

#3 Updated by Gerrit Code Review over 1 year ago

Patch set 3 for branch master of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/57397

#4 Updated by Gerrit Code Review over 1 year ago

Patch set 4 for branch master of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/57397

#5 Updated by Gerrit Code Review about 1 year ago

Patch set 5 for branch master of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/57397

#6 Updated by Christian Kuhn about 1 year ago

  • Status changed from Under Review to Resolved
  • % Done changed from 0 to 100

#7 Updated by Christian Kuhn about 1 year ago

#8 Updated by Christian Kuhn about 1 year ago

  • Related to Feature #71081: Additional help text property for TCA field types added

#9 Updated by Benni Mack about 1 year ago

  • Status changed from Resolved to Closed

#10 Updated by Georg Ringer 12 months ago

  • Related to Bug #86720: Description for TCA type "slug" not possible added

Also available in: Atom PDF