About this document¶

This document describes TSconfig and its options: A TypoScript a-like configuration syntax to configure details of the backend for backend users based on a user, group and page level.

This document can be seen as detail below the main TYPO3 Explained documentation. It is too huge to be integrated into TYPO3 Explained directly.

First parts of this document explain the concepts of TSconfig, the different places it can be found in the system, how it can be diagnosed, and goes a bit into the PHP API if developers need to access data from TSconfig. The rest of the document is a reference: A document to look-up and find properties on a daily basis.

This document is especially important for integrators who want to make life as easy as possible for their dear backend users.

About TSconfig¶

TSconfig is used in TYPO3 to configure and customize the backend on a page and a user or group basis. The syntax to do this is based on TypoScript that is also used to configure frontend output of the web site.

The whole point of TSconfig is that it allows configuration of backend details by integrators, without asking developers for writing PHP code. Thus, some areas of TSconfig are rather powerful and offer vast possibilities of customizing the TYPO3 backend.

TSconfig is divided into configuration for pages ("Page TSconfig") and configuration for users and groups ("User TSconfig"). Each variant is further detailed in this document.

The general "dotted notation" of TypoScript is re-used for Page TSconfig and User TSconfig, it is possible to reference values, use conditions, and so on. For a general look at the syntax, please read the according section of TYPO3 Explained.

Other than the basic syntax, TSconfig and frontend TypoScript have nothing in common. Properties outlined in the TypoScript Reference can never be used in TSconfig and vice versa. Frontend TypoScript and TSconfig are different things: TypoScript is used to steer the rendering of the frontend web site, TSconfig is used to configure what is displayed to a logged in backend user.

While this might be confusing in the first place, it becomes clear as soon as integrators start using TSconfig and looking at the available options: It is all about setting values to configure if a backend users sees or does not see this-and-that, give a user additional editing options, or removing them. As a last note to complete this picture: TSconfig is also used to configure the "Admin panel" in the frontend. While this might look funny in the first place, thinking about that makes clear on why admin panel configuration options are bound to TSconfig and not to frontend TypoScript: The admin panel is basically a view to parts of the backend that is shown in the frontend, it is entirely bound to backend users. So, the admin panel is a backend thing, even if displayed in frontend, it is for backend users. This is why the admin panel is configured via TSconfig.

Setting the page TSconfig globally¶

Global page TSconfig should be stored within an extension, usually a sitepackage extension. The content of the file Configuration/page.tsconfig within an extension is automatically loaded during build time.

It is possible to load other TSconfig files with the import syntax within this file:

@import 'EXT:my_sitepackage/Configuration/TsConfig/Page/Basic.tsconfig'
@import 'EXT:my_sitepackage/Configuration/TsConfig/Page/Mod/Wizards/NewContentElement.tsconfig'

Many page TSconfig settings can be set globally. This is useful for installations that contain only one site and use only one sitepackage extension.

Extensions supplying custom default page TSconfig that should always be included, can also set the page TSconfig globally.

The PSR-14 event BeforeLoadedPageTsConfigEvent is available to add global static page TSconfig before anything else is loaded.

<?php

declare(strict_types=1);

use TYPO3\CMS\Core\Information\Typo3Version;
use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
use TYPO3\CMS\Core\Utility\GeneralUtility;

defined('TYPO3') or die();

$versionInformation = GeneralUtility::makeInstance(Typo3Version::class);
// Only include page.tsconfig if TYPO3 version is below 12 so that it is not imported twice.
if ($versionInformation->getMajorVersion() < 12) {
    ExtensionManagementUtility::addPageTSConfig(
        '@import "EXT:my_sitepackage/Configuration/page.tsconfig"'
    );
}

Page TSconfig on site level¶

Page TSconfig can be defined on a site level by placing a file called page.tsconfig in the storage directory of the site (config/sites/<identifier>/).

Extensions and site packages can provide page TSconfig in site sets by placing a file called page.tsconfig into the folder of that set.

This way sites and sets can ship page TSconfig without the need for database entries or by polluting global scope. Dependencies can be expressed via site sets, allowing for automatic ordering and deduplication.

See also site sets as page TSconfig provider.

name: my-vendor/my-set
label: My Set

base: 'http://example.com/'
rootPageId: 1
dependencies:
  - my-vendor/my-set

# This tsconfig will be loaded for pages in site "my-site"
# [...]

# This tsconfig will be loaded for pages in all sites that depend on set 'my-vendor/my-set'
# [...]

Static page TSconfig¶

<?php

use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;

ExtensionManagementUtility::registerPageTSConfigFile(
    'extension_name',
    'Configuration/TsConfig/Page/myPageTSconfigFile.tsconfig',
    'My special config'
);

<?php

$GLOBALS['TCA']['pages']['columns']['tsconfig_includes']['config']['items'][] =
    [
        'LLL:EXT:my_sitepackage/Resources/Private/Language/locallang_db.xlf:pages.pageTSconfig.my_ext_be_layouts',
        'EXT:my_sitepackage/Configuration/TsConfig/Page/myPageTSconfigFile.tsconfig',
    ];

Set page TSconfig directly in the page properties¶

Go to the page properties of the page where you want to include the page TSconfig and open the tab Resources.

You can enter page TSconfig directly into the field Page TSconfig:

Page TSconfig inserted directly into the page properties is applied to the page itself and all its subpages.

Verify the final configuration¶

The full page TSconfig for any given page can be viewed using the module Page TSconfig with in the Site Management section.

Overriding and modifying values¶

Page TSconfig is loaded in the following order, the latter override the former:

1. Default page TSconfig that was set globally
2. Static page TSconfig that was included for a page tree.
3. Direct page TSconfig entered directly in the page properties.
4. User TSconfig overrides

Static and direct page TSconfig are loaded for the page they are set on and all their subpages.

The TypoScript syntax to modify values can also be used for the page TSconfig.

Example¶

Default page TSconfig

RTE.default.proc.allowTagsOutside = hr

Static page TSconfig included on the parent page

RTE.default.proc.allowTagsOutside := addToList(blockquote)

Finally you get the value "hr,blockquote".

Importing the user TSconfig into a backend user or group¶

1. Open the record of the user or group. Go to Options > TSconfig.

   

2. Enter the following TSconfig to import a configuration file from your sitepackage:

   TsConfig added in the backend record of a backend user or group

   @import 'EXT:my_sitepackage/Configuration/TsConfig/User/my_editor.tsconfig'

   Copied!

This will make all settings in the file available to the user. The file itself can be kept under version control together with your sitepackage.

TSconfig defined at user level overrides TSconfig defined at group level.

If a user is a member of several groups, the TSconfig from each group is loaded. The order in which the groups are added to the user in field General > Group is used.

The TSconfig from latter groups overrides the TSconfig from earlier groups if both define the same property.

Setting default user TSconfig¶

User TSconfig is designed to be individual for users or groups of users. However, good defaults can be defined and overridden by group or user-specific TSconfig.

Default user TSconfig should be stored within an extension, usually a sitepackage extension. The content of the file Configuration/user.tsconfig within an extension is automatically loaded during build time.

It is possible to load other user TSconfig files with the import syntax within this file:

@import 'EXT:my_sitepackage/Configuration/TsConfig/User/default.tsconfig'

The PSR-14 event BeforeLoadedUserTsConfigEvent is available to add global static user TSconfig before anything else is loaded.

<?php

declare(strict_types=1);

use TYPO3\CMS\Core\Information\Typo3Version;
use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
use TYPO3\CMS\Core\Utility\GeneralUtility;

defined('TYPO3') or die();

$versionInformation = GeneralUtility::makeInstance(Typo3Version::class);
// Only include user.tsconfig if TYPO3 version is below 13 so that it is not imported twice.
if ($versionInformation->getMajorVersion() < 13) {
    ExtensionManagementUtility::addUserTSConfig(
        '@import "EXT:my_sitepackage/Configuration/user.tsconfig"'
    );
}

Verify the final configuration¶

The full user TSconfig of the currently logged-in backend user can be viewed using the System > Configuration backend module and choosing the action $GLOBALS['BE_USER']->getTSConfig() (User TSconfig). However this module can only be accessed by admins.

The Configuration module is available with installed lowlevel system extension.

Override and modify values¶

Properties, which are set in the TSconfig field of a group, are valid for all users of that group.

Values set in one group can be overridden and modified in the same or another group. If a user is a member of multiple groups, the TSconfig settings are evaluated in the order in which the groups are included in the user account: When editing the backend user, the selected groups are evaluated from top to bottom.

Example:

• Add in user TSconfig

  EXT:site_package/Configuration/user.tsconfig

  page.RTE.default.showButtons = bold

  Copied!
• You get the value "bold".

• Add later in user TSconfig

  EXT:site_package/Configuration/user.tsconfig

  page.RTE.default.showButtons := addToList(italic)

  Copied!
• You get the value "bold,italic".

Finally, you can override or modify the settings from groups that your user is a member of in the user TSconfig field of that specific user.

Example:

Let's say the user is a member of a usergroup with this configuration:

TCAdefaults.tt_content {
    hidden = 1
    header = Hello!
}

Then we set the following values in the TSconfig field of the specific user.

page.TCAdefaults.tt_content.header = 234
options.clearCache.all = 1

This would override the default value of the header ("234") and add the clear cache option. The default value of the hidden field is not changed and simply inherited directly from the group.

Overriding page TSconfig in user TSconfig¶

All properties from page TSconfig can be overridden in user TSconfig by prepending the property name with page..

When a page TSconfig property is set in user TSconfig that way, regardless of whether it is in the TSconfig field of a group or a user, it overrides the value of the according page TSconfig property.

To illustrate this feature let's say new pages and copied pages are not hidden by default:

TCAdefaults.pages.hidden = 0
TCEMAIN.table.pages.disableHideAtCopy = 1

If we activate the following configuration in the user TSconfig of a certain backend user group, new and copied pages will be hidden for that group. The user TSconfig to be used is the same, but prefixed with page.

// Override the settings from the page TSconfig for the editors usergroup
page {
    TCAdefaults.pages.hidden = 1
    TCEMAIN.table.pages.disableHideAtCopy = 0
}

# Enable the "bold" button in Page TSconfig (!)
RTE.default.showButtons = bold

# Try to additionally add the "italic" button in User TSconfig (!)
page.RTE.default.showButtons := addToList(italic)

Condition variables available in TSconfig¶

[applicationContext == "Development"]
    // Your settings go here
[END]

[applicationContext matches "/^Production/"]
    // Your settings go here
[END]

# Check single page uid
[traverse(page, "uid") == 2]
    // Your settings go here
[END]
# Check list of page uids
[traverse(page, "uid") in [17,24]]
    // Your settings go here
[END]
# Check list of page uids NOT in
[traverse(page, "uid") not in [17,24]]
    // Your settings go here
[END]
# Check range of pages (example: page uid from 10 to 20)
[traverse(page, "uid") in 10..20]
    // Your settings go here
[END]

# Check the page backend layout
[traverse(page, "backend_layout") == 5]
    // Your settings go here
[END]
[traverse(page, "backend_layout") == "example_layout"]
    // Your settings go here
[END]

# Check the page title
[traverse(page, "title") == "foo"]
    // Your settings go here
[END]

# Check if page is on level 0:
[tree.level == 0]
    // Your settings go here
[END]

# Use backend_layout records uids
[tree.pagelayout == 2]
    // Your settings go here
[END]

# Use TSconfig provider of backend layouts
[tree.pagelayout == "pagets__Home"]
    // Your settings go here
[END]

[tree.rootLine[0]["uid"] == 1]
    // Your settings go here
[END]

# Check if page with uid 2 is inside the root line
[2 in tree.rootLineIds]
    // Your settings go here
[END]

# Check if page with uid 2 is the parent of a page inside the root line
[2 in tree.rootLineParentIds]
    // Your settings go here
[END]

# Evaluates to true if current backend user is administrator
[backend.user.isAdmin]
    // Your settings go here
[END]

[backend.user.isLoggedIn]
    // Your settings go here
[END]

# Evaluates to true if user uid of current logged in backend user is equal to 5
[backend.user.userId == 5]
    // Your settings go here
[END]

[2 in backend.user.userGroupIds]
    // Your settings go here
[END]

[like(","~backend.user.userGroupList~",", "*,1,*")]
    // Your settings go here
[END]

[workspace.workspaceId == 0]
    // Your settings go here
[END]

[workspace.isLive]
    // Your settings go here
[END]

[workspace.isOffline]
    // Your settings go here
[END]

[typo3.version == "12.4.0"]
    // Your settings go here
[END]

[typo3.branch == "12.4"]
    // Your settings go here
[END]

[typo3.devIpMask == "203.0.113.6"]
    // Your settings go here
[END]

Condition functions available in TSconfig¶

# True if day of current month is 7
[date("j") == 7]
    // Your settings go here
[END]

# True if day of current week is 7
[date("w") == 7]
    // Your settings go here
[END]

# True if day of current year is 7
[date("z") == 7]
    // Your settings go here
[END]

# True if current hour is 7
[date("G") == 7]
    // Your settings go here
[END]

# Search a string with * within another string
[like("fooBarBaz", "*Bar*")]
    // Your settings go here
[END]

# Search string with single characters in between, using ?
[like("fooBarBaz", "f?oBa?Baz")]
    // Your settings go here
[END]

# Search string using regular expression
[like("fooBarBaz", "/f[o]{2,2}[aBrz]+/")]
    // Your settings go here
[END]

# Traverse query parameters of current request along tx_news_pi1[news]
[traverse(request.getQueryParams(), 'tx_news_pi1/news') > 0]
    // Your settings go here
[END]

# True if current version is 12.4.x
[compatVersion("12.4")]
    // Your settings go here
[END]
[compatVersion("12.4.0")]
    // Your settings go here
[END]
[compatVersion("12.4.1")]
    // Your settings go here
[END]

[getenv("VIRTUAL_HOST") == "www.example.org"]
    // Your settings go here
[END]

# True if feature toggle for strict TypoScript syntax is enabled:
[feature("TypoScript.strictSyntax") === false]
    // Your settings go here
[END]

# Site identifier
[site("identifier") == "my_website"]
    // Your settings go here
[END]

# Match site base host
[site("base").getHost() == "www.example.org"]
    // Your settings go here
[END]

# Match base path
[site("base").getPath() == "/"]
    // Your settings go here
[END]

# Match root page uid
[site("rootPageId") == 1]
    // Your settings go here
[END]

# Match a configuration property
[traverse(site("configuration"), "myCustomProperty") == true]
    // Your settings go here
[END]

Retrieving TSconfig settings¶

The PHP API to retrieve page and user TSconfig in a backend module can be used as follows:

<?php

declare(strict_types=1);

use TYPO3\CMS\Backend\Utility\BackendUtility;
use TYPO3\CMS\Core\Authentication\BackendUserAuthentication;

final class MyBackendController
{
    public function someMethod(int $currentPageId): void
    {
        // Retrieve user TSconfig of currently logged in user
        $userTsConfig = $this->getBackendUser()->getTSConfig();

        // Retrieve page TSconfig of the given page id
        $pageTsConfig = BackendUtility::getPagesTSconfig($currentPageId);
    }

    private function getBackendUser(): BackendUserAuthentication
    {
        return $GLOBALS['BE_USER'];
    }
}

Both methods return the entire TSconfig as a PHP array. The former retrieves the user TSconfig while the latter retrieves the page TSconfig.

All imports, overrides, modifications, etc. are already resolved. This includes page TSconfig overrides by user TSconfig.

Similar to other TypoScript-related API methods, properties that contain sub-properties return their sub-properties using the property name with a trailing dot, while a single property is accessible by the property name itself. The example below gives more insight on this.

If accessing TSconfig arrays, the PHP null coalescing operator ?? is useful: TSconfig options may or not be set, accessing non-existent array keys in PHP would thus raise PHP notice level warnings.

Combining the array access with a fallback using ?? helps when accessing these optional array structures.

options.someToggle = 1
options.somePartWithSubToggles = foo
options.somePartWithSubToggles.aValue = bar

<?php

return [
    'options.' => [
        'someToggle' => '1',
        'somePartWithSubToggles' => 'foo',
        'somePartWithSubToggles.' => [
            'aValue' => 'bar',
        ],
    ],
];

<?php

declare(strict_types=1);

final class _MyBackendLoggedInController
{
    public function isUserToggleEnabled(): bool
    {
        // Typical call to retrieve a sanitized value:
        return $isToggleEnabled = (bool)($this->getUserTsConfig()['options.']['someToggle'] ?? false);
    }

    public function getSomePartWithSubToggles(): array
    {
        // Retrieve a subset, note the dot at the end:
        return $this->getUserTsConfig()['options.']['somePartWithSubToggles.'] ?? [];
    }

    private function getUserTsConfig(): array
    {
        return $GLOBALS['BE_USER']->getTSConfig();
    }
}

Changing or adding page TSconfig¶

The PSR-14 event ModifyLoadedPageTsConfigEvent is available to modify or add page TSconfig entries.

Basic syntax¶

First, define the colors by name and RGB value:

colorPalettes {
  colors {
    typo3 {
      value = #ff8700
    }
    blue {
      value = #0080c9
    }
    darkgrey {
      value = #515151
    }
    valid {
      value = #5abc55
    }
    error {
      value = #dd123d
    }
  }
}

Then assign the colors to your palettes:

colorPalettes {
  palettes {
    main = typo3
    key_colors = typo3, blue, darkgrey
    messages = valid, error
  }
}

Now you can assign a color palette to one field, to all fields of a table or as a global configuration, see TCEFORM.colorPalette.

Properties¶

colPos_list¶

colPos_list ¶

Type

list of integers

Default

1,0,2,3

This option lets you specify which columns of tt_content elements should be editable in the 'Columns' view of the Web > Page module.

Used on top of backend layouts, this setting controls which columns are editable. Columns configured in the Backend Layout which are not listed here, will be displayed with placeholder area.

Each column has a number which ultimately comes from the configuration of the table tt_content, field 'colPos'. These are the values of the four default columns used in the default backend layout:

Left: 1, Normal: 0, Right: 2, Border: 3

defaultLanguageFlag¶

defaultLanguageFlag ¶

Type

string

Country flag shown for the "Default" language in the backend, used in Web > List and Web > Page module. Values as listed in the "Select flag icon" of a language record in the backend are allowed, including the value "multiple".

mod.SHARED {
    defaultLanguageFlag = de
    defaultLanguageLabel = deutsch
}

defaultLanguageLabel¶

defaultLanguageLabel ¶

Type

string

Alternate label for "Default" when language labels are shown in the interface.

Used in Web > List and Web > Page module.

disableLanguages¶

disableLanguages ¶

Type

string

Comma-separated list of language UIDs which will be disabled in the given page tree.

disableSysNoteButton¶

disableSysNoteButton ¶

Type

boolean

Disables the sys_note creation button in the modules' top button bar in the Page, List and Info modules.

fieldDefinitions¶

fieldDefinitions ¶

Type

array

The available fields in the "Pagetree overview" module under the Info module, by default ship with the entries "Basic settings", "Record overview", and "Cache and age".

By using page TsConfig it is possible to change the available fields and add additional entries to the select box.

Next to using a list of fields from the pages table you can add counters for records in a given table by prefixing a table name with table_ and adding it to the list of fields.

The string ###ALL_TABLES### is replaced with a list of all table names an editor has access to.

mod.web_info.fieldDefinitions {
    0 {
        # Basic settings
        label = LLL:EXT:info/Resources/Private/Language/locallang_webinfo.xlf:pages_0
        fields = title,uid,slug,alias,starttime,endtime,fe_group,target,url,shortcut,shortcut_mode
    }
    1 {
        # Record overview
        label = LLL:EXT:info/Resources/Private/Language/locallang_webinfo.xlf:pages_1
        fields = title,uid,###ALL_TABLES###
    }
    2 {
        # Cache and age
        label = LLL:EXT:info/Resources/Private/Language/locallang_webinfo.xlf:pages_2
        fields = title,uid,table_tt_content,table_fe_users
    }
}

menu.function¶

# before
mod.web_info.menu.function.TYPO3\CMS\Info\Controller\TranslationStatusController = 0

# after
options.hideModules := addToList(web_info_translations)

allowInconsistentLanguageHandling¶

allowInconsistentLanguageHandling ¶

Type

boolean

By default, TYPO3 will not allow you to mix translated content and independent content in the page module. Content elements violating this behavior will be marked in the page module and there is no UI control (yet) allowing you to create independent content elements in a given language.

If you want to go back to the old, inconsistent behavior, you can toggle it back on using this switch.

mod.web_layout.allowInconsistentLanguageHandling = 1

BackendLayouts¶

BackendLayouts ¶

Type

array

no-index

1

Backend Layouts were initially introduced in order to customize the view of the Page module in TYPO3 Backend for a page, but has then since grown also in Frontend rendering to select for example Fluid template files via TypoScript for a page, commonly used via data:pagelayout.

See also the dedicated chapter Backend layouts.

mod.web_layout.BackendLayouts {
    exampleKey {
        title = Example
        icon = EXT:example_extension/Resources/Public/Images/BackendLayouts/default.gif
        config {
            backend_layout {
                colCount = 1
                rowCount = 2
                rows {
                    1 {
                        columns {
                            1 {
                                name = LLL:EXT:frontend/Resources/Private/Language/locallang_ttc.xlf:colPos.I.3
                                colPos = 3
                                colspan = 1
                            }
                        }
                    }
                    2 {
                        columns {
                            1 {
                                name = Main
                                colPos = 0
                                colspan = 1
                                identifier = main
                            }
                        }
                    }
                }
            }
        }
    }
}

defaultLanguageLabel¶

defaultLanguageLabel ¶

Type

string

Alternate label for "Default" when language labels are shown in the interface.

Overrides the same property from mod.SHARED if set.

defLangBinding¶

defLangBinding ¶

Type

boolean

Default

0

If set, translations of content elements are bound to the default record in the display. This means that within each column with content elements any translation found for exactly the shown default content element will be shown in the language column next to.

This display mode should be used depending on how the frontend is configured to display localization. The frontend must display localized pages by selecting the default content elements and for each one overlay with a possible translation if found.

hideRestrictedCols¶

hideRestrictedCols ¶

Type

boolean

Default

false

If activated, only columns will be shown in the backend that the editor is allowed to access. All columns with access restriction are hidden in that case.

By default columns with restricted access are rendered with a message telling that the user doesn't have access. This may be useless and distracting or look repelling. Instead, all columns an editor doesn't have access to can be hidden:

EXT:site_package/Configuration/page.tsconfig

mod.web_layout.hideRestrictedCols = 1

Copied!

Attention

This setting will break your layout if you are using backend layouts.

localization.enableCopy¶

localization.enableCopy ¶

Type

boolean

Default

1

Enables the creation of copies of content elements into languages in the translation wizard ("free mode").

mod.web_layout {
    localization.enableCopy = 0
}

localization.enableTranslate¶

localization.enableTranslate ¶

Type

boolean

Default

1

Enables simple translations of content elements in the translation wizard ("connected mode").

mod.web_layout {
    localization.enableTranslate = 0
}

menu.functions¶

menu.functions ¶

Type

array

Disable elements of the "Function selector" in the document header of the module.

The function keys are numerical:

Columns

1

Languages

2

Warning

Blinding Function Menu items is not hardcore access control! All it does is hide the possibility of accessing that module functionality from the interface. It might be possible for users to hack their way around it and access the functionality anyways. You should use the option of blinding elements mostly to remove otherwise distracting options.

# Disables "Languages" from function menu
mod.web_layout.menu.functions {
    2 = 0
}

noCreateRecordsLink¶

noCreateRecordsLink ¶

Type

boolean

Default

0

If set, the link in the bottom of the page, "Create new record", is hidden.

tt_content.preview¶

tt_content.preview ¶

Type

boolean

It is possible to render previews of your own content elements in the page module. By referencing a Fluid template you can create a visual representation of your content element, making it easier for an editor to understand what is going on on the page.

The syntax is as follows:

EXT:site_package/Configuration/page.tsconfig

mod.web_layout.tt_content.preview.[CTYPE].[list_type value] = EXT:site_mysite/Resources/Private/Templates/Preview/ExamplePlugin.html

Copied!

This way you can even switch between previews for your plugins by supplying list as CType.

Note

This only works, if there is no hook registered for this content type, you may want to check this section in the System > Configuration module:

Search for registrations of this hook

$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['cms/layout/class.tx_cms_layout.php']
    ['tt_content_drawItem']['content_element_xy'];

Copied!

mod.web_layout.tt_content {
    preview.custom_ce = EXT:site_mysite/Resources/Private/Templates/Preview/CustomCe.html
    preview.table = EXT:site_mysite/Resources/Private/Templates/Preview/Table.html
    preview.list.tx_news = EXT:site_mysite/Resources/Private/Templates/Preview/TxNews.html
}

Example: Use a backend layout in the page content data processor¶

Define the backend layout via page TSconfig, for example in the site:

mod.web_layout.BackendLayouts {
    default {
        title = Default
        config {
            backend_layout {
                colCount = 2
                rowCount = 2
                rows {
                    1 {
                        columns {
                            1 {
                                name = Jumbotron
                                colPos = 1
                                identifier = jumbotron
                                slideMode = slide
                                colspan = 2
                            }
                        }
                    }

                    1 {
                        columns {
                            1 {
                                name = Left
                                colPos = 0
                                identifier = left
                            }

                            2 {
                                name = Right
                                colPos = 2
                                identifier = right
                                slideMode = collectReverse
                            }
                        }
                    }
                }
            }
        }
    }
}

Configure the output via TypoScript, using the content object PAGEVIEW and the DataProcessor page-content.

page = PAGE
page {
    10 = PAGEVIEW
    10 {
        paths.10 = EXT:my_sitepackage/Resources/Private/Templates/
        dataProcessing.10 = page-content
        dataProcessing.10.as = myContent
    }
}

Use the identifiers of the columns in the Fluid template:

<f:render partial="Jumbotron" arguments="{jumbotronContent: myContent.jumbotron}"/>
<main>
    <f:for each="{myContent.left.records}" as="contentElement">
        <f:cObject typoscriptObjectPath="tt_content.{contentElement.data.CType}"
            data="{contentElement.data}"
            table="tt_content"
        />
    </f:for>
</main>
<aside>
    <f:render partial="Aside" arguments="{content: myContent.right}"/>
</aside>

allowedNewTables¶

allowedNewTables ¶

Type

list of table names

If this list is set, then only tables listed here will have a link to "create new" in the page and sub pages. This also affects the "Create new record" content element wizard.

This is the opposite of deniedNewTables property.

Note

Technically records can be created (e.g. by copying/moving), so this is not a security feature. The point is to reduce the number of options for new records visually.

Example: Only allow records of type pages or sys_category in the new record wizard¶

EXT:site_package/Configuration/page.tsconfig

mod.web_list {
    # Only pages and sys_category table elements will be linked to in the new record wizard
    allowedNewTables = pages, sys_category
}

Copied!

clickTitleMode¶

clickTitleMode ¶

Type

string

Default

edit

Keyword which defines what happens when a user clicks a record title in the list.

The following values are possible:

edit

Edits record

info

Shows information

show

Shows page in the frontend

csvDelimiter¶

csvDelimiter ¶

Type

string

Default

,

Defines the default delimiter for CSV downloads (Microsoft Excel expects ; to be set). The value set will be displayed as default delimiter in the download dialog in the list module.

Example: Use semicolon as delimiter CSV downloads¶

EXT:examples/Configuration/TsConfig/Page/Mod/csvExport.tsconfig

mod.web_list {
   csvDelimiter = ;
   csvQuote = '
}

Copied!

csvQuote¶

csvQuote ¶

Type

string

Default

"

Defines the default quoting character for CSV downloads. The value set will be displayed as default quoting in the download dialog in the list module.

Example: Use single quotes as quoting character for CSV downloads¶

EXT:examples/Configuration/TsConfig/Page/Mod/csvExport.tsconfig

mod.web_list {
   csvDelimiter = ;
   csvQuote = '
}

Copied!

deniedNewTables¶

deniedNewTables ¶

Type

list of table names

If this list is set, then the tables listed here won't have a link to "create new record" in the page and sub pages. This also affects the "Create new record" content element wizard.

This is the opposite of allowedNewTables property.

If allowedNewTables and deniedNewTables contain a common subset, deniedNewTables takes precedence.

mod.web_list {
    deniedNewTables = sys_category, tt_content
}

disableSingleTableView¶

disableSingleTableView ¶

Type

boolean

If set, then the links on the table titles which shows a single table listing will not be available - including sorting links on columns titles, because these links jumps to the table-only view.

displayColumnSelector¶

displayColumnSelector ¶

Type

boolean

Default

true

The column selector is enabled by default and can be disabled with this option. The column selector is displayed at the top of each record list in the List module. It can be used to compare different fields of the listed records.

mod.web_list.displayColumnSelector = 0

downloadPresets¶

downloadPresets.[table] ¶

Type

array of presets

New in version 13.2

A new function has been introduced that makes it possible to select the data columns to be exported from a list of configurable presets.

This property adds presets of preselected fields to the download area in the Web > List backend module.

Those presets can be configured via page TSconfig, and can also be overridden via user TSconfig (for example, to expand certain presets only to specific users).

Each entry of mod.web_list.downloadPresets defines the table name on the first level, followed by any number of presets.

Each preset contains a label (the displayed name of the preset, which can be a locallang key), a comma-separated list of each column that should be included in the export as columns and optionally an identifier. In case identifier is not provided, the identifier is generated as hash of the label and columns.

Since any table can be configured for a preset, any extension can deliver a defined set of presets through the EXT:my_extension/Configuration/page.tsconfig file and their table name(s).

Additionally, the list of presets can be manipulated via the PSR-14 event BeforeRecordDownloadPresetsAreDisplayedEvent.

mod.web_list.downloadPresets {
    pages {
        minimum {
            label = Quick overview
            columns = uid, title, crdate, slug
        }

        fullExport {
            identifier = uid-title
            label = LLL:EXT:myext/Resources/Private/Language/locallang.xlf:preset2.label
            columns = uid, title
        }
    }
}

mod.web_list.downloadPresets {
    pages {
        minimum {
            label = Quick overview
            columns = uid, title, crdate, slug
        }

        fullExport {
            identifier = uid-title
            label = LLL:EXT:myext/Resources/Private/Language/locallang.xlf:preset2.label
            columns = uid, title
        }
    }
}

enableClipBoard¶

enableClipBoard ¶

Type

list of keywords

Default

selectable

Determines whether the checkbox "Show clipboard" in the list module is shown or hidden. If it is hidden, you can predefine it to be always activated or always deactivated.

The following values are possible:

activated

The option is activated and the checkbox is hidden.

deactivated

The option is deactivated and the checkbox is hidden.

selectable

The checkbox is shown so that the option can be selected by the user.

enableDisplayBigControlPanel¶

hideTables¶

hideTables ¶

Type

list of table names, or *

Hide these tables in record listings (comma-separated)

If * is used, all tables will be hidden

hideTranslations¶

hideTranslations ¶

Type

list of table names, or *

For tables in this list all their translated records in additional website languages will be hidden in the List module.

Use * to hide all records of additional website languages in all tables or set single table names as comma-separated list.

mod.web_list.hideTranslations = *

mod.web_list.hideTranslations = tt_content, tt_news

itemsLimitPerTable¶

itemsLimitPerTable ¶

Type

positive integer

Default

20 Set the default maximum number of items to show per table. The number must be between 5 and 10000`. If below or above this range, the nearest valid number will be used.

mod.web_list {
    itemsLimitPerTable = 10
}

itemsLimitSingleTable¶

itemsLimitSingleTable ¶

Type

positive integer

Default

100

Set the default maximum number of items to show in single table view. The number must be between 5 and 10000. If below or above this range, the nearest valid number will be used.

mod.web_list {
    itemsLimitSingleTable = 10
}

listOnlyInSingleTableView¶

listOnlyInSingleTableView ¶

Type

boolean

Default

0

If set, the default view will not show the single records inside a table anymore, but only the available tables and the number of records in these tables. The individual records will only be listed in the single table view, that means when a table has been clicked. This is very practical for pages containing many records from many tables!

Example: Only list records of tables in single-table mode¶

EXT:site_package/Configuration/page.tsconfig

mod.web_list {
    listOnlyInSingleTableView = 1
}

The result will be that records from tables are only listed in the single-table mode:

Copied!

newPageWizard.override¶

newPageWizard.override ¶

Type

string

If set to an extension key, then the specified module or route will be used for creating new elements on the page.

noCreateRecordsLink¶

noCreateRecordsLink ¶

Type

boolean

Default

0

If set, the link "Create new record" is hidden.

mod.web_list {
    noCreateRecordsLink = 1
}

noExportRecordsLinks¶

noExportRecordsLinks ¶

Type

boolean

Default

0

If set, the Download and Export buttons are hidden in the list module. This applies to the Export button located at the top left for t3d exports, the Download button directly on the table listing for csv download and the Download button in the tables single view.

This option is for example important to disable batch download of sensitive data via CSV or t3d exports.

Note

This option only hides the buttons in the list module. Bulk export of data is still possible via the context menu of the page tree.

mod.web_list {
   noExportRecordsLinks = 1
}

noViewWithDokTypes¶

noViewWithDokTypes ¶

Type

string (comma-separated list of integers)

Default

254,255

Hide view icon for the defined doktypes.

table.[tableName].hideTable¶

table.[tableName].hideTable ¶

Type

boolean

Default

0

If set to non-zero, the table is hidden. If it is zero, table is shown even if table name is listed in "hideTables" list.

mod.web_list.table.tt_content.hideTable = 1

table.[tableName].displayColumnSelector¶

table.[tableName].displayColumnSelector ¶

Type

boolean

If set to false, the column selector in the title row of the specified table gets hidden. If the column selctors have been disabled globally this option can be used to enable it for a specific table.

mod.web_list.table.tt_content.displayColumnSelector = 0

mod.web_list.displayColumnSelector = 0
mod.web_list.table.sys_category.displayColumnSelector = 1

tableDisplayOrder¶

tableDisplayOrder.[tableName] ¶

Type

array

Flexible configuration of the order in which tables are displayed.

The keywords before and after can be used to specify an order relative to other table names.

mod.web_list.tableDisplayOrder.<tableName> {
    before = <tableA>, <tableB>, ...
    after = <tableA>, <tableB>, ...
}

Copied!

searchLevel.items¶

searchLevel.items ¶

Type

array

Sets labels for each level label in the search level select box

EXT:site_package/Configuration/page.tsconfig

mod.web_list.searchLevel.items {
    -1 = EXT:core/Resources/Private/Language/locallang_core.xlf:labels.searchLevel.infinite
    0 = EXT:core/Resources/Private/Language/locallang_core.xlf:labels.searchLevel.0
    1 = EXT:core/Resources/Private/Language/locallang_core.xlf:labels.searchLevel.1
    2 = EXT:core/Resources/Private/Language/locallang_core.xlf:labels.searchLevel.2
    3 = EXT:core/Resources/Private/Language/locallang_core.xlf:labels.searchLevel.3
    4 = EXT:core/Resources/Private/Language/locallang_core.xlf:labels.searchLevel.4
}

Copied!

searchLevel.default¶

searchLevel.default ¶

Type

integer

New in version 13.2

This option allows to define one of the available level options as the default level to use.

When searching for records in the Web > List module as well as the database browser, it is possible to select the search levels (page tree levels to respect in the search).

An editor is therefore able to select between the current page, a couple of defined levels (e.g. 1, 2, 3) as well as the special "infinite levels".

Those options can already be extended using the TSconfig option searchLevel.items.

mod.web_list.searchLevel.default = -1

previewFrameWidths¶

previewFrameWidths ¶

Type

array

Configure available presets in view module.

<key>.label

Label for the preset

<key>.type

Category of the preset, must be one of 'desktop', 'tablet' or 'mobile'

<key>.width

Width of the preset

<key>.height

Height of the preset

Example: Define a new preview preset¶

With this configuration a new preset '1014' with size 1024x768 will be configured with a label loaded from an xlf file and the category 'desktop'.

EXT:site_package/Configuration/page.tsconfig

mod.web_view.previewFrameWidths {
    1024.label = LLL:EXT:viewpage/Resources/Private/Language/locallang.xlf:computer
    1024.type = desktop
    1024.width = 1024
    1024.height = 768
}

Copied!

type¶

type ¶

Type

positive integer

Enter the value of the &type= parameter passed to the webpage.

mod.web_view {
    # Frontend link will be something like index.php?id=123&type=42
    type = 42
}

newContentElement.wizardItems¶

newContentElement.wizardItems ¶

Type

array

Path

mod.wizards.newContentElement.wizardItems

In the New Content Element Wizard, content element types are grouped together by type. Each such group can be configured independently. The four default groups are: default, special, forms and plugins.

Changed in version 13.0

The group common was renamed to default. A permanent migration is in place.

removeItems ¶

Type

comma separated list of groups

Path

mod.wizards.newContentElement.wizardItems.removeItems

Changed in version 13.0

With this setting one or several groups with all their content elements can be hidden in the New Content Element Wizard.

# This will remove the "menu" group
mod.wizards.newContentElement.wizardItems.removeItems := addToList(menu)

Copied!

[group].before ¶

Type

string

Path

mod.wizards.newContentElement.wizardItems.[group].before

Sorts [group] in front of the group given.

[group].after ¶

Type

string

Path

mod.wizards.newContentElement.wizardItems.[group].after

Sorts [group] after the group given.

[group].header ¶

Type

string | localized string

Path

mod.wizards.newContentElement.wizardItems.[group].header

Name of the group.

[group].show ¶

Type

string, comma-separated list of items

Path

mod.wizards.newContentElement.wizardItems.[group].show

Changed in version 13.0

The configuration of the New Content Element Wizard has been changed to automatically registering the groups and elements from the TCA configuration.

The previously used option to show / hide elements mod.wizards.newContentElement.wizardItems.<group>.show is not evaluated anymore.

All configured groups and elements are automatically shown. Removing these groups and elements from the New Content Element Wizard can be done via the option removeItems and [group].removeItems options.

[group].elements ¶

Type

array

Path

mod.wizards.newContentElement.wizardItems.[group].elements

List of items in the group.

[name] ¶

Type

array

Path

mod.wizards.newContentElement.wizardItems.[group].elements.[name]

Configuration for a single item.

iconIdentifier ¶

Type

string

Path

mod.wizards.newContentElement.wizardItems.[group].elements.[name].iconIdentifier

The icon identifier of the icon you want to display.

iconOverlay ¶

Type

string

Path

mod.wizards.newContentElement.wizardItems.[group].elements.[name].iconOverlay

The icon identifier of the overlay icon you want to use.

title ¶

Type

string | localized string

Path

mod.wizards.newContentElement.wizardItems.[group].elements.[name].title

Name of the item.

description ¶

Type

string | localized string

Path

mod.wizards.newContentElement.wizardItems.[group].elements.[name].description

Description text for the item.

tt_content_defValues ¶

Type

array

Path

mod.wizards.newContentElement.wizardItems.[group].elements.[name].tt_content_defValues

Default values for tt_content fields.

saveAndClose ¶

Type

bool

Path

mod.wizards.newContentElement.wizardItems.[group].elements.[name].saveAndClose

Default

false

If true, directs the user back to the Page module directly instead of showing the FormEngine.

[group].removeItems ¶

Type

Comma separated list

Path

mod.wizards.newContentElement.wizardItems.[group].removeItems

Changed in version 13.0

Comma separated list of content elements that should be hidden in [group].

EXT:site_package/Configuration/page.tsconfig

mod.wizards.newContentElement.wizardItems {
    special.removeItems := addToList(html)
}

Copied!

# Add a new element (header) to the "common" group
mod.wizards.newContentElement.wizardItems.common.elements.header {
    iconIdentifier = content-header
    title = Header
    description = Adds a header element only
    tt_content_defValues {
        CType = header
    }
}
mod.wizards.newContentElement.wizardItems.common.show := addToList(header)

Example: Create a new group and add an element to it¶

EXT:site_package/Configuration/page.tsconfig

# Create a new group and add a (pre-filled) element to it
mod.wizards.newContentElement.wizardItems.myGroup {
    header = LLL:EXT:cms/layout/locallang.xlf:advancedFunctions
    elements.customText {
        iconIdentifier = content-text
        title = Introductory text for national startpage
        description = Use this element for all national startpages
        tt_content_defValues {
            CType = text
            bodytext (
                    <h2>Section Header</h2>
                    <p class="bodytext">Lorem ipsum dolor sit amet, consectetur, sadipisci velit ...</p>
            )
            header = Section Header
            header_layout = 100
        }
    }
}
mod.wizards.newContentElement.wizardItems.myGroup.show = customText

Copied!

With the second example, the bottom of the new content element wizard shows:

newRecord.order¶

newRecord.order ¶

Type

list of values

Define an alternate order for the groups of records in the new records wizard. Pages and content elements will always be on top, but the order of other record groups can be changed.

Records are grouped by extension keys, plus the special key "system" for records provided by the TYPO3 Core.

Example: Place the tt_news group at the top of the new record dialog¶

Place the tt_news group at the top (after pages and content elements), other groups follow unchanged:

EXT:site_package/Configuration/page.tsconfig

mod.wizards.newRecord.order = tt_news

Copied!

newRecord.pages¶

newRecord.pages ¶

Type

boolean

Use the following sub-properties to show or hide the specified links. Setting any of these properties to 0 will hide the corresponding link, but setting to 1 will leave it visible.

show.pageAfter

Show or hide the link to create new pages after the selected page.

show.pageInside

Show or hide the link to create new pages inside the selected page.

show.pageSelectPosition

Show or hide the link to create new pages at a selected position.

Example: Hide the "Page (inside)" link in the "New Record" dialog¶

EXT:site_package/Configuration/page.tsconfig

mod.wizards.newRecord.pages.show {
    # Hide the "Page (inside)" link.
    pageInside = 0
}

Copied!

Properties¶

Example: Exclude two backend layouts from drop down selector¶

EXT:site_package/Configuration/page.tsconfig

# Exclude two backend layouts from drop down selector
options.backendLayout.exclude = 1,2

Copied!

# Set default upload folder to "fileadmin/page_upload" on PID 1
[traverse(page, "uid") == 1]
    options.defaultUploadFolder = 1:/page_upload/
[END]

Examples¶

# Disable all RTEs
RTE.default.disabled = 1

# Disable all RTEs
RTE.default.disabled = 1
# Enable RTE for the tt_content bodytext field only
RTE.config.tt_content.bodytext.disabled = 0

# Disable all RTEs
RTE.default.disabled = 1
# Enable RTE for the tt_content bodytext field only
RTE.config.tt_content.bodytext.disabled = 0
# But disable RTE for tt_content bodytext again if the record type is "text"
RTE.config.tt_content.bodytext.types.text.disabled = 1

# set a default preset to use as fallback
RTE.default.preset = custom_preset_default

# Override preset for field "description" in table "tt_address"
RTE.config.tt_address.description.preset = custom_preset_fancy

Properties¶

# Allow only hr tags outside of p and div
RTE.default.proc.allowTagsOutside = hr

$GLOBALS['TYPO3_CONF_VARS']['SYS']['features']['security.backend.htmlSanitizeRte'] = true;

processing:
  allowTags:
    # ...
  HTMLparser_db:
    # ...
    # disable individually per use case
    htmlSanitize: false

    # This is the default configuration,
    # the feature flag has to be enabled
    htmlSanitize:
      # use default builder as configured in
      # $GLOBALS['TYPO3_CONF_VARS']['SYS']['htmlSanitizer']
      build: default

Example: Do not hide newly created pages by default¶

TCAdefaults.pages.hidden = 0

Applying properties¶

The properties listed below apply to various contexts which are explained per property. The full property path thus depends on the property and where it should apply. In general, a more specific property path overrides a less specific one:

Some properties apply to single fields, those can be usually set per table or per table and record type. This leads to the property paths TCEFORM.[tableName].[fieldName].[propertyName] to configure the field for all types and TCEFORM.[tableName].[fieldName].types.[typeName] to configure a field for a specific type, see the TCA type section for details on types.

While all that property path munging looks messy at first, it should become more clear when reading through the single properties below and looking at the examples.

# TCEFORM.[tableName].[fieldName].[dataStructureKey].[flexSheet].[flexFieldName with escaped dots].[propertyName]
TCEFORM.tt_content.pi_flexform.sfregister_create.sDEF.settings\.fields\.selected.addItems.ZZZ = ZZZ

Properties¶

TCEFORM.tt_content.header_layout {
    # Add another header_layout option:
    addItems.1525215969 = Another header layout
    # Add another one with localized label, icon and group
    addItems.1525216023 = LLL:EXT:my_ext/Resources/Private/Language/locallang.xlf:header_layout
    addItems.1525216023.icon = EXT:my_ext/icon.png
    addItems.1525216023.group = special
}

Instead of adding files by path, icon identifiers should be used.

altLabels¶

altLabels ¶

Type

localized string

This property applies to TCA type=select, TCA type=check and TCA type=radio.

This property allows you to enter alternative labels for the items in the list. For a single checkbox or radio button, use default, for multiple checkboxes and radiobuttons, use an integer for their position starting at 0.

This property is available for various levels:

table level:

TCEFORM.[tableName].[fieldName].altLabels

table and record type level:

TCEFORM.[tableName].[fieldName].types.[typeName].altLabels

Flex form field level, example:

TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.settings\.myfield.altLabels

Where sDEF is the sheet name. For a description see the section Applying properties to FlexForm fields on this page.

Example: Override labels for document types¶

EXT:site_package/Configuration/page.tsconfig

TCEFORM.pages.doktype {
    # Set a different item label
    altLabels.1 = STANDARD Page Type
    altLabels.254 = Folder (for various elements)
    # Sets the default label for Recycler via "locallang":
    altLabels.255 = LLL:EXT:my_ext/Resources/Private/Language/locallang_tca.xlf:recycler
}

Copied!

Note

If the item has an empty value, the syntax is slightly different and an additional dot must be provided, like on this example:

EXT:site_package/Configuration/page.tsconfig

TCEFORM.tt_content.space_before_class.altLabels.. = foo

Copied!

Note the double dot after altLabels.

TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.myField.PAGE_TSCONFIG_ID = 22

TCEFORM.tx_myext_table.myfield.PAGE_TSCONFIG_ID = 22

TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.myField.PAGE_TSCONFIG_IDLIST = 20,21,22

TCEFORM.tx_myext_table.myfield.PAGE_TSCONFIG_IDLIST = 20,21,22

TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.myField.PAGE_TSCONFIG_STR = %hello%

TCEFORM.tx_myext_table.myfield.PAGE_TSCONFIG_STR = %hello%

# Assign a palette to a specific field
TCEFORM.tx_myext_table.myfield.colorPalette = messages

# Assign a palette to all color pickers used in a table
TCEFORM.tx_myext_table.colorPalette = key_colors

# Assign global palette
TCEFORM.colorPalette = main

description¶

description ¶

Type

string

This property sets or overrides the TCA property TCA description, which allows to define a description for a TCA field, next to its label.

EXT:site_package/Configuration/page.tsconfig

TCEFORM.tt_content.header.description = override description

Copied!

As already known from other properties, this can also be configured for a specific language.

EXT:site_package/Configuration/page.tsconfig

TCEFORM.tt_content.header.description.de = override description for DE

Copied!

The option can be used on a per record type basis, too.

EXT:site_package/Configuration/page.tsconfig

TCEFORM.tt_content.header.types.textpic.description = override description for textpic

Copied!

Also referencing language labels is supported.

EXT:site_package/Configuration/page.tsconfig

TCEFORM.tt_content.header.description = LLL:EXT:my_ext/Resources/Private/Language/locallang.xlf:override_description

Copied!

TCEFORM.pages.title {
    # The title field of the pages table is not editable
    disabled = 1
}

disableNoMatchingValueElement¶

disableNoMatchingValueElement ¶

Type

boolean

This property applies only to items in TCA type=select fields. If a selector box value is not available among the options in the box, the default behavior of TYPO3 is to preserve the value and to show a label which warns about this special state:

If disableNoMatchingValueElement is set, the element "INVALID VALUE" will not be added to the list.

This property is available for various levels:

table level, example:

TCEFORM.tt_content.header_layout.disableNoMatchingValueElement

table and record type level, example:

TCEFORM.tt_content.header_layout.types.textpic.disableNoMatchingValueElement

Flex form field level, example:

TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.settings\.myfield.disableNoMatchingValueElement

Where sDEF is the sheet name. For a description see the section Applying properties to FlexForm fields on this page.

Example: Disable "INVALID VALUE ..." label¶

EXT:site_package/Configuration/page.tsconfig

TCEFORM.pages.doktype {
    # "INVALID VALUE ..." label will never show up
    disableNoMatchingValueElement = 1
}

Copied!

Now the selector box will default to the first element in the selector box:

TCEFORM.pages.doktype {
    # Show only standard and "Spacer" page types
    keepItems = 1, 199
}

TCEFORM.pages.title {
    label = LLL:EXT:my_ext/Resources/Private/Language/locallang.xlf:table.column
    label.default = New Label
    label.de = Neuer Feldname
}

noMatchingValue_label¶

noMatchingValue_label ¶

Type

localized string

This property applies only to items in TCA type=select fields, it allows defining a different label of the noMatchingValue element.

It is possible to use the placeholder %s to insert the value. If the property is set to empty, the label will be blank.

This property is available for various levels:

table level, example:

TCEFORM.tt_content.header_layout.noMatchingValue_label

table and record type level, example:

TCEFORM.tt_content.header_layout.types.textpic.noMatchingValue_label

Flex form field level, example:

TCEFORM.tt_content.pi_flexform.myext_pi1.sDEF.settings\.myfield.noMatchingValue_label

Where sDEF is the sheet name. For a description see the section Applying properties to FlexForm fields on this page.

Example: Replace "INVALID VALUE ..." label with another string¶

EXT:site_package/Configuration/page.tsconfig

TCEFORM.pages.doktype {
    # Different "INVALID VALUE ..." label:
    noMatchingValue_label = VALUE "%s" was not available!
}

Copied!

TCEFORM.pages.doktype {
    # Remove "Recycler" and "Spacer" page types
    removeItems = 199, 255
}

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.myext_pi1.sDEF
}

suggest¶

Configuration of the suggest wizard that is available and often enabled for TCA type=group fields.

The properties listed below are available on various levels. A more specific setting overrides a less specific one:

Configuration of all suggest wizards in all tables for all target query tables:

TCEFORM.suggest.default

Configuration of all suggest wizards in all tables looking up records from a specific target table:

TCEFORM.suggest.[queryTable]

Configuration of one suggest wizard field in one table for all target query tables:

TCEFORM.[tableName].[fieldName].suggest.default

Configuration of one suggest wizard field in one table for a specific target query table:

TCEFORM.[tableName].[fieldName].suggest.[queryTable]

Configuration of one suggest wizard field in a flex form field of one table for all target query tables:

TCEFORM.[tableName].[fieldName].[dataStructureKey].[sheetName].[flexFieldName].suggest.default

Configuration of one suggest wizard field in a flex form field of one table for a specific target query table:

TCEFORM.[tableName].[fieldName].[dataStructureKey].[sheetName].[flexFieldName].suggest.[queryTable]

suggest.additionalSearchFields¶

suggest.additionalSearchFields ¶

Type

string

Comma-separated list of fields the suggest wizard should also search in. By default the wizard looks only in the fields listed in the label and label_alt of TCA ctrl properties.

suggest.addWhere¶

suggest.addWhere ¶

Type

string

Additional WHERE clause (with AND at the beginning).

Markers possible for replacement:

• ###THIS_UID###
• ###CURRENT_PID###
• ###PAGE_TSCONFIG_ID###
• ###PAGE_TSCONFIG_IDLIST###
• ###PAGE_TSCONFIG_STR###

Example: limit storage_pid to the children of a certain page¶

EXT:site_package/Configuration/page.tsconfig

TCEFORM.pages.storage_pid.suggest.default {
    addWhere = AND pages.pid=###PAGE_TSCONFIG_ID###
}

Copied!

suggest.cssClass¶

suggest.cssClass ¶

Type

string

Add a CSS class to every list item of the result list.

EXT:site_package/Configuration/page.tsconfig

TCEFORM.suggest.pages {
    # Configure all suggest wizards which list records from table "pages"
    # to add the CSS class "pages" to every list item of the result list.
    cssClass = pages
}

Copied!

suggest.hide¶

suggest.hide ¶

Type

boolean

Hide the suggest field. Works only for single fields.

Example: Hide the suggest field for the storage_pid¶

EXT:site_package/Configuration/page.tsconfig

TCEFORM.pages.storage_pid.suggest.default {
    hide = 1
}

Copied!

suggest.maxPathTitleLength¶

suggest.maxPathTitleLength ¶

Type

positive integer

Maximum number of characters to display when a path element is too long.

Example: Limit the suggest field to 30 characters¶

EXT:site_package/Configuration/page.tsconfig

TCEFORM.suggest.default {
    maxPathTitleLength = 30
}

Copied!

suggest.minimumCharacters¶

suggest.minimumCharacters ¶

Type

positive integer

Default

2

Minimum number of characters needed to start the search. Works only for single fields.

Example: Start the suggest search after 3 characters¶

EXT:site_package/Configuration/page.tsconfig

TCEFORM.pages.storage_pid.suggest.default {
    minimumCharacters = 3
}

Copied!

suggest.pidDepth¶

suggest.pidDepth ¶

Type

positive integer

Expand pidList by this number of levels. Only has an effect, if pidList has a value.

Example: Set search depth for suggest field¶

EXT:site_package/Configuration/page.tsconfig

TCEFORM.suggest.default {
    pidList = 6,7
    pidDepth = 4
}

Copied!

suggest.pidList¶

suggest.pidList ¶

Type

list of values

Limit the search to certain pages (and their subpages). When pidList is empty all pages will be included in the search as long as the backend user is allowed to see them.

Example: Limit suggest search to records on certain pages¶

EXT:site_package/Configuration/page.tsconfig

TCEFORM.suggest.default {
    # sets the pidList for a suggest fields in all tables
    pidList = 1,2,3,45
}

Copied!

suggest.receiverClass¶

suggest.receiverClass ¶

Type

Fully Qualified PHP class name

Default

\TYPO3\CMS\Backend\Form\Element\SuggestDefaultReceiver

PHP class alternative receiver class - the file that holds the class should be derived from \TYPO3\CMS\Backend\Form\Element\SuggestDefaultReceiver.

suggest.renderFunc¶

suggest.renderFunc ¶

Type

string

User function to manipulate the displayed records in the result.

suggest.searchCondition¶

suggest.searchCondition ¶

Type

string

Additional WHERE clause (no AND needed to prepend).

Example: Only search on pages with doktype=1¶

EXT:site_package/Configuration/page.tsconfig

TCEFORM.pages.storage_pid.suggest.default {
    # Configure the suggest wizard for the field "storage_pid" in table "pages"
    # to search only for pages with doktype=1
    searchCondition = doktype=1
}

Copied!

suggest.searchWholePhrase¶

suggest.searchWholePhrase ¶

Type

boolean

Default

0

Whether to do a LIKE=%mystring% (searchWholePhrase = 1) or a LIKE=mystring% (to do a real find as you type).

Example: Search only for whole phrases¶

EXT:site_package/Configuration/page.tsconfig

TCEFORM.pages.storage_pid.suggest.default {
    # Configure the suggest wizard for the field "storage_pid" in table "pages" to search only for whole phrases
    searchWholePhrase = 1
}

Copied!

Properties¶

TCEMAIN {
    # Clear the cache for page uid 12 and 23 when saving a record in this page
    clearCacheCmd = 12, 23
    # Clear all frontent page caches of pages
    clearCacheCmd = pages
    # Clear ALL caches
    clearCacheCmd = all
    # Clear cache for all pages tagged with tag "pagetag1"
    clearCacheCmd = cacheTag:pagetag1
}