modules/spam_tokens/README.txt

; $Id: readme.html,v 1.1 2007/10/22 15:52:43 nancyw Exp $

Spam_Tokens is an add-on to the Spam module. It allows the Spam administrator to control
the tokens that are used by the Spam filters to determine whether or not content is spam.

Required Modules
----------------

The Spam_Tokens module requires the contributed Spam module.

Installation
------------
Normal module installation procedures.

Settings
--------
There are no settings for this module.

Permissions
-----------
There are no new permissions for this module.

Menu Items
----------
Tokens - is a tab on the Spam administration (Administer >> Site Configuration >> Spam) page.

Using the Module
----------------
On the Spam_Tokens page you will have a list of all current tokens.

There is a link at the top to add new tokens.

Next (if you have enough tokens yet) you will find a box with the first letters of tokens.
Clicking on one of those letters will restrict the display to only tokens beginning with
that letter.

Last, you will find the [possibly filtered] list of tokens. Each has a link to edit that
token. The edit function also is used to delete the token.

* The "Spam" and "Not Spam" columns show how many times the token has been seen in content
  that ended up being marked as spam or not.

* "Probablility" is the likelihood that a term is an indicator of spam. The "average" value
  for this is 50 (percent). Values below this indicate that the token is less likely to be
  spam; values above it are more likely to be spam. The maximum value is 99, which will
  definitely mark the content as spam. A value of zero (0) indicates that the token should
  be ignored entirely. The farther the probability is away from 50, the more "interesting"
  the token becomes. The Spam filter will use a configurable number (the default is 15) of
  the most interesting tokens. [This number is shown at the top of the page.]

* "Last seen" tells you when the token was last encountered in content.

1	; $Id: readme.html,v 1.1 2007/10/22 15:52:43 nancyw Exp $
2
3	Spam_Tokens is an add-on to the Spam module. It allows the Spam administrator to control
4	the tokens that are used by the Spam filters to determine whether or not content is spam.
5
6	Required Modules
7	----------------
8
9	The Spam_Tokens module requires the contributed Spam module.
10
11	Installation
12	------------
13	Normal module installation procedures.
14
15	Settings
16	--------
17	There are no settings for this module.
18
19	Permissions
20	-----------
21	There are no new permissions for this module.
22
23	Menu Items
24	----------
25	Tokens - is a tab on the Spam administration (Administer >> Site Configuration >> Spam) page.
26
27	Using the Module
28	----------------
29	On the Spam_Tokens page you will have a list of all current tokens.
30
31	There is a link at the top to add new tokens.
32
33	Next (if you have enough tokens yet) you will find a box with the first letters of tokens.
34	Clicking on one of those letters will restrict the display to only tokens beginning with
35	that letter.
36
37	Last, you will find the [possibly filtered] list of tokens. Each has a link to edit that
38	token. The edit function also is used to delete the token.
39
40	* The "Spam" and "Not Spam" columns show how many times the token has been seen in content
41	that ended up being marked as spam or not.
42
43	* "Probablility" is the likelihood that a term is an indicator of spam. The "average" value
44	for this is 50 (percent). Values below this indicate that the token is less likely to be
45	spam; values above it are more likely to be spam. The maximum value is 99, which will
46	definitely mark the content as spam. A value of zero (0) indicates that the token should
47	be ignored entirely. The farther the probability is away from 50, the more "interesting"
48	the token becomes. The Spam filter will use a configurable number (the default is 15) of
49	the most interesting tokens. [This number is shown at the top of the page.]
50
51	* "Last seen" tells you when the token was last encountered in content.
52