ken cochrane avatar ken cochrane committed e165521

cleaned up ReST text

Comments (0)

Files changed (1)

 Track a visitors movements across your site.
 
 Possible uses:
+
 * See what they were doing before they got an error.
+
 * Use it for analytics and usability testing to see how people are moving around your site, and where you are losing people.
 
+
 Inspired by OpenSymphony's Java project of the same name. http://code.google.com/p/clickstream/ 
 
 Requirements
 
 Custom Settings
 ===============
+
 Add the following properties to your settings file if you want to override the default settings.
 
-# CLICKSTREAM_IGNORE_PATHS
-# Default = ()
-# Takes a list of regular expressions for paths that you want to ignore
-# if it is picked up by these clicks won't be tracked.
-CLICKSTREAM_IGNORE_PATHS = ('^/private/',
-                            '^/dont-track-me/',
-                            'super-secret.txt',
-                            )
 
-# CLICKSTREAM_IGNORE_ANONYMOUS
-# Default = False
-# If you only want to track people that are logged in, change to True
+CLICKSTREAM_IGNORE_PATHS
+========================
+
+Default = ()
+
+Takes a list of regular expressions for paths that you want to ignore if it is picked up by these clicks won't be tracked.
+
+CLICKSTREAM_IGNORE_PATHS = ('^/private/', '^/dont-track-me/', 'super-secret.txt')
+
+CLICKSTREAM_IGNORE_ANONYMOUS
+============================
+
+Default = False
+
+If you only want to track people that are logged in, change to True
+
 CLICKSTREAM_IGNORE_ANONYMOUS = False
 
-#CLICKSTREAM_IGNORE_IP
-# Default = ()
-# A list of IP's that you don't want to track
+
+CLICKSTREAM_IGNORE_IP
+=====================
+Default = ()
+
+A list of IP's that you don't want to track
+
 CLICKSTREAM_IGNORE_IP = ('127.0.0.1', '10.10.10.10, '8.8.8.8')
 
 Middleware 
 
 App
 ===
+
 Add clickstream to INSTALLED_APPS
 
 
 Sync Tables + Migrate
 =====================
-Run ./manage.py syncdb to load up the tables in your database.
-run ./manage.py migrate to run the south migrations
+
+Run './manage.py syncdb' to load up the tables in your database.
+
+Run './manage.py migrate' to run the south migrations
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.