Subscribe Plugin

This is a companion plugin to the MailerContrib. It allows you to trivially add a "Subscribe me" link to topics to get subscribed to changes.

Example (only works if plugin is installed, and you are logged in (not TWikiGuest)):

Usage

Anywhere in a topic or template:

• %SUBSCRIBE{...}% or simply %SUBSCRIBE%

Parameter	Default	Meaning
who	Logged-in user	Who to subscribe (wikiname, no web)
topic	Current topic	Topic to subscribe to. Wildcards may be used e.g. topic="Item*" will subscribe to all topics starting with Item. Use topic="Main.*" to subscribe to the WebNotify for that web.
unsubscribe	Not set	If set to "on", will unsubscribe the user
format	Simple HTML Link with an action anchor "Subscribe" or "Unsubscribe"	Defines custom look-and-feel for subscribe link using the following format variables: $topics, $url, $wikiname, $action
formatunsubscribe	format	Serves same function as format, but allows the user to define a different format than subscribe.

• The button toggles subscribe/unsubscribe if the user is already subscribed or vice versa. So after the next click on the button, the user will be unsubscribed.
• The plugin will do the best it can to optimise the subscription lists in WebNotify.

Access Controls

The guest user is not allowed to subscribe for notification.

You don't need VIEW access to the WebNotify topic in order to subscribe to changes in a web, but you must have CHANGE access. If you want users to be able to subscribe or unsubscribe, but you don't want them to be able to modify their subscription or otherwise edit the WebNotify topic, you can restrict VIEW access to WebNotify. This will make it uneditable from the browser (but will not block save urls, so is not fully secure).

Note that permissions on individual topics are not checked when subscription mails are sent out, so be very careful about who you allow to subscribe.

Plugin Installation Instructions

You do not need to install anything in the browser to use this extension. The following instructions are for the administrator who installs the extension on the server where TWiki is running.

Like many other TWiki extensions, this module is shipped with a fully automatic installer script written using the BuildContrib.

• If you have TWiki 4.2 or later, you can install from the configure interface (Go to Plugins->Find More Extensions)
  • See the installation supplement on TWiki.org for more information.
• If you have any problems, then you can still install manually from the command-line:
  1. Download one of the .zip or .tgz archives
  2. Unpack the archive in the root directory of your TWiki installation.
  3. Run the installer script ( perl <module>_installer )
  4. Run configure and enable the module, if it is a plugin.
  5. Repeat for any missing dependencies.
• If you are still having problems, then instead of running the installer script:
  1. Make sure that the file permissions allow the webserver user to access all files.
  2. Check in any installed files that have existing ,v files in your existing install (take care not to lock the files when you check in)
  3. Manually edit LocalSite.cfg to set any configuration variables.

Plugin Info

Another great TWiki extension from the WikiRing - working together to improve your wiki experience!

Plugin Author:	TWiki:Main.CrawfordCurrie
Copyright:	© 2008, Crawford Currie http://c-dot.co.uk
License:	GPL (GNU General Public License)
Plugin Version:	17641 (18 Oct 2008)
Dependencies:	Name Version Description TWiki::Contrib::MailerContrib >=17628 TWiki 4 mailer module
Change History:
15 Oct 2008	TWikibug:Item4115: enable subscriptions with (child), TWikibug:Item5950: fix cross web SUBSCRIPTION indication (requires updated MailerContrib) can now get feedback to %SUBSCRIBE{topic="*"}% - TWiki:Main.SvenDowideit
25 May 2008	TWikibug:Item5488: merged TWiki:Main.DavidPatterson's patch to fix deep subscription
25 Jan 2008	TWikibug:Item4812: added TWiki:Main.BobGoldstein's noexpand patch for groups
9 Sep 2007	TWikibug:Item4175 added MAKETEXT in case the string is available
13966	TWikiBug :Item4155 Fixed for 4.0.x and 4.1.x
13787	TWikibug:Item4010 - fix web subscription, and format parameters. - TWiki:Main.SvenDowideit
13525	TWikibug:Item3731 - Update documentation topic.
13512	TWikibug:Item3731 - final pre-release tweaks, result of testing on 4.1.2
13510	TWikibug:Item3731 - completed the plugin now that the Mailer updates are done
13506	TWikibug:Item3731 - Update dependency to latest version of MailerContrib
13081	TWikibug:Item3731 - Added SubscribePlugin, and cleaned up and updated APIs in MailerContrib
24 Apr 2007	First version
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/SubscribePlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/SubscribePluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/SubscribePluginAppraisal

Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences