root / branches / 1.4.5-wp2.2 / readme.txt

Revision 54, 5.5 kB (checked in by root, 6 months ago)

1.4.5beta with a very lot of new features

Line 
1=== Plugin Name ===
2Contributors: michelem, helened
3Donate link: http://www.michelem.org/
4Tags: tracker, tracking, statistics, analyze, web, realtime, stats, ajax, visitors, visits, online users, details, seo, admin, spy, visitors, widgets, widget, sidebar
5Requires at least: 2.3
6Tested up to: 2.3.2 - 2.3.1 - 2.3
7Stable tag: 1.4.5
8
9Wordpress plugin to analyze your visitors traffic with real time stats, chart and a lot of chronological informations. It has sidebar Widget support to show current online visitors and other statistics.
10
11== Description ==
12
13WassUp is a new Wordpress plugin to track your visitors in real time. It has a very readable and fancy admin console to keep tracks of your blog's users visits.
14It has a "current visitors online" view and a more detailed "visitors details" view where you can know almost everything your users are doing on your blog, it's very useful for SEO or statistics maniacs. Now it comes with a new "Spy" view in Ajax like the Digg Spy.
15The aim of WassUp is the knowledge of what your visitors do when they surf your blog, it is not intended to show grouped statistics for periods like visitors per day, pageviews per months and so on (there are many others tools to better gain that, like Google Analytics). With WassUp you'll get a cronology of your blog's visits with a lot of details for each single user session.
16
17Now WassUp works with two anti-spam function to detect and skip (if you want) referers spammers and akismet spammers.
18
19For people with database space problem, now WassUp has some options to manage his database table, you can empty it or delete old records to prevent reaching the size limit.
20
21Now it comes with a nice sidebar Widget which shows current visitors online, last searched terms and last external referers. The widget is fully customizable.
22
23WassUp shows a lot of data from who is visiting your blog like:
24
25 - ip / hostname
26 - referer
27 - spider
28 - search engines used
29 - keywords
30 - SERP (search engine result page)
31 - operating system / language / browser
32 - pages viewed (chronologically and per user session)
33 - complete user agent
34 - name of user logged in
35 - name of comment's author
36 - top ten charts with aggregate data (top queries, requests, os, browsers)
37
38The admin console is very nice and you can customize it by:
39
40 - records by date range
41 - records per page
42 - records per entry type (spider, users logged in, comment's authors, search engine, referer)
43 - expand/collapse informations (with ajax support)
44
45There are 4 views:
46
47 - Spy view like Digg Spy
48 - Current Online view
49 - Details view
50 - Options to customize WassUp
51
52Many options are customizable:
53
54 - Refreshing minutes
55 - details width
56 - Users levels required
57 - Enable/Disable recording
58 - Record or not users logged in
59 - Record or not spiders and bots
60 - Record or not exploit attempts (libwww-perl user agent)
61 - IPs to exclude from recording
62 - Alert admin for table growth
63 - Empty/Reset the database table
64 - Export current table in SQL format
65 - Automatically deletes records older then selected period (day, week, months, year)
66 - Manually deletes records older then selected period (day, week, months, year)
67
68== Frequently Asked Questions ==
69
70Coming soon
71
72== Screenshots ==
73
74You could find some screenshots at http://www.wpwp.org
75
76== Usage ==
77
78Installation:
79
80- Download the plugin WassUp (Real Time Visitors Tracking)
81- uncompress it with your preferred unzip/untar program or use the command line: tar xzvf wassup.tar.gz
82- copy the directory wassup in your plugins directory at your wordpress blog (/wp-content/plugins)
83- activate the WassUp Wordpress plugin at your Plugins admin page
84
85Upgrading:
86
87If you upgrade from a previous version is recommended to disable plugin before you overwrite the directory and then re-activate the plugin. (It's not needed but it should be better)
88
89Usage:
90
91When you activate the plugin, it works "as is". You don't have anything to do. Wait your visitors hit your blog and start seeing details (click the dashboard and go to WassUp page)
92
93Usage of wassup_sidebar function:
94
95    if (function_exists('wassup_sidebar'))  {
96            wassup_sidebar('');
97    }
98
99Valid option values for wassup_sidebar function are:
100
101    * before_widget - html before the widget
102    * after_widget - html after the widget
103    * before_title - html before the title (default <h2>)
104    * after_title - html after the title (default </h2>)
105    * wtitle - the title (default "visitors online")
106    * wulclass - the ul style class (default "links")
107    * wchars - the max width of sentences (default 18 characters)
108    * wsearch - set 1 to show last searched terms (default 0)
109    * wsearchlimit -  how many searched terms to show  (default 5)
110    * wref - set 1 to show last referers (default 0)
111    * wreflimit - how many referers to show (default 5)
112    * wtopbr - set 1 to show top browsers (default 0)
113    * wtopbrlimit - how many top browsers to show (default 5)
114    * wtopos - set 1 to show top OS (default 0)
115    * wtoposlimit - how many top OS to show (default 5)
116
117You have to put every 15 values, leave them empty if you don't want to use them, for example:
118
119    if (function_exists('wassup_sidebar')){
120                wassup_sidebar('','','<h2>','</h2>','Online Visitors','links',20,1,5,1,5,1,10,1,10);
121    }
122
123== Infos ==
124
125You could find every informations and much more at http://www.wpwp.org - http://trac.wpwp.org - http://www.wpwp.org/forums
126
127Credits to: Jquery ( http://www.jquery.com ) for the amazing Ajax framework, FAMFAMFAM ( http://www.famfamfam.com/ ) for the flags icons and a big thanks to Helene D. ( http://supernatural.hellioness.com/ ) for her help to improve WassUp!
Note: See TracBrowser for help on using the browser.