collective.analyticspanel 2.0.1

Add more control over the inclusion of JavaScript analytics code of your Plone site

This product will replace the basic Plone feature for adding analytics JavaScript to your site with an advanced version.

Table of contents

• Introduction

• How to use it

  • JavaScript for web statistics support

  • JavaScript to be included when an error message is get

  • JavaScript to be included inside specific site’s paths

  • Hiding

• JavaScript in the header or footer of the page?

• Privacy

• Compatibility

• Credits

• Authors

• Changelog

  • 2.0.1 (2023-09-18)

  • 2.0.0 (2022-11-23)

  • 1.0.0 (2019-01-09)

  • 0.6.1 (2017-09-15)

  • 0.6.0 (2017-09-15)

  • 0.5.0 (2017-01-20)

  • 0.4.0 (2014-06-25)

  • 0.3.0 (2012-08-28)

  • 0.2.0 (2012-07-13)

  • 0.1.0 (2012-07-04)

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

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

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

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.

• 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.

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.

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.

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

  

All of them supports the PloneGov initiative.

Authors

This product was developed by RedTurtle Technology team.

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

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]

0.1.0 (2012-07-04)

• Initial release