6.1
en
WACON Internet GmbH
This extension documentation is published under the CC BY-NC-SA 4.0 (Creative Commons) license
Table of Contents
wacon_cookie_management(WCM) is a TYPO3 extension that enables website owner to comply to the General Data Protection Regulation (GDPR) in terms of the usage of cookies an the inclusion of external ressources. The Plugin displays a cookie consent box whenever the permission of a website visitor is necessary (so called "opt-in" method), saves the settings and generates a cookie to identify the user in further page requests.
If you run a website you have to consider at least two types of cookies:
Ask the website visitor for consent BEFORE you use:
The layout, position, content, images and options can be fully customized. Here are some samples:
Frontend view of the cookie consent box
Visitors can change their preferences on any page via a link at the page
"Frosted glass effect" to visualize a required consent
Install the extension via composer by using the following command
composer req waconcookiemanagement/wacon-cookie-management
Search for wacon_cookie_management and choose the proper version:
Install WCM via Extension Manager
Include the WCM Template in your Site Template:
Include static Template Wacon Cookie Management
This extensions loads its own jQuery file. You can disable it by adding the following TypoScript inside your
constants. or by editing the constants inside the constant editor in the Template module.
plugin.tx_waconcookiemanagement_cookiefreigabe.settings.includeJQuery = 0Create a new folder for your cookies (here "WCM").
Set the folder in TypoScript inside your
constants. or by editing the constants inside the constant editor in the Template module.
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
Define new cookie
Fill out the fields as accurate as possible
Fields of a Cookie record
Edit Cookie information when needed
Edit Cookie information
In Rich Text Editors you can make some settings inside your .yaml file so that you can insert links to the
cookie consent box inside any bodytext.
Put the following configuration inside your .yaml file for your RTE.
For example, it could be located inside Configuration/ but this depends on your sitepackage/exension:
editor:
config:
stylesSet:
- { name: "Cookie Set", element: "p", attributes: { 'class': 'cookie-set' } }
With this settings, you get an extra dropdown item inside the Style-dropdown list.
This example surrounds the <p>-Tag with an extra class cookie-. f.e.: <p class="cookie-
Example of the dropdown.
Important
You can use any other solution for adding this class to your text. It is only important, that the element must have
the class cookie-.
For example you can use a <span>-Tag like <span class="cookie-.
Be aware that you might need other settings than explained here.
Create a new folder for your scripts you want to include in the <head>.
Set the folder in TypoScript inside your
constants. or by editing the constants inside the constant editor in the Template module.
plugin.tx_waconcookiemanagement_cookiefreigabe.settings.headerScriptStorage = {your pid}Manage your cookies by selecting the corresponding folder in the List module:
Create or edit a cookie record and supply the required information:
Prevent external content to load without consent by using the plugin "Include external resource":
Include external resource
Fill out the fields:
Define external resource
Prevent external content to load without consent by using the plugin "WCM Include script in header":
Fill out the fields:
All known issues will be listed in our GitHub Repository. If there are specific issues which will occur from time to time in several installations, they will be listed here, too.
Target group: Administrators
Describes how to manage the extension from an administrator point of view. That relates to Page/User TSconfig, permissions, configuration etc., which administrator level users have access to.
Language should be non / semi-technical, explaining, using small examples.
To install the extension, perform the following steps:
For a list of configuration options, using a definition list is recommended:
Extension Manager (caption of the image)
List of extensions within the Extension Manager also shorten with "EM" (legend of the image)
Possible subsection: FAQ
Some subsection
Deeper into the structure...
Give a link pointing to a roadmap. Alternatively, you can dress up a list of things you want to add or fix in this chapter or give a vision about where the extension is heading.
Target group: Editors
Here should be described how to use the extension from the editor perspective.
How does it work?
Language should be non-technical, explaining, using small examples. Don't use to many acronyms unless they have been explained. Don't be confusing by putting information targeting administrators.
Tip
Take a break from time to time.
Admonitions should be used to warn the users about potential pitfalls, attract their attention to important elements or just add some notes for for information (further reading, for example).
Important
Remember to always say "please" when asking your software to do something.
Provide screenshots as needed for making things clear. When creating screenshots, try using the Introduction Package as a neutral TYPO3 CMS instance.
Default Backend view (caption of the image)
The Backend view of TYPO3 after the user has clicked on module "Page". (legend of the image)
Possible subsection: FAQ