Skip to content

Commit

Permalink
Use myext_pi1 instead of my_ext_pi1 (TYPO3-Documentation#406)
Browse files Browse the repository at this point in the history 
On the TCEFORM page there are several examples for setting properties
in Flexforms. Usually "my_ext_pi1" is given, but this should rather
by "myext_pi1".

Resolves: TYPO3-Documentation#403

---------

Co-authored-by: Chris Müller <2566282+brotkrueml@users.noreply.github.com>
  • Loading branch information
@sypets @brotkrueml
sypets and brotkrueml committed Dec 2, 2023
1 parent cb5baf5 commit 814da25
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 21 deletions.
42 changes: 21 additions & 21 deletions Documentation/PageTsconfig/TceForm.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The `[dataStructureKey]` represents the key of a FlexForm in
:php:`$GLOBALS['TCA'][<tableName>]['columns'][<field>]['config']['ds']`. This key will be split into up to
two parts. By default the first part will be used as identifier of the FlexForm in TSconfig. The second part
will override the identifier if it is not empty, `list` or `*`. For example the identifier of the key
`my_ext_pi1,list` will be `my_ext_pi1` and of the key `*,my_CType` it will be `my_CType`. See section
`myext_pi1,list` will be `myext_pi1` and of the key `*,my_CType` it will be `my_CType`. See section
:ref:`Pointing to a data structure <t3tca:columns-flex-ds-pointer>` of the TCA reference for details.

Some properties apply to whole FlexForm sheets, their property path is
Expand Down Expand Up @@ -78,7 +78,7 @@ addItems
`TCEFORM.tt_content.header_layout.types.textpic.addItems`

Flex form field level, example:
`TCEFORM.tt_content.pi_flexform.my_ext_pi1.sDEF.myField.addItems`
`TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.myField.addItems`

Where `sDEF` is the sheet name.

Expand Down Expand Up @@ -126,7 +126,7 @@ altLabels
`TCEFORM.[tableName].[fieldName].types.[typeName].altLabels`

Flex form field level, example:
`TCEFORM.tt_content.pi_flexform.my_ext_pi1.sDEF.myField.altLabels`
`TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.myField.altLabels`

Where `sDEF` is the sheet name.

Expand Down Expand Up @@ -181,7 +181,7 @@ PAGE_TSCONFIG_ID
.. code-block:: typoscript
:caption: EXT:site_package/Configuration/page.tsconfig
TCEFORM.tt_content.pi_flexform.my_ext_pi1.sDEF.myField.PAGE_TSCONFIG_ID = 22
TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.myField.PAGE_TSCONFIG_ID = 22
In this example, the value will substitute the marker in a plugin FlexForm.

Expand Down Expand Up @@ -210,7 +210,7 @@ PAGE_TSCONFIG_IDLIST
.. code-block:: typoscript
:caption: EXT:site_package/Configuration/page.tsconfig
TCEFORM.tt_content.pi_flexform.my_ext_pi1.sDEF.myField.PAGE_TSCONFIG_IDLIST = 20,21,22
TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.myField.PAGE_TSCONFIG_IDLIST = 20,21,22
In this example, the value will substitute the marker in a plugin FlexForm.

Expand Down Expand Up @@ -239,7 +239,7 @@ PAGE_TSCONFIG_STR
.. code-block:: typoscript
:caption: EXT:site_package/Configuration/page.tsconfig
TCEFORM.tt_content.pi_flexform.my_ext_pi1.sDEF.myField.PAGE_TSCONFIG_STR = %hello%
TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.myField.PAGE_TSCONFIG_STR = %hello%
In this example, the value will substitute the marker in a plugin FlexForm.

Expand Down Expand Up @@ -293,7 +293,7 @@ config
`TCEFORM.tt_content.header.types.textpic.config.max`

Flex form field level, example:
`TCEFORM.tt_content.pi_flexform.my_ext_pi1.sDEF.myField.config.max`
`TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.myField.config.max`

Where `sDEF` is the sheet name.

Expand Down Expand Up @@ -331,7 +331,7 @@ config.treeConfig
`TCEFORM.tt_content.header.types.config.treeConfig.rootUid`

Flex form field level, example:
`TCEFORM.tt_content.pi_flexform.my_ext_pi1.sDEF.myField.config.treeConfig.rootUid`
`TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.myField.config.treeConfig.rootUid`

Where `sDEF` is the sheet name.

Expand Down Expand Up @@ -408,12 +408,12 @@ disabled
`TCEFORM.tt_content.header.types.textpic.disabled`

Flex form sheet level. If set, the entire tab is not rendered, example:
`TCEFORM.tt_content.pi_flexform.my_ext_pi1.sDEF.disabled`
`TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.disabled`

Where `sDEF` is the sheet name.

Flex form field level, example:
`TCEFORM.tt_content.pi_flexform.my_ext_pi1.sDEF.myField.disabled`
`TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.myField.disabled`

Where `sDEF` is the sheet name.

Expand Down Expand Up @@ -458,7 +458,7 @@ disableNoMatchingValueElement
`TCEFORM.tt_content.header_layout.types.textpic.disableNoMatchingValueElement`

Flex form field level, example:
`TCEFORM.tt_content.pi_flexform.my_ext_pi1.sDEF.myField.disableNoMatchingValueElement`
`TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.myField.disableNoMatchingValueElement`

Where `sDEF` is the sheet name.

Expand Down Expand Up @@ -521,7 +521,7 @@ fileFolderConfig
`TCEFORM.[tableName].[fieldName].types.[typeName].fileFolderConfig.folder`

Flex form field level, example:
`TCEFORM.tt_content.pi_flexform.my_ext_pi1.sDEF.myField.fileFolderConfig.folder`
`TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.myField.fileFolderConfig.folder`

Where `sDEF` is the sheet name.

Expand Down Expand Up @@ -550,7 +550,7 @@ itemsProcFunc
`TCEFORM.[tableName].[fieldName].types.[typeName].itemsProcFunc`

Flex form field level, example:
`TCEFORM.tt_content.pi_flexform.my_ext_pi1.sDEF.myField.itemsProcFunc`
`TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.myField.itemsProcFunc`

Where `sDEF` is the sheet name.

Expand All @@ -577,7 +577,7 @@ keepItems
`TCEFORM.tt_content.header_layout.types.textpic.keepItems`

Flex form field level, example:
`TCEFORM.tt_content.pi_flexform.my_ext_pi1.sDEF.myField.keepItems`
`TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.myField.keepItems`

Where `sDEF` is the sheet name.

Expand Down Expand Up @@ -617,7 +617,7 @@ label
`TCEFORM.[tableName].[fieldName].types.[typeName].label`

Flex form field level, example:
`TCEFORM.tt_content.pi_flexform.my_ext_pi1.sDEF.myField.label`
`TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.myField.label`

Where `sDEF` is the sheet name.

Expand Down Expand Up @@ -657,7 +657,7 @@ noMatchingValue_label
`TCEFORM.tt_content.header_layout.types.textpic.noMatchingValue_label`

Flex form field level, example:
`TCEFORM.tt_content.pi_flexform.my_ext_pi1.sDEF.myField.noMatchingValue_label`
`TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.myField.noMatchingValue_label`

Where `sDEF` is the sheet name.

Expand Down Expand Up @@ -698,7 +698,7 @@ removeItems
`TCEFORM.tt_content.header_layout.types.textpic.removeItems`

Flex form field level, example:
`TCEFORM.tt_content.pi_flexform.my_ext_pi1.sDEF.myField.removeItems`
`TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.myField.removeItems`

Where `sDEF` is the sheet name.

Expand All @@ -724,7 +724,7 @@ sheetDescription
Specifies a description for the sheet shown in the FlexForm.

This property is only available on flex form sheet level, example:
`TCEFORM.tt_content.pi_flexform.my_ext_pi1.sDEF.sheetDescription`
`TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.sheetDescription`

Where `sDEF` is the sheet name.

Expand All @@ -742,7 +742,7 @@ sheetShortDescr
Specifies a short description of the sheet used as link title in the tab-menu.

This property is only available on flex form sheet level, example:
`TCEFORM.tt_content.pi_flexform.my_ext_pi1.sDEF.sheetShortDescription`
`TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.sheetShortDescription`

Where `sDEF` is the sheet name.

Expand All @@ -759,15 +759,15 @@ sheetTitle
Set the title of the sheet / tab in a FlexForm configuration.

This property is only available on flex form sheet level, example:
`TCEFORM.tt_content.pi_flexform.my_ext_pi1.sDEF.sheetTitle`
`TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.sheetTitle`

Where `sDEF` is the sheet name.

:aspect:`Example`
.. code-block:: typoscript
:caption: EXT:site_package/Configuration/page.tsconfig
TCEFORM.tt_content.pi_flexform.my_ext_pi1.sDEF {
TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF {
# Rename the first tab of the FlexForm plug-in configuration
sheetTitle = LLL:my_ext/Resource/Private/Language/locallang.xlf:tt_content.pi_flexform.my_ext_pi1.sDEF
}
Expand Down
10 changes: 10 additions & 0 deletions Documentation/UsingSetting/PageTSconfig.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,16 @@ The TypoScript syntax to
:ref:`modify <t3coreapi:typoscript-syntax-syntax-value-modification>` values
can also be used for the page TSconfig.

Overriding FlexForm settings
============================

It is possible to override some :ref:`FlexForm <t3coreapi:flexforms>` settings via TSconfig. You can find
some examples for this in the reference section, for example on the
:ref:`TCEFORM <tceform>` page.

The syntax is similar as when overriding TCA settings, but a little different.



Example
=======
Expand Down

0 comments on commit 814da25

Please sign in to comment.