Skip to content

Commit

Permalink
Update docu
Browse files Browse the repository at this point in the history
  • Loading branch information
kuschmitt committed Dec 20, 2024
1 parent bab2497 commit 5116408
Show file tree
Hide file tree
Showing 4 changed files with 57 additions and 67 deletions.
56 changes: 48 additions & 8 deletions Documentation/Configuration/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,19 +15,46 @@ This extensions loads its own jQuery file. You can disable it by adding the foll
.. code-block:: typoscript
plugin.tx_waconcookiemanagement_cookiefreigabe.settings.includeJQuery = 0
Limit the amount of days, the cookie consents will be stored inside the database
================================================================================
Define your cookies
===============

You can now set how long user consent is stored in the database.
This can help to keep the database-tables as small as possible.
Create a new folder for your cookies (here "WCM").

This setting is available inside TypoScript
Set the folder in TypoScript inside your
`constants.typoscript` or by editing the constants inside the constant editor in the Template module.

.. code-block:: typoscript
plugin.tx_waconcookiemanagement_cookiefreigabe.settings.statisticsDays = 30
plugin.tx_waconcookiemanagement_cookiefreigabe.settings.cookieStorage = {your pid}
Go to the list module an create a "Cookie" record for each cookie you use on your website


.. figure:: ../Images/wcm_screenshot8.jpg
:class: with-shadow
:alt: New Cookie record
:width: 300px

Define new cookie

Fill out the fields as accurate as possible

.. figure:: ../Images/wcm_screenshot7.jpg
:class: with-shadow
:alt: Cookie information
:width: 500px

Fields of a Cookie record

Edit Cookie information when needed

.. figure:: ../Images/wcm_screenshot6.jpg
:class: with-shadow
:alt: Edit Cookie information
:width: 500px

Edit Cookie information


.. info::
This is by default set to 365 days.

Adding links inside bodytext for displaying the cookie consent box
==================================================================
Expand Down Expand Up @@ -59,3 +86,16 @@ This example surrounds the `<p>`-Tag with an extra class `cookie-set`. f.e.: `<p
For example you can use a `<span>`-Tag like `<span class="cookie-set">Cookies</span>`.

Be aware that you might need other settings than explained here.


Define folder for scripts in <head>-Tag
=======================================

Create a new folder for your scripts you want to include in the <head>.

Set the folder in TypoScript inside your
`constants.typoscript` or by editing the constants inside the constant editor in the Template module.

.. code-block:: typoscript
plugin.tx_waconcookiemanagement_cookiefreigabe.settings.headerScriptStorage = {your pid}
29 changes: 9 additions & 20 deletions Documentation/Editor/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Create or edit a cookie record and supply the required information:



Use the plugin
Use the plugin for content/script in <body>
==========
Prevent external content to load without consent by using the plugin "Include external resource":

Expand All @@ -37,6 +37,7 @@ Prevent external content to load without consent by using the plugin "Include ex

Fill out the fields:

- Direct accepted - the cookie is activated direct by click, you have to write this in the field "Show text if Cookie is not accepted"
- Choose the corresponding Cookie record
- Copy the script or html code in the field "Script"
- Deliver text to be shown if the resource is not accepted yet by the visitor
Expand All @@ -50,24 +51,12 @@ Fill out the fields:

Define external resource

Show statistics
Use the plugin for script in <head>
==========
Since TYPO3 v10 you can analyze the usage of the cookie settings with a dashboard widget:


.. important::
You need to have the EXT:dashboard installed to view the widgets.


.. figure:: ../Images/wcm_screenshot4.jpg
:class: with-shadow
:alt: Dashboard integration
:width: 500px

Click on "details" to select the information by month:

Prevent external content to load without consent by using the plugin "WCM Include script in header":

Fill out the fields:

.. figure:: ../Images/wcm_screenshot11.jpg
:class: with-shadow
:alt: Cookie counter
:width: 500px
- Choose the corresponding Cookie record
- Copy the script or html code in the field "Script"
- Tell the Plugin where your Cookie records are stored
32 changes: 0 additions & 32 deletions Documentation/Installation/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,36 +37,4 @@ Include the WCM Template in your Site Template:

Include static Template Wacon Cookie Management

Define your cookies
===============

Create a new folder for your cookies and scripts (here "WCM").

Go to the list module an create a "Cookie" record for each cookie you use on your website


.. figure:: ../Images/wcm_screenshot8.jpg
:class: with-shadow
:alt: New Cookie record
:width: 300px

Define new cookie

Fill out the fields as accurate as possible

.. figure:: ../Images/wcm_screenshot7.jpg
:class: with-shadow
:alt: Cookie information
:width: 500px

Fields of a Cookie record

Edit Cookie information when needed

.. figure:: ../Images/wcm_screenshot6.jpg
:class: with-shadow
:alt: Edit Cookie information
:width: 500px

Edit Cookie information

7 changes: 0 additions & 7 deletions Documentation/Introduction/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,10 +64,3 @@ The layout, position, content, images and options can be fully customized. Here

"Frosted glass effect" to visualize a required consent

.. figure:: ../Images/wcm_screenshot4.jpg
:class: with-shadow
:alt: Dashboard integration
:width: 500px

Dashboard integration with counter for "Allow all cookies", "Allow only necessary cookies", "Individual cookie settings"

0 comments on commit 5116408

Please sign in to comment.