modules/akismet/README.txt

$Id: README.txt,v 1.6 2006/06/20 15:16:44 markus_petrux Exp $
********************************************************************
                    D R U P A L    M O D U L E                     
********************************************************************
Name	: akismet
Version	: 1.1.2
Author	: markus_petrux  [ http://www.phpmix.org ]
Drupal	: 4.7

********************************************************************
DESCRIPTION:

This module allows you to use Akismet services as an attempt to
protect your site from being spammed.

To use the akismet service, you need a WordPress.com API key. To get
one, you have to sign up for a free account at wordpress.com

Please, see the following pages for further information:
http://akismet.com
http://akismet.com/faq/
http://wordpress.com/api-keys/


********************************************************************
FEATURES:

* Ability to check for spam in comments and/or nodes, sending a
  query to Akismet, in real time.
* The actual content types that should be checked can be selected
  from the settings panel.
* Real time connections can be disabled.
* Detected spam is still recorded into database. However, a cron
  task can be customized to automatically remove spam older than a
  specified age.
* Moderators can submit missed spam or false possitives (ham) back
  to Akismet.
* Users may inherit moderator status depending on permissions
  assigned to them such as 'administer nodes', 'administer comments'
  or a set of 'moderate spam in <content-type>' permissions created
  by this module.
* Ability to perform publish/unpublish and submit spam/ham operations
  from links at the bottom of content.
* Enhanced moderator queue for nodes and comments aimed to help
  moderators to review spam, unpublished or even published content.
* An experimental set of anti-spambot measures that can be configured
  from the settings panel.
* All operations are logged to watchdog, trying not to generate a lot
  of records though.
* Spam counter that also reminds the 'counting since date'. This
  information can be changed at will from the settings panel.
* The spam counter is displayed on the settings panel and the
  moderation queue. It can also be displayed to user by means of a
  fully configurable and themable block.
* There is also an option in the settings panel that allows
  administrators set how many blocks they wish to use (or none at
  all). This is aimed to keep the block administration panel as clean
  as possible. Each block can be customized independently.
* Opt-in option for content administrators and moderators to receive
  e-mail notifications about new (or updated) content, only content
  needing approval or nothing at all. The site administrator can
  disable this option, though. If enabled, content administrators and
  moderators will have a new block of settings in their user profiles.
* Comprehensive settings panel where every option has been self
  documented with descriptions. Almost every feature can be customized.
* A couple of buttons are included in the contrib subdirectory for
  those who use the control panel module. I'm not really good with
  graphics, I did it the best that I could...
* Finally, this module has a simple, but hopefuly useful, version
  checker. It can check for updates at intervals that are customized
  in the settings panel. This option can be disabled.


********************************************************************
INSTALLATION - UPGRADE - UNINSTALLATION:

Please, see the file INSTALL.txt in this directory.

********************************************************************
1	$Id: README.txt,v 1.6 2006/06/20 15:16:44 markus_petrux Exp $
2	********************************************************************
3	D R U P A L M O D U L E
4	********************************************************************
5	Name : akismet
6	Version : 1.1.2
7	Author : markus_petrux [ http://www.phpmix.org ]
8	Drupal : 4.7
9
10	********************************************************************
11	DESCRIPTION:
12
13	This module allows you to use Akismet services as an attempt to
14	protect your site from being spammed.
15
16	To use the akismet service, you need a WordPress.com API key. To get
17	one, you have to sign up for a free account at wordpress.com
18
19	Please, see the following pages for further information:
20	http://akismet.com
21	http://akismet.com/faq/
22	http://wordpress.com/api-keys/
23
24
25	********************************************************************
26	FEATURES:
27
28	* Ability to check for spam in comments and/or nodes, sending a
29	query to Akismet, in real time.
30	* The actual content types that should be checked can be selected
31	from the settings panel.
32	* Real time connections can be disabled.
33	* Detected spam is still recorded into database. However, a cron
34	task can be customized to automatically remove spam older than a
35	specified age.
36	* Moderators can submit missed spam or false possitives (ham) back
37	to Akismet.
38	* Users may inherit moderator status depending on permissions
39	assigned to them such as 'administer nodes', 'administer comments'
40	or a set of 'moderate spam in <content-type>' permissions created
41	by this module.
42	* Ability to perform publish/unpublish and submit spam/ham operations
43	from links at the bottom of content.
44	* Enhanced moderator queue for nodes and comments aimed to help
45	moderators to review spam, unpublished or even published content.
46	* An experimental set of anti-spambot measures that can be configured
47	from the settings panel.
48	* All operations are logged to watchdog, trying not to generate a lot
49	of records though.
50	* Spam counter that also reminds the 'counting since date'. This
51	information can be changed at will from the settings panel.
52	* The spam counter is displayed on the settings panel and the
53	moderation queue. It can also be displayed to user by means of a
54	fully configurable and themable block.
55	* There is also an option in the settings panel that allows
56	administrators set how many blocks they wish to use (or none at
57	all). This is aimed to keep the block administration panel as clean
58	as possible. Each block can be customized independently.
59	* Opt-in option for content administrators and moderators to receive
60	e-mail notifications about new (or updated) content, only content
61	needing approval or nothing at all. The site administrator can
62	disable this option, though. If enabled, content administrators and
63	moderators will have a new block of settings in their user profiles.
64	* Comprehensive settings panel where every option has been self
65	documented with descriptions. Almost every feature can be customized.
66	* A couple of buttons are included in the contrib subdirectory for
67	those who use the control panel module. I'm not really good with
68	graphics, I did it the best that I could...
69	* Finally, this module has a simple, but hopefuly useful, version
70	checker. It can check for updates at intervals that are customized
71	in the settings panel. This option can be disabled.
72
73
74	********************************************************************
75	INSTALLATION - UPGRADE - UNINSTALLATION:
76
77	Please, see the file INSTALL.txt in this directory.
78
79	********************************************************************