[[html(
)]] 28th Oct 2009:: Watchlist tables are now ([6910],[6913]) dynamically sortable using the [http://tablesorter.com/docs/ jquery table sorter javascript library] and its tablesorter pagination plugin. [[html(
)]] = 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 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. [[TOC]] To insert a watchlist style table into wikis use the ListOfWikiPagesMacro. A special [source:watchlistplugin/0.11/tracwatchlist/watchlist_report.sql ticket report] which only shows watched tickets is also provided. == Installation == Install the python package [t:TracPlugins as normal], e.g.: {{{ easy_install --always-unzip http://trac-hacks.org/svn/watchlistplugin/0.11 }}} 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 }}} See also [#AnnouncerPlugin this section] how to configure this plugin to work together with the AnnouncerPlugin. == Bugs/Feature Requests == [[html(
)]] '''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. [[html(
)]] Existing bugs and feature requests for WatchlistPlugin are [report:9?COMPONENT=WatchlistPlugin here]. If you have any issues, create a [http://trac-hacks.org/newticket?component=WatchlistPlugin&owner=martin_s new ticket]. == Download == Download the zipped source from [download:watchlistplugin here]. == Source == You can check out WatchlistPlugin from [http://trac-hacks.org/svn/watchlistplugin here] using Subversion, or [source:watchlistplugin 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 [source:watchlistplugin/0.11/tracwatchlist/watchlist_report.sql this file]. == Using it together with the AnnouncerPlugin ==#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: [[Image(watchlist.2.png)]] Watchlist under `[/watchlist]`: [[Image(watchlist.png)]] == Recent Changes == [[ChangeLog(watchlistplugin, 3)]] == Author/Contributors == '''Author:''' [wiki:martin_s] [[BR]] '''Contributors:'''