e81f523b2ed0222b061813eed51593eebd17923d
[openafs-wiki.git] / TWiki / TWikiPreferences.mdwn
1 # <a name="%WIKITOOLNAME% Site-Level Prefer"></a><a name=" %WIKITOOLNAME% Site-Level Prefe"></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="#Web Preferences"> Web Preferences</a></li>
10     <li><a href="#User Settings"> User Settings</a></li>
11     <li><a href="#TWiki Platform Settings"> TWiki Platform Settings</a></li>
12     <li><a href="#Email and Proxy Server Settings"> Email and Proxy Server Settings</a><ul>
13         <li><a href="#Email Link Settings"> Email Link Settings</a></li>
14       </ul>
15     </li>
16     <li><a href="#Plugins Settings"> Plugins Settings</a></li>
17     <li><a href="#HTTP-EQUIV Settings"> HTTP-EQUIV Settings</a></li>
18     <li><a href="#Miscellaneous Settings"> Miscellaneous Settings</a></li>
19     <li><a href="#Access Control Settings"> Access Control Settings</a></li>
20     <li><a href="#Creating New Preference Variable"> Creating New Preference Variables</a></li>
21     <li><a href="#Related Topics"> Related Topics</a></li>
22   </ul>
23 </div>
24
25 ## <a name="Web Preferences"></a> Web Preferences
26
27 %X% **NOTE:** They are typically redefined in individual WebPreferences topics
28
29 - List of selected topics in a web - the second line of the upper toolbar (usually overwritten in individual [[WebPreferences]]):
30   - Set WEBTOPICLIST = [[Changes|Main/WebChanges]] | [[Index|Main/WebIndex]] | [[Search|Main/WebSearch]] | Go <input name="topic" size="16" type="text" />
31
32 - Web specific background color: (is overwritten by web preferences)
33   - Set WEBBGCOLOR = #C0C0C0
34
35 - Copyright notice:
36   - Set WEBCOPYRIGHT = <font>Copyright © 1999-2003 by the contributing authors. \\nAll material on this collaboration platform is the property of the contributing authors. <br /> \\nIdeas, requests, problems regarding %WIKITOOLNAME%? [Send](mailto:?subject=%WIKITOOLNAME% Feedback on %WEB%.%TOPIC%) feedback. </font>
37
38 - Exclude web from a `web="all"` search: (Set to `on` for hidden webs; is overwritten by web preferences)
39   - Set NOSEARCHALL =
40
41 - Prevent automatic linking of [[WikiWords]] and acronyms (if set to `on`); link WikiWords (if empty); can be overwritten by web preferences:
42   - Set NOAUTOLINK =
43   - **_Note:_** Use the `[[...][...]]` syntax to link topics in case you disabled WikiWord linking. The `<noautolink> ... </noautolink>` syntax can be used to prevents links within a block of text.
44
45 - Warn if `%INCLUDE{}%` of topic fails: Fail silently (if empty or `off`); output "Warning: Can't INCLUDE Topic, topic not found" (if set to `on`); else, output specific text (use `$topic` for topic). You can override this setting by web preferences and by a `warn="..."` parameter in `%INCLUDE{}%` :
46   - Set INCLUDEWARNING = %RED% **_Note:_** %ENDCOLOR% Included topic [[$topic|Main/Topic]] does not exist yet
47
48 ## <a name="User Settings"></a> User Settings
49
50 %X% **NOTE:** They are typically redefined in topics of individual [[TWikiUsers]]
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 - Style of text edit box. Set to `width: 99%` for full window width (default; this will overwrite the EDITBOXWIDTH setting), or `width: auto` to disable. This setting works for IE and some other recent browsers. (can be overwritten by user preferences)
59   - Set EDITBOXSTYLE = width: 99%
60
61 - 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)
62   - Set RELEASEEDITLOCKCHECKBOX =
63
64 - 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)
65   - Set DONTNOTIFYCHECKBOX =
66
67 - 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)
68   - Set ATTACHLINKBOX =
69
70 - Format of file link 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>**\\t**</code> to tab (3 spaces for bullets).
72   - Set ATTACHEDFILELINKFORMAT = \\t\* [$name](http://www.dementia.org/twiki//view/$name): $comment
73
74 - Format of images when the **_link_** check box is checked: (can be overwritten by user preferences)
75   - %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).
76
77           * Set ATTACHEDIMAGEFORMAT = \t* $comment: <br />
78             <img src="%ATTACHURLPATH%/$name" alt="$name" $size />
79
80 ## <a name="TWiki Platform Settings"></a> TWiki Platform Settings
81
82 - TWiki platform name:
83   - Set WIKITOOLNAME = TWikibeta
84
85 - Image, URL and alternate tooltip text of TWiki logo: (can be overwritten by web preferences)
86   - Set WIKILOGOIMG = ![twikiRobot46x50.gif](http://www.dementia.org/twiki//view/TWiki/TWikiLogos/twikiRobot46x50.gif)
87   - Set WIKILOGOURL = <http://TWiki.org/>
88   - Set WIKILOGOALT = TWiki home
89
90 - List of %WIKITOOLNAME% webs - on the first line of the upper toolbar (to add a new web, see [[ManagingWebs]] and [[SiteMap]]):
91   - Set WIKIWEBLIST = [[Main|Main/WebHome]] | [[TWiki|TWiki/WebHome]] | [[Know|Know/WebHome]] | [[Sandbox|Sandbox/WebHome]]
92   - %T% **NOTE:** To automatically list all non-hidden webs in alphabetical order, use the `%WEBLIST{}%` variable instead: <br />
93
94 - Skin overriding the default TWiki templates: (can be overwritten by [[WebPreferences]] and user preferences)
95   - Set SKIN =
96
97 - Broadcast message for skins supporting a %BROADCASTMESSAGE% at the top of the page: (IMPORTANT: Set to empty message if not used; #Comment out unused messages)
98   - #Set BROADCASTMESSAGE =
99   - Set BROADCASTMESSAGE = <table border="0" cellpadding="3" cellspacing="0" width="100%">
100   <tr>
101     <td bgcolor="yellow"><font color="red"><strong>NOTE:</strong></font><font size="-1"> Edit and Attach will be disabled today between 05:00 PM and 06:00 PM PDT (00:00 to 01:00 GMT) for a scheduled %WIKITOOLNAME% maintenance. </font></td>
102   </tr>
103 </table>
104
105 ## <a name="Email and Proxy Server Settings"></a> Email and Proxy Server Settings
106
107 - TWiki webmaster email address:
108   - Set WIKIWEBMASTER = <webmaster@your.company>
109
110 - TWiki webmaster name (first name and last name, e.g. `Fred Smith`):
111   - Set WIKIWEBMASTERNAME = TWiki Webmaster
112
113 - 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>
114   - Set SMTPMAILHOST = mail
115
116 - 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>
117   - Set SMTPSENDERHOST =
118
119 - Proxy Server. Some environments require outbound HTTP traffic to go through a proxy server. Set the host in PROXYHOST (example: <code>**proxy.your.company**</code>), and the port number in PROXYPORT (example: <code>**8080**</code>). No proxy is used if PROXYHOST or PROXYPORT is empty.
120   - Set PROXYHOST =
121   - Set PROXYPORT =
122
123 ### <a name="Email Link Settings"></a> Email Link Settings
124
125 - 'Mail this topic' mailto: link - can be included in topics, templates or skins
126   - Set MAILTHISTOPIC = [%MAILTHISTOPICTEXT%](mailto:?subject=WebHome&amp;body=%TOPICURL%)
127
128 - 'Mail this topic' link text
129   - Set MAILTHISTOPICTEXT = Send a link to this page
130
131 - URL for current topic
132   - Set TOPICURL = <http://www.dementia.org/twiki//view/%WEB%/WebHome>
133
134 ## <a name="Plugins Settings"></a> Plugins Settings
135
136 - [[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.
137   - Set INSTALLEDPLUGINS = [[DefaultPlugin]], [[SpreadSheetPlugin]]
138   - Set DISABLEDPLUGINS = [[EmptyPlugin]]
139   - Currently activated plugins: [[SpreadSheetPlugin]], [[CommentPlugin]], [[EditTablePlugin]], [[InterwikiPlugin]], [[PreferencesPlugin]], [[SlideShowPlugin]], [[SmiliesPlugin]], [[TablePlugin]], [[TwistyPlugin]]
140   - %T% **NOTE:** You can enable/disable all plugins with the <code>**$disableAllPlugins**</code> flag in the <code>**lib/TWiki.cfg**</code> file.
141
142 ## <a name="HTTP-EQUIV Settings"></a> HTTP-EQUIV Settings
143
144 - <code>**http-equiv**</code> meta tags for <code>**view**</code>, <code>**rdiff**</code>, <code>**attach**</code>, <code>**search\***</code> scripts:
145
146           * Set HTTP_EQUIV_ON_VIEW =
147
148 - <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">`
149
150           * Set HTTP_EQUIV_ON_EDIT =
151
152 - <code>**http-equiv**</code> meta tags for <code>**preview**</code> script:
153
154           * Set HTTP_EQUIV_ON_PREVIEW =
155
156 ## <a name="Miscellaneous Settings"></a> Miscellaneous Settings
157
158 - Line break:
159   - Set BR = <br />
160
161 - Bullet sign:
162   - Set BULLET = •
163
164 - Line break and bullet: (useful in table cells)
165   - Set BB = <br />•
166
167 - Colored text: (see more [[StandardColors]]) <table border="1" cellpadding="0" cellspacing="0">
168   <tr>
169     <td> You type: </td>
170     <td><code>%RED% red text %ENDCOLOR% and %GREEN% green text %ENDCOLOR%</code></td>
171   </tr>
172   <tr>
173     <td> You get: </td>
174     <td> %RED% red text %ENDCOLOR% and %GREEN% green text %ENDCOLOR% </td>
175   </tr>
176 </table>
177   - **_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%`.
178   - Set YELLOW = <font>
179     - **YELLOW looks like this**</font>
180 - Set ORANGE = <font>
181   - **ORANGE looks like this**</font>
182
183 - Set RED = <font>
184   - **RED looks like this**</font>
185
186 - Set PINK = <font>
187   - **PINK looks like this**</font>
188
189 - Set PURPLE = <font>
190   - **PURPLE looks like this**</font>
191
192 - Set TEAL = <font>
193   - **TEAL looks like this**</font>
194
195 - Set NAVY = <font>
196   - **NAVY looks like this**</font>
197
198 - Set BLUE = <font>
199   - **BLUE looks like this**</font>
200
201 - Set AQUA = <font>
202   - **AQUA looks like this**</font>
203
204 - Set LIME = <font>
205   - **LIME looks like this**</font>
206
207 - Set GREEN = <font>
208   - **GREEN looks like this**</font>
209
210 - Set OLIVE = <font>
211   - **OLIVE looks like this**</font>
212
213 - Set MAROON = <font>
214   - **MAROON looks like this**</font>
215
216 - Set BLACK = <font>
217   - **BLACK looks like this**</font>
218
219 - Set GRAY = <font>
220   - **GRAY looks like this**</font>
221
222 - Set SILVER = <font>
223   - **SILVER looks like this**</font>
224
225 - Set WHITE = <font>
226   - **WHITE looks like this**</font>
227
228 - And finally:<font> </font>
229 - Set ENDCOLOR =
230   - To finish colored text
231
232 <a name="DocGraphics"></a>
233
234 - Graphics used in TWiki documentation - view all images in [[TWikiDocGraphics]]. _(There are various ways to set up common icons as text variables. This is simply one quick approach.)_:
235   - Set H = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/help.gif" width="16" height="16" alt="HELP" />
236   - Set I = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/tip.gif" width="16" height="16" alt="IDEA!" />
237   - Set M = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/arrowright.gif" width="16" height="16" alt="MOVED TO..." />
238   - Set N = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/new.gif" width="28" height="8" alt="NEW" />
239   - Set P = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/pencil.gif" width="16" height="16" alt="REFACTOR" />
240   - Set Q = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/help.gif" width="16" height="16" alt="QUESTION?" />
241   - Set S = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/starred.gif" width="16" height="16" alt="PICK" />
242   - Set T = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/tip.gif" width="16" height="16" alt="TIP" />
243   - Set U = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/updated.gif" width="56" height="8" alt="UPDATED" />
244   - Set X = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/warning.gif" width="16" height="16" alt="ALERT!" />
245   - Set Y = <img src="http://www.dementia.org/twiki//view/TWiki/TWikiDocGraphics/choice-yes.gif" width="16" height="16" alt="DONE" />
246
247 - Background color of non existing topic: ( default `cornsilk` or `#FFFFCE` )
248   - Set NEWTOPICBGCOLOR = #FFFFCE
249
250 - Font color of non existing topic: ( default `#0000FF` )
251   - Set NEWTOPICFONTCOLOR = #0000FF
252
253 - [[PreviewBackground]] image:
254   - Set PREVIEWBGIMAGE = ![preview2bg.gif](http://www.dementia.org/twiki//view/TWiki/PreviewBackground/preview2bg.gif)
255
256 ## <a name="Access Control Settings"></a> Access Control Settings
257
258 - Users or groups allowed to change or rename this %TOPIC% topic: (ex: [[TWikiAdminGroup]])
259   - Set ALLOWTOPICCHANGE =
260   - Set ALLOWTOPICRENAME =
261
262 - Users or groups allowed to [[create new webs|TWiki/ManagingWebs]]: (ex: [[TWikiAdminGroup]])
263   - Set ALLOWWEBMANAGE = [[TWikiAdminGroup]]
264
265 - Site-level preferences that are **not** allowed to be overridden by [[WebPreferences]] and user preferences:
266   - Set FINALPREFERENCES = PREVIEWBGIMAGE, WIKITOOLNAME, WIKIWEBMASTER, SMTPMAILHOST , SMTPSENDERHOST, ALLOWWEBMANAGE
267
268 ## <a name="Creating New Preference Variable"></a> Creating New Preference Variables
269
270 You can introduce new VARIABLES and use them in your topics and templates. There is no need to change the TWiki engine (Perl scripts).
271
272 - 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):
273   - Set WEBBGCOLOR = #FFFFC0
274 - Preferences are used as [[TWikiVariables]] by enclosing the name in percent signs: <code>**%**</code>. Example:
275   - When you write variable <code>**%WEBBGCOLOR%**</code>, it gets expanded to `%WEBBGCOLOR%` .
276
277 - %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.
278
279 ## <a name="Related Topics"></a> Related Topics
280
281 - [[WebPreferences]] has preferences of the %WIKITOOLNAME%.%WEB% web.
282 - [[TWikiUsers]] has a list of user topics. User topics can have optional user preferences.
283 - [[TWikiVariables]] has a list of common `%VARIABLES%`.
284 - [[TWikiAccessControl]] explains how to restrict access by users or groups.
285
286 **_Note_**: Can't edit? [View raw topic](http://www.dementia.org/twiki//view/%WEB%/%TOPIC%?raw=on)