Installation

Note

Before you start using mask, you should have set up your sitepackage.

Add Mask as dependency

It is important to add Mask as a dependency in your ext_emconf.php of your sitepackage. This ensures, Mask is loaded before your Theme extension. Only then, you can override the generated TCA from Mask in your Overrides folder.

$EM_CONF[$_EXTKEY] = [
    'constraints' => [
        'depends' => [
            'mask' => '' // Add the minimum version here or leave blank for any version.
        ]
    ]
];

Install and configure

Download Mask with composer by running the command composer require mask/mask or install via extension manager. The first thing you should do is to define the paths to your template directories. If you don’t do this, Mask falls back to a dummy extension called mask_project. The easiest way to change the paths is to add the snippet below to your AdditionalConfiguration.php:

$GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS']['mask'] = [
    'backend' => 'EXT:sitepackage/Resources/Private/Mask/Backend/Templates/',
    'backendlayout_pids' => '0,1',
    'content' => 'EXT:sitepackage/Resources/Private/Mask/Frontend/Templates/',
    'json' => 'EXT:sitepackage/Configuration/Mask/mask.json',
    'layouts' => 'EXT:sitepackage/Resources/Private/Mask/Frontend/Layouts/',
    'layouts_backend' => 'EXT:sitepackage/Resources/Private/Mask/Backend/Layouts/',
    'partials' => 'EXT:sitepackage/Resources/Private/Mask/Frontend/Partials/',
    'partials_backend' => 'EXT:sitepackage/Resources/Private/Mask/Backend/Partials/',
    'preview' => 'EXT:sitepackage/Resources/Public/Mask/',
];

Explanations for the settings can be found here. Adjust the paths to your needs and activate the extension. When you visit the Mask backend, you will have the option to create all missing files and folders defined here.

Note

This is also great to have in version control so others will have this already set up when checking out the project.

Include TypoScript

Mask works best with fluid_styled_content so go to your static includes in the template module and include it there. After that also include the Mask static TypoScript.

Include TypoScript Template

That’s it. Now you can start creating your own content elements!