Should CSH Functionality be dropped?
I propose that we should remove the CSH functionality (including TCA_DESCR) fully in TYPO3 v10.0.
- The concept was really cool back in TYPO3 3.x and 4.0 when the help was displayed inline or via frames, however the main documentation has evolved and the functionality was hidden more and more within 4.x development already to clean up the UI (mainly FormEngine)
- We literally haven’t had any maintainer for 10+ years now within Core - thus: we have outdated information, and if nobody will step up this will not change
- Currently CSH is very limited and hacky for FormEngine / TCA data and modules, and hard to exchange for project specific information
- docs.typo3.org gains more attraction where the actual documentation of fields / functionality as provided by TYPO3 Core could / should be located. This way we do not have to update screenshots or functionality and make new releases for these kind of things
- This way, also the base package (tar.gz/zip) gets smaller as we don’t ship (outdated) screenshots for documentation anymore
- The technical basis (global array based on XLF language files) is very outdated. The last time there were changes was back in 4.x when I made the overlays “load via AJAX”.
- I hardly got feedback on using CSH in the past 4 years - only some minor content updates and questions about “which docs is right? docs.typo3.org or inline CSH?”
I think, inline documentation is very powerful, but it would be even more powerful to have project-specific docs in an installation, where integrators/admins can show context-specific information for every part of TYPO3 - even personalized on a per-user / per-group basis. But the CSH construct seems not the right weapon of choice here.
Impact for v10.0
- We’ll deprecate API functions within LanguageService, BackendUtility and ExtensionManagementUtility
- We’ll remove all usages of TCA_DESCR and the Backend module for “browsing” the manual within TYPO3
- We’ve seen some guided tour approaches (currently in TER) during T3UXW a few years back, a way better approach to get newcomers into TYPO3 Backend - lets put more effort in functionality like this
- We should include links to docs.typo3.org as much as possible within TYPO3 Core to help integrators, admins and extension authors do things “the right way”
- I call for people coming up with good concepts addressing the issues above and create a better UX for both the people writing context-based docs and having them visible. These days, some AJAX / JS based functionality should be built.
I agree, we should usually first come up with new concepts and implement them instead of just removing them, but in this case, I haven’t seen feeling the need for coming up with new ideas.
- No outdated docs in core package
- Smaller footprint of the tar.gz / zip files
- More focus / attention on docs.typo3.org
- No CSH anymore, no help icons anymore
- No “replacement” in place already
Topic Initiator: Benni Mack
Topic Mentor: Benni Mack