modules/affinity/README.txt

$Id: README.txt,v 1.1.2.1 2008/08/09 00:10:50 sicjoy Exp $

  author : Kevin Mathis (sicjoy)
  contact: kevin [at] vervemojo [dot] com

  The Affinity module is intended to be used as a catalyst for community
  interaction on sites where users rate the content.  It works in conjunction
  with the Voting API module to match users to other users with similar voting
  patterns. The module provides a block showing users you may have an affinity
  for.

  SETTINGS

  Affinity recalculation cycle - There is a trade-off between users having up
  to date Affinity Matches and server load.  This setting addresses this issue.
  The affinity caclulation results for each user are cached in a database
  table.  Affinity matches don't get recalculated until the cache's timestamp
  is older than the set period.

  Number of matches - This is the number of matches to calculate for each user.

  Common vote threshold - Sets the minimum number of votes in common required
  before two users can be considered in the matching algorithm.  Setting this
  higher will result in shorter calculation times.  However, it will require
  users to cast at least this many votes before they can begin receiving
  matches.

  Votingapi content type - This will depend on your site's voting system.  Most
  likely it should be set to either node or comment.

  Votingapi value type - Depends on your site's voting system.  Typical values
  include percent or points.

  Votingapi tag - Again, this depends on you site's voting system.  In most
  cases use vote, but it can be anything.  The External Link Popularity module
  uses pop_links for this value.

  MATCHES BLOCK SETTINGS

  Block title - Here you can give the block a different title.  The default value
  is Affinity Matches.

  Empty block text - This is the text shown in the block when a user doesn't have
  any matches yet.  This will happen, for example, when a user hasn't cast any
  votes.

  Anonymous user text - This is the text shown in the block for anonymous users.

  Show user pictures - Check this box if you want to show user picures in the
  affinity block.  Make sure that user pictures are enabled at admin/user/settings.
  You should also assign a default picture for the case where users choose not to
  upload a picture.

  Enjoy,

  sicjoy
1	$Id: README.txt,v 1.1.2.1 2008/08/09 00:10:50 sicjoy Exp $
2
3	author : Kevin Mathis (sicjoy)
4	contact: kevin [at] vervemojo [dot] com
5
6	The Affinity module is intended to be used as a catalyst for community
7	interaction on sites where users rate the content. It works in conjunction
8	with the Voting API module to match users to other users with similar voting
9	patterns. The module provides a block showing users you may have an affinity
10	for.
11
12	SETTINGS
13
14	Affinity recalculation cycle - There is a trade-off between users having up
15	to date Affinity Matches and server load. This setting addresses this issue.
16	The affinity caclulation results for each user are cached in a database
17	table. Affinity matches don't get recalculated until the cache's timestamp
18	is older than the set period.
19
20	Number of matches - This is the number of matches to calculate for each user.
21
22	Common vote threshold - Sets the minimum number of votes in common required
23	before two users can be considered in the matching algorithm. Setting this
24	higher will result in shorter calculation times. However, it will require
25	users to cast at least this many votes before they can begin receiving
26	matches.
27
28	Votingapi content type - This will depend on your site's voting system. Most
29	likely it should be set to either node or comment.
30
31	Votingapi value type - Depends on your site's voting system. Typical values
32	include percent or points.
33
34	Votingapi tag - Again, this depends on you site's voting system. In most
35	cases use vote, but it can be anything. The External Link Popularity module
36	uses pop_links for this value.
37
38	MATCHES BLOCK SETTINGS
39
40	Block title - Here you can give the block a different title. The default value
41	is Affinity Matches.
42
43	Empty block text - This is the text shown in the block when a user doesn't have
44	any matches yet. This will happen, for example, when a user hasn't cast any
45	votes.
46
47	Anonymous user text - This is the text shown in the block for anonymous users.
48
49	Show user pictures - Check this box if you want to show user picures in the
50	affinity block. Make sure that user pictures are enabled at admin/user/settings.
51	You should also assign a default picture for the case where users choose not to
52	upload a picture.
53
54	Enjoy,
55
56	sicjoy