Note: This topic should be regarded as read-only, so that upgrades can safely overwrite it without risk to your customizations.
Preference settings local to your site should be set in Main.SitePreferences (this topic is pointed to by {LocalSitePreferences}, which is set by the admin in the configure interface). Settings in Main.SitePreferences will override settings in this topic, and should be used for defining custom settings.
Read more on how to set preferences.
NOTE: These are just defaults; don't change them here. Instead, add them to the WebPreferences topic in each webfavicon.ico to a web's WebPreferences or add a FAVICON setting to WebPreferences 
on, do not set NOSEARCHALL, and add the "what" and "use to..." description for the site map. Make sure to list only links that include the name of the web, e.g. System.Topic links.
Copyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors. web="all" search: (Set to on for hidden webs; is overwritten by web preferences) Note it is much better to use AccessControls in individual webs to control who can and can't view the contents of a web. NOSEARCHALL is retained for compatibility, but you should avoid using it. on); link WikiWords (if empty); can be overwritten by web preferences: [[...][...]] syntax to link topics in case you disabled WikiWord linking. The <noautolink> ... </noautolink> syntax can be used to prevents links within a block of text.
%INCLUDE{}% of topic fails: Fail silently if empty or off. Output warning message (defined in templates/oopsalerts.tmpl) if set to on. Otherwise output specific text (use $topic for topic). You can override this in web preferences, or by using a warn="..." parameter with %INCLUDE{}% : 1
1 to 6
6
1 to 6
depth parameter of TOC
On this page:
title parameter of TOC
on or nothing
NOTE: They are typically redefined in the individual users topic. eg. WikiAdmin.FOSWIKIPREF cooke has been set. They have
been removed from Foswiki 2.0.
width: 99% for full window width (default; this will override the EDITBOXWIDTH setting), or width: auto to disable. This setting works for IE and some other recent browsers. (can be overwritten by user preferences) Set FORCENEWREVISIONCHECKBOX = checked="checked", or unchecked if empty: (can be overwritten by user preferences) Set DONTNOTIFYCHECKBOX = checked="checked", or unchecked if empty: (can be overwritten by user preferences) Set ATTACHLINKBOX = checked="checked", or unchecked if empty (Set ATTACHLINKBOX =). If checked, a link is created to the attached file at the end of the topic: (can be overwritten by user preferences) 
NOTE: Keyword $filename gets expanded to filename; $fileurl gets expanded to the urlencoded filename; $comment to comment; \t to tab (3 spaces for bullets).
* Set ATTACHEDFILELINKFORMAT =
* [[%ATTACHURL%/$fileurl][$filename]]: $comment
NOTE: Keyword $filename gets expanded to filename; $fileurl gets expanded to the urlencoded filename; $comment to comment; $size to width="..." height="..." attribute of img tag; \t to tab and ==
== to linefeed (3 spaces for bullets).
* Set ATTACHEDIMAGEFORMAT =
* $comment: <br />
<img src="%ATTACHURLPATH%/$fileurl" alt="$filename" $size />
NOTE: To automatically list all non-hidden webs in alphabetical order, use the %WEBLIST{}% macro instead: Note: if you need to block all user access (view included) the easiest way it to change the configure AccessControl option to AdminOnlyAccess (see the Security and Authentication section)
%SEARCH{}% macro, one of: keyword, regex, or literal Customize the Search and Jump boxes at the top of the page by customizing the WebTopBar. See PatternSkinCustomization#Top_bar and WebTopBarExample.extraField_groups to the optionalFields section. See UserAuthentication#Custom_registration_page for more information. automatic: users will be automatically added to eligible groups
one: users can select one of the groups
multiple: users can select from multiple groups to join
none: user cannot be added to groups while registering
NOTE: Changing cache behaviour with these settings should not be necessary and may cause cache-related problems. These settings do not affect proxy caches.<link>-tags).
http-equiv meta tags for view, rdiff, attach, search* scripts: http-equiv meta tags for edit script: http-equiv meta tags for preview script: initPlugin using the following simple code fragment. Say you want to add 'MYPREF' to the list:
my $pref = Foswiki::Func::getPreferencesValue('EXPORTEDPREFERENCES')||'';
my @list = split(/[,\s]+/, $pref);
unless (grep { /^MYPREF$/ } @list) {
push(@list, 'MYPREF');
}
Foswiki::Func::setPreferencesValue(
'EXPORTEDPREFERENCES', join(',', @list));
PATTERNSKIN_THEME_VARIANT): %ICON{name}%. INIT which will hold the default initialisation parameters for the TinyMCE editor. Not set in this topic, the plugin assumes this value if missing 0 (no animation)
| You type: | %RED% red text %ENDCOLOR% and %GREEN% green text %ENDCOLOR% |
| You get: | red text and green text |
%<color>% text must end with %ENDCOLOR%. If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
* Set YELLOW = <span class='foswikiYellowFG'>
* Set ORANGE = <span class='foswikiOrangeFG'>
* Set RED = <span class='foswikiRedFG'>
* Set PINK = <span class='foswikiPinkFG'>
* Set PURPLE = <span class='foswikiPurpleFG'>
* Set TEAL = <span class='foswikiTealFG'>
* Set NAVY = <span class='foswikiNavyFG'>
* Set BLUE = <span class='foswikiBlueFG'>
* Set AQUA = <span class='foswikiAquaFG'>
* Set LIME = <span class='foswikiLimeFG'>
* Set GREEN = <span class='foswikiGreenFG'>
* Set OLIVE = <span class='foswikiOliveFG'>
* Set MAROON = <span class='foswikiMaroonFG'>
* Set BROWN = <span class='foswikiBrownFG'>
* Set BLACK = <span class='foswikiBlackFG'>
* Set GRAY = <span class='foswikiGrayFG'>
* Set SILVER = <span class='foswikiSilverFG'>
* Set WHITE = <span class='foswikiWhiteFG'>
* Set ENDCOLOR = </span>
$text is the topic link text, $topic is the name of the new topic, and $web is the name of the web for the new topic. Values for the 3 are taken from the link syntax [[$web.$topic][$text]]. For normal plain WikiWord links $text and $topic are the same. The value of $web is the current web unless the link is in the format $web.$topic. sequential, sidebyside or debug configure (expert setting) [3 spaces] * [space] Set NAME = value %. Example: %WEBBGCOLOR%, it gets expanded to #FFD8AA .
The sequential order of the preference settings is significant. Define preferences that use other preferences FIRST. For example, set WEBCOPYRIGHT before WIKIWEBMASTER since the copyright notice uses the Wiki administrator e-mail address.
In order to protect your custom preferences from being overwritten when upgrading the System.DefaultPreferences topic, it is recommended that all custom settings are defined in Main.SitePreferences.%MACROS%.