MINOR Documentation

git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/cms/branches/2.4@104402 467b73ca-7a2a-4603-9d3b-597d59a354a9
This commit is contained in:
Ingo Schommer 2010-05-09 20:11:00 +00:00 committed by Sam Minnee
parent cbc0b0a849
commit 6c12757a91

View File

@ -1,5 +1,21 @@
<?php
/**
* The SSAkismet class provides spam detection for comments using http://akismet.com/.
* In order to use it, you must get an API key, which you can get free for non-commercial use by signing
* up for a http://www.wordpress.com account. Commercial keys can be bought at http://akismet.com/commercial/.
*
* To enable spam detection, set your API key in _config.php.
* The following lines should be added to **mysite/_config.php**
* (or to the _config.php in another folder if you're not using mysite).
*
* <code>
* SSAkismet::setAPIKey('<your-key>');
* </code>
*
* You can then view spam for a page by appending <i>?showspam=1</i> to the url, or use the {@link CommentAdmin} in the CMS.
*
* @see http://demo.silverstripe.com/blog Demo of SSAkismet in action
*
* @package cms
* @subpackage comments
*/