# TWiki Formatted Search Inline search feature allows flexible formatting of search result The default output format of a %SEARCH{...}% is a table consisting of t...
#VarACTIVATEDPLUGINS ACTIVATEDPLUGINS list of currently activated plugins * Syntax: %ACTIVATEDPLUGINS% * Expands to: * Related: PLUGINDESCRIPTIONS, F...
#VarALLVARIABLES ALLVARIABLES list of currently defined TWikiVariables * Syntax: %ALLVARIABLES% * Expands to: a table showing all defined TWikiVariables ...
#VarATTACHURL ATTACHURL full URL for attachments in the current topic * Syntax: %ATTACHURL% * Expands to: == * Example: If you attach a file you can r...
#VarATTACHURLPATH ATTACHURLPATH path of the attachment URL of the current topic * Syntax: %ATTACHURLPATH% * Expands to: == * Related: ATTACHURL, PUBUR...
#VarAUTHREALM AUTHREALM authentication realm * String defined as {AuthRealm} in configure. This is used in certain password encodings, and in login template...
#VarBASETOPIC BASETOPIC base topic where an INCLUDE started * The name of the topic where a single or nested INCLUDE started same as %TOPIC% if there is n...
#VarBASEWEB BASEWEB base web where an INCLUDE started * The web name where the includes started, e.g. the web of the first topic of nested includes. Same as...
#VarDATE DATE signature format date * Syntax: %DATE% * Expands to: == * _ Note:_ When used in a template topic, this variable will be expanded when th...
#VarDISPLAYTIME2 DISPLAYTIME{"format"} formatted display time * Formatted time either GMT or Local server time, depending on setting in configure. Same fo...
#VarENCODE ENCODE{"string"} encodes a string to HTML entities * Encode "special" characters to HTML numeric entities. Encoded characters are: * all no...
#VarENDSECTION ENDSECTION{"name"} marks the end of a named section within a topic * Syntax: %ENDSECTION{"name"}% * Syntax: %ENDSECTION{type="include"}% ...
#VarFAILEDPLUGINS FAILEDPLUGINS debugging for plugins that failed to load, and handler list * Syntax: %FAILEDPLUGINS% * Expands to: See TWikiPlugins#FAIL...
#VarGMTIME GMTIME GM time * Syntax: %GMTIME% * Expands to: == * _ Note:_ When used in a template topic, this variable will be expanded when the templa...
#VarHTTP HTTP get HTTP headers * Called with the name of an HTTP header field, returns its value. Capitalization and the use of hyphens versus underscores a...
#VarHTTPS HTTPS get HTTPS headers * The same as %HTTP% but operates on the HTTPS environment variables present when the SSL protocol is in effect. Can be us...
#VarICON ICON{"name"} small documentation graphic or icon of common attachment types * Generates the HTML img tag of a small graphic image attached to TWiki...
#VarICONURL ICONURL{"name"} URL of small documentation graphic or icon * Generates the full URL of a TWikiDocGraphics image, which TWiki renders as an image...
#VarICONURLPATH ICONURLPATH{"name"} URL path of small documentation graphic or icon * Generates the URL path of a TWikiDocGraphics image, typically used in ...
#VarIF IF{"condition" ...} simple conditionals * Evaluate a condition and show one text or another based on the result. See details in IfStatements * Syn...
#VarINCLUDINGTOPIC INCLUDINGTOPIC name of topic that includes current topic * The name of the topic that includes the current topic same as %TOPIC% in cas...
#VarINCLUDINGWEB INCLUDINGWEB web that includes current topic * The web name of the topic that includes the current topic same as %WEB% if there is no INC...
#VarLANGUAGE LANGUAGE current user's language * Returns the language code for the language used as the current user. This is the language actually used by T...
#VarLANGUAGES LANGUAGES list available TWiki languages * List the languages available (as PO files) to TWiki. Those are the languages in which TWiki's ...
#VarLOCALSITEPREFS LOCALSITEPREFS web.topicname of site preferences topic * The full name of the local site preferences topic. This topic is read for prefer...
#VarLOGIN LOGIN present a full login link * Syntax: %LOGIN% * Expand to: * Related: TWikiUserAuthentication, SESSIONID, SESSIONVAR, LOGOUT, SESSION_V...
#VarLOGOUT LOGOUT present a full logout link * Syntax: %LOGOUT% * Expand to: * Related: TWikiUserAuthentication, SESSIONID, SESSIONVAR, LOGIN, SESSIO...
#VarMETA META displays meta data * Provided mainly for use in templates, this variable generates the parts of the topic view that relate to meta data (attac...
#VarNOP NOP template text not to be expanded in instantiated topics * Syntax: %NOP% * In normal topic text, expands to nop , which prevents expansion...
#VarPLUGINVERSION PLUGINVERSION the version of a TWiki Plugin, or the TWiki Plugins API * Syntax: %PLUGINVERSION{"name"}% to get the version of a specific p...
#VarPUBURL PUBURL the base URL of attachments * Syntax: %PUBURL% * Expands to: == * Example: You can refer to a file attached to another topic with %P...
#VarQUERYSTRING QUERYSTRING full, unprocessed string of parameters to this URL * String of all the URL parameters that were on the URL used to get to the cu...
#VarSCRIPTNAME SCRIPTNAME name of current script * The name of the current script is shown, including script suffix, if any (for example viewauth.cgi) * ...
#VarSCRIPTSUFFIX SCRIPTSUFFIX script suffix * Some Foswiki installations require a file extension for CGI scripts, such as .pl or .cgi * Syntax: %SCRIPTS...
#VarSCRIPTURL2 SCRIPTURL{"script"} URL of TWiki script * Syntax: %SCRIPTURL{"script"}% * Expands to: == * Example: To get the authenticated version of...
#VarSCRIPTURLPATH SCRIPTURLPATH base URL path of TWiki scripts * As %SCRIPTURL%, but doesn't include the protocol and host part of the URL * Syntax: %SCR...
#VarSCRIPTURLPATH2 SCRIPTURLPATH{"script"} URL path of TWiki script * As %SCRIPTURL{"script"}%, but doesn't include the protocol and host part of the URL ...
#VarSERVERTIME SERVERTIME server time * Syntax: %SERVERTIME% * Expands to: == * _ Note:_ When used in a template topic, this variable will be expanded...
#VarSERVERTIME2 SERVERTIME{"format"} formatted server time * Same format qualifiers as %GMTIME% * Syntax: %SERVERTIME{"format"}% * Example: %SERVERTIM...
#VarSESSIONID SESSIONID unique ID for this session * Syntax: %SESSIONID% * Expand to: * Related: TWikiUserAuthentication, AUTHREALM, SESSIONVAR, LOGI...
#VarSESSIONVAR SESSIONVAR name of CGI and session variable that stores the session ID * Syntax: %SESSIONVAR% * Expand to: * Related: TWikiUserAuthent...
#VarSPACEDTOPIC SPACEDTOPIC topic name, spaced and URL encoded deprecated * The current topic name with added URL encoded spaces, for use in regular express...
#VarSPACEOUT SPACEOUT{"string"} renders string with spaces inserted in sensible places * Inserts spaces after lower case letters that are followed by a digi...
#VarSTARTINCLUDE STARTINCLUDE start position of topic text if included * If present in included topic, start to include text from this location up to the en...
#VarSTARTSECTION STARTSECTION marks the start of a section within a topic * Section boundaries are defined with %STARTSECTION{}% and %ENDSECTION{}%. * Se...
#VarSTOPINCLUDE STOPINCLUDE end position of topic text if included * If present in included topic, stop to include text at this location and ignore the rema...
#VarTOC2 TOC{"Topic"} table of contents * Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSynta...
#VarTOPICLIST TOPICLIST{"format"} topic index of a web * List of all topics in a web. The "format" defines the format of one topic item. It may include vari...
#VarTWIKIWEB TWIKIWEB name of TWiki documentation web * The web containing all documentation and site wide preference settings for Foswiki * Syntax: %TWI...
#VarURLPARAM URLPARAM{"name"} get value of a URL parameter * Returns the value of a URL parameter. * Syntax: %URLPARAM{"name"}% * Supported parameters...
#VarUSERNAME USERNAME your login username * TWiki makes names available in three formats: USERNAME like jsmith, WIKINAME like JohnSmith and WIKIUSERNAME lik...
#VarVAR VAR{"NAME" web="Web"} get a preference value from another web * Syntax: %VAR{"NAME" web="Web"}% * Example: To get %WEBBGCOLOR% of the web write...
#VarWEBLIST WEBLIST{"format"} index of all webs * List of all webs. Obfusticated webs are excluded, e.g. webs with a NOSEARCHALL = on preference variable. T...
#VarWIKINAME WIKINAME your Wiki username * The WikiName is the same as %USERNAME% if not defined in the . topic * Syntax: %WIKINAME% * Expands to: == ...
#VarWIKIUSERNAME WIKIUSERNAME your Wiki username with web prefix * Your %WIKINAME% with web prefix, useful to point to your Foswiki home page * Syntax: ...
#VarWIKIUSERSTOPIC WIKIUSERSTOPIC name of topic listing all registers users * Syntax: %WIKIUSERSTOPIC% * Expands to: ==, with prefix renders as . * R...