none
[openafs-wiki.git] / TWiki / TWikiPreferences.mdwn
1 **%WIKITOOLNAME% Site-Level Preferences**
2
3 The following settings are **_site-level preferences_** , e.g. affecting all users in all %WIKITOOLNAME% webs. These preferences can be overwritten by **_web preferences_** (topic [[WebPreferences]] in each %WIKITOOLNAME% web) and **_user preferences_** (your personal topic, i.e. [[TWikiGuest]] in the %WIKITOOLNAME%.Main web)
4
5 **_Preferences:_**
6
7 - List of %WIKITOOLNAME% webs: (the first line of a topic; to add a web see [[TWikiDocumentation]] and [[TWikiWebsTable]])
8   - Set WIKIWEBLIST = [[Main|Main/WebHome]] | [[TWiki|TWiki/WebHome]] | [[Know|Know/WebHome]] | [[Test|Test/WebHome]]
9   - **_Note:_** To automatically list all non-hidden webs in alphabetical order you can use this variable instead: Set WIKIWEBLIST =
10
11 - List of topics of a web: (the second line of a topic, is overwritten by web preferences)
12   - Set WEBTOPICLIST = [[Home|Main/WebHome]] | [[Changes|Main/WebChanges]] | [[Index|Main/WebIndex]] | [[Search|Main/WebSearch]] | Go <input name="topic" size="16" type="text" />
13
14 - Copyright notice:
15   - Set WEBCOPYRIGHT = <font>Copyright © 2000 by the contributing authors. \\nAll material on this collaboration tool is the property of the contributing authors. <br /> \\nIdeas, requests, problems regarding %WIKITOOLNAME%? [Send](mailto:?subject=%WIKITOOLNAME% Feedback) feedback. </font>
16
17 - Exclude web from a `web="all"` search: (Set to `on` for hidden webs; is overwritten by web preferences)
18   - Set NOSEARCHALL =
19
20 - Web specific background color: (is overwritten by web preferences)
21   - Set WEBBGCOLOR = #C0C0C0
22
23 - [[PreviewBackground]] image:
24   - Set PREVIEWBGIMAGE = ![previewbg.gif](http://www.dementia.org/twiki//view/TWiki/PreviewBackground/previewbg.gif)
25
26 - Background color of non existing topic: ( default `cornsilk` or `#FFFFCE` )
27   - Set NEWTOPICBGCOLOR = #FFFFCE
28
29 - Font color of non existing topic: ( default `#0000FF` )
30   - Set NEWTOPICFONTCOLOR = #0000FF
31
32 - Horizontal size of text edit box: (can be overwritten by user preferences)
33   - Set EDITBOXWIDTH = 70
34
35 - Vertical size of text edit box: (can be overwritten by user preferences)
36   - Set EDITBOXHEIGHT = 15
37
38 - Default state of the **_Release edit lock_** ([[UnlockTopic]]) check box in preview. Checkbox is initially checked if `Set RELEASEEDITLOCKCHECKBOX = checked="checked"`, or unchecked if empty. If checked, make sure to click on <u>Edit</u> to do more changes; do **not** go back in your browser to the edit page, or you risk that someone else will edit the topic at the same time: (can be overwritten by user preferences)
39   - Set RELEASEEDITLOCKCHECKBOX =
40
41 - Default state of the **_Minor Changes, Don't Notify_** ([[DontNotify]]) check box in preview. Check box is initially checked if `Set DONTNOTIFYCHECKBOX = checked="checked"`, or unchecked if empty: (can be overwritten by user preferences)
42   - Set DONTNOTIFYCHECKBOX =
43
44 - Default state of the **_link_** check box in the attach file page. Checkbox is initially checked if `Set ATTACHLINKBOX = checked="checked"`, or unchecked if empty (`Set ATTACHLINKBOX =`). If checked, a link is created to the attached file at the end of the topic: (can be overwritten by user preferences)
45   - Set ATTACHLINKBOX =
46
47 - Wiki webmaster email address:
48   - Set WIKIWEBMASTER = <webmaster@your.company>
49
50 - Mail host for outgoing mail. This is used for [[TWikiNotificationOfChanges]] if Perl module <code>**Net::SMTP**</code> is installed. If not, sendmail is used instead (defined by <code>**$mailProgram**</code> in <code>**TWiki.cfg**</code>). Examples: `mail.your.company` or `localhost`
51   - Set SMTPMAILHOST = mail
52
53 - [[TWikiPlugins]] configuration: All plugin modules that exist in the `lib/TWiki/Plugins` directory are activated automatically unless disabled by DISABLEDPLUGINS. You can optionally list the installed plugins in INSTALLEDPLUGINS. This is useful to define the sequence of plugin execution, or to specify other webs then the TWiki web for the plugin topics. Specify plugins as a comma separated list of topics.
54   - Set INSTALLEDPLUGINS = [[DefaultPlugin]]
55   - Set DISABLEDPLUGINS = [[EmptyPlugin]]
56   - Currently activated plugins: [[SpreadSheetPlugin]], [[CommentPlugin]], [[EditTablePlugin]], [[InterwikiPlugin]], [[PreferencesPlugin]], [[SlideShowPlugin]], [[SmiliesPlugin]], [[TablePlugin]], [[TwistyPlugin]]
57   - **_Note:_** In case you have a rough plugin you can disable all plugins with the <code>**$disableAllPlugins**</code> flag in the `TWiki.cfg` file.
58
59 - http-equiv meta tags for **_view_**, **_rdiff_**, **_attach_**, **_search\*_** scripts:
60
61           * Set HTTP_EQUIV_ON_VIEW =
62
63 - http-equiv meta tags for **_edit_** script. Example to expire immediately: <br />`Set HTTP_EQUIV_ON_EDIT = <meta http-equiv="Expires" content="%GMTIME{"$day $month, $year - $hour:$min:$sec"}% GMT">`
64
65           * Set HTTP_EQUIV_ON_EDIT =
66
67 - http-equiv meta tags for **_preview_** script:
68
69           * Set HTTP_EQUIV_ON_PREVIEW =
70
71 - Users or groups allowed to change this %TOPIC% topic: (I.e. [[TWikiAdminGroup]])
72   - Set ALLOWTOPICCHANGE =
73
74 - Site-level preferences that are **not** allowed to be overridden by [[WebPreferences]] and user preferences:
75   - Set FINALPREFERENCES = PREVIEWBGIMAGE, WIKIWEBMASTER, MAILHOST
76
77 **_Notes:_**
78
79 - A preference is defined as: <br />`6 spaces * Set NAME = value`<br /> Example:
80   - Set WEBBGCOLOR = #FFFFC0
81 - Preferences are used as [[TWikiVariables]] by enclosing the name in percent signs. Example:
82   - When you write variable `%WEBBGCOLOR%` , it gets expanded to `%WEBBGCOLOR%` .
83 - 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.
84 - You can introduce new variables and use them in your topics and templates. There is no need to change the %WIKITOOLNAME% engine (Perl scripts).
85
86 **_Related Topics:_**
87
88 - [[WebPreferences]] has preferences of the %WIKITOOLNAME%.%WEB% web.
89 - [[TWikiUsers]] has a list of user topics. User topics can have optional user preferences.
90 - [[TWikiVariables]] has a list of common `%VARIABLES%` .
91 - [[TWikiAccessControl]] explains how to restrict access by users or groups.