Story #94322

Inconsistencies in showing page TSconfig in Info module

Added by Sybille Peters about 2 months ago. Updated about 1 month ago.

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

33%

Estimated time:
(Total: 0.00 h)
TYPO3 Version:
11
PHP Version:
Tags:
Sprint Focus:

Description

TYPO3 backend => Info => Page TSconfig

Proposed solution

1. Consistent naming in the select list (see #94322)
2. (?) Remove "Module: Web > Modules" - as a module "Modules" no longer exists (#94324
3. Same order in results for "all" as order in select list (if "sort alphabetically" is not checked)
4. Use the same naming scheme and order in the documentation: https://docs.typo3.org/m/typo3/reference-tsconfig/master/en-us/PageTsconfig/Mod.html#

Related: naming conventions for extensions #94325

e.g.

  • All
  • Module [mod]
  • Module: Web > Page [mod.web_layout]
  • Module: Web > View [mod.web_view]
  • ...
  • Rich text editor [RTE] *

to be done: find a nice descriptive representation for "TCEMAIN", "TCEFORM" ...

I am using the `[...]` style of putting the technical representation in brackets as that is already customary for e.g. page ids, page fields, fields in Flexform etc. in the Backend forms.

Problem

In the select list, there is a mixture of showing the objects in

1. their technical representation as they are used in TSConfig, e.g. "TCEMAIN"
2. in a full plaintext representation, e.g. "Module: Web>Page"
3. and a mixture , e.g. " "Module key (mod) with overruling user settings"

Should be done consistently, IMHO.

Also, the sorting in the results for "all" should then be the same sorting as in the select list.

What I find important is that you can look at the list and then find this info in the documentation (and vice versa), maybe even have the docs page open while you go through the list.

Example

When I look at "Module: Web>Page" I find this confusing. This is "mod.web_layout". I think it is done to point out where this applies and this is good, but you need both information. Here, the technical representation is missing, which also makes it difficult to use the option.

Use case

You don't know all the options by heart and things are still a little muddled. You configured the Backend Layouts and now want to check in Info => Page TSConfig.

Where is it? You don't know. You can look at "all" and then find it (with CTRL+f) but then you still don't know where it is in the select list the next time you need it (unless you already clicked and "got" the relation "Web > Page = "web_layout").

If you do got directly to "Module: Web> Page" in the select list, you do not see the missing piece "web_layout" but you need it to define, e.g.

mod.web_layout.BackendLayout

and not

mod.BackendLayout

This can make it error prone and confusing.

screenshots

Info > Page TSconfig > select box


Files

tsconfig_select.png (24.4 KB) tsconfig_select.png "Info" > "Page TSconfig" > select box Sybille Peters, 2021-06-12 06:39

Subtasks

Bug #94321: Info => Page TSconfig: Sort orderNew2021-06-12

Actions
Bug #94323: Fix naming inconsistencies in module "Info > Page TSconfig"Resolved2021-06-12

Actions
Bug #94324: Remove "Module Web>Modules" from select list in Info > Page TSconfigUnder ReviewSybille Peters2021-06-12

Actions

Related issues

Related to TYPO3 Core - Feature #94320: Have collapse / expand in list of page TSconfig in Info moduleNew2021-06-12

Actions
Related to TYPO3 Core - Task #94325: Naming conventions for extensions for extending Page TSconfigNew2021-06-12

Actions
#1

Updated by Sybille Peters about 2 months ago

  • Related to Bug #94321: Info => Page TSconfig: Sort order added
#2

Updated by Sybille Peters about 2 months ago

  • Related to Feature #94320: Have collapse / expand in list of page TSconfig in Info module added
#3

Updated by Sybille Peters about 2 months ago

  • Tracker changed from Bug to Story
#4

Updated by Sybille Peters about 2 months ago

  • Description updated (diff)
#5

Updated by Sybille Peters about 2 months ago

  • Subject changed from Inconsistencies in showing page TSconfig (naming and sorting) to Inconsistencies in showing page TSconfig in Info module
#6

Updated by Sybille Peters about 2 months ago

  • Description updated (diff)
#7

Updated by Sybille Peters about 2 months ago

  • Related to Task #94325: Naming conventions for extensions for extending Page TSconfig added
#8

Updated by Sybille Peters about 2 months ago

  • Description updated (diff)

Also available in: Atom PDF