TWiki/TWikiVariables.mdwn

   1 ## <a name="TWiki Variables"></a> TWiki Variables
   2
   3 ### <a name="Predefined Variables"></a> Predefined Variables
   4
   5 %WIKITOOLNAME% expands the following variables enclosed in % percent signs:
   6
   7 <table border="1">
   8   <tr>
   9     <th> Variable: </th>
  10     <th> Expanded to: </th>
  11   </tr>
  12   <tr>
  13     <td><code>%WIKIHOMEURL%</code></td>
  14     <td> The base script URL of %WIKITOOLNAME%, is the link of the Home icon in the upper left corner, is <b>%WIKIHOMEURL%</b></td>
  15   </tr>
  16   <tr>
  17     <td><code>%SCRIPTURL%</code></td>
  18     <td> The script URL of %WIKITOOLNAME%, is <b>http://www.dementia.org/twiki/</b></td>
  19   </tr>
  20   <tr>
  21     <td><code>%SCRIPTURLPATH%</code></td>
  22     <td> The path of the script URL of %WIKITOOLNAME%, is <b>http://www.dementia.org/twiki/</b></td>
  23   </tr>
  24   <tr>
  25     <td><code>%SCRIPTSUFFIX%</code></td>
  26     <td> The script suffix, i.e. <code>.pl</code>, is <b></b></td>
  27   </tr>
  28   <tr>
  29     <td><code>%PUBURL%</code></td>
  30     <td> The public URL of TWiki, is <b>http://www.dementia.org/twiki//view</b></td>
  31   </tr>
  32   <tr>
  33     <td><code>%PUBURLPATH%</code></td>
  34     <td> The path of the public URL of %WIKITOOLNAME%, is <b>http://www.dementia.org/twiki//view</b></td>
  35   </tr>
  36   <tr>
  37     <td><code>%ATTACHURL%</code></td>
  38     <td> The attachment URL of the current topic, is <b>http://www.dementia.org/twiki//view</b><br /> Example: If you attach a file you can refer to it as <code><b>%ATTACHURL%/image.gif</b></code></td>
  39   </tr>
  40   <tr>
  41     <td><code>%ATTACHURLPATH%</code></td>
  42     <td> The path of the attachment URL of the current topic, is <b>http://www.dementia.org/twiki//view</b></td>
  43   </tr>
  44   <tr>
  45     <td><code>%URLPARAM{"name"}%</code></td>
  46     <td> Returns the value of a URL parameter. I.e. <code>%URLPARAM{"skin"}%</code> returns <b>print</b> for a <code>.../view/%WEB%/%TOPIC%?skin=print</code> URL. Is <b></b></td>
  47   </tr>
  48   <tr>
  49     <td><code>%WIKITOOLNAME%</code></td>
  50     <td> Name of wiki tool, is <b>%WIKITOOLNAME%</b></td>
  51   </tr>
  52   <tr>
  53     <td><code>%WIKIVERSION%</code></td>
  54     <td> Wiki tool version, is <b>TWiki-4.1.2, Sat, 03 Mar 2007, build 13046</b></td>
  55   </tr>
  56   <tr>
  57     <td><code>%USERNAME%</code></td>
  58     <td> Your login username, is <b>admin</b></td>
  59   </tr>
  60   <tr>
  61     <td><code>%WIKIUSERNAME%</code></td>
  62     <td> Your Wiki username, if defined in [[Main/TWikiUsers]]. Same as %USERNAME% if not defined. Is <b>Main.admin</b></td>
  63   </tr>
  64   <tr>
  65     <td><code>%WEB%</code></td>
  66     <td> The current web, is <b>%WEB%</b></td>
  67   </tr>
  68   <tr>
  69     <td><code>%BASEWEB%</code></td>
  70     <td> The web name where the includes started, e.g. the web of the first topic of nested includes. Same as <code>%WEB%</code> in case there is no include. </td>
  71   </tr>
  72   <tr>
  73     <td><code>%INCLUDINGWEB%</code></td>
  74     <td> The web name of the topic that includes the current topic. Same as <code>%WEB%</code> in case there is no include. </td>
  75   </tr>
  76   <tr>
  77     <td><code>%TOPIC%</code></td>
  78     <td> The current topic name, is <b>%TOPIC%</b></td>
  79   </tr>
  80   <tr>
  81     <td><code>%BASETOPIC%</code></td>
  82     <td> The name of the topic where the includes started, e.g. the first topic of nested includes. Same as <code>%TOPIC%</code> in case there is no include. </td>
  83   </tr>
  84   <tr>
  85     <td><code>%INCLUDINGTOPIC%</code></td>
  86     <td> The name of the topic that includes the current topic. Same as <code>%TOPIC%</code> in case there is no include. </td>
  87   </tr>
  88   <tr>
  89     <td><code>%SPACEDTOPIC%</code></td>
  90     <td> The current topic name with added spaces, for regular expression search of Ref-By, is <b></b></td>
  91   </tr>
  92   <tr>
  93     <td><code>%GMTIME%</code></td>
  94     <td> GM time, is <b>29 Jun 2010 - 15:26</b></td>
  95   </tr>
  96   <tr>
  97     <td><code>%GMTIME{"format"}%</code></td>
  98     <td> Formatted GM time based on time variables. <table border="1" cellpadding="0" cellspacing="0">
  99         <tr>
 100           <th bgcolor="#99CCCC"><strong> Variable: </strong></th>
 101           <th bgcolor="#99CCCC"><strong> Unit: </strong></th>
 102           <th bgcolor="#99CCCC"><strong> Example </strong></th>
 103         </tr>
 104         <tr>
 105           <td> $seconds </td>
 106           <td> seconds </td>
 107           <td> 59 </td>
 108         </tr>
 109         <tr>
 110           <td> $minutes </td>
 111           <td> minutes </td>
 112           <td> 59 </td>
 113         </tr>
 114         <tr>
 115           <td> $hours </td>
 116           <td> hours </td>
 117           <td> 23 </td>
 118         </tr>
 119         <tr>
 120           <td> $day </td>
 121           <td> day of month </td>
 122           <td> 31 </td>
 123         </tr>
 124         <tr>
 125           <td> $month </td>
 126           <td> month in ISO format </td>
 127           <td> Dec </td>
 128         </tr>
 129         <tr>
 130           <td> $mo </td>
 131           <td> 2 digit month </td>
 132           <td> 12 </td>
 133         </tr>
 134         <tr>
 135           <td> $year </td>
 136           <td> 4 digit year </td>
 137           <td> 1999 </td>
 138         </tr>
 139         <tr>
 140           <td> $ye </td>
 141           <td> 2 digit year </td>
 142           <td> 99 </td>
 143         </tr>
 144       </table> Variables can be shortened to 3 characters. Example: <br /><code>%GMTIME{"$day $month, $year - $hour:$min:$sec"}%</code> is <br /><b>29 Jun, 2010 - 15:26:30</b></td>
 145   </tr>
 146   <tr>
 147     <td><code>%SERVERTIME%</code></td>
 148     <td> Server time, is <b>29 Jun 2010 - 11:26</b></td>
 149   </tr>
 150   <tr>
 151     <td><code>%SERVERTIME{"format"}%</code></td>
 152     <td> Formatted server time. <br /> Example: <code>%SERVERTIME{"$hou:$min"}%</code> is <b>11:26</b></td>
 153   </tr>
 154   <tr>
 155     <td><code>%HTTP_HOST%</code></td>
 156     <td> HTTP_HOST environment variable, is <b></b></td>
 157   </tr>
 158   <tr>
 159     <td><code>%REMOTE_ADDR%</code></td>
 160     <td> REMOTE_ADDR environment variable, is <b></b></td>
 161   </tr>
 162   <tr>
 163     <td><code>%REMOTE_PORT%</code></td>
 164     <td> REMOTE_PORT environment variable, is <b></b></td>
 165   </tr>
 166   <tr>
 167     <td><code>%REMOTE_USER%</code></td>
 168     <td> REMOTE_USER environment variable, is <b></b></td>
 169   </tr>
 170   <tr>
 171     <td><code>%INCLUDE{"SomeTopic"}%</code></td>
 172     <td> Server side include, includes another topic. The current Wiki web is searched by default. Example: <code><b>%INCLUDE{"TWiki.TWikiWebsTable"}%</b></code></td>
 173   </tr>
 174   <tr>
 175     <td><code>%STARTINCLUDE%</code></td>
 176     <td> If present in included topic, start to include text from this location up to the end, or up to the location of the <code>%STOPINCLUDE%</code> variable. A normal view of the topic shows everyting exept the <code>%STARTINCLUDE%</code> variable itself. </td>
 177   </tr>
 178   <tr>
 179     <td><code>%STOPINCLUDE%</code></td>
 180     <td> If present in included topic, stop to include text at this location and ignore the remaining text. A normal view of the topic shows everyting exept the <code>%STOPINCLUDE%</code> variable itself. </td>
 181   </tr>
 182   <tr>
 183     <td><code>%TOC%</code></td>
 184     <td> Table of Content of current topic. </td>
 185   </tr>
 186   <tr>
 187     <td><code>%TOC{"SomeTopic" ...}%</code></td>
 188     <td> Table of Content. Shows a TOC that is generated automatically based on headings of a topic. Headings in [[Main/WikiSyntax]] (<code>"---++ text"</code>) and HTML (<code>"&lt;h2&gt;text&lt;h2&gt;"</code>) are taken into account. Parameter is composed of the topic name, followed by optional <code>name="value"</code> pairs: <table border="1" cellpadding="0" cellspacing="0">
 189         <tr>
 190           <th bgcolor="#99CCCC"><strong> Pair: </strong></th>
 191           <th bgcolor="#99CCCC"><strong> Description: </strong></th>
 192           <th bgcolor="#99CCCC"><strong> Default: </strong></th>
 193         </tr>
 194         <tr>
 195           <td><code>web="Name"</code></td>
 196           <td> Name of web </td>
 197           <td> Current web </td>
 198         </tr>
 199         <tr>
 200           <td><code>depth="2"</code></td>
 201           <td> Limit depth of headings shown in TOC </td>
 202           <td> 6 </td>
 203         </tr>
 204       </table> Examples: <code><b>%TOC{depth="2"}%</b></code>, <code><b>%TOC{"TWikiDocumentation" web="TWiki"}%</b></code></td>
 205   </tr>
 206   <tr>
 207     <td><code>%SEARCH{"str" ...}%</code></td>
 208     <td> Inline search, shows a search result embedded in a topic. Parameter is composed of the search term (enclosed in double quotes), followed by optional <code>name="value"</code> pairs: [1] <table border="1" cellpadding="0" cellspacing="0">
 209         <tr>
 210           <th bgcolor="#99CCCC"><strong> Pair: </strong></th>
 211           <th bgcolor="#99CCCC"><strong> Description: </strong></th>
 212           <th bgcolor="#99CCCC"><strong> Default: </strong></th>
 213         </tr>
 214         <tr>
 215           <td><code>search="food"</code></td>
 216           <td> Search term, (either regex or literal, depending on the <code>regex</code> parameter) </td>
 217           <td> (used if initial search term is missing) </td>
 218         </tr>
 219         <tr>
 220           <td><code>web="Name"</code><br /><code>web="Main Know"</code><br /><code>web="all"</code></td>
 221           <td> Wiki web to search: A web, a list of webs separated by whitespace, or all webs <code>[2]</code></td>
 222           <td> Current web </td>
 223         </tr>
 224         <tr>
 225           <td><code>scope="topic"</code><br /><code>scope="text"</code></td>
 226           <td> Search topic name (title) or in the text (body) of the topic </td>
 227           <td> Topic text (body) </td>
 228         </tr>
 229         <tr>
 230           <td><code>order="topic"</code><br /><code>order="modified"</code><br /><code>order="editby"</code></td>
 231           <td> Sort the results of search by the topic names, last modified time, or last editor </td>
 232           <td> Sort by topic name </td>
 233         </tr>
 234         <tr>
 235           <td><code>limit="all"</code><br /><code>limit="16"</code></td>
 236           <td> Limit the number of results returned </td>
 237           <td> All results </td>
 238         </tr>
 239         <tr>
 240           <td><code>regex="on"</code></td>
 241           <td>[[Main/RegularExpression]] search </td>
 242           <td> Literal search </td>
 243         </tr>
 244         <tr>
 245           <td><code>reverse="on"</code></td>
 246           <td> Reverse the direction of the search </td>
 247           <td> Ascending search </td>
 248         </tr>
 249         <tr>
 250           <td><code>casesensitive="on"</code></td>
 251           <td> Case sensitive search </td>
 252           <td> Ignore case </td>
 253         </tr>
 254         <tr>
 255           <td><code>nosummary="on"</code></td>
 256           <td> Show topic title only </td>
 257           <td> Show topic summary </td>
 258         </tr>
 259         <tr>
 260           <td><code>bookview="on"</code></td>
 261           <td>[[Main/BookView]] search, e.g. show complete topic text </td>
 262           <td> Show topic summary </td>
 263         </tr>
 264         <tr>
 265           <td><code>nosearch="on"</code></td>
 266           <td> Suppress search string </td>
 267           <td> Show search string </td>
 268         </tr>
 269         <tr>
 270           <td><code>noheader="on"</code></td>
 271           <td> Suppress search header <br /><span style="background: #FFB0B0"> <strong>Topics: Changed: By:</strong> </span></td>
 272           <td> Show search header </td>
 273         </tr>
 274         <tr>
 275           <td><code>nototal="on"</code></td>
 276           <td> Do not show number of topics found </td>
 277           <td> Show number </td>
 278         </tr>
 279       </table> Example: <code><b>%SEARCH{"wiki" web="Main" scope="topic"}%</b></code></td>
 280   </tr>
 281   <tr>
 282     <td><code>%VAR{"NAME" web="Web"}%</code></td>
 283     <td> Get a preference value from a web other then the current one. Example: To get <code>%WEBBGCOLOR%</code> of the Main web write <code>%VAR{"WEBBGCOLOR" web="Main"}%</code>, is <code><b></b></code></td>
 284     <td>
 285       <p>
 286       </p>
 287     </td>
 288   </tr>
 289 </table>
 290
 291 [1] **_Note_**: The search form uses identical names for input fields.
 292
 293 [2] **_Note_**: A web can be excluded from a `web="all"` search if you define a `NOSEARCHALL=on` variable in its [[WebPreferences]].
 294
 295 ### <a name="Preferences Variables"></a> Preferences Variables
 296
 297 Additional variables are defined in the preferences ( site-level ( **_SL_** ) in [[TWikiPreferences]], web-level ( **_WL_** ) in [[WebPreferences]] of each web, and user level ( **_UL_** ) preferences in individual user topics):
 298
 299 <table border="1">
 300   <tr>
 301     <th> Variable: </th>
 302     <th> Level: </th>
 303     <th> What: </th>
 304   </tr>
 305   <tr>
 306     <td><code>%WIKIWEBMASTER%</code></td>
 307     <td><strong><em>SL</em></strong></td>
 308     <td> Webmaster email address (sender of email notifications) , is <b></b></td>
 309   </tr>
 310   <tr>
 311     <td><code>%WIKIWEBLIST%</code></td>
 312     <td><strong><em>SL</em></strong></td>
 313     <td> List of %WIKITOOLNAME% webs (in upper right corner of topics) </td>
 314   </tr>
 315   <tr>
 316     <td><code>%WEBTOPICLIST%</code></td>
 317     <td><strong><em>WL</em></strong></td>
 318     <td> Common links of web (second line of topics) </td>
 319   </tr>
 320   <tr>
 321     <td><code>%WEBCOPYRIGHT%</code></td>
 322     <td><strong><em>SL</em></strong> , <strong><em>WL</em></strong></td>
 323     <td> Copyright notice (bottom right corner of topics) </td>
 324   </tr>
 325   <tr>
 326     <td><code>%WEBBGCOLOR%</code></td>
 327     <td><strong><em>WL</em></strong></td>
 328     <td> Background color of web </td>
 329   </tr>
 330   <tr>
 331     <td><code>%NOSEARCHALL%</code></td>
 332     <td><strong><em>WL</em></strong></td>
 333     <td> Exclude web from a <code>web="all"</code> search (set variable to <code>on</code> for hidden webs) </td>
 334   </tr>
 335   <tr>
 336     <td><code>%NEWTOPICBGCOLOR%</code></td>
 337     <td><strong><em>SL</em></strong> , <em>UL</em></td>
 338     <td> Background color of non existing topic. ( <strong><em>UL</em></strong> needs authentication for topic views ) </td>
 339   </tr>
 340   <tr>
 341     <td><code>%NEWTOPICFONTCOLOR%</code></td>
 342     <td><strong><em>SL</em></strong> , <em>UL</em></td>
 343     <td> Font color of non existing topic. ( <strong><em>UL</em></strong> needs authentication for topic views ) </td>
 344   </tr>
 345   <tr>
 346     <td><code>%EDITBOXWIDTH%</code></td>
 347     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
 348     <td> Horizontal size of edit box, is <b> <code>%EDITBOXWIDTH%</code> </b></td>
 349   </tr>
 350   <tr>
 351     <td><code>%EDITBOXHEIGHT%</code></td>
 352     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
 353     <td> Vertical size of edit box, is <b> <code>%EDITBOXHEIGHT%</code> </b></td>
 354   </tr>
 355   <tr>
 356     <td><code>%ATTACHLINKBOX%</code></td>
 357     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
 358     <td> Default state of the link check box in the attach file page. Check box is initially checked if value is set to <code>CHECKED</code> , unchecked if empty. If checked, a link is created to the attached file at the end of the topic. Value is: <b><code>%ATTACHLINKBOX%</code></b></td>
 359   </tr>
 360   <tr>
 361     <td><code>%HTTP_EQUIV_ON_VIEW%</code></td>
 362     <td><strong><em>SL</em></strong></td>
 363     <td> http-equiv meta tags for view, rdiff, attach, search* scripts. </td>
 364   </tr>
 365   <tr>
 366     <td><code>%HTTP_EQUIV_ON_EDIT%</code></td>
 367     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
 368     <td> http-equiv meta tags for edit script. </td>
 369   </tr>
 370   <tr>
 371     <td><code>%HTTP_EQUIV_ON_PREVIEW%</code></td>
 372     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
 373     <td> http-equiv meta tags for preview script. </td>
 374   </tr>
 375   <tr>
 376     <td><code>%DENYWEBCHANGE%</code></td>
 377     <td><strong><em>WL</em></strong></td>
 378     <td> List of users and groups who are <strong>not allowed</strong> to change topics in the %WIKITOOLNAME% web. (More in [[Main/TWikiAccessControl]]) </td>
 379   </tr>
 380   <tr>
 381     <td><code>%ALLOWWEBCHANGE%</code></td>
 382     <td><strong><em>WL</em></strong></td>
 383     <td> List of users and groups who are <strong>allowed</strong> to change topics in the %WIKITOOLNAME% web. (More in [[Main/TWikiAccessControl]]) </td>
 384   </tr>
 385   <tr>
 386     <td><code>%DENYTOPICCHANGE%</code></td>
 387     <td><strong><em>(any topic)</em></strong></td>
 388     <td> List of users and groups who are <strong>not allowed</strong> to change the current topic. (More in [[Main/TWikiAccessControl]]) </td>
 389   </tr>
 390   <tr>
 391     <td><code>%ALLOWTOPICCHANGE%</code></td>
 392     <td><strong><em>(any topic)</em></strong></td>
 393     <td> List of users and groups who are <strong>allowed</strong> to change the current topic. (More in [[Main/TWikiAccessControl]]) </td>
 394   </tr>
 395   <tr>
 396     <td><code>%FINALPREFERENCES%</code></td>
 397     <td><strong><em>SL</em></strong> , <strong><em>WL</em></strong></td>
 398     <td> List of preferences that are not allowed to be overridden by next level preferences</td>
 399   </tr>
 400 </table>
 401
 402 **_Notes:_**
 403
 404 - Preferences variables ( on site-level, web-level and user level ) are defined by bullet lines with this syntax:
 405   - `Set VARIABLENAME = value`
 406 - Additional preferences variables can be defined on all three level as needed. Example:
 407   - `Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif`
 408
 409 -- [[PeterThoeny]] - 24 Mar 2001 <br />