buildrelease
[openafs-wiki.git] / TWiki / TWikiPreferences.mdwn
1 <form action="http://www.dementia.org/twiki/viewauth/Main/WebHome" enctype="multipart/form-data" method="post" name="editpreferences">
2   <p>
3   </p>
4   <h1><a name="%WIKITOOLNAME% Site-Level Prefer"></a><a name=" %WIKITOOLNAME% Site-Level Prefe"></a> %WIKITOOLNAME% Site-Level Preferences </h1>
5   <p> This topic defines <strong><em>site-level</em></strong> settings that apply to all users and webs on this [[Main/TWikiSite]]. </p>
6   <p><strong><em>%X% Note:</em></strong> This topic should be regarded as read-only, so that upgrades can safely overwrite it without risk to your customizations. </p>
7   <p> Preference settings local to your site should be set in [[Main/TWikiPreferences]] (this topic is pointed to by {LocalSitePreferences}, which is set by the admin in the <code>configure</code> interface). Settings in [[Main/TWikiPreferences]] will override settings in this topic, and should be used for defining custom settings and variables. </p>
8   <p>[[Main/TWikiVariables#PreferencesVariables]] on how to set Preferences Variables. </p>
9   <p>
10   </p><input name="prefsaction" type="submit" value="Edit" /> <em>(Click for form-based editing of existing preferences.)</em><div>
11     <ul>
12       <li><a href="#Default Web Preferences"> Default Web Preferences</a></li>
13       <li><a href="#Default User Settings"> Default User Settings</a></li>
14       <li><a href="#TWiki Platform Settings"> TWiki Platform Settings</a><ul>
15           <li><a href="#Search Settings"> Search Settings</a></li>
16           <li><a href="#E-mail Settings"> E-mail Settings</a></li>
17           <li><a href="#HTTP-EQUIV Settings"> HTTP-EQUIV Settings</a></li>
18         </ul>
19       </li>
20       <li><a href="#Skin Settings"> Skin Settings</a><ul>
21           <li><a href="#PatternSkin"> PatternSkin</a></li>
22           <li><a href="#Skin icons"> Skin icons</a></li>
23           <li><a href="#Legacy support"> Legacy support</a></li>
24         </ul>
25       </li>
26       <li><a href="#Plugins Settings"> Plugins Settings</a></li>
27       <li><a href="#Rendering Shortcuts Settings"> Rendering Shortcuts Settings</a></li>
28       <li><a href="#Miscellaneous Settings"> Miscellaneous Settings</a></li>
29       <li><a href="#Creating New Preference Variable"> Creating New Preference Variables</a></li>
30       <li><a href="#Related Topics"> Related Topics</a></li>
31     </ul>
32   </div>
33   <p><a name="DefaultWebPreferences"></a></p>
34   <h2><a name="Default Web Preferences"></a> Default Web Preferences </h2>
35   <p> %X% <strong>NOTE:</strong> These are just defaults; don't change them here. Instead, add them to the WebPreferences topic in each web </p>
36   <p>
37   </p>
38   <ul>
39     <li> List of selected topics in a web (used in menus) <ul>
40         <li> Set WEBTOPICLIST = [[Main/WebChanges]] | [[Main/WebIndex]] | [[Main/WebSearch]] | Go <input name="topic" size="16" type="text" /></li>
41       </ul>
42     </li>
43   </ul>
44   <p>
45   </p>
46   <ul>
47     <li> Web-specific background color: (is overwritten by web preferences) <ul>
48         <li> Set WEBBGCOLOR = #FFD8AA </li>
49       </ul>
50     </li>
51   </ul>
52   <p>
53   </p>
54   <ul>
55     <li><a href="http://en.wikipedia.org/wiki/Favicon" target="_top">favicon</a>: Attach a <code>favicon.ico</code> to a web's [[Main/WebPreferences]] or add a <code>FAVICON</code> setting to [[Main/WebPreferences]]<ul>
56         <li> Set FAVICON = <a href="http://www.dementia.org/twiki//view/Main/WebPreferences/favicon.ico" target="_top">http://www.dementia.org/twiki//view/Main/WebPreferences/favicon.ico</a></li>
57       </ul>
58     </li>
59   </ul>
60   <p>
61   </p>
62   <ul>
63     <li> Image, URL and alternate tooltip text of web's logo. <ul>
64         <li> Set WEBLOGOIMG = %WIKILOGOIMG% </li>
65         <li> Set WEBLOGOURL = %WIKILOGOURL% </li>
66         <li> Set WEBLOGOALT = %WIKILOGOALT% </li>
67       </ul>
68     </li>
69   </ul>
70   <p>
71   </p>
72   <ul>
73     <li> List this web in the [[TWiki/SiteMap]]: <ul>
74         <li> If yes, set SITEMAPLIST to <code>on</code>, do not set NOSEARCHALL, and add the "what" and "use to..." description for the site map. Make sure to list only links that include the name of the web, e.g. %WEB%.Topic links. </li>
75         <li> Set SITEMAPLIST = on </li>
76         <li> Set SITEMAPWHAT = Describe what this web does. </li>
77         <li> Set SITEMAPUSETO = ...to do something. </li>
78       </ul>
79     </li>
80   </ul>
81   <p>
82   </p>
83   <ul>
84     <li> Copyright notice: <ul>
85         <li> Set WEBCOPYRIGHT = <span> <a href="http://twiki.org/"><img alt="This site is powered by the TWiki collaboration platform" border="0" height="15" src="http://www.dementia.org/twiki//view/TWiki/TWikiLogos/T-logo-80x15.gif" title="This site is powered by the TWiki collaboration platform" width="80" /></a></span>Copyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors. <br /> Ideas, requests, problems regarding %WIKITOOLNAME%? <a href="mailto:?subject=%WIKITOOLNAME% Feedback on Main.WebHome">Send feedback</a></li>
86       </ul>
87     </li>
88   </ul>
89   <p>
90   </p>
91   <ul>
92     <li> Simplified Copyright notice for the [[Main/WebRss]] feed (don't use any special characters, html tags, entities, wiki markup or [[Main/WikiWords]]) <ul>
93         <li> Set WEBRSSCOPYRIGHT = Copyright 2010 by contributing authors </li>
94       </ul>
95     </li>
96   </ul>
97   <p>
98   </p>
99   <ul>
100     <li> Exclude web from a <code>web="all"</code> search: (Set to <code>on</code> for hidden webs; is overwritten by web preferences) <strong><em>Note</em></strong> it is much better to use [[Main/TWikiAccessControls]] in individual webs to control who can and can't view the contents of a web. NOSEARCHALL is retained for compatibility, but you should avoid using it. <ul>
101         <li> Set NOSEARCHALL = </li>
102       </ul>
103     </li>
104     <li> Prevent automatic linking of [[TWiki/WikiWords]] and acronyms (if set to <code>on</code>); link WikiWords (if empty); can be overwritten by web preferences: <ul>
105         <li> Set NOAUTOLINK = </li>
106         <li><strong><em>Note:</em></strong> Use the <code>[[...][...]]</code> syntax to link topics in case you disabled WikiWord linking. The <code>&lt;noautolink&gt; ... &lt;/noautolink&gt;</code> syntax can be used to prevents links within a block of text. </li>
107       </ul>
108     </li>
109   </ul>
110   <p>
111   </p>
112   <ul>
113     <li> Warn if <code>%INCLUDE{}%</code> of topic fails: Fail silently if empty or <code>off</code>. Output warning message (defined in templates/oopsalerts.tmpl) if set to <code>on</code>. Otherwise output specific text (use <code>$topic</code> for topic). You can override this in web preferences, or by using a <code>warn="..."</code> parameter with <code>%INCLUDE{}%</code> : <ul>
114         <li> Set INCLUDEWARNING = on </li>
115       </ul>
116     </li>
117   </ul>
118   <p>
119   </p>
120   <p>
121   </p>
122   <h2><a name="Default User Settings"></a> Default User Settings </h2>
123   <p> %X% <strong>NOTE:</strong> They are typically redefined in topics of individual [[Main/TWikiUsers]]</p>
124   <p>
125   </p>
126   <ul>
127     <li> Show tool-tip topic info on mouse-over of [[Main/WikiWord]] links. Setting can be on, off, or customized. An empty setting or off setting disables the tool-tips (for better performance). The setting can contain $summary to show the topic summary, $date for the last change date, $rev for the revision, $username for the login name of the last editor, $wikiname for the WikiName, $wikiusername for Main.WikiName, $topic for the topic name, and $web for the web name <ul>
128         <li> Set LINKTOOLTIPINFO = off </li>
129         <li> #Set LINKTOOLTIPINFO = $username - $date - $rev: $summary </li>
130       </ul>
131     </li>
132   </ul>
133   <p>
134   </p>
135   <ul>
136     <li> Some skins have two editors available; the default editor, and a second editor which is usually a WYSIWYG editor (the second editor is used by hitting the WYSIWYG link in <code>pattern</code> or <code>classic</code> skins). If COMPOSER is not set, the second editor will work the same as the <em>default</em> editor. If the WysiwygPlugin is installed and it is set to 'kupu' (the default), then the <strong>Kupu</strong> WYSIWYG editor will be enabled. You can change the setting to use any editor that is enabled by setting the <code>cover</code> parameter on the edit URL. <ul>
137         <li> Set COMPOSER = kupu </li>
138       </ul>
139     </li>
140   </ul>
141   <p>
142   </p>
143   <ul>
144     <li> Horizontal size of text edit box: (can be overwritten by user preferences) <ul>
145         <li> Set EDITBOXWIDTH = 70 </li>
146       </ul>
147     </li>
148   </ul>
149   <p>
150   </p>
151   <ul>
152     <li> Vertical size of text edit box: (can be overwritten by user preferences) <ul>
153         <li> Set EDITBOXHEIGHT = 22 </li>
154       </ul>
155     </li>
156   </ul>
157   <p>
158   </p>
159   <ul>
160     <li> Style of text edit box. Set to <code>width: 99%</code> for full window width (default; this will overwrite the EDITBOXWIDTH setting), or <code>width: auto</code> to disable. This setting works for IE and some other recent browsers. (can be overwritten by user preferences) <ul>
161         <li> Set EDITBOXSTYLE = width: 99% </li>
162       </ul>
163     </li>
164   </ul>
165   <p>
166   </p>
167   <ul>
168     <li> Default state of the <strong><em>Force New Revision</em></strong> ([[Main/ForceNewRevision]]) check box in preview. Check box is initially checked if <code>Set FORCENEWREVISIONCHECKBOX = checked="checked"</code>, or unchecked if empty: (can be overwritten by user preferences) <ul>
169         <li> Set FORCENEWREVISIONCHECKBOX = </li>
170       </ul>
171     </li>
172   </ul>
173   <p>
174   </p>
175   <ul>
176     <li> Default state of the <strong><em>Minor Changes, Don't Notify</em></strong> ([[Main/DontNotify]]) check box in preview. Check box is initially checked if <code>Set DONTNOTIFYCHECKBOX = checked="checked"</code>, or unchecked if empty: (can be overwritten by user preferences) <ul>
177         <li> Set DONTNOTIFYCHECKBOX = </li>
178       </ul>
179     </li>
180   </ul>
181   <p>
182   </p>
183   <ul>
184     <li> Default state of the <strong><em>link</em></strong> check box in the attach file page. Checkbox is initially checked if <code>Set ATTACHLINKBOX = checked="checked"</code>, or unchecked if empty (<code>Set ATTACHLINKBOX =</code>). If checked, a link is created to the attached file at the end of the topic: (can be overwritten by user preferences) <ul>
185         <li> Set ATTACHLINKBOX = </li>
186       </ul>
187     </li>
188   </ul>
189   <p>
190   </p>
191   <ul>
192     <li> Format of file link when the <strong><em>link</em></strong> check box is checked: (can be overwritten by user preferences) <ul>
193         <li> %H% <strong>NOTE:</strong> Keyword <code><b>$name</b></code> gets expanded to filename; <code><b>$comment</b></code> to comment; <code><b>\t</b></code> to tab (3 spaces for bullets). </li>
194         <li> Set ATTACHEDFILELINKFORMAT = \n * <a href="http://www.dementia.org/twiki//view/$name" target="_top">$name</a>: $comment </li>
195       </ul>
196     </li>
197   </ul>
198   <p>
199   </p>
200   <ul>
201     <li> Format of images when the <strong><em>link</em></strong> check box is checked: (can be overwritten by user preferences) <ul>
202         <li> %H% <strong>NOTE:</strong> Keyword <code><b>$name</b></code> gets expanded to filename; <code><b>$comment</b></code> to comment; <code><b>$size</b></code> to <code><b>width="..." height="..."</b></code> attribute of <code><b>img</b></code> tag; <code><b>\t</b></code> to tab and <code><b>\n</b></code> to linefeed (3 spaces for bullets). </li>
203         <li> Set ATTACHEDIMAGEFORMAT = \n * $comment: <br />\n <img $size="$size" alt="$name" src="http://www.dementia.org/twiki//view/$name" /></li>
204       </ul>
205     </li>
206   </ul>
207   <p>
208   </p>
209   <h2><a name="TWiki Platform Settings"></a> TWiki Platform Settings </h2>
210   <p>
211   </p>
212   <ul>
213     <li> TWiki site name: <ul>
214         <li> Set WIKITOOLNAME = TWiki </li>
215       </ul>
216     </li>
217   </ul>
218   <p>
219   </p>
220   <ul>
221     <li> Image, URL and alternate tooltip text of the logo <strong>for this installation</strong>: you should change these settings for your site, or they can be overwridden in WebPreferences for individual webs by defining these variables there. <ul>
222         <li> Set WIKILOGOIMG = <img alt="T-logo-140x40-t.gif" src="http://www.dementia.org/twiki//view/TWiki/TWikiLogos/T-logo-140x40-t.gif" /></li>
223         <li> Set WIKILOGOURL = <a href="http://TWiki.org/" target="_top">http://TWiki.org/</a></li>
224         <li> Set WIKILOGOALT = Powered by %WIKITOOLNAME% </li>
225       </ul>
226     </li>
227   </ul>
228   <p>
229   </p>
230   <ul>
231     <li> Home page of this site <ul>
232         <li> Set WIKIHOMEURL = <a href="http://www.dementia.org/twiki/view" target="_top">http://www.dementia.org/twiki/view</a></li>
233       </ul>
234     </li>
235   </ul>
236   <p>
237   </p>
238   <ul>
239     <li> List of %WIKITOOLNAME% webs - on the first line of the upper toolbar (to add a new web, see [[Main/ManagingWebs]] and [[TWiki/SiteMap]]): <ul>
240         <li> Set WIKIWEBLIST = [[Main/WebHome]] | [[TWiki/WebHome]] | [[Sandbox/WebHome]]</li>
241         <li> %T% <strong>NOTE:</strong> To automatically list all non-hidden webs in alphabetical order, use the <code>%WEBLIST{}%</code> variable instead: <br />
242         </li>
243       </ul>
244     </li>
245   </ul>
246   <p>
247   </p>
248   <p>
249   </p>
250   <ul>
251     <li> Maximum size of [[TWiki/FileAttachments]] in KB, 0 for no limit: <ul>
252         <li> Set ATTACHFILESIZELIMIT = 10000 </li>
253       </ul>
254     </li>
255   </ul>
256   <p>
257   </p>
258   <ul>
259     <li> 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) <ul>
260         <li> Set BROADCASTMESSAGE = </li>
261         <li> #Set BROADCASTMESSAGE = <table border="0" cellpadding="3" cellspacing="0" width="100%">
262             <tr>
263               <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>
264             </tr>
265           </table>
266         </li>
267         <li> If you use [[Main/PatternSkin]]: </li>
268         <li> #Set BROADCASTMESSAGE = <div><strong>NOTE:</strong> 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.</div>
269         </li>
270       </ul>
271     </li>
272   </ul>
273   <p>
274   </p>
275   <ul>
276     <li> Users or groups allowed to [[TWiki/ManagingWebs]]: (ex: [[Main/TWikiAdminGroup]]) </li>
277     <li><strong>This has been disabled for the TWiki-4.0.0 release due to a potential security hole - you must be in the [[Main/TWikiAdminGroup]] to create a web</strong><ul>
278         <li> Set ALLOWWEBMANAGE = [[Main/TWikiAdminGroup]]</li>
279       </ul>
280     </li>
281   </ul>
282   <p>
283   </p>
284   <h3><a name="Search Settings"></a> Search Settings </h3>
285   <p>
286   </p>
287   <ul>
288     <li> Default type for search, one of: keyword (for search engine like syntax), regex (for [[Main/RegularExpression]] search), or literal (for verbatim search) <ul>
289         <li> Set SEARCHDEFAULTTTYPE = keyword </li>
290       </ul>
291     </li>
292     <li> Default for <code>%SEARCH{}%</code> variable, one of: keyword, regex, or literal <ul>
293         <li> Set SEARCHVARDEFAULTTYPE = literal </li>
294       </ul>
295     </li>
296     <li> Stop words, e.g., common words and characters to exclude from a keyword search: <ul>
297         <li> Set SEARCHSTOPWORDS = a, all, am, an, and, any, as, at, b, be, by, c, d, e, for, from, g, h, how, i, i'm, i.e., in, is, isn't, it, it's, its, j, k, l, m, n, o, of, on, or, p, q, r, s, t, that, that's, the, this, to, u, v, w, was, wasn't, what, what's, when, where, who, who's, will, with, x, y, z </li>
298       </ul>
299     </li>
300   </ul>
301   <p>
302   </p>
303   <h3><a name="E-mail Settings"></a> E-mail Settings </h3>
304   <p>
305   </p>
306   <ul>
307     <li> TWiki administrator e-mail address: <ul>
308         <li> Set WIKIWEBMASTER = <a href="mailto:webmaster@example.com">webmaster@example.com</a></li>
309       </ul>
310     </li>
311   </ul>
312   <p>
313   </p>
314   <ul>
315     <li> TWiki administrator name (first name and last name, e.g. <code>Fred Smith</code>): <ul>
316         <li> Set WIKIWEBMASTERNAME = TWiki Administrator </li>
317       </ul>
318     </li>
319   </ul>
320   <p>
321   </p>
322   <ul>
323     <li> 'Mail this topic' mailto: link - can be included in topics, templates or skins <ul>
324         <li> Set MAILTHISTOPIC = <a href="mailto:?subject=WebHome&body=%TOPICURL%">%MAILTHISTOPICTEXT%</a></li>
325       </ul>
326     </li>
327   </ul>
328   <p>
329   </p>
330   <ul>
331     <li> 'Mail this topic' link text <ul>
332         <li> Set MAILTHISTOPICTEXT = Send a link to this page </li>
333       </ul>
334     </li>
335   </ul>
336   <p>
337   </p>
338   <ul>
339     <li> URL for current topic <ul>
340         <li> Set TOPICURL = [[%WEB%/WebHome]]</li>
341       </ul>
342     </li>
343   </ul>
344   <p>
345   </p>
346   <p>
347   </p>
348   <h3><a name="HTTP-EQUIV Settings"></a> HTTP-EQUIV Settings </h3>
349   <p>
350   </p>
351   <ul>
352     <li> %T% <strong>NOTE:</strong> Changing cache behaviour with these settings should not be necessary and may cause cache-related problems (e.g. TWiki:Codev.BackFromPreviewLosesText or TWiki:Codev.RefreshEditPage). These settings do not affect proxy caches. </li>
353     <li><strong>NOTE:</strong> The current values of these preferences are not displayed in view mode (values are <code>&lt;link&gt;</code>-tags). </li>
354   </ul>
355   <p>
356   </p>
357   <ul>
358     <li><code><b>http-equiv</b></code> meta tags for <code><b>view</b></code>, <code><b>rdiff</b></code>, <code><b>attach</b></code>, <code><b>search*</b></code> scripts: <ul>
359         <li> #Set HTTP_EQUIV_ON_VIEW = </li>
360         <li> Set HTTP_EQUIV_ON_VIEW = </li>
361       </ul>
362     </li>
363   </ul>
364 </form>
365
366 - <code>**http-equiv**</code> meta tags for <code>**edit**</code> script:
367   - Set HTTP\_EQUIV\_ON\_EDIT =
368
369 - <code>**http-equiv**</code> meta tags for <code>**preview**</code> script:
370   - Set HTTP\_EQUIV\_ON\_PREVIEW =
371
372 ## <a name="Skin Settings"></a> Skin Settings
373
374 - Skin overriding the default TWiki templates: (can be overwritten by [[WebPreferences]] and user preferences)
375   - Set SKIN = pattern
376
377 - **_Note:_** See [[TWikiSkinBrowser]] for currently installed skins
378
379 ### <a name="PatternSkin"></a> [[PatternSkin]]
380
381 - Default TWiki styles
382   - Set TWIKILAYOUTURL = <http://www.dementia.org/twiki//view/TWiki/PatternSkin/layout.css>
383   - Set TWIKISTYLEURL = <http://www.dementia.org/twiki//view/TWiki/PatternSkin/style.css>
384   - Set TWIKICOLORSURL = <http://www.dementia.org/twiki//view/TWiki/PatternSkin/colors.css>
385
386 - Custom overriding styles (enabled pr. default but empty, to prevent browsers from fetching %USERLAYOUTURL%-style URLs)
387   - Set USERLAYOUTURL =
388   - Set USERSTYLEURL =
389   - Set USERCOLORSURL =
390
391 - **PatternSkin header settings**
392   - Set WEBHEADERART = ![TWiki\_header.gif](http://www.dementia.org/twiki//view/TWiki/PatternSkin/TWiki_header.gif)
393   - Set WEBHEADERBGCOLOR = #ffffff
394
395 ### <a name="Skin icons"></a> Skin icons
396
397 - Topic containing the icon graphics library. Icons can easily be rendered with `%ICON{name}%`.
398   - Set ICONTOPIC = [[TWikiDocGraphics]]
399
400 ### <a name="Legacy support"></a> Legacy support
401
402 - Support for legacy "EDITTOPIC", used to be hard-coded, now replaced by TMPL:P conditional instantiation
403   - Set EDITURL = <http://www.dementia.org/twiki/edit/%WEB%/%TOPIC%?t=1277827148>
404   - Set EDITTOPIC = [Edit](%EDITURL% Edit Topic - deprecated usage - please see release notes)
405
406 ## <a name="Plugins Settings"></a> Plugins Settings
407
408 - You can enable/disable Plugins using the [configure](http://www.dementia.org/twiki/configure) interface.
409 - Currently activated Plugins: [[SpreadSheetPlugin]], [[CommentPlugin]], [[EditTablePlugin]], [[InterwikiPlugin]], [[PreferencesPlugin]], [[SlideShowPlugin]], [[SmiliesPlugin]], [[TablePlugin]], [[TwistyPlugin]]
410 - %T% **NOTE:** You can enable/disable Plugins by passing a comma-separated list of Plugin names in the `debugenableplugins` url parameter; for example, [[http://www.dementia.org/twiki/view/%WEB%/%TOPIC%?debugenableplugins=SmiliesPlugin|%WEB%/%TOPIC%?debugenableplugins=SmiliesPlugin]] will display this topic with all Plugins disabled except the [[SmiliesPlugin]].
411 - Detailed diagnostics can be found in [[InstalledPlugins]]
412 - Legacy settings:
413   - Set DISABLEDPLUGINS = The DISABLEDPLUGINS variable is no longer supported
414   - Set INSTALLEDPLUGINS = The INSTALLEDPLUGINS variable is no longer supported. You can set the Plugins execution order using the [configure](http://www.dementia.org/twiki/configure) interface.
415
416 ## <a name="Rendering Shortcuts Settings"></a> Rendering Shortcuts Settings
417
418 - Line break:
419   - Set BR = <br />
420
421 - Bullet sign:
422   - Set BULLET = •
423
424 - Line break and bullet with different levels of indentation:
425   - Set BB = <br />•
426   - Set BB2 = <br />  •
427   - Set BB3 = <br />    •
428   - Set BB4 = <br />      •
429
430 - Colored text: (see more [[StandardColors]]) <table border="1" cellpadding="0" cellspacing="0">
431   <tr>
432     <td> You type: </td>
433     <td><code>%RED% red text %ENDCOLOR% and %GREEN% green text %ENDCOLOR%</code></td>
434   </tr>
435   <tr>
436     <td> You get: </td>
437     <td> %RED% red text %ENDCOLOR% and %GREEN% green text %ENDCOLOR% </td>
438   </tr>
439 </table>
440   - **_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%`.
441   - %YELLOW% **Set YELLOW = looks like this** %ENDCOLOR%
442   - %ORANGE% **Set ORANGE = looks like this** %ENDCOLOR%
443   - %RED% **Set RED = looks like this** %ENDCOLOR%
444   - %PINK% **Set PINK = looks like this** %ENDCOLOR%
445   - %PURPLE% **Set PURPLE = looks like this** %ENDCOLOR%
446   - %TEAL% **Set TEAL = looks like this** %ENDCOLOR%
447   - %NAVY% **Set NAVY = looks like this** %ENDCOLOR%
448   - %BLUE% **Set BLUE = looks like this** %ENDCOLOR%
449   - %AQUA% **Set AQUA = looks like this** %ENDCOLOR%
450   - %LIME% **Set LIME = looks like this** %ENDCOLOR%
451   - %GREEN% **Set GREEN = looks like this** %ENDCOLOR%
452   - %OLIVE% **Set OLIVE = looks like this** %ENDCOLOR%
453   - %MAROON% **Set MAROON = looks like this** %ENDCOLOR%
454   - %BROWN% **Set BROWN = looks like this** %ENDCOLOR%
455   - %BLACK% **Set BLACK = looks like this** %ENDCOLOR%
456   - %GRAY% **Set GRAY = looks like this** %ENDCOLOR%
457   - %SILVER% **Set SILVER = looks like this** %ENDCOLOR%
458   - <span>%WHITE% **Set WHITE = looks like this (with gray background)** %ENDCOLOR%</span>
459   - The following color settings are enclosed in verbatim tags to avoid incorrect nesting of XHTML tags:
460
461           * Set YELLOW = <font color="#ffff00">
462           * Set ORANGE = <font color="#ff6600">
463           * Set RED = <font color="#ff0000">
464           * Set PINK = <font color="#ff00ff">
465           * Set PURPLE = <font color="#800080">
466           * Set TEAL = <font color="#008080">
467           * Set NAVY = <font color="#000080">
468           * Set BLUE = <font color="#0000ff">
469           * Set AQUA = <font color="#00ffff">
470           * Set LIME = <font color="#00ff00">
471           * Set GREEN = <font color="#008000">
472           * Set OLIVE = <font color="#808000">
473           * Set MAROON = <font color="#800000">
474           * Set BROWN = <font color="#996633">
475           * Set BLACK = <font color="#000000">
476           * Set GRAY = <font color="#808080">
477           * Set SILVER = <font color="#c0c0c0">
478           * Set WHITE = <font color="#ffffff">
479           * Set ENDCOLOR = </font>
480
481 <a name="DocGraphics"></a>
482
483 - Graphics used in TWiki documentation - view all images in %ICONTOPIC%. _(There are various ways to set up common icons as text variables. This is simply one quick approach.)_:
484   - Set H = <img src="http://www.dementia.org/twiki//view/Main/WebHome/help.gif" width="16" height="16" alt="HELP" title="HELP" />
485   - Set I = <img src="http://www.dementia.org/twiki//view/Main/WebHome/tip.gif" width="16" height="16" alt="IDEA!" title="IDEA!" />
486   - Set M = <img src="http://www.dementia.org/twiki//view/Main/WebHome/arrowright.gif" width="16" height="16" alt="MOVED TO..." title="MOVED TO..." />
487   - Set N = <img src="http://www.dementia.org/twiki//view/Main/WebHome/new.gif" width="30" height="16" alt="NEW" title="NEW" />
488   - Set P = <img src="http://www.dementia.org/twiki//view/Main/WebHome/pencil.gif" width="16" height="16" alt="REFACTOR" title="REFACTOR" />
489   - Set Q = <img src="http://www.dementia.org/twiki//view/Main/WebHome/help.gif" width="16" height="16" alt="QUESTION?" title="QUESTION?" />
490   - Set S = <img src="http://www.dementia.org/twiki//view/Main/WebHome/starred.gif" width="16" height="16" alt="PICK" title="PICK" />
491   - Set T = <img src="http://www.dementia.org/twiki//view/Main/WebHome/tip.gif" width="16" height="16" alt="TIP" title="TIP" />
492   - Set U = <img src="http://www.dementia.org/twiki//view/Main/WebHome/updated.gif" width="55" height="16" alt="UPDATED" title="UPDATED" />
493   - Set X = <img src="http://www.dementia.org/twiki//view/Main/WebHome/warning.gif" width="16" height="16" alt="ALERT!" title="ALERT!" />
494   - Set Y = <img src="http://www.dementia.org/twiki//view/Main/WebHome/choice-yes.gif" width="16" height="16" alt="DONE" title="DONE" />
495
496 ## <a name="Miscellaneous Settings"></a> Miscellaneous Settings
497
498 - Background color of non existing topic: ( default `cornsilk` or `#FFFFCE` )
499   - Set NEWTOPICBGCOLOR = #FFFFCE
500
501 - Font color of non existing topic: ( default `#0000FF` )
502   - Set NEWTOPICFONTCOLOR = #0000FF
503
504 - [[PreviewBackground]] image:
505   - Set PREVIEWBGIMAGE = ![preview2bg.gif](http://www.dementia.org/twiki//view/TWiki/PreviewBackground/preview2bg.gif)
506
507 ## <a name="Creating New Preference Variable"></a> Creating New Preference Variables
508
509 You can introduce new VARIABLES and use them in your topics and templates. There is no need to change the TWiki engine (Perl scripts).
510
511 - 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):
512   - Set WEBBGCOLOR = #FFFFC0
513 - Preferences are used as [[TWikiVariables]] by enclosing the name in percent signs: <code>**%**</code>. Example:
514   - When you write variable <code>**%WEBBGCOLOR%**</code>, it gets expanded to `%WEBBGCOLOR%` .
515
516 - %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 TWiki administrator e-mail address.
517 - %X% In order to protect your custom variables from being overwritten when upgrading the [[TWiki.%TOPIC%|TWiki/TOPIC]] topic, it is recommended that custom variables are defined in [[Main.%TOPIC%|Main/TOPIC]].
518
519 ## <a name="Related Topics"></a> Related Topics
520
521 - [[WebPreferences]] has preferences of the %WEB% web.
522 - [[TWikiUsers]] has a list of user topics. User topics can have optional user preferences.
523 - [[TWikiVariables]] has a list of common `%VARIABLES%`.
524 - [[TWikiAccessControl]] explains how to restrict access by users or groups.
525 - TWiki:Plugins.PreferencesPlugin makes editing preferences a snap.
526
527 **_Note_**: Can't edit? [[View raw topic|%WEB%/%TOPIC%?raw=on]]