.. include:: ../Includes.txt .. _installation: ============ Installation ============ .. note:: Before you start using mask, you should have set up your :ref:`sitepackage`. 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. .. code-block:: php $EM_CONF[$_EXTKEY] = [ 'constraints' => [ 'depends' => [ 'mask' => '8.1' // Add the minimum version here or leave blank for any version. ] ] ]; 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. .. code-block:: json { "require": { "mask/mask": "^8.1" } } .. note:: If you add the dependency after Mask is already installed and activated, you need to rebuild the loading order by reinstalling your extension. Install and configure ===================== .. rst-class:: bignums #. Download Mask with composer by running the command `composer require mask/mask` or install via extension manager. #. Activate Mask in the extension manager (not needed in TYPO3 Composer mode) #. :ref:`include-site-set` or :ref:`include-typoscript`. #. Navigate to the Mask module and enter your site package extension key for auto-configuration (your extension must be loaded!). #. Start creating your own content elements! .. _include-site-set: Include the Mask site set (TYPO3 v13 and above) ----------------------------------------------- If you have a custom :ref:`site package extension `, add the Mask site set as dependency to your site packages :ref:`Site set definition `: .. literalinclude:: _codesnippets/_config.yaml :caption: EXT:my_site_package/Configuration/Sets/SitePackage/config.yaml It is also possible to include mask as site dependency directly in the backend: Got to module :guilabel:`Site Management > Sites` and edit your site configuration. In section :guilabel:`Sets for this Site` chose site set :guilabel:`Mask`. .. note:: The site set of Mask depends on the set Fluid Styled Content. You do not have to include this set separately as was done with manual TypoScript inclusion. .. _include-typoscript: Include the required TypoScript directly (TYPO3 v12 and bellow) --------------------------------------------------------------- .. rst-class:: bignums #. Mask requires `fluid_styled_content` so go to your static includes in the template module and include it there. :ref:`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` #. 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 :ref:`extension configuration ` of Mask. .. tip:: It is great to have the `LocalConfiguration.php` file (where the extension configuration is stored) in version control so others will have this already set up when checking out the project. Screenshots =========== .. figure:: ../Images/AdministratorManual/TypoScriptTemplate.png :alt: Include TypoScript Template :class: with-border Include TypoScript Template .. versionadded:: 7.1.0 .. figure:: ../Images/Mask7.1/AutoConfiguration.png :alt: Mask auto-configuration :class: with-border Mask warns you about missing configuration