Skip to topic | Skip to bottom
Home

Start of topic | Skip to actions

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:

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

  • 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 = The TWiki system web of the open software release site http://www.vtf.website/asc
    • Set SITEMAPUSETO = System web of the release site

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

  • Prevent automatic linking of WikiWords? and acronyms (if set to on); link WikiWords (if empty); can be overwritten by web preferences:
    • Set NOAUTOLINK =
    • Note: Use the [[...][...]] syntax to link topics in case you disabled WikiWord linking. The <noautolink> ... </noautolink> syntax can be used to prevents links within a block of text.

  • Default template for new topics and form(s) for this web:
    • WebTopicEditTemplate: Site-level default template for new topics
    • TWikiForms?: How to enable form(s)
    • Set WEBFORMS =

  • 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 = TWikiAdminGroup?
    • Set DENYWEBRENAME =
    • Set ALLOWWEBRENAME = TWikiAdminGroup?

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

  • Web preferences that are not allowed to be overridden by user preferences:
    • Set FINALPREFERENCES = NOSEARCHALL, ATTACHFILESIZELIMIT, WIKIWEBMASTER, WEBCOPYRIGHT, 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:

  • TWikiPreferences has site-level preferences.
  • TWikiUsers? has a list of user topics. User topics can have optional user preferences.
  • TWikiVariables? has a list of common %VARIABLES%.
  • TWikiAccessControl? explains how to restrict access by users or groups.

You are here: TWiki > WebPreferences

to top

Copyright © 1997-2019 California Institute of Technology.