README
1====== User Subscriptions Plugin for DokuWiki ======
2
3Use :
4 <usersubscriptions * /> (lists all of the user subscriptions)
5 <usersubscriptions /> (lists all of the user subscriptions for the current namespace)
6 <usersubscriptions . /> (same as above)
7 <usersubscriptions ns1:ns2 /> (lists all of the user subscriptions for the namespace ns1:ns2)
8
9 add the r=<depth> (no value, ie r or r=, means infinite) option to make listing recursive,
10 ie : <usersubscriptions ns1:ns2 r=2 />, to use it with the current namespace use <usersubscriptions . r=<depth> />,
11
12 add the deletelink option to display subscription cancel link, ie : <usersubscriptions ns1:ns2 deletelink />, to use it
13 with the current namespace use <usersubscriptions . deletelink />,
14
15 add the quicksubscribe option to display quick subscription form, ie : <usersubscriptions ns1:ns2 quicksubscribe />, to use it
16 with the current namespace use <usersubscriptions . quicksubscribe />,
17
18 add the displayinheritedsubscriptions option to display items that are subscribed due to subscription to a parent namespace,
19 ie : <usersubscriptions ns1:ns2 quicksubscribe />, to use it with the current namespace use
20 <usersubscriptions . displayinheritedsubscriptions />,
21
22 these options can be chained like <usersubscriptions ns deletelink r=3 quicksubscribe displayinheritedsubscriptions/>,
23 they can be written in uppercase.
24
25All documentation for the User Subscriptions Plugin is available online at:
26http://wiki.splitbrain.org/plugin:usersubscriptions
27
28(c) 2009 by Etienne Meleard <etienne.meleard@free.fr>
29See COPYING for license info.
30