From version 169.1
edited by Thomas Mortagne
on 2017/03/28 15:10
To version 170.1
edited by Guillaume Delhumeau
on 2018/01/23 13:12
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -xwiki:XWiki.ThomasMortagne
1 +xwiki:XWiki.gdelhumeau
ExtensionCode.ExtensionClass[0]
Is allowed namespaces empty
... ... @@ -1,0 +1,1 @@
1 +No
Description
... ... @@ -42,7 +42,7 @@
42 42  * Password (optional)
43 43  * JavaMail properties (optional)
44 44  
45 -For more details about configuring authentication for SMTP you can check out the [[Administration Guide>>platform:AdminGuide.Configuration||anchor=HConfiguringtheSMTPserver]].
45 +For more details about configuring authentication for SMTP you can check out the [[Administration Guide>>platform:AdminGuide.Configuration||anchor="HConfiguringtheSMTPserver"]].
46 46  
47 47  Once you have configured the SMTP settings your users can start watching pages, spaces or even the whole wiki. They will receive an e-mail summing up changes.
48 48  
... ... @@ -50,9 +50,11 @@
50 50  
51 51  The e-mail is send to the e-mail-address users set up in their profile. If a single user prefers not to get e-mail notificationm, the e-mail-address can be left empty, or the notification frequency set to //never// by chosing the empty notifier (see next section).
52 52  
53 +
53 53  == Setting the email delay ==
54 54  
55 55  Depending on your preferences, you can set the email //frequency// to:
57 +
56 56  * Realtime (since 7.0RC1)
57 57  * One hour
58 58  * One day
... ... @@ -59,6 +59,7 @@
59 59  * One week
60 60  
61 61  To change the frequency follow these steps:
64 +
62 62  * Hover over "Profile"
63 63  * Click "Watchlist"
64 64  * Click on the //small pencil// icon located to the right of the "Watchlist Preferences" section
... ... @@ -157,7 +157,7 @@
157 157  
158 158  When multiple realtime notification emails are received regarding the same document, they will be threaded/grouped by document by the email client:
159 159  
160 -{{image reference="watchlistRealtimeChangesMailConversation.png" /}}
163 +{{image reference="watchlistRealtimeChangesMailConversation.png"/}}
161 161  
162 162  ==== Multiple XWiki instances on the same machine ====
163 163  
... ... @@ -168,6 +168,7 @@
168 168  == Administrators: Customizing the WatchList email template ==
169 169  
170 170  The template used for watchlist email notifications is customizable. It is stored in an //XWiki.Mail// object inside the page:
174 +
171 171  * //XWiki.WatchListMessage// for scheduled notifications (i.e. hourly, daily, weekly)
172 172  * //XWiki.WatchListRealtimeMessage// for realtime notifications
173 173  
... ... @@ -179,6 +179,7 @@
179 179  * HTML: the content of the mail when the mail client displays the mail as HTML
180 180  
181 181  When customizing a watchlist message template, you will be writing Velocity code and, in addition to the standard bindings (XWiki API, Script Services, Velocity Tools, etc.), you will also have access to the following WatchList specific bindings:
186 +
182 182  |=Binding|=Data Type|=Notes
183 183  |**previousFireTime**|Date|The last time the current notification was triggered and delivered to the subscribers.
184 184  |**events**|List of [[WatchListEvent>>https://github.com/xwiki/xwiki-platform/blob/master/xwiki-platform-core/xwiki-platform-watchlist/xwiki-platform-watchlist-api/src/main/java/org/xwiki/watchlist/internal/api/WatchListEvent.java]]|One event per modified document. For Realtime notifications, there will always be 1 event to display, while for Scheduled notifications there can be more than 1.
... ... @@ -208,6 +208,20 @@
208 208  {{watchlist/}}
209 209  {{/code}}
210 210  
211 -If e.g. the watchlist macro is used on the dashboard for the main page, users can see the pages they watch directly after login (((
216 +If e.g. the watchlist macro is used on the dashboard for the main page, users can see the pages they watch directly after login
217 +
218 +(((
212 212  {{image reference="watchlistmacro"/}}
213 213  )))
221 +
222 +== Disabling the application ==
223 +
224 +{{info}}Since 9.11.2 and 10.0RC1{{/info}}, you can disable the application without uninstalling it. All you need to do is to edit the file ##xwiki.properties## and to change the following lines:
225 +
226 +{{code language="cfg"}}
227 +#-# [Since 10.0RC1]
228 +#-# [Since 9.11.2]
229 +#-# Controls if the notifications feature is enabled. Default value is true.
230 +#-# Thanks to this option, you can disable the application without uninstalling it.
231 +watchlist.enabled = false
232 +{{/code}}
Recommended
... ... @@ -1,0 +1,1 @@
1 +No
Show installed count
... ... @@ -1,0 +1,1 @@
1 +Yes

Get Connected