Project

General

Profile

Actions

Task #94325

open

Naming conventions for extensions for extending Page TSconfig

Added by Sybille Peters almost 3 years ago. Updated 11 months ago.

Status:
New
Priority:
Should have
Assignee:
-
Category:
Backend API
Target version:
-
Start date:
2021-06-12
Due date:
% Done:

0%

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

Description

What namespace should extensions use for naming the TSconfig settings (e.g. "tx_myext", "mod.tx_myext", "user.tx_myext" ...).

Should core and extension settings be separated?

How the namespace is also affects how they are displayed in "Info > Page TSconfig" (the order and if they can be selected in the select field"

Also, ideally the core settings should be unified in using uppercase / lowercase in the top-level "objects", currently we have a mix of all uppercase and all lowercase. There may be some deeper meaning or reason I am not aware of, but from what I wrote in #94321:

For basic coredev installation it looks like this:
  • TCEFORM
  • TCEMAIN
  • mod
    ... I think it would be better to (long term) unify the naming so that the top-level items are all lowercase.
    In TypoScript, by convention the type of the "objects" are uppercase (e.g. PAGE) and the "objects" themselves are lowercase. So I think TCEFORM, TCEMAIN etc. should be changed to lowercase. (This sometimes mixing of type and "object" and inconsistent usage of terms is something which was not just noticed and pointed out by me, we already make some changes in the "TypoScript Reference" to address this).

Requirements

1. Make it possible to easily find the settings in the filter options in "Info > Page TSconfig".
2. All extension TSconfig should be grouped together, not found in various places
3. They should be grouped logically
4. use an intuitive convention that is easy to remember

The difficulty is finding a good namespace. In mod, you have the namespaces per module, e.g mod.web_info, but you might rather want to group by extension key or group by third party extensions in general.

Examples for existing TSconfig:

Examples for extension TSconfig and how they are displayed.

  • news: tx_news: only appears in "all" (this is what news uses)
  • linkvalidator: mod.linkvalidator: appears in "all" and in "mod"
  • direct_mail: mod.web_modules.dmail : appears in "Module: Web>Modules"

Related issues 1 (0 open1 closed)

Related to TYPO3 Core - Story #94322: Inconsistencies in showing page TSconfig in Info moduleClosed2021-06-12

Actions
Actions

Also available in: Atom PDF