topic
parameter is specified, it gets the value of the specified preferences variable in the specified topic. Please note that the WebPreferences of the web of the specified topic is not examined. So the returned value may not be the same as the value of the variable when the specified topic is viewed.
topic
parameter is not specified and the web
parameter is specified, it gets the value of the specified preferences variable in the specified web, which means the specified web's WebPreferences is examined for the variable.
topic
nor web
parameter is specified, it gets the value of the specified variable in the current context -- the variable can either be a preferences variable or a session variable but cannot be a tag with a tag handler (e.g. %GMTIME%
). %VAR{"NAME"}%
is similar to %NAME%
, but they differ if NAME
is undefined, in which case %VAR{"NAME"}%
is expanded to null (zero width string) while %NAME%
remains as is (%NAME%
). %VAR{"NAME"}%
yields the same value as %IF{"defined NAME" then="$percntNAME$percnt"}%
if NAME is a variable, but the latter is cubmersome.
%VAR{"NAME" ...}%
Parameter: | Description: | Default: |
---|---|---|
ignorenull="on" | If specified, a null string ("") value is regarded as undefined. This affects whether or not the value specified by the default parameter is returned. | "off" |
topic="Topic" | Same as above, but the web is specified specified explicitly with the web parameter or the current web is specified. | none |
topic="Web.Topic" | Specifies the topic in which the specified preferences vaiable is fetched. | none |
default="Value" | Specifies the value to be returned if the specified variable is undefined. | "" (null string) |
web="Web" | Specifies the web in which the specified preferences variable is fetched. | none |
"Variable" | The name of the variable to be retrieved. If not specified, %VAR{...}% is expanded to null. | required |
%VAR{"GROUP" topic="%USERSWEB%.TWikiAdminGroup"}%
, which expands to ==.
%WEBBGCOLOR%
of the Main web write %VAR{"WEBBGCOLOR" web="Main"}%
, which expands to #FFEFA6
%VAR{"FOOSKIN_HTML_HEAD_HOOK" default="<nop>" ignorenull="on"}%