TWiki Variables » Search » Category: Email & Notification

SUBSCRIBE{ attributes } -- subscribe the current user for notification of changes to the current topic

• The %SUBSCRIBE{...}% variable is handled by the SubscribePlugin
• Syntax: %SUBSCRIBE{...}% or simply %SUBSCRIBE%
• Parameters:

  Parameter	Default	Meaning <-- -->
  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
  unsubscribe	Not set	If set to "on", will unsubscribe the user
  formatunsubscribe	format	Serves same function as format, but allows the user to define a different format than subscribe.
  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.
  who	Logged-in user	Who to subscribe (wikiname, no web)

• 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.
• Category: EmailAndNotificationVariables
• Related: SubscribePlugin (this topic)

Total: 1 variable

Related Topics: TWikiVariables, TWikiVariablesSearch, TWikiVariablesQuickStart