TWiki/IfStatements.mdwn

   1 # <a name="=IF= Statements"></a> `IF` Statements
   2
   3 The `%IF%` construct gives TWiki the power to include content in topics based on the value of simple expressions.
   4
   5 `%IF{"CONDITION" then="THEN" else="ELSE"}%`
   6
   7 In the example above, if CONDITION evaluates to TRUE, then THEN will be included in the topic; otherwise ELSE will be included.
   8
   9 What can be included in the THEN and ELSE parameters is obviously limited by standard TWiki syntax for parameters.
  10
  11 The basic syntax of a condition is as follows:
  12
  13     expr ::= '(' expr ')' ;
  14     expr ::= andexpr | andexpr 'or' expr ;
  15     andexpr ::= notexpr | notexpr 'and' andexpr ;
  16     notexpr ::= basexpr | 'not' baseexpr ;
  17     basexpr ::= atom | uop atom | atom bop basexpr ;
  18     uop ::= 'context' | 'defined' | '$' ;
  19     bop ::= '=' | '!=' | '>' | '<' | '>=' | '<=' ;
  20     atom ::= context identifier, TWiki variable name, single-quoted string, or configuration item
  21 <table border="1" cellpadding="0" cellspacing="0">
  22   <tr>
  23     <th bgcolor="#99CCCC" colspan="2"><strong> Operators </strong></th>
  24   </tr>
  25   <tr>
  26     <td> and </td>
  27     <td> True if both sides are true </td>
  28   </tr>
  29   <tr>
  30     <td> or </td>
  31     <td> True if one or other side is true </td>
  32   </tr>
  33   <tr>
  34     <td> not </td>
  35     <td> negate the following expression </td>
  36   </tr>
  37   <tr>
  38     <td> =, != </td>
  39     <td> String comparison </td>
  40   </tr>
  41   <tr>
  42     <td> &lt;, &gt;, &lt;=, &gt;= </td>
  43     <td> Number comparison (there is no explicit numeric =) </td>
  44   </tr>
  45   <tr>
  46     <td> context </td>
  47     <td> True if the current context is set (see below) </td>
  48   </tr>
  49   <tr>
  50     <td> defined </td>
  51     <td> True if a preference variable or url parameter of this name is defined. </td>
  52   </tr>
  53   <tr>
  54     <td> $ </td>
  55     <td> expands a URL parameter or [[Main/TWikiVariables]]. Plugin handlers <strong>are not called</strong>. Built-in variables and user-defined preferences are supported. You can pass a limited subset of parameters to TWiki variables by enclosing the variable name in single quotes; for example, <code>$ 'VARIABLE{value}'</code>. The <code>'VARIABLE{value}'</code> string may <strong>not</strong> contain quotes (' or "). </td>
  56   </tr>
  57 </table>
  58
  59 examples:
  60
  61     TWiki variable defined or not
  62     %IF{"defined WIKINAME" then="WIKINAME is defined" else="WIKINAME is not defined"}%
  63
  64     You are %IF{ "$ WIKINAME='TWikiGuest' and not defined OPEN_DAY" then="not" }% allowed to
  65     %IF{ "context view" then="view" else="edit"}% this TWiki today.
  66
  67     URL parameter
  68     %IF{ "defined search" then="Search: %URLPARAM{search}%" else="No search passed in"}%
  69
  70     Configuration item set or not
  71     %IF{ "{AntiSpam}{HideUserDetails}" then="User details are hidden" }%
  72
  73     url param t is %IF{ "0 < $ t and $ t < 1000" then="in" else="out of"}% range.
  74
  75     Text comparison
  76     %IF{ "$'URLPARAM{scope}'='text'" then="Plain text search" }%
  77
  78 **Configuration items** are defined in [configure](http://www.dementia.org/twiki/configure). You cannot see the value of a configuration item, you can only see if the item is set or not.
  79
  80 **Context identifiers** are used in TWiki to label various stages of the rendering process. They are especially useful for [[skin|Main/TWikiSkins]] authors to find out where they are in the rendering process. The following context identifiers are available:
  81
  82 <table border="1" cellpadding="0" cellspacing="0">
  83   <tr>
  84     <th bgcolor="#99CCCC"><strong> id </strong></th>
  85     <th bgcolor="#99CCCC"><strong> context </strong></th>
  86   </tr>
  87   <tr>
  88     <td> absolute_urls </td>
  89     <td> Set if absolute URLs are required </td>
  90   </tr>
  91   <tr>
  92     <td> authenticated </td>
  93     <td> a user is authenticated </td>
  94   </tr>
  95   <tr>
  96     <td> body_text </td>
  97     <td> when the body text is being processed in a view (useful in plugin handlers) </td>
  98   </tr>
  99   <tr>
 100     <td> can_login </td>
 101     <td> current environment supports login </td>
 102   </tr>
 103   <tr>
 104     <td> changes </td>
 105     <td> in changes script (see [[Main/TWikiScripts]]) </td>
 106   </tr>
 107   <tr>
 108     <td> command_line </td>
 109     <td> the running script was run from the command line, and not from CGI </td>
 110   </tr>
 111   <tr>
 112     <td> diff </td>
 113     <td> in rdiff script (see [[Main/TWikiScripts]]) </td>
 114   </tr>
 115   <tr>
 116     <td> edit </td>
 117     <td> in edit script (see [[Main/TWikiScripts]]) </td>
 118   </tr>
 119   <tr>
 120     <td> footer_text </td>
 121     <td> when the footer text is being processed in a view (useful in plugin handlers) </td>
 122   </tr>
 123   <tr>
 124     <td> header_text </td>
 125     <td> when the header text is being processed in a view (useful in plugin handlers) </td>
 126   </tr>
 127   <tr>
 128     <td> i18n_enabled </td>
 129     <td> when user interface I18N support is enabled (i.e., user can choose the language for UI) </td>
 130   </tr>
 131   <tr>
 132     <td> inactive </td>
 133     <td> if active links such as 'edit' and 'attach' should be disabled </td>
 134   </tr>
 135   <tr>
 136     <td> mirror </td>
 137     <td> if this is a mirror </td>
 138   </tr>
 139   <tr>
 140     <td> new_topic </td>
 141     <td> if the topic doesn't already exist </td>
 142   </tr>
 143   <tr>
 144     <td> oops </td>
 145     <td> in oops script (see [[Main/TWikiScripts]]) </td>
 146   </tr>
 147   <tr>
 148     <td> preview </td>
 149     <td> in preview script (see [[Main/TWikiScripts]]) </td>
 150   </tr>
 151   <tr>
 152     <td> rss </td>
 153     <td> if this is an RSS skin rendering </td>
 154   </tr>
 155   <tr>
 156     <td> save </td>
 157     <td> in save script (see [[Main/TWikiScripts]]) </td>
 158   </tr>
 159   <tr>
 160     <td> search </td>
 161     <td> in search script (see [[Main/TWikiScripts]]) </td>
 162   </tr>
 163   <tr>
 164     <td> view </td>
 165     <td> in view script (see [[Main/TWikiScripts]]) </td>
 166   </tr>
 167   <tr>
 168     <td> rest </td>
 169     <td> in rest script (see [[Main/TWikiScripts]]) </td>
 170   </tr>
 171 </table>
 172
 173 In addition there is a context identifier for each enabled plugin; for example, if `GallousBreeksPlugin` is installed **and enabled**, then the context ID `GallousBreeksPluginEnabled` will be set. Other extensions may set additional context identifiers.
 174
 175 The `%IF%` statement is deliberately kept simple. In particular, note that there is no way to conditionally execute a Set statement. If you need more sophisticated control over formatting, then consider using the [[SpreadSheetPlugin]].