DATE signature format date Examples * %DATE% expands to == * Date format defined as {DefaultDateFormat} in configure When used in a template topic, thi...
DISPLAYTIME display formatted time Formatted time either GMT or Local server time, depending on {DisplayTimeValues} setting in configure. Same format qualifiers...
ENDCOLOR end colored text ENDCOLOR is one of the shortcut macros predefined in . It is used to terminate a colour change (revert back to the default colour). The ...
ENDINCLUDE 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 view...
ENDSECTION marks the end of a named section within a topic If the STARTSECTION is named, the corresponding ENDSECTION must also be named with the same name. If th...
ENV inspect the value of an environment variable Returns the current value of the environment variable in the CGI (Common Gateway Interface) environment. This is ...
FAILEDPLUGINS debugging for plugins that failed to load Also generates a list of handlers defined by plugins Examples * %FAILEDPLUGINS% Related PLUGINDESCRI...
ICON small documentation graphic or icon of common attachment types Generates a small graphic image from the set attached to . Images typically have a 16x16...
ICONURL URL of small documentation graphic or icon Generates the full URL of a image, which Foswiki renders as an image. The related %ICON{"name"}% generat...
ICONURLPATH URL path of small documentation graphic or icon Generates the relative URL path of a image, typically used in an HTML img tag. Specify image na...
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. If a...
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. If a topic is used ...
LANGUAGE language code for the current user Returns the language code for the current user. This is the language used by Foswiki to generate the user interface. T...
LANGUAGES list available languages List the languages available (as PO files). These are the languages in which the user interface is available. Parameters ...
LOGIN present a full login link %IF{"context authenticated" then="$percentT$percent You are already authenticated, so %LOGIN% expands to an empty string "}%...
LOGOUT present a full logout link %IF{"context authenticated" else="$percentT$percent You are already logged out, so %LOGOUT expands to an empty string" }% ...
META displays meta data Provided mainly for use in templates, this macro generates the parts of the topic view that relate to meta data (attachments, forms etc.)....
NOP template text not to be expanded in instantiated topics * %NOP% * In normal topic text, expands to nop , which prevents expansion of adjacent macros...
PERLDEPENDENCYREPORT report perl module dependencies Intended for use by installers / administrators, reports on the status of Perl dependencies in the Foswiki co...
PLUGINVERSION the version of a Foswiki Plugin, or the Foswiki Plugins API Use %PLUGINVERSION{"name"}% to get the version of a specific plugin Examples * %PLUG...
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 exa...
REMOTE_USER environment variable Examples * %REMOTE_USER% expands to Displays the user identity established by the Web Server. Not available when using ...
REVARG rev=n parameter of current request %REVARG% If a topic revision is requested in the URL, it returns the revision of the current topic suitable for concaten...
REVTITLE The requested revision as displayed in topic breadcrumbs If a topic revision is requested in the URL, it returns the printable revision of the current t...
SCRIPTNAME name of current script * The name of the current script is shown, including script suffix, if any (for example viewauth.cgi) Examples * %SCRIPTN...
SCRIPTSUFFIX script suffix * Some Foswiki installations require a file extension for CGI scripts, such as .pl or .cgi Examples * %SCRIPTSUFFIX% expands to ...
SERVERINFORMATION report detailed web server information Intended for use by installers / administrators, reports on the runtime information of the Foswiki instal...
SERVERTIME formatted server time Same format parameters as VarGMTIME GMTIME% , but displaying the server time instead of UTC. Examples * %SERVERTIME% els...
SESSIONID unique ID for this session Examples * %SESSIONID% expands to == Related UserAuthentication, AUTHREALM, SESSIONVAR, LOGIN, LOGOUT, SESSION_VARIABLE...
SESSIONVAR name of CGI and session variable that stores the session ID Examples * %SESSIONVAR% expands to Related UserAuthentication, AUTHREALM, SESSIONID,...
SKIN current skin %SKIN% expands the skin search path. For instance, SKIN can be set to catskin, bearskin. The SKIN setting can be overridden using the URL parame...
SLIDESHOWEND end slideshow The %SLIDESHOWEND% macro is handled by the SlideShowPlugin Examples See SLIDESHOWSTART Related SLIDESHOWSTART, SlideShowPlugin
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 bac...
SPACEOUT renders string with spaces inserted in sensible places Inserts spaces after lower case letters that are followed by a digit or a capital letter, and afte...
STARTINCLUDE start position of topic text if included If present in included topic, start to include text from this location up to the next %ENDINCLUDE% macro, or...
STARTSECTION marks the start of a section within a topic Section boundaries are defined with %STARTSECTION{}% and %ENDSECTION{}%. Sections may be given a name to ...
SYSTEMWEB name of documentation web The web containing all documentation and default preference settings Examples * %SYSTEMWEB% expands to == Related USERSW...
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 top...