wiki:WatchlistPlugin

Version 30 (modified by martin_s, 4 years ago) (diff)

--

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

Features in Planning

  • Allow users to use wildcards in wiki/ticket add input field, e.g. "Trac*" should add all wikis starting with Trac.
  • "Delete Wiki/Ticket" input field on watchlist.
  • User specific settings with settings on watchlist page:
    • Redirect setting (Go to watchlist or to watched page?)
    • Notification settings (auto-notify-on etc.)
    • Maybe control over watchlist table content.

Watchlist for Wikis and Tickets

Description

This plug-in adds a watchlist for wikis and tickets. Every logged-in user can watch any wikis and ticket. The watchlist is provided under [/watchlist] which is also added to the main navigation bar.

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

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

Download

The official releases can be downloaded from here (v0.3, v0.4).

The release files are also available on the Python Package Index.

Download the zipped source of the develop version from here.

Source

You can check out WatchlistPlugin for Trac version v0.11 and v0.12 using Subversion, or browse the source with Trac.

A normal check-out is done using:

svn co http://trac-hacks.org/svn/watchlistplugin/<trac version> watchlistplugin

To export the sources replace the above co with export.

Installation

This package can be installed using the following commands. The easy_install program is provided by the python setuptools (e.g. python-setuptools package in Ubuntu). See also TracPlugins.

Official Releases

easy_install TracWatchlistPlugin

Develop Versions

easy_install http://trac-hacks.org/svn/watchlistplugin/0.11
# or
easy_install http://trac-hacks.org/svn/watchlistplugin/0.12

Enable Plugin

Enable the plugin in the trac.ini config file (or over WebAdminPlugin):

[components]
tracwatchlist.* = enabled

Then update your Trac database using:

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

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 =

[watchlist]
notifications = true
display_notify_navitems = true

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

# still in [watchlist]
notify_by_default = true

Configuration

The following config file options are currently supported. Per-user configuration settings will be implemented soon. The (legacy) default settings are shown.

[watchlist]
notifications = false                             # Notification support on/off, see above
notify_by_default = false                         # Enable notifications about all watchlist entries, see above 
display_notify_navitems = false                   # Display own notification menu items
display_notify_column = true                      # Display notification column in watchlist tables

stay_at_resource = false                          # Stay at wiki or ticket page after watch/unwatch etc., otherwise go to watchlist page
show_messages_on_resource_page = true             # If stay_at_resource is true show action messages on resource page
show_messages_on_watchlist_page = true            # If stay_at_resource is false show action messages on watchlist page
show_messages_while_on_watchlist_page = true      # Show messages about changes done on the watchlist page

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.

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].

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].

Bugs/Feature Requests

Existing bugs and feature requests for WatchlistPlugin are here.

If you have any issues, create a new ticket.

Recent Changes

[14022] by rjollos on 2014-07-24 23:56:20
Fix test for table existence in Trac 1.0 and later. Fixes #10423.
[14021] by rjollos on 2014-07-24 23:18:19
Removed obsolete directory.
[14020] by rjollos on 2014-07-24 23:18:02
Removed obsolete directory.

Author/Contributors

Author: martin_s
Maintainer: martin_s
Contributors:

Attachments (2)

Download all attachments as: .zip