annotate gtk/plugins/cap/README @ 14711:556a112ab6ca

[gaim-migrate @ 17465] When installing libraries in system lib dirs, be sure to run ldconfig as required committer: Tailor Script <tailor@pidgin.im>
author Stu Tomlinson <stu@nosnilmot.com>
date Thu, 12 Oct 2006 02:51:52 +0000
parents eec3ce357b70
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14266
63ef6342db05 [gaim-migrate @ 16948]
Geoff Foster <g-off_>
parents:
diff changeset
1 Contact Availability Prediction
63ef6342db05 [gaim-migrate @ 16948]
Geoff Foster <g-off_>
parents:
diff changeset
2 Google Summer of Code 2006
63ef6342db05 [gaim-migrate @ 16948]
Geoff Foster <g-off_>
parents:
diff changeset
3 Student: Geoffrey Foster
63ef6342db05 [gaim-migrate @ 16948]
Geoff Foster <g-off_>
parents:
diff changeset
4 Mentor: Mark Doliner
63ef6342db05 [gaim-migrate @ 16948]
Geoff Foster <g-off_>
parents:
diff changeset
5
63ef6342db05 [gaim-migrate @ 16948]
Geoff Foster <g-off_>
parents:
diff changeset
6 The Contact Availability Prediction plugin (CAP) attempts to provide feedback as to the availability of buddies in your buddy list beyond that of their status. It gathers various bits of information as you use Gaim (and the plugin is running) and provides a "Response Probability" value between 0.0 and 1.0. For those new to probability a value of 0 means 0% chance and 1 means 100% chance.
63ef6342db05 [gaim-migrate @ 16948]
Geoff Foster <g-off_>
parents:
diff changeset
7
63ef6342db05 [gaim-migrate @ 16948]
Geoff Foster <g-off_>
parents:
diff changeset
8 Currently the probability value is only displayed in the tooltip of a buddy but in future graphs will be available showing usage patterns.
63ef6342db05 [gaim-migrate @ 16948]
Geoff Foster <g-off_>
parents:
diff changeset
9
63ef6342db05 [gaim-migrate @ 16948]
Geoff Foster <g-off_>
parents:
diff changeset
10 In order to build CAP libdbi (http://libdbi.sourceforge.net) version 0.8.1 and the MySQL driver (http://libdbi-drivers.sourceforge.net) version 0.8.x are required to build and use the plugin. The --enable-cap option must also be set during the configure phase of building. At the moment MySQL is the only database backend that can be used but this will later be extended to both Postgres and SQLite.
63ef6342db05 [gaim-migrate @ 16948]
Geoff Foster <g-off_>
parents:
diff changeset
11
63ef6342db05 [gaim-migrate @ 16948]
Geoff Foster <g-off_>
parents:
diff changeset
12 After installation the schema must also be created in the database. Adding code to automate this is on my todo list but executing the following command in the directory containing cap-mysql.sql will produce the correct tables in the desired database.
63ef6342db05 [gaim-migrate @ 16948]
Geoff Foster <g-off_>
parents:
diff changeset
13 mysql -u username -p database < cap-mysql.sql
63ef6342db05 [gaim-migrate @ 16948]
Geoff Foster <g-off_>
parents:
diff changeset
14
63ef6342db05 [gaim-migrate @ 16948]
Geoff Foster <g-off_>
parents:
diff changeset
15 Preferences: I currently don't have the best names for configuration options so they might require more explanation.
63ef6342db05 [gaim-migrate @ 16948]
Geoff Foster <g-off_>
parents:
diff changeset
16 * Maximum response timeout
63ef6342db05 [gaim-migrate @ 16948]
Geoff Foster <g-off_>
parents:
diff changeset
17 This value is how much time will be allowed to pass after you message a buddy while waiting for a response from them. If from the time you message them to that time plus maximum response timeout value they have not yet responded to you a failure is logged. If they do respond within that timeframe then a success is logged.
63ef6342db05 [gaim-migrate @ 16948]
Geoff Foster <g-off_>
parents:
diff changeset
18
63ef6342db05 [gaim-migrate @ 16948]
Geoff Foster <g-off_>
parents:
diff changeset
19 * Maximum last-seen difference
63ef6342db05 [gaim-migrate @ 16948]
Geoff Foster <g-off_>
parents:
diff changeset
20 This value is not currently used but will be used at a later date to prevent useless data from being recorded.
63ef6342db05 [gaim-migrate @ 16948]
Geoff Foster <g-off_>
parents:
diff changeset
21
63ef6342db05 [gaim-migrate @ 16948]
Geoff Foster <g-off_>
parents:
diff changeset
22 * Threshold
63ef6342db05 [gaim-migrate @ 16948]
Geoff Foster <g-off_>
parents:
diff changeset
23 This is how many minutes before and after the current time should be looked at when computing a buddies response probability. The larger the value the more data that is available but the larger the timeframe it will encompass and thus the less accurate the prediction will be. As data collection increases this value can be reduced for more fine tuned statistics.
63ef6342db05 [gaim-migrate @ 16948]
Geoff Foster <g-off_>
parents:
diff changeset
24
63ef6342db05 [gaim-migrate @ 16948]
Geoff Foster <g-off_>
parents:
diff changeset
25 Bugs and Feedback are appreciated and may be sent to g-off_ at users.sourceforge.net.