Index: trunk/extensions/UserRightsNotif/UserRightsNotif |
— | — | @@ -1,76 +0,0 @@ |
2 | | -USER RIGHTS EMAIL NOTIFICATION EXTENSION |
3 | | - |
4 | | - Version 1.0 |
5 | | - � 2006 Rob Church |
6 | | - |
7 | | -This is free software licensed under the GNU General Public Licence. Please |
8 | | -see http://www.gnu.org/copyleft/gpl.html for further details, including the |
9 | | -full text and terms of the licence. |
10 | | - |
11 | | -== Overview == |
12 | | - |
13 | | - 1. Introduction |
14 | | - 2. Installation requirements |
15 | | - 3. Installing the extension |
16 | | - 4. Editing the notification email |
17 | | - 5. Further configuration |
18 | | - 6. Notes |
19 | | - 7. Change log |
20 | | - |
21 | | -== 1. Introduction == |
22 | | - |
23 | | -The user rights email notification extension provides a clean and customisable |
24 | | -means to send email messages to one or more registered users upon a change to |
25 | | -their group memberships. The behaviour of the extension can be controlled using |
26 | | -configuration options within the LocalSettings.php file for MediaWiki. |
27 | | - |
28 | | -== 2. Installation requirements == |
29 | | - |
30 | | -This extension requires hooks present in MediaWiki 1.5.9 and later. |
31 | | - |
32 | | -== 3. Installing the extension == |
33 | | - |
34 | | -To install the new user email notification extension, first upload/copy the |
35 | | -extension file UserRightsNotif.php into your MediaWiki extensions directory. Then |
36 | | -edit your LocalSettings.php file and add the following line: |
37 | | - |
38 | | - require_once( 'extensions/UserRightsNotif.php' ); |
39 | | - |
40 | | -Save the file (uploading if applicable) to complete the installation. |
41 | | - |
42 | | -== 4. Editing the notification email == |
43 | | - |
44 | | -When preparing the email message to be sent to each recipient, the extension |
45 | | -relies upon two system messages. You will need to create these if you wish |
46 | | -to customise them, as detailed below: |
47 | | - |
48 | | -MediaWiki:Userrightsnotifysubject |
49 | | - This file contains the subject line for the email. |
50 | | - $1 is replaced with the wiki site name from $wgSitename. |
51 | | - |
52 | | -MediaWiki:Userrightsnotifybody |
53 | | - This file contains the body text for the email. |
54 | | - $1 is replaced with the username of the recipient; |
55 | | - $2 is replaced with the wiki site name from $wgSitename; |
56 | | - $3 is replaced with the username of the user who made the change; |
57 | | - $4 is replaced with the time and date of the change; |
58 | | - $5 is replaced with a comma-delimited list of groups added; |
59 | | - $6 is replaced with a comma-delimited list of groups removed. |
60 | | - |
61 | | -== 5. Further configuration == |
62 | | - |
63 | | -To change the sender email address used (the default is the same as |
64 | | -$wgPasswordSender), set the $wgUserRightsNotif['sender'] variable in LocalSettings.php. |
65 | | - |
66 | | -== 6. Notes == |
67 | | - |
68 | | -* On wikis where email address authentication is present and active(1), then |
69 | | - no email is sent unless the recipient's email address is validated. |
70 | | - |
71 | | -(1) => MediaWiki 1.5 and later |
72 | | - |
73 | | -== 7. Change Log == |
74 | | - |
75 | | -Version 1.0 |
76 | | -29/03/2006 |
77 | | - Initial release |
\ No newline at end of file |
Index: trunk/extensions/UserRightsNotif/UserRightsNotif.php |
— | — | @@ -17,6 +17,7 @@ |
18 | 18 | 'name' => 'User Rights Email Notification', |
19 | 19 | 'url' => 'http://meta.wikimedia.org/wiki/User_Rights_Email_Notification', |
20 | 20 | 'author' => 'Rob Church', |
| 21 | + 'desc' => 'Sends email notification to users upon rights changes', |
21 | 22 | ); |
22 | 23 | |
23 | 24 | # Change this to alter the email sender |
— | — | @@ -45,6 +46,4 @@ |
46 | 47 | } else { |
47 | 48 | echo( "This file is an extension to the MediaWiki software and cannot be executed standalone.\n" ); |
48 | 49 | die( 1 ); |
49 | | -} |
50 | | - |
51 | | - |
| 50 | +} |
\ No newline at end of file |
Index: trunk/extensions/UserRightsNotif/README |
— | — | @@ -0,0 +1,76 @@ |
| 2 | +USER RIGHTS EMAIL NOTIFICATION EXTENSION |
| 3 | + |
| 4 | + Version 1.0 |
| 5 | + � 2006 Rob Church |
| 6 | + |
| 7 | +This is free software licensed under the GNU General Public Licence. Please |
| 8 | +see http://www.gnu.org/copyleft/gpl.html for further details, including the |
| 9 | +full text and terms of the licence. |
| 10 | + |
| 11 | +== Overview == |
| 12 | + |
| 13 | + 1. Introduction |
| 14 | + 2. Installation requirements |
| 15 | + 3. Installing the extension |
| 16 | + 4. Editing the notification email |
| 17 | + 5. Further configuration |
| 18 | + 6. Notes |
| 19 | + 7. Change log |
| 20 | + |
| 21 | +== 1. Introduction == |
| 22 | + |
| 23 | +The user rights email notification extension provides a clean and customisable |
| 24 | +means to send email messages to one or more registered users upon a change to |
| 25 | +their group memberships. The behaviour of the extension can be controlled using |
| 26 | +configuration options within the LocalSettings.php file for MediaWiki. |
| 27 | + |
| 28 | +== 2. Installation requirements == |
| 29 | + |
| 30 | +This extension requires hooks present in MediaWiki 1.5.9 and later. |
| 31 | + |
| 32 | +== 3. Installing the extension == |
| 33 | + |
| 34 | +To install the new user email notification extension, first upload/copy the |
| 35 | +extension file UserRightsNotif.php into your MediaWiki extensions directory. Then |
| 36 | +edit your LocalSettings.php file and add the following line: |
| 37 | + |
| 38 | + require_once( 'extensions/UserRightsNotif.php' ); |
| 39 | + |
| 40 | +Save the file (uploading if applicable) to complete the installation. |
| 41 | + |
| 42 | +== 4. Editing the notification email == |
| 43 | + |
| 44 | +When preparing the email message to be sent to each recipient, the extension |
| 45 | +relies upon two system messages. You will need to create these if you wish |
| 46 | +to customise them, as detailed below: |
| 47 | + |
| 48 | +MediaWiki:Userrightsnotifysubject |
| 49 | + This file contains the subject line for the email. |
| 50 | + $1 is replaced with the wiki site name from $wgSitename. |
| 51 | + |
| 52 | +MediaWiki:Userrightsnotifybody |
| 53 | + This file contains the body text for the email. |
| 54 | + $1 is replaced with the username of the recipient; |
| 55 | + $2 is replaced with the wiki site name from $wgSitename; |
| 56 | + $3 is replaced with the username of the user who made the change; |
| 57 | + $4 is replaced with the time and date of the change; |
| 58 | + $5 is replaced with a comma-delimited list of groups added; |
| 59 | + $6 is replaced with a comma-delimited list of groups removed. |
| 60 | + |
| 61 | +== 5. Further configuration == |
| 62 | + |
| 63 | +To change the sender email address used (the default is the same as |
| 64 | +$wgPasswordSender), set the $wgUserRightsNotif['sender'] variable in LocalSettings.php. |
| 65 | + |
| 66 | +== 6. Notes == |
| 67 | + |
| 68 | +* On wikis where email address authentication is present and active(1), then |
| 69 | + no email is sent unless the recipient's email address is validated. |
| 70 | + |
| 71 | +(1) => MediaWiki 1.5 and later |
| 72 | + |
| 73 | +== 7. Change Log == |
| 74 | + |
| 75 | +Version 1.0 |
| 76 | +29/03/2006 |
| 77 | + Initial release |
\ No newline at end of file |
Property changes on: trunk/extensions/UserRightsNotif/README |
___________________________________________________________________ |
Added: svn:eol-style |
1 | 78 | + native |
Added: svn:keywords |
2 | 79 | + Author Date Id Revision |