TWiki/TWikiVariables.mdwn

   1 TWiki 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 TWiki, link of Home icon in upper left corner is <b>%WIKIHOMEURL%</b></td>
  11   </tr>
  12   <tr>
  13     <td><code>%SCRIPTURL%</code></td>
  14     <td> The base script URL of TWiki, is <b>http://www.dementia.org/twiki/</b></td>
  15   </tr>
  16   <tr>
  17     <td><code>%PUBURL%</code></td>
  18     <td> The base public URL of TWiki, is <b>http://www.dementia.org/twiki//view</b></td>
  19   </tr>
  20   <tr>
  21     <td><code>%ATTACHURL%</code></td>
  22     <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>
  23   </tr>
  24   <tr>
  25     <td><code>%WIKITOOLNAME%</code></td>
  26     <td> Name of wiki tool, is <b>%WIKITOOLNAME%</b></td>
  27   </tr>
  28   <tr>
  29     <td><code>%WIKIVERSION%</code></td>
  30     <td> Wiki tool version, is <b>TWiki-4.1.2, Sat, 03 Mar 2007, build 13046</b></td>
  31   </tr>
  32   <tr>
  33     <td><code>%USERNAME%</code></td>
  34     <td> Your login username, is <b>admin</b></td>
  35   </tr>
  36   <tr>
  37     <td><code>%WIKIUSERNAME%</code></td>
  38     <td> Your Wiki username, if defined in [[Main/TWikiUsers]]. Same as %USERNAME% if not defined. Is <b>Main.admin</b></td>
  39   </tr>
  40   <tr>
  41     <td><code>%WEB%</code></td>
  42     <td> The current web, is <b>%WEB%</b></td>
  43   </tr>
  44   <tr>
  45     <td><code>%TOPIC%</code></td>
  46     <td> The current topic name, is <b>%TOPIC%</b></td>
  47   </tr>
  48   <tr>
  49     <td><code>%DATE%</code></td>
  50     <td> Todays date, is <b>29 Jun 2010</b></td>
  51   </tr>
  52   <tr>
  53     <td><code>%INCLUDE{"file.ext"}%</code></td>
  54     <td> Server side include, includes the text of a file. The default directory is the current Wiki web. Example: <code><b>%INCLUDE{"../Know/TopicName.txt"}%</b></code></td>
  55   </tr>
  56   <tr>
  57     <td><code>%SEARCH{"str" ...}%</code></td>
  58     <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">
  59         <tr>
  60           <th bgcolor="#99CCCC"><strong> Pair: </strong></th>
  61           <th bgcolor="#99CCCC"><strong> Description: </strong></th>
  62           <th bgcolor="#99CCCC"><strong> Default: </strong></th>
  63         </tr>
  64         <tr>
  65           <td><code>web="Name"</code></td>
  66           <td> Specify Wiki web to search </td>
  67           <td> Current web </td>
  68         </tr>
  69         <tr>
  70           <td><code>scope="topic"</code></td>
  71           <td> Search topic name (title) </td>
  72           <td> Topic text (body) </td>
  73         </tr>
  74         <tr>
  75           <td><code>regex="on"</code></td>
  76           <td>[[Main/RegularExpression]] search </td>
  77           <td> Literal search </td>
  78         </tr>
  79         <tr>
  80           <td><code>casesensitive="on"</code></td>
  81           <td> Case sensitive search </td>
  82           <td> Ignore case </td>
  83         </tr>
  84         <tr>
  85           <td><code>nosummary="on"</code></td>
  86           <td> Show topic title only </td>
  87           <td> Show topic summary </td>
  88         </tr>
  89         <tr>
  90           <td><code>nosearch="on"</code></td>
  91           <td> Suppress search string </td>
  92           <td> Show search string </td>
  93         </tr>
  94         <tr>
  95           <td><code>nototal="on"</code></td>
  96           <td> Do not show number of topics found </td>
  97           <td> Show number </td>
  98         </tr>
  99       </table> Example: <code><b>%SEARCH{"wiki" web="Main" scope="topic"}%</b></code></td>
 100   </tr>
 101 </table>
 102
 103 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):
 104
 105 <table border="1">
 106   <tr>
 107     <th> Variable: </th>
 108     <th> Level: </th>
 109     <th> What: </th>
 110   </tr>
 111   <tr>
 112     <td><code>%WIKIWEBMASTER%</code></td>
 113     <td><strong><em>SL</em></strong></td>
 114     <td> Webmaster email address (sender of email notifications) , is <b></b></td>
 115   </tr>
 116   <tr>
 117     <td><code>%WIKIWEBLIST%</code></td>
 118     <td><strong><em>SL</em></strong></td>
 119     <td> List of %WIKITOOLNAME% webs (in upper right corner of topics) </td>
 120   </tr>
 121   <tr>
 122     <td><code>%WEBTOPICLIST%</code></td>
 123     <td><strong><em>WL</em></strong></td>
 124     <td> Common links of web (second line of topics) </td>
 125   </tr>
 126   <tr>
 127     <td><code>%WEBCOPYRIGHT%</code></td>
 128     <td><strong><em>SL</em></strong> , <strong><em>WL</em></strong></td>
 129     <td> Copyright notice (bottom right corner of topics) </td>
 130   </tr>
 131   <tr>
 132     <td><code>%WEBBGCOLOR%</code></td>
 133     <td><strong><em>WL</em></strong></td>
 134     <td> Background color of web </td>
 135   </tr>
 136   <tr>
 137     <td><code>%EDITBOXWIDTH%</code></td>
 138     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
 139     <td> Horizontal size of edit box, is <b> <code>%EDITBOXWIDTH%</code> </b></td>
 140   </tr>
 141   <tr>
 142     <td><code>%EDITBOXHEIGHT%</code></td>
 143     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
 144     <td> Vertical size of edit box, is <b> <code>%EDITBOXHEIGHT%</code> </b></td>
 145   </tr>
 146 </table>