Formatted Search Customize the display of search results. The default output format of a %SEARCH{...}% is a table consisting of topic names and topic summaries. U...

Query Search Query searches help you search the contents of forms attached to your topics, as well as the values of other meta data attached to the topic. Using q...

#VarACTIVATEDPLUGINS ACTIVATEDPLUGINS list of currently activated plugins * Syntax: %ACTIVATEDPLUGINS% * Expands to: * Related: PLUGINDESCRIPTIONS, F...

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

#VarADDTOZONE ADDTOZONE %ADDTOZONE{ "zone" … }% Parameters: * "zone" optional, comma separated list of the names of zones that the content should be add...

#VarALLVARIABLES ALLVARIABLES list of currently defined macros * Syntax: %ALLVARIABLES% * Expands to: a table showing all defined macros in the curre...

#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} expert option in configure. This is used in certain password encodings, and in ...

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

BUTTON renders a nice button Parameters Parameter Description Default "text" text to be put on this button value text t...

CALC add spreadsheet calculations to tables and outside tables The %CALC{"formula"}% macro is handled by the SpreadSheetPlugin. There are around 90 formulae, such...

CALCULATE add spreadsheet formulae calls using standard Macro evaluation order. The %CALCULATE{"formula"}% macro is handled by the SpreadSheetPlugin. There are ar...

COMMENT insert an edit box into the topic to easily add comments. Parameters * The following standard attributes are recognized Name Descriptio...

#VarCOVER COVER current skin cover * %COVER% extends the skin search path. For instance, if SKIN is set to catskin, bearskin, and COVER is set to ruskin, th...

#VarDATE DATE signature format date * Syntax: %DATE% * Expands to: == * Date format defined as {DefaultDateFormat} in configure When used in a tem...

#VarDISPLAYTIME DISPLAYTIME{"format"} formatted display time * Formatted time either GMT or Local server time, depending on {DisplayTimeValues} setting in...

#VarEDITACTION EDITACTION Selects an edit template * The EDITACTION preference setting lets you define the use of an editaction template instead of the stan...

#VarENCODE ENCODE{"string"} encodes a string * Encode character sequences in "string", by mapping characters (or sequences of characters) to an alternative ...

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

#VarENDSECTION ENDSECTION{"name"} marks the end of a named section within a topic * Syntax: %ENDSECTION{"name"}% * Syntax: %ENDSECTION{type="include"}% ...

ENDTAB ending marker for a tab of a tabpane This closes a previously opened TAB. Related TAB, TABPANE, ENDTAB, JQueryPlugin, JQueryTabpane

ENDTABPANE ending tag for tabpane widget This closes a previously opened TABPANE. Related TAB, ENDTAB, TABPANE, JQueryPlugin, JQueryTabpane

ENDTWISTY complements an opening TWISTY tag to close a twisty Closes an open twisty Related

ENDTWISTYTOGGLE Twisty closure Will end the most inner unclosed Twisty Toggle section, using the proper tag Examples %ENDTWISTYTOGGLE% Related

#VarENV ENV{"varname"} inspect the value of an environment variable * Returns the current value of the environment variable in the CGI (Common Gateway Inter...

#VarEXPAND EXPAND{"expression" scope="topictoexpandin" ...}% Expands macros in expression as if they were used in the topic topictoexpandin. The viewer must have...

#VarFAILEDPLUGINS FAILEDPLUGINS debugging for plugins that failed to load, and handler list * Syntax: %FAILEDPLUGINS% * Expands to: See Plugins#FAILEDP...

#VarFORMAT FORMAT{"list" format="" header="" footer="" separator=""} format a list of objects * Syntax: %FORMAT{"list"}% * Supported parameters: P...

#VarFORMFIELD FORMFIELD{"fieldname"} renders a field in the form attached to some topic * Syntax: %FORMFIELD{"fieldname"}% * Supported parameters: ...

#VarGMTIME GMTIME{"format"} formatted GM time * Syntax: %GMTIME% OR %GMTIME{"format"}% * %GMTIME% uses the default date format defined by the {DefaultDat...

#VarGROUPINFO GROUPINFO{"name"} retrieve details about a group * Syntax: %GROUPINFO% * Expands to: comma separated list of all groups * Syntax: %GR...

#VarGROUPS GROUPS a formatted list of groups Deprecated do not use. Use VarGROUPINFO instead * Expands to a formatted list of user groups in your Foswiki….

HISTORY control attributes of tables and sorting of table columns The %HISTORY{}% macro is handled by the HistoryPlugin Parameters Parameter ...

#VarHOMETOPIC HOMETOPIC home topic in each web * Syntax: %HOMETOPIC% * Expands to: ==, renders as * Related: NOTIFYTOPIC, STATISTICSTOPIC, TOPIC

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

#VarHTTPHOST HTTP_HOST environment variable * Syntax: %HTTP_HOST% * Expands to: == * Related: ENV, REMOTE_ADDR, REMOTE_PORT, REMOTE_USER

#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" alt="" default="name"} small documentation graphic or icon of common attachment types * Generates a small graphic image from the set at...

#VarICONURL ICONURL{"name" default="name"} URL of small documentation graphic or icon * Generates the full URL of a image, which Foswiki renders as an imag...

#VarICONURLPATH ICONURLPATH{"name" default="name"} URL path of small documentation graphic or icon * Generates the relative URL path of a image, typically ...

#VarIF IF{"condition" ...} simple conditionals * Evaluate a condition and show one text or another based on the result. See details in IfStatements * Syn...

#VarIMAGEGALLERY IMAGEGALLERY{"topic" options...} render an image gallery * The %IMAGEGALLERY{"topic"}% macro is handled by the ImageGalleryPlugin. * Syn...

#VarINCLUDE INCLUDE{"topic"} include other topic. * Syntax: %INCLUDE{"topic" ...}% (See also the URL form of %INCLUDE%) * Supported parameters: P...

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

JQICON render an image Renders an icon image as found on an icon search path. The icon search path is configured Extensions tab, JQueryPlugin sub tab in {JQueryP...

JQICONPATH render the urlpath to an image This is a shortcut for Examples * %JQICONPATH{"tick"}% expands to == Related JQICON, ICONURL, JQueryPlugin...

JQPLUGINS display a summary of available plugins Parameters Parameter Description Default "plugins" this is a regular expression that...

JQREQUIRE enable a plugin on the current page This macro will load a list of plugins to be added to the current page. Use JQPLUGINS to display the list of av...

JQTHEME switch jQuery UI theme Foswiki's default UI theme is configured in $Foswiki::cfg{JQueryPlugin}{JQueryTheme} and defaults to foswiki. Use configure to cha...

#VarLANG 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 {UseLoca...

#VarLANGUAGE LANGUAGE language code for the current user * Returns the language code for the current user. This is the language used by Foswiki to generate ...

#VarLANGUAGES LANGUAGES list available languages * List the languages available (as PO files). These are the languages in which the user interface is a...

#VarLOCALSITEPREFS LOCALSITEPREFS web.topicname of site preferences topic * The full name of the local site preferences topic. These local site preferences ...

#VarLOGIN LOGIN present a full login link %IF{"context authenticated" then="$percentT$percent You are already authenticated, so %LOGIN% expands to an emp...

#VarLOGOUT LOGOUT present a full logout link %IF{"context authenticated" else="$percentT$percent You are already logged out, so %LOGOUT expands to an emp...

#VarMAINWEB MAINWEB synonym for USERSWEB Deprecated. Please use %USERSWEB% instead.

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

#VarMETA 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, ...

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

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

#VarNOP NOP template text not to be expanded in instantiated topics * Syntax: %NOP% * In normal topic text, expands to nop , which prevents expansion...

#VarNOTIFYTOPIC NOTIFYTOPIC name of the notify topic * Syntax: %NOTIFYTOPIC% * Expands to: ==, renders as * Related: HOMETOPIC, STATISTICSTOPIC, ...

#VarNRIMAGES NRIMAGES{"topic"} returns the number of images attachted to a (list of) topics * The %NRIMAGES{"topic"}% macro is handled by the ImageGalleryPl...

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

#VarPLUGINDESCRIPTIONS PLUGINDESCRIPTIONS list of plugin descriptions * Syntax: %PLUGINDESCRIPTIONS% * Expands to: * Related: ACTIVATEDPLUGINS, FAILE...

#VarPLUGINVERSION PLUGINVERSION the version of a Foswiki Plugin, or the Foswiki Plugins API * Syntax: %PLUGINVERSION{"name"}% to get the version of a specif...

POPUPWINDOW opens a topic or url in a new window Parameters Parameter Description Default "topic" topic="topic" topic="web.topic" T...

#VarPUBURL PUBURL the base URL of attachments * Syntax: %PUBURL% * Expands to: == * Example: You can refer to a file attached to another topic with %P...

#VarPUBURLPATH PUBURLPATH the base URL path of attachments * Syntax: %PUBURLPATH% * Expands to: == * Related: ATTACHURL, ATTACHURLPATH, PUBURL, SCRIPT...

#VarQUERY QUERY get the value of meta data * Uses the query syntax described in QuerySearch to get information about meta data. * supports formatted a...

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

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

#VarREMOTEADDR REMOTE_ADDR environment variable * Syntax: %REMOTE_ADDR% * Expands to: == * Related: ENV, HTTP_HOST, REMOTE_PORT, REMOTE_USER

#VarREMOTEPORT REMOTE_PORT environment variable * Syntax: %REMOTE_PORT% * Expands to: * Related: ENV, HTTP_HOST, REMOTE_ADDR, REMOTE_USER

#VarREMOTEUSER REMOTE_USER environment variable * Syntax: %REMOTE_USER% * Expands to: * Related: ENV, HTTP_HOST, REMOTE_ADDR, REMOTE_PORT, USERNAME, ...

#VarRENDERFORM RENDERFORM render DataForms data within a topic * The %RENDERLIST% variable is handled by the RenderFormPlugin * Syntax: %RENDERFORM{ "ADa...

RENDERLIST render bullet lists in a variety of formats The %RENDERLIST% macro is handled by the RenderListPlugin Examples * Engineering * Tech Pub...

#VarRENDERZONE RENDERZONE See ADDTOZONE for an explanation of zones. Parameters: * "zone" required, name of the zone. * format="..." optional, format strin...

#VarREVARG REVARG rev=n URL revision parameter of current topic * Syntax: %REVARG% * %REVARG% If a topic revision is requested in the URL, it returns th...

#VarREVINFO REVINFO revision information of current topic * Syntax: %REVINFO% * %REVINFO% is equivalent to %REVINFO{format="r1.$rev $date $wikiuserna...

#VarREVTITLE REVTITLE (r1) The requested revision as displayed in topic breadcrumbs * Syntax: %REVTITLE% * %REVTITLE% If a topic revision is requested i...

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

#VarSCRIPTURL SCRIPTURL{"script"} URL of script * Syntax: %SCRIPTURL% OR %SCRIPTURL{"script"}% * %SCRIPTURL% returns the base URL of scripts expands to...

#VarSCRIPTURLPATH SCRIPTURLPATH{"script"} URL path of script * As %SCRIPTURL{"script"}%, but doesn't include the protocol and host part of the URL * Synt...

#VarSEARCH SEARCH{"text"} search content * Inline search, shows a search result embedded in a topic * Syntax: %SEARCH{"text" ...}% * Supported paramet...

SERVERINFORMATION report detailed web server information Intended for use by installers / administrators, reports on the runtime information of the Foswiki instal...

#VarSERVERTIME SERVERTIME{"format"} formatted server time * Same format qualifiers as %GMTIME% * Syntax: %SERVERTIME% OR %SERVERTIME{"format"}% * %SER...

#VarSESSIONID SESSIONID unique ID for this session * Syntax: %SESSIONID% * Expand to: == * Related: UserAuthentication, AUTHREALM, SESSIONVAR, LOGIN, ...

#VarSESSIONVAR SESSIONVAR name of CGI and session variable that stores the session ID * Syntax: %SESSIONVAR% * Expand to: * Related: UserAuthenticati...

#VarSESSIONVARIABLE SESSION_VARIABLE get, set or clear a session variable * Syntax: %SESSION_VARIABLE{"name"}% * Syntax: %SESSION_VARIABLE{"name" set="va...

SET set a preference setting during runtime A preference setting created via a %SET macro is usable by the topic containing the %SET statement, and in any other t...

#VarSHOWPREFERENCE SHOWPREFERENCE show where preferences are defined. Preference values are shown in a bulleted list. * %SHOWPREFERENCE% * Show all pr...

#VarSKIN SKIN current skin * %SKIN% expands the skin search path. For instance, SKIN can be set to catskin, bearskin. * The SKIN setting can be overridde...

SLIDESHOWEND end slideshow The %SLIDESHOWEND% macro is handled by the SlideShowPlugin Examples See SLIDESHOWSTART Related SLIDESHOWSTART, SlideShowPlugin

SLIDESHOWSTART convert a topic with headings into a slideshow Handled by the SlideShowPlugin Parameters Parameter Description template optional n...

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

#VarSTATISTICSTOPIC STATISTICSTOPIC name of statistics topic * Syntax: %STATISTICSTOPIC% * Expands to: ==, renders as * Related: HOMETOPIC, NOTIF...

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

STOPSECTION Alias for ENDSECTION Related ENDSECTION, STARTSECTION

#VarSYSTEMWEB SYSTEMWEB name of documentation web * The web containing all documentation and default preference settings * Syntax: %SYSTEMWEB% * Expan...

TAB tab inside a tabpane widget Defines a tab inside a TABPANE area; must be closed using ENDTAB. Parameters Parameter Description Default ...

TABLE control attributes of tables and sorting of table columns The %TABLE{}% macro is handled by the TablePlugin Attributes for tables Parameter ...

TABPANE tabpane widget This macro starts the tabpane, containing a series of TAB...ENDTABs and ends with ENDTABPANE. A complete tabpane normally looks like this: ...

#VarTOC TOC{"Topic"} table of contents * Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax...

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

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

%TREEVIEW{}% displays topic children in a hierarchical tree %TREE{}% synonym of %TREEVIEW{}% Place the tag %TREEBROWSER{ parameters }% immediately before a bulle...

%TREEVIEW{}% displays topic children in a hierarchical tree %TREE{}% synonym of %TREEVIEW{}% Parameters * The following standard attributes are recognized ...

#VarTWIKIWEB TWIKIWEB synonym for SYSTEMWEB Deprecated. Use %SYSTEMWEB% instead

TWISTY generate content block with interactive visibility controls This renders the button as well as the toggled content section contained within this and the cl...

TWISTYBUTTON Shorthand version for TWISTYSHOW TWISTYHIDE This is useful if both the show and the hide button take the same arguments. Parameters All parameters...

TWISTYHIDE Hide/close link Parameters Parameter Description Default id Used to link TWISTYSHOW, TWISTYHIDE and TWISTYTOGGLE required ...

TWISTYSHOW Show/open link Parameters Parameter Description Default id Used to link TWISTYSHOW, TWISTYHIDE and TWISTYTOGGLE required ...

TWISTYTOGGLE Twisty Toggle contents section Parameters Parameter Description Default id Used to link TWISTYSHOW, TWISTYHIDE and TWISTYT...

#VarURLPARAM URLPARAM{"name"} get URL or HTTP POST parameter value * Returns the value of the named parameter in the URL or HTTP POST request. * Syntax: ...

#VarUSERINFO USERINFO{"name"} retrieve details about a user * Syntax: %USERINFO% * Expands to: (comma separated list of the username, wikiusername, and ...

#VarUSERNAME USERNAME your login username * Foswiki makes names available in three formats: USERNAME like jsmith, WIKINAME like JohnSmith and WIKIUSERNAME l...

#VarUSERSWEB USERSWEB name of users web * The web containing individual user topics, .WikiGroups, and customised site wide preferences. * Syntax: %USERSW...

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

#VarWEB 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 i...

#VarWEBLIST WEBLIST{"format"} index of all webs * List of all webs. Obfuscated webs are excluded, e.g. webs with a NOSEARCHALL = on preference setting. The ...

#VarWEBPREFSTOPIC WEBPREFSTOPIC name of web preferences topic * Syntax: %WEBPREFSTOPIC% * Expands to: ==, renders as * Related: HOMETOPIC, WIKIPR...

WIKIAGENTEMAIL From: email address in emails sent by Foswiki. Examples * %WIKIAGENTEMAIL% expands to == Related WIKIAGENTNAME, WIKIWEBMASTER, WIKIWEBMASTERNA...

WIKIAGENTNAME From: Name used in emails sent by Foswiki Examples * %WIKIAGENTNAME% expands to == Related WIKIAGENTEMAIL, WIKIWEBMASTER, WIKIWEBMASTERNAME

#VarWIKIHOMEURL WIKIHOMEURL site home URL * Syntax %WIKIHOMEURL% * Expands to == * Normally by default set to %SCRIPTURLPATH{"view"}% For the top ...

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

#VarWIKIPREFSTOPIC WIKIPREFSTOPIC name of site wide preferences topic * Syntax: %WIKIPREFSTOPIC% * Expands to: ==, renders as * Related: HOMETOPI...

#VarWIKITOOLNAME WIKITOOLNAME name of your site * Syntax: %WIKITOOLNAME% * Expands to: Foswiki * Related: WIKIHOMEURL, WIKIVERSION

#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 registered users * Syntax: %WIKIUSERSTOPIC% * Expands to: ==, with prefix renders as . * ...

#VarWIKIVERSION WIKIVERSION the version of the installed Foswiki engine * Syntax: %WIKIVERSION% * Expands to: == * Related: PLUGINVERSION, WIKITOOLNAM...

#VarWIKIWEBMASTER WIKIWEBMASTER feedback email address for site * Syntax: %WIKIWEBMASTER% * Expands to: == * Related: WIKIWEBMASTERNAME

#VarWIKIWEBMASTERNAME WIKIWEBMASTERNAME Name of the administrator for the site * Syntax: %WIKIWEBMASTERNAME% * Expands to: == * Related: WIKIWEBMASTER...