Macros

%MACRONAME%
%MACRONAME{ parameter="value" }%

1. Preference settings: May be defined and modified by the user
2. Registered macros: Defined by the system or by Plugins (for example, the SpreadSheetPlugin introduces a %CALC{}% macro)

Using Macros

• type %T% to get (a preference settings)
• type %TOPIC% to get Macros (a predefined macro)
• type %CALC{ "$UPPER(Text)" }% to get TEXT (CALC is a macro defined by SpreadSheetPlugin)

• To leave a macro unexpanded, precede it with an exclamation point, e.g. type !%TOPIC% to get %TOPIC%
  • Alternatively, insert a <nop> anywhere in the macro, Eg. %<nop>TOPIC%
• Macros are expanded relative to the topic they are used in, not the topic they are defined in
• Type %ALLVARIABLES% to get a full listing of all macros defined for a particular topic
• If a macro is not defined, then it will be left in the text unless it is called with a default parameter, in which case the value of the default parameter will replace the macro call in the output. For example, %UNDEFINED{default="blank"}% will expand to blank.

Order of expansion

• Preference settings
• Most macros provided by plugins (those that use registerTagHandler())

  Not those that use commonTagsHandler()

• Most built-in Foswiki macros

  Notable exceptions include: CALC, STARTSECTION/ENDSECTION, STARTINCLUDE/STOPINCLUDE

Standard form

%MACRO1{
   something="%MACRO2{
      somethingelse="%MACRO3%, %MACRO4%"
   }%"
}%

Animated Example

%INCLUDE{
    "%QUERY{
        "'%THETOPIC%'/%THEFIELD%"
    }%"
    section="Summary"
}%
   * Set THETOPIC = %SYSTEMWEB%.FAQWhatIsWikiWiki
   * Set THEFIELD = TopicClassification

%INCLUDE{
    "%QUERY{
        "'%SYSTEMWEB%.FAQWhatIsWikiWiki'/%THEFIELD%"
    }%"
    section="Summary"
}%
   * Set THETOPIC = %SYSTEMWEB%.FAQWhatIsWikiWiki
   * Set THEFIELD = TopicClassification

%INCLUDE{
    "%QUERY{
        "'%SYSTEMWEB%.FAQWhatIsWikiWiki'/TopicClassification"
    }%"
    section="Summary"
}%
   * Set THETOPIC = %SYSTEMWEB%.FAQWhatIsWikiWiki
   * Set THEFIELD = TopicClassification

%INCLUDE{
    "%QUERY{
        "'System.FAQWhatIsWikiWiki'/TopicClassification"
    }%"
    section="Summary"
}%
   * Set THETOPIC = %SYSTEMWEB%.FAQWhatIsWikiWiki
   * Set THEFIELD = TopicClassification

%INCLUDE{
    "FrequentlyAskedQuestion"
    section="Summary"
}%
   * Set THETOPIC = %SYSTEMWEB%.FAQWhatIsWikiWiki
   * Set THEFIELD = TopicClassification

These topics are for frequently
asked questions including answers.

   * Set THETOPIC = %SYSTEMWEB%.FAQWhatIsWikiWiki
   * Set THEFIELD = TopicClassification

These topics are for frequently
asked questions including answers.

   * Set THETOPIC = System.FAQWhatIsWikiWiki
   * Set THEFIELD = TopicClassification

Delayed form

When working with a given macro, consult its documentation to determine which parameters support the $percent/$percnt format tokens. Generally only output parameters like header, format and footer support format tokens.

%MACRO1{
   format="$percentMACRO2{
      format=\"%MACRO3%, %MACRO4%\"
   }$percent"
}%

Animated Example

%SEARCH{
  "info.date >= d2n('2009-01-01') AND info.date <= d2n('2009-12-31')"
  type="query"
  limit="2"
  nonoise="on"
  format="   * $percentICON{
    \"$percentIF{
      \"'$topic'/parent.name='%PARENT%'\"
      then=\"info\" else=\"gear\"
    }$percent\"
  }$percent [[$topic]]"
}%
----
   * Set PARENT = UserDocumentationCategory

%SEARCH{
  "info.date >= d2n('2009-01-01') AND info.date <= d2n('2009-12-31')"
  type="query"
  limit="2"
  nonoise="on"
  format="   * $percentICON{
    \"$percentIF{
      \"'$topic'/parent.name='UserDocumentationCategory'\"
      then=\"info\" else=\"gear\"
    }$percent\"
  }$percent [[$topic]]"
}%
----
   * Set PARENT = UserDocumentationCategory

   * %ICON{
    "%IF{
      "'AccessKeys'/parent.name='UserDocumentationCategory'"
      then="info" else="gear"
    }%"
  }% [[AccessKeys]]
   * %ICON{
    "%IF{
      "'AdminSkillsAssumptions'/parent.name='UserDocumentationCategory'"
      then="info" else="gear"
    }%"
  }% [[AdminSkillsAssumptions]]
----
   * Set PARENT = UserDocumentationCategory

   * %ICON{
    "info"
  }% [[AccessKeys]]
   * %ICON{
    "gear"
  }% [[AdminSkillsAssumptions]]
----
   * Set PARENT = UserDocumentationCategory

   * <img src="http://malat.biz/foswiki/pub/System/DocumentGraphics/info.png"/> [[AccessKeys]]
   * <img src="http://malat.biz/foswiki/pub/System/DocumentGraphics/gear.png"/> [[AdminSkillsAssumptions]]
----
   * Set PARENT = UserDocumentationCategory

Macro Names

Preference Settings

[multiple of 3 spaces] * [space] Set [space] MACRONAME [space] = [space] value

Example:

   * Set WEBBGCOLOR = #FFFFC0

1. DefaultPreferences (Foswiki upgrades overwrite this topic)
2. In (some) plugin documentation topics. (Deprecated)
3. SitePreferences
4. In user topics, if the user has one (yours is Main.WikiGuest)
5. WebPreferences
6. Sub-webs inherit the WebPreferences of their parent
7. In the topic being accessed

   * #Set DENYWEBCHANGE = %USERSWEB%.UnknownUser

<!--
   * Set HIDDEN = This will be invisible in the output
-->

   * Set MACRONAME = value starts here
     and continues here

• To place a logo anywhere in a web by typing %MYLOGO%, define the preference settings in the web's WebPreferences topic, and upload a logo file, ex: mylogo.gif. You can upload by attaching the file to WebPreferences, or, to avoid clutter, to any other topic in the same web, e.g. LogoTopic. Sample preference setting in WebPreferences:

   * Set MYLOGO = %PUBURL%/%WEB%/LogoTopic/mylogo.gif

Parameters

   * Set CONDITIONS = According to [[%BASETOPIC%]] the %WHAT% is %STATE% today (Set in ...).

• %CONDITIONS{WHAT="sea" STATE="choppy"}%
  • expands to According to Macros, The sea is choppy today. (Set in Macros)..

Parameter defaults

• The special parameter name DEFAULT gets the value of any unnamed parameter in the macro call.
• Parameter macros can accept a default parameter so that they expand to something even when a value isn't passed for them in the call.

   * Set WEATHER = It's %DEFAULT{default="raining"}%.

• %WEATHER% expands to It's raining.
• %WEATHER{"sunny"}% expands to It's sunny.

Access Control Settings

Local values for preferences

   * Set EDITBOXHEIGHT = 10
   * Local EDITBOXHEIGHT = 20

Predefined Macros

Predefined macros can be overridden by preference settings (except TOPIC and WEB)

Plugins may extend the set of predefined macros (see individual Plugins topics for details)

Take the time to thoroughly read through ALL preference macros. If you actively configure your site, review macros periodically. They cover a wide range of functions, and it can be easy to miss the one perfect macro for something you have in mind. For example, see %BASETOPIC%, %INCLUDE%, and the mighty %SEARCH%.

ACTIVATEDPLUGINS -- list of currently activated plugins

• Syntax: %ACTIVATEDPLUGINS%
• Expands to: SpreadSheetPlugin, AutoViewTemplatePlugin, CommentPlugin, EditTablePlugin, HistoryPlugin, InterwikiPlugin, JQueryPlugin, MenuListPlugin, PreferencesPlugin, RenderListPlugin, SmiliesPlugin, TablePlugin, TwistyPlugin
• Related: PLUGINDESCRIPTIONS, FAILEDPLUGINS, PLUGINVERSION

ADDTOHEAD

ADDTOZONE

%ADDTOZONE{
  "zone"
  ...
}%

• "zone" optional, comma-separated list of the names of zones that the content should be added to. The only zones guaranteed to exist are head and script. Defaults to head.
• id optional, identifier for the text being added with the ADDTOZONE call, to be used in the requires parameter of other ADDTOZONE calls.
  • Multiple ADDTOZONE calls with the same id parameter will simply overwrite the earlier ADDTOZONE call.
• requires="..." optional, comma separated string of ids of text within this zone that this content should follow when the zone is rendered. The content will be rendered even if a specified id is missing.
• text="..." optional, text to be added to the named zone, mutually exclusive with topic.
• topic="..." optional, full qualified web.topic name that contains the text to be added, mutually exclusive with text. Defaults to %BASETOPIC%
• section="..." optional, section of the topic to be added, defaults to the default section between STARTINCLUDE and STOPINCLUDE.

What is a "Zone"?

<head>
...
%RENDERZONE{"head"}%
%RENDERZONE{"script"}%
</head>

• Create a sidebar zone to add widgets,
• Create a toolbar zone to add buttons icons
• Create a menu zone to add menu entries

Adding content to a zone

Enforcing a linear order of content within a zone

Working with {MergeHeadAndScriptZones} disabled (default)

Working with {MergeHeadAndScriptZones} enabled

{MergeHeadAndScriptZones} is provided to maintain compatibility with legacy extensions that use ADDTOHEAD to add <script> markup and require content that is now in the script zone. {MergeHeadAndScriptZones} will be removed from a future version of Foswiki.

Example: Adding to a zone with missing dependencies

%ADDTOZONE{
  "script"
  text="
  <script type='text/javascript'>
    alert('test');
  </script>"
  requires="some-id-that-exists-in-script"
  id="MY::TEST"
}%

<script type='text/javascript'>
  alert('test');
</script>
<!-- MY::TEST: requires= missing ids: some-id-that-exists-in-script -->

Example: Adding Javascript to a page

%JQREQUIRE{"shake"}%
%ADDTOZONE{
   "script"
   id="MyApp::ShakePart"
   text="
   <script type='text/javascript'>
      jQuery('#something').shake(3, 10, 180);
   </script>"
   requires="JQUERYPLUGIN::SHAKE"
}%

Example: Adding CSS to a page

%ADDTOZONE{"head"
   id="MyCSS"
   text="
      <style type='text/css' media='all'>
         @import url('%PUBURLPATH%/%SYSTEMWEB%/MyCSS/foo.css');
      </style>"
}%

ALLVARIABLES -- list of currently defined macros

• Syntax: %ALLVARIABLES%
• Expands to: a table showing all defined macros in the current context

AQUA -- start aqua colored text

• AQUA is one of the shortcut macros predefined in DefaultPreferences. See the section shortcut macros in that topic for a complete list of colors.
  Example:

  %AQUA% aqua text %ENDCOLOR%

  Expands to: aqua text

  %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write

  %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%

ATTACHURL -- full URL for attachments in the current topic

• Syntax: %ATTACHURL%
• Expands to: http://malat.biz/foswiki/pub/System/VarATTACHURL
• Example: If you attach a file you can refer to it as %ATTACHURL%/image.gif
• Related: ATTACHURLPATH, PUBURL, PUBURLPATH, SCRIPTURL, SCRIPTURLPATH, FileAttachments

ATTACHURLPATH -- path of the attachment URL of the current topic

• Syntax: %ATTACHURLPATH%
• Expands to: /foswiki/pub/System/VarATTACHURLPATH
• Related: ATTACHURL, PUBURL, PUBURLPATH, SCRIPTURL, SCRIPTURLPATH, FileAttachments

AUTHREALM -- authentication realm

• String defined as {AuthRealm} expert option in configure. This is used in certain password encodings, and in login templates as part of the login prompt.
• Syntax: %AUTHREALM%
• Expands to: Enter your WikiName. (First name and last name, no space, no dots, capitalized, e.g. JohnSmith). Cancel to register if you do not have one.
• Related: UserAuthentication, SESSIONID, SESSIONVAR, LOGIN, LOGOUT, SESSION_VARIABLE

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 name of the topic requested by the user.
• Syntax: %BASETOPIC%
• Related: BASEWEB, INCLUDINGTOPIC, INCLUDE, TOPIC

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 is no include.
• This is the name of the web requested by the user.
• Syntax: %BASEWEB%
• Related: BASETOPIC, INCLUDINGWEB, INCLUDE, WEB

BB -- bullet with line break

• Line break and bullet without indentation.
• Current value: BB =
  •
• Related: BR, BULLET, BB2, BB3, BB4, CARET, VBAR

BB2 -- level 2 bullet with line break

• Line break and bullet, level 2.
• Current value: BB2 =
    •
• Related: BR, BULLET, BB, BB3, BB4, VBAR

BB3 -- level 3 bullet with line break

• Line break and bullet, level 3.
• Current value: BB3 =
      •
• Related: BR, BULLET, BB, BB2, BB4, VBAR

BB4 -- level 4 bullet with line break

• Line break and bullet, level 4.
• Current value: BB4 =
        •
• Related: BR, BULLET, BB, BB2, BB3, VBAR

BLACK -- start black colored text

• BLACK is one of the shortcut macros predefined in DefaultPreferences. See the section shortcut macros in that topic for a complete list of colors.
  Example:

  %BLACK% black text %ENDCOLOR%

  Expands to: black text

  %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write

  %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%

BLUE -- start blue colored text

• BLUE is one of the shortcut macros predefined in DefaultPreferences. See the section shortcut macros in that topic for a complete list of colors.
  Example:

  %BLUE% blue text %ENDCOLOR%

  Expands to: blue text

  %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write

  %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%

BR -- line break

• Current value: BR =
  
• Related: BULLET, BB, BB2, BB3, BB4, CARET, VBAR

BROWN -- start brown colored text

• BROWN is one of the shortcut macros predefined in DefaultPreferences. See the section shortcut macros in that topic for a complete list of colors.
  Example:

  %BROWN% brown text %ENDCOLOR%

  Expands to: brown text

  %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write

  %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%

BULLET -- bullet character

• Current value: BULLET = •
• Related: BR, BB, BB2, BB3, BB4, CARET, VBAR

BUTTON{"text" ...} -- renders a nice button

• Parameters:

  Parameter:	Description:	Default:
  "text", value="text"	text to be put on this button
  accesskey	access key used for this button
  class	extra class: use foswikiRight or foswikiLeft to specify aligment; use cyan, red, green for different background colors; use simple for a non-3D button
  href	url of the click target	#
  icon	icon to be put on the left; note, this can be any icon attached to the {IconSearchPath}; see also VarJQICON
  id	html id for this button
  onclick	javascript event triggered when clicking the button
  onmouseout	javascript event triggered when the pointer leaves the button
  onmouseover	javascript event triggered when the pointer hovers over the button
  target	topic to open when clicking on the button
  title	popup title displayed when hovering over the button
  type	type of action to be performed; available actions are button: (default) normal click button, target specified in target or href parameter clear: clears all input fields in the form that contains the button reset: resets all input fields in a form to their initial value submit: submits the form that contains the button save: same as submit but takes care of extra validation steps when saving a wiki topic	button

• Example:

  %BUTTON{
      "%MAKETEXT{"Submit"}%"
      click="confirm('Are your sure?')"
    }%
    %BUTTON{
      "%MAKETEXT{"Cancel"}%"
      icon="cross"
      target="%WEB%.%TOPIC%"
    }% %CLEAR%

• Expands as:
  Submit Cancel
• Note: BUTTONS are floating to the left by default. Take care to add a %CLEAR% after the %BUTTON{...}% so that further content does not overlap with the button.
• Related: JQueryButton

CALC{"formula"} -- add spreadsheet calculations to tables and outside tables

• The %CALC{"formula"}% macro is handled by the SpreadSheetPlugin. There are around 90 formulae, such as $ABS(), $EXACT(), $EXISTS(), $GET()/$SET(), $IF(), $LOG(), $LOWER(), $PERCENTILE(), $TIME(), $VALUE().
• Syntax: %CALC{"formula"}%
• Examples:
  • %CALC{"$SUM($ABOVE())"}% returns the sum of all cells above the current cell
  • %CALC{"$EXISTS(Web.SomeTopic)"}% returns 1 if the topic exists
  • %CALC{"$UPPER(Collaboration)"}% returns COLLABORATION
• Related: IF, SpreadSheetPlugin

CARET -- caret symbol

• The CARET macro is useful in TML tables.
• Current value: CARET = ^
• Related: BR, BULLET, BB, BB2, BB3, BB4, VBAR

COMMENT{ attributes } -- insert an edit box into the topic to easily add comments.

• A %COMMENT% without parameters shows a simple text box.
• The following standard attributes are recognized

  Name	Description	Default
  type	This is the name of the template to use for this comment. Comment templates are defined in a Foswiki template - see Customisation, below. If this attribute is not defined, the type is whatever is defined by COMMENTPLUGIN_DEFAULT_TYPE, either in this topic or in your WebPreferences.	below
  default	Default text to put into the textarea of the prompt.
  target	Name of the topic to add the comment to	the current topic
  location	Regular expression specifying the comment location in the target topic. Read carefully the CommentPlugin documentation!
  mode	For compatibility with older versions only, synonymous with type
  nonotify	Set to "on" to disable change notification for target topics	off
  noform	Set to "on" to disable the automatic form that encloses your comment block - remember to insert <form> tags yourself! See CommentPluginExamples:noform for an example.	off
  nopost	Set to "on" to disable insertion of the posted text into the topic.	off
  remove	Set to "on" to remove the comment prompt after the first time it is clicked.	off
  button	Button label text	Add comment

• See CommentPlugin for more information

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, the skin search path becomes ruskin, catskin, bearskin.
• The COVER setting can be overridden using the URL parameter cover, such as ?cover=ruskin
• Syntax: %COVER%
• Expands to: %COVER%
• See Skins for more information

DATE -- signature format date

• Syntax: %DATE%
• Expands to: 23 Feb 2025
• Date format defined as {DefaultDateFormat} in configure

  When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TemplateTopics#TemplateTopicsVars for details.

• Related: DISPLAYTIME, GMTIME{"format"}, SERVERTIME

DISPLAYTIME{"format"} -- formatted display time

• Formatted time - either GMT or Local server time, depending on {DisplayTimeValues} setting in configure. Same format qualifiers as %GMTIME%
• Syntax: %DISPLAYTIME% OR %DISPLAYTIME{"format"}%
• %DISPLAYTIME% The time is shown as hh:mm (24 hour clock)
  • Expands to: 23 Feb 2025 - 14:57
• Example:

  %DISPLAYTIME{"$hou:$min"}%

  expands to 14:57
• Related: GMTIME, SERVERTIME

EDITACTION -- Selects an edit template

• The EDITACTION preference setting lets you define the use of an editaction template instead of the standard edit. If EDITACTION is defined as text, then hide the form. If EDITACTION is defined as form hide the normal text area and only edit the form.
• Syntax:

     * Set EDITACTION = text|form

• Expands to: %EDITACTION%

  When EDITACTION is defined as text or form the Edit and Edit Raw buttons simply add ;action=text or ;action=form to the URL for the edit script. If you have defined an EDITACTION preference setting you can still edit the topic content or the form by removing the ;action=form or ;action=text from the edit URL in the browser and reload.

• Related: CommandAndCGIScripts#edit

EDITTABLE{ attributes } -- edit tables using edit fields and other input fields

• The %EDITTABLE{}% macro is handled by the EditTablePlugin
• Syntax: %EDITTABLE{ attributes }%

• Supported attributes:

  Attribute	Comment	Default
  header	Specify the header format of a new table like "|*Food*|*Drink*|". Useful to start a table with only a button	(no header)
  format	The format of one column when editing the table. A cell can be a text input field, or any of these edit field types: • Text input field (1 line):   | text, <size>, <initial value> | • Textarea input field:   | textarea, <rows>x<columns>, <initial value> | • Drop down box:   | select, <size>, <option 1>, <option 2>, etc* |   * only one item can be selected • Radio buttons:   | radio, <size*>, <option 1>, <option 2>, etc |   * size indicates the number of buttons per line in edit mode • Checkboxes:   | checkbox, <size*>, <option 1>, <option 2>, etc |   * size indicates the number of checkboxes per line in edit mode • Fixed label:   | label, 0, <label text> | • Row number:   | row, <offset> | • Date:   | date, <size>, <initial value>, <DHTML date format> | (see Date Field Type)	"text, 16" for all cells
  changerows	Rows can be added and removed if "on" Rows can be added but not removed if "add" Rows cannot be added or removed if "off"	CHANGEROWS plugin setting
  quietsave	Quiet Save button is shown if "on", hidden if "off"	QUIETSAVE plugin setting
  include	Other topic defining the EDITTABLE parameters. The first %EDITTABLE% in the topic is used. This is useful if you have many topics with the same table format and you want to update the format in one place. Use topic or web.topic notation.	(none)
  helptopic	Topic name containing help text shown below the table when editing a table. The %STARTINCLUDE% and %STOPINCLUDE% macros can be used in the topic to specify what is shown.	(no help text)
  headerislabel	Table header cells are read-only (labels) if "on"; header cells can be edited if "off" or "0"	"on"
  editbutton	Set edit button text, e.g. "Edit this table"; set button image with alt text, e.g. "Edit table, %PUBURL%/%SYSTEMWEB%/DocumentGraphics/edittopic.gif"; hide edit button at the end of the table with "hide" (Note: Button is automatically hidden if an edit button is present in a cell)	EDITBUTTON plugin setting
  buttonrow	Set to top to put the edit buttons above the table.	bottom
  javascriptinterface	Use javascript to directly move and delete row without page refresh. Enable with "on", disable with "off".	JAVASCRIPTINTERFACE plugin setting

%EDITTABLE{ format="| text, 20 | select, 1, one, two, three |" changerows="on" }%
| *Name* | *Type* |
| Foo    | two    |

ENCODE{"string"} -- encodes a string

• Encode character sequences in "string", by mapping characters (or sequences of characters) to an alternative character (or sequence of characters). This macro can be used to encode strings for use in URLs, to encode to HTML entities, to protect quotes, and for as many other uses as you can imagine.
• Syntax: %ENCODE{"string"}%
• Parameters:

  Parameter	Description	Default
  "string"	String to encode	"" (empty string)
  type="encodingname"	Use a predefined encoding (see below).	Default is 'url'. Parameter type not be used if old or new are given.
  old="tokenlist"	Comma-separated list of tokens to replace. Tokens are normally single characters, but can also be sequences of characters. The standard format tokens may be used in this list. Each token must be unique - you cannot list the same token twice.	May not be used with type; required if new is used
  new="tokenlist"	comma-separated list of replacement tokens. The elements in this list match 1:1 with the elements in the old list. Again, the standard format tokens may be used. An empty element in the new list will result in the corresponding token in the old list being deleted from the string. If the new list is shorter than the old list it will be extended to the same length using the empty element. Tokens do not have to be unique. When using old and new, be aware that the results of applying earlier tokens are not processed again using later tokens. (see examples below)	May not be used with type; required if old is used

• If ENCODE is called with no optional parameters (e.g. %ENCODE{"string"}%) then the default type="url" encoding will be used.
• Predefined encodings.
  • Unless otherwise specified, the type parameter encodes the following "special characters"
    • all non-printable ASCII characters below space, except newline ("\n") and carriage return ("\r")
    • HTML special characters "<", ">", "&", single quote (') and double quote (")
    • TML special characters "%", "[", "]", "@", "_", "*", "=" and "|"
  • type="entity" or type="entities" Encode special characters into HTML entities, like a double quote into ". Does not encode \n (newline).
  • type="html" As type="entity" except it also encodes \n (newline)
  • type="safe" Encode just the characters '"<>% into HTML entities.
  • type="quote" or type="quotes" Escapes double quotes with backslashes (\"), does not change any other characters
  • type="url" Encode special characters for use in URL parameters, like a double quote into %22
• Examples

     %ENCODE{"spaced name"}%= expands to
        spaced%20name
     %ENCODE{"| Blah | | More blah |" old="|,$n" new="&#124;,<br />"}% expands to
        | Blah | | More blah |
        - this encoding is useful to protect special TML characters in tables.
     %ENCODE{"10xx1x01x" old="1,x,0" new="A,,B"}% expands to
        ABABA
     %ENCODE{"1,2" old="$comma" new=";"}% expands to
        1;2

• Values for HTML input fields must be entity encoded.
  Example:

  <input type="text" name="address" value="%ENCODE{ "any text" type="entity" }%" />

• ENCODE can be used to filter user input from URL parameters and similar to help protect against cross-site scripting. The safest approach is to use type="entity". This can however prevent an application from fully working. You can alternatively use type="safe" which encodes only the characters '"<>% into HTML entities. When ENCODE is passing a string inside another macro always use double quotes ("") type="quote". For maximum protection against cross-site scripting you are advised to install the Foswiki:Extensions.SafeWikiPlugin.

• Double quotes in strings must be escaped when passed into other macros.
  Example:

  %SEARCH{ "%ENCODE{ "string with "quotes"" type="quotes" }%" noheader="on" }%

  When using old and new, be aware that the results of applying earlier tokens are not processed again using later tokens. For example:

     %ENCODE{"A" old="A,B" new="B,C"}% will result in 'B' (not 'C'),
     %ENCODE{"asd" old="as,d" new="d,f"}% will yield 'df', and
     %ENCODE{"A" old="A,AA" new="AA,B"}% will give 'AA' and.
     %ENCODE{"asdf" old="a,asdf" new="a,2"}% will give 'asdf'

• Related: URLPARAM

ENDCOLOR -- end colored text

• ENDCOLOR is one of the shortcut macros predefined in DefaultPreferences. See the section shortcut macros in that topic for a complete list of shortcuts.
  Example:

  %GREEN% green text %ENDCOLOR%

  Expands to: green text

  %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write

  %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%

• Related: VarAQUA, VarBLACK, VarBLUE, VarBROWN, VarGRAY, VarGREEN, VarLIME, VarMAROON, VarNAVY, VarOLIVE, VarORANGE, VarPINK, VarPURPLE, VarRED, VarSILVER, VarTEAL, VarWHITE, VarYELLOW, DefaultPreferences, StandardColors

ENDSECTION{"name"} -- marks the end of a named section within a topic

• Syntax: %ENDSECTION{"name"}%
• Syntax: %ENDSECTION{type="include"}%
• Supported parameter:

  Parameter:	Description:
  "name"	Name of the section.
  type="..."	Type of the section being terminated; supported types "section", "include", "expandvariables", "templateonly".

• If the STARTSECTION is named, the corresponding ENDSECTION must also be named with the same name. If the STARTSECTION specifies a type, then the corresponding ENDSECTION must also specify the same type. If the section is unnamed, ENDSECTION will match with the nearest unnamed %STARTSECTION% of the same type above it.
• Related: STARTSECTION

ENDTAB -- ending marker for a tab of a tabpane

• This closes a previously opened TAB.
• no parameters
• Related: VarTAB, VarTABPANE, VarENDTAB, JQueryPlugin, JQueryTabpane

ENDTABPANE -- ending tag for tabpane widget

• This closes a previously opened TABPANE.
• no parameters
• Related: VarTAB, VarENDTAB, VarTABPANE, JQueryPlugin, JQueryTabpane

ENDTWISTY

• Syntax: %ENDTWISTY%
• Related: VarENDTWISTY, VarENDTWISTYTOGGLE, VarTWISTY, VarTWISTYBUTTON, VarTWISTYHIDE, VarTWISTYSHOW, VarTWISTYTOGGLE

ENDTWISTYTOGGLE

• Syntax: %ENDTWISTYTOGGLE%
  • Will end the most inner unclosed Twisty Toggle section, using the proper tag
• Example: %ENDTWISTYTOGGLE%
• Related: VarENDTWISTY, VarENDTWISTYTOGGLE, VarTWISTY, VarTWISTYBUTTON, VarTWISTYHIDE, VarTWISTYSHOW, VarTWISTYTOGGLE

ENV{"varname"} -- inspect the value of an environment variable

• Returns the current value of the environment variable in the CGI (Common Gateway Interface) environment. This is the environment that the CommandAndCGIScripts are running in.
• Note: For security reasons, only those environment variables whose names match the regular expression in {AccessibleENV} in the Security Settings/Miscellaneous section of configure can be displayed. Any other variable will just be shown as an empty string, irrespective of its real value.
• Example: %ENV{MOD_PERL}% displays as: not set
• If an environment variable is undefined (as against being set to the empty string) it will be returned as not set.
• Related: HTTP_HOST, REMOTE_ADDR, REMOTE_PORT, REMOTE_USER

EXAMPLETAG -- example variable

• The %EXAMPLETAG{}% variable is handled by the ExamplePlugin
• Syntax: %EXAMPLETAG{"text" format="..."}%
• Parameter text="..." - example text.
• Parameter format="..." - format of report.
• Example: %EXAMPLETAG{"hello" format="| $topic: $summary |"}%
• Related: ExamplePlugin

EXPAND{"expression" scope="topictoexpandin" ...}%

   * Set MYPREFERENCE = value

%EXPAND{"$percentMYPREFERENCE$percent" scope="SettingsTopic"}%

%EXPAND{"$percentMYPREFERENCE$percent" scope="%OTHERTOPIC%"}%

%EXPAND{"$percentMYPREFERENCE{$quotdefault$quot param=$quotvalue$quot}" scope="SettingsTopic"}%

• EXPAND is not very efficient, and should be used sparingly.
• To expand a web preference (for example, a web access control) then set scope="Theotherweb.%WEBPREFSTOPIC%"

FAILEDPLUGINS -- debugging for plugins that failed to load, and handler list

• Syntax: %FAILEDPLUGINS%
• Expands to: See Plugins#FAILEDPLUGINS
• Related: PLUGINDESCRIPTIONS, ACTIVATEDPLUGINS, PLUGINVERSION

FORMAT{"list" format="" header="" footer="" separator=""} -- format a list of objects

• Syntax: %FORMAT{"list"}%
• Supported parameters:

  Parameter:	Description:	Default:
  "one, two, three"	The list to be expanded into the format. Required. Currently only two types of list data are supported; topic names (type="topic") and plain strings (type="string").	""
  format="..."	Format string; see Supported formatting tokens for possible values.	""
  header="..."	Text to come before the formatted output	""
  footer="..."	Text to come after the formatted output	""
  separator="n"	Separator between formatted elements	"$n"
  type=""	Treat input list as either topic or string	"topic"

• Examples:

     %FORMAT{"one,two,three" type="string" format="   * $item"}%
     %FORMAT{"%SKIN%"
        header="the Skin setting is evaluated in this order:"
        format="   1 =$topic="
        footer="   1 =default="
     }%

• Related: SEARCH

Supported formatting tokens

For more sophisticated handling of string lists, consider installing Foswiki:Extensions.FilterPlugin.

• Related: SEARCH, ENCODE, FormattedSearch

FORMFIELD{"fieldname"} -- renders a field in the form attached to some topic

• Syntax: %FORMFIELD{"fieldname"}%
• Supported parameters:

  Parameter:	Description:	Default:
  "fieldname"	The name of a Data form field	required
  topic="..."	Topic where form data is located. May be of the form Web.TopicName	Current topic
  format="..."	Format string. $value expands to the field value, and $name expands to the field name, $title to the field title, $form to the name of the form the field is in. The standard format tokens are also expanded.	"$value"
  default="..."	Text shown if the field is defined in the topic, but the field value is empty. For example, a text field for which all the content has been deleted.	""
  alttext="..."	Text shown if the field is not defined in the topic (even if it is specified in the form definition). For example, this is used when a field exists in the form definition, but the referring topic hasn't been edited since it was added.	""
  rev="n"	Specifiy a revision of the topic. If not specified, defaults to the most recent rev (or the viewed rev if viewing an old rev of the same topic)

• Example:

   %FORMFIELD{"ProjectName"
     topic="Projects.SushiProject"
     default="(no project name given)"
     alttext="ProjectName field not found in form"
   }%

• Related: SEARCH

GMTIME{"format"} -- formatted GM time

• Syntax: %GMTIME% OR %GMTIME{"format"}%
• %GMTIME% uses the default date format defined by the {DefaultDateFormat} setting in configure
  • expands to 23 Feb 2025 - 14:57
• Supported special format tokens:

  Token:	Unit:	Example
  $seconds	seconds	59
  $minutes	minutes	59
  $hours	hours	23
  $day	day of month	31
  $wday	day of the Week (Sun, Mon, Tue, Wed, Thu, Fri, Sat)	Thu
  $dow	day of the week (Sun = 0)	2
  $week	number of week in year (ISO 8601)	34
  $month	short name of month	Dec
  $mo	2 digit month	12
  $year	4 digit year	1999
  $ye	2 digit year	99
  $tz	either "GMT" (if set to gmtime), or "Local" (if set to servertime)	GMT
  $iso	ISO format timestamp	2025-02-23T14:57:27Z
  $rcs	RCS format timestamp	2025/02/23 14:57:27
  $http	E-mail & http format timestamp	Sun, 23 Feb 2025 14:57:27 GMT
  $epoch	Number of seconds since 00:00 on 1st January, 1970	1740322647

• Tokens can be shortened to 3 characters
• Example:

  %GMTIME{"$day $month, $year - $hour:$min:$sec"}%

  expands to

  23 Feb, 2025 - 14:57:27

  When used in a template topic, this macro will be expanded when the template is used to create a new topic. See TemplateTopics#TemplateTopicsVars for details.

• Related: GMTIME, REVINFO, SERVERTIME

GRAY -- start gray colored text

• GRAY is one of the shortcut macros predefined in DefaultPreferences. See the section shortcut macros in that topic for a complete list of colors.
  Example:

  %GRAY% gray text %ENDCOLOR%

  Expands to: gray text

  %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write

  %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%

GREEN -- start green colored text

• GREEN is one of the shortcut macros predefined in DefaultPreferences. See the section shortcut macros in that topic for a complete list of colors.
  Example:

  %GREEN% green text %ENDCOLOR%

  Expands to: green text

  %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write

  %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%

GROUPINFO{"name"} -- retrieve details about a group

• Syntax: %GROUPINFO%
  • Expands to: comma-separated list of all groups
• Syntax: %GROUPINFO{"groupname"}%
  • Expands to: comma-separated list of users in that group
• Parameters:

  format	Format of a single user or group in the list. $name expands to the group name, and (for users list only) $wikiname, $username and $wikiusername to the relevant strings. $allowschange returns 0 (false) or 1 (true) if that group can be modified by the current user. $allowschange(UserWikiName) returns 0 (false) or 1 (true) if that group can be modified by the specified user (does not work for groups yet.). The standard FormatTokens are also supported.	$name for groups list, $wikiusername for users list
  separator	separator between items in the list	,
  header	Header for the list	''
  footer	Footer for the list	''
  zeroresults	If set, and there are no Groups or Members that can be shown, the header and footer are suppressed, and this text is output	undefined
  show	filter the output list of Groups - can be set to all, allowschange, denychange, allowschange(UserWikiName), denychange(UserWikiName)	all
  expand	Set false if users should not be expanded from nested groups. Default behavior is to expand all nested groups into a flat list of users.	1
  limit	If set, limits the number of results to this	infinity
  limited	If limit is set, and the list is truncated, this text will be added at the end of the list	''

Note: GROUPINFO will not list members that are hidden from the current authenticated user. If the current user does not have VIEW authority for a user's topic, then the user will not be shown as a group member.

• Related: USERINFO

GROUPS -- a formatted list of groups

• Expands to a formatted list of user groups in your Petr Malát.
• Syntax: %GROUPS%
• The macro is intended to be used in WikiGroups, to allow a group listing for various user mapping managers.
• Related: REMOTE_USER, USERINFO, USERNAME, WIKIUSERNAME, WIKIUSERSTOPIC

H -- help icon

• Current value: H =
• Related: I, ICON, M, N, P, Q, S, T, U, X, Y

HISTORY{ attributes } -- control attributes of tables and sorting of table columns

• The %HISTORY{}% macro is handled by the HistoryPlugin
• Syntax: %HISTORY{ attributes }%

Additional macros

• %HISTORY_REV1%: Oldest revision from the printed history
• %HISTORY_REV2%: Latest revision from the printed history
• %HISTORY_NREV%: Number of the printed revisions
• %HISTORY_MAXREV%: Latest available revision of the topic

HOMETOPIC -- home topic in each web

• Syntax: %HOMETOPIC%
• Expands to: WebHome, renders as WebHome
• Related: NOTIFYTOPIC, STATISTICSTOPIC, TOPIC

HTTP -- get HTTP headers

• Called with the name of an HTTP header field, returns its value. Capitalization and the use of hyphens versus underscores are not significant.
• Syntax: %HTTP%
• Syntax: %HTTP{"Header-name"}%
• Examples:

  %HTTP%
  %HTTP{"Accept-language"}%
  %HTTP{"User-Agent"}%	Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; ClaudeBot/1.0; +claudebot@anthropic.com)

  You can see the HTTP headers your browser sends to the server on a number of sites e.g. http://www.ericgiguere.com/tools/http-header-viewer.html

• Related: HTTPS, REMOTE_ADDR, REMOTE_PORT, REMOTE_USER

HTTP_HOST -- environment variable

• Syntax: %HTTP_HOST%
• Expands to: malat.biz
• 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 whether SSL is turned on.
• Syntax: %HTTPS%
• Syntax: %HTTPS{"Header-name"}%
• Related: HTTP, REMOTE_ADDR, REMOTE_PORT, REMOTE_USER

I -- idea icon

• Current value: I =
• Related: H, ICON, M, N, P, Q, S, T, U, X, Y

ICON{"name" alt="" default="name"} -- small documentation graphic or icon of common attachment types

• Generates a small graphic image from the set attached to DocumentGraphics. Images typically have a 16x16 pixel size. You can select a specific image by name, or you can give a full filename, in which case the type of the file will be used to select one of a collection of common file type icons.
• if you specify an icon which cannot be found, the one specified in the default parameter will be used (and if that fails, the 'else' icon will be used)
• Syntax: =%ICON{ "filename or icon name" [ default="filename or icon name" ] [ alt="alt text to be added to the HTML img tag" ] }%
• Examples:
  • %ICON{"flag-gray"}% displays as
  • %ICON{"pdf"}% displays as
  • %ICON{"docx" default="doc"}% displays as
  • %ICON{"smile.pdf"}% displays as
  • %ICON{"/dont/you/dare/smile.pdf"}% returns
  • %ICON{"data.unknown" alt="Unknown file type"}% displays as
  • %ICON{"data.unknown"}% displays as
  • %ICON{"http://trunk.foswiki.org/pub/System/DocumentGraphics/xsl.gif"}% displays
• Graphic samples: arrowbright, bubble, choice-yes, hand
• File type samples: bmp, doc, gif, hlp, html, mp3, pdf, ppt, txt, xls, xml, zip
• Related: ICONURL, ICONURLPATH, DefaultPreferences, FileAttachments, DocumentGraphics

ICONURL{"name" default="name"} -- URL of small documentation graphic or icon

• Generates the full URL of a DocumentGraphics image, which Foswiki renders as an image. The related %ICON{"name"}% generates the full HTML img tag. Specify image name or full filename (see ICON for details on filenames.)
• Syntax: %ICONURL{"name"}%
• Examples:
  • %ICONURL{"arrowbright"}% returns http://malat.biz/foswiki/pub/System/DocumentGraphics/arrowbright.png
  • %ICONURL{"novel.pdf"}% returns http://malat.biz/foswiki/pub/System/DocumentGraphics/pdf.png
  • %ICONURL{"/queen/boheme.mp3"}% returns http://malat.biz/foswiki/pub/System/DocumentGraphics/mp3.png
• Related: ICONURLPATH, ICON, DefaultPreferences, FileAttachments, DocumentGraphics

ICONURLPATH{"name" default="name"} -- URL path of small documentation graphic or icon

• Generates the relative URL path of a DocumentGraphics image, typically used in an HTML img tag. Specify image name or full filename (see ICON for details on filenames.)
• Syntax: %ICONURLPATH{"name"}%
• Examples:
  • %ICONURLPATH{"locktopic"}% returns /foswiki/pub/System/DocumentGraphics/locktopic.png
  • %ICONURLPATH{"eggysmell.xml"}% returns /foswiki/pub/System/DocumentGraphics/xml.png
  • %ICONURLPATH{"/doc/xhtml.xsl"}% returns /foswiki/pub/System/DocumentGraphics/xsl.png
• Related: ICONURL, ICON, DefaultPreferences, FileAttachments, DocumentGraphics

IF{"condition" ...} -- simple conditionals

• Evaluate a condition and show one text or another based on the result. See details in IfStatements
• Syntax:

  %IF{"CONDITION" then="THEN" else="ELSE"}%

  shows
  "THEN" if "CONDITION" evaluates to TRUE, otherwise "ELSE" will be shown
• Example:

   %IF{"defined FUNFACTOR"
     then="FUNFACTOR is defined"
     else="FUNFACTOR is not defined"
   }%

  renders as

  FUNFACTOR is not defined

• Related: $IF() of SpreadSheetPlugin

INCLUDE{"topic"} -- include other topic.

• Syntax: %INCLUDE{"topic" ...}% (See also the URL form of %INCLUDE%)
• Supported parameters:

  Parameter:	Description:	Default:
  "SomeTopic"	The name of a topic located in the current web, i.e. %INCLUDE{"WebNotify"}%
  "Web.Topic"	A topic in another web, i.e. %INCLUDE{"System.SiteMap"}%
  pattern="..."	Include a subset of a topic or a web page. Specify a RegularExpression that contains the text you want to keep in parenthesis, e.g. pattern="(from here.*?to here)". IncludeTopicsAndWebPages has more.	none
  rev="2"	Include a previous topic revision; N/A for URLs	top revision
  warn="off"	Warn if topic include fails: Fail silently (if off); output default warning (if set to on); else, output specific text (use $topic for topic name)	%INCLUDEWARNING% preferences setting
  section="name"	Includes only the specified named section, as defined in the included topic by the STARTSECTION and ENDSECTION macros. Nothing is shown if the named section does not exists. section="" is equivalent to not specifying a section
  PARONE="val 1" PARTWO="val 2"	Any other parameter will be defined as a macro within the scope of the included topic. The example parameters on the left will result in %PARONE% and %PARTWO% being defined within the included topic.

• Examples: See IncludeTopicsAndWebPages
• Related: BASETOPIC, BASEWEB, INCLUDE("URL"), INCLUDE("doc:") ,INCLUDINGTOPIC, INCLUDINGWEB, STARTINCLUDE, STOPINCLUDE, STARTSECTION, ENDSECTION

INCLUDE{"url"} -- include a web page

• Syntax: %INCLUDE{"http://..." ...}% (See also the topic form of %INCLUDE%)
• Supported parameters:

  Parameter:	Description:	Default:
  "http://..."	A full qualified URL, i.e. %INCLUDE{"http://foswiki.org:80/index.html"}%. Supported content types are text/html and text/plain. If the URL resolves to an attachment file on the server this will automatically translate to a server-side include.
  pattern="..."	Include a subset of a topic or a web page. Specify a RegularExpression that contains the text you want to keep in parenthesis, e.g. pattern="(from here.*?to here)". IncludeTopicsAndWebPages has more.	none
  raw="on"	When a page is included, normally Petr Malát will process it, doing the following: 1) Alter relative links to point back to originating host, 2) Remove some basic HTML tags (html, head, body, script) and finally 3) Remove newlines from HTML tags spanning multiple lines. If you prefer to include exactly what is in the source of the originating page set this to on. raw="on" is short for disableremoveheaders="on", disableremovescript="on", disableremovebody="on", disablecompresstags="on" and disablerewriteurls="on".	disabled
  literal="on"	While using the raw option will indeed include the raw content, the included content will still be processed and rendered like regular topic content. To disable parsing of the included content, set the literal option to "on".	disabled
  disableremoveheaders="on"	Bypass stripping headers from included HTML (everything until first </head> tag)	disabled
  disableremovescript="on"	Bypass stripping all <script> tags from included HTML	disabled
  disableremovebody="on"	Bypass stripping the </body> tag and everything around over and below it	disabled
  disablecompresstags="on"	Bypass replacing newlines in HTML tags with spaces. This compression step rewrites unmatched <'s into &lt; entities unless bypassed	disabled
  disablerewriteurls="on"	Bypass rewriting relative URLs into absolute ones	disabled
  warn="off"	Warn if URL include fails: Fail silently (if off); output default warning (if set to on); else, output specific text (use $topic for topic name) appended with the http error information.	%INCLUDEWARNING% preferences setting

  JavaScript in included webpages is filtered out as a security precaution per default (disable filter with disableremovescript parameter)

  Foswiki by default is configured to deny URL format includes.

• Examples: See IncludeTopicsAndWebPages
• Related: INCLUDE("topic")

INCLUDE{"doc:"} -- include Foswiki embedded module documentation

• Syntax: %INCLUDE{"doc:Foswiki::Func" ...}%
• Supported parameters:

  Parameter:	Description:	Default:
  "doc:..."	A full qualified Foswiki module, i.e. %INCLUDE{"doc:Foswiki::Func"}%. The module must be found on the Foswiki lib path
  level="1"	Override the root heading level to the specified number
  pattern="..."	Include a subset of the module. Specify a RegularExpression that contains the text you want to keep in parenthesis, e.g. pattern="(from here.*?to here)". IncludeTopicsAndWebPages has more.	none

• Examples: See System/PerlDoc?module=Foswiki::Func
• Related: INCLUDE("topic") INCLUDE("URL")

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 topic is used in a chain of INCLUDEs, INCLUDINGTOPIC is set to the topic directly INCLUDing this one, NOT the topic that has been requested by the user (which is set in BASETOPIC)

  While this Macro may appear to work, unless you require the subtle difference between INCLUDINGTOPIC and BASETOPIC, you probably should use BASETOPIC

• Syntax: %INCLUDINGTOPIC%
• Related: BASETOPIC, INCLUDINGWEB, INCLUDE, TOPIC

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 in a chain of INCLUDEs, INCLUDINGWEB is set to the topic directly INCLUDing this one, NOT the web that has been requested by the user (which is set in BASEWEB)

  While this Macro may appear to work, unless you require the subtle difference between INCLUDINGWEB and BASEWEB, you probably should use BASEWEB

• Syntax: %INCLUDINGWEB%
• Related: BASEWEB, INCLUDINGTOPIC, INCLUDE, WEB

JQICON{"name" ...} -- render an image

• This renders an icon image as found on an icon search path. The icon search path is configured in {JQueryPlugin}{IconSearchPath} and defaults to FamFamFamSilkIcons, FamFamFamSilkCompanion1Icons, FamFamFamFlagIcons, FamFamFamMiniIcons, FamFamFamMintIcons'. The named icon will be picked found first on this path of topics where icons are attached to. The JQICON leverages the general icon loading mechanism as implemented by the JQueryPlugin and used by BUTTON as well.
• Parameters:

  Parameter:	Description:	Default:
  "name"	name of the icon to display
  class	additional css class for the img tag
  alt		alt attribute
  title	title attribute
  format	format string used to render the icon; known variables to be used in the format string are: $iconPath: url path $iconClass: css class as specified by the class parameter $iconAlt: alt attribute-value; if the alt parameter to JQICON is set, this expands to alt='...' $iconTitle: title attribute-value; if the title parameter to JQICON is set, this expands to title='...'	<img src='$iconPath' class='$iconClass' $iconAlt$iconTitle/>

• Example:

       %JQICON{"tick" alt="alternative content" title="this is a tick icon"}%
       %JQICON{"cross"}%
       %JQICON{"disk"}%
       %JQICON{"star"}%
       %JQICON{"lightbulb"}%
       %JQICON{"camera"}%
       %JQICON{"date"}%
       

  Produces:
• Related: VarJQICONPATH, VarICON, JQueryPlugin, FamFamFamSilkIcons

JQICONPATH{"name"} -- render the urlpath to an image

• This is a shortcut for

  %JQICON{"name" format="$iconPath"}%

• Example: /foswiki/pub/System/FamFamFamSilkIcons/tick.png
• Related: VarJQICON, VarICONURL, JQueryPlugin

JQPLUGINS{"plugins" ... } -- display a summary of available plugins

• Parameters:

  Parameter:	Description:	Default:
  "plugins"	this is a regular expression that the plugin identifier must match to be displayed
  format	format string to render information for each matching plugin; known variables to be used in the format string are: active: state of the plugin: displays (active) when this plugin is loaded on the current page author: author of the plugin documentation: plugin documentation topic defaults to %SYSTEMWEB%.JQuery$name homepage: link to the hompeage of this third party plugin index: the current index in the list of all plugins being displayed name: name of the plugin as can be used in JQREQUIRE summary: short description what this plugin does; most plugins provide this piece of information in the summary section of the documentation topic tags: list of TML macros this plugin implements version: version of the plugin as provided by the author of this plugin	1 <a href="$homepage">$name</a> $active $version $author
  header	header string prepended to the output; empty when no plugin matches
  footer	footer string appended to the output; empty when no plugin matches
  separator	separator put between each plugin rendered in a row	$n
  tagformat	format string to render a link to any tag documentation a plugin implements	[[%SYSTEMWEB%.Var$tag][$tag]]

• Example:

   %JQPLUGINS{
     "treeview|slimbox"
     header="   * JQuery Plugins:$n"
     format="      * [[$documentation][$name]] v$version was developed by [[$homepage][$author]]"
   }%

  Produces:
• JQuery Plugins:
  • Slimbox v2.04 was developed by Christophe Beyls
  • Treeview v1.4 was developed by Joern Zaefferer
• Related: JQueryPlugin

JQREQUIRE{"plugin, plugin, ... "} -- 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 available and active plugins. While loading a plugin, additional plugins it may depend on are loaded as well. Information about these dependencies is stored within the plugins themselves and can't be changed. Dependencies also make sure the javascript code is added to the html page in the right order. It uses ADDTOZONE to aggregate javascript and css at the right place on the html page.
• Parameters:

  Parameter:	Description:	Default:
  "plugin[, plugin, plugin]"	list of plugins to be loaded
  warn	(on/off) allows you to switch off warnings when a plugin was not found	on

• Related: JQueryPlugin, VarJQPLUGINS, VarADDTOZONE

JQTHEME{"name" ...} -- switch jQuery UI theme

• Foswiki's default UI theme is configured in $Foswiki::cfg{JQueryPlugin}{JQueryTheme} and defaults to base. Use configure to change this site wide. Use JQTHEME if you decide to use a different theme on the current page.
• Note: some Foswiki skins may come with their own jQuery UI matching the overall user experience of the web design.
• Parameters:

  Parameter:	Description:	Default:
  "name"	name of theme: JQueryPlugin knows the following themes base, lightness, redmod, smoothness; additional themes maybe created using the themeroller and installed to /foswiki/pub/System/JQueryPlugin/$name	base

• Related: JQueryUI

LANG -- the lang attribute of generated HTML pages

• In templates the lang attribute is defined like this:

  <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="%LANG%" lang="%LANG%">

• The value is read from configure setting {Site}{Locale}
• Do not confuse LANG with LANGUAGE
• Syntax: %LANG%
• Expands to: en_US

LANGUAGE -- current user's language

• Returns the language code for the language used as the current user. This is the language actually used by Foswiki (e.g. in user interface).
• The language is detected from the user's browser, unless some site/web/user/session-defined setting overrides it:
  • If the LANGUAGE preference is set, it's used as user's language instead of any language detected from the browser.
  • Avoid defining LANGUAGE at a non per-user way, so each user can choose his/her preferred language.
• Related: LANGUAGES

LANGUAGES -- list available languages

• List the languages available (as PO files). These are the languages in which the user interface is available.
• Syntax: %LANGUAGES{...}%
• Supported parameters:

  Parameter:	Description:	Default:
  format	format for each item. See below for format tokens available in the format string.	"   * $langname"
  separator	separator between items.	"\n" (newline)
  marker="selected"	Text for $marker if the item matches selection	"selected"
  selection="%LANGUAGE%"	Current language to be selected in list	(none)

• format tokens:

  Token	Meaning
  $langname	language's name, as informed by the translators
  $langtag	language's tag. Ex: en, pt-br, etc.

• Example: <select>%LANGUAGES{format="<option $marker value='$langtag'>$langname</option>" selection="%LANGUAGE%"}%</select> creates an option list of the available languages with the current language selected

LIME -- start lime colored text

• LIME is one of the shortcut macros predefined in DefaultPreferences. See the section shortcut macros in that topic for a complete list of colors.
  Example:

  %LIME% lime text %ENDCOLOR%

  Expands to: lime text

  %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write

  %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%

LOCALSITEPREFS -- web.topicname of site preferences topic

• The full name of the local site preferences topic. These local site preferences overload the system level preferences defined in System.DefaultPreferences.
• Syntax: %LOCALSITEPREFS%
• Expands to: Main.SitePreferences, renders as SitePreferences

LOGIN -- present a full login link

• Syntax: %LOGIN%
• Expand to: Login
• Related: UserAuthentication, SESSIONID, SESSIONVAR, LOGOUT, SESSION_VARIABLE

LOGOUT -- present a full logout link

You are already logged out, so %LOGOUT expands to an empty string

• Syntax: %LOGOUT%
• Expand to:
• Related: UserAuthentication, SESSIONID, SESSIONVAR, LOGIN, SESSION_VARIABLE

M -- moved to... icon

• Current value: M =
• Related: H, I, ICON, N, P, Q, S, T, U, X, Y

MAINWEB -- synonym for USERSWEB

Deprecated. Please use %USERSWEB% instead.

MAKETEXT -- creates text using Foswiki's I18N infrastructure

• Syntax: %MAKETEXT{"string" args="..."}%
• Supported parameters:

  Parameter	Description	Default
  "text" or string="text"	The text to be displayed (the translatable string).	none
  args="param1, param2"	a comma-separated list of arguments to be interpolated in the string, replacing [_N] placeholders in it.	none

• Examples:

    %MAKETEXT{string="Notes:"}%
    expands to:
      Notes:
  
    %MAKETEXT{
      "If you have any questions, please contact [_1]."
      args="%WIKIWEBMASTER%"
    }%
    expands to:
      If you have any questions, please contact eshopy@malat.biz.
  
    %MAKETEXT{
      "Did you want to [[[_1]][reset [_2]'s password]]?"
      args="%SYSTEMWEB%.ResetPassword,%WIKIUSERNAME%"
    }%
    expands to:
      Did you want to [[System.ResetPassword][reset Main.WikiGuest's password]]?

• Notes:
  • [_n] brackets are validated to a positive integer from 1 to 100.
  • Missing arguments are replaced with an empty string ''.
  • An ampersand (&) followed by one ascii alphabetic character (a...z, A...Z) in the translatable string will be expanded to an access key string. For example, &X will expand to <span class='foswikiAccessKey'>X</span>. If you want to write an actual ampersand, either follow it with a non-alphabetic character or write two consecutive ampersands (&&).
  • Translatable strings starting with underscores (_) are reserved. You cannot use translatable phrases starting with an underscore.
  • Make sure that the translatable string is constant. Do not include %MACROS% inside the translatable strings as they will be expanded before the %MAKETEXT{...}% itself is handled. You can, however, use macros in the args, as shown in the examples above.
  • The string will be output in English if no mapping can be found in the .po translation file for the current user's selected language.

• Plurals:
  • The %MAKETEXT macro also supports a limited subset of the quant style bracket notation:

      %MAKETEXT{string="Edit [*,_1,file]" args="4"}%
      expands to:
        Edit 4 files

• Notes on plurals:
  • Only 3 arguments are supported.
  • The first parameter must be an asterisk. Literals quant, numf or # are not supported.
  • The 2nd parameter must be the argument number
  • The 3rd parameter is the word or phrase to be made plural.

MAROON -- start maroon colored text

• MAROON is one of the shortcut macros predefined in DefaultPreferences. See the section shortcut macros in that topic for a complete list of colors.
  Example:

  %MAROON% maroon text %ENDCOLOR%

  Expands to: maroon text

  %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write

  %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%

META -- displays meta-data

• "form" - generates the table showing the form fields. See Form Definition.
• "attachments" - generate a table of attachments
  • all="on" to show hidden attachments.
  • title="..." to show a title - only if attachments are displayed.
  • template="..." to use a custom template for the rendering of attachments; default attachtables is used.
• "moved" - if a topic was moved or renamed, generates a message with details and a revert link
  • prefix="...": Prefix that goes before the moved message, but only if the message is generated, default "".
  • suffix="...": Prefix that goes after the moved message, but only if the message is generated, default "".
• "parent" - display details of ancestor topics
  • dontrecurse="on": By default recurses up tree, this has some cost. Equivalent to depth=1
  • depth="...": Return only the specified ancestor.
  • nowebhome="on": Suppress WebHome.
  • format="...": Format string used to display each parent topic where $web expands to the web name, and $topic expands to the topic name; default: "[[$web.$topic][$topic]]"
  • separator="...": Separator between parents; default " > "
  • prefix="...": Prefix that goes before parents, but only if there are parents, default "".
  • suffix="...": Suffix, only appears if there are parents; default "".
• "formfield" - display the value of a single form field
  • name="...": name of the field.
  • newline="...": by default, each newline character will be rewritten to <br /> to allow metadata that contains newlines to be used in tables, etc. $n indicates a newline character.
  • bar="...": by default, each vertical bar is rewritten to an HTML entity so as to not be mistaken for a table separator.

Use of "formfield" is deprecated in favour of the much more powerful QUERY macro.

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.

• Syntax: %METASEARCH{...}%
• Supported parameters:

  Parameter:	Description:	Default:
  type="topicmoved"	What sort of search is required? "topicmoved" if search for a topic that may have been moved "parent" if searching for topics that have a specific parent i.e. its children "field" if searching for topics that have a particular form field value (use the name and value parameters to specify which field to search).	Required
  web="%WEB%"	Wiki web to search: A web, a list of webs separated by whitespace, or all webs.	Current web
  topic="%TOPIC%"	The topic the search relates to, for topicmoved and parent searches	All topics in a web
  name	form field to search, for field type searches. May be a regular expression (see SEARCH).
  value	form field value, for field type searches. May be a regular expression (see SEARCH).
  title="Title"	Text that is prefixed to any search results	empty
  format="..."	Custom format results. Supports same format strings as SEARCH. See FormattedSearch for usage & examples	Results in table
  default="none"	Default text shown if no search hit	Empty

• Examples:

    %METASEARCH{
      type="topicmoved"
      web="%WEB%"
      topic="%TOPIC%"
      title="This topic used to exist and was moved to: "
    }%

  You may want to use this in WebTopicViewTemplate and WebTopicNonWikiTemplate:

    %METASEARCH{
      type="parent"
      web="%WEB%"
      topic="%TOPIC%"
      title="Children: "
    }%
  
    %METASEARCH{
      type="field"
      name="Country"
      value="China"
    }%

• Related: SEARCH, META

N -- "new" icon

• Current value: N =
• Related: H, I, ICON, M, P, Q, S, T, U, X, Y

NAVY -- start navy colored text

• NAVY is one of the shortcut macros predefined in DefaultPreferences. See the section shortcut macros in that topic for a complete list of colors.
  Example:

  %NAVY% navy text %ENDCOLOR%

  Expands to: navy text

  %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write

  %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%

NOP -- template text not to be expanded in instantiated topics

• Syntax: %NOP%
  • In normal topic text, expands to <nop>, which prevents expansion of adjacent macros and wikiwords
  • When the topic containing this is used as a template for another topic, it is removed.
• Syntax: %NOP{...}% deprecated
  • In normal topic text, expands to whatever is in the curly braces (if anything).

    This is deprecated. Do not use it. Use %STARTSECTION{type="templateonly"}% .. %ENDSECTION{type="templateonly"}% instead (see TemplateTopics for more details).

• Related: STARTSECTION, TemplateTopics

NOTIFYTOPIC -- name of the notify topic

• Syntax: %NOTIFYTOPIC%
• Expands to: WebNotify, renders as WebNotify
• Related: HOMETOPIC, STATISTICSTOPIC, TOPIC

OLIVE -- start olive colored text

• OLIVE is one of the shortcut macros predefined in DefaultPreferences. See the section shortcut macros in that topic for a complete list of colors.
  Example:

  %OLIVE% olive text %ENDCOLOR%

  Expands to: olive text

  %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write

  %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%

ORANGE -- start orange colored text

• ORANGE is one of the shortcut macros predefined in DefaultPreferences. See the section shortcut macros in that topic for a complete list of colors.
  Example:

  %ORANGE% orange text %ENDCOLOR%

  Expands to: orange text

  %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write

  %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%

P -- pencil icon

• Current value: P =
• Related: H, I, ICON, M, N, Q, S, T, U, X, Y

PINK -- start pink colored text

• PINK is one of the shortcut macros predefined in DefaultPreferences. See the section shortcut macros in that topic for a complete list of colors.
  Example:

  %PINK% pink text %ENDCOLOR%

  Expands to: pink text

  %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write

  %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%

PLUGINDESCRIPTIONS -- list of plugin descriptions

• Syntax: %PLUGINDESCRIPTIONS%
• Expands to:
  • SpreadSheetPlugin (1.1.7, v1.1.7): Add spreadsheet calculations like "$SUM($ABOVE())" to Foswiki tables and other topic text
  • AutoViewTemplatePlugin (2012-12-16, v1.1.7): Automatically sets VIEW_TEMPLATE and EDIT_TEMPLATE
  • CommentPlugin (1.1.6, v1.1.6): Quickly post comments to a page without an edit/save cycle
  • EditTablePlugin (4.43, 4.43): Edit tables using edit fields, date pickers and drop down boxes
  • HistoryPlugin (1.11, 1.11): Shows a complete history of a topic
  • InterwikiPlugin (1.1.6, v1.1.6): Link ExternalSite:Page text to external sites based on aliases defined in a rules topic
  • JQueryPlugin (4.45, 4.45): jQuery JavaScript library for Foswiki
  • MenuListPlugin (18-Nov-2012, 2.0): dynamic Folding menu list
  • PreferencesPlugin (1.1.4, v1.1.4): Allows editing of preferences using fields predefined in a form
  • RenderListPlugin (2.2.7, v2.2.7): Render bullet lists in a variety of formats
  • SmiliesPlugin (28 Nov 2012, v1.1.6): Render smilies like as icons
  • TablePlugin (1.141, 1.141): Control attributes of tables and sorting of table columns
  • TwistyPlugin (1.6.16, v1.6.16): Twisty section Javascript library to open/close content dynamically
• Related: ACTIVATEDPLUGINS, FAILEDPLUGINS, PLUGINVERSION

PLUGINVERSION -- the version of a Foswiki Plugin, or the Foswiki Plugins API

• Syntax: %PLUGINVERSION{"name"}% to get the version of a specific plugin
• Example: %PLUGINVERSION{"InterwikiPlugin"}% expands to v1.1.6
• Syntax: %PLUGINVERSION% to get the version of the API
• Expands to: 2.2
• Related: WIKIVERSION, ACTIVATEDPLUGINS, FAILEDPLUGINS, PLUGINDESCRIPTIONS

POPUPWINDOW{"topic" ...} -- opens a topic or url in a new window

• Parameters:

  Parameter:	Description:	Default:
  "topic", topic="topic", topic="web.topic"	Topic to open
  url	URL to open (if topic is not used)
  label	Link label	the topic or the url
  template	View template to call when viewing a topic; not used for URLs	"viewplain"
  width	Width of window	"600"
  height	Height of window	"480"
  toolbar	Show toolbars?	"0"
  scrollbars	Show scrollbars?	"1"
  status	Show status?	"1"
  location	Show location bar?	"0"
  resizable	Is the window resizable?	"1"
  left	Left position	"0"
  top	Top position	"0"
  center	Center the window?	"0"
  menubar	Show menubar?	"0"
  createnew	Create a new window for each popup?	"1"

• Example with topic link:

  %POPUPWINDOW{"Macros" label="Open this topic in a new window"}%

  Generates: Open this topic in a new window
• Example with url:

  %POPUPWINDOW{url="http://foswiki.org"}%

  Generates: http://foswiki.org
• Enable POPUPWINDOW by writing %JQREQUIRE{"popupwindow"}% on the page

PUBURL -- the base URL of attachments

• Syntax: %PUBURL%
• Expands to: http://malat.biz/foswiki/pub
• Example: You can refer to a file attached to another topic with %PUBURL%/%WEB%/OtherTopic/image.gif
• Related: ATTACHURL, ATTACHURLPATH, PUBURLPATH, SCRIPTURL, SCRIPTURLPATH, FileAttachments

PUBURLPATH -- the base URL path of attachments

• Syntax: %PUBURLPATH%
• Expands to: /foswiki/pub
• Related: ATTACHURL, ATTACHURLPATH, PUBURL, SCRIPTURL, SCRIPTURLPATH, FileAttachments

PURPLE -- start purple colored text

• PURPLE is one of the shortcut macros predefined in DefaultPreferences. See the section shortcut macros in that topic for a complete list of colors.
  Example:

  %PURPLE% purple text %ENDCOLOR%

  Expands to: purple text

  %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write

  %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%

Q -- question icon

• Current value: Q =
• Related: H, I, ICON, M, N, P, S, T, U, X, Y

QUERY -- get the value of meta-data

• Uses the query syntax described in QuerySearch to get information about meta-data.
  • supports formatted access to formfields and other meta-data in topics using the same syntax as is used in IF and SEARCH statements,
  • gives access to all meta-data, including that added by extensions,
  • supports reporting values using JSON and other standards, simplifying the retrieval of meta-data for REST applications,
  • replaces the FORMFIELD macro for most applications.
• Syntax: %QUERY{ "query" }%
• See QuerySearch for more details of how to write queries
• Parameters:
  • style="stylename" - set the output format (see below)
  • rev="version" - operate on the given version of the current topic. Note that this will only affect simple queries that refer to the current topic, such as form.name. More complex queries that use searches or indirection to refer to other topics always use the latest version of those topics.
• Examples:

        Get the name of the form in the current topic:
        %QUERY{"form.name"}%
  
        Get the value of the 'Firstname' form field in
          the current topic:
        %QUERY{"fields[name='Firstname'].value"}%
  
        Get the value of the 'Firstname' form field in
          the current topic (shorthand version):
        %QUERY{"Firstname"}%
  
        Get a list of all the names of attachments on
          the topic 'System.DocumentGraphics':
        %QUERY{"'System.DocumentGraphics'/attachments.name"}%
  
        Get configuration setting {NameFilter}:
        %QUERY{"{NameFilter}"}%

• style="perl" - generates values as Perl code strings
• style="json" - generates values as JSON strings, suitable for reading by browsers.

• Related: META QuerySearch

QUERYPARAMS -- show paramaters to the query

• Expands the parameters to the query that was used to display the page.
• Syntax: %QUERYPARAMS{...}%
• Supported parameters:

  Parameter:	Description:	Default:
  format="..."	Format string for each entry	$name=$value
  separator="..."	Separator string	separator="$n" (newline)
  encoding="entity" encoding="safe" encoding="html" encoding="quotes" encoding="url"	Control how special characters are encoded. If this parameter is not given, "safe" encoding is performed which HTML entity encodes the characters '"<>%. entity: Encode special characters into HTML entities, like a double quote into &#034;. Does not encode \n or \r. safe: Encode characters '"<>% into HTML entities. (this is the default) html: As type="entity" except it also encodes \n and \r quotes: Escape double quotes with backslashes (\"), does not change other characters url: Encode special characters for URL parameter use, like a double quote into %22	type="safe"

• The following escape sequences are expanded in the format string:

  Sequence:	Expands To:
  $name	Name of the parameter
  $value	String value of the parameter. Multi-valued parameters will have a "row" for each value.
  $n or $n()	New line. Use $n() if followed by alphanumeric character, e.g. write Foo$n()Bar instead of Foo$nBar Most macros accept parameter strings which are split over multiple lines. This is usually more readable than using $n tokens. If you are familiar with sectional includes, you might also consider nested sectional includes to hold the newline content outside of the parameter string entirely. Note that newline is not a line break. The browser will wrap the lines together. If you require a line break, displaying the results on two lines, use %BR%. Or use two consecutive newlines to create a TML "Paragraph".
  $nop or $nop()	Is a "no operation". This token gets removed; useful for nested search
  $quot	Double quote (") (\" also works)
  $percent	Percent sign (%) ($percnt also works)
  $dollar	Dollar sign ($)
  $lt	Less than sign (<)
  $gt	Greater than sign (>)
  $amp	Ampersand (&)
  $comma	Comma (,)

• Example:

     %QUERYPARAMS{
       format="<input type='hidden' name='$name' value='$value' encoding="entity" />"
     }%

Security warning!

Using QUERYPARAMS can easily be misused for cross-site scripting unless specific characters are entity encoded. By default QUERYPARAMS encodes the characters '"<>% into HTML entities (same as encoding="safe") which is relatively safe. The safest is to use encoding="entity". When passing QUERYPARAMS inside another macro always use double quotes ("") combined with using QUERYPARAMS with encoding="quote". For maximum security against cross-site scripting you are adviced to install the Foswiki:Extensions.SafeWikiPlugin.

• See also QUERYSTRING, URLPARAM

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 example, if you add ?name=Samantha;age=24;eyes=blue to this URL you can see this in action. This string can be appended to a URL to pass parameter values on to another page.

  URLs built this way are typically restricted in length, typically to 2048 characters. If you need more space than this, you will need to use an HTML form and =%QUERYPARAMS%=

• Syntax: %QUERYSTRING%
• Expands to: colsidx=1;skin=widgets;widgetscolumns=w
• Related: QUERYPARAMS, URLPARAM

RED -- start red colored text

• RED is one of the shortcut macros predefined in DefaultPreferences. See the section shortcut macros in that topic for a complete list of colors.
  Example:

  %RED% red text %ENDCOLOR%

  Expands to: red text

  %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write

  %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%

REMOTE_ADDR -- environment variable

• Syntax: %REMOTE_ADDR%
• Expands to: 10.102.222.130
• Related: ENV, HTTP_HOST, REMOTE_PORT, REMOTE_USER

REMOTE_PORT -- environment variable

• Syntax: %REMOTE_PORT%
• Expands to:
• Related: ENV, HTTP_HOST, REMOTE_ADDR, REMOTE_USER

REMOTE_USER -- environment variable

• Syntax: %REMOTE_USER%
• Expands to:
• Related: ENV, HTTP_HOST, REMOTE_ADDR, REMOTE_PORT, USERNAME, WIKINAME, WIKIUSERNAME

RENDERLIST -- render bullet lists in a variety of formats

• The %RENDERLIST% macro is handled by the RenderListPlugin
• Syntax: %RENDERLIST%
• Example:

  %RENDERLIST{"org" focus="Sales.WestCoastTeam"}%
        * [[Eng.WebHome][Engineering]]
           * [[Eng.TechPubs][Tech Pubs]]
        * [[Sales.WestCoastTeam][Sales]]
           * [[Sales.EastCoastTeam][East Coast]]
           * [[Sales.WestCoastTeam][West Coast]]

Expands as:

Sales

East Coast

West Coast

• Related: RenderListPlugin

RENDERZONE

%RENDERZONE{"zone" ...}%

• "zone" required, name of the zone.
• format="..." optional, format string for each item added to the zone, default:

  $item <!--<literal> $id $missing</literal>-->

  Tokens:
  • $id - id of the ADDTOZONE call within the zone currently being rendered.
  • $item - text of the ADDTOZONE call within the zone currently being rendered.
  • $zone - the "zone" currently being rendered.
  • $missing - if the ADDTOZONE call being rendered required any id which was not found, then $missing is the missingtoken parameter; empty string otherwise.
  • $missingids - comma separated list of ids that were required by the ADDTOZONE call currently being rendered but weren't found within this zone.
• missingtoken="..." optional, this will be the string assigned to the $missing format token for use in the format parameter. Default:

  $id: requires= missing ids: $missingids

• chomp="on" remove leading and trailing whitespace from formatted items, can be useful for pretty-printing and compression.
• header="..." optional, prepended to the output
• footer="..." optional, appended to the output
• separator="..." optional, put between each item of a zone

• header and footer are not output if there is no content in the zone (nothing has been ADDTOZONEd ). However they are output if the output is the empty string (at least one ADDTOZONE has been processed).
• Zones are cleared after being rendered; they are only ever rendered once.
• head and script are automatic zones. They don't require a corresponding RENDERZONE anywhere in the templates - they are automatically inserted before the </head> tag in the output HTML page.
• Normally, dependencies between individual ADDTOZONE statements are resolved within each zone. However, if {MergeHeadAndScriptZones} is enabled in configure, then head content which requires an id that only exists in script will be re-ordered to satisfy this dependency.

  {MergeHeadAndScriptZones} will be removed from a future version of Foswiki.

REVARG -- &rev=n URL revision parameter of current topic

• Syntax: %REVARG%
• %REVARG% If a topic revision is requested in the URL, it returns the revision of the current topic suitable for concatenation to the view query parameters. Otherwise returns an empty string.
• Expands to: (simulated) &rev=3 (actual)
• Related: REVINFO, REVTITLE

REVINFO -- revision information of current topic

• Syntax: %REVINFO%
• %REVINFO% is equivalent to %REVINFO{format="r1.$rev - $date - $wikiusername"}%
  • Expands to: r1 - 26 Jun 2011 - 21:39:52 - ProjectContributor
• Related: REVARG,REVTITLE

REVINFO{"format"} -- formatted revision information of topic

• Syntax: %REVINFO{"format"}%
• %REVINFO% is equivalent to %REVINFO{format="r$rev - $date - $wikiusername"}%
  • Expands to: r1 - 26 Jun 2011 - 21:39:52 - ProjectContributor
• Supported parameters:

  Parameter:	Description:	Default:
  "format"	Format of revision information, see supported formatting tokens below	"r1.$rev - $date - $wikiusername"
  web="..."	Name of web	Current web
  topic="..."	Topic name	Current topic
  rev="1.5"	Specific revision number	Latest revision

• Supported formatting tokens:

  Token:	Unit:	Example
  $web	Name of web	Current web
  $topic	Topic name	Current topic
  $rev	Revision number. Prefix r1. to get the usual r1.5 format	5
  $username	Login username of revision	jsmith
  $wikiname	WikiName of revision	JohnSmith
  $wikiusername	WikiName with Main web prefix	Main.JohnSmith
  $date	Revision date. Actual date format defined as {DefaultDateFormat} in configure	21 Sep 2006
  $time	Revision time	23:24:25
  $iso	Revision date in ISO date format	2006-09-22T06:24:25Z
  $min, $sec, etc.	Same date format qualifiers as GMTIME{"format"}

• Example, returns revision info of first revision:

  %REVINFO{"$date - $wikiusername" rev="1.1"}%

• To get the latest revision, even when looking at an older revision:

  %REVINFO{"$rev" rev="-1"}%

• Related: REVARG,REVTITLE

REVTITLE -- (r1) The requested revision as displayed in topic breadcrumbs

• Syntax: %REVTITLE%
• %REVTITLE% If a topic revision is requested in the URL, it returns the printable revision of the current topic revision. Otherwise returns an empty string.
• Expands to: (simulated) (r3) (actual)
• Related: REVINFO, REVARG

S -- red star icon

• Current value: S =
• Related: H, I, ICON, M, N, P, Q, T, U, X, Y

SCRIPTNAME -- name of current script

• The name of the current script is shown, including script suffix, if any (for example viewauth.cgi)
• Syntax: %SCRIPTNAME%
• Expands to: view
• Related: SCRIPTSUFFIX, SCRIPTURL, SCRIPTURLPATH

SCRIPTSUFFIX -- script suffix

• Some Petr Malát installations require a file extension for CGI scripts, such as .pl or .cgi
• Syntax: %SCRIPTSUFFIX%
• Expands to:
• Related: SCRIPTNAME, SCRIPTURL, SCRIPTURLPATH

SCRIPTURL{"script"} -- URL of script

• Syntax: %SCRIPTURL% OR %SCRIPTURL{"script"}%
• %SCRIPTURL% returns the base URL of scripts - expands to http://malat.biz
• Expands to: http://malat.biz/script
• Example: To get the authenticated version of the current topic you can write %SCRIPTURL{"viewauth"}%/%WEB%/%TOPIC% which expands to http://malat.biz/viewauth/System/Macros

  In most cases you should use %SCRIPTURLPATH{"script"}% instead, as it works with URL rewriting much better

  The edit script should always be used in conjunction with ?t=%GMTIME{"$epoch"}% to ensure pages about to be edited are not cached in the browser

• Related: PUBURL, SCRIPTNAME, SCRIPTSUFFIX, SCRIPTURLPATH

SCRIPTURLPATH{"script"} -- URL path of script

• As %SCRIPTURL{"script"}%, but doesn't include the protocol and host part of the URL
• Syntax: %SCRIPTURL% OR %SCRIPTURLPATH{"script"}%
• Expands to: /script

  The edit script should always be used in conjunction with ?t=%GMTIME{"$epoch"}% to ensure pages about to be edited are not cached in the browser

• Related: PUBURLPATH, SCRIPTNAME, SCRIPTSUFFIX, SCRIPTURL

SEARCH{"text"} -- search content

• Inline search, shows a search result embedded in a topic
• Syntax: %SEARCH{"text" ...}%
• Supported parameters:

  Parameter:	Description:	Default:
  "text"	Search term. Is a keyword search, literal search, regular expression search, or query, depending on the type parameter. SearchHelp has more	required
  search="text"	(Alternative to above)	N/A
  web="Name" web="Main, Know" web="all"	Comma-separated list of webs to search. You can specifically exclude webs from an all search using a minus sign - for example, web="all,-Secretweb". The special word all means all webs that do not have the NOSEARCHALL preference set to on in their WebPreferences. Note that AccessControls are respected when searching webs; it is much better to use them than NOSEARCHALL. Wildcards are not currently supported for web names.	Current web
  topic="WebPreferences" topic="*Bug"	Limit search to topics: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. Note this is a list of topic names and must not include web names.	All topics in a web
  excludetopic="Web*" excludetopic="WebHome, WebChanges"	Exclude topics from search: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. Note this is a list of topic names and must not include web names.	None
  scope="topic" scope="text" scope="all"	Search topic name (title); the text (body) of topic; or all (title and body)	"text"
  type="keyword" type="word" type="literal" type="regex" type="query"	Control how the search is performed when scope="text" or scope="all" keyword: use Google-like controls as in soap "web service" -shampoo; searches word parts: using the example, topics with "soapsuds" will be found as well, but topics with "shampoos" will be excluded word: identical to keyword but searches whole words: topics with "soapsuds" will not be found, and topics with "shampoos" will not be excluded literal: search for the exact string, like web service regex: use a RegularExpression search like soap;web service;!shampoo; to search on whole words use \bsoap\b query: query search of form fields and other meta-data, like (Firstname='Emma' OR Firstname='John') AND Lastname='Peel'	%SEARCHVAR- DEFAULTTYPE% preferences setting (literal)
  order="topic" order="created" order="modified" order="editby" order=  "formfield(name)"	Sort the results of search by the topic names, topic creation time, last modified time, last editor's WikiName, or named field of DataForms. The sorting is done web by web; if you want to sort across webs, create a formatted table and sort it with TablePlugin's initsort. Note that dates are sorted most recent date last (i.e at the bottom of the table).	Sort by topic name
  limit="all" limit="16"	Limit the number of topics from which results will be returned. This is done after sorting if order is specified. Note that this does not limit the number of hits from the same topic when you have multiple="on".	All results
  date="..."	limits the results to those pages with latest edit time in the given time interval.	All results
  reverse="on"	Reverse the direction of the search	Ascending search
  casesensitive="on"	Case sensitive search	Ignore case
  bookview="on"	BookView search, e.g. show complete topic text. Very resource demanding. Use only with small result sets	Show entire topic content.
  nonoise="on"	Shorthand for nosummary="on" nosearch="on" nototal="on" zeroresults="off" noheader="on" noempty="on"	Off
  nosummary="on"	Show topic title only	Show topic summary
  nosearch="on"	Suppress search string	Show search string
  noheader="on"	Suppress default search header Topics: Changed: By: , unless a header is explicitly specified	Show default search header, unless search is inline and a format is specified (Cairo compatibility)
  nototal="on"	Do not show number of topics found	Show number
  zeroresults="off" or zeroresults="..."	Suppress/replace all output if there are no hits (the boolean nature of the setting uses true, false, on, off, 0 so those cannot be used as a format string on their own (insert a to escape them))- can also be set to a FormattedSearch string to customise the output	zeroresults="on" - displays the summary, and number of topics found. "Number of topics: 0"
  noempty="on"	Suppress results for webs that have no hits.	Show webs with no hits
  header="..." format="..." footer="..."	Custom format results: see FormattedSearch for usage & examples	Results in table
  expandvariables="on"	Expand embedded macros before applying a FormattedSearch on a search hit. Useful to show the expanded text, e.g. to show the result of a SpreadSheetPlugin %CALC{}% instead of the formula	Raw text
  multiple="on"	Multiple hits per topic. Each hit can be formatted. The last token is used in case of a regular expression ";" and search	Only one hit per topic
  nofinalnewline="on"	If on, the search variable does not end in a line by itself. Any text continuing immediately after the SEARCH macro on the same line will be rendered as part of the table generated by the search, if appropriate. This feature is only active when format is defined.	on
  recurse="on"	Recurse into subwebs, if subwebs are enabled. Note: recurse will currently search subwebs of explicitly excluded webs. (web="all, -Sandbox" recurse="on") will still search subwebs of Sandbox. This behavior is likely to change in a future release.	off
  separator=", "	Line separator between search hits (only used when format= is set) uses FormatTokens. If separator is not defined, the default is "$n" (newline). Not defining the separator will additionally cause a newline to be added after a header and before a footer.	"$n" (Newline)
  newline="%BR%"	Line separator within a search hit. Useful if you want to put multi-line content into a table cell, for example if the format="" parameter contains a $pattern() that captures more than one line.	"$n" (Newline)
  pagesize="25"	number of items to show per page	"25"
  showpage="1"	Page of items to show (starts at 1) (over-ridden by the value specified by the URL parameter hash from $previousurl and $nexturl)	"1"
  pager="on"	appends the pager to the footer format (the quickest way to add paging to your SEARCHes is to just add pager="on") Note: the default pager (when pagerformat is not defined) requires the parameters to the SEARCH to not change while paging, as it uses $previousurl and $nexturl which use a hash of the Macro's parameters to override the value of showpage. If you use time variable parameters, you will need to define your own pagerformat.	"off"
  pagerformat="text"	Custom format results: see FormattedSearch for usage & examples	filled from skin template
  groupby="none"	Warning: this option is liable to change dramatically (and potentially incompatibly) in the next major release of foswiki. Setting to "none" applies only to multi-web SEARCHs, and means the header and footer are only output once - at the beginning and end of the list of results, and the order parameter is applied over the entire set of results (this setting removes the legacy that results are always partitioned by web) see SiteChanges for an example.	"web"

• Example:

  %SEARCH{"wiki" web="%USERSWEB%" scope="topic"}%

• Example with format:

  %SEARCH{
      "FAQ"
      nonoise="on"
      header="| *Topic: * | *Summary: * |"
      format="| $topic    | $summary    |"
  }%

  (displays results in a table with header - details)

The appearance of the table emitted by the SEARCH may be controlled with TablePlugin's %TABLE{}% macro placed just before the %SEARCH{}%. Example: %TABLE{ tablewidth="90%" }%

SERVERTIME{"format"} -- formatted server time

• Same format qualifiers as %GMTIME%
• Syntax: %SERVERTIME% OR %SERVERTIME{"format"}%
• %SERVERTIME% uses the Date format defined as {DefaultDateFormat} in configure
• Example: %SERVERTIME{"$hou:$min"}% expands to 15:57

  Note: When used in a template topic, this macro will be expanded when the template is used to create a new topic. See TemplateTopics#TemplateTopicsVars for details.

• Related: GMTIME, SERVERTIME

SESSIONID -- unique ID for this session

• Syntax: %SESSIONID%
• Expand to: 123f9c13d18dc68b827944eb40fb79b5
• Related: UserAuthentication, AUTHREALM, SESSIONVAR, LOGIN, LOGOUT, SESSION_VARIABLE

SESSIONVAR -- name of CGI and session variable that stores the session ID

• Syntax: %SESSIONVAR%
• Expand to: FOSWIKISID
• Related: UserAuthentication, AUTHREALM, SESSIONID, LOGIN, LOGOUT, SESSION_VARIABLE

SESSION_VARIABLE -- get, set or clear a session variable

• Syntax: %SESSION_VARIABLE{"name"}%
• Syntax: %SESSION_VARIABLE{"name" set="value"}%
• Syntax: %SESSION_VARIABLE{"name" clear=""}%

  The users ID is in the AUTHUSER session variable, and is read-only

• Related: UserAuthentication, AUTHREALM, SESSIONID, SESSIONVAR, LOGIN, LOGOUT

SHOWPREFERENCE -- show where preferences are defined.

• %SHOWPREFERENCE%
  • Show all preferences
• %SHOWPREFERENCE{"PREFERENCENAME"}%
  • Show a single preference
  • Example:

    %SHOWPREFERENCE{"ATTACHFILESIZELIMIT"}%

  • Expands as:

       * Set ATTACHFILESIZELIMIT = "10000"
          * ATTACHFILESIZELIMIT was *finalised* in System.DefaultPreferences
    

• %SHOWPREFERENCE{"PREFERENCENAME,PREFERENCENAME,..."}%
  • Show all of the preferences in a comma-separated list of preference names. This is particularly useful for reviewing the access controls that apply to a topic.
  • Example:

    %SHOWPREFERENCE{"DENYWEBCHANGE,ALLOWWEBCHANGE"}%

  • Expands as:

       * Set DENYWEBCHANGE = ""
       * Set ALLOWWEBCHANGE = "%USERSWEB%.AdminGroup"
          * ALLOWWEBCHANGE was defined in System.WebPreferences
    

SILVER -- start silver colored text

• SILVER is one of the shortcut macros predefined in DefaultPreferences. See the section shortcut macros in that topic for a complete list of colors.
  Example:

  %SILVER% silver text %ENDCOLOR%

  Expands to: silver text

  %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write

  %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%

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 parameter skin, such as ?skin=catskin,bearskin
• You can also extend the existing skin path using covers - see COVER
• Syntax: %SKIN%
• Expands to: widgets
• See Skins for more information
• Related: SkinBrowser

SLIDESHOWEND -- end slideshow

• The %SLIDESHOWEND% macro is handled by the SlideShowPlugin
• Syntax: %SLIDESHOWEND%
• Example: See SLIDESHOWSTART
• Related: SLIDESHOWSTART, SlideShowPlugin

SLIDESHOWSTART -- convert a topic with headings into a slideshow

• The %SLIDESHOWSTART% macro is handled by the SlideShowPlugin
• Syntax: %SLIDESHOWSTART%
• Syntax: %SLIDESHOWSTART{ template="MyOwnSlideTemplate" }%
• Example:

   %SLIDESHOWSTART%
   ---++ Sample Slide 1
      * Bullet 1
      * Bullet 2
   ---++ Sample Slide 2
      * Bullet 1
      * Bullet 2
   %SLIDESHOWEND%

• Expands as:

Sample Slide 1

• Bullet 1
• Bullet 2

Sample Slide 2

• Bullet 1
• Bullet 2

• Related: SLIDESHOWEND, SlideShowPlugin

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 backlinks to the current topic
• Syntax: %SPACEDTOPIC%
• Expands to: Var%20*SPACEDTOPIC

  This is a deprecated macro. It can be duplicated with %ENCODE{%SPACEOUT{"%TOPIC%" separator=" *"}%}%

• Related: SPACEOUT, TOPIC, ENCODE

SPACEOUT{"string"} -- 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 after digits that are followed by a capital letter.
• Useful for spacing out WikiWords
• Syntax: %SPACEOUT{ "%TOPIC%" }%
• Expands to: Macros
• Supported parameters:

  Parameter:	Description:	Default:
  separator	The separator to put between words e.g. %SPACEOUT{"DogsCatsBudgies" separator=", "}% -> Dogs, Cats, Budgies	' '

  Spaced out WikiWords are not automatically linked. To SPACEOUT a WikiWord but preserve the link use "double bracket" format. For example, [[WebHome][%SPACEOUT{"WebHome"}%]] expands to Web Home

• Related: SPACEDTOPIC, $PROPERSPACE() of SpreadSheetPlugin

STARTINCLUDE -- start position of topic text if included

• If present in included topic, start to include text from this location up to the end, or up to the location of the %STOPINCLUDE% macro. A normal view of the topic shows everything exept the %STARTINCLUDE% macro itself.
• Syntax: %STARTINCLUDE%

  If you want more than one part of the topic included, use %STARTSECTION{type="include"}% instead

• Related: INCLUDE, STARTSECTION, STOPINCLUDE

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 help identify them, and/or a type, which changes how they are used.
  • type="section" - the default, used for a generic section, such as a named section used by INCLUDE.
  • type="include" - like %STARTINCLUDE% ... %STOPINCLUDE% except that you can have as many include blocks as you want which are all merged into one when included (%STARTINCLUDE% is restricted to only one). Sections of type include may not be given a name.
  • type="expandvariables" - all macros inside an "expandvariables" type section gets expanded when a new topic based on the template topic is created. See TemplateTopics for more information.
  • type="templateonly" - start position of text to be removed when a template topic is used. This is used to embed text that you do not want expanded when a new topic based on the template topic is created. See TemplateTopics for more information.
• Syntax: %STARTSECTION{"name"}% ................... %ENDSECTION{"name"}%
• Syntax: %STARTSECTION{type="include"}% ........... %ENDSECTION{type="include"}%
• Syntax: %STARTSECTION{type="expandvariables"}% ... %ENDSECTION{type="expandvariables"}%
• Syntax: %STARTSECTION{type="templateonly"}% ...... %ENDSECTION{type="templateonly"}%

• Supported parameters:

  Parameter:	Description:	Default
  "name"	Name of the section. Must be unique inside a topic.	Generated name
  type="..."	Type of the section; type "section", "expandvariables", "include" or "templateonly"	"section"

  If a section is not given a name, it will be assigned one. Unnamed sections are assigned names starting with _SECTION0 for the first unnamed section in the topic, _SECTION1 for the second, etc..

  You can define nested sections. It is not recommended to overlap sections, although it is valid in Foswiki. Use named sections to make sure that the correct START and ENDs are matched. Section markers are not displayed when a topic is viewed.

• Related: ENDSECTION, INCLUDE, NOP, STARTINCLUDE, STOPINCLUDE

STATISTICSTOPIC -- name of statistics topic

• Syntax: %STATISTICSTOPIC%
• Expands to: WebStatistics, renders as WebStatistics
• Related: HOMETOPIC, NOTIFYTOPIC, TOPIC

STOPINCLUDE -- 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 of the topic shows everyting exept the %STOPINCLUDE% macro itself.
• Syntax: %STOPINCLUDE%
• Related: INCLUDE, STARTINCLUDE

SYSTEMWEB -- name of documentation web

• The web containing all documentation and default preference settings
• Syntax: %SYSTEMWEB%
• Expands to: System
• Related: USERSWEB

T -- tip icon

• Current value: T =
• Related: H, I, ICON, M, N, P, Q, S, U, X, Y

TAB{"text" ...} -- tab inside a tabpane widget

• Defines a tab inside a TABPANE area; must be closed using ENDTAB.
• Parameters:

  Parameter:	Description:	Default:
  "text"	label of the tab	Tab
  before	when switching tabs, this is the javascript fragment to be executed just before the tab is displayed
  after	this javascript handler is to be executed after the tab has been made visible
  afterload	this javascript handler will be called when content loaded asynchronously (using the url parameter, below) has finished loading; depending on the network latency, this can be significantly later than execution of the after handler above
  id	id of this tab; this id can be used in the TABPANEs select parameter to display this tab; this id is also added to the class attribute of the html element representing the tab button
  url	link from where to load the content of the tab asynchronously when selecting this tab; the result of the addressed handler will replace the content area; if no url is set the content of the TAB ... ENDTAB area will be shown when the tab is selected
  width	width of the tab area	auto
  height	height of the tab area	auto
  container	element where ajax content will be loaded; this is only used together with url

• Related: VarENDTAB, VarTABPANE, VarENDTABPANE, JQueryPlugin, JQueryTabpane

TABLE{ attributes } -- control attributes of tables and sorting of table columns

• The %TABLE{}% macro is handled by the TablePlugin
• Syntax: %TABLE{ attributes }%

Attributes for tables

Attributes for table sorting

Attributes for table cells

Attributes for data cells

Attributes for headers

Other attributes

• Example:

   %TABLE{ tableborder="0" cellpadding="4" cellspacing="3" cellborder="0" }%
   | *A1* | *B1* |
   | A2   | B2   |

• Expands as:

  A1	B1
  A2	B2

• Related: See TablePlugin for more details

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:

  %TABPANE%
   %TAB{"tab 1"}%
     ...
   %ENDTAB%
   %TAB{"tab 2"}%
     ...
   %ENDTAB%
  %ENDTABPANE%
  

  Multiple tabpanes can be nested using the following scheme:

  %TABPANE%
   %TAB{"tab 1"}%
     %TABPANE%
       %TAB{"tab 1.1"}%
         ...
       %ENDTAB%
       %TAB{"tab1.2"}%
         ...
       %ENDTAB%
     %ENDTABPANE%
   %ENDTAB%
   %TAB{"tab 2"}%
     ...
   %ENDTAB%
  %ENDTABPANE%
  

• Example: see JQueryTabpane for more examples
• Parameters:

  Parameter:	Description:	Default:
  select	number or id of tab to select	1
  automaxexpand	resizes the tabpane to the maximum height to fit into the window	off
  minheight	when automaxexpand is enabled, this is the minimum size a tab is allowed to be resized	230
  class	extra class: use simple for a non-3D tabpane
  animate	(on/off) enables/disables animation of switching tabs	off

• Related: VarTAB, VarENDTAB, VarENDTABPANE, JQueryPlugin, JQueryTabpane

TEAL -- start teal colored text

• TEAL is one of the shortcut macros predefined in DefaultPreferences. See the section shortcut macros in that topic for a complete list of colors.
  Example:

  %TEAL% teal text %ENDCOLOR%

  Expands to: teal text

  %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write

  %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%

TOC{"Topic"} -- table of contents

• Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax ("---++ text") and HTML ("<h2>text</h2>") are taken into account. Any heading text after "!!" is excluded from the TOC; for example, write "---+!! text" if you do not want to list a header in the TOC
• Syntax: %TOC% OR %TOC{"SomeTopic" ...}%
• Supported parameters:

  Parameter:	Description:	Default:
  "TopicName"	topic name	Current topic
  web="Name"	Name of web	Current web
  depth="2"	Limit depth of headings shown in TOC	6
  title="Some text"	Title to appear at top of TOC	none

• Default settings are defined in DefaultPreferences, and can be overridden in SitePreferences
• Examples:

  %TOC{depth="2"}%
   %TOC{"CompleteDocumentation" web="%SYSTEMWEB%" title="Contents:"}%

  See also: Foswiki:Support/HowToCreateATableOfContents

  TOC will add an HTML anchor called foswikiTOC just before the table of contents. This enables adding a link from within a topic back to the table of contents to ease navigation. Example [[#foswikiTOC][Back to TOC]] creates Back to TOC.

  If multiple headers have the exact same text, the anchors for the 2nd, 3rd etc will be suffixed by _AN1, _AN2 etc so the anchors become unique.

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 topic.
• Syntax: %TOPIC%
• Expands to: Macros, renders as Macros
• Related: BASETOPIC, INCLUDINGTOPIC, TOPICLIST, WEB

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 formatting tokens: The $topic token gets expanded to the topic name, $marker to marker parameter where topic matches selection, and $web to the name of the web, or any of the standard FormatTokens.
• Syntax: %TOPICLIST{"format" ...}%
• Supported parameters:

  Parameter:	Description:	Default:
  "format"	Format of one line, may include $web (name of web), $topic (name of the topic), $marker (which expands to marker for the item matching selection only)	"$topic"
  format="format"	(Alternative to above)	"$topic"
  separator=", "	line separator	"$n" (new line)
  marker="selected"	Text for $marker if the item matches selection	"selected"
  selection="TopicA, TopicB"	Current value to be selected in list	(none)
  web="Name"	Name of web	Current web

• Examples:

     Create a bullet list of all topics:
     %TOPICLIST{"   * $web.$topic"}%
  
     Create a comma separated list of all topics:
     %TOPICLIST{separator=", "}%
  
     Create an option list (for drop down menus):
     %TOPICLIST{" <option>$topic</option>"}%
  
     Create an option list of web topics with the current topic selected:
     <select>%TOPICLIST{
        " <option $marker value='$topic'>$topic</option>"
        separator=" "
        selection="%TOPIC%"
     }%</select>

• Related: SEARCH, WEBLIST

TOPICURL -- shortcut to viewing the current topic

• This macro always expands to an url pointing to the current base topic.
• Current value: TOPICURL = http://malat.biz/view/System/Macros

TWIKIWEB -- synonym for SYSTEMWEB

Deprecated. Use %SYSTEMWEB% instead

TWISTY

• Related: VarENDTWISTY, VarENDTWISTYTOGGLE, VarTWISTY, VarTWISTYBUTTON, VarTWISTYHIDE, VarTWISTYSHOW, VarTWISTYTOGGLE

TWISTYBUTTON

• Supported parameters: all parameters supported by TWISTY, except for noscript and class (only used for 'toggle' content)
• Parameter differences:
  • mode: button mode defaults to div
• Syntax: %TWISTYBUTTON{id="myid" ... }%
• Supported parameters:

  Parameter	Value	Description	Remark
  mode	"div" or "span"	Specify if the Twisty button will use a <div> or a <span> tag. Note that if the contents contains block elements such as div, mode should be div as well to create valid HTML markup.	optional, defaults to <div>

• Example:

  %TWISTYBUTTON{
      id="myid"
      link="more"
    }%%TWISTYTOGGLE{
      id="myid"
    }%content%ENDTWISTYTOGGLE%

• Expands as:
  moremore
  content
• Related: VarENDTWISTY, VarENDTWISTYTOGGLE, VarTWISTY, VarTWISTYBUTTON, VarTWISTYHIDE, VarTWISTYSHOW, VarTWISTYTOGGLE

TWISTYHIDE

• Syntax: %TWISTYHIDE{id="myid" ... }%
• Supported parameters:

  Parameter	Value	Description	Remark
  id	Unique identifier	Used to link TWISTYSHOW, TWISTYHIDE and TWISTYTOGGLE	required
  link	Link label	Hide link label	optional
  mode	"div" or "span"	Specify if the Twisty Hide link will use a <div> or a <span> tag. Note that if the contents contains block elements such as div, mode should be div as well to create valid HTML markup.	optional, defaults to <div>
  img	Image url	Specify the url of an image that will be displayed at the right side of the link. You may use ICONURLPATH to display one of the DocumentGraphics icons. Alternatively use an image attached to the topic.	optional, defaults to no image
  remember	"on", "off"	If "on", the Twisty state is remembered the next time the page is shown. If "off", the stored setting will be cleared. Note: when used, think carefully about a unique name (id) for the Twisty, otherwise the cookie that is set might affect other Twisties with the same name. Also note that only interaction is stored, not the state of the Twisty when left unclicked.	optional, no default
  start	"hide" or "show"	Initial state of the Twisty; this will override any setting stored in a cookie (see remember).	optional, default no initial state
  firststart	"hide" or "show"	Initial state of the Twisty the first time the visitor gets to see the Twisty; this will NOT override cookie settings (see remember).	optional, default no initial state

• Example:

  %TWISTYHIDE{id="demo" link=" Click to Fold " imgleft="%ICONURLPATH{toggleclose}%"}%

• Related: VarENDTWISTY, VarENDTWISTYTOGGLE, VarTWISTY, VarTWISTYBUTTON, VarTWISTYHIDE, VarTWISTYSHOW, VarTWISTYTOGGLE

TWISTYSHOW

• Syntax: %TWISTYSHOW{id="myid" ... }%
• Supported parameters:

  Parameter	Value	Description	Remark
  id	Unique identifier	Used to link TWISTYSHOW, TWISTYHIDE and TWISTYTOGGLE	required
  link	Link label	Show link label	optional
  mode	"div" or "span"	Specify if the Twisty Show link will use a <div> or a <span> tag. Note that if the contents contains block elements such as div, mode should be div as well to create valid HTML markup.	optional, defaults to <div>
  img	Image url	Specify the url of an image that will be displayed at the right side of the link. You may use ICONURLPATH to display one of the DocumentGraphics icons. Alternatively use an image attached to the topic.	optional, defaults to no image
  imgleft	Image url	Specify the url of an image that will be displayed at the left side of the link. You may use ICONURLPATH to display one of the DocumentGraphics icons. Alternatively use an image attached to the topic.	optional, defaults to no image
  imgright	Image url	Specify the url of an image that will be displayed at the right side of the link. You may use ICONURLPATH to display one of the DocumentGraphics icons. Alternatively use an image attached to the topic.	optional, defaults to no image
  remember	"on", "off"	If "on", the Twisty state is remembered the next time the page is shown. If "off", the stored setting will be cleared. Note: when used, think carefully about a unique name (id) for the Twisty, otherwise the cookie that is set might affect other Twisties with the same name. Also note that only interaction is stored, not the state of the Twisty when left unclicked.	optional, no default
  start	"hide" or "show"	Initial state of the Twisty; this will override any setting stored in a cookie (see remember).	optional, default no initial state
  firststart	"hide" or "show"	Initial state of the Twisty the first time the visitor gets to see the Twisty; this will NOT override cookie settings (see remember).	optional, default no initial state

• Example:

  %TWISTYSHOW{id="demo" link=" Click to Unfold " imgleft="%ICONURLPATH{toggleopen}%"}%

• Related: VarENDTWISTY, VarENDTWISTYTOGGLE, VarTWISTY, VarTWISTYBUTTON, VarTWISTYHIDE, VarTWISTYSHOW, VarTWISTYTOGGLE

TWISTYTOGGLE

• Syntax: %TWISTYTOGGLE{id="myid"}%
• Supported parameters:

  Parameter	Value	Description	Remark
  id	Unique identifier	Used to link TWISTYSHOW, TWISTYHIDE and TWISTYTOGGLE.	required
  mode	"div" or "span"	Specify if the Twisty Toggle section will use a <div> or a <span> tag. Note that if the contents contains block elements such as div, mode should be div as well to create valid HTML markup.	optional, defaults to <div>
  class	CSS class name	Class for content div or span	optional, default none
  linkclass	CSS class name	Class for link	optional, default none
  remember	"on", "off"	If "on", the Twisty state is remembered the next time the page is shown. If "off", the stored setting will be cleared. Note: when used, think carefully about a unique name (id) for the Twisty, otherwise the cookie that is set might affect other Twisties with the same name. Also note that only interaction is stored, not the state of the Twisty when left unclicked.	optional, no default
  start	"hide" or "show"	Initial state of the Twisty; this will override any setting stored in a cookie (see remember).	optional, default no initial state
  firststart	"hide" or "show"	Initial state of the Twisty the first time the visitor gets to see the Twisty; this will NOT override cookie settings (see remember).	optional, default no initial state
  noscript	"hide"	Make content hidden in case use does not have JavaScript on	optional, default content is shown with no JavaScript

• Example:

  %TWISTYTOGGLE{id="demo" mode="div" remember="on"}%My content%ENDTWISTYTOGGLE%

• Related: VarENDTWISTY, VarENDTWISTYTOGGLE, VarTWISTY, VarTWISTYBUTTON, VarTWISTYHIDE, VarTWISTYSHOW, VarTWISTYTOGGLE

U -- "updated" icon

• Current value: U =
• Related: H, I, ICON, M, N, P, Q, S, T, X, Y

URLPARAM{"name"} -- get URL or HTTP POST parameter value

• Returns the value of the named parameter in the URL or HTTP POST request.
• Syntax: %URLPARAM{"name"}%
• Supported parameters:

  Parameter:	Description:	Default:
  "name"	The name of a URL parameter	required
  default="..."	Default value in case parameter is empty or missing	empty string
  newline="<br />"	Convert newlines in textarea to other delimiters	no conversion
  encode="off" encode="entity" encode="safe" encode="url" encode="quote"	Control how special characters are encoded off: No encoding. Avoid using this when possible. See the security warning below. entity: Encode special characters into HTML entities. See ENCODE for more details. safe: Encode characters '"<>% into HTML entities. url: Encode special characters for URL parameter use, like a double quote into %22 quote: Escape double quotes with backslashes (\"), does not change other characters; required when feeding URL parameters into other macros.	"safe"
  multiple="on" multiple="[[$item]]"	If set, gets all selected elements of a <select multiple="multiple"> tag. A format can be specified, with $item indicating the element, e.g. multiple="Option: $item" (also supports the standard format tokens)	first element
  separator=", "	Separator between multiple selections. Only relevant if multiple is specified	"\n" (new line)

• Example: %URLPARAM{"skin"}% returns print for a .../view/System/Macros?skin=print URL
• Notes:
  • URL parameters passed into HTML form fields must be entity ENCODEd.
  • Double quotes in URL parameters must be escaped when passed into other macros.
    Example: %SEARCH{ "%URLPARAM{ "search" encode="quote" }%" noheader="on" }%
  • When used in a template topic, this macro will be expanded when the template is used to create a new topic. See TemplateTopics#TemplateTopicsVars for details.
  • Watch out for internal parameters, such as rev, skin, template, topic, web; they have a special meaning in Foswiki. Common parameters and view script specific parameters are documented at CommandAndCGIScripts.
  • If you have %URLPARAM{ in the value of a URL parameter, it will be modified to %<nop>URLPARAM{. This is to prevent an infinite loop during expansion.
  • Security warning! Using URLPARAM can easily be misused for cross-site scripting unless specific characters are entity encoded. By default URLPARAM encodes the characters '"<>% into HTML entities (same as encode="safe") which is relatively safe. The safest is to use encode="entity". When passing URLPARAM inside another macro always use double quotes ("") combined with using URLPARAM with encode="quote". For maximum security against cross-site scripting you are adviced to install the Foswiki:Extensions.SafeWikiPlugin.
• Related: ENCODE, SEARCH, FormattedSearch, QUERYSTRING

USERINFO{"name"} -- retrieve details about a user

• Syntax: %USERINFO%
• Expands to: guest, WikiGuest, (comma-separated list of the username, wikiusername, and emails)
• With formatted output, using tokens $emails, $username, $wikiname, $wikiusername, $groups and $admin ($admin returns 'true' or 'false'):
  • Example:

    %USERINFO{ format="$username is really $wikiname" }%

  • Expands to: guest is really WikiGuest
• Retrieve information about another user:
  • Example:

    %USERINFO{ "WikiGuest" format="$username is really $wikiname" }%

  • Expands to: guest is really WikiGuest

    You need to be a member of AdminGroup for the USERINFO macro to provide details about other users

    The parameter should be the wikiname of a user. You can also pass a login name. You can only get information about another user if the {AntiSpam}{HideUserDetails} configuration option is not enabled, or if you are an admin. (User details are hidden in this site)

• Related: USERNAME, WIKINAME, WIKIUSERNAME, GROUPINFO, UserAuthentication, ChangeEmailAddress

USERNAME -- your login username

• Foswiki makes names available in three formats: USERNAME like jsmith, WIKINAME like JohnSmith and WIKIUSERNAME like Main.JohnSmith. Un-authenticated users are all WikiGuest.
• Syntax: %USERNAME%
• Expands to: guest

  When used in a template topic, this macro will be expanded when the template is used to create a new topic. See TemplateTopics#TemplateTopicsVars for details

• Related: REMOTE_USER, USERINFO, WIKINAME, WIKIUSERNAME, UserAuthentication

USERSWEB -- name of users web

• The web containing individual user topics, WikiGroups, and customised site-wide preferences.
• Syntax: %USERSWEB%
• Expands to: Main
• Related: SYSTEMWEB

VAR{"NAME" web="Web"} -- get a preference value from another web

• Syntax: %VAR{"NAME" web="Web"}%
• Example: To get %WEBBGCOLOR% of the Main web write %VAR{"WEBBGCOLOR" web="Main"}%, which expands to #FFEFA6
• Related: WEBPREFSTOPIC

VBAR -- vertical bar

• The vertical bar macro can be used in TML tables.
• Current value: VBAR = |
• Related: BR, BULLET, BB, BB2, BB3, BB4, CARET

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 where the included topic is located.
• Syntax: %WEB%
• Expands to: System
• Related: BASEWEB, INCLUDINGWEB, TOPIC

WEBLIST{"format"} -- index of all webs

• List of all webs. Obfuscated webs are excluded, e.g. webs with a NOSEARCHALL = on preference setting. The "format" defines the format of one web item. The $name gets expanded to the name of the web, $qname gets expanded to double quoted name, $marker to marker where web matches selection. Subwebs are listed recursively.
• Syntax: %WEBLIST{"format" ...}%
• Supported parameters:

  Parameter:	Description:	Default:
  "format"	Format of one line, may include $name (the name of the web), $qname (the name of the web in double quotes), $indentedname (the name of the web with parent web names replaced by indents, for use in indented lists), and $marker (which expands to marker for the item matching selection only)	$name
  format="format"	(Alternative to above)	$name
  separator=", "	Line separator	$n (new line)
  web=""	if you specify $web in format, it will be replaced with this value.	none
  webs="public"	Comma separated list of webs to consider. This list can include two pseudo-webs, public which expands to all non-hidden and webtemplate which expands to the names of all template webs. NOTE: Administrators will see all webs, not just the public ones	public
  subwebs="Sandbox"	Specifies a single web. If specified, then public and webtemplate (described above) will expand relative to show subwebs *below this web only.	""
  selection="%WEB%"	Entry to be selected in list. If one of the webs matches this selection, then $marker in the format will be expanded	selection=%WEB%
  marker="selected"	Text for $marker if the item matches selection	selected="selected"

• Example, creates a bullet list of all webs:

  %WEBLIST{"   * [[$name.%HOMETOPIC%]]"}%

• Example, creates a dropdown of all public webs + Trash web, with the current web highlighted:

  <form><select name="web">%WEBLIST{
        "<option $marker value='$qname'>$name</option>"
        webs="Trash, public"
        selection="%WEB%"
        separator=" "
     }% </select></form>

  WEBLIST will not show a web called 'TWiki' even if it exists in the file system unless the TWikiCompatibilityPlugin is installed and activated in configure. This is done to ensure that the TWiki compatibility components such as the TWiki web are only visible and active when needed

• Related: TOPICLIST, SEARCH

WEBPREFSTOPIC -- name of web preferences topic

• Syntax: %WEBPREFSTOPIC%
• Expands to: WebPreferences, renders as WebPreferences
• Related: HOMETOPIC, WIKIPREFSTOPIC, VAR

WHITE -- start white colored text

• WHITE is one of the shortcut macros predefined in DefaultPreferences. See the section shortcut macros in that topic for a complete list of colors.
  Example:

  %WHITE% white text %ENDCOLOR%

  Expands to: white text

  %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write

  %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%

WIKIHOMEURL -- site home URL

• Syntax %WIKIHOMEURL%
• Expands to /view/
• Normally by default set to %SCRIPTURLPATH{"view"}%

  For the top bar logo URL use %WIKILOGOURL% defined in WebPreferences instead.

• Related: WIKITOOLNAME

WIKINAME -- your Wiki username

• The WikiName is the same as %USERNAME% if not defined in the WikiUsers topic
• Syntax: %WIKINAME%
• Expands to: WikiGuest

  When used in a template topic, this macro will be expanded when the template is used to create new topic. See TemplateTopics#TemplateTopicsVars for details

• Related: REMOTE_USER, USERINFO, USERNAME, WIKIUSERNAME, WIKIUSERSTOPIC

WIKIPREFSTOPIC -- name of site-wide preferences topic

• Syntax: %WIKIPREFSTOPIC%
• Expands to: DefaultPreferences, renders as DefaultPreferences
• Related: HOMETOPIC, WEBPREFSTOPIC

WIKITOOLNAME -- name of your site

• Syntax: %WIKITOOLNAME%
• Expands to: Petr Malát
• Related: WIKIHOMEURL, WIKIVERSION

WIKIUSERNAME -- your Wiki username with web prefix

• Your %WIKINAME% with Main web prefix, useful to point to your Petr Malát home page
• Syntax: %WIKIUSERNAME%
• Expands to: Main.WikiGuest, renders as WikiGuest

  When used in a template topic, this macro will be expanded when the template is used to create a new topic. See TemplateTopics#TemplateTopicsVars for details

• Related: REMOTE_USER, USERINFO, USERNAME, WIKINAME

WIKIUSERSTOPIC -- name of topic listing all registered users

• Syntax: %WIKIUSERSTOPIC%
• Expands to: WikiUsers, with Main prefix renders as WikiUsers
• Related: WIKIUSERNAME

WIKIVERSION -- the version of the installed Foswiki engine

• Syntax: %WIKIVERSION%
• Expands to: v1.1.7
• Related: PLUGINVERSION, WIKITOOLNAME

WIKIWEBMASTER -- feedback email address for site

• Syntax: %WIKIWEBMASTER%
• Expands to: eshopy@malat.biz
• Related: WIKIWEBMASTERNAME

WIKIWEBMASTERNAME -- Name of the administrator for the site

• Syntax: %WIKIWEBMASTERNAME%
• Expands to: Wiki Administrator
• Related: WIKIWEBMASTER

X -- warning icon

• Current value: X =
• Related: H, I, ICON, M, N, P, Q, S, T, U, Y

Y -- "yes" icon

• Current value: Y =
• Related: H, I, ICON, M, N, P, Q, S, T, U, X

YELLOW -- start yellow colored text

• YELLOW is one of the shortcut macros predefined in DefaultPreferences. See the section shortcut macros in that topic for a complete list of colors.
  Example:

  %YELLOW% yellow text %ENDCOLOR%

  Expands to: yellow text

  %<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write

  %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%

Shortcuts

• %BR% - line break
• %BULLET% - bullet sign
• %BB% - line break and bullet combined
• %BB2% - indented line break and bullet
• %RED% text %ENDCOLOR% - colored text (also %YELLOW%, %ORANGE%, %PINK%, %PURPLE%, %TEAL%, %NAVY%, %BLUE%, %AQUA%, %LIME%, %GREEN%, %OLIVE%, %MAROON%, %BROWN%, %BLACK%, %GRAY%, %SILVER%, %WHITE%)
• %H% - Help icon
• %I% - Idea icon
• %M% - Moved to icon
• %N% - New icon
• %P% - Refactor icon
• %Q% - Question icon
• %S% - Red star icon
• %T% - Tip icon
• %U% - Updated icon
• %X% - Alert icon
• %Y% - Done icon