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: GetClicky

Author:Kasper Skårhøj
Created:2002-11-01T00:32:00
Changed by:Bernhard Gschwantner
Changed:2008-02-19T11:11:42
Email:extensions.typo3.org@datenbankdesign.com
Info 2:
Info 3:
Info 4:

EXT: GetClicky

Extension Key: tx_getclicky

Copyright 2000-2008, extensions.typo3.org@datenbankdesign.com, <extensions.typo3.org@datenbankdesign.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.com

Table of Contents

EXT: GetClicky 1

Introduction 1

What does it do? 1

Screenshots 1

Users manual 1

FAQ 1

Adminstration 2

FAQ 2

Configuration 2

FAQ 2

Reference 2

Tutorial 3

Known problems 3

To-Do list 3

Changelog 3

Important guidelines 4

Issues with Open Office documentation for TYPO3 4

Inserting images 4

Paragraph styles 4

Linking 5

Meta data and updates 5

Introduction

What does it do?

This extension integrates Clicky user tracking (getclicky.com) into Typo3. To support development, please use my affiliate link: http://getclicky.com/5987 .

Clicky is targeted towards smaller-scale sites and tracks individual users in real time. Especially with the so called “Spy” you can see what is happening on your website. It is a perfect companion to general statistics, such as AWStats or Google Analytics.

Clicky offers the basic features for free, but there is also a blogger and pro version, which you have to pay for. This extension also supports the additional pro features, such as tracking custom data (and more to come as soon as the API is available).

If you'd like to have any other features, just drop me a line!

Screenshots

See http://getclicky.com/5987 for current screenshots.

Users manual

Create a Clicky account at http://getclicky.com/5987 (which is my affiliate link – please support further development by using that link), or at http://getclicky.com .

Install the plugin via the extension manager.

Include both static files (“include static (from extensions)”) in your template ( very important! ).

Go to the constant editor and edit the setting for the Clicky ID and DBServer, and you're done! You can find this information in your site preferences page on the Clicky website (that's the last tab on the stats pages).

You can immediately view your statistics on the GetClicky website.

Administration

Nothing special right now – just view your stats via the GetClicky website.

Configuration

Changing the place where the code is inserted

If you use the static template “GetClicky at end of page”, the tracking code is inserted at the end of the page. If you don't want this (or you use frames on your website or whatever), just add a reference to lib.tx_getclicky to your template:

page.headerdata.1000 =<  lib.tx_getclicky

Of course you don't have to include the static template “GetClicky at end of page” then, just use “GetClicky basic setup”.

Customization

You can customize the values that are tracked by editing the predefined values in the constant editor:

Constants
id

Property

id

Data type

int+

Description

GetClicky Site ID

Default

dbserver

Property

dbserver

Data type

text

Description

The GetClicky Server Name as found on the site preferences page

Default

Db3

profeatures

Property

profeatures

Data type

boolean

Description

Enables or disables pro features (if you are in the trial period, all pro features are enabled, so you can track user names)

Default

1

profeatures.trackusers

Property

profeatures.trackusers

Data type

boolean

Description

Track the names of your frontend users. Currently this is the only pro feature available. In the future this section will be extended.

See below for customization.

Default

1

[tsconf:plugin.tx_getclicky]

userfield

Property

userfield

Data type

options

Description

Field name to use as the primary tracking field.

Default

username

userfield2

Property

userfield2

Data type

options

Description

Additional field name to add to the username in brackets. Since Clicky displays the username in all statistics pages, it may be easier to identify the user by his real name (or email/company etc.)

Default

name

userfield2.crop

Property

userfield2.crop

Data type

text

Description

Crop the second field (by default after 15 chars and add three dots). For the syntax see tsref:stdWrap.crop

Default

15|...

((Unknown Property))

Property

Data type

Description

Default

[tsconf:plugin.tx_getclicky.profeatures.trackusers]

Example

Tracks users by their real name and fe_user uid:

plugin.tx_getclicky.profeatures.trackusers {
        userfield = name
        userfield2 = uid
        userfield2.crop =
}

Technical discussion

This extension creates the JavaScript (and HTML) code necessary for integrating GetClicky.

The static templates are separated into the general setup, where the tracking code is generated, and a second (example) template that inserts the tracking code at the end of the page object.

Currently the getclicky code is all created by TypoScript. This may change in the future, so please don't rely on customizing lib.tx_getclicky, but only use the constants. If you'd like something added, please drop me a line!

I tried to get as much as possible done with caching, only the user names have to be generated by a COA_INT. So if you don't use the pro features, the output can be cached completely.

I'm currently also tracking the e-mail, real name and company in separate custom variables, as stated in the Clicky customization guide, but this doesn't seem to work as stated, or it just isn't displayed right now.

Clicky is introducing new features every week, so if you are not satisfied right now, you probably will in some weeks ;-) So check back sometime!

I intend to do another similar extension for reinvigorate, which is currently in beta (which means you get everything for free there). It works similarly, but the web interface is currently quite awful. Strong point at the moment is the standalone application called snoop, which lets you see what's happening in real time, but not in the browser as the Clicky Spy, and it also make some noise ;-) See for yourself: http://www.reinvigorate.net

Known problems

None so far.

To-Do list

  • The Clicky API v2 is now ready and can be used to integrate Clicky into the Typo3 backend
  • Frontend plugin to support opting out for individual frontend users
  • Maybe change the TS path from lib.tx_getclicky to plugin.tx_getclicky (not sure about that, though).
  • Do you want other features? Please drop me a line!

Changelog

0.1.1: Update to the current Clicky tracking code: NoScript version is updated

0.1.1: Track FE user id also

0.1.0: Fix for IE JavaScript problems, manual added

0.0.2: Caching problems resolved

0.0.1: First upload

img-1 EXT: GetClicky - 3