Review main Merged

84486[TASK] Change labels of sections in the access rights configuration form

Marcin Sągol CR +2 V +2 Easy +9 −5 updated 07/12/24, 04:43

Commit message

Updated the labels for various sections in the access rights
configuration form to improve clarity and usability.

It was suggested to add a description text to the Modules section
in the backend group configuration form, to notice users that it
behaves differently than Limit To Languages section.

Having additional description probably wasn't a good idea because
there are also other sections that probably should have one added.

Instead the seaction labels were updated to make them more
self-explanatory, so now we have:

Grouptitle --> Title
Modules --> Allowed modules
Dashboard widgets --> Allowed dashboard widgets
Page types --> Allowed page types
Allowed excludefields --> Allowed fields

They align for example with already defined labels like:
Allowed multi-factor authentication providers.

The used/added Allowed word clearly states that by checking some
checkboxes in such sections, we allow to use some elements.

Review

  • Code review CR +2 Done
    • Jasmina Ließmann +2
    • Garvin Hicking +1
    • Christian Kuhn +1
  • Verified V +2 Done
    • Jasmina Ließmann +2
    • Garvin Hicking +1
    • Christian Kuhn +1
    • core-ci +1 CI

Issues 1

Files 2

Review log 2632

Show 57 earlier messages
  1. Marcin Sągol uploaded patch set 1 06/04/24, 09:18

  2. core-ci voted on patch set 1 V +1 06/04/24, 09:25 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/58669

  3. Mathias Brodala commented on patch set 1 06/04/24, 09:33

    locallang_tca.xlf:175

    This should probably stay at "Exclude" instead, especially to keep the close relation to the "exclude" TCA option. See https://docs.typo3.org/m/typo3/reference-tca/12.4/en-us/Columns/Properties/Exclude.html
  4. Marcin Sągol uploaded patch set 2 V +1 06/04/24, 09:51

  5. Marcin Sągol commented on patch set 1 06/04/24, 09:52

    locallang_tca.xlf:175 Reply

    Done
  6. Marcin Sągol updated the commit message in patch set 3 06/04/24, 09:52

  7. core-ci voted on patch set 3 V +1 06/04/24, 10:00 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/58673

  1. core-ci voted on patch set 2 V -1 06/04/24, 10:02 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/58672

  2. Marcin Sągol updated the commit message in patch set 4 V +1 06/04/24, 10:44

  3. core-ci voted on patch set 4 V +1 06/04/24, 10:48 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/58677

  4. Riccardo De Contardi commented on patch set 4 06/04/24, 14:29

    locallang_tca.xlf:175

    I wonder if just "Allowed Fields" would be just ok. For me it is difficult to understand what "Exclude Field" actually means..
  5. Mathias Brodala commented on patch set 4 06/04/24, 14:31

    locallang_tca.xlf:175 Reply

    Actually a good idea IMO. The term "exclude" by itself is bad enough and should be considered to be changed. Maybe we should add a field description then which says something like this: > Allow fields which are excluded by default Then again this is only me thinking that integrators/developers need the term "exclude" to match this field to the TCA option.
  6. Riccardo De Contardi commented on patch set 4 06/04/24, 15:00

    locallang_tca.xlf:175 Reply

    So, something like: Title: Allowed Fields Description (needs improvement): the following fields are excluded by default and must be added manually for non-admin users to use them
  7. Mathias Bolt Lesniak commented on patch set 4 06/05/24, 07:05

    locallang_tca.xlf:175 Reply

    A few thoughts: "Allowed Fields" is definitely better than "Allowed Exclude Fields". However, if the context is "access rights" and we're talking about checkboxes or other UI elements with a clear enabled/disabled state, "Fields" should be sufficient. Then the description could simply be "Enable optional fields for non-admins." It follows that I think it's sufficient with "page types" and "dashboard widgets", optionally with a similar description. The use of "access/allow" vs. "visibility/enable" is also important to consider, depending on context. A developer might think of "giving access to avoid unauthorized access", but others might think "I want this user to see these fields". Is the primary concern of the person seeing this interface to avoid all write access or to simplify the UI for a group of users? (I think the latter, and I think TYPO3 should take care of the underlaying security best practices without requiring the user to always consider the question from that context.) I have always found that "Exclude Fields" is an odd way of saying "optional" or "excludable" (depending on context). But I know, I'm crazy. A developer on domain-driven design enhancement drugs would probably settle with "discretional", "elective" or "volitional". PS! The capitalization is odd between "Allowed Page types" and "Allowed Exclude Fields" (it's either "Page Types" and "Exclude Fields" or "page types" and "exclude fields".
  8. Marcin Sągol commented on patch set 4 06/05/24, 09:49

    locallang_tca.xlf:175 Reply

    There is a bit wider context here. After discussion with UI/UX team there were changes proposed to reorganize a bit tabs and their content, see: https://review.typo3.org/c/Packages/TYPO3.CMS/+/84080. So in context of backend groups, we will now have tabs called - Module Permissions - Record Permissions Now going back to the labels. The idea behind this change was to avoid adding extra description, explaining how those sections behave. This was a follow-up to the change where the description was added to the Allowed langauges field (https://review.typo3.org/c/Packages/TYPO3.CMS/+/84078) explaining how it works (because it behaves in a different way when it comes to permissions to languages - if you do not select any, you have access to all of them ; and for example for modules, if you don't select any, you have access to non of them). Changing labels was to clearly explain user how the given section handles permissions. For example Allowed Modules tells you that you will be allowed to use them. It can be change to Enabled Modules though. I would like to have some consistency here. We have now section label: 'Allowed multi-factor authentication providers' so wither we align with this one or chnage it to match other one naming convention.
  9. Garvin Hicking commented on patch set 4 06/05/24, 10:40

    locallang_tca.xlf:175 Reply

    (Just to throw into the ring; "Exclude Fields" is a pretty common term for devs/integrators. I think improving this is good, but at least for some period we should somewhere keep the term "Exclude field" referenced to not cause confusion. Something like "This option refers to 'exclude' configuration set in TCA")
  10. Marcin Sągol commented on patch set 4 06/08/24, 20:14

    locallang_tca.xlf:175 Reply

    Right also - probably - in many places in the documentation it is used.
  11. Garvin Hicking commented on patch set 4 CR +1 V +1 06/18/24, 07:59

    I'm in favor of the current patch proposal.
  12. Marcin Sągol commented on patch set 4 06/18/24, 08:03

    Reply

    Hi, Gavin I would just make sure that we write the labels either all words uppercased or only the first one. Now we have a lot of inconsistency? Which approach would be better?
  13. Mathias Brodala commented on patch set 4 06/18/24, 08:12

    Reply

    IMO only the first should be capitalized since field names are not "headers" or section legends/labels. This also makes them easier to read.
  14. Marcin Sągol commented on patch set 4 06/18/24, 08:23

    Reply

    Fine for me. I just checked other places where various forms are used. And there is also inconsistency - sometimes uppercased labels are used, sometimes not. Maybe it would be a good idea to have some recommendation mentioned in the docs?
  15. Marcin Sągol uploaded patch set 5 CR +1 V +1 06/18/24, 08:37

  16. core-ci voted on patch set 5 V +1 06/18/24, 08:44 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/59783

  17. Garvin Hicking commented on patch set 5 CR +1 V +1 06/18/24, 10:24

    Reply

    We from the documentation team try to only uppercase words for headlines like in usual sentences, so (not a sane example): Exclude field (only in Composer Mode) and not: Exclude Field (Only In Composer Mode) This would apply to reST documentationf files and changelogs. HOWEVER, this is not what the Core often employs. There are many cases in the UI where uppercasing is used for headlines. This would probably need a decission from the Core Mergers and then a change would be needed for ALL current labels if this wants to be cleared up. That'll be a huge task to review. For now I think the best bet is to keep casing intact when changing things, and live with the rest being a personal preference depending on who creates/merges a patch. I don't think upper/lowercasing should block a well intended naming change, and I don't think applying it to only a very small scope would help. TL;DR: I would keep the currently proposed upper/lowercasing of your patch, and the rest needs to be unified with a central decision, and not the scope of this patch.
  18. Tymoteusz Motylewski commented on patch set 5 06/18/24, 11:17

    I'm strongly in favor of renaming "Allowed exclude fields". No person new to TYPO3 knows what it is, and what to expect. Which makes it bad UX. Maybe we should do the change in a dedicated patch, not to block this one, but definitely we need a self explanatory label. And maybe also adding description for the field would be necessary and adding the synonyms to documentation so it's easily findable.
  19. Marcin Sągol uploaded patch set 6 CR +1 V +1 06/26/24, 13:14

  20. core-ci voted on patch set 6 V +1 06/26/24, 13:21 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/60389

  21. Garvin Hicking voted on patch set 6 CR +1 V +1 07/10/24, 10:04

  22. Christian Kuhn commented on patch set 6 07/11/24, 22:27

    locallang_tca.xlf:175 Reply

    Acknowledged
  23. Christian Kuhn voted on patch set 6 CR +1 V +1 07/11/24, 22:27

  24. Jasmina Ließmann commented on patch set 6 CR +2 V +2 07/12/24, 04:43

    Reply

    As Garvin suggested, we keep the currently proposed upper/lowercasing of your patch.

    Reply

    This adjustment has meanwhile been made in the patch.
  25. Jasmina Ließmann merged patch set 7 07/12/24, 04:43