collective.analyticspanel 0.3.0

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

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

• Dependencies

• Credits

• Authors

• Changelog

  • 0.3.0 (2012-08-28)

  • 0.2.0 (2012-07-13)

  • 0.1.0 (2012-07-04)

Introduction

This product will replace the basic Plone feature for adding statistical and analytics JavaScript to your site with an advanced version that:

• 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

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

Dependencies

This product has been tested on:

• Plone 3.3 (read below)

• Plone 4.2

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:

• Regione Emilia Romagna

• Provincia di Ferrara

  

All of them supports the PloneGov initiative.

Authors

This product was developed by RedTurtle Technology team.

Changelog

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