Welcome, Registration, and other StartingPoints; Foswiki history & Wiki style; All the docs...
Restore | Raw | History | First | Previous | Next | Last | Close
You are here: System » WebPreferences

System Web Preferences

The following settings are web preferences of the System web. These preferences override the site-level preferences in DefaultPreferences and SitePreferences, and can be overwritten by user preferences (your personal topic, eg: WikiGuest in the Main web).

Web Preferences Settings

These preference settings override the defaults for this web and it's subwebs only.

  • Web settings:
    • Set WEBTOPICLIST = Welcome | Register | Changes | Topics | Index | Search | Go
    • Set WEBBGCOLOR = #FFD8AA
    • Set SITEMAPLIST = on
    • Set SITEMAPWHAT = Welcome, Registration, and other StartingPoints; Foswiki history & Wiki style; All the docs...
    • Set SITEMAPUSETO = ...discover Foswiki details, and how to start your own site.
    • Hide Table of Contents if the topic is included
      • Set TOC_HIDE_IF_INCLUDED = on
    • Set default Table of Contents title
      • Set TOC_TITLE = On this page:
    • The first header level to appear in the TOC:
      • Set TOC_MIN_DEPTH = 2
    • Use auto linking for the Foswiki documentation pages:
      • Set NOAUTOLINK = 0
  • Default template for new topics for this web:
  • Users or groups who are not / are allowed to view / change / rename topics in the System web: (See AccessControl).
  • Web preferences that are not allowed to be overridden by sub-web, user or topic preferences:
    • Set FINALPREFERENCES = NOSEARCHALL, ATTACHFILESIZELIMIT, WIKIWEBMASTER, WEBCOPYRIGHT, WEBTOPICLIST, DENYWEBVIEW, ALLOWWEBVIEW, DENYWEBCHANGE, ALLOWWEBCHANGE, ALLOWWEBRENAME, DENYWEBRENAME

Help on Preferences

  • A preference setting lets you define a simple Macro that can be expanded in your output.
  • A preference setting looks like this:
    3 or 6 spaces * Set NAME = value
    Example:
    • Set WEBBGCOLOR = #FFFFC0
  • A preferences setting can be disabled with a # sign. Remove the # sign to enable a local customisation. Example:
  • Macros defined using preference settings are expanded 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. i.e. set WEBCOPYRIGHT before WIKIWEBMASTER since %WEBCOPYRIGHT% uses the %WIKIWEBMASTER% setting.
  • You can introduce your own preference settings and use them in your topics and templates.
  • Preferences can be defined in a number of places:
    1. DefaultPreferences
    2. SitePreferences
    3. Parent webs WebPreferences
    4. WebPreferences
    5. In user topics
    6. In Plugin documentation topics
    7. In topics
  • Preference settings can be finalised, which means they can't be redefined

Tools

Related Topics

spacer
Copyright © 2014 Atomikos BVBA. Transaction Management for Extreme Transaction Processing and SOA Environments serving ISV, Commercial, OEM and Open Source Markets
Site map RSS ATOM