Setting page TSconfig

It is recommended to always define custom page TSconfig in a project-specific sitepackage extension. This way the page TSconfig settings can be kept under version control.

The options described below are available for setting page TSconfig in non-sitepackage extensions.

Page TSconfig can be defined globally as Default page TSconfig, on site level via Page TSconfig via site or set or for a page tree, a page and all its subpages.

It is also possible to set set page TSconfig directly in the page properties but this is not recommended anymore.

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:

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

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.

Page TSconfig on site level

New in version 13.1

Page TSconfig can be included on a per 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.

Example: load page TSconfig from the site set and the site

Let us assume, you have a site set defined in your extension:

EXT:my_extension/Configuration/Sets/MySet/config.yaml
name: my-vendor/my-set
label: My Set
Copied!

And use it in a site in your project:

config/sites/my-site/config.yaml
base: 'http://example.com/'
rootPageId: 1
dependencies:
  - my-vendor/my-set
Copied!

You can now put a file called page.tsconfig in the same folder like your site configuration and it will be automatically loaded for all pages in that site.

config/sites/my-site/page.tsconfig
# This tsconfig will be loaded for pages in site "my-site"
# [...]
Copied!

Or you can put the file page.tsconfig in the same directory like the site set you defined in your extension. It will then be loaded by all pages of all sites that depend on this set:

EXT:my_extension/Configuration/Sets/MySet/page.tsconfig
# This tsconfig will be loaded for pages in all sites that depend on set 'my-vendor/my-set'
# [...]
Copied!

Static page TSconfig

Include static page TSconfig into a page tree

Static page TSconfig that has been registered by your sitepackage or a third party extension can be included in the page properties.

  1. Go to the page properties of the page where you want to include the page TSconfig.
  2. Go to the tab Resources, then to page TSconfig > Include static page TSconfig (from extensions) and select the desired configurations from the Available Items.

Register static page TSconfig files

Register PageTS config files in the Configuration/TCA/Overrides/pages.php of any extension.

These can be selected in the page properties.

EXT:my_sitepackage/Configuration/TCA/Overrides/pages.php
<?php

use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;

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

It is not possible to use language strings LLL:... for the third parameter as the extension name will be automatically appended.

If you need to localize these labels, modify the TCA directly instead of using the API function:

EXT:my_sitepackage/Configuration/TCA/Overrides/pages.php
<?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',
    ];
Copied!

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:

TSconfig-related fields in the Resources tab of a page

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

EXT:site_package/Configuration/page.tsconfig
RTE.default.proc.allowTagsOutside = hr
Copied!

Static page TSconfig included on the parent page

EXT:site_package/Configuration/page.tsconfig
RTE.default.proc.allowTagsOutside := addToList(blockquote)
Copied!

Finally you get the value "hr,blockquote".