TWiki Web Preferences

Web Preferences Settings

These settings override the defaults for this web only. See full list of defaults with explanation.

• Web settings:
  • Set WEBTOPICLIST = Welcome | Register | Changes | Topics | Index | Search | Go
  • Set WEBBGCOLOR = #FFD8AA
  • Set WEBHEADERART = /pub/TWiki/WebPreferences/Dakar.gif
  • Set SITEMAPLIST = on
  • Set SITEMAPWHAT = TWiki documentation, welcome guest and user registration
  • 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 TWiki documentation pages:
    • Set NOAUTOLINK = 0

• Default template for new topics in this web:
  • WebTopicEditTemplate: System-level default topic template (do not modify! Create a site-level template in the %USERS% web instead)
  • Main.WebTopicEditTemplate: Site-level default topic template (if it exists, it overides the system-level template for topics created in webs other than the TWiki web)

• Copyright notice for the TWiki web.
  • Set WEBCOPYRIGHT = Copyright © 1999-2025 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.

Access Control and Security

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

• Users or groups allowed to change or rename this WebPreferences topic:
  • Set ALLOWTOPICCHANGE = TWikiAdminGroup
  • Set ALLOWTOPICRENAME = NobodyGroup

• 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, DENYWEBRENAME, ALLOWWEBRENAME

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

Revision r34 - 2015-09-18 - 01:15:25 - TWikiContributor

Edit