NotificationPlugin

This plugin allows you to send fine grained notifications of topics you are interested in. It allows you to specify to kinds of notifications - immediate and regular. Immediate notifications are send every time somebody changed the requested topic, regular notifications are the same as default TWiki notifications, but allows better settings.

On this page:

Syntax Rules

You have to create topic %Your_user_name%NotifyList in Main web from template NotificationPluginListTemplate. Fill it with desired topics, webs and regexps and enjoy...

Create Main.TWikiGuestNotifyList now!.

NTF variable

For adding fast switching to notifications you can use %NTF{}% variable:

You should add this variable to view.tmpl (you can use view.tmpl bundled in NotificationPlugin.zip). The buttons are JavaScript-ed so you need to have JavaScript enabled in your browser.

You can use these attributes in %NTF{}% variable:

popup - if displays button which opens new window with support of changing notifications
tin - it displays button for changing 'Topic immediate notifications'
win - it displays button for changing 'Web immediate notifications'
tn - it displays button for changing 'Topic notifications'
wn - it displays button for changing 'Web notifications'

Default values for all these attributes are "on". You can set it "off" to hide buttons.

NTF examples

%NTF{}% - displays all four buttons
%NTF{win="off" wn="off"}% - displays only buttons for topic immediate notification and regular topic notification

Description of NotifyList topics

There are two types of notifications - immediate and regular.

Type of notifications

Immediate notifications

This type of notifications is send immediatly after user change watched topic. This type of notification is send also in the case user use 'Don't notify' checkbox. This means that you can see ANY change which is made in selected topics or webs. But, on the other hand, this is also the best way to be spammed with many mails if you set immediate notification on whole webs if topics in this web are often changed. You have to decide when to use this type of notification.

Regular notifications

This type of notifications is the default TWiki notification system. The problem with this type of notifications is when somebody use "Don't notify" option because notification is not send (what is logical :-)). But sometimes you want to know about every change in your topic and then the immediate notifications come into play...

Subtypes

The syntax of setting a notification is with bullet TWiki list.

Example: If you put following line in "Topic immediate notifications" section when anybody change this topic you will get notification about the change:

WebHome

If you want to set immediate notifications on web TWiki add this line under "Web immediate notifications":

TWiki

If you want to set immediate notifications on all topics in web Test and topics which contains string 'Design' in the name add following line in "Regex immediate notifications":

Test\..*Design