Installation

Preparations

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' => '8.1' // Add the minimum version here or leave blank for any version.
        ]
    ]
];
Copied!

For composer installations also add the requirement to your extension's composer.json file. In TYPO3 v11 the ext_emconf.php file is not even needed anymore, when in composer mode.

{
   "require": {
      "mask/mask": "^8.1"
   }
}
Copied!

Install and configure

  1. Download Mask with composer by running the command composer require mask/mask or install via extension manager.
  2. Activate Mask in the extension manager (not needed in TYPO3 Composer mode)
  3. Include the Mask site set (TYPO3 v13 and above) or Include the required TypoScript directly (TYPO3 v12 and bellow).
  4. Navigate to the Mask module and enter your site package extension key for auto-configuration (your extension must be loaded!).
  5. Start creating your own content elements!

Include the Mask site set (TYPO3 v13 and above)

If you have a custom site package extension, add the Mask site set as dependency to your site packages Site set definition:

name: myvendor/my-site-package
label: My site package set
dependencies:
  - mask/mask
Copied!

It is also possible to include mask as site dependency directly in the backend:

Got to module Site Management > Sites and edit your site configuration.

In section Sets for this Site chose site set Mask.

Include the required TypoScript directly (TYPO3 v12 and bellow)

  1. Mask requires fluid_styled_content so go to your static includes in the template module and include it there.

    Read here how to include static templates

    You can install this core extension in composer mode with the command
    composer require typo3/cms-fluid-styled-content
  2. Also include the Mask static TypoScript.

Manual configuration

If you don't want to use the default folder structure created by the auto-configuration, you can adjust every path in the extension configuration of Mask.

Screenshots

Include TypoScript Template

Include TypoScript Template

New in version 7.1.0

Mask auto-configuration

Mask warns you about missing configuration