%WIKITOOLNAME% expands the following variables enclosed in % percent signs:
Variable: | Expanded to: | |||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
%WIKIHOMEURL% |
The base script URL of %WIKITOOLNAME%, is the link of the Home icon in the upper left corner, is %WIKIHOMEURL% | |||||||||||||||||||||||||||||||||||||||
%SCRIPTURL% |
The script URL of %WIKITOOLNAME%, is http://www.dementia.org/twiki/ | |||||||||||||||||||||||||||||||||||||||
%SCRIPTURLPATH% |
The path of the script URL of %WIKITOOLNAME%, is http://www.dementia.org/twiki/ | |||||||||||||||||||||||||||||||||||||||
%SCRIPTSUFFIX% |
The script suffix, i.e. .pl , is |
|||||||||||||||||||||||||||||||||||||||
%PUBURL% |
The public URL of TWiki, is http://www.dementia.org/twiki//view | |||||||||||||||||||||||||||||||||||||||
%PUBURLPATH% |
The path of the public URL of %WIKITOOLNAME%, is http://www.dementia.org/twiki//view | |||||||||||||||||||||||||||||||||||||||
%ATTACHURL% |
The attachment URL of the current topic, is http://www.dementia.org/twiki//view Example: If you attach a file you can refer to it as %ATTACHURL%/image.gif |
|||||||||||||||||||||||||||||||||||||||
%ATTACHURLPATH% |
The path of the attachment URL of the current topic, is http://www.dementia.org/twiki//view | |||||||||||||||||||||||||||||||||||||||
%WIKITOOLNAME% |
Name of wiki tool, is %WIKITOOLNAME% | |||||||||||||||||||||||||||||||||||||||
%WIKIVERSION% |
Wiki tool version, is TWiki-4.1.2, Sat, 03 Mar 2007, build 13046 | |||||||||||||||||||||||||||||||||||||||
%USERNAME% |
Your login username, is admin | |||||||||||||||||||||||||||||||||||||||
%WIKIUSERNAME% |
Your Wiki username, if defined in [[Main/TWikiUsers]]. Same as %USERNAME% if not defined. Is Main.admin | |||||||||||||||||||||||||||||||||||||||
%WEB% |
The current web, is %WEB% | |||||||||||||||||||||||||||||||||||||||
%BASEWEB% |
The web name where the includes started, e.g. the web of the first topic of nested includes. Same as %WEB% in case there is no include. |
|||||||||||||||||||||||||||||||||||||||
%INCLUDINGWEB% |
The web name of the topic that includes the current topic. Same as %WEB% in case there is no include. |
|||||||||||||||||||||||||||||||||||||||
%TOPIC% |
The current topic name, is %TOPIC% | |||||||||||||||||||||||||||||||||||||||
%BASETOPIC% |
The name of the topic where the includes started, e.g. the first topic of nested includes. Same as %TOPIC% in case there is no include. |
|||||||||||||||||||||||||||||||||||||||
%INCLUDINGTOPIC% |
The name of the topic that includes the current topic. Same as %TOPIC% in case there is no include. |
|||||||||||||||||||||||||||||||||||||||
%SPACEDTOPIC% |
The current topic name with added spaces, for regular expression search of Ref-By, is | |||||||||||||||||||||||||||||||||||||||
%GMTIME% |
GM time, is 29 Jun 2010 - 15:26 | |||||||||||||||||||||||||||||||||||||||
%GMTIME{"format"}% |
Formatted GM time based on time variables.
%GMTIME{"$day $month, $year - $hour:$min:$sec"}% is 29 Jun, 2010 - 15:26:06 |
|||||||||||||||||||||||||||||||||||||||
%SERVERTIME% |
Server time, is 29 Jun 2010 - 11:26 | |||||||||||||||||||||||||||||||||||||||
%SERVERTIME{"format"}% |
Formatted server time. Example: %SERVERTIME{"$hou:$min"}% is 11:26 |
|||||||||||||||||||||||||||||||||||||||
%HTTP_HOST% |
HTTP_HOST environment variable, is | |||||||||||||||||||||||||||||||||||||||
%REMOTE_ADDR% |
REMOTE_ADDR environment variable, is | |||||||||||||||||||||||||||||||||||||||
%REMOTE_PORT% |
REMOTE_PORT environment variable, is | |||||||||||||||||||||||||||||||||||||||
%REMOTE_USER% |
REMOTE_USER environment variable, is | |||||||||||||||||||||||||||||||||||||||
%INCLUDE{"SomeTopic"}% |
Server side include, includes another topic. The current Wiki web is searched by default. Example: %INCLUDE{"TWiki.TWikiWebsTable"}% |
|||||||||||||||||||||||||||||||||||||||
%STARTINCLUDE% |
If present in included topic, start to include text from this location up to the end, or up to the location of the %STOPINCLUDE% variable. A normal view of the topic shows everyting exept the %STARTINCLUDE% variable itself. |
|||||||||||||||||||||||||||||||||||||||
%STOPINCLUDE% |
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 %STOPINCLUDE% variable itself. |
|||||||||||||||||||||||||||||||||||||||
%TOC% |
Table of Content of current topic. | |||||||||||||||||||||||||||||||||||||||
%TOC{"SomeTopic" ...}% |
Table of Content. Shows a TOC that is generated automatically based on headings of a topic. Headings in [[Main/WikiSyntax]] ("---++ text" ) and HTML ("<h2>text<h2>" ) are taken into account. Parameter is composed of the topic name, followed by optional name="value" pairs:
%TOC{depth="2"}% , %TOC{"TWikiDocumentation" web="TWiki"}% |
|||||||||||||||||||||||||||||||||||||||
%SEARCH{"str" ...}% |
Inline search, shows a search result embedded in a topic. Parameter is composed of the search string, followed by optional name="value" pairs:
%SEARCH{"wiki" web="Main" scope="topic"}% |
|||||||||||||||||||||||||||||||||||||||
%VAR{"NAME" web="Web"}% |
Get a preference value from another web then the current one. Example: To get %WEBBGCOLOR% of the Main web write %VAR{"WEBBGCOLOR" web="Main"}% , is
|
|
Variable: | Level: | What: |
---|---|---|
%WIKIWEBMASTER% |
SL | Webmaster email address (sender of email notifications) , is |
%WIKIWEBLIST% |
SL | List of %WIKITOOLNAME% webs (in upper right corner of topics) |
%WEBTOPICLIST% |
WL | Common links of web (second line of topics) |
%WEBCOPYRIGHT% |
SL , WL | Copyright notice (bottom right corner of topics) |
%WEBBGCOLOR% |
WL | Background color of web |
%NOSEARCHALL% |
WL | Exclude web from a web="all" search (set variable to on for hidden webs) |
%NEWTOPICBGCOLOR% |
SL , UL | Background color of non existing topic. ( UL needs authentication for topic views ) |
%NEWTOPICFONTCOLOR% |
SL , UL | Font color of non existing topic. ( UL needs authentication for topic views ) |
%EDITBOXWIDTH% |
SL , UL | Horizontal size of edit box, is %EDITBOXWIDTH% |
%EDITBOXHEIGHT% |
SL , UL | Vertical size of edit box, is %EDITBOXHEIGHT% |
%ATTACHLINKBOX% |
SL , UL | Default state of the link check box in the attach file page. Check box is initially checked if value is set to CHECKED , unchecked if empty. If checked, a link is created to the attached file at the end of the topic. Value is: %ATTACHLINKBOX% |
%HTTP_EQUIV_ON_VIEW% |
SL | http-equiv meta tags for view, rdiff, attach, search* scripts. |
%HTTP_EQUIV_ON_EDIT% |
SL , UL | http-equiv meta tags for edit script. |
%HTTP_EQUIV_ON_PREVIEW% |
SL , UL | http-equiv meta tags for preview script. |
%DENYWEBCHANGE% |
WL | List of users and groups who are not allowed to change topics in the %WIKITOOLNAME% web. (More in [[Main/TWikiAccessControl]]) |
%ALLOWWEBCHANGE% |
WL | List of users and groups who are allowed to change topics in the %WIKITOOLNAME% web. (More in [[Main/TWikiAccessControl]]) |
%DENYTOPICCHANGE% |
(any topic) | List of users and groups who are not allowed to change the current topic. (More in [[Main/TWikiAccessControl]]) |
%ALLOWTOPICCHANGE% |
(any topic) | List of users and groups who are allowed to change the current topic. (More in [[Main/TWikiAccessControl]]) |
%FINALPREFERENCES% |
SL , WL | List of preferences that are not allowed to be overridden by next level preferences |