releasing version 2.31.1

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

diff --git a/doc/plugins/conditional.mdwn b/doc/plugins/conditional.mdwn
index 42eb4e62dd09471cf4f19b59d0b787f53502b40b..7a230fbae3e7a0aa187977814567a027cfc2260c 100644 (file)
--- a/doc/plugins/conditional.mdwn
+++ b/doc/plugins/conditional.mdwn
@@ -5,8 +5,8 @@ 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.
@@ -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.
 
-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)