X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/479c7a1ea62d8fce3ef54f9deae89230d0b52a5d..84e6c4fa665703133b5778e92c045897df496e97:/doc/plugins/conditional.mdwn?ds=sidebyside diff --git a/doc/plugins/conditional.mdwn b/doc/plugins/conditional.mdwn index f3398af57..7a230fbae 100644 --- a/doc/plugins/conditional.mdwn +++ b/doc/plugins/conditional.mdwn @@ -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. @@ -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)