50 recent changes in System Web retrieved at 03:45 (Local)

ADDTOHEAD deprecated, use ADDTOZONE instead This macro is deprecated. Please use VarADDTOZONE instead. It effecively is a shortcut for %ADDTOZONE{"head" ...}%

ADDTOZONE add content to a named zone on the page Parameters Parameter Description Default "zone" comma separated list of the names of zones th...

ALLVARIABLES list of currently defined macros Expands to a table showing all defined macros in the current context Deprecated 2009 04 29 in favour of SHOWPREF...

ATTACHURL full URL for attachments in the current topic Shorthand for PUBURL, with path set to the current topic. Otherwise supports all the same parameters as PU...

ATTACHURLPATH path of the attachment URL of the current topic Shorthand for PUBURLPATH with path set to the current topic. Otherwise supports all the same paramet...

AUTHREALM authentication realm String defined as the {AuthRealm} expert option in configure Security And Authentication tab, =Login sub tab.. This is used in cert...

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. This is the...

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 there...

COVER current skin cover Extends the skin search path. For instance, if SKIN is set to catskin, bearskin, and COVER is set to ruskin, the skin search path becomes...

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

ENCODE encode characters in a string Encode character sequences in "string", by mapping characters (or sequences of characters) to an alternative character (or se...

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

EXPAND expand macros in a string as if they were used in another topic The viewer must have VIEW access to topictoexpandin for this to work. All the standard form...

FAILEDPLUGINS debugging for plugins that failed to load Also generates a list of handlers defined by plugins Examples * %FAILEDPLUGINS% Related PLUGINDESCRI...

FORMAT format a list of objects Parameters Parameter Description Default "one, two, three" The list to be expanded into the format. R...

FORMFIELD renders a field in the form attached to some topic Parameters Parameter Description Default "name" The name of a Data form ...

GMTIME formatted Greenwich Mean Time (UTC) Parameters Parameter Description Default "format" format $day $month $year $hour:$min %GMTI...

GROUPINFO retrieve details about a group Parameters Parameter Description Default "groupname" Optional name of group format ...

GROUPS a formatted list of groups Deprecated do not use. Use VarGROUPINFO instead * Expands to a formatted list of user groups. * The macro is intended to...

HOMETOPIC home topic in each web Examples * %HOMETOPIC% expands to ==, renders as Related NOTIFYTOPIC, STATISTICSTOPIC, TOPIC

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

HTTP_HOST environment variable Examples * %HTTP_HOST% expands to == Related ENV, 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 wh...

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

IF simple conditionals Evaluate a condition and show one text or another based on the result. See details in IfStatements . Parameter Description Defa...

INCLUDE include another topic, or subsection of a topic, or a URL, or Foswiki embedded documentation (Including a topic) Parameters Parameter: Des...

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

LANG the language specified by the server locale This macro is used to generate the lang (and xml:lang) attribute in generated HTML pages. If {UseLocale} is enabl...

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

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

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" }% ...

MAINWEB deprecated synonym for USERSWEB Deprecated. Please use %USERSWEB% instead.

MAKETEXT creates text using Foswiki's I18N infrastructure Strings captured in the MAKETEXT macro are automatically mapped to the current user's selected language ...

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

METASEARCH special search of meta data METASEARCH is deprecated in favour of the new and much more powerful query type search. See SEARCH and QuerySearch. Param...

NONCE generate a nonce (developers only) DEVELOPERS ONLY This macro is used to generate a 'nonce', a unique key that identifies the source of a request in order t...

NOP template text not to be expanded in instantiated topics * %NOP% * In normal topic text, expands to nop , which prevents expansion of adjacent macros...

NOTIFYTOPIC name of the notify topic Examples * %NOTIFYTOPIC% expands to ==, renders as Related HOMETOPIC, STATISTICSTOPIC, TOPIC

PERLDEPENDENCYREPORT report perl module dependencies Intended for use by installers / administrators, reports on the status of Perl dependencies in the Foswiki co...

PLUGINDESCRIPTIONS list of plugin descriptions Examples * %PLUGINDESCRIPTIONS% expands to Related ACTIVATEDPLUGINS, FAILEDPLUGINS, PLUGINVERSION

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