Task #78383

TCA: Streamline field order and position for recurring fields

Added by Daniel Windloff about 3 years ago. Updated about 1 year ago.

Status:
Closed
Priority:
Should have
Category:
Backend User Interface
Target version:
-
Start date:
2016-10-23
Due date:
% Done:

100%

TYPO3 Version:
8
PHP Version:
Tags:
Complexity:
Sprint Focus:

Description

User story

When I edit a record, I would like to have the same options on similar places. So I have a chance to have a valid expectation where to find the option.

Description of the issue

In T3 there are some recurring field definitions shared by a lot of records (core records and extension records). These fields are mostly defined in TCA[‘crtl’]- e.g. disabled, descriptionColumn. These fields should have a standard position and order.

Example Field enablecolumns.disabled

Record Tab Field position
Page Access Visibility – Page - Disable
Backendusergroup General Disable
Backenduser General Disable
Webseite language Access Disable
Action Access Deactivated
System News General Disable
Scheduler task group --- Disable
Template General Disable
Content element Access Visibility – Content Element - Disable
Website User General Disable
Backend layout Access Disable:
Domain --- Disable
Alternative Page Language Access Visiblity – Page - Disable
Category General Hide (next to Language in palette)
Record Collection General Hide (next to Language in palette)
Abbreviation --- Hide

Suggested solution

Streamline the field order and position for all core records. Add missing fields where necessary. Document the order and position to encourage extension authors to change the field order accordingly.

Suggested field order and position

Legend: / means palette

Tab: General (must be the first tab)

  • type / (main sub selection e.g. colPos)
  • label / (label specific options)
  • label_alt (in case these fields are related to the label)

Other tabs defined by the specific record

Tab: Language

  • language_field / transOrigPointerField
  • other language or translation related options

Tab: Access

  • disabled / (hide in menu)
  • starttime / endtime
  • fe_group / fe_admin_lock
  • adminlock
  • other access related options

Tab: Categories

  • categories (not to select parent categories; only to categorize a record)

Tab: Notes

  • descriptionColumn

Related issues

Related to TYPO3 Core - Task #79901: Add missing documentation of field positions in tabs in BE Closed 2017-02-19
Related to TYPO3 Core - Bug #83974: Miscellaneous palette in pages table has invalid showitem string Closed 2018-02-20

Associated revisions

Revision d03e9d67 (diff)
Added by Daniel Windloff about 3 years ago

[!!!][TASK] TCA: Streamline field position in tabs

In TYPO3 there are some recurring field definitions shared
by a lot of records. These fields are mostly defined in
the control section of TCA.

These fields are used as well by the core as by records
introduced by third party extensions.

In order to get a consistent behaviour
(from editor's perspective)
these fields should have a generic position in tabs.

Resolves: #78383
Releases: master
Change-Id: I365538b8e6013e3911710b113bec7d41314809b2
Reviewed-on: https://review.typo3.org/50364
Reviewed-by: Alexander Stehlik <>
Tested-by: Alexander Stehlik <>
Tested-by: TYPO3com <>
Reviewed-by: Anja Leichsenring <>
Tested-by: Anja Leichsenring <>
Reviewed-by: Jan Helke <>
Tested-by: Jan Helke <>

Revision 4d0fd49f (diff)
Added by Helmut Hummel almost 3 years ago

[FOLLOWUP][TASK] TCA: Streamline field position in tabs

Fix some typos and a leading newline in a PHP file

Related: #78383
Releases: master
Change-Id: I483b09abf02a9f109350284e31cba15848004e5c
Reviewed-on: https://review.typo3.org/50961
Reviewed-by: Anja Leichsenring <>
Tested-by: Anja Leichsenring <>
Tested-by: TYPO3com <>
Reviewed-by: Nicole Cordes <>
Tested-by: Nicole Cordes <>

History

#1 Updated by Jo Hasenau about 3 years ago

  • Description updated (diff)

#2 Updated by Jo Hasenau about 3 years ago

  • Status changed from New to Accepted

#3 Updated by Frans Saris about 3 years ago

Somekind of API to add these fields to your own TCA would be great. That would help all extension authors and make it much easier to streamline the backed and also to customize it again. 1 place that defines the configuration of all the general fields, pallettes and tabs + column order and search.

#4 Updated by Daniel Windloff about 3 years ago

Yes, it's nasty to write on every own extension table the same configuration etc. It would be a good starting point for an API to benefit the situation.

I would suggest applying changes in the following order:

  1. Streamline core fields order and position
  2. Document field position and order
  3. Add a (misused) unit/functional test or something else to ensure the position and order for core records in the future
  4. Introduce an API to make it easy to add those fields consistently

#5 Updated by Gerrit Code Review about 3 years ago

  • Status changed from Accepted 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/50364

#6 Updated by Gerrit Code Review about 3 years 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/50364

#7 Updated by Gerrit Code Review about 3 years 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/50364

#8 Updated by Gerrit Code Review about 3 years 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/50364

#9 Updated by Gerrit Code Review about 3 years 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/50364

#10 Updated by Gerrit Code Review about 3 years ago

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

#11 Updated by Gerrit Code Review about 3 years ago

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

#12 Updated by Gerrit Code Review about 3 years ago

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

#13 Updated by Daniel Windloff about 3 years ago

Hi,

I had a proposal on gerrit. The main difference I made is the movement of the language related fields (in comperison to tt_content or page).
I think it is not longer necessary to have them in the first tab, as the translation is mainly done by wizards and the current (language) status is also avaliable through the module menu.

Best regards,
Daniel

#14 Updated by Gerrit Code Review about 3 years ago

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

#15 Updated by Gerrit Code Review about 3 years ago

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

#16 Updated by Gerrit Code Review about 3 years ago

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

#17 Updated by Gerrit Code Review about 3 years ago

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

#18 Updated by Gerrit Code Review about 3 years ago

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

#19 Updated by Gerrit Code Review about 3 years ago

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

#20 Updated by Gerrit Code Review about 3 years ago

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

#21 Updated by Gerrit Code Review about 3 years ago

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

#22 Updated by Gerrit Code Review about 3 years ago

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

#23 Updated by Gerrit Code Review about 3 years ago

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

#24 Updated by Gerrit Code Review about 3 years ago

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

#25 Updated by Gerrit Code Review about 3 years ago

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

#26 Updated by Gerrit Code Review about 3 years ago

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

#27 Updated by Gerrit Code Review about 3 years ago

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

#28 Updated by Daniel Windloff about 3 years ago

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

#29 Updated by Christian Kuhn almost 2 years ago

  • Related to Bug #83974: Miscellaneous palette in pages table has invalid showitem string added

#30 Updated by Benni Mack about 1 year ago

  • Status changed from Resolved to Closed

Also available in: Atom PDF