Tags:
create new tag
view all tags

Subscribe Plugin

Companion plugin to the MailerContrib, adding a "Subscribe me" link to topics to easily subscribe to topic changes

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

Usage

  • Syntax: %SUBSCRIBE{...}% or simply %SUBSCRIBE%
  • Parameters:
    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 updates 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

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

  • For an automated installation, run the configure script and follow "Find More Extensions" in the in the Extensions section.

  • Or, follow these manual installation steps:
    • Download the ZIP file from the extension home on twiki.org (see below).
    • Unzip SubscribePlugin.zip in your twiki installation directory.
    • Set the ownership of the extracted directories and files to the webserver user.
    • Install the dependencies (if any).

  • Plugin configuration and testing:
    • Run the configure script and enable the plugin in the Plugins section.
    • Configure additional plugin settings in the Extensions section if needed.
    • Test if the installation was successful using the examples provided.

Plugin Info

Plugin Author: TWiki:Main/CrawfordCurrie
Copyright: © 2007-2008 Crawford Currie http://c-dot.co.uk;
© 2008-2012 TWiki:TWiki/TWikiContributor
License: GPL (GNU General Public License)
Plugin Version: 2012-12-02
Change History:  
2012-12-02: TWikibug:Item7020: Add category to VarSUBSCRIBE -- TWiki:Main.PeterThoeny
2010-04-25 TWikibug:Item6433 - doc improvements
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
Dependencies:
NameVersionDescription
TWiki::Contrib::MailerContrib>=17628TWiki 4 mailer module
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: VarSUBSCRIBE, TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences

Edit | Attach | Watch | Print version | History: r2 < r1 | Backlinks | Raw View | WYSIWYG | More topic actions
Topic revision: r2 - 2020-08-31 - TWikiAdminUser
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 1999-2024 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.