VarSUBSCRIBE < TWiki

#VarSUBSCRIBE
---+++ SUBSCRIBE{ _attributes_ } -- subscribe the current user for notification of changes to the current topic
   * The =%<nop>SUBSCRIBE{...}%= variable is handled by the SubscribePlugin%STARTSECTION{"subscribe_attributes"}%
   * Syntax: =%<nop>SUBSCRIBE{...}%= or simply =%<nop>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="%USERSWEB%.*"= 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.%ENDSECTION{"subscribe_attributes"}%
   * Category: EmailAndNotificationVariables
   * Related: SubscribePlugin

This topic: TWiki > WebHome > TWikiVariables > VarSUBSCRIBE
Topic revision: r2 - 2023-02-01 - TWikiAdminUser

Copyright © 1999-2026 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.VarSUBSCRIBE.