Detailed topic list for System Web

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

#VarMIMEICON MIMEICON{"filename"} return a meaningful icon for this filename * Syntax: %MIMEICON{"filename"}% * Supported parameters: Parameter ...

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

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

#VarPERL %PERL{"perl expression"}% * Expands to the result of the perl expression, evaluated in a Safe container. %PERL{topic="topic name"}% * Expands to t...

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

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

PUBURL generate an URL for an attachment Generate an absolute URL for an attachment, or for a web or topic within the attachment database. Parameters ...

PUBURLPATH generate a relative URL for an attachment Generate a relative URL for an attachment, or for a web or topic within the attachment database. Parameters ...

QUERY get the value of meta data Uses the query syntax described in QuerySearch to get information about meta data from one specified topic. * supports formatt...

QUERYPARAMS show parameters to the query Expands the parameters to the query that was used to display the page. Parameters Parameter: Description:...

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_ADDR environment variable Examples * %REMOTE_ADDR% expands to == Related ENV, HTTP_HOST, REMOTE_PORT, REMOTE_USER

REMOTE_PORT environment variable Examples * %REMOTE_PORT% expands to Related ENV, HTTP_HOST, REMOTE_ADDR, REMOTE_USER

REMOTE_USER environment variable Examples * %REMOTE_USER% expands to Displays the user identity established by the Web Server. Not available when using ...

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

RENDERZONE render the content of a zone Rendersa zone. See ADDTOZONE for an explanation of zones. Parameters Parameter Description Default ...

REVARG rev=n parameter of current request If a topic revision is requested in the URL, it returns the revision of the current topic suitable for concaten...

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 Wiki installations require a file extension for CGI scripts, such as .pl or .cgi Examples * %SCRIPTSUFFIX% expands to R...

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 a %SET macro is usable by the topic containing the %SET statement, and in any other t...

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