TWiki/WebPreferences.mdwn

   1 **%WIKITOOLNAME%.%WEB% Web Preferences**
   2
   3 The following settings are **_web preferences_** of the %WIKITOOLNAME%.%WEB% web. These preferences overwrite the **_site-level preferences_** in [[TWikiPreferences]], and can be overwritten by **_user preferences_** (your personal topic, i.e. [[TWikiGuest]] in the %WIKITOOLNAME%.Main web)
   4
   5 **_Preferences:_**
   6
   7 - List of topics of the %WIKITOOLNAME%.%WEB% web:
   8   - Set WEBTOPICLIST = %WEB% . \{ [Home](WebHome) | [Welcome](WelcomeGuest) | [Register](TWikiRegistration) | [Changes](WebChanges) | [Index](WebIndex) | [Search](WebSearch) | Go <input name="topic" size="16" type="text" />
   9  \}
  10
  11 - Web specific background color: (Pick a lighter one of the [[StandardColors]])
  12   - Set WEBBGCOLOR = #FFE0B0
  13
  14 - Exclude web from a `web="all"` search: (Set to `on` for hidden webs)
  15   - Set NOSEARCHALL =
  16
  17 - Users or groups who **_are not_** / **_are_** allowed to change topics in the %WEB% web: (See [[TWikiAccessControl]])
  18   - Set DENYWEBCHANGE = [[TWikiGuest]]
  19   - Set ALLOWWEBCHANGE =
  20
  21 - Users or groups allowed to change this %TOPIC% topic: (I.e. [[TWikiAdminGroup]])
  22   - Set ALLOWTOPICCHANGE =
  23
  24 - Web preferences that are **not** allowed to be overridden by user preferences:
  25   - Set FINALPREFERENCES = WEBTOPICLIST, DENYWEBVIEW, ALLOWWEBVIEW, DENYWEBCHANGE, ALLOWWEBCHANGE
  26
  27 **_Notes:_**
  28
  29 - A preference is defined as: <br />`6 spaces * Set NAME = value`<br /> Example:
  30   - Set WEBBGCOLOR = #FFFFC0
  31 - Preferences are used as [[TWikiVariables]] by enclosing the name in percent signs. Example:
  32   - When you write variable `%WEBBGCOLOR%` , it gets expanded to `%WEBBGCOLOR%` .
  33 - 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.
  34 - You can introduce new preferences variables and use them in your topics and templates. There is no need to change the %WIKITOOLNAME% engine (Perl scripts).
  35
  36 **_Related Topics:_**
  37
  38 - [[TWikiPreferences]] has site-level preferences.
  39 - [[TWikiUsers]] has a list of user topics. User topics can have optional user preferences.
  40 - [[TWikiVariables]] has a list of common `%VARIABLES%` .
  41 - [[TWikiAccessControl]] explains how to restrict access by users or groups.