1 ## <a name="TWiki Variables"></a> TWiki Variables
3 ### <a name="Predefined Variables"></a> Predefined Variables
5 %WIKITOOLNAME% expands the following variables enclosed in % percent signs:
10 <th> Expanded to: </th>
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>
17 <td><code>%SCRIPTURL%</code></td>
18 <td> The script URL of %WIKITOOLNAME%, is <b>http://www.dementia.org/twiki/</b></td>
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>
25 <td><code>%SCRIPTSUFFIX%</code></td>
26 <td> The script suffix, i.e. <code>.pl</code>, is <b></b></td>
29 <td><code>%PUBURL%</code></td>
30 <td> The public URL of TWiki, is <b>http://www.dementia.org/twiki//view</b></td>
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>
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>
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>
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>
49 <td><code>%WIKITOOLNAME%</code></td>
50 <td> Name of wiki tool, is <b>%WIKITOOLNAME%</b></td>
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>
57 <td><code>%USERNAME%</code></td>
58 <td> Your login username, is <b>admin</b></td>
61 <td><code>%WIKINAME%</code></td>
62 <td> Your Wiki username. Same as %USERNAME% if not defined in the [[Main/TWikiUsers]] topic. Is <b>admin</b></td>
65 <td><code>%WIKIUSERNAME%</code></td>
66 <td> Your %WIKINAME% including the Main web name. Usefull for signatures. Is <b>Main.admin</b></td>
69 <td><code>%MAINWEB%</code></td>
70 <td> The Main web containing [[Main/TWikiUsers]], [[Main/OfficeLocations]] and [[Main/TWikiGroups]]. Is <b>Main</b></td>
73 <td><code>%TWIKIWEB%</code></td>
74 <td> The web containing all documentation and configuration of %WIKITOOLNAME%. Is <b>TWiki</b></td>
77 <td><code>%WEB%</code></td>
78 <td> The current web, is <b>%WEB%</b></td>
81 <td><code>%BASEWEB%</code></td>
82 <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>
85 <td><code>%INCLUDINGWEB%</code></td>
86 <td> The web name of the topic that includes the current topic. Same as <code>%WEB%</code> in case there is no include. </td>
89 <td><code>%HOMETOPIC%</code></td>
90 <td> The home topic in each web. Is <b>[[Main/WebHome]]</b></td>
93 <td><code>%NOTIFYTOPIC%</code></td>
94 <td> The notify topic in each web. Is <b>[[Main/WebNotify]]</b></td>
97 <td><code>%WIKIUSERSTOPIC%</code></td>
98 <td> The index topic of all registered users. Is <b>TWikiUsers</b></td>
101 <td><code>%WEBPREFSTOPIC%</code></td>
102 <td> The web preferences topic. Is <b>WebPreferences</b></td>
105 <td><code>%STATISTICSTOPIC%</code></td>
106 <td> The web statistics topic. Is <b>WebStatistics</b></td>
109 <td><code>%TOPIC%</code></td>
110 <td> The current topic name, is <b>%TOPIC%</b></td>
113 <td><code>%BASETOPIC%</code></td>
114 <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>
117 <td><code>%INCLUDINGTOPIC%</code></td>
118 <td> The name of the topic that includes the current topic. Same as <code>%TOPIC%</code> in case there is no include. </td>
121 <td><code>%SPACEDTOPIC%</code></td>
122 <td> The current topic name with added spaces, for regular expression search of Ref-By, is <b></b></td>
125 <td><code>%TOPICLIST{"format"}%</code></td>
126 <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">
128 <th bgcolor="#99CCCC"><strong> Parameter: </strong></th>
129 <th bgcolor="#99CCCC"><strong> Description: </strong></th>
130 <th bgcolor="#99CCCC"><strong> Default: </strong></th>
133 <td><code>"format"</code></td>
134 <td> Format of one line, may include <code>$name</code> and <code>$web</code> variables </td>
135 <td><code>"$name"</code></td>
138 <td><code>format="format"</code></td>
139 <td> (Alternative to above) </td>
140 <td><code>"$name"</code></td>
143 <td><code>separator=", "</code></td>
144 <td> line separator </td>
145 <td><code>"\n"</code> (new line) </td>
148 <td><code>web="Name"</code></td>
149 <td> Name of web </td>
150 <td> Current web </td>
152 </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{" <option>$name</option>"}%</code> creates an option list (for drop down menus). </td>
155 <td><code>%WEBLIST{"format"}%</code></td>
156 <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">
158 <th bgcolor="#99CCCC"><strong> Parameter: </strong></th>
159 <th bgcolor="#99CCCC"><strong> Description: </strong></th>
160 <th bgcolor="#99CCCC"><strong> Default: </strong></th>
163 <td><code>"format"</code></td>
164 <td> Format of one line, may include <code>$name</code> variable </td>
165 <td><code>"$name"</code></td>
168 <td><code>format="format"</code></td>
169 <td> (Alternative to above) </td>
170 <td><code>"$name"</code></td>
173 <td><code>separator=", "</code></td>
174 <td> line separator </td>
175 <td><code>"\n"</code> (new line) </td>
178 <td><code>webs="public"</code></td>
179 <td> comma sep list of Web, public expands to all non-hidden </td>
180 <td><code>"public"</code></td>
183 <td><code>marker="selected"</code></td>
184 <td> Text for <code>$marker</code> where item matches <code>selection</code>, otherwise equals <code>""</code></td>
185 <td><code>"selected"</code></td>
188 <td><code>selection</code></td>
189 <td> Current value e.g. current for current Web, =section="%WEB%" </td>
191 </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>
194 <td><code>%GMTIME%</code></td>
195 <td> GM time, is <b>29 Jun 2010 - 15:27</b></td>
198 <td><code>%GMTIME{"format"}%</code></td>
199 <td> Formatted GM time based on time variables. <table border="1" cellpadding="0" cellspacing="0">
201 <th bgcolor="#99CCCC"><strong> Variable: </strong></th>
202 <th bgcolor="#99CCCC"><strong> Unit: </strong></th>
203 <th bgcolor="#99CCCC"><strong> Example </strong></th>
222 <td> day of month </td>
227 <td> month in ISO format </td>
232 <td> 2 digit month </td>
237 <td> 4 digit year </td>
242 <td> 2 digit year </td>
245 </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:16</b></td>
248 <td><code>%SERVERTIME%</code></td>
249 <td> Server time, is <b>29 Jun 2010 - 11:27</b></td>
252 <td><code>%SERVERTIME{"format"}%</code></td>
253 <td> Formatted server time. <br /> Example: <code>%SERVERTIME{"$hou:$min"}%</code> is <b>11:27</b></td>
256 <td><code>%HTTP_HOST%</code></td>
257 <td> HTTP_HOST environment variable, is <b></b></td>
260 <td><code>%REMOTE_ADDR%</code></td>
261 <td> REMOTE_ADDR environment variable, is <b></b></td>
264 <td><code>%REMOTE_PORT%</code></td>
265 <td> REMOTE_PORT environment variable, is <b></b></td>
268 <td><code>%REMOTE_USER%</code></td>
269 <td> REMOTE_USER environment variable, is <b></b></td>
272 <td><code>%INCLUDE{"page" ...}%</code></td>
273 <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">
275 <td><code>"SomeTopic"</code></td>
276 <td> The name of a topic located in the current web, i.e. <code>%INCLUDE{"WebNotify"}%</code></td>
279 <td><code>"Web.Topic"</code></td>
280 <td> A topic in another web, i.e. <code>%INCLUDE{"TWiki.TWikiWebsTable"}%</code></td>
283 <td><code>"http://..."</code></td>
284 <td> A full qualified URL, i.e. <code>%INCLUDE{"http://twiki.org/"}%</code></td>
290 <td><code>%STARTINCLUDE%</code></td>
291 <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>
294 <td><code>%STOPINCLUDE%</code></td>
295 <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>
298 <td><code>%TOC%</code></td>
299 <td> Table of Content of current topic. </td>
302 <td><code>%TOC{"SomeTopic" ...}%</code></td>
303 <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>"<h2>text<h2>"</code>) are taken into account. (But not <code>"<H2>text<H2>"</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">
305 <th bgcolor="#99CCCC"><strong> Parameter: </strong></th>
306 <th bgcolor="#99CCCC"><strong> Description: </strong></th>
307 <th bgcolor="#99CCCC"><strong> Default: </strong></th>
310 <td><code>"TopicName"</code></td>
311 <td> topic name </td>
312 <td> Current topic </td>
315 <td><code>web="Name"</code></td>
316 <td> Name of web </td>
317 <td> Current web </td>
320 <td><code>depth="2"</code></td>
321 <td> Limit depth of headings shown in TOC </td>
324 </table> Examples: <code><b>%TOC{depth="2"}%</b></code>, <code><b>%TOC{"TWikiDocumentation" web="TWiki"}%</b></code></td>
327 <td><code>%SEARCH{"text" ...}%</code></td>
328 <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">
330 <th bgcolor="#99CCCC"><strong> Parameter: </strong></th>
331 <th bgcolor="#99CCCC"><strong> Description: </strong></th>
332 <th bgcolor="#99CCCC"><strong> Default: </strong></th>
335 <td><code>"text"</code></td>
336 <td> Search term. (Is a regular expression or literal, depending on the <code>regex</code> parameter) </td>
340 <td><code>search="text"</code></td>
341 <td> (Alternative to above) </td>
345 <td><code>web="Name"</code><br /><code>web="Main Know"</code><br /><code>web="all"</code></td>
346 <td> Wiki web to search: A web, a list of webs separated by whitespace, or <code>all</code> webs. [2] </td>
347 <td> Current web </td>
350 <td><code>scope="topic"</code><br /><code>scope="text"</code></td>
351 <td> Search topic name (title) or in the text (body) of the topic </td>
352 <td> Topic text (body) </td>
355 <td><code>order="topic"</code><br /><code>order="modified"</code><br /><code>order="editby"</code></td>
356 <td> Sort the results of search by the topic names, last modified time, or last editor </td>
357 <td> Sort by topic name </td>
360 <td><code>limit="all"</code><br /><code>limit="16"</code></td>
361 <td> Limit the number of results returned </td>
362 <td> All results </td>
365 <td><code>regex="on"</code></td>
366 <td>[[Main/RegularExpression]] search </td>
367 <td> Literal search </td>
370 <td><code>reverse="on"</code></td>
371 <td> Reverse the direction of the search </td>
372 <td> Ascending search </td>
375 <td><code>casesensitive="on"</code></td>
376 <td> Case sensitive search </td>
377 <td> Ignore case </td>
380 <td><code>nosummary="on"</code></td>
381 <td> Show topic title only </td>
382 <td> Show topic summary </td>
385 <td><code>bookview="on"</code></td>
386 <td>[[Main/BookView]] search, e.g. show complete topic text </td>
387 <td> Show topic summary </td>
390 <td><code>nosearch="on"</code></td>
391 <td> Suppress search string </td>
392 <td> Show search string </td>
395 <td><code>noheader="on"</code></td>
396 <td> Suppress search header <br /><span style="background: #FFB0B0"> <strong>Topics: Changed: By:</strong> </span></td>
397 <td> Show search header </td>
400 <td><code>nototal="on"</code></td>
401 <td> Do not show number of topics found </td>
402 <td> Show number </td>
404 </table> Example: <code><b>%SEARCH{"wiki" web="Main" scope="topic"}%</b></code></td>
407 <td><code>%VAR{"NAME" web="Web"}%</code></td>
408 <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>
416 [1] **_Note_**: The search form uses identical names for input fields.
418 [2] **_Note_**: A web can be excluded from a `web="all"` search if you define a `NOSEARCHALL=on` variable in its [[WebPreferences]].
420 ### <a name="Preferences Variables"></a> Preferences Variables
422 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):
431 <td><code>%WIKIWEBMASTER%</code></td>
432 <td><strong><em>SL</em></strong></td>
433 <td> Webmaster email address (sender of email notifications) , is <b></b></td>
436 <td><code>%WIKIWEBLIST%</code></td>
437 <td><strong><em>SL</em></strong></td>
438 <td> List of %WIKITOOLNAME% webs (in upper right corner of topics) </td>
441 <td><code>%WEBTOPICLIST%</code></td>
442 <td><strong><em>WL</em></strong></td>
443 <td> Common links of web (second line of topics) </td>
446 <td><code>%WEBCOPYRIGHT%</code></td>
447 <td><strong><em>SL</em></strong> , <strong><em>WL</em></strong></td>
448 <td> Copyright notice (bottom right corner of topics) </td>
451 <td><code>%WEBBGCOLOR%</code></td>
452 <td><strong><em>WL</em></strong></td>
453 <td> Background color of web </td>
456 <td><code>%NOSEARCHALL%</code></td>
457 <td><strong><em>WL</em></strong></td>
458 <td> Exclude web from a <code>web="all"</code> search (set variable to <code>on</code> for hidden webs) </td>
461 <td><code>%NEWTOPICBGCOLOR%</code></td>
462 <td><strong><em>SL</em></strong> , <em>UL</em></td>
463 <td> Background color of non existing topic. ( <strong><em>UL</em></strong> needs authentication for topic views ) </td>
466 <td><code>%NEWTOPICFONTCOLOR%</code></td>
467 <td><strong><em>SL</em></strong> , <em>UL</em></td>
468 <td> Font color of non existing topic. ( <strong><em>UL</em></strong> needs authentication for topic views ) </td>
471 <td><code>%EDITBOXWIDTH%</code></td>
472 <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
473 <td> Horizontal size of edit box, is <b> <code>%EDITBOXWIDTH%</code> </b></td>
476 <td><code>%EDITBOXHEIGHT%</code></td>
477 <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
478 <td> Vertical size of edit box, is <b> <code>%EDITBOXHEIGHT%</code> </b></td>
481 <td><code>%RELEASEEDITLOCKCHECKBOX%</code></td>
482 <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
483 <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>
486 <td><code>%DONTNOTIFYCHECKBOX%</code></td>
487 <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
488 <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>
491 <td><code>%ATTACHLINKBOX%</code></td>
492 <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
493 <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>
496 <td><code>%HTTP_EQUIV_ON_VIEW%</code></td>
497 <td><strong><em>SL</em></strong></td>
498 <td> http-equiv meta tags for view, rdiff, attach, search* scripts. </td>
501 <td><code>%HTTP_EQUIV_ON_EDIT%</code></td>
502 <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
503 <td> http-equiv meta tags for edit script. </td>
506 <td><code>%HTTP_EQUIV_ON_PREVIEW%</code></td>
507 <td><strong><em>SL</em></strong> , <strong><em>UL</em></strong></td>
508 <td> http-equiv meta tags for preview script. </td>
511 <td><code>%DENYWEBCHANGE%</code></td>
512 <td><strong><em>WL</em></strong></td>
513 <td> List of users and groups who are <strong>not allowed</strong> to change topics in the %WIKITOOLNAME% web. (More in [[Main/TWikiAccessControl]]) </td>
516 <td><code>%ALLOWWEBCHANGE%</code></td>
517 <td><strong><em>WL</em></strong></td>
518 <td> List of users and groups who are <strong>allowed</strong> to change topics in the %WIKITOOLNAME% web. (More in [[Main/TWikiAccessControl]]) </td>
521 <td><code>%DENYTOPICCHANGE%</code></td>
522 <td><strong><em>(any topic)</em></strong></td>
523 <td> List of users and groups who are <strong>not allowed</strong> to change the current topic. (More in [[Main/TWikiAccessControl]]) </td>
526 <td><code>%ALLOWTOPICCHANGE%</code></td>
527 <td><strong><em>(any topic)</em></strong></td>
528 <td> List of users and groups who are <strong>allowed</strong> to change the current topic. (More in [[Main/TWikiAccessControl]]) </td>
531 <td><code>%DENYWEBRENAME%</code></td>
532 <td><strong><em>WL</em></strong></td>
533 <td> List of users and groups who are <strong>not allowed</strong> to rename topics in the %WIKITOOLNAME% web. (More in [[Main/TWikiAccessControl]]) </td>
536 <td><code>%ALLOWWEBRENAME%</code></td>
537 <td><strong><em>WL</em></strong></td>
538 <td> List of users and groups who are <strong>allowed</strong> to rename topics in the %WIKITOOLNAME% web. (More in [[Main/TWikiAccessControl]]) </td>
541 <td><code>%DENYTOPICRENAME%</code></td>
542 <td><strong><em>(any topic)</em></strong></td>
543 <td> List of users and groups who are <strong>not allowed</strong> to rename the current topic. (More in [[Main/TWikiAccessControl]]) </td>
546 <td><code>%ALLOWTOPICRENAME%</code></td>
547 <td><strong><em>(any topic)</em></strong></td>
548 <td> List of users and groups who are <strong>allowed</strong> to rename the current topic. (More in [[Main/TWikiAccessControl]]) </td>
555 <td><code>%FINALPREFERENCES%</code></td>
556 <td><strong><em>SL</em></strong> , <strong><em>WL</em></strong></td>
557 <td> List of preferences that are not allowed to be overridden by next level preferences</td>
563 - Preferences variables ( on site-level, web-level and user level ) are defined by bullet lines with this syntax:
564 - `Set VARIABLENAME = value`
565 - Additional preferences variables can be defined on all three level as needed. Example:
566 - `Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif`
568 -- [[PeterThoeny]] - 23 Jul 2001 <br />