Skip to topic | Skip to bottom
TWiki.TWikiVariablesr1.3 - 28 Feb 2000 - 08:23 - PeterThoeny?topic end

Start of topic | Skip to actions
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
%SCRIPTURL% The base script URL of TWiki, is
%PUBURL% The base public URL of TWiki, is
%ATTACHURL% The attachment URL of the current topic, is
Example: If you attach a file you can refer to it as %ATTACHURL%/image.gif
%WIKITOOLNAME% Name of wiki tool, is TWiki
%WIKIVERSION% Wiki tool version, is 04 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.guest
%WEB% The current web, is TWiki
%TOPIC% The current topic name, is TWikiVariables
%DATE% Todays date, is 20 Mar 2019
%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
%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 15

to top

You are here: TWiki > TWikiVariables

to top

Copyright © 1999-2019 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding this material Send feedback