TWiki Web Preferences

The following settings are web preferences of the TWiki web. These preferences overwrite the site-level preferences in TWiki.TWikiPreferences and Main.TWikiPreferences, and can be overwritten by user preferences (your personal topic, eg: TWikiGuest in the Main web).

• • Set WEBBGCOLOR = #FFD8AA
  • Set WEBHEADERART = /wiki/twiki-6.1.0/pub/TWiki/WebPreferences/Dakar.gif
  • Set SITEMAPLIST = on

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

• Default template for new topics for this web:
  • WebTopicEditTemplate: Site-level default topic template

• • Set WEBFORMS = TWikiPreferencesForm

• Copyright notice for the TWiki web.
  • Set WEBCOPYRIGHT = Copyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
    Ideas, requests, problems regarding TWiki? Send feedback
    Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.WebPreferences

• Users or groups who are not / are allowed to view / change / rename topics in the TWiki web: (See TWikiAccessControl).

• • Set ALLOWWEBRENAME = TWikiAdminGroup

• Users or groups allowed to change or rename this WebPreferences topic: (e.g., WebAdministratorsGroup)

Help on Preferences

• A preference setting is defined by:
  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 customization. Example:
  
  • #Set DENYWEBCHANGE = UnknownUser
• Preferences are used as TWikiVariables by enclosing the name in percent signs. Example:
  • When you write variable %WEBBGCOLOR% , it gets expanded to #FFD8AA
• The sequential order of the preference settings is significant. Define preferences that use other preferences first, i.e. set WEBCOPYRIGHT before WIKIWEBMASTER since %WEBCOPYRIGHT% uses the %WIKIWEBMASTER% variable.
• You can introduce your own preferences variables and use them in your topics and templates.

Related Topics

• TWiki.TWikiPreferences, Main.TWikiPreferences - site-level preferences
• UserList - list of user topics. User topics can have optional user preferences
• TWikiVariables - list of common %VARIABLES%
• TWikiAccessControl - explains how to restrict access by users or groups

Rename, Move or Delete this Web