wiki:WatchlistPlugin

Version 21 (modified by martin_s, 5 years ago) (diff)

--

Watchlist for Wikis and Tickets

28th Oct 2009
Watchlist tables are now ([6910],[6913]) dynamically sortable using the jquery table sorter javascript library and its tablesorter pagination plugin.

Description

This plug-in adds a watchlist for wikis and tickets. Every logged-in user can watch any wikis and ticket and later unwatch it. The watchlist is provided under [/projectname]/watchlist which is added to the main navigation bar as soon the user watches something.

To insert a watchlist style table into wikis use the ListOfWikiPagesMacro.

A special ticket report which only shows watched tickets is also provided.

Installation

Install the python package as normal and update your Trac database using:

trac-admin /path/to/trac/environment upgrade

Bugs/Feature Requests

Existing bugs and feature requests for WatchlistPlugin are here.

If you have any issues, create a new ticket.

Download

Download the zipped source from here.

Source

You can check out WatchlistPlugin from here using Subversion, or browse the source with Trac.

Usage

Browse any wiki or ticket and click Watch in the context navigation bar. To unwatch a wiki or ticket browse to it and click Unwatch in the context navigation bar or click the corresponding Unwatch link in the watchlist.

In order to see the watchlist click on the Watchlist button on the main navigation bar. This button will only be displayed for logged in users. The watchlist will be displayed under the location /watchlist. Therefore it can be linked to from a wiki page using [/watchlist].

Watchlist Report

A ticket report can be added to list all watched tickets of the current user. This is not done automatically at the moment. However, the needed SQL code for a manual installation can be taken from the this file.

Using it together with the AnnouncerPlugin

If the AnnouncerPlugin is used to receive change notifications the watchlist allows the user to easily change the notification setting of watched wikis and tickets. If this feature (#4744) is enabled an extra column appears in the watchlist which informs the user about the current setting (On/Off) and allow him/her to change it. Watching and notifications can be independent, i.e. users can have themselves notified about changes of a wiki which is not on their watchlist or vice versa, but can also be linked together as shown below.

To enable notification settings in the watchlist install the AnnouncerPlugin in revision [6916] or later and write the following into your Trac configuration file (conf/trac.ini):

[announcer]
# Rename announcers context navigation items (empty list removes them):
ctxtnav_names = Notify me, Do not notify me 

[watchlist]
notifications = true

To enable notifications by default for all entries in the watchlist (see #6052) also add:

# still in [watchlist]
notify_by_default = true

Screenshots

Navigation bar items for a unwatched wiki page:

Screenshot navigation bar holding items of WatchlistPlugin and modified item of AnnouncerPlugin.

Watchlist under [/watchlist]:

Screenshot of watchlist as of [6913].

Recent Changes

[14353] by jun66j5 on 2014-12-27 15:18:40
1.0.1: fixed an AttributeError when Trac has unavailable translations and Babel is installed (refs #10054)
[14329] by rjollos on 2014-12-15 00:31:34
1.0.1: Fixed handling of timezone offset. Fixes #10424.

Patch by Jun Omae.

[14022] by rjollos on 2014-07-24 23:56:20
Fix test for table existence in Trac 1.0 and later. Fixes #10423.

Author/Contributors

Author: martin_s
Contributors:

Attachments (2)

Download all attachments as: .zip