Detailed topic list for System Web

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

#VarI I idea icon * Type: Preference variable TWikiRenderingShortcut. * Syntax: %I% * Expands to: * Related: H, ICON, M, N, P, Q, S, T, U, X, Y,...

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

#VarJQENDTAB JQENDTAB end a JQuery tab within a tab pane * This variable is handled by the JQueryPlugin. For description see JQTABPANE * Syntax: %JQTABPA...

#VarJQENDTABPANE JQENDTABPANE end a JQuery tab pane * This variable is handled by the JQueryPlugin. For description see JQTABPANE * Syntax: %JQTABPANE% %...

JQICON render an image Renders an icon made availabe by the IconService. Parameters Parameter Description Default "name" name of the icon to displa...

JQICONPATH render the url path to an image icon This is a shortcut for: Note that this macro only makes sense for image icons, those that refer to a single image ...

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

#VarJQTAB JQTAB start a JQuery tab within a tab pane * This variable is handled by the JQueryPlugin. For description see JQTABPANE * Syntax: %JQTABPANE% ...

#VarJQTABPANE JQTABPANE start a JQuery tab pane * Create nice looking horizontal tab panes in TWiki topics. Write a sequence of %JQTAB{"..."}% and %JQENDTAB...

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

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

#VarLIME LIME start lime colored text * LIME is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut s...

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

#VarLOGINURL LOGINURL present a login link * Present a login link, regardless of the state of login * Syntax: %LOGINURL% * Expand to: * Related: T...

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

#VarLOGOUTURL LOGOUTURL present a logout link * Present a logout link, regardless of the state of login * Syntax: %LOGOUTURL% * Expand to: * Relat...

#VarM M moved to... icon * Type: Preference variable TWikiRenderingShortcut. * Syntax: %M% * Expands to: * Related: H, I, ICON, N, P, Q, S, T, U...

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

#VarMAROON MAROON start maroon colored text * MAROON is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering sh...

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

#VarN N "new" icon * Type: Preference variable TWikiRenderingShortcut. * Syntax: %N% * Expands to: * Related: H, I, ICON, M, P, Q, S, T, U, X, Y...

#VarNAVY NAVY start navy blue colored text * NAVY is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering short...

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

#VarOLIVE OLIVE start olive green colored text * OLIVE is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering ...

#VarORANGE ORANGE start orange colored text * ORANGE is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering sh...

#VarP P pencil icon * Type: Preference variable TWikiRenderingShortcut. * Syntax: %P% * Expands to: * Related: H, I, ICON, M, N, Q, S, T, U, X, ...

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

#VarPINK PINK start pink colored text * PINK is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut s...

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

#VarPURPLE PURPLE start purple colored text * PURPLE is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering sh...