Review main Merged

62109[FEATURE] Introduce palette descriptions

Simon Gilli CR +2 V +2 Normal +99 −17 updated 06/27/21, 08:48

Commit message

A new TCA property "description" is available to be added to
palette configurations. It allows to provide additional text,
which will be rendered by FormEngine between the palette label
and the corresponding fields. It is similar to the TCA field
description, introduced in #85410.

This will support editors as specific field usages can be
clarified directly in the UI.

In contrast to the palette label, the new description property
can not be overwritten on a record type basis.

Review

  • Code review CR +2 Done
    • Christian Kuhn +2
    • Oli Bartsch +1
  • Verified V +2 Done
    • Christian Kuhn +2
    • Oli Bartsch +1
    • core-ci +1 CI

Issues 1

Files 5

Review log 6490

Show 4465 earlier messages
  1. Simon Gilli uploaded patch set 1 10/25/19, 11:08

  2. TYPO3com voted on patch set 1 V -1 10/25/19, 11:17 Completed build in 08m 49s on Fri, 25 Oct, 11:17 AM Test Summary: 28 of 48378 failed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-37662

  3. Simon Gilli uploaded patch set 2 10/25/19, 12:22

  4. TYPO3com voted on patch set 2 V -1 10/25/19, 12:34 Completed build in 11m 05s on Fri, 25 Oct, 12:34 PM Test Summary: 30 of 48378 failed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-37666

  5. Simon Gilli uploaded patch set 3 10/25/19, 19:24

  6. TYPO3com voted on patch set 3 V -1 10/25/19, 19:34 Completed build in 13s on Fri, 25 Oct, 07:34 PM Test Summary: No tests found Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-37737

  7. Simon Gilli uploaded patch set 4 10/25/19, 19:35

  8. TYPO3com voted on patch set 4 V -1 10/25/19, 19:57 Completed build in 14m 26s on Fri, 25 Oct, 07:57 PM Test Summary: 28 of 48418 failed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-37740

  9. Simon Gilli uploaded patch set 5 10/25/19, 20:33

  10. TYPO3com voted on patch set 5 V -1 10/25/19, 20:43 Completed build in 10m 03s on Fri, 25 Oct, 08:43 PM Test Summary: 12 of 48418 failed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-37745

  11. Simon Gilli uploaded patch set 6 10/25/19, 20:57

  12. TYPO3com voted on patch set 6 V -1 10/25/19, 21:07 Completed build in 10m 19s on Fri, 25 Oct, 09:07 PM Test Summary: 48049 passed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-37747

  13. Simon Gilli uploaded patch set 7 10/25/19, 21:28

  14. TYPO3com voted on patch set 7 V +1 10/25/19, 21:37 Completed build in 09m 17s on Fri, 25 Oct, 09:37 PM Test Summary: 48059 passed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-37748

  15. Simon Gilli uploaded patch set 8 10/25/19, 21:42

  16. TYPO3com voted on patch set 8 V +1 10/25/19, 21:55 Completed build in 11m 16s on Fri, 25 Oct, 09:55 PM Test Summary: 48059 passed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-37753

  17. Simon Gilli commented on patch set 8 10/25/19, 21:57

    Ready for review
  18. Simon Gilli uploaded patch set 9 10/26/19, 02:04

  19. TYPO3com voted on patch set 9 V +1 10/26/19, 02:13 Completed build in 09m 04s on Sat, 26 Oct, 02:13 AM Test Summary: 48059 passed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-37755

  20. Simon Gilli uploaded patch set 10 10/26/19, 07:51

  21. TYPO3com voted on patch set 10 V -1 10/26/19, 08:05 Completed build in 12m 22s on Sat, 26 Oct, 08:05 AM Test Summary: 4 of 48418 failed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-37763

  22. Simon Gilli uploaded patch set 11 10/26/19, 08:10

  23. TYPO3com voted on patch set 11 V -1 10/26/19, 08:19 Completed build in 08m 41s on Sat, 26 Oct, 08:19 AM Test Summary: 47575 passed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-37765

  24. Simon Gilli uploaded patch set 12 10/26/19, 08:35

  25. TYPO3com commented on patch set 12 10/26/19, 08:46 Completed build in 11m 42s on Sat, 26 Oct, 08:46 AM Test Summary: 1 of 48418 failed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-37767

  26. TYPO3com voted on patch set 11 V +1 10/26/19, 08:53 Completed build in 51m 09s on Sat, 26 Oct, 08:53 AM Test Summary: 48059 passed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-37765

  27. Robert Wildling commented on patch set 12 V +1 CR +1 10/26/19, 09:03

    LGTM
  28. Lina Wolf commented on patch set 12 CR +1 10/29/19, 20:36

    Gefällt mir gut.

    PaletteAndSingleContainer.php:106

    Pallette Description is optional may not - darf nicht
  29. Thomas Anders commented on patch set 12 V +1 10/30/19, 07:38

    Good work - Works like expected, both in the "--palette--;;mypalette;My Description," and in the "['palettes']['mypalette']['description']" array.
  30. Robert Wildling commented on patch set 12 10/30/19, 08:18

    > Patch Set 12: Verified+1 Code-Review+1 > > LGTM Also works fine in FlexForms! Thank you!

    PaletteAndSingleContainer.php:106 Reply

    I like Lina's formulation better.
  31. Simon Gilli uploaded patch set 13 11/01/19, 08:48

  32. Simon Gilli commented on patch set 13 11/01/19, 08:51

    Please vote again, only a comment has changed

    PaletteAndSingleContainer.php:106 Reply

    Is changed, also for the existing label field
  33. Thomas Anders commented on patch set 13 V +1 11/01/19, 08:55

    Looks good.
  34. TYPO3com voted on patch set 13 V -1 11/01/19, 08:59 Completed build in 10m 15s on Fri, 1 Nov, 08:59 AM Test Summary: 16 of 48438 failed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-37913

  35. Simon Gilli uploaded patch set 14 11/01/19, 09:01

  36. Simon Gilli commented on patch set 14 11/01/19, 09:03

    I'm sorry, I accidentally added a test that should not be changed. So please vote again for this patch
  37. Robert Wildling commented on patch set 14 V +1 CR +1 11/01/19, 09:07

    Thank you, Simon!!
  38. TYPO3com voted on patch set 14 V +1 11/01/19, 09:13 Completed build in 12m 12s on Fri, 1 Nov, 09:13 AM Test Summary: 48079 passed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-37915

  39. Thomas Anders voted on patch set 14 V +1 11/01/19, 09:35

  40. Oli Bartsch commented on patch set 14 11/02/19, 09:07

    _main_form.scss:352

    I would integrate that into `form-section-headline`: .form-section-headline { margin-top: 0; margin-bottom: 10px; & + .form-section-headline-description { margin-top: -5px; margin-bottom: 10px; } } That would ensure the styling only applies to a direct sibling of `.form-section-headline`

    Feature-89507-AddDescriptionForTCAPalettes.rst:12

    I would suggest using `This` here.

    Feature-89507-AddDescriptionForTCAPalettes.rst:46

    I don't know if we need this word here. What does it mean in this context? Each `palette` is IMO individual. I would suggest simply drop it here.

    Feature-89507-AddDescriptionForTCAPalettes.rst:46

    provide
  41. Simon Gilli uploaded patch set 15 11/02/19, 14:43

  42. Simon Gilli commented on patch set 15 11/02/19, 14:44

    _main_form.scss:352 Reply

    Good point, thanks

    Feature-89507-AddDescriptionForTCAPalettes.rst:12 Reply

    Done

    Feature-89507-AddDescriptionForTCAPalettes.rst:46 Reply

    Done

    Feature-89507-AddDescriptionForTCAPalettes.rst:46 Reply

    Done
  43. Thomas Anders commented on patch set 15 11/02/19, 14:53

    Two typos for word "palette" found.

    PaletteAndSingleContainer.php:88

    Palette with single `l`

    PaletteAndSingleContainer.php:106

    Palette with single `l`
  44. TYPO3com voted on patch set 15 V -1 11/02/19, 14:53 Completed build in 10m 07s on Sat, 2 Nov, 02:53 PM Test Summary: 1 of 48438 failed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-37928

  45. Simon Gilli uploaded patch set 16 11/02/19, 15:03

  46. Simon Gilli commented on patch set 16 11/02/19, 15:03

    PaletteAndSingleContainer.php:88 Reply

    Done

    PaletteAndSingleContainer.php:106 Reply

    Done
  47. TYPO3com voted on patch set 16 V +1 11/02/19, 15:12 Completed build in 09m 18s on Sat, 2 Nov, 03:12 PM Test Summary: 48079 passed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-37929

  48. Thomas Anders voted on patch set 16 V +1 CR +1 11/02/19, 15:15

  49. Oli Bartsch voted on patch set 16 V +1 CR +1 11/02/19, 15:15

  50. Benni Mack commented on patch set 16 CR -1 11/08/19, 09:31

    Deprecation RST missing (if there is something to deprecate?). Also - I don't get the "deprecation" info as it adds new things in AbstractContainer... don't understand that change fully tbh. I like the feature though!

    AbstractContainer.php:109

    if it is deprecated, how should people migrate? We need a Deprecation RST then
  51. Simon Gilli commented on patch set 16 11/08/19, 10:06

    AbstractContainer.php:109 Reply

    I would like to avoid changes in ListOfFieldsContainerTest. If I directly add paletteDescription to the array this will break it but it's not really a breaking change. And this is also not a real deprecation, I don't know how to name it. It's also possible to directly integrate the new field into the array and change the test as I did on the first patch sets. This should simply avoid a change of a test which has not really changed. And ofc there is nothing to mirgrate, poeple don't have to change anything. So how should I proceed here? Imho making this in one change is possible too and not breaking... Should I upload a new patchset to show it?
  52. Simon Gilli uploaded patch set 17 11/08/19, 10:34

  53. Simon Gilli commented on patch set 17 11/08/19, 10:41

    AbstractContainer.php:109 Reply

    I finished the change now to how it should be

    ListOfFieldsContainerTest.php:56

    this changes are necessary to pass the tests, but it's not breaking
  54. TYPO3com voted on patch set 17 V -1 11/08/19, 10:50 Completed build in 15m 44s on Fri, 8 Nov, 10:50 AM Test Summary: 46267 passed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-38101

  55. Simon Gilli commented on patch set 17 11/08/19, 10:59

    btw there is also a PR for ext:styleguide to see this feature: https://github.com/TYPO3/styleguide/pull/139
  56. TYPO3com commented on patch set 17 11/08/19, 11:20 Completed build in 1h 01m 24s on Fri, 8 Nov, 11:20 AM Test Summary: 47682 passed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-38101

  57. TYPO3com voted on patch set 17 V +1 11/08/19, 13:30 Completed build in 3h 57m 29s on Fri, 8 Nov, 01:30 PM Test Summary: 48147 passed Find logs and detail information at https://bamboo.typo3.com/browse/CORE-GTC-38101

  58. Benni Mack commented on patch set 17 CR -1 11/09/19, 15:00

    isn't there any other way to _not_ allow the description as another part of the huge string? I know that this was used for e.g. RTE custom field processing...
  59. Simon Gilli commented on patch set 17 11/09/19, 15:07

    Reply

    I would love it but I don't know currently. Will dive into that again....
  60. Benni Mack commented on patch set 17 11/09/19, 15:10

    Reply

    GREAT. Thanks!
  61. Simon Gilli marked it work in progress 11/18/19, 13:17

  62. Nikita Hovratov uploaded patch set 18 06/02/21, 17:08

  63. Nikita Hovratov uploaded patch set 19 06/02/21, 18:48

  64. Nikita Hovratov commented on patch set 19 06/02/21, 18:57

    Hey everyone, I changed the place to define the descriptions so it's not part of the showitems string anymore. Please remove WIP state and start reviewing :)
  65. core-ci voted on patch set 19 V -1 06/02/21, 18:59 Core CI is not happy: https://gitlab.typo3.org/TYPO3/CI/cms/-/pipelines/12137

  1. Simon Gilli marked it ready for review 06/02/21, 19:20

  2. Simon Gilli commented on patch set 19 06/02/21, 19:20

    Reply

    Done
  3. Simon Gilli uploaded patch set 20 06/02/21, 20:27

  4. core-ci voted on patch set 20 V +1 06/02/21, 20:39 Core CI is happy: https://gitlab.typo3.org/TYPO3/CI/cms/-/pipelines/12138

  5. Christian Kuhn commented on patch set 20 CR -1 06/12/21, 12:24

    Looks good overall. Clever to introduce an array key for this. Need to think about some implications (for instance if we decide to finally clean up the showitem mess), but i think it should be ok. Will review in detail soon, and will take care of according styleguide examples before merge. -1 for now until this is / I finished this.
  6. Nikita Hovratov uploaded patch set 21 06/22/21, 15:04

  7. core-ci voted on patch set 21 V +1 06/22/21, 15:15 Core CI is happy: https://gitlab.typo3.org/TYPO3/CI/cms/-/pipelines/12670

  8. Christian Kuhn commented on patch set 21 06/22/21, 17:08

    still on my radar ... *promise to review soon*
  9. Christian Kuhn commented on patch set 21 06/22/21, 18:43

    Hey. I'm fine with adding $TCA['table']['palette']['description'] - that's in parallel to 'label' and won't harm, no matter what we do with $TCA['table']['palette']['showitem']. But I'd love to not allow to override the description per type via $TCA['table']['someType']['palette'] array: The idea is that we hack especially showitem of types into an array, so we shouldn't establish a parallel array right now, that probably collides with a 'showitem' array later, where a palette is a sub-array later. Thus: Let's get the 'description' on 'palette' level in, with this patch, but let's not introduce the palette-description override on types-level.
  10. Christian Kuhn voted on patch set 21 CR -1 06/22/21, 18:44

  11. Nikita Hovratov uploaded patch set 22 06/23/21, 07:33

  12. Nikita Hovratov commented on patch set 22 06/23/21, 07:37

    Reply

    Ok, I understand (probably). It is still beneficial to have a global description for palettes.
  13. core-ci voted on patch set 22 V +1 06/23/21, 07:46 Core CI is happy: https://gitlab.typo3.org/TYPO3/CI/cms/-/pipelines/12686

  14. Oli Bartsch uploaded patch set 23 06/23/21, 14:27

  15. Oli Bartsch voted on patch set 23 V +1 CR +1 06/23/21, 14:30

  16. core-ci voted on patch set 23 V +1 06/23/21, 14:39 Core CI is happy: https://gitlab.typo3.org/TYPO3/CI/cms/-/pipelines/12692

  17. Nikita Hovratov commented on patch set 23 06/23/21, 14:52

    Feature-89507-AddDescriptionForTCAPalettes.rst:21

    Typo property
  18. Nikita Hovratov commented on patch set 23 06/23/21, 14:53

    Typo description
  19. Nikita Hovratov uploaded patch set 24 06/23/21, 15:52

  20. Nikita Hovratov commented on patch set 24 06/23/21, 15:53

    Reply

    Done

    Feature-89507-AddDescriptionForTCAPalettes.rst:21 Reply

    Done
  21. Oli Bartsch voted on patch set 24 V +1 CR +1 06/23/21, 15:54

  22. core-ci voted on patch set 24 V +1 06/23/21, 16:03 Core CI is happy: https://gitlab.typo3.org/TYPO3/CI/cms/-/pipelines/12695

  23. Christian Kuhn commented on patch set 24 V +2 CR +2 06/27/21, 08:46

    Thank you. Let's bring it in. Sorry for the delays.
  24. Christian Kuhn merged patch set 25 06/27/21, 08:46

  25. Christian Kuhn commented on patch set 25 06/27/21, 08:48

    styleguide example with tx_styleguide_palette.php palette_1