Changes between Version 49 and Version 50 of WatchlistPlugin
- Timestamp:
- Nov 18, 2015, 11:52:50 AM (8 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
WatchlistPlugin
v49 v50 5 5 == Description 6 6 7 This plugin adds a watchlist for wikis and tickets. Every logged-in user can watch any wiki sand ticket. The watchlist is provided under `[/watchlist]` which is also added to the main navigation bar.7 This plugin adds a watchlist for wikis and tickets. Every logged-in user can watch any wiki page and ticket. The watchlist is provided under `[/watchlist]` which is also added to the main navigation bar. 8 8 9 9 To insert a watchlist style table into wikis use the ListOfWikiPagesMacro. … … 29 29 The release files are also available on the [pypi:TracWatchlistPlugin/ Python Package Index]. 30 30 31 Download the zipped source of the develop version from [ download:watchlistplugin here].31 Download the zipped source of the develop version from [export:watchlistplugin here]. 32 32 33 33 == Source 34 34 35 You can check out WatchlistPlugin for Trac version [ http://trac-hacks.org/svn/watchlistplugin/0.12 0.12] (also compatible with Trac 0.11) or [source:watchlistplugin browse the source] with Trac.35 You can check out WatchlistPlugin for Trac version [/svn/watchlistplugin/0.12 0.12] (also compatible with Trac 0.11) or [source:watchlistplugin browse the source] with Trac. 36 36 37 The older releases, without language support and newer features, for [ http://trac-hacks.org/svn/watchlistplugin/0.11old 0.11] and [http://trac-hacks.org/svn/watchlistplugin/0.12old 0.12] are also still available.37 The older releases, without language support and newer features, for [/svn/watchlistplugin/0.11old 0.11] and [/svn/watchlistplugin/0.12old 0.12] are also still available. 38 38 39 A normal check-out is done using:39 A normal check-out is done as follows: 40 40 {{{#!sh 41 svn co http ://trac-hacks.org/svn/watchlistplugin/<trac version> watchlistplugin41 svn co https://trac-hacks.org/svn/watchlistplugin/<trac version> watchlistplugin 42 42 }}} 43 43 44 To export the sources replace the above `co` with `export`.44 To export the sources, replace `co` with `export` in the line above. 45 45 46 46 Note that 0.11 is currently just a symbolic link to 0.12 because this version is also compatible with Trac 0.11. … … 64 64 === Enable Plugin 65 65 66 Enable the plugin in the `trac.ini` config file (or over WebAdminPlugin):66 Enable the plugin in the `trac.ini` configuration file (or over WebAdminPlugin): 67 67 {{{#!ini 68 68 [components] … … 77 77 === Uninstall Plugin 78 78 79 An [source:watchlistplugin/0.12/tools/uninstall.py uninstaller] (a python script) is provided to remove all created database tables. [ [http://trac-hacks.org/export/latest/watchlistplugin/0.12/tools/uninstall.py Direct Download] ]80 The plugin itself can be uninstalled by removing the python egg file.79 An [source:watchlistplugin/0.12/tools/uninstall.py uninstaller] (a Python script) is provided to remove all created database tables. [ [/export/latest/watchlistplugin/0.12/tools/uninstall.py Direct download] ] 80 The plugin itself can be uninstalled by removing the Python egg file. 81 81 82 82 ==== Usage … … 88 88 ==== Optional arguments 89 89 90 `<tables>` stands for a comma-separated list of one or more of the DBtables `watchlist`, `watchlist_settings` and `system`. The first two are database tables created by the plugin, while the last holds the watchlist version.90 `<tables>` stands for a comma-separated list of one or more of the database tables `watchlist`, `watchlist_settings` and `system`. The first two are database tables created by the plugin, while the last holds the watchlist version. 91 91 Only the given tables are deleted: the `system` table is not deleted of course, only the `watchlist_version` entry is removed. By default all three tables are affected. 92 92 … … 95 95 === Rename user names 96 96 97 A [source:watchlistplugin/dev/tools/rename_user.py script] is provided to rename a user in the DB tables created by the plugin. [ [http://trac-hacks.org/export/latest/watchlistplugin/dev/tools/rename_user.py Direct Download] ]97 A [source:watchlistplugin/dev/tools/rename_user.py script] is provided to rename a user in the database tables created by the plugin. [ [http://trac-hacks.org/export/latest/watchlistplugin/dev/tools/rename_user.py Direct download] ] 98 98 Please note that no other tables or settings are affected. Renaming to an already existing username will result in an error if both watchlists share identical content. 99 99 … … 106 106 == Using it together with the AnnouncerPlugin ==#AnnouncerPlugin 107 107 108 If the AnnouncerPlugin is used to receive change notifications the watchlist allows the user to easily change notification setting of watched wiki s and tickets.109 If this feature (#4744) is enabled, an extra column appears in the watchlist which informs the user about the current setting (On/Off) and allows him/her to change it.110 Watching and notifications can be independent, i .e.users can have themselves notified about changes of a wiki page which is not on their watchlist or vice versa, but can also be linked together as shown below.108 If the AnnouncerPlugin is used to receive change notifications the watchlist allows the user to easily change notification setting of watched wiki pages and tickets. 109 If this feature (#4744) is enabled, an extra column appears in the watchlist, which informs the user about the current setting (On/Off) and allows him/her to change it. 110 Watching and notifications can be independent, ie users can have themselves notified about changes of a wiki page which is not on their watchlist or vice versa, but can also be linked together as shown below. 111 111 112 112 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`):