Project

General

Profile

Actions

Task #97312

closed

Remove CSH

Added by Michael Telgkamp over 2 years ago. Updated almost 2 years ago.

Status:
Closed
Priority:
Should have
Category:
Backend User Interface
Target version:
-
Start date:
2022-04-05
Due date:
% Done:

100%

Estimated time:
TYPO3 Version:
12
PHP Version:
Tags:
Complexity:
Sprint Focus:

Description

As proposed in the slack channel #typo3-cms-coredev we should get rid of the CSH (context sensitive help) completely for TYPO3 v12

Here are the arguments for removement I see:
  • The help is not really context sensitive, it only relies on tablename and fieldname, if a field is used for different purposes in different content types, the CSH always shows the same help
  • There is outdated information in CSH (e.g. Screenshots form TYPO3 4.x) and noone is available to update the information
  • Some CSH descriptions explain the same content with different words which is confusing (e.g. tt_content - CType > Title: "Type" > CSH Tooltip: "Select the kind of Page Content this element represents. New options will appear when you save the record.")
  • Many CSH texts do not provide useful additional information (e.g. tt_content - header > Title: "Header" > CSH Tooltip: "Enter header text for the Content Element.")
  • The currently available online documentation https://docs.typo3.org/ improved a lot and should helps better than the CSH in most cases, as it is up to date
  • CSH is hidden for most users currently, as it is only available by clicking on a label (no hint that help is available without hovering the label by mouse, not available for keyboard users)
  • description is available for explainations when they are required. Adding relevant information as description will help everyone as it is visible. Additionally breaking changes on a field that need adjustment of the description will be observed.
  • The removal was already proposed in 2019 (see https://decisions.typo3.org/t/drop-context-sensitive-help-in-core/511) and most arguments against removal can be solved using the description or by linking to the official documentation
  • Removal of CSH also removes a lot of outdated files (and results in smaller footprint of the TYPO3 core package)

Related issues 4 (0 open4 closed)

Related to TYPO3 Core - Bug #97349: Scheduler "Add Task" view brokenClosed2022-04-08

Actions
Related to TYPO3 Core - Bug #77601: CSH for TCA not working inside "Inline"-Elements.Closed2016-08-22

Actions
Related to TYPO3 Core - Bug #94483: CSH show more arrow not visibleClosed2021-07-05

Actions
Related to TYPO3 Core - Task #101058: Remove deprecated CSH related codeClosed2023-06-14

Actions
Actions

Also available in: Atom PDF