Extension:CategorySubscriptions: Difference between revisions
Content deleted Content added
m Use GoogleCodeDownload template in the infobox |
last commit 15 years ago Tag: Replaced |
||
| (14 intermediate revisions by 7 users not shown) | |||
| Line 1: | Line 1: | ||
{{Archived extension|5662240}} |
|||
{{Extension |
|||
|name = CategorySubscriptions |
|||
|description = Allows users to subscribe to categories and receive daily email updates listing new and updated pages for each category |
|||
|type1 = special |
|||
|type2 = database |
|||
|author = Michael Yatzkanic |
|||
|username = Myatzkan |
|||
|status = beta |
|||
|version = Beta 2 (May 16, 2008) |
|||
|image = |
|||
|license = GPL v3 |
|||
|download = {{GoogleCodeDownload|mw-categorysubscriptions}} |
|||
|rights = |
|||
|mediawiki = 1.11+ |
|||
}} |
|||
==Description== |
|||
'''CategorySubscriptions''' allows a user to subscribe to categories and receive daily email updates of the changes that occured within each category during the previous day. |
|||
The goal of this extension is to allow a user to easily watch changes that occur within a category. Categories can be added directly (one category at a time) or by viewing a wiki page and viewing all the categories that wiki page belongs too. |
|||
== Update == |
|||
<big>'''The code has undergone a major update.'''</big> Please visit the new [http://code.google.com/p/mw-categorysubscriptions project home] to get the newest source code. |
|||
This wiki page and the new Google code page will be updated in the near future to reflect the new changes. |
|||
==Requirements== |
|||
===Pear=== |
|||
The following Pear packages are required for the php emailing script. If you do not have Pear installed you will have to install it in additon to these required packages. |
|||
*Mail |
|||
*Net_SMTP (if using smtp to send emails) |
|||
*Net_socket (dependant of net_smtp) |
|||
If you are using a different emailing protocol other than SMTP you will have to configure the mailer script and Pear as needed. |
|||
===SQL Table=== |
|||
<big>'''An installer script is now provided to create the table automatically. The following is left for reference.'''</big> |
|||
A new table must be created in the mediawiki database. |
|||
The table is very simple and has only 3 columns |
|||
*id - unique identifier for each column (auto-increment) |
|||
*user_id - the id of the user making the subscription |
|||
*category - the name of the category to be subscribed too |
|||
The SQL statement to create the table (note: only tested on MySQL database): |
|||
<source lang="mysql"> |
|||
CREATE TABLE category_subscriptions ( |
|||
id int(10) unsigned NOT NULL auto_increment, |
|||
user_id int(10) unsigned NOT NULL default '0', |
|||
category varchar(255) NOT NULL default '', |
|||
PRIMARY KEY (id) |
|||
); |
|||
</source> |
|||
If your MediaWiki installation has a database prefix, be sure to prefix it to the table name. Example, if $wgDBprefix="mw" then your table name will be "mwcategory_subscriptions" |
|||
==Installation== |
|||
<big>'''This section will be updated to reflect the new procedure...'''</big> |
|||
#Install required Pear packages and create new table in database |
|||
#Create directory "CategorySubscriptions" under the extensions folder of your wiki installation |
|||
#Copy all 3 php files (CategorySubscriptions.php, CategorySubscriptions.i18n.php, CategorySubscriptionsMailer.php) into the folder you just created |
|||
#Add the following code to your LocalSettings.php file: <source lang="php">require_once("$IP/extensions/CategorySubscriptions/CategorySubscriptions.php");</source> |
|||
#Configure the mailer script (database host, user name, password, etc...) |
|||
#Using your favorite automation method, set the CategorySubscriptionsMailer.php script to run every morning. |
|||
==Usage== |
|||
New and improved usage instructions will be up shortly, as the interface to the extension changed slightly. |
|||
==Code== |
|||
Code is now available through svn at the Google code page linked in the info box. |
|||
Latest revision as of 11:45, 24 July 2023
 | This extension has been archived.
This extension has not been maintained for some time, and no longer supports recent releases of MediaWiki. |