TWiki/TWikiVariables.mdwn

   1 %WIKITOOLNAME% expands the following variables enclosed in % percent signs:
   2
   3 <table border="1">
   4   <tr>
   5     <th> Variable: </th>
   6     <th> Expanded to: </th>
   7   </tr>
   8   <tr>
   9     <td><code>%WIKIHOMEURL%</code></td>
  10     <td> The base script URL of %WIKITOOLNAME%, is the link of the Home icon in the upper left corner, is <b>%WIKIHOMEURL%</b></td>
  11   </tr>
  12   <tr>
  13     <td><code>%SCRIPTURL%</code></td>
  14     <td> The script URL of %WIKITOOLNAME%, is <b>http://www.dementia.org/twiki/</b></td>
  15   </tr>
  16   <tr>
  17     <td><code>%SCRIPTURLPATH%</code></td>
  18     <td> The path of the script URL of %WIKITOOLNAME%, is <b>http://www.dementia.org/twiki/</b></td>
  19   </tr>
  20   <tr>
  21     <td><code>%SCRIPTSUFFIX%</code></td>
  22     <td> The script suffix, i.e. <code>.pl</code>, is <b></b></td>
  23   </tr>
  24   <tr>
  25     <td><code>%PUBURL%</code></td>
  26     <td> The public URL of TWiki, is <b>http://www.dementia.org/twiki//view</b></td>
  27   </tr>
  28   <tr>
  29     <td><code>%PUBURLPATH%</code></td>
  30     <td> The path of the public URL of %WIKITOOLNAME%, is <b>http://www.dementia.org/twiki//view</b></td>
  31   </tr>
  32   <tr>
  33     <td><code>%ATTACHURL%</code></td>
  34     <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>
  35   </tr>
  36   <tr>
  37     <td><code>%ATTACHURLPATH%</code></td>
  38     <td> The path of the attachment URL of the current topic, is <b>http://www.dementia.org/twiki//view</b></td>
  39   </tr>
  40   <tr>
  41     <td><code>%WIKITOOLNAME%</code></td>
  42     <td> Name of wiki tool, is <b>%WIKITOOLNAME%</b></td>
  43   </tr>
  44   <tr>
  45     <td><code>%WIKIVERSION%</code></td>
  46     <td> Wiki tool version, is <b>TWiki-4.1.2, Sat, 03 Mar 2007, build 13046</b></td>
  47   </tr>
  48   <tr>
  49     <td><code>%USERNAME%</code></td>
  50     <td> Your login username, is <b>admin</b></td>
  51   </tr>
  52   <tr>
  53     <td><code>%WIKIUSERNAME%</code></td>
  54     <td> Your Wiki username, if defined in [[Main/TWikiUsers]]. Same as %USERNAME% if not defined. Is <b>Main.admin</b></td>
  55   </tr>
  56   <tr>
  57     <td><code>%WEB%</code></td>
  58     <td> The current web, is <b>%WEB%</b></td>
  59   </tr>
  60   <tr>
  61     <td><code>%TOPIC%</code></td>
  62     <td> The current topic name, is <b>%TOPIC%</b></td>
  63   </tr>
  64   <tr>
  65     <td><code>%SPACEDTOPIC%</code></td>
  66     <td> The current topic name with added spaces, for regular expression search of Ref-By, is <b></b></td>
  67   </tr>
  68   <tr>
  69     <td><code>%GMTIME%</code></td>
  70     <td> GM time, is <b>29 Jun 2010 - 15:25</b></td>
  71   </tr>
  72   <tr>
  73     <td><code>%GMTIME{"format"}%</code></td>
  74     <td> Formatted GM time based on keywords (first three characters needed.) <br /> Example: <code>%GMTIME{"day month, year - hour:min:sec"}%</code> is <b>day month, year - hour:min:sec</b></td>
  75   </tr>
  76   <tr>
  77     <td><code>%SERVERTIME%</code></td>
  78     <td> Server time, is <b>29 Jun 2010 - 11:25</b></td>
  79   </tr>
  80   <tr>
  81     <td><code>%SERVERTIME{"format"}%</code></td>
  82     <td> Formatted server time. Example: <code>%SERVERTIME{"hou:min"}%</code> is <b>hou:min</b></td>
  83   </tr>
  84   <tr>
  85     <td><code>%HTTP_HOST%</code></td>
  86     <td> HTTP_HOST environment variable, is <b></b></td>
  87   </tr>
  88   <tr>
  89     <td><code>%REMOTE_ADDR%</code></td>
  90     <td> REMOTE_ADDR environment variable, is <b></b></td>
  91   </tr>
  92   <tr>
  93     <td><code>%REMOTE_PORT%</code></td>
  94     <td> REMOTE_PORT environment variable, is <b></b></td>
  95   </tr>
  96   <tr>
  97     <td><code>%REMOTE_USER%</code></td>
  98     <td> REMOTE_USER environment variable, is <b></b></td>
  99   </tr>
 100   <tr>
 101     <td><code>%INCLUDE{"SomeTopic"}%</code></td>
 102     <td> Server side include, includes another topic. The current Wiki web is searched by default. Example: <code><b>%INCLUDE{"TWiki.TWikiWebsTable"}%</b></code></td>
 103   </tr>
 104   <tr>
 105     <td><code>%SEARCH{"str" ...}%</code></td>
 106     <td> Inline search, shows a search result embedded in a topic. Parameter is composed of the search string, followed by optional <code>name="value"</code> pairs: <table border="1" cellpadding="0" cellspacing="0">
 107         <tr>
 108           <th bgcolor="#99CCCC"><strong> Pair: </strong></th>
 109           <th bgcolor="#99CCCC"><strong> Description: </strong></th>
 110           <th bgcolor="#99CCCC"><strong> Default: </strong></th>
 111         </tr>
 112         <tr>
 113           <td><code>web="Name"</code><br /><code>web="Main Know"</code><br /><code>web="all"</code></td>
 114           <td> Wiki web to search: A web, a list of webs separated by whitespace, or all webs <code>[1]</code></td>
 115           <td> Current web </td>
 116         </tr>
 117         <tr>
 118           <td><code>scope="topic"</code><br /><code>scope="text"</code></td>
 119           <td> Search topic name (title) or in the text (body) of the topic </td>
 120           <td> Topic text (body) </td>
 121         </tr>
 122         <tr>
 123           <td><code>order="topic"</code><br /><code>order="modified"</code><br /><code>order="editby"</code></td>
 124           <td> Sort the results of search by the topic names, last modified time, or last editor </td>
 125           <td> Sort by topic name </td>
 126         </tr>
 127         <tr>
 128           <td><code>limit="all"</code><br /><code>limit="16"</code></td>
 129           <td> Limit the number of results returned </td>
 130           <td> All results </td>
 131         </tr>
 132         <tr>
 133           <td><code>regex="on"</code></td>
 134           <td>[[Main/RegularExpression]] search </td>
 135           <td> Literal search </td>
 136         </tr>
 137         <tr>
 138           <td><code>reverse="on"</code></td>
 139           <td> Reverse the direction of the search </td>
 140           <td> Ascending search </td>
 141         </tr>
 142         <tr>
 143           <td><code>casesensitive="on"</code></td>
 144           <td> Case sensitive search </td>
 145           <td> Ignore case </td>
 146         </tr>
 147         <tr>
 148           <td><code>nosummary="on"</code></td>
 149           <td> Show topic title only </td>
 150           <td> Show topic summary </td>
 151         </tr>
 152         <tr>
 153           <td><code>bookview="on"</code></td>
 154           <td>[[Main/BookView]] search, e.g. show complete topic text </td>
 155           <td> Show topic summary </td>
 156         </tr>
 157         <tr>
 158           <td><code>nosearch="on"</code></td>
 159           <td> Suppress search string </td>
 160           <td> Show search string </td>
 161         </tr>
 162         <tr>
 163           <td><code>nototal="on"</code></td>
 164           <td> Do not show number of topics found </td>
 165           <td> Show number </td>
 166         </tr>
 167       </table> Example: <code><b>%SEARCH{"wiki" web="Main" scope="topic"}%</b></code></td>
 168   </tr>
 169   <tr>
 170     <td><code>%VAR{"NAME" web="Web"}%</code></td>
 171     <td> Get a preference value from another web 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>
 172     <td>
 173       <p>
 174       </p>
 175     </td>
 176   </tr>
 177 </table>
 178
 179 [1] **_Note_**: A web can be excluded from a `web="all"` search if you define a `NOSEARCHALL=on` variable in its [[WebPreferences]].
 180
 181 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):
 182
 183 <table border="1">
 184   <tr>
 185     <th> Variable: </th>
 186     <th> Level: </th>
 187     <th> What: </th>
 188   </tr>
 189   <tr>
 190     <td><code>%WIKIWEBMASTER%</code></td>
 191     <td><strong><em>SL</em></strong></td>
 192     <td> Webmaster email address (sender of email notifications) , is <b></b></td>
 193   </tr>
 194   <tr>
 195     <td><code>%WIKIWEBLIST%</code></td>
 196     <td><strong><em>SL</em></strong></td>
 197     <td> List of %WIKITOOLNAME% webs (in upper right corner of topics) </td>
 198   </tr>
 199   <tr>
 200     <td><code>%WEBTOPICLIST%</code></td>
 201     <td><strong><em>WL</em></strong></td>
 202     <td> Common links of web (second line of topics) </td>
 203   </tr>
 204   <tr>
 205     <td><code>%WEBCOPYRIGHT%</code></td>
 206     <td><strong><em>SL</em></strong> , <strong><em>WL</em></strong></td>
 207     <td> Copyright notice (bottom right corner of topics) </td>
 208   </tr>
 209   <tr>
 210     <td><code>%WEBBGCOLOR%</code></td>
 211     <td><strong><em>WL</em></strong></td>
 212     <td> Background color of web </td>
 213   </tr>
 214   <tr>
 215     <td><code>%NOSEARCHALL%</code></td>
 216     <td><strong><em>WL</em></strong></td>
 217     <td> Exclude web from a <code>web="all"</code> search (set variable to <code>on</code> for hidden webs) </td>
 218   </tr>
 219   <tr>
 220     <td><code>%NEWTOPICBGCOLOR%</code></td>
 221     <td><strong><em>SL</em></strong> , <em>UL</em></td>
 222     <td> Background color of non existing topic. ( <strong><em>UL</em></strong> needs authentication for topic views ) </td>
 223   </tr>
 224   <tr>
 225     <td><code>%NEWTOPICFONTCOLOR%</code></td>
 226     <td><strong><em>SL</em></strong> , <em>UL</em></td>
 227     <td> Font color of non existing topic. ( <strong><em>UL</em></strong> needs authentication for topic views ) </td>
 228   </tr>
 229   <tr>
 230     <td><code>%EDITBOXWIDTH%</code></td>
 231     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
 232     <td> Horizontal size of edit box, is <b> <code>%EDITBOXWIDTH%</code> </b></td>
 233   </tr>
 234   <tr>
 235     <td><code>%EDITBOXHEIGHT%</code></td>
 236     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
 237     <td> Vertical size of edit box, is <b> <code>%EDITBOXHEIGHT%</code> </b></td>
 238   </tr>
 239   <tr>
 240     <td><code>%ATTACHLINKBOX%</code></td>
 241     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
 242     <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>
 243   </tr>
 244   <tr>
 245     <td><code>%HTTP_EQUIV_ON_VIEW%</code></td>
 246     <td><strong><em>SL</em></strong></td>
 247     <td> http-equiv meta tags for view, rdiff, attach, search* scripts. </td>
 248   </tr>
 249   <tr>
 250     <td><code>%HTTP_EQUIV_ON_EDIT%</code></td>
 251     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
 252     <td> http-equiv meta tags for edit script. </td>
 253   </tr>
 254   <tr>
 255     <td><code>%HTTP_EQUIV_ON_PREVIEW%</code></td>
 256     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
 257     <td> http-equiv meta tags for preview script. </td>
 258   </tr>
 259   <tr>
 260     <td><code>%DENYWEBCHANGE%</code></td>
 261     <td><strong><em>WL</em></strong></td>
 262     <td> List of users and groups who are <strong>not allowed</strong> to change topics in the %WIKITOOLNAME% web. (More in [[Main/TWikiAccessControl]]) </td>
 263   </tr>
 264   <tr>
 265     <td><code>%ALLOWWEBCHANGE%</code></td>
 266     <td><strong><em>WL</em></strong></td>
 267     <td> List of users and groups who are <strong>allowed</strong> to change topics in the %WIKITOOLNAME% web. (More in [[Main/TWikiAccessControl]]) </td>
 268   </tr>
 269   <tr>
 270     <td><code>%DENYTOPICCHANGE%</code></td>
 271     <td><strong><em>(any topic)</em></strong></td>
 272     <td> List of users and groups who are <strong>not allowed</strong> to change the current topic. (More in [[Main/TWikiAccessControl]]) </td>
 273   </tr>
 274   <tr>
 275     <td><code>%ALLOWTOPICCHANGE%</code></td>
 276     <td><strong><em>(any topic)</em></strong></td>
 277     <td> List of users and groups who are <strong>allowed</strong> to change the current topic. (More in [[Main/TWikiAccessControl]]) </td>
 278   </tr>
 279   <tr>
 280     <td><code>%FINALPREFERENCES%</code></td>
 281     <td><strong><em>SL</em></strong> , <strong><em>WL</em></strong></td>
 282     <td> List of preferences that are not allowed to be overridden by next level preferences</td>
 283   </tr>
 284 </table>
 285
 286 **_Notes:_**
 287
 288 - Preferences variables ( on site-level, web-level and user level ) are defined by bullet lines with this syntax:
 289   - `Set VARIABLENAME = value`
 290 - Additional preferences variables can be defined on all three level as needed. Example:
 291   - `Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif`
 292
 293 -- [[PeterThoeny]] - 10 Nov 2000 <br />