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 formatting macros can be used in expression, such as $percent and $quot.


Parameter Description Default
"text" Text to expand. Note that %-signs must be escaped using $percent, or they will be expanded in the context of the calling topic  
scope Scope to expand the topic in. This is the name of a topic. You can use Web.Topic syntax to refer to a topic in another web %TOPIC%


EXPAND can be useful when you want to pick up the value of macros defined in another topic. For example, you might want to define a set of preferences in one topic, but pick up their value in another topic (this is very useful when building reusable applications). In this case you can write:
   * Set MYPREFERENCE = value
in "SettingsTopic" and then, in "MyTopic", write:
%EXPAND{"$percentMYPREFERENCE$percent" scope="SettingsTopic"}%
Of course we can also write:
%EXPAND{"$percentMYPREFERENCE$percent" scope="%OTHERTOPIC%"}%
which lets us select which other topic to get the preference value from.

Additional parameters can be passed to the macro being expanded using the standard macro syntax in the name of the macro; for example,

%EXPAND{"$percentMYPREFERENCE{$quotdefault$quot param=$quotvalue$quot}" scope="SettingsTopic"}%

ALERT! EXPAND is not very efficient, and should be used sparingly.

HELP To expand a web preference (for example, a web access control) then set scope="Theotherweb.%WEBPREFSTOPIC%"
Topic revision: r1 - 03 May 2016, UnknownUser
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