You are here:
Foswiki
>
System Web
>
Category
>
UserDocumentationCategory
>
MacrosQuickReference
(03 Sep 2015,
ProjectContributor
)
Edit
Attach
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
AQUA -- start aqua colored text
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
BLACK -- start black colored text
BLUE -- start blue colored text
BR -- line break
BROWN -- start brown colored text
BULLET -- bullet sign
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
DISPLAYTIME{"format"} -- formatted display time
EDITACTION -- Selects an edit template
EDITTABLE{
attributes
} -- edit tables using edit fields and other input fields
ENCODE -- encode characters in a string
ENDBG -- end background color section
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
FORMAT -- format a list of objects
FORMFIELD -- renders a field in the form attached to some topic
GMTIME -- formatted Greenwich Mean Time (UTC)
GMTIME{"format"} -- formatted GM time
GRAY -- start gray colored text
GREEN -- start green colored text
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
JQENDTAB -- end a JQuery tab within a tab pane
JQENDTABPANE -- end a JQuery tab pane
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
JQTAB -- start a JQuery tab within a tab pane
JQTABPANE -- start a JQuery tab pane
JQTHEME -- switch jQuery UI theme
LANG -- the language specified by the server locale
LANGUAGE -- language code for the current user
LANGUAGES -- list available languages
LIME -- start lime colored text
LOCALSITEPREFS -- web.topicname of site preferences topic
LOGIN -- present a full login link
LOGINURL -- present a login link
LOGOUT -- present a full logout link
LOGOUTURL -- present a logout link
M -- moved to... icon
MAINWEB -- deprecated synonym for USERSWEB
MAKETEXT -- creates text using Foswiki's I18N infrastructure
MAROON -- start maroon colored text
META -- displays meta-data
METASEARCH -- special search of meta data
N -- "new" icon
NAVY -- start navy blue colored text
NONCE -- generate a nonce (developers only)
NOP -- template text not to be expanded in instantiated topics
NOTIFYTOPIC -- name of the notify topic
OLIVE -- start olive green colored text
ORANGE -- start orange colored text
P -- pencil icon
PERLDEPENDENCYREPORT -- report perl module dependencies
PINK -- start pink colored text
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
PURPLE -- start purple colored text
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
RED -- start red colored text
REDBG -- start red colored background section
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
REVINFO{"format"} -- formatted revision information of 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)
SCRIPTURL{"script"} -- URL of TWiki script
SCRIPTURLPATH -- URL path of script(s)
SCRIPTURLPATH{"script"} -- URL path of TWiki script
SEARCH -- search content
SERVERINFORMATION -- report detailed web server information
SERVERTIME -- formatted server time
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.
SILVER -- start silver colored text
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
TEAL -- start teal colored text
TOC -- table of contents
TOC{"Topic"} -- 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
WEB -- name of current web
WEBLIST -- index of all webs
WEBPREFSTOPIC -- name of web preferences topic
WHITE -- start white colored text
WIKIAGENTEMAIL -- From: email address in emails sent by Foswiki.
WIKIAGENTNAME -- From: Name used in emails sent by Foswiki
WIKIHOMEURL -- site home URL
WIKILOGOALT -- site logo tooltip message
WIKILOGOIMG -- site logo image URL
WIKILOGOURL -- site logo 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
YELLOW -- start yellow colored text
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
E
dit
|
A
ttach
|
P
rint version
|
H
istory
: r1
|
B
acklinks
|
V
iew wiki text
|
Edit
w
iki text
|
M
ore topic actions
Topic revision: r1 - 03 Sep 2015,
ProjectContributor
System
Log In
System Web
Users
Groups
Index
Search
Changes
Notifications
RSS Feed
Statistics
Preferences
User Reference
ATasteOfTWiki
TextFormattingRules
TWikiVariables
FormattedSearch
QuerySearch
TWikiDocGraphics
TWikiSkinBrowser
InstalledPlugins
Admin Maintenance
Reference Manual
AdminToolsCategory
InterWikis
ManagingWebs
TWikiSiteTools
DefaultPreferences
WebPreferences
Categories
Admin Documentation
Admin Tools
Developer Doc
User Documentation
User Tools
Webs
Main
Sandbox
System
Copyright © by the contributing authors. All material on this site is the property of the contributing authors.
Ideas, requests, problems regarding Foswiki?
Send feedback