Macros Quick Reference
See
Macros
for a detailed description of how to use Macros
Predefined Macros
ACTIVATEDPLUGINS -- list of currently activated plugins
ADDTOHEAD
ADDTOZONE
ALLVARIABLES -- list of currently defined macros
[[VarAQUA][]]
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
BASEWEB -- base web where an INCLUDE started
BB -- bullet with line break
BB2 -- level 2 bullet with line break
BB3 -- level 3 bullet with line break
BB4 -- level 4 bullet with line break
[[VarBLACK][]]
[[VarBLUE][]]
BR -- line break
[[VarBROWN][]]
BULLET -- bullet character
BUTTON -- renders a nice button
CALC{"formula"} -- add spreadsheet calculations to tables and outside tables
CALCULATE -- add spreadsheet formulae calls using standard Macro evaluation order.
CARET -- caret symbol
COMMENT -- insert an edit box into the topic to easily add comments.
COVER -- current skin cover
DATE -- signature format date
DISPLAYTIME{"format"} -- formatted display time
EDITACTION -- Selects an edit template
EDITTABLE{
attributes
} -- edit tables using edit fields and other input fields
ENCODE{"string"} -- encodes a string
ENDCOLOR -- end colored text
ENDINCLUDE -- end position of topic text if included
ENDSECTION{"name"} -- marks the end of a named section within a topic
ENDTAB -- ending marker for a tab of a tabpane
ENDTABPANE -- ending tag for tabpane widget
ENDTWISTY
ENDTWISTYTOGGLE
ENV{"varname"} -- inspect the value of an environment variable
EXAMPLETAG -- example variable
EXPAND{"expression" scope="topictoexpandin" ...}%
FAILEDPLUGINS -- debugging for plugins that failed to load, and handler list
FORMAT{"list" format="" header="" footer="" separator=""} -- format a list of objects
FORMFIELD{"fieldname"} -- renders a field in the form attached to some topic
GMTIME{"format"} -- formatted GM time
[[VarGRAY][]]
[[VarGREEN][]]
GROUPINFO{"name"} -- retrieve details about a group
GROUPS -- a formatted list of groups
H -- help icon
HISTORY -- control attributes of tables and sorting of table columns
HOMETOPIC -- home topic in each web
HTTP -- get HTTP headers
HTTP_HOST -- environment variable
HTTPS -- get HTTPS headers
I -- idea icon
ICON{"name" alt="" default="name"} -- small documentation graphic or icon of common attachment types
ICONURL{"name" default="name"} -- URL of small documentation graphic or icon
ICONURLPATH{"name" default="name"} -- URL path of small documentation graphic or icon
IF{"condition" ...} -- simple conditionals
INCLUDE{"topic"} -- include other topic.
INCLUDINGTOPIC -- name of topic that includes current topic
INCLUDINGWEB -- web that includes current topic
JQICON -- render an image
JQICONPATH -- render the urlpath to an image
JQPLUGINS -- display a summary of available plugins
JQREQUIRE -- enable a plugin on the current page
JQTHEME -- switch jQuery UI theme
LANG -- the language specified by the server locale
LANGUAGE -- language code for the current user
LANGUAGES -- list available languages
[[VarLIME][]]
LOCALSITEPREFS -- web.topicname of site preferences topic
LOGIN -- present a full login link
LOGOUT -- present a full logout link
M -- moved to... icon
[[VarMAINWEB][MAINWEB -- synonym for
USERSWEB
]]
MAKETEXT -- creates text using Foswiki's I18N infrastructure
[[VarMAROON][]]
META -- displays meta-data
METASEARCH -- special search of meta data
N -- "new" icon
[[VarNAVY][]]
NONCE -- generate a nonce (developers only)
NOP -- template text not to be expanded in instantiated topics
NOTIFYTOPIC -- name of the notify topic
[[VarOLIVE][]]
[[VarORANGE][]]
P -- pencil icon
PERLDEPENDENCYREPORT -- report perl module dependencies
[[VarPINK][]]
PLUGINDESCRIPTIONS -- list of plugin descriptions
PLUGINVERSION -- the version of a Foswiki Plugin, or the Foswiki Plugins API
POPUPWINDOW -- opens a topic or url in a new window
PUBURL -- the base URL of attachments
PUBURLPATH -- the base URL path of attachments
[[VarPURPLE][]]
Q -- question icon
QUERY -- get the value of meta-data
QUERYPARAMS -- show paramaters to the query
QUERYSTRING -- full, unprocessed string of parameters to this URL
[[VarRED][]]
REMOTE_ADDR -- environment variable
REMOTE_PORT -- environment variable
REMOTE_USER -- environment variable
RENDERLIST -- render bullet lists in a variety of formats
RENDERZONE
REVARG --
&rev=n
URL revision parameter of current topic
REVINFO -- revision information of current topic
REVTITLE --
(r1)
The requested revision as displayed in topic breadcrumbs
S -- red star icon
SCRIPTNAME -- name of current script
SCRIPTSUFFIX -- script suffix
SCRIPTURL{"script"} -- URL of script
SCRIPTURLPATH{"script"} -- URL path of script
SEARCH{"text"} -- search content
SERVERINFORMATION -- report detailed web server information
SERVERTIME{"format"} -- formatted server time
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
SET -- set a preference setting during runtime
SHOWPREFERENCE -- show where preferences are defined.
[[VarSILVER][]]
SKIN -- current skin
SLIDESHOWEND -- end slideshow
SLIDESHOWSTART -- convert a topic with headings into a slideshow
SPACEDTOPIC -- topic name, spaced and URL-encoded
deprecated
SPACEOUT{"string"} -- renders string with spaces inserted in sensible places
STARTINCLUDE -- start position of topic text if included
STARTSECTION -- marks the start of a section within a topic
STATISTICSTOPIC -- name of statistics topic
STOPINCLUDE -- end position of topic text if included
STOPSECTION -- Alias for ENDSECTION
SUBSCRIBE{
attributes
} - subscribe the current user for notification of changes to the current topic
SYSTEMWEB -- name of documentation web
T -- tip icon
TAB -- tab inside a tabpane widget
TABLE -- control attributes of tables and sorting of table columns
TABPANE -- tabpane widget
[[VarTEAL][]]
TOC{"Topic"} -- table of contents
TOPIC -- name of current topic
TOPICLIST{"format"} -- topic index of a web
TOPICURL -- shortcut to viewing the current topic
[[VarTWIKIWEB][TWIKIWEB -- synonym for
SYSTEMWEB
]]
TWISTY
TWISTYBUTTON
TWISTYHIDE
TWISTYSHOW
TWISTYTOGGLE
U -- "updated" icon
URLPARAM{"name"} -- get URL or HTTP POST parameter value
USERINFO{"name"} -- retrieve details about a user
USERNAME -- your login username
USERSWEB -- name of users web
VAR{"NAME" web="Web"} -- get a preference value from another web
VBAR -- vertical bar
WEB -- name of current web
WEBLIST{"format"} -- index of all webs
WEBPREFSTOPIC -- name of web preferences topic
[[VarWHITE][]]
WIKIAGENTEMAIL -- From: email address in emails sent by Foswiki.
WIKIAGENTNAME -- From: Name used in emails sent by Foswiki
WIKIHOMEURL -- site home URL
WIKINAME -- your Wiki username
WIKIPREFSTOPIC -- name of site-wide preferences topic
WIKITOOLNAME -- name of your site
WIKIUSERNAME -- your Wiki username with web prefix
WIKIUSERSTOPIC -- name of topic listing all registered users
WIKIVERSION -- the version of the installed Foswiki engine
WIKIWEBMASTER -- feedback email address for site
WIKIWEBMASTERNAME -- Name of the administrator for the site
X -- warning icon
Y -- "yes" icon
[[VarYELLOW][]]
Deprecated macros
The following macros are deprecated and should not be used.
Shortcuts
For example,
%CARET%
will appear as
^
Icons
H -
I -
M -
N -
P -
Q -
S -
T -
U -
X -
Y -
Related Topics:
Macros
,
PreferenceSettings
,
UserDocumentationCategory
This topic: System
>
WebHome
>
ReferenceManual
>
UserDocumentationCategory
>
MacrosQuickReference
Topic revision:
03 Sep 2015,
ProjectContributor
Copyright © by the contributing authors. All material on this site is the property of the contributing authors.
Ideas, requests, problems regarding Foswiki?
Send feedback