Initial commit - Typo3 11.5.41

typo3conf/ext/dp_cookieconsent/Documentation/Configuration/Configuration.rst

@@ -0,0 +1,68 @@
+.. include:: ../Includes.rst.txt
+
+.. _config:
+
+
+=============================================================
+Configuration
+=============================================================
+
+.. container:: row m-0 p-0
+
+   .. container:: col-12 col-md-6 pl-0 pr-3 py-3 m-0
+
+      .. container:: card px-0 h-100
+
+         .. rst-class:: card-header h3
+
+            .. rubric:: :ref:`Basic <config_basics>`
+
+         .. container:: card-body
+
+            The default constants configruation for the plugin
+
+   .. container:: col-12 col-md-6 pl-0 pr-3 py-3 m-0
+
+      .. container:: card px-0 h-100
+
+         .. rst-class:: card-header h3
+
+            .. rubric:: :ref:`Palette <config_palette>`
+
+         .. container:: card-body
+
+            Customizing the consent Window
+
+   .. container:: col-12 col-md-6 pl-0 pr-3 py-3 m-0
+
+      .. container:: card px-0 h-100
+
+         .. rst-class:: card-header h3
+
+            .. rubric:: :ref:`Overlay <config_overlay>`
+
+         .. container:: card-body
+
+            Customizing the Overlay Window
+
+   .. container:: col-12 col-md-6 pl-0 pr-3 py-3 m-0
+
+      .. container:: card px-0 h-100
+
+         .. rst-class:: card-header h3
+
+            .. rubric:: :ref:`Example Configuration <example>`
+
+         .. container:: card-body
+
+            A example configuration
+
+.. toctree::
+   :glob:
+   :hidden:
+   :titlesonly:
+
+   Constants/Default
+   Constants/Palette
+   Constants/Overlay
+   Constants/Example

typo3conf/ext/dp_cookieconsent/Documentation/Configuration/Constants/Default.rst

@@ -0,0 +1,91 @@
+.. include:: ../../Includes.rst.txt
+
+.. _config_basics:
+
+===========
+Basic
+===========
+
+plugin.tx_cookieconsent.settings.
+=========
+
+url
+--------------------
+:aspect:`Description`
+   PID to Data Protection
+
+storagePid
+--------------------
+:aspect:`Description`
+   PID to Cookie Folder
+
+target
+--------------------
+:aspect:`Description`
+   Link target of read more link
+:aspect:`Default`
+   _bank
+
+theme
+--------------------
+:aspect:`Description`
+   Layout Class of the consent
+:aspect:`Options`
+   edgeless, :guilabel:`... following ..`
+:aspect:`Default`
+   edgeless
+
+position
+--------------------
+:aspect:`Description`
+   position of the consent
+:aspect:`Options`
+   bottom, top, bottom-left, bottom-right
+:aspect:`Default`
+   bottom-right
+
+revokable
+--------------------
+:aspect:`Description`
+   Some countries REQUIRE that users can change their mind
+:aspect:`Options`
+   true, false
+:aspect:`Default`
+   true
+
+reloadOnRevoke
+--------------------
+:aspect:`Description`
+   force page reload after revoke
+:aspect:`Options`
+   true, false
+:aspect:`Default`
+   false
+
+type
+--------------------
+:aspect:`Description`
+   consent types
+:aspect:`Options`
+   opt-in, :guilabel:`... following ..`
+:aspect:`Default`
+   opt-in
+
+statistics
+--------------------
+:aspect:`Description`
+   pre check statistics in checkboxes layout
+:aspect:`Options`
+   true, false
+:aspect:`Default`
+   false
+
+marketing
+--------------------
+:aspect:`Description`
+   pre check marketing in checkboxes layout
+:aspect:`Options`
+   true, false
+:aspect:`Default`
+   false
+

typo3conf/ext/dp_cookieconsent/Documentation/Configuration/Constants/Example.rst

@@ -0,0 +1,64 @@
+.. include:: ../../Includes.rst.txt
+
+.. _example:
+
+===========
+Example
+===========
+
+This example configuration is based on the base TypoScript-Constants configuration (see :ref:`installation`).
+
+.. code-block:: typoscript
+   :caption: TypoScript constants
+
+    plugin.tx_cookieconsent.settings {
+        # PID to Data Protection
+        url =
+        # PID of Cookie Storage
+        storagePid =
+        # Layout
+        theme = edgeless
+        # Position
+        position = bottom-right
+        # Type (info, opt-out, opt-in)
+        type = opt-in
+        #  pre check statistics in checkboxes layout
+        statistics = false
+        # pre check statistics in checkboxes layout
+        marketing = false
+
+        # show Iframe overlay
+        overlay {
+            # Enable Iframe overlay
+            notice = true
+
+            box {
+                # Overlay: Background
+                background = rgba(0,0,0,.8)
+                # Overlay: Text
+                text = #fff
+            }
+            button {
+                # Overlay Button: Background
+                background = #b81839
+                # Overlay Button: Text
+                text = #fff
+            }
+        }
+
+        # Cookiehint Style
+        palette {
+            popup {
+                # Bar: Background color
+                background = rgba(0,0,0,.8)
+                # Bar: text color
+                text = #fff
+            }
+            button {
+                # Button: Background color
+                background = #b81839
+                # Button: text color
+                text = #fff
+            }
+        }
+    }

typo3conf/ext/dp_cookieconsent/Documentation/Configuration/Constants/Overlay.rst

@@ -0,0 +1,61 @@
+.. include:: ../../Includes.rst.txt
+
+.. _config_overlay:
+
+===========
+Overlay
+===========
+
+Customizing the Overlay Window
+
+.. figure:: ../../Images/iframe-overlay.png
+   :class: with-shadow
+   :width: 400px
+
+plugin.tx_cookieconsent.settings.overlay.
+=========
+
+notice
+--------------------
+:aspect:`Description`
+   enable or disable overlays (iframe, content)
+:aspect:`Options`
+   true, false
+:aspect:`Default`
+   true
+
+box.background
+--------------------
+:aspect:`Description`
+   Overlay: Background color
+:aspect:`Options`
+   rgba(), #hexa
+:aspect:`Default`
+   rgba(0,0,0,.8)
+
+box.text
+--------------------
+:aspect:`Description`
+   Overlay: text color
+:aspect:`Options`
+   rgba(), #hexa
+:aspect:`Default`
+   #fff
+
+button.background
+--------------------
+:aspect:`Description`
+   Overlay: Button Background color
+:aspect:`Options`
+   rgba(), #hexa
+:aspect:`Default`
+   #b81839
+
+button.text
+--------------------
+:aspect:`Description`
+   Overlay: Button text color
+:aspect:`Options`
+   rgba(), #hexa
+:aspect:`Default`
+   #fff

typo3conf/ext/dp_cookieconsent/Documentation/Configuration/Constants/Palette.rst

@@ -0,0 +1,52 @@
+.. include:: ../../Includes.rst.txt
+
+.. _config_palette:
+
+===========
+Palette
+===========
+
+Customizing the consent Window
+
+.. figure:: ../../Images/consent-box.png
+   :class: with-shadow
+   :width: 400px
+
+plugin.tx_cookieconsent.settings.palette.
+=========
+
+popup.background
+--------------------
+:aspect:`Description`
+   Consent Background color
+:aspect:`Options`
+   rgba(), #hexa
+:aspect:`Default`
+  rgba(0,0,0,.8)
+
+popup.background
+--------------------
+:aspect:`Description`
+   Consent Text color
+:aspect:`Options`
+   rgba(), #hexa
+:aspect:`Default`
+  #fff
+
+button.background
+--------------------
+:aspect:`Description`
+   Consent Button Background color
+:aspect:`Options`
+   rgba(), #hexa
+:aspect:`Default`
+  #b81839
+
+button.text
+--------------------
+:aspect:`Description`
+   Consent Button Text color
+:aspect:`Options`
+   rgba(), #hexa
+:aspect:`Default`
+  #fff

typo3conf/ext/dp_cookieconsent/Documentation/Configuration/Content.rst

@@ -0,0 +1,19 @@
+.. include:: ../Includes.rst.txt
+
+.. _content:
+
+===========
+Content Loading
+===========
+If you want to load a Youtube Video or any other HTMl Code after the consent is accepted take a loot to the new Content element.
+
+.. figure:: ../Images/be-element.png
+   :class: with-shadow
+   :width: 400px
+
+Just add your Youtube embed Code into this element, and the Plugin will handle it four you.
+
+.. figure:: ../Images/be-element-detail.png
+   :class: with-shadow
+   :width: 400px
+

typo3conf/ext/dp_cookieconsent/Documentation/Configuration/CookieList.rst

@@ -0,0 +1,25 @@
+.. include:: ../Includes.rst.txt
+
+.. _cookielist:
+
+===========
+Cookie listing
+===========
+
+.. figure:: ../Images/be-element-cookie-list.png
+   :class: with-shadow
+   :width: 600px
+
+    If you want to list all your defined cookies in the data privacy, use the **Cookie Listing** content element.
+
+.. figure:: ../Images/be-cookies.png
+   :class: with-shadow
+   :width: 600px
+
+    Define the Startingpoint where u placed alle cookie information.
+
+.. figure:: ../Images/data-privacy-cookie-list.png
+   :class: with-shadow
+   :width: 600px
+
+    As result u get a `Bootstrap Table <https://getbootstrap.com/docs/5.0/content/tables/>`_ which shows u all defined cookies.

typo3conf/ext/dp_cookieconsent/Documentation/Configuration/Language.rst

@@ -0,0 +1,78 @@
+.. include:: ../Includes.rst.txt
+
+.. _language:
+
+===========
+Language changes
+===========
+
+You can change the default language packs by adding new translations via TypoScript
+
+.. note::
+   **If you are from a country other than Germany, let me know your legal text and I will mark it for the next version!**
+
+Arguments
+=========
+.. _language_arguments:
+plugin.tx_dp_cookieconsent._LOCAL_LANG.##LANG##.
+--------------------
+:aspect:`message`
+    the default consent message
+
+:aspect:`dismiss`
+    allow cookie button
+
+:aspect:`link`
+    read more link
+
+:aspect:`deny`
+    decline button
+
+:aspect:`allow`
+    allow cookie button
+
+:aspect:`allowall`
+    allow all cookie button
+
+:aspect:`dpRequire`
+    checkbox required label
+
+:aspect:`dpStatistik`
+    checkbox statistic label
+
+:aspect:`dpMarketing`
+    checkbox marketing label
+
+:aspect:`media.notice`
+    overlay notice headline
+
+:aspect:`media.desc`
+    overlay notice text
+
+:aspect:`media.btn`
+    overlay button text
+
+
+.. code-block:: typoscript
+    :caption: TypoScript setup
+
+    plugin.tx_dp_cookieconsent._LOCAL_LANG {
+        de {
+            message = XXX
+            dismiss = XXX
+            allow = XXX
+            link = XXX
+            deny = XXX
+            allowall = XXX
+
+            # Checkbox labels
+            dpRequire = XXX
+            dpStatistik = XXX
+            dpMarketing = XXX
+
+            # Iframe Overlay text
+            media.notice = XXX
+            media.desc = XXX
+            media.btn = XXX
+        }
+    }

typo3conf/ext/dp_cookieconsent/Documentation/Configuration/Scripts.rst

@@ -0,0 +1,33 @@
+.. include:: ../Includes.rst.txt
+
+.. _scripts:
+
+===========
+Script loading
+===========
+Since version 1.3.0, you can define scripts such as Google Analytics in the TYPO3 backend that are loaded after the content has been accepted.
+To do this, define the cookie and select the consent type.
+
+.. note::
+   make sure u defined the storagePid :ref:`Configuration <config_arguments>`
+
+.. figure:: ../Images/be-cookies.png
+   :class: with-shadow
+   :width: 600px
+
+    list of defined cookies
+
+.. figure:: ../Images/be-cookie-example.png
+   :class: with-shadow
+   :width: 400px
+
+    basic cookie information
+
+.. figure:: ../Images/be-cookie-example-scripts.png
+   :class: with-shadow
+   :width: 400px
+
+    script that loads after consent
+
+
+If you want to define the script directly in your code, look in the :ref:`developer area <scripts_code>`.