[TWiki-Dev] [SVN] PeterThoeny r25215 - twiki/branches/TWikiRelease05x01/WatchlistPlugin/data/TWiki

[<de...@de...>]

Author: PeterThoeny
Date: 2013-02-27 02:08:18 -0600 (Wed, 27 Feb 2013)
New Revision: 25215
Trac url: http://develop.twiki.org/trac/changeset/25215

Modified:
   twiki/branches/TWikiRelease05x01/WatchlistPlugin/data/TWiki/WatchlistPlugin.txt
Log:
Item7143: Initial version of WatchlistPlugin - preliminary documentation of configuration

Modified: twiki/branches/TWikiRelease05x01/WatchlistPlugin/data/TWiki/WatchlistPlugin.txt
===================================================================
--- twiki/branches/TWikiRelease05x01/WatchlistPlugin/data/TWiki/WatchlistPlugin.txt	2013-02-27 08:08:09 UTC (rev 25214)
+++ twiki/branches/TWikiRelease05x01/WatchlistPlugin/data/TWiki/WatchlistPlugin.txt	2013-02-27 08:08:18 UTC (rev 25215)
@@ -1,6 +1,38 @@
-%META:TOPICINFO{author="TWikiContributor" date="1361757725" format="1.1" version="$Rev$"}%
+%META:TOPICINFO{author="TWikiContributor" date="1361952336" format="1.1" version="$Rev$"}%
 ---+ Watchlist Plugin
 
 %ICON{wip}% To be documented
 
+---++ Configuration
+
+__1. Add a "Watch" pulldown menu:__
+
+To show a "Watch" pulldown menu next to the "Edit" pulldown, upgrade the %SYSTEMWEB%.TopMenuSkin to version 2013-02-26 or later, or add the following to %SYSTEMWEB%.TopMenuSkinTopicMenu just before the =%<nop>STOPINCLUDE%=:
+<verbatim>
+%IF{
+ "context WatchlistPluginEnabled AND context authenticated"
+ then="   * $percntWATCHLIST{ \"showlink\" format=\"<a href='$url' title='$watch this topic'>$watch %ICON{ "menu-down" format="<img src='$urlpath' width='$width' height='$height' border='0' alt='' />" }%</a>\" }$percnt
+      * %IF{
+          "istopic '%USERSWEB%.%WIKINAME%Watchlist'"
+          then="[[%USERSWEB%.%WIKINAME%Watchlist][Watchlist Changes]]"
+          else="[[%SCRIPTURL{viewauth}%/%USERSWEB%/%WIKINAME%Watchlist?createifnotexist=1&amp;templatetopic=%SYSTEMWEB%.WatchlistTemplate&amp;topicparent=%WIKINAME%][Watchlist Changes]]"
+        }%"
+ else="<nop>"
+}%
+</verbatim>
+
+__2. Add a "Watch" link to the topic action row:__
+
+To add a "Watch" link to the bottom topic action row, edit =templates/viewtopicactionbuttons.tmpl= and make the following two modifications.
+
+1. In template definition =%<nop>TMPL:DEF{"topicactionbuttons"}%=, add =%<nop>TMPL:P{"action_watch"}%= before =%<nop>TMPL:P{"action_printable"}%=.
+
+2. Add the following two template definitions:
+
+<verbatim>
+%TMPL:DEF{"action_watch"}%%TMPL:P{context="WatchlistPluginEnabled" then="watch_link" else=""}%%TMPL:END%
+
+%TMPL:DEF{"watch_link"}%<span>%IF{ "context authenticated" then="$percntWATCHLIST{showlink}$percnt" else="<strike>Watch</strike>" }%</span>%TMPL:P{"sep"}%%TMPL:END%
+</verbatim>
+
 __Related:__ WatchlistTemplate