Get rid of the last (I think) php4-style calls to wfGetDB()
[toast/cookiecaptcha.git] / MathCaptcha
1 MATHCAPTCHA PLUGIN FOR MEDIAWIKI
2
3 1. Overview
4 2. Requirements
5 3. Installing the plugin
6 4. Customising captcha behaviour
7 5. Change log
8 6. Feedback
9 7. References
10
11 == 1. Overview ==
12
13 The MathCaptcha plugin is an alternative captcha[1] mechanism which can
14 be used in conjunction with the ConfirmEdit extension[2] to provide a
15 more convenient means of blocking or throttling automated editing.
16
17 The method used to generate the captcha images, and the formatting of
18 said images, means that the captchas will not, at this time, defeat a
19 tool which is designed to break them; however, casual mass-registration
20 or mass-spamming attempts will be dissuaded.
21
22 == 2. Requirements ==
23
24 The plugin requires
25
26 * Working support for TeX within MediaWiki (using the standard TexVC
27   software)[3]
28 * ConfirmEdit extension
29
30 == 3. Installing the plugin ==
31
32 Check the plugin out from Subversion[4] (and check out the ConfirmEdit
33 extension, if you don't have it installed) and place the files in your
34 extensions/ directory, within your wiki root.
35
36 Edit LocalSettings.php and add the following lines near the bottom of the
37 file, above the closing ?> tag, if any:
38
39         require_once( 'extensions/ConfirmEdit.php' );
40         require_once( 'extensions/MathCaptcha.php' );
41         $wgCaptchaClass = 'MathCaptcha';
42
43 This installs ConfirmEdit and instructs it to use the MathCaptcha plugin.
44 The default settings for ConfirmEdit are used. At this point, no further
45 action is required to have the plugin work for user registration or edits
46 which add new external links to a page.
47
48 == 4. Customising captcha behaviour ==
49
50 A number of settings relating to the ConfirmEdit extension can be used to alter
51 the attitude of the captcha, including those actions for which it appears,
52 users who do not have to pass a captcha, etc. See the ConfirmEdit.php file for
53 information on this.
54
55 As an example, to throw a captcha for all edits, add the following line to
56 LocalSettings.php:
57
58         $wgCaptchaTriggers['edit'] = true;
59
60 == 5. Change log ==
61
62 12/06/2006
63 1.0
64         Initial release
65
66 == 6. Feedback ==
67
68 Feedback on the MathCaptcha plugin is welcomed at <robchur@gmail.com>. To report bugs
69 with the ConfirmEdit extension, please use http://bugzilla.wikimedia.org.
70
71 == 7. References ==
72
73 i. http://en.wikipedia.org/wiki/Captcha
74 ii. http://www.mediawiki.org/wiki/Extension:ConfirmEdit
75 iii. http://www.mediawiki.org/wiki/Manual:Enable_TeX
76 iv. http://www.mediawiki.org/wiki/Subversion