lib_django_cookie_law /

Filename Size Date modified Message
cookie_law
275 B
932 B
1.6 KB
41 B
3.0 KB
1.7 KB
Django cookie law
=================
This is a Django application that makes it easy to implement cookies compliant with Dutch law, as far as I am able
to tell. I'm not a lawyer, so use at your own risk.

Updating
========

From 0.1.6 to 0.2 or higher
-------------------

The model has changed, run South migrations. Multilingual support has been added. Optional title and close fields
added.


From 0.1.4 to 0.1.5
--------------------

If you're updating from 0.1.4 to 0.1.5 take note that the CookieBar model has changed,
you should run the South migrations.


Requirements
============

- jQuery>=1.5.1

Usage
=====

- Add the cookie_law app to your INSTALLED_APPS.
- Add 'url(r'^cookies/', include('cookie_law.urls')),' to your main urls.py, without the ''.
- Run the cookie_law migrations or syncdb if you don't use South, but you should.
- Load the cookie_bar template tags and include {% show_cookie_bar %} under the <body> tag in your base template.
- Create a cookie bar in the admin (if you do not a default bar will be created, you should edit this asap).
- Surround your cookies with {% if request.COOKIES.allow_cookies == '1' %} <cookie> {% endif %}
- To change the domain used for the cookies to check a visitor's preferences, create a Django setting.COOKIE_LAW_DOMAIN


Cookie Bar Details
------------------

- Optional title:
    This title can be displayed as a title for your text
- Optional link cookie policy page:
    If you want a page explaining what kind of cookies you use and why place the full url here.
- Optional display name of the link:
    This will be displayed after the display text. For instance:
    "This site uses cookies, read about it <link_display_name>"
- Title of the allow cookie button:
    This will be the text shown in the cookie bar button.
- Text:
    The text displayed in the cookie bar.
- "This cookie bar is displayed":
    Check this if you want this particular cookie bar to be shown.
    Cookie bars without this boolean will not be shown.
- Optional "Show a close (dismiss) button for this cookie bar" boolean:
    The close field is used when you want to give visitors the option to hide the cookie bar
    while not accepting cookies. This is turned off by default.
- Optional Language:
    You can create a cookie bar for multiple languages, read more about this in the Multilingual support section.
    Each of these cookie bars will need the "This cookie bar is displayed" boolean set to True.


Multilingual Support
--------------------

If you want multilingual support add the languages you want to your settings file.
LANGUAGES = (('nl','Nederlands'), ('en','English'))
Every time the cookie bar template tag is called it will check if a cookie bar exists for each language,
if not; one will be created. It is up to you to translate these into the right language.
You can do this via the admin.

The multilingual support works by checking for a LANGUAGE_CODE in the request.
Localization middleware should handle this. If this doesn't exist the default Dutch cookie bar will be used.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.