TWiki/TWikiVariables.mdwn

   1 <div>
   2   <ul>
   3     <li><a href="#TWiki Variables"> TWiki Variables</a><ul>
   4         <li><a href="#Predefined Variables"> Predefined Variables</a></li>
   5         <li><a href="#Preferences Variables"> Preferences Variables</a></li>
   6       </ul>
   7     </li>
   8   </ul>
   9 </div>
  10
  11 ## <a name="TWiki Variables"></a> TWiki Variables
  12
  13 ### <a name="Predefined Variables"></a> Predefined Variables
  14
  15 %WIKITOOLNAME% expands the following variables enclosed in % percent signs:
  16
  17 <table border="1">
  18   <tr>
  19     <th> Variable: </th>
  20     <th> Expanded to: </th>
  21   </tr>
  22   <tr>
  23     <td><code>%WIKIHOMEURL%</code></td>
  24     <td> The base script URL of %WIKITOOLNAME%, is the link of the Home icon in the upper left corner, is <b>%WIKIHOMEURL%</b></td>
  25   </tr>
  26   <tr>
  27     <td><code>%SCRIPTURL%</code></td>
  28     <td> The script URL of %WIKITOOLNAME%, is <b>http://www.dementia.org/twiki/</b></td>
  29   </tr>
  30   <tr>
  31     <td><code>%SCRIPTURLPATH%</code></td>
  32     <td> The path of the script URL of %WIKITOOLNAME%, is <b>http://www.dementia.org/twiki/</b></td>
  33   </tr>
  34   <tr>
  35     <td><code>%SCRIPTSUFFIX%</code></td>
  36     <td> The script suffix, i.e. <code>.pl</code>, is <b></b></td>
  37   </tr>
  38   <tr>
  39     <td><code>%PUBURL%</code></td>
  40     <td> The public URL of TWiki, is <b>http://www.dementia.org/twiki//view</b></td>
  41   </tr>
  42   <tr>
  43     <td><code>%PUBURLPATH%</code></td>
  44     <td> The path of the public URL of %WIKITOOLNAME%, is <b>http://www.dementia.org/twiki//view</b></td>
  45   </tr>
  46   <tr>
  47     <td><code>%ATTACHURL%</code></td>
  48     <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>
  49   </tr>
  50   <tr>
  51     <td><code>%ATTACHURLPATH%</code></td>
  52     <td> The path of the attachment URL of the current topic, is <b>http://www.dementia.org/twiki//view</b></td>
  53   </tr>
  54   <tr>
  55     <td><code>%URLPARAM{"name"}%</code></td>
  56     <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>
  57   </tr>
  58   <tr>
  59     <td><code>%WIKITOOLNAME%</code></td>
  60     <td> Name of wiki tool, is <b>%WIKITOOLNAME%</b></td>
  61   </tr>
  62   <tr>
  63     <td><code>%WIKIVERSION%</code></td>
  64     <td> Wiki tool version, is <b>TWiki-4.1.2, Sat, 03 Mar 2007, build 13046</b></td>
  65   </tr>
  66   <tr>
  67     <td><code>%USERNAME%</code></td>
  68     <td> Your login username, is <b>admin</b></td>
  69   </tr>
  70   <tr>
  71     <td><code>%WIKINAME%</code></td>
  72     <td> Your Wiki username. Same as %USERNAME% if not defined in the [[Main/TWikiUsers]] topic. Is <b>admin</b></td>
  73   </tr>
  74   <tr>
  75     <td><code>%WIKIUSERNAME%</code></td>
  76     <td> Your %WIKINAME% including the Main web name. Usefull for signatures. Is <b>Main.admin</b></td>
  77   </tr>
  78   <tr>
  79     <td><code>%MAINWEB%</code></td>
  80     <td> The Main web containing [[Main/TWikiUsers]], [[Main/OfficeLocations]] and [[Main/TWikiGroups]]. Is <b>Main</b></td>
  81   </tr>
  82   <tr>
  83     <td><code>%TWIKIWEB%</code></td>
  84     <td> The web containing all documentation and configuration of %WIKITOOLNAME%. Is <b>TWiki</b></td>
  85   </tr>
  86   <tr>
  87     <td><code>%WEB%</code></td>
  88     <td> The current web, is <b>%WEB%</b></td>
  89   </tr>
  90   <tr>
  91     <td><code>%BASEWEB%</code></td>
  92     <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>
  93   </tr>
  94   <tr>
  95     <td><code>%INCLUDINGWEB%</code></td>
  96     <td> The web name of the topic that includes the current topic. Same as <code>%WEB%</code> in case there is no include. </td>
  97   </tr>
  98   <tr>
  99     <td><code>%HOMETOPIC%</code></td>
 100     <td> The home topic in each web. Is <b>[[Main/WebHome]]</b></td>
 101   </tr>
 102   <tr>
 103     <td><code>%NOTIFYTOPIC%</code></td>
 104     <td> The notify topic in each web. Is <b>[[Main/WebNotify]]</b></td>
 105   </tr>
 106   <tr>
 107     <td><code>%WIKIUSERSTOPIC%</code></td>
 108     <td> The index topic of all registered users. Is <b>TWikiUsers</b></td>
 109   </tr>
 110   <tr>
 111     <td><code>%WEBPREFSTOPIC%</code></td>
 112     <td> The web preferences topic. Is <b>WebPreferences</b></td>
 113   </tr>
 114   <tr>
 115     <td><code>%STATISTICSTOPIC%</code></td>
 116     <td> The web statistics topic. Is <b>WebStatistics</b></td>
 117   </tr>
 118   <tr>
 119     <td><code>%TOPIC%</code></td>
 120     <td> The current topic name, is <b>%TOPIC%</b></td>
 121   </tr>
 122   <tr>
 123     <td><code>%BASETOPIC%</code></td>
 124     <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>
 125   </tr>
 126   <tr>
 127     <td><code>%INCLUDINGTOPIC%</code></td>
 128     <td> The name of the topic that includes the current topic. Same as <code>%TOPIC%</code> in case there is no include. </td>
 129   </tr>
 130   <tr>
 131     <td><code>%SPACEDTOPIC%</code></td>
 132     <td> The current topic name with added spaces, for regular expression search of Ref-By, is <b></b></td>
 133   </tr>
 134   <tr>
 135     <td><code>%TOPICLIST{"format"}%</code></td>
 136     <td> Topic index of a web. The "format" defines the format of one topic item. It may include variables: The <code>$name</code> variable gets expanded to the topic name; the <code>$web</code> variable gets expanded to the name of the web. Parameters are format, separator and web: <table border="1" cellpadding="0" cellspacing="0">
 137         <tr>
 138           <th bgcolor="#99CCCC"><strong> Parameter: </strong></th>
 139           <th bgcolor="#99CCCC"><strong> Description: </strong></th>
 140           <th bgcolor="#99CCCC"><strong> Default: </strong></th>
 141         </tr>
 142         <tr>
 143           <td><code>"format"</code></td>
 144           <td> Format of one line, may include <code>$name</code> and <code>$web</code> variables </td>
 145           <td><code>"$name"</code></td>
 146         </tr>
 147         <tr>
 148           <td><code>format="format"</code></td>
 149           <td> (Alternative to above) </td>
 150           <td><code>"$name"</code></td>
 151         </tr>
 152         <tr>
 153           <td><code>separator=", "</code></td>
 154           <td> line separator </td>
 155           <td><code>"\n"</code> (new line) </td>
 156         </tr>
 157         <tr>
 158           <td><code>web="Name"</code></td>
 159           <td> Name of web </td>
 160           <td> Current web </td>
 161         </tr>
 162       </table> Examples: <br /><code>%TOPICLIST{"   * $web.$name"}%</code> creates a bullet list of all topics. <br /><code>%TOPICLIST{separator=", "}%</code> creates a comma separated list of all topics. <br /><code>%TOPICLIST{" &lt;option&gt;$name&lt;/option&gt;"}%</code> creates an option list (for drop down menus). </td>
 163   </tr>
 164   <tr>
 165     <td><code>%WEBLIST{"format"}%</code></td>
 166     <td> Web index, e.g. list of all webs. Hidden webs are excluded, e.g. webs with a <code>NOSEARCHALL=on</code> preference variable. The <code>"format"</code> defines the format of one web item. The <code>$name</code> variable gets expanded to the name of the web, <code>$qname</code> gets expanded to double quoted name, <code>$marker</code> to <code>marker</code> where web matches <code>selection</code>. Parameters are format, separator and web: <table border="1" cellpadding="0" cellspacing="0">
 167         <tr>
 168           <th bgcolor="#99CCCC"><strong> Parameter: </strong></th>
 169           <th bgcolor="#99CCCC"><strong> Description: </strong></th>
 170           <th bgcolor="#99CCCC"><strong> Default: </strong></th>
 171         </tr>
 172         <tr>
 173           <td><code>"format"</code></td>
 174           <td> Format of one line, may include <code>$name</code> variable </td>
 175           <td><code>"$name"</code></td>
 176         </tr>
 177         <tr>
 178           <td><code>format="format"</code></td>
 179           <td> (Alternative to above) </td>
 180           <td><code>"$name"</code></td>
 181         </tr>
 182         <tr>
 183           <td><code>separator=", "</code></td>
 184           <td> line separator </td>
 185           <td><code>"\n"</code> (new line) </td>
 186         </tr>
 187         <tr>
 188           <td><code>webs="public"</code></td>
 189           <td> comma sep list of Web, public expands to all non-hidden </td>
 190           <td><code>"public"</code></td>
 191         </tr>
 192         <tr>
 193           <td><code>marker="selected"</code></td>
 194           <td> Text for <code>$marker</code> where item matches <code>selection</code>, otherwise equals <code>""</code></td>
 195           <td><code>"selected"</code></td>
 196         </tr>
 197         <tr>
 198           <td><code>selection</code></td>
 199           <td> Current value e.g. current for current Web, =section="%WEB%" </td>
 200         </tr>
 201       </table> Examples: <br /><code>%WEBLIST{"   * [[$name.WebHome]]"}%</code> creates a bullet list of all webs. <br /><code>%WEBLIST{"<select><option $marker="$marker" value="$qname">$name</option>" webs="Trash,public" selection="%WEB%" separator=" "}%</select></code> Dropdown of all public Webs + Trash Web, current Web highlighted. </td>
 202   </tr>
 203   <tr>
 204     <td><code>%GMTIME%</code></td>
 205     <td> GM time, is <b>29 Jun 2010 - 15:27</b></td>
 206   </tr>
 207   <tr>
 208     <td><code>%GMTIME{"format"}%</code></td>
 209     <td> Formatted GM time based on time variables. <table border="1" cellpadding="0" cellspacing="0">
 210         <tr>
 211           <th bgcolor="#99CCCC"><strong> Variable: </strong></th>
 212           <th bgcolor="#99CCCC"><strong> Unit: </strong></th>
 213           <th bgcolor="#99CCCC"><strong> Example </strong></th>
 214         </tr>
 215         <tr>
 216           <td> $seconds </td>
 217           <td> seconds </td>
 218           <td> 59 </td>
 219         </tr>
 220         <tr>
 221           <td> $minutes </td>
 222           <td> minutes </td>
 223           <td> 59 </td>
 224         </tr>
 225         <tr>
 226           <td> $hours </td>
 227           <td> hours </td>
 228           <td> 23 </td>
 229         </tr>
 230         <tr>
 231           <td> $day </td>
 232           <td> day of month </td>
 233           <td> 31 </td>
 234         </tr>
 235         <tr>
 236           <td> $month </td>
 237           <td> month in ISO format </td>
 238           <td> Dec </td>
 239         </tr>
 240         <tr>
 241           <td> $mo </td>
 242           <td> 2 digit month </td>
 243           <td> 12 </td>
 244         </tr>
 245         <tr>
 246           <td> $year </td>
 247           <td> 4 digit year </td>
 248           <td> 1999 </td>
 249         </tr>
 250         <tr>
 251           <td> $ye </td>
 252           <td> 2 digit year </td>
 253           <td> 99 </td>
 254         </tr>
 255       </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:27:28</b></td>
 256   </tr>
 257   <tr>
 258     <td><code>%SERVERTIME%</code></td>
 259     <td> Server time, is <b>29 Jun 2010 - 11:27</b></td>
 260   </tr>
 261   <tr>
 262     <td><code>%SERVERTIME{"format"}%</code></td>
 263     <td> Formatted server time. <br /> Example: <code>%SERVERTIME{"$hou:$min"}%</code> is <b>11:27</b></td>
 264   </tr>
 265   <tr>
 266     <td><code>%HTTP_HOST%</code></td>
 267     <td> HTTP_HOST environment variable, is <b></b></td>
 268   </tr>
 269   <tr>
 270     <td><code>%REMOTE_ADDR%</code></td>
 271     <td> REMOTE_ADDR environment variable, is <b></b></td>
 272   </tr>
 273   <tr>
 274     <td><code>%REMOTE_PORT%</code></td>
 275     <td> REMOTE_PORT environment variable, is <b></b></td>
 276   </tr>
 277   <tr>
 278     <td><code>%REMOTE_USER%</code></td>
 279     <td> REMOTE_USER environment variable, is <b></b></td>
 280   </tr>
 281   <tr>
 282     <td><code>%INCLUDE{"page" ...}%</code></td>
 283     <td> Server side include to [[Main/IncludeTopicsAndWebPages]]. Parameters are page name, and an optional <code>pattern="(reg-exp)"</code>. The page name is: <table border="1" cellpadding="0" cellspacing="0">
 284         <tr>
 285           <td><code>"SomeTopic"</code></td>
 286           <td> The name of a topic located in the current web, i.e. <code>%INCLUDE{"WebNotify"}%</code></td>
 287         </tr>
 288         <tr>
 289           <td><code>"Web.Topic"</code></td>
 290           <td> A topic in another web, i.e. <code>%INCLUDE{"TWiki.TWikiWebsTable"}%</code></td>
 291         </tr>
 292         <tr>
 293           <td><code>"http://..."</code></td>
 294           <td> A full qualified URL, i.e. <code>%INCLUDE{"http://twiki.org/"}%</code></td>
 295         </tr>
 296       </table>
 297     </td>
 298   </tr>
 299   <tr>
 300     <td><code>%STARTINCLUDE%</code></td>
 301     <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>
 302   </tr>
 303   <tr>
 304     <td><code>%STOPINCLUDE%</code></td>
 305     <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>
 306   </tr>
 307   <tr>
 308     <td><code>%TOC%</code></td>
 309     <td> Table of Contents of current topic. </td>
 310   </tr>
 311   <tr>
 312     <td><code>%TOC{"SomeTopic" ...}%</code></td>
 313     <td> Table of Contents. 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. (But not <code>"&lt;H2&gt;text&lt;/H2&gt;"</code>, which can be used to exclude a heading from the TOC.) Parameters are topic name, web and depth: <table border="1" cellpadding="0" cellspacing="0">
 314         <tr>
 315           <th bgcolor="#99CCCC"><strong> Parameter: </strong></th>
 316           <th bgcolor="#99CCCC"><strong> Description: </strong></th>
 317           <th bgcolor="#99CCCC"><strong> Default: </strong></th>
 318         </tr>
 319         <tr>
 320           <td><code>"TopicName"</code></td>
 321           <td> topic name </td>
 322           <td> Current topic </td>
 323         </tr>
 324         <tr>
 325           <td><code>web="Name"</code></td>
 326           <td> Name of web </td>
 327           <td> Current web </td>
 328         </tr>
 329         <tr>
 330           <td><code>depth="2"</code></td>
 331           <td> Limit depth of headings shown in TOC </td>
 332           <td> 6 </td>
 333         </tr>
 334       </table> Examples: <code><b>%TOC{depth="2"}%</b></code>, <code><b>%TOC{"TWikiDocumentation" web="TWiki"}%</b></code></td>
 335   </tr>
 336   <tr>
 337     <td><code>%SEARCH{"text" ...}%</code></td>
 338     <td> Inline search, shows a search result embedded in a topic. Parameters are the search term, web, scope, order and many more: [1] <table border="1" cellpadding="0" cellspacing="0">
 339         <tr>
 340           <th bgcolor="#99CCCC"><strong> Parameter: </strong></th>
 341           <th bgcolor="#99CCCC"><strong> Description: </strong></th>
 342           <th bgcolor="#99CCCC"><strong> Default: </strong></th>
 343         </tr>
 344         <tr>
 345           <td><code>"text"</code></td>
 346           <td> Search term. (Is a regular expression or literal, depending on the <code>regex</code> parameter) </td>
 347           <td> required </td>
 348         </tr>
 349         <tr>
 350           <td><code>search="text"</code></td>
 351           <td> (Alternative to above) </td>
 352           <td> N/A </td>
 353         </tr>
 354         <tr>
 355           <td><code>web="Name"</code><br /><code>web="Main Know"</code><br /><code>web="all"</code></td>
 356           <td> Wiki web to search: A web, a list of webs separated by whitespace, or <code>all</code> webs. [2] </td>
 357           <td> Current web </td>
 358         </tr>
 359         <tr>
 360           <td><code>scope="topic"</code><br /><code>scope="text"</code></td>
 361           <td> Search topic name (title) or in the text (body) of the topic </td>
 362           <td> Topic text (body) </td>
 363         </tr>
 364         <tr>
 365           <td><code>order="topic"</code><br /><code>order="modified"</code><br /><code>order="editby"</code></td>
 366           <td> Sort the results of search by the topic names, last modified time, or last editor </td>
 367           <td> Sort by topic name </td>
 368         </tr>
 369         <tr>
 370           <td><code>limit="all"</code><br /><code>limit="16"</code></td>
 371           <td> Limit the number of results returned </td>
 372           <td> All results </td>
 373         </tr>
 374         <tr>
 375           <td><code>regex="on"</code></td>
 376           <td>[[Main/RegularExpression]] search </td>
 377           <td> Literal search </td>
 378         </tr>
 379         <tr>
 380           <td><code>reverse="on"</code></td>
 381           <td> Reverse the direction of the search </td>
 382           <td> Ascending search </td>
 383         </tr>
 384         <tr>
 385           <td><code>casesensitive="on"</code></td>
 386           <td> Case sensitive search </td>
 387           <td> Ignore case </td>
 388         </tr>
 389         <tr>
 390           <td><code>nosummary="on"</code></td>
 391           <td> Show topic title only </td>
 392           <td> Show topic summary </td>
 393         </tr>
 394         <tr>
 395           <td><code>bookview="on"</code></td>
 396           <td>[[Main/BookView]] search, e.g. show complete topic text </td>
 397           <td> Show topic summary </td>
 398         </tr>
 399         <tr>
 400           <td><code>nosearch="on"</code></td>
 401           <td> Suppress search string </td>
 402           <td> Show search string </td>
 403         </tr>
 404         <tr>
 405           <td><code>noheader="on"</code></td>
 406           <td> Suppress search header <br /><span style="background: #FFB0B0"> <strong>Topics: Changed: By:</strong> </span></td>
 407           <td> Show search header </td>
 408         </tr>
 409         <tr>
 410           <td><code>nototal="on"</code></td>
 411           <td> Do not show number of topics found </td>
 412           <td> Show number </td>
 413         </tr>
 414       </table> Example: <code><b>%SEARCH{"wiki" web="Main" scope="topic"}%</b></code></td>
 415   </tr>
 416   <tr>
 417     <td><code>%VAR{"NAME" web="Web"}%</code></td>
 418     <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>
 419     <td>
 420       <p>
 421       </p>
 422     </td>
 423   </tr>
 424 </table>
 425
 426 [1] **_Note_**: The search form uses identical names for input fields.
 427
 428 [2] **_Note_**: A web can be excluded from a `web="all"` search if you define a `NOSEARCHALL=on` variable in its [[WebPreferences]].
 429
 430 ### <a name="Preferences Variables"></a> Preferences Variables
 431
 432 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):
 433
 434 <table border="1">
 435   <tr>
 436     <th> Variable: </th>
 437     <th> Level: </th>
 438     <th> What: </th>
 439   </tr>
 440   <tr>
 441     <td><code>%WIKIWEBMASTER%</code></td>
 442     <td><strong><em>SL</em></strong></td>
 443     <td> Webmaster email address (sender of email notifications) , is <b></b></td>
 444   </tr>
 445   <tr>
 446     <td><code>%WIKIWEBLIST%</code></td>
 447     <td><strong><em>SL</em></strong></td>
 448     <td> List of %WIKITOOLNAME% webs (in upper right corner of topics) </td>
 449   </tr>
 450   <tr>
 451     <td><code>%WEBTOPICLIST%</code></td>
 452     <td><strong><em>WL</em></strong></td>
 453     <td> Common links of web (second line of topics) </td>
 454   </tr>
 455   <tr>
 456     <td><code>%WEBCOPYRIGHT%</code></td>
 457     <td><strong><em>SL</em></strong> , <strong><em>WL</em></strong></td>
 458     <td> Copyright notice (bottom right corner of topics) </td>
 459   </tr>
 460   <tr>
 461     <td><code>%WEBBGCOLOR%</code></td>
 462     <td><strong><em>WL</em></strong></td>
 463     <td> Background color of web </td>
 464   </tr>
 465   <tr>
 466     <td><code>%NOSEARCHALL%</code></td>
 467     <td><strong><em>WL</em></strong></td>
 468     <td> Exclude web from a <code>web="all"</code> search (set variable to <code>on</code> for hidden webs) </td>
 469   </tr>
 470   <tr>
 471     <td><code>%NEWTOPICBGCOLOR%</code></td>
 472     <td><strong><em>SL</em></strong> , <em>UL</em></td>
 473     <td> Background color of non existing topic. ( <strong><em>UL</em></strong> needs authentication for topic views ) </td>
 474   </tr>
 475   <tr>
 476     <td><code>%NEWTOPICFONTCOLOR%</code></td>
 477     <td><strong><em>SL</em></strong> , <em>UL</em></td>
 478     <td> Font color of non existing topic. ( <strong><em>UL</em></strong> needs authentication for topic views ) </td>
 479   </tr>
 480   <tr>
 481     <td><code>%EDITBOXWIDTH%</code></td>
 482     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
 483     <td> Horizontal size of edit box, is <b> <code>%EDITBOXWIDTH%</code> </b></td>
 484   </tr>
 485   <tr>
 486     <td><code>%EDITBOXHEIGHT%</code></td>
 487     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
 488     <td> Vertical size of edit box, is <b> <code>%EDITBOXHEIGHT%</code> </b></td>
 489   </tr>
 490   <tr>
 491     <td><code>%RELEASEEDITLOCKCHECKBOX%</code></td>
 492     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
 493     <td> Default state of the "Release edit lock" ([[Main/UnlockTopic]]) check box in preview. Checkbox is initially checked if <code>Set RELEASEEDITLOCKCHECKBOX = checked="checked"</code>, or unchecked if empty. If checked, make sure to click on <u>Edit</u> to do more changes; do <strong>not</strong> go back in your browser to the edit page, or you risk that someone else will edit the topic at the same time! Value is: <b><code>%RELEASEEDITLOCKCHECKBOX%</code></b></td>
 494   </tr>
 495   <tr>
 496     <td><code>%DONTNOTIFYCHECKBOX%</code></td>
 497     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
 498     <td> Default state of the "Minor Changes, Don't Notify" ([[Main/DontNotify]]) check box in preview. Check box is initially checked if <code>Set DONTNOTIFYCHECKBOX = checked="checked"</code>, or unchecked if empty. Value is: <b><code>%DONTNOTIFYCHECKBOX%</code></b></td>
 499   </tr>
 500   <tr>
 501     <td><code>%ATTACHLINKBOX%</code></td>
 502     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
 503     <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>
 504   </tr>
 505   <tr>
 506     <td><code>%HTTP_EQUIV_ON_VIEW%</code></td>
 507     <td><strong><em>SL</em></strong></td>
 508     <td> http-equiv meta tags for view, rdiff, attach, search* scripts. </td>
 509   </tr>
 510   <tr>
 511     <td><code>%HTTP_EQUIV_ON_EDIT%</code></td>
 512     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
 513     <td> http-equiv meta tags for edit script. </td>
 514   </tr>
 515   <tr>
 516     <td><code>%HTTP_EQUIV_ON_PREVIEW%</code></td>
 517     <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
 518     <td> http-equiv meta tags for preview script. </td>
 519   </tr>
 520   <tr>
 521     <td><code>%DENYWEBCHANGE%</code></td>
 522     <td><strong><em>WL</em></strong></td>
 523     <td> List of users and groups who are <strong>not allowed</strong> to change topics in the %WIKITOOLNAME% web. (More in [[Main/TWikiAccessControl]]) </td>
 524   </tr>
 525   <tr>
 526     <td><code>%ALLOWWEBCHANGE%</code></td>
 527     <td><strong><em>WL</em></strong></td>
 528     <td> List of users and groups who are <strong>allowed</strong> to change topics in the %WIKITOOLNAME% web. (More in [[Main/TWikiAccessControl]]) </td>
 529   </tr>
 530   <tr>
 531     <td><code>%DENYTOPICCHANGE%</code></td>
 532     <td><strong><em>(any topic)</em></strong></td>
 533     <td> List of users and groups who are <strong>not allowed</strong> to change the current topic. (More in [[Main/TWikiAccessControl]]) </td>
 534   </tr>
 535   <tr>
 536     <td><code>%ALLOWTOPICCHANGE%</code></td>
 537     <td><strong><em>(any topic)</em></strong></td>
 538     <td> List of users and groups who are <strong>allowed</strong> to change the current topic. (More in [[Main/TWikiAccessControl]]) </td>
 539   </tr>
 540   <tr>
 541     <td><code>%DENYWEBRENAME%</code></td>
 542     <td><strong><em>WL</em></strong></td>
 543     <td> List of users and groups who are <strong>not allowed</strong> to rename topics in the %WIKITOOLNAME% web. (More in [[Main/TWikiAccessControl]]) </td>
 544   </tr>
 545   <tr>
 546     <td><code>%ALLOWWEBRENAME%</code></td>
 547     <td><strong><em>WL</em></strong></td>
 548     <td> List of users and groups who are <strong>allowed</strong> to rename topics in the %WIKITOOLNAME% web. (More in [[Main/TWikiAccessControl]]) </td>
 549   </tr>
 550   <tr>
 551     <td><code>%DENYTOPICRENAME%</code></td>
 552     <td><strong><em>(any topic)</em></strong></td>
 553     <td> List of users and groups who are <strong>not allowed</strong> to rename the current topic. (More in [[Main/TWikiAccessControl]]) </td>
 554   </tr>
 555   <tr>
 556     <td><code>%ALLOWTOPICRENAME%</code></td>
 557     <td><strong><em>(any topic)</em></strong></td>
 558     <td> List of users and groups who are <strong>allowed</strong> to rename the current topic. (More in [[Main/TWikiAccessControl]]) </td>
 559   </tr>
 560   <tr>
 561     <td>
 562       <p>
 563       </p>
 564     </td>
 565     <td><code>%FINALPREFERENCES%</code></td>
 566     <td><strong><em>SL</em></strong> , <strong><em>WL</em></strong></td>
 567     <td> List of preferences that are not allowed to be overridden by next level preferences</td>
 568   </tr>
 569 </table>
 570
 571 **_Notes:_**
 572
 573 - Preferences variables ( on site-level, web-level and user level ) are defined by bullet lines with this syntax:
 574   - `Set VARIABLENAME = value`
 575 - Additional preferences variables can be defined on all three level as needed. Example:
 576   - `Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif`
 577
 578 -- [[PeterThoeny]] - 23 Jul 2001 <br /> -- [[MikeMannix]] - 26 Aug 2001 <br />