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
%$INSTALL_INSTRUCTIONS%
Plugin Info
Another great TWiki extension from the
WikiRing - working together to improve your wiki experience!
Related Topics: TWikiPlugins,
DeveloperDocumentationCategory,
AdminDocumentationCategory,
TWikiPreferences
Topic revision: r1 - 02 Apr 2008 - 01:17:01 -
TWikiGuest