.. image:: https://travis-ci.org/RedTurtle/collective.analyticspanel.svg?branch=master
:target: https://travis-ci.org/RedTurtle/collective.analyticspanel
This product will replace the basic Plone feature for **adding analytics JavaScript to your site**
with an advanced version.
.. contents:: **Table of contents**
Introduction
============
New features added:
* add possibility to add specific JavaScript when the user is **inside error page**
(useful for special code when on the "*Page not found*")
* add possibility to **customize code for a site area** or a single content
* not display JavaScript code for specific area of the site
* choose to put you snippets in the page header or footer)
How to use it
=============
When installed, the basic Plone feature for handling JavaScript for statistics is hidden from the standard
"*Site settings*" (in facts, it's moved to a new configuration panel called "*Analytics settings*") and
new options are now available.
JavaScript for web statistics support
-------------------------------------
.. image:: http://blog.redturtle.it/pypi-images/collective.analyticspanel/collective.analyticspanel-0.4.0-01.png
:alt: Basic feature
Nothing new there: this is simply the basic Plone feature about JavaScript inclusion, just moved in this
separate panel (and you can put it in the header of the page).
This is always the default code included when other options don't match.
JavaScript to be included when an error message is get
------------------------------------------------------
.. image:: http://blog.redturtle.it/pypi-images/collective.analyticspanel/collective.analyticspanel-0.4.0-02.png
:alt: Code for error page
When this product is installed you can control JavaScript code based on error messages (ignoring the default one).
The main motivation is to use this for the ``NotFound`` (HTTP 404) error.
However this feature is still generic... you could probably use it for other error code (like ``ValueError``)
if this make any sense for you!
JavaScript to be included inside specific site's paths
------------------------------------------------------
.. image:: http://blog.redturtle.it/pypi-images/collective.analyticspanel/collective.analyticspanel-0.4.0-03.png
:alt: Code for specific site's path
You can use this section for putting a list of absolute site subsection you want to control, adding a specific
JavaScript section and ignoring the default one.
When more than a provided path match the current URL, the most specific ones is used.
This kind of rule has a policy selection.
.. image:: http://blog.redturtle.it/pypi-images/collective.analyticspanel/collective.analyticspanel-0.3.0-04.png
:align: right
:alt: Policy selection
* The default one ("*to the whole subtree*") is for applying the rule to the whole subtree.
* Using "*only to the context*" you can choose to apply the analytics code only to the content and not
to sub-contents inside it.
* Using "*to the context and non-folderish children*" you are applying the analytics code only to the content,
and to all sub-contents inside it that are not folders.
This last policy seems a little complex, but there are analytics tools (at least: `Piwik`__) where this can
be useful to define custom reports for sections of the site.
__ http://piwik.org/
As the concept of "folder" in Plone can change with different add-ons installed, this last policy take care
of using as "folder" what is defined in the "*Folderish types*" configuration option.
.. image:: http://blog.redturtle.it/pypi-images/collective.analyticspanel/collective.analyticspanel-0.3.0-05.png
:alt: Folderish types selection panel
The Plone native "Folder" type is selected by default.
Hiding
------
You can also use this product for hiding analytics code from specific site areas or error pages, leaving a default
one for the rest of the site.
Just configure options with empty code!
JavaScript in the header or footer of the page?
===============================================
Historically Plone put analytics code in the page footer; this is an old way to go and modern analytics
software suggest to put you code before the ``body`` tag.
However old analytics software that can block the page rendering are better to be kept at the end of the page.
For this reason this product will let you add analytics on both header or footer of the page at your choice.
As you seen this option is available everywhere, for every feature added, just note that analytics in the header
or footer are treat separately.
Privacy
=======
EU has been recently hit by the `Cookie Law`__ phenomenon.
This add-on provide now a couple of privacy settings you can enable if *you* think that analytics in your site
could harm privacy of your users.
* The `Do Not Track`__ option is about a client side feature added on some modern browser.
* The usare of a ``analytics-optout`` cookie is something different.
The scope of this add-on is to react to the presence (and value) of this cookie, but is task of 3rd party add-on
(or software outside Plone) to generate this cookie.
__ http://eur-lex.europa.eu/legal-content/EN/TXT/?uri=celex:32009L0136
__ https://en.wikipedia.org/wiki/Do_Not_Track
**Please note** that the best way to conditionally load analytics code based on cookie presence is to perform it
*client side*.
Server side check commonly require integration with reverse-proxy in front of Plone (if any).
Compatibility
=============
Plone >= 5.2 and Python3 from version 2.0.0.
For previous Plone versions, use < 2.0.0
Credits
=======
Developed with the support of:
* `Regione Emilia Romagna`__
* `Provincia di Ferrara`__
.. image:: http://www.provincia.fe.it/Distribuzione/logo_provincia.png
:alt: Provincia di Ferrara - logo
All of them supports the `PloneGov initiative`__.
__ http://www.regione.emilia-romagna.it/
__ http://www.provincia.fe.it/
__ http://www.plonegov.it/
Authors
=======
This product was developed by RedTurtle Technology team.
.. image:: http://www.redturtle.it/redturtle_banner.png
:alt: RedTurtle Technology Site
:target: http://www.redturtle.it/
Changelog
=========
2.0.1 (2023-09-18)
------------------
- Fix logic in controlpanel save method.
[cekk]
2.0.0 (2022-11-23)
------------------
- Major refactoring for python 3.8 and plone 5.2
[axaroth]
1.0.0 (2019-01-09)
------------------
- Remove custom persistent field from registry.
[cekk]
0.6.1 (2017-09-15)
------------------
- Fix pypi classifiers
[cekk]
0.6.0 (2017-09-15)
------------------
- Plone 5 compatibility.
[cekk, mamico]
- Drop plone 3 compatibility.
[cekk]
- Fix tests and add travis config.
[cekk]
0.5.0 (2017-01-20)
------------------
- Added options to block analytics for user's privacy choices
[keul]
- Don't show analytics in views used on overlays (so with ajax_load paramiter)
[cekk]
0.4.0 (2014-06-25)
------------------
- Fix bug that prevented viewlet from being shown on plone sites
located in subfolders (eg. /project/Plone) which is quite common
when ZODB mountpoints are used. [fRiSi]
- Fixed a bug that randomly hit the installation (See `#2`__) [keul]
- Fixed translations not shown in vocabulary [keul]
- You can now choose to put analytics before the ``body`` tag or
near the end of it. This close `#1`__
__ https://github.com/RedTurtle/collective.analyticspanel/issues/2
__ https://github.com/RedTurtle/collective.analyticspanel/issues/1
0.3.0 (2012-08-28)
------------------
- Italian i18n fixes [keul]
- Added a way to set rules for subsections and leaf contents inside
(subcontents that are not folderish) [keul]
0.2.0 (2012-07-13)
------------------
- Some styles fixes in the management panel [keul]
- Added new option: ``apply_to_subsection``
- Added the "*autoresize*" CSS class for textareas
(in the case you also use `collective.autoresizetextarea`__)
[keul]
__ http://pypi.python.org/pypi/collective.autoresizetextarea/
0.1.0 (2012-07-04)
------------------
- Initial release
Raw data
{
"_id": null,
"home_page": "http://plone.org/products/collective.analyticspanel",
"name": "collective.analyticspanel",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "plone analytics plonegov",
"author": "RedTurtle Technology",
"author_email": "sviluppoplone@redturtle.it",
"download_url": "https://files.pythonhosted.org/packages/36/1e/339fb4fa1427bfd3b1268215adf00623fff4106549facf0aadf13750c9ec/collective.analyticspanel-2.0.1.tar.gz",
"platform": null,
"description": ".. image:: https://travis-ci.org/RedTurtle/collective.analyticspanel.svg?branch=master\n :target: https://travis-ci.org/RedTurtle/collective.analyticspanel\n\nThis product will replace the basic Plone feature for **adding analytics JavaScript to your site**\nwith an advanced version.\n\n.. contents:: **Table of contents**\n\nIntroduction\n============\n\nNew features added:\n\n* add possibility to add specific JavaScript when the user is **inside error page**\n (useful for special code when on the \"*Page not found*\")\n* add possibility to **customize code for a site area** or a single content\n* not display JavaScript code for specific area of the site\n* choose to put you snippets in the page header or footer)\n\nHow to use it\n=============\n\nWhen installed, the basic Plone feature for handling JavaScript for statistics is hidden from the standard\n\"*Site settings*\" (in facts, it's moved to a new configuration panel called \"*Analytics settings*\") and\nnew options are now available.\n\nJavaScript for web statistics support\n-------------------------------------\n\n.. image:: http://blog.redturtle.it/pypi-images/collective.analyticspanel/collective.analyticspanel-0.4.0-01.png\n :alt: Basic feature\n\nNothing new there: this is simply the basic Plone feature about JavaScript inclusion, just moved in this\nseparate panel (and you can put it in the header of the page).\nThis is always the default code included when other options don't match.\n\nJavaScript to be included when an error message is get\n------------------------------------------------------\n\n.. image:: http://blog.redturtle.it/pypi-images/collective.analyticspanel/collective.analyticspanel-0.4.0-02.png\n :alt: Code for error page\n\nWhen this product is installed you can control JavaScript code based on error messages (ignoring the default one).\nThe main motivation is to use this for the ``NotFound`` (HTTP 404) error.\n\nHowever this feature is still generic... you could probably use it for other error code (like ``ValueError``)\nif this make any sense for you!\n\nJavaScript to be included inside specific site's paths\n------------------------------------------------------\n\n.. image:: http://blog.redturtle.it/pypi-images/collective.analyticspanel/collective.analyticspanel-0.4.0-03.png\n :alt: Code for specific site's path\n\nYou can use this section for putting a list of absolute site subsection you want to control, adding a specific\nJavaScript section and ignoring the default one.\n\nWhen more than a provided path match the current URL, the most specific ones is used.\n\nThis kind of rule has a policy selection.\n\n.. image:: http://blog.redturtle.it/pypi-images/collective.analyticspanel/collective.analyticspanel-0.3.0-04.png\n :align: right\n :alt: Policy selection\n\n* The default one (\"*to the whole subtree*\") is for applying the rule to the whole subtree.\n* Using \"*only to the context*\" you can choose to apply the analytics code only to the content and not\n to sub-contents inside it.\n* Using \"*to the context and non-folderish children*\" you are applying the analytics code only to the content,\n and to all sub-contents inside it that are not folders.\n\nThis last policy seems a little complex, but there are analytics tools (at least: `Piwik`__) where this can\nbe useful to define custom reports for sections of the site.\n\n__ http://piwik.org/\n\nAs the concept of \"folder\" in Plone can change with different add-ons installed, this last policy take care\nof using as \"folder\" what is defined in the \"*Folderish types*\" configuration option.\n\n.. image:: http://blog.redturtle.it/pypi-images/collective.analyticspanel/collective.analyticspanel-0.3.0-05.png\n :alt: Folderish types selection panel\n\nThe Plone native \"Folder\" type is selected by default.\n\nHiding\n------\n\nYou can also use this product for hiding analytics code from specific site areas or error pages, leaving a default\none for the rest of the site.\n\nJust configure options with empty code!\n\nJavaScript in the header or footer of the page?\n===============================================\n\nHistorically Plone put analytics code in the page footer; this is an old way to go and modern analytics\nsoftware suggest to put you code before the ``body`` tag.\nHowever old analytics software that can block the page rendering are better to be kept at the end of the page.\n\nFor this reason this product will let you add analytics on both header or footer of the page at your choice.\n\nAs you seen this option is available everywhere, for every feature added, just note that analytics in the header\nor footer are treat separately.\n\nPrivacy\n=======\n\nEU has been recently hit by the `Cookie Law`__ \tphenomenon.\nThis add-on provide now a couple of privacy settings you can enable if *you* think that analytics in your site\ncould harm privacy of your users.\n\n* The `Do Not Track`__ option is about a client side feature added on some modern browser.\n* The usare of a ``analytics-optout`` cookie is something different.\n The scope of this add-on is to react to the presence (and value) of this cookie, but is task of 3rd party add-on\n (or software outside Plone) to generate this cookie.\n\n__ http://eur-lex.europa.eu/legal-content/EN/TXT/?uri=celex:32009L0136\n__ https://en.wikipedia.org/wiki/Do_Not_Track\n\n**Please note** that the best way to conditionally load analytics code based on cookie presence is to perform it\n*client side*.\nServer side check commonly require integration with reverse-proxy in front of Plone (if any).\n\nCompatibility\n=============\n\nPlone >= 5.2 and Python3 from version 2.0.0.\n\nFor previous Plone versions, use < 2.0.0\n\n\nCredits\n=======\n\nDeveloped with the support of:\n\n* `Regione Emilia Romagna`__\n\n* `Provincia di Ferrara`__\n\n .. image:: http://www.provincia.fe.it/Distribuzione/logo_provincia.png\n :alt: Provincia di Ferrara - logo\n\nAll of them supports the `PloneGov initiative`__.\n\n__ http://www.regione.emilia-romagna.it/\n__ http://www.provincia.fe.it/\n__ http://www.plonegov.it/\n\nAuthors\n=======\n\nThis product was developed by RedTurtle Technology team.\n\n.. image:: http://www.redturtle.it/redturtle_banner.png\n :alt: RedTurtle Technology Site\n :target: http://www.redturtle.it/\n\nChangelog\n=========\n\n2.0.1 (2023-09-18)\n------------------\n\n- Fix logic in controlpanel save method.\n [cekk]\n\n\n2.0.0 (2022-11-23)\n------------------\n\n- Major refactoring for python 3.8 and plone 5.2\n [axaroth]\n\n\n1.0.0 (2019-01-09)\n------------------\n\n- Remove custom persistent field from registry.\n [cekk]\n\n\n0.6.1 (2017-09-15)\n------------------\n\n- Fix pypi classifiers\n [cekk]\n\n0.6.0 (2017-09-15)\n------------------\n\n- Plone 5 compatibility.\n [cekk, mamico]\n- Drop plone 3 compatibility.\n [cekk]\n- Fix tests and add travis config.\n [cekk]\n\n0.5.0 (2017-01-20)\n------------------\n\n- Added options to block analytics for user's privacy choices\n [keul]\n- Don't show analytics in views used on overlays (so with ajax_load paramiter)\n [cekk]\n\n0.4.0 (2014-06-25)\n------------------\n\n- Fix bug that prevented viewlet from being shown on plone sites\n located in subfolders (eg. /project/Plone) which is quite common\n when ZODB mountpoints are used. [fRiSi]\n- Fixed a bug that randomly hit the installation (See `#2`__) [keul]\n- Fixed translations not shown in vocabulary [keul]\n- You can now choose to put analytics before the ``body`` tag or\n near the end of it. This close `#1`__\n\n__ https://github.com/RedTurtle/collective.analyticspanel/issues/2\n__ https://github.com/RedTurtle/collective.analyticspanel/issues/1\n\n0.3.0 (2012-08-28)\n------------------\n\n- Italian i18n fixes [keul]\n- Added a way to set rules for subsections and leaf contents inside\n (subcontents that are not folderish) [keul]\n\n0.2.0 (2012-07-13)\n------------------\n\n- Some styles fixes in the management panel [keul]\n- Added new option: ``apply_to_subsection``\n- Added the \"*autoresize*\" CSS class for textareas\n (in the case you also use `collective.autoresizetextarea`__)\n [keul]\n\n__ http://pypi.python.org/pypi/collective.autoresizetextarea/\n\n0.1.0 (2012-07-04)\n------------------\n\n- Initial release\n",
"bugtrack_url": null,
"license": "GPL",
"summary": "Add more control over the inclusion of JavaScript analytics code of your Plone site",
"version": "2.0.1",
"project_urls": {
"Homepage": "http://plone.org/products/collective.analyticspanel"
},
"split_keywords": [
"plone",
"analytics",
"plonegov"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "361e339fb4fa1427bfd3b1268215adf00623fff4106549facf0aadf13750c9ec",
"md5": "6825fc898555b81925f2a690f85a2139",
"sha256": "f5153d6a24793b149304b3383154516118469ddbef98fd02c24800071629aeab"
},
"downloads": -1,
"filename": "collective.analyticspanel-2.0.1.tar.gz",
"has_sig": false,
"md5_digest": "6825fc898555b81925f2a690f85a2139",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 34243,
"upload_time": "2023-09-18T08:27:44",
"upload_time_iso_8601": "2023-09-18T08:27:44.995882Z",
"url": "https://files.pythonhosted.org/packages/36/1e/339fb4fa1427bfd3b1268215adf00623fff4106549facf0aadf13750c9ec/collective.analyticspanel-2.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-18 08:27:44",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "collective.analyticspanel"
}
JSON