TWiki Web Preferences

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

Preferences:

  • List this web in the SiteMap:
    • If yes, Set SITEMAPLIST = on, 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. TWiki.Topic links.
    • Set SITEMAPLIST = on
    • Set SITEMAPWHAT = Welcome, Registration, and other StartingPoints; TWiki history & Wiki style; All the docs...
    • Set SITEMAPUSETO = ...discover TWiki details, and how to start your own site.

  • Web specific background color: (Pick a lighter one of the StandardColors)
    • Set WEBBGCOLOR = #FFE0B0

  • Exclude web from a web="all" search: (Set to on for hidden webs)
    • Set NOSEARCHALL =

  • Default template for new topics and form(s) for this web:

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

  • Users or groups allowed to change or rename this WebPreferences topic: (I.e. TWikiAdminGroup)
    • Set ALLOWTOPICCHANGE =
    • Set ALLOWTOPICRENAME =

  • Web preferences that are not allowed to be overridden by user preferences:
    • Set FINALPREFERENCES = WEBTOPICLIST, DENYWEBVIEW, ALLOWWEBVIEW, DENYWEBCHANGE, ALLOWWEBCHANGE, DENYWEBRENAME, ALLOWWEBRENAME

Notes:

  • A preference is defined as:
    6 spaces * Set NAME = value
    Example:
    • Set WEBBGCOLOR = #FFFFC0
  • 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 new preferences variables and use them in your topics and templates. There is no need to change the TWiki engine (Perl scripts).

Related Topics:


This topic: TWiki > WebPreferences
Topic revision: r14 - 2002-05-12 - MikeMannix
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 1999-2024 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.