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 banner at the bottom or 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 banner appears with a "Thank you" message.
  18
  19 The module provides a settings page where the banner can be customized. There
  20 are also template files for the banners 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
  26    the module.
  27
  28 2. If desired, give the administer EU Cookie Compliance banner permissions that
  29    allow users of certain roles access the administration page. You can do so on
  30    the admin/user/permissions page.
  31
  32   - there is also a 'display eu cookie compliance banner' permission that helps
  33     you show the banner to the roles you desire.
  34
  35 3. You may want to create a page that would explain how your site uses cookies.
  36    Alternatively, if you have a privacy policy, you can link the banner to that
  37    page (see next step).
  38
  39 4. Go to the admin/config/system/eu-cookie-compliance page to configure and
  40    enable the banner.
  41
  42 5. If you want to customize the banner background and text color, either type
  43    in the hex values or simply install
  44    http://drupal.org/project/jquery_colorpicker.
  45
  46 6. If you want to theme your banner, override the themes in the template file.
  47
  48 7. If you want to show the message in EU countries only, install the Smart IP
  49    module: http://drupal.org/project/smart_ip and enable the option "Only
  50    display banner in EU countries" on the admin page. There is a JavaScript
  51    based option available for sites that use Varnish (or other caching
  52    strategies). The JavaScript based variant also works for visitors that bypass
  53    Varnish.
  54
  55 NOTICE: The module does not audit your cookies nor does it prevent cookies from
  56 being set.
  57
  58 For developers.
  59 ===============
  60
  61 If you want to conditionally set cookies in your module, there is a javascript
  62 function provided that returns TRUE if the current user has given his consent:
  63
  64 Drupal.eu_cookie_compliance.hasAgreed()