Detailed topic list for System Web

REVINFO revision information of current topic %REVINFO% is equivalent to %REVINFO{format="r1.$rev $date $wikiusername"}% Examples * %REVINFO% expands to =...

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

SCRIPTURL URL of script(s) Expands to the URL of a script, or the base URL of all scripts Parameters Parameter Description Default "$script" ...

SCRIPTURLPATH URL path of script(s) Expands to the base URL of scripts, without protocol or host Parameters Parameter Description Default "$s...

SEARCH search content Inline search, shows a search result embedded in a topic Parameters Parameter Description Default: "text" search...

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

SESSION_VARIABLE get, set or clear a session variable Parameters Parameter Description "name" name of variable set value to set it to ...

SET set a preference setting during runtime A preference setting created via %SET{}% will only be usable in the topic where it has been found by the parser, simil...

SHOWPREFERENCE show where preferences are defined. Preference values are shown in a bulleted list, together with where they were defined. Parameters ...

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

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

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

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

STOPINCLUDE Alias for ENDINCLUDE Related INCLUDE, STARTINCLUDE

STOPSECTION Alias for ENDSECTION Related ENDSECTION, STARTSECTION

SUBSCRIBE{ attributes } subscribe the current user for notification of changes to the current topic Anywhere in a topic or template: * %SUBSCRIBE{...}% or si...

SYSTEMWEB name of documentation web The web containing all documentation and default preference settings Examples * %SYSTEMWEB% expands to == Related USERSW...

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

TOC table of contents Shows a Table of Contents that is generated automatically based on headings of a topic. Headings in TopicMarkupLanguage (" text") and HTML ...

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

TOPICLIST topic index of a web List of all topics in a web. The "format" defines the format of one topic item. It may include formatting tokens: The $topic token ...

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

URLPARAM get URL or HTTP POST parameter value Returns the value of the named parameter in the URL or HTTP POST request. Parameters Parameter: Desc...

USERINFO retrieve details about a user Parameters Parameter Description "name" WikiName or login username. May be a group. current user ...

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

USERSWEB name of users web * The web containing individual user topics, .WikiGroups, and customised site wide preferences. Examples * %USERSWEB% expands to...

VAR get a preference value from another web Parameters Parameter Description "name" name of preference to retrieve web name of web to r...

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

WEBLIST index of all webs Generate a list of webs. Obfuscated webs are excluded, e.g. webs with a NOSEARCHALL = on preference setting. The "format" defines the fo...

WEBPREFSTOPIC name of web preferences topic Examples * %WEBPREFSTOPIC% expands to ==, renders as Related HOMETOPIC, WIKIPREFSTOPIC, VAR

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

WIKIHOMEURL site home URL Examples * %WIKIHOMEURL%= expands to = * Normally by default set to %SCRIPTURLPATH{"view"}% For the top bar logo URL use %WIK...

WIKINAME your Wiki username The WikiName is the same as %USERNAME% if not defined in the . topic. This macro is an alias for the USERINFO macro with a fixed forma...