diff options
author | Joey Hess <joey@kodama.kitenet.net> | 2008-09-11 18:41:26 -0400 |
---|---|---|
committer | Joey Hess <joey@kodama.kitenet.net> | 2008-09-11 18:41:26 -0400 |
commit | 9921a4a8a1a696ce69acce5e14943f0149d926ff (patch) | |
tree | 926ebf50f913087a99c05993a3b01e2d935c9878 /doc/ikiwiki/directive/if.mdwn | |
parent | 7d98c3d52bcdf2a3010843d176bf9fd79643207b (diff) |
Move the directive documentation into its own underlay, separate from basewiki, since it's sorta large compared to the rest of basewiki.
Diffstat (limited to 'doc/ikiwiki/directive/if.mdwn')
-rw-r--r-- | doc/ikiwiki/directive/if.mdwn | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/doc/ikiwiki/directive/if.mdwn b/doc/ikiwiki/directive/if.mdwn new file mode 100644 index 000000000..d6419b18b --- /dev/null +++ b/doc/ikiwiki/directive/if.mdwn @@ -0,0 +1,48 @@ +The `if` directive is supplied by the [[!iki plugins/conditional]] plugin. + +With this directive, 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 [[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) + + 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. + +[[!meta robots="noindex, follow"]] |