More user friendly token validation
[project/google_analytics.git] / README.txt
CommitLineData
8afc0408 1// $Id$
2
3Module: Google Analytics
520d142e 4Author: Alexander Hass <http://drupal.org/user/85918>
8afc0408 5
6
7Description
8===========
9Adds the Google Analytics tracking system to your website.
10
11Requirements
12============
13
14* Google Analytics user account
15
16
17Installation
18============
19* Copy the 'googleanalytics' module directory in to your Drupal
20sites/all/modules directory as usual.
21
22
23Usage
24=====
25In the settings page enter your Google Analytics account number.
26
8afc0408 27All pages will now have the required JavaScript added to the
28HTML footer can confirm this by viewing the page source from
29your browser.
30
31New approach to page tracking in 5.x-1.5 and 6.x-1.1
32====================================================
33With 5.x-1.5 and 6.x-1.1 there are new settings on the settings page at
34admin/settings/googleanalytics. The "Page specific tracking" area now
35comes with an interface that copies Drupal's block visibility settings.
36
37The default is set to "Add to every page except the listed pages". By
38default the following pages are listed for exclusion:
39
40admin
41admin/*
42user/*/*
43node/add*
44node/*/*
45
46These defaults are changeable by the website administrator or any other
47user with 'administer google analytics' permission.
48
49Like the blocks visibility settings in Drupal core, there is now a
50choice for "Add if the following PHP code returns TRUE." Sample PHP snippets
51that can be used in this textarea can be found on the handbook page
52"Overview-approach to block visibility" at http://drupal.org/node/64135.
53
54A code snippet that creates opt-out by role functionality for unchecked roles
55can be found in the Google Analytics handbook at http://drupal.org/node/261997.
56
ff05e032 57Custom variables
58=================
59One example for custom variables tracking is the "User roles" tracking. Enter
60the below configuration data into the custom variables settings form under
61admin/settings/googleanalytics.
62
63Slot: 1
64Name: User roles
65Value: [roles]
66Scope: Visitor
67
68More details about Custom variables can be found in the Google API documentation at
69http://code.google.com/intl/en/apis/analytics/docs/tracking/gaTrackingCustomVariables.html
70
8afc0408 71Advanced Settings
72=================
73You can include additional JavaScript snippets in the custom javascript
74code textarea. These can be found on the official Google Analytics pages
75and a few examples at http://drupal.org/node/248699. Support is not
76provided for any customisations you include.
77
78To speed up page loading you may also cache the Analytics ga.js
79file locally. You need to make sure the site file system is in public
80download mode.