xref: /plugin/condition/README.md (revision 09b43617b7cf414344497ee7ebf8cd1b31efdab4)
1====== Condition Plugin for DokuWiki ======
2
3Use :
4
5	<if [condition_list]>doku code</if>
6	or <if [condition_list]>doku code<else>doku code</if>
7
8	[condition_list] is a set of [condition] records separated by logical operators (&&, and, ||, or, ^, xor for now), use of parenthesis is allowed, negation is achieved by using heading ! (ex !foo=bar or !(a=b || c<d) )
9
10	[condition] is formed from a [key], followed by an [operator] (optionnal) and then a [value] (optionnal)
11
12	[key] is in the list (defined in base_tester.php as of 2009/06/10) :
13		- user : refers to the user "login" (like in $_SERVER['REMOTE_USER'])
14		- group : refers to the user group-set
15		- nsread : refers to the ability of the user to read a namespace
16		- nsedit : refers to the ability of the user to edit a namespace
17		- IP : refers to the client's IP address
18
19	[operator] signification is [key] dependent, for example :
20		- = (==) : equality, membership, read/edit ability on ...
21		- != : non-equality, non-member, no read/edit ability on ...
22		- ...
23		(browse base_tester.php for test_* methods for more information)
24
25	[value] can be a string (whitespace, ) and > free) or a " delimited string (whitespaces, ) and > are then allowed)
26
27All documentation for the User Subscriptions Plugin is available online at:
28http://wiki.splitbrain.org/plugin:condition
29
30(c) 2009 by Etienne Meleard <etienne.meleard@free.fr>, (c) 2013 by Gerry Weißbach <gweissbach@inetsoftware.de> See COPYING for license info.
31