TWiki expands the following variables enclosed in % percent signs:
Variable: Expanded to:
%WIKIHOMEURL% The base script URL of TWiki, link of Home icon in upper left corner, is %WIKIHOMEURL%
%SCRIPTURL% The script URL of TWiki, is http://www.dementia.org/twiki/
%SCRIPTURLPATH% The path of the script URL of TWiki, is http://www.dementia.org/twiki/
%PUBURL% The public URL of TWiki, is http://www.dementia.org/twiki//view
%PUBURLPATH% The path of the public URL of TWiki, 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%
%TOPIC% The current topic name, is %TOPIC%
%DATE% Todays date (local server time), is 29 Jun 2010
%GMTIME% Todays date (GM time), is 29 Jun 2010 - 15:24
%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{"file.ext"}% Server side include, includes the text of a file. The default directory is the current Wiki web. Example: %INCLUDE{"../Know/TopicName.txt"}%
%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:
Pair: Description: Default:
web="Name" Specify Wiki web to search Current web
scope="topic" Search topic name (title) Topic text (body)
regex="on" [[Main/RegularExpression]] search Literal search
casesensitive="on" Case sensitive search Ignore case
nosummary="on" Show topic title only Show topic summary
nosearch="on" Suppress search string Show search string
nototal="on" Do not show number of topics found Show number
Example: %SEARCH{"wiki" web="Main" scope="topic"}%
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):
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
%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%
-- [[PeterThoeny]] - 29 May 2000