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).

ALERT! 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

%$INSTALL_INSTRUCTIONS%

Plugin Info

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

Plugin Author: TWiki:Main.CrawfordCurrie
Copyright: © 2007, Crawford Currie http://c-dot.co.uk
License: GPL (GNU General Public License)
Plugin Version: %$VERSION%
Dependencies: %$DEPENDENCIES%
Change History:  
9 Sep 2007 Bugs:Item4175 added MAKETEXT in case the string is available
13966 Bugs:Item4155 Fixed for 4.0.x and 4.1.x
13787 Item4010fix web subscription, and format parameters. - TWiki:Main.SvenDowideit
13525 Item3731 Update documentation topic.
13512 Item3731 final pre-release tweaks, result of testing on 4.1.2
13510 Item3731 completed the plugin now that the Mailer updates are done
13506 Item3731 Update dependency to latest version of MailerContrib
13081 Item3731 Added SubscribePlugin, and cleaned up and updated APIs in MailerContrib
?1' '  
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

Topic revision: r1 - 02 Apr 2008 - 01:17:01 - TWikiGuest
 
This site is powered by the TWiki collaboration platformCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.SubscribePlugin