]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/plugins/conditional.mdwn
oh, we don't use comments here, do we?
[git.ikiwiki.info.git] / doc / plugins / conditional.mdwn
index ba1cf9bb2f39137e8ab164dd2b21b1d17af5c815..27a99bb7cc0ce0ab77973077c8f05822cfcf7d97 100644 (file)
@@ -1,47 +1,5 @@
-[[template id=plugin name=conditional core=1 author="[[Joey]]"]]
-[[tag type/format]]
+[[!template id=plugin name=conditional core=1 author="[[Joey]]"]]
+[[!tag type/special-purpose]]
 
-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.."]]
-
-If the specified `test` succeeds, the `then` text will be displayed,
-otherwise the `else` text will be displayed. The `else` part is optional.
-
-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.
-
-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)
-
-  Tests whether the specified plugin is enabled.
-
-* sourcepage(glob)
-
-  Tests whether the glob matches the name of the page that contains the
-  conditional.
-
-* destpage(glob)
-
-  Tests whether the glob matches the name of the page that is being built.
-  That might be different than the name of the page that contains the
-  conditional, if it's being inlined into another page.
-
-* included()
-
-  Tests whether the page is being included onto another page.
+This plugin provides the [[ikiwiki/directive/if]] [[ikiwiki/directive]].
+With this directive, you can make text be conditionally displayed on a page.