[DOCS] Add TCA path information (#520)

* [DOCS] Add TCA path information Add information about where exactly the configuration is located in the TCA array releases: main, 11.5 * Update FieldControl.rst * Update FieldControl.rst Co-authored-by: lina.wolf <lwolf@w-commerce.de>
TYPO3-Documentation · Jan 23, 2022 · 8385a2e · 8385a2e
1 parent f3ec502
commit 8385a2e
Show file tree

Hide file tree

Showing 194 changed files with 263 additions and 48 deletions.
diff --git a/Documentation/Columns/Properties/Config.rst b/Documentation/Columns/Properties/Config.rst
@@ -7,6 +7,7 @@ config
 
 .. confval:: config
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]
    :Required: true
    :type: array
    :Scope: Proc. / Display

diff --git a/Documentation/Columns/Properties/Description.rst b/Documentation/Columns/Properties/Description.rst
@@ -7,6 +7,7 @@ Description
 
 .. confval:: description
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]
    :Required: false
    :type: string or LLL reference
    :Scope: Display

diff --git a/Documentation/Columns/Properties/DisplayCond.rst b/Documentation/Columns/Properties/DisplayCond.rst
@@ -15,6 +15,7 @@ FlexForm values.
 
 .. confval:: displayCond
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]
    :Required: false
    :type: string / array
    :Scope: Display

diff --git a/Documentation/Columns/Properties/Exclude.rst b/Documentation/Columns/Properties/Exclude.rst
@@ -7,6 +7,7 @@ exclude
 
 .. confval:: exclude
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]
    :Required: false
    :type: boolean
    :Scope: Proc. / Display

diff --git a/Documentation/Columns/Properties/L10nDisplay.rst b/Documentation/Columns/Properties/L10nDisplay.rst
@@ -7,6 +7,7 @@ Localization display (l10n\_display)
 
 .. confval:: l10n_display
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]
    :Required: false
    :type: string (list of keywords)
    :Scope: Display

diff --git a/Documentation/Columns/Properties/L10nMode.rst b/Documentation/Columns/Properties/L10nMode.rst
@@ -7,6 +7,7 @@ Localization mode (l10n_mode)
 
 .. confval:: l10n_mode
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]
    :Required: false
    :type: string (keyword)
    :Scope: Display / Proc.
@@ -67,5 +68,5 @@ be copied without a prepended string.
 
 .. code-block::
    :caption: EXT:my_sitepackage/Configuration/TCA/Overrides/tt_content.php
-   
+
    $GLOBALS['TCA']['tt_content']['columns']['header']['l10n_mode'] = ''
diff --git a/Documentation/Columns/Properties/Label.rst b/Documentation/Columns/Properties/Label.rst
@@ -7,6 +7,7 @@ label
 
 .. confval:: label
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]
    :Required: true
    :type: string or LLL reference
    :Scope: Display

diff --git a/Documentation/Columns/Properties/OnChange.rst b/Documentation/Columns/Properties/OnChange.rst
@@ -7,6 +7,7 @@ onChange
 
 .. confval:: onChange
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]
    :Required: false
    :type: string
    :Scope: Display

diff --git a/Documentation/ColumnsConfig/CommonProperties/AutoSizeMax.rst b/Documentation/ColumnsConfig/CommonProperties/AutoSizeMax.rst
@@ -8,6 +8,7 @@ autoSizeMax
 
 .. confval:: autoSizeMax
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']
    :type: integer
    :Scope: Display
    :Types: :ref:`select <columns-select>`, :ref:`group <columns-group>`, :ref:`inline <columns-inline>`

diff --git a/...tation/ColumnsConfig/CommonProperties/BehaviourAllowLanguageSynchronization.rst b/...tation/ColumnsConfig/CommonProperties/BehaviourAllowLanguageSynchronization.rst
@@ -8,6 +8,7 @@ allowLanguageSynchronization behaviour
 
 .. confval:: behaviour > allowLanguageSynchronization
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']
    :type: boolean
    :Scope: Proc.
    :Types: :ref:`check <columns-check>`, :ref:`flex <columns-flex>`,
@@ -17,9 +18,9 @@ allowLanguageSynchronization behaviour
       :ref:`radio <columns-radio>`
 
    Allows an editor to select in a localized record whether the value is copied
-   over from default or source language record, or if the field has an own value 
-   in the localization. If set to true and if the table supports localization 
-   and if a localized record is edited, this setting enables FieldWizard 
+   over from default or source language record, or if the field has an own value
+   in the localization. If set to true and if the table supports localization
+   and if a localized record is edited, this setting enables FieldWizard
    :ref:`LocalizationStateSelector <columns-input-properties-fieldWizard-localizationStateSelector>`:
    Two or three radio buttons shown below the field input. The state of this is
    stored in a json encoded array in the database table called :code:`l10n_state`.

diff --git a/Documentation/ColumnsConfig/CommonProperties/Default.rst b/Documentation/ColumnsConfig/CommonProperties/Default.rst
@@ -7,6 +7,7 @@ default
 
 .. confval:: default
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']
    :type: integer / string
    :Scope: Display / Proc.
    :Types: :ref:`group <columns-group>`, :ref:`input <columns-input>`,

diff --git a/Documentation/ColumnsConfig/CommonProperties/DontRemapTablesOnCopy.rst b/Documentation/ColumnsConfig/CommonProperties/DontRemapTablesOnCopy.rst
@@ -7,6 +7,7 @@ dontRemapTablesOnCopy
 
 .. confval:: dontRemapTablesOnCopy
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']
    :type: string (list of tables)
    :Scope: Proc.
    :Types: :aspect:`Description`

diff --git a/Documentation/ColumnsConfig/CommonProperties/FieldControl.rst b/Documentation/ColumnsConfig/CommonProperties/FieldControl.rst
@@ -7,6 +7,7 @@ fieldControl
 
 .. confval:: fieldControl
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']
    :type: array
    :Scope: Display
    :Types: :ref:`group <columns-group>`,

diff --git a/Documentation/ColumnsConfig/CommonProperties/FieldControl/AddRecord.rst b/Documentation/ColumnsConfig/CommonProperties/FieldControl/AddRecord.rst
@@ -7,6 +7,7 @@ addRecord
 
 .. confval:: addRecord
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldControl']
    :type: array
    :Scope: fieldControl
    :Types: :ref:`group <columns-group>`
@@ -56,6 +57,7 @@ Options
 
 .. confval:: disabled
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldControl']['addRecord']
    :type: boolean
    :Scope: fieldControl -> addRecord
    :Default: true
@@ -65,6 +67,7 @@ Options
 
 .. confval:: options[pid]
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldControl']['addRecord']
    :type: string
    :Scope: fieldControl -> addRecord
    :Values: marker or an integer
@@ -83,6 +86,7 @@ Options
 
 .. confval:: options[table]
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldControl']['addRecord']
    :type: string
    :Scope: fieldControl -> addRecord
    :Values: name of the table
@@ -95,6 +99,7 @@ Options
 
 .. confval:: options[title]
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldControl']['addRecord']
    :type: string
    :Scope: fieldControl -> addRecord
    :Values: string or LLL reference
@@ -104,6 +109,7 @@ Options
 
 .. confval:: options[setValue]
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldControl']['addRecord']
    :type: string
    :Scope: fieldControl -> addRecord
    :Values: string

diff --git a/Documentation/ColumnsConfig/CommonProperties/FieldControl/EditPopup.rst b/Documentation/ColumnsConfig/CommonProperties/FieldControl/EditPopup.rst
@@ -7,6 +7,7 @@ editPopup
 
 .. confval:: editPopup
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldControl']
    :type: array
    :Scope: fieldControl
    :Types: :ref:`group <columns-group>`
@@ -23,6 +24,7 @@ Options
 
 .. confval:: disabled
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldControl']['editPopup']
    :type: boolean
    :Scope: fieldControl -> editPopup
    :Default: true
@@ -32,6 +34,7 @@ Options
 
 .. confval:: options[title]
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldControl']['editPopup']
    :type: string
    :Scope: fieldControl -> editPopup
    :Values: string or LLL reference
@@ -41,6 +44,7 @@ Options
 
 .. confval:: options[windowOpenParameters]
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldControl']['editPopup']
    :type: string
    :Scope: fieldControl -> editPopup
    :Values: string or LLL reference

diff --git a/Documentation/ColumnsConfig/CommonProperties/FieldControl/ListModule.rst b/Documentation/ColumnsConfig/CommonProperties/FieldControl/ListModule.rst
@@ -7,6 +7,7 @@ listModule
 
 .. confval:: listModule
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldControl']
    :type: array
    :Scope: fieldControl
    :Types: :ref:`group <columns-group>`
@@ -23,6 +24,7 @@ Options
 
 .. confval:: disabled
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldControl']['listModule']
    :type: boolean
    :Scope: fieldControl -> listModule
    :Default: true
@@ -32,6 +34,7 @@ Options
 
 .. confval:: options[pid]
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldControl']['listModule']
    :type: string
    :Scope: fieldControl -> addRecord
    :Values: marker or an integer
@@ -50,6 +53,7 @@ Options
 
 .. confval:: options[table]
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldControl']['listModule']
    :type: string
    :Scope: fieldControl -> listModule
    :Values: name of the table
@@ -62,6 +66,7 @@ Options
 
 .. confval:: options[title]
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldControl']['listModule']
    :type: string
    :Scope: fieldControl -> listModule
    :Values: string or LLL reference

diff --git a/Documentation/ColumnsConfig/CommonProperties/FieldControl/ResetSelection.rst b/Documentation/ColumnsConfig/CommonProperties/FieldControl/ResetSelection.rst
@@ -7,6 +7,7 @@ resetSelection
 
 .. confval:: resetSelection
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldControl']
    :type: array
    :Scope: fieldControl
    :Types: :aspect:`Description`

diff --git a/Documentation/ColumnsConfig/CommonProperties/FieldInformation.rst b/Documentation/ColumnsConfig/CommonProperties/FieldInformation.rst
@@ -7,6 +7,7 @@ fieldInformation
 
 .. confval:: fieldInformation
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']
    :type: array
    :Scope: Display
    :Types: :ref:`check <columns-check>`, :ref:`flex <columns-flex>`,

diff --git a/Documentation/ColumnsConfig/CommonProperties/FieldWizard.rst b/Documentation/ColumnsConfig/CommonProperties/FieldWizard.rst
@@ -7,6 +7,7 @@ fieldWizard
 
 .. confval:: fieldWizard
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']
    :type: array
    :Scope: Display
    :Types: :ref:`check <columns-check>`, :ref:`flex <columns-flex>`,

diff --git a/...ation/ColumnsConfig/CommonProperties/FieldWizard/DefaultLanguageDifferences.rst b/...ation/ColumnsConfig/CommonProperties/FieldWizard/DefaultLanguageDifferences.rst
@@ -7,6 +7,7 @@ defaultLanguageDifferences
 
 .. confval:: defaultLanguageDifferences
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldWizard']
    :type: array
    :Scope: fieldWizard
    :Types: :ref:`check <columns-check>`, :ref:`flex <columns-flex>`,

diff --git a/...tation/ColumnsConfig/CommonProperties/FieldWizard/LocalizationStateSelector.rst b/...tation/ColumnsConfig/CommonProperties/FieldWizard/LocalizationStateSelector.rst
@@ -7,6 +7,7 @@ localizationStateSelector
 
 .. confval:: localizationStateSelector
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldWizard']
    :type: array
    :Scope: fieldWizard
 

diff --git a/Documentation/ColumnsConfig/CommonProperties/FieldWizard/OtherLanguageContent.rst b/Documentation/ColumnsConfig/CommonProperties/FieldWizard/OtherLanguageContent.rst
@@ -7,6 +7,7 @@ otherLanguageContent
 
 .. confval:: otherLanguageContent
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldWizard']
    :type: array
    :Scope: fieldWizard
    :Types: :ref:`check <columns-check>`, :ref:`flex <columns-flex>`,

diff --git a/Documentation/ColumnsConfig/CommonProperties/FieldWizard/RecordsOverview.rst b/Documentation/ColumnsConfig/CommonProperties/FieldWizard/RecordsOverview.rst
@@ -7,6 +7,7 @@ recordsOverview
 
 .. confval:: recordsOverview
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldWizard']
    :type: array
    :Scope: fieldWizard
    :Types: :ref:`group <columns-group>`

diff --git a/Documentation/ColumnsConfig/CommonProperties/FieldWizard/SelectIcons.rst b/Documentation/ColumnsConfig/CommonProperties/FieldWizard/SelectIcons.rst
@@ -7,6 +7,7 @@ selectIcons
 
 .. confval:: selectIcons
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldWizard']
    :type: array
    :Scope: fieldWizard
 

diff --git a/Documentation/ColumnsConfig/CommonProperties/FieldWizard/TableList.rst b/Documentation/ColumnsConfig/CommonProperties/FieldWizard/TableList.rst
@@ -7,6 +7,7 @@ tableList
 
 .. confval:: tableList
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']['fieldWizard']
    :type: array
    :Scope: fieldWizard
    :Types: :ref:`group <columns-group>`

diff --git a/Documentation/ColumnsConfig/CommonProperties/ItemsProcFunc.rst b/Documentation/ColumnsConfig/CommonProperties/ItemsProcFunc.rst
@@ -7,6 +7,7 @@ itemsProcFunc
 
 .. confval:: itemsProcFunc
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']
    :type: string (class->method reference)
    :Scope: Display / Proc.
    :Types: :ref:`check <columns-check>`, :ref:`select <columns-select>`, :ref:`radio <columns-radio>`

diff --git a/...ation/ColumnsConfig/CommonProperties/LocalizeReferencesAtParentLocalization.rst b/...ation/ColumnsConfig/CommonProperties/LocalizeReferencesAtParentLocalization.rst
@@ -7,6 +7,7 @@ localizeReferencesAtParentLocalization
 
 .. confval:: localizeReferencesAtParentLocalization
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']
    :type: boolean
    :Scope: Proc.
    :Types: :ref:`group <columns-group>`, :ref:`select <columns-select>`

diff --git a/Documentation/ColumnsConfig/CommonProperties/Maxitems.rst b/Documentation/ColumnsConfig/CommonProperties/Maxitems.rst
@@ -7,6 +7,7 @@ maxitems
 
 .. confval:: maxitems
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']
    :type: integer > 0
    :Scope: Display / Proc.
    :Types: :ref:`group <columns-group>`, :ref:`inline <columns-inline>`

diff --git a/Documentation/ColumnsConfig/CommonProperties/Minitems.rst b/Documentation/ColumnsConfig/CommonProperties/Minitems.rst
@@ -7,6 +7,7 @@ minitems
 
 .. confval:: minitems
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']
    :type: integer > 0
    :Scope: Display
    :Types: :ref:`group <columns-group>`, :ref:`inline <columns-inline>`

diff --git a/Documentation/ColumnsConfig/CommonProperties/Mm.rst b/Documentation/ColumnsConfig/CommonProperties/Mm.rst
@@ -7,6 +7,7 @@ MM
 
 .. confval:: MM
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']
    :type: string (table name)
    :Scope: Proc.
    :Types: :ref:`group <columns-group>`, :ref:`select <columns-select>`, :ref:`inline <columns-inline>`

diff --git a/Documentation/ColumnsConfig/CommonProperties/Mode.rst b/Documentation/ColumnsConfig/CommonProperties/Mode.rst
@@ -7,6 +7,7 @@ mode
 
 .. confval:: mode
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']
    :type: string (keywords)
    :Scope: Display
    :Types: :ref:`input <columns-input>`

diff --git a/Documentation/ColumnsConfig/CommonProperties/Multiple.rst b/Documentation/ColumnsConfig/CommonProperties/Multiple.rst
@@ -7,6 +7,7 @@ multiple
 
 .. confval:: multiple
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']
    :type: boolean
    :Scope: Display / Proc.
    :Types: :ref:`group <columns-group>`, :ref:`selec <columns-select>`

diff --git a/Documentation/ColumnsConfig/CommonProperties/Placeholder.rst b/Documentation/ColumnsConfig/CommonProperties/Placeholder.rst
@@ -7,6 +7,7 @@ placeholder
 
 .. confval:: placeholder
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']
    :type: string
    :Scope: Display
    :Types: :ref:`input <columns-input>`

diff --git a/Documentation/ColumnsConfig/CommonProperties/ReadOnly.rst b/Documentation/ColumnsConfig/CommonProperties/ReadOnly.rst
@@ -7,6 +7,7 @@ readOnly
 
 .. confval:: readOnly
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']
    :type: boolean
    :Scope: Display
    :Types: :ref:`check <columns-check>`, :ref:`flex <columns-flex>`,

diff --git a/Documentation/ColumnsConfig/CommonProperties/Search.rst b/Documentation/ColumnsConfig/CommonProperties/Search.rst
@@ -7,6 +7,7 @@ search
 
 .. confval:: search
 
+   :Path: $GLOBALS['TCA'][$table]['columns'][$field]['config']
    :type: array
    :Scope: Search
    :Types: :ref:`input <columns-input>`