netfrag.org . TWiki . TWikiVariables

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://TWiki.org/
%SCRIPTURL% The script URL of TWiki, is http://www.netfrag.org/twiki/bin
%SCRIPTURLPATH% The path of the script URL of TWiki, is /twiki/bin
%PUBURL% The public URL of TWiki, is http://www.netfrag.org/twiki/pub
%PUBURLPATH% The path of the public URL of TWiki, is /twiki/pub
%ATTACHURL% The attachment URL of the current topic, is http://www.netfrag.org/twiki/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 /twiki/pub/TWiki/TWikiVariables
%WIKITOOLNAME% Name of wiki tool, is netfrag.org
%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.TWikiGuest
%WEB% The current web, is TWiki
%TOPIC% The current topic name, is TWikiVariables
%SPACEDTOPIC% The current topic name with added spaces, for regular expression search of Ref-By, is TWiki%20*Variables
%GMTIME% GM time, is 31 Oct 2024 - 23:06
%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 01 Nov 2024 - 00:06
%SERVERTIME{"format"}% Formatted server time. Example: %SERVERTIME{"hou:min"}% is hou:min
%HTTP_HOST% HTTP_HOST environment variable, is www.netfrag.org
%REMOTE_ADDR% REMOTE_ADDR environment variable, is 3.137.178.169
%REMOTE_PORT% REMOTE_PORT environment variable, is 7135
%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"}%
%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"
web="Main Know"
web="all" 		Wiki web to search: A web, a list of webs separated by whitespace, or all webs [1] Current web
scope="topic"
scope="text" 		Search topic name (title) or in the text (body) of the topic Topic text (body)
order="topic"
order="modified"
order="editby" 		Sort the results of search by the topic names, last modified time, or last editor Sort by topic name
limit="all"
limit="16" 		Limit the number of results returned All results
regex="on" RegularExpression search Literal search
reverse="on" Reverse the direction of the search Ascending search
casesensitive="on" Case sensitive search Ignore case
nosummary="on" Show topic title only Show topic summary
bookview="on" BookView search, e.g. show complete topic text 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"}%

[1] Note: A web can be excluded from a web="all" search if you define a NOSEARCHALL=on variable in its WebPreferences.

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 webmaster@netfrag.org
%WIKIWEBLIST% SL List of netfrag.org 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 100
%EDITBOXHEIGHT% SL , UL Vertical size of edit box, is 20
%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:
%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.

-- PeterThoeny? - 18 Sep 2000

----- Revision r1.11 - 20 Sep 2000 - 01:00 - PeterThoeny?