f7ae5e0df05f94f0a61d6cc86e56fece362e164a
[openafs-wiki.git] / 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 = [[Home|Main/WebHome]] | [[Welcome|Main/WelcomeGuest]] | [[Register|Main/TWikiRegistration]] | [[Changes|Main/WebChanges]] | [[Index|Main/WebIndex]] | [[Search|Main/WebSearch]] | Go <input name="topic" size="16" type="text" />
9
10 - Web specific background color: (Pick a lighter one of the [[StandardColors]])
11   - Set WEBBGCOLOR = #FFE0B0
12
13 - Exclude web from a `web="all"` search: (Set to `on` for hidden webs)
14   - Set NOSEARCHALL =
15
16 - Users or groups who **_are not_** / **_are_** allowed to change topics in the %WEB% web: (See [[TWikiAccessControl]])
17   - Set DENYWEBCHANGE =
18   - Set ALLOWWEBCHANGE =
19
20 - Users or groups allowed to change this %TOPIC% topic: (I.e. [[TWikiAdminGroup]])
21   - Set ALLOWTOPICCHANGE =
22
23 - Web preferences that are **not** allowed to be overridden by user preferences:
24   - Set FINALPREFERENCES = WEBTOPICLIST, DENYWEBVIEW, ALLOWWEBVIEW, DENYWEBCHANGE, ALLOWWEBCHANGE
25
26 **_Notes:_**
27
28 - A preference is defined as: <br />`6 spaces * Set NAME = value`<br /> Example:
29   - Set WEBBGCOLOR = #FFFFC0
30 - Preferences are used as [[TWikiVariables]] by enclosing the name in percent signs. Example:
31   - When you write variable `%WEBBGCOLOR%` , it gets expanded to `%WEBBGCOLOR%` .
32 - 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.
33 - 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).
34
35 **_Related Topics:_**
36
37 - [[TWikiPreferences]] has site-level preferences.
38 - [[TWikiUsers]] has a list of user topics. User topics can have optional user preferences.
39 - [[TWikiVariables]] has a list of common `%VARIABLES%` .
40 - [[TWikiAccessControl]] explains how to restrict access by users or groups.