bc4a531b5326ba4f329f662bc38e44e776828727
[openafs-wiki.git] / AFSLore / WebPreferences.mdwn
1 ## <a name="%WIKITOOLNAME%.%WEB% Web Prefere"></a> %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]] | [[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 = #99CCFF
12
13 - Exclude web from a `web="all"` search: (Set to `on` for hidden webs)
14   - Set NOSEARCHALL =
15
16 - Default template for new topics and form(s) for this web:
17   - [[WebTopicEditTemplate]]: Default template for new topics in this web. (Site-level is used if topic does not exist)
18   - [[TWiki.WebTopicEditTemplate|TWiki/WebTopicEditTemplate]]: Site-level default template
19   - [[TWikiForms]]: How to enable form(s)
20   - Set WEBFORMS =
21
22 - Users or groups who **_are not_** / **_are_** allowed to **_view_** / **_change_** / **_rename_** topics in the %WEB% web: (See [[TWikiAccessControl]])
23   - Set DENYWEBVIEW =
24   - Set ALLOWWEBVIEW =
25   - Set DENYWEBCHANGE = [[TWikiGuest]]
26   - Set ALLOWWEBCHANGE =
27   - Set DENYWEBRENAME = [[TWikiGuest]]
28   - Set ALLOWWEBRENAME =
29
30 - Users or groups allowed to change or rename this %TOPIC% topic: (I.e. [[TWikiAdminGroup]])
31   - Set ALLOWTOPICCHANGE = [[TWikiAdminGroup]]
32   - Set ALLOWTOPICRENAME = [[TWikiAdminGroup]]
33
34 - Web preferences that are **not** allowed to be overridden by user preferences:
35   - Set FINALPREFERENCES = WEBTOPICLIST, DENYWEBVIEW, ALLOWWEBVIEW, DENYWEBCHANGE, ALLOWWEBCHANGE, DENYWEBRENAME, ALLOWWEBRENAME
36
37 **_Notes:_**
38
39 - A preference is defined as: <br />`6 spaces * Set NAME = value`<br /> Example:
40   - Set WEBBGCOLOR = #FFFFC0
41 - Preferences are used as [[TWikiVariables]] by enclosing the name in percent signs. Example:
42   - When you write variable `%WEBBGCOLOR%` , it gets expanded to `%WEBBGCOLOR%` .
43 - 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.
44 - 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).
45
46 **_Related Topics:_**
47
48 - [[TWikiPreferences]] has site-level preferences.
49 - [[TWikiUsers]] has a list of user topics. User topics can have optional user preferences.
50 - [[TWikiVariables]] has a list of common `%VARIABLES%`.
51 - [[TWikiAccessControl]] explains how to restrict access by users or groups.