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.

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

NotificationPlugin Global Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %INTERWIKIPLUGIN_SHORTDESCRIPTION%

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = This plugin allows you to send fine grained notifications of topics you are interested in

• Debug plugin: (See output in data/debug.txt)
  • Set DEBUG = 0

• Custom settings:
  • Set SENDER = JUNOlink Administrator <beheer@junolink.nl>

TODO

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

Plugin Installation Instructions

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the server where TWiki is running.

• Download the ZIP file from the Plugin web (see below)
• Unzip NotificationPlugin.zip in your twiki installation directory. Content:

  File:	Description:
  data/TWiki/NotificationPlugin.txt	Plugin topic
  data/TWiki/NotificationPluginListTemplate.txt	Template for NotifyList topics
  lib/TWiki/Plugins/NotificationPlugin.pm	Plugin Perl module
  bin/mailnotify-NP	Perl script for sending regular notifications (could be put in cron) You can rename it if you need old notifications
  bin/changenotify	Perl script for changing notifications using NTF variable
  templates/htmlchanges.tmpl	Template for generating HTML mails with notifications
  templates/view.NP.tmpl	Template with example of using NTF variable

• (Dakar) Visit configure in your TWiki installation, and enable the plugin in the {Plugins} section.

Plugin History

• Version - Nov 2009
  • Upgraded to work with TWiki 4.3.2 version
• Version 1.03
  • added SENDER variable
  • fixed bug with remaining \n and \r characters when parsing NotifyList topics
  • fixed many error log entries when notifications are generated
• Version 1.04
  • fixed bug when immediate notifications were send to people who had not set this type of notification
• Version 1.05
  • fixed error log entries generated on line 221; function getScriptUrl is now properly called with params (thanx NormProffitt)
• Version 1.1
  • added new functions for better handling of NotifyList topics
  • added support for fast setting notifications on every TWiki page (view.tmpl)
• Version 1.11
  • code substitution to remove trailing whitespace
  • bug-fix 'attr' to 'attrs' on line 519
• Version 1.12
  • fixed function getUsersToNotify
• Version 1.13
  • fixed bug in mailnotify script
• Version 1.14
  • added popup support for changing notifications (thanx KenGoldenberg
  • mailnotify script renamed to mailnotify-NP
    • you should create new cron job for regular notifications of NotificationPlugin

Plugin Info

Plugin Author:	TWiki:Main/RichardBaar, TWiki:Main/SopanShewale ( Twiki, Inc.)
Plugin Release Date	2017-08-05
Change History:
2017-08-05	TWikibug:Item7851: Fix unescaped left brace in regex issue -- TWiki:Main.HaraldJoerg
27 Nov 2009	Bugs:Item6247: Upgrade NotificationPlugin to latest version of TWiki 4.3.0
21 May 2007	Bugs:Item3969 - 8bit email fix (TWiki:Main.WillNorris)
14 Jan 2004:	Initial version
24 Feb 2004:	Version 1.03 - added SENDER variable, bug-fixes
24 Feb 2004:	Version 1.04 - bug-fix of immediate notifications
25 Feb 2004:	Version 1.05 - bugfix
26 Apr 2004:	Version 1.1 - new functions; added support for fast setting notifications
28 Apr 2004:	Version 1.11 - bugfixes
28 Apr 2004:	Version 1.12 - bugfix
29 Apr 2004:	Version 1.13 - mailnotify script bugfix
11 May 2004:	Version 1.14 - popup support for changing notifications
CPAN Dependencies:	none
Other Dependencies:	none
Perl Version:	5.005
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/NotificationPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/NotificationPluginDev

Related Topics: TWikiPreferences, TWikiPlugins

• Thanks Twiki, Inc. for allowing time time upgrade to support on TWiki 4.3.2 version - TWiki:Main/SopanShewale
• Thanks to Systinet for sponsoring initial verion - TWiki:Main/RichardBaar