NotificationPlugin

Send fine grained notifications of topics you are interested in

Allows you to specify to kinds of notifications - immediate and regular. Immediate notifications are sent every time somebody changes the requested topic, regular notifications are the same as default Foswiki notifications, but allows better settings.

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.WikiGuestNotifyList 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 Foswiki 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 Foswiki list.

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

• Main

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

• Foswiki

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

TODO

• Add child notifications (setting an topic and get notifications of all its children)

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.

Open configure, and open the "Extensions" section. Use "Find More Extensions" to get a list of available extensions. Select "Install".

If you have any problems, or if the extension isn't available in configure, then you can still install manually from the command-line. See http://foswiki.org/Support/ManuallyInstallingExtensions for more help.

Some unusual files are installed that are worthy of mention:

templates/htmlchanges.tmpl	Template for generating HTML mails with notifications
templates/view.NP.tmpl	Template with example of using NTF variable
tools/mailnotify-NP	Perl script for sending regular notifications (could be put in cron) You can rename it if you need old notifications
tools/changenotify	Perl script for changing notifications using NTF variable

Info

Sponsored by Systinet

Author:	Foswiki:Main/RichardBaar
Version:	9012 (2010-09-12)
Release:	1.20
Change History:
12 Sep 2010 (1.16)	Tasks:Item8428 - Lose SENDER
21 May 2007:	Bugs:Item3969 - 8bit email fix (Foswiki:Main.WillNorris)
11 May 2004:	Version 1.14 - popup support for changing notifications
29 Apr 2004:	Version 1.13 - mailnotify script bugfix
28 Apr 2004:	Version 1.12 - bugfix
28 Apr 2004:	Version 1.11 - bugfixes
25 Feb 2004:	Version 1.05 - bugfix
24 Feb 2004:	Version 1.04 - bug-fix of immediate notifications
24 Feb 2004:	Version 1.03 - added SENDER variable, bug-fixes
26 Apr 2004:	Version 1.1 - new functions; added support for fast setting notifications
14 Jan 2004:	Initial version
Home:	http://foswiki.org/Extensions/NotificationPlugin
Feedback:	http://foswiki.org/Extensions/NotificationPluginDev

-- Foswiki:Main/RichardBaar - 26 Apr 2004