related ideas

[git.ikiwiki.info.git] / doc / plugins / blogspam.mdwn

diff --git a/doc/plugins/blogspam.mdwn b/doc/plugins/blogspam.mdwn
index 307d4646dac2e58b659bc6c938d29dd9ffc47e3c..3dd017f61897b318d017b40ad70ae704ea851469 100644 (file)
--- a/doc/plugins/blogspam.mdwn
+++ b/doc/plugins/blogspam.mdwn
@@ -1,20 +1,29 @@
 [[!template id=plugin name=blogspam author="[[Joey]]"]]
 [[!template id=plugin name=blogspam author="[[Joey]]"]]

-[[!tag type/auth]]
+[[!tag type/auth type/comments]]

 
 This plugin adds antispam support to ikiwiki, using the
 [blogspam.net](http://blogspam.net/) API. Both page edits and
 
 This plugin adds antispam support to ikiwiki, using the
 [blogspam.net](http://blogspam.net/) API. Both page edits and

-[[comment|comments]] postings can be checked for spam. Currently,
-detected spam is not saved for human review, it is just rejected.
+[[comment|comments]] postings can be checked for spam. Page edits that
+appear to contain spam will be rejected; comments that look spammy will be
+stored in a queue for moderation by an admin.

 
 

-You can control how content is tested via the `blogspam_options`
-setting. By default, the options are configured in a way that is
-appropriate for wiki content. This includes turning off some of the
-more problimatic tests.
+To check for and moderate comments, log in to the wiki as an admin,
+go to your Preferences page, and click the "Comment Moderation" button.
+
+The plugin requires the [[!cpan RPC::XML]] perl module.
+
+You can control how content is tested via the `blogspam_options` setting.
+The list of options is [here](http://blogspam.net/api/testComment.html#options).
+By default, the options are configured in a way that is appropriate for
+wiki content. This includes turning off some of the more problematic tests.
+An interesting option for testing is `fail`, by setting it (e.g.,
+`blogspam_options => 'fail'`), *all* comments will be marked as SPAM, so that
+you can check whether the interaction with blogspam.net works.

 
 The `blogspam_pagespec` setting is a [[ikiwiki/PageSpec]] that can be
 used to configure which pages are checked for spam. The default is to check
 all edits. If you only want to check [[comments]] (not wiki page edits),
 
 The `blogspam_pagespec` setting is a [[ikiwiki/PageSpec]] that can be
 used to configure which pages are checked for spam. The default is to check
 all edits. If you only want to check [[comments]] (not wiki page edits),

-set it to "postcomment(*)".
+set it to "postcomment(*)". Posts by admins are never checked for spam.

 
 By default, the blogspam.net server is used to do the spam checking. To
 change this, the `blogspam_server` option can be set to the url for a
 
 By default, the blogspam.net server is used to do the spam checking. To
 change this, the `blogspam_server` option can be set to the url for a