SubscribePlugin < TWiki

TWiki Web>SubscribePlugin (2009-10-21, TWikiAdminUser) (raw view)EditAttach
<a href="http://wikiring.com"><img src="%ATTACHURL%/logo.gif" style="float:right" /></a>
---+ Subscribe Plugin

<!--
   * Set SHORTDESCRIPTION = 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.
-->
%SHORTDESCRIPTION%

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

---++ Usage
%INCLUDE{"VarSUBSCRIBE" section="subscribe_attributes"}%

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

%X% 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 Build<nop>Contrib.
   * If you have TWiki 4.2 or later, you can install from the =configure= interface (Go to Plugins->Find More Extensions)
      * See the [[http://twiki.org/cgi-bin/view/Plugins/BuildContribInstallationSupplement][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
      1 Unpack the archive in the root directory of your TWiki installation.
      1 Run the installer script ( =perl &lt;module&gt;_installer= )
      1 Run =configure= and enable the module, if it is a plugin.
      1 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.
      1 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)
      1 Manually edit !LocalSite.cfg to set any configuration variables.

%IF{"defined 'SYSTEMWEB'" else="<div class='twikiAlert'>%X% WARNING: SYSTEMWEB is not defined in this TWiki. Please add these definitions to your %MAINWEB%.TWikiPreferences, if they are not already there:<br><pre>   * <nop>Set SYSTEMWEB = %<nop>TWIKIWEB%<br>   * <nop>Set USERSWEB = %<nop>MAINWEB%</pre></div>"}%


---++ Plugin Info

Another great TWiki extension from the <a style="text-decoration:none" href="http://wikiring.com"><img src="%ATTACHURLPATH%/wikiringlogo20x20.png" alt="" /> *WikiRing* </a> - working together to improve your wiki experience!

|  Plugin Author: | TWiki:Main.CrawfordCurrie |
|  Copyright: | &copy; 2008, Crawford Currie http://c-dot.co.uk |
|  License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) |
|  Plugin Version: | 17641 (18 Oct 2008) |
|  Dependencies: | <table border="1"><tr><th>Name</th><th>Version</th><th>Description</th></tr><tr><td align="left">TWiki::Contrib::MailerContrib</td><td align="left">&gt;=17628</td><td align="left">TWiki 4 mailer module</td></tr></table> |
|  Change&nbsp;History: | <!-- versions below in reverse order -->&nbsp; |
|  15 Oct 2008 | TWikibug:Item4115: enable subscriptions with (child), \
                    TWikibug:Item5950: fix cross web SUBSCRIPTION indication (requires updated MailerContrib) \
                    can now get feedback to %<nop>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/%TOPIC% |
|  Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev |
|  Appraisal: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal |

__Related Topics:__ %TWIKIWEB%.TWikiPlugins, %TWIKIWEB%.DeveloperDocumentationCategory, %TWIKIWEB%.AdminDocumentationCategory, %TWIKIWEB%.TWikiPreferences
Attachments
Topic attachments
I	Attachment	Action	Size	Date	Who	Comment
png	wikiringlogo20x20.png	manage	1.3 K	2008-10-18 - 12:13	TWikiAdminUser	Saved by install script
Topic revision: r2 - 2009-10-21 - 09:55:07 - TWikiAdminUser
TWiki
Copyright © 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