6bafd7f963b2b29bad28eaef61822ae4de984067
[openafs-wiki.git] / Main / 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, i.e. [[TWikiGuest]] in the %WIKITOOLNAME%.Main web)
4
5 **_Preferences:_**
6
7 - List of topics of the %WIKITOOLNAME%.%WEB% web:
8   - Set WEBTOPICLIST = [[Users|Main/TWikiUsers]] | [[Groups|Main/TWikiGroups]] | [[Offices|Main/OfficeLocations]] | [[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 = #FFFFC0
12
13 - List this web in the [[SiteMap]]:
14   - 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.
15   - Set SITEMAPLIST = on
16   - Set SITEMAPWHAT = Welcome to %WIKITOOLNAME%... [[Users|WEB/TWikiUsers]], [[Groups|WEB/TWikiGroups]], [[Offices|WEB/OfficeLocations]] - tour this expandable virtual workspace.
17   - Set SITEMAPUSETO = ...get a first-hand feel for TWiki possibilities.
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]]: Default template for new topics in this web. (Site-level is used if topic does not exist)
24   - [[TWiki.WebTopicEditTemplate|TWiki/WebTopicEditTemplate]]: Site-level default template
25   - [[TWikiForms]]: How to enable form(s)
26   - Set WEBFORMS =
27
28 - Users or groups who **_are not_** / **_are_** allowed to **_view_** / **_change_** / **_rename_** topics in the %WEB% web: (See [[TWikiAccessControl]])
29   - Set DENYWEBVIEW =
30   - Set ALLOWWEBVIEW =
31   - Set DENYWEBCHANGE =
32   - Set ALLOWWEBCHANGE =
33   - Set DENYWEBRENAME =
34   - Set ALLOWWEBRENAME =
35
36 - Users or groups allowed to change or rename this %TOPIC% topic: (I.e. [[TWikiAdminGroup]])
37   - Set ALLOWTOPICCHANGE =
38   - Set ALLOWTOPICRENAME =
39
40 - Web preferences that are **not** allowed to be overridden by user preferences:
41   - Set FINALPREFERENCES = WEBTOPICLIST, DENYWEBVIEW, ALLOWWEBVIEW, DENYWEBCHANGE, ALLOWWEBCHANGE, DENYWEBRENAME, ALLOWWEBRENAME
42
43 **_Notes:_**
44
45 - A preference is defined as: <br />`6 spaces * Set NAME = value`<br /> Example:
46   - Set WEBBGCOLOR = #FFFFC0
47 - Preferences are used as [[TWikiVariables]] by enclosing the name in percent signs. Example:
48   - When you write variable `%WEBBGCOLOR%` , it gets expanded to `%WEBBGCOLOR%` .
49 - 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.
50 - 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).
51
52 **_Related Topics:_**
53
54 - [[TWikiPreferences]] has site-level preferences.
55 - [[TWikiUsers]] has a list of user topics. User topics can have optional user preferences.
56 - [[TWikiVariables]] has a list of common `%VARIABLES%`.
57 - [[TWikiAccessControl]] explains how to restrict access by users or groups.