TWiki Variables

Predefined Variables

GNHLUG expands the following variables enclosed in % percent signs:

Variable:	Expanded to:
%WIKIHOMEURL%	The base script URL of GNHLUG, is the link of the Home icon in the upper left corner, is /Main/WebHome
%SCRIPTURL%	The script URL of GNHLUG, is http://wiki.gnhlug.org/bin
%SCRIPTURLPATH%	The path of the script URL of GNHLUG, is /bin
%SCRIPTSUFFIX%	The script suffix, i.e. .pl, is
%PUBURL%	The public URL of TWiki, is http://wiki.gnhlug.org/pub
%PUBURLPATH%	The path of the public URL of GNHLUG, is /pub
%ATTACHURL%	The attachment URL of the current topic, is http://wiki.gnhlug.org/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
%URLPARAM{"name"}%	Returns the value of a URL parameter. I.e. %URLPARAM{"skin"}% returns print for a .../view/TWiki/TWikiVariables?skin=print URL. Is
%WIKITOOLNAME%	Name of wiki tool, is GNHLUG
%WIKIVERSION%	Wiki tool version, is TWiki-6.1.0, Mon, 16 Jul 2018, build 30610
%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
%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 TWikiVariables
%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 TWiki%20*Variables
%GMTIME%	GM time, is 2024-11-01 - 00:36
%GMTIME{"format"}%	Formatted GM time based on time variables. Variable: Unit: Example $seconds seconds 59 $minutes minutes 59 $hours hours 23 $day day of month 31 $month month in ISO format Dec $mo 2 digit month 12 $year 4 digit year 1999 $ye 2 digit year 99 Variables can be shortened to 3 characters. Example: %GMTIME{"$day $month, $year - $hour:$min:$sec"}% is 01 Nov, 2024 - 00:36:51
%SERVERTIME%	Server time, is 2024-10-31 - 20:36
%SERVERTIME{"format"}%	Formatted server time. Example: %SERVERTIME{"$hou:$min"}% is 20:36
%HTTP_HOST%	HTTP_HOST environment variable, is wiki.gnhlug.org
%REMOTE_ADDR%	REMOTE_ADDR environment variable, is 13.58.201.75
%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 WikiSyntax ("---++ text") and HTML ("<h2>text<h2>") are taken into account. Parameter is composed of the topic name, followed by optional name="value" pairs: Pair: Description: Default: web="Name" Name of web Current web depth="2" Limit depth of headings shown in TOC 6 Examples: %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 term (enclosed in double quotes), followed by optional name="value" pairs: [1] 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 [2] Current web search="food" Search term, (either regex or literal, depending on the regex parameter) (used if initial search term is missing) scope="topic" scope="text" Search topic name (title) or in the text (body) of the topic Topic text (body) reverse="on" Reverse the direction of the search Ascending search regex="on" RegularExpression search Literal search 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 nototal="on" Do not show number of topics found Show number nosummary="on" Show topic title only Show topic summary nosearch="on" Suppress search string Show search string noheader="on" Suppress search header Topics: Changed: By: Show search header limit="all" limit="16" Limit the number of results returned All results casesensitive="on" Case sensitive search Ignore case bookview="on" BookView search, e.g. show complete topic text Show topic summary Example: %SEARCH{"wiki" web="Main" scope="topic"}%
%VAR{"NAME" web="Web"}%	Get a preference value from a web other then the current one. Example: To get %WEBBGCOLOR% of the Main web write %VAR{"WEBBGCOLOR" web="Main"}%, is #99CCFF

[1] Note: The search form uses identical names for input fields.

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

Preferences Variables

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):

Notes:

• Preferences variables ( on site-level, web-level and user level ) are defined by bullet lines with this syntax:
  • Set VARIABLENAME = value
• Additional preferences variables can be defined on all three level as needed. Example:
  • Set MYLOGO = %PUBURLPATH%/%MAINWEB%/LogoTopic/logo.gif

-- PeterThoeny - 24 Mar 2001