Added CCCD

[git.ikiwiki.info.git] / doc / plugins / conditional.mdwn

diff --git a/doc/plugins/conditional.mdwn b/doc/plugins/conditional.mdwn
index a8dd215898e1dd24eca087e4a94dd67c22522885..5793cb30e61cd7dd92f736fff78f6948c7c45328 100644 (file)
--- a/doc/plugins/conditional.mdwn
+++ b/doc/plugins/conditional.mdwn
@@ -1,10 +1,10 @@
-[[template id=plugin name=conditional core=1 author="[[Joey]]"]]
-[[tag type/format]]
+[[!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:
 
 
 With this plugin, you can make text be conditionally displayed on a page.
 For example:
 

-       \[[if test="enabled(smiley)"
+       \[[!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.."]]
 


@@ -15,10 +15,16 @@ The `then` and `else` values can include any markup that would be allowed
 in the wiki page outside the template. Triple-quoting the values even allows
 quotes to be included.
 
 in the wiki page outside the template. Triple-quoting the values even allows
 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
+The `test` is a [[ikiwiki/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.
+
+If you want the [[ikiwiki/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 [[ikiwiki/PageSpec]] syntax is expanded with the following

 additional tests:
 
 * enabled(plugin)
 additional tests:
 
 * enabled(plugin)