DEPRECATION WARNING
This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.
EXT: Readable name of your extension¶
| Created: | 2010-02-18T17:33:18 |
|---|---|
| Changed by: | siva |
| Changed: | 2013-03-15T10:01:48 |
| Classification: | extensionkey |
| Description: | The keywords help with categorizing and tagging of the manuals. You can combine two or more keywords and add additional keywords yourself. Please use at least one keyword from both lists. If your manual is NOT in english, see next tab "language" ---- forEditors (use this for editors / german "Redakteure") forAdmins (use this for Administrators) forDevelopers (use this for Developers) forBeginners (manuals covering TYPO3 basics) forIntermediates (manuals going into more depth) forAdvanced (covering the most advanced TYPO3 topics) see more: http://wiki.typo3.org/doc_template#tags ---- |
| Keywords: | keywords comma-separated |
| Author: | Author Name |
| Email: | your@email.com |
| Info 4: | |
| Language: | en |
Cookie-control-cookie_control_extbasecookie-control
Cookie-control Extbase¶
Extension Key: cookie_control_extbase
Language: en
Keywords: cookie-control,Cookie control extbase,Cookie control,Cooke control PIT Solutions
Copyright 2012-2013, Sivaprasad S|PIT Solutions Ltd Pvt. < sivaprasad.s@pitsolutions.com >
Azeef A S|PIT Solutions Ltd Pvt. <azeef @pitsolutions.com >
This document is published under the Open Content License
available from http://www.opencontent.org/opl.shtml
The content of this document is related to TYPO3
- a GNU/GPL CMS/Framework available from www.typo3.org
Table of Contents¶
`Introduction 3 <#1.1.Introduction|outline>`_
`Users manual 5 <#1.2.Users%20manual|outline>`_
`Configuration 6 <#1.3.Configuration|outline>`_
`Typoscript Reference 8 <#1.4.Typoscript%20Reference|outline>`_
`Installation 11 <#1.5.Installation|outline>`_
`Changelog 12 <#1.6.Changelog|outline>`_
`Known problems 13 <#1.7.Known%20problems|outline>`_
`To-Do list 14 <#1.1.To-Do%20list|outline>`_
Introduction¶
What does it do?¶
Overview. Cookie-control extension is a mechanism for controlling user consent for the use of cookie on their computer with a good user interface that doesn't hurt the look and feel of current site . The extension is a widget based on solutions provided by http://www.civicuk.com/cookie-law/index .
Note: Before implementing cookie-control widget on your website please see the Terms and condition.
EU rules about Cookies¶
Third parties may wish to store information on the equipment of a user, or gain access to information already stored, for a number of purposes, ranging from the legitimate (such as certain types of cookies) to those involving unwanted intrusion into the private sphere (such as spyware or viruses). It is therefore of paramount importance that users be provided with clear and comprehensive information when engaging in any activity which could result in such storage or gaining of access. The methods of providing information and offering the right to refuse should be as user-friendly as possible. Exceptions to the obligation to provide information and offer the right to refuse should be limited to those situations where the technical storage or access is strictly necessary for the legitimate purpose of enabling the use of a specific service explicitly requested by the subscriber or user. Where it is technically possible and effective, in accordance with the relevant provisions of Directive 95/46/EC, the user’s consent to processing may be expressed by using the appropriate settings of a browser or other application. The enforcement of these requirements should be made more effective by way of enhanced powers granted to the relevant national authorities.
Here you can see what the extension does:
Users manual¶
((generated))¶
Content Model¶
These can be either of the 3 options:
1: Information only (Informs users the site is using cookies. They are given no option to opt out. )
2: Implicit (Informs users the site is using cookies and they are given the option to opt out. )
3:Explicit (Informs users the site would like to use cookies and they are given the option to opt in. )
Pop up Box title
Enter the title of the cookie control box
Introductory text
Information text as sub header inside the pop up.
These can be either of the 3 options:Extra options
Set some extra JavaScript options as in . Eg :
onAccept:function(){ccAddAnalytics()}
onReady:function(){}
onCookiesAllowed:function(){ccAddAnalytics()},
onCookiesNotAllowed:function(){}
Enable Countries
Enable country check for cookies with a geo cms plug in.
Countries
If the above field is checked, country string can be added in this field to only perform cookie control only for the specified countries in the list. Use the full country name; list of valid country names can be checked here:
Google Analytics Code
If you use Google Analytics, enter your Google Analytics Key in this field here. This will prevent Google Analytics cookies being set before your users allow cookies on your site.
Select the Theme
Select the available css themes that you want to see in the front end, By default the 'Default' theme will be selected.
Custom theme
If theme selection is custom in above field , the path to custom css can be defined here.
Theme Position
The icon can be positioned either in left or right . The default value if left.
*Note
If you want to hide the Cookie Control pop up after the user has given consent then check the *Do not ask me again* in explicit mode .
Configuration¶
Cookie control plug in can be configured in 2 ways
A). tt_content [to be used in case of Information only consent mode]
B). Using Typoscript (used in Implicit or Explicit mode)
Add static typo script “Cookie Control” in the template record. Choose the page to configure cookie control plug in.
Add a plug in content element. Choose general plug in option and then select cookie control in plug in tab
See fig
Click on the ‘Plugin’ tab and fill out all the fields for the configuration option for cookie control plug in. Default values specified in the typo script constants will be taken if fields are empty in plug in options. All available settings in the plug in options are described in the user manual section above.
After filling click the ‘save button’ and the the cookie control pop up will appear in the front end.
Using Typo script (used in Implicit or Explicit mode)
Add the static template Cookie Control in the root template record; adjust the constants (described in typo script configuration page)
Eg: typo script
temp.cookiecontrol = USER
temp.cookiecontrol {
userFunc = tx_extbase_core_bootstrap->run
pluginName = Cookiecontrolextbase
extensionName = CookieControlExtbase
}
}
page.330 < temp.cookiecontrol
Typo Script Settings
Setup:
plugin.tx_cookiecontrolextbase.extra_options = onReady:function(){}, onCookiesAllowed:function(){ccAddAnalytics()},onCookiesNotAllowed:func tion(){}page.20 < plugin.tx_cookiecontrolextbase
Configure the introductory_text and additional_text using locallang variables in typoscript
plugin.tx_cookiecontrolextbase._LOCAL_LANG.default.introductory_te xt = INTRODUCTORY TEXT
plugin.tx_cookiecontrolextbase._LOCAL_LANG.default.introductory_te xt = INTRODUCTORY TEXT.
plugin.tx_cookiecontrolextbase._LOCAL_LANG.default.additional_text = ADDITIONAL TEXT
Typoscript Reference¶
Constants¶
plugin.tx_cookiecontrolextbase.theme.themeselect¶
Property
plugin.tx_cookiecontrolextbase.theme.themeselect
Data type
String
Description
Theme css; default(orange), blue, grey, black
Default
default
plugin.tx_cookiecontrolextbaseextbase.view.partialRootPath¶
Property
plugin.tx_cookiecontrolextbaseextbase.view.partialRootPath
Data type
String
Description
Path to root Templates folder
Default
EXT:cookie_control_extbase/Resources/Private/Templates/
plugin.tx_cookiecontrolextbaseextbase.view.layoutRootPath¶
Property
plugin.tx_cookiecontrolextbaseextbase.view.layoutRootPath
Data type
String
Description
Path to Partials folder
Default
EXT:cookie_control_extbase/Resources/Private/Partials/
plugin.tx_cookiecontrolextbaseextbase.view.templateRootPath¶
Property
plugin.tx_cookiecontrolextbaseextbase.view.templateRootPath
Data type
String
Description
Path to layouts folder
Default
EXT:cookie_control_extbase/Resources/Private/Layouts/
plugin.tx_cookiecontrolextbase.theme.themepath¶
Property
plugin.tx_cookiecontrolextbase.theme.themepath
Data type
String
Description
Theme path for the cookie-control plugin if you are using custom theme
Default
typo3conf/ext/cookiecontrol/
plugin.tx_cookiecontrolextbase.theme.bluetheme¶
Property
plugin.tx_cookiecontrolextbase.theme.bluetheme
Data type
String
Description
Blue theme css filename
Default
plugin.tx_cookiecontrolextbase.theme.greytheme¶
Property
plugin.tx_cookiecontrolextbase.theme.greytheme
Data type
String
Description
Grey theme css filename
Default
plugin.tx_cookiecontrolextbase.theme.blacktheme¶
Property
plugin.tx_cookiecontrolextbase.theme.blacktheme
Data type
String
Description
Black theme css filename
Default
plugin.tx_cookiecontrolextbase.theme.defaulttheme¶
Property
plugin.tx_cookiecontrolextbase.theme.defaulttheme
Data type
String
Description
Deafult theme css file path
Default
plugin.tx_cookiecontrolextbase.theme.countryselction¶
Property
plugin.tx_cookiecontrolextbase.theme.countryselction
Data type
Boolean
Description
Enable Countries option to check cookies for the specified countries.
Default
0
plugin.tx_cookiecontrolextbase.theme.countryfiled¶
Property
plugin.tx_cookiecontrolextbase.theme.countryfiled
Data type
String
Description
Countries in comma seperated format. eg: Germany,France ... more listed here http://www.geoplugin.com/iso3166
Default
plugin.tx_cookiecontrolextbase.theme.theme¶
Property
plugin.tx_cookiecontrolextbase.theme.theme
Data type
String
Description
Custom theme css file path
Default
plugin.tx_cookiecontrolextbase.theme.analyticode¶
Property
plugin.tx_cookiecontrolextbase.theme.analyticode
Data type
String
Description
Google analytics key
Default
plugin.tx_cookiecontrolextbase.theme.consentmode¶
Property
plugin.tx_cookiecontrolextbase.theme.consentmode
Data type
String
Description
Select the consent mode
1.) information_only
2.) explicit
3.) implicit
More info in http://civicuk.com/cookie-law/cookie_configuration_v5
Default
plugin.tx_cookiecontrolextbase.theme.enablesession¶
Property
plugin.tx_cookiecontrolextbase.theme.enablesession
Data type
Boolean
Description
Disable session cookies
Default
0
plugin.tx_cookiecontrolextbase.theme.iconposition¶
Property
plugin.tx_cookiecontrolextbase.theme.iconposition
Data type
String
Description
Select the icon position;
right or left
Default
right
plugin.tx_cookiecontrolextbase.theme.icontype¶
Property
plugin.tx_cookiecontrolextbase.theme.icontype
Data type
String
Description
Select the icon type;
diamond or triangle
Default
Diamond
Setup¶
view.templateRootPath¶
Property
view.templateRootPath
Data type
String
Description
Path to root Templates folder
Default
$plugin.tx_cookiecontrolextbaseextbase.view.templateRootPath
view.partialRootPath¶
Property
view.partialRootPath
Data type
String
Description
Path to Partials folder
Default
$plugin.tx_cookiecontrolextbaseextbase.view.layoutRootPath
view.layoutRootPath¶
Property
view.layoutRootPath
Data type
String
Description
Path to layouts folder
Default
$plugin.tx_cookiecontrolextbaseextbase.view.layoutRootPath
themeselect¶
Property
themeselect
Data type
String
Description
Theme css; default(orange), blue, grey, black
Default
$plugin.tx_cookiecontrolextbase.theme.themepath
themepath¶
Property
themepath
Data type
String
Description
Theme path for the cookie-control plugin if you are using custom theme
Default
$plugin.tx_cookiecontrolextbase.theme.themeselect
bluetheme¶
Property
bluetheme
Data type
String
Description
Blue theme css filename
Default
$plugin.tx_cookiecontrolextbase.theme.bluetheme
greytheme¶
Property
greytheme
Data type
String
Description
Grey theme css filename
Default
$plugin.tx_cookiecontrolextbase.theme.greytheme
blacktheme¶
Property
blacktheme
Data type
String
Description
Black theme css filename
Default
$plugin.tx_cookiecontrolextbase.theme.blacktheme
defaulttheme¶
Property
defaulttheme
Data type
String
Description
Deafult theme css file path
Default
$plugin.tx_cookiecontrolextbase.theme.defaulttheme
countryselction¶
Property
countryselction
Data type
Boolean
Description
Enable Countries option to check cookies for the specified countries.
Default
$plugin.tx_cookiecontrolextbase.theme.countryselection
countryfiled¶
Property
countryfiled
Data type
String
Description
Countries in comma seperated format. eg: Germany,France ... more listed here http://www.geoplugin.com/iso3166
Default
$plugin.tx_cookiecontrolextbase.theme.countryfield
analyticode¶
Property
analyticode
Data type
String
Description
Google analytics key
Default
$plugin.tx_cookiecontrolextbase.theme.analyticscode
consentmode¶
Property
consentmode
Data type
String
Description
Select the consent mode
1.) information_only
2.) explicit
3.) implicit
More info in http://civicuk.com/cookie-law/cookie_configuration_v5
Default
$plugin.tx_cookiecontrolextbase.theme.consentmodel
enablesession¶
Property
enablesession
Data type
Boolean
Description
Disable session cookies
Default
$plugin.tx_cookiecontrolextbase.theme.enableSession
iconposition¶
Property
iconposition
Data type
String
Description
Select the icon position;
right or left
Default
$plugin.tx_cookiecontrolextbase.theme.iconposition
icontype¶
Property
icontype
Data type
String
Description
Select the icon type;
diamond or triangle
Default
$plugin.tx_cookiecontrolextbase.theme.icontype
Third parties may wish to store information on the equipment of a user, or gain access to information already stored, for a number of purposes, ranging from the legitimate (such as certain types of cookies) to those
Installation¶
Installing this extension is fairly easy. Just download it via the Extension Manager (EM) and click on the install button. Add the static template 'Cookie Control' in the root template.