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 http://your.domain.com/twiki
%SCRIPTURL% The script URL of TWiki, is http://pyqplayer.sourceforge.net/cgi-bin/bin
%SCRIPTURLPATH% The path of the script URL of TWiki, is /cgi-bin/bin
%PUBURL% The public URL of TWiki, is http://pyqplayer.sourceforge.net/pub
%PUBURLPATH% The path of the public URL of TWiki, is /pub
%ATTACHURL% The attachment URL of the current topic, is http://pyqplayer.sourceforge.net/pub/TWiki/TWikiVariables
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 /pub/TWiki/TWikiVariables
%WIKITOOLNAME% Name of wiki tool, is TWiki
%WIKIVERSION% Wiki tool version, is 01 Sep 2004 $Rev: 1742 $
%USERNAME% Your login username, is guest
%WIKIUSERNAME% Your Wiki username, if defined in TWikiUsers. Same as %USERNAME% if not defined. Is Main.TWikiGuest
%WEB% The current web, is TWiki
%TOPIC% The current topic name, is TWikiVariables
%GMTIME% GM time, is 06 Nov 2024 - 03:10
%GMTIME{"format"}% Formatted GM time based on keywords (first three characters needed.)
Example: %GMTIME{"day month, year - hour:min:sec"}% is day month, year - hour:min:sec
%SERVERTIME% Server time, is 06 Nov 2024 - 03:10
%SERVERTIME{"format"}% Formatted server time. Example: %SERVERTIME{"hou:min"}% is hou:min
%HTTP_HOST% HTTP_HOST environment variable, is pyqplayer.sourceforge.net
%REMOTE_ADDR% REMOTE_ADDR environment variable, is 127.0.0.1
%REMOTE_PORT% REMOTE_PORT environment variable, is 41044
%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" 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 dkessler@operamail.com
%WIKIWEBLIST% SL List of TWiki 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 70
%EDITBOXHEIGHT% SL , UL Vertical size of edit box, is 17
%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:

-- PeterThoeny - 29 May 2000

Revision: r1.8 - 28 Jul 2000 - 23:24 - PeterThoeny
TWiki > TWikiVariables
Copyright © 1999-2024 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Project hosting provided by:
SourceForge.net Logo
Donations welcome:
Support This Project