Changeset 35838

Show
Ignore:
Timestamp:
03/22/08 12:19:30 (4 months ago)
Author:
ear1grey
Message:

Improved installation instructions
etc...

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • worst-offenders/trunk/readme.txt

    r35837 r35838  
    11=== Worst Offenders === 
     2Version: 3.0.alpha2 
     3Stable tag: 3.0.alpha2 
    24Contributors: ear1grey 
    3 Donate link: http://boakes.org/ 
    45Tags: comments, spam 
    56Requires at least: 2.5 
    67Tested up to: 2.5 
    7 Stable tag: 3.0.alpha2 
    8 Version tag: 3.0.alpha2 
    98 
    109Worst Offenders works cooperatively with other anti-spam plugins: its primary purpose is identifying and deleting the comments that are 100% definitely spam so that any false-positives can be easily found. 
     
    20191. Upload the wo3 Folder to to the `/wp-content/plugins/` directory 
    21201. Activate the plugin through the 'Plugins' menu in WordPress 
    22 1. Check out the WorstOffenders tab under the main Comments tab. 
     211. Visit the "WorstOffenders Config" page under the Plugins tab and click "Update Options" to generate indexes for faster analysis. 
     221. Check out the WorstOffenders page under the main Comments tab. 
    2323 
    2424== Frequently Asked Questions == 
     
    3838 
    3939= Can more litmus tests be devised? = 
     40Yes, the test system is plugabble, and one day it will automatically discover new tests. 
    4041 
    41 Yes, the test system is plugabble. 
     42= My PHP and SQL foo is strong, how do I write a new litmus test? = 
     431. Copy an existing test and call it whatever you like (e.g. ExampleLitmus.php) 
     441. In ExampleLitmus.php change any references to the original class name to ExampleLitmus). 
     451. Invent your magic spam-spotting SQL and insert it the getMatches method, in order to return the comment id you must return either the field comment_id containing a single comment id, or the field comment_id_list which must contain a comma separated list of comments. 
     461. Modify the content method (this is what gets displayed in the tab) 
     471. If necessary, include an addIndexes method. 
     481. Include your litmus test from plugin.php. 
     491. Re-check these instructions, 'cause they're bound to change (and hopefully get easier) as WorstOffenders matures. 
    4250 
    4351== Screenshots == 
     
    54621. Create a widget, so spammers know not to bother. 
    55631. Provide better feedback about things that got deleted. 
     641. Include a warning if indexes are missing (with a create link) 
    5665 
    5766== Done ==