You are here: System » Macros

Macros

Special text strings expand on the fly to display user data or system info

Macros are text strings in one of two forms:

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

These usually expand into content when a topic is rendered for viewing. There are two types of macros:
  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)

On this page:

Using Macros

To use a macro type its name. For example,

Note:
  • 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

The following describes only these types of macros:

Standard form

The key to understanding nested expressions in Foswiki is to understand that macros are expanded "inside-out, left-to-right". Example:

%MACRO1{
   something="%MACRO2{
      somethingelse="%MACRO3%, %MACRO4%"
   }%"
}%
The macros are expanded in this order: MACRO3, MACRO4, MACRO2, MACRO1.

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

Standard form macros can nearly always be used to build the parameter string of another macro; however, sometimes it is desirable to bypass the inside-out expansion order and delay the inner macro until after the outer macro has finished expansion. This is accomplished by using the $percent format token instead of %, and escaping any " character it uses (becomes \")

TIP 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.
Example:
%MACRO1{
   format="$percentMACRO2{
      format=\"%MACRO3%, %MACRO4%\"
   }$percent"
}%
The macros are expanded in this order: MACRO3, MACRO4, MACRO1, MACRO2.
Animated Example
From the conditional output 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="https://www.atomikos.com/pub/System/DocumentGraphics/info.png"/> [[AccessKeys]]
   * <img src="https://www.atomikos.com/pub/System/DocumentGraphics/gear.png"/> [[AdminSkillsAssumptions]]
----
   * Set PARENT = UserDocumentationCategory

See also: FormattedSearch

Macro Names

Macro names must start with a letter. The following characters can be letters, numbers and the underscore '_'. Letters may be upper or lower-case, E.g. %MYVAR%, %MyVar%, %My2ndVar%, and %My_Var% are all separate, valid macro names (macros are case sensitive - %MyVAR% and %MYVAR% are not the same).

By convention all settings, predefined macros and macros registered by plugins are always UPPER-CASE. %META:TOPICPARENT{name="AdminToolsCategory"}% #SettingPrefs

Preference Settings

A preference setting lets you define a simple macro that will be expanded in your output. A preference setting looks like this:

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

Example:

   * Set WEBBGCOLOR = #FFFFC0
Macros defined using preference settings are expanded by enclosing their name in percent signs. So when you write %WEBBGCOLOR%, it gets expanded to #FFD8AA

A preference macro is always taken from the most current topic revision, even when accessing previous revisions of a topic.

Preferences can be defined in a number of places:
  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 WikiGuest)
  5. WebPreferences
  6. Sub-webs inherit the WebPreferences of their parent
  7. In the topic being accessed
In this list, Set statements which occur at numerically higher locations override macros of the same name defined at lower numbered levels, unless the macro was listed in a finalpreferences setting (finalised) at a lower-numbered level. in this case, the macro is locked to the value at that level; set statements at higher-numbered levels are ignored.

prefs-stack.jpg

Writing preference settings

Preference settings are written as a simple bullet. In TML, they are written as 3-spaces,asterisk,equals,value
   * Set MYSETTING = My setting value

When using the Wysiwyg editor, click the "Bullet" button and write the setting as a simple bullet. Don't include the asterisk.

Spaces between the = sign and the value will be ignored. You can split a value over several lines by indenting following lines with spaces - as long as you don't try to use * as the first character on the following line.

Example:
   * Set MACRONAME = value starts here
     and continues here

Whatever you include in your macro will be expanded on display, exactly as if it had been entered directly (though see Parameters, below).

Example: Create a custom logo macro
  • 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

Preference settings are case sensitive. (Foswiki by convention always writes settings in upper case.)

   * Set lower = This is LOWER
   * Set LOWER = This is UPPER
   * Set LoWeR = This is MIXED
Expand %lower%, %LOWER% and %LoWeR%
Expand %lower%, %LOWER% and %LoWeR%.

IDEA! preference settings can easily be disabled with a # sign. Example:
   * #Set DENYWEBCHANGE = %USERSWEB%.UnknownUser

Hiding preference settings

IDEA! You can hide preference settings in the output by enclosing them in HTML comments; for example,
<!--
   * Set HIDDEN = This will be invisible in the output
-->

You can also set preference settings in a topic by clicking the link Edit topic preference settings under More topic actions. Preferences set in this manner are known as 'meta' preferences and are not visible in the topic text, but take effect nevertheless.

ALERT! Caution If your topic will be used in an INCLUDE, it is recommended to not use HTML comments. instead, set preferences into the topic metadata by using the "Edit Settings for this topic" button on the "More topic actions" page. Settings in an included topic are always ignored, but nested comments will break the HTML.

Order of perference settings

If you are setting a preference and using it in the same topic, note that Foswiki reads all the preference settings from the saved version of the topic before it displays anything. This means you can use a setting anywhere in the topic, even if you set it at the very end. But beware: it also means that if you change the setting of a macro you are using in the same topic, Preview will show the wrong thing, and you must Save the topic to see it correctly.

Preference settings and topic revision history

Foswiki always reads the settings from the most current topic revision, so viewing older revisions of a topic can show unexpected results.

And especially important, preference settings are never overridden or set in "%INCLUDE{" topics. in the below example about weather conditions, note the difference in the CONDITIONS expansion

Parameters

Note that %CONDITIONS% expands differently when this example is viewed in PreferenceSettings. This is because Set statement are not active in included topics. The including topic's set statements are used.

Macros defined using preference settings can take parameters. These are symbols passed in the call to the macro to define local macros that will be expanded in the output. For example,
   * Set CONDITIONS = According to [[%BASETOPIC%]] the %WHAT% is %STATE% today (Set in ...).
You can call this macro passing in values for WHAT and STATE. For example:
  • %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.
Example:
   * Set WEATHER = It's %DEFAULT{default="raining"}%.
  • %WEATHER% expands to It's raining.
  • %WEATHER{"sunny"}% expands to It's sunny.
The standard formatting tokens can be used in parameters. They will be expanded immediately when the macro is instantiated.

ALERT! Note that parameters override all other macros, including system defined macros, in the expansion of the macro where they are used.

Access Control Settings

These are special types of preference settings to control access to content. AccessControl explains these security settings in detail. Parameters are not available in access control settings.

Local values for preferences

Certain topics (user, plugin, web, site and default preferences topics) have a problem; macros defined in those topics can have two meanings. For example, consider a user topic. A user may want to use a double-height edit box when they are editing their home topic - but only when editing their home topic. The rest of the time, they want to have a normal edit box. This separation is achieved using Local in place of Set in the macro definition. For example, if the user sets the following in their home topic:
   * Set EDITBOXHEIGHT = 10
   * Local EDITBOXHEIGHT = 20
Then, when they are editing any other topic, they will get a 10 high edit box. However, when they are editing their home topic they will get a 20 high edit box. Local can be used wherever a preference needs to take a different value depending on where the current operation is being performed.

Use this powerful feature with great care! %ALLVARIABLES% can be used to get a listing of the values of all macros in their evaluation order, so you can see macro scope if you get confused.

Deprecation warning. The setting used in this example, EDITBOXHEIGHT, is being deprecated and will be remove from Foswiki 1.2. Note that if the edit box size is changed using the javascript controls in the lower right corner of the edit box window, those settings will be used, and the EDITBOX* settings will be ignored.

Predefined Macros

Most predefined macros return values that were either set in the configuration when Foswiki was installed, or taken from server info (such as current username, or date and time). Some, like %SEARCH%, are powerful and general tools.

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

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

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

Your installation of Foswiki v1.1.9 has the following registered macros:

ACTIVATEDPLUGINS -- list of currently activated plugins

ADDTOHEAD

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

ADDTOZONE

%ADDTOZONE{
  "zone"
  ...
}%

Parameters:
  • "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.
    • HELP 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"?

Zones are specific places in the output HTML that are marked by calls to the RENDERZONE macro. Zones are used to collect various content together, such as Javascript and CSS, that must be included in the output HTML in a specific order, and in a specific place.

There are two special zones called head and script. The head zone is rendered as part of the HTML head section. It is the catch-all container for any content supposed to be placed into the HTML head section, except Javascript, which is collected in the script zone.

All Javascript must always be added to the script zone exclusively, in order to grant ordering constraints among scripts are resolved properly. Never add Javascript to the head zone -- never add non-Javascript content to the script zone.

Both zones are added to the HTML head section automatically just before the closing </head> tag as if they were specified explicitly in the skin templates using:
<head>
...
%RENDERZONE{"head"}%
%RENDERZONE{"script"}%
</head>

You may create as many zones in addition to the standard head and script zones as you like. For any non-standard zone specified in ADDTOZONE you will also need to provide an appropriate RENDERZONE.

Interesting use cases in wiki applications:
  • 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

ADDTOZONE adds content to a zone identified with the id parameter. An id identifier is unique within the zone that they are added to. When the same id is used in multiple calls to ADDTOZONE the last call will win, that is previous content of the same id will be overwritten.

Enforcing a linear order of content within a zone

An ADDTOZONE call may ensure that its content appears after the content of some other ADDTOZONE calls by specifying their ids in the requires parameter. The requires parameter constraints the linear order of content added to a zone. When a zone is rendered, all ordering constraints expressed via requires are satisfied. Those ids not found in a zone don't have any influence on the final ordering. Missing ids aren't considered an error rather than an over-specified ordering problem.

Working with {MergeHeadAndScriptZones} disabled (default)

In this mode, the head and script zones are treated separately.

Even when head and script zones are treated separately, the head zone will always be rendered before the script zone, unless otherwise specified using RENDERZONE explicitly. So any content in the script zone that depends on content placed into the head zone is satisfied intrinsicly as they are both rendered as specified above.

Working with {MergeHeadAndScriptZones} enabled

In this mode, the head and script zones are separate when adding to them, but may be treated as merged when you call RENDERZONE if there are any dependencies specified that only exist in the opposite zone. This allows an ADDTOZONE{"head"...} to to successfully require an id that has been added to script.

ALERT! {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

You must ensure that no head content (and no inline Javascript) depends on script content. Any such dependency will be ignored.

In real world application this isn't a problem as Javascript is never added to the head zone or Javascript zone part of the script zone never really depends on non-Javascript content part of the head zone.

HTML comment decoration which normally appears after each id's content in the rendered HTML will contain a small informative text to aid debugging.

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

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

Example: Adding Javascript to a page

Make sure that all inline Javascript code in the topic (if it is allowed) is added to the page using %ADDTOZONE{"script"...requires="library-id"}% with the appropriate library-id to guarantee a correct load order. For example, jQuery code should be added as follows:

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

where "MyApp::ShakePart" is a unique id to identify the text added to script; and JQUERYPLUGIN::SHAKE signifies that the content added with that identifier should appear beforehand.

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

See also RENDERZONE, Using ADDTOZONE, Updating applications to use script zone

ALLVARIABLES -- list of currently defined macros

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

Deprecated 2009-04-29 in favour of SHOWPREFERENCE

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

    ALERT! %<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: ENDCOLOR, DefaultPreferences, StandardColors

ATTACHURL -- full URL for attachments in the current topic

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

AUTHREALM -- authentication realm

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

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

    ALERT! %<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: ENDCOLOR, DefaultPreferences, StandardColors

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

    ALERT! %<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: ENDCOLOR, DefaultPreferences, StandardColors

BR -- line break

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

    ALERT! %<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: ENDCOLOR, DefaultPreferences, StandardColors

BULLET -- bullet character

BUTTON -- renders a nice button

Parameters

Parameter Description Default
"text" text to be put on this button  
value 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 - 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

Examples

%BUTTON{
    "%MAKETEXT{"Submit"}%"
    onclick="confirm('Are your sure?')"
  }%
  %BUTTON{
    "%MAKETEXT{"Cancel"}%"
    icon="cross"
    target="%WEB%.%TOPIC%"
  }% %CLEAR%
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.

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

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

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

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: 24 Aug 2016 - 23:31
  • Example:
    %DISPLAYTIME{"$hou:$min"}%
    expands to 23:31
  • 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%
    ALERT! 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

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

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

Produces:

Name Type
Foo two
Related: See EditTablePlugin for more details

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 FormatTokens 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 FormatTokens 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.
    ALERT! 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 &#034;. 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" }%
    ALERT! 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

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.

ENDTABPANE -- ending tag for tabpane widget

This closes a previously opened TABPANE.

ENDTWISTY -- complements an opening TWISTY tag to close a twisty

Closes an open twisty

ENDTWISTYTOGGLE -- Twisty closure

Will end the most inner unclosed Twisty Toggle section, using the proper tag

Examples

%ENDTWISTYTOGGLE%

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

Expands macros in expression as if they were used in the topic topictoexpandin. The viewer must have VIEW access to topictoexpandin for this to work. All the standard formatting macros can be used in expression, such as $percent and $quot.

EXPAND can be useful when you want to pick up the value of macros defined in another topic. For example, you might want to define a set of preferences in one topic, but pick up their value in another topic (this is very useful when building reusable applications). In this case you can write:
   * Set MYPREFERENCE = value
in "SettingsTopic" and then, in "MyTopic", write:
%EXPAND{"$percentMYPREFERENCE$percent" scope="SettingsTopic"}%
Of course we can also write:
%EXPAND{"$percentMYPREFERENCE$percent" scope="%OTHERTOPIC%"}%
which lets us select which other topic to get the preference value from.

Additional parameters can be passed to the macro being expanded using the standard macro syntax in the name of the macro; for example,

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

Notes:
  • 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

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

If type="topic" (the default) the format string can contain any of the topic-specific format tokens specified in FormattedSearch ($web, $topic, $parent, $text, $locked, $date, $isodate, $index, $item, $rev, $username, $wikiname, $wikiusername, $createdate, $createusername, $createwikiname, $createwikiusername, $summary, $changes, $formname, $formfield, $pattern, $count, $ntopics, $nhits, $pager). In addition, the macro supports all the standard FormatTokens.

If type="string" then the comma separated list is treated as a list of strings. In this case, the format tokens $index and $item will return the position of the item in the list (1-based), and the item itself, respectively. Note that a comma can be embedded in the data using the standard formatting token $comma.

The FORMAT macro is currently only of use in formatting lists of topics, or of simple strings. It will be extended in future releases to add the capability to render other object types.

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

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 24 Aug 2016 - 21:31
  • 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 2016-08-24T21:31:08Z
    $rcs RCS format timestamp 2016/08/24 21:31:08
    $http E-mail & http format timestamp Wed, 24 Aug 2016 21:31:08 GMT
    $epoch Number of seconds since 00:00 on 1st January, 1970 1472074268
  • Tokens can be shortened to 3 characters
  • Example:
    %GMTIME{"$day $month, $year - $hour:$min:$sec"}%
    expands to
    24 Aug, 2016 - 21:31:08
    ALERT! When used in a template topic, this macro will be expanded when the template is used to create a new topic. See TemplateTopics 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

    ALERT! %<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: ENDCOLOR, DefaultPreferences, StandardColors

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

    ALERT! %<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: ENDCOLOR, DefaultPreferences, StandardColors

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:
    show filter the output list of Groups - can be set to all, allowschange, denychange, allowschange(UserWikiName), denychange(UserWikiName) all
    footer Footer for the list
    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
    header Header for the list
    limited If limit is set, and the list is truncated, this text will be added at the end of 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
    limit If set, limits the number of results to this infinity
    separator separator between items in the list ,
    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

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

GROUPS -- a formatted list of groups

Deprecated - do not use. Use VarGROUPINFO instead

H -- help icon

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

The %HISTORY{}% macro is handled by the HistoryPlugin

Parameters

Parameter Description Default
"format"
format="format"
Format of one line, may include any variable which is supported by macro REVINFO r$rev - $date - $wikiusername
topic Topic name, can be in web.topic format current topic
web Web name current web
versions Number or range (format: from..to). Examples:
To get version 2, write: versions="2"
To get version 2 to 3, write: versions="2..3"
To get version 2 to the latest, write: versions="2.."
To get all versions up to version 5, write: versions="..5"
To get all versions up to but not including the latest, write: versions="..-1"
To get the versions from 1 to 5 in reverse order, write: versions="5..1"
all versions in the order latest to first
header Text to print before the list.
May contain the tokens $next and $previous which will be evaluated if there are newer or older revisions available for the topic that are not listed according to versions (or rev1, rev2, nrev).
These tokens take the syntax $next{'some text' url='url'} (the same for $previous). 'some text' is the text which should be printed, 'url' is the url for the corresponding link.
The tokens $rev1, $rev2, $nrev in 'text' or 'url' will be replaced by appropriate values for the next or previous block of revisions. See the attached oopshistory.tmpl for an example of how to use this.
$next
footer="text" Text to print after the list. May contain the tokens $next and $previous (see header) $previous

Deprecated (but supported) parameters:
Parameter Description Default
nrev Number of revisions to show. Ignored if versions is specified, or if both rev1 and rev2 are specified. 10
rev2 Newest revision to show rev1+nrev if rev1 is specified, latest revision otherwise
rev1 Oldest revision to show rev2-nrev
reverse Show newest revisions first, if on "on"

Additional macros

The following macros are expanded only if there is a corresponding %HISTORY% on the page. If more than one %HISTORY% is used on the same page, the values from the last one will be used.

  • %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

HTTP -- get HTTP headers

HTTP_HOST -- environment variable

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

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 flag-gray
    • %ICON{"pdf"}% displays as pdf
    • %ICON{"docx" default="doc"}% displays as docx
    • %ICON{"smile.pdf"}% displays as smile.pdf
    • %ICON{"/dont/you/dare/smile.pdf"}% returns /dont/you/dare/smile.pdf
    • %ICON{"data.unknown" alt="Unknown file type"}% displays as Unknown file type
    • %ICON{"data.unknown"}% displays as data.unknown
    • %ICON{"http://trunk.foswiki.org/pub/System/DocumentGraphics/xsl.gif"}% displays http://trunk.foswiki.org/pub/System/DocumentGraphics/xsl.gif
  • Graphic samples: arrowbright arrowbright, bubble bubble, choice-yes choice-yes, hand hand
  • File type samples: bmp bmp, doc doc, gif gif, hlp hlp, html html, mp3 mp3, pdf pdf, ppt ppt, txt txt, xls xls, xml xml, zip 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 https://www.atomikos.com/pub/System/DocumentGraphics/arrowbright.png
    • %ICONURL{"novel.pdf"}% returns https://www.atomikos.com/pub/System/DocumentGraphics/pdf.png
    • %ICONURL{"/queen/boheme.mp3"}% returns https://www.atomikos.com/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 /pub/System/DocumentGraphics/locktopic.png
    • %ICONURLPATH{"eggysmell.xml"}% returns /pub/System/DocumentGraphics/xml.png
    • %ICONURLPATH{"/doc/xhtml.xsl"}% returns /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

IMAGEGALLERY{"topic" options...} -- render an image gallery

  • The %IMAGEGALLERY{"topic"}% macro is handled by the ImageGalleryPlugin.
  • Syntax: %IMAGEGALLERY{"topic" options...}%
  • Examples:
    • =%IMAGEGALLERY{"System.DocumentGraphics" columns="3" limit="12" exclude="arrow" sort="name"}%
  • Related: NRIMAGES, ImageGalleryPlugin

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{"name" type="section"} and ENDSECTION{"name" type="section"} 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.
    IDEA! 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 Atomikos 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

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

    ALERT! Foswiki by default is configured to deny URL format includes.
  • Examples: See IncludeTopicsAndWebPages
  • Related: INCLUDE("topic")

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

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)
    ALERT! 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)
    ALERT! 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 -- render an image

Renders an icon image as found on an icon search path. The icon search path is configured Extensions tab, JQueryPlugin sub-tab in {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. When the name of the icon starts with fa- like in fa-bold then icons are taken from the font-awesome iconset. Note that these icons use a different way to be inserted them into the page making resizable for one.

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  
style css style format to be added to the image element
format format string used to render the icon; known variables to be used in the format string are:
  • $iconName: name as given to the name parameter
  • $iconPath: url path
  • $iconClass: css class as specified by the class parameter
  • $iconStyle: css styles as specified by the style 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 for famfamfam icons:
%JQICON{"tick" alt="alternative content" title="this is a tick icon"}%
%JQICON{"cross"}%
%JQICON{"disk"}%
%JQICON{"star"}%
%JQICON{"lightbulb"}%
%JQICON{"camera"}%
%JQICON{"date"}%
     
Produces: alternative content cross disk star lightbulb camera date Example for font-awesome icons:
%JQICON{"fa-pagelines" style="font-size:1em;color:#00BF00"}%
%JQICON{"fa-pagelines" style="font-size:2em;color:#0FAF0F"}%
%JQICON{"fa-pagelines" style="font-size:3em;color:#1F9C1F"}%
%JQICON{"fa-pagelines" style="font-size:4em;color:#2D812D"}%
%JQICON{"fa-pagelines" style="font-size:5em;color:#315C31"}%
     
Produces:

JQICONPATH -- render the urlpath to an image

This is a shortcut for
%JQICON{"name" format="$iconPath"}%

Examples

  • %JQICONPATH{"tick"}% expands to /pub/System/FamFamFamSilkIcons/tick.png

JQPLUGINS -- 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]]

Examples

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

JQREQUIRE -- enable a plugin on the current page

This macro will load a list of plugins to be added to the current page. Use JQPLUGINS to display the list of 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.
HELP in case of an error JQREQUIRE will produce an inline HTML error message.

Parameters

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

Examples

  • %JQREQUIRE{"easing,sliding,falling"}%

JQTHEME -- switch jQuery UI theme

Foswiki's default UI theme is configured in $Foswiki::cfg{JQueryPlugin}{JQueryTheme} and defaults to foswiki. Use configure to change this site wide. Use JQTHEME if you decide to use a different theme on the current page.

Some Foswiki skins may come with their own jQuery UI matching the overall user experience of the web design.
HELP in case of an error JQTHEME will produce an inline HTML error message.

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 /pub/System/JQueryPlugin/$name foswiki
warn (on/off) allows you to switch off warnings when a theme was not found on

LANG -- the language specified by the server locale

This macro is used to generate the lang (and xml:lang) attribute in generated HTML pages. If {UseLocale} is enabled, it is calculated from the configure setting of {Site}{Locale}. Otherwise it defaults to en (English).
  • In templates the lang attribute is defined like this:
    <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="%LANG%" lang="%LANG%">
  • Do not confuse LANG with LANGUAGE
  • Syntax: %LANG%
  • Expands to: en

LANGUAGE -- language code for the current user

  • Returns the language code for the current user. This is the language used by Foswiki to generate the user interface.
  • The language is detected from the user's browser, unless some site/web/user/session-defined preference setting overrides it:
    • If a LANGUAGE preference is explicitly set, this will be used as the user language instead of any language detected from the browser.
    • ALERT! Avoid defining LANGUAGE in a non- per-user way, otherwise users will not be able to choose their preferred language.
  • Do not confuse LANGUAGE with LANG
  • Syntax: %LANGUAGE%
  • Expands to: en
  • 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

    ALERT! %<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: ENDCOLOR, DefaultPreferences, StandardColors

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 DefaultPreferences.
  • Syntax: %LOCALSITEPREFS%
  • Expands to: Main.SitePreferences, renders as SitePreferences

LOGIN -- present a full login link

LOGOUT -- present a full logout link

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

M -- moved to… icon

MAINWEB -- synonym for USERSWEB

ALERT! Deprecated. Please use %USERSWEB% instead.

MAKETEXT -- creates text using Foswiki's I18N infrastructure

Strings captured in the MAKETEXT macro are automatically mapped to the current user's selected language via locale/*.po translation files.
  • 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 webmaster@atomikos.com.
    
      %MAKETEXT{
        "Did you want to [[[_1]][reset [_2]'s password]]?"
        args="%SYSTEMWEB%.ResetPassword,%WIKIUSERNAME%"
      }%
      expands to:
        Did you want to [[System.ResetPassword][reset Users.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

    ALERT! %<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: ENDCOLOR, DefaultPreferences, StandardColors

META -- displays meta-data

Provided mainly for use in templates, this macro generates the parts of the topic view that relate to meta-data (attachments, forms etc.).

Syntax: %META{ "item" ...}%

Parameters:
  • "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.
    • display="on" - only used with "formfield", retrieves the displayed value of a *+values formfield type, as against the default, stored, value.
  • topic="Main.WebPreferences" - optional parameter to select which topic to get the meta-data from.
ALERT! Use of "formfield" is deprecated in favour of the much more powerful QUERY macro.

Related: QUERY

METASEARCH -- special search of meta data

ALERT! 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

MIMEICON{"filename"} -- return a meaningful icon for this filename

  • Syntax: %MIMEICON{"filename"}%
  • Supported parameters:
    Parameter Description Default
    "filename" filenam or file extension to display an icon for required
    size="..." icon size; available sizes are depending on the icon set; common sizes are: 16, 32, 48, 64, 128 48; when the size isn't found in the icon set a best fitting size available will be chosen automatically
    theme="oxygen/crystal" name of the icon set to chose from; for now only these two are supported oxygen or defined in configure
    format="..." format string for the img tag returned by this macro; within the format string the variables %NAME%, %URL% and %SIZE% are replaced with the concrete values for the icon being rendered see mimeicon.theme.tmpl

Examples:

video-x-generic.png video-x-generic.png video-x-generic.png video.png video.png video.png
application-pdf.png application-pdf.png application-pdf.png pdf.png pdf.png pdf.png
text-plain.png text-plain.png text-plain.png txt.png txt.png txt.png
application-zip.png application-zip.png application-zip.png zip.png zip.png zip.png
audio-x-generic.png audio-x-generic.png audio-x-generic.png sound.png sound.png sound.png

N -- "new" icon

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

    ALERT! %<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: ENDCOLOR, DefaultPreferences, StandardColors

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).
      ALERT! 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

NRIMAGES{"topic"} -- returns the number of images attachted to a (list of) topics

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

    ALERT! %<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: ENDCOLOR, DefaultPreferences, StandardColors

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

    ALERT! %<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: ENDCOLOR, DefaultPreferences, StandardColors

P -- pencil icon

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

    ALERT! %<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: ENDCOLOR, DefaultPreferences, StandardColors

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
    • AccountPlugin (0.01, 0.01): Manage user accounts from within Foswiki
    • AutoTemplatePlugin (31 Aug 2015, 4.01): Automatically sets VIEW_TEMPLATE and EDIT_TEMPLATE
    • BlogPlugin (3.10, 3.10): A blogging system for Foswiki
    • BreadCrumbsPlugin (2.51, 2.51): A flexible way to display breadcrumbs navigation
    • CaptchaPlugin (2.11, 2.11): A visual challenge-response test to prevent automated scripts from using the wiki
    • ClassificationPlugin (17 Jul 2015, 5.00): A topic classification plugin and application
    • CommentPlugin (1.1.6, v1.1.6): Quickly post comments to a page without an edit/save cycle
    • CompareRevisionsAddonPlugin (1.114, 1.114):
    • DBCachePlugin (09 Mar 2016, 9.20): Lightweighted frontend to the DBCacheContrib
    • DisqusPlugin (31 Aug 2015, 2.01): Disqus-based commenting system
    • EditChapterPlugin (4.71, 4.71): An easy sectional edit facility
    • EditTablePlugin (4.43, 4.43): Edit tables using edit fields, date pickers and drop down boxes
    • ExplicitNumberingPlugin (1.62, 1.62): Use the ##., ##.. etc. notation to insert outline numbering sequences (1, 1.1, 2, 2.1) in topic's text. Also support numbered headings.
    • FilterPlugin (31 Aug 2015, 4.11): Substitute and extract information from content by using regular expressions
    • FlexFormPlugin (24 Mar 2015, 5.10): Flexible way to render DataForms
    • FlexWebListPlugin (1.93, 1.93): Flexible way to display hierarchical weblists
    • GenPDFPrincePlugin (31 Aug 2015, 2.00): Generate PDF using Prince XML
    • GraphvizPlugin (31 Aug 2015, 1.00): Draw graphs using the GraphViz utility
    • GridLayoutPlugin (2 Sep 2015, 3.02): A 12er grid system for responsive layouts
    • HistoryPlugin (1.12, 1.12): Shows a complete history of a topic
    • ImageGalleryPlugin (31 Aug 2015, 7.01): Displays image gallery with auto-generated thumbnails from attachments
    • ImagePlugin (7.00, 7.00): Image and thumbnail services to display and alignment images using an easy syntax
    • InterwikiPlugin (1.1.7, v1.1.7): Link ExternalSite:Page text to external sites based on aliases defined in a rules topic
    • JQDataTablesPlugin (2.99, 2.99): JQuery based progressive enhancement of tables
    • JQGridPlugin (2.41, 2.41): jQuery grid widget for Foswiki
    • JQueryPlugin (16 Jun 2015, 6.13): jQuery JavaScript library for Foswiki
    • ListyPlugin (31 Aug 2015, 1.00_004): Fancy list manager
    • MailerContribPlugin (2.5.3, v2.5.3): Supports e-mail notification of changes
    • MetaCommentPlugin (31 Aug 2015, 3.00): An easy to use comment system
    • MetaDataPlugin (4.10, 4.10): Bring custom meta data to wiki apps
    • MimeIconPlugin (17 Jul 2015, 1.30): Icon sets for mimetypes
    • MoreFormfieldsPlugin (09 Apr 2015, 1.00): Additional formfield types for DataForms
    • MultiLingualPlugin (2.10, 2.10): Support for a multi lingual Foswiki
    • NatEditPlugin (13 Aug 2015, 9.05): A Wikiwyg Editor
    • NatSkinPlugin (17 Jul 2015, 4.10): Support plugin for NatSkin
    • PageOptimizerPlugin (23 Feb 2015, 1.00): Optimize html markup, as well as js and css
    • PasswordPlugin (0.01, 0.01): Secure password formfield
    • RedDotPlugin (5 Mar 2015, 4.00): Quick-edit links
    • RenderListPlugin (2.2.7, v2.2.7): Render bullet lists in a variety of formats
    • RenderPlugin (31 Aug 2015, 4.00): Render WikiApplications asynchronously
    • SecureDownloadPlugin (08 Jun 2016, 1.00): Secure, temporary download links
    • SendEmailPlugin (1.5.4, 1.5.4): Send e-mails through an e-mail form
    • SetVariablePlugin (2.33, 2.33): Flexible handling of topic variables
    • SlideShowPlugin (2.21, 2.21): Create web based presentations based on topics with headings
    • SmiliesPlugin (25 Jun 2015, 2.02): Render smilies like smile as icons
    • SocialSharePlugin (0.01, 0.01): Social Share Buttons
    • SolrPlugin (17 Jul 2015, 4.00): Enterprise Search Engine for Foswiki based on Solr
    • TablePlugin (1.142, 1.142): Control attributes of tables and sorting of table columns
    • TagCloudPlugin (3.01, 3.01): Renders a tag cloud given a list of terms
    • TimeSincePlugin (4.00, 4.00):
    • TinyMCEPlugin (1.2.9, v1.2.9): Integration of the Tiny MCE WYSIWYG Editor
    • TopicInteractionPlugin (17 Jul 2015, 4.00): Improved interaction with attachments and DataForms
    • TrashPlugin (1.10, 1.10): Maintain the Trash web
    • TreePlugin (1.93, 1.93): Renders topics' parent-child relationships as hierarchical tree view. Useful for dynamic site maps and threads.
    • TwistyPlugin (1.62, 1.62): Twisty section Javascript library to open/close content dynamically
    • TwitterPlugin (2.00, 2.00): Access Twitter via Foswiki
    • WebLinkPlugin (1.31, 1.31): A parametrized %WEB macro
    • WorkflowPlugin (11 March 2015, 1.14): Associate a "state" with a topic and then control the work flow that the topic progresses through as content is added.
    • WysiwygPlugin (16 May 2013, v1.1.16): Translator framework for WYSIWYG editors
  • Related: ACTIVATEDPLUGINS, FAILEDPLUGINS, PLUGINVERSION

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

POPUPWINDOW -- 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"

Examples

  • 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

PUBURLPATH -- the base URL path of attachments

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

    ALERT! %<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: ENDCOLOR, DefaultPreferences, StandardColors

Q -- question icon

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}"}%
Plain strings (such as field values) are returned without quotes. Simple arrays of scalars are also returned without quotes, in a comma-separated list (beware of values that contain commas!).

More complex data structures (e.g. arrays of hashes) will be returned as Perl code strings generated by running through CPAN:Data::Dumper.

You can make the macro generate different output formats using the style parameter:
  • style="perl" - generates values as Perl code strings
  • style="json" - generates values as JSON strings, suitable for reading by browsers.

Only some configuration settings are available via QUERY: {ScriptSuffix}, {LoginManager}, {AuthScripts}, {LoginNameFilterIn}, {AdminUserLogin}, {AdminUserWikiName}, {SuperAdminGroup}, {UsersTopicName}, {AuthRealm}, {MinPasswordLength}, {Register}{AllowLoginName}, {Register}{EnableNewUserRegistration}, {Register}{NeedVerification}, {Register}{RegistrationAgentWikiName}, {AllowInlineScript}, {DenyDotDotInclude}, {UploadFilter}, {NameFilter}, {AccessibleCFG}, {AntiSpam}{EmailPadding}, {AntiSpam}{EntityEncode}, {AntiSpam}{HideUserDetails}, {AntiSpam}{RobotsAreWelcome}, {Stats}{TopViews}, {Stats}{TopContrib}, {Stats}{TopicName}, {UserInterfaceInternationalisation}, {UseLocale}, {Site}{Locale}, {Site}{CharSet}, {DisplayTimeValues}, {DefaultDateFormat}, {Site}{LocaleRegexes}, {UpperNational}, {LowerNational}, {PluralToSingular}, {EnableHierarchicalWebs}, {WebMasterEmail}, {WebMasterName}, {NotifyTopicName}, {SystemWebName}, {TrashWebName}, {SitePrefsTopicName}, {LocalSitePreferences}, {HomeTopicName}, {WebPrefsTopicName}, {UsersWebName}, {TemplatePath}, {LinkProtocolPattern}, {NumberOfRevisions}, {MaxRevisionsInADiff}, {ReplaceIfEditedAgainWithin}, {LeaseLength}, {LeaseLengthLessForceful}, {Plugins}{WebSearchPath}, {PluginsOrder}, {Cache}{Enabled}, {Validation}{Method}, {Register}{DisablePasswordConfirmation}, {SolrPlugin}{PersonDataForm}

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
    TIP 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.
    TIP 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" />"
       }%
ALERT! 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.

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.
    ALERT! 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: sortcol=1;table=10;up=0
  • 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

    ALERT! %<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: ENDCOLOR, DefaultPreferences, StandardColors

REMOTE_ADDR -- environment variable

REMOTE_PORT -- environment variable

REMOTE_USER -- environment variable

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

RENDERZONE

%RENDERZONE{"zone" ...}%
See ADDTOZONE for an explanation of zones.

Parameters:
  • "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
Supports the standard format tokens in all parameters.

Notes:
  • 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.
    ALERT! {MergeHeadAndScriptZones} will be removed from a future version of Foswiki.

See also ADDTOZONE for more information on zones.

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

  • Syntax:
  • 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"}%
  • Related: REVARG,REVTITLE

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

  • Syntax: %REVINFO{"format"}%
  • %REVINFO% is equivalent to %REVINFO{format="r$rev - $date - $wikiusername"}%
  • 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 Users web prefix Users.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:
  • 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

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 Atomikos 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 https://www.atomikos.com/bin
  • Expands to: https://www.atomikos.com/bin/script
  • Example: To get the authenticated version of the current topic you can write %SCRIPTURL{"viewauth"}%/%WEB%/%TOPIC% which expands to https://www.atomikos.com/bin/viewauth/System/Macros
    ALERT! In most cases you should use %SCRIPTURLPATH{"script"}% instead, as it works with URL rewriting much better

    ALERT! 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: /bin/script
    ALERT! 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="Users, 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: QuerySearch 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)

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


Related topics: FormattedSearch, QuerySearch, SearchHelp, SearchPatternCookbook, RegularExpression, TOPICLIST, WEBLIST

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 23:31
    ALERT! Note: When used in a template topic, this macro will be expanded when the template is used to create a new topic. See TemplateTopics for details.
  • Related: GMTIME, SERVERTIME

SESSIONID -- unique ID for this session

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

SESSION_VARIABLE -- get, set or clear a session variable

SHOWPREFERENCE -- show where preferences are defined.

Preference values are shown in a bulleted list.
  • %SHOWPREFERENCE%
    • Show all preferences
  • %SHOWPREFERENCE{"PREFERENCENAME"}%
    • Show a single preference
    • Example:
      %SHOWPREFERENCE{"ATTACHFILESIZELIMIT"}%
    • Expands as:
         * Set ATTACHFILESIZELIMIT = ""
            * ATTACHFILESIZELIMIT was *finalised* in Main.SitePreferences
      
  • %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

    ALERT! %<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: ENDCOLOR, DefaultPreferences, StandardColors

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: wwb, atomikos2.nat, natedit, nat
  • See Skins for more information
  • Related: SkinBrowser

SLIDESHOWEND -- end slideshow

The %SLIDESHOWEND% macro is handled by the SlideShowPlugin

Examples

See SLIDESHOWSTART

SLIDESHOWSTART -- convert a topic with headings into a slideshow

Handled by the SlideShowPlugin

Parameters

Parameter Description
template optional name of slide template to use

Examples

 %SLIDESHOWSTART%
 ---++ Sample Slide 1
    * Bullet 1
    * Bullet 2
 ---++ Sample Slide 2
    * Bullet 1
    * Bullet 2
 %SLIDESHOWEND%
  • Expands as:

Start presentation

Slide 1: Sample Slide 1

  • Bullet 1
  • Bullet 2

Slide 2: Sample Slide 2

  • Bullet 1
  • Bullet 2

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
    ALERT! 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 ' '
    TIP 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%
    TIP 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{"name" type="section"}% …. %ENDSECTION{"name" type="section"}% (type="section" is the default)
  • 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"
    ALERT! 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..

    ALERT! 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

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

T -- tip icon

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

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

Argument Comment Default value Example
tableborder Table border width (pixels). "1" tableborder="2"
tablebordercolor Table border color . Is only visible when cellspacing is larger than 1, or cellborder is 0, or tablerules is none, otherwise the cell borders overlap the table border. unspecified tablebordercolor="#333"
tableframe Table frame, set to "void" (no sides), "above" (the top side only), "below" (the bottom side only), "hsides" (the top and bottom sides only), "lhs" (the left-hand side only), "rhs" (the right-hand side only), "vsides" (the right and left sides only), "box" (all four sides), "border" (all four sides). unspecified tableframe="hsides"
tablerules Table rules, set to "none" (no rules), "groups" (rules will appear between row groups and column groups only), "rows" (rules will appear between rows only), "cols" (rules will appear between columns only), "all" (rules will appear between all rows and columns). See also: headerrules and datarules. unspecified tablerules="rows"
tablewidth Table width: percentage of window width, or absolute pixel value. unspecified tablewidth="100%"
headerrows Number of header rows to exclude from sort. (will be rendered in a HTML thead section) "1" headerrows="1"
footerrows Number of footer rows to exclude from sort. (will be rendered in a HTML tfoot section) "0" footerrows="1"
id Unique table identifier string, used for targeting a table with CSS. tableN (where N is the table order number on the page) id="userTable"
summary Table summary used by screen readers: A summary of what the table presents. It should provide an orientation for someone who listens to the table. unspecified summary="List of subscribed users"
caption Table caption: A title that will be displayed just above the table. unspecified caption="Users"
inlinemarkup Set to "on" to generate inline markup HTML (in addition to the CSS markup); useful if you need to copy the table, for instance to paste the table into an email). unspecified inlinemarkup="on"

Attributes for table sorting

Argument Comment Default value Example
sort Set the table sorting user interface (clickable column headers) "on" or "off". unspecified sort="on"
initsort Column to sort initially (use "1" for the first column). If specified, sorting is enabled; by setting sort="off" the sorting interface can be hidden. unspecified initsort="2"
initdirection Initial sorting direction for initsort, set to "up" (descending, or decreasing in value) or "down" (ascending, or increasing in value). down initdirection="up"
disableallsort Disable all sorting, both initsort and header sort. This is mainly used by plugins such as the EditTablePlugin to disable sorting in a table while editing the table. unspecified disableallsort="on"

Attributes for table cells

Argument Comment Default value Example
cellpadding Cell padding (pixels). unspecified cellpadding="0"
cellspacing Cell spacing (pixels). unspecified cellspacing="3"
cellborder Cell border width (pixels). unspecified cellborder="0"
valign Vertical alignment of cells and headers, set to "top", "middle", "bottom" or "baseline". unspecified valign="top"
columnwidths Column widths: Comma delimited list of column widths, percentage or absolute pixel value. unspecified columnwidths="80%,20%"

Attributes for data cells

Argument Comment Default value Example
datarules Set to "none" (no rules), "rows" (rules will appear between rows only), "cols" (rules will appear between columns only), "all" (rules will appear between all rows and columns). Overrides tablerules for data cells. unspecified datarules="none"
datavalign Vertical alignment of data cells; overrides valign. unspecified datavalign="top"
dataalign Data cell alignment, one value for all columns, or a comma separated list for different alignment of individual columns. Set to "left", "center", "right" or "justify". Overrides individual cell settings. unspecified dataalign="center"
databg Data cell background colour, a comma separated list. Specify "none" for no colour, that is to use the colour/background of the page the table is on. "#edf4f9,#fff" databg="#f2f2f2,#fff"
databgsorted Data cell background colour of a sorted column; see databg. the values of databg databgsorted="#d4e8e4, #e5f5ea"
datacolor Data cell text colour, a comma separated list. unspecified datacolor="#00c, #000"

Attributes for headers

Argument Comment Default value Example
headerrules Set to "none" (no rules), "rows" (rules will appear between rows only), "cols" (rules will appear between columns only), "all" (rules will appear between all rows and columns). Overrides tablerules for header cells. unspecified headerrules="none"
headerbg Header cell background colour. Specify "none" for no colour, that is to use the colour/background of the page the table is on. "#6b7f93" headerbg="#999"
headerbgsorted Header cell background colour of a sorted column. Specify "none" for no colour, that is to use the colour/background of the page the table is on. the value of headerbg headerbgsorted="#32596c"
headercolor Header cell text colour. "#fff" headercolor="#00c"
headervalign Vertical alignment of header cells; overrides valign. unspecified headervalign="top"
headeralign Header cell alignment, one value for all columns, or a comma separated list for different alignment of individual columns. Set to "left", "center", "right" or "justify". Overrides individual cell settings. unspecified headeralign="left,right"
headerrows See: Attributes for tables

Other attributes

Argument Comment Default value Example
include Other topic defining the TABLE parameters. The first %TABLE% 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. unspecified include="Main.WebHome"

  • 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%

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 enables/disables animation of switching tabs off

Examples

see JQueryTabpane for more examples

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

    ALERT! %<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: ENDCOLOR, DefaultPreferences, StandardColors

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

    TIP 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

%TREEVIEW{}% displays topic children in a hierarchical tree
%TREE{}% synonym of %TREEVIEW{}%

Parameters

  • The following standard attributes are recognized
Parameter Description Default
web The web to search. current web
topic Specify tree's root topic. If none the entire web topics' tree is generated none
formatting Specify the formatting method
ullist is a <ul>-list, see sample UL lists
ollist is a <ol>-list, see sample OL lists
outline is an outline list, see sample Outlines
hlist is a <h n >-list of section heads, see sample Headlines
coloroutline:colorlist is an outline formatting with level values turned into colors, see sample Nested tables. Example: formatting="coloroutline:#ffeeff,#eeffee,#ffffee,#eeeeff,#ffeeee,#eeffff"
imageoutline:mode is a way to incorporate images into the outline format, specifically to display thread-like and folder views, see sample Image Trees. The general format is: imageoutline: mode : images : imageformat. Example: formatting="imageoutline:thread" or formatting="imageoutline:thread:I.gif,white.gif,T.gif,L.gif:<img src=\"$image\" border=\"0\">".
outline
excludetopic Same meaning as VarSEARCH excludetopic. Topics with excluded parent or processed like topic without parent. none
includetopic Same meaning as VarSEARCH topic. Can improve processing time. none
startlevel The depth of the tree to start showing nodes from. To hide the root node, supply startlevel="1" (root is level 0). The displayed node depths are relative to the root topic. 0 or 1 if topic is not specified
stoplevel The depth of the tree to show, relative to start level. 999
header Output the value within a <div> of class treePluginHeader. Suppressed if the tree is empty. none
footer Output the value within a <div> of class treePluginFooter. Suppressed if the tree is empty. none
zero Output the value within a <div> of class treePluginZero if the tree is empty. none
bookview List topics in BookView form. Not supported from v0.9. Instead use something like:
%TREE{topic="GrandParent" formatting="outline" format="$outnum $topic <br /> $summary <hr />"}%
none
format Specify the format for each node ( outline & coloroutline). The following pseudo-variable are supported on top of the ones described in FormattedSearch:
$spacetopic - the topic with spaces
$level - the tree depth of the topic (in whatever format)
$count - the topic's child position
$index - the index of the topic in the tree. Starts from one. Most useful when used in combination with TreeBrowserPlugin
$outnum - outline number for the topic (eg, 1.3.4.2)
$url - the current topic's URL Not supported. Use %SCRIPTURL{view}%/$web/$topic instead.
$author - the topic's last author Not supported from v0.9. Use %AUTHOR% instead.
$modTime - the topic's modification time. Not supported from v0.9. Use $date instead.
none
formatbranch - specify the format for a group of children ( outline & coloroutline)
$parent - the text of a node
$children - the text of all the node's children (if any)
none
levelprefix Specify a prefix to a node format. The prefix is inserted $level times at the beginning of the rendered node format. It allows generation of trees using Foswiki bullet list syntax thus enabling usage of TreePlugin in combination with TreeBrowserPlugin. none
nodiv Suppress the <div> around the tree. Set to 2 to suppress div around header, footer and zero. Allows for trees concatenation. none
separator Character string used to separate items in the tree \n
nocache Set to 1 to disable caching mechanism for that specific tree. Really a developer setting. 0

Examples

See the following page for sample usage and output:

TWIKIWEB -- synonym for SYSTEMWEB

ALERT! Deprecated. Use %SYSTEMWEB% instead

TWISTY -- generate content block with interactive visibility controls

This renders the button as well as the toggled content section contained within this and the closing ENDTWISTY tag.

Parameters

Parameter Description Default
id Used to link TWISTYBUTTON and TWISTYTOGGLE  
link Link label for both show and hide links  
hidelink Hide link label  
showlink Show link label  
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. <div>
showimgleft Specify the url of an image that will be displayed with the show link 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.
 
hideimgleft Specify the url of an image that will be displayed with the hide link 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.
 
showimgright Specify the url of an image that will be displayed with the show link 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.
 
hideimgright Specify the url of an image that will be displayed with the hide link 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.
 
remember If "on", the Twisty state is remembered the next time the page is shown. If "off", the stored setting will be cleared.

ALERT! 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.
 
start "hide" or "show" Initial state of the Twisty; this will override any setting stored in a cookie (see remember).  
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).  
noscript Make content hidden in case use does not have JavaScript on. Default content is shown in case JavaScript if off  
class CSS class name for Twisty div or span  
linkclass CSS class name for link  
prefix Text to display before the show/hide links  
suffix Text to display after the show/hide links  
Additional parameters img, imgleft, imgright, hideimg, showimg are deprecated, use showimgleft, hideimgleft, showimgright or hideimgright.

TWISTYBUTTON -- Shorthand version for TWISTYSHOW & TWISTYHIDE

This is useful if both the show and the hide button take the same arguments.

Parameters

All parameters supported by TWISTY, except for
  • noscript and class (only used for 'toggle' content)
  • mode button mode defaults to div

Examples

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

Related

TWISTYHIDE - Hide/close link

Parameters

Parameter Description Default
id Used to link TWISTYSHOW, TWISTYHIDE and TWISTYTOGGLE required
link Hide link label  
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. <div>
img 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.
 
remember 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.
 
start "hide" or "show" Initial state of the Twisty; this will override any setting stored in a cookie (see remember).  
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).  

Examples

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

TWISTYSHOW - Show/open link

Parameters

Parameter Description Default
id Used to link TWISTYSHOW, TWISTYHIDE and TWISTYTOGGLE required
link Show link label  
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. <div>
img 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.
 
imgleft 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.
 
imgright 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.
 
remember 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.
 
start "hide" or "show" Initial state of the Twisty; this will override any setting stored in a cookie (see remember).  
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).  

Examples

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

TWISTYTOGGLE -- Twisty Toggle contents section

Parameters

Parameter Description Default
id 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. <div>
class CSS class name for content div or span  
linkclass CSS class name for link  
remember 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.
 
start "hide" or "show" Initial state of the Twisty; this will override any setting stored in a cookie (see remember).  
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).  
noscript hide to make content hidden in case use does not have JavaScript on  

Examples

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

U -- "updated" icon

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, used if the parameter is not present 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 FormatTokens) 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 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
      TIP You need to be a member of AdminGroup for the USERINFO macro to provide details about other users
      HELP 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 Users.JohnSmith. Un-authenticated users are all WikiGuest.
  • Syntax: %USERNAME%
  • Expands to: guest
    ALERT! When used in a template topic, this macro will be expanded when the template is used to create a new topic. See TemplateTopics for details
  • Related: REMOTE_USER, USERINFO, WIKINAME, WIKIUSERNAME, UserAuthentication

USERSWEB -- name of users web

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

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

  • Syntax: %VAR{"NAME" web="Web"}%
  • Example: To get %WEBBGCOLOR% of the Users web write %VAR{"WEBBGCOLOR" web="Users"}%, which expands to ==
  • 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

WEBLINK

  • create a link to a web
  • Syntax: %WEBLINK{web="..." name="..."}%
  • Supported parameters:
    Parameter: Description: Default:
    "web" name of the web to link to BASEWEB
    name="..." name to display instead of the web name BASEWEB (its tail in case it is a subweb)
    format="..." format string for the web link <a class="webLink $marker" href="$url" title="%ENCODE{"$tooltip" type="html"}%">$title</a>
    marker="..." string to be inserted into the format string if the web link points to the current web current
    class="..." css class used within the web link webLink

The following variables can be used in the format string:
  • $web: full qualified name of the web to link to
  • $topic: name of the topic to link to, defaults to WebHome
  • $title: title of the WebHome topic; this is either the topic name or its title
  • $name: name of the web, that is the tail of the web specification with all parent webs stripped off
  • $url: url for the link
  • $marker: the marker set to the "marker" string if the link points to the current web
  • $tooltip: tooltip for the link, mostly used in a title argument of an anchor
  • $summary: web summary as defined in the WEBSUMMARY preference variable

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>
    ALERT! 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

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

    ALERT! %<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: ENDCOLOR, DefaultPreferences, StandardColors

WIKIHOMEURL -- site home URL

  • Syntax %WIKIHOMEURL%
  • Expands to /
  • Normally by default set to %SCRIPTURLPATH{"view"}%
    ALERT! For the top bar logo URL use %WIKILOGOURL% defined in WebPreferences instead.
  • Related: WIKITOOLNAME

WIKINAME -- your Wiki username

WIKIPREFSTOPIC -- name of site-wide preferences topic

WIKITOOLNAME -- name of your site

WIKIUSERNAME -- your Wiki username with web prefix

  • Your %WIKINAME% with Users web prefix, useful to point to your Atomikos home page
  • Syntax: %WIKIUSERNAME%
  • Expands to: Users.WikiGuest, renders as WikiGuest
    ALERT! When used in a template topic, this macro will be expanded when the template is used to create a new topic. See TemplateTopics for details
  • Related: REMOTE_USER, USERINFO, USERNAME, WIKINAME

WIKIUSERSTOPIC -- name of topic listing all registered users

  • Syntax: %WIKIUSERSTOPIC%
  • Expands to: WebHome, with Users prefix renders as Users
  • Related: WIKIUSERNAME

WIKIVERSION -- the version of the installed Foswiki engine

WIKIWEBMASTER -- feedback email address for site

  • Syntax: %WIKIWEBMASTER%
  • Expands to: webmaster@atomikos.com
  • Related: WIKIWEBMASTERNAME

WIKIWEBMASTERNAME -- Name of the administrator for the site

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

WORKFLOW* -- macros associated with WorkflowPlugin

Controlling topics in the workflow
%WORKATTACHTOPIC% Expands to a link that lets you attach to the topic (if the user is not able to modify the topic, either in the workflow sense or according to the standard access controls, the link will be struck out).
%WORKFLOWEDITTOPIC% Expands to a link that lets you edit the topic (if the user is not able to modify the topic, either in the workflow sense or according to the standard access controls, the link will be struck out).
%WORKFLOWFORK{...}% Expands to a button that will create a copy of the current topic (see below for more details)
%WORKFLOWTRANSITION% Expands to either (a) a pull-down menu if the user can perform more than one transition, (b) a button if the current user can only perform one transition, or © empty space if the current user is not allowed to perform any action. You can change the format of the button using a CSS class (see WORKFLOWTRANSITIONCSSCLASS below)
Querying the workflow
%WORKFLOWHISTORY% Expands to the history of state transitions the topic has undergone. The format of the history is dictated by the WORKFLOWHISTORYFORMAT (described below).
%WORKFLOWLASTREV{"State"}% Expands to the version number when the document was last in the state State.
%WORKFLOWLASTTIME{"State"}% Expands to the timestamp when the document was last in the State state. For example, %WORKFLOWLASTTIME{"APPROVED"}% would be replaced by the timestamp when the document was last in the APPROVED state.
%WORKFLOWLASTUSER{"State"}% Expands to the last user who transitioned the document into the state State.
%WORKFLOWLASTVERSION{"State"}% Expands to a link to the version of the document when it was last in the state State.
%WORKFLOWSTATE% Expands to the current state of the document. It can also be given a topic parameter (default), in which case the state of that topic is returned.
%WORKFLOWSTATEMESSAGE% Expands to the corresponding message in the state table.

(All the macros accept an optional default parameter, which is the name of a topic, a web and a rev parameter. If these are omitted, they will default to the current topic, latest revision)

Furthermore, the plugin replaces any macro starting with WORKFLOW that is defined in the workflow description file.

If the topic is not controlled, then any references to WORKFLOW macros are simply removed (you can use this behaviour to place these tags in the header or footer in your skin templates. They appear only if the currently displayed document is controlled. Otherwise, they are just removed and do not disturb the layout).

In addition there are two macros you can define in your topics (or WebPreferences)

WORKFLOWHISTORYFORMAT tells the plugin how to format each new line added to the WORKFLOWHISTORY. The format is used as a template for each new entry, and should include all the formatting necessary to make the history look nice when it is viewed.

In this example the history is formatted as a table:
  • Set WORKFLOWHISTORYFORMAT = $n| $state | $wikiusername | $date |
The leading $n expands to a newline character that separates each line of the history. You could also format the history as a bullet list:
  • Set WORKFLOWHISTORYFORMAT = $n * $state -- $wikiusername, $date
The standard FormatTokens are supported, as well as the following special tokens:
Token Expands to
$wikiusername Who triggered the transition
$state The target state of the transition
$date Date of the transition
$rev Version at the transition

The appearance of the button to change state can be configured by providing a CSS class. For example,
  • Set WORKFLOWTRANSITIONCSSCLASS = myCSSClass
The default is foswikiChangeFormButton foswikiSubmit.

The WORKFLOWFORK macro is used to generate a button that will create a copy of a workflow topic. It accepts the following parameters:
Parameter Meaning Default
"TopicName" (Optional) name of the topic to fork current topic
web (Optional) name of the web containing the topic to fork current web
newnames="NameOne,NameTwo" Comma-separated list of name(s) of the new topic(s) to create, You can use a web specifier on the topic names. required, no default.
label="Fork" Label to use in the button "Fork"
lockdown="on" Set this if you want the forked topic to be set as uneditable after the fork off
This macro is used when you have a topic that has to be split to follow different routes through a workflow - for example, when a requirement is refined to create two new requirements that must follow their own lifecycles; or perhaps a problem report is found to affect two different components of a system, and the resolutions have to be separately tracked. Both the copied topic and the new topic will have workflow history entries added.

For example, %WORKFLOWFORK{"OriginalTopic" label="Divide and conquer" newnames="ForkPathOne,ForkPathTwo" lockdown="on"}% will create two copies of OriginalTopic, named ForkPathOne and ForkPathTwo and set the OriginalTopic as uneditable (using ALLOWTOPICCHANGE).

The histories in both the fork copies and the original topic record what happened.

The user has to be able to modify the topic (both in the workflow sense and according to the standard access controls) in order to fork.

ALERT! due to a bug in versions of the plugin prior to Oct 2009, the default "TopicName" parameter was interpreted as the name of the new topic to fork to. This has been corrected, but the macro will revert to the old meaning if you omit the newnames parameter.

X -- warning icon

Y -- "yes" icon

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

    ALERT! %<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: ENDCOLOR, DefaultPreferences, StandardColors

Shortcuts

The following macros are preference settings and are frequently used in topic content.
  • %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 Help icon
  • %I% - IDEA! Idea icon
  • %M% - MOVED TO... Moved to icon
  • %N% - NEW New icon
  • %P% - REFACTOR Refactor icon
  • %Q% - QUESTION? Question icon
  • %S% - PICK Red star icon
  • %T% - TIP Tip icon
  • %U% - UPDATED Updated icon
  • %X% - ALERT! Alert icon
  • %Y% - DONE Done icon

See ShortcutMacros for a full list of predefined shortcuts.


Related Topics: UserDocumentationCategory

Contact Us

Atomikos Corporate Headquarters
Hoveniersstraat, 39/1, 2800
Mechelen, Belgium

E info@atomikos.com
E sales@atomikos.com
T +3215613055

Subscribe to our newsletter

Never miss an update

Copyright 2016 Atomikos BVBA