Task #90667

Directory names for TSconfig not consistent and also not consistent in docs (CGL, T3 Explained)

Added by Sybille Peters over 1 year ago. Updated 8 months ago.

Status:
New
Priority:
Should have
Assignee:
-
Category:
Code Cleanup
Target version:
-
Start date:
2020-03-06
Due date:
% Done:

0%

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

Description

backend/Configuration/TSconfig
felogin/Configuration/TsConfig
form/Configuration/PageTS
frontend/Configuration/TSconfig
linkvalidator/Configuration/TsConfig

It's sometimes TSconfig or TsConfig.

And it's sometimes Page in TsConfig or PageTS.

Issue was raised in docs where it is also inconsistent:

https://github.com/TYPO3-Documentation/TYPO3CMS-Reference-CoreApi/issues/794

I don't know which way should be the "correct" way.

I found the discussion in decisions which is usually used to decide these things:

But the final post with the results does not mention the folder structure:

#1

Updated by Markus Klein 8 months ago

  • Description updated (diff)
#2

Updated by Markus Klein 8 months ago

  • Description updated (diff)
#3

Updated by Markus Klein 8 months ago

Configuration/TsConfig/Page/
and
Configuration/TsConfig/User/

is the way to go IMO.

#4

Updated by Sybille Peters 8 months ago

See also merged patch: Unify spelling for TSconfig

#5

Updated by Markus Klein 8 months ago

That doesn't make the decision easier, does it?

But a completely different approach would be to rename TSconfig to what it actually is: BackendConfig

So what do you think Sybille? What's your proposal for Txxonfig?

#6

Updated by Sybille Peters 8 months ago

I haven't looked at this for a while so can't say off the top of my head.

But a completely different approach would be to rename TSconfig to what it actually is: BackendConfig

See also decision: https://decisions.typo3.org/t/clarification-of-term-typoscript/560/7?u=sypets

There was a suggestion to rename TSconfig to PageConfig and UserConfig.

Now you are suggestion BackendConfig. I think it is good to have the word Backend in there. But there is also other backend config, such as extensions configuration, $GLOBALS['TYPO3_CONF_VARS']['BE'], etc..

How about, "Backend Page Config" and "Backend User Config"

but these terms are too generic. I think it is good to have something like Flexforms which is very specific.

or "Page BackendTSconfig" and "User BackendTSconfig" - too long.

Also, I would differentiate between used in file / directory names and used in text (docs, BE GUI), so it might be

  • "Page BackendTSconfig"
  • and Configuration/BackendTSconfig/Page

I think this needs some tweaking.

There are 2 things to consider

1. What would be the best terms
2. Should we really change it because there will be lots of changes, confusion and collateral damage. (e.g. change translations, how do you even translate these things, add redirects in docs, rename files in core, change in docs) - God help us!

#7

Updated by Sybille Peters 8 months ago

Fun fact about naming of TSconfig:

Typescript uses the term "TSConfig", e.g. "TSConfig Reference" and tsconfig.json

https://www.typescriptlang.org/tsconfig

#8

Updated by Markus Klein 8 months ago

It's about time to rename TSconfig completely => BackendConfig

Also available in: Atom PDF