none
[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="#Miscellaneous Settings"> Miscellaneous Settings</a></li>
15         <li><a href="#Preferences Access Control"> Preferences Access Control</a></li>
16         <li><a href="#Creating New Preference Variable"> Creating New Preference Variables</a></li>
17         <li><a href="#Related Topics"> Related Topics</a></li>
18       </ul>
19     </li>
20   </ul>
21 </div>
22
23 ----
24
25 ## <a name="General Preferences"></a> General Preferences
26
27 - List of %WIKITOOLNAME% webs - on the first line of the upper toolbar (to add a new web, see [[ManagingWebs]] and [[SiteMap]]):
28   - Set WIKIWEBLIST = [[Main|Main/WebHome]] | [[TWiki|TWiki/WebHome]] | [[Know|Know/WebHome]] | [[Test|Test/WebHome]]
29   - %T% **NOTE:** To automatically list all non-hidden webs in alphabetical order, use this variable instead: <br />Set WIKIWEBLIST =
30
31 - List of selected topics in a web - the second line of the upper toolbar (usually overwritten in individual [[WebPreferences]]):
32   - Set WEBTOPICLIST = [[Home|Main/WebHome]] | [[Changes|Main/WebChanges]] | [[Index|Main/WebIndex]] | [[Search|Main/WebSearch]] | Go <input name="topic" size="16" type="text" />
33
34 - Copyright notice:
35   - 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>
36
37 - Exclude web from a `web="all"` search: (Set to `on` for hidden webs; is overwritten by web preferences)
38   - Set NOSEARCHALL =
39
40 - Web specific background color: (is overwritten by web preferences)
41   - Set WEBBGCOLOR = #C0C0C0
42
43 - [[PreviewBackground]] image:
44   - Set PREVIEWBGIMAGE = ![previewbg.gif](http://www.dementia.org/twiki//view/TWiki/PreviewBackground/previewbg.gif)
45
46 - Background color of non existing topic: ( default `cornsilk` or `#FFFFCE` )
47   - Set NEWTOPICBGCOLOR = #FFFFCE
48
49 - Font color of non existing topic: ( default `#0000FF` )
50   - Set NEWTOPICFONTCOLOR = #0000FF
51
52 - Horizontal size of text edit box: (can be overwritten by user preferences)
53   - Set EDITBOXWIDTH = 70
54
55 - Vertical size of text edit box: (can be overwritten by user preferences)
56   - Set EDITBOXHEIGHT = 15
57
58 - 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)
59   - Set RELEASEEDITLOCKCHECKBOX =
60
61 - 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)
62   - Set DONTNOTIFYCHECKBOX =
63
64 - 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)
65   - Set ATTACHLINKBOX =
66
67 - Format of file link when the **_link_** check box is checked: (can be overwritten by user preferences)
68   - %H% **NOTE:** Keyword <code>**$name**</code> gets expanded to filename; <code>**$comment**</code> to comment; <code>**\\t**</code> to tab (3 spaces for bullets).
69   - Set ATTACHEDFILELINKFORMAT = \\t\* [$name](http://www.dementia.org/twiki//view/$name): $comment
70
71 - Format of images when the **_link_** check box is checked: (can be overwritten by user preferences)
72   - %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).
73
74           * Set ATTACHEDIMAGEFORMAT = \t* $comment: <br />
75             <img src="%ATTACHURLPATH%/$name" alt="$name" $size />
76
77 ## <a name="Email Settings"></a> Email Settings
78
79 - TWiki webmaster email address:
80   - Set WIKIWEBMASTER = <webmaster@your.company>
81
82 - 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>
83   - Set SMTPMAILHOST = mail
84
85 - 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>
86   - Set SMTPSENDERHOST =
87
88 ## <a name="Plugins Settings"></a> Plugins Settings
89
90 - [[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.
91   - Set INSTALLEDPLUGINS = [[DefaultPlugin]]
92   - Set DISABLEDPLUGINS = [[EmptyPlugin]]
93   - Currently activated plugins: [[SpreadSheetPlugin]], [[CommentPlugin]], [[EditTablePlugin]], [[InterwikiPlugin]], [[PreferencesPlugin]], [[SlideShowPlugin]], [[SmiliesPlugin]], [[TablePlugin]], [[TwistyPlugin]]
94   - %T% **NOTE:** You can enable/disable all plugins with the <code>**$disableAllPlugins**</code> flag in the <code>**lib/TWiki.cfg**</code> file.
95
96 ## <a name="HTTP-EQUIV Settings"></a> HTTP-EQUIV Settings
97
98 - <code>**http-equiv**</code> meta tags for <code>**view**</code>, <code>**rdiff**</code>, <code>**attach**</code>, <code>**search\***</code> scripts:
99
100           * Set HTTP_EQUIV_ON_VIEW =
101
102 - <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">`
103
104           * Set HTTP_EQUIV_ON_EDIT =
105
106 - <code>**http-equiv**</code> meta tags for <code>**preview**</code> script:
107
108           * Set HTTP_EQUIV_ON_PREVIEW =
109
110 ## <a name="Miscellaneous Settings"></a> Miscellaneous Settings
111
112 - Colored text: (see more [[StandardColors]]) <table border="1" cellpadding="0" cellspacing="0">
113   <tr>
114     <td> You type: </td>
115     <td><code>%RED% red text %ENDCOLOR% and %GREEN% green text %ENDCOLOR%</code></td>
116   </tr>
117   <tr>
118     <td> You get: </td>
119     <td> %RED% red text %ENDCOLOR% and %GREEN% green text %ENDCOLOR% </td>
120   </tr>
121 </table>
122   - **_Note:_** `%<color>%` text must end with `%ENDCOLOR%` . If you want to switch from one color to another one you first need to end the active color with `%ENDCOLOR%`, e.g. write `%RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%`.
123   - Set YELLOW = <font>
124     - **YELLOW looks like this**</font>
125 - Set RED = <font>
126   - **RED looks like this**</font>
127
128 - Set PINK = <font>
129   - **PINK looks like this**</font>
130
131 - Set PURPLE = <font>
132   - **PURPLE looks like this**</font>
133
134 - Set TEAL = <font>
135   - **TEAL looks like this**</font>
136
137 - Set NAVY = <font>
138   - **NAVY looks like this**</font>
139
140 - Set BLUE = <font>
141   - **BLUE looks like this**</font>
142
143 - Set AQUA = <font>
144   - **AQUA looks like this**</font>
145
146 - Set LIME = <font>
147   - **LIME looks like this**</font>
148
149 - Set GREEN = <font>
150   - **GREEN looks like this**</font>
151
152 - Set OLIVE = <font>
153   - **OLIVE looks like this**</font>
154
155 - Set MAROON = <font>
156   - **MAROON looks like this**</font>
157
158 - Set BLACK = <font>
159   - **BLACK looks like this**</font>
160
161 - Set GRAY = <font>
162   - **GRAY looks like this**</font>
163
164 - Set SILVER = <font>
165   - **SILVER looks like this**</font>
166
167 - Set WHITE = <font>
168   - **WHITE looks like this**</font>
169
170 - And finally:
171 - Set ENDCOLOR =
172   - To finish colored text
173
174 ## <a name="Preferences Access Control"></a> Preferences Access Control
175
176 - Users or groups allowed to change or rename this %TOPIC% topic: (ex: [[TWikiAdminGroup]])
177   - Set ALLOWTOPICCHANGE =
178   - Set ALLOWTOPICRENAME =
179
180 - Site-level preferences that are **not** allowed to be overridden by [[WebPreferences]] and user preferences:
181   - Set FINALPREFERENCES = PREVIEWBGIMAGE, WIKIWEBMASTER, SMTPMAILHOST , SMTPSENDERHOST
182
183 ## <a name="Creating New Preference Variable"></a> Creating New Preference Variables
184
185 You can introduce new VARIABLES and use them in your topics and templates. There is no need to change the TWiki engine (Perl scripts).
186
187 - 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):
188   - Set WEBBGCOLOR = #FFFFC0
189 - Preferences are used as [[TWikiVariables]] by enclosing the name in percent signs: <code>**%**</code>. Example:
190   - When you write variable <code>**%WEBBGCOLOR%**</code>, it gets expanded to `%WEBBGCOLOR%` .
191
192 - %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.
193
194 ## <a name="Related Topics"></a> Related Topics
195
196 - [[WebPreferences]] has preferences of the %WIKITOOLNAME%.%WEB% web.
197 - [[TWikiUsers]] has a list of user topics. User topics can have optional user preferences.
198 - [[TWikiVariables]] has a list of common `%VARIABLES%` .
199 - [[TWikiAccessControl]] explains how to restrict access by users or groups.