Changes between Version 47 and Version 48 of WatchlistPlugin
- Timestamp:
- Jun 3, 2015, 12:49:26 PM (9 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
WatchlistPlugin
v47 v48 1 1 [[PageOutline(2-5,Contents,pullout)]] 2 2 3 {{{ 4 #!NewsFlash 5 11th Mar 2012:: Develop version released as v1.0 for Trac 0.12, backwards-compatible with Trac 0.11. 3 = Watchlist for Wikis and Tickets 6 4 7 26rd Sep 2010:: The [source:watchlistplugin/dev dev] branch got tested for PostgresSQL and MySQL backends. The DB schema is now stable for the next release. Feel free to test it out. 8 23rd Sep 2010:: Feature freeze for upcoming release. 9 15th Sep 2010:: 10 * '''Warning:''' The DB schema in the `dev` branch is currently under development. Do not use this version for anything else than testing and be ready to loose all your watchlist data. 11 9th Sep 2010:: 12 * [source:watchlistplugin/dev@8724 dev] branch is now [8724] again compatible with Trac 0.11 (and of course with Trac 0.12). 13 Fall-back functions (No-Ops) are provided for all Trac 0.12 functions. 14 7th Sep 2010:: 15 * Autocomplete of ''add'' and ''remove'' fields. This uses the [http://docs.jquery.com/Plugins/Autocomplete jQuery autocomplete library]. 16 * The javascript library [http://www.datatables.net/ dataTables] is now used for dynamic user interaction (sorting, state saving, etc.) on the watchlist tables. 17 * Both above features are now optional, i.e. can be disabled by the trac admin to lower the amount of code loaded. 18 30th Aug 2010:: 19 * `i18n` branch is updated to a preliminary version with i18n almost finished. Tested with German translations and Trac 0.12-[t:changeset:9990 r9990]. Soon we'll publish message catalogs at Transifex as well. 5 == Description 20 6 21 27th Aug 2010:: 22 * The `dev` branch is now for Trac 0.12. 23 * Internationalization/localization support is currently implemented by [wiki:hasienda]. 24 25 30th May 2010:: 26 The `dev` branch (for Trac 0.11) now supports the following features: 27 * API for extensions to allow watching of content generated by other plugins. 28 * Allow users to use wildcards in wiki/ticket add input field, e.g. "`Trac*`" should add all wikis starting with `Trac`. 29 * "Delete Wiki/Ticket" input field on watchlist. 30 * Unwatch and Notify On/Off buttons in the watchlist are now handled dynamically using jQuery Ajax. The watchlist is not reloaded for every change. 31 32 28th Oct 2009:: 33 Watchlist tables are now ([6910],[6913]) dynamically sortable using the [http://tablesorter.com/docs/ jquery table sorter javascript library] and its tablesorter pagination plugin. 34 35 36 '''Features in Planning''' 37 * User specific settings with settings on watchlist page: 38 * Redirect setting (Go to watchlist or to watched page?) 39 * Notification settings (auto-notify-on etc.) 40 * Maybe control over watchlist table content. 41 }}} 42 43 = Watchlist for Wikis and Tickets = 44 45 == Description == 46 47 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. 7 This plugin 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. 48 8 49 9 To insert a watchlist style table into wikis use the ListOfWikiPagesMacro. 50 10 51 A special [source:watchlistplugin/0.1 1/tracwatchlist/watchlist_report.sql ticket report] which only shows watched tickets is also provided.11 A special [source:watchlistplugin/0.12/tracwatchlist/watchlist_report.sql ticket report] which only shows watched tickets is also provided. 52 12 13 == Bugs/Feature Requests 53 14 54 == Download == 15 Existing bugs and feature requests for WatchlistPlugin are 16 [report:9?COMPONENT=WatchlistPlugin here]. 17 18 If you have any issues, create a 19 [/newticket?component=WatchlistPlugin new ticket]. 20 21 [[TicketQuery(component=WatchlistPlugin&group=type,format=progress)]] 22 23 == Download 55 24 56 25 The official releases can be downloaded from [/svn/watchlistplugin/releases here] … … 62 31 Download the zipped source of the develop version from [download:watchlistplugin here]. 63 32 64 == Source ==33 == Source 65 34 66 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. 36 67 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. 68 38 69 39 A normal check-out is done using: 70 {{{ 71 #!sh 40 {{{#!sh 72 41 svn co http://trac-hacks.org/svn/watchlistplugin/<trac version> watchlistplugin 73 42 }}} 43 74 44 To export the sources replace the above `co` with `export`. 75 45 76 46 Note that 0.11 is currently just a symbolic link to 0.12 because this version is also compatible with Trac 0.11. 77 47 78 == Installation == 48 == Installation 49 79 50 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. 80 51 81 === Official Releases ===82 {{{ 83 #!sh52 === Official Releases 53 54 {{{#!sh 84 55 easy_install TracWatchlistPlugin 85 56 }}} 86 57 87 === Source Versions ===88 {{{ 89 #!sh58 === Source Versions 59 60 {{{#!sh 90 61 easy_install http://trac-hacks.org/svn/watchlistplugin/0.12 91 62 }}} 92 63 93 === Enable Plugin === 64 === Enable Plugin 65 94 66 Enable the plugin in the `trac.ini` config file (or over WebAdminPlugin): 95 {{{ 96 #!ini 67 {{{#!ini 97 68 [components] 98 69 tracwatchlist.* = enabled … … 100 71 101 72 Then update your Trac database using: 102 {{{ 103 #!sh 73 {{{#!sh 104 74 trac-admin /path/to/trac/environment upgrade 105 75 }}} 106 76 107 === Uninstall Plugin === 77 === Uninstall Plugin 78 108 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] ] 109 80 The plugin itself can be uninstalled by removing the python egg file. 110 81 111 ==== Usage ====112 {{{ 113 #!sh82 ==== Usage 83 84 {{{#!sh 114 85 # python uninstall.py /path/to/trac/environment [-t <tables>] [-u <username>] 115 86 }}} 116 87 117 ==== Optional arguments ==== 88 ==== Optional arguments 89 118 90 `<tables>` stands for a comma-separated list of one or more of the DB tables `watchlist`, `watchlist_settings` and `system`. The first two are DB tables created by the plugin, while the last holds the watchlist version. 119 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. … … 121 93 The watchlist data of only a single user can be deleted using the `-u` option which takes the username as argument. 122 94 123 === Rename user names === 95 === Rename user names 96 124 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] ] 125 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. 126 99 127 ==== Usage ====128 {{{ 129 #!sh100 ==== Usage 101 102 {{{#!sh 130 103 # python rename_user.py /path/to/trac/environment <oldname> <newname> 131 104 }}} … … 138 111 139 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`): 140 {{{ 141 #!ini 113 {{{#!ini 142 114 [announcer] 143 115 # Rename announcers context navigation items (empty list removes them): … … 150 122 151 123 To enable notifications by default for all entries in the watchlist (see #6052) also add: 152 {{{ 153 #!ini 124 {{{#!ini 154 125 # still in [watchlist] 155 126 notify_by_default = true 156 127 }}} 157 128 158 == Configuration == 129 == Configuration 130 159 131 The following config file options are currently supported. Per-user configuration settings will be implemented soon. 160 132 The (legacy) default settings are shown. 161 {{{ 162 #!ini 133 {{{#!ini 163 134 [watchlist] 164 135 notifications = false # Notification support on/off, see above … … 173 144 }}} 174 145 175 176 == Watchlist Report == 146 === Watchlist Report 177 147 178 148 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 179 149 code for a manual installation can be taken from [source:watchlistplugin/0.11/tracwatchlist/watchlist_report.sql this file]. 180 150 181 == Usage ==151 === Usage 182 152 183 153 Browse any wiki or ticket and click ''Watch'' in the context navigation bar. … … 187 157 The watchlist will be displayed under the location `/watchlist`. Therefore it can be linked to from a wiki page using `[/watchlist]`. 188 158 159 == Screenshots 189 160 190 == Screenshots ==191 161 Navigation bar items for a unwatched wiki page: 192 162 … … 197 167 [[Image(watchlist.png)]] 198 168 199 200 == Bugs/Feature Requests == 201 202 Existing bugs and feature requests for WatchlistPlugin are 203 [report:9?COMPONENT=WatchlistPlugin here]. 204 205 If you have any issues, create a 206 [http://trac-hacks.org/newticket?component=WatchlistPlugin&owner=martin_s new ticket]. 207 208 == Recent Changes == 169 == Recent Changes 209 170 210 171 [[ChangeLog(watchlistplugin, 3)]] 211 172 212 == Author/Contributors ==173 == Author/Contributors 213 174 214 175 '''Author:''' [wiki:martin_s] [[BR]] 215 '''Maintainer:''' [ wiki:martin_s] [[BR]]176 '''Maintainer:''' [[Maintainer]] [[BR]] 216 177 '''Contributors:''' [wiki:hasienda] (i18n, German l10n)