You are here

README.txt in EU Cookie Compliance (GDPR Compliance) 7

Same filename and directory in other branches
  1. 5 README.txt
  2. 6 README.txt
  3. 7.2 README.txt
EU Cookie Compliance 7.x - 1.x
==============================
This module intends to deal with the EU Directive on Privacy and Electronic
Communications that comes into effect on 26th May 2012.
From that date, if you are not compliant or visibly working towards compliance,
you run the risk of enforcement action, which can include a fine of up to
half a million pounds for a serious breach.

How it works.
=============
The module displays a banner at the bottom or at the top of web site to make
users aware of the fact that cookies are being set. The user may then give
his/her consent or move to a page that provides more details. Consent is given
by user pressing the agree buttons or by continuing browsing the web site. Once
consent is given another banner appears with a thank you message.

The module provides a settings page where the banner can be customised. There
are also template files for the banners that can be overridden by your theme.

Upgrade info.
=============
7.24 introduces a dependency on ctools. Please (install and) enable ctools when
you upgrade from a version below 7.24.

https://www.drupal.org/project/ctools

For translations, 7.15 introduced a soft dependency on i18n_variable. If you
need to translate the banners, download i18n and install the i18n_variable and
its dependencies.

https://www.drupal.org/project/i18n

Installation.
=============
1. Unzip the files to the "sites/all/modules" directory and enable the module.

2. If desired, give the administer EU Cookie Compliance banner permissions that
   allow users of certain roles access the administration page. You can do so on
   the admin/user/permissions page.

   - there is also a 'display EU Cookie Compliance banner' permission that helps
   you show the banner to the roles you desire

3. You may want to create a page that would explain how your site uses cookies.
   Alternatively, if you have a privacy policy, you can link the banner to that
   page (see next step).

4. Go to the admin/config/system/eu-cookie-compliance page to configure and
   enable the banner

5. If you want to customise the banner background and text color, either type
   in the hex values or simply install
   http://drupal.org/project/jquery_colorpicker

6. If you want to theme your banner override the themes in the template file.

7. If you want to show the message in EU countries only, install the geoip
   module: http://drupal.org/project/geoip or the smart_ip module:
   http://drupal.org/project/smart_ip and enable the option "Only display banner
   in EU countries" on the admin page. There is a JavaScript based option
   available for sites that use Varnish (or other caching strategies). The
   JavaScript based variant also works for visitors that bypass Varnish.

Translations.
=============

To translate the message in the banners, enable the "i18n_variable" submodule in
the i18n project.

https://www.drupal.org/project/i18n

After enabling "EU Cookie Compliance" at admin/config/regional/i18n/variable,
you will be able to set your translations on the settings page for this module.

Using Domain Access? Instead of using the "domain_settings" module, you need to
use the "domain_variable_i18n" sub-module from the domain_variable project,
or you won't be able to translate the module settings.

https://www.drupal.org/project/domain_variable

For developers.
===============
If you want to conditionally set cookies in your module, there is a javascript
function provided that returns TRUE if the current user has given his consent:

Drupal.eu_cookie_compliance.hasAgreed()

Prevent "Consent by clicking" for some links
============================================
The module offers a feature to accept consent by clicking. It may be relevant to
prevent this for certain links. In such cases, the link(s) can be wrapped in an
element with the class "popup-content".

File

README.txt
View source
  1. EU Cookie Compliance 7.x - 1.x
  2. ==============================
  3. This module intends to deal with the EU Directive on Privacy and Electronic
  4. Communications that comes into effect on 26th May 2012.
  5. From that date, if you are not compliant or visibly working towards compliance,
  6. you run the risk of enforcement action, which can include a fine of up to
  7. half a million pounds for a serious breach.
  8. How it works.
  9. =============
  10. The module displays a banner at the bottom or at the top of web site to make
  11. users aware of the fact that cookies are being set. The user may then give
  12. his/her consent or move to a page that provides more details. Consent is given
  13. by user pressing the agree buttons or by continuing browsing the web site. Once
  14. consent is given another banner appears with a thank you message.
  15. The module provides a settings page where the banner can be customised. There
  16. are also template files for the banners that can be overridden by your theme.
  17. Upgrade info.
  18. =============
  19. 7.24 introduces a dependency on ctools. Please (install and) enable ctools when
  20. you upgrade from a version below 7.24.
  21. https://www.drupal.org/project/ctools
  22. For translations, 7.15 introduced a soft dependency on i18n_variable. If you
  23. need to translate the banners, download i18n and install the i18n_variable and
  24. its dependencies.
  25. https://www.drupal.org/project/i18n
  26. Installation.
  27. =============
  28. 1. Unzip the files to the "sites/all/modules" directory and enable the module.
  29. 2. If desired, give the administer EU Cookie Compliance banner permissions that
  30. allow users of certain roles access the administration page. You can do so on
  31. the admin/user/permissions page.
  32. - there is also a 'display EU Cookie Compliance banner' permission that helps
  33. you show the banner to the roles you desire
  34. 3. You may want to create a page that would explain how your site uses cookies.
  35. Alternatively, if you have a privacy policy, you can link the banner to that
  36. page (see next step).
  37. 4. Go to the admin/config/system/eu-cookie-compliance page to configure and
  38. enable the banner
  39. 5. If you want to customise the banner background and text color, either type
  40. in the hex values or simply install
  41. http://drupal.org/project/jquery_colorpicker
  42. 6. If you want to theme your banner override the themes in the template file.
  43. 7. If you want to show the message in EU countries only, install the geoip
  44. module: http://drupal.org/project/geoip or the smart_ip module:
  45. http://drupal.org/project/smart_ip and enable the option "Only display banner
  46. in EU countries" on the admin page. There is a JavaScript based option
  47. available for sites that use Varnish (or other caching strategies). The
  48. JavaScript based variant also works for visitors that bypass Varnish.
  49. Translations.
  50. =============
  51. To translate the message in the banners, enable the "i18n_variable" submodule in
  52. the i18n project.
  53. https://www.drupal.org/project/i18n
  54. After enabling "EU Cookie Compliance" at admin/config/regional/i18n/variable,
  55. you will be able to set your translations on the settings page for this module.
  56. Using Domain Access? Instead of using the "domain_settings" module, you need to
  57. use the "domain_variable_i18n" sub-module from the domain_variable project,
  58. or you won't be able to translate the module settings.
  59. https://www.drupal.org/project/domain_variable
  60. For developers.
  61. ===============
  62. If you want to conditionally set cookies in your module, there is a javascript
  63. function provided that returns TRUE if the current user has given his consent:
  64. Drupal.eu_cookie_compliance.hasAgreed()
  65. Prevent "Consent by clicking" for some links
  66. ============================================
  67. The module offers a feature to accept consent by clicking. It may be relevant to
  68. prevent this for certain links. In such cases, the link(s) can be wrapped in an
  69. element with the class "popup-content".