Foswiki Site-Level Preferences

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 SitePreferences (this topic is pointed to by {LocalSitePreferences}, which is set by the admin in the configure interface). Settings in SitePreferences will override settings in this topic, and should be used for defining custom settings. Read more on how to set preferences.

Default Web Preferences

NOTE: These are just defaults; don't change them here. Instead, add them to the WebPreferences topic in each web

• Web-specific background color: (is overwritten by web preferences)
  • Set WEBBGCOLOR = #ffcc99

• favicon: Attach a favicon.ico to a web's WebPreferences or add a FAVICON setting to WebPreferences
  • Set FAVICON = /foswiki/pub/System/ProjectLogos/favicon.ico

• Image, URL and alternate tooltip text of web's logo.
  • Set WEBLOGOIMG =
  • Set WEBLOGOURL = https://nkwiki.de/foswiki/bin/view/Main/WebHome
  • Set WEBLOGOALT = Powered by Foswiki, The Free and Open Source Wiki

• List this web in the SiteMap:
  • 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.
  • Set SITEMAPLIST = on
  • Set WEBSUMMARY =

• Copyright notice:
  • Set WEBCOPYRIGHT = Copyright &© by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
    Ideas, requests, problems regarding Foswiki? Send feedback

• Simplified Copyright notice for the WebRss feed (don't use any special characters, html tags, entities, wiki markup or WikiWords)
  • Set WEBRSSCOPYRIGHT = Copyright 2025 by contributing authors

• 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{}%:
  • Set INCLUDEWARNING = on

Default User Settings

NOTE: They are typically redefined in topics of individual WikiUsers

• 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
  • Set LINKTOOLTIPINFO = off
  • #Set LINKTOOLTIPINFO = $username - $date - r$rev: $summary
    • This is exactly equivalent to:
  • #Set LINKTOOLTIPINFO = on

• 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: autoto disable. This setting works for IE and some other recent browsers. (can be overwritten by user preferences)
  • Set EDITBOXSTYLE = width:99%

• Style of the user signature
  • Set SIGNATUREFORMAT = -- Main.WikiGuest - 06 May 2025

• Work-around for sluggish/erratic wikitext editing in Internet Explorer 8. When this browser is in standards mode, at least some versions suffer sluggish response to keystrokes and erratic scrolling. For skins that are aware of it, this setting forces IE8 into compatibility mode for the edit template only.
  • Set EDIT_FORCE_IE8_COMPATIBILITYMODE = on

• Default state of the Force New Revision (ForceNewRevision) 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 (DontNotify) 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).

        * Set ATTACHEDIMAGEFORMAT = \n   * $comment: 
  \n     

Platform Settings

• Site name:
  • Set WIKITOOLNAME = Foswiki

• 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.
  • Set WIKILOGOIMG =
  • Set WIKILOGOURL = https://nkwiki.de/foswiki/bin/view/Main/WebHome
  • Set WIKILOGOALT = Powered by Foswiki, The Free and Open Source Wiki

• Home page of this site
  • Set WIKIHOMEURL = /foswiki/bin/view

• List of Foswiki webs - on the first line of the upper toolbar (to add a new web, see ManagingWebs and SiteMap):
  • Set WIKIWEBLIST = Main | System | Sandbox
  • NOTE: To automatically list all non-hidden webs in alphabetical order, use the %WEBLIST{}% macro instead:
    Applications | Applications.ClassificationApp | Extensions | Main | System

• Maximum size of FileAttachments in KB, 0 for no limit:
  • Set ATTACHFILESIZELIMIT = 10000

• 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.

• Users or groups allowed to create new top-level webs: (ex: WebCreatorsGroup?). If set to nothing, only administrators will be able to do this.
  • Set ALLOWROOTCHANGE = AdminGroup

Search Settings

• 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

E-mail Settings

• 'Mail this topic' mailto: link - can be included in topics, templates or skins
  • Set MAILTHISTOPIC = Send a link to this page

• 'Mail this topic' link text
  • Set MAILTHISTOPICTEXT = Send a link to this page

• URL for current topic
  • Set TOPICURL = https://nkwiki.de/foswiki/bin/view/System/DefaultPreferences

Registration configuration options

Add user to group during registration

• Users can be automatically added to the Groups (by setting to automatic), or Users can select one of the Groups (by setting to one) or Users can select Multiple Groups to join when they register (by setting to multiple) or The Add user to Groups feature can be disabled (by setting to none)
  • Set REGISTRATIONGROUPTYPE = none
• If REGISTRATIONGROUPS below can be set to a comma separated list of Groups, to be shown on the registration topic. If it is unset, then Group change permissions will be used to create the list of groups a user can be added to (for guest driven registration the RegistrationAgent? 's permissions are used, for logged in user registration of someone else, that user's permissions are used).
  • #Set REGISTRATIONGROUPS =

Change of Password Message

• If password management is not handled by Foswiki this message will be displayed on ChangePassword and 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 handled by Foswiki

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 -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 editscript:
  • Set HTTP_EQUIV_ON_EDIT =

• http-equiv meta tags for previewscript:
  • Set HTTP_EQUIV_ON_PREVIEW =

Extension Settings

• Skin overriding the default templates: (can be overwritten by WebPreferences and user preferences)
  • Set SKIN = 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:

      my $pref = Foswiki::Func::getPreferencesValue('EXPORTEDPREFERENCES')||'';
      my @list = split(/[,\s]+/, $pref);
      unless (grep { /^MYPREF$/ } @list) {
          push(@list, 'MYPREF');
      }
      Foswiki::Func::setPreferencesValue(
          'EXPORTEDPREFERENCES', join(',', @list));
      

• Set EXPORTEDPREFERENCES = PUBURL, PUBURLPATH, SCRIPTSUFFIX, SCRIPTURL, SCRIPTURLPATH, SERVERTIME, SKIN, SYSTEMWEB, TOPIC, USERNAME, USERSWEB, WEB, WIKINAME, WIKIUSERNAME, NAMEFILTER

PatternSkin

• Global skin styles. To change the look of the site, point these variables to custom CSS attachments.
  • Set FOSWIKI_LAYOUT_URL = /foswiki/pub/System/PatternSkinTheme/layout.css
  • Set FOSWIKI_STYLE_URL = /foswiki/pub/System/PatternSkinTheme/style.css
  • Set FOSWIKI_COLORS_URL = /foswiki/pub/System/PatternSkinTheme/colors.css

• Themes that add upon the global skin styles. See the Theme Browser in PatternSkin.
  • Set PATTERNSKIN_THEME_VARIANT = /foswiki/pub/System/PatternSkinTheme/variant_foswiki_noframe.css
  • Set PATTERNSKIN_COLUMNS = /foswiki/pub/System/PatternSkinTheme/column_left.css
  • #Set PATTERNSKIN_NAVIGATION_TOPIC = PatternSkinHorizontalNavigationExample
• Deprecated (use PATTERNSKIN_THEME_VARIANT):
  • Set PATTERNSKIN_THEME = /foswiki/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 = /foswiki/pub/System/PatternSkin/header5.gif
  • Set WEBHEADERBGCOLOR = #ffffff

Skin icons

• Topic containing the icon graphics library. Icons can easily be rendered with %ICON{name}%.
  • Set ICONTOPIC = DocumentGraphics
  • to use the Foswiki 1.0 iconset, set the ICONTOPIC to DocumentGraphics

TinyMCEPlugin

• Topic containing a section? named INITwhich will hold the default initialisation parameters for the TinyMCE editor.
  • #Set TINYMCEPLUGIN_INIT_TOPIC = TinyMCEPlugin

    Not set in this topic, the plugin assumes this value if missing

TwistyPlugin

• Show/hide animation speed: 'fast', 'slow', or integer milliseconds | 0(no animation)
  • Set TWISTYPLUGIN_TWISTYANIMATIONSPEED = fast

Legacy support

• Support for legacy "EDITTOPIC", used to be hard-coded, now replaced by TMPL:P conditional instantiation
  • Set EDITURL = /foswiki/bin/edit/System/DefaultPreferences?t=1746534861
  • Set EDITTOPIC = Edit
• 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 settingto be a list of plugins to disable e.g.
  • Set DISABLEDPLUGINS = SpreadSheetPlugin,EditTablePlugin
  • Currently, %DISABLEDPLUGINS% is set to "%DISABLEDPLUGINS%"
• Currently activated Plugins: TWikiCompatibilityPlugin, SpreadSheetPlugin, AutoCompletePlugin, AutoViewTemplatePlugin, BreadCrumbsPlugin, ClassificationPlugin, CommentPlugin, CompareRevisionsAddonPlugin, DBCachePlugin, EditTablePlugin, FilterPlugin, FlexFormPlugin, FlexWebListPlugin, FootNotePlugin, GluePlugin, HistoryPlugin, IfDefinedPlugin, ImageGalleryPlugin, ImagePlugin, InterwikiPlugin, JQGridPlugin, JQueryPlugin, MailerContribPlugin, MediaPlugin, MetaDataPlugin, PatchFoswikiContribPlugin?, PreferencesPlugin, PublishPlugin, RedirectPlugin, RenderListPlugin, RenderPlugin, SlideShowPlugin, SmiliesPlugin, TablePlugin, TagMePlugin, TinyMCEPlugin, TopicCreatePlugin, TopicDataHelperPlugin, TreeBrowserPlugin, TreePlugin, TwistyPlugin, WysiwygPlugin

• NOTE: You can enable/disable Plugins by passing a comma-separated list of Plugin names in the debugenableplugins url parameter; for example, https://nkwiki.de/foswiki/bin/view/System/DefaultPreferences?debugenableplugins=SmiliesPlugin will display this topic with all Plugins disabled except the SmiliesPlugin.
• Detailed diagnostics can be found in InstalledPlugins
• Legacy settings:
  • Set INSTALLEDPLUGINS = The INSTALLEDPLUGINS macro is no longer supported. You can set the Plugins execution order using the configure interface.

Rendering Shortcuts Settings

• Line break: Note that the setting has an intentional trailing space
  • Set BR =
    

• Clear floats:
  • Set CLEAR =

• Bullet sign:
  • Set BULLET = •

• Vertical bar / pipe symbol:
  • Set VBAR = |

• Vertical caret symbol:
  • Set CARET = ^

• Line break and bullet with different levels of indentation:
  • Set BB =
    •
  • Set BB2 =
    •
  • Set BB3 =
    •
  • Set BB4 =
    •

• Hint: Above shortcuts are useful in tables where you cannot use newlines

• Macros for graphics used in documentation - view all images in DocumentGraphics:
  • Set H =
  • Set I =
  • Set M =
  • Set N =
  • Set P =
  • Set Q =
  • Set S =
  • Set T =
  • Set U =
  • Set X =
  • Set Y =

• Colored text: (see more StandardColors)

• • Note: %% 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:

      * Set YELLOW = 
      * Set ORANGE = 
      * Set RED = 
      * Set PINK = 
      * Set PURPLE = 
      * Set TEAL = 
      * Set NAVY = 
      * Set BLUE = 
      * Set AQUA = 
      * Set LIME = 
      * Set GREEN = 
      * Set OLIVE = 
      * Set MAROON = 
      * Set BROWN = 
      * Set BLACK = 
      * Set GRAY = 
      * Set SILVER = 
      * Set WHITE = 
      * Set ENDCOLOR =