#b120c5
web="all"
search: (Set to on
for hidden webs, default is empty) on
); link WikiWords (if empty): [[...][...]]
syntax to link topics if you disabled WikiWord linking.<noautolink> ... </noautolink>
syntax can be used to prevents links within a block of text.
[multiple of 3 spaces] * [space] Set [space] MACRONAME [space] = [space] value
Example:
* Set WEBBGCOLOR = #FFFFC0Macros defined using preference settings are expanded by enclosing their name in percent signs. So when you write
%WEBBGCOLOR%
, it gets expanded to #b120c5
A preference macro is always taken from the most current topic revision, even when accessing previous revisions of a topic.
Preferences can be defined in a number of places: Set
statements which occur at numerically higher locations override macros of the same name defined at lower numbered levels, unless the macro was listed in a finalpreferences setting (finalised) at a lower-numbered level. in this case, the macro is locked to the value at that level; set
statements at higher-numbered levels are ignored.
3-spaces,asterisk,equals,value
* Set MYSETTING = My setting valueWhen using the Wysiwyg editor, click the "Bullet" button and write the setting as a simple bullet. Don't include the asterisk. Spaces between the = sign and the value will be ignored. You can split a value over several lines by indenting following lines with spaces - as long as you don't try to use * as the first character on the following line. Example:
* Set MACRONAME = value starts here and continues hereWhatever you include in your macro will be expanded on display, exactly as if it had been entered directly (though see Parameters, below). Example: Create a custom logo macro
%MYLOGO%
, define the preference settings in the web's WebPreferences topic, and upload a logo file, ex: mylogo.gif
. You can upload by attaching the file to WebPreferences, or, to avoid clutter, to any other topic in the same web, e.g. LogoTopic
. Sample preference setting in WebPreferences:
* Set MYLOGO = %PUBURL%/%WEB%/LogoTopic/mylogo.gifPreference settings are case sensitive. (Foswiki by convention always writes settings in upper case.)
* Set lower = This is LOWER * Set LOWER = This is UPPER * Set System.LoWeR = This is MIXED Expand %lower%, %LOWER% and %LoWeR%Expand %lower%, %LOWER% and %LoWeR%. preference settings can easily be disabled with a # sign. Example:
* #Set DENYWEBCHANGE = %USERSWEB%.UnknownUser
<!-- * Set HIDDEN = This will be invisible in the output -->You can also set preference settings in a topic by clicking the link
Edit topic preference settings
under More topic actions
. Preferences set in this manner are known as 'meta' preferences and are not visible in the topic text, but take effect nevertheless.
Preview
will show the wrong thing, and you must Save
the topic to see it correctly.
* Set CONDITIONS = According to [[%BASETOPIC%][%BASETOPIC%]] the %WHAT% is %STATE% today (Set in ...).You can call this macro passing in values for
WHAT
and STATE
. For example: %CONDITIONS{WHAT="sea" STATE="choppy"}%
%CONDITIONS{WHAT="sea" STATE="choppy"}%
.
DEFAULT
gets the value of any unnamed parameter in the macro call.
default
parameter so that they expand to something even when a value isn't passed for them in the call.
* Set WEATHER = It's %DEFAULT{default="raining"}%.
%WEATHER%
expands to %WEATHER%
%WEATHER{"sunny"}%
expands to %WEATHER{"sunny"}%
Local
in place of Set
in the macro definition. For example, if the user sets the following in their home topic:
* Set EDITBOXHEIGHT = 10 * Local EDITBOXHEIGHT = 20Then, when they are editing any other topic, they will get a 10 high edit box. However, when they are editing their home topic they will get a 20 high edit box.
Local
can be used wherever a preference needs to take a different value depending on where the current operation is being performed.
Use this powerful feature with great care! %ALLVARIABLES%
can be used to get a listing of the values of all macros in their evaluation order, so you can see macro scope if you get confused.
I | Attachment | Action | Size | Date | Who | Comment |
---|---|---|---|---|---|---|
ico | favicon.ico | manage | 318 bytes | 20 Nov 2004 - 18:14 | TWikiContributor | placeholder favicon |