Review main Merged Breaking

74191[!!!][TASK] Remove context sensitive help

Michael Telgkamp CR +2 V +2 Nightmare +412 −6138 updated 04/07/22, 07:20

Commit message

The context sensitive help (CSH) is not accessible and the information
is often not useful or not updated for a long time.

As the online documentation is now improved a lot, there is a link added
in the main help menu. For short, but important additional information
to explain the usage of a field the `description` field should be used.

Review

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

Issues 1

Files 310

Show 290 more files

Review log 4262

Show 2237 earlier messages
  1. Michael Telgkamp uploaded patch set 1 04/05/22, 20:14

  2. Torben Hansen updated the commit message in patch set 2 04/05/22, 20:19

  3. core-ci voted on patch set 1 V -1 04/05/22, 20:27 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/25558

  4. Michael Telgkamp uploaded patch set 3 04/05/22, 20:32

  5. core-ci voted on patch set 2 V -1 04/05/22, 20:35 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/25559

  6. Oli Bartsch commented on patch set 3 04/05/22, 20:37

    ext_tables.php:1

    This file should also be removed.
  7. Michael Telgkamp uploaded patch set 4 04/05/22, 20:41

  8. core-ci voted on patch set 3 V -1 04/05/22, 20:43 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/25560

  9. core-ci voted on patch set 4 V -1 04/05/22, 20:57 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/25561

  10. Benni Mack commented on patch set 4 04/05/22, 21:11

    I like this one in general! I added a few remarks

    ButtonBar.php:156

    please add a trigger_error() call here.

    HelpButton.php:36

    I guess we need to keep this one, in a way to NOT render any content in v12. and mark it as deprecated with trigger_error()

    BackendUtility.php:1892

    the method is internal and can be removed directly

    BackendUtility.php:1906

    the method is internal, can be removed directly

    LanguageService.php:208

    needs a trigger_error() call

    Breaking-97312-RemoveContextSensitiveHelp.rst:34

    we should also list the removed entry points and module

    Breaking-97312-RemoveContextSensitiveHelp.rst:36

    Can you provide an example here?
  11. Michael Telgkamp uploaded patch set 5 04/05/22, 22:17

  12. core-ci voted on patch set 5 V -1 04/05/22, 22:28 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/25567

  13. Michael Telgkamp uploaded patch set 6 04/06/22, 07:22

  14. core-ci voted on patch set 6 V -1 04/06/22, 07:33 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/25578

  15. Benni Mack uploaded patch set 7 04/06/22, 08:32

  16. Benni Mack uploaded patch set 8 04/06/22, 08:41

  17. core-ci voted on patch set 7 V -1 04/06/22, 08:43 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/25591

  18. core-ci voted on patch set 8 V -1 04/06/22, 08:57 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/25594

  19. Michael Telgkamp uploaded patch set 9 04/06/22, 10:06

  20. core-ci voted on patch set 9 V -1 04/06/22, 10:19 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/25610

  21. Michael Telgkamp uploaded patch set 10 04/06/22, 10:26

  22. core-ci voted on patch set 10 V -1 04/06/22, 10:39 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/25616

  23. Michael Telgkamp uploaded patch set 11 04/06/22, 11:13

  24. core-ci voted on patch set 11 V +1 04/06/22, 11:24 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/25621

  25. Michael Telgkamp commented on patch set 9 04/06/22, 11:24

    Thank you for the helping comments. I tried to adjust everything mentioned.

    ButtonBar.php:156 Reply

    Trigger call is added

    HelpButton.php:36 Reply

    The class is added with a deprecation warning in the render() method

    BackendUtility.php:1892 Reply

    The method is removed and the removal is mentioned in the rst.

    BackendUtility.php:1906 Reply

    The method is removed and the removal is mentioned in the rst.

    LanguageService.php:208 Reply

    As the method was @internal the method is removed and the removal is mentioned in the rst.

    Breaking-97312-RemoveContextSensitiveHelp.rst:34 Reply

    the rst is adjusted.

    Breaking-97312-RemoveContextSensitiveHelp.rst:36 Reply

    an example is added

    ext_tables.php:1 Reply

    The file is now removed.
  26. Oli Bartsch commented on patch set 11 04/06/22, 12:47

    Please add proper line breaks to the commit message.

    runTests.sh:246

    I think this was not commited intentionally?

    context-help.ts:16

    unused

    context-help.ts:17

    unused

    context-help.ts:21

    unused

    context-help.ts:77

    According to the comment, this might also be removed.

    FullRecordContainer.php:42

    This should get a TCAMigration. Additionally, EXT:frontend/Configuration/TCA/tt_content.php still defines the property.

    SelectCheckBoxElement.php:274

    We might use the description from removed BackendUtility::wrapInHelp() here?

    ButtonBar.php:155

    This needs an entry in the extension scanner (MethodCallMather)

    HelpButton.php:36

    The whole class should be deprecated. Triggering an error could IMO be done in the constructor. This then also needs a extension scanner entry (ClassNameMatcher).

    HelpButton.php:152

    Let's move the trigger_error to the __construct() since the whole class should be deprecated.

    BackendUtility.php:1895

    Needs an entry in the extension scanner (MethodCallStaticMatcher)

    ExtensionManagementUtility.php:832

    Any reason for not adding a trigger_error() here? Needs an entry in the extension scanner (MethodCallStaticMatcher)

    Breaking-97312-RemoveContextSensitiveHelp.rst:5

    Those should match the ending of the title

    Breaking-97312-RemoveContextSensitiveHelp.rst:12

    Since this is an internal class, no mention necessary.

    Breaking-97312-RemoveContextSensitiveHelp.rst:18

    Since this is an internal class, no mention necessary.

    Breaking-97312-RemoveContextSensitiveHelp.rst:21

    Since this is an internal class, no mention necessary.

    Breaking-97312-RemoveContextSensitiveHelp.rst:22

    $GLOBALS['TCA_DESCR'] needs to be removed properly. This includes: - Extension scanner entry (ArrayGlobalMatcher) - Remove from Bootsrap::unsetReservedGlobalVariables() - Remove from ConfigurationModuleProviderCest::dropDownPagesDataProvider() - Remove corresponding configuration provider from EXT:lowlevel/Configuration/Services.yaml with the corresponding locallang label - TcaItemsProcessorFunctionsTest still fills this array in test cases

    Breaking-97312-RemoveContextSensitiveHelp.rst:34

    Since this is an internal method, no mention necessary.

    Breaking-97312-RemoveContextSensitiveHelp.rst:38

    Since this methods are internal, no mention necessary.

    CshViewHelper.php:87

    Would suggest sth like: __CLASS__ only returns the $renderChildrenClosure() in TYPO3 v12 as compatibility layer and will be completely removed in TYPO3 v13.

    CshViewHelper.php:83

    Lets use __CLASS__ here

    CshViewHelperTest.php:41

    If this is still done in the viewHelper, the test should not be removed but moved to /Tests/FunctionalDeprecated/

    AdvancedOptions.html:22

    Why do we remove this label here completely?

    Upload.html:11

    Why do we remove this label here completely?

    DatabaseRecordList.php:666

    This "if" looks superfluous now.

    SetupModuleController.php:667

    This is no longer used. Is this correct? Then we should drop the method.
  27. Michael Telgkamp uploaded patch set 12 04/06/22, 14:43

  28. Michael Telgkamp updated the commit message in patch set 13 04/06/22, 14:44

  29. Michael Telgkamp updated the commit message in patch set 14 04/06/22, 14:46

  30. Michael Telgkamp commented on patch set 14 04/06/22, 14:56

    Reply

    Done

    runTests.sh:246 Reply

    Done

    context-help.ts:16 Reply

    Done

    context-help.ts:17 Reply

    Done

    context-help.ts:21 Reply

    Done

    context-help.ts:77 Reply

    Done

    FullRecordContainer.php:42 Reply

    Done

    SelectCheckBoxElement.php:274 Reply

    I adjusted the description and renamed the variable to fit better to the usage.

    ButtonBar.php:155 Reply

    Done

    HelpButton.php:36 Reply

    Done

    HelpButton.php:152 Reply

    Done

    BackendUtility.php:1895 Reply

    Done

    ExtensionManagementUtility.php:832 Reply

    The reason is that this function is called on every page load and might flood the deprecation logs.

    Breaking-97312-RemoveContextSensitiveHelp.rst:5 Reply

    Done

    Breaking-97312-RemoveContextSensitiveHelp.rst:12 Reply

    Done

    Breaking-97312-RemoveContextSensitiveHelp.rst:18 Reply

    Done

    Breaking-97312-RemoveContextSensitiveHelp.rst:21 Reply

    Done

    Breaking-97312-RemoveContextSensitiveHelp.rst:22 Reply

    Done

    Breaking-97312-RemoveContextSensitiveHelp.rst:34 Reply

    Done

    Breaking-97312-RemoveContextSensitiveHelp.rst:38 Reply

    Done

    CshViewHelper.php:87 Reply

    Done

    CshViewHelper.php:83 Reply

    Done

    CshViewHelperTest.php:41 Reply

    Done

    AdvancedOptions.html:22 Reply

    This was an error, Label is added again, but without buttons.csh

    Upload.html:11 Reply

    This was an error, Label is added again, but without buttons.csh

    DatabaseRecordList.php:666 Reply

    Done

    SetupModuleController.php:667 Reply

    Done
  31. core-ci voted on patch set 12 V +1 04/06/22, 14:57 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/25657

  32. core-ci voted on patch set 13 V -1 04/06/22, 14:59 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/25658

  33. core-ci voted on patch set 14 V +1 04/06/22, 15:03 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/25660

  34. Andreas Kienast commented on patch set 14 CR -1 04/06/22, 15:08

    on it
  35. Andreas Kienast uploaded patch set 15 04/06/22, 15:12

  36. core-ci voted on patch set 15 V +1 04/06/22, 15:29 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/25664

  37. Andreas Kienast commented on patch set 15 CR -1 04/06/22, 15:45

    still on it
  1. Andreas Kienast uploaded patch set 16 04/06/22, 16:28

  2. Andreas Kienast commented on patch set 16 V +1 CR +1 04/06/22, 16:29

    Looks fine to me now.
  3. core-ci voted on patch set 16 V +1 04/06/22, 16:36 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/25674

  4. Oliver Hader commented on patch set 16 04/06/22, 17:35

    Breaking-87193-DeprecatedFunctionalityRemoved.rst:97

    This line should be kept, shouldn't it? Since it refers to docs of TYPO3 v10.0.
  5. Michael Telgkamp uploaded patch set 17 04/06/22, 17:47

  6. Michael Telgkamp commented on patch set 17 04/06/22, 17:48

    Breaking-87193-DeprecatedFunctionalityRemoved.rst:97 Reply

    Done
  7. Oliver Hader voted on patch set 17 CR +1 04/06/22, 17:49

  8. core-ci voted on patch set 17 V +1 04/06/22, 18:02 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/25688

  9. Oliver Hader voted on patch set 17 V +1 04/06/22, 18:08

  10. Georg Ringer voted on patch set 17 V +1 CR +1 04/06/22, 18:13

  11. Oli Bartsch commented on patch set 16 CR -1 04/06/22, 18:36

    Thanks for all the adjustments! Had a second look, giving -1 because of the missing TCA migration tests.

    SelectCheckBoxElement.php:280

    This annotation can be dropped since the method is already protected.

    TcaMigration.php:1098

    Let's also remove ['interface'] if it gets empty due to removal of "always_description" Please also cover this with a test.

    Breaking-97312-RemoveContextSensitiveHelp.rst:11

    Could we please add some sort of actual description about the why and how?
  12. Oli Bartsch voted on patch set 17 CR -1 04/06/22, 18:37

  13. Michael Telgkamp uploaded patch set 18 04/06/22, 19:19

  14. Michael Telgkamp commented on patch set 17 04/06/22, 19:20

    SelectCheckBoxElement.php:280 Reply

    Done

    TcaMigration.php:1098 Reply

    Done

    Breaking-97312-RemoveContextSensitiveHelp.rst:11 Reply

    Done
  15. core-ci voted on patch set 18 V +1 04/06/22, 19:29 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/25699

  16. Oli Bartsch uploaded patch set 19 04/06/22, 19:42

  17. Oli Bartsch commented on patch set 19 V +1 CR +1 04/06/22, 19:43

    Great patch, thanks a lot!
  18. core-ci voted on patch set 19 V +1 04/06/22, 19:56 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/25701

  19. Stefan Bürk commented on patch set 19 V +1 CR +1 04/06/22, 21:03

    Thanks for the work on this patch, Michael (and others).
  20. Georg Ringer voted on patch set 19 V +1 CR +1 04/07/22, 03:57

  21. Andreas Kienast uploaded patch set 20 04/07/22, 06:34

  22. Andreas Kienast voted on patch set 20 V +1 CR +1 04/07/22, 06:35

  23. core-ci voted on patch set 20 V +1 04/07/22, 06:44 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/25707

  24. Oli Bartsch voted on patch set 20 V +2 CR +2 04/07/22, 07:20

  25. Oli Bartsch merged patch set 21 04/07/22, 07:20