SubscribePlugin < TWiki

TWiki Web>SubscribePlugin (2020-08-31, TWikiAdminUser) (raw view)
---+ Subscribe Plugin
<!--
   Contributions to this plugin are appreciated. Please update the plugin page at
   http://twiki.org/cgi-bin/view/Plugins/SubscribePlugin or provide feedback at
   http://twiki.org/cgi-bin/view/Plugins/SubscribePluginDev.
   If you are a TWiki contributor please update the plugin in the SVN repository.

   * Set SHORTDESCRIPTION = Companion plugin to the MailerContrib, adding a "Subscribe me" link to topics to easily subscribe to topic changes
-->
<sticky><div style="float:right; background-color:#EBEEF0; margin:0 0 20px 20px; padding: 0 10px 0 10px;">
%TOC{title="Page contents"}%
</div></sticky>
%SHORTDESCRIPTION%

Example (only works if plugin is installed, and you are logged in (not %USERSWEB%.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

__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 [[%SCRIPTURL{configure}%][configure]] script and follow "Find More Extensions" in the in the __Extensions__ section.
      * See the [[http://twiki.org/cgi-bin/view/Plugins/BuildContribInstallationSupplement][installation supplement]] on TWiki.org for more information.

   * Or, follow these __manual installation__ steps:
      * Download the ZIP file from the extension home on twiki.org (see below).
      * Unzip ==%TOPIC%.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 [[%SCRIPTURL{configure}%][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: | &copy; 2007-2008 Crawford Currie http://c-dot.co.uk; <br /> &copy; 2008-2012 TWiki:TWiki/TWikiContributor |
|  License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) |
|  Plugin Version: | 2012-12-02 |
|  Change&nbsp;History: | <!-- versions below in reverse order -->&nbsp; |
|  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 %<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 |
|  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> |
|  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:__ VarSUBSCRIBE, %SYSTEMWEB%.TWikiPlugins, %SYSTEMWEB%.DeveloperDocumentationCategory, %SYSTEMWEB%.AdminDocumentationCategory, %SYSTEMWEB%.TWikiPreferences
Topic revision: r2 - 2020-08-31 - TWikiAdminUser
TWiki
Webs
Sandbox
TWiki
Copyright © 1999-2025 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.