(no commit message)
[openafs-wiki.git] / TWiki / WebPreferencesHelp.mdwn
1 ## <a name="Help on Preferences"></a> Help on Preferences
2
3 - A preference setting is defined by: <br />`3 or 6 spaces * Set NAME = value`<br /> Example:
4   - Set WEBBGCOLOR = #FFFFC0
5 - A preferences setting can be disabled with a # sign. Remove the # sign to enable a local customisation. Example:%BR%
6   - #Set DENYWEBCHANGE = %USERSWEB%.UnknownUser
7 - Preferences are used as %SYSTEMWEB%.TWikiVariables by enclosing the name in percent signs. Example:
8   - When you write variable `%WEBBGCOLOR%` , it gets expanded to `%WEBBGCOLOR%`
9 - 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.
10 - You can introduce your own preferences variables and use them in your topics and templates.
11
12 ## <a name="Related Topics"></a> Related Topics
13
14 - [[%SYSTEMWEB%.TWikiPreferences|SYSTEMWEB/TWikiPreferences]], [[Main.TWikiPreferences|Main/TWikiPreferences]] - site-level preferences
15 - %USERSWEB%.TWikiUsers - list of user topics. User topics can have optional user preferences
16 - %SYSTEMWEB%.TWikiVariables - list of common `%VARIABLES%`
17 - %SYSTEMWEB%.TWikiAccessControl - explains how to restrict access by users or groups
18
19 ## <a name="Tools"></a> Tools