.. include:: ../../../Includes.txt .. toctree:: .. _typoscript-setup: ================ TypoScript setup ================ See a full TypoScript :ref:`configuration-example`. All configuration is prepended with `plugin.tx_cookieman.settings`. .. _groups: groups ^^^^^^ .. rst-class:: dl-parameters groups :sep:`|` :aspect:`Data type:` array :sep:`|` :aspect:`Default:` mandatory :sep:`|` Holds the group configurations. A group contains several tracking objects. By default, it only contains the 'mandatory' group, which includes the `CookieConsent` settings cookie. See a full TypoScript :ref:`configuration-example`. .. _groups.: groups. ^^^^^^^^^^^^^^^^^^ .. rst-class:: dl-parameters groups. :sep:`|` :aspect:`Data type:` array :sep:`|` :aspect:`Default:` mandatory :sep:`|` A single group. The group's key (name) should not contain spaces and non-ASCII characters. It will be saved in the settings cookie and can be checked with JavaScript: :js:`hasConsented('‹group-key›')` .. _groups.‹group-key›.preselected: groups.‹group-key›.preselected ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. rst-class:: dl-parameters groups..preselected :sep:`|` :aspect:`Data type:` :ref:`t3tsref:data-type-boolean` :sep:`|` :aspect:`Default:` 0 (not set) :sep:`|` If enabled (`1`), the group's consent checkbox will be already checked when the popup opens. The default group 'mandatory' has this set to `1`. .. _groups.‹group-key›.disabled: groups.‹group-key›.disabled ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. rst-class:: dl-parameters groups..disabled :sep:`|` :aspect:`Data type:` :ref:`t3tsref:data-type-boolean` :sep:`|` :aspect:`Default:` 0 (not set) :sep:`|` If enabled (`1`), the group's consent checkbox will be disabled (cannot be changed). The default group 'mandatory' has this set to `1`. .. _groups.‹group-key›.trackingObjects: groups.‹group-key›.trackingObjects ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. rst-class:: dl-parameters groups..trackingObjects :sep:`|` :aspect:`Data type:` array with numeric indices :sep:`|` Holds a list of tracking object keys (numbered). Example: .. code-block:: typoscript trackingObjects { 0 = CookieConsent 1 = fe_typo_user } .. _groups.‹group-key›.respectDnt: groups.‹group-key›.respectDnt ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. rst-class:: dl-parameters groups..respectDnt :sep:`|` :aspect:`Data type:` :ref:`t3tsref:data-type-boolean` :sep:`|` :aspect:`Default:` 0 (not set) :sep:`|` If set to `1`, this group respects to the `"Do-not-track" setting of your browser `__. .. _groups.‹group-key›.showDntMessage: groups.‹group-key›.showDntMessage ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. rst-class:: dl-parameters groups..showDntMessage :sep:`|` :aspect:`Data type:` :ref:`t3tsref:data-type-boolean` :sep:`|` :aspect:`Default:` 0 (not set) :sep:`|` If set to `1` **and** the `"Do-not-track" setting of your browser `__ is enabled, an additional message about that is shown inside the group. .. _trackingObjects: trackingObjects ^^^^^^^^^^^^^^^ .. rst-class:: dl-parameters trackingObjects :sep:`|` :aspect:`Data type:` array :sep:`|` This array holds the tracking object configurations. The Cookieman extension already provides several **preconfigured** tracking objects in the folder `./Configuration/TypoScript/TrackingObjects/ `__ (link to the Github repository). .. important:: If you add a preconfigured tracking object, you must at least **adapt** the `inject` code to your needs! The default group 'mandatory' only contains the tracking object `CookieConsent` settings cookie. .. _trackingObjects.‹tracking-object-key›: trackingObjects.‹tracking-object-key› ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. rst-class:: dl-parameters trackingObjects.‹tracking-object-key› :sep:`|` :aspect:`Data type:` array :sep:`|` :aspect:`Example:` fe_typo_user :sep:`|` A single tracking object configuration. Example: .. code-block:: typoscript plugin.tx_cookieman.settings.trackingObjects { // 'Matomo' is the ‹tracking-object-key›: Matomo { // injected code, if consent is given: inject ( ) show { // set cookies, if consent is given: _pk_id { duration = 13 durationUnit = months type = cookie_http+html provider = Matomo } // etc. } } } .. _trackingObjects.‹tracking-object-key›.inject: trackingObjects.‹tracking-object-key›.inject ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. rst-class:: dl-parameters trackingObjects.‹tracking-object-key›.inject :sep:`|` :aspect:`Data type:` :ref:`data-type-html-code` :sep:`|` :aspect:`Example:` :sep:`|` Each HTML tag in here will be appended to the page when the respective group is consented. This can be `