collective.analyticspanel

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

Project Description

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

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

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

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

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.

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.

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!

Dependencies

This product has been tested on:

  • Plone 3.3 (read below)
  • Plone 4.2
  • Plone 4.3

It's based on plone.app.registry that it not part of Plone on 3.3 version. You need to be sure that a compatible version is used (in my experience: use plone.app.registry 1.0b1 and plone.registry 1.0).

Credits

Developed with the support of:

All of them supports the PloneGov initiative.

Authors

This product was developed by RedTurtle Technology team.

RedTurtle Technology Site

Self-Certification

[X] Internationalized

[X] Unit tests

[X] End-user documentation

[X] Internal documentation (documentation, interfaces, etc.)

[X] Existed and maintained for at least 6 months

[X] Installs and uninstalls cleanly

[X] Code structure follows best practice

Current Release
collective.analyticspanel 0.4.0

Released Jun 25, 2014 — tested with Plone 4.3, Plone 4.2, Plone 4.1, Plone 4, Plone 3

Bugfix and new features
More about this release…

Download file Get collective.analyticspanel for all platforms
collective.analyticspanel-0.4.0.zip
If you are using Plone 3.2 or higher, you probably want to install this product with buildout. See our tutorial on installing add-on products with buildout for more information.

All Releases

Version Released Description Compatibility Licenses Status
0.4.0 Jun 25, 2014 Bugfix and new features More about this release…
Plone 4.3
Plone 4.2
Plone 4.1
Plone 4
Plone 3
GPL final
0.3.0 Aug 28, 2012 New feature release More about this release…
Plone 4.2
Plone 4.1
Plone 4
Plone 3
GPL final
0.2.0 Jul 13, 2012 Visual fixes and new feature More about this release…
Plone 4.2
Plone 4.1
Plone 4
Plone 3
GPL final
0.1.0 First public release More about this release…
Plone 4.2
Plone 4.1
Plone 4
Plone 3
GPL beta