CGI Contrib Package Introduction This contrib does not add any features to TWiki. Its purpose is to convert Perl`s CGI module from being an external dependency to...

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 no INCLUDE....

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 % WEB% in case...

CHILDREN find children of a topic Find direct children of a topic, as defined by the parent child relationship between topics. To find children recursively...

CONTENTMODE{web `WEB`} content mode Returns the content mode of the specified web. It`s either `local`, `read only`, `master`, or `slave`. Read ReadOnlyAndMirrorWebs...

DATE signature format date Syntax: % DATE% Expands to: Date format defined as {DefaultDateFormat} in configure, default $year $mo $day Note...

DISPLAYTIME display date and time Syntax: % DISPLAYTIME% Expands to: Date part of the format is displayed as defined by the {DefaultDateFormat...

DISPLAYTIME{`format`} formatted display time Formatted time either GMT or Local server time, depending on {DisplayTimeValues} setting in configure, default...

ENV{`varname`} inspect the value of an environment variable Returns the current value of the environment variable in the CGI (Common Gateway Interface) environment...

FAILEDPLUGINS debugging for plugins that failed to load, and handler list Syntax: % FAILEDPLUGINS% Expands to: See TWikiPlugins#FAILEDPLUGINS Category...

HOMETOPIC home topic in each web Note: Each web has a home topic Syntax: % HOMETOPIC% Expands to: , renders as Category: SystemInformationVariables...

HTTP get HTTP headers Called with the name of an HTTP header field, returns its value. Capitalization and the use of hyphens versus underscores are not significant...

HTTP HOST environment variable Syntax: % HTTP HOST% Expands to: Category: SystemInformationVariables Related: ENV, REMOTE ADDR, REMOTE PORT...

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 used to determine...

INCLUDINGTOPIC name of topic that includes current topic The name of the topic that includes the current topic same as % TOPIC% in case there is no include...

INCLUDINGWEB web that includes current topic The web name of the topic that includes the current topic same as % WEB% if there is no INCLUDE. Syntax...

LANGUAGE current user`s language Returns the language code for the language used as the current user. This is the language actually used by TWiki Internationalization...

LANGUAGES list available TWiki languages List the languages available (as PO files) to TWiki. Those are the languages in which TWiki`s user interface is...

LOCALSITEPREFS web.topicname of site preferences topic The full name of the local site preferences topic. These local site preferences overload the system level...

MAINWEB synonym for USERSWEB Deprecated. Please use % USERSWEB% instead. Category: SystemInformationVariables Related: SYSTEMWEB, USERSWEB

MDREPO retrieve data from metadata repository Attention: This variable works only if MetadataRepository is in use. Otherwise, it always returns a zero length...

META displays meta data Provided mainly for use in templates, this variable generates the parts of the topic view that relate to meta data (attachments, forms...

METASEARCH special search of meta data Syntax: % METASEARCH{... Supported parameters: Parameter: Description: Default: type...

NOTIFYTOPIC name of the notify topic Note: Each web has a notify topic Syntax: % NOTIFYTOPIC% Expands to: , renders as Category: SystemInformationVariabl...

PARENTTOPIC parent of current topic Syntax: % PARENTTOPIC% or % PARENTTOPIC{ format `...` topic `...` Expands to: , renders as Parameters...

PLUGINDESCRIPTIONS list of plugin descriptions Syntax: % PLUGINDESCRIPTIONS% Expands to: Category: AdministrationVariables, SystemInformationVariables...

PLUGINVERSION the version of a TWiki Plugin, or the TWiki Plugins API Syntax: % PLUGINVERSION{`name` to get the version of a specific plugin Example:...

PUBURL the base URL of attachments Syntax: % PUBURL% Expands to: Example: You can refer to a file attached to another topic with % PUBURL%/% WEB...

PUBURLPATH the base URL path of attachments Syntax: % PUBURLPATH% Expands to: Category: AttachmentsAndFilesVariables, SystemInformationVariables...

QUERYPARAMS show paramaters to the query Expands the parameters to the query that was used to display the page. Syntax: % QUERYPARAMS{... Parameters...

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 current page. For example...

REMOTE ADDR environment variable Syntax: % REMOTE ADDR% Expands to: Category: DevelopmentVariables, SystemInformationVariables Related:...

REMOTE PORT environment variable Syntax: % REMOTE PORT% Expands to: Category: DevelopmentVariables, SystemInformationVariables Related: ENV...

REMOTE USER environment variable Syntax: % REMOTE USER% Expands to: Category: DevelopmentVariables, SystemInformationVariables, UsersAndAuthenticationVariables...

REVINFO revision information of current topic Syntax: % REVINFO% Expands to: Date format defined as {DefaultDateFormat} in configure, default $year...

REVINFO{`format`} formatted revision information of topic Syntax: % REVINFO{`format` Supported parameters: Parameter: Description: Default...

SCRIPTNAME name of current script The name of the current script is shown, including script suffix, if any (for example viewauth.cgi ) Syntax: % SCRIPTNAME...

SCRIPTSUFFIX script suffix Some TWiki installations require a file extension for CGI scripts, such as .pl or .cgi Syntax: % SCRIPTSUFFIX%...

SCRIPTURL base URL of TWiki scripts Syntax: % SCRIPTURL% Expands to: Note: The edit script should always be used in conjunction with ?t % GMTIME...

SCRIPTURL{`script`} URL of TWiki script Expands to the URL of the specified script. Optionally, you can specify a web and/or a topic. In that case,...

SCRIPTURLPATH base URL path of TWiki scripts As % SCRIPTURL% , but doesn`t include the protocol and host part of the URL Syntax: % SCRIPTURLPATH%...

SCRIPTURLPATH{`script`} URL path of TWiki script As % SCRIPTURL{`script` , but doesn`t include the protocol and host part of the URL Like % SCRIPTURL{...

SERVERTIME server time Syntax: % SERVERTIME% Expands to: Date format defined as {DefaultDateFormat} in configure, default $year $mo $day...

SERVERTIME{`format`} formatted server time Same format qualifiers as % GMTIME% Syntax: % SERVERTIME{`format` Supported variables: $seconds ,...

SESSIONID unique ID for this session Syntax: % SESSIONID% Expand to: Category: DevelopmentVariables, SystemInformationVariables, UsersAndAuthenticationVariables...

SESSIONVAR name of CGI and session variable that stores the session ID Syntax: % SESSIONVAR% Expand to: Category: DevelopmentVariables, SystemInformationVariables...

SESSION VARIABLE get, set or clear a session variable Session variables are stored in a personal `persistent memory space` that is not lost until the web browser...

SITENAME the current site name Syntax: % SITENAME% Supported parameters: none Returns the current site name defined by {ReadOnlyAndMirrorWebs}{SiteName...

SITESTATISTICSTOPIC name of site statistics topic Note: The site statistics topic is assumed to be in the web. Syntax: % SITESTATISTICSTOPIC% Expands...

STATISTICSTOPIC name of statistics topic Note: Each web has a statistics topic Syntax: % STATISTICSTOPIC% Expands to: , renders as Category...

SYSTEMWEB name of TWiki documentation web The web containing all documentation and default preference settings Syntax: % SYSTEMWEB% Expands to:...

TOPIC name of current topic % TOPIC% expands to the name of the topic. If you are looking at the text of an included topic, it is the name of the included topic...

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 variables: The $topic...

TOPICTITLE title of a topic The topic title is defined by, in order of sequence: form field named `Title`, topic preference setting named TITLE...

TOPICURL shortcut to viewing the current topic This variable always expands to an url pointing to the current base topic. Type: Preference variable TWikiRenderingShortcut...

TWIKIWEB synonym for SYSTEMWEB Deprecated. Please use % SYSTEMWEB% instead. Category: SystemInformationVariables Related: SYSTEMWEB, USERSWEB

URLPARAM{`name`} get value of a URL parameter Returns the value of a URL parameter. Syntax: % URLPARAM{`name` Supported parameters: Parameter...

USERINFO{`name`} retrieve details about a user Syntax: % USERINFO% Expands to: (comma separated list of the username, wikiusername, and emails) With...

USERNAME your login username TWiki makes names available in three formats: USERNAME like jsmith , WIKINAME like JohnSmith and WIKIUSERNAME like .JohnSmith...

USERSWEB name of users web The web containing individual user topics, .TWikiGroups, and customized site wide preferences. Syntax: % USERSWEB% Expands...

VAR{`NAME` ...} get a preference value from another web or topic and more Gets the value of a variable in various manners. If the topic parameter...

WEB name of current web % WEB% expands to the name of the web where the topic is located. If you are looking at the text of an included topic, it is the web...

WEBLIST{`format`} index of all webs List of all webs. Obfusticated webs are excluded, e.g. webs with a NOSEARCHALL on preference variable. The `format`...

WEBPREFSTOPIC name of web preferences topic Syntax: % WEBPREFSTOPIC% Expands to: , renders as Category: AdministrationVariables, SystemInformationVariables...

WIKIHOMEURL site home URL DEPRECATED, please use % WIKILOGOURL% instead. Syntax: % WIKIHOMEURL% Expands to: Defined in: TWikiPreferences,...

WIKILOGOALT site logo tooltip message Syntax: % WIKILOGOALT% Expands to: Defined in: TWikiPreferences Category: AdministrationVariables, SystemInformationVar...

WIKILOGOIMG site logo image URL Syntax: % WIKILOGOIMG% Expands to: Renders as: Defined in: TWikiPreferences Category: AdministrationVariables...

WIKILOGOURL site logo home URL Syntax: % WIKILOGOURL% Expands to: Defined in: TWikiPreferences, default % SCRIPTURLPATH{`view`/% USERSWEB%/% HOMETOPIC...

WIKINAME your Wiki username The WikiName is the same as % USERNAME% if not defined in the . topic Syntax: % WIKINAME% Expands to: Note:...

WIKIPREFSTOPIC name of site wide preferences topic Syntax: % WIKIPREFSTOPIC% Expands to: , renders as Category: AdministrationVariables, SystemInformationVari...

WIKITOOLNAME name of your TWiki site Syntax: % WIKITOOLNAME% Expands to: TWiki Category: SystemInformationVariables Related: WIKILOGOURL, WIKIVERSION...

WIKIUSERNAME your Wiki username with web prefix Your % WIKINAME% with web prefix, useful to point to your user profile page Syntax: % WIKIUSERNAME%...

WIKIUSERSTOPIC name of topic listing all registers users Syntax: % WIKIUSERSTOPIC% Expands to: , with prefix renders as . Category: SystemInformationVariables...

WIKIVERSION the version of the installed TWiki engine Syntax: % WIKIVERSION% Expands to: Category: AdministrationVariables, SystemInformationVariables...

WIKIWEBMASTER email address of the administrator % WIKIWEBMASTER% expands to the email address of the administrator of . Syntax: % WIKIWEBMASTER% , expands...

WIKIWEBMASTERNAME name of the administrator % WIKIWEBMASTERNAME% expands to the name of the administrator of . Syntax: % WIKIWEBMASTERNAME% , expands...