]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/plugins/conditional.mdwn
web commit by http://ptecza.myopenid.com/: * Added forgotten signature
[ikiwiki.git] / doc / plugins / conditional.mdwn
index f3398af573d58d27d79f8fbc38e8bc636aabd2b1..ba1cf9bb2f39137e8ab164dd2b21b1d17af5c815 100644 (file)
@@ -1,12 +1,12 @@
-[[template id=plugin name=conditional core=1 included=1 author="[[Joey]]"]]
+[[template id=plugin name=conditional core=1 author="[[Joey]]"]]
 [[tag type/format]]
 
 With this plugin, you can make text be conditionally displayed on a page.
 For example:
 
        \[[if test="enabled(smiley)"
-       then="The smiley plugin is enabled :-)"
-       else="No smiley plugin here.."]]
+             then="The smiley plugin is enabled :-)"
+             else="No smiley plugin here.."]]
 
 If the specified `test` succeeds, the `then` text will be displayed,
 otherwise the `else` text will be displayed. The `else` part is optional.
@@ -18,8 +18,14 @@ quotes to be included.
 The `test` is a [[PageSpec]]; if it matches any page in the wiki then it
 succeeds. So you can do things like testing for the existence of a page or
 pages, testing to see if any pages were created in a given month, and so
-on. The regular [[PageSpec]] syntax is expanded with the following
-additional tests:
+on.
+
+If you want the [[PageSpec]] to only match against the page that
+contains the conditional, rather than matching against all pages in the
+wiki, set the "all" parameter to "no".
+
+The regular [[PageSpec]] syntax is expanded with the following additional
+tests:
 
 * enabled(plugin)