TWiki/WebPreferences.mdwn

   1 ## <a name="%WEB% Web Preferences"></a> %WEB% Web Preferences
   2
   3 The following settings are **_web preferences_** of the [[%WEB%|WEB/WebHome]] 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|Main/WebHome]] web).
   4
   5 **_Preferences:_**
   6
   7 - List of topics of the %WIKITOOLNAME%.%WEB% web:
   8   - Set WEBTOPICLIST = [[Home|Main/WebHome]] | [[Welcome|Main/WelcomeGuest]] | [[Register|Main/TWikiRegistration]] | [[Changes|Main/WebChanges]] | [[Topics|Main/WebTopicList]] | [[Index|Main/WebIndex]] | [[Search|Main/WebSearch]] | Go <input name="topic" size="16" type="text" />
   9
  10 - List this web in the [[SiteMap]]:
  11   - 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. %WEB%.Topic links.
  12   - Set SITEMAPLIST = on
  13   - Set SITEMAPWHAT = [[Welcome|WEB/WelcomeGuest]], [[Registration|WEB/TWikiRegistration]], and other %WEB%.StartingPoints; TWiki history &amp; Wiki style; All the docs...
  14   - Set SITEMAPUSETO = ...discover TWiki details, and how to start your own site.
  15
  16 - Web specific background color: (Pick a lighter one of the [[StandardColors]])
  17   - Set WEBBGCOLOR = #FFE0B0
  18
  19 - Exclude web from a `web="all"` search: (Set to `on` for hidden webs)
  20   - Set NOSEARCHALL =
  21
  22 - Default template for new topics and form(s) for this web:
  23   - [[WebTopicEditTemplate]]: Site-level default template for new topics
  24   - [[TWikiForms]]: How to enable form(s)
  25   - Set WEBFORMS =
  26
  27 - Users or groups who **_are not_** / **_are_** allowed to **_view_** / **_change_** / **_rename_** topics in the %WEB% web: (See [[TWikiAccessControl]])
  28   - Set DENYWEBVIEW =
  29   - Set ALLOWWEBVIEW =
  30   - Set DENYWEBCHANGE =
  31   - Set ALLOWWEBCHANGE =
  32   - Set DENYWEBRENAME =
  33   - Set ALLOWWEBRENAME =
  34
  35 - Users or groups allowed to change or rename this %TOPIC% topic: (I.e. [[TWikiAdminGroup]])
  36   - Set ALLOWTOPICCHANGE =
  37   - Set ALLOWTOPICRENAME =
  38
  39 - Web preferences that are **not** allowed to be overridden by user preferences:
  40   - Set FINALPREFERENCES = WEBTOPICLIST, DENYWEBVIEW, ALLOWWEBVIEW, DENYWEBCHANGE, ALLOWWEBCHANGE, DENYWEBRENAME, ALLOWWEBRENAME
  41
  42 **_Notes:_**
  43
  44 - A preference is defined as: <br />`6 spaces * Set NAME = value`<br /> Example:
  45   - Set WEBBGCOLOR = #FFFFC0
  46 - Preferences are used as [[TWikiVariables]] by enclosing the name in percent signs. Example:
  47   - When you write variable `%WEBBGCOLOR%` , it gets expanded to `%WEBBGCOLOR%` .
  48 - 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.
  49 - 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).
  50
  51 **_Related Topics:_**
  52
  53 - [[TWikiPreferences]] has site-level preferences.
  54 - [[TWikiUsers]] has a list of user topics. User topics can have optional user preferences.
  55 - [[TWikiVariables]] has a list of common `%VARIABLES%`.
  56 - [[TWikiAccessControl]] explains how to restrict access by users or groups.