This topic defines site-level settings that apply to all users and webs on this site.
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.
If yes, set SITEMAPLIST to 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.
Simplified Copyright notice for the WebRss feed (don't use any special characters, html tags, entities, wiki markup or WikiWords)
Set WEBRSSCOPYRIGHT = Copyright 2024 by contributing authors
Exclude web from a 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.
Set NOSEARCHALL =
Prevent automatic linking of WikiWords and acronyms (if set to on); link WikiWords (if empty); can be overwritten by web preferences:
Set NOAUTOLINK =
Note: Use the [[...][...]] 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.
Warn if %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{}% :
Do not show a TOC if the topic it contains is included in another topic:
Set TOC_HIDE_IF_INCLUDED =
If not set: included TOC is shown
Possible values: on or nothing
Default User Settings
NOTE: They are typically redefined in the individual users topic. eg. WikiGuest.
Show tool-tip topic info on mouse-over of WikiWord links. Setting can be on, off, or customized. An empty setting or off setting disables the tool-tips (for better performance). The setting can contain $summary to show the topic summary, $date for the last change date, $rev for the revision, $username for the login name of the last editor, $wikiname for the WikiName, $wikiusername for Main.WikiName, $topic for the topic name, and $web for the web name
These settings are overridden by an editor cookie that is set when using the
Sizing and font buttons on the lower right corner of the edit window. These
settings will be ignored once a FOSWIKIPREF cooke has been set. They have
been removed from Foswiki 2.0.
Horizontal size of text edit box: (can be overwritten by user preferences)
Set EDITBOXWIDTH = 70
Vertical size of text edit box: (can be overwritten by user preferences)
Set EDITBOXHEIGHT = 22
Style of text edit box. Set to 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)
Default state of the Force New Revision check box in preview. Check box is initially checked if Set FORCENEWREVISIONCHECKBOX = checked="checked", or unchecked if empty: (can be overwritten by user preferences)
Set FORCENEWREVISIONCHECKBOX =
Default state of the Minor Changes, Don't Notify check box in preview. Check box is initially checked if Set DONTNOTIFYCHECKBOX = checked="checked", or unchecked if empty: (can be overwritten by user preferences)
Set DONTNOTIFYCHECKBOX =
Default state of the link check box in the attach file page. Checkbox is initially checked if 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)
Set ATTACHLINKBOX =
Format of file link when the link check box is checked: (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 = \n * [[%ATTACHURL%/$fileurl][$filename]]: $comment
Format of images when the link check box is checked: (can be overwritten by user preferences)
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 \n to linefeed (3 spaces for bullets).
Image, URL and alternate tooltip text of the logo for this installation: you should change these settings for your site, or they can be overwridden in WebPreferences for individual webs by defining these settings there.
Broadcast message for skins supporting a %BROADCASTMESSAGE% at the top of the page: (IMPORTANT: Set to empty message if not used; #Comment out unused messages)
Set BROADCASTMESSAGE =
#Set BROADCASTMESSAGE = NOTE: Edit and Attach will be disabled today between 05:00 PM and 06:00 PM PDT (00:00 to 01:00 GMT) for a scheduled Foswiki maintenance.
Note: if you need to block all user access (view included) the easiest way it to change the configureAccessControl option to AdminOnlyAccess (see the Security and Authentication section)
Default type for search bin script, one of: keyword (for search engine like syntax), regex (for RegularExpression search), or literal (for verbatim search). It does not influence the default for the WebSearch
Set SEARCHDEFAULTTTYPE = keyword
Default for %SEARCH{}% macro, one of: keyword, regex, or literal
Set SEARCHVARDEFAULTTYPE = literal
Stop words, e.g., common words and characters to exclude from a keyword search:
Set SEARCHSTOPWORDS = a, all, am, an, and, any, as, at, b, be, by, c, d, e, for, from, g, h, how, i, i'm, i.e., in, is, isn't, it, it's, its, j, k, l, m, n, o, of, on, or, p, q, r, s, t, that, that's, the, this, to, u, v, w, was, wasn't, what, what's, when, where, who, who's, will, with, x, y, z
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
Set REGISTRATIONGROUPTYPE = none
If REGISTRATIONGROUPS is set to a comma separated list of groups, only those listed groups will be shown in the UserRegistration form. If it is unset, then group change permissions will be used to create the list of groups eligible for selection during registration. (When using "self-registration" by guest users, the RegistrationAgent's permissions are used. If the registration is entered by another logged in user, that user's permissions are used).
#Set REGISTRATIONGROUPS =
Implementation Notes:
If the RegistrationAgent or logged in user does not have permission to change one of the listed groups, then that group will be silently skipped. The user will not be added to the group.
Group permissions are stored in Topic Settings, not inline in the group topic. Edit the Group Topic Settings to change permissions.
Change of Password Message
If password management is not handled by Foswiki, this message will be displayed on ChangePassword and ResetPassword. If email is disabled, it will also be displayed on ResetPassword. Replace this generic text with a reference to how to change or reset password within your organisation.
Set CHANGEPASSWORDDISABLEDMESSAGE = Resetting and setting password is not available.
HTTP-EQUIV Settings
NOTE: Changing cache behaviour with these settings should not be necessary and may cause cache-related problems. These settings do not affect proxy caches.
NOTE: The current values of these preferences are not displayed in view mode (values are <link>-tags).
http-equiv meta tags for view, rdiff, attach, search* scripts:
#Set HTTP_EQUIV_ON_VIEW =
Set HTTP_EQUIV_ON_VIEW =
http-equiv meta tags for edit script:
Set HTTP_EQUIV_ON_EDIT =
http-equiv meta tags for preview script:
Set HTTP_EQUIV_ON_PREVIEW =
Extension Settings
Skin overriding the default templates: (can be overwritten by WebPreferences and user preferences)
Set SKIN = natedit,pattern
Note: See SkinBrowser for currently installed skins
JQuery
List of Foswiki preferences, the values of which are made available through the foswiki.getPreference() javascript function. Note: Plugin authors can extend this list in their initPlugin using the following simple code fragment. Say you want to add 'MYPREF' to the list:
Set PATTERNSKIN_THEME = /pub/System/PatternSkinTheme/variant_foswiki_noframe.css
Overriding styles that add upon the global and theme styles. Enabled by default but empty to prevent browsers from fetching %USERLAYOUTURL%-style URLs.
Set USERLAYOUTURL =
Set USERSTYLEURL =
Set USERCOLORSURL =
Top bar background image and color
Set WEBHEADERART = /pub/System/PatternSkin/header5.gif
Set WEBHEADERBGCOLOR = #ffffff
Skin icons
Topic containing the icon graphics library. Icons can easily be rendered with %ICON{name}%.
Support for MAINWEB which is often used in older legacy webs that have been upgraded to Foswiki
Set MAINWEB = Main
Plugins Settings
You can enable/disable Plugins using the configure interface.
You can also disable installed plugins in individual webs/topics by defining the DISABLEDPLUGINS preference setting to be a list of plugins to disable e.g.
Broadcast message for skins supporting a %BROADCASTMESSAGE% at the top of the page: (IMPORTANT: Set to empty message if not used; #Comment out unused messages)
Set BROADCASTMESSAGE =
#Set BROADCASTMESSAGE = NOTE: Edit and Attach will be disabled today between 05:00 PM and 06:00 PM PDT (00:00 to 01:00 GMT) for a scheduled Foswiki maintenance.
Note: if you need to block all user access (view included) the easiest way it to change the configureAccessControl option to AdminOnlyAccess (see the Security and Authentication section)
Default type for search bin script, one of: keyword (for search engine like syntax), regex (for RegularExpression search), or literal (for verbatim search). It does not influence the default for the WebSearch
Set SEARCHDEFAULTTTYPE = keyword
Default for %SEARCH{}% macro, one of: keyword, regex, or literal
Set SEARCHVARDEFAULTTYPE = literal
Stop words, e.g., common words and characters to exclude from a keyword search:
Set SEARCHSTOPWORDS = a, all, am, an, and, any, as, at, b, be, by, c, d, e, for, from, g, h, how, i, i'm, i.e., in, is, isn't, it, it's, its, j, k, l, m, n, o, of, on, or, p, q, r, s, t, that, that's, the, this, to, u, v, w, was, wasn't, what, what's, when, where, who, who's, will, with, x, y, z
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
Set REGISTRATIONGROUPTYPE = none
If REGISTRATIONGROUPS is set to a comma separated list of groups, only those listed groups will be shown in the UserRegistration form. If it is unset, then group change permissions will be used to create the list of groups eligible for selection during registration. (When using "self-registration" by guest users, the RegistrationAgent's permissions are used. If the registration is entered by another logged in user, that user's permissions are used).
#Set REGISTRATIONGROUPS =
Implementation Notes:
If the RegistrationAgent or logged in user does not have permission to change one of the listed groups, then that group will be silently skipped. The user will not be added to the group.
Group permissions are stored in Topic Settings, not inline in the group topic. Edit the Group Topic Settings to change permissions.
Change of Password Message
If password management is not handled by Foswiki, this message will be displayed on ChangePassword and ResetPassword. If email is disabled, it will also be displayed on ResetPassword. Replace this generic text with a reference to how to change or reset password within your organisation.
Set CHANGEPASSWORDDISABLEDMESSAGE = Resetting and setting password is not available.
HTTP-EQUIV Settings
NOTE: Changing cache behaviour with these settings should not be necessary and may cause cache-related problems. These settings do not affect proxy caches.
NOTE: The current values of these preferences are not displayed in view mode (values are <link>-tags).
http-equiv meta tags for view, rdiff, attach, search* scripts:
#Set HTTP_EQUIV_ON_VIEW =
Set HTTP_EQUIV_ON_VIEW =
http-equiv meta tags for edit script:
Set HTTP_EQUIV_ON_EDIT =
http-equiv meta tags for preview script:
Set HTTP_EQUIV_ON_PREVIEW =
Extension Settings
Skin overriding the default templates: (can be overwritten by WebPreferences and user preferences)
Set SKIN = natedit,pattern
Note: See SkinBrowser for currently installed skins
JQuery
List of Foswiki preferences, the values of which are made available through the foswiki.getPreference() javascript function. Note: Plugin authors can extend this list in their initPlugin using the following simple code fragment. Say you want to add 'MYPREF' to the list:
Set PATTERNSKIN_THEME = /pub/System/PatternSkinTheme/variant_foswiki_noframe.css
Overriding styles that add upon the global and theme styles. Enabled by default but empty to prevent browsers from fetching %USERLAYOUTURL%-style URLs.
Set USERLAYOUTURL =
Set USERSTYLEURL =
Set USERCOLORSURL =
Top bar background image and color
Set WEBHEADERART = /pub/System/PatternSkin/header5.gif
Set WEBHEADERBGCOLOR = #ffffff
Skin icons
Topic containing the icon graphics library. Icons can easily be rendered with %ICON{name}%.
Support for MAINWEB which is often used in older legacy webs that have been upgraded to Foswiki
Set MAINWEB = Main
Plugins Settings
You can enable/disable Plugins using the configure interface.
You can also disable installed plugins in individual webs/topics by defining the DISABLEDPLUGINS preference setting to be a list of plugins to disable e.g.
%RED% red text %ENDCOLOR% and %GREEN% green text %ENDCOLOR%
You get:
red text and green text
Note:%<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 = looks like this
Set ORANGE = looks like this
Set RED = looks like this
Set PINK = looks like this
Set PURPLE = looks like this
Set TEAL = looks like this
Set NAVY = looks like this
Set BLUE = looks like this
Set AQUA = looks like this
Set LIME = looks like this
Set GREEN = looks like this
Set OLIVE = looks like this
Set MAROON = looks like this
Set BROWN = looks like this
Set BLACK = looks like this
Set GRAY = looks like this
Set SILVER = looks like this
Set WHITE = looks like this (with gray background)
The following color settings are enclosed in verbatim tags to avoid incorrect nesting of XHTML tags, and in sticky to prevent wrapping of the closing verbatim.
* 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>
Note that $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.
Note that any configuration variable accessed via QUERY must be included in the
definition of {AccessibleCFG} in configure (expert setting)
Set NAMEFILTER = [\\\s*?~^$@%`"'&|<:;>\[\]#\x00-\x1f]
Creating New Preference Settings
You can introduce new preference settings and use them in your topics and templates. There is no need to change the Foswiki engine (Perl scripts).
A preference is defined in a bullet item: [3 spaces] * [space] Set NAME = value Example (as a nested bullet item, indented 6 spaces):
Set WEBBGCOLOR = #FFFFC0
Preferences are used as Macros by enclosing the name in percent signs: %. Example:
When you write %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.
Protected System Settings
The following macros are declared final to protect them as read only. These are system macros that should
never be attempted set or altered in any preference topic or topic settings.
Note:%<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 = looks like this
Set ORANGE = looks like this
Set RED = looks like this
Set PINK = looks like this
Set PURPLE = looks like this
Set TEAL = looks like this
Set NAVY = looks like this
Set BLUE = looks like this
Set AQUA = looks like this
Set LIME = looks like this
Set GREEN = looks like this
Set OLIVE = looks like this
Set MAROON = looks like this
Set BROWN = looks like this
Set BLACK = looks like this
Set GRAY = looks like this
Set SILVER = looks like this
Set WHITE = looks like this (with gray background)
The following color settings are enclosed in verbatim tags to avoid incorrect nesting of XHTML tags, and in sticky to prevent wrapping of the closing verbatim.
* 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>
Note that $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.
Note that any configuration variable accessed via QUERY must be included in the
definition of {AccessibleCFG} in configure (expert setting)
Set NAMEFILTER = [\\\s*?~^$@%`"'&|<:;>\[\]#\x00-\x1f]
Creating New Preference Settings
You can introduce new preference settings and use them in your topics and templates. There is no need to change the Foswiki engine (Perl scripts).
A preference is defined in a bullet item: [3 spaces] * [space] Set NAME = value Example (as a nested bullet item, indented 6 spaces):
Set WEBBGCOLOR = #FFFFC0
Preferences are used as Macros by enclosing the name in percent signs: %. Example:
When you write %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.
Protected System Settings
The following macros are declared final to protect them as read only. These are system macros that should
never be attempted set or altered in any preference topic or topic settings.