Changes between Version 49 and Version 50 of WatchlistPlugin


Ignore:
Timestamp:
Nov 18, 2015, 11:52:50 AM (8 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • WatchlistPlugin

    v49 v50  
    55== Description
    66
    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.
     7This 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.
    88
    99To insert a watchlist style table into wikis use the ListOfWikiPagesMacro.
     
    2929The release files are also available on the [pypi:TracWatchlistPlugin/ Python Package Index].
    3030
    31 Download the zipped source of the develop version from [download:watchlistplugin here].
     31Download the zipped source of the develop version from [export:watchlistplugin here].
    3232
    3333== Source
    3434
    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.
     35You 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.
    3636
    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.
     37The 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.
    3838
    39 A normal check-out is done using:
     39A normal check-out is done as follows:
    4040{{{#!sh
    41 svn co http://trac-hacks.org/svn/watchlistplugin/<trac version> watchlistplugin
     41svn co https://trac-hacks.org/svn/watchlistplugin/<trac version> watchlistplugin
    4242}}}
    4343
    44 To export the sources replace the above `co` with `export`.
     44To export the sources, replace `co` with `export` in the line above.
    4545
    4646Note that 0.11 is currently just a symbolic link to 0.12 because this version is also compatible with Trac 0.11.
     
    6464=== Enable Plugin
    6565
    66 Enable the plugin in the `trac.ini` config file (or over WebAdminPlugin):
     66Enable the plugin in the `trac.ini` configuration file (or over WebAdminPlugin):
    6767{{{#!ini
    6868[components]
     
    7777=== Uninstall Plugin
    7878
    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.
     79An [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] ]
     80The plugin itself can be uninstalled by removing the Python egg file.
    8181
    8282==== Usage
     
    8888==== Optional arguments
    8989
    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 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.
    9191Only 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.
    9292
     
    9595=== Rename user names
    9696
    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] ]
     97A [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] ]
    9898Please 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.
    9999
     
    106106== Using it together with the AnnouncerPlugin ==#AnnouncerPlugin
    107107
    108 If the AnnouncerPlugin is used to receive change notifications the watchlist allows the user to easily change notification setting of watched wikis 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.
     108If the AnnouncerPlugin is used to receive change notifications the watchlist allows the user to easily change notification setting of watched wiki pages and tickets.
     109If 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.
     110Watching 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.
    111111
    112112To 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`):