www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/eu_cookie_compliance/README.txt

   1 EU Cookie Compliance 8.x - 1.x
   2 ==============================
   3
   4 This module intends to deal with the EU Directive on Privacy and Electronic
   5 Communications that comes into effect on 26th May 2012.
   6 From that date, if you are not compliant or visibly working towards compliance,
   7 you run the risk of enforcement action, which can include a fine of up to
   8 half a million pounds for a serious breach.
   9
  10 How it works.
  11 =============
  12
  13 The module displays a pop-up at the bottom or at the top of website to make
  14 users aware of the fact that cookies are being set. The user may then give
  15 his/her consent or move to a page that provides more details. Consent is given
  16 by user pressing the agree buttons or by continuing browsing the website. Once
  17 consent is given another pop-up appears with a thank you message.
  18
  19 The module provides a settings page where the pop-up can be customized. There
  20 are also template files for the pop-ups that can be overridden by your theme.
  21
  22 Installation.
  23 =============
  24
  25 1. Unzip the files to the "sites/all/modules" OR "modules" directory and enable the module.
  26
  27 2. If desired, give the administer EU Cookie Compliance pop-up permissions that
  28 allow users of certain roles access the administration page. You can do so on
  29 the admin/user/permissions page.
  30
  31   - there is also a 'display eu cookie compliance popup' permission that helps
  32     you show the popup to the roles you desire.
  33
  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 pop-up to that
  36 page (see next step).
  37
  38 4. Go to the admin/config/system/eu-cookie-compliance page to configure and enable
  39 the pop-up.
  40
  41 5. If you want to customize the pop-up background and text color, either type
  42 in the hex values or simply install http://drupal.org/project/jquery_colorpicker.
  43
  44 6. If you want to theme your pop-up override the themes in the template file.
  45
  46 7. If you want to show the message in EU countries only, install the geoip
  47 module: http://drupal.org/project/geoip and enable the option on the admin page.
  48
  49 NOTICE: The module does not audit your cookies nor does it prevent cookies
  50 from being set.
  51
  52 For developers.
  53 ===============
  54
  55 If you want to conditionally set cookies in your module, there is a javascript
  56 function provided that returns TRUE if the current user has given his consent:
  57
  58 Drupal.eu_cookie_compliance.hasAgreed()
  59
  60 To run test you should run next script:
  61
  62 php ./core/scripts/run-tests.sh --color --verbose --browser --url <http://example.com> --class "\Drupal\eu_cookie_compliance\Tests\EuCookieComplianceTest"
  63
  64 If you have Drupal Console installed:
  65
  66 drupal tr --url=<http://example.com> "\Drupal\eu_cookie_compliance\Tests\EuCookieComplianceTest"