Main/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) | [Users](TWikiUsers) | [Offices](OfficeLocations) | [Changes](WebChanges) | [Index](WebIndex) | [Search](WebSearch) | Go <input name="topic" size="16" type="text" />
   9  \}
  10
  11 - Web specific background color:
  12   - Set WEBBGCOLOR = #FFFFC0
  13
  14 - Exclude web from a `web="all"` search: (Set to `on` for hidden webs)
  15   - Set NOSEARCHALL =
  16
  17 **_Notes:_**
  18
  19 - A preference is defined as: <br />`6 spaces * Set NAME = value`<br /> Example:
  20   - Set WEBBGCOLOR = #FFFFC0
  21 - Preferences are used as [[TWikiVariables]] by enclosing the name in percent signs. Example:
  22   - When you write variable `%WEBBGCOLOR%` , it gets expanded to `%WEBBGCOLOR%` .
  23 - 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.
  24 - 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).
  25
  26 **_Related Topics:_**
  27
  28 - [[TWikiPreferences]] has site-level preferences.
  29 - [[TWikiUsers]] has a list of user topics. User topics can have optional user preferences.
  30 - [[TWikiVariables]] has a list of common `%VARIABLES%` .