Children of Macros in System Web

Results from System web retrieved at 09:05 (GMT)

VarACTIVATEDPLUGINS
ACTIVATEDPLUGINS list of currently activated plugins Examples * %ACTIVATEDPLUGINS% expands to Related PLUGINDESCRIPTIONS, FAILEDPLUGINS, PLUGINVERSION
VarADDTOZONE
ADDTOZONE add content to a named zone on the page Parameters Parameter Description Default "zone" comma separated list of the names of zones th...
VarATTACHURL
ATTACHURL full URL for attachments in the current topic Shorthand for PUBURL, with path set to the current topic. Otherwise supports all the same parameters as PU...
VarATTACHURLPATH
ATTACHURLPATH path of the attachment URL of the current topic Shorthand for PUBURLPATH with path set to the current topic. Otherwise supports all the same paramet...
VarAUTHREALM
AUTHREALM authentication realm String defined as the {AuthRealm} expert option in configure Security And Authentication tab, =Login sub tab.. This is used in cert...
VarBASETOPIC
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...
VarBASEWEB
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...
VarBUTTON
BUTTON renders a nice button Parameters Parameter Description Default "text" text to be put on this button value text t...
VarCALC
CALC add spreadsheet calculations to tables and outside tables The %CALC{"formula"}% macro is handled by the SpreadSheetPlugin. There are around 90 formulae, such...
VarCALCULATE
CALCULATE add spreadsheet formulae calls using standard Macro evaluation order. The %CALCULATE{"formula"}% macro is handled by the SpreadSheetPlugin. There are ar...
VarCOMMENT
COMMENT insert an edit box into the topic to easily add comments. Parameters * The following standard attributes are recognized Name Descriptio...
VarCOVER
COVER current skin 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...
VarDATE
DATE signature format date Examples * %DATE% expands to == * Date format defined as {DefaultDateFormat} in configure When used in a template topic, thi...
VarDISPLAYTIME
DISPLAYTIME display formatted time Formatted time either GMT or Local server time, depending on {DisplayTimeValues} setting in configure. Same format qualifiers...
VarENCODE
ENCODE encode characters in a string Encode character sequences in "string", by mapping characters (or sequences of characters) to an alternative character (or se...
VarENDINCLUDE
ENDINCLUDE 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...
VarENDSECTION
ENDSECTION marks the end of a named section within a topic If the STARTSECTION is named, the corresponding ENDSECTION must also be named with the same name. If th...
VarENDTAB
ENDTAB ending marker for a tab of a tabpane This closes a previously opened TAB. Related TAB, TABPANE, ENDTAB, JQueryPlugin, JQueryTabpane
VarENDTABPANE
ENDTABPANE ending tag for tabpane widget This closes a previously opened TABPANE. Related TAB, ENDTAB, TABPANE, JQueryPlugin, JQueryTabpane
VarENDTWISTY
ENDTWISTY complements an opening TWISTY tag to close a twisty Closes an open twisty Related
VarENDTWISTYTOGGLE
ENDTWISTYTOGGLE Twisty closure Will end the most inner unclosed Twisty Toggle section, using the proper tag Examples %ENDTWISTYTOGGLE% Related
VarENV
ENV inspect the value of an environment variable Returns the current value of the environment variable in the CGI (Common Gateway Interface) environment. This is ...
VarEXAMPLETAG
EXAMPLETAG example macro tag The %EXAMPLETAG% variable is handled by the ExamplePlugin Parameters Parameter Description Default "..." Unnamed p...
VarEXPAND
EXPAND expand macros in a string as if they were used in another topic The viewer must have VIEW access to topictoexpandin for this to work. All the standard form...
VarFAILEDPLUGINS
FAILEDPLUGINS debugging for plugins that failed to load Also generates a list of handlers defined by plugins Examples * %FAILEDPLUGINS% Related PLUGINDESCRI...
VarFORMAT
FORMAT format a list of objects Parameters Parameter Description Default "one, two, three" The list to be expanded into the format. R...
VarFORMFIELD
FORMFIELD renders a field in the form attached to some topic Parameters Parameter Description Default "name" The name of a Data form ...
VarGMTIME
GMTIME formatted Greenwich Mean Time (UTC) Parameters Parameter Description Default "format" format $day $month $year $hour:$min %GMTI...
VarGROUPINFO
GROUPINFO retrieve details about a group Parameters Parameter Description Default "groupname" Optional name of group format ...
VarHISTORY
HISTORY control attributes of tables and sorting of table columns The %HISTORY{}% macro is handled by the HistoryPlugin Parameters Parameter ...
VarHOMETOPIC
HOMETOPIC home topic in each web Examples * %HOMETOPIC% expands to ==, renders as Related NOTIFYTOPIC, STATISTICSTOPIC, TOPIC
VarHTTP
HTTP get HTTP headers * Called with the name of an HTTP request header field, returns its value. Capitalization and the use of hyphens versus underscores are n...
VarHTTPHOST
HTTP_HOST environment variable Examples * %HTTP_HOST% expands to == Related ENV, REMOTE_ADDR, REMOTE_PORT, REMOTE_USER
VarHTTPS
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 wh...
VarICON
ICON small documentation graphic or icon of common attachment types Generates a small graphic image from the set attached to . Images typically have a 16x16...
VarICONURL
ICONURL URL of small documentation graphic or icon Generates the full URL of a image, which Foswiki renders as an image. The related %ICON{"name"}% generat...
VarICONURLPATH
ICONURLPATH URL path of small documentation graphic or icon Generates the relative URL path of a image, typically used in an HTML img tag. Specify image na...
VarIF
IF simple conditionals Evaluate a condition and show one text or another based on the result. See details in IfStatements . Parameter Description Defa...
VarINCLUDE
INCLUDE include another topic, or subsection of a topic, or a URL, or Foswiki embedded documentation (Including a topic) Parameters Parameter: Des...
VarINCLUDINGTOPIC
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...
VarINCLUDINGWEB
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 ...
VarJQICON
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 {JQueryP...
VarJQICONPATH
JQICONPATH render the urlpath to an image This is a shortcut for Examples * %JQICONPATH{"tick"}% expands to == Related JQICON, ICONURL, JQueryPlugin...
VarJQPLUGINS
JQPLUGINS display a summary of available plugins Parameters Parameter Description Default "plugins" this is a regular expression that...
VarJQREQUIRE
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 av...
VarJQTHEME
JQTHEME switch jQuery UI theme Foswiki's default UI theme is configured in $Foswiki::cfg{JQueryPlugin}{JQueryTheme} and defaults to foswiki. Use configure to cha...
VarLANG
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 enabl...
VarLANGUAGE
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. T...
VarLANGUAGES
LANGUAGES list available languages List the languages available (as PO files). These are the languages in which the user interface is available. Parameters ...
VarLOCALSITEPREFS
LOCALSITEPREFS web.topicname of site preferences topic * The full name of the local site preferences topic. These local site preferences overload the system le...
VarLOGIN
LOGIN present a full login link %IF{"context authenticated" then="$percentT$percent You are already authenticated, so %LOGIN% expands to an empty string "}%...
VarLOGOUT
LOGOUT present a full logout link %IF{"context authenticated" else="$percentT$percent You are already logged out, so %LOGOUT expands to an empty string" }% ...
VarMAKETEXT
MAKETEXT creates text using Foswiki's I18N infrastructure Strings captured in the MAKETEXT macro are automatically mapped to the current user's selected language ...
VarMETA
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.)....
VarNONCE
NONCE generate a nonce (developers only) DEVELOPERS ONLY This macro is used to generate a 'nonce', a unique key that identifies the source of a request in order t...
VarNOP
NOP template text not to be expanded in instantiated topics * %NOP% * In normal topic text, expands to nop , which prevents expansion of adjacent macros...
VarNOTIFYTOPIC
NOTIFYTOPIC name of the notify topic Examples * %NOTIFYTOPIC% expands to ==, renders as Related HOMETOPIC, STATISTICSTOPIC, TOPIC
VarPERLDEPENDENCYREPORT
PERLDEPENDENCYREPORT report perl module dependencies Intended for use by installers / administrators, reports on the status of Perl dependencies in the Foswiki co...
VarPLUGINDESCRIPTIONS
PLUGINDESCRIPTIONS list of plugin descriptions Examples * %PLUGINDESCRIPTIONS% expands to Related ACTIVATEDPLUGINS, FAILEDPLUGINS, PLUGINVERSION
VarPLUGINVERSION
PLUGINVERSION the version of a Foswiki Plugin, or the Foswiki Plugins API Use %PLUGINVERSION{"name"}% to get the version of a specific plugin Examples * %PLUG...
VarPOPUPWINDOW
POPUPWINDOW opens a topic or url in a new window Parameters Parameter Description Default "topic" topic="topic" topic="web.topic" T...
VarPUBURL
PUBURL generate an URL for an attachment Generate an absolute URL for an attachment, or for a web or topic within the attachment database. Parameters ...
VarPUBURLPATH
PUBURLPATH generate a relative URL for an attachment Generate a relative URL for an attachment, or for a web or topic within the attachment database. Parameters ...
VarQUERY
QUERY get the value of meta data Uses the query syntax described in QuerySearch to get information about meta data from one specified topic. * supports formatt...
VarQUERYPARAMS
QUERYPARAMS show parameters to the query Expands the parameters to the query that was used to display the page. Parameters Parameter: Description:...
VarQUERYSTRING
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 exa...
VarREMOTEADDR
REMOTE_ADDR environment variable Examples * %REMOTE_ADDR% expands to == Related ENV, HTTP_HOST, REMOTE_PORT, REMOTE_USER
VarREMOTEPORT
REMOTE_PORT environment variable Examples * %REMOTE_PORT% expands to Related ENV, HTTP_HOST, REMOTE_ADDR, REMOTE_USER
VarREMOTEUSER
REMOTE_USER environment variable Examples * %REMOTE_USER% expands to Displays the user identity established by the Web Server. Not available when using ...
VarRENDERLIST
RENDERLIST render bullet lists in a variety of formats The %RENDERLIST% macro is handled by the RenderListPlugin Examples * Engineering * Tech Pub...
VarRENDERZONE
RENDERZONE render the content of a zone Rendersa zone. See ADDTOZONE for an explanation of zones. Parameters Parameter Description Default ...
VarREVINFO
REVINFO revision information of current topic %REVINFO% is equivalent to %REVINFO{format="r1.$rev $date $wikiusername"}% Examples * %REVINFO% expands to =...
VarREVTITLE
REVTITLE The requested revision as displayed in topic breadcrumbs If a topic revision is requested in the URL, it returns the printable revision of the current t...
VarSCRIPTNAME
SCRIPTNAME name of current script * The name of the current script is shown, including script suffix, if any (for example viewauth.cgi) Examples * %SCRIPTN...
VarSCRIPTSUFFIX
SCRIPTSUFFIX script suffix * Some Foswiki installations require a file extension for CGI scripts, such as .pl or .cgi Examples * %SCRIPTSUFFIX% expands to ...
VarSCRIPTURL
SCRIPTURL URL of script(s) Expands to the URL of a script, or the base URL of all scripts Parameters Parameter Description Default "$script" ...
VarSCRIPTURLPATH
SCRIPTURLPATH URL path of script(s) Expands to the base URL of scripts, without protocol or host Parameters Parameter Description Default "$s...
VarSEARCH
SEARCH search content Inline search, shows a search result embedded in a topic Parameters Parameter Description Default: "text" search...
VarSERVERINFORMATION
SERVERINFORMATION report detailed web server information Intended for use by installers / administrators, reports on the runtime information of the Foswiki instal...
VarSERVERTIME
SERVERTIME formatted server time Same format parameters as VarGMTIME GMTIME% , but displaying the server time instead of UTC. Examples * %SERVERTIME% els...
VarSESSIONID
SESSIONID unique ID for this session Examples * %SESSIONID% expands to == Related UserAuthentication, AUTHREALM, SESSIONVAR, LOGIN, LOGOUT, SESSION_VARIABLE...
VarSESSIONVAR
SESSIONVAR name of CGI and session variable that stores the session ID Examples * %SESSIONVAR% expands to Related UserAuthentication, AUTHREALM, SESSIONID,...
VarSESSIONVARIABLE
SESSION_VARIABLE get, set or clear a session variable Parameters Parameter Description "name" name of variable set value to set it to ...
VarSET
SET set a preference setting during runtime A preference setting created via a %SET macro is usable by the topic containing the %SET statement, and in any other t...
VarSHOWPREFERENCE
SHOWPREFERENCE show where preferences are defined. Preference values are shown in a bulleted list, together with where they were defined. Parameters ...
VarSKIN
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 parame...
VarSLIDESHOWEND
SLIDESHOWEND end slideshow The %SLIDESHOWEND% macro is handled by the SlideShowPlugin Examples See SLIDESHOWSTART Related SLIDESHOWSTART, SlideShowPlugin
VarSLIDESHOWSTART
SLIDESHOWSTART convert a topic with headings into a slideshow Handled by the SlideShowPlugin Parameters Parameter Description template optional n...
VarSPACEDTOPIC
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 bac...
VarSPACEOUT
SPACEOUT 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 afte...
VarSTARTINCLUDE
STARTINCLUDE start position of topic text if included If present in included topic, start to include text from this location up to the next %ENDINCLUDE% macro, or...
VarSTARTSECTION
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 ...
VarSTATISTICSTOPIC
STATISTICSTOPIC name of statistics topic Examples * %STATISTICSTOPIC% expands to ==, renders as Related HOMETOPIC, NOTIFYTOPIC, TOPIC
VarSTOPINCLUDE
STOPINCLUDE Alias for ENDINCLUDE Related INCLUDE, STARTINCLUDE
VarSTOPSECTION
STOPSECTION Alias for ENDSECTION Related ENDSECTION, STARTSECTION
VarSYSTEMWEB
SYSTEMWEB name of documentation web The web containing all documentation and default preference settings Examples * %SYSTEMWEB% expands to == Related USERSW...
VarTAB
TAB tab inside a tabpane widget Defines a tab inside a TABPANE area; must be closed using ENDTAB. Parameters Parameter Description Default ...
VarTABLE
TABLE control attributes of tables and sorting of table columns The %TABLE{}% macro is handled by the TablePlugin Attributes for tables Parameter ...
VarTABPANE
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: ...
VarTOC
TOC table of contents Shows a Table of Contents that is generated automatically based on headings of a topic. Headings in TopicMarkupLanguage (" text") and HTML ...
VarTOPIC
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 top...
VarTOPICLIST
TOPICLIST 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 ...
VarTWISTY
TWISTY generate content block with interactive visibility controls This renders the button as well as the toggled content section contained within this and the cl...
VarTWISTYBUTTON
TWISTYBUTTON Shorthand version for TWISTYSHOW TWISTYHIDE This is useful if both the show and the hide button take the same arguments. Parameters All parameters...
VarTWISTYHIDE
TWISTYHIDE Hide/close link Parameters Parameter Description Default id Used to link TWISTYSHOW, TWISTYHIDE and TWISTYTOGGLE required ...
VarTWISTYSHOW
TWISTYSHOW Show/open link Parameters Parameter Description Default id Used to link TWISTYSHOW, TWISTYHIDE and TWISTYTOGGLE required ...
VarTWISTYTOGGLE
TWISTYTOGGLE Twisty Toggle contents section Parameters Parameter Description Default id Used to link TWISTYSHOW, TWISTYHIDE and TWISTYT...
VarURLPARAM
URLPARAM get URL or HTTP POST parameter value Returns the value of the named parameter in the URL or HTTP POST request. Parameters Parameter: Desc...
VarUSERINFO
USERINFO retrieve details about a user Parameters Parameter Description "name" WikiName or login username. May be a group. current user ...
VarUSERNAME
USERNAME your login username Foswiki makes names available in three formats: USERNAME like jsmith, WIKINAME like JohnSmith and WIKIUSERNAME like .JohnSmith. Un au...
VarUSERSWEB
USERSWEB name of users web * The web containing individual user topics, .WikiGroups, and customised site wide preferences. Examples * %USERSWEB% expands to...
VarVAR
VAR get a preference value from another web Parameters Parameter Description "name" name of preference to retrieve web name of web to r...
VarWEB
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 w...
VarWEBLIST
WEBLIST index of all webs Generate a list of webs. Obfuscated webs are excluded, e.g. webs with a NOSEARCHALL = on preference setting. The "format" defines the fo...
VarWEBPREFSTOPIC
WEBPREFSTOPIC name of web preferences topic Examples * %WEBPREFSTOPIC% expands to ==, renders as Related HOMETOPIC, WIKIPREFSTOPIC, VAR
VarWIKIAGENTEMAIL
WIKIAGENTEMAIL From: email address in emails sent by Foswiki. Examples * %WIKIAGENTEMAIL% expands to == Related WIKIAGENTNAME, WIKIWEBMASTER, WIKIWEBMASTERNA...
VarWIKIAGENTNAME
WIKIAGENTNAME From: Name used in emails sent by Foswiki Examples * %WIKIAGENTNAME% expands to == Related WIKIAGENTEMAIL, WIKIWEBMASTER, WIKIWEBMASTERNAME
VarWIKIHOMEURL
WIKIHOMEURL site home URL Examples * %WIKIHOMEURL%= expands to = * Normally by default set to %SCRIPTURLPATH{"view"}% For the top bar logo URL use %WIK...
VarWIKINAME
WIKINAME your Wiki username The WikiName is the same as %USERNAME% if not defined in the . topic. This macro is an alias for the USERINFO macro with a fixed forma...
VarWIKIPREFSTOPIC
WIKIPREFSTOPIC name of site wide preferences topic Examples * %WIKIPREFSTOPIC% expands to ==, renders as Related HOMETOPIC, WEBPREFSTOPIC
VarWIKITOOLNAME
WIKITOOLNAME name of your site Examples * %WIKITOOLNAME% expands to Foswiki Related WIKIHOMEURL, WIKIVERSION
VarWIKIUSERNAME
WIKIUSERNAME your Wiki username with web prefix Your %WIKINAME% with web prefix, useful to point to your Foswiki home page This macro is an alias for the USERINF...
VarWIKIUSERSTOPIC
WIKIUSERSTOPIC name of topic listing all registered users Examples * %WIKIUSERSTOPIC% expands to == * with prefix renders as . Related WIKIUSERNAME
VarWIKIVERSION
WIKIVERSION the version of the installed Foswiki engine Examples * %WIKIVERSION% expands to == Related PLUGINVERSION, WIKITOOLNAME
VarWIKIWEBMASTER
WIKIWEBMASTER feedback email address for site Examples * %WIKIWEBMASTER% expands to == Related WIKIWEBMASTERNAME
VarWIKIWEBMASTERNAME
WIKIWEBMASTERNAME Name of the administrator for the site Examples * %WIKIWEBMASTERNAME% expands to == Related WIKIWEBMASTER
Number of topics: 126
This site is powered by FoswikiCopyright © by the contributing authors. All material on this site is the property of the contributing authors.
Ideas, requests, problems regarding Foswiki? Send feedback