From 8ad2f254951358445e24a16d19d0ecd55ceb9461 Mon Sep 17 00:00:00 2001 From: Julian Hofmann Date: Fri, 17 Oct 2025 17:16:57 +0200 Subject: [PATCH 1/6] [TASK] Unify extension name in examples Unify the extension name of examples to an identical in all places of documentation. Follow-up of https://github.com/TYPO3-Documentation/TYPO3CMS-Reference-CoreApi/pull/6110 --- .../Guide/TypoScriptFunctions/GetText/Index.rst | 2 +- .../Mod/_WebList/_downloadPresets.tsconfig | 2 +- Documentation/PageTsconfig/TceForm.rst | 16 ++++++++-------- Documentation/PageTsconfig/TceMain.rst | 6 +++--- Documentation/TopLevelObjects/Plugin.rst | 6 +++--- 5 files changed, 16 insertions(+), 16 deletions(-) diff --git a/Documentation/Guide/TypoScriptFunctions/GetText/Index.rst b/Documentation/Guide/TypoScriptFunctions/GetText/Index.rst index 8f9af1a4d..760f267de 100644 --- a/Documentation/Guide/TypoScriptFunctions/GetText/Index.rst +++ b/Documentation/Guide/TypoScriptFunctions/GetText/Index.rst @@ -41,7 +41,7 @@ current branch, i.e. the website root for that branch: .. code-block:: typoscript 10 = TEXT - 10.data = LLL:EXT:myext/Resources/Private/Language/locallang.xlf:siteTitle + 10.data = LLL:EXT:my_extension/Resources/Private/Language/locallang.xlf:siteTitle Creates a text object that contains the value of the "siteTitle" string in the given localization, appropriately translated for the current language. diff --git a/Documentation/PageTsconfig/Mod/_WebList/_downloadPresets.tsconfig b/Documentation/PageTsconfig/Mod/_WebList/_downloadPresets.tsconfig index 2f27fe123..5fc8a8b84 100644 --- a/Documentation/PageTsconfig/Mod/_WebList/_downloadPresets.tsconfig +++ b/Documentation/PageTsconfig/Mod/_WebList/_downloadPresets.tsconfig @@ -7,7 +7,7 @@ mod.web_list.downloadPresets { fullExport { identifier = uid-title - label = LLL:EXT:myext/Resources/Private/Language/locallang.xlf:preset2.label + label = LLL:EXT:my_extension/Resources/Private/Language/locallang.xlf:preset2.label columns = uid, title } } diff --git a/Documentation/PageTsconfig/TceForm.rst b/Documentation/PageTsconfig/TceForm.rst index 20b551a18..7a8efd1ef 100644 --- a/Documentation/PageTsconfig/TceForm.rst +++ b/Documentation/PageTsconfig/TceForm.rst @@ -230,10 +230,10 @@ In this example, the value will substitute the marker in a plugin FlexForm. .. code-block:: typoscript :caption: EXT:site_package/Configuration/page.tsconfig - TCEFORM.tx_myext_table.myfield.PAGE_TSCONFIG_ID = 22 + TCEFORM.table.myfield.PAGE_TSCONFIG_ID = 22 This example might be used for a record in an extension. It refers to a -table called `tx_myext_table` and the field `myfield`. Here the marker will +table called `table` and the field `myfield`. Here the marker will be substituted by the value `22`. .. _tceform-page_tsconfig_idlist: @@ -262,10 +262,10 @@ In this example, the value will substitute the marker in a plugin FlexForm. .. code-block:: typoscript :caption: EXT:site_package/Configuration/page.tsconfig - TCEFORM.tx_myext_table.myfield.PAGE_TSCONFIG_IDLIST = 20,21,22 + TCEFORM.table.myfield.PAGE_TSCONFIG_IDLIST = 20,21,22 This example might be used for a record in an extension. It refers to a -table called `tx_myext_table` and the field `myfield`. Here the marker will +table called `table` and the field `myfield`. Here the marker will be substituted by the list of integers. @@ -295,10 +295,10 @@ In this example, the value will substitute the marker in a plugin FlexForm. .. code-block:: typoscript :caption: EXT:site_package/Configuration/page.tsconfig - TCEFORM.tx_myext_table.myfield.PAGE_TSCONFIG_STR = %hello% + TCEFORM.table.myfield.PAGE_TSCONFIG_STR = %hello% This example might be used for a record in an extension. It refers to a -table called `tx_myext_table` and the field `myfield`. Here the marker will +table called `table` and the field `myfield`. Here the marker will be substituted by the given value. @@ -329,10 +329,10 @@ Example: Assign a palette to a field :caption: EXT:my_sitepackage/Configuration/page.tsconfig # Assign a palette to a specific field - TCEFORM.tx_myext_table.myfield.colorPalette = messages + TCEFORM.table.myfield.colorPalette = messages # Assign a palette to all color pickers used in a table - TCEFORM.tx_myext_table.colorPalette = key_colors + TCEFORM.table.colorPalette = key_colors # Assign global palette TCEFORM.colorPalette = main diff --git a/Documentation/PageTsconfig/TceMain.rst b/Documentation/PageTsconfig/TceMain.rst index 12672a321..a69e40811 100644 --- a/Documentation/PageTsconfig/TceMain.rst +++ b/Documentation/PageTsconfig/TceMain.rst @@ -542,10 +542,10 @@ preview previewPageId = 123 useDefaultLanguageRecord = 0 fieldToParameterMap { - uid = tx_myext_pi1[showUid] + uid = pi1[showUid] } additionalGetParameters { - tx_myext_pi1.special = HELLO # results in tx_myext_pi1[special] + pi1.special = HELLO # results in pi1[special] } } } @@ -567,7 +567,7 @@ preview Finally :typoscript:`additionalGetParameters` allow you to add arbitrary GET-parameters and even override others. If the plugin on your target page shows a list of records by default you will also need something like - :typoscript:`tx_myext_pi1.action = show` to ensure the record details are displayed. + :typoscript:`pi1.action = show` to ensure the record details are displayed. The core automatically sets the "no_cache" and the "L" parameter. The language matches the language of the current record. You may override each parameter by using the :typoscript:`additionalGetParameters` configuration diff --git a/Documentation/TopLevelObjects/Plugin.rst b/Documentation/TopLevelObjects/Plugin.rst index 252a98b34..42b6412b5 100644 --- a/Documentation/TopLevelObjects/Plugin.rst +++ b/Documentation/TopLevelObjects/Plugin.rst @@ -11,8 +11,8 @@ plugin This is used for extensions in TYPO3 set up as frontend plugins. Typically you can set configuration properties of the plugin here. Say you have an extension with the key "myext" and it has a frontend -plugin named "tx\_myext\_pi1" then you would find the TypoScript -configuration at the position :typoscript:`plugin.tx_myext_pi1` in the object +plugin named "tx\_myextension\_pi1" then you would find the TypoScript +configuration at the position :typoscript:`plugin.pi1` in the object tree! Most plugins are :ref:`cobj-user` objects @@ -522,4 +522,4 @@ Demonstrates: .. code-block:: typoscript :caption: EXT:site_package/Configuration/TypoScript/setup.typoscript - plugin.tx_myext_pi1._LOCAL_LANG.de.list_mode_1 = Der erste Modus + plugin.pi1._LOCAL_LANG.de.list_mode_1 = Der erste Modus From 99551eae52f857464830db9e2e6ccbc954127540 Mon Sep 17 00:00:00 2001 From: Julian Hofmann Date: Mon, 20 Oct 2025 08:02:43 +0200 Subject: [PATCH 2/6] Use backticks to mark this as code Co-authored-by: Lina Wolf <48202465+linawolf@users.noreply.github.com> --- Documentation/TopLevelObjects/Plugin.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/TopLevelObjects/Plugin.rst b/Documentation/TopLevelObjects/Plugin.rst index 42b6412b5..ba225e284 100644 --- a/Documentation/TopLevelObjects/Plugin.rst +++ b/Documentation/TopLevelObjects/Plugin.rst @@ -11,7 +11,7 @@ plugin This is used for extensions in TYPO3 set up as frontend plugins. Typically you can set configuration properties of the plugin here. Say you have an extension with the key "myext" and it has a frontend -plugin named "tx\_myextension\_pi1" then you would find the TypoScript +plugin named `tx_myextension_pi1` then you would find the TypoScript configuration at the position :typoscript:`plugin.pi1` in the object tree! From 3ba2d2c29edeb35fb5354b0c0dd579d3b52312f5 Mon Sep 17 00:00:00 2001 From: Julian Hofmann Date: Mon, 20 Oct 2025 08:04:13 +0200 Subject: [PATCH 3/6] Re-add prefix to tablename The prefix was previously removed due to an incorrect search & replace operation. Co-authored-by: Lina Wolf <48202465+linawolf@users.noreply.github.com> --- Documentation/PageTsconfig/TceForm.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/PageTsconfig/TceForm.rst b/Documentation/PageTsconfig/TceForm.rst index 7a8efd1ef..2fb061584 100644 --- a/Documentation/PageTsconfig/TceForm.rst +++ b/Documentation/PageTsconfig/TceForm.rst @@ -230,7 +230,7 @@ In this example, the value will substitute the marker in a plugin FlexForm. .. code-block:: typoscript :caption: EXT:site_package/Configuration/page.tsconfig - TCEFORM.table.myfield.PAGE_TSCONFIG_ID = 22 + TCEFORM.tx_myextension_table.myfield.PAGE_TSCONFIG_ID = 22 This example might be used for a record in an extension. It refers to a table called `table` and the field `myfield`. Here the marker will From 08d8a9b8d2edaa8185e912bbad37083ea899a72c Mon Sep 17 00:00:00 2001 From: Julian Hofmann Date: Mon, 20 Oct 2025 08:04:46 +0200 Subject: [PATCH 4/6] Re-add exxtension prefix The prefix was previously removed due to an incorrect search & replace operation. Co-authored-by: Lina Wolf <48202465+linawolf@users.noreply.github.com> --- Documentation/PageTsconfig/TceMain.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/PageTsconfig/TceMain.rst b/Documentation/PageTsconfig/TceMain.rst index a69e40811..976db2264 100644 --- a/Documentation/PageTsconfig/TceMain.rst +++ b/Documentation/PageTsconfig/TceMain.rst @@ -542,7 +542,7 @@ preview previewPageId = 123 useDefaultLanguageRecord = 0 fieldToParameterMap { - uid = pi1[showUid] + uid = tx_myextension_pi1[showUid] } additionalGetParameters { pi1.special = HELLO # results in pi1[special] From 4eab493fdcee2c8c32634bc007e9004b103d1e74 Mon Sep 17 00:00:00 2001 From: Julian Hofmann Date: Mon, 20 Oct 2025 11:16:26 +0200 Subject: [PATCH 5/6] [BUGFIX] Revert incorrect replace action In the previous commit, an incorrect search & replace action was performed. This has now been reverted. --- Documentation/PageTsconfig/TceForm.rst | 14 +++++++------- Documentation/PageTsconfig/TceMain.rst | 4 ++-- Documentation/TopLevelObjects/Plugin.rst | 6 +++--- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/Documentation/PageTsconfig/TceForm.rst b/Documentation/PageTsconfig/TceForm.rst index 2fb061584..ec595be92 100644 --- a/Documentation/PageTsconfig/TceForm.rst +++ b/Documentation/PageTsconfig/TceForm.rst @@ -233,7 +233,7 @@ In this example, the value will substitute the marker in a plugin FlexForm. TCEFORM.tx_myextension_table.myfield.PAGE_TSCONFIG_ID = 22 This example might be used for a record in an extension. It refers to a -table called `table` and the field `myfield`. Here the marker will +table called `tx_myext_table` and the field `myfield`. Here the marker will be substituted by the value `22`. .. _tceform-page_tsconfig_idlist: @@ -262,10 +262,10 @@ In this example, the value will substitute the marker in a plugin FlexForm. .. code-block:: typoscript :caption: EXT:site_package/Configuration/page.tsconfig - TCEFORM.table.myfield.PAGE_TSCONFIG_IDLIST = 20,21,22 + TCEFORM.tx_myext_table.myfield.PAGE_TSCONFIG_IDLIST = 20,21,22 This example might be used for a record in an extension. It refers to a -table called `table` and the field `myfield`. Here the marker will +table called `tx_myext_table` and the field `myfield`. Here the marker will be substituted by the list of integers. @@ -295,10 +295,10 @@ In this example, the value will substitute the marker in a plugin FlexForm. .. code-block:: typoscript :caption: EXT:site_package/Configuration/page.tsconfig - TCEFORM.table.myfield.PAGE_TSCONFIG_STR = %hello% + TCEFORM.tx_myext_table.myfield.PAGE_TSCONFIG_STR = %hello% This example might be used for a record in an extension. It refers to a -table called `table` and the field `myfield`. Here the marker will +table called `tx_myext_table` and the field `myfield`. Here the marker will be substituted by the given value. @@ -329,10 +329,10 @@ Example: Assign a palette to a field :caption: EXT:my_sitepackage/Configuration/page.tsconfig # Assign a palette to a specific field - TCEFORM.table.myfield.colorPalette = messages + TCEFORM.tx_myext_table.myfield.colorPalette = messages # Assign a palette to all color pickers used in a table - TCEFORM.table.colorPalette = key_colors + TCEFORM.tx_myext_table.colorPalette = key_colors # Assign global palette TCEFORM.colorPalette = main diff --git a/Documentation/PageTsconfig/TceMain.rst b/Documentation/PageTsconfig/TceMain.rst index 976db2264..53ef75028 100644 --- a/Documentation/PageTsconfig/TceMain.rst +++ b/Documentation/PageTsconfig/TceMain.rst @@ -545,7 +545,7 @@ preview uid = tx_myextension_pi1[showUid] } additionalGetParameters { - pi1.special = HELLO # results in pi1[special] + tx_myext_pi1.special = HELLO # results in tx_myext_pi1[special] } } } @@ -567,7 +567,7 @@ preview Finally :typoscript:`additionalGetParameters` allow you to add arbitrary GET-parameters and even override others. If the plugin on your target page shows a list of records by default you will also need something like - :typoscript:`pi1.action = show` to ensure the record details are displayed. + :typoscript:`tx_myext_pi1.action = show` to ensure the record details are displayed. The core automatically sets the "no_cache" and the "L" parameter. The language matches the language of the current record. You may override each parameter by using the :typoscript:`additionalGetParameters` configuration diff --git a/Documentation/TopLevelObjects/Plugin.rst b/Documentation/TopLevelObjects/Plugin.rst index ba225e284..252a98b34 100644 --- a/Documentation/TopLevelObjects/Plugin.rst +++ b/Documentation/TopLevelObjects/Plugin.rst @@ -11,8 +11,8 @@ plugin This is used for extensions in TYPO3 set up as frontend plugins. Typically you can set configuration properties of the plugin here. Say you have an extension with the key "myext" and it has a frontend -plugin named `tx_myextension_pi1` then you would find the TypoScript -configuration at the position :typoscript:`plugin.pi1` in the object +plugin named "tx\_myext\_pi1" then you would find the TypoScript +configuration at the position :typoscript:`plugin.tx_myext_pi1` in the object tree! Most plugins are :ref:`cobj-user` objects @@ -522,4 +522,4 @@ Demonstrates: .. code-block:: typoscript :caption: EXT:site_package/Configuration/TypoScript/setup.typoscript - plugin.pi1._LOCAL_LANG.de.list_mode_1 = Der erste Modus + plugin.tx_myext_pi1._LOCAL_LANG.de.list_mode_1 = Der erste Modus From bc09ffc673da259cb678a04e6a253de55375a46d Mon Sep 17 00:00:00 2001 From: Julian Hofmann Date: Mon, 20 Oct 2025 11:21:48 +0200 Subject: [PATCH 6/6] [TASK] Unify extension name in examples Unify the extension name of examples to an identical in all places of documentation. Follow-up of https://github.com/TYPO3-Documentation/TYPO3CMS-Reference-CoreApi/pull/6110 --- Documentation/PageTsconfig/TceForm.rst | 14 +++++++------- Documentation/PageTsconfig/TceMain.rst | 4 ++-- Documentation/TopLevelObjects/Plugin.rst | 6 +++--- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/Documentation/PageTsconfig/TceForm.rst b/Documentation/PageTsconfig/TceForm.rst index ec595be92..139ca4e33 100644 --- a/Documentation/PageTsconfig/TceForm.rst +++ b/Documentation/PageTsconfig/TceForm.rst @@ -233,7 +233,7 @@ In this example, the value will substitute the marker in a plugin FlexForm. TCEFORM.tx_myextension_table.myfield.PAGE_TSCONFIG_ID = 22 This example might be used for a record in an extension. It refers to a -table called `tx_myext_table` and the field `myfield`. Here the marker will +table called `tx_myextension_table` and the field `myfield`. Here the marker will be substituted by the value `22`. .. _tceform-page_tsconfig_idlist: @@ -262,10 +262,10 @@ In this example, the value will substitute the marker in a plugin FlexForm. .. code-block:: typoscript :caption: EXT:site_package/Configuration/page.tsconfig - TCEFORM.tx_myext_table.myfield.PAGE_TSCONFIG_IDLIST = 20,21,22 + TCEFORM.tx_myextension_table.myfield.PAGE_TSCONFIG_IDLIST = 20,21,22 This example might be used for a record in an extension. It refers to a -table called `tx_myext_table` and the field `myfield`. Here the marker will +table called `tx_myextension_table` and the field `myfield`. Here the marker will be substituted by the list of integers. @@ -295,10 +295,10 @@ In this example, the value will substitute the marker in a plugin FlexForm. .. code-block:: typoscript :caption: EXT:site_package/Configuration/page.tsconfig - TCEFORM.tx_myext_table.myfield.PAGE_TSCONFIG_STR = %hello% + TCEFORM.tx_myextension_table.myfield.PAGE_TSCONFIG_STR = %hello% This example might be used for a record in an extension. It refers to a -table called `tx_myext_table` and the field `myfield`. Here the marker will +table called `tx_myextension_table` and the field `myfield`. Here the marker will be substituted by the given value. @@ -329,10 +329,10 @@ Example: Assign a palette to a field :caption: EXT:my_sitepackage/Configuration/page.tsconfig # Assign a palette to a specific field - TCEFORM.tx_myext_table.myfield.colorPalette = messages + TCEFORM.tx_myextension_table.myfield.colorPalette = messages # Assign a palette to all color pickers used in a table - TCEFORM.tx_myext_table.colorPalette = key_colors + TCEFORM.tx_myextension_table.colorPalette = key_colors # Assign global palette TCEFORM.colorPalette = main diff --git a/Documentation/PageTsconfig/TceMain.rst b/Documentation/PageTsconfig/TceMain.rst index 53ef75028..dbfc6f44a 100644 --- a/Documentation/PageTsconfig/TceMain.rst +++ b/Documentation/PageTsconfig/TceMain.rst @@ -545,7 +545,7 @@ preview uid = tx_myextension_pi1[showUid] } additionalGetParameters { - tx_myext_pi1.special = HELLO # results in tx_myext_pi1[special] + tx_myextension_pi1.special = HELLO # results in tx_myextension_pi1[special] } } } @@ -567,7 +567,7 @@ preview Finally :typoscript:`additionalGetParameters` allow you to add arbitrary GET-parameters and even override others. If the plugin on your target page shows a list of records by default you will also need something like - :typoscript:`tx_myext_pi1.action = show` to ensure the record details are displayed. + :typoscript:`tx_myextension_pi1.action = show` to ensure the record details are displayed. The core automatically sets the "no_cache" and the "L" parameter. The language matches the language of the current record. You may override each parameter by using the :typoscript:`additionalGetParameters` configuration diff --git a/Documentation/TopLevelObjects/Plugin.rst b/Documentation/TopLevelObjects/Plugin.rst index 252a98b34..b2f2052a2 100644 --- a/Documentation/TopLevelObjects/Plugin.rst +++ b/Documentation/TopLevelObjects/Plugin.rst @@ -12,8 +12,8 @@ This is used for extensions in TYPO3 set up as frontend plugins. Typically you can set configuration properties of the plugin here. Say you have an extension with the key "myext" and it has a frontend plugin named "tx\_myext\_pi1" then you would find the TypoScript -configuration at the position :typoscript:`plugin.tx_myext_pi1` in the object -tree! +configuration at the position :typoscript:`plugin.tx_myextension_pi1` in the +object tree! Most plugins are :ref:`cobj-user` objects which means that they have at least 1 or 2 reserved properties. @@ -522,4 +522,4 @@ Demonstrates: .. code-block:: typoscript :caption: EXT:site_package/Configuration/TypoScript/setup.typoscript - plugin.tx_myext_pi1._LOCAL_LANG.de.list_mode_1 = Der erste Modus + plugin.tx_myextension_pi1._LOCAL_LANG.de.list_mode_1 = Der erste Modus