Macros Quick Reference

See Macros for a detailed description of how to use Macros

Predefined Macros

• ACTIVATEDPLUGINS -- list of currently activated plugins
• ADDTOHEAD -- deprecated, use ADDTOZONE instead
• ADDTOZONE -- add content to a named zone on the page
• 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 -- 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 -- display formatted time
• DOCUMENTVIEWER -- Embed a presentation, spreadsheet, PDF or other document in a viewer
• EDITACTION -- Selects an edit template
• EDITTABLE{ attributes } -- edit tables using edit fields and other input fields
• ENCODE -- encode characters in a string
• ENDCOLOR -- end colored text
• ENDINCLUDE -- end position of topic text if included
• ENDSECTION -- 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 -- complements an opening TWISTY tag to close a twisty
• ENDTWISTYTOGGLE -- Twisty closure
• ENV -- inspect the value of an environment variable
• EXAMPLETAG -- example macro tag
• EXPAND -- expand macros in a string as if they were used in another topic
• FAILEDPLUGINS -- debugging for plugins that failed to load
• FLOWCHART{ attributes } -- create a flowchart from topic text.
• FORMAT -- format a list of objects
• FORMFIELD -- renders a field in the form attached to some topic
• GMTIME -- formatted Greenwich Mean Time (UTC)
• [[VarGRAY][]]
• [[VarGREEN][]]
• GROUPINFO -- 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 -- small documentation graphic or icon of common attachment types
• ICONURL -- URL of small documentation graphic or icon
• ICONURLPATH -- URL path of small documentation graphic or icon
• IF -- simple conditionals
• INCLUDE -- include another topic, or subsection of a topic, or a URL, or Foswiki embedded documentation
• INCLUDINGTOPIC -- name of topic that includes current topic
• INCLUDINGWEB -- web that includes current topic
• JQICON -- render an image
• JQICONPATH -- render the url path to an image icon
• JQPLUGINS -- display a summary of available plugins
• JQREQUIRE -- enable a plugin on the current page
• JQTHEME -- switch jQuery UI theme
• KINOSEARCH tag
• 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
• MAINWEB -- deprecated synonym for USERSWEB
• MAKETEXT -- creates text using Foswiki's I18N infrastructure
• [[VarMAROON][]]
• META -- displays meta-data
• METASEARCH -- special search of meta data
• MIMEICON{"filename"} -- return a meaningful icon for this filename
• 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 -- generate an URL for an attachment
• PUBURLPATH -- generate a relative URL for an attachment
• [[VarPURPLE][]]
• Q -- question icon
• QUERY -- get the value of meta-data
• QUERYPARAMS -- show parameters 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 - render the content of a zone
• REVARG -- &rev=n parameter of current request
• REVINFO -- revision information of current topic
• REVTITLE -- The requested revision as displayed in topic breadcrumbs
• S -- red star icon
• SCRIPTNAME -- name of current script
• SCRIPTSUFFIX -- script suffix
• SCRIPTURL -- URL of script(s)
• SCRIPTURLPATH -- URL path of script(s)
• SEARCH -- search content
• SERVERINFORMATION -- report detailed web server information
• SERVERTIME -- 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 -- 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 -- Alias for ENDINCLUDE
• 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 -- table of contents
• TOPIC -- name of current topic
• TOPICLIST -- topic index of a web
• TOPICURL -- shortcut to viewing the current topic
• TWIKIWEB -- synonym for SYSTEMWEB
• TWISTY -- generate content block with interactive visibility controls
• TWISTYBUTTON -- Shorthand version for TWISTYSHOW & TWISTYHIDE
• TWISTYHIDE - Hide/close link
• TWISTYSHOW - Show/open link
• TWISTYTOGGLE -- Twisty Toggle contents section
• U -- "updated" icon
• URLPARAM -- get URL or HTTP POST parameter value
• USERINFO -- retrieve details about a user
• USERNAME -- your login username
• USERSWEB -- name of users web
• VAR -- get a preference value from another web
• VBAR -- vertical bar
• VOTE{ attributes } -- define a poll in a topic.
• WEB -- name of current web
• WEBLINK
• WEBLIST -- 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
• WORKFLOW* -- macros associated with WorkflowPlugin
• X -- warning icon
• Y -- "yes" icon
• [[VarYELLOW][]]

Deprecated macros

The following macros are deprecated and should not be used.

• ADDTOHEAD -- deprecated, use ADDTOZONE instead
• ALLVARIABLES -- list of currently defined macros
• GROUPS -- a formatted list of groups
• MAINWEB -- deprecated synonym for USERSWEB
• METASEARCH -- special search of meta data
• REVARG -- &rev=n parameter of current request
• TWIKIWEB -- synonym for SYSTEMWEB

Shortcuts

• TOPICURL -- absolute URL for the current topic
• BR -- line break
• CLEAR -- clear floats
• BULLET -- •
• VBAR -- |
• CARET -- ^
• BB -- line break and bullet

For example, %CARET% will appear as ^

Icons

• H -
• I -
• M -
• N -
• P -
• Q -
• S -
• T -
• U -
• X -
• Y -

---

Related Topics: Macros, PreferenceSettings, UserDocumentationCategory