Searched: ^v

Results from TWiki web retrieved at 15:54 (GMT)

ACTIVATEDPLUGINS list of currently activated plugins Syntax: % ACTIVATEDPLUGINS% Expands to: Related: PLUGINDESCRIPTIONS, FAILEDPLUGINS, PLUGINVERSION...
ALLVARIABLES list of currently defined TWikiVariables Syntax: % ALLVARIABLES% Expands to: a table showing all defined TWikiVariables in the current context...
ATTACHURL full URL for attachments in the current topic Syntax: % ATTACHURL% Expands to: https://wiki.e citiz.com/pub/TWiki/VarATTACHURL Example...
ATTACHURLPATH path of the attachment URL of the current topic Syntax: % ATTACHURLPATH% Expands to: https://wiki.e citiz.com/pub/TWiki/VarATTACHURLPATH...
AUTHREALM authentication realm String defined as {AuthRealm} in configure . This is used in certain password encodings, and in login templates as part of the...
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...
DATE signature format date Syntax: % DATE% Expands to: Note: When used in a template topic, this variable will be expanded when the template...
DISPLAYTIME display time Syntax: % DISPLAYTIME% Expands to: Related: DISPLAYTIME{`format`}, GMTIME, SERVERTIME
DISPLAYTIME{`format`} formatted display time Formatted time either GMT or Local server time, depending on setting in configure. Same format qualifiers as...
ENCODE{`string`} encodes a string to HTML entities Encode `special` characters to HTML numeric entities. Encoded characters are: all non printable ASCII...
ENDSECTION{`name`} marks the end of a named section within a topic Syntax: % ENDSECTION{`name` Syntax: % ENDSECTION{type `include` Supported parameter...
FAILEDPLUGINS debugging for plugins that failed to load, and handler list Syntax: % FAILEDPLUGINS% Expands to: See TWikiPlugins#FAILEDPLUGINS Related...
FORMFIELD{`fieldname`} renders a field in the form attached to some topic Syntax: % FORMFIELD{`fieldname` Supported parameters: Parameter:...
GMTIME GM time Syntax: % GMTIME% Expands to: Note: When used in a template topic, this variable will be expanded when the template is used...
GMTIME{`format`} formatted GM time Syntax: % GMTIME{`format` Supported variables: Variable: Unit: Example $seconds seconds...
GROUPS a formatted list of groups Expands to a formatted list of user groups in your TWiki. Syntax: % GROUPS% The variable is intended to be used...
HOMETOPIC home topic in each web Syntax: % HOMETOPIC% Expands to: , renders as Related: NOTIFYTOPIC, STATISTICSTOPIC, TOPIC
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: Related: REMOTE ADDR, REMOTE PORT, REMOTE USER
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...
ICON{`name`} small documentation graphic or icon of common attachment types Generates the HTML img tag of a small graphic image attached to TWikiDocGraphics....
ICONURL{`name`} URL of small documentation graphic or icon Generates the full URL of a TWikiDocGraphics image, which TWiki renders as an image. The related...
ICONURLPATH{`name`} URL path of small documentation graphic or icon Generates the URL path of a TWikiDocGraphics image, typically used in an HTML img tag. Specify...
IF{`condition` ...} simple conditionals Evaluate a condition and show one text or another based on the result. See details in IfStatements Syntax: % IF...
INCLUDE{`page`} include other topic or web page Syntax: % INCLUDE{`page` ... Supported parameters: Parameter: Description: Default:...
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. This topic is read for preferences before . is...
LOGIN present a full login link Syntax: % LOGIN% Expand to: Related: TWikiUserAuthentication, SESSIONID, SESSIONVAR, LOGOUT, SESSION VARIABLE
LOGOUT present a full logout link Syntax: % LOGOUT% Expand to: Related: TWikiUserAuthentication, SESSIONID, SESSIONVAR, LOGIN, SESSION VARIABLE
MAINWEB name of Main web The web containing ., individual user topics and .TWikiGroups Syntax: % MAINWEB% Expands to: Related: TWIKIWEB
MAKETEXT creates text using TWiki`s I18N infrastructure Syntax: % MAKETEXT{`string` args `...`} Supported parameters: Parameter Description...
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...
NOP template text not to be expanded in instantiated topics Syntax: % NOP% In normal topic text, expands to nop , which prevents expansion of adjacent...
NOTIFYTOPIC name of the notify topic Syntax: % NOTIFYTOPIC% Expands to: , renders as Related: HOMETOPIC, STATISTICSTOPIC, TOPIC
PLUGINDESCRIPTIONS list of plugin descriptions Syntax: % PLUGINDESCRIPTIONS% Expands to: Related: ACTIVATEDPLUGINS, FAILEDPLUGINS, PLUGINVERSION
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: Related: ATTACHURL, PUBURL, SCRIPTURL, SCRIPTURLPATH, FileAttachments...
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: Related: HTTP HOST, REMOTE PORT, REMOTE USER
REMOTE PORT environment variable Syntax: % REMOTE PORT% Expands to: Related: HTTP HOST, REMOTE ADDR, REMOTE USER
REMOTE USER environment variable Syntax: % REMOTE USER% Expands to: Related: HTTP HOST, REMOTE ADDR, REMOTE PORT, USERNAME, WIKINAME, WIKIUSERNAME...
REVINFO revision information of current topic Syntax: % REVINFO% Expands to: Related: REVINFO{`format`}
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: Related: PUBURL, SCRIPTNAME, SCRIPTSUFFIX, SCRIPTURL{`script`}, SCRIPTURLPATH...
SCRIPTURL{`script`} URL of TWiki script Syntax: % SCRIPTURL{`script` Expands to: Example: To get the authenticated version of the current topic...
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 Syntax: % SCRIPTURLPATH...
SEARCH{`text`} search content Inline search, shows a search result embedded in a topic Syntax: % SEARCH{`text` ... Supported parameters: Parameter...
SERVERTIME server time Syntax: % SERVERTIME% Expands to: Note: When used in a template topic, this variable will be expanded when the template...
SERVERTIME{`format`} formatted server time Same format qualifiers as % GMTIME% Syntax: % SERVERTIME{`format` Example: % SERVERTIME{`$hou:$min`...
SESSIONID unique ID for this session Syntax: % SESSIONID% Expand to: Related: TWikiUserAuthentication, AUTHREALM, SESSIONVAR, LOGIN, LOGOUT, SESSION...
SESSIONVAR name of CGI and session variable that stores the session ID Syntax: % SESSIONVAR% Expand to: Related: TWikiUserAuthentication, AUTHREALM...
SESSION VARIABLE get, set or clear a session variable Syntax: % SESSION VARIABLE{`name` Syntax: % SESSION VARIABLE{`name` set `value` Syntax:...
SPACEDTOPIC topic name, spaced and URL encoded deprecated The current topic name with added URL encoded spaces, for use in regular expressions that search for...
SPACEOUT{`string`} renders string with spaces inserted in sensible places Inserts spaces after lower case letters that are followed by a digit or a capital letter...
STARTINCLUDE start position of topic text if included If present in included topic, start to include text from this location up to the end, or up to the location...
STARTSECTION marks the start of a section within a topic Section boundaries are defined with % STARTSECTION{ and % ENDSECTION{ . Sections may be given...
STATISTICSTOPIC name of statistics topic Syntax: % STATISTICSTOPIC% Expands to: , renders as Related: HOMETOPIC, NOTIFYTOPIC, TOPIC
STOPINCLUDE end position of topic text if included If present in included topic, stop to include text at this location and ignore the remaining text. A normal...
TOC table of contents of current topic Syntax: % TOC% Related: TOC{`Topic`}
TOC{`Topic`} table of contents Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax ( ` text`...
TOPIC name of current topic Syntax: % TOPIC% Expands to: , renders as Related: BASETOPIC, INCLUDINGTOPIC, TOPICLIST, WEB
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 $name...
TWIKIWEB name of TWiki documentation web The web containing all documentation and site wide preference settings for TWiki Syntax: % TWIKIWEB%...
URLPARAM{`name`} get value of a URL parameter Returns the value of a URL parameter. Syntax: % URLPARAM{`name` Supported parameters: Parameter...
USERINFO retrieve details about a user (by default the logged in user) Syntax: % USERINFO% Expands to: To format that information differently:...
USERNAME your login username TWiki makes names available in three formats: USERNAME like jsmith , WIKINAME like JohnSmith and WIKIUSERNAME like .JohnSmith...
VAR{`NAME` web `Web`} get a preference value from another web Syntax: % VAR{`NAME` web `Web` Example: To get % WEBBGCOLOR% of the web write % VAR...
WEB name of current web Syntax: % WEB% Expands to: TWiki Related: BASEWEB, INCLUDINGWEB, TOPIC
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 Related: HOMETOPIC, WIKIPREFSTOPIC, VAR
WIKIHOMEURL site home URL deprecated Note: use % WIKILOGOURL% defined in WebPreferences instead.
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 Related: HOMETOPIC, WEBPREFSTOPIC
WIKITOOLNAME name of your TWiki site Syntax: % WIKITOOLNAME% Expands to: TWiki Related: WIKIHOMEURL, WIKIVERSION
WIKIUSERNAME your Wiki username with web prefix Your % WIKINAME% with web prefix, useful to point to your TWiki home page Syntax: % WIKIUSERNAME%...
WIKIUSERSTOPIC name of topic listing all registers users Syntax: % WIKIUSERSTOPIC% Expands to: , with prefix renders as . Related: WIKIUSERNAME...
WIKIVERSION the version of the installed TWiki engine Syntax: % WIKIVERSION% Expands to: Related: PLUGINVERSION, WIKITOOLNAME
Number of topics: 86

Topic revision: r88 - 2005-07-23 - TWikiContributor
 
Powered by TWiki
This site is powered by the TWiki collaboration platform Powered by Perl This site is powered by the TWiki collaboration platformCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.WebHome