8a1f5ad6b9eee9f278fb94e2057376e83bc83806
[openafs-wiki.git] / TWiki / TWikiPreferences.mdwn
1 # <a name="%WIKITOOLNAME% Site-Level Prefer"></a> %WIKITOOLNAME% Site-Level Preferences
2
3 The following are **_site-level_** settings that affect all users in all webs on this [[TWikiSite]]. They can be selectively overwritten on the **_individual web level_** (see [[WebPreferences]] in each web), and on the **_user level_** (create preferences in your user account topic in the Main web, ex: Main.admin).
4
5 - %X% **NOTE:** You can lock individual settings at the site or web levels using User &amp; Group Access Control - see section below.
6
7 <div>
8   <ul>
9     <li><a href="#%WIKITOOLNAME% Site-Level Prefer">%WIKITOOLNAME% Site-Level Preferences</a><ul>
10         <li><a href="#General Preferences:"> General Preferences:</a></li>
11         <li><a href="#Email Settings"> Email Settings</a></li>
12         <li><a href="#Plugins Settings"> Plugins Settings</a></li>
13         <li><a href="#HTTP-EQUIV Settings"> HTTP-EQUIV Settings</a></li>
14         <li><a href="#Preferences Access Control"> Preferences Access Control</a></li>
15         <li><a href="#Creating New Preference Variable"> Creating New Preference Variables</a></li>
16         <li><a href="#Related Topics"> Related Topics</a></li>
17       </ul>
18     </li>
19   </ul>
20 </div>
21
22 ----
23
24 ## <a name="General Preferences:"></a> General Preferences:
25
26 - List of %WIKITOOLNAME% webs - on the first line of the upper toolbar (to add a new web, see [[ManagingWebs]] and [[TWikiWebsTable]]):
27   - Set WIKIWEBLIST = [[Main|Main/WebHome]] | [[TWiki|TWiki/WebHome]] | [[Know|Know/WebHome]] | [[Test|Test/WebHome]]
28   - %T% **NOTE:** To automatically list all non-hidden webs in alphabetical order, use this variable instead: <br />Set WIKIWEBLIST =
29
30 - List of selected topics in a web - the second line of the upper toolbar (usually overwritten in individual [[WebPreferences]]):
31   - Set WEBTOPICLIST = [[Home|Main/WebHome]] | [[Changes|Main/WebChanges]] | [[Index|Main/WebIndex]] | [[Search|Main/WebSearch]] | Go <input name="topic" size="16" type="text" />
32
33 - Copyright notice:
34   - Set WEBCOPYRIGHT = <font>Copyright © 1999-2002 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>
35
36 - Exclude web from a `web="all"` search: (Set to `on` for hidden webs; is overwritten by web preferences)
37   - Set NOSEARCHALL =
38
39 - Web specific background color: (is overwritten by web preferences)
40   - Set WEBBGCOLOR = #C0C0C0
41
42 - [[PreviewBackground]] image:
43   - Set PREVIEWBGIMAGE = ![previewbg.gif](http://www.dementia.org/twiki//view/TWiki/PreviewBackground/previewbg.gif)
44
45 - Background color of non existing topic: ( default `cornsilk` or `#FFFFCE` )
46   - Set NEWTOPICBGCOLOR = #FFFFCE
47
48 - Font color of non existing topic: ( default `#0000FF` )
49   - Set NEWTOPICFONTCOLOR = #0000FF
50
51 - Horizontal size of text edit box: (can be overwritten by user preferences)
52   - Set EDITBOXWIDTH = 70
53
54 - Vertical size of text edit box: (can be overwritten by user preferences)
55   - Set EDITBOXHEIGHT = 15
56
57 - 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)
58   - Set RELEASEEDITLOCKCHECKBOX =
59
60 - 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)
61   - Set DONTNOTIFYCHECKBOX =
62
63 - 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)
64   - Set ATTACHLINKBOX =
65
66 - Format of file link when the **_link_** check box is checked: (can be overwritten by user preferences)
67   - %H% **NOTE:** Keyword <code>**$name**</code> gets expanded to filename; <code>**$comment**</code> to comment; <code>**\\t**</code> to tab (3 spaces for bullets).
68   - Set ATTACHEDFILELINKFORMAT = \\t\* [$name](http://www.dementia.org/twiki//view/$name): $comment
69
70 - Format of images when the **_link_** check box is checked: (can be overwritten by user preferences)
71   - %H% **NOTE:** Keyword <code>**$name**</code> gets expanded to filename; <code>**$comment**</code> to comment; <code>**$size**</code> to <code>**width="..." height="..."**</code> attribute of <code>**img**</code> tag; <code>**\\t**</code> to tab (3 spaces for bullets).
72
73           * Set ATTACHEDIMAGEFORMAT = \t* $comment: <br />
74             <img src="%ATTACHURLPATH%/$name" alt="$name" $size />
75
76 ## <a name="Email Settings"></a> Email Settings
77
78 - TWiki webmaster email address:
79   - Set WIKIWEBMASTER = <webmaster@your.company>
80
81 - Mail host for outgoing mail. This is used for [[WebChangesAlert]] if Perl module <code>**Net::SMTP**</code> is installed. If not, or if `SMTPMAILHOST` is empty, the external sendmail program is used instead (defined by <code>**$mailProgram**</code> in <code>**TWiki.cfg**</code>). Examples: <code>**mail.your.company**</code> or <code>**localhost**</code>
82   - Set SMTPMAILHOST = mail
83
84 - Mail domain sending mail. SMTP requires that you identify the TWiki server sending mail. If not set, <code>**Net::SMTP**</code> will guess it for you. Ex: <code>**twiki.your.company**</code>
85   - Set SMTPSENDERHOST =
86
87 ## <a name="Plugins Settings"></a> Plugins Settings
88
89 - [[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.
90   - Set INSTALLEDPLUGINS = [[DefaultPlugin]]
91   - Set DISABLEDPLUGINS = [[EmptyPlugin]]
92   - Currently activated plugins: [[SpreadSheetPlugin]], [[CommentPlugin]], [[EditTablePlugin]], [[InterwikiPlugin]], [[PreferencesPlugin]], [[SlideShowPlugin]], [[SmiliesPlugin]], [[TablePlugin]], [[TwistyPlugin]]
93   - %T% **NOTE:** You can enable/disable all plugins with the <code>**$disableAllPlugins**</code> flag in the <code>**lib/TWiki.cfg**</code> file.
94
95 ## <a name="HTTP-EQUIV Settings"></a> HTTP-EQUIV Settings
96
97 - <code>**http-equiv**</code> meta tags for <code>**view**</code>, <code>**rdiff**</code>, <code>**attach**</code>, <code>**search\***</code> scripts:
98
99           * Set HTTP_EQUIV_ON_VIEW =
100
101 - <code>**http-equiv**</code> meta tags for <code>**edit**</code> script. Example, to expire immediately: <br />`Set HTTP_EQUIV_ON_EDIT = <meta http-equiv="Expires" content="%GMTIME{"$day $month $year $hour:$min:$sec"}% GMT">`
102
103           * Set HTTP_EQUIV_ON_EDIT =
104
105 - <code>**http-equiv**</code> meta tags for <code>**preview**</code> script:
106
107           * Set HTTP_EQUIV_ON_PREVIEW =
108
109 ## <a name="Preferences Access Control"></a> Preferences Access Control
110
111 - Users or groups allowed to change or rename this %TOPIC% topic: (ex: [[TWikiAdminGroup]])
112   - Set ALLOWTOPICCHANGE =
113   - Set ALLOWTOPICRENAME =
114
115 - Site-level preferences that are **not** allowed to be overridden by [[WebPreferences]] and user preferences:
116   - Set FINALPREFERENCES = PREVIEWBGIMAGE, WIKIWEBMASTER, SMTPMAILHOST , SMTPSENDERHOST
117
118 ## <a name="Creating New Preference Variable"></a> Creating New Preference Variables
119
120 You can introduce new VARIABLES and use them in your topics and templates. There is no need to change the TWiki engine (Perl scripts).
121
122 - A preference is defined in a [[TWikiShorthand]] bullet item: <code>**[3 spaces] \* [space] Set NAME = value**</code><br /> Example (as a nested bullet item, indented 6 spaces):
123   - Set WEBBGCOLOR = #FFFFC0
124 - Preferences are used as [[TWikiVariables]] by enclosing the name in percent signs: <code>**%**</code>. Example:
125   - When you write variable <code>**%WEBBGCOLOR%**</code>, it gets expanded to `%WEBBGCOLOR%` .
126
127 - %X% The sequential order of the preference settings is significant. Define preferences that use other preferences FIRST. For example, set <code>**WEBCOPYRIGHT**</code> before <code>**WIKIWEBMASTER**</code> since the copyright notice uses the webmaster email address.
128
129 ## <a name="Related Topics"></a> Related Topics
130
131 - [[WebPreferences]] has preferences of the %WIKITOOLNAME%.%WEB% web.
132 - [[TWikiUsers]] has a list of user topics. User topics can have optional user preferences.
133 - [[TWikiVariables]] has a list of common `%VARIABLES%` .
134 - [[TWikiAccessControl]] explains how to restrict access by users or groups.