[WIP] adjust doc for extending the user settings#6502
Draft
can0199 wants to merge 1 commit into
Draft
Conversation
can0199
force-pushed
the
feature/extend-user-settings
branch
from
f703bec to
1a1f7bd
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Since TYPO3 v14.2, the user settings configuration has been migrated to a TCA-based approach:
https://docs.typo3.org/c/typo3/cms-core/main/en-us/Changelog/14.2/Feature-108843-UserSettingsConfigurationMigratedToTCA.html#feature-108843-1738600001
The current documentation still describes the legacy method using
$GLOBALS['TYPO3_USER_SETTINGS'].This pull request updates the “Extending the user settings” section to reflect the new TCA-based configuration introduced in v14.
The documentation now explains:
ExtensionManagementUtility::addUserSetting()Configuration/TCA/Overrides/be_users.phpNote regarding button fields
While reviewing the migration, I noticed that there is currently no documented TCA
type => 'button'for user settings.In the legacy
$GLOBALS['TYPO3_USER_SETTINGS']configuration, it was possible to define button-like elements with confirmation dialogs.With the migration to TCA, only documented and supported TCA field types are available.
As far as I can see, there is currently no direct TCA equivalent for defining a dedicated button field with confirmation behavior inside
user_settings.If such functionality is still intended to be supported, it might need clarification or additional documentation.
Work in Progress
This PR is currently marked as work in progress.
I am not entirely sure how the existing documentation sections related to
columnsandshowitemshould be structured after the migration. Before making further structural changes, I would like to use this PR as a basis for discussion on how the overall section should be reorganized.Feedback is very welcome.
Please let me know if I can further assist or adjust the changes.